@tmdjr/document-contracts 0.0.13 → 0.0.15

package/dist/document.types.d.ts

@@ -244,11 +244,11 @@ export interface components {
                 [key: string]: components["schemas"]["SectionDto"];
             };
         };
-        WorkshopDoc: Record<string, never>;
-        WorkshopDocumentIdentifierDto: {
-            /** @description Object id of the workshop-document. */
+        Workshop: Record<string, never>;
+        WorkshopPageIdentifierDto: {
+            /** @description Object id of the workshop-page. */
             _id: string;
-            /** @description Display name of the workshop-document. */
+            /** @description Display name of the workshop-page. */
             name: string;
             /** @description Position of the doc item in the section's list */
             sortId: number;
@@ -263,7 +263,7 @@ export interface components {
             summary: string;
             /** @default https://via.placeholder.com/250/400 */
             thumbnail: string;
-            workshopDocuments?: components["schemas"]["WorkshopDocumentIdentifierDto"][];
+            workshopDocuments?: components["schemas"]["WorkshopPageIdentifierDto"][];
             /** Format: date-time */
             workshopDocumentsLastUpdated?: string;
         };
@@ -277,7 +277,7 @@ export interface components {
             summary?: string;
             /** @default https://via.placeholder.com/250/400 */
             thumbnail: string;
-            workshopDocuments?: components["schemas"]["WorkshopDocumentIdentifierDto"][];
+            workshopDocuments?: components["schemas"]["WorkshopPageIdentifierDto"][];
             /** Format: date-time */
             workshopDocumentsLastUpdated?: string;
         };
@@ -285,7 +285,20 @@ export interface components {
             acknowledged: boolean;
             deletedCount: number;
         };
-        WorkshopDocumentDto: {
+        CreateWorkshopPageDto: {
+            workshopGroupId: string;
+            /** @default Page */
+            name: string;
+            /** @default 0 */
+            sortId: number;
+            /** @default PAGE */
+            pageType: string;
+            /** Format: date-time */
+            lastUpdated?: string;
+            /** @description Serialized JSON of the document blocks */
+            html?: string;
+        };
+        WorkshopPageDto: {
             _id: string;
             workshopGroupId: string;
             /** @default Page */
@@ -301,7 +314,7 @@ export interface components {
             __v: number;
         };
         PageParamsDto: {
-            page: components["schemas"]["WorkshopDocumentDto"];
+            page: components["schemas"]["WorkshopPageDto"];
             workshopId: string;
         };
         WorkshopDto: {
@@ -314,7 +327,7 @@ export interface components {
             summary: string;
             /** @default https://via.placeholder.com/250/400 */
             thumbnail: string;
-            workshopDocuments: components["schemas"]["WorkshopDocumentIdentifierDto"][];
+            workshopDocuments: components["schemas"]["WorkshopPageIdentifierDto"][];
             /** Format: date-time */
             workshopDocumentsLastUpdated: string;
         };
@@ -362,7 +375,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["WorkshopDoc"][];
+                    "application/json": components["schemas"]["Workshop"][];
                 };
             };
         };
@@ -385,7 +398,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["WorkshopDoc"];
+                    "application/json": components["schemas"]["Workshop"];
                 };
             };
         };
@@ -408,7 +421,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["WorkshopDoc"];
+                    "application/json": components["schemas"]["Workshop"];
                 };
             };
         };
@@ -450,7 +463,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["WorkshopDoc"][];
+                    "application/json": components["schemas"]["Workshop"][];
                 };
             };
         };
@@ -464,7 +477,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["PageParamsDto"];
+                "application/json": components["schemas"]["CreateWorkshopPageDto"];
             };
         };
         responses: {
@@ -473,7 +486,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["WorkshopDoc"];
+                    "application/json": components["schemas"]["Workshop"];
                 };
             };
         };
@@ -510,7 +523,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["WorkshopDocumentDto"];
+                "application/json": components["schemas"]["WorkshopPageDto"];
             };
         };
         responses: {
@@ -580,7 +593,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["WorkshopDocumentDto"][];
+                    "application/json": components["schemas"]["WorkshopPageDto"][];
                 };
             };
         };
@@ -599,7 +612,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["WorkshopDocumentDto"];
+                    "application/json": components["schemas"]["WorkshopPageDto"];
                 };
             };
         };
@@ -618,7 +631,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["WorkshopDocumentDto"];
+                    "application/json": components["schemas"]["WorkshopPageDto"];
                 };
             };
         };

package/dist/index.d.ts

@@ -1,10 +1,11 @@
 export type { CreateWorkshopDto } from './models/CreateWorkshopDto';
+export type { CreateWorkshopPageDto } from './models/CreateWorkshopPageDto';
 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 { Workshop } from './models/Workshop';
 export type { WorkshopDto } from './models/WorkshopDto';
+export type { WorkshopPageDto } from './models/WorkshopPageDto';
+export type { WorkshopPageIdentifierDto } from './models/WorkshopPageIdentifierDto';

package/dist/models/CreateWorkshopDto.d.ts

@@ -1,4 +1,4 @@
-import type { WorkshopDocumentIdentifierDto } from './WorkshopDocumentIdentifierDto';
+import type { WorkshopPageIdentifierDto } from './WorkshopPageIdentifierDto';
 export type CreateWorkshopDto = {
     _id: string;
     sectionId: string;
@@ -7,6 +7,6 @@ export type CreateWorkshopDto = {
     name: string;
     summary: string;
     thumbnail?: string;
-    workshopDocuments?: Array<WorkshopDocumentIdentifierDto>;
+    workshopDocuments?: Array<WorkshopPageIdentifierDto>;
     workshopDocumentsLastUpdated?: string;
 };

package/dist/models/CreateWorkshopPageDto.d.ts

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

package/dist/models/PageParamsDto.d.ts

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

package/dist/models/UpdateWorkshopDto.d.ts

@@ -1,4 +1,4 @@
-import type { WorkshopDocumentIdentifierDto } from './WorkshopDocumentIdentifierDto';
+import type { WorkshopPageIdentifierDto } from './WorkshopPageIdentifierDto';
 export type UpdateWorkshopDto = {
     _id?: string;
     sectionId?: string;
@@ -7,6 +7,6 @@ export type UpdateWorkshopDto = {
     name?: string;
     summary?: string;
     thumbnail?: string;
-    workshopDocuments?: Array<WorkshopDocumentIdentifierDto>;
+    workshopDocuments?: Array<WorkshopPageIdentifierDto>;
     workshopDocumentsLastUpdated?: string;
 };

package/dist/models/Workshop.d.ts

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

package/dist/models/WorkshopDto.d.ts

@@ -1,4 +1,4 @@
-import type { WorkshopDocumentIdentifierDto } from './WorkshopDocumentIdentifierDto';
+import type { WorkshopPageIdentifierDto } from './WorkshopPageIdentifierDto';
 export type WorkshopDto = {
     _id: string;
     workshopDocumentGroupId: string;
@@ -7,6 +7,6 @@ export type WorkshopDto = {
     name: string;
     summary: string;
     thumbnail: string;
-    workshopDocuments: Array<WorkshopDocumentIdentifierDto>;
+    workshopDocuments: Array<WorkshopPageIdentifierDto>;
     workshopDocumentsLastUpdated: string;
 };

package/dist/models/{WorkshopDocumentDto.d.ts → WorkshopPageDto.d.ts}

@@ -1,4 +1,4 @@
-export type WorkshopDocumentDto = {
+export type WorkshopPageDto = {
     _id: string;
     workshopGroupId: string;
     name: string;

package/dist/models/{WorkshopDocumentIdentifierDto.d.ts → WorkshopPageIdentifierDto.d.ts}

@@ -1,10 +1,10 @@
-export type WorkshopDocumentIdentifierDto = {
+export type WorkshopPageIdentifierDto = {
     /**
-     * Object id of the workshop-document.
+     * Object id of the workshop-page.
      */
     _id: string;
     /**
-     * Display name of the workshop-document.
+     * Display name of the workshop-page.
      */
     name: string;
     /**

package/dist/models/WorkshopPageIdentifierDto.js

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

package/package.json

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

package/dist/models/WorkshopDoc.d.ts

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