@supernova-studio/model 0.46.7 → 0.46.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supernova-studio/model",
-  "version": "0.46.7",
+  "version": "0.46.8",
   "description": "Supernova Data Models",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/export/export-destinations.ts

@@ -0,0 +1,75 @@
+import { z } from "zod";
+import { PublishedDocEnvironment } from "../dsm";
+
+const BITBUCKET_SLUG = /^[-a-zA-Z0-9~]*$/;
+const BITBUCKET_MAX_LENGTH = 64;
+
+export const ExporterDestinationDocs = z.object({
+  environment: PublishedDocEnvironment,
+});
+
+export const ExporterDestinationS3 = z.object({});
+
+export const ExporterDestinationGithub = z.object({
+  connectionId: z.string(),
+  branch: z.string(),
+  relativePath: z.string(),
+
+  // // +
+  // userId: z.coerce.string(),
+});
+
+export const ExporterDestinationAzure = z.object({
+  connectionId: z.string(),
+  organizationId: z.string(),
+  projectId: z.string(),
+  repositoryId: z.string(),
+  branch: z.string(),
+  relativePath: z.string(),
+
+  // // +
+  // userId: z.coerce.string(),
+  // url: z.string(),
+});
+
+export const ExporterDestinationGitlab = z.object({
+  connectionId: z.string(),
+  projectId: z.string(),
+  branch: z.string(),
+  relativePath: z.string(),
+
+  // // +
+  // userId: z.coerce.string(),
+  // url: z.string(),
+});
+
+export const ExporterDestinationBitbucket = z.object({
+  connectionId: z.string(),
+  workspaceSlug: z.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
+  projectKey: z.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
+  repoSlug: z.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
+  branch: z.string(),
+  relativePath: z.string(),
+
+  // // +
+  // userId: z.string(),
+  // url: z.string(),
+});
+
+export const ExportDestinationsMap = z.object({
+  webhookUrl: z.string().optional(),
+  destinationSnDocs: ExporterDestinationDocs.optional(),
+  destinationS3: ExporterDestinationS3.optional(),
+  destinationGithub: ExporterDestinationGithub.optional(),
+  destinationAzure: ExporterDestinationAzure.optional(),
+  destinationGitlab: ExporterDestinationGitlab.optional(),
+  destinationBitbucket: ExporterDestinationBitbucket.optional(),
+});
+
+export type ExporterDestinationDocs = z.infer<typeof ExporterDestinationDocs>;
+export type ExporterDestinationS3 = z.infer<typeof ExporterDestinationS3>;
+export type ExporterDestinationGithub = z.infer<typeof ExporterDestinationGithub>;
+export type ExporterDestinationAzure = z.infer<typeof ExporterDestinationAzure>;
+export type ExporterDestinationGitlab = z.infer<typeof ExporterDestinationGitlab>;
+export type ExporterDestinationBitbucket = z.infer<typeof ExporterDestinationBitbucket>;
+export type ExportDestinationsMap = z.infer<typeof ExportDestinationsMap>;

package/src/export/export-jobs.ts

