@twin.org/ts-to-openapi 0.0.1-next.9 → 0.0.2-next.1

package/dist/cjs/index.cjs

@@ -5,6 +5,7 @@ var node_url = require('node:url');
 var cliCore = require('@twin.org/cli-core');
 var promises = require('node:fs/promises');
 var core = require('@twin.org/core');
+var toolsCore = require('@twin.org/tools-core');
 var web = require('@twin.org/web');
 var tsJsonSchemaGenerator = require('ts-json-schema-generator');
 
@@ -239,7 +240,20 @@ async function tsToOpenApi(config, outputFile, workingDirectory) {
         }
     }
     cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-openapi.progress.generatingSchemas"));
-    const schemas = await generateSchemas(typeRoots, types, workingDirectory);
+    const autoExpandTypes = config.autoExpandTypes ?? [];
+    const defaultExpandTypes = ["ObjectOrArray<.*>"];
+    for (const defaultType of defaultExpandTypes) {
+        if (!autoExpandTypes.includes(defaultType)) {
+            autoExpandTypes.push(defaultType);
+        }
+    }
+    const schemas = await generateSchemas(typeRoots, types, autoExpandTypes, workingDirectory);
+    for (const type in schemas) {
+        if (core.Is.object(config.overrides?.[type])) {
+            cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-openapi.progress.overridingSchema"));
+            schemas[type] = config.overrides?.[type];
+        }
+    }
     const usedCommonResponseTypes = [];
     for (let i = 0; i < inputResults.length; i++) {
         const result = inputResults[i];
@@ -659,8 +673,13 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
             }
         }
     }
-    if (finalSchemas.HttpStatusCode) {
-        delete finalSchemas.HttpStatusCode;
+    // Remove standard types that we don't want in the final output
+    const removeTypes = ["HttpStatusCode", "Uint8Array", "ArrayBuffer"];
+    for (const type of removeTypes) {
+        delete finalSchemas[type];
+    }
+    for (const type in finalSchemas) {
+        toolsCore.JsonSchemaHelper.processArrays(finalSchemas[type]);
     }
     const schemaKeys = Object.keys(finalSchemas);
     schemaKeys.sort();
@@ -672,7 +691,7 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
         schemas: sortedSchemas,
         securitySchemes
     };
