@tmdjr/coding-labs-contracts 0.0.1 → 0.0.2

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

@@ -115,6 +115,134 @@ export interface paths {
         patch: operations["ExampleCrudController_unarchive"];
         trace?: never;
     };
+    "/labs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["LabsController_findAll"];
+        put?: never;
+        post: operations["LabsController_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/labs/{labId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["LabsController_findOne"];
+        put?: never;
+        post?: never;
+        delete: operations["LabsController_remove"];
+        options?: never;
+        head?: never;
+        patch: operations["LabsController_update"];
+        trace?: never;
+    };
+    "/labs/{labId}/versions/draft": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["LabVersionsController_createDraft"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/labs/{labId}/versions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["LabVersionsController_findAll"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/labs/{labId}/versions/{versionId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["LabVersionsController_findOne"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch: operations["LabVersionsController_patchDraft"];
+        trace?: never;
+    };
+    "/labs/{labId}/versions/{versionId}/publish": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["LabVersionsController_publish"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/embeds": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["LabEmbedsController_findAll"];
+        put?: never;
+        post: operations["LabEmbedsController_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/embeds/{embedId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete: operations["LabEmbedsController_remove"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -161,6 +289,120 @@ export interface components {
             /** Format: date-time */
             lastUpdated?: string;
         };
+        CreateLabDto: {
+            workshopId: string;
+            workshopDocumentGroupId?: string;
+            slug: string;
+            title: string;
+            summary?: string;
+            /** @default [] */
+            tags: string[];
+            /** @enum {string} */
+            difficulty?: "intro" | "easy" | "medium" | "hard";
+            estimatedMinutes?: number;
+            /**
+             * @default draft
+             * @enum {string}
+             */
+            status: "draft" | "published" | "archived";
+            createdBy: string;
+            updatedBy?: string;
+        };
+        HandsOnLabMongo: Record<string, never>;
+        UpdateLabDto: {
+            workshopId?: string;
+            workshopDocumentGroupId?: string;
+            slug?: string;
+            title?: string;
+            summary?: string;
+            /** @default [] */
+            tags: string[];
+            /** @enum {string} */
+            difficulty?: "intro" | "easy" | "medium" | "hard";
+            estimatedMinutes?: number;
+            /**
+             * @default draft
+             * @enum {string}
+             */
+            status: "draft" | "published" | "archived";
+            createdBy?: string;
+            updatedBy?: string;
+        };
+        ReferenceSolutionDto: {
+            code: string;
+            notesMarkdown?: string;
+        };
+        ComparatorDto: {
+            /** @enum {string} */
+            kind: "deepEqual" | "strictEqual" | "numberTolerance" | "stringNormalized" | "custom";
+            tolerance?: number;
+            normalizeWhitespace?: boolean;
+            ignoreCase?: boolean;
+            customComparatorId?: string;
+        };
+        LabTestCaseDto: {
+            _id?: string;
+            name: string;
+            /** @enum {string} */
+            kind: "io" | "unit";
+            input?: Record<string, never>;
+            expected?: Record<string, never>;
+            comparator?: components["schemas"]["ComparatorDto"];
+            testCode?: string;
+            /** @enum {string} */
+            framework?: "jest" | "vitest";
+        };
+        LabRunnerConfigDto: {
+            timeoutMs: number;
+            memoryMb?: number;
+            entryFnName?: string;
+            nodeVersion?: string;
+        };
+        CreateDraftVersionDto: {
+            /** @enum {string} */
+            language?: "typescript" | "javascript";
+            promptMarkdown?: string;
+            hints?: string[];
+            starterCode?: string;
+            referenceSolution?: components["schemas"]["ReferenceSolutionDto"];
+            sampleTests?: components["schemas"]["LabTestCaseDto"][];
+            hiddenTests?: components["schemas"]["LabTestCaseDto"][];
+            runner?: components["schemas"]["LabRunnerConfigDto"];
+            contentHash?: string;
+            createdBy: string;
+        };
+        HandsOnLabVersionMongo: Record<string, never>;
+        UpdateDraftVersionDto: {
+            /** @enum {string} */
+            language?: "typescript" | "javascript";
+            promptMarkdown?: string;
+            hints?: string[];
+            starterCode?: string;
+            referenceSolution?: components["schemas"]["ReferenceSolutionDto"];
+            sampleTests?: components["schemas"]["LabTestCaseDto"][];
+            hiddenTests?: components["schemas"]["LabTestCaseDto"][];
+            runner?: components["schemas"]["LabRunnerConfigDto"];
+            contentHash?: string;
+            createdBy?: string;
+        };
+        PublishVersionDto: {
+            publishedBy: string;
+            notes?: string;
+        };
+        CreateEmbedDto: {
+            labId: string;
+            workshopId: string;
+            workshopDocumentId: string;
+            blockId: string;
+            /**
+             * @default handsOnLab
+             * @enum {string}
+             */
+            blockType: "handsOnLab";
+            pinnedVersionId?: string;
+            createdBy: string;
+        };
+        HandsOnLabEmbedMongo: Record<string, never>;
     };
     responses: never;
     parameters: never;
@@ -381,4 +623,305 @@ export interface operations {
             };
         };
     };
+    LabsController_findAll: {
+        parameters: {
+            query?: {
+                workshopId?: string;
+                status?: string;
+                tag?: string;
+                q?: string;
+                limit?: number;
+                skip?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HandsOnLabMongo"][];
+                };
+            };
+        };
+    };
+    LabsController_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateLabDto"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HandsOnLabMongo"];
+                };
+            };
+        };
+    };
+    LabsController_findOne: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                labId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HandsOnLabMongo"];
+                };
+            };
+        };
+    };
+    LabsController_remove: {
+        parameters: {
+            query: {
+                archivedBy: string;
+            };
+            header?: never;
+            path: {
+                labId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    LabsController_update: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                labId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateLabDto"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HandsOnLabMongo"];
+                };
+            };
+        };
+    };
+    LabVersionsController_createDraft: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                labId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateDraftVersionDto"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HandsOnLabVersionMongo"];
+                };
+            };
+        };
+    };
+    LabVersionsController_findAll: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                labId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HandsOnLabVersionMongo"][];
+                };
+            };
+        };
+    };
+    LabVersionsController_findOne: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                labId: string;
+                versionId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HandsOnLabVersionMongo"];
+                };
+            };
+        };
+    };
+    LabVersionsController_patchDraft: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                labId: string;
+                versionId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateDraftVersionDto"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HandsOnLabVersionMongo"];
+                };
+            };
+        };
+    };
+    LabVersionsController_publish: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                labId: string;
+                versionId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PublishVersionDto"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HandsOnLabVersionMongo"];
+                };
+            };
+        };
+    };
+    LabEmbedsController_findAll: {
+        parameters: {
+            query?: {
+                labId?: string;
+                workshopId?: string;
+                workshopDocumentId?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HandsOnLabEmbedMongo"][];
+                };
+            };
+        };
+    };
+    LabEmbedsController_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateEmbedDto"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HandsOnLabEmbedMongo"];
+                };
+            };
+        };
+    };
+    LabEmbedsController_remove: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                embedId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
 }

