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

package/dist/cjs/index.cjs

@@ -698,6 +698,8 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
     json = json.replace(/#\/components\/schemas\/(.*)\[\]/g, "#/components/schemas/ListOf$1");
     // Remove the partial markers
     json = json.replace(/Partial%3CI(.*?)%3E/g, "$1");
+    // Remove the omit markers
+    json = json.replace(/Omit%3CI(.*?)%2C.*%3E/g, "$1");
     // Cleanup the generic markers
     json = json.replace(/%3Cunknown%3E/g, "");
     // Remove external references
@@ -855,6 +857,8 @@ async function generateSchemas(modelDirWildcards, types, outputWorkingDir) {
             for (const def in schema.definitions) {
                 // Remove the partial markers
                 let defSub = def.replace(/^Partial<(.*?)>/g, "$1");
+                // Remove the omit markers
+                defSub = defSub.replace(/^Omit<(.*?),.*>/g, "$1");
                 // Cleanup the generic markers
                 defSub = defSub.replace(/</g, "%3C").replace(/>/g, "%3E");
                 allSchemas[defSub] = schema.definitions[def];
@@ -898,7 +902,10 @@ 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(schema.$ref
+            .replace("#/definitions/", "")
+            .replace(/^Partial%3C(.*?)%3E/g, "$1")
+            .replace(/^Omit%3C(.*?)%2C.*%3E/g, "$1"));
     }
     else if (core.Is.object(schema.items)) {
         if (core.Is.arrayValue(schema.items)) {
@@ -1110,7 +1117,7 @@ class CLI extends cliCore.CLIBase {
         return this.execute({
             title: "TWIN TypeScript To OpenAPI",
             appName: "ts-to-openapi",
-            version: "0.0.1-next.23", // x-release-please-version
+            version: "0.0.1-next.25", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

package/dist/esm/index.mjs

@@ -695,6 +695,8 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
     json = json.replace(/#\/components\/schemas\/(.*)\[\]/g, "#/components/schemas/ListOf$1");
     // Remove the partial markers
     json = json.replace(/Partial%3CI(.*?)%3E/g, "$1");
+    // Remove the omit markers
+    json = json.replace(/Omit%3CI(.*?)%2C.*%3E/g, "$1");
     // Cleanup the generic markers
     json = json.replace(/%3Cunknown%3E/g, "");
     // Remove external references
@@ -852,6 +854,8 @@ async function generateSchemas(modelDirWildcards, types, outputWorkingDir) {
             for (const def in schema.definitions) {
                 // Remove the partial markers
                 let defSub = def.replace(/^Partial<(.*?)>/g, "$1");
+                // Remove the omit markers
+                defSub = defSub.replace(/^Omit<(.*?),.*>/g, "$1");
                 // Cleanup the generic markers
                 defSub = defSub.replace(/</g, "%3C").replace(/>/g, "%3E");
                 allSchemas[defSub] = schema.definitions[def];
@@ -895,7 +899,10 @@ 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(schema.$ref
+            .replace("#/definitions/", "")
+            .replace(/^Partial%3C(.*?)%3E/g, "$1")
+            .replace(/^Omit%3C(.*?)%2C.*%3E/g, "$1"));
     }
     else if (Is.object(schema.items)) {
         if (Is.arrayValue(schema.items)) {
@@ -1107,7 +1114,7 @@ class CLI extends CLIBase {
         return this.execute({
             title: "TWIN TypeScript To OpenAPI",
             appName: "ts-to-openapi",
-            version: "0.0.1-next.23", // x-release-please-version
+            version: "0.0.1-next.25", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

package/dist/locales/en.json

@@ -70,6 +70,8 @@
 			"array": "Property \"{property}\" must be an array, it is \"{value}\"",
 			"arrayValue": "Property \"{property}\" must be an array with at least one item",
 			"arrayOneOf": "Property \"{property}\" must be one of [{options}], it is \"{value}\"",
+			"arrayStartsWith": "Property \"{property}\" must be an array starting with [{startValues}], it is \"{value}\"",
+			"arrayEndsWith": "Property \"{property}\" must be an array ending with [{endValues}], it is \"{value}\"",
 			"uint8Array": "Property \"{property}\" must be a Uint8Array, it is \"{value}\"",
 			"function": "Property \"{property}\" must be a function, it is \"{value}\"",
 			"urn": "Property \"{property}\" must be a Urn formatted string, it is \"{value}\"",

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

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

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

@@ -1,4 +1,4 @@
-import type { JSONSchema7 } from "json-schema";
+import type { IJsonSchema } from "./IJsonSchema";
 import type { IOpenApiPathMethod } from "./IOpenApiPathMethod";
 import type { IOpenApiSecurityScheme } from "./IOpenApiSecurityScheme";
 /**
@@ -46,7 +46,7 @@ export interface IOpenApi {
      * The components.
      */
     components?: {
-        schemas?: JSONSchema7;
+        schemas?: IJsonSchema;
         securitySchemes?: {
             [name: string]: IOpenApiSecurityScheme;
         };

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

@@ -1,4 +1,5 @@
-import type { JSONSchema7Type, JSONSchema7TypeName } from "json-schema";
+import type { Json } from "@hyperjump/json-pointer";
+import type { JsonSchemaType } from "@hyperjump/json-schema";
 import type { IOpenApiExample } from "./IOpenApiExample";
 import type { IOpenApiResponse } from "./IOpenApiResponse";
 /**
@@ -26,8 +27,8 @@ export interface IOpenApiPathMethod {
         description?: string;
         required: boolean;
         schema: {
-            type?: JSONSchema7TypeName | JSONSchema7TypeName[];
-            enum?: JSONSchema7Type[];
+            type?: JsonSchemaType | JsonSchemaType[];
+            enum?: Json[];
             $ref?: string;
         };
         style?: string;

package/docs/changelog.md

@@ -1,5 +1,41 @@
 # @twin.org/ts-to-openapi - Changelog
 
+## [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)
+
+
+### Features
+
+* add ts-to-schema overrides ([3c54504](https://github.com/twinfoundation/tools/commit/3c5450468eb998204a75576b7791a7ca4027da62))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.24 to 0.0.1-next.25
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.1-next.24 to 0.0.1-next.25
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.24 to 0.0.1-next.25
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.24 to 0.0.1-next.25
+
+## [0.0.1-next.24](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.1-next.23...ts-to-openapi-v0.0.1-next.24) (2025-06-05)
+
+
+### Features
+
+* strip Omit types ([3a079f9](https://github.com/twinfoundation/tools/commit/3a079f9abe8127c5b44a2b9382babf2f19629d08))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.23 to 0.0.1-next.24
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.1-next.23 to 0.0.1-next.24
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.23 to 0.0.1-next.24
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.23 to 0.0.1-next.24
+
 ## [0.0.1-next.23](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.1-next.22...ts-to-openapi-v0.0.1-next.23) (2025-06-03)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/ts-to-openapi",
-	"version": "0.0.1-next.23",
+	"version": "0.0.1-next.25",
 	"description": "Tool to convert TypeScript REST route definitions to OpenAPI Specifications",
 	"repository": {
 		"type": "git",
@@ -14,14 +14,15 @@
 		"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.23",
+		"@twin.org/nameof": "0.0.1-next.25",
 		"@twin.org/web": "next",
-		"commander": "13.1.0",
-		"glob": "11.0.1",
-		"jsonschema": "1.5.0",
+		"commander": "14.0.0",
+		"glob": "11.0.2",
 		"ts-json-schema-generator": "2.4.0"
 	},
 	"main": "./dist/cjs/index.cjs",