-    let json = JSON.stringify(openApi, undefined, "    ");
+    let json = JSON.stringify(openApi, undefined, "\t");
     // Remove the reference only schemas, repeating until no more substitutions
     let performedSubstitution;
     do {
@@ -693,10 +712,7 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
     // Remove the array [] from the type names
     // eslint-disable-next-line unicorn/better-regex
     json = json.replace(/#\/components\/schemas\/(.*)\[\]/g, "#/components/schemas/ListOf$1");
-    // Remove the partial markers
-    json = json.replace(/Partial%3CI(.*?)%3E/g, "$1");
-    // Cleanup the generic markers
-    json = json.replace(/%3Cunknown%3E/g, "");
+    json = toolsCore.JsonSchemaHelper.normaliseTypeName(json);
     // Remove external references
     for (const finalExternal in finalExternals) {
         json = json.replace(new RegExp(`"#/components/schemas/${core.StringHelper.stripPrefix(finalExternal)}"`, "g"), `"${finalExternals[finalExternal]}"`);
@@ -706,7 +722,7 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
         await promises.mkdir(path.dirname(outputFile), { recursive: true });
     }
     catch { }
-    await promises.writeFile(outputFile, json);
+    await promises.writeFile(outputFile, `${json}\n`);
 }
 /**
  * Build the security schemas from the config.
@@ -826,7 +842,7 @@ async function processPackageRestDetails(restRoutes) {
  * @returns Nothing.
  * @internal
  */
-async function generateSchemas(modelDirWildcards, types, outputWorkingDir) {
+async function generateSchemas(modelDirWildcards, types, autoExpandTypes, outputWorkingDir) {
     const allSchemas = {};
     const arraySingularTypes = [];
     for (const type of types) {
@@ -850,16 +866,14 @@ async function generateSchemas(modelDirWildcards, types, outputWorkingDir) {
         const schema = generator.createSchema("*");
         if (schema.definitions) {
             for (const def in schema.definitions) {
-                // Remove the partial markers
-                let defSub = def.replace(/^Partial<(.*?)>/g, "$1");
-                // Cleanup the generic markers
-                defSub = defSub.replace(/</g, "%3C").replace(/>/g, "%3E");
+                const defSub = toolsCore.JsonSchemaHelper.normaliseTypeName(def);
                 allSchemas[defSub] = schema.definitions[def];
             }
         }
     }
     const referencedSchemas = {};
-    extractTypes(allSchemas, types, referencedSchemas);
+    toolsCore.JsonSchemaHelper.extractTypes(allSchemas, [...types, ...autoExpandTypes], referencedSchemas);
+    toolsCore.JsonSchemaHelper.expandTypes(referencedSchemas, autoExpandTypes);
     for (const arraySingularType of arraySingularTypes) {
         referencedSchemas[`${arraySingularType}[]`] = {
             type: "array",
@@ -870,74 +884,6 @@ async function generateSchemas(modelDirWildcards, types, outputWorkingDir) {
     }
     return referencedSchemas;
 }
-/**
- * Extract the required types from all the known schemas.
- * @param allSchemas All the known schemas.
- * @param requiredTypes The required types.
- * @param referencedSchemas The references schemas.
- * @internal
- */
-function extractTypes(allSchemas, requiredTypes, referencedSchemas) {
-    for (const type of requiredTypes) {
-        if (allSchemas[type] && !referencedSchemas[type]) {
-            referencedSchemas[type] = allSchemas[type];
-            extractTypesFromSchema(allSchemas, allSchemas[type], referencedSchemas);
-        }
-    }
-}
-/**
- * Extract type from properties definition.
- * @param allTypes All the known types.
- * @param schema The schema to extract from.
- * @param output The output types.
- * @internal
- */
-function extractTypesFromSchema(allTypes, schema, output) {
-    const additionalTypes = [];
-    if (core.Is.stringValue(schema.$ref)) {
-        additionalTypes.push(schema.$ref.replace("#/definitions/", "").replace(/^Partial%3C(.*?)%3E/g, "$1"));
-    }
-    else if (core.Is.object(schema.items)) {
-        if (core.Is.arrayValue(schema.items)) {
-            for (const itemSchema of schema.items) {
-                extractTypesFromSchema(allTypes, itemSchema, output);
-            }
-        }
-        else {
-            extractTypesFromSchema(allTypes, schema.items, output);
-        }
-    }
-    else if (core.Is.object(schema.properties) || core.Is.object(schema.additionalProperties)) {
-        if (core.Is.object(schema.properties)) {
-            for (const prop in schema.properties) {
-                const p = schema.properties[prop];
-                if (core.Is.object(p)) {
-                    extractTypesFromSchema(allTypes, p, output);
-                }
-            }
-        }
-        if (core.Is.object(schema.additionalProperties)) {
-            extractTypesFromSchema(allTypes, schema.additionalProperties, output);
-        }
-    }
-    else if (core.Is.arrayValue(schema.anyOf)) {
-        for (const prop of schema.anyOf) {
-            if (core.Is.object(prop)) {
-                extractTypesFromSchema(allTypes, prop, output);
-            }
-        }
-    }
-    else if (core.Is.arrayValue(schema.oneOf)) {
-        for (const prop of schema.oneOf) {
-            if (core.Is.object(prop)) {
-                extractTypesFromSchema(allTypes, prop, output);
-            }
-        }
-    }
-    if (additionalTypes.length > 0) {
-        extractTypes(allTypes, additionalTypes, output);
-    }
-}
 /**
  * Tidy up the schemas for use in OpenAPI context.
  * @param props The properties to tidy up.
@@ -1107,7 +1053,7 @@ class CLI extends cliCore.CLIBase {
         return this.execute({
             title: "TWIN TypeScript To OpenAPI",
             appName: "ts-to-openapi",
-            version: "0.0.1-next.9",
+            version: "0.0.2-next.1", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

package/dist/esm/index.mjs

@@ -3,6 +3,7 @@ import { fileURLToPath } from 'node:url';
 import { CLIDisplay, CLIUtils, CLIBase } from '@twin.org/cli-core';
 import { mkdir, rm, writeFile } from 'node:fs/promises';
 import { I18n, GeneralError, Is, StringHelper, ObjectHelper } from '@twin.org/core';
+import { JsonSchemaHelper } from '@twin.org/tools-core';
 import { HttpStatusCode, MimeTypes } from '@twin.org/web';
 import { createGenerator } from 'ts-json-schema-generator';
 
@@ -236,7 +237,20 @@ async function tsToOpenApi(config, outputFile, workingDirectory) {
         }
     }
     CLIDisplay.task(I18n.formatMessage("commands.ts-to-openapi.progress.generatingSchemas"));
-    const schemas = await generateSchemas(typeRoots, types, workingDirectory);
+    const autoExpandTypes = config.autoExpandTypes ?? [];
+    const defaultExpandTypes = ["ObjectOrArray<.*>"];
+    for (const defaultType of defaultExpandTypes) {
+        if (!autoExpandTypes.includes(defaultType)) {
+            autoExpandTypes.push(defaultType);
+        }
+    }
+    const schemas = await generateSchemas(typeRoots, types, autoExpandTypes, workingDirectory);
+    for (const type in schemas) {
+        if (Is.object(config.overrides?.[type])) {
+            CLIDisplay.task(I18n.formatMessage("commands.ts-to-openapi.progress.overridingSchema"));
+            schemas[type] = config.overrides?.[type];
+        }
+    }
     const usedCommonResponseTypes = [];
     for (let i = 0; i < inputResults.length; i++) {
         const result = inputResults[i];
@@ -656,8 +670,13 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
             }
         }
     }
-    if (finalSchemas.HttpStatusCode) {
-        delete finalSchemas.HttpStatusCode;
+    // Remove standard types that we don't want in the final output
+    const removeTypes = ["HttpStatusCode", "Uint8Array", "ArrayBuffer"];
+    for (const type of removeTypes) {
+        delete finalSchemas[type];
+    }
+    for (const type in finalSchemas) {
+        JsonSchemaHelper.processArrays(finalSchemas[type]);
     }
     const schemaKeys = Object.keys(finalSchemas);
     schemaKeys.sort();
@@ -669,7 +688,7 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
         schemas: sortedSchemas,
         securitySchemes
     };
-    let json = JSON.stringify(openApi, undefined, "    ");
+    let json = JSON.stringify(openApi, undefined, "\t");
     // Remove the reference only schemas, repeating until no more substitutions
     let performedSubstitution;
     do {
@@ -690,10 +709,7 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
     // Remove the array [] from the type names
     // eslint-disable-next-line unicorn/better-regex
     json = json.replace(/#\/components\/schemas\/(.*)\[\]/g, "#/components/schemas/ListOf$1");
-    // Remove the partial markers
-    json = json.replace(/Partial%3CI(.*?)%3E/g, "$1");
-    // Cleanup the generic markers
-    json = json.replace(/%3Cunknown%3E/g, "");
+    json = JsonSchemaHelper.normaliseTypeName(json);
     // Remove external references
     for (const finalExternal in finalExternals) {
         json = json.replace(new RegExp(`"#/components/schemas/${StringHelper.stripPrefix(finalExternal)}"`, "g"), `"${finalExternals[finalExternal]}"`);
@@ -703,7 +719,7 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
         await mkdir(path.dirname(outputFile), { recursive: true });
     }
     catch { }
-    await writeFile(outputFile, json);
+    await writeFile(outputFile, `${json}\n`);
 }
 /**
  * Build the security schemas from the config.
@@ -823,7 +839,7 @@ async function processPackageRestDetails(restRoutes) {
  * @returns Nothing.
  * @internal
  */
-async function generateSchemas(modelDirWildcards, types, outputWorkingDir) {
+async function generateSchemas(modelDirWildcards, types, autoExpandTypes, outputWorkingDir) {
     const allSchemas = {};
     const arraySingularTypes = [];
     for (const type of types) {
@@ -847,16 +863,14 @@ async function generateSchemas(modelDirWildcards, types, outputWorkingDir) {
         const schema = generator.createSchema("*");
         if (schema.definitions) {
             for (const def in schema.definitions) {
-                // Remove the partial markers
-                let defSub = def.replace(/^Partial<(.*?)>/g, "$1");
-                // Cleanup the generic markers
-                defSub = defSub.replace(/</g, "%3C").replace(/>/g, "%3E");
+                const defSub = JsonSchemaHelper.normaliseTypeName(def);
                 allSchemas[defSub] = schema.definitions[def];
             }
         }
     }
     const referencedSchemas = {};
-    extractTypes(allSchemas, types, referencedSchemas);
+    JsonSchemaHelper.extractTypes(allSchemas, [...types, ...autoExpandTypes], referencedSchemas);
+    JsonSchemaHelper.expandTypes(referencedSchemas, autoExpandTypes);
     for (const arraySingularType of arraySingularTypes) {
         referencedSchemas[`${arraySingularType}[]`] = {
             type: "array",
@@ -867,74 +881,6 @@ async function generateSchemas(modelDirWildcards, types, outputWorkingDir) {
     }
     return referencedSchemas;
 }
-/**
- * Extract the required types from all the known schemas.
- * @param allSchemas All the known schemas.
- * @param requiredTypes The required types.
- * @param referencedSchemas The references schemas.
- * @internal
- */
-function extractTypes(allSchemas, requiredTypes, referencedSchemas) {
-    for (const type of requiredTypes) {
-        if (allSchemas[type] && !referencedSchemas[type]) {
-            referencedSchemas[type] = allSchemas[type];
-            extractTypesFromSchema(allSchemas, allSchemas[type], referencedSchemas);
-        }
-    }
-}
-/**
- * Extract type from properties definition.
- * @param allTypes All the known types.
- * @param schema The schema to extract from.
- * @param output The output types.
- * @internal
- */
-function extractTypesFromSchema(allTypes, schema, output) {
-    const additionalTypes = [];
-    if (Is.stringValue(schema.$ref)) {
-        additionalTypes.push(schema.$ref.replace("#/definitions/", "").replace(/^Partial%3C(.*?)%3E/g, "$1"));
-    }
-    else if (Is.object(schema.items)) {
-        if (Is.arrayValue(schema.items)) {
-            for (const itemSchema of schema.items) {
-                extractTypesFromSchema(allTypes, itemSchema, output);
-            }
-        }
-        else {
-            extractTypesFromSchema(allTypes, schema.items, output);
-        }
-    }
-    else if (Is.object(schema.properties) || Is.object(schema.additionalProperties)) {
-        if (Is.object(schema.properties)) {
-            for (const prop in schema.properties) {
-                const p = schema.properties[prop];
-                if (Is.object(p)) {
-                    extractTypesFromSchema(allTypes, p, output);
-                }
-            }
-        }
-        if (Is.object(schema.additionalProperties)) {
-            extractTypesFromSchema(allTypes, schema.additionalProperties, output);
-        }
-    }
-    else if (Is.arrayValue(schema.anyOf)) {
-        for (const prop of schema.anyOf) {
-            if (Is.object(prop)) {
-                extractTypesFromSchema(allTypes, prop, output);
-            }
-        }
-    }
-    else if (Is.arrayValue(schema.oneOf)) {
-        for (const prop of schema.oneOf) {
-            if (Is.object(prop)) {
-                extractTypesFromSchema(allTypes, prop, output);
-            }
-        }
-    }
-    if (additionalTypes.length > 0) {
-        extractTypes(allTypes, additionalTypes, output);
-    }
-}
 /**
  * Tidy up the schemas for use in OpenAPI context.
  * @param props The properties to tidy up.
@@ -1104,7 +1050,7 @@ class CLI extends CLIBase {
         return this.execute({
             title: "TWIN TypeScript To OpenAPI",
             appName: "ts-to-openapi",
-            version: "0.0.1-next.9",
+            version: "0.0.2-next.1", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth