feat: add openapi gen to core

packages/api-cli/package.json

@@ -42,8 +42,8 @@
     "@types/cli-progress": "3.11.0",
     "@types/express": "4.17.17",
     "@types/fs-extra": "9.0.13",
-    "@types/junit-report-builder": "3.0.0",
     "@types/json-schema": "7.0.11",
+    "@types/junit-report-builder": "3.0.0",
     "@types/mocha": "10.0.1",
     "@types/node": "18.15.3",
     "@types/wait-on": "5.3.1",

packages/api-cli/src/e2e.ts

@@ -114,9 +114,9 @@ async function retrieveItems(api: ConnectorClient, suite: junit.TestSuite, error
       type: 'value',
     },
   };
-  for (const uid of localItemMap.keys()) {
+  for (const {uid, type} of localItemMap.values()) {
     await runTest(
-      `Should find ${uid}`,
+      `Should find ${type} (${uid})`,
       async () => {
         singleItemSearchRequest.filter!.arguments.value = uid;
         const searchResponse = await api.search(singleItemSearchRequest);
@@ -139,7 +139,7 @@ async function retrieveItems(api: ConnectorClient, suite: junit.TestSuite, error
 async function compareItems(suite: junit.TestSuite, errors: string[]) {
   for (const localThing of localItemMap.values()) {
     await runTest(
-      `Should be the same for ${localThing.uid}`,
+      `Should be the same for ${localThing.type} (${localThing.uid})`,
       async () => {
         /* istanbul ignore next retrieveItems will throw before*/
         if (!remoteItemMap.has(localThing.uid)) {

packages/api-cli/turbo.json

@@ -1,9 +0,0 @@
-{
-  "extends": ["//"],
-  "pipeline": {
-    "deploy": {
-      "dependsOn": ["@openstapps/api-cli#build"],
-      "outputs": [".deploy/api-cli"]
-    }
-  }
-}

packages/core-tools/package.json

@@ -103,7 +103,6 @@
     ]
   },
   "eslintIgnore": [
-    "resources",
-    "openapi"
+    "resources"
   ]
 }

packages/core-tools/src/app.ts

@@ -15,7 +15,6 @@
 import {Logger} from '@openstapps/logger';
 import {Command} from 'commander';
 import {existsSync, readFileSync, writeFileSync} from 'fs';
-import {copy} from 'fs-extra';
 import path from 'path';
 import {lightweightDefinitionsFromPath, lightweightProjectFromPath} from '@openstapps/easy-ast';
 import {openapi3Template} from './resources/openapi-303-template.js';
@@ -57,7 +56,7 @@ commander
     // get absolute paths
     const sourcePath = path.resolve(relativeSourceBundlePath);
     const outDirectoryPath = path.resolve(relativeOutDirectoryPath);
-    const outDirectorySchemasPath = path.join(outDirectoryPath, 'schemas');
+    const outDirectorySchemasPath = path.join(outDirectoryPath, 'schema');
 
     // get information about routes
     const routes = await gatherRouteInformation(sourcePath);
@@ -82,9 +81,6 @@ commander
     // initialize json output
     const output = openapi3Template;
 
-    // names of the schemas to copy
-    const schemasToCopy: string[] = [];
-
     // generate documentation for all routes
     for (const routeWithMetaInformation of routes) {
       routeWithMetaInformation.tags = [capitalize(routeWithMetaInformation.route.urlPath.split('/')[1])];
@@ -92,29 +88,10 @@ commander
       output.paths[routeWithMetaInformation.route.urlPath] = generateOpenAPIForRoute(
         routeWithMetaInformation,
         path.relative(relativeOutDirectoryPath, outDirectorySchemasPath),
-        schemasToCopy,
         tagsToKeep,
       );
     }
 
-    // copy schema json schema files
-    try {
-      if (!existsSync(outDirectorySchemasPath)) {
-        await mkdir(outDirectorySchemasPath, {
-          recursive: true,
-        });
-      }
-      for (const fileName of schemasToCopy) {
-        await copy(
-          path.join(sourcePath, 'schema', `${fileName}.json`),
-          path.join(outDirectorySchemasPath, `${fileName}.json`),
-        );
-      }
-    } catch (error) {
-      await Logger.error(error);
-      process.exit(-2);
-    }
-
     // write openapi object to file (prettified)
     writeFileSync(path.join(outDirectoryPath, 'openapi.json'), JSON.stringify(output, undefined, 2));
 

packages/core-tools/src/routes.ts

@@ -79,20 +79,16 @@ export async function gatherRouteInformation(path: string): Promise<RouteWithMet
  * Generate documentation snippet for one route
  * @param routeWithInfo A route instance with its meta information
  * @param outDirectorySchemasPath Path to directory that will contain relevant schemas for the route
- * @param schemasToCopy Schemas identified as relevant for this route
  * @param tagsToKeep Tags / keywords that can be used for grouping routes
  */
 export function generateOpenAPIForRoute(
   routeWithInfo: RouteWithMetaInformation,
   outDirectorySchemasPath: string,
-  schemasToCopy: string[],
   tagsToKeep: string[],
 ): OpenAPIV3.PathItemObject {
   const route = routeWithInfo.route;
   const openapiPath: OpenAPIV3.PathItemObject = {};
 
-  schemasToCopy.push(route.requestBodyName, route.responseBodyName);
-
   openapiPath[route.method.toLowerCase() as OpenAPIV3.HttpMethods] = {
     summary: capitalize(routeWithInfo.description.shortText?.replace(/(Route to |Route for )/gim, '')),
     description: routeWithInfo.description.text,
@@ -133,7 +129,6 @@ export function generateOpenAPIForRoute(
   };
 
   for (const error of route.errors) {
-    schemasToCopy.push(error.name);
     openapiPath[route.method.toLowerCase() as OpenAPIV3.HttpMethods]!.responses![error.statusCode] = {
       description:
         error.message ?? capitalize(error.name.replaceAll(/([A-Z][a-z])/g, ' $1').replace('SC ', '')),
@@ -155,7 +150,7 @@ export function generateOpenAPIForRoute(
         required: true,
         schema: {
           // TODO make this less of a hack and search copied schemas for the first occurring definition
-          $ref: `schemas/SCSearchResponse.json#/definitions/${schemaDefinition}`,
+          $ref: `schema/SCSearchResponse.json#/definitions/${schemaDefinition}`,
         },
       };
       openapiPath[route.method.toLowerCase() as OpenAPIV3.HttpMethods]?.parameters?.push(openapiParameter);

packages/core/package.json

@@ -31,7 +31,7 @@
     "README.md"
   ],
   "scripts": {
-    "build": "tsup-node --dts && pnpm run mappings && pnpm run schema",
+    "build": "tsup-node --dts && pnpm run mappings && pnpm run schema && pnpm run openapi",
     "docs": "typedoc --json ./docs/docs.json --options ../../typedoc.base.json src/index.ts",
     "format": "prettier . -c --ignore-path ../../.gitignore",
     "format:fix": "prettier --write . --ignore-path ../../.gitignore",
@@ -39,6 +39,7 @@
     "lint:fix": "eslint --fix --ext .ts src/",
     "mappings": "openstapps-es-mapping-generator mapping ../core/src -i minlength,pattern,see,tjs-format -m lib/mappings/mappings.json -a lib/mappings/aggregations.json",
     "mappings-integration": "openstapps-es-mapping-generator put-es-templates lib/mappings/mappings.json http://elasticsearch:9200/",
+    "openapi": "openstapps-core-tools openapi lib lib && node -e \"assert(JSON.parse(require('fs').readFileSync('lib/openapi.json', 'utf8')).paths['/search'] !== undefined)\"",
     "schema": "node --max-old-space-size=8192 --stack-size=10240 ./node_modules/@openstapps/core-tools/lib/app.js schema src lib/schema",
     "test": "c8 mocha"
   },

packages/easy-ast/src/easy-ast.ts

@@ -86,7 +86,7 @@ class LightweightDefinitionBuilder {
         esModuleInterop: true,
         experimentalDecorators: true,
         inlineSourceMap: true,
-        module: ts.ModuleKind.CommonJS,
+        module: ts.ModuleKind.NodeNext,
         strict: true,
         target: ts.ScriptTarget.ES2015,
       },

packages/easy-ast/src/types/lightweight-project.ts

@@ -23,7 +23,7 @@ import {LightweightDefinition} from './lightweight-definition.js';
  */
 function buildIndex(project: LightweightProject): Record<string, string> {
   return Object.fromEntries(
-    Object.values(project).flatMap((definitions, file) =>
+    Object.entries(project).flatMap(([file, definitions]) =>
       Object.keys(definitions).map(definition => [definition, file.toString()]),
     ),
   );