@twin.org/tools-core 0.0.3-next.15 → 0.0.3-next.16

package/docs/reference/interfaces/ITypeScriptToSchemaOptions.md

@@ -0,0 +1,44 @@
+# Interface: ITypeScriptToSchemaOptions
+
+Options for TypeScript to JSON schema generation.
+
+## Properties
+
+### externalReferences? {#externalreferences}
+
+> `optional` **externalReferences?**: `object`
+
+Mapping of package ids, type ids, wildcard patterns, or regex patterns to schema id prefixes
+or replacement templates for referenced schemas.
+
+#### Index Signature
+
+\[`id`: `string`\]: `string`
+
+***
+
+### onDiagnostic? {#ondiagnostic}
+
+> `optional` **onDiagnostic?**: (`diagnostic`) => `void`
+
+Optional diagnostic callback for non-fatal generation issues.
+
+#### Parameters
+
+##### diagnostic
+
+[`ITypeScriptToSchemaDiagnostics`](ITypeScriptToSchemaDiagnostics.md)
+
+The diagnostic details for the generation issue.
+
+#### Returns
+
+`void`
+
+***
+
+### suppressPackageWarnings? {#suppresspackagewarnings}
+
+> `optional` **suppressPackageWarnings?**: `string`[]
+
+Package names where diagnostics should be suppressed, e.g. jose.

package/locales/en.json

@@ -1,3 +1,32 @@
 {
-	"error": {}
+	"error": {
+		"jsonSchemaBuilder": {
+			"invalidJsonSchemaTagKey": "Ignoring invalid @json-schema tag key \"{rawKey}\". Mapped key \"{schemaKey}\" is not supported by JSON Schema.",
+			"missingTypeReferenceSchema": "Unable to resolve type \"{typeName}\"{importSource} required as base type for utility type. Ensure the type is in the configured packages list or its external package exports TypeScript source files that can be parsed via the AST."
+		}
+	},
+	"jsonSchemaBuilder": {
+		"diagnostic": {
+			"symbolValuedProperty": "Skipping symbol-typed property \"{propertyName}\".",
+			"symbolKeyedMember": "Skipping symbol-keyed member \"{memberName}\".",
+			"unsupportedComputedPropertyName": "Skipping unsupported computed property name \"{propertyName}\".",
+			"functionTypedProperty": "Skipping function-typed property \"{propertyName}\".",
+			"unsupportedIndexSignature": "Skipping index signature with unsupported key type \"{keyType}\".",
+			"unresolvedKeyofOperand": "Could not resolve keyof operand \"{operand}\".",
+			"unmappedTypeNode": "Unsupported TypeScript type node kind \"{kind}\"; the type will be omitted.",
+			"unresolvedMappedTypeRemap": "Could not resolve mapped type key remap for \"{typeName}\"; falling back to additionalProperties.",
+			"unsupportedImportTypeForm": "Skipping unsupported import type form \"{argument}\".",
+			"unresolvedImportTypeQualifier": "Could not resolve import type qualifier for \"{argument}\".",
+			"unresolvedTypeQueryTarget": "Could not resolve type query target \"{target}\".",
+			"unsupportedInferredExpressionKind": "Skipping unsupported inferred expression kind \"{kind}\".",
+			"unsupportedInferredObjectComputedKey": "Skipping inferred object property with unsupported computed key \"{propertyName}\".",
+			"unsupportedInferredObjectSpread": "Skipping inferred object spread expression \"{expression}\".",
+			"unsupportedInferredObjectMemberKind": "Skipping inferred object member kind \"{kind}\".",
+			"unsupportedInferredTupleElement": "Skipping unsupported inferred tuple element kind \"{kind}\".",
+			"unsupportedTemplateLiteralSpan": "Could not derive a regex pattern for template literal type \"{type}\"; falling back to string.",
+			"unsupportedTypeElementMember": "Skipping unsupported type member kind \"{kind}\".",
+			"unsupportedUtilityType": "Skipping unsupported utility type \"{utilityType}\".",
+			"excludedEnclosingObjectDisallowedType": "Excluding enclosing object \"{enclosingObjectName}\" because property \"{propertyName}\" uses disallowed type \"{disallowedTypeName}\"."
+		}
+	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/tools-core",
-	"version": "0.0.3-next.15",
+	"version": "0.0.3-next.16",
 	"description": "Shared utilities and models for tooling packages",
 	"repository": {
 		"type": "git",
@@ -16,7 +16,8 @@
 	"dependencies": {
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
-		"ajv": "8.18.0"
+		"@twin.org/tools-models": "0.0.3-next.16",
+		"glob": "13.0.6"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",

package/dist/es/models/IJsonSchema.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=IJsonSchema.js.map

package/dist/es/models/IJsonSchema.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IJsonSchema.js","sourceRoot":"","sources":["../../../src/models/IJsonSchema.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { AnySchemaObject } from \"ajv/dist/2020.js\";\n\n/**\n * Default schema type.\n */\nexport type IJsonSchema = AnySchemaObject;\n"]}

package/dist/es/models/IOpenApi.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=IOpenApi.js.map

package/dist/es/models/IOpenApi.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IOpenApi.js","sourceRoot":"","sources":["../../../src/models/IOpenApi.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonSchema } from \"./IJsonSchema.js\";\nimport type { IOpenApiPathMethod } from \"./IOpenApiPathMethod.js\";\nimport type { IOpenApiSecurityScheme } from \"./IOpenApiSecurityScheme.js\";\n\n/**\n * The Open API config definition.\n */\nexport interface IOpenApi {\n\t/**\n\t * The open api version.\n\t */\n\topenapi: string;\n\n\t/**\n\t * Info.\n\t */\n\tinfo: {\n\t\ttitle: string;\n\t\tversion: string;\n\t\tdescription: string;\n\t\tlicense?: {\n\t\t\tname: string;\n\t\t\turl: string;\n\t\t};\n\t};\n\n\t/**\n\t * The servers for the endpoints.\n\t */\n\tservers?: {\n\t\turl: string;\n\t}[];\n\n\t/**\n\t * Tags for the endpoints.\n\t */\n\ttags?: {\n\t\tname: string;\n\t\tdescription: string;\n\t}[];\n\n\t/**\n\t * The paths.\n\t */\n\tpaths: {\n\t\t[path: string]: {\n\t\t\t[method: string]: IOpenApiPathMethod;\n\t\t};\n\t};\n\n\t/**\n\t * The components.\n\t */\n\tcomponents?: {\n\t\tschemas?: IJsonSchema;\n\t\tsecuritySchemes?: {\n\t\t\t[name: string]: IOpenApiSecurityScheme;\n\t\t};\n\t};\n}\n"]}

