@supernova-studio/model 0.47.28 → 0.47.29

package/package.json

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

package/src/export/export-destinations.ts

@@ -22,8 +22,8 @@ export const ExporterDestinationGithub = z.object({
   relativePath: nullishToOptional(z.string()),
 
   // Legacy deprecated fields. Use `credentialId` instead
-  connectionId: z.string().optional(),
-  userId: z.number().optional(),
+  connectionId: nullishToOptional(z.string()),
+  userId: nullishToOptional(z.number()),
 });
 
 export const ExporterDestinationAzure = z.object({
@@ -42,8 +42,8 @@ export const ExporterDestinationAzure = z.object({
   url: nullishToOptional(z.string()),
 
   // Legacy deprecated fields. Use `credentialId` instead
-  connectionId: z.string().optional(),
-  userId: z.number().optional(),
+  connectionId: nullishToOptional(z.string()),
+  userId: nullishToOptional(z.number()),
 });
 
 export const ExporterDestinationGitlab = z.object({
@@ -60,8 +60,8 @@ export const ExporterDestinationGitlab = z.object({
   url: nullishToOptional(z.string()),
 
   // Legacy deprecated fields. Use `credentialId` instead
-  connectionId: z.string().optional(),
-  userId: z.number().optional(),
+  connectionId: nullishToOptional(z.string()),
+  userId: nullishToOptional(z.number()),
 });
 
 export const ExporterDestinationBitbucket = z.object({
@@ -77,8 +77,8 @@ export const ExporterDestinationBitbucket = z.object({
   relativePath: nullishToOptional(z.string()),
 
   // Legacy deprecated fields. Use `credentialId` instead
-  connectionId: z.string().optional(),
-  userId: z.number().optional(),
+  connectionId: nullishToOptional(z.string()),
+  userId: nullishToOptional(z.number()),
 });
 
 export const ExportDestinationsMap = z.object({

package/src/export/export-jobs.ts

@@ -57,6 +57,7 @@ export const ExportJobResult = z.object({
   gitlab: nullishToOptional(ExportJobPullRequestDestinationResult),
   bitbucket: nullishToOptional(ExportJobPullRequestDestinationResult),
   sndocs: nullishToOptional(ExportJobDocsDestinationResult),
+  logs: nullishToOptional(ExportJobLogEntry.array()),
 });
 
 export type ExportJobLogEntry = z.infer<typeof ExportJobLogEntry>;
@@ -71,8 +72,8 @@ export type ExportJobResult = z.infer<typeof ExportJobResult>;
 
 export const ExportJob = z.object({
   id: z.string(),
-  createdAt: z.date(),
-  finishedAt: z.date().optional(),
+  createdAt: z.coerce.date(),
+  finishedAt: z.coerce.date().optional(),
   designSystemId: z.string(),
   designSystemVersionId: z.string(),
   workspaceId: z.string(),

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

@@ -12,6 +12,7 @@ export const ExportJobContext = z.object({
   accessToken: z.string(),
 
   designSystemId: z.string(),
+  exporterId: z.string(),
   versionId: z.string(),
   brandId: z.string().optional(),
   themeId: z.string().optional(),

package/src/integrations/git.ts

@@ -14,26 +14,36 @@ export const GitOrganization = z.object({
   id: z.string(),
   name: z.string(),
   url: z.string(),
+  slug: z.string(),
 });
-export type GitOrganization = z.infer<typeof GitOrganization>;
 
 export const GitProject = z.object({
   id: z.string(),
   name: z.string(),
   url: z.string(),
+  slug: z.string(),
 });
-export type GitProject = z.infer<typeof GitProject>;
 
 export const GitRepository = z.object({
   id: z.string(),
   name: z.string(),
   url: z.string(),
-  defaultBranch: z.string(),
+  slug: z.string(),
+
+  /**
+   * Can be undefined when:
+   *  - there are no branches in the repository yet
+   *  - Git provider doesn't expose this information on a repository via their API
+   */
+  defaultBranch: z.string().optional(),
 });
-export type GitRepository = z.infer<typeof GitRepository>;
 
 export const GitBranch = z.object({
   name: z.string(),
   lastCommitId: z.string(),
 });
+
+export type GitOrganization = z.infer<typeof GitOrganization>;
+export type GitProject = z.infer<typeof GitProject>;
+export type GitRepository = z.infer<typeof GitRepository>;
 export type GitBranch = z.infer<typeof GitBranch>;

package/src/integrations/integration.ts

@@ -15,6 +15,9 @@ export type IntegrationDesignSystem = z.infer<typeof IntegrationDesignSystem>;
 export const IntegrationCredentialsType = z.enum(["OAuth2", "PAT", "GithubApp"]);
 export type IntegrationCredentialsType = z.infer<typeof IntegrationCredentialsType>;
 
+export const IntegrationCredentialsState = z.enum(["Active", "Inactive"]);
+export type IntegrationCredentialsState = z.infer<typeof IntegrationCredentialsState>;
+
 export const IntegrationCredentialsProfile = z.object({
   id: nullishToOptional(z.string()),
   email: nullishToOptional(z.string()),
@@ -22,6 +25,7 @@ export const IntegrationCredentialsProfile = z.object({
   type: nullishToOptional(z.string()),
   avatarUrl: nullishToOptional(z.string()),
   organization: nullishToOptional(z.string()),
+  collection: nullishToOptional(z.string()),
 });
 
 export type IntegrationCredentialsProfile = z.infer<typeof IntegrationCredentialsProfile>;
@@ -41,6 +45,8 @@ export const IntegrationCredentials = z.object({
   appInstallationId: z.string().optional(),
   profile: IntegrationCredentialsProfile.optional(),
   customUrl: z.string().optional(),
+  state: IntegrationCredentialsState,
+
   user: UserMinified.optional(),
 });
 
@@ -76,9 +82,6 @@ export type ExtendedIntegration = Omit<Integration, "type"> & {
   integrationDesignSystems?: IntegrationDesignSystem[];
 };
 
-// Custom URL validation
-const forbiddenCustomUrldomainList = ["github.com", "gitlab.com", "bitbucket.org", "figma.com", "dev.azure.com"];
-
 export const IntegrationToken = z
   .object({
     access_token: z.string(),
@@ -86,16 +89,14 @@ export const IntegrationToken = z
     expires_in: z.union([z.number().optional(), z.string().optional()]),
     token_type: z.string().optional(),
     token_name: z.string().optional(),
-    token_azure_organization_name: z.string().optional(), // Azure only
+    token_azure_organization_name: z.string().optional(), // Azure Cloud PAT only
+    token_azure_collection_name: z.string().optional(), // Azure Server PAT only
     token_bitbucket_username: z.string().optional(), // Bitbucket only
     custom_url: z
       .string()
+      .url()
       .optional()
-      .refine(value => {
-        if (!value) return true;
-        if (forbiddenCustomUrldomainList.some(domain => value.includes(domain))) return false;
-        return true;
-      }, "Custom URL validation failed"),
+      .transform(value => value && formatCustomUrl(value)),
   })
   .refine(data => {
     if (data.custom_url && data.token_azure_organization_name) {
@@ -112,19 +113,25 @@ export const IntegrationToken = z
       tokenName: data.token_name,
       tokenBitbucketUsername: data.token_bitbucket_username,
       tokenAzureOrganizationName: data.token_azure_organization_name,
-      customUrl: data.custom_url ? formatCustomUrl(data.custom_url) : undefined,
+      tokenAzureCollection: data.token_azure_collection_name,
+      customUrl: data.custom_url,
     };
-
-    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>;
+
+// Custom URL validation
+const forbiddenCustomUrlDomainList = ["github.com", "gitlab.com", "bitbucket.org", "figma.com", "dev.azure.com"];
+
+function formatCustomUrl(url: string): string | undefined {
+  let formattedUrl = url.trim().toLowerCase();
+  if (!formattedUrl.startsWith("http://") && !formattedUrl.startsWith("https://")) {
+    formattedUrl = "https://" + formattedUrl;
+  }
+  if (formattedUrl.endsWith("/")) {
+    formattedUrl = formattedUrl.slice(0, -1);
+  }
+
+  // do not store default urls that we incorrectly provided as custom urls
+  return forbiddenCustomUrlDomainList.some(domain => formattedUrl.includes(domain)) ? undefined : formattedUrl;
+}

package/src/utils/common.ts

@@ -115,6 +115,10 @@ export async function sleep(ms: number): Promise<void> {
   return new Promise(resolve => setTimeout(resolve, ms));
 }
 
+export function uniqueBy<K, V>(items: V[], prop: (v: V) => K): V[] {
+  return Array.from(mapByUnique(items, prop).values());
+}
+
 export type Pagination = {
   skip?: number;
   take?: number;

package/src/utils/errors.ts

@@ -15,6 +15,7 @@ export type SupernovaExceptionType =
   | "MissingWorkspacePermission"
   | "MissingExporterPermission"
   | "MissingIntegration"
+  | "MissingIntegrationAccess"
   | "NoAccess"
   | "MissingCredentials"
   | "ValidationError"
@@ -85,6 +86,10 @@ export class SupernovaException extends Error {
     return new SupernovaException("MissingIntegration", message);
   }
 
+  static missingIntegrationAccess(message?: string): SupernovaException {
+    return new SupernovaException("MissingIntegrationAccess", message);
+  }
+
   static noAccess(message?: string): SupernovaException {
     return new SupernovaException("NoAccess", message);
   }