@tmdjr/coding-labs-contracts 0.0.1

package/dist/coding-labs.types.d.ts

@@ -0,0 +1,384 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/example-crud/ping": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["ExampleCrudController_health"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/example-crud/auth-test": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["ExampleCrudController_authTest"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/example-crud": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["ExampleCrudController_findAll"];
+        put?: never;
+        post: operations["ExampleCrudController_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/example-crud/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["ExampleCrudController_findOne"];
+        put?: never;
+        post?: never;
+        delete: operations["ExampleCrudController_remove"];
+        options?: never;
+        head?: never;
+        patch: operations["ExampleCrudController_update"];
+        trace?: never;
+    };
+    "/example-crud/name/{name}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["ExampleCrudController_findByName"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/example-crud/{id}/archive": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch: operations["ExampleCrudController_archive"];
+        trace?: never;
+    };
+    "/example-crud/{id}/unarchive": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch: operations["ExampleCrudController_unarchive"];
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        AuthTestDto: {
+            message: string;
+        };
+        ExampleMongodbDocObjectDto: {
+            street: string;
+            city: string;
+            state: string;
+            zip: string;
+        };
+        CreateExampleMongodbDocDto: {
+            name: string;
+            /** @enum {string} */
+            type: "SOME_ENUM" | "SOME_OTHER_ENUM";
+            description?: string;
+            archived?: boolean;
+            exampleMongodbDocObject?: components["schemas"]["ExampleMongodbDocObjectDto"];
+            /** Format: date-time */
+            lastUpdated?: string;
+        };
+        ExampleMongodbDocDto: {
+            _id: string;
+            name: string;
+            /** @enum {string} */
+            type: "SOME_ENUM" | "SOME_OTHER_ENUM";
+            version: number;
+            description: string;
+            /** Format: date-time */
+            lastUpdated: string;
+            archived: boolean;
+            exampleMongodbDocObject?: components["schemas"]["ExampleMongodbDocObjectDto"];
+            __v: number;
+        };
+        UpdateExampleMongodbDocDto: {
+            name?: string;
+            /** @enum {string} */
+            type?: "SOME_ENUM" | "SOME_OTHER_ENUM";
+            description?: string;
+            archived?: boolean;
+            exampleMongodbDocObject?: components["schemas"]["ExampleMongodbDocObjectDto"];
+            /** Format: date-time */
+            lastUpdated?: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    ExampleCrudController_health: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": string;
+                };
+            };
+        };
+    };
+    ExampleCrudController_authTest: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AuthTestDto"];
+                };
+            };
+        };
+    };
+    ExampleCrudController_findAll: {
+        parameters: {
+            query?: {
+                /** @description Filter by archived status */
+                archived?: boolean;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExampleMongodbDocDto"][];
+                };
+            };
+        };
+    };
+    ExampleCrudController_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateExampleMongodbDocDto"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExampleMongodbDocDto"];
+                };
+            };
+        };
+    };
+    ExampleCrudController_findOne: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExampleMongodbDocDto"];
+                };
+            };
+        };
+    };
+    ExampleCrudController_remove: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ExampleCrudController_update: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateExampleMongodbDocDto"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExampleMongodbDocDto"];
+                };
+            };
+        };
+    };
+    ExampleCrudController_findByName: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                name: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExampleMongodbDocDto"];
+                };
+            };
+        };
+    };
+    ExampleCrudController_archive: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExampleMongodbDocDto"];
+                };
+            };
+        };
+    };
+    ExampleCrudController_unarchive: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExampleMongodbDocDto"];
+                };
+            };
+        };
+    };
+}

package/dist/coding-labs.types.js

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export {};

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export type { AuthTestDto } from './models/AuthTestDto';
+export type { CreateExampleMongodbDocDto } from './models/CreateExampleMongodbDocDto';
+export type { ExampleMongodbDocDto } from './models/ExampleMongodbDocDto';
+export type { ExampleMongodbDocObjectDto } from './models/ExampleMongodbDocObjectDto';
+export type { UpdateExampleMongodbDocDto } from './models/UpdateExampleMongodbDocDto';

package/dist/index.js

@@ -0,0 +1,5 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export {};

package/dist/models/AuthTestDto.d.ts

@@ -0,0 +1,3 @@
+export type AuthTestDto = {
+    message: string;
+};

package/dist/models/AuthTestDto.js

@@ -0,0 +1 @@
+export {};

package/dist/models/CreateExampleMongodbDocDto.d.ts

@@ -0,0 +1,9 @@
+import type { ExampleMongodbDocObjectDto } from './ExampleMongodbDocObjectDto';
+export type CreateExampleMongodbDocDto = {
+    name: string;
+    type: 'SOME_ENUM' | 'SOME_OTHER_ENUM';
+    description?: string;
+    archived?: boolean;
+    exampleMongodbDocObject?: ExampleMongodbDocObjectDto;
+    lastUpdated?: string;
+};

package/dist/models/CreateExampleMongodbDocDto.js

@@ -0,0 +1 @@
+export {};

package/dist/models/ExampleMongodbDocDto.d.ts

@@ -0,0 +1,12 @@
+import type { ExampleMongodbDocObjectDto } from './ExampleMongodbDocObjectDto';
+export type ExampleMongodbDocDto = {
+    _id: string;
+    name: string;
+    type: 'SOME_ENUM' | 'SOME_OTHER_ENUM';
+    version: number;
+    description: string;
+    lastUpdated: string;
+    archived: boolean;
+    exampleMongodbDocObject?: ExampleMongodbDocObjectDto;
+    __v: number;
+};

package/dist/models/ExampleMongodbDocDto.js

@@ -0,0 +1 @@
+export {};

package/dist/models/ExampleMongodbDocObjectDto.d.ts

@@ -0,0 +1,6 @@
+export type ExampleMongodbDocObjectDto = {
+    street: string;
+    city: string;
+    state: string;
+    zip: string;
+};

package/dist/models/ExampleMongodbDocObjectDto.js

@@ -0,0 +1 @@
+export {};

package/dist/models/UpdateExampleMongodbDocDto.d.ts

@@ -0,0 +1,9 @@
+import type { ExampleMongodbDocObjectDto } from './ExampleMongodbDocObjectDto';
+export type UpdateExampleMongodbDocDto = {
+    name?: string;
+    type?: 'SOME_ENUM' | 'SOME_OTHER_ENUM';
+    description?: string;
+    archived?: boolean;
+    exampleMongodbDocObject?: ExampleMongodbDocObjectDto;
+    lastUpdated?: string;
+};

package/dist/models/UpdateExampleMongodbDocDto.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@tmdjr/coding-labs-contracts",
+  "version": "0.0.1",
+  "description": "Types & runtime enums generated from NGX coding-labs spec",
+  "license": "MIT",
+  "private": false,
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "rm -rf dist src/coding-labs.types.ts src/models src/core src/schemas",
+    "gen:types": "openapi-typescript ../../openapi.json --output ./src/coding-labs.types.ts",
+    "gen:models": "openapi --input ../../openapi.json --output ./src --client none --exportCore false --exportServices false --exportModels true --useUnionTypes true",
+    "gen": "npm run gen:types && npm run gen:models",
+    "build": "tsc -p tsconfig.build.json",
+    "prepublishOnly": "npm run clean && npm run gen && npm run build"
+  },
+  "devDependencies": {
+    "openapi-typescript": "^7.5.1",
+    "typescript": "^5.7.3",
+    "openapi-typescript-codegen": "^0.29.0"
+  }
+}