@tmdjr/service-nestjs-assessment-test-contracts 0.0.6

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export type { AssessmentTestDto } from './models/AssessmentTestDto';
+export type { StartTestDto } from './models/StartTestDto';
+export type { SubmitTestDto } from './models/SubmitTestDto';
+export type { TestChoiceDto } from './models/TestChoiceDto';
+export type { TestQuestionDto } from './models/TestQuestionDto';
+export type { UserAssessmentTestDto } from './models/UserAssessmentTestDto';
+export type { UserSubjectEligibilityDto } from './models/UserSubjectEligibilityDto';

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/AssessmentTestDto.d.ts

@@ -0,0 +1,10 @@
+import type { TestQuestionDto } from './TestQuestionDto';
+export type AssessmentTestDto = {
+    _id: string;
+    name: string;
+    subject: 'ANGULAR' | 'NESTJS' | 'RXJS';
+    level: number;
+    lastUpdated: string;
+    testQuestions: Array<TestQuestionDto>;
+    __v: number;
+};

package/dist/models/AssessmentTestDto.js

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

package/dist/models/StartTestDto.d.ts

@@ -0,0 +1,3 @@
+export type StartTestDto = {
+    subject: 'ANGULAR' | 'NESTJS' | 'RXJS';
+};

package/dist/models/StartTestDto.js

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

package/dist/models/SubmitTestDto.d.ts

@@ -0,0 +1,4 @@
+export type SubmitTestDto = {
+    testId: string;
+    answers: Array<string>;
+};

package/dist/models/SubmitTestDto.js

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

package/dist/models/TestChoiceDto.d.ts

@@ -0,0 +1,3 @@
+export type TestChoiceDto = {
+    value: string;
+};

package/dist/models/TestChoiceDto.js

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

package/dist/models/TestQuestionDto.d.ts

@@ -0,0 +1,8 @@
+import type { TestChoiceDto } from './TestChoiceDto';
+export type TestQuestionDto = {
+    question: string;
+    choices: Array<TestChoiceDto>;
+    answer: string;
+    correctResponse: string;
+    incorrectResponse: string;
+};

package/dist/models/TestQuestionDto.js

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

package/dist/models/UserAssessmentTestDto.d.ts

@@ -0,0 +1,12 @@
+export type UserAssessmentTestDto = {
+    _id: string;
+    uuid: string;
+    testName: string;
+    score: number;
+    subject: 'ANGULAR' | 'NESTJS' | 'RXJS';
+    userAnswers: Array<string>;
+    passed: boolean;
+    completed: boolean;
+    lastUpdated: string;
+    __v: number;
+};

package/dist/models/UserAssessmentTestDto.js

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

package/dist/models/UserSubjectEligibilityDto.d.ts

@@ -0,0 +1,6 @@
+export type UserSubjectEligibilityDto = {
+    subject: 'ANGULAR' | 'NESTJS' | 'RXJS';
+    levelCount: number;
+    totalCount: number;
+    enabled: boolean;
+};

package/dist/models/UserSubjectEligibilityDto.js

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

package/dist/service-nestjs-assessment-test.types.d.ts

@@ -0,0 +1,349 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/assessment-test": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["AssessmentTestController_fetch"];
+        put?: never;
+        post: operations["AssessmentTestController_create"];
+        delete: operations["AssessmentTestController_delete"];
+        options?: never;
+        head?: never;
+        patch: operations["AssessmentTestController_update"];
+        trace?: never;
+    };
+    "/assessment-test/user-asssessments": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["AssessmentTestController_fetchUsersAssessments"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/assessment-test/user-subjects-eligibility": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["AssessmentTestController_fetchUserSubjectsEligibility"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/assessment-test/start-test": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["AssessmentTestController_startTest"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/assessment-test/submit-test": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["AssessmentTestController_submitTest"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/assessment-test/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["AssessmentTestController_fetchAssessmentTest"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        TestChoiceDto: {
+            value: string;
+        };
+        TestQuestionDto: {
+            question: string;
+            choices: components["schemas"]["TestChoiceDto"][];
+            answer: string;
+            correctResponse: string;
+            incorrectResponse: string;
+        };
+        AssessmentTestDto: {
+            _id: string;
+            name: string;
+            /** @enum {string} */
+            subject: "ANGULAR" | "NESTJS" | "RXJS";
+            level: number;
+            /** Format: date-time */
+            lastUpdated: string;
+            testQuestions: components["schemas"]["TestQuestionDto"][];
+            __v: number;
+        };
+        UserAssessmentTestDto: {
+            _id: string;
+            uuid: string;
+            testName: string;
+            score: number;
+            /** @enum {string} */
+            subject: "ANGULAR" | "NESTJS" | "RXJS";
+            userAnswers: string[];
+            passed: boolean;
+            completed: boolean;
+            /** Format: date-time */
+            lastUpdated: string;
+            __v: number;
+        };
+        UserSubjectEligibilityDto: {
+            /** @enum {string} */
+            subject: "ANGULAR" | "NESTJS" | "RXJS";
+            levelCount: number;
+            totalCount: number;
+            enabled: boolean;
+        };
+        StartTestDto: {
+            /** @enum {string} */
+            subject: "ANGULAR" | "NESTJS" | "RXJS";
+        };
+        SubmitTestDto: {
+            testId: string;
+            answers: string[];
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    AssessmentTestController_fetch: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    AssessmentTestController_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AssessmentTestDto"];
+                };
+            };
+        };
+    };
+    AssessmentTestController_delete: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": string;
+            };
+        };
+        responses: {
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    AssessmentTestController_update: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AssessmentTestDto"];
+                };
+            };
+        };
+    };
+    AssessmentTestController_fetchUsersAssessments: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UserAssessmentTestDto"][];
+                };
+            };
+        };
+    };
+    AssessmentTestController_fetchUserSubjectsEligibility: {
+        parameters: {
+            query: {
+                /** @description CSV list of subjects, e.g. ANGULAR,NESTJS,RXJS */
+                subjects: ("ANGULAR" | "NESTJS" | "RXJS")[];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UserSubjectEligibilityDto"][];
+                };
+            };
+        };
+    };
+    AssessmentTestController_startTest: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["StartTestDto"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UserAssessmentTestDto"];
+                };
+            };
+        };
+    };
+    AssessmentTestController_submitTest: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SubmitTestDto"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UserAssessmentTestDto"];
+                };
+            };
+        };
+    };
+    AssessmentTestController_fetchAssessmentTest: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AssessmentTestDto"];
+                };
+            };
+        };
+    };
+}

package/dist/service-nestjs-assessment-test.types.js

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

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@tmdjr/service-nestjs-assessment-test-contracts",
+  "version": "0.0.6",
+  "description": "Types & runtime enums generated from NGX service-nestjs-assessment-test 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/service-nestjs-assessment-test.types.ts src/models src/core src/schemas",
+    "gen:types": "openapi-typescript ../../openapi.json --output ./src/service-nestjs-assessment-test.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"
+  }
+}