@twin.org/tools-models 0.0.3-next.16

package/dist/es/models/openApi/IOpenApiSecurityRequirement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IOpenApiSecurityRequirement.js","sourceRoot":"","sources":["../../../../src/models/openApi/IOpenApiSecurityRequirement.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * An OpenAPI Security Requirement Object.\n * @see https://spec.openapis.org/oas/latest.html#security-requirement-object\n */\nexport interface IOpenApiSecurityRequirement {\n\t[name: string]: string[];\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IOpenApiSecurityScheme.js","sourceRoot":"","sources":["../../../../src/models/openApi/IOpenApiSecurityScheme.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IOpenApiOAuthFlows } from \"./IOpenApiOAuthFlows.js\";\n\n/**\n * An OpenAPI Security Scheme Object.\n * @see https://spec.openapis.org/oas/latest.html#security-scheme-object\n */\nexport type IOpenApiSecurityScheme =\n\t| {\n\t\t\ttype: \"apiKey\";\n\t\t\tdescription?: string;\n\t\t\tname: string;\n\t\t\tin: \"query\" | \"header\" | \"cookie\";\n\t\t\tdeprecated?: boolean;\n\t  }\n\t| {\n\t\t\ttype: \"http\";\n\t\t\tdescription?: string;\n\t\t\tscheme: string;\n\t\t\tbearerFormat?: string;\n\t\t\tdeprecated?: boolean;\n\t  }\n\t| {\n\t\t\ttype: \"mutualTLS\";\n\t\t\tdescription?: string;\n\t\t\tdeprecated?: boolean;\n\t  }\n\t| {\n\t\t\ttype: \"oauth2\";\n\t\t\tdescription?: string;\n\t\t\tflows: IOpenApiOAuthFlows;\n\t\t\toauth2MetadataUrl?: string;\n\t\t\tdeprecated?: boolean;\n\t  }\n\t| {\n\t\t\ttype: \"openIdConnect\";\n\t\t\tdescription?: string;\n\t\t\topenIdConnectUrl: string;\n\t\t\tdeprecated?: boolean;\n\t  };\n"]}

package/dist/es/models/openApi/IOpenApiServer.js

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

package/dist/es/models/openApi/IOpenApiServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IOpenApiServer.js","sourceRoot":"","sources":["../../../../src/models/openApi/IOpenApiServer.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IOpenApiServerVariable } from \"./IOpenApiServerVariable.js\";\n\n/**\n * An OpenAPI Server Object.\n * @see https://spec.openapis.org/oas/latest.html#server-object\n */\nexport interface IOpenApiServer {\n\t/**\n\t * The target URL.\n\t * @see https://spec.openapis.org/oas/latest.html#fixed-fields-3\n\t */\n\turl: string;\n\n\t/**\n\t * A description of the server.\n\t * @see https://spec.openapis.org/oas/latest.html#fixed-fields-3\n\t */\n\tdescription?: string;\n\n\t/**\n\t * A unique server name.\n\t * @see https://spec.openapis.org/oas/latest.html#fixed-fields-3\n\t */\n\tname?: string;\n\n\t/**\n\t * URL template variables.\n\t * @see https://spec.openapis.org/oas/latest.html#fixed-fields-3\n\t */\n\tvariables?: {\n\t\t[name: string]: IOpenApiServerVariable;\n\t};\n}\n"]}

package/dist/es/models/openApi/IOpenApiServerVariable.js

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

package/dist/es/models/openApi/IOpenApiServerVariable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IOpenApiServerVariable.js","sourceRoot":"","sources":["../../../../src/models/openApi/IOpenApiServerVariable.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * An OpenAPI Server Variable Object.\n * @see https://spec.openapis.org/oas/latest.html#server-variable-object\n */\nexport interface IOpenApiServerVariable {\n\t/**\n\t * Allowed substitution values.\n\t * @see https://spec.openapis.org/oas/latest.html#fixed-fields-4\n\t */\n\tenum?: string[];\n\n\t/**\n\t * The default substitution value.\n\t * @see https://spec.openapis.org/oas/latest.html#fixed-fields-4\n\t */\n\tdefault: string;\n\n\t/**\n\t * A description of the variable.\n\t * @see https://spec.openapis.org/oas/latest.html#fixed-fields-4\n\t */\n\tdescription?: string;\n}\n"]}