package/dist/index.d.ts

@@ -1,5 +1,18 @@
 export type { AuthTestDto } from './models/AuthTestDto';
+export type { ComparatorDto } from './models/ComparatorDto';
+export type { CreateDraftVersionDto } from './models/CreateDraftVersionDto';
+export type { CreateEmbedDto } from './models/CreateEmbedDto';
 export type { CreateExampleMongodbDocDto } from './models/CreateExampleMongodbDocDto';
+export type { CreateLabDto } from './models/CreateLabDto';
 export type { ExampleMongodbDocDto } from './models/ExampleMongodbDocDto';
 export type { ExampleMongodbDocObjectDto } from './models/ExampleMongodbDocObjectDto';
+export type { HandsOnLabEmbedMongo } from './models/HandsOnLabEmbedMongo';
+export type { HandsOnLabMongo } from './models/HandsOnLabMongo';
+export type { HandsOnLabVersionMongo } from './models/HandsOnLabVersionMongo';
+export type { LabRunnerConfigDto } from './models/LabRunnerConfigDto';
+export type { LabTestCaseDto } from './models/LabTestCaseDto';
+export type { PublishVersionDto } from './models/PublishVersionDto';
+export type { ReferenceSolutionDto } from './models/ReferenceSolutionDto';
+export type { UpdateDraftVersionDto } from './models/UpdateDraftVersionDto';
 export type { UpdateExampleMongodbDocDto } from './models/UpdateExampleMongodbDocDto';
+export type { UpdateLabDto } from './models/UpdateLabDto';

package/dist/models/ComparatorDto.d.ts

@@ -0,0 +1,7 @@
+export type ComparatorDto = {
+    kind: 'deepEqual' | 'strictEqual' | 'numberTolerance' | 'stringNormalized' | 'custom';
+    tolerance?: number;
+    normalizeWhitespace?: boolean;
+    ignoreCase?: boolean;
+    customComparatorId?: string;
+};

package/dist/models/ComparatorDto.js

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

package/dist/models/CreateDraftVersionDto.d.ts

@@ -0,0 +1,15 @@
+import type { LabRunnerConfigDto } from './LabRunnerConfigDto';
+import type { LabTestCaseDto } from './LabTestCaseDto';
+import type { ReferenceSolutionDto } from './ReferenceSolutionDto';
+export type CreateDraftVersionDto = {
+    language?: 'typescript' | 'javascript';
+    promptMarkdown?: string;
+    hints?: Array<string>;
+    starterCode?: string;
+    referenceSolution?: ReferenceSolutionDto;
+    sampleTests?: Array<LabTestCaseDto>;
+    hiddenTests?: Array<LabTestCaseDto>;
+    runner?: LabRunnerConfigDto;
+    contentHash?: string;
+    createdBy: string;
+};

