@twin.org/ts-to-openapi 0.0.1-next.2

package/dist/locales/en.json

@@ -0,0 +1,274 @@
+{
+  "error": {
+    "commands": {
+      "ts-to-openapi": {
+        "configFailed": "Configuration failed to load.",
+        "missingRestRoutesEntryPoints": "Missing REST routes method \"{method}\" in package \"{package}\".",
+        "missingRestRoutesEntryPoint": "Missing REST routes entryPoint \"{entryPoint}\" in package \"{package}\".",
+        "unsupportedProperties": "Unsupported properties found in the request object \"{keys}\"."
+      },
+      "common": {
+        "missingEnv": "The \"{option}\" option is configured as an environment variable, but there is no environment variable with the name \"{value}\" set.",
+        "optionInvalidHex": "The \"{option}\" does not appear to be hex. \"{value}\"",
+        "optionInvalidBase64": "The \"{option}\" does not appear to be base64. \"{value}\"",
+        "optionInvalidHexBase64": "The \"{option}\" does not appear to be hex or base64. \"{value}\"",
+        "optionInvalidBech32": "The \"{option}\" does not appear to be bech32. \"{value}\"",
+        "optionMinValue": "The \"{option}\" option must be greater than or equal to {minValue}, it is {value}.",
+        "optionMaxValue": "The \"{option}\" option must be less than or equal to {maxValue}, it is {value}."
+      }
+    },
+    "baseRestClient": {
+      "missingRouteProp": "Missing route parameter in data \"{routeProp}\" for route \"{route}\"",
+      "decodingFailed": "Decoding JSON failed for route \"{route}\"",
+      "failureStatusText": "The request to the API failed: \"{statusText}\""
+    },
+    "validation": {
+      "beEmpty": "{fieldName} must be empty",
+      "beNotEmpty": "{fieldName} must not be empty",
+      "beText": "{fieldName} must be text",
+      "beTextValue": "{fieldName} must contain some text",
+      "beTextMinMax": "{fieldName} must be longer than {minLength} and shorter than {maxLength} characters",
+      "beTextMin": "{fieldName} must be longer than {minLength} characters",
+      "beTextMax": "{fieldName} must be shorter than {maxLength} characters",
+      "beNumber": "{fieldName} must be a number",
+      "beNumberMinMax": "{fieldName} must be >= {minValue} and <= {maxValue}",
+      "beNumberMin": "{fieldName} must be >= {minValue}",
+      "beNumberMax": "{fieldName} must be <= {maxValue}",
+      "beWholeNumber": "{fieldName} must be a whole number",
+      "beWholeNumberMinMax": "{fieldName} must be a whole number >= {minValue} and <= {maxValue}",
+      "beWholeNumberMin": "{fieldName} must be a whole number >= {minValue}",
+      "beWholeNumberMax": "{fieldName} must be a whole number <= {maxValue}",
+      "beBigInteger": "{fieldName} must be a bigint",
+      "beBigIntegerMinMax": "{fieldName} must be a bigint >= {minValue} and <= {maxValue}",
+      "beBigIntegerMin": "{fieldName} must be a bigint >= {minValue}",
+      "beBigIntegerMax": "{fieldName} must be a bigint <= {maxValue}",
+      "beBoolean": "{fieldName} must be true or false",
+      "beDate": "{fieldName} must be a date",
+      "beDateTime": "{fieldName} must be a date/time",
+      "beTime": "{fieldName} must be a time",
+      "beTimestampMilliseconds": "{fieldName} must be a timestamp in milliseconds",
+      "beTimestampSeconds": "{fieldName} must be a timestamp in seconds",
+      "beObject": "{fieldName} must be an object",
+      "beArray": "{fieldName} must be an array",
+      "beArrayValue": "{fieldName} must be an array with at least one item",
+      "beIncluded": "{fieldName} is unrecognised",
+      "beByteArray": "{fieldName} must be a byte array",
+      "beUrn": "{fieldName} must be a correctly formatted urn",
+      "beUrl": "{fieldName} must be a correctly formatted url",
+      "beJSON": "{fieldName} must be correctly formatted JSON",
+      "beEmail": "{fieldName} must be a correctly formatted e-mail address",
+      "failed": "Validation failed",
+      "failedObject": "Validation of \"{objectName}\" failed"
+    },
+    "guard": {
+      "undefined": "Property \"{property}\" must be defined, it is \"{value}\"",
+      "string": "Property \"{property}\" must be a string, it is \"{value}\"",
+      "stringEmpty": "Property \"{property}\" must have a value, it is empty",
+      "stringBase64": "Property \"{property}\" must be a base64 encoded string, it is \"{value}\"",
+      "stringBase64Url": "Property \"{property}\" must be a base64 url encoded string, it is \"{value}\"",
+      "stringHex": "Property \"{property}\" must be a hex string, it is \"{value}\"",
+      "stringHexLength": "Property \"{property}\" must be a hex string of length \"{options}\", it is \"{value}\"",
+      "number": "Property \"{property}\" must be a number, it is \"{value}\"",
+      "integer": "Property \"{property}\" must be an integer, it is \"{value}\"",
+      "bigint": "Property \"{property}\" must be a bigint, it is \"{value}\"",
+      "boolean": "Property \"{property}\" must be a boolean, it is \"{value}\"",
+      "date": "Property \"{property}\" must be a date, it is \"{value}\"",
+      "timestampMilliseconds": "Property \"{property}\" must be a timestamp in milliseconds, it is \"{value}\"",
+      "timestampSeconds": "Property \"{property}\" must be a timestamp in seconds, it is \"{value}\"",
+      "objectUndefined": "Property \"{property}\" must be an object, it is \"undefined\"",
+      "object": "Property \"{property}\" must be an object, it is \"{value}\"",
+      "objectValue": "Property \"{property}\" must be an object, with at least one property, it is \"{value}\"",
+      "array": "Property \"{property}\" must be an array, it is \"{value}\"",
+      "arrayValue": "Property \"{property}\" must be an array with at least one item",
+      "arrayOneOf": "Property \"{property}\" must be one of [{options}], it is \"{value}\"",
+      "uint8Array": "Property \"{property}\" must be a Uint8Array, it is \"{value}\"",
+      "function": "Property \"{property}\" must be a function, it is \"{value}\"",
+      "urn": "Property \"{property}\" must be a Urn formatted string, it is \"{value}\"",
+      "url": "Property \"{property}\" must be a Url formatted string, it is \"{value}\"",
+      "email": "Property \"{property}\" must be string in e-mail format, it is \"{value}\"",
+      "length32Multiple": "Property \"{property}\" should be a multiple of 32, it is {value}",
+      "lengthEntropy": "Property \"{property}\" should be a multiple of 4, >=16 and <= 32, it is {value}",
+      "length3Multiple": "Property \"{property}\" should be a multiple of 3, it is {value}",
+      "greaterThan0": "Property \"{property}\" must be greater than zero, it is {value}"
+    },
+    "objectHelper": {
+      "failedBytesToJSON": "Failed converting bytes to JSON"
+    },
+    "common": {
+      "notImplementedMethod": "The method \"{method}\" has not been implemented",
+      "validation": "Validation failed"
+    },
+    "factory": {
+      "noUnregister": "There is no {typeName} registered with the name \"{name}\"",
+      "noGet": "The requested {typeName} \"{name}\" does not exist in the factory"
+    },
+    "bitString": {
+      "outOfRange": "The index should be >= 0 and less than the length of the bit string"
+    },
+    "fetchHelper": {
+      "decodingJSON": "Decoding JSON failed for route \"{route}\"",
+      "failureStatusText": "The request to the API failed: \"{statusText}\"",
+      "connectivity": "The request failed, the API could be offline, or there are other connectivity issues",
+      "timeout": "The request timed out",
+      "general": "A general failure occurred during the request"
+    },
+    "jwt": {
+      "noKeyOrSigner": "No key or signer was provided for JWT creation",
+      "noKeyOrVerifier": "No key or verifier was provided for JWT creation"
+    },
+    "bip39": {
+      "missingMnemonicWord": "The mnemonic contains a word not in the wordlist, \"{value}\"",
+      "checksumMismatch": "The checksum does not match \"{newChecksum}\" != \"{checksumBits}\""
+    },
+    "ed25519": {
+      "privateKeyLength": "The private key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\"",
+      "publicKeyLength": "The public key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\""
+    },
+    "secp256k1": {
+      "privateKeyLength": "The private key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\"",
+      "publicKeyLength": "The public key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\""
+    },
+    "x25519": {
+      "invalidPublicKey": "Invalid Ed25519 Public Key"
+    },
+    "blake2b": {
+      "outputLength64": "The output length should be between 1 and 64, it is \"{outputLength}\"",
+      "keyLength64": "The key length should be between 1 and 64, it is \"{keyLength}\""
+    },
+    "sha512": {
+      "bitSize": "Only 224, 256, 384 or 512 bits are supported, it is \"{bitSize}\""
+    },
+    "sha256": {
+      "bitSize": "Only 224 or 256 bits are supported, it is \"{bitSize}\""
+    },
+    "hmacSha256": {
+      "bitSize": "Only 224 or 256 bits are supported, it is \"{bitSize}\""
+    },
+    "hmacSha512": {
+      "bitSize": "Only 224, 256, 384 or 512 bits are supported, it is \"{bitSize}\""
+    },
+    "base32": {
+      "invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
+    },
+    "base64": {
+      "length4Multiple": "Invalid length should be a multiple of 4, it is \"{value}\""
+    },
+    "bech32": {
+      "decodeFailed": "The address contains decoding failed for address \"{bech32}\"",
+      "invalidChecksum": "The address contains an invalid checksum in address, \"{bech32}\"",
+      "separatorMisused": "The separator character '1' should only be used between hrp and data, \"{bech32}\"",
+      "lowerUpper": "The address my use either lowercase or uppercase, \"{bech32}\"",
+      "dataTooShort": "The address does not contain enough data to decode, \"{bech32}\""
+    },
+    "pbkdf2": {
+      "keyTooLong": "The requested key length \"{keyLength}\" is too long, based on the \"{macLength}\""
+    },
+    "chaCha20Poly1305": {
+      "noAadWithData": "You can not set the aad when there is already data",
+      "noAuthTag": "Can not finalise when the auth tag is not set",
+      "authenticationFailed": "The data could not be authenticated",
+      "authTagDecrypting": "Can not get the auth tag when decrypting",
+      "authTagEncrypting": "Can not set the auth tag when encrypting",
+      "noAuthTagSet": "The auth tag has not been set"
+    },
+    "bip44": {
+      "unsupportedKeyType": "The key type \"{keyType}\" is not supported"
+    },
+    "slip0010": {
+      "invalidSeed": "The seed is invalid \"{seed}\""
+    }
+  },
+  "commands": {
+    "ts-to-openapi": {
+      "options": {
+        "config": {
+          "param": "'<'config'>'",
+          "description": "Path to the JSON configuration file."
+        },
+        "output-file": {
+          "param": "'<'output-file'>'",
+          "description": "The JSON file to write the OpenAPI spec."
+        }
+      },
+      "progress": {
+        "loadingConfigJson": "Loading Config JSON",
+        "creatingWorkingDir": "Creating Working Directory",
+        "creatingSecuritySchemas": "Creating Security Schemas",
+        "generatingSchemas": "Generating Schemas",
+        "finalisingSchemas": "Finalising Schemas",
+        "writingOutputFile": "Writing Output File",
+        "models": "Models",
+        "installingNpmPackages": "Installing NPM Packages",
+        "processingPackage": "Processing Package",
+        "importingModule": "Importing Module",
+        "processingRoutes": "Processing Routes"
+      },
+      "labels": {
+        "configJson": "Config JSON",
+        "outputFile": "Output File",
+        "outputWorkingDir": "Output Working Directory",
+        "route": "Route"
+      }
+    }
+  },
+  "errorNames": {
+    "error": "Error",
+    "generalError": "General",
+    "guardError": "Guard",
+    "conflictError": "Conflict",
+    "notFoundError": "Not Found",
+    "notSupportedError": "Not Supported",
+    "alreadyExistsError": "Already Exists",
+    "notImplementedError": "Not Implemented",
+    "validationError": "Validation",
+    "unprocessableError": "Unprocessable"
+  },
+  "validation": {
+    "defaultFieldName": "The field"
+  },
+  "errorMessages": {
+    "fetch": "Fetch"
+  },
+  "cli": {
+    "progress": {
+      "done": "Done.",
+      "error": "Error",
+      "loadingEnvFiles": "Loading env files",
+      "pleaseWait": "Please wait...",
+      "writingJsonFile": "Writing JSON file",
+      "writingEnvFile": "Writing env file",
+      "readingJsonFile": "Reading JSON file",
+      "readingEnvFile": "Reading env file"
+    },
+    "options": {
+      "lang": {
+        "param": "--lang '<'lang'>'",
+        "description": "The language to display the output in."
+      },
+      "load-env": {
+        "param": "--load-env [env...]",
+        "description": "Load the env files to initialise any environment variables."
+      },
+      "no-console": {
+        "param": "--no-console",
+        "description": "Hides the output in the console."
+      },
+      "json": {
+        "param": "--json '<'filename'>'",
+        "description": "Creates a JSON file containing the output."
+      },
+      "env": {
+        "param": "--env '<'filename'>'",
+        "description": "Creates an env file containing the output."
+      },
+      "merge-json": {
+        "param": "--merge-json",
+        "description": "If the JSON file already exists merge the data instead of overwriting."
+      },
+      "merge-env": {
+        "param": "--merge-env",
+        "description": "If the env file already exists merge the data instead of overwriting."
+      }
+    }
+  }
+}

