@supernova-studio/model 0.46.0 → 0.46.3

package/package.json

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

package/src/codegen/export-destinations.ts

@@ -0,0 +1,54 @@
+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,4 +1,12 @@
 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"]);
@@ -40,58 +48,6 @@ export const ExporterJobResult = z.object({
   sndocs: ExporterJobResultDocsDestination.optional(),
 });
 
-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(),
-});
-
 export const ExporterJob = z.object({
   id: z.coerce.string(),
   createdAt: z.coerce.date(),

package/src/codegen/export-schedule.ts

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

package/src/codegen/index.ts

@@ -1,4 +1,6 @@
+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";

package/src/dsm/data-sources/data-source.ts

@@ -123,7 +123,7 @@ export type DataSource = {
   name: string;
   thumbnailUrl: string | undefined;
 
-  // createdAt: Date;
+  createdAt: Date | null;
   // updatedAt: Date;
 
   lastImportedAt: Date | undefined;

package/src/dsm/elements/data/documentation-block-v1.ts

@@ -143,6 +143,7 @@ export const PageBlockShortcut = z.object({
   description: nullishToOptional(z.string()),
   asset: nullishToOptional(PageBlockAsset),
   documentationItemId: nullishToOptional(z.string()),
+  pageHeadingId: nullishToOptional(z.string()),
   url: nullishToOptional(z.string()),
   openInNewTab: nullishToOptional(z.boolean()),
   urlPreview: nullishToOptional(PageBlockUrlPreview),

package/src/dsm/elements/figma-node-reference.ts

@@ -1,11 +1,12 @@
 import { z } from "zod";
-import { DesignElementBase } from "./base";
-import { FigmaNodeReferenceData } from "./data/figma-node-reference";
 import { DbCreateInputOmit, DbUpdate } from "../../helpers";
 import { OmitStrict } from "../../utils";
+import { DesignElementBase } from "./base";
+import { FigmaNodeReferenceData } from "./data/figma-node-reference";
 
 export const FigmaNodeReferenceOrigin = z.object({
   sourceId: z.string(),
+  parentName: z.string().optional(),
 });
 
 export const FigmaNodeReference = DesignElementBase.extend({

package/src/dsm/index.ts

@@ -4,7 +4,6 @@ export * from "./documentation";
 export * from "./elements";
 export * from "./import";
 export * from "./properties";
-export * from "./rooms";
 export * from "./views";
 export * from "./brand";
 export * from "./design-system";

package/src/dsm/published-doc-page.ts

@@ -18,7 +18,6 @@ export const PublishedDocPage = z.object({
   pathV1: z.string(),
   pathV2: z.string(),
   storagePath: z.string(),
-  fallbackPublicPath: z.string().optional(),
   locale: z.string().optional(),
 
   isPrivate: z.boolean(),

package/src/dsm/version.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
 import { OmitStrict } from "../utils";
-import { DbCreateInputOmit, DbUpdate } from "../helpers";
+import { DbCreateInputOmit, DbUpdate, nullishToOptional } from "../helpers";
 
 export const DesignSystemVersion = z.object({
   id: z.string(),
@@ -22,3 +22,21 @@ export type UpdateDesignSystemVersion = OmitStrict<
   DbUpdate<DesignSystemVersion>,
   "designSystemId" | "isReadonly" | "version" | "parentId"
 >;
+
+
+// Jobs
+export const VersionCreationJobStatus = z.enum(["Success", "InProgress", "Error"]);
+
+export type VersionCreationJobStatus = z.infer<typeof VersionCreationJobStatus>;
+
+export const VersionCreationJob = z.object({
+    id: z.string(),
+    version: z.string(),
+    designSystemId: z.string(),
+    designSystemVersionId: nullishToOptional(z.string()),
+    status: VersionCreationJobStatus,
+    errorMessage: nullishToOptional(z.string()),
+});
+
+export type VersionCreationJob = z.infer<typeof VersionCreationJob>;
+

package/src/index.ts

@@ -8,6 +8,7 @@ export * from "./dsm";
 export * from "./feature-flags";
 export * from "./helpers";
 export * from "./integrations";
+export * from "./liveblocks";
 export * from "./npm";
 export * from "./tokens";
 export * from "./users";

package/src/integrations/integration.ts

@@ -1,11 +1,22 @@
 import { z } from "zod";
 
+export const IntegrationDesignSystem = z.object({
+  designSystemId: z.string(),
+  brandId: z.string(),
+  title: z.string().optional(),
+  userId: z.string().optional(),
+  date: z.coerce.date().optional(),
+});
+
+export type IntegrationDesignSystem = z.infer<typeof IntegrationDesignSystem>;
+
 export const IntegrationCredentialsType = z.enum(["OAuth2", "PAT", "GithubApp"]);
 export type IntegrationCredentialsType = z.infer<typeof IntegrationCredentialsType>;
 
 export const IntegrationCredentialsProfile = z.object({
   id: z.string(),
-  username: z.string().optional(),
+  email: z.string().optional(),
+  handle: z.string().optional(),
   avatarUrl: z.string().optional(),
 });
 
@@ -19,13 +30,26 @@ export const IntegrationCredentials = z.object({
   userId: z.string(),
   createdAt: z.coerce.date(),
   refreshToken: z.string().optional(),
+  tokenName: z.string().optional(),
+  expiresAt: z.coerce.date().optional(),
   profile: IntegrationCredentialsProfile.optional(),
   customUrl: z.string().optional(),
 });
 
 export type IntegrationCredentials = z.infer<typeof IntegrationCredentials>;
 
-export const IntegrationType = z.enum(["Figma", "Github", "Gitlab", "Bitbucket", "Azure"]);
+export const ExtendedIntegrationType = z.enum([
+  "Figma",
+  "Github",
+  "Gitlab",
+  "Bitbucket",
+  "Azure",
+  "TokenStudio",
+  "FigmaVariablesPlugin",
+]);
+export type ExtendedIntegrationType = z.infer<typeof ExtendedIntegrationType>;
+
+export const IntegrationType = ExtendedIntegrationType.exclude(["TokenStudio", "FigmaVariablesPlugin"]);
 export type IntegrationType = z.infer<typeof IntegrationType>;
 
 export const Integration = z.object({
@@ -36,34 +60,48 @@ export const Integration = z.object({
   integrationCredentials: z.array(IntegrationCredentials).optional(),
 });
 export type Integration = z.infer<typeof Integration>;
+export type ExtendedIntegration = Omit<Integration, "type"> & {
+  type: ExtendedIntegrationType;
+  integrationDesignSystems?: IntegrationDesignSystem[];
+};
 
 // Custom URL validation
 const forbiddenCustomUrldomainList = ["github.com", "gitlab.com", "bitbucket.org", "figma.com", "dev.azure.com"];
-// const azureCustomUrlRegex = /dev\.azure\.com\/.*/;
-// const isAzureCustomUrl = (value: string) => azureCustomUrlRegex.test(value);
 
+// Will be renamed to IntegrationToken in the future as there is already a type named IntegrationToken
 export const IntegrationTokenResponse = z
   .object({
     access_token: z.string(),
     refresh_token: z.string().optional(),
-    expires_in: z.number().optional(),
+    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_bitbucket_username: z.string().optional(), // Bitbucket only
     custom_url: z
       .string()
       .optional()
       .refine(value => {
         if (!value) return true;
         if (forbiddenCustomUrldomainList.some(domain => value.includes(domain))) return false;
-        // if (isAzureCustomUrl(value)) return true;
         return true;
       }, "Custom URL validation failed"),
   })
+  .refine(data => {
+    if (data.custom_url && data.token_azure_organization_name) {
+      return false;
+    }
+    return true;
+  }, "Custom URL and Azure organization name cannot be present at the same time")
   .transform(data => {
     return {
       accessToken: data.access_token,
       refreshToken: data.refresh_token,
-      expiresIn: data.expires_in,
+      expiresIn: typeof data.expires_in === "string" ? Number(data.expires_in) : data.expires_in,
       tokenType: data.token_type,
+      tokenName: data.token_name,
+      tokenBitbucketUsername: data.token_bitbucket_username,
+      tokenAzureOrganizationName: data.token_azure_organization_name,
       customUrl: data.custom_url,
     };
   });

package/src/liveblocks/index.ts

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

package/src/{dsm → liveblocks}/rooms/design-system-version-room.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
-import { DocumentationPageV2, ElementGroup } from "..";
 import { Entity } from "../../common/entity";
+import { DocumentationPageV2, ElementGroup } from "../../dsm";
 import { DbCreateInputOmit, DbUpdate } from "../../helpers";
 
 //

package/src/{dsm → liveblocks}/rooms/documentation-page-room.ts

@@ -1,14 +1,14 @@
 import { z } from "zod";
 import { Entity } from "../../common/entity";
-import { DbCreateInputOmit, DbUpdate } from "../../helpers";
 import {
-  DocumentationItemConfigurationV2,
-  DocumentationPageV2,
-  ElementGroup,
-  PageBlockDefinition,
-  PageBlockEditorModelV2,
-  PageSectionEditorModelV2,
-} from "..";
+    DocumentationItemConfigurationV2,
+    DocumentationPageV2,
+    ElementGroup,
+    PageBlockDefinition,
+    PageBlockEditorModelV2,
+    PageSectionEditorModelV2,
+} from "../../dsm";
+import { DbCreateInputOmit, DbUpdate } from "../../helpers";
 import { OmitStrict } from "../../utils";
 
 export const DocumentationPageRoom = Entity.extend({

package/src/{dsm → liveblocks}/rooms/index.ts

@@ -1,3 +1,4 @@
 export * from "./design-system-version-room";
 export * from "./documentation-page-room";
 export * from "./room-type";
+export * from "./workspace-room";

package/src/{dsm → liveblocks}/rooms/room-type.ts

@@ -3,6 +3,7 @@ import { z } from "zod";
 export enum RoomTypeEnum {
   DocumentationPage = "documentation-page",
   DesignSystemVersion = "design-system-version",
+  Workspace = "workspace",
 }
 
 export const RoomTypeSchema = z.nativeEnum(RoomTypeEnum);

package/src/liveblocks/rooms/workspace-room.ts

@@ -0,0 +1,16 @@
+//
+// Room
+//
+
+import { z } from "zod";
+import { Entity } from "../../common/entity";
+import { DbCreateInputOmit, DbUpdate } from "../../helpers/db";
+
+export const WorkspaceRoom = Entity.extend({
+  workspaceId: z.string(),
+  liveblocksId: z.string(),
+});
+
+export type WorkspaceRoom = z.infer<typeof WorkspaceRoom>;
+export type CreateWorkspaceRoom = DbCreateInputOmit<WorkspaceRoom>;
+export type UpdateWorkspaceRoom = DbUpdate<WorkspaceRoom>;