@tmdjr/document-contracts 0.0.3 → 0.0.9

package/dist/document.types.d.ts

@@ -3,14 +3,14 @@
  * Do not make direct changes to the file.
  */
 export interface paths {
-    "/example-crud/auth-test": {
+    "/navigation/sections": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        get: operations["ExampleCrudController_authTest"];
+        get: operations["NavigationController_sections"];
         put?: never;
         post?: never;
         delete?: never;
@@ -19,55 +19,55 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/example-crud": {
+    "/navigation/workshops": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        get: operations["ExampleCrudController_findAll"];
+        get: operations["NavigationController_workshops"];
         put?: never;
-        post: operations["ExampleCrudController_create"];
+        post?: never;
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/example-crud/{id}": {
+    "/navigation/workshop/create-workshop": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        get: operations["ExampleCrudController_findOne"];
+        get?: never;
         put?: never;
-        post?: never;
-        delete: operations["ExampleCrudController_remove"];
+        post: operations["NavigationController_createWorkshop"];
+        delete?: never;
         options?: never;
         head?: never;
-        patch: operations["ExampleCrudController_update"];
+        patch?: never;
         trace?: never;
     };
-    "/example-crud/name/{name}": {
+    "/navigation/workshop/edit-workshop-name-and-summary": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        get: operations["ExampleCrudController_findByName"];
+        get?: never;
         put?: never;
-        post?: never;
+        post: operations["NavigationController_editWorkshopNameAndSummary"];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/example-crud/{id}/archive": {
+    "/navigation/workshop/delete-workshop-and-workshop-documents": {
         parameters: {
             query?: never;
             header?: never;
@@ -76,14 +76,78 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        post?: never;
+        post: operations["NavigationController_deleteWorkshopAndWorkshops"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/navigation/workshop/sort-workshops": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["NavigationController_sortWorkshops"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/navigation/page/create-page": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["NavigationController_createPage"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/navigation/page/delete-page-and-update-workshop": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["NavigationController_deletePageAndUpdateWorkshop"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/navigation/page/edit-page-name-update-workshop": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["NavigationController_editPageNameUpdateWorkshop"];
         delete?: never;
         options?: never;
         head?: never;
-        patch: operations["ExampleCrudController_archive"];
+        patch?: never;
         trace?: never;
     };
-    "/example-crud/{id}/unarchive": {
+    "/navigation/page/sort-pages": {
         parameters: {
             query?: never;
             header?: never;
@@ -92,58 +156,151 @@ export interface paths {
         };
         get?: never;
         put?: never;
+        post: operations["NavigationController_sortPages"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/workshop/workshops": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["WorkshopController_workshops"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/workshop/{objectId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["WorkshopController_workshop"];
+        put?: never;
         post?: never;
         delete?: never;
         options?: never;
         head?: never;
-        patch: operations["ExampleCrudController_unarchive"];
+        patch?: never;
+        trace?: never;
+    };
+    "/workshop/update-workshop-html": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["WorkshopController_updateWorkshopHtml"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
         trace?: never;
     };
 }
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
-        AuthTestDto: {
-            message: string;
+        SectionDto: {
+            _id: string;
+            sectionTitle: string;
+            summary: number;
+            menuSvgPath: string;
+            headerSvgPath: string;
+            categoriesLastUpdated: string;
         };
-        ExampleMongodbDocObjectDto: {
-            street: string;
-            city: string;
-            state: string;
-            zip: string;
+        SectionsMapDto: {
+            sections: {
+                [key: string]: components["schemas"]["SectionDto"];
+            };
         };
-        CreateExampleMongodbDocDto: {
+        WorkshopDoc: Record<string, never>;
+        WorkshopDocumentIdentifierDto: {
+            /** @description Object id of the workshop-document. */
+            _id: string;
+            /** @description Display name of the workshop-document. */
             name: string;
-            /** @enum {string} */
-            type: "SOME_ENUM" | "SOME_OTHER_ENUM";
-            description?: string;
-            archived?: boolean;
-            exampleMongodbDocObject?: components["schemas"]["ExampleMongodbDocObjectDto"];
+            /** @description Position of the doc item in the section's list */
+            sortId: number;
+        };
+        CreateWorkshopDto: {
+            _id: string;
+            sectionId: string;
+            workshopDocumentGroupId?: string;
+            /** @default 0 */
+            sortId: number;
+            name: string;
+            summary: string;
+            /** @default https://via.placeholder.com/250/400 */
+            thumbnail: string;
+            workshopDocuments?: components["schemas"]["WorkshopDocumentIdentifierDto"][];
+            /** Format: date-time */
+            workshopDocumentsLastUpdated?: string;
+        };
+        UpdateWorkshopDto: {
+            _id?: string;
+            sectionId?: string;
+            workshopDocumentGroupId?: string;
+            /** @default 0 */
+            sortId: number;
+            name?: string;
+            summary?: string;
+            /** @default https://via.placeholder.com/250/400 */
+            thumbnail: string;
+            workshopDocuments?: components["schemas"]["WorkshopDocumentIdentifierDto"][];
             /** Format: date-time */
-            lastUpdated?: string;
+            workshopDocumentsLastUpdated?: string;
+        };
+        DeleteResultDto: {
+            acknowledged: boolean;
+            deletedCount: number;
         };
-        ExampleMongodbDocDto: {
+        WorkshopDocumentDto: {
             _id: string;
+            workshopGroupId: string;
+            /** @default Page */
             name: string;
-            /** @enum {string} */
-            type: "SOME_ENUM" | "SOME_OTHER_ENUM";
-            version: number;
-            description: string;
+            /** @default 0 */
+            sortId: number;
+            /** @default PAGE */
+            pageType: string;
             /** Format: date-time */
             lastUpdated: string;
-            archived: boolean;
-            exampleMongodbDocObject?: components["schemas"]["ExampleMongodbDocObjectDto"];
+            /** @description Serialized JSON of the document blocks */
+            html: string;
             __v: number;
         };
-        UpdateExampleMongodbDocDto: {
-            name?: string;
-            /** @enum {string} */
-            type?: "SOME_ENUM" | "SOME_OTHER_ENUM";
-            description?: string;
-            archived?: boolean;
-            exampleMongodbDocObject?: components["schemas"]["ExampleMongodbDocObjectDto"];
+        PageParamsDto: {
+            page: components["schemas"]["WorkshopDocumentDto"];
+            workshopId: string;
+        };
+        WorkshopDto: {
+            _id: string;
+            workshopDocumentGroupId: string;
+            sectionId: string;
+            /** @default 0 */
+            sortId: number;
+            name: string;
+            summary: string;
+            /** @default https://via.placeholder.com/250/400 */
+            thumbnail: string;
+            workshopDocuments: components["schemas"]["WorkshopDocumentIdentifierDto"][];
             /** Format: date-time */
-            lastUpdated?: string;
+            workshopDocumentsLastUpdated: string;
         };
     };
     responses: never;
@@ -154,7 +311,7 @@ export interface components {
 }
 export type $defs = Record<string, never>;
 export interface operations {
-    ExampleCrudController_authTest: {
+    NavigationController_sections: {
         parameters: {
             query?: never;
             header?: never;
@@ -168,16 +325,15 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["AuthTestDto"];
+                    "application/json": components["schemas"]["SectionsMapDto"][];
                 };
             };
         };
     };
-    ExampleCrudController_findAll: {
+    NavigationController_workshops: {
         parameters: {
-            query?: {
-                /** @description Filter by archived status */
-                archived?: boolean;
+            query: {
+                section: string;
             };
             header?: never;
             path?: never;
@@ -190,12 +346,12 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ExampleMongodbDocDto"][];
+                    "application/json": components["schemas"]["WorkshopDoc"][];
                 };
             };
         };
     };
-    ExampleCrudController_create: {
+    NavigationController_createWorkshop: {
         parameters: {
             query?: never;
             header?: never;
@@ -204,27 +360,48 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["CreateExampleMongodbDocDto"];
+                "application/json": components["schemas"]["CreateWorkshopDto"];
             };
         };
         responses: {
-            201: {
+            200: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ExampleMongodbDocDto"];
+                    "application/json": components["schemas"]["WorkshopDoc"];
                 };
             };
         };
     };
-    ExampleCrudController_findOne: {
+    NavigationController_editWorkshopNameAndSummary: {
         parameters: {
             query?: never;
             header?: never;
-            path: {
-                id: string;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateWorkshopDto"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WorkshopDoc"];
+                };
             };
+        };
+    };
+    NavigationController_deleteWorkshopAndWorkshops: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
             cookie?: never;
         };
         requestBody?: never;
@@ -234,42 +411,67 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ExampleMongodbDocDto"];
+                    "application/json": components["schemas"]["DeleteResultDto"];
                 };
             };
         };
     };
-    ExampleCrudController_remove: {
+    NavigationController_sortWorkshops: {
         parameters: {
             query?: never;
             header?: never;
-            path: {
-                id: string;
-            };
+            path?: never;
             cookie?: never;
         };
-        requestBody?: never;
+        requestBody: {
+            content: {
+                "application/json": string[];
+            };
+        };
         responses: {
-            204: {
+            200: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["WorkshopDoc"][];
+                };
             };
         };
     };
-    ExampleCrudController_update: {
+    NavigationController_createPage: {
         parameters: {
             query?: never;
             header?: never;
-            path: {
-                id: string;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PageParamsDto"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WorkshopDoc"];
+                };
             };
+        };
+    };
+    NavigationController_deletePageAndUpdateWorkshop: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
             cookie?: never;
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["UpdateExampleMongodbDocDto"];
+                "application/json": components["schemas"]["PageParamsDto"];
             };
         };
         responses: {
@@ -278,18 +480,64 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ExampleMongodbDocDto"];
+                    "application/json": components["schemas"]["DeleteResultDto"];
                 };
             };
         };
     };
