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

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

@@ -0,0 +1,33 @@
+import type { IOpenApiOAuthFlows } from "./IOpenApiOAuthFlows.js";
+/**
+ * An OpenAPI Security Scheme Object.
+ * @see https://spec.openapis.org/oas/latest.html#security-scheme-object
+ */
+export type IOpenApiSecurityScheme = {
+    type: "apiKey";
+    description?: string;
+    name: string;
+    in: "query" | "header" | "cookie";
+    deprecated?: boolean;
+} | {
+    type: "http";
+    description?: string;
+    scheme: string;
+    bearerFormat?: string;
+    deprecated?: boolean;
+} | {
+    type: "mutualTLS";
+    description?: string;
+    deprecated?: boolean;
+} | {
+    type: "oauth2";
+    description?: string;
+    flows: IOpenApiOAuthFlows;
+    oauth2MetadataUrl?: string;
+    deprecated?: boolean;
+} | {
+    type: "openIdConnect";
+    description?: string;
+    openIdConnectUrl: string;
+    deprecated?: boolean;
+};

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

@@ -0,0 +1,29 @@
+import type { IOpenApiServerVariable } from "./IOpenApiServerVariable.js";
+/**
+ * An OpenAPI Server Object.
+ * @see https://spec.openapis.org/oas/latest.html#server-object
+ */
+export interface IOpenApiServer {
+    /**
+     * The target URL.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-3
+     */
+    url: string;
+    /**
+     * A description of the server.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-3
+     */
+    description?: string;
+    /**
+     * A unique server name.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-3
+     */
+    name?: string;
+    /**
+     * URL template variables.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-3
+     */
+    variables?: {
+        [name: string]: IOpenApiServerVariable;
+    };
+}

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

@@ -0,0 +1,21 @@
+/**
+ * An OpenAPI Server Variable Object.
+ * @see https://spec.openapis.org/oas/latest.html#server-variable-object
+ */
+export interface IOpenApiServerVariable {
+    /**
+     * Allowed substitution values.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-4
+     */
+    enum?: string[];
+    /**
+     * The default substitution value.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-4
+     */
+    default: string;
+    /**
+     * A description of the variable.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-4
+     */
+    description?: string;
+}

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

@@ -0,0 +1,31 @@
+import type { IOpenApiExternalDocumentation } from "./IOpenApiExternalDocumentation.js";
+/**
+ * An OpenAPI Tag Object.
+ * @see https://spec.openapis.org/oas/latest.html#tag-object
+ */
+export interface IOpenApiTag {
+    /**
+     * The name of the tag.
+     */
+    name: string;
+    /**
+     * A short summary of the tag.
+     */
+    summary?: string;
+    /**
+     * A description of the tag.
+     */
+    description?: string;
+    /**
+     * Additional external documentation for the tag.
+     */
+    externalDocs?: IOpenApiExternalDocumentation;
+    /**
+     * Parent tag name.
+     */
+    parent?: string;
+    /**
+     * A machine-readable category for the tag.
+     */
+    kind?: string;
+}

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

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

package/dist/types/models/packageJson/IPackageJson.d.ts

