@twin.org/ts-to-openapi 0.0.1 → 0.0.2-next.10

package/docs/examples.md

@@ -254,7 +254,7 @@ The generated `output.json` should be:
             }
           },
           {
-            "name": "pageSize",
+            "name": "limit",
             "description": "The maximum number of entities in a page.",
             "in": "query",
             "required": false,

package/docs/reference/interfaces/ITsToOpenApiConfig.md

@@ -101,3 +101,23 @@ External type references
 #### Index Signature
 
 \[`id`: `string`\]: `string`
+
+***
+
+### overrides?
+
+> `optional` **overrides**: `object`
+
+Override for specific types, to be used when the type cannot be generated automatically, or is generated incorrectly.
+
+#### Index Signature
+
+\[`id`: `string`\]: `AnySchemaObject`
+
+***
+
+### autoExpandTypes?
+
+> `optional` **autoExpandTypes**: `string`[]
+
+The types to automatically expand inline in type definitions, reg ex string matches.

package/locales/.validate-ignore

@@ -0,0 +1 @@
+^errorMessage$

package/locales/en.json

@@ -26,6 +26,7 @@
 				"creatingWorkingDir": "Creating Working Directory",
 				"creatingSecuritySchemas": "Creating Security Schemas",
 				"generatingSchemas": "Generating Schemas",
+				"overridingSchema": "Overriding Schema",
 				"finalisingSchemas": "Finalising Schemas",
 				"writingOutputFile": "Writing Output File",
 				"models": "Models",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/ts-to-openapi",
-	"version": "0.0.1",
+	"version": "0.0.2-next.10",
 	"description": "Tool to convert TypeScript REST route definitions to OpenAPI Specifications",
 	"repository": {
 		"type": "git",
@@ -14,14 +14,14 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "^0.0.1-next.1",
-		"@twin.org/cli-core": "^0.0.1",
-		"@twin.org/core": "^0.0.1",
-		"@twin.org/nameof": "^0.0.1",
-		"@twin.org/web": "^0.0.1",
-		"ajv": "8.17.1",
-		"commander": "14.0.0",
-		"glob": "11.0.2",
+		"@twin.org/api-models": "next",
+		"@twin.org/cli-core": "next",
+		"@twin.org/core": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/tools-core": "0.0.2-next.10",
+		"@twin.org/web": "next",
+		"commander": "14.0.1",
+		"glob": "11.0.3",
 		"ts-json-schema-generator": "2.4.0"
 	},
 	"main": "./dist/cjs/index.cjs",
@@ -45,5 +45,17 @@
 	],
 	"bin": {
 		"ts-to-openapi": "bin/index.js"
-	}
+	},
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"tools"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/tools/issues"
+	},
+	"homepage": "https://twindev.org"
 }

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

@@ -1,5 +0,0 @@
-import type { AnySchemaObject } from "ajv/dist/2020.js";
-/**
- * Default schema type.
- */
-export type IJsonSchema = AnySchemaObject;

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

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

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

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

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

@@ -1,65 +0,0 @@
-import type { IJsonSchema } from "./IJsonSchema";
-import type { IOpenApiExample } from "./IOpenApiExample";
-import type { IOpenApiResponse } from "./IOpenApiResponse";
-import type { JsonTypeName } from "./jsonTypeName";
-/**
- * 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?: JsonTypeName | JsonTypeName[];
-            enum?: IJsonSchema[];
-            $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

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

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

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

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

@@ -1,5 +0,0 @@
-import type { JSONType } from "ajv/dist/2020.js";
-/**
- * Default schema type.
- */
-export type JsonTypeName = JSONType;