package/dist/models/CreateDraftVersionDto.js

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

package/dist/models/CreateEmbedDto.d.ts

@@ -0,0 +1,9 @@
+export type CreateEmbedDto = {
+    labId: string;
+    workshopId: string;
+    workshopDocumentId: string;
+    blockId: string;
+    blockType?: 'handsOnLab';
+    pinnedVersionId?: string;
+    createdBy: string;
+};

package/dist/models/CreateEmbedDto.js

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

package/dist/models/CreateLabDto.d.ts

@@ -0,0 +1,13 @@
+export type CreateLabDto = {
+    workshopId: string;
+    workshopDocumentGroupId?: string;
+    slug: string;
+    title: string;
+    summary?: string;
+    tags?: Array<string>;
+    difficulty?: 'intro' | 'easy' | 'medium' | 'hard';
+    estimatedMinutes?: number;
+    status?: 'draft' | 'published' | 'archived';
+    createdBy: string;
+    updatedBy?: string;
+};

package/dist/models/CreateLabDto.js

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

package/dist/models/HandsOnLabEmbedMongo.d.ts

@@ -0,0 +1 @@
+export type HandsOnLabEmbedMongo = {};

package/dist/models/HandsOnLabEmbedMongo.js

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

package/dist/models/HandsOnLabMongo.d.ts

@@ -0,0 +1 @@
+export type HandsOnLabMongo = {};

package/dist/models/HandsOnLabMongo.js

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

package/dist/models/HandsOnLabVersionMongo.d.ts

@@ -0,0 +1 @@
+export type HandsOnLabVersionMongo = {};

package/dist/models/HandsOnLabVersionMongo.js

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

package/dist/models/LabRunnerConfigDto.d.ts

@@ -0,0 +1,6 @@
+export type LabRunnerConfigDto = {
+    timeoutMs: number;
+    memoryMb?: number;
+    entryFnName?: string;
+    nodeVersion?: string;
+};

package/dist/models/LabRunnerConfigDto.js

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

package/dist/models/LabTestCaseDto.d.ts

@@ -0,0 +1,11 @@
+import type { ComparatorDto } from './ComparatorDto';
+export type LabTestCaseDto = {
+    _id?: string;
+    name: string;
+    kind: 'io' | 'unit';
+    input?: Record<string, any>;
+    expected?: Record<string, any>;
+    comparator?: ComparatorDto;
+    testCode?: string;
+    framework?: 'jest' | 'vitest';
+};

package/dist/models/LabTestCaseDto.js

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

package/dist/models/PublishVersionDto.d.ts

@@ -0,0 +1,4 @@
+export type PublishVersionDto = {
+    publishedBy: string;
+    notes?: string;
+};

package/dist/models/PublishVersionDto.js

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

package/dist/models/ReferenceSolutionDto.d.ts

@@ -0,0 +1,4 @@
+export type ReferenceSolutionDto = {
+    code: string;
+    notesMarkdown?: string;
+};

package/dist/models/ReferenceSolutionDto.js

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

package/dist/models/UpdateDraftVersionDto.d.ts

@@ -0,0 +1,15 @@
+import type { LabRunnerConfigDto } from './LabRunnerConfigDto';
+import type { LabTestCaseDto } from './LabTestCaseDto';
+import type { ReferenceSolutionDto } from './ReferenceSolutionDto';
+export type UpdateDraftVersionDto = {
+    language?: 'typescript' | 'javascript';
+    promptMarkdown?: string;
+    hints?: Array<string>;
+    starterCode?: string;
+    referenceSolution?: ReferenceSolutionDto;
+    sampleTests?: Array<LabTestCaseDto>;
+    hiddenTests?: Array<LabTestCaseDto>;
+    runner?: LabRunnerConfigDto;
+    contentHash?: string;
+    createdBy?: string;
+};

package/dist/models/UpdateDraftVersionDto.js

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

package/dist/models/UpdateLabDto.d.ts

@@ -0,0 +1,13 @@
+export type UpdateLabDto = {
+    workshopId?: string;
+    workshopDocumentGroupId?: string;
+    slug?: string;
+    title?: string;
+    summary?: string;
+    tags?: Array<string>;
+    difficulty?: 'intro' | 'easy' | 'medium' | 'hard';
+    estimatedMinutes?: number;
+    status?: 'draft' | 'published' | 'archived';
+    createdBy?: string;
+    updatedBy?: string;
+};

package/dist/models/UpdateLabDto.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmdjr/coding-labs-contracts",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Types & runtime enums generated from NGX coding-labs spec",
   "license": "MIT",
   "private": false,