@@ -0,0 +1,134 @@
+import type { IPackageJsonBugs } from "./IPackageJsonBugs.js";
+import type { IPackageJsonPerson } from "./IPackageJsonPerson.js";
+import type { IPackageJsonPublishConfig } from "./IPackageJsonPublishConfig.js";
+import type { IPackageJsonRepository } from "./IPackageJsonRepository.js";
+import type { IPackageJsonStringMap } from "./IPackageJsonStringMap.js";
+/**
+ * Configuration for each individual package.
+ * @see https://docs.npmjs.com/creating-a-package-json-file
+ * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json
+ */
+export interface IPackageJson {
+    /**
+     * The name of the package.
+     * @see https://docs.npmjs.com/creating-a-package-json-file#required-name-and-version-fields
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#name
+     */
+    name: string;
+    /**
+     * The semantic version for the package.
+     * @see https://docs.npmjs.com/creating-a-package-json-file#required-name-and-version-fields
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#version
+     */
+    version?: string;
+    /**
+     * The short description for the package.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#description
+     */
+    description?: string;
+    /**
+     * Search keywords for the package.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#keywords
+     */
+    keywords?: string[];
+    /**
+     * The package author.
+     * @see https://docs.npmjs.com/creating-a-package-json-file#author-field
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#people-fields-author-contributors
+     */
+    author?: IPackageJsonPerson;
+    /**
+     * The contributors for the package.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#people-fields-author-contributors
+     */
+    contributors?: IPackageJsonPerson[];
+    /**
+     * The project homepage.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#homepage
+     */
+    homepage?: string;
+    /**
+     * The source repository for the package.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#repository
+     */
+    repository?: IPackageJsonRepository;
+    /**
+     * The issue tracker for the package.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bugs
+     */
+    bugs?: IPackageJsonBugs;
+    /**
+     * The SPDX license expression for the package.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#license
+     */
+    license?: string;
+    /**
+     * Whether the package is private and should not be published.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#private
+     */
+    private?: boolean;
+    /**
+     * The module system for .js files in the package.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#type
+     */
+    type?: "commonjs" | "module";
+    /**
+     * The primary package entry point.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#main
+     */
+    main?: string;
+    /**
+     * The TypeScript declaration entry point.
+     */
+    types?: string;
+    /**
+     * The executable entry points for the package.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin
+     */
+    bin?: string | IPackageJsonStringMap;
+    /**
+     * The files to include when the package is packed or published.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#files
+     */
+    files?: string[];
+    /**
+     * The lifecycle scripts for the package.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#scripts
+     */
+    scripts?: IPackageJsonStringMap;
+    /**
+     * The dependencies for the package.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#dependencies
+     */
+    dependencies?: IPackageJsonStringMap;
+    /**
+     * The development-only dependencies for the package.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#devdependencies
+     */
+    devDependencies?: IPackageJsonStringMap;
+    /**
+     * The peer dependencies for the package.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependencies
+     */
+    peerDependencies?: IPackageJsonStringMap;
+    /**
+     * The optional dependencies for the package.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#optionaldependencies
+     */
+    optionalDependencies?: IPackageJsonStringMap;
+    /**
+     * Runtime engine constraints for the package.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#engines
+     */
+    engines?: IPackageJsonStringMap;
+    /**
+     * Publish-time npm configuration.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#publishconfig
+     */
+    publishConfig?: IPackageJsonPublishConfig;
+    /**
+     * Workspace globs for a monorepo root package.
+     * @see https://docs.npmjs.com/cli/v11/configuring-npm/package-json#workspaces
+     */
+    workspaces?: string[];
+}

package/dist/types/models/packageJson/IPackageJsonBugs.d.ts

@@ -0,0 +1,7 @@
+/**
+ * A package bugs field.
+ */
+export type IPackageJsonBugs = string | {
+    url?: string;
+    email?: string;
+};

package/dist/types/models/packageJson/IPackageJsonPerson.d.ts

@@ -0,0 +1,8 @@
+/**
+ * A package person field.
+ */
+export type IPackageJsonPerson = string | {
+    name: string;
+    email?: string;
+    url?: string;
+};

package/dist/types/models/packageJson/IPackageJsonPublishConfig.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Publish-time npm configuration.
+ */
+export interface IPackageJsonPublishConfig {
+    [id: string]: string | boolean;
+}

package/dist/types/models/packageJson/IPackageJsonRepository.d.ts

@@ -0,0 +1,8 @@
+/**
+ * A package repository field.
+ */
+export type IPackageJsonRepository = string | {
+    type?: string;
+    url: string;
+    directory?: string;
+};

package/dist/types/models/packageJson/IPackageJsonStringMap.d.ts

@@ -0,0 +1,6 @@
+/**
+ * A map of package names to version specifiers.
+ */
+export interface IPackageJsonStringMap {
+    [id: string]: string;
+}

