@supernova-studio/model 0.47.16 → 0.47.18

package/package.json

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

package/src/export/export-destinations.ts

@@ -1,5 +1,6 @@
 import { z } from "zod";
 import { PublishedDocEnvironment } from "../dsm";
+import { nullishToOptional } from "../helpers";
 
 const BITBUCKET_SLUG = /^[-a-zA-Z0-9~]*$/;
 const BITBUCKET_MAX_LENGTH = 64;
@@ -11,48 +12,57 @@ export const ExporterDestinationDocs = z.object({
 export const ExporterDestinationS3 = z.object({});
 
 export const ExporterDestinationGithub = z.object({
+  credentialId: z.string().optional(),
+
+  // Repository
   url: z.string(),
+
+  // Location
   branch: z.string(),
-  userId: z.string(),
-  connectionId: z.string(),
-  relativePath: z.string(),
+  relativePath: nullishToOptional(z.string()),
 });
 
 export const ExporterDestinationAzure = z.object({
-  connectionId: z.string(),
+  credentialId: z.string().optional(),
+
+  // Repository
   organizationId: z.string(),
   projectId: z.string(),
   repositoryId: z.string(),
+
+  // Location
   branch: z.string(),
-  relativePath: z.string(),
+  relativePath: nullishToOptional(z.string()),
 
-  // // +
-  // userId: z.coerce.string(),
-  // url: z.string(),
+  // Maybe not needed
+  url: nullishToOptional(z.string()),
 });
 
 export const ExporterDestinationGitlab = z.object({
-  connectionId: z.string(),
+  credentialId: z.string().optional(),
+
+  // Repository
   projectId: z.string(),
+
+  // Location
   branch: z.string(),
-  relativePath: z.string(),
+  relativePath: nullishToOptional(z.string()),
 
-  // // +
-  // userId: z.coerce.string(),
-  // url: z.string(),
+  // Maybe not needed
+  url: nullishToOptional(z.string()),
 });
 
 export const ExporterDestinationBitbucket = z.object({
-  connectionId: z.string(),
+  credentialId: z.string().optional(),
+
+  // Repository
   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(),
+  // Location
+  branch: z.string(),
+  relativePath: nullishToOptional(z.string()),
 });
 
 export const ExportDestinationsMap = z.object({

package/src/export/export-jobs.ts

@@ -7,7 +7,15 @@ import { ExportDestinationsMap } from "./export-destinations";
 // Enums
 //
 
-export const ExportJobDestinationType = z.enum(["s3", "webhookUrl", "github", "documentation", "azure", "gitlab"]);
+export const ExportJobDestinationType = z.enum([
+  "s3",
+  "webhookUrl",
+  "github",
+  "documentation",
+  "azure",
+  "gitlab",
+  "bitbucket",
+]);
 export const ExportJobStatus = z.enum(["InProgress", "Success", "Failed", "Timeout"]);
 export const ExportJobLogEntryType = z.enum(["success", "info", "warning", "error", "user"]);
 

package/src/export/exporter.ts

@@ -1,13 +1,13 @@
 import { z } from "zod";
-import { GitProvider } from "./git-providers";
-import { PulsarCustomBlock, PulsarContributionConfigurationProperty, PulsarContributionVariant } from "./pulsar";
 import { nullishToOptional } from "../helpers";
+import { GitProvider } from "./git-providers";
+import { PulsarContributionConfigurationProperty, PulsarContributionVariant, PulsarCustomBlock } from "./pulsar";
 
 export const ExporterType = z.enum(["code", "documentation"]);
 export const ExporterSource = z.enum(["git", "upload"]);
 export const ExporterTag = z.string().regex(/^[0-9a-zA-Z]+(\s[0-9a-zA-Z]+)*$/);
 
-export const ExporterDetails = z.object({
+export const ExporterPulsarDetails = z.object({
   description: z.string(),
   version: z.string(),
   routingVersion: nullishToOptional(z.string()),
@@ -25,7 +25,9 @@ export const ExporterDetails = z.object({
 
   usesBrands: nullishToOptional(z.boolean()).default(false),
   usesThemes: nullishToOptional(z.boolean()).default(false),
+});
 
+export const ExporterDetails = ExporterPulsarDetails.extend({
   source: ExporterSource,
 
   gitProvider: nullishToOptional(GitProvider),
@@ -47,5 +49,6 @@ export const Exporter = z.object({
 export type ExporterType = z.infer<typeof ExporterType>;
 export type ExporterSource = z.infer<typeof ExporterSource>;
 export type ExporterTag = z.infer<typeof ExporterTag>;
+export type ExporterPulsarDetails = z.infer<typeof ExporterPulsarDetails>;
 export type ExporterDetails = z.infer<typeof ExporterDetails>;
 export type Exporter = z.infer<typeof Exporter>;

package/src/export/index.ts

@@ -1,9 +1,9 @@
 export * from "./export-runner";
 export * from "./export-destinations";
 export * from "./export-jobs";
-export * from "./export-schedule";
 export * from "./exporter-workspace-membership-role";
 export * from "./exporter-workspace-membership";
 export * from "./exporter";
 export * from "./git-providers";
+export * from "./pipeline";
 export * from "./pulsar";

package/src/export/pipeline.ts

@@ -0,0 +1,33 @@
+import { z } from "zod";
+import { ExportDestinationsMap } from "./export-destinations";
+
+export const PipelineEventType = z.enum(["OnVersionReleased", "OnHeadChanged", "OnSourceUpdated", "None"]);
+
+export const PipelineDestinationGitType = z.enum(["Github", "Gitlab", "Bitbucket", "Azure"]);
+export const PipelineDestinationExtraType = z.enum(["WebhookUrl", "S3", "Documentation"]);
+export const PipelineDestinationType = z.union([PipelineDestinationGitType, PipelineDestinationExtraType]);
+
+export const Pipeline = 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(),
+
+  // Destinations
+  ...ExportDestinationsMap.shape,
+});
+
+export type PipelineEventType = z.infer<typeof PipelineEventType>;
+export type PipelineDestinationGitType = z.infer<typeof PipelineDestinationGitType>;
+export type PipelineDestinationExtraType = z.infer<typeof PipelineDestinationExtraType>;
+export type PipelineDestinationType = z.infer<typeof PipelineDestinationType>;
+
+export type Pipeline = z.infer<typeof Pipeline>;

package/src/integrations/git.ts

@@ -1,5 +1,15 @@
 import { z } from "zod";
 
+export const GitObjectsQuery = z.object({
+  organization: z.string().optional(), // Azure Organization | Bitbucket Workspace slug | Gitlab Group | Github Account (User or Organization)
+  project: z.string().optional(), // Only for Bitbucket and Azure
+  repository: z.string().optional(), // For all providers. For Gitlab, it's called "project".
+  branch: z.string().optional(), // For all providers.
+  user: z.string().optional(), // Gitlab user
+});
+
+export type GitObjectsQuery = z.infer<typeof GitObjectsQuery>;
+
 export const GitOrganization = z.object({
   id: z.string(),
   name: z.string(),

package/src/integrations/integration.ts

@@ -1,5 +1,6 @@
 import { z } from "zod";
 import { UserMinified } from "../users/user-minified";
+
 export const IntegrationDesignSystem = z.object({
   designSystemId: z.string(),
   brandId: z.string(),
@@ -57,6 +58,9 @@ export type ExtendedIntegrationType = z.infer<typeof ExtendedIntegrationType>;
 export const IntegrationType = ExtendedIntegrationType.exclude(["TokenStudio", "FigmaVariablesPlugin"]);
 export type IntegrationType = z.infer<typeof IntegrationType>;
 
+export const GitIntegrationType = IntegrationType.exclude(["Figma"]);
+export type GitIntegrationType = z.infer<typeof GitIntegrationType>;
+
 export const Integration = z.object({
   id: z.string(),
   workspaceId: z.string(),
@@ -106,8 +110,19 @@ export const IntegrationToken = z
       tokenName: data.token_name,
       tokenBitbucketUsername: data.token_bitbucket_username,
       tokenAzureOrganizationName: data.token_azure_organization_name,
-      customUrl: data.custom_url,
+      customUrl: data.custom_url ? formatCustomUrl(data.custom_url) : undefined,
     };
+
+    function formatCustomUrl(url: string): string {
+      let formattedUrl = url.trim();
+      if (!formattedUrl.startsWith("http://") && !formattedUrl.startsWith("https://")) {
+        formattedUrl = "http://" + formattedUrl;
+      }
+      if (formattedUrl.endsWith("/")) {
+        formattedUrl = formattedUrl.slice(0, -1);
+      }
+      return formattedUrl;
+    }
   });
 
 export type IntegrationToken = z.infer<typeof IntegrationToken>;

package/src/utils/common.ts

@@ -39,6 +39,16 @@ export function trimTrailingSlash(string: string): string {
   return string.endsWith("/") ? string.substring(0, string.length - 1) : string;
 }
 
+export function tryParseUrl(url: string): URL | null {
+  try {
+    return parseUrl(url);
+  } catch (e) {
+    console.error(`Error parsing URL ${url}`);
+    console.error(e);
+    return null;
+  }
+}
+
 export function parseUrl(url: string): URL {
   return new URL(url.startsWith("https://") || url.startsWith("http://") ? url : `https://${url}`);
 }

package/src/export/export-schedule.ts

@@ -1,25 +0,0 @@
-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>;