package/dist/types/cli.d.ts

@@ -0,0 +1,19 @@
+import { CLIBase } from "@twin.org/cli-core";
+import type { Command } from "commander";
+/**
+ * The main entry point for the CLI.
+ */
+export declare class CLI extends CLIBase {
+    /**
+     * Run the app.
+     * @param argv The process arguments.
+     * @param localesDirectory The directory for the locales, default to relative to the script.
+     * @returns The exit code.
+     */
+    run(argv: string[], localesDirectory?: string): Promise<number>;
+    /**
+     * Configure any options or actions at the root program level.
+     * @param program The root program command.
+     */
+    protected configureRoot(program: Command): void;
+}

package/dist/types/commands/httpStatusCodeMap.d.ts

@@ -0,0 +1,20 @@
+import { HttpStatusCode } from "@twin.org/web";
+export declare const HTTP_STATUS_CODE_MAP: {
+    [id: string]: {
+        code: HttpStatusCode;
+        responseType: string;
+        example?: unknown;
+    };
+};
+/**
+ * Get the HTTP status code from the error code type.
+ * @param errorCodeType The error code type.
+ * @returns The HTTP status code.
+ */
+export declare function getHttpStatusCodeFromType(errorCodeType: string): HttpStatusCode;
+/**
+ * Get the HTTP example from the error code type.
+ * @param errorCodeType The error code type.
+ * @returns The example.
+ */
+export declare function getHttpExampleFromType(errorCodeType: string): unknown;

