@twin.org/tools-core 0.0.2-next.1 → 0.0.2-next.3

package/dist/cjs/index.cjs

@@ -72,18 +72,21 @@ class JsonSchemaHelper {
      */
     static normaliseTypeName(typeName) {
         // Remove the partial markers
-        let sTypeName = typeName.replace(/^Partial<(.*?)>/g, "$1");
+        let sTypeName = typeName.replace(/^Partial<I(.*?)>/g, "$1");
         sTypeName = sTypeName.replace(/Partial%3CI(.*?)%3E/g, "$1");
         // Remove the omit markers
-        sTypeName = sTypeName.replace(/^Omit<(.*?),.*>/g, "$1");
+        sTypeName = sTypeName.replace(/^Omit<I(.*?),.*>/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<I(.*?),.*>/g, "$1");
         sTypeName = sTypeName.replace(/Pick%3CI(.*?)%2C.*%3E/g, "$1");
+        // Cleanup the generic markers
+        sTypeName = sTypeName.replace(/^(.*?)<I(.*?)>/g, "$1<$2>");
+        sTypeName = sTypeName.replace(/(.*?)%3CI(.*?)%3E/g, "$1<$2>");
         // Cleanup the unknown markers
         sTypeName = sTypeName.replace(/<unknown>/g, "");
         sTypeName = sTypeName.replace(/%3Cunknown%3E/g, "");
-        // Replace the generic markers with the base URL
+        // Replace the other url markers
         sTypeName = sTypeName.replace(/%7C/g, "|").replace(/%3C/g, "<").replace(/%3E/g, ">");
         return sTypeName;
     }
@@ -147,10 +150,13 @@ class JsonSchemaHelper {
      */
     static extractTypes(allSchemas, requiredTypes, referencedSchemas) {
         for (const typeKey of Object.keys(allSchemas)) {
-            for (const requiredType of requiredTypes) {
-                if (new RegExp(requiredType).test(typeKey) && !referencedSchemas[typeKey]) {
-                    referencedSchemas[typeKey] = allSchemas[typeKey];
-                    JsonSchemaHelper.extractTypesFromSchema(allSchemas, allSchemas[typeKey], referencedSchemas);
+            if (!referencedSchemas[typeKey]) {
+                for (const requiredType of requiredTypes) {
+                    if ((core.Is.regexp(requiredType) && new RegExp(requiredType).test(typeKey)) ||
+                        (core.Is.stringValue(requiredType) && requiredType === typeKey)) {
+                        referencedSchemas[typeKey] = allSchemas[typeKey];
+                        JsonSchemaHelper.extractTypesFromSchema(allSchemas, allSchemas[typeKey], referencedSchemas);
+                    }
                 }
             }
         }
@@ -223,4 +229,17 @@ class JsonSchemaHelper {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Helper class for OpenAPI processing.
+ */
+class OpenApiHelper {
+    /**
+     * The OpenAPI version used.
+     */
+    static API_VERSION = "3.1.1";
+}
+
 exports.JsonSchemaHelper = JsonSchemaHelper;
+exports.OpenApiHelper = OpenApiHelper;

package/dist/esm/index.mjs

@@ -70,18 +70,21 @@ class JsonSchemaHelper {
      */
     static normaliseTypeName(typeName) {
         // Remove the partial markers
-        let sTypeName = typeName.replace(/^Partial<(.*?)>/g, "$1");
+        let sTypeName = typeName.replace(/^Partial<I(.*?)>/g, "$1");
         sTypeName = sTypeName.replace(/Partial%3CI(.*?)%3E/g, "$1");
         // Remove the omit markers
-        sTypeName = sTypeName.replace(/^Omit<(.*?),.*>/g, "$1");
+        sTypeName = sTypeName.replace(/^Omit<I(.*?),.*>/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<I(.*?),.*>/g, "$1");
         sTypeName = sTypeName.replace(/Pick%3CI(.*?)%2C.*%3E/g, "$1");
+        // Cleanup the generic markers
+        sTypeName = sTypeName.replace(/^(.*?)<I(.*?)>/g, "$1<$2>");
+        sTypeName = sTypeName.replace(/(.*?)%3CI(.*?)%3E/g, "$1<$2>");
         // Cleanup the unknown markers
         sTypeName = sTypeName.replace(/<unknown>/g, "");
         sTypeName = sTypeName.replace(/%3Cunknown%3E/g, "");
-        // Replace the generic markers with the base URL
+        // Replace the other url markers
         sTypeName = sTypeName.replace(/%7C/g, "|").replace(/%3C/g, "<").replace(/%3E/g, ">");
         return sTypeName;
     }
@@ -145,10 +148,13 @@ class JsonSchemaHelper {
      */
     static extractTypes(allSchemas, requiredTypes, referencedSchemas) {
         for (const typeKey of Object.keys(allSchemas)) {
-            for (const requiredType of requiredTypes) {
-                if (new RegExp(requiredType).test(typeKey) && !referencedSchemas[typeKey]) {
-                    referencedSchemas[typeKey] = allSchemas[typeKey];
-                    JsonSchemaHelper.extractTypesFromSchema(allSchemas, allSchemas[typeKey], referencedSchemas);
+            if (!referencedSchemas[typeKey]) {
+                for (const requiredType of requiredTypes) {
+                    if ((Is.regexp(requiredType) && new RegExp(requiredType).test(typeKey)) ||
+                        (Is.stringValue(requiredType) && requiredType === typeKey)) {
+                        referencedSchemas[typeKey] = allSchemas[typeKey];
+                        JsonSchemaHelper.extractTypesFromSchema(allSchemas, allSchemas[typeKey], referencedSchemas);
+                    }
                 }
             }
         }
@@ -221,4 +227,16 @@ class JsonSchemaHelper {
     }
 }
 
-export { JsonSchemaHelper };
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Helper class for OpenAPI processing.
+ */
+class OpenApiHelper {
+    /**
+     * The OpenAPI version used.
+     */
+    static API_VERSION = "3.1.1";
+}
+
+export { JsonSchemaHelper, OpenApiHelper };

package/dist/types/index.d.ts

@@ -1,4 +1,11 @@
 export * from "./models/IJsonSchema";
+export * from "./models/IOpenApi";
+export * from "./models/IOpenApiExample";
+export * from "./models/IOpenApiHeader";
+export * from "./models/IOpenApiPathMethod";
+export * from "./models/IOpenApiResponse";
+export * from "./models/IOpenApiSecurityScheme";
 export * from "./models/IPackageJson";
 export * from "./models/jsonTypeName";
 export * from "./utils/jsonSchemaHelper";
+export * from "./utils/openApiHelper";

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

@@ -0,0 +1,54 @@
+import type { IJsonSchema } from "./IJsonSchema";
+import type { IOpenApiPathMethod } from "./IOpenApiPathMethod";
+import type { IOpenApiSecurityScheme } from "./IOpenApiSecurityScheme";
+/**
+ * The Open API config definition.
+ */
+export interface IOpenApi {
+    /**
+     * The open api version.
+     */
+    openapi: string;
+    /**
+     * Info.
+     */
+    info: {
+        title: string;
+        version: string;
+        description: string;
+        license?: {
+            name: string;
+            url: string;
+        };
+    };
+    /**
+     * The servers for the endpoints.
+     */
+    servers?: {
+        url: string;
+    }[];
+    /**
+     * Tags for the endpoints.
+     */
+    tags?: {
+        name: string;
+        description: string;
+    }[];
+    /**
+     * The paths.
+     */
+    paths: {
+        [path: string]: {
+            [method: string]: IOpenApiPathMethod;
+        };
+    };
+    /**
+     * The components.
+     */
+    components?: {
+        schemas?: IJsonSchema;
+        securitySchemes?: {
+            [name: string]: IOpenApiSecurityScheme;
+        };
+    };
+}

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

@@ -0,0 +1,13 @@
+/**
+ * The Open API config definition.
+ */
+export interface IOpenApiExample {
+    /**
+     * The summary of the example.
+     */
+    summary?: string;
+    /**
+     * The value of the example.
+     */
+    value: unknown;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * The Open API config definition.
+ */
+export interface IOpenApiHeader {
+    /**
+     * The schema of the header.
+     */
+    schema?: {
+        type: string;
+    };
+    /**
+     * The description of the header.
+     */
+    description?: string;
+    /**
+     * The format of the header.
+     */
+    format?: string;
+}

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

@@ -0,0 +1,65 @@
+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.
+ */
+export interface IOpenApiPathMethod {
+    /**
+     * The operation id.
+     */
+    operationId: string;
+    /**
+     * Summary.
+     */
+    summary: string;
+    /**
+     * Tags.
+     */
+    tags?: string[];
+    /**
+     * Parameters.
+     */
+    parameters?: {
+        name: string;
+        in: string;
+        description?: string;
+        required: boolean;
+        schema: {
+            type?: JsonTypeName | JsonTypeName[];
+            enum?: IJsonSchema[];
+            $ref?: string;
+        };
+        style?: string;
+    }[];
+    /**
+     * Request body.
+     */
+    requestBody?: {
+        required: boolean;
+        description?: string;
+        content?: {
+            [contentType: string]: {
+                schema: {
+                    $ref: string;
+                };
+                examples?: {
+                    [id: string]: IOpenApiExample;
+                };
+            };
+        };
+    };
+    /**
+     * Response body.
+     */
+    responses?: {
+        [code: string]: IOpenApiResponse;
+    };
+    /**
+     * Security model for the API.
+     */
+    security?: {
+        [name: string]: string[];
+    }[];
+}

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

@@ -0,0 +1,32 @@
+import type { IOpenApiExample } from "./IOpenApiExample";
+import type { IOpenApiHeader } from "./IOpenApiHeader";
+/**
+ * The Open API config definition.
+ */
+export interface IOpenApiResponse {
+    /**
+     * Descriptions for the response.
+     */
+    description?: string;
+    /**
+     * Content for the response.
+     */
+    content?: {
+        [contentType: string]: {
+            schema: {
+                type?: string;
+                format?: string;
+                $ref?: string;
+            };
+            examples?: {
+                [id: string]: IOpenApiExample;
+            };
+        };
+    };
+    /**
+     * The headers for the response.
+     */
+    headers?: {
+        [id: string]: IOpenApiHeader;
+    };
+}

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

@@ -0,0 +1,25 @@
+/**
+ * The Open API config definition for security scheme.
+ */
+export interface IOpenApiSecurityScheme {
+    /**
+     * The type of the security schema.
+     */
+    type?: string;
+    /**
+     * The scheme method.
+     */
+    scheme?: string;
+    /**
+     * The bearer format.
+     */
+    bearerFormat?: string;
+    /**
+     * Where is the token located.
+     */
+    in?: string;
+    /**
+     * What is the name of the token.
+     */
+    name?: string;
+}

package/dist/types/utils/jsonSchemaHelper.d.ts

@@ -11,7 +11,7 @@ export declare class JsonSchemaHelper {
      * Process arrays in the schema object.
      * @param schemaObject The schema object to process.
      */
-    static processArrays(schemaObject?: IJsonSchema): void;
+    static processArrays(schemaObject: IJsonSchema): void;
     /**
      * Process arrays in the schema object.
      * @param schemaDictionary The schema object to process.
@@ -49,7 +49,7 @@ export declare class JsonSchemaHelper {
      */
     static extractTypes(allSchemas: {
         [id: string]: IJsonSchema;
-    }, requiredTypes: string[], referencedSchemas: {
+    }, requiredTypes: (string | RegExp)[], referencedSchemas: {
         [id: string]: IJsonSchema;
     }): void;
     /**

package/dist/types/utils/openApiHelper.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Helper class for OpenAPI processing.
+ */
+export declare class OpenApiHelper {
+    /**
+     * The OpenAPI version used.
+     */
+    static readonly API_VERSION = "3.1.1";
+}

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.0.2-next.3](https://github.com/twinfoundation/tools/compare/tools-core-v0.0.2-next.2...tools-core-v0.0.2-next.3) (2025-08-05)
+
+
+### Features
+
+* improve type name normalisation ([1fe28e5](https://github.com/twinfoundation/tools/commit/1fe28e567593e46a41a833fbba95fe4cd958f525))
+
+## [0.0.2-next.2](https://github.com/twinfoundation/tools/compare/tools-core-v0.0.2-next.1...tools-core-v0.0.2-next.2) (2025-07-17)
+
+
+### Features
+
+* improve auto expand types ([6181d1d](https://github.com/twinfoundation/tools/commit/6181d1daded1f91323195cf7efbc2f1881f38b41))
+
 ## [0.0.2-next.1](https://github.com/twinfoundation/tools/compare/tools-core-v0.0.2-next.0...tools-core-v0.0.2-next.1) (2025-07-14)
 
 

package/docs/reference/classes/JsonSchemaHelper.md

@@ -24,13 +24,13 @@ The JSON Schema version used.
 
 ### processArrays()
 
-> `static` **processArrays**(`schemaObject?`): `void`
+> `static` **processArrays**(`schemaObject`): `void`
 
 Process arrays in the schema object.
 
 #### Parameters
 
-##### schemaObject?
+##### schemaObject
 
 `AnySchemaObject`
 
@@ -144,7 +144,7 @@ All the known schemas.
 
 ##### requiredTypes
 
-`string`[]
+(`string` \| `RegExp`)[]
 
 The required types.
 

package/docs/reference/classes/OpenApiHelper.md

@@ -0,0 +1,21 @@
+# Class: OpenApiHelper
+
+Helper class for OpenAPI processing.
+
+## Constructors
+
+### Constructor
+
+> **new OpenApiHelper**(): `OpenApiHelper`
+
+#### Returns
+
+`OpenApiHelper`
+
+## Properties
+
+### API\_VERSION
+
+> `readonly` `static` **API\_VERSION**: `"3.1.1"` = `"3.1.1"`
+
+The OpenAPI version used.

package/docs/reference/index.md

@@ -3,9 +3,16 @@
 ## Classes
 
 - [JsonSchemaHelper](classes/JsonSchemaHelper.md)
+- [OpenApiHelper](classes/OpenApiHelper.md)
 
 ## Interfaces
 
+- [IOpenApi](interfaces/IOpenApi.md)
+- [IOpenApiExample](interfaces/IOpenApiExample.md)
+- [IOpenApiHeader](interfaces/IOpenApiHeader.md)
+- [IOpenApiPathMethod](interfaces/IOpenApiPathMethod.md)
+- [IOpenApiResponse](interfaces/IOpenApiResponse.md)
+- [IOpenApiSecurityScheme](interfaces/IOpenApiSecurityScheme.md)
 - [IPackageJson](interfaces/IPackageJson.md)
 
 ## Type Aliases

package/docs/reference/interfaces/IOpenApi.md

@@ -0,0 +1,103 @@
+# Interface: IOpenApi
+
+The Open API config definition.
+
+## Properties
+
+### openapi
+
+> **openapi**: `string`
+
+The open api version.
+
+***
+
+### info
+
+> **info**: `object`
+
+Info.
+
+#### title
+
+> **title**: `string`
+
+#### version
+
+> **version**: `string`
+
+#### description
+
+> **description**: `string`
+
+#### license?
+
+> `optional` **license**: `object`
+
+##### license.name
+
+> **name**: `string`
+
+##### license.url
+
+> **url**: `string`
+
+***
+
+### servers?
+
+> `optional` **servers**: `object`[]
+
+The servers for the endpoints.
+
+#### url
+
+> **url**: `string`
+
+***
+
+### tags?
+
+> `optional` **tags**: `object`[]
+
+Tags for the endpoints.
+
+#### name
+
+> **name**: `string`
+
+#### description
+
+> **description**: `string`
+
+***
+
+### paths
+
+> **paths**: `object`
+
+The paths.
+
+#### Index Signature
+
+\[`path`: `string`\]: `object`
+
+***
+
+### components?
+
+> `optional` **components**: `object`
+
+The components.
+
+#### schemas?
+
+> `optional` **schemas**: `AnySchemaObject`
+
+#### securitySchemes?
+
+> `optional` **securitySchemes**: `object`
+
+##### Index Signature
+
+\[`name`: `string`\]: [`IOpenApiSecurityScheme`](IOpenApiSecurityScheme.md)

package/docs/reference/interfaces/IOpenApiExample.md

@@ -0,0 +1,19 @@
+# Interface: IOpenApiExample
+
+The Open API config definition.
+
+## Properties
+
+### summary?
+
+> `optional` **summary**: `string`
+
+The summary of the example.
+
+***
+
+### value
+
+> **value**: `unknown`
+
+The value of the example.

package/docs/reference/interfaces/IOpenApiHeader.md

@@ -0,0 +1,31 @@
+# Interface: IOpenApiHeader
+
+The Open API config definition.
+
+## Properties
+
+### schema?
+
+> `optional` **schema**: `object`
+
+The schema of the header.
+
+#### type
+
+> **type**: `string`
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+The description of the header.
+
+***
+
+### format?
+
+> `optional` **format**: `string`
+
+The format of the header.

package/docs/reference/interfaces/IOpenApiPathMethod.md

@@ -0,0 +1,119 @@
+# Interface: IOpenApiPathMethod
+
+The Open API config definition.
+
+## Properties
+
+### operationId
+
+> **operationId**: `string`
+
+The operation id.
+
+***
+
+### summary
+
+> **summary**: `string`
+
+Summary.
+
+***
+
+### tags?
+
+> `optional` **tags**: `string`[]
+
+Tags.
+
+***
+
+### parameters?
+
+> `optional` **parameters**: `object`[]
+
+Parameters.
+
+#### name
+
+> **name**: `string`
+
+#### in
+
+> **in**: `string`
+
+#### description?
+
+> `optional` **description**: `string`
+
+#### required
+
+> **required**: `boolean`
+
+#### schema
+
+> **schema**: `object`
+
+##### schema.type?
+
+> `optional` **type**: `"string"` \| `"number"` \| `"boolean"` \| `"object"` \| `"integer"` \| `"null"` \| `"array"` \| (`"string"` \| `"number"` \| `"boolean"` \| `"object"` \| `"integer"` \| `"null"` \| `"array"`)[]
+
+##### schema.enum?
+
+> `optional` **enum**: `AnySchemaObject`[]
+
+##### schema.$ref?
+
+> `optional` **$ref**: `string`
+
+#### style?
+
+> `optional` **style**: `string`
+
+***
+
+### requestBody?
+
+> `optional` **requestBody**: `object`
+
+Request body.
+
+#### required
+
+> **required**: `boolean`
+
+#### description?
+
+> `optional` **description**: `string`
+
+#### content?
+
+> `optional` **content**: `object`
+
+##### Index Signature
+
+\[`contentType`: `string`\]: `object`
+
+***
+
+### responses?
+
+> `optional` **responses**: `object`
+
+Response body.
+
+#### Index Signature
+
+\[`code`: `string`\]: [`IOpenApiResponse`](IOpenApiResponse.md)
+
+***
+
+### security?
+
+> `optional` **security**: `object`[]
+
+Security model for the API.
+
+#### Index Signature
+
+\[`name`: `string`\]: `string`[]

package/docs/reference/interfaces/IOpenApiResponse.md

@@ -0,0 +1,35 @@
+# Interface: IOpenApiResponse
+
+The Open API config definition.
+
+## Properties
+
+### description?
+
+> `optional` **description**: `string`
+
+Descriptions for the response.
+
+***
+
+### content?
+
+> `optional` **content**: `object`
+
+Content for the response.
+
+#### Index Signature
+
+\[`contentType`: `string`\]: `object`
+
+***
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers for the response.
+
+#### Index Signature
+
+\[`id`: `string`\]: [`IOpenApiHeader`](IOpenApiHeader.md)

package/docs/reference/interfaces/IOpenApiSecurityScheme.md

@@ -0,0 +1,43 @@
+# Interface: IOpenApiSecurityScheme
+
+The Open API config definition for security scheme.
+
+## Properties
+
+### type?
+
+> `optional` **type**: `string`
+
+The type of the security schema.
+
+***
+
+### scheme?
+
+> `optional` **scheme**: `string`
+
+The scheme method.
+
+***
+
+### bearerFormat?
+
+> `optional` **bearerFormat**: `string`
+
+The bearer format.
+
+***
+
+### in?
+
+> `optional` **in**: `string`
+
+Where is the token located.
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+What is the name of the token.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/tools-core",
-	"version": "0.0.2-next.1",
+	"version": "0.0.2-next.3",
 	"description": "Shared components for the tools",
 	"repository": {
 		"type": "git",