package/dist/es/models/IOpenApiExample.js

@@ -1,4 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-export {};
-//# sourceMappingURL=IOpenApiExample.js.map

package/dist/es/models/IOpenApiExample.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IOpenApiExample.js","sourceRoot":"","sources":["../../../src/models/IOpenApiExample.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The Open API config definition.\n */\nexport interface IOpenApiExample {\n\t/**\n\t * The summary of the example.\n\t */\n\tsummary?: string;\n\n\t/**\n\t * The value of the example.\n\t */\n\tvalue: unknown;\n}\n"]}

package/dist/es/models/IOpenApiHeader.js

@@ -1,4 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-export {};
-//# sourceMappingURL=IOpenApiHeader.js.map

package/dist/es/models/IOpenApiHeader.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IOpenApiHeader.js","sourceRoot":"","sources":["../../../src/models/IOpenApiHeader.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The Open API config definition.\n */\nexport interface IOpenApiHeader {\n\t/**\n\t * The schema of the header.\n\t */\n\tschema?: {\n\t\ttype: string;\n\t};\n\n\t/**\n\t * The description of the header.\n\t */\n\tdescription?: string;\n\n\t/**\n\t * The format of the header.\n\t */\n\tformat?: string;\n}\n"]}

package/dist/es/models/IOpenApiPathMethod.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=IOpenApiPathMethod.js.map

package/dist/es/models/IOpenApiPathMethod.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IOpenApiPathMethod.js","sourceRoot":"","sources":["../../../src/models/IOpenApiPathMethod.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonSchema } from \"./IJsonSchema.js\";\nimport type { IOpenApiExample } from \"./IOpenApiExample.js\";\nimport type { IOpenApiResponse } from \"./IOpenApiResponse.js\";\nimport type { JsonTypeName } from \"./jsonTypeName.js\";\n\n/**\n * The Open API config definition.\n */\nexport interface IOpenApiPathMethod {\n\t/**\n\t * The operation id.\n\t */\n\toperationId: string;\n\n\t/**\n\t * Summary.\n\t */\n\tsummary: string;\n\n\t/**\n\t * Tags.\n\t */\n\ttags?: string[];\n\n\t/**\n\t * Parameters.\n\t */\n\tparameters?: {\n\t\tname: string;\n\t\tin: string;\n\t\tdescription?: string;\n\t\trequired: boolean;\n\t\tschema: {\n\t\t\ttype?: JsonTypeName | JsonTypeName[];\n\t\t\tenum?: IJsonSchema[];\n\t\t\t$ref?: string;\n\t\t};\n\t\tstyle?: string;\n\t}[];\n\n\t/**\n\t * Request body.\n\t */\n\trequestBody?: {\n\t\trequired: boolean;\n\t\tdescription?: string;\n\t\tcontent?: {\n\t\t\t[contentType: string]: {\n\t\t\t\tschema: {\n\t\t\t\t\t$ref: string;\n\t\t\t\t};\n\t\t\t\texamples?: {\n\t\t\t\t\t[id: string]: IOpenApiExample;\n\t\t\t\t};\n\t\t\t};\n\t\t};\n\t};\n\n\t/**\n\t * Response body.\n\t */\n\tresponses?: {\n\t\t[code: string]: IOpenApiResponse;\n\t};\n\n\t/**\n\t * Security model for the API.\n\t */\n\tsecurity?: {\n\t\t[name: string]: string[];\n\t}[];\n}\n"]}

package/dist/es/models/IOpenApiResponse.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=IOpenApiResponse.js.map

package/dist/es/models/IOpenApiResponse.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IOpenApiResponse.js","sourceRoot":"","sources":["../../../src/models/IOpenApiResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IOpenApiExample } from \"./IOpenApiExample.js\";\nimport type { IOpenApiHeader } from \"./IOpenApiHeader.js\";\n\n/**\n * The Open API config definition.\n */\nexport interface IOpenApiResponse {\n\t/**\n\t * Descriptions for the response.\n\t */\n\tdescription?: string;\n\n\t/**\n\t * Content for the response.\n\t */\n\tcontent?: {\n\t\t[contentType: string]: {\n\t\t\tschema: {\n\t\t\t\ttype?: string;\n\t\t\t\tformat?: string;\n\t\t\t\t$ref?: string;\n\t\t\t};\n\t\t\texamples?: {\n\t\t\t\t[id: string]: IOpenApiExample;\n\t\t\t};\n\t\t};\n\t};\n\n\t/**\n\t * The headers for the response.\n\t */\n\theaders?: {\n\t\t[id: string]: IOpenApiHeader;\n\t};\n}\n"]}

package/dist/es/models/IOpenApiSecurityScheme.js

@@ -1,4 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-export {};
-//# sourceMappingURL=IOpenApiSecurityScheme.js.map

package/dist/es/models/IOpenApiSecurityScheme.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IOpenApiSecurityScheme.js","sourceRoot":"","sources":["../../../src/models/IOpenApiSecurityScheme.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The Open API config definition for security scheme.\n */\nexport interface IOpenApiSecurityScheme {\n\t/**\n\t * The type of the security schema.\n\t */\n\ttype?: string;\n\n\t/**\n\t * The scheme method.\n\t */\n\tscheme?: string;\n\n\t/**\n\t * The bearer format.\n\t */\n\tbearerFormat?: string;\n\n\t/**\n\t * Where is the token located.\n\t */\n\tin?: string;\n\n\t/**\n\t * What is the name of the token.\n\t */\n\tname?: string;\n}\n"]}

package/dist/es/models/IPackageJson.js

@@ -1,4 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-export {};
-//# sourceMappingURL=IPackageJson.js.map

package/dist/es/models/IPackageJson.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IPackageJson.js","sourceRoot":"","sources":["../../../src/models/IPackageJson.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Configuration for each individual package.\n */\nexport interface IPackageJson {\n\t/**\n\t * The name of the package.\n\t */\n\tname: string;\n\n\t/**\n\t * The dependencies for the package.\n\t */\n\tdependencies?: { [id: string]: string };\n}\n"]}

package/dist/es/models/jsonTypeName.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=jsonTypeName.js.map