package/docs/changelog.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## [0.0.3-next.16](https://github.com/twinfoundation/tools/compare/tools-models-v0.0.3-next.15...tools-models-v0.0.3-next.16) (2026-03-19)
+
+
+### Features
+
+* ts to schema ([#86](https://github.com/twinfoundation/tools/issues/86)) ([ffebda5](https://github.com/twinfoundation/tools/commit/ffebda5f14ab5ec734bf37c9fb70a7ec3d4012c3))
+
+## Changelog

package/docs/examples.md

@@ -0,0 +1,85 @@
+# Tools Models Examples
+
+This package exports the shared interfaces and constants used by the generator libraries and CLI applications. In most cases you will use these types to describe JSON Schema and OpenAPI documents in a type-safe way.
+
+## Define A JSON Schema Document
+
+```ts
+import type { IJsonSchema, JsonSchemaTypeNames } from '@twin.org/tools-models';
+
+const schemaType: JsonSchemaTypeNames = 'object';
+
+const productSchema: IJsonSchema = {
+  $schema: 'https://json-schema.org/draft/2020-12/schema',
+  $id: 'https://schema.example.com/catalog/product',
+  title: 'Product',
+  type: schemaType,
+  properties: {
+    id: { type: 'string' },
+    name: { type: 'string', minLength: 1 },
+    price: { type: 'number', minimum: 0 }
+  },
+  required: ['id', 'name', 'price'],
+  additionalProperties: false
+};
+```
+
+## Work With Supported JSON Schema Tags
+
+`JsonSchemaTagNames` lists the tag names recognised by the schema builders after alias mapping. This is useful when validating custom documentation tags before handing source files to the generator.
+
+```ts
+import { JsonSchemaTagNames } from '@twin.org/tools-models';
+
+const supportedTags = new Set(JsonSchemaTagNames);
+
+if (supportedTags.has('minimum')) {
+  console.log('minimum is supported');
+}
+```
+
+## Define An OpenAPI Document
+
+```ts
+import type { IOpenApi } from '@twin.org/tools-models';
+
+const openApiDocument: IOpenApi = {
+  openapi: '3.1.1',
+  info: {
+    title: 'Catalog API',
+    version: '1.0.0',
+    description: 'Operations for querying catalogue entries.'
+  },
+  paths: {
+    '/products/{productId}': {
+      get: {
+        operationId: 'getProduct',
+        responses: {
+          '200': {
+            description: 'The requested product.',
+            content: {
+              'application/json': {
+                schema: {
+                  $ref: '#/components/schemas/Product'
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  components: {
+    schemas: {
+      Product: {
+        type: 'object',
+        properties: {
+          id: { type: 'string' },
+          name: { type: 'string' }
+        },
+        required: ['id', 'name']
+      }
+    }
+  }
+};
+```

package/docs/reference/classes/OpenApiConstants.md

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

package/docs/reference/index.md

@@ -0,0 +1,48 @@
+# @twin.org/tools-models
+
+## Classes
+
+- [OpenApiConstants](classes/OpenApiConstants.md)
+
+## Interfaces
+
+- [IJsonSchema](interfaces/IJsonSchema.md)
+- [IOpenApi](interfaces/IOpenApi.md)
+- [IOpenApiComponents](interfaces/IOpenApiComponents.md)
+- [IOpenApiContact](interfaces/IOpenApiContact.md)
+- [IOpenApiExample](interfaces/IOpenApiExample.md)
+- [IOpenApiExternalDocumentation](interfaces/IOpenApiExternalDocumentation.md)
+- [IOpenApiHeader](interfaces/IOpenApiHeader.md)
+- [IOpenApiInfo](interfaces/IOpenApiInfo.md)
+- [IOpenApiLicense](interfaces/IOpenApiLicense.md)
+- [IOpenApiMediaType](interfaces/IOpenApiMediaType.md)
+- [IOpenApiOAuthFlow](interfaces/IOpenApiOAuthFlow.md)
+- [IOpenApiOAuthFlows](interfaces/IOpenApiOAuthFlows.md)
+- [IOpenApiParameter](interfaces/IOpenApiParameter.md)
+- [IOpenApiPathItem](interfaces/IOpenApiPathItem.md)
+- [IOpenApiPathMethod](interfaces/IOpenApiPathMethod.md)
+- [IOpenApiReference](interfaces/IOpenApiReference.md)
+- [IOpenApiRequestBody](interfaces/IOpenApiRequestBody.md)
+- [IOpenApiResponse](interfaces/IOpenApiResponse.md)
+- [IOpenApiResponses](interfaces/IOpenApiResponses.md)
+- [IOpenApiSecurityRequirement](interfaces/IOpenApiSecurityRequirement.md)
+- [IOpenApiServer](interfaces/IOpenApiServer.md)
+- [IOpenApiServerVariable](interfaces/IOpenApiServerVariable.md)
+- [IOpenApiTag](interfaces/IOpenApiTag.md)
+- [IPackageJson](interfaces/IPackageJson.md)
+- [IPackageJsonPublishConfig](interfaces/IPackageJsonPublishConfig.md)
+- [IPackageJsonStringMap](interfaces/IPackageJsonStringMap.md)
+
+## Type Aliases
+
+- [JsonSchemaTypeNames](type-aliases/JsonSchemaTypeNames.md)
+- [OpenApiParameterLocation](type-aliases/OpenApiParameterLocation.md)
+- [OpenApiParameterStyle](type-aliases/OpenApiParameterStyle.md)
+- [IOpenApiSecurityScheme](type-aliases/IOpenApiSecurityScheme.md)
+- [IPackageJsonBugs](type-aliases/IPackageJsonBugs.md)
+- [IPackageJsonPerson](type-aliases/IPackageJsonPerson.md)
+- [IPackageJsonRepository](type-aliases/IPackageJsonRepository.md)
+
+## Variables
+
+- [JsonSchemaTagNames](variables/JsonSchemaTagNames.md)