@tmdjr/coding-labs-contracts 0.0.5 → 0.0.6

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

@@ -3,6 +3,22 @@
  * Do not make direct changes to the file.
  */
 export interface paths {
+    "/published-labs/{labId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["PublishedLabsController_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/labs": {
         parameters: {
             query?: never;
@@ -83,6 +99,22 @@ export interface paths {
         patch: operations["LabVersionsController_patchDraft"];
         trace?: never;
     };
+    "/labs/{labId}/versions/{versionId}/verify": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["LabVersionsController_verify"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/labs/{labId}/versions/{versionId}/publish": {
         parameters: {
             query?: never;
@@ -135,6 +167,45 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        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?: (string | number | boolean | unknown[] | {
+                [key: string]: unknown;
+            }) | null;
+            expected?: (string | number | boolean | unknown[] | {
+                [key: string]: unknown;
+            }) | null;
+            comparator?: components["schemas"]["ComparatorDto"];
+            testCode?: string;
+            /** @enum {string} */
+            framework?: "jest" | "vitest";
+        };
+        PublishedLabDto: {
+            labId: string;
+            versionId: string;
+            versionNumber: number;
+            title: string;
+            /** @enum {string} */
+            difficulty?: "intro" | "easy" | "medium" | "hard";
+            /** @enum {string} */
+            language: "javascript" | "typescript";
+            promptMarkdown: string;
+            hints: string[];
+            starterCode: string;
+            sampleTests: components["schemas"]["LabTestCaseDto"][];
+            entryFnName?: string;
+        };
         CreateLabDto: {
             workshopId: string;
             workshopDocumentGroupId?: string;
@@ -154,9 +225,29 @@ export interface components {
             createdBy: string;
             updatedBy?: string;
         };
-        HandsOnLabMongo: Record<string, never>;
+        HandsOnLabMongo: {
+            _id: string;
+            workshopId: string;
+            workshopDocumentGroupId?: string;
+            slug: string;
+            title: string;
+            summary?: string;
+            tags: string[];
+            /** @enum {string} */
+            difficulty?: "intro" | "easy" | "medium" | "hard";
+            estimatedMinutes?: number;
+            /** @enum {string} */
+            status: "draft" | "published" | "archived";
+            currentDraftVersionId?: string;
+            latestPublishedVersionId?: string;
+            createdAt: string;
+            createdBy: string;
+            updatedAt: string;
+            updatedBy: string;
+            archivedAt?: string;
+            archivedBy?: string;
+        };
         UpdateLabDto: {
-            workshopId?: string;
             workshopDocumentGroupId?: string;
             slug?: string;
             title?: string;
@@ -166,38 +257,12 @@ export interface components {
             /** @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;
@@ -217,7 +282,26 @@ export interface components {
             contentHash?: string;
             createdBy: string;
         };
-        HandsOnLabVersionMongo: Record<string, never>;
+        HandsOnLabVersionMongo: {
+            _id: string;
+            labId: string;
+            versionNumber: number;
+            isDraft: boolean;
+            /** @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"];
+            publishedAt?: string;
+            publishedBy?: string;
+            createdAt: string;
+            createdBy: string;
+            contentHash?: string;
+        };
         UpdateDraftVersionDto: {
             /** @enum {string} */
             language?: "typescript" | "javascript";
@@ -230,8 +314,34 @@ export interface components {
             runner?: components["schemas"]["LabRunnerConfigDto"];
             contentHash?: string;
             createdBy?: string;
+            /** @description Hash from the loaded draft; prevents stale overwrites */
+            expectedContentHash: string;
+        };
+        TestResultDto: {
+            name: string;
+            /** @enum {string} */
+            suite: "sample" | "hidden";
+            /** @enum {string} */
+            status: "passed" | "failed" | "error" | "timeout";
+            durationMs: number;
+            actual?: (string | number | boolean | unknown[] | {
+                [key: string]: unknown;
+            }) | null;
+            expected?: (string | number | boolean | unknown[] | {
+                [key: string]: unknown;
+            }) | null;
+            message?: string;
+        };
+        VerificationDto: {
+            passed: boolean;
+            contentHash: string;
+            totalTests: number;
+            passedTests: number;
+            durationMs: number;
+            results: components["schemas"]["TestResultDto"][];
         };
         PublishVersionDto: {
+            expectedContentHash: string;
             publishedBy: string;
             notes?: string;
         };
@@ -248,7 +358,17 @@ export interface components {
             pinnedVersionId?: string;
             createdBy: string;
         };
-        HandsOnLabEmbedMongo: Record<string, never>;
+        HandsOnLabEmbedMongo: {
+            _id: string;
+            labId: string;
+            workshopId: string;
+            workshopDocumentId: string;
+            blockId: string;
+            blockType: string;
+            pinnedVersionId?: string;
+            createdAt: string;
+            createdBy: string;
+        };
     };
     responses: never;
     parameters: never;
@@ -258,6 +378,29 @@ export interface components {
 }
 export type $defs = Record<string, never>;
 export interface operations {
+    PublishedLabsController_get: {
+        parameters: {
+            query?: {
+                versionId?: string;
+            };
+            header?: never;
+            path: {
+                labId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PublishedLabDto"];
+                };
+            };
+        };
+    };
     LabsController_findAll: {
         parameters: {
             query?: {
@@ -282,6 +425,20 @@ export interface operations {
                     "application/json": components["schemas"]["HandsOnLabMongo"][];
                 };
             };
+            /** @description Valid platform authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Administrator role required */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     LabsController_create: {
@@ -305,6 +462,20 @@ export interface operations {
                     "application/json": components["schemas"]["HandsOnLabMongo"];
                 };
             };
+            /** @description Valid platform authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Administrator role required */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     LabsController_findOne: {
@@ -326,13 +497,25 @@ export interface operations {
                     "application/json": components["schemas"]["HandsOnLabMongo"];
                 };
             };
+            /** @description Valid platform authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Administrator role required */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     LabsController_remove: {
         parameters: {
-            query: {
-                archivedBy: string;
-            };
+            query?: never;
             header?: never;
             path: {
                 labId: string;
@@ -347,6 +530,20 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Valid platform authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Administrator role required */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     LabsController_update: {
@@ -372,6 +569,20 @@ export interface operations {
                     "application/json": components["schemas"]["HandsOnLabMongo"];
                 };
             };
+            /** @description Valid platform authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Administrator role required */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     LabVersionsController_createDraft: {
@@ -397,6 +608,20 @@ export interface operations {
                     "application/json": components["schemas"]["HandsOnLabVersionMongo"];
                 };
             };
+            /** @description Valid platform authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Administrator role required */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     LabVersionsController_findAll: {
@@ -418,6 +643,20 @@ export interface operations {
                     "application/json": components["schemas"]["HandsOnLabVersionMongo"][];
                 };
             };
+            /** @description Valid platform authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Administrator role required */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     LabVersionsController_findOne: {
@@ -440,6 +679,20 @@ export interface operations {
                     "application/json": components["schemas"]["HandsOnLabVersionMongo"];
                 };
             };
+            /** @description Valid platform authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Administrator role required */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     LabVersionsController_patchDraft: {
@@ -466,6 +719,56 @@ export interface operations {
                     "application/json": components["schemas"]["HandsOnLabVersionMongo"];
                 };
             };
+            /** @description Valid platform authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Administrator role required */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    LabVersionsController_verify: {
+        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"]["VerificationDto"];
+                };
+            };
+            /** @description Valid platform authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Administrator role required */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     LabVersionsController_publish: {
@@ -492,6 +795,20 @@ export interface operations {
                     "application/json": components["schemas"]["HandsOnLabVersionMongo"];
                 };
             };
+            /** @description Valid platform authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Administrator role required */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     LabEmbedsController_findAll: {
@@ -515,6 +832,20 @@ export interface operations {
                     "application/json": components["schemas"]["HandsOnLabEmbedMongo"][];
                 };
             };
+            /** @description Valid platform authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Administrator role required */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     LabEmbedsController_create: {
@@ -538,6 +869,20 @@ export interface operations {
                     "application/json": components["schemas"]["HandsOnLabEmbedMongo"];
                 };
             };
+            /** @description Valid platform authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Administrator role required */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     LabEmbedsController_remove: {
@@ -557,6 +902,20 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Valid platform authentication required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Administrator role required */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
 }

package/dist/index.d.ts

@@ -7,7 +7,10 @@ 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 { PublishedLabDto } from './models/PublishedLabDto';
 export type { PublishVersionDto } from './models/PublishVersionDto';
 export type { ReferenceSolutionDto } from './models/ReferenceSolutionDto';
+export type { TestResultDto } from './models/TestResultDto';
 export type { UpdateDraftVersionDto } from './models/UpdateDraftVersionDto';
 export type { UpdateLabDto } from './models/UpdateLabDto';
+export type { VerificationDto } from './models/VerificationDto';

package/dist/models/HandsOnLabEmbedMongo.d.ts

@@ -1 +1,11 @@
-export type HandsOnLabEmbedMongo = {};
+export type HandsOnLabEmbedMongo = {
+    _id: string;
+    labId: string;
+    workshopId: string;
+    workshopDocumentId: string;
+    blockId: string;
+    blockType: string;
+    pinnedVersionId?: string;
+    createdAt: string;
+    createdBy: string;
+};

package/dist/models/HandsOnLabMongo.d.ts

@@ -1 +1,20 @@
-export type HandsOnLabMongo = {};
+export type HandsOnLabMongo = {
+    _id: string;
+    workshopId: string;
+    workshopDocumentGroupId?: string;
+    slug: string;
+    title: string;
+    summary?: string;
+    tags: Array<string>;
+    difficulty?: 'intro' | 'easy' | 'medium' | 'hard';
+    estimatedMinutes?: number;
+    status: 'draft' | 'published' | 'archived';
+    currentDraftVersionId?: string;
+    latestPublishedVersionId?: string;
+    createdAt: string;
+    createdBy: string;
+    updatedAt: string;
+    updatedBy: string;
+    archivedAt?: string;
+    archivedBy?: string;
+};

package/dist/models/HandsOnLabVersionMongo.d.ts

@@ -1 +1,22 @@
-export type HandsOnLabVersionMongo = {};
+import type { LabRunnerConfigDto } from './LabRunnerConfigDto';
+import type { LabTestCaseDto } from './LabTestCaseDto';
+import type { ReferenceSolutionDto } from './ReferenceSolutionDto';
+export type HandsOnLabVersionMongo = {
+    _id: string;
+    labId: string;
+    versionNumber: number;
+    isDraft: boolean;
+    language: 'typescript' | 'javascript';
+    promptMarkdown: string;
+    hints?: Array<string>;
+    starterCode: string;
+    referenceSolution?: ReferenceSolutionDto;
+    sampleTests: Array<LabTestCaseDto>;
+    hiddenTests: Array<LabTestCaseDto>;
+    runner: LabRunnerConfigDto;
+    publishedAt?: string;
+    publishedBy?: string;
+    createdAt: string;
+    createdBy: string;
+    contentHash?: string;
+};

package/dist/models/LabTestCaseDto.d.ts

@@ -3,8 +3,8 @@ export type LabTestCaseDto = {
     _id?: string;
     name: string;
     kind: 'io' | 'unit';
-    input?: Record<string, any>;
-    expected?: Record<string, any>;
+    input?: (string | number | boolean | Record<string, any>) | null;
+    expected?: (string | number | boolean | Record<string, any>) | null;
     comparator?: ComparatorDto;
     testCode?: string;
     framework?: 'jest' | 'vitest';

package/dist/models/PublishVersionDto.d.ts

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

package/dist/models/PublishedLabDto.d.ts

@@ -0,0 +1,14 @@
+import type { LabTestCaseDto } from './LabTestCaseDto';
+export type PublishedLabDto = {
+    labId: string;
+    versionId: string;
+    versionNumber: number;
+    title: string;
+    difficulty?: 'intro' | 'easy' | 'medium' | 'hard';
+    language: 'javascript' | 'typescript';
+    promptMarkdown: string;
+    hints: Array<string>;
+    starterCode: string;
+    sampleTests: Array<LabTestCaseDto>;
+    entryFnName?: string;
+};

package/dist/models/PublishedLabDto.js

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

package/dist/models/TestResultDto.d.ts

@@ -0,0 +1,9 @@
+export type TestResultDto = {
+    name: string;
+    suite: 'sample' | 'hidden';
+    status: 'passed' | 'failed' | 'error' | 'timeout';
+    durationMs: number;
+    actual?: (string | number | boolean | Record<string, any>) | null;
+    expected?: (string | number | boolean | Record<string, any>) | null;
+    message?: string;
+};

package/dist/models/TestResultDto.js

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

package/dist/models/UpdateDraftVersionDto.d.ts

@@ -12,4 +12,8 @@ export type UpdateDraftVersionDto = {
     runner?: LabRunnerConfigDto;
     contentHash?: string;
     createdBy?: string;
+    /**
+     * Hash from the loaded draft; prevents stale overwrites
+     */
+    expectedContentHash: string;
 };

package/dist/models/UpdateLabDto.d.ts

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

package/dist/models/VerificationDto.d.ts

@@ -0,0 +1,9 @@
+import type { TestResultDto } from './TestResultDto';
+export type VerificationDto = {
+    passed: boolean;
+    contentHash: string;
+    totalTests: number;
+    passedTests: number;
+    durationMs: number;
+    results: Array<TestResultDto>;
+};

package/dist/models/VerificationDto.js

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

package/package.json

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