@supernova-studio/client 0.47.17 → 0.47.19

package/package.json

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

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

@@ -0,0 +1 @@
+export * from "./pipeline";

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

@@ -0,0 +1,23 @@
+import { Pipeline } from "@supernova-studio/model";
+import { DTOPipeline } from "../../dto/export/pipeline";
+
+export function pipelineToDto(pipeline: Pipeline): DTOPipeline {
+  return {
+    id: pipeline.id,
+    name: pipeline.name,
+    eventType: pipeline.eventType,
+    isEnabled: pipeline.isEnabled,
+    workspaceId: pipeline.workspaceId,
+    designSystemId: pipeline.designSystemId,
+    exporterId: pipeline.exporterId,
+    brandPersistentId: pipeline.brandPersistentId,
+    themePersistentId: pipeline.themePersistentId,
+    destinationAzure: pipeline.destinationAzure,
+    destinationBitbucket: pipeline.destinationBitbucket,
+    destinationSnDocs: pipeline.destinationSnDocs,
+    destinationGithub: pipeline.destinationGithub,
+    destinationGitlab: pipeline.destinationGitlab,
+    destinationS3: pipeline.destinationS3,
+    webhookUrl: pipeline.webhookUrl,
+  };
+}

package/src/api/conversion/index.ts

@@ -1,2 +1,3 @@
 export * from "./documentation";
+export * from "./export";
 export * from "./integrations";

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

@@ -23,7 +23,7 @@ export const DTOExporter = z.object({
   iconURL: z.string().optional(),
   configurationProperties: PulsarContributionConfigurationProperty.array(),
   customBlocks: PulsarCustomBlock.array(),
-  blockVariants: PulsarContributionVariant.array(),
+  blockVariants: z.record(z.string(), PulsarContributionVariant.array()),
 
   usesBrands: z.boolean(),
   usesThemes: z.boolean(),
@@ -61,7 +61,7 @@ export const DTOExporterGitProviderEnum = z.enum(["github", "gitlab", "bitbucket
 
 export const DTOExporterCreateInput = z.object({
   url: z.string(),
-  provider: DTOExporterGitProviderEnum.optional(),
+  provider: DTOExporterGitProviderEnum,
 });
 
 export type DTOExporterGitProviderEnum = z.infer<typeof DTOExporterGitProviderEnum>;

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

@@ -1,2 +1,3 @@
 export * from "./exporter";
 export * from "./job";
+export * from "./pipeline";

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

@@ -48,20 +48,25 @@ export const DTOExportJob = z.object({
   status: ExportJobStatus,
   estimatedExecutionTime: z.number().optional(),
 
-  createdBy: DTOExportJobCreatedBy,
+  createdBy: DTOExportJobCreatedBy.optional(),
   designSystem: DTOExportJobDesignSystemPreview,
   designSystemVersion: DTOExportJobDesignSystemVersionPreview,
 
   destinations: DTOExportJobDestinations,
 
   exporterId: z.string(),
-  scheduleId: z.string(),
+  scheduleId: z.string().optional(),
 
   result: ExportJobResult.optional(),
 });
 
+export const DTOExportJobResponse = z.object({
+  job: DTOExportJob,
+});
+
 export type DTOExportJobCreatedBy = z.infer<typeof DTOExportJobCreatedBy>;
 export type DTOExportJobDesignSystemPreview = z.infer<typeof DTOExportJobDesignSystemPreview>;
 export type DTOExportJobDesignSystemVersionPreview = z.infer<typeof DTOExportJobDesignSystemVersionPreview>;
 export type DTOExportJobDestinations = z.infer<typeof DTOExportJobDestinations>;
 export type DTOExportJob = z.infer<typeof DTOExportJob>;
+export type DTOExportJobResponse = z.infer<typeof DTOExportJobResponse>;

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

@@ -0,0 +1,17 @@
+import { ExportDestinationsMap, PipelineEventType } from "@supernova-studio/model";
+import { z } from "zod";
+
+export const DTOPipeline = z.object({
+  id: z.string(),
+  name: z.string(),
+  eventType: PipelineEventType,
+  isEnabled: z.boolean(),
+  workspaceId: z.string(),
+  designSystemId: z.string(),
+  exporterId: z.string(),
+  brandPersistentId: z.string().optional(),
+  themePersistentId: z.string().optional(),
+  ...ExportDestinationsMap.shape,
+});
+
+export type DTOPipeline = z.infer<typeof DTOPipeline>;

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

@@ -0,0 +1 @@
+export * from "./pipeline";

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

@@ -0,0 +1,46 @@
+import {
+  ExporterDestinationAzure,
+  ExporterDestinationBitbucket,
+  ExporterDestinationDocs,
+  ExporterDestinationGithub,
+  ExporterDestinationGitlab,
+  ExporterDestinationS3,
+  GitObjectsQuery,
+  PipelineDestinationType,
+  PipelineEventType,
+} from "@supernova-studio/model";
+import { z } from "zod";
+
+export const DTOPipelineCreateBody = z.object({
+  name: z.string(),
+  exporterId: z.string(),
+  designSystemId: z.string(),
+  isEnabled: z.boolean(),
+  eventType: PipelineEventType,
+  brandPersistentId: z.string().optional(),
+  themePersistentId: z.string().optional(),
+
+  destination: PipelineDestinationType,
+  gitQuery: GitObjectsQuery,
+  destinations: z.object({
+    s3: ExporterDestinationS3.nullish(),
+    azure: ExporterDestinationAzure.nullish(),
+    bitbucket: ExporterDestinationBitbucket.nullish(),
+    github: ExporterDestinationGithub.nullish(),
+    gitlab: ExporterDestinationGitlab.nullish(),
+    documentation: ExporterDestinationDocs.nullish(),
+    webhookUrl: z.string().nullish(),
+  }),
+});
+
+export const DTOPipelineUpdateBody = DTOPipelineCreateBody.extend({
+  id: z.string(),
+});
+
+export const DTOPipelineTriggerBody = z.object({
+  designSystemVersionId: z.string(),
+});
+
+export type DTOPipelineCreateBody = z.infer<typeof DTOPipelineCreateBody>;
+export type DTOPipelineUpdateBody = z.infer<typeof DTOPipelineUpdateBody>;
+export type DTOPipelineTriggerBody = z.infer<typeof DTOPipelineTriggerBody>;

package/src/api/payloads/index.ts

@@ -1,5 +1,6 @@
 export * from "./design-systems";
 export * from "./documentation";
+export * from "./export";
 export * from "./liveblocks";
 export * from "./users";
 export * from "./workspaces";

package/src/api/payloads/workspaces/workspace-integrations.ts

@@ -16,11 +16,11 @@ export const DTOWorkspaceIntegrationPATInput = z.object({
 export type DTOWorkspaceIntegrationPATInput = z.infer<typeof DTOWorkspaceIntegrationPATInput>;
 
 export const DTOWorkspaceIntegrationGetGitObjectsInput = z.object({
-  organization: z.string().optional(), // Azure Organization | Bitbucket Workspace slug | Gitlab Group | Github Account (User or Organization)
+  organization: z.string().optional(), // Azure Organization | Bitbucket Workspace slug | Gitlab Group and Sub-Groups | Github Account (User or Organization)
   project: z.string().optional(), // Only for Bitbucket and Azure
   repository: z.string().optional(), // For all providers. Pay attention for Gitlab, they call repositories "projects".
-  branch: z.string().optional(), // For all providers.
-  user: z.string().optional(), // Only for Gitlab
+  branch: z.string().optional(), // For all providers, useful for PR creations.
+  user: z.string().optional(), // Only for Gitlab User Repositories
 });
 
 export type DTOWorkspaceIntegrationGetGitObjectsInput = z.infer<typeof DTOWorkspaceIntegrationGetGitObjectsInput>;