@twin.org/tools-core 0.0.3-next.2 → 0.0.3-next.21

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

@@ -1,78 +0,0 @@
-import type { IJsonSchema } from "../models/IJsonSchema.js";
-/**
- * Helper class for JSON Schema processing.
- */
-export declare class JsonSchemaHelper {
-    /**
-     * The JSON Schema version used.
-     */
-    static readonly 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: IJsonSchema): void;
-    /**
-     * Process arrays in the schema object.
-     * @param schemaDictionary The schema object to process.
-     */
-    static processSchemaDictionary(schemaDictionary?: {
-        [key: string]: IJsonSchema;
-    }): void;
-    /**
-     * Process arrays in the schema object.
-     * @param schemaArray The schema object to process.
-     */
-    static processSchemaArray(schemaArray?: IJsonSchema[]): void;
-    /**
-     * Cleanup TypeScript markers from the type name.
-     * @param typeName The definition string to clean up.
-     * @returns The cleaned up definition string.
-     */
-    static normaliseTypeName(typeName: string): string;
-    /**
-     * 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: {
-        [id: string]: IJsonSchema;
-    }, schema: IJsonSchema, output: {
-        [id: string]: IJsonSchema;
-    }): void;
-    /**
-     * 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: {
-        [id: string]: IJsonSchema;
-    }, requiredTypes: string[], referencedSchemas: {
-        [id: string]: IJsonSchema;
-    }): void;
-    /**
-     * Expand the types inline.
-     * @param schemas The schemas to include the expanded types.
-     * @param expandedTypes The types to expand.
-     */
-    static expandTypes(schemas: {
-        [id: string]: IJsonSchema;
-    }, expandedTypes: string[]): void;
-    /**
-     * 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: {
-        [id: string]: IJsonSchema;
-    }, schema: IJsonSchema, expandedTypes: string[]): void;
-    /**
-     * Convert a string pattern to a regular expression.
-     * @param matchPattern The pattern to convert.
-     * @returns The regular expression.
-     */
-    static stringToRegEx(matchPattern: string): RegExp;
-}

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

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

package/docs/reference/classes/JsonSchemaHelper.md

@@ -1,233 +0,0 @@
-# Class: JsonSchemaHelper
-
-Helper class for JSON Schema processing.
-
-## Constructors
-
-### Constructor
-
-> **new JsonSchemaHelper**(): `JsonSchemaHelper`
-
-#### Returns
-
-`JsonSchemaHelper`
-
-## Properties
-
-### SCHEMA\_VERSION
-
-> `readonly` `static` **SCHEMA\_VERSION**: `"https://json-schema.org/draft/2020-12/schema"` = `"https://json-schema.org/draft/2020-12/schema"`
-
-The JSON Schema version used.
-
-## Methods
-
-### processArrays()
-
-> `static` **processArrays**(`schemaObject`): `void`
-
-Process arrays in the schema object.
-
-#### Parameters
-
-##### schemaObject
-
-`AnySchemaObject`
-
-The schema object to process.
-
-#### Returns
-
-`void`
-
-***
-
-### processSchemaDictionary()
-
-> `static` **processSchemaDictionary**(`schemaDictionary?`): `void`
-
-Process arrays in the schema object.
-
-#### Parameters
-
-##### schemaDictionary?
-
-The schema object to process.
-
-#### Returns
-
-`void`
-
-***
-
-### processSchemaArray()
-
-> `static` **processSchemaArray**(`schemaArray?`): `void`
-
-Process arrays in the schema object.
-
-#### Parameters
-
-##### schemaArray?
-
-`AnySchemaObject`[]
-
-The schema object to process.
-
-#### Returns
-
-`void`
-
-***
-
-### normaliseTypeName()
-
-> `static` **normaliseTypeName**(`typeName`): `string`
-
-Cleanup TypeScript markers from the type name.
-
-#### Parameters
-
-##### typeName
-
-`string`
-
-The definition string to clean up.
-
-#### Returns
-
-`string`
-
-The cleaned up definition string.
-
-***
-
-### extractTypesFromSchema()
-
-> `static` **extractTypesFromSchema**(`allTypes`, `schema`, `output`): `void`
-
-Extract type from properties definition.
-
-#### Parameters
-
-##### allTypes
-
-All the known types.
-
-##### schema
-
-`AnySchemaObject`
-
-The schema to extract from.
-
-##### output
-
-The output types.
-
-#### Returns
-
-`void`
-
-***
-
-### extractTypes()
-
-> `static` **extractTypes**(`allSchemas`, `requiredTypes`, `referencedSchemas`): `void`
-
-Extract the required types from all the known schemas.
-
-#### Parameters
-
-##### allSchemas
-
-All the known schemas.
-
-##### requiredTypes
-
-`string`[]
-
-The required types.
-
-##### referencedSchemas
-
-The references schemas.
-
-#### Returns
-
-`void`
-
-***
-
-### expandTypes()
-
-> `static` **expandTypes**(`schemas`, `expandedTypes`): `void`
-
-Expand the types inline.
-
-#### Parameters
-
-##### schemas
-
-The schemas to include the expanded types.
-
-##### expandedTypes
-
-`string`[]
-
-The types to expand.
-
-#### Returns
-
-`void`
-
-***
-
-### expandSchemaTypes()
-
-> `static` **expandSchemaTypes**(`allSchemas`, `schema`, `expandedTypes`): `void`
-
-Expand the types inline.
-
-#### Parameters
-
-##### allSchemas
-
-All the known schemas.
-
-##### schema
-
-`AnySchemaObject`
-
-The schemas to include the expanded types.
-
-##### expandedTypes
-
-`string`[]
-
-The types to expand.
-
-#### Returns
-
-`void`
-
-***
-
-### stringToRegEx()
-
-> `static` **stringToRegEx**(`matchPattern`): `RegExp`
-
-Convert a string pattern to a regular expression.
-
-#### Parameters
-
-##### matchPattern
-
-`string`
-
-The pattern to convert.
-
-#### Returns
-
-`RegExp`
-
-The regular expression.

package/docs/reference/classes/OpenApiHelper.md

@@ -1,21 +0,0 @@
-# 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/interfaces/IOpenApi.md

@@ -1,103 +0,0 @@
-# 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

@@ -1,19 +0,0 @@
-# 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

@@ -1,31 +0,0 @@
-# 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

@@ -1,119 +0,0 @@
-# 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

@@ -1,35 +0,0 @@
-# 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

@@ -1,43 +0,0 @@
-# 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/docs/reference/interfaces/IPackageJson.md

@@ -1,23 +0,0 @@
-# Interface: IPackageJson
-
-Configuration for each individual package.
-
-## Properties
-
-### name
-
-> **name**: `string`
-
-The name of the package.
-
-***
-
-### dependencies?
-
-> `optional` **dependencies**: `object`
-
-The dependencies for the package.
-
-#### Index Signature
-
-\[`id`: `string`\]: `string`

package/docs/reference/type-aliases/IJsonSchema.md

@@ -1,5 +0,0 @@
-# Type Alias: IJsonSchema
-
-> **IJsonSchema** = `AnySchemaObject`
-
-Default schema type.