@@ -0,0 +1,110 @@
+import { z } from "zod";
+import { PublishedDocEnvironment } from "../dsm";
+import { DbCreateInputOmit, DbUpdate } from "../helpers";
+import { ExportDestinationsMap } from "./export-destinations";
+
+//
+// Enums
+//
+
+export const ExportJobDestinationType = z.enum(["s3", "webhookUrl", "github", "documentation", "azure", "gitlab"]);
+export const ExportJobStatus = z.enum(["InProgress", "Success", "Failed", "Timeout"]);
+export const ExportJobLogEntryType = z.enum(["success", "info", "warning", "error", "user"]);
+
+export type ExportJobDestinationType = z.infer<typeof ExportJobDestinationType>;
+export type ExportJobStatus = z.infer<typeof ExportJobStatus>;
+export type ExportJobLogEntryType = z.infer<typeof ExportJobLogEntryType>;
+
+//
+// Results
+//
+
+export const ExportJobLogEntry = z.object({
+  id: z.string().optional(),
+  time: z.coerce.date(),
+  type: ExportJobLogEntryType,
+  message: z.string(),
+});
+
+export const ExportJobPullRequestDestinationResult = z.object({
+  pullRequestUrl: z.string(),
+});
+
+export const ExportJobS3DestinationResult = z.object({
+  bucket: z.string(),
+  urlPrefix: z.string().optional(),
+  path: z.string(),
+  files: z.array(z.string()),
+});
+
+export const ExportJobDocsDestinationResult = z.object({
+  url: z.string(),
+});
+
+export const ExportJobResult = z.object({
+  error: z.string().optional(),
+  s3: ExportJobS3DestinationResult.optional(),
+  github: ExportJobPullRequestDestinationResult.optional(),
+  azure: ExportJobPullRequestDestinationResult.optional(),
+  gitlab: ExportJobPullRequestDestinationResult.optional(),
+  bitbucket: ExportJobPullRequestDestinationResult.optional(),
+  sndocs: ExportJobDocsDestinationResult.optional(),
+});
+
+export type ExportJobLogEntry = z.infer<typeof ExportJobLogEntry>;
+export type ExportJobPullRequestDestinationResult = z.infer<typeof ExportJobPullRequestDestinationResult>;
+export type ExportJobS3DestinationResult = z.infer<typeof ExportJobS3DestinationResult>;
+export type ExportJobDocsDestinationResult = z.infer<typeof ExportJobDocsDestinationResult>;
+export type ExportJobResult = z.infer<typeof ExportJobResult>;
+
+//
+// Job
+//
+
+export const ExportJob = z.object({
+  id: z.string(),
+  createdAt: z.date(),
+  finishedAt: z.date().optional(),
+  designSystemId: z.string(),
+  designSystemVersionId: z.string(),
+  workspaceId: z.string(),
+  scheduleId: z.string().nullish(),
+  exporterId: z.string(),
+  brandId: z.string().optional(),
+  themeId: z.string().optional(),
+  estimatedExecutionTime: z.number().optional(),
+  status: ExportJobStatus,
+  result: ExportJobResult.optional(),
+  createdByUserId: z.string().optional(),
+
+  // Destinations
+  ...ExportDestinationsMap.shape,
+});
+
+export type ExportJob = z.infer<typeof ExportJob>;
+
+export type CreateExportJob = DbCreateInputOmit<ExportJob>;
+export type UpdateExportJob = Pick<DbUpdate<ExportJob>, "id" | "status" | "result" | "finishedAt">;
+
+//
+// Support
+//
+
+export const ExportJobFindByFilter = ExportJob.pick({
+  exporterId: true,
+  designSystemVersionId: true,
+  destinations: true,
+  createdByUserId: true,
+  status: true,
+  scheduleId: true,
+  designSystemId: true,
+  themeId: true,
+  brandId: true,
+})
+  .extend({
+    destinations: z.array(ExportJobDestinationType),
+    docsEnvironment: PublishedDocEnvironment,
+  })
+  .partial();
+
+export type ExportJobFindByFilter = z.infer<typeof ExportJobFindByFilter>;

package/src/export/export-runner/export-context.ts

@@ -0,0 +1,22 @@
+import { z } from "zod";
+import { ExporterPropertyValue, PublishedDocEnvironment } from "../../dsm";
+
+export const ExportJobDocumentationContext = z.object({
+  isSingleVersionDocs: z.boolean(),
+  versionSlug: z.string(),
+  environment: PublishedDocEnvironment,
+});
+
+export const ExportJobContext = z.object({
+  apiUrl: z.string(),
+  accessToken: z.string(),
+  designSystemId: z.string(),
+  designSystemVersionId: z.string(),
+  brandId: z.string().optional(),
+  exporterPackageUrl: z.string(),
+  exporterPropertyValues: ExporterPropertyValue.array(),
+  documentation: ExportJobDocumentationContext.optional(),
+});
+
+export type ExportJobDocumentationContext = z.infer<typeof ExportJobDocumentationContext>;
+export type ExportJobContext = z.infer<typeof ExportJobContext>;

package/src/export/export-runner/exporter-payload.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+
+export const ExporterFunctionPayload = z.object({
+  exportJobId: z.string(),
+  exportContextId: z.string(),
+  designSystemId: z.string(),
+});
+
+export type ExporterFunctionPayload = z.infer<typeof ExporterFunctionPayload>;

package/src/export/export-runner/index.ts

@@ -0,0 +1,2 @@
+export * from "./export-context";
+export * from "./exporter-payload";

package/src/export/export-schedule.ts

