@redocly/portal-plugin-async-api 0.0.0-react18-20231120182601

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@redocly/portal-plugin-async-api",
+  "version": "0.0.0-react18-20231120182601",
+  "description": "Async API plugin for @redocly/portal",
+  "type": "module",
+  "exports": {
+    ".": "./lib/plugin.js",
+    "./package.json": "./package.json",
+    "./plugin.js": "./lib/plugin.js",
+    "./template": "./lib/template.js",
+    "./template.js": "./lib/template.js",
+    "./config.js": "./lib/config.js",
+    "./config": "./lib/config.js"
+  },
+  "keywords": [
+    "redocly",
+    "theme",
+    "AsyncAPI"
+  ],
+  "author": "",
+  "license": "SEE LICENSE IN LICENSE",
+  "devDependencies": {
+    "@types/node": "^18.11.18",
+    "@types/react": "^18.2.31",
+    "@types/styled-components": "^5.1.30",
+    "typescript": "^5.2.2"
+  },
+  "dependencies": {
+    "@asyncapi/bundler": "^0.3.11",
+    "@asyncapi/react-component": "1.0.0-next.47",
+    "json-schema-to-ts": "^2.9.1",
+    "styled-components": "^5.3.11"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0",
+    "@redocly/portal": "0.0.0-react18-20231120182601"
+  },
+  "overrides": {
+    "react": "^18.0.0"
+  },
+  "scripts": {
+    "clean": "rm -rf lib",
+    "compile": "tsc -p tsconfig.build.json",
+    "build": "npm run clean && npm run compile",
+    "watch": "tsc -w -p tsconfig.build.json"
+  }
+}

package/src/config.ts

@@ -0,0 +1,37 @@
+import type { FromSchema } from 'json-schema-to-ts';
+
+const expandSectionSchema = {
+  type: 'object',
+  properties: {
+    root: { type: 'boolean' },
+    elements: { type: 'boolean' },
+  },
+  additionalProperties: false,
+} as const;
+
+const asyncApiDocsSchema = {
+  type: 'object',
+  properties: {
+    schemaId: { type: 'string' },
+    hideErrors: { type: 'boolean' },
+    hideInfo: { type: 'boolean' },
+    hideChannels: { type: 'boolean' },
+    hideServers: { type: 'boolean' },
+    hideMessages: { type: 'boolean' },
+    hideSchemas: { type: 'boolean' },
+    expandChannels: expandSectionSchema,
+    expandServers: expandSectionSchema,
+    expandMessages: expandSectionSchema,
+    expandSchemas: expandSectionSchema,
+  },
+  additionalProperties: false,
+} as const;
+
+export const themeConfigSchema = {
+  type: 'object',
+  properties: {
+    asyncapi: asyncApiDocsSchema,
+  },
+} as const;
+
+export type AsyncApiDocsSettings = FromSchema<typeof asyncApiDocsSchema>;

package/src/plugin.ts

@@ -0,0 +1,115 @@
+// FIXME: think of a way to make these imports shorter?
+
+import { getAllowedTeamsForRoute } from '@redocly/portal/dist/server/utils/rbac.js';
+import { REDOCLY_TEAMS_RBAC } from '@redocly/portal/dist/shared/constants.js';
+import { withPathPrefix } from '@redocly/portal/dist/shared/urls.js';
+import bundle from '@asyncapi/bundler';
+
+import type { PageStaticData } from '@redocly/portal/dist/shared/types';
+import type { AsyncApiDocsSettings } from './config';
+import type {
+  GetStaticDataFn,
+  PageRouteDetails,
+  PluginInstance,
+} from '@redocly/portal/dist/server/plugins/types';
+
+const ASYNCAPI_TEMPLATE_ID = 'asyncapi-docs';
+const ASYNCAPI_SHARED_DATA_PREFIX = 'asyncapi-docs-';
+
+export default async function asyncAPIDocsPlugin(): Promise<PluginInstance> {
+  return {
+    processContent: async (contentProvider, actions) => {
+      const asyncAPITemplateId = actions.createTemplate(
+        ASYNCAPI_TEMPLATE_ID,
+        '@redocly/portal-plugin-async-api/template.js',
+      );
+
+      const config = actions.getConfig<{ asyncapi?: AsyncApiDocsSettings }>();
+      const globalSettings = config.theme?.asyncapi || {};
+
+      const definitions = loadDefinitions();
+      const currentScriptLocation = process.cwd();
+
+      for (const [relativePath, parsedDefinition] of definitions) {
+        const pageSlug = contentProvider.slugFromRelativePath(relativePath);
+
+        const sharedDataKey = `${ASYNCAPI_SHARED_DATA_PREFIX}${relativePath}`;
+        const isLocatedInRoot = relativePath.lastIndexOf('/') === -1;
+        try {
+          const fileLocation = relativePath.substring(
+            0,
+            isLocatedInRoot ? undefined : relativePath.lastIndexOf('/'),
+          );
+          // todo: workaround for $ref resolving until following issue is resolved: https://github.com/asyncapi/bundler/issues/136
+          process.chdir(fileLocation);
+          const bundledContent = await bundle([parsedDefinition as string]);
+          await actions.createSharedData(sharedDataKey, bundledContent.string());
+
+          const route = {
+            slug: pageSlug,
+            fsPath: relativePath,
+            templateId: asyncAPITemplateId,
+            getStaticData: buildGetStaticDataFn(globalSettings, pageSlug),
+            versions: contentProvider.versions.getPageVersions(relativePath, pageSlug),
+            [REDOCLY_TEAMS_RBAC]: getAllowedTeamsForRoute(config.rbac, {
+              slug: pageSlug,
+              fsPath: relativePath,
+            }),
+            metadata: {
+              type: 'asyncapi',
+              title: 'AsyncAPI',
+            },
+          };
+
+          actions.addRoute(route);
+          actions.addRouteSharedData(route.slug, 'AsyncApiDefinition', sharedDataKey);
+          process.chdir(currentScriptLocation);
+        } catch (e) {
+          process.chdir(currentScriptLocation);
+          console.error(e);
+        }
+      }
+
+      function loadDefinitions() {
+        const definitions: Map<string, unknown> = new Map();
+        for (const relativePath of contentProvider.filesList.values()) {
+          if (!relativePath.match(/(\.ya?ml|\.json)$/)) {
+            continue;
+          }
+
+          try {
+            const contentRecord = contentProvider.loadContent<any>(relativePath, 'yaml');
+            if (contentRecord.isIgnored) {
+              continue;
+            }
+
+            if (!contentRecord.parsed?.asyncapi) {
+              continue;
+            }
+            definitions.set(relativePath, contentRecord.content);
+          } catch (error) {
+            continue;
+          }
+        }
+
+        return definitions;
+      }
+    },
+  };
+
+  function buildGetStaticDataFn(
+    settings: AsyncApiDocsSettings,
+    pageSlug: string,
+  ): GetStaticDataFn<PageRouteDetails, PageStaticData> {
+    return async function (_route, _data, _context) {
+      return {
+        props: {
+          settings: {
+            ...settings,
+            baseUrlPath: withPathPrefix(pageSlug),
+          },
+        },
+      };
+    };
+  }
+}