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

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

@@ -0,0 +1,70 @@
+import type { IOpenApiExample } from "./IOpenApiExample.js";
+import type { IOpenApiHeader } from "./IOpenApiHeader.js";
+import type { IOpenApiMediaType } from "./IOpenApiMediaType.js";
+import type { IOpenApiParameter } from "./IOpenApiParameter.js";
+import type { IOpenApiPathItem } from "./IOpenApiPathItem.js";
+import type { IOpenApiReference } from "./IOpenApiReference.js";
+import type { IOpenApiRequestBody } from "./IOpenApiRequestBody.js";
+import type { IOpenApiResponse } from "./IOpenApiResponse.js";
+import type { IOpenApiSecurityScheme } from "./IOpenApiSecurityScheme.js";
+import type { IJsonSchema } from "../jsonSchema/IJsonSchema.js";
+/**
+ * An OpenAPI Components Object.
+ * @see https://spec.openapis.org/oas/latest.html#components-object
+ */
+export interface IOpenApiComponents {
+    /**
+     * Reusable schemas.
+     */
+    schemas?: {
+        [name: string]: IJsonSchema | boolean;
+    };
+    /**
+     * Reusable responses.
+     */
+    responses?: {
+        [name: string]: IOpenApiResponse | IOpenApiReference;
+    };
+    /**
+     * Reusable parameters.
+     */
+    parameters?: {
+        [name: string]: IOpenApiParameter | IOpenApiReference;
+    };
+    /**
+     * Reusable examples.
+     */
+    examples?: {
+        [name: string]: IOpenApiExample | IOpenApiReference;
+    };
+    /**
+     * Reusable request bodies.
+     */
+    requestBodies?: {
+        [name: string]: IOpenApiRequestBody | IOpenApiReference;
+    };
+    /**
+     * Reusable headers.
+     */
+    headers?: {
+        [name: string]: IOpenApiHeader | IOpenApiReference;
+    };
+    /**
+     * Reusable security schemes.
+     */
+    securitySchemes?: {
+        [name: string]: IOpenApiSecurityScheme | IOpenApiReference;
+    };
+    /**
+     * Reusable path items.
+     */
+    pathItems?: {
+        [name: string]: IOpenApiPathItem;
+    };
+    /**
+     * Reusable media types.
+     */
+    mediaTypes?: {
+        [name: string]: IOpenApiMediaType | IOpenApiReference;
+    };
+}

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