package/dist/es/models/openApi/IOpenApiTag.js

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

package/dist/es/models/openApi/IOpenApiTag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IOpenApiTag.js","sourceRoot":"","sources":["../../../../src/models/openApi/IOpenApiTag.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IOpenApiExternalDocumentation } from \"./IOpenApiExternalDocumentation.js\";\n\n/**\n * An OpenAPI Tag Object.\n * @see https://spec.openapis.org/oas/latest.html#tag-object\n */\nexport interface IOpenApiTag {\n\t/**\n\t * The name of the tag.\n\t */\n\tname: string;\n\n\t/**\n\t * A short summary of the tag.\n\t */\n\tsummary?: string;\n\n\t/**\n\t * A description of the tag.\n\t */\n\tdescription?: string;\n\n\t/**\n\t * Additional external documentation for the tag.\n\t */\n\texternalDocs?: IOpenApiExternalDocumentation;\n\n\t/**\n\t * Parent tag name.\n\t */\n\tparent?: string;\n\n\t/**\n\t * A machine-readable category for the tag.\n\t */\n\tkind?: string;\n}\n"]}

package/dist/es/models/openApi/openApiConstants.js

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

package/dist/es/models/openApi/openApiConstants.js.map

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IPackageJson.js","sourceRoot":"","sources":["../../../../src/models/packageJson/IPackageJson.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\nimport type { IPackageJsonBugs } from \"./IPackageJsonBugs.js\";\nimport type { IPackageJsonPerson } from \"./IPackageJsonPerson.js\";\nimport type { IPackageJsonPublishConfig } from \"./IPackageJsonPublishConfig.js\";\nimport type { IPackageJsonRepository } from \"./IPackageJsonRepository.js\";\nimport type { IPackageJsonStringMap } from \"./IPackageJsonStringMap.js\";\n\n/**\n * Configuration for each individual package.\n * @see https://docs.npmjs.com/creating-a-package-json-file\n * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json\n */\nexport interface IPackageJson {\n\t/**\n\t * The name of the package.\n\t * @see https://docs.npmjs.com/creating-a-package-json-file#required-name-and-version-fields\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#name\n\t */\n\tname: string;\n\n\t/**\n\t * The semantic version for the package.\n\t * @see https://docs.npmjs.com/creating-a-package-json-file#required-name-and-version-fields\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#version\n\t */\n\tversion?: string;\n\n\t/**\n\t * The short description for the package.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#description\n\t */\n\tdescription?: string;\n\n\t/**\n\t * Search keywords for the package.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#keywords\n\t */\n\tkeywords?: string[];\n\n\t/**\n\t * The package author.\n\t * @see https://docs.npmjs.com/creating-a-package-json-file#author-field\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#people-fields-author-contributors\n\t */\n\tauthor?: IPackageJsonPerson;\n\n\t/**\n\t * The contributors for the package.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#people-fields-author-contributors\n\t */\n\tcontributors?: IPackageJsonPerson[];\n\n\t/**\n\t * The project homepage.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#homepage\n\t */\n\thomepage?: string;\n\n\t/**\n\t * The source repository for the package.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#repository\n\t */\n\trepository?: IPackageJsonRepository;\n\n\t/**\n\t * The issue tracker for the package.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bugs\n\t */\n\tbugs?: IPackageJsonBugs;\n\n\t/**\n\t * The SPDX license expression for the package.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#license\n\t */\n\tlicense?: string;\n\n\t/**\n\t * Whether the package is private and should not be published.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#private\n\t */\n\tprivate?: boolean;\n\n\t/**\n\t * The module system for .js files in the package.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#type\n\t */\n\ttype?: \"commonjs\" | \"module\";\n\n\t/**\n\t * The primary package entry point.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#main\n\t */\n\tmain?: string;\n\n\t/**\n\t * The TypeScript declaration entry point.\n\t */\n\ttypes?: string;\n\n\t/**\n\t * The executable entry points for the package.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin\n\t */\n\tbin?: string | IPackageJsonStringMap;\n\n\t/**\n\t * The files to include when the package is packed or published.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#files\n\t */\n\tfiles?: string[];\n\n\t/**\n\t * The lifecycle scripts for the package.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#scripts\n\t */\n\tscripts?: IPackageJsonStringMap;\n\n\t/**\n\t * The dependencies for the package.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#dependencies\n\t */\n\tdependencies?: IPackageJsonStringMap;\n\n\t/**\n\t * The development-only dependencies for the package.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#devdependencies\n\t */\n\tdevDependencies?: IPackageJsonStringMap;\n\n\t/**\n\t * The peer dependencies for the package.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependencies\n\t */\n\tpeerDependencies?: IPackageJsonStringMap;\n\n\t/**\n\t * The optional dependencies for the package.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#optionaldependencies\n\t */\n\toptionalDependencies?: IPackageJsonStringMap;\n\n\t/**\n\t * Runtime engine constraints for the package.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#engines\n\t */\n\tengines?: IPackageJsonStringMap;\n\n\t/**\n\t * Publish-time npm configuration.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#publishconfig\n\t */\n\tpublishConfig?: IPackageJsonPublishConfig;\n\n\t/**\n\t * Workspace globs for a monorepo root package.\n\t * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#workspaces\n\t */\n\tworkspaces?: string[];\n}\n"]}

package/dist/es/models/packageJson/IPackageJsonBugs.js

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

package/dist/es/models/packageJson/IPackageJsonBugs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPackageJsonBugs.js","sourceRoot":"","sources":["../../../../src/models/packageJson/IPackageJsonBugs.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * A package bugs field.\n */\nexport type IPackageJsonBugs =\n\t| string\n\t| {\n\t\t\turl?: string;\n\t\t\temail?: string;\n\t  };\n"]}

package/dist/es/models/packageJson/IPackageJsonPerson.js

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

package/dist/es/models/packageJson/IPackageJsonPerson.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPackageJsonPerson.js","sourceRoot":"","sources":["../../../../src/models/packageJson/IPackageJsonPerson.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * A package person field.\n */\nexport type IPackageJsonPerson =\n\t| string\n\t| {\n\t\t\tname: string;\n\t\t\temail?: string;\n\t\t\turl?: string;\n\t  };\n"]}

package/dist/es/models/packageJson/IPackageJsonPublishConfig.js

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

package/dist/es/models/packageJson/IPackageJsonPublishConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPackageJsonPublishConfig.js","sourceRoot":"","sources":["../../../../src/models/packageJson/IPackageJsonPublishConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Publish-time npm configuration.\n */\nexport interface IPackageJsonPublishConfig {\n\t[id: string]: string | boolean;\n}\n"]}

package/dist/es/models/packageJson/IPackageJsonRepository.js

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

package/dist/es/models/packageJson/IPackageJsonRepository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPackageJsonRepository.js","sourceRoot":"","sources":["../../../../src/models/packageJson/IPackageJsonRepository.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * A package repository field.\n */\nexport type IPackageJsonRepository =\n\t| string\n\t| {\n\t\t\ttype?: string;\n\t\t\turl: string;\n\t\t\tdirectory?: string;\n\t  };\n"]}

package/dist/es/models/packageJson/IPackageJsonStringMap.js

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

package/dist/es/models/packageJson/IPackageJsonStringMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPackageJsonStringMap.js","sourceRoot":"","sources":["../../../../src/models/packageJson/IPackageJsonStringMap.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * A map of package names to version specifiers.\n */\nexport interface IPackageJsonStringMap {\n\t[id: string]: string;\n}\n"]}

package/dist/types/index.d.ts

@@ -0,0 +1,33 @@
+export * from "./models/jsonSchema/IJsonSchema.js";
+export * from "./models/jsonSchema/jsonSchemaTagNames.js";
+export * from "./models/jsonSchema/jsonSchemaTypeNames.js";
+export * from "./models/openApi/IOpenApi.js";
+export * from "./models/openApi/IOpenApiComponents.js";
+export * from "./models/openApi/IOpenApiContact.js";
+export * from "./models/openApi/IOpenApiExample.js";
+export * from "./models/openApi/IOpenApiExternalDocumentation.js";
+export * from "./models/openApi/IOpenApiHeader.js";
+export * from "./models/openApi/IOpenApiInfo.js";
+export * from "./models/openApi/IOpenApiLicense.js";
+export * from "./models/openApi/IOpenApiMediaType.js";
+export * from "./models/openApi/IOpenApiOAuthFlow.js";
+export * from "./models/openApi/IOpenApiOAuthFlows.js";
+export * from "./models/openApi/IOpenApiParameter.js";
+export * from "./models/openApi/IOpenApiPathItem.js";
+export * from "./models/openApi/IOpenApiPathMethod.js";
+export * from "./models/openApi/IOpenApiReference.js";
+export * from "./models/openApi/IOpenApiRequestBody.js";
+export * from "./models/openApi/IOpenApiResponse.js";
+export * from "./models/openApi/IOpenApiResponses.js";
+export * from "./models/openApi/IOpenApiSecurityRequirement.js";
+export * from "./models/openApi/IOpenApiSecurityScheme.js";
+export * from "./models/openApi/IOpenApiServer.js";
+export * from "./models/openApi/IOpenApiServerVariable.js";
+export * from "./models/openApi/IOpenApiTag.js";
+export * from "./models/openApi/openApiConstants.js";
+export * from "./models/packageJson/IPackageJson.js";
+export * from "./models/packageJson/IPackageJsonBugs.js";
+export * from "./models/packageJson/IPackageJsonPerson.js";
+export * from "./models/packageJson/IPackageJsonPublishConfig.js";
+export * from "./models/packageJson/IPackageJsonRepository.js";
+export * from "./models/packageJson/IPackageJsonStringMap.js";

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

@@ -0,0 +1,372 @@
+/**
+ * JSON schema representation used by the TypeScript conversion utilities.
+ * @see https://json-schema.org/draft/2020-12/json-schema-core
+ */
+export interface IJsonSchema {
+    /**
+     * Dialect URI for the schema document.
+     * @see https://www.learnjsonschema.com/2020-12/core/schema/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-8.1.1
+     */
+    $schema?: string;
+    /**
+     * Canonical identifier for the schema resource.
+     * @see https://www.learnjsonschema.com/2020-12/core/id/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-8.2.1
+     */
+    $id?: string;
+    /**
+     * Reference to another schema resource.
+     * @see https://www.learnjsonschema.com/2020-12/core/ref/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-8.2.3.1
+     */
+    $ref?: string;
+    /**
+     * Location-independent identifier fragment.
+     * @see https://www.learnjsonschema.com/2020-12/core/anchor/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-8.2.2
+     */
+    $anchor?: string;
+    /**
+     * Runtime-resolved dynamic schema reference.
+     * @see https://www.learnjsonschema.com/2020-12/core/dynamicref/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-8.2.3.2
+     */
+    $dynamicRef?: string;
+    /**
+     * Dynamic extension point anchor.
+     * @see https://www.learnjsonschema.com/2020-12/core/dynamicanchor/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-8.2.2
+     */
+    $dynamicAnchor?: string;
+    /**
+     * Declares vocabularies for a meta-schema dialect.
+     * @see https://www.learnjsonschema.com/2020-12/core/vocabulary/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-8.1.2
+     */
+    $vocabulary?: {
+        [uri: string]: boolean;
+    };
+    /**
+     * Maintainer comment for tools.
+     * @see https://www.learnjsonschema.com/2020-12/core/comment/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-8.3
+     */
+    $comment?: string;
+    /**
+     * Reusable inlined schema definitions.
+     * @see https://www.learnjsonschema.com/2020-12/core/defs/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-8.2.4
+     */
+    $defs?: {
+        [id: string]: IJsonSchema;
+    };
+    /**
+     * Human-friendly schema title.
+     * @see https://www.learnjsonschema.com/2020-12/meta-data/title/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-9.1
+     */
+    title?: string;
+    /**
+     * Human-friendly schema description.
+     * @see https://www.learnjsonschema.com/2020-12/meta-data/description/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-9.1
+     */
+    description?: string;
+    /**
+     * Constrain allowed JSON value types.
+     * @see https://www.learnjsonschema.com/2020-12/validation/type/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.1.1
+     */
+    type?: string | string[];
+    /**
+     * Property schemas for object members.
+     * @see https://www.learnjsonschema.com/2020-12/applicator/properties/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-10.3.2.1
+     */
+    properties?: {
+        [id: string]: IJsonSchema;
+    };
+    /**
+     * Property schemas selected by regex on property names.
+     * @see https://www.learnjsonschema.com/2020-12/applicator/patternproperties/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-10.3.2.2
+     */
+    patternProperties?: {
+        [pattern: string]: IJsonSchema;
+    };
+    /**
+     * Object property names that must be present.
+     * @see https://www.learnjsonschema.com/2020-12/validation/required/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.5.3
+     */
+    required?: string[];
+    /**
+     * Property-level schema dependencies.
+     * @see https://www.learnjsonschema.com/2020-12/applicator/dependentschemas/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-10.2.2.4
+     */
+    dependentSchemas?: {
+        [property: string]: IJsonSchema;
+    };
+    /**
+     * Property-level required-key dependencies.
+     * @see https://www.learnjsonschema.com/2020-12/validation/dependentrequired/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.5.4
+     */
+    dependentRequired?: {
+        [property: string]: string[];
+    };
+    /**
+     * Schema for array items (or boolean form).
+     * @see https://www.learnjsonschema.com/2020-12/applicator/items/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-10.3.1.2
+     */
+    items?: IJsonSchema | boolean;
+    /**
+     * Tuple-style schemas for leading array positions.
+     * @see https://www.learnjsonschema.com/2020-12/applicator/prefixitems/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-10.3.1.1
+     */
+    prefixItems?: IJsonSchema[];
+    /**
+     * Schema for properties not listed in properties/patternProperties.
+     * @see https://www.learnjsonschema.com/2020-12/applicator/additionalproperties/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-10.3.2.3
+     */
+    additionalProperties?: IJsonSchema | boolean;
+    /**
+     * Union where at least one branch schema must match.
+     * @see https://www.learnjsonschema.com/2020-12/applicator/anyof/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-10.2.1.2
+     */
+    anyOf?: IJsonSchema[];
+    /**
+     * Intersection where all branch schemas must match.
+     * @see https://www.learnjsonschema.com/2020-12/applicator/allof/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-10.2.1.1
+     */
+    allOf?: IJsonSchema[];
+    /**
+     * Exactly one branch schema must match.
+     * @see https://www.learnjsonschema.com/2020-12/applicator/oneof/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-10.2.1.3
+     */
+    oneOf?: IJsonSchema[];
+    /**
+     * Negated schema condition.
+     * @see https://www.learnjsonschema.com/2020-12/applicator/not/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-10.2.1.4
+     */
+    not?: IJsonSchema;
+    /**
+     * Condition schema for conditional application.
+     * @see https://www.learnjsonschema.com/2020-12/applicator/if/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-10.2.2.1
+     */
+    if?: IJsonSchema;
+    /**
+     * Schema applied when if matches.
+     * @see https://www.learnjsonschema.com/2020-12/applicator/then/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-10.2.2.2
+     */
+    then?: IJsonSchema;
+    /**
+     * Schema applied when if does not match.
+     * @see https://www.learnjsonschema.com/2020-12/applicator/else/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-10.2.2.3
+     */
+    else?: IJsonSchema;
+    /**
+     * Array must contain at least one matching item.
+     * @see https://www.learnjsonschema.com/2020-12/applicator/contains/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-10.3.1.3
+     */
+    contains?: IJsonSchema;
+    /**
+     * Schema for validating object property names.
+     * @see https://www.learnjsonschema.com/2020-12/applicator/propertynames/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-10.3.2.4
+     */
+    propertyNames?: IJsonSchema;
+    /**
+     * Single fixed value constraint.
+     * @see https://www.learnjsonschema.com/2020-12/validation/const/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.1.3
+     */
+    const?: unknown;
+    /**
+     * Enumerated set of allowed values.
+     * @see https://www.learnjsonschema.com/2020-12/validation/enum/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.1.2
+     */
+    enum?: unknown[];
+    /**
+     * Example instances for documentation tooling.
+     * @see https://www.learnjsonschema.com/2020-12/meta-data/examples/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
+     */
+    examples?: unknown[];
+    /**
+     * Suggested default instance value.
+     * @see https://www.learnjsonschema.com/2020-12/meta-data/default/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-9.2
+     */
+    default?: unknown;
+    /**
+     * Semantic format annotation.
+     * @see https://www.learnjsonschema.com/2020-12/format-annotation/format/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-7.1
+     */
+    format?: string;
+    /**
+     * Regular expression that strings must match.
+     * @see https://www.learnjsonschema.com/2020-12/validation/pattern/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.3.3
+     */
+    pattern?: string;
+    /**
+     * Content encoding annotation for string instances.
+     * @see https://www.learnjsonschema.com/2020-12/content/contentencoding/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-8.3
+     */
+    contentEncoding?: string;
+    /**
+     * Media type annotation for string content.
+     * @see https://www.learnjsonschema.com/2020-12/content/contentmediatype/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-8.4
+     */
+    contentMediaType?: string;
+    /**
+     * Schema for the decoded content payload.
+     * @see https://www.learnjsonschema.com/2020-12/content/contentschema/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-8.5
+     */
+    contentSchema?: IJsonSchema;
+    /**
+     * Annotation indicating read-only semantics.
+     * @see https://www.learnjsonschema.com/2020-12/meta-data/readonly/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-9.4
+     */
+    readOnly?: boolean;
+    /**
+     * Annotation indicating write-only semantics.
+     * @see https://www.learnjsonschema.com/2020-12/meta-data/writeonly/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-9.4
+     */
+    writeOnly?: boolean;
+    /**
+     * Annotation indicating deprecation.
+     * @see https://www.learnjsonschema.com/2020-12/meta-data/deprecated/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-9.3
+     */
+    deprecated?: boolean;
+    /**
+     * Non-standard extension used by some tooling ecosystems.
+     */
+    discriminator?: {
+        propertyName: string;
+    };
+    /**
+     * Minimum length for strings.
+     * @see https://www.learnjsonschema.com/2020-12/validation/minlength/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.3.2
+     */
+    minLength?: number;
+    /**
+     * Maximum length for strings.
+     * @see https://www.learnjsonschema.com/2020-12/validation/maxlength/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.3.1
+     */
+    maxLength?: number;
+    /**
+     * Inclusive lower numeric bound.
+     * @see https://www.learnjsonschema.com/2020-12/validation/minimum/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.2.4
+     */
+    minimum?: number;
+    /**
+     * Inclusive upper numeric bound.
+     * @see https://www.learnjsonschema.com/2020-12/validation/maximum/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.2.2
+     */
+    maximum?: number;
+    /**
+     * Exclusive lower numeric bound.
+     * @see https://www.learnjsonschema.com/2020-12/validation/exclusiveminimum/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.2.5
+     */
+    exclusiveMinimum?: number;
+    /**
+     * Exclusive upper numeric bound.
+     * @see https://www.learnjsonschema.com/2020-12/validation/exclusivemaximum/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.2.3
+     */
+    exclusiveMaximum?: number;
+    /**
+     * Numeric divisor constraint.
+     * @see https://www.learnjsonschema.com/2020-12/validation/multipleof/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.2.1
+     */
+    multipleOf?: number;
+    /**
+     * Minimum array length.
+     * @see https://www.learnjsonschema.com/2020-12/validation/minitems/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.4.2
+     */
+    minItems?: number;
+    /**
+     * Maximum array length.
+     * @see https://www.learnjsonschema.com/2020-12/validation/maxitems/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.4.1
+     */
+    maxItems?: number;
+    /**
+     * Require array elements to be unique.
+     * @see https://www.learnjsonschema.com/2020-12/validation/uniqueitems/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.4.3
+     */
+    uniqueItems?: boolean;
+    /**
+     * Minimum number of object properties.
+     * @see https://www.learnjsonschema.com/2020-12/validation/minproperties/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.5.2
+     */
+    minProperties?: number;
+    /**
+     * Maximum number of object properties.
+     * @see https://www.learnjsonschema.com/2020-12/validation/maxproperties/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.5.1
+     */
+    maxProperties?: number;
+    /**
+     * Minimum number of contains matches.
+     * @see https://www.learnjsonschema.com/2020-12/validation/mincontains/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.4.5
+     */
+    minContains?: number;
+    /**
+     * Maximum number of contains matches.
+     * @see https://www.learnjsonschema.com/2020-12/validation/maxcontains/
+     * @see https://json-schema.org/draft/2020-12/json-schema-validation#section-6.4.4
+     */
+    maxContains?: number;
+    /**
+     * Schema applied to array items not yet evaluated by adjacent applicators.
+     * @see https://www.learnjsonschema.com/2020-12/unevaluated/unevaluateditems/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-11.2
+     */
+    unevaluatedItems?: IJsonSchema | boolean;
+    /**
+     * Schema applied to object properties not yet evaluated by adjacent applicators.
+     * @see https://www.learnjsonschema.com/2020-12/unevaluated/unevaluatedproperties/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-11.3
+     */
+    unevaluatedProperties?: IJsonSchema | boolean;
+    /**
+     * Allow additional extension keywords.
+     * @see https://www.learnjsonschema.com/2020-12/
+     * @see https://json-schema.org/draft/2020-12/json-schema-core#section-4.3.1
+     */
+    [key: string]: unknown;
+}

