@supernova-studio/client 0.59.18 → 0.59.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supernova-studio/client",
-  "version": "0.59.18",
+  "version": "0.59.20",
   "description": "Supernova Data Models",
   "source": "src/index.ts",
   "main": "dist/index.js",

package/src/api/conversion/export/pipeline.ts

@@ -19,7 +19,7 @@ export function pipelineToDto(pipeline: Pipeline): DTOPipeline {
     destinationGithub: pipeline.destinationGithub,
     destinationGitlab: pipeline.destinationGitlab,
     destinationS3: pipeline.destinationS3,
-    exporterConfigurationProperties: pipeline.exporterConfigurationProperties,
+    exporterPropertyValues: pipeline.exporterPropertyValues,
     webhookUrl: pipeline.webhookUrl,
     latestJobs: [],
   };

package/src/api/dto/elements/documentation/page-actions-v2.ts

@@ -7,6 +7,7 @@ import {
   DTOMoveDocumentationPageInputV2,
   DTORestoreDocumentationGroupInput,
   DTORestoreDocumentationPageInput,
+  DTOUpdateDocumentationPageDocumentInputV2,
   DTOUpdateDocumentationPageInputV2,
 } from "./page-v2";
 
@@ -28,6 +29,11 @@ export const DTODocumentationPageUpdateActionOutputV2 = z.object({
   output: SuccessPayload,
 });
 
+export const DTODocumentationPageUpdateDocumentActionOutputV2 = z.object({
+  type: z.literal("DocumentationPageUpdateDocument"),
+  output: SuccessPayload,
+});
+
 export const DTODocumentationPageMoveActionOutputV2 = z.object({
   type: z.literal("DocumentationPageMove"),
   output: SuccessPayload,
@@ -60,6 +66,9 @@ export const DTODocumentationPageApprovalStateChangeActionOutput = z.object({
 
 export type DTODocumentationPageCreateActionOutputV2 = z.infer<typeof DTODocumentationPageCreateActionOutputV2>;
 export type DTODocumentationPageUpdateActionOutputV2 = z.infer<typeof DTODocumentationPageUpdateActionOutputV2>;
+export type DTODocumentationPageUpdateDocumentActionOutputV2 = z.infer<
+  typeof DTODocumentationPageUpdateDocumentActionOutputV2
+>;
 export type DTODocumentationPageMoveActionOutputV2 = z.infer<typeof DTODocumentationPageMoveActionOutputV2>;
 export type DTODocumentationPageDuplicateActionOutputV2 = z.infer<typeof DTODocumentationPageDuplicateActionOutputV2>;
 export type DTODocumentationPageDeleteActionOutputV2 = z.infer<typeof DTODocumentationPageDeleteActionOutputV2>;
@@ -82,6 +91,11 @@ export const DTODocumentationPageUpdateActionInputV2 = z.object({
   input: DTOUpdateDocumentationPageInputV2,
 });
 
+export const DTODocumentationPageUpdateDocumentActionInputV2 = z.object({
+  type: z.literal("DocumentationPageUpdateDocument"),
+  input: DTOUpdateDocumentationPageDocumentInputV2,
+});
+
 export const DTODocumentationPageMoveActionInputV2 = z.object({
   type: z.literal("DocumentationPageMove"),
   input: DTOMoveDocumentationPageInputV2,
@@ -114,6 +128,9 @@ export const DTODocumentationPageApprovalStateChangeActionInput = z.object({
 
 export type DTODocumentationPageCreateActionInputV2 = z.infer<typeof DTODocumentationPageCreateActionInputV2>;
 export type DTODocumentationPageUpdateActionInputV2 = z.infer<typeof DTODocumentationPageUpdateActionInputV2>;
+export type DTODocumentationPageUpdateDocumentActionInputV2 = z.infer<
+  typeof DTODocumentationPageUpdateDocumentActionInputV2
+>;
 export type DTODocumentationPageMoveActionInputV2 = z.infer<typeof DTODocumentationPageMoveActionInputV2>;
 export type DTODocumentationPageDuplicateActionInputV2 = z.infer<typeof DTODocumentationPageDuplicateActionInputV2>;
 export type DTODocumentationPageDeleteActionInputV2 = z.infer<typeof DTODocumentationPageDeleteActionInputV2>;

package/src/api/dto/elements/documentation/page-v2.ts

@@ -1,4 +1,4 @@
-import { DocumentationPageApprovalState } from "@supernova-studio/model";
+import { DocumentationPageApprovalState, DocumentationPageContentItem } from "@supernova-studio/model";
 import { z } from "zod";
 import { DTODocumentationPageApprovalState } from "../../documentation";
 import { DTODocumentationDraftState } from "./draft-state";
@@ -64,7 +64,7 @@ export const DTOCreateDocumentationPageInputV2 = z.object({
 });
 
 export const DTOUpdateDocumentationPageInputV2 = z.object({
-  // Identifier of the group to update
+  // Identifier of the page to update
   id: z.string(),
 
   // Page properties
@@ -72,6 +72,14 @@ export const DTOUpdateDocumentationPageInputV2 = z.object({
   configuration: DTODocumentationItemConfigurationV2.partial().optional(),
 });
 
+export const DTOUpdateDocumentationPageDocumentInputV2 = z.object({
+  // Identifier of the page to update
+  id: z.string(),
+
+  // Page properties
+  documentItems: z.array(DocumentationPageContentItem),
+});
+
 export const DTOMoveDocumentationPageInputV2 = z.object({
   // Identifier of the group to update
   id: z.string(),
@@ -115,6 +123,7 @@ export const DTODocumentationPageApprovalStateChangeInput = z.object({
 
 export type DTOCreateDocumentationPageInputV2 = z.infer<typeof DTOCreateDocumentationPageInputV2>;
 export type DTOUpdateDocumentationPageInputV2 = z.infer<typeof DTOUpdateDocumentationPageInputV2>;
+export type DTOUpdateDocumentationPageDocumentInputV2 = z.infer<typeof DTOUpdateDocumentationPageDocumentInputV2>;
 export type DTOMoveDocumentationPageInputV2 = z.infer<typeof DTOMoveDocumentationPageInputV2>;
 export type DTODuplicateDocumentationPageInputV2 = z.infer<typeof DTODuplicateDocumentationPageInputV2>;
 export type DTODeleteDocumentationPageInputV2 = z.infer<typeof DTODeleteDocumentationPageInputV2>;

package/src/api/dto/elements/elements-action-v2.ts

@@ -32,6 +32,8 @@ import {
   DTODocumentationPageRestoreActionOutput,
   DTODocumentationPageUpdateActionInputV2,
   DTODocumentationPageUpdateActionOutputV2,
+  DTODocumentationPageUpdateDocumentActionInputV2,
+  DTODocumentationPageUpdateDocumentActionOutputV2,
 } from "./documentation/page-actions-v2";
 import {
   DTOFigmaNodeRenderActionInput,
@@ -48,6 +50,7 @@ export const DTOElementActionOutput = z.discriminatedUnion("type", [
   // Documentation pages
   DTODocumentationPageCreateActionOutputV2,
   DTODocumentationPageUpdateActionOutputV2,
+  DTODocumentationPageUpdateDocumentActionOutputV2,
   DTODocumentationPageMoveActionOutputV2,
   DTODocumentationPageDuplicateActionOutputV2,
   DTODocumentationPageDeleteActionOutputV2,
@@ -84,6 +87,7 @@ export const DTOElementActionInput = z
     // Documentation pages
     DTODocumentationPageCreateActionInputV2,
     DTODocumentationPageUpdateActionInputV2,
+    DTODocumentationPageUpdateDocumentActionInputV2,
     DTODocumentationPageMoveActionInputV2,
     DTODocumentationPageDuplicateActionInputV2,
     DTODocumentationPageDeleteActionInputV2,

package/src/api/dto/export/exporter-property.ts

@@ -8,10 +8,10 @@ const PrimitiveValue = z.number().or(z.boolean()).or(z.string());
 const ArrayValue = z.array(z.string());
 const ObjectValue = z.record(z.string());
 
-export const DTOExporterPropertyDefinitionValue = PrimitiveValue.or(ArrayValue).or(ObjectValue);
+export const DTOExporterPropertyValue = PrimitiveValue.or(ArrayValue).or(ObjectValue);
 export const DTOExporterPropertyType = z.enum(["Enum", "Boolean", "String", "Number", "Array", "Object"]);
 
-export type DTOExporterPropertyDefinitionValue = z.infer<typeof DTOExporterPropertyDefinitionValue>;
+export type DTOExporterPropertyDefinitionValue = z.infer<typeof DTOExporterPropertyValue>;
 export type DTOExporterPropertyType = z.infer<typeof DTOExporterPropertyType>;
 
 //
@@ -101,5 +101,5 @@ export type DTOExporterPropertyDefinitionsResponse = z.infer<typeof DTOExporterP
 // Value
 //
 
-export const DTOExporterPropertyDefinitionValueMap = z.record(DTOExporterPropertyDefinitionValue);
-export type DTOExporterPropertyDefinitionValueMap = z.infer<typeof DTOExporterPropertyDefinitionValueMap>;
+export const DTOExporterPropertyValueMap = z.record(DTOExporterPropertyValue);
+export type DTOExporterPropertyValueMap = z.infer<typeof DTOExporterPropertyValueMap>;

package/src/api/dto/export/job.ts

@@ -11,7 +11,7 @@ import {
   ObjectMeta,
 } from "@supernova-studio/model";
 import { z } from "zod";
-import { DTOExporterPropertyDefinitionValueMap } from "./exporter-property";
+import { DTOExporterPropertyValueMap } from "./exporter-property";
 
 export const DTOExportJobCreatedBy = z.object({
   userId: z.string(),
@@ -71,7 +71,7 @@ export const DTOExportJob = z.object({
   themePersistentId: z.string().optional(),
   themePersistentIds: z.string().array().optional(),
 
-  exporterConfigurationProperties: DTOExporterPropertyDefinitionValueMap.optional(),
+  exporterPropertyValues: DTOExporterPropertyValueMap.optional(),
 });
 
 export const DTOExportJobResponse = z.object({
@@ -94,3 +94,20 @@ export type DTOExportJobDestinations = z.infer<typeof DTOExportJobDestinations>;
 export type DTOExportJobResult = z.infer<typeof DTOExportJobResult>;
 export type DTOExportJob = z.infer<typeof DTOExportJob>;
 export type DTOExportJobResponse = z.infer<typeof DTOExportJobResponse>;
+
+//
+// Write
+//
+
+export const DTOExportJobCreateInput = z.object({
+  designSystemId: z.string(),
+  designSystemVersionId: z.string(),
+  exporterId: z.string(),
+  brandId: z.string().optional(),
+  themeId: z.string().optional(),
+  themePersistentIds: z.string().array().optional(),
+  destinations: DTOExportJobDestinations,
+  exporterPropertyValues: DTOExporterPropertyValueMap.optional(),
+});
+
+export type DTOExportJobCreateInput = z.infer<typeof DTOExportJobCreateInput>;

package/src/api/dto/export/pipeline.ts

@@ -1,6 +1,6 @@
 import { ExportDestinationsMap, PipelineEventType } from "@supernova-studio/model";
 import { z } from "zod";
-import { DTOExporterPropertyDefinitionValueMap } from "./exporter-property";
+import { DTOExporterPropertyValueMap } from "./exporter-property";
 import { DTOExportJob } from "./job";
 
 export const DTOPipelineListQuery = z.object({
@@ -22,7 +22,7 @@ export const DTOPipeline = z.object({
   themePersistentId: z.string().optional(),
   themePersistentIds: z.string().array().optional(),
 
-  exporterConfigurationProperties: DTOExporterPropertyDefinitionValueMap.optional(),
+  exporterPropertyValues: DTOExporterPropertyValueMap.optional(),
 
   ...ExportDestinationsMap.shape,
 

package/src/api/payloads/export/pipeline.ts

@@ -10,7 +10,7 @@ import {
   PipelineEventType,
 } from "@supernova-studio/model";
 import { z } from "zod";
-import { DTOExporterPropertyDefinitionValueMap } from "../../dto/export/exporter-property";
+import { DTOExporterPropertyValueMap } from "../../dto/export/exporter-property";
 
 export const DTOPipelineCreateBody = z.object({
   name: z.string(),
@@ -22,7 +22,7 @@ export const DTOPipelineCreateBody = z.object({
   themePersistentId: z.string().optional(),
   themePersistentIds: z.string().array().optional(),
 
-  exporterConfigurationProperties: DTOExporterPropertyDefinitionValueMap.optional(),
+  exporterPropertyValues: DTOExporterPropertyValueMap.optional(),
 
   destination: PipelineDestinationType.optional(),
   gitQuery: GitObjectsQuery,
@@ -47,7 +47,7 @@ export const DTOPipelineUpdateBody = z.object({
   themePersistentId: z.string().optional(),
   themePersistentIds: z.string().array().optional(),
 
-  exporterConfigurationProperties: DTOExporterPropertyDefinitionValueMap.optional(),
+  exporterPropertyValues: DTOExporterPropertyValueMap.optional(),
 
   destination: PipelineDestinationType.optional(),
   gitQuery: GitObjectsQuery.optional(),