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

package/dist/cjs/index.cjs

@@ -659,11 +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];
     }
-    if (finalSchemas.Uint8Array) {
-        delete finalSchemas.Uint8Array;
+    for (const type in finalSchemas) {
+        processArrays(finalSchemas[type]);
     }
     const schemaKeys = Object.keys(finalSchemas);
     schemaKeys.sort();
@@ -1098,6 +1100,59 @@ 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);
+            }
+        }
+    }
+}
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -1117,7 +1172,7 @@ class CLI extends cliCore.CLIBase {
         return this.execute({
             title: "TWIN TypeScript To OpenAPI",
             appName: "ts-to-openapi",
-            version: "0.0.1-next.25", // x-release-please-version
+            version: "0.0.1-next.27", // 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,11 +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];
     }
-    if (finalSchemas.Uint8Array) {
-        delete finalSchemas.Uint8Array;
+    for (const type in finalSchemas) {
+        processArrays(finalSchemas[type]);
     }
     const schemaKeys = Object.keys(finalSchemas);
     schemaKeys.sort();
@@ -1095,6 +1097,59 @@ 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);
+            }
+        }
+    }
+}
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -1114,7 +1169,7 @@ class CLI extends CLIBase {
         return this.execute({
             title: "TWIN TypeScript To OpenAPI",
             appName: "ts-to-openapi",
-            version: "0.0.1-next.25", // x-release-please-version
+            version: "0.0.1-next.27", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

package/dist/types/models/IJsonSchema.d.ts

@@ -1,5 +1,5 @@
-import type { JsonSchemaDraft202012Object } from "@hyperjump/json-schema/draft-2020-12";
+import type { AnySchemaObject } from "ajv/dist/2020.js";
 /**
  * Default schema type.
  */
-export type IJsonSchema = JsonSchemaDraft202012Object;
+export type IJsonSchema = AnySchemaObject;

package/dist/types/models/IOpenApiPathMethod.d.ts

@@ -1,7 +1,7 @@
-import type { Json } from "@hyperjump/json-pointer";
-import type { JsonSchemaType } from "@hyperjump/json-schema";
+import type { IJsonSchema } from "./IJsonSchema";
 import type { IOpenApiExample } from "./IOpenApiExample";
 import type { IOpenApiResponse } from "./IOpenApiResponse";
+import type { JsonTypeName } from "./jsonTypeName";
 /**
  * The Open API config definition.
  */
@@ -27,8 +27,8 @@ export interface IOpenApiPathMethod {
         description?: string;
         required: boolean;
         schema: {
-            type?: JsonSchemaType | JsonSchemaType[];
-            enum?: Json[];
+            type?: JsonTypeName | JsonTypeName[];
+            enum?: IJsonSchema[];
             $ref?: string;
         };
         style?: string;

package/dist/types/models/jsonTypeName.d.ts

@@ -0,0 +1,5 @@
+import type { JSONType } from "ajv/dist/2020.js";
+/**
+ * Default schema type.
+ */
+export type JsonTypeName = JSONType;

package/docs/changelog.md

@@ -1,5 +1,41 @@
 # @twin.org/ts-to-openapi - Changelog
 
+## [0.0.1-next.27](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.1-next.26...ts-to-openapi-v0.0.1-next.27) (2025-06-17)
+
+
+### Features
+
+* add latest json schema features ([494293f](https://github.com/twinfoundation/tools/commit/494293f4252b9c7d4a20790ec157fc9d8c96c3d2))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.26 to 0.0.1-next.27
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.1-next.26 to 0.0.1-next.27
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.26 to 0.0.1-next.27
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.26 to 0.0.1-next.27
+
+## [0.0.1-next.26](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.1-next.25...ts-to-openapi-v0.0.1-next.26) (2025-06-11)
+
+
+### Features
+
+* use most recent JSON schema specs ([4598cbf](https://github.com/twinfoundation/tools/commit/4598cbf29f7b82dba4a9f3b19f81dfe66f5a6060))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.25 to 0.0.1-next.26
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.1-next.25 to 0.0.1-next.26
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.25 to 0.0.1-next.26
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.25 to 0.0.1-next.26
+
 ## [0.0.1-next.25](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.1-next.24...ts-to-openapi-v0.0.1-next.25) (2025-06-10)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/ts-to-openapi",
-	"version": "0.0.1-next.25",
+	"version": "0.0.1-next.27",
 	"description": "Tool to convert TypeScript REST route definitions to OpenAPI Specifications",
 	"repository": {
 		"type": "git",
@@ -14,13 +14,12 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@hyperjump/json-pointer": "1.1.1",
-		"@hyperjump/json-schema": "1.14.1",
 		"@twin.org/api-models": "next",
 		"@twin.org/cli-core": "next",
 		"@twin.org/core": "next",
-		"@twin.org/nameof": "0.0.1-next.25",
+		"@twin.org/nameof": "0.0.1-next.27",
 		"@twin.org/web": "next",
+		"ajv": "8.17.1",
 		"commander": "14.0.0",
 		"glob": "11.0.2",
 		"ts-json-schema-generator": "2.4.0"