package/dist/types/commands/tsToOpenApi.d.ts

@@ -0,0 +1,21 @@
+import type { Command } from "commander";
+import type { ITsToOpenApiConfig } from "../models/ITsToOpenApiConfig";
+/**
+ * Build the root command to be consumed by the CLI.
+ * @param program The command to build on.
+ */
+export declare function buildCommandTsToOpenApi(program: Command): void;
+/**
+ * Action the root command.
+ * @param configFile The optional configuration file.
+ * @param outputFile The output file for the generation OpenApi spec.
+ * @param opts The options for the command.
+ */
+export declare function actionCommandTsToOpenApi(configFile: string, outputFile: string, opts: unknown): Promise<void>;
+/**
+ * Convert the TypeScript definitions to OpenAPI spec.
+ * @param config The configuration for the app.
+ * @param outputFile The location of the file to output the OpenAPI spec.
+ * @param workingDirectory The folder the app was run from.
+ */
+export declare function tsToOpenApi(config: ITsToOpenApiConfig, outputFile: string, workingDirectory: string): Promise<void>;

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./cli";
+export * from "./commands/tsToOpenApi";
+export * from "./models/ITsToOpenApiConfig";
+export * from "./models/ITsToOpenApiConfigEntryPoint";

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

@@ -0,0 +1,68 @@
+import type { HttpMethod, HttpStatusCode } from "@twin.org/web";
+/**
+ * The resulting details for a REST path.
+ */
+export interface IInputPath {
+    /**
+     * The path.
+     */
+    path: string;
+    /**
+     * The REST method.
+     */
+    method: HttpMethod;
+    /**
+     * The parameters contained in the path.
+     */
+    pathParameters: string[];
+    /**
+     * The id of the operation.
+     */
+    operationId: string;
+    /**
+     * Summary of what task the operation performs.
+     */
+    summary: string;
+    /**
+     * Tags for the operation.
+     */
+    tag: string;
+    /**
+     * The request type.
+     */
+    requestType?: string;
+    /**
+     * The request mime type.
+     */
+    requestMimeType?: string;
+    /**
+     * Example objects for the request.
+     */
+    requestExamples?: {
+        id: string;
+        description?: string;
+        request: unknown;
+    }[];
+    /**
+     * The response type.
+     */
+    responseType: {
+        statusCode: HttpStatusCode;
+        type: string;
+        mimeType?: string;
+        description?: string;
+        examples?: {
+            id: string;
+            description?: string;
+            response: unknown;
+        }[];
+    }[];
+    /**
+     * Response codes.
+     */
+    responseCodes: string[];
+    /**
+     * Skip authentication for this path.
+     */
+    skipAuth: boolean;
+}

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