-    ExampleCrudController_findByName: {
+    NavigationController_editPageNameUpdateWorkshop: {
         parameters: {
             query?: never;
             header?: never;
-            path: {
-                name: string;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["WorkshopDocumentDto"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WorkshopDto"];
+                };
+            };
+        };
+    };
+    NavigationController_sortPages: {
+        parameters: {
+            query: {
+                workshopId: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": string[];
             };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WorkshopDto"];
+                };
+            };
+        };
+    };
+    WorkshopController_workshops: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
             cookie?: never;
         };
         requestBody?: never;
@@ -299,18 +547,16 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ExampleMongodbDocDto"];
+                    "application/json": components["schemas"]["WorkshopDocumentDto"][];
                 };
             };
         };
     };
-    ExampleCrudController_archive: {
+    WorkshopController_workshop: {
         parameters: {
             query?: never;
             header?: never;
-            path: {
-                id: string;
-            };
+            path?: never;
             cookie?: never;
         };
         requestBody?: never;
@@ -320,18 +566,16 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ExampleMongodbDocDto"];
+                    "application/json": components["schemas"]["WorkshopDocumentDto"];
                 };
             };
         };
     };
-    ExampleCrudController_unarchive: {
+    WorkshopController_updateWorkshopHtml: {
         parameters: {
             query?: never;
             header?: never;
-            path: {
-                id: string;
-            };
+            path?: never;
             cookie?: never;
         };
         requestBody?: never;
@@ -341,7 +585,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ExampleMongodbDocDto"];
+                    "application/json": components["schemas"]["WorkshopDocumentDto"];
                 };
             };
         };