package/dist/es/models/jsonTypeName.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"jsonTypeName.js","sourceRoot":"","sources":["../../../src/models/jsonTypeName.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { JSONType } from \"ajv/dist/2020.js\";\n\n/**\n * Default schema type.\n */\nexport type JsonTypeName = JSONType;\n"]}

package/dist/es/utils/jsonSchemaHelper.js

@@ -1,282 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-import { Is } from "@twin.org/core";
-/**
- * Helper class for JSON Schema processing.
- */
-export class JsonSchemaHelper {
-    /**
-     * The JSON Schema version used.
-     */
-    static SCHEMA_VERSION = "https://json-schema.org/draft/2020-12/schema";
-    /**
-     * Process arrays in the schema object.
-     * @param schemaObject The schema object to process.
-     */
-    static processArrays(schemaObject) {
-        if (Is.object(schemaObject)) {
-            // new json schema version has prefixItems instead of items for arrays with fixed ordering
-            // so convert any old style schemas that use items as an array
-            // prefixItems validates fixed positions and is an array
-            // items validates the rest and is an object
-            // additionalItems no longer exists
-            // https://www.learnjsonschema.com/2020-12/applicator/items/
-            // https://www.learnjsonschema.com/2020-12/applicator/prefixitems/
-            if (Is.array(schemaObject.items)) {
-                if (Is.object(schemaObject.additionalItems)) {
-                    // If the items are an array then this is fixed ordering
-                    // so move to prefixItems and then do the same for additionalItems
-                    schemaObject.prefixItems = schemaObject.items;
-                    delete schemaObject.items;
-                    schemaObject.items = schemaObject.additionalItems;
-                }
-                else if (Is.integer(schemaObject.minItems) &&
-                    Is.integer(schemaObject.maxItems) &&
-                    schemaObject.minItems === schemaObject.maxItems &&
-                    schemaObject.maxItems === schemaObject.items.length) {
-                    // There is a fixed number of items which matches the items array length
-                    // so move construct an allOf to enforce the fixed length
-                    schemaObject.items = { allOf: schemaObject.items };
-                    delete schemaObject.minItems;
-                    delete schemaObject.maxItems;
-                }
-                else {
-                    // no additional items so wrap in an anyOf
-                    schemaObject.items = { anyOf: schemaObject.items };
-                }
-            }
-            // We can't use additionalItems in the new schema version
-            // so just remove it after processing
-            delete schemaObject.additionalItems;
-            // Since we are generating JSON-LD schemas we need to support
-            // additional properties to allow for object expansion
-            // but don't change anything that has specific additional properties defined
-            if (schemaObject.additionalProperties === false) {
-                delete schemaObject.additionalProperties;
-            }
-            JsonSchemaHelper.processSchemaDictionary(schemaObject.properties);
-            JsonSchemaHelper.processArrays(schemaObject.additionalProperties);
-            JsonSchemaHelper.processSchemaArray(schemaObject.allOf);
-            JsonSchemaHelper.processSchemaArray(schemaObject.anyOf);
-            JsonSchemaHelper.processSchemaArray(schemaObject.oneOf);
-            if (Is.stringValue(schemaObject.$ref)) {
-                schemaObject.$ref = JsonSchemaHelper.normaliseTypeName(schemaObject.$ref);
-            }
-        }
-    }
-    /**
-     * Process arrays in the schema object.
-     * @param schemaDictionary The schema object to process.
-     */
-    static processSchemaDictionary(schemaDictionary) {
-        if (Is.object(schemaDictionary)) {
-            for (const item of Object.values(schemaDictionary)) {
-                if (Is.object(item)) {
-                    JsonSchemaHelper.processArrays(item);
-                }
-            }
-        }
-    }
-    /**
-     * Process arrays in the schema object.
-     * @param schemaArray The schema object to process.
-     */
-    static processSchemaArray(schemaArray) {
-        if (Is.arrayValue(schemaArray)) {
-            const seenSignatures = new Set();
-            for (const item of schemaArray) {
-                if (Is.object(item)) {
-                    const signature = JSON.stringify(item);
-                    // There is a bug in JSON schema generator where spread tuple produce the same output
-                    // e.g. [typeA, ...typeB] and [...typeA, typeB] can produce the same items schema
-                    // in the legacy shape { items: { typeA }, additionalItems: [typeB] }.
-                    // For duplicate signatures we normalize one entry to the alternate approximation
-                    // so we don't emit identical duplicated anyOf/oneOf branches.
-                    if (seenSignatures.has(signature) &&
-                        Is.array(item.items) &&
-                        Is.object(item.additionalItems)) {
-                        const originalItems = item.items;
-                        item.items = [item.additionalItems];
-                        item.additionalItems = originalItems[0];
-                    }
-                    seenSignatures.add(signature);
-                    JsonSchemaHelper.processArrays(item);
-                }
-            }
-        }
-    }
-    /**
-     * Cleanup TypeScript markers from the type name.
-     * @param typeName The definition string to clean up.
-     * @returns The cleaned up definition string.
-     */
-    static normaliseTypeName(typeName) {
-        // Remove the partial markers
-        let sTypeName = typeName.replace(/^Partial<I(.*?)>/g, "$1");
-        sTypeName = sTypeName.replace(/Partial%3CI(.*?)%3E/g, "$1");
-        // Remove the omit markers
-        sTypeName = sTypeName.replace(/^Omit<I(.*?),.*>/g, "$1");
-        sTypeName = sTypeName.replace(/Omit%3CI(.*?)%2C.*%3E/g, "$1");
-        // Remove the pick markers
-        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 other url markers
-        sTypeName = sTypeName.replace(/%7C/g, "|").replace(/%3C/g, "<").replace(/%3E/g, ">");
-        return sTypeName;
-    }
-    /**
-     * Extract type from properties definition.
-     * @param allTypes All the known types.
-     * @param schema The schema to extract from.
-     * @param output The output types.
-     */
-    static extractTypesFromSchema(allTypes, schema, output) {
-        const additionalTypes = [];
-        if (Is.stringValue(schema.$ref)) {
-            additionalTypes.push(JsonSchemaHelper.normaliseTypeName(schema.$ref.replace("#/definitions/", "")));
-        }
-        else if (Is.object(schema.items)) {
-            if (Is.arrayValue(schema.items)) {
-                for (const itemSchema of schema.items) {
-                    JsonSchemaHelper.extractTypesFromSchema(allTypes, itemSchema, output);
-                }
-            }
-            else {
-                JsonSchemaHelper.extractTypesFromSchema(allTypes, schema.items, output);
-            }
-        }
-        else if (Is.object(schema.properties) || Is.object(schema.additionalProperties)) {
-            if (Is.object(schema.properties)) {
-                for (const prop in schema.properties) {
-                    const p = schema.properties[prop];
-                    if (Is.object(p)) {
-                        JsonSchemaHelper.extractTypesFromSchema(allTypes, p, output);
-                    }
-                }
-            }
-            if (Is.object(schema.additionalProperties)) {
-                JsonSchemaHelper.extractTypesFromSchema(allTypes, schema.additionalProperties, output);
-            }
-        }
-        else if (Is.arrayValue(schema.anyOf)) {
-            for (const prop of schema.anyOf) {
-                if (Is.object(prop)) {
-                    JsonSchemaHelper.extractTypesFromSchema(allTypes, prop, output);
-                }
-            }
-        }
-        else if (Is.arrayValue(schema.oneOf)) {
-            for (const prop of schema.oneOf) {
-                if (Is.object(prop)) {
-                    JsonSchemaHelper.extractTypesFromSchema(allTypes, prop, output);
-                }
-            }
-        }
-        if (additionalTypes.length > 0) {
-            JsonSchemaHelper.extractTypes(allTypes, additionalTypes, output);
-        }
-    }
-    /**
-     * Extract the required types from all the known schemas.
-     * @param allSchemas All the known schemas.
-     * @param requiredTypes The required types.
-     * @param referencedSchemas The references schemas.
-     */
-    static extractTypes(allSchemas, requiredTypes, referencedSchemas) {
-        for (const typeKey of Object.keys(allSchemas)) {
-            if (!referencedSchemas[typeKey]) {
-                for (const requiredType of requiredTypes) {
-                    const regex = JsonSchemaHelper.stringToRegEx(requiredType);
-                    if (regex.test(typeKey)) {
-                        referencedSchemas[typeKey] = allSchemas[typeKey];
-                        JsonSchemaHelper.extractTypesFromSchema(allSchemas, allSchemas[typeKey], referencedSchemas);
-                    }
-                }
-            }
-        }
-    }
-    /**
-     * Expand the types inline.
-     * @param schemas The schemas to include the expanded types.
-     * @param expandedTypes The types to expand.
-     */
-    static expandTypes(schemas, expandedTypes) {
-        for (const typeKey of Object.keys(schemas)) {
-            const schema = schemas[typeKey];
-            JsonSchemaHelper.expandSchemaTypes(schemas, schema, expandedTypes);
-        }
-    }
-    /**
-     * Expand the types inline.
-     * @param allSchemas All the known schemas.
-     * @param schema The schemas to include the expanded types.
-     * @param expandedTypes The types to expand.
-     */
-    static expandSchemaTypes(allSchemas, schema, expandedTypes) {
-        if (Is.stringValue(schema.$ref)) {
-            for (const expandedType of expandedTypes) {
-                const typeName = JsonSchemaHelper.normaliseTypeName(schema.$ref.replace("#/definitions/", ""));
-                const regex = JsonSchemaHelper.stringToRegEx(expandedType);
-                if (regex.test(typeName) && allSchemas[typeName]) {
-                    delete schema.$ref;
-                    Object.assign(schema, allSchemas[typeName]);
-                    break;
-                }
-            }
-        }
-        else if (Is.object(schema.items)) {
-            if (Is.arrayValue(schema.items)) {
-                for (const itemSchema of schema.items) {
-                    JsonSchemaHelper.expandSchemaTypes(allSchemas, itemSchema, expandedTypes);
-                }
-            }
-            else {
-                JsonSchemaHelper.expandSchemaTypes(allSchemas, schema.items, expandedTypes);
-            }
-        }
-        else if (Is.object(schema.properties) || Is.object(schema.additionalProperties)) {
-            if (Is.object(schema.properties)) {
-                for (const prop in schema.properties) {
-                    const p = schema.properties[prop];
-                    if (Is.object(p)) {
-                        JsonSchemaHelper.expandSchemaTypes(allSchemas, p, expandedTypes);
-                    }
-                }
-            }
-            if (Is.object(schema.additionalProperties)) {
-                JsonSchemaHelper.expandSchemaTypes(allSchemas, schema.additionalProperties, expandedTypes);
-            }
-        }
-        else if (Is.arrayValue(schema.anyOf)) {
-            for (const prop of schema.anyOf) {
-                if (Is.object(prop)) {
-                    JsonSchemaHelper.expandSchemaTypes(allSchemas, prop, expandedTypes);
-                }
-            }
-        }
-        else if (Is.arrayValue(schema.oneOf)) {
-            for (const prop of schema.oneOf) {
-                if (Is.object(prop)) {
-                    JsonSchemaHelper.expandSchemaTypes(allSchemas, prop, expandedTypes);
-                }
-            }
-        }
-    }
-    /**
-     * Convert a string pattern to a regular expression.
-     * @param matchPattern The pattern to convert.
-     * @returns The regular expression.
-     */
-    static stringToRegEx(matchPattern) {
-        return matchPattern.startsWith("/") && matchPattern.endsWith("/")
-            ? new RegExp(matchPattern.slice(1, -1))
-            : new RegExp(`^${matchPattern}$`);
-    }
-}
-//# sourceMappingURL=jsonSchemaHelper.js.map