@@ -0,0 +1,25 @@
+import { z } from "zod";
+import { ExportDestinationsMap } from "./export-destinations";
+
+export const ExporterScheduleEventType = z.enum(["OnVersionReleased", "OnHeadChanged", "OnSourceUpdated", "None"]);
+
+export const ExporterSchedule = z.object({
+  id: z.string(),
+
+  name: z.string(),
+  eventType: ExporterScheduleEventType,
+  isEnabled: z.boolean(),
+
+  workspaceId: z.string(),
+  designSystemId: z.string(),
+  exporterId: z.string(),
+
+  brandId: z.string().optional(),
+  themeId: z.string().optional(),
+
+  // Destinations
+  ...ExportDestinationsMap.shape,
+});
+
+export type ExporterScheduleEventType = z.infer<typeof ExporterScheduleEventType>;
+export type ExporterSchedule = z.infer<typeof ExporterSchedule>;

package/src/{codegen → export}/index.ts

@@ -1,3 +1,4 @@
+export * from "./export-runner";
 export * from "./export-destinations";
 export * from "./export-jobs";
 export * from "./export-schedule";

package/src/index.ts

@@ -1,10 +1,10 @@
 export * from "./auth";
 export * from "./billing";
-export * from "./codegen";
 export * from "./common";
 export * from "./custom-domains";
 export * from "./docs-server";
 export * from "./dsm";
+export * from "./export";
 export * from "./feature-flags";
 export * from "./helpers";
 export * from "./integrations";

package/src/codegen/export-destinations.ts

@@ -1,54 +0,0 @@
-import { PublishedDocEnvironment } from "../dsm";
-import { z } from "zod";
-
-export const ExporterDestinationSnDocs = z.object({
-  environment: PublishedDocEnvironment,
-});
-
-export const ExporterDestinationS3 = z.object({});
-
-export const ExporterDestinationGithub = z.object({
-  connectionId: z.string(),
-  url: z.string(),
-  branch: z.string(),
-  relativePath: z.string(),
-  // +
-  userId: z.coerce.string(),
-});
-
-export const ExporterDestinationAzure = z.object({
-  connectionId: z.string(),
-  organizationId: z.string(),
-  projectId: z.string(),
-  repositoryId: z.string(),
-  branch: z.string(),
-  relativePath: z.string(),
-  // +
-  userId: z.coerce.string(),
-  url: z.string(),
-});
-
-export const ExporterDestinationGitlab = z.object({
-  connectionId: z.string(),
-  projectId: z.string(),
-  branch: z.string(),
-  relativePath: z.string(),
-  // +
-  userId: z.coerce.string(),
-  url: z.string(),
-});
-
-const BITBUCKET_SLUG = /^[-a-zA-Z0-9~]*$/;
-const BITBUCKET_MAX_LENGTH = 64;
-
-export const ExporterDestinationBitbucket = z.object({
-  connectionId: z.string(),
-  workspaceSlug: z.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
-  projectKey: z.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
-  repoSlug: z.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
-  branch: z.string(),
-  relativePath: z.string(),
-  // +
-  userId: z.coerce.string(),
-  url: z.string(),
-});

package/src/codegen/export-jobs.ts

@@ -1,97 +0,0 @@
-import { PublishedDocEnvironment } from "../dsm";
-import {
-  ExporterDestinationSnDocs,
-  ExporterDestinationS3,
-  ExporterDestinationGithub,
-  ExporterDestinationGitlab,
-  ExporterDestinationBitbucket,
-  ExporterDestinationAzure,
-} from "./export-destinations";
-import { z } from "zod";
-
-export const ExporterJobDestination = z.enum(["s3", "webhookUrl", "github", "documentation", "azure", "gitlab"]);
-
-export const ExporterJobStatus = z.enum(["InProgress", "Success", "Failed", "Timeout"]);
-
-export const ExporterJobLogEntryType = z.enum(["success", "info", "warning", "error", "user"]);
-
-export const ExporterJobLogEntry = z.object({
-  id: z.string().optional(),
-  time: z.coerce.date(),
-  type: ExporterJobLogEntryType,
-  message: z.string(),
-});
-
-export const ExporterJobResultPullRequestDestination = z.object({
-  pullRequestUrl: z.string(),
-});
-
-export const ExporterJobResultS3Destination = z.object({
-  bucket: z.string(),
-  urlPrefix: z.string().optional(),
-  path: z.string(),
-  files: z.array(z.string()),
-});
-
-export const ExporterJobResultDocsDestination = z.object({
-  url: z.string(),
-});
-
-export const ExporterJobResult = z.object({
-  error: z.string().optional(),
-  logs: z.array(ExporterJobLogEntry).optional(),
-  s3: ExporterJobResultS3Destination.optional(),
-  github: ExporterJobResultPullRequestDestination.optional(),
-  azure: ExporterJobResultPullRequestDestination.optional(),
-  gitlab: ExporterJobResultPullRequestDestination.optional(),
-  bitbucket: ExporterJobResultPullRequestDestination.optional(),
-  sndocs: ExporterJobResultDocsDestination.optional(),
-});
-
-export const ExporterJob = z.object({
-  id: z.coerce.string(),
-  createdAt: z.coerce.date(),
-  finishedAt: z.coerce.date().optional(),
-  designSystemId: z.coerce.string(),
-  designSystemVersionId: z.coerce.string(),
-  workspaceId: z.coerce.string(),
-  scheduleId: z.coerce.string().nullish(),
-  exporterId: z.coerce.string(),
-  brandId: z.coerce.string().optional(),
-  themeId: z.coerce.string().optional(),
-  estimatedExecutionTime: z.number().optional(),
-  status: ExporterJobStatus,
-  result: ExporterJobResult.optional(),
-  createdByUserId: z.string().optional(),
-
-  // CodegenDestinationsModel
-  webhookUrl: z.string().optional(),
-  destinationSnDocs: ExporterDestinationSnDocs.optional(),
-  destinationS3: ExporterDestinationS3.optional(),
-  destinationGithub: ExporterDestinationGithub.optional(),
-  destinationAzure: ExporterDestinationAzure.optional(),
-  destinationGitlab: ExporterDestinationGitlab.optional(),
-  destinationBitbucket: ExporterDestinationBitbucket.optional(),
-});
-
-export const ExporterJobFindByFilter = ExporterJob.pick({
-  exporterId: true,
-  designSystemVersionId: true,
-  destinations: true,
-  createdByUserId: true,
-  status: true,
-  scheduleId: true,
-  designSystemId: true,
-  themeId: true,
-  brandId: true,
-})
-  .extend({
-    destinations: z.array(ExporterJobDestination),
-    docsEnvironment: PublishedDocEnvironment,
-  })
-  .partial();
-
-export type ExporterJobDestination = z.infer<typeof ExporterJobDestination>;
-export type ExporterJobStatus = z.infer<typeof ExporterJobStatus>;
-export type ExporterJob = z.infer<typeof ExporterJob>;
-export type ExporterJobFindByFilter = z.infer<typeof ExporterJobFindByFilter>;

package/src/codegen/export-schedule.ts

@@ -1,37 +0,0 @@
-import {
-  ExporterDestinationSnDocs,
-  ExporterDestinationS3,
-  ExporterDestinationGithub,
-  ExporterDestinationGitlab,
-  ExporterDestinationBitbucket,
-  ExporterDestinationAzure,
-} from "./export-destinations";
-import { z } from "zod";
-
-export const ExporterScheduleEventType = z.enum(["InProgress", "Success", "Failed", "Timeout"]);
-
-export const ExporterSchedule = z.object({
-  id: z.coerce.string(),
-
-  name: z.coerce.string(),
-  eventType: ExporterScheduleEventType,
-  isEnabled: z.coerce.boolean(),
-
-  workspaceId: z.coerce.string(),
-  designSystemId: z.coerce.string(),
-  exporterId: z.coerce.string(),
-  brandId: z.coerce.string().optional(),
-  themeId: z.coerce.string().optional(),
-
-  // CodegenDestinationsModel
-  webhookUrl: z.string().optional(),
-  destinationSnDocs: ExporterDestinationSnDocs.optional(),
-  destinationS3: ExporterDestinationS3.optional(),
-  destinationGithub: ExporterDestinationGithub.optional(),
-  destinationAzure: ExporterDestinationAzure.optional(),
-  destinationGitlab: ExporterDestinationGitlab.optional(),
-  destinationBitbucket: ExporterDestinationBitbucket.optional(),
-});
-
-export type ExporterScheduleEventType = z.infer<typeof ExporterScheduleEventType>;
-export type ExporterSchedule = z.infer<typeof ExporterSchedule>;