package/dist/index.d.ts

@@ -1,5 +1,10 @@
-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';
+export type { CreateWorkshopDto } from './models/CreateWorkshopDto';
+export type { DeleteResultDto } from './models/DeleteResultDto';
+export type { PageParamsDto } from './models/PageParamsDto';
+export type { SectionDto } from './models/SectionDto';
+export type { SectionsMapDto } from './models/SectionsMapDto';
+export type { UpdateWorkshopDto } from './models/UpdateWorkshopDto';
+export type { WorkshopDoc } from './models/WorkshopDoc';
+export type { WorkshopDocumentDto } from './models/WorkshopDocumentDto';
+export type { WorkshopDocumentIdentifierDto } from './models/WorkshopDocumentIdentifierDto';
+export type { WorkshopDto } from './models/WorkshopDto';

package/dist/models/CreateWorkshopDto.d.ts

@@ -0,0 +1,12 @@
+import type { WorkshopDocumentIdentifierDto } from './WorkshopDocumentIdentifierDto';
+export type CreateWorkshopDto = {
+    _id: string;
+    sectionId: string;
+    workshopDocumentGroupId?: string;
+    sortId?: number;
+    name: string;
+    summary: string;
+    thumbnail?: string;
+    workshopDocuments?: Array<WorkshopDocumentIdentifierDto>;
+    workshopDocumentsLastUpdated?: string;
+};