@@ -0,0 +1,15 @@
+import type { ITag } from "@twin.org/api-models";
+import type { IInputPath } from "./IInputPath";
+/**
+ * The set of path results for a package.
+ */
+export interface IInputResult {
+    /**
+     * The paths.
+     */
+    paths: IInputPath[];
+    /**
+     * The tags.
+     */
+    tags: ITag[];
+}

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

@@ -0,0 +1,54 @@
+import type { JSONSchema7 } from "json-schema";
+import type { IOpenApiPathMethod } from "./IOpenApiPathMethod";
+import type { IOpenApiSecurityScheme } from "./IOpenApiSecurityScheme";
+/**
+ * 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?: JSONSchema7;
+        securitySchemes?: {
+            [name: string]: IOpenApiSecurityScheme;
+        };
+    };
+}

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

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

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

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

@@ -0,0 +1,64 @@
+import type { JSONSchema7Type, JSONSchema7TypeName } from "json-schema";
+import type { IOpenApiExample } from "./IOpenApiExample";
+import type { IOpenApiResponse } from "./IOpenApiResponse";
+/**
+ * The Open API config definition.
+ */
+export interface IOpenApiPathMethod {
+    /**
+     * The operation id.
+     */
+    operationId: string;
+    /**
+     * Summary.
+     */
+    summary: string;
+    /**
+     * Tags.
+     */
+    tags?: string[];
+    /**
+     * Parameters.
+     */
+    parameters?: {
+        name: string;
+        in: string;
+        description?: string;
+        required: boolean;
+        schema: {
+            type?: JSONSchema7TypeName | JSONSchema7TypeName[];
+            enum?: JSONSchema7Type[];
+            $ref?: string;
+        };
+        style?: string;
+    }[];
+    /**
+     * Request body.
+     */
+    requestBody?: {
+        required: boolean;
+        description?: string;
+        content?: {
+            [contentType: string]: {
+                schema: {
+                    $ref: string;
+                };
+                examples?: {
+                    [id: string]: IOpenApiExample;
+                };
+            };
+        };
+    };
+    /**
+     * Response body.
+     */
+    responses?: {
+        [code: string]: IOpenApiResponse;
+    };
+    /**
+     * Security model for the API.
+     */
+    security?: {
+        [name: string]: string[];
+    }[];
+}

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

