docs/gatsby-node.js

/* eslint-disable no-console */

const path = require('path')
const { createFilePath } = require('gatsby-source-filesystem')
const Swagger = require('swagger-client')
const { redirects } = require('./config')

exports.onCreateNode = ({ node, getNode, actions }) => {
    const { createNodeField } = actions

    if (node.internal.type === 'MarkdownRemark') {
        const fileNode = getNode(node.parent)
        const parsedFilePath = path.parse(fileNode.relativePath)

        let slug = createFilePath({ node, getNode, basePath: 'content' })
        let section = parsedFilePath.dir

        if (node.frontmatter.slug) {
            ;({ slug } = node.frontmatter)
        }

        if (node.frontmatter.section) {
            ;({ section } = node.frontmatter)
        }

        createNodeField({
            node,
            name: 'slug',
            value: slug
        })

        createNodeField({
            node,
            name: 'section',
            value: section
        })
    }
}

exports.createPages = ({ graphql, actions }) => {
    const { createPage, createRedirect } = actions

    return new Promise((resolve, reject) => {
        resolve(
            graphql(
                `
                    query {
                        allMarkdownRemark(
                            filter: { fileAbsolutePath: { regex: "/content/" } }
                        ) {
                            edges {
                                node {
                                    fields {
                                        slug
                                        section
                                    }
                                }
                            }
                        }

                        devOceanDocs: allMarkdownRemark(
                            filter: {
                                fileAbsolutePath: { regex: "/dev-ocean/doc/" }
                            }
                        ) {
                            edges {
                                node {
                                    fields {
                                        slug
                                        section
                                    }
                                    frontmatter {
                                        slug
                                        title
                                        description
                                        section
                                    }
                                }
                            }
                        }

                        squidJs: github {
                            repository(
                                name: "squid-js"
                                owner: "oceanprotocol"
                            ) {
                                name
                                releases(
                                    first: 30
                                    orderBy: {
                                        field: CREATED_AT
                                        direction: DESC
                                    }
                                ) {
                                    edges {
                                        node {
                                            isPrerelease
                                            isDraft
                                            releaseAssets(
                                                first: 1
                                                name: "squid-js.json"
                                            ) {
                                                edges {
                                                    node {
                                                        name
                                                        downloadUrl
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                `
            ).then(async (result) => {
                if (result.errors) {
                    console.log(result.errors)
                    reject(result.errors)
                }

                const docTemplate = path.resolve('./src/templates/Doc.jsx')
                const posts = result.data.allMarkdownRemark.edges

                //
                // Create Doc pages
                //
                posts.forEach((post) => {
                    createPage({
                        path: `${post.node.fields.slug}`,
                        component: docTemplate,
                        context: {
                            slug: post.node.fields.slug,
                            section: post.node.fields.section
                        }
                    })
                })

                //
                // Create pages from dev-ocean contents
                //
                const postsDevOcean = result.data.devOceanDocs.edges

                postsDevOcean
                    // only grab files with required frontmatter defined
                    .filter(
                        (post) =>
                            post.node.frontmatter &&
                            post.node.frontmatter.slug &&
                            post.node.frontmatter.title &&
                            post.node.frontmatter.description &&
                            post.node.frontmatter.section
                    )
                    .forEach((post) => {
                        createPage({
                            path: `${post.node.fields.slug}`,
                            component: docTemplate,
                            context: {
                                slug: post.node.fields.slug,
                                section: post.node.fields.section
                            }
                        })
                    })

                // API: brizo, aquarius
                await createSwaggerPages(createPage)

                // API: squid-js
                const lastRelease = result.data.squidJs.repository.releases.edges.filter(
                    ({ node }) => !node.isPrerelease && !node.isDraft
                )[0].node.releaseAssets.edges[0].node
                await createTypeDocPage(
                    createPage,
                    result.data.squidJs.repository.name,
                    lastRelease.downloadUrl
                )

                //
                // create redirects
                //
                redirects.forEach(({ from, to }) => {
                    createRedirect({
                        fromPath: from,
                        redirectInBrowser: true,
                        toPath: to
                    })

                    console.log('Create redirect: ' + from + ' --> ' + to)
                })

                resolve()
            })
        )
    })
}

