"use strict"; // P A C K A G E S import asyncHtml from "choo-async/html"; import dedent from "dedent"; import fs from "graceful-fs"; import raw from "choo/html/raw"; const fetch = require("make-fetch-happen").defaults({ cacheManager: "./cache" }); // V A R I A B L E const apiScripts = ""; // E X P O R T module.exports = exports = state => parseApiFile(state.params.wildcard).then(response => asyncHtml`
${raw(createApiContent(response).join(""))}
${raw(apiScripts)} `); // H E L P E R S function createApiContent(apiDetails) { const apiContent = []; for (const apiDetail of apiDetails) { let apiDetailsReturns = ""; if (apiDetail.returns) apiDetailsReturns = JSON.parse(JSON.stringify(apiDetail.returns)); apiContent.push(`

${apiDetail.name}

${apiDetail.description}

${apiDetail.arguments.length ? `

Arguments

` : ""}

Returns

${dedent(apiDetailsReturns)}
// example(s) for ${apiDetail.name} to come later
`); } return apiContent; } function createApiSidebar(apiDetails) { const apiSidebar = []; for (const apiDetail of apiDetails) { apiSidebar.push(`
  • ${apiDetail.name}
  • `); } return apiSidebar; } function parseApiFile(urlSlug) { let apiFileLink; if (!urlSlug || urlSlug === "api" || urlSlug === "protocol") apiFileLink = process.env.NODE_ENV === "development" ? "https://rawgit.com/lbryio/lbry/master/docs/api.json" : "https://cdn.rawgit.com/lbryio/lbry/5b3103e4/docs/api.json" ; if (urlSlug === "blockchain") apiFileLink = process.env.NODE_ENV === "development" ? "https://rawgit.com/lbryio/lbrycrd/add_api_docs_scripts/contrib/devtools/generated/api_v1.json" : "https://cdn.rawgit.com/lbryio/lbrycrd/add_api_docs_scripts/contrib/devtools/generated/api_v1.json" ; if (!apiFileLink) return; // TODO: Error handling return fetch(apiFileLink).then(() => fetch(apiFileLink, { cache: "no-cache" // forces a conditional request })).then(res => res.json().then(body => body)); // res.status 304 = cache validated } function renderArguments(args) { const argumentContent = []; for (const arg of args) { argumentContent.push(`
  • ${arg.name}
    ${arg.is_required === true ? "" : "optional" }${arg.type}
    ${typeof arg.description === "string" ? arg.description.replace(//g, ">") : ""}
  • `); } return argumentContent; }