@twin.org/ts-to-openapi 0.0.1-next.8 → 0.0.1

package/dist/cjs/index.cjs

@@ -659,8 +659,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) {
+        processArrays(finalSchemas[type]);
     }
     const schemaKeys = Object.keys(finalSchemas);
     schemaKeys.sort();
@@ -672,7 +677,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 +698,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 = 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 +708,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.
@@ -850,10 +852,7 @@ 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 = normaliseTypeName(def);
                 allSchemas[defSub] = schema.definitions[def];
             }
         }
@@ -895,7 +894,7 @@ function extractTypes(allSchemas, requiredTypes, referencedSchemas) {
 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"));
+        additionalTypes.push(normaliseTypeName(schema.$ref).replace("#/definitions/", ""));
     }
     else if (core.Is.object(schema.items)) {
         if (core.Is.arrayValue(schema.items)) {
@@ -1088,6 +1087,79 @@ async function loadPackages(tsToOpenApiConfig, outputWorkingDir, typeRoots) {
     }
     return restRoutes;
 }
+/**
+ * Process arrays in the schema object.
+ * @param schemaObject The schema object to process.
+ */
+function processArrays(schemaObject) {
+    if (core.Is.object(schemaObject)) {
+        // latest specs have singular items in `items` property
+        // and multiple items in prefixItems, so update the schema accordingly
+        // https://www.learnjsonschema.com/2020-12/applicator/items/
+        // https://www.learnjsonschema.com/2020-12/applicator/prefixitems/
+        const schemaItems = schemaObject.items;
+        if (core.Is.array(schemaItems) || core.Is.object(schemaItems)) {
+            schemaObject.prefixItems = core.ArrayHelper.fromObjectOrArray(schemaItems);
+            delete schemaObject.items;
+        }
+        const additionalItems = schemaObject.additionalItems;
+        if (core.Is.array(additionalItems) || core.Is.object(additionalItems)) {
+            schemaObject.items = core.ArrayHelper.fromObjectOrArray(additionalItems)[0];
+            delete schemaObject.additionalItems;
+        }
+        processSchemaDictionary(schemaObject.properties);
+        processArrays(schemaObject.additionalProperties);
+        processSchemaArray(schemaObject.allOf);
+        processSchemaArray(schemaObject.anyOf);
+        processSchemaArray(schemaObject.oneOf);
+    }
+}
+/**
+ * Process arrays in the schema object.
+ * @param schemaDictionary The schema object to process.
+ */
+function processSchemaDictionary(schemaDictionary) {
+    if (core.Is.object(schemaDictionary)) {
+        for (const item of Object.values(schemaDictionary)) {
+            if (core.Is.object(item)) {
+                processArrays(item);
+            }
+        }
+    }
+}
+/**
+ * Process arrays in the schema object.
+ * @param schemaArray The schema object to process.
+ */
+function processSchemaArray(schemaArray) {
+    if (core.Is.arrayValue(schemaArray)) {
+        for (const item of schemaArray) {
+            if (core.Is.object(item)) {
+                processArrays(item);
+            }
+        }
+    }
+}
+/**
+ * Cleanup TypeScript markers from the type name.
+ * @param typeName The definition string to clean up.
+ * @returns The cleaned up definition string.
+ */
+function normaliseTypeName(typeName) {
+    // Remove the partial markers
+    let sTypeName = typeName.replace(/^Partial<(.*?)>/g, "$1");
+    sTypeName = sTypeName.replace(/Partial%3CI(.*?)%3E/g, "$1");
+    // Remove the omit markers
+    sTypeName = sTypeName.replace(/^Omit<(.*?),.*>/g, "$1");
+    sTypeName = sTypeName.replace(/Omit%3CI(.*?)%2C.*%3E/g, "$1");
+    // Remove the pick markers
+    sTypeName = sTypeName.replace(/^Pick<(.*?),.*>/g, "$1");
+    sTypeName = sTypeName.replace(/Pick%3CI(.*?)%2C.*%3E/g, "$1");
+    // Cleanup the generic markers
+    sTypeName = sTypeName.replace(/</g, "%3C").replace(/>/g, "%3E");
+    sTypeName = sTypeName.replace(/%3Cunknown%3E/g, "");
+    return sTypeName;
+}
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -1107,7 +1179,7 @@ class CLI extends cliCore.CLIBase {
         return this.execute({
             title: "TWIN TypeScript To OpenAPI",
             appName: "ts-to-openapi",
-            version: "0.0.1-next.8",
+            version: "0.0.1", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

package/dist/esm/index.mjs

@@ -2,7 +2,7 @@ import path from 'node:path';
 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 { I18n, GeneralError, Is, StringHelper, ObjectHelper, ArrayHelper } from '@twin.org/core';
 import { HttpStatusCode, MimeTypes } from '@twin.org/web';
 import { createGenerator } from 'ts-json-schema-generator';
 
@@ -656,8 +656,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) {
+        processArrays(finalSchemas[type]);
     }
     const schemaKeys = Object.keys(finalSchemas);
     schemaKeys.sort();
@@ -669,7 +674,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 +695,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 = 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 +705,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.
@@ -847,10 +849,7 @@ 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 = normaliseTypeName(def);
                 allSchemas[defSub] = schema.definitions[def];
             }
         }
@@ -892,7 +891,7 @@ function extractTypes(allSchemas, requiredTypes, referencedSchemas) {
 function extractTypesFromSchema(allTypes, schema, output) {
     const additionalTypes = [];
     if (Is.stringValue(schema.$ref)) {
-        additionalTypes.push(schema.$ref.replace("#/definitions/", "").replace(/^Partial%3C(.*?)%3E/g, "$1"));
+        additionalTypes.push(normaliseTypeName(schema.$ref).replace("#/definitions/", ""));
     }
     else if (Is.object(schema.items)) {
         if (Is.arrayValue(schema.items)) {
@@ -1085,6 +1084,79 @@ async function loadPackages(tsToOpenApiConfig, outputWorkingDir, typeRoots) {
     }
     return restRoutes;
 }
+/**
+ * Process arrays in the schema object.
+ * @param schemaObject The schema object to process.
+ */
+function processArrays(schemaObject) {
+    if (Is.object(schemaObject)) {
+        // latest specs have singular items in `items` property
+        // and multiple items in prefixItems, so update the schema accordingly
+        // https://www.learnjsonschema.com/2020-12/applicator/items/
+        // https://www.learnjsonschema.com/2020-12/applicator/prefixitems/
+        const schemaItems = schemaObject.items;
+        if (Is.array(schemaItems) || Is.object(schemaItems)) {
+            schemaObject.prefixItems = ArrayHelper.fromObjectOrArray(schemaItems);
+            delete schemaObject.items;
+        }
+        const additionalItems = schemaObject.additionalItems;
+        if (Is.array(additionalItems) || Is.object(additionalItems)) {
+            schemaObject.items = ArrayHelper.fromObjectOrArray(additionalItems)[0];
+            delete schemaObject.additionalItems;
+        }
+        processSchemaDictionary(schemaObject.properties);
+        processArrays(schemaObject.additionalProperties);
+        processSchemaArray(schemaObject.allOf);
+        processSchemaArray(schemaObject.anyOf);
+        processSchemaArray(schemaObject.oneOf);
+    }
+}
+/**
+ * Process arrays in the schema object.
+ * @param schemaDictionary The schema object to process.
+ */
+function processSchemaDictionary(schemaDictionary) {
+    if (Is.object(schemaDictionary)) {
+        for (const item of Object.values(schemaDictionary)) {
+            if (Is.object(item)) {
+                processArrays(item);
+            }
+        }
+    }
+}
+/**
+ * Process arrays in the schema object.
+ * @param schemaArray The schema object to process.
+ */
+function processSchemaArray(schemaArray) {
+    if (Is.arrayValue(schemaArray)) {
+        for (const item of schemaArray) {
+            if (Is.object(item)) {
+                processArrays(item);
+            }
+        }
+    }
+}
+/**
+ * Cleanup TypeScript markers from the type name.
+ * @param typeName The definition string to clean up.
+ * @returns The cleaned up definition string.
+ */
+function normaliseTypeName(typeName) {
+    // Remove the partial markers
+    let sTypeName = typeName.replace(/^Partial<(.*?)>/g, "$1");
+    sTypeName = sTypeName.replace(/Partial%3CI(.*?)%3E/g, "$1");
+    // Remove the omit markers
+    sTypeName = sTypeName.replace(/^Omit<(.*?),.*>/g, "$1");
+    sTypeName = sTypeName.replace(/Omit%3CI(.*?)%2C.*%3E/g, "$1");
+    // Remove the pick markers
+    sTypeName = sTypeName.replace(/^Pick<(.*?),.*>/g, "$1");
+    sTypeName = sTypeName.replace(/Pick%3CI(.*?)%2C.*%3E/g, "$1");
+    // Cleanup the generic markers
+    sTypeName = sTypeName.replace(/</g, "%3C").replace(/>/g, "%3E");
+    sTypeName = sTypeName.replace(/%3Cunknown%3E/g, "");
+    return sTypeName;
+}
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -1104,7 +1176,7 @@ class CLI extends CLIBase {
         return this.execute({
             title: "TWIN TypeScript To OpenAPI",
             appName: "ts-to-openapi",
-            version: "0.0.1-next.8",
+            version: "0.0.1", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth