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

package/dist/cjs/index.cjs

@@ -607,6 +607,7 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
         }
     }
     const substituteSchemas = [];
+    const finalExternals = {};
     // Remove the I, < and > from names
     const finalSchemas = {};
     for (const schema in schemas) {
@@ -629,8 +630,10 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
         // If the schema is external then remove it from the final schemas
         if (core.Is.object(externalReferences)) {
             for (const external in externalReferences) {
-                if (new RegExp(`^${external}$`).test(schema)) {
+                const re = new RegExp(`^I?${external}(?<!Request|Response)$`);
+                if (re.test(schema)) {
                     skipSchema = true;
+                    finalExternals[core.StringHelper.stripPrefix(schema)] = schema.replace(re, externalReferences[external]);
                     break;
                 }
             }
@@ -695,10 +698,8 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
     // Cleanup the generic markers
     json = json.replace(/%3Cunknown%3E/g, "");
     // Remove external references
-    if (core.Is.objectValue(externalReferences)) {
-        for (const external in externalReferences) {
-            json = json.replace(new RegExp(`#/components/schemas/${core.StringHelper.stripPrefix(external)}`, "g"), externalReferences[external]);
-        }
+    for (const finalExternal in finalExternals) {
+        json = json.replace(new RegExp(`"#/components/schemas/${core.StringHelper.stripPrefix(finalExternal)}"`, "g"), `"${finalExternals[finalExternal]}"`);
     }
     cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-openapi.progress.writingOutputFile"), outputFile);
     try {
@@ -1098,15 +1099,18 @@ class CLI extends cliCore.CLIBase {
      * Run the app.
      * @param argv The process arguments.
      * @param localesDirectory The directory for the locales, default to relative to the script.
+     * @param options Additional options.
+     * @param options.overrideOutputWidth Override the output width.
      * @returns The exit code.
      */
-    async run(argv, localesDirectory) {
+    async run(argv, localesDirectory, options) {
         return this.execute({
             title: "TWIN TypeScript To OpenAPI",
             appName: "ts-to-openapi",
-            version: "0.0.1-next.3",
+            version: "0.0.1-next.6",
             icon: "⚙️ ",
-            supportsEnvFiles: false
+            supportsEnvFiles: false,
+            overrideOutputWidth: options?.overrideOutputWidth
         }, localesDirectory ?? path.join(path.dirname(node_url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)))), "../locales"), argv);
     }
     /**

package/dist/esm/index.mjs

@@ -604,6 +604,7 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
         }
     }
     const substituteSchemas = [];
+    const finalExternals = {};
     // Remove the I, < and > from names
     const finalSchemas = {};
     for (const schema in schemas) {
@@ -626,8 +627,10 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
         // If the schema is external then remove it from the final schemas
         if (Is.object(externalReferences)) {
             for (const external in externalReferences) {
-                if (new RegExp(`^${external}$`).test(schema)) {
+                const re = new RegExp(`^I?${external}(?<!Request|Response)$`);
+                if (re.test(schema)) {
                     skipSchema = true;
+                    finalExternals[StringHelper.stripPrefix(schema)] = schema.replace(re, externalReferences[external]);
                     break;
                 }
             }
@@ -692,10 +695,8 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
     // Cleanup the generic markers
     json = json.replace(/%3Cunknown%3E/g, "");
     // Remove external references
-    if (Is.objectValue(externalReferences)) {
-        for (const external in externalReferences) {
-            json = json.replace(new RegExp(`#/components/schemas/${StringHelper.stripPrefix(external)}`, "g"), externalReferences[external]);
-        }
+    for (const finalExternal in finalExternals) {
+        json = json.replace(new RegExp(`"#/components/schemas/${StringHelper.stripPrefix(finalExternal)}"`, "g"), `"${finalExternals[finalExternal]}"`);
     }
     CLIDisplay.task(I18n.formatMessage("commands.ts-to-openapi.progress.writingOutputFile"), outputFile);
     try {
@@ -1095,15 +1096,18 @@ class CLI extends CLIBase {
      * Run the app.
      * @param argv The process arguments.
      * @param localesDirectory The directory for the locales, default to relative to the script.
+     * @param options Additional options.
+     * @param options.overrideOutputWidth Override the output width.
      * @returns The exit code.
      */
-    async run(argv, localesDirectory) {
+    async run(argv, localesDirectory, options) {
         return this.execute({
             title: "TWIN TypeScript To OpenAPI",
             appName: "ts-to-openapi",
-            version: "0.0.1-next.3",
+            version: "0.0.1-next.6",
             icon: "⚙️ ",
-            supportsEnvFiles: false
+            supportsEnvFiles: false,
+            overrideOutputWidth: options?.overrideOutputWidth
         }, localesDirectory ?? path.join(path.dirname(fileURLToPath(import.meta.url)), "../locales"), argv);
     }
     /**

package/dist/locales/en.json

@@ -105,6 +105,10 @@
     "bitString": {
       "outOfRange": "The index should be >= 0 and less than the length of the bit string"
     },
+    "entitySchemaHelper": {
+      "noIsPrimary": "Property \"entitySchema.properties\" must contain a value with isPrimary set",
+      "multipleIsPrimary": "Property \"entitySchema.properties\" contains more than one property with isPrimary set"
+    },
     "fetchHelper": {
       "decodingJSON": "Decoding JSON failed for route \"{route}\"",
       "failureStatusText": "The request to the API failed: \"{statusText}\"",

package/dist/types/cli.d.ts

@@ -8,9 +8,13 @@ export declare class CLI extends CLIBase {
      * Run the app.
      * @param argv The process arguments.
      * @param localesDirectory The directory for the locales, default to relative to the script.
+     * @param options Additional options.
+     * @param options.overrideOutputWidth Override the output width.
      * @returns The exit code.
      */
-    run(argv: string[], localesDirectory?: string): Promise<number>;
+    run(argv: string[], localesDirectory?: string, options?: {
+        overrideOutputWidth?: number;
+    }): Promise<number>;
     /**
      * Configure any options or actions at the root program level.
      * @param program The root program command.

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/ts-to-openapi - Changelog
 
-## v0.0.1-next.3
+## v0.0.1-next.6
 
 - Initial Release

package/docs/reference/classes/CLI.md

@@ -24,7 +24,7 @@ The main entry point for the CLI.
 
 ### run()
 
-> **run**(`argv`, `localesDirectory`?): `Promise`\<`number`\>
+> **run**(`argv`, `localesDirectory`?, `options`?): `Promise`\<`number`\>
 
 Run the app.
 
@@ -38,6 +38,14 @@ The process arguments.
 
 The directory for the locales, default to relative to the script.
 
+• **options?**
+
+Additional options.
+
+• **options.overrideOutputWidth?**: `number`
+
+Override the output width.
+
 #### Returns
 
 `Promise`\<`number`\>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/ts-to-openapi",
-	"version": "0.0.1-next.3",
+	"version": "0.0.1-next.6",
 	"description": "Tool to convert TypeScript REST route definitions to OpenAPI Specifications",
 	"repository": {
 		"type": "git",
@@ -13,46 +13,17 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
-	"scripts": {
-		"clean": "rimraf dist coverage",
-		"build": "tspc",
-		"merge-locales": "merge-locales",
-		"test": "vitest --run --config ./vitest.config.ts --no-cache",
-		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
-		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
-		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
-		"bundle": "npm run bundle:esm && npm run bundle:cjs",
-		"docs:clean": "rimraf docs/reference",
-		"docs:generate": "typedoc",
-		"docs": "npm run docs:clean && npm run docs:generate",
-		"dist": "npm run clean && npm run build && npm run merge-locales && npm run test && npm run bundle && npm run docs"
-	},
 	"dependencies": {
 		"@twin.org/api-models": "next",
 		"@twin.org/cli-core": "next",
 		"@twin.org/core": "next",
-		"@twin.org/nameof": "0.0.1-next.3",
+		"@twin.org/nameof": "0.0.1-next.6",
 		"@twin.org/web": "next",
 		"commander": "12.1.0",
 		"glob": "11.0.0",
 		"jsonschema": "1.4.1",
 		"ts-json-schema-generator": "2.4.0-next.1"
 	},
-	"devDependencies": {
-		"@twin.org/merge-locales": "0.0.1-next.3",
-		"@twin.org/nameof-transformer": "0.0.1-next.3",
-		"@types/node": "22.5.5",
-		"@vitest/coverage-v8": "2.1.1",
-		"copyfiles": "2.4.1",
-		"rimraf": "6.0.1",
-		"rollup": "4.21.3",
-		"rollup-plugin-typescript2": "0.36.0",
-		"ts-patch": "3.2.1",
-		"typedoc": "0.26.7",
-		"typedoc-plugin-markdown": "4.2.7",
-		"typescript": "5.6.2",
-		"vitest": "2.1.1"
-	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",