package/dist/es/utils/jsonSchemaHelper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"jsonSchemaHelper.js","sourceRoot":"","sources":["../../../src/utils/jsonSchemaHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAGpC;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAC5B;;OAEG;IACI,MAAM,CAAU,cAAc,GAAG,8CAA8C,CAAC;IAEvF;;;OAGG;IACI,MAAM,CAAC,aAAa,CAAC,YAAyB;QACpD,IAAI,EAAE,CAAC,MAAM,CAAc,YAAY,CAAC,EAAE,CAAC;YAC1C,0FAA0F;YAC1F,8DAA8D;YAC9D,wDAAwD;YACxD,4CAA4C;YAC5C,mCAAmC;YACnC,4DAA4D;YAC5D,kEAAkE;YAClE,IAAI,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClC,IAAI,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,eAAe,CAAC,EAAE,CAAC;oBAC7C,wDAAwD;oBACxD,kEAAkE;oBAClE,YAAY,CAAC,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC;oBAC9C,OAAO,YAAY,CAAC,KAAK,CAAC;oBAC1B,YAAY,CAAC,KAAK,GAAG,YAAY,CAAC,eAAe,CAAC;gBACnD,CAAC;qBAAM,IACN,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC;oBACjC,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC;oBACjC,YAAY,CAAC,QAAQ,KAAK,YAAY,CAAC,QAAQ;oBAC/C,YAAY,CAAC,QAAQ,KAAK,YAAY,CAAC,KAAK,CAAC,MAAM,EAClD,CAAC;oBACF,wEAAwE;oBACxE,yDAAyD;oBACzD,YAAY,CAAC,KAAK,GAAG,EAAE,KAAK,EAAE,YAAY,CAAC,KAAK,EAAE,CAAC;oBACnD,OAAO,YAAY,CAAC,QAAQ,CAAC;oBAC7B,OAAO,YAAY,CAAC,QAAQ,CAAC;gBAC9B,CAAC;qBAAM,CAAC;oBACP,0CAA0C;oBAC1C,YAAY,CAAC,KAAK,GAAG,EAAE,KAAK,EAAE,YAAY,CAAC,KAAK,EAAE,CAAC;gBACpD,CAAC;YACF,CAAC;YAED,yDAAyD;YACzD,qCAAqC;YACrC,OAAO,YAAY,CAAC,eAAe,CAAC;YAEpC,6DAA6D;YAC7D,sDAAsD;YACtD,4EAA4E;YAC5E,IAAI,YAAY,CAAC,oBAAoB,KAAK,KAAK,EAAE,CAAC;gBACjD,OAAO,YAAY,CAAC,oBAAoB,CAAC;YAC1C,CAAC;YAED,gBAAgB,CAAC,uBAAuB,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YAClE,gBAAgB,CAAC,aAAa,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC;YAClE,gBAAgB,CAAC,kBAAkB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACxD,gBAAgB,CAAC,kBAAkB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACxD,gBAAgB,CAAC,kBAAkB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAExD,IAAI,EAAE,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvC,YAAY,CAAC,IAAI,GAAG,gBAAgB,CAAC,iBAAiB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YAC3E,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,uBAAuB,CAAC,gBAAiD;QACtF,IAAI,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACjC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBACpD,IAAI,EAAE,CAAC,MAAM,CAAc,IAAI,CAAC,EAAE,CAAC;oBAClC,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;gBACtC,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,WAA2B;QAC3D,IAAI,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAChC,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;YACzC,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;gBAChC,IAAI,EAAE,CAAC,MAAM,CAAc,IAAI,CAAC,EAAE,CAAC;oBAClC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;oBACvC,qFAAqF;oBACrF,iFAAiF;oBACjF,sEAAsE;oBACtE,iFAAiF;oBACjF,8DAA8D;oBAC9D,IACC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC;wBAC7B,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;wBACpB,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,EAC9B,CAAC;wBACF,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC;wBACjC,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;wBACpC,IAAI,CAAC,eAAe,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;oBACzC,CAAC;oBACD,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;oBAC9B,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;gBACtC,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,QAAgB;QAC/C,6BAA6B;QAC7B,IAAI,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;QAC5D,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;QAE5D,0BAA0B;QAC1B,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;QACzD,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAC;QAE9D,0BAA0B;QAC1B,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;QACzD,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAC;QAE9D,8BAA8B;QAC9B,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QAC3D,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAC;QAE9D,8BAA8B;QAC9B,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QAChD,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;QAEpD,gCAAgC;QAChC,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAErF,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,sBAAsB,CACnC,QAAuC,EACvC,MAAmB,EACnB,MAAqC;QAErC,MAAM,eAAe,GAAG,EAAE,CAAC;QAE3B,IAAI,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,eAAe,CAAC,IAAI,CACnB,gBAAgB,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,CAC7E,CAAC;QACH,CAAC;aAAM,IAAI,EAAE,CAAC,MAAM,CAAc,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACjD,IAAI,EAAE,CAAC,UAAU,CAAc,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9C,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;oBACvC,gBAAgB,CAAC,sBAAsB,CAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;gBACvE,CAAC;YACF,CAAC;iBAAM,CAAC;gBACP,gBAAgB,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACzE,CAAC;QACF,CAAC;aAAM,IAAI,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,EAAE,CAAC;YACnF,IAAI,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;gBAClC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;oBACtC,MAAM,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;oBAClC,IAAI,EAAE,CAAC,MAAM,CAAc,CAAC,CAAC,EAAE,CAAC;wBAC/B,gBAAgB,CAAC,sBAAsB,CAAC,QAAQ,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;oBAC9D,CAAC;gBACF,CAAC;YACF,CAAC;YACD,IAAI,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,EAAE,CAAC;gBAC5C,gBAAgB,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;YACxF,CAAC;QACF,CAAC;aAAM,IAAI,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjC,IAAI,EAAE,CAAC,MAAM,CAAc,IAAI,CAAC,EAAE,CAAC;oBAClC,gBAAgB,CAAC,sBAAsB,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;gBACjE,CAAC;YACF,CAAC;QACF,CAAC;aAAM,IAAI,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjC,IAAI,EAAE,CAAC,MAAM,CAAc,IAAI,CAAC,EAAE,CAAC;oBAClC,gBAAgB,CAAC,sBAAsB,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;gBACjE,CAAC;YACF,CAAC;QACF,CAAC;QAED,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,gBAAgB,CAAC,YAAY,CAAC,QAAQ,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;QAClE,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,YAAY,CACzB,UAAyC,EACzC,aAAuB,EACvB,iBAAgD;QAEhD,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/C,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAAE,CAAC;gBACjC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;oBAC1C,MAAM,KAAK,GAAG,gBAAgB,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;oBAE3D,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;wBACzB,iBAAiB,CAAC,OAAO,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;wBACjD,gBAAgB,CAAC,sBAAsB,CACtC,UAAU,EACV,UAAU,CAAC,OAAO,CAAC,EACnB,iBAAiB,CACjB,CAAC;oBACH,CAAC;gBACF,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,WAAW,CAAC,OAAsC,EAAE,aAAuB;QACxF,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5C,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;YAEhC,gBAAgB,CAAC,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;QACpE,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,iBAAiB,CAC9B,UAAyC,EACzC,MAAmB,EACnB,aAAuB;QAEvB,IAAI,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;gBAC1C,MAAM,QAAQ,GAAG,gBAAgB,CAAC,iBAAiB,CAClD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CACzC,CAAC;gBACF,MAAM,KAAK,GAAG,gBAAgB,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;gBAC3D,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAClD,OAAO,MAAM,CAAC,IAAI,CAAC;oBACnB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;oBAC5C,MAAM;gBACP,CAAC;YACF,CAAC;QACF,CAAC;aAAM,IAAI,EAAE,CAAC,MAAM,CAAc,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACjD,IAAI,EAAE,CAAC,UAAU,CAAc,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9C,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;oBACvC,gBAAgB,CAAC,iBAAiB,CAAC,UAAU,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;gBAC3E,CAAC;YACF,CAAC;iBAAM,CAAC;gBACP,gBAAgB,CAAC,iBAAiB,CAAC,UAAU,EAAE,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;YAC7E,CAAC;QACF,CAAC;aAAM,IAAI,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,EAAE,CAAC;YACnF,IAAI,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;gBAClC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;oBACtC,MAAM,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;oBAClC,IAAI,EAAE,CAAC,MAAM,CAAc,CAAC,CAAC,EAAE,CAAC;wBAC/B,gBAAgB,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC,EAAE,aAAa,CAAC,CAAC;oBAClE,CAAC;gBACF,CAAC;YACF,CAAC;YACD,IAAI,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,EAAE,CAAC;gBAC5C,gBAAgB,CAAC,iBAAiB,CAAC,UAAU,EAAE,MAAM,CAAC,oBAAoB,EAAE,aAAa,CAAC,CAAC;YAC5F,CAAC;QACF,CAAC;aAAM,IAAI,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjC,IAAI,EAAE,CAAC,MAAM,CAAc,IAAI,CAAC,EAAE,CAAC;oBAClC,gBAAgB,CAAC,iBAAiB,CAAC,UAAU,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;gBACrE,CAAC;YACF,CAAC;QACF,CAAC;aAAM,IAAI,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjC,IAAI,EAAE,CAAC,MAAM,CAAc,IAAI,CAAC,EAAE,CAAC;oBAClC,gBAAgB,CAAC,iBAAiB,CAAC,UAAU,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;gBACrE,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,YAAoB;QAC/C,OAAO,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC;YAChE,CAAC,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACvC,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,YAAY,GAAG,CAAC,CAAC;IACpC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Is } from \"@twin.org/core\";\nimport type { IJsonSchema } from \"../models/IJsonSchema.js\";\n\n/**\n * Helper class for JSON Schema processing.\n */\nexport class JsonSchemaHelper {\n\t/**\n\t * The JSON Schema version used.\n\t */\n\tpublic static readonly SCHEMA_VERSION = \"https://json-schema.org/draft/2020-12/schema\";\n\n\t/**\n\t * Process arrays in the schema object.\n\t * @param schemaObject The schema object to process.\n\t */\n\tpublic static processArrays(schemaObject: IJsonSchema): void {\n\t\tif (Is.object<IJsonSchema>(schemaObject)) {\n\t\t\t// new json schema version has prefixItems instead of items for arrays with fixed ordering\n\t\t\t// so convert any old style schemas that use items as an array\n\t\t\t// prefixItems validates fixed positions and is an array\n\t\t\t// items validates the rest and is an object\n\t\t\t// additionalItems no longer exists\n\t\t\t// https://www.learnjsonschema.com/2020-12/applicator/items/\n\t\t\t// https://www.learnjsonschema.com/2020-12/applicator/prefixitems/\n\t\t\tif (Is.array(schemaObject.items)) {\n\t\t\t\tif (Is.object(schemaObject.additionalItems)) {\n\t\t\t\t\t// If the items are an array then this is fixed ordering\n\t\t\t\t\t// so move to prefixItems and then do the same for additionalItems\n\t\t\t\t\tschemaObject.prefixItems = schemaObject.items;\n\t\t\t\t\tdelete schemaObject.items;\n\t\t\t\t\tschemaObject.items = schemaObject.additionalItems;\n\t\t\t\t} else if (\n\t\t\t\t\tIs.integer(schemaObject.minItems) &&\n\t\t\t\t\tIs.integer(schemaObject.maxItems) &&\n\t\t\t\t\tschemaObject.minItems === schemaObject.maxItems &&\n\t\t\t\t\tschemaObject.maxItems === schemaObject.items.length\n\t\t\t\t) {\n\t\t\t\t\t// There is a fixed number of items which matches the items array length\n\t\t\t\t\t// so move construct an allOf to enforce the fixed length\n\t\t\t\t\tschemaObject.items = { allOf: schemaObject.items };\n\t\t\t\t\tdelete schemaObject.minItems;\n\t\t\t\t\tdelete schemaObject.maxItems;\n\t\t\t\t} else {\n\t\t\t\t\t// no additional items so wrap in an anyOf\n\t\t\t\t\tschemaObject.items = { anyOf: schemaObject.items };\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// We can't use additionalItems in the new schema version\n\t\t\t// so just remove it after processing\n\t\t\tdelete schemaObject.additionalItems;\n\n\t\t\t// Since we are generating JSON-LD schemas we need to support\n\t\t\t// additional properties to allow for object expansion\n\t\t\t// but don't change anything that has specific additional properties defined\n\t\t\tif (schemaObject.additionalProperties === false) {\n\t\t\t\tdelete schemaObject.additionalProperties;\n\t\t\t}\n\n\t\t\tJsonSchemaHelper.processSchemaDictionary(schemaObject.properties);\n\t\t\tJsonSchemaHelper.processArrays(schemaObject.additionalProperties);\n\t\t\tJsonSchemaHelper.processSchemaArray(schemaObject.allOf);\n\t\t\tJsonSchemaHelper.processSchemaArray(schemaObject.anyOf);\n\t\t\tJsonSchemaHelper.processSchemaArray(schemaObject.oneOf);\n\n\t\t\tif (Is.stringValue(schemaObject.$ref)) {\n\t\t\t\tschemaObject.$ref = JsonSchemaHelper.normaliseTypeName(schemaObject.$ref);\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Process arrays in the schema object.\n\t * @param schemaDictionary The schema object to process.\n\t */\n\tpublic static processSchemaDictionary(schemaDictionary?: { [key: string]: IJsonSchema }): void {\n\t\tif (Is.object(schemaDictionary)) {\n\t\t\tfor (const item of Object.values(schemaDictionary)) {\n\t\t\t\tif (Is.object<IJsonSchema>(item)) {\n\t\t\t\t\tJsonSchemaHelper.processArrays(item);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Process arrays in the schema object.\n\t * @param schemaArray The schema object to process.\n\t */\n\tpublic static processSchemaArray(schemaArray?: IJsonSchema[]): void {\n\t\tif (Is.arrayValue(schemaArray)) {\n\t\t\tconst seenSignatures = new Set<string>();\n\t\t\tfor (const item of schemaArray) {\n\t\t\t\tif (Is.object<IJsonSchema>(item)) {\n\t\t\t\t\tconst signature = JSON.stringify(item);\n\t\t\t\t\t// There is a bug in JSON schema generator where spread tuple produce the same output\n\t\t\t\t\t// e.g. [typeA, ...typeB] and [...typeA, typeB] can produce the same items schema\n\t\t\t\t\t// in the legacy shape { items: { typeA }, additionalItems: [typeB] }.\n\t\t\t\t\t// For duplicate signatures we normalize one entry to the alternate approximation\n\t\t\t\t\t// so we don't emit identical duplicated anyOf/oneOf branches.\n\t\t\t\t\tif (\n\t\t\t\t\t\tseenSignatures.has(signature) &&\n\t\t\t\t\t\tIs.array(item.items) &&\n\t\t\t\t\t\tIs.object(item.additionalItems)\n\t\t\t\t\t) {\n\t\t\t\t\t\tconst originalItems = item.items;\n\t\t\t\t\t\titem.items = [item.additionalItems];\n\t\t\t\t\t\titem.additionalItems = originalItems[0];\n\t\t\t\t\t}\n\t\t\t\t\tseenSignatures.add(signature);\n\t\t\t\t\tJsonSchemaHelper.processArrays(item);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Cleanup TypeScript markers from the type name.\n\t * @param typeName The definition string to clean up.\n\t * @returns The cleaned up definition string.\n\t */\n\tpublic static normaliseTypeName(typeName: string): string {\n\t\t// Remove the partial markers\n\t\tlet sTypeName = typeName.replace(/^Partial<I(.*?)>/g, \"$1\");\n\t\tsTypeName = sTypeName.replace(/Partial%3CI(.*?)%3E/g, \"$1\");\n\n\t\t// Remove the omit markers\n\t\tsTypeName = sTypeName.replace(/^Omit<I(.*?),.*>/g, \"$1\");\n\t\tsTypeName = sTypeName.replace(/Omit%3CI(.*?)%2C.*%3E/g, \"$1\");\n\n\t\t// Remove the pick markers\n\t\tsTypeName = sTypeName.replace(/^Pick<I(.*?),.*>/g, \"$1\");\n\t\tsTypeName = sTypeName.replace(/Pick%3CI(.*?)%2C.*%3E/g, \"$1\");\n\n\t\t// Cleanup the generic markers\n\t\tsTypeName = sTypeName.replace(/^(.*?)<I(.*?)>/g, \"$1<$2>\");\n\t\tsTypeName = sTypeName.replace(/(.*?)%3CI(.*?)%3E/g, \"$1<$2>\");\n\n\t\t// Cleanup the unknown markers\n\t\tsTypeName = sTypeName.replace(/<unknown>/g, \"\");\n\t\tsTypeName = sTypeName.replace(/%3Cunknown%3E/g, \"\");\n\n\t\t// Replace the other url markers\n\t\tsTypeName = sTypeName.replace(/%7C/g, \"|\").replace(/%3C/g, \"<\").replace(/%3E/g, \">\");\n\n\t\treturn sTypeName;\n\t}\n\n\t/**\n\t * Extract type from properties definition.\n\t * @param allTypes All the known types.\n\t * @param schema The schema to extract from.\n\t * @param output The output types.\n\t */\n\tpublic static extractTypesFromSchema(\n\t\tallTypes: { [id: string]: IJsonSchema },\n\t\tschema: IJsonSchema,\n\t\toutput: { [id: string]: IJsonSchema }\n\t): void {\n\t\tconst additionalTypes = [];\n\n\t\tif (Is.stringValue(schema.$ref)) {\n\t\t\tadditionalTypes.push(\n\t\t\t\tJsonSchemaHelper.normaliseTypeName(schema.$ref.replace(\"#/definitions/\", \"\"))\n\t\t\t);\n\t\t} else if (Is.object<IJsonSchema>(schema.items)) {\n\t\t\tif (Is.arrayValue<IJsonSchema>(schema.items)) {\n\t\t\t\tfor (const itemSchema of schema.items) {\n\t\t\t\t\tJsonSchemaHelper.extractTypesFromSchema(allTypes, itemSchema, output);\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tJsonSchemaHelper.extractTypesFromSchema(allTypes, schema.items, output);\n\t\t\t}\n\t\t} else if (Is.object(schema.properties) || Is.object(schema.additionalProperties)) {\n\t\t\tif (Is.object(schema.properties)) {\n\t\t\t\tfor (const prop in schema.properties) {\n\t\t\t\t\tconst p = schema.properties[prop];\n\t\t\t\t\tif (Is.object<IJsonSchema>(p)) {\n\t\t\t\t\t\tJsonSchemaHelper.extractTypesFromSchema(allTypes, p, output);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (Is.object(schema.additionalProperties)) {\n\t\t\t\tJsonSchemaHelper.extractTypesFromSchema(allTypes, schema.additionalProperties, output);\n\t\t\t}\n\t\t} else if (Is.arrayValue(schema.anyOf)) {\n\t\t\tfor (const prop of schema.anyOf) {\n\t\t\t\tif (Is.object<IJsonSchema>(prop)) {\n\t\t\t\t\tJsonSchemaHelper.extractTypesFromSchema(allTypes, prop, output);\n\t\t\t\t}\n\t\t\t}\n\t\t} else if (Is.arrayValue(schema.oneOf)) {\n\t\t\tfor (const prop of schema.oneOf) {\n\t\t\t\tif (Is.object<IJsonSchema>(prop)) {\n\t\t\t\t\tJsonSchemaHelper.extractTypesFromSchema(allTypes, prop, output);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif (additionalTypes.length > 0) {\n\t\t\tJsonSchemaHelper.extractTypes(allTypes, additionalTypes, output);\n\t\t}\n\t}\n\n\t/**\n\t * Extract the required types from all the known schemas.\n\t * @param allSchemas All the known schemas.\n\t * @param requiredTypes The required types.\n\t * @param referencedSchemas The references schemas.\n\t */\n\tpublic static extractTypes(\n\t\tallSchemas: { [id: string]: IJsonSchema },\n\t\trequiredTypes: string[],\n\t\treferencedSchemas: { [id: string]: IJsonSchema }\n\t): void {\n\t\tfor (const typeKey of Object.keys(allSchemas)) {\n\t\t\tif (!referencedSchemas[typeKey]) {\n\t\t\t\tfor (const requiredType of requiredTypes) {\n\t\t\t\t\tconst regex = JsonSchemaHelper.stringToRegEx(requiredType);\n\n\t\t\t\t\tif (regex.test(typeKey)) {\n\t\t\t\t\t\treferencedSchemas[typeKey] = allSchemas[typeKey];\n\t\t\t\t\t\tJsonSchemaHelper.extractTypesFromSchema(\n\t\t\t\t\t\t\tallSchemas,\n\t\t\t\t\t\t\tallSchemas[typeKey],\n\t\t\t\t\t\t\treferencedSchemas\n\t\t\t\t\t\t);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Expand the types inline.\n\t * @param schemas The schemas to include the expanded types.\n\t * @param expandedTypes The types to expand.\n\t */\n\tpublic static expandTypes(schemas: { [id: string]: IJsonSchema }, expandedTypes: string[]): void {\n\t\tfor (const typeKey of Object.keys(schemas)) {\n\t\t\tconst schema = schemas[typeKey];\n\n\t\t\tJsonSchemaHelper.expandSchemaTypes(schemas, schema, expandedTypes);\n\t\t}\n\t}\n\n\t/**\n\t * Expand the types inline.\n\t * @param allSchemas All the known schemas.\n\t * @param schema The schemas to include the expanded types.\n\t * @param expandedTypes The types to expand.\n\t */\n\tpublic static expandSchemaTypes(\n\t\tallSchemas: { [id: string]: IJsonSchema },\n\t\tschema: IJsonSchema,\n\t\texpandedTypes: string[]\n\t): void {\n\t\tif (Is.stringValue(schema.$ref)) {\n\t\t\tfor (const expandedType of expandedTypes) {\n\t\t\t\tconst typeName = JsonSchemaHelper.normaliseTypeName(\n\t\t\t\t\tschema.$ref.replace(\"#/definitions/\", \"\")\n\t\t\t\t);\n\t\t\t\tconst regex = JsonSchemaHelper.stringToRegEx(expandedType);\n\t\t\t\tif (regex.test(typeName) && allSchemas[typeName]) {\n\t\t\t\t\tdelete schema.$ref;\n\t\t\t\t\tObject.assign(schema, allSchemas[typeName]);\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t} else if (Is.object<IJsonSchema>(schema.items)) {\n\t\t\tif (Is.arrayValue<IJsonSchema>(schema.items)) {\n\t\t\t\tfor (const itemSchema of schema.items) {\n\t\t\t\t\tJsonSchemaHelper.expandSchemaTypes(allSchemas, itemSchema, expandedTypes);\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tJsonSchemaHelper.expandSchemaTypes(allSchemas, schema.items, expandedTypes);\n\t\t\t}\n\t\t} else if (Is.object(schema.properties) || Is.object(schema.additionalProperties)) {\n\t\t\tif (Is.object(schema.properties)) {\n\t\t\t\tfor (const prop in schema.properties) {\n\t\t\t\t\tconst p = schema.properties[prop];\n\t\t\t\t\tif (Is.object<IJsonSchema>(p)) {\n\t\t\t\t\t\tJsonSchemaHelper.expandSchemaTypes(allSchemas, p, expandedTypes);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (Is.object(schema.additionalProperties)) {\n\t\t\t\tJsonSchemaHelper.expandSchemaTypes(allSchemas, schema.additionalProperties, expandedTypes);\n\t\t\t}\n\t\t} else if (Is.arrayValue(schema.anyOf)) {\n\t\t\tfor (const prop of schema.anyOf) {\n\t\t\t\tif (Is.object<IJsonSchema>(prop)) {\n\t\t\t\t\tJsonSchemaHelper.expandSchemaTypes(allSchemas, prop, expandedTypes);\n\t\t\t\t}\n\t\t\t}\n\t\t} else if (Is.arrayValue(schema.oneOf)) {\n\t\t\tfor (const prop of schema.oneOf) {\n\t\t\t\tif (Is.object<IJsonSchema>(prop)) {\n\t\t\t\t\tJsonSchemaHelper.expandSchemaTypes(allSchemas, prop, expandedTypes);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Convert a string pattern to a regular expression.\n\t * @param matchPattern The pattern to convert.\n\t * @returns The regular expression.\n\t */\n\tpublic static stringToRegEx(matchPattern: string): RegExp {\n\t\treturn matchPattern.startsWith(\"/\") && matchPattern.endsWith(\"/\")\n\t\t\t? new RegExp(matchPattern.slice(1, -1))\n\t\t\t: new RegExp(`^${matchPattern}$`);\n\t}\n}\n"]}

package/dist/es/utils/openApiHelper.js

@@ -1,12 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Helper class for OpenAPI processing.
- */
-export class OpenApiHelper {
-    /**
-     * The OpenAPI version used.
-     */
-    static API_VERSION = "3.1.1";
-}
-//# sourceMappingURL=openApiHelper.js.map

package/dist/es/utils/openApiHelper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"openApiHelper.js","sourceRoot":"","sources":["../../../src/utils/openApiHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,MAAM,OAAO,aAAa;IACzB;;OAEG;IACI,MAAM,CAAU,WAAW,GAAG,OAAO,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Helper class for OpenAPI processing.\n */\nexport class OpenApiHelper {\n\t/**\n\t * The OpenAPI version used.\n\t */\n\tpublic static readonly API_VERSION = \"3.1.1\";\n}\n"]}

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

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

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

@@ -1,54 +0,0 @@
-import type { IJsonSchema } from "./IJsonSchema.js";
-import type { IOpenApiPathMethod } from "./IOpenApiPathMethod.js";
-import type { IOpenApiSecurityScheme } from "./IOpenApiSecurityScheme.js";
-/**
- * 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

@@ -1,13 +0,0 @@
-/**
- * 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

@@ -1,19 +0,0 @@
-/**
- * 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;
-}