package/dist/types/models/jsonSchema/jsonSchemaTagNames.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Supported @json-schema tag keys (after alias mapping).
+ */
+export declare const JsonSchemaTagNames: string[];

package/dist/types/models/jsonSchema/jsonSchemaTypeNames.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Default schema type names.
+ */
+export type JsonSchemaTypeNames = "string" | "number" | "integer" | "boolean" | "null" | "object" | "array";

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

@@ -0,0 +1,72 @@
+import type { IOpenApiComponents } from "./IOpenApiComponents.js";
+import type { IOpenApiExternalDocumentation } from "./IOpenApiExternalDocumentation.js";
+import type { IOpenApiInfo } from "./IOpenApiInfo.js";
+import type { IOpenApiPathItem } from "./IOpenApiPathItem.js";
+import type { IOpenApiSecurityRequirement } from "./IOpenApiSecurityRequirement.js";
+import type { IOpenApiServer } from "./IOpenApiServer.js";
+import type { IOpenApiTag } from "./IOpenApiTag.js";
+/**
+ * The OpenAPI document definition.
+ * @see https://spec.openapis.org/oas/latest.html#openapi-object
+ */
+export interface IOpenApi {
+    /**
+     * The OpenAPI specification version.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields
+     */
+    openapi: string;
+    /**
+     * The self-assigned URI of the document.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields
+     */
+    $self?: string;
+    /**
+     * The metadata for the API.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields
+     */
+    info: IOpenApiInfo;
+    /**
+     * The default JSON Schema dialect URI.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields
+     */
+    jsonSchemaDialect?: string;
+    /**
+     * Connectivity information for target servers.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields
+     */
+    servers?: IOpenApiServer[];
+    /**
+     * Available paths and operations.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields
+     */
+    paths?: {
+        [path: string]: IOpenApiPathItem;
+    };
+    /**
+     * Incoming webhooks keyed by name.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields
+     */
+    webhooks?: {
+        [name: string]: IOpenApiPathItem;
+    };
+    /**
+     * Reusable components.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields
+     */
+    components?: IOpenApiComponents;
+    /**
+     * API-wide security requirements.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields
+     */
+    security?: IOpenApiSecurityRequirement[];
+    /**
+     * Tags used by the API description.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields
+     */
+    tags?: IOpenApiTag[];
+    /**
+     * Additional external documentation.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields
+     */
+    externalDocs?: IOpenApiExternalDocumentation;
+}