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

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

@@ -0,0 +1,61 @@
+import type { ITsToOpenApiConfigEntryPoint } from "./ITsToOpenApiConfigEntryPoint";
+/**
+ * Configuration for the API.
+ */
+export interface ITsToOpenApiConfig {
+    /**
+     * Title of the API.
+     */
+    title: string;
+    /**
+     * The version.
+     */
+    version: string;
+    /**
+     * Description of the API.
+     */
+    description: string;
+    /**
+     * The license to use.
+     */
+    licenseName: string;
+    /**
+     * The license URL.
+     */
+    licenseUrl: string;
+    /**
+     * The servers for the endpoints.
+     */
+    servers: string[];
+    /**
+     * The authentication methods.
+     */
+    authMethods?: ("basic" | "jwtBearer" | "jwtCookie" | string)[];
+    /**
+     * The packages containing routes.
+     */
+    restRoutes: {
+        /**
+         * The package containing the routes.
+         */
+        package?: string;
+        /**
+         * The version of the package to use, defaults to latest.
+         */
+        version?: string;
+        /**
+         * To point to a local instance of a package use this property instead of package/version.
+         */
+        packageRoot?: string;
+        /**
+         * The rest entry points to include, defaults to all exported entry points.
+         */
+        entryPoints?: ITsToOpenApiConfigEntryPoint[];
+    }[];
+    /**
+     * External type references
+     */
+    externalReferences?: {
+        [id: string]: string;
+    };
+}

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

@@ -0,0 +1,17 @@
+/**
+ * Configuration for the API.
+ */
+export interface ITsToOpenApiConfigEntryPoint {
+    /**
+     * Match the name of the exported entry point.
+     */
+    name: string;
+    /**
+     * The base route path to use, defaults to the one in the entry point.
+     */
+    baseRoutePath?: string;
+    /**
+     * If using the same routes on multiple paths use the distinguisher to avoid operationId clashes, will be appended to operationIds.
+     */
+    operationIdDistinguisher?: string;
+}

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/ts-to-openapi - Changelog
+
+## v0.0.1-next.10
+
+- Initial Release