package/dist/models/DeleteResultDto.d.ts

@@ -0,0 +1,4 @@
+export type DeleteResultDto = {
+    acknowledged: boolean;
+    deletedCount: number;
+};

package/dist/models/PageParamsDto.d.ts

@@ -0,0 +1,5 @@
+import type { WorkshopDocumentDto } from './WorkshopDocumentDto';
+export type PageParamsDto = {
+    page: WorkshopDocumentDto;
+    workshopId: string;
+};

package/dist/models/SectionDto.d.ts

@@ -0,0 +1,8 @@
+export type SectionDto = {
+    _id: string;
+    sectionTitle: string;
+    summary: number;
+    menuSvgPath: string;
+    headerSvgPath: string;
+    categoriesLastUpdated: string;
+};

package/dist/models/SectionsMapDto.d.ts

@@ -0,0 +1,4 @@
+import type { SectionDto } from './SectionDto';
+export type SectionsMapDto = {
+    sections: Record<string, SectionDto>;
+};

package/dist/models/UpdateWorkshopDto.d.ts

@@ -0,0 +1,12 @@
+import type { WorkshopDocumentIdentifierDto } from './WorkshopDocumentIdentifierDto';
+export type UpdateWorkshopDto = {
+    _id?: string;
+    sectionId?: string;
+    workshopDocumentGroupId?: string;
+    sortId?: number;
+    name?: string;
+    summary?: string;
+    thumbnail?: string;
+    workshopDocuments?: Array<WorkshopDocumentIdentifierDto>;
+    workshopDocumentsLastUpdated?: string;
+};

package/dist/models/UpdateWorkshopDto.js

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

package/dist/models/WorkshopDoc.d.ts

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

package/dist/models/WorkshopDoc.js

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

package/dist/models/WorkshopDocumentDto.d.ts

@@ -0,0 +1,13 @@
+export type WorkshopDocumentDto = {
+    _id: string;
+    workshopGroupId: string;
+    name: string;
+    sortId: number;
+    pageType: string;
+    lastUpdated: string;
+    /**
+     * Serialized JSON of the document blocks
+     */
+    html: string;
+    __v: number;
+};

package/dist/models/WorkshopDocumentDto.js

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

package/dist/models/WorkshopDocumentIdentifierDto.d.ts

@@ -0,0 +1,14 @@
+export type WorkshopDocumentIdentifierDto = {
+    /**
+     * Object id of the workshop-document.
+     */
+    _id: string;
+    /**
+     * Display name of the workshop-document.
+     */
+    name: string;
+    /**
+     * Position of the doc item in the section's list
+     */
+    sortId: number;
+};

package/dist/models/WorkshopDocumentIdentifierDto.js

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

package/dist/models/WorkshopDto.d.ts

@@ -0,0 +1,12 @@
+import type { WorkshopDocumentIdentifierDto } from './WorkshopDocumentIdentifierDto';
+export type WorkshopDto = {
+    _id: string;
+    workshopDocumentGroupId: string;
+    sectionId: string;
+    sortId: number;
+    name: string;
+    summary: string;
+    thumbnail: string;
+    workshopDocuments: Array<WorkshopDocumentIdentifierDto>;
+    workshopDocumentsLastUpdated: string;
+};

package/dist/models/WorkshopDto.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmdjr/document-contracts",
-  "version": "0.0.3",
+  "version": "0.0.9",
   "description": "Types & runtime enums generated from NGX document spec",
   "license": "MIT",
   "private": false,

package/dist/models/AuthTestDto.d.ts

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

package/dist/models/CreateExampleMongodbDocDto.d.ts

@@ -1,9 +0,0 @@
-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/ExampleMongodbDocDto.d.ts

@@ -1,12 +0,0 @@
-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/ExampleMongodbDocObjectDto.d.ts

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

package/dist/models/UpdateExampleMongodbDocDto.d.ts

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