@supernova-studio/model 0.40.0 → 0.41.0

package/package.json

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

package/src/dsm/brand.ts

@@ -1,4 +1,5 @@
 import { z } from "zod";
+import { DbCreateInputOmit } from "../helpers";
 
 export const Brand = z.object({
   id: z.string(),
@@ -9,3 +10,4 @@ export const Brand = z.object({
 });
 
 export type Brand = z.infer<typeof Brand>;
+export type CreateBrand = DbCreateInputOmit<Brand>;

package/src/dsm/desing-system-create.ts

@@ -2,12 +2,11 @@ import { z } from "zod";
 
 const DS_NAME_MIN_LENGTH: number = 2;
 const DS_NAME_MAX_LENGTH: number = 64;
-const DS_DESC_MIN_LENGTH: number = 2;
 const DS_DESC_MAX_LENGTH: number = 64;
 
 const DesignSystemCreateInputMetadata = z.object({
   name: z.string().min(DS_NAME_MIN_LENGTH).max(DS_NAME_MAX_LENGTH).trim(),
-  description: z.string().min(DS_DESC_MIN_LENGTH).max(DS_DESC_MAX_LENGTH).trim(),
+  description: z.string().max(DS_DESC_MAX_LENGTH).trim(),
 });
 
 export const DesignSystemCreateInput = z.object({

package/src/dsm/desing-system-update.ts

@@ -2,12 +2,11 @@ import { z } from "zod";
 
 const DS_NAME_MIN_LENGTH: number = 2;
 const DS_NAME_MAX_LENGTH: number = 64;
-const DS_DESC_MIN_LENGTH: number = 2;
 const DS_DESC_MAX_LENGTH: number = 64;
 
 const DesignSystemUpdateInputMetadata = z.object({
   name: z.string().min(DS_NAME_MIN_LENGTH).max(DS_NAME_MAX_LENGTH).trim().optional(),
-  description: z.string().min(DS_DESC_MIN_LENGTH).max(DS_DESC_MAX_LENGTH).trim().optional(),
+  description: z.string().max(DS_DESC_MAX_LENGTH).trim().optional(),
 });
 
 export const DesignSystemUpdateInput = z.object({
@@ -18,7 +17,7 @@ export const DesignSystemUpdateInput = z.object({
   docUserSlug: z.string().nullish().optional(),
   source: z.array(z.string()).optional(),
   name: z.string().min(DS_NAME_MIN_LENGTH).max(DS_NAME_MAX_LENGTH).trim().optional(),
-  description: z.string().min(DS_DESC_MIN_LENGTH).max(DS_DESC_MAX_LENGTH).trim().optional(),
+  description: z.string().max(DS_DESC_MAX_LENGTH).trim().optional(),
   docExporterId: z.string().optional(),
 });
 

package/src/dsm/documentation/index.ts

@@ -1,6 +1,7 @@
 export * from "./block-definitions";
 export * from "./group";
 export * from "./link-preview";
+export * from "./page-anchor";
 export * from "./page-content-backup";
 export * from "./page-content";
 export * from "./page";

package/src/dsm/documentation/page-anchor.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+
+export const DocumentationPageAnchor = z.object({
+  blockId: z.string(),
+  level: z.number(),
+  text: z.string(),
+});
+
+export type DocumentationPageAnchor = z.infer<typeof DocumentationPageAnchor>;

package/src/dsm/documentation/page-content.ts

@@ -19,7 +19,6 @@ export const DocumentationPageContent = z.object({
   updatedAt: z.coerce.date(),
   documentationPageId: z.string(),
   data: DocumentationPageContentData,
-  isDirty: z.boolean(),
 });
 
 export type DocumentationPageContentItem = z.infer<typeof DocumentationPageContentItem>;

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

@@ -144,6 +144,7 @@ export const PageBlockShortcut = z.object({
   asset: nullishToOptional(PageBlockAsset),
   documentationItemId: nullishToOptional(z.string()),
   url: nullishToOptional(z.string()),
+  openInNewTab: nullishToOptional(z.boolean()),
   urlPreview: nullishToOptional(PageBlockUrlPreview),
   documentationItemPreview: nullishToOptional(PageBlockLinkPreview),
 });
@@ -212,7 +213,8 @@ export const PageBlockTextSpanAttribute = z.object({
   type: PageBlockTextSpanAttributeType,
   link: nullishToOptional(z.string()),
   documentationItemId: nullishToOptional(z.string()),
-  openInNewWindow: nullishToOptional(z.boolean()),
+  openInNewWindow: nullishToOptional(z.boolean()), // deprecated. use openInNewTab
+  openInNewTab: nullishToOptional(z.boolean()),
 });
 
 export const PageBlockTextSpan = z.object({

package/src/dsm/exporter-property-values-collection.ts

@@ -0,0 +1,31 @@
+import { z } from "zod";
+import { ColorTokenData, PageBlockAsset, TypographyTokenData } from "./elements";
+
+export const ExporterPropertyImageValue = z.object({
+  asset: PageBlockAsset.optional(),
+  assetId: z.string().optional(),
+  assetUrl: z.string().optional(),
+});
+
+export const ExporterPropertyValue = z.object({
+  key: z.string(),
+  value: z.union([
+    z.number(),
+    z.string(),
+    z.boolean(),
+    ExporterPropertyImageValue,
+    ColorTokenData,
+    TypographyTokenData,
+  ]),
+});
+
+export const ExporterPropertyValuesCollection = z.object({
+  id: z.string(),
+  designSystemId: z.string(),
+  exporterId: z.string(),
+  values: z.array(ExporterPropertyValue),
+});
+
+export type ExporterPropertyImageValue = z.infer<typeof ExporterPropertyImageValue>;
+export type ExporterPropertyValue = z.infer<typeof ExporterPropertyValue>;
+export type ExporterPropertyValuesCollection = z.infer<typeof ExporterPropertyValuesCollection>;

package/src/dsm/index.ts

@@ -10,6 +10,7 @@ export * from "./brand";
 export * from "./design-system";
 export * from "./desing-system-create";
 export * from "./desing-system-update";
+export * from "./exporter-property-values-collection";
 export * from "./published-doc-page";
 export * from "./published-doc";
 export * from "./reference";

package/src/dsm/properties/property-definition.ts

@@ -1,10 +1,13 @@
 import { z } from "zod";
 import { DbCreateInputOmit, DbUpdate } from "../../helpers";
+import { OmitStrict } from "../../utils";
 
 export const ElementPropertyTypeSchema = z.enum(["Text", "Number", "Boolean", "Select", "Generic", "Link", "URL"]);
 export const ElementPropertyTargetType = z.enum(["Token", "Component", "DocumentationPage"]);
 export const ElementPropertyLinkType = z.enum(["FigmaComponent", "DocumentationPage"]);
 
+const CODE_NAME_REGEX = /^[a-zA-Z_$][a-zA-Z_$0-9]{1,99}$/;
+
 export const ColorTokenInlineData = z.object({
   value: z.string(),
 });
@@ -20,7 +23,7 @@ export const ElementPropertyDefinition = z.object({
   designSystemVersionId: z.string(),
   persistentId: z.string(),
   name: z.string(),
-  codeName: z.string(),
+  codeName: z.string().regex(CODE_NAME_REGEX),
   description: z.string(),
   type: ElementPropertyTypeSchema,
   targetElementType: ElementPropertyTargetType,
@@ -38,7 +41,10 @@ export type ElementPropertyDefinitionOption = z.infer<typeof ElementPropertyDefi
 export type ElementPropertyDefinition = z.infer<typeof ElementPropertyDefinition>;
 
 export type CreateElementPropertyDefinition = DbCreateInputOmit<ElementPropertyDefinition>;
-export type UpdateElementPropertyDefinition = DbUpdate<ElementPropertyDefinition>;
+export type UpdateElementPropertyDefinition = OmitStrict<
+  DbUpdate<ElementPropertyDefinition>,
+  "designSystemVersionId" | "targetElementType" | "type"
+>;
 
 export type ElementPropertyDefinitionDiff = {
   toCreate: CreateElementPropertyDefinition[];

package/src/dsm/views/view.ts

@@ -1,5 +1,7 @@
-import { ElementPropertyTargetType } from "../properties";
 import { z } from "zod";
+import { DbCreateInputOmit, DbUpdate } from "../../helpers";
+import { OmitStrict } from "../../utils";
+import { ElementPropertyTargetType } from "../properties";
 
 export const ElementView = z.object({
   id: z.string(),
@@ -12,3 +14,6 @@ export const ElementView = z.object({
 });
 
 export type ElementView = z.infer<typeof ElementView>;
+
+export type CreateElementView = DbCreateInputOmit<ElementView>;
+export type UpdateElementView = OmitStrict<DbUpdate<ElementView>, "designSystemVersionId" | "targetElementType">;

package/src/feature-flags/feature-flags.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
 
-export const FlaggedFeature = z.enum(["FigmaImporterV2", "ShadowOpacityOptional"]);
+export const FlaggedFeature = z.enum(["FigmaImporterV2", "ShadowOpacityOptional", "DisableImporter"]);
 export const FeatureFlagMap = z.record(FlaggedFeature, z.boolean());
 export const FeatureFlag = z.object({
   id: z.string(),

package/src/integrations/index.ts

@@ -1,3 +1,5 @@
 export * from "./external-oauth-request";
+export * from "./integration";
 export * from "./oauth-providers";
 export * from "./oauth-token";
+export * from "./workspace-oauth-requests";

package/src/integrations/integration.ts

@@ -0,0 +1,36 @@
+import { z } from "zod";
+
+export const IntegrationType = z.enum(["Figma", "Github", "Gitlab", "Bitbucket", "Azure"]);
+export type IntegrationType = z.infer<typeof IntegrationType>;
+
+export const Integration = z.object({
+  id: z.string(),
+  workspaceId: z.string(),
+  type: IntegrationType,
+  createdAt: z.coerce.date(),
+});
+export type Integration = z.infer<typeof Integration>;
+
+export const IntegrationCredentialsType = z.enum(["OAuth2", "PAT"]);
+export type IntegrationCredentialsType = z.infer<typeof IntegrationCredentialsType>;
+
+export const IntegrationCredentialsProfile = z.object({
+  id: z.string(),
+  username: z.string().optional(),
+  avatarUrl: z.string().optional(),
+});
+
+export type IntegrationCredentialsProfile = z.infer<typeof IntegrationCredentialsProfile>;
+
+export const IntegrationCredentialsSchema = z.object({
+  id: z.string(),
+  type: IntegrationCredentialsType,
+  integrationId: z.string(),
+  accessToken: z.string(),
+  userId: z.string(),
+  createdAt: z.coerce.date(),
+  refreshToken: z.string().optional(),
+  profile: IntegrationCredentialsProfile.optional(),
+});
+
+export type IntegrationCredentials = z.infer<typeof IntegrationCredentialsSchema>;

package/src/integrations/workspace-oauth-requests.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+import { OAuthProviderSchema } from "./oauth-providers";
+
+export const WorkspaceOAuthRequestSchema = z.object({
+  id: z.string(),
+  workspaceId: z.string(),
+  provider: OAuthProviderSchema,
+  userId: z.string(),
+  createdAt: z.coerce.date(),
+});
+
+export type WorkspaceOAuthRequest = z.infer<typeof WorkspaceOAuthRequestSchema>;

package/src/tokens/personal-access-token.ts

@@ -1,17 +1,25 @@
 import { z } from "zod";
+import { DbCreateInputOmit } from "../helpers";
+import { OmitStrict } from "../utils";
 import { WorkspaceRoleSchema } from "../workspace";
 
 export const PersonalAccessToken = z.object({
   id: z.string(),
   userId: z.string(),
+
+  workspaceId: z.string().optional(),
+  workspaceRole: WorkspaceRoleSchema.optional(),
+
   name: z.string(),
+  hidden: z.boolean(),
+
   token: z.string(),
+  scope: z.string().optional(),
+
   createdAt: z.coerce.date(),
-  hidden: z.boolean(),
-  workspaceId: z.string().optional(),
-  workspaceRole: WorkspaceRoleSchema.optional(),
   expireAt: z.coerce.date().optional(),
-  scope: z.string().optional(),
 });
 
 export type PersonalAccessToken = z.infer<typeof PersonalAccessToken>;
+
+export type CreatePersonalAccessToken = DbCreateInputOmit<PersonalAccessToken>;

package/src/utils/errors.ts

@@ -14,7 +14,8 @@ export type SupernovaExceptionType =
   | "PlanRestricted"
   | "MissingWorkspacePermission"
   | "MissingExporterPermission"
-  | "NoAccess";
+  | "NoAccess"
+  | "MissingCredentials";
 
 export class SupernovaException extends Error {
   static wrongFormat(message?: string): SupernovaException {
@@ -81,6 +82,10 @@ export class SupernovaException extends Error {
     return new SupernovaException("NoAccess", message);
   }
 
+  static missingCredentials(message?: string): SupernovaException {
+    return new SupernovaException("MissingCredentials", message);
+  }
+
   //
   // To refactor
   //