@@ -0,0 +1,32 @@
+import type { IOpenApiExample } from "./IOpenApiExample";
+import type { IOpenApiHeader } from "./IOpenApiHeader";
+/**
+ * The Open API config definition.
+ */
+export interface IOpenApiResponse {
+    /**
+     * Descriptions for the response.
+     */
+    description?: string;
+    /**
+     * Content for the response.
+     */
+    content?: {
+        [contentType: string]: {
+            schema: {
+                type?: string;
+                format?: string;
+                $ref?: string;
+            };
+            examples?: {
+                [id: string]: IOpenApiExample;
+            };
+        };
+    };
+    /**
+     * The headers for the response.
+     */
+    headers?: {
+        [id: string]: IOpenApiHeader;
+    };
+}

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

@@ -0,0 +1,25 @@
+/**
+ * The Open API config definition for security scheme.
+ */
+export interface IOpenApiSecurityScheme {
+    /**
+     * The type of the security schema.
+     */
+    type?: string;
+    /**
+     * The scheme method.
+     */
+    scheme?: string;
+    /**
+     * The bearer format.
+     */
+    bearerFormat?: string;
+    /**
+     * Where is the token located.
+     */
+    in?: string;
+    /**
+     * What is the name of the token.
+     */
+    name?: string;
+}

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

@@ -0,0 +1,15 @@
+/**
+ * Configuration for each individual package.
+ */
+export interface IPackageJson {
+    /**
+     * The name of the package.
+     */
+    name: string;
+    /**
+     * The dependencies for the package.
+     */
+    dependencies?: {
+        [id: string]: string;
+    };
+}