@@ -0,0 +1,21 @@
+/**
+ * An OpenAPI Contact Object.
+ * @see https://spec.openapis.org/oas/latest.html#contact-object
+ */
+export interface IOpenApiContact {
+    /**
+     * The identifying name of the contact person or organisation.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-1
+     */
+    name?: string;
+    /**
+     * The URI for the contact information.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-1
+     */
+    url?: string;
+    /**
+     * The email address for the contact.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-1
+     */
+    email?: string;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * An OpenAPI Example Object.
+ * @see https://spec.openapis.org/oas/latest.html#example-object
+ */
+export interface IOpenApiExample {
+    /**
+     * Short description for the example.
+     */
+    summary?: string;
+    /**
+     * Long description for the example.
+     */
+    description?: string;
+    /**
+     * The schema-ready value for the example.
+     */
+    dataValue?: unknown;
+    /**
+     * The serialized form of the example.
+     */
+    serializedValue?: string;
+    /**
+     * An external URI for the serialized example.
+     */
+    externalValue?: string;
+    /**
+     * Backwards-compatible embedded example value.
+     */
+    value?: unknown;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * An OpenAPI External Documentation Object.
+ * @see https://spec.openapis.org/oas/latest.html#external-documentation-object
+ */
+export interface IOpenApiExternalDocumentation {
+    /**
+     * A description of the target documentation.
+     */
+    description?: string;
+    /**
+     * The URI for the target documentation.
+     */
+    url: string;
+}

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

@@ -0,0 +1,50 @@
+import type { IOpenApiExample } from "./IOpenApiExample.js";
+import type { IOpenApiMediaType } from "./IOpenApiMediaType.js";
+import type { IOpenApiReference } from "./IOpenApiReference.js";
+import type { IJsonSchema } from "../jsonSchema/IJsonSchema.js";
+/**
+ * An OpenAPI Header Object.
+ * @see https://spec.openapis.org/oas/latest.html#header-object
+ */
+export interface IOpenApiHeader {
+    /**
+     * The description of the header.
+     */
+    description?: string;
+    /**
+     * Whether the header is required.
+     */
+    required?: boolean;
+    /**
+     * Whether the header is deprecated.
+     */
+    deprecated?: boolean;
+    /**
+     * A shorthand example for the header.
+     */
+    example?: unknown;
+    /**
+     * Named examples for the header.
+     */
+    examples?: {
+        [id: string]: IOpenApiExample | IOpenApiReference;
+    };
+    /**
+     * The serialization style for the header.
+     */
+    style?: "simple";
+    /**
+     * Whether exploded serialization is used.
+     */
+    explode?: boolean;
+    /**
+     * The schema of the header.
+     */
+    schema?: IJsonSchema;
+    /**
+     * The content definition for the header.
+     */
+    content?: {
+        [contentType: string]: IOpenApiMediaType | IOpenApiReference;
+    };
+}

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

@@ -0,0 +1,43 @@
+import type { IOpenApiContact } from "./IOpenApiContact.js";
+import type { IOpenApiLicense } from "./IOpenApiLicense.js";
+/**
+ * An OpenAPI Info Object.
+ * @see https://spec.openapis.org/oas/latest.html#info-object
+ */
+export interface IOpenApiInfo {
+    /**
+     * The title of the API.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-0
+     */
+    title: string;
+    /**
+     * A short summary of the API.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-0
+     */
+    summary?: string;
+    /**
+     * A description of the API.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-0
+     */
+    description?: string;
+    /**
+     * The terms of service URI.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-0
+     */
+    termsOfService?: string;
+    /**
+     * Contact information for the API.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-0
+     */
+    contact?: IOpenApiContact;
+    /**
+     * License information for the API.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-0
+     */
+    license?: IOpenApiLicense;
+    /**
+     * The version of the API description.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-0
+     */
+    version: string;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * An OpenAPI License Object.
+ * @see https://spec.openapis.org/oas/latest.html#license-object
+ */
+export interface IOpenApiLicense {
+    /**
+     * The license name.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-2
+     */
+    name: string;
+    /**
+     * The SPDX license expression.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-2
+     */
+    identifier?: string;
+    /**
+     * The URI for the license.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-2
+     */
+    url?: string;
+}

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

@@ -0,0 +1,41 @@
+import type { IOpenApiExample } from "./IOpenApiExample.js";
+import type { IOpenApiReference } from "./IOpenApiReference.js";
+import type { IJsonSchema } from "../jsonSchema/IJsonSchema.js";
+/**
+ * An OpenAPI Media Type Object.
+ * @see https://spec.openapis.org/oas/latest.html#media-type-object
+ */
+export interface IOpenApiMediaType {
+    /**
+     * A schema describing the complete content.
+     */
+    schema?: IJsonSchema;
+    /**
+     * A schema describing each item within a sequential media type.
+     */
+    itemSchema?: IJsonSchema;
+    /**
+     * A single shorthand example.
+     */
+    example?: unknown;
+    /**
+     * Named examples for the media type.
+     */
+    examples?: {
+        [id: string]: IOpenApiExample | IOpenApiReference;
+    };
+    /**
+     * Encoding metadata keyed by property name.
+     */
+    encoding?: {
+        [id: string]: unknown;
+    };
+    /**
+     * Positional encoding metadata for multipart payloads.
+     */
+    prefixEncoding?: unknown[];
+    /**
+     * Repeating item encoding metadata for multipart payloads.
+     */
+    itemEncoding?: unknown;
+}

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

@@ -0,0 +1,28 @@
+/**
+ * An OpenAPI OAuth Flow Object.
+ * @see https://spec.openapis.org/oas/latest.html#oauth-flow-object
+ */
+export interface IOpenApiOAuthFlow {
+    /**
+     * The authorization URL for this flow.
+     */
+    authorizationUrl?: string;
+    /**
+     * The device authorization URL for this flow.
+     */
+    deviceAuthorizationUrl?: string;
+    /**
+     * The token URL for this flow.
+     */
+    tokenUrl?: string;
+    /**
+     * The refresh URL for this flow.
+     */
+    refreshUrl?: string;
+    /**
+     * Available scopes for this flow.
+     */
+    scopes: {
+        [name: string]: string;
+    };
+}

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

@@ -0,0 +1,27 @@
+import type { IOpenApiOAuthFlow } from "./IOpenApiOAuthFlow.js";
+/**
+ * An OpenAPI OAuth Flows Object.
+ * @see https://spec.openapis.org/oas/latest.html#oauth-flows-object
+ */
+export interface IOpenApiOAuthFlows {
+    /**
+     * Configuration for the implicit flow.
+     */
+    implicit?: IOpenApiOAuthFlow;
+    /**
+     * Configuration for the resource owner password flow.
+     */
+    password?: IOpenApiOAuthFlow;
+    /**
+     * Configuration for the client credentials flow.
+     */
+    clientCredentials?: IOpenApiOAuthFlow;
+    /**
+     * Configuration for the authorization code flow.
+     */
+    authorizationCode?: IOpenApiOAuthFlow;
+    /**
+     * Configuration for the device authorization flow.
+     */
+    deviceAuthorization?: IOpenApiOAuthFlow;
+}

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

@@ -0,0 +1,74 @@
+import type { IOpenApiExample } from "./IOpenApiExample.js";
+import type { IOpenApiMediaType } from "./IOpenApiMediaType.js";
+import type { IOpenApiReference } from "./IOpenApiReference.js";
+import type { IJsonSchema } from "../jsonSchema/IJsonSchema.js";
+/**
+ * The supported parameter locations.
+ */
+export type OpenApiParameterLocation = "path" | "query" | "querystring" | "header" | "cookie";
+/**
+ * The supported parameter styles.
+ */
+export type OpenApiParameterStyle = "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | "cookie";
+/**
+ * An OpenAPI Parameter Object.
+ * @see https://spec.openapis.org/oas/latest.html#parameter-object
+ */
+export interface IOpenApiParameter {
+    /**
+     * The name of the parameter.
+     */
+    name: string;
+    /**
+     * The location of the parameter.
+     */
+    in: OpenApiParameterLocation;
+    /**
+     * A brief description of the parameter.
+     */
+    description?: string;
+    /**
+     * Whether the parameter is required.
+     */
+    required?: boolean;
+    /**
+     * Whether the parameter is deprecated.
+     */
+    deprecated?: boolean;
+    /**
+     * Whether empty values are allowed for query parameters.
+     */
+    allowEmptyValue?: boolean;
+    /**
+     * A shorthand example for the parameter.
+     */
+    example?: unknown;
+    /**
+     * Named examples for the parameter.
+     */
+    examples?: {
+        [id: string]: IOpenApiExample | IOpenApiReference;
+    };
+    /**
+     * The serialization style for the parameter.
+     */
+    style?: OpenApiParameterStyle;
+    /**
+     * Whether exploded serialization is used.
+     */
+    explode?: boolean;
+    /**
+     * Whether reserved characters may pass through unchanged.
+     */
+    allowReserved?: boolean;
+    /**
+     * The schema describing the parameter.
+     */
+    schema?: IJsonSchema;
+    /**
+     * Content-based parameter serialization.
+     */
+    content?: {
+        [contentType: string]: IOpenApiMediaType | IOpenApiReference;
+    };
+}

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

@@ -0,0 +1,72 @@
+import type { IOpenApiParameter } from "./IOpenApiParameter.js";
+import type { IOpenApiPathMethod } from "./IOpenApiPathMethod.js";
+import type { IOpenApiReference } from "./IOpenApiReference.js";
+import type { IOpenApiServer } from "./IOpenApiServer.js";
+/**
+ * An OpenAPI Path Item Object.
+ * @see https://spec.openapis.org/oas/latest.html#path-item-object
+ */
+export interface IOpenApiPathItem {
+    /**
+     * A referenced definition of this path item.
+     */
+    $ref?: string;
+    /**
+     * A summary applying to all operations in the path.
+     */
+    summary?: string;
+    /**
+     * A description applying to all operations in the path.
+     */
+    description?: string;
+    /**
+     * A GET operation on the path.
+     */
+    get?: IOpenApiPathMethod;
+    /**
+     * A PUT operation on the path.
+     */
+    put?: IOpenApiPathMethod;
+    /**
+     * A POST operation on the path.
+     */
+    post?: IOpenApiPathMethod;
+    /**
+     * A DELETE operation on the path.
+     */
+    delete?: IOpenApiPathMethod;
+    /**
+     * An OPTIONS operation on the path.
+     */
+    options?: IOpenApiPathMethod;
+    /**
+     * A HEAD operation on the path.
+     */
+    head?: IOpenApiPathMethod;
+    /**
+     * A PATCH operation on the path.
+     */
+    patch?: IOpenApiPathMethod;
+    /**
+     * A TRACE operation on the path.
+     */
+    trace?: IOpenApiPathMethod;
+    /**
+     * A QUERY operation on the path.
+     */
+    query?: IOpenApiPathMethod;
+    /**
+     * Additional non-standard HTTP operations keyed by method name.
+     */
+    additionalOperations?: {
+        [method: string]: IOpenApiPathMethod;
+    };
+    /**
+     * Alternative servers for this path.
+     */
+    servers?: IOpenApiServer[];
+    /**
+     * Shared parameters for all operations on this path.
+     */
+    parameters?: (IOpenApiParameter | IOpenApiReference)[];
+}

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

@@ -0,0 +1,75 @@
+import type { IOpenApiExternalDocumentation } from "./IOpenApiExternalDocumentation.js";
+import type { IOpenApiParameter } from "./IOpenApiParameter.js";
+import type { IOpenApiReference } from "./IOpenApiReference.js";
+import type { IOpenApiRequestBody } from "./IOpenApiRequestBody.js";
+import type { IOpenApiResponses } from "./IOpenApiResponses.js";
+import type { IOpenApiSecurityRequirement } from "./IOpenApiSecurityRequirement.js";
+import type { IOpenApiServer } from "./IOpenApiServer.js";
+/**
+ * An OpenAPI Operation Object.
+ * @see https://spec.openapis.org/oas/latest.html#operation-object
+ */
+export interface IOpenApiPathMethod {
+    /**
+     * Tags for the operation.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-7
+     */
+    tags?: string[];
+    /**
+     * A short summary of the operation.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-7
+     */
+    summary?: string;
+    /**
+     * A verbose description of the operation.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-7
+     */
+    description?: string;
+    /**
+     * Additional external documentation for the operation.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-7
+     */
+    externalDocs?: IOpenApiExternalDocumentation;
+    /**
+     * A unique identifier for the operation.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-7
+     */
+    operationId?: string;
+    /**
+     * Parameters for the operation.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-7
+     */
+    parameters?: (IOpenApiParameter | IOpenApiReference)[];
+    /**
+     * The request body for the operation.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-7
+     */
+    requestBody?: IOpenApiRequestBody | IOpenApiReference;
+    /**
+     * The responses for the operation.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-7
+     */
+    responses: IOpenApiResponses;
+    /**
+     * Callbacks related to the operation.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-7
+     */
+    callbacks?: {
+        [id: string]: unknown;
+    };
+    /**
+     * Whether the operation is deprecated.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-7
+     */
+    deprecated?: boolean;
+    /**
+     * Security requirements for the operation.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-7
+     */
+    security?: IOpenApiSecurityRequirement[];
+    /**
+     * Alternative servers for the operation.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-7
+     */
+    servers?: IOpenApiServer[];
+}

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

@@ -0,0 +1,18 @@
+/**
+ * An OpenAPI Reference Object.
+ * @see https://spec.openapis.org/oas/latest.html#reference-object
+ */
+export interface IOpenApiReference {
+    /**
+     * The reference identifier.
+     */
+    $ref: string;
+    /**
+     * A summary override for the referenced object.
+     */
+    summary?: string;
+    /**
+     * A description override for the referenced object.
+     */
+    description?: string;
+}

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

@@ -0,0 +1,22 @@
+import type { IOpenApiMediaType } from "./IOpenApiMediaType.js";
+import type { IOpenApiReference } from "./IOpenApiReference.js";
+/**
+ * An OpenAPI Request Body Object.
+ * @see https://spec.openapis.org/oas/latest.html#request-body-object
+ */
+export interface IOpenApiRequestBody {
+    /**
+     * A brief description of the request body.
+     */
+    description?: string;
+    /**
+     * The content of the request body.
+     */
+    content: {
+        [contentType: string]: IOpenApiMediaType | IOpenApiReference;
+    };
+    /**
+     * Whether the request body is required.
+     */
+    required?: boolean;
+}

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

@@ -0,0 +1,35 @@
+import type { IOpenApiHeader } from "./IOpenApiHeader.js";
+import type { IOpenApiMediaType } from "./IOpenApiMediaType.js";
+import type { IOpenApiReference } from "./IOpenApiReference.js";
+/**
+ * An OpenAPI Response Object.
+ * @see https://spec.openapis.org/oas/latest.html#response-object
+ */
+export interface IOpenApiResponse {
+    /**
+     * A short summary of the meaning of the response.
+     */
+    summary?: string;
+    /**
+     * A description of the response.
+     */
+    description: string;
+    /**
+     * The headers for the response.
+     */
+    headers?: {
+        [id: string]: IOpenApiHeader | IOpenApiReference;
+    };
+    /**
+     * The content for the response.
+     */
+    content?: {
+        [contentType: string]: IOpenApiMediaType | IOpenApiReference;
+    };
+    /**
+     * Design-time links from this response.
+     */
+    links?: {
+        [id: string]: unknown;
+    };
+}

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

@@ -0,0 +1,18 @@
+import type { IOpenApiReference } from "./IOpenApiReference.js";
+import type { IOpenApiResponse } from "./IOpenApiResponse.js";
+/**
+ * An OpenAPI Responses Object.
+ * @see https://spec.openapis.org/oas/latest.html#responses-object
+ */
+export interface IOpenApiResponses {
+    /**
+     * Named HTTP status code or status code range responses.
+     * @see https://spec.openapis.org/oas/latest.html#patterned-fields-0
+     */
+    [code: string]: IOpenApiResponse | IOpenApiReference | undefined;
+    /**
+     * The default response for otherwise undeclared status codes.
+     * @see https://spec.openapis.org/oas/latest.html#fixed-fields-13
+     */
+    default?: IOpenApiResponse | IOpenApiReference;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * An OpenAPI Security Requirement Object.
+ * @see https://spec.openapis.org/oas/latest.html#security-requirement-object
+ */
+export interface IOpenApiSecurityRequirement {
+    [name: string]: string[];
+}