//
// Create pages from TypeDoc json files
//
const createTypeDocPage = async (createPage, name, downloadUrl) => {
    try {
        const typedoc = await fetch(downloadUrl)
        const typedocTemplate = path.resolve(
            './src/templates/Typedoc/index.jsx'
        )
        const slug = `/references/${name}/`

        createPage({
            path: slug,
            component: typedocTemplate,
            context: {
                slug,
                typedoc: await typedoc.json(),
                // We define the classes here so the data object passed as page context
                // is as small as possible.
                // Caveat: no live update during development when these values are changed.
                //
                // TODO: defining these classes for inclusion
                // needs to be handled somewhere else to keep
                // it generic for all TypeDoc specs
                classes: [
                    'ocean/Ocean',
                    'ocean/OceanAccounts',
                    'ocean/OceanAssets',
                    'ocean/OceanAgreements',
                    'ocean/OceanAgreementsConditions',
                    'ocean/OceanCompute',
                    'ocean/OceanSecretStore',
                    'ocean/OceanVersions',
                    'ocean/Account',
                    'ocean/DID',
                    'ddo/DDO',
                    'ddo/Service',
                    'aquarius/Aquarius',
                    'brizo/Brizo',
                    'keeper/Keeper',
                    'keeper/ContractHandler',
                    'keeper/EventHandler',
                    'keeper/Web3Provider',
                    'models/Config',
                    'models/Balance',
                    'ocean/utils/OceanUtils',
                    'ocean/utils/ServiceAgreement',
                    'ocean/utils/WebServiceConnector',
                    'utils/Logger'
                ]
            }
        })
    } catch (error) {
        console.log(error.message)
    }
}

//
// Create pages from swagger json files
//
// https://github.com/swagger-api/swagger-js
const fetchSwaggerSpec = async (name) => {
    try {
        const client = await Swagger(
            `https://${name}.commons.oceanprotocol.com/spec`
        )
        return client.spec // The resolved spec

        // client.originalSpec // In case you need it
        // client.errors // Any resolver errors

        // Tags interface
        // client.apis.pet.addPet({id: 1, name: "bobby"}).then(...)

        // TryItOut Executor, with the `spec` already provided
        // client.execute({operationId: 'addPet', parameters: {id: 1, name: "bobby") }).then(...)
    } catch (error) {
        console.error(error.message)
    }
}

const createSwaggerPages = async (createPage) => {
    const swaggerComponents = ['aquarius', 'brizo']
    const apiSwaggerTemplate = path.resolve('./src/templates/Swagger/index.jsx')

    const getSlug = (name) => {
        const slug = `/references/${name}/`
        return slug
    }

    const specAquarius = await fetchSwaggerSpec(swaggerComponents[0])
    const slugAquarius = getSlug(swaggerComponents[0])

    createPage({
        path: slugAquarius,
        component: apiSwaggerTemplate,
        context: {
            slug: slugAquarius,
            name: swaggerComponents[0],
            api: specAquarius
        }
    })

    const specBrizo = await fetchSwaggerSpec(swaggerComponents[1])
    const slugBrizo = getSlug(swaggerComponents[1])

    createPage({
        path: slugBrizo,
        component: apiSwaggerTemplate,
        context: {
            slug: slugBrizo,
            name: swaggerComponents[1],
            api: specBrizo
        }
    })

    // Swagger Pet Store example
    const petStoreSlug = '/references/petstore/'

    try {
        const client = await Swagger(
            `http://petstore.swagger.io/v2/swagger.json`
        )

        createPage({
            path: petStoreSlug,
            component: apiSwaggerTemplate,
            context: {
                slug: petStoreSlug,
                api: client.spec
            }
        })
    } catch (error) {
        console.error(error.message)
    }
}