@supernova-studio/model 1.0.0 → 1.0.1

package/src/dsm/assets/index.ts

@@ -1,4 +0,0 @@
-export * from "./asset-dynamo-record";
-export * from "./asset-reference";
-export * from "./asset-value";
-export * from "./asset";

package/src/dsm/brand.ts

@@ -1,13 +0,0 @@
-import { z } from "zod";
-import { DbCreateInputOmit } from "../helpers";
-
-export const Brand = z.object({
-  id: z.string(),
-  designSystemVersionId: z.string(),
-  persistentId: z.string(),
-  name: z.string(),
-  description: z.string(),
-});
-
-export type Brand = z.infer<typeof Brand>;
-export type CreateBrand = DbCreateInputOmit<Brand>;

package/src/dsm/collection.ts

@@ -1,51 +0,0 @@
-import { z } from "zod";
-import { DbCreateInputOmit, DbUpdate } from "../helpers";
-import { OmitStrict } from "../utils";
-import { ColorTokenInlineData } from "./properties";
-
-export const CollectionOrigin = z.object({
-  id: z.string(),
-  sourceId: z.string(),
-});
-
-export const Collection = z.object({
-  id: z.string(),
-  persistentId: z.string(),
-
-  designSystemVersionId: z.string(),
-
-  name: z.string(),
-  description: z.string(),
-  backgroundColor: ColorTokenInlineData.optional(),
-
-  /**
-   * ID of Select element property definition's option that corresponds to this collection.
-   *
-   * Each collection is represented by an option in a special kind of element property that
-   * is present in each design system where a collections are present. The property is maintained
-   * automatically and is not available to the user (see immutable element properties).
-   *
-   * Collections have an immutable element property that allows bridging places where element properites
-   * can be selected (e.g. documentation blocks) with the concept of collection without having to add
-   * specific logic for collection selection.
-   */
-  elementPropertyOptionId: z.string(),
-
-  createdAt: z.coerce.date(),
-  updatedAt: z.coerce.date(),
-
-  sortOrder: z.string(),
-
-  origin: CollectionOrigin.optional(),
-});
-
-export type CollectionOrigin = z.infer<typeof CollectionOrigin>;
-export type Collection = z.infer<typeof Collection>;
-
-export type CreateCollection = OmitStrict<DbCreateInputOmit<Collection>, "elementPropertyOptionId">;
-export type UpdateCollection = OmitStrict<
-  DbUpdate<Collection>,
-  "designSystemVersionId" | "origin" | "elementPropertyOptionId"
-> & {
-  origin?: Partial<CollectionOrigin>;
-};

package/src/dsm/components/asset-rendering.ts

@@ -1,22 +0,0 @@
-import { z } from "zod";
-import { FigmaRenderFormat } from "../import";
-
-export const AssetRenderConfiguration = z.object({
-  prefix: z.string().optional(),
-  suffix: z.string().optional(),
-  scale: z.number(),
-  format: FigmaRenderFormat,
-});
-
-export const RenderedAssetFile = z.object({
-  assetPersistentId: z.string(),
-  assetName: z.string(),
-
-  renderedImageFileName: z.string(),
-  renderedImageUrl: z.string(),
-
-  settings: AssetRenderConfiguration,
-});
-
-export type AssetRenderConfiguration = z.infer<typeof AssetRenderConfiguration>;
-export type RenderedAssetFile = z.infer<typeof RenderedAssetFile>;

package/src/dsm/components/index.ts

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

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

@@ -1,167 +0,0 @@
-import { z } from "zod";
-import { DbCreateInputOmit, DbUpdate, nullishToOptional } from "../../helpers";
-import { OmitStrict } from "../../utils";
-import { ImportWarning } from "../import/warning";
-import { SourceImportSummary } from "./import-summary";
-
-//
-// Enums
-//
-
-export const DataSourceRemoteType = z.enum(["Figma", "TokenStudio", "FigmaVariablesPlugin"]);
-export const DataSourceUploadRemoteSource = z.enum(["TokenStudio", "FigmaVariablesPlugin", "Custom"]);
-export const DataSourceFigmaState = z.enum(["Active", "MissingIntegration", "MissingFileAccess", "MissingFileOwner"]);
-export const DataSourceAutoImportMode = z.enum(["Never", "Hourly"]);
-
-export type DataSourceRemoteType = z.infer<typeof DataSourceRemoteType>;
-export type DataSourceUploadRemoteSource = z.infer<typeof DataSourceUploadRemoteSource>;
-export type DataSourceFigmaState = z.infer<typeof DataSourceFigmaState>;
-export type DataSourceAutoImportMode = z.infer<typeof DataSourceAutoImportMode>;
-
-//
-// Aux
-//
-
-export const DataSourceStats = z.object({
-  tokens: zeroNumberByDefault(),
-  components: zeroNumberByDefault(),
-  assets: zeroNumberByDefault(),
-  frames: zeroNumberByDefault(),
-});
-
-export type DataSourceStats = z.infer<typeof DataSourceStats>;
-
-//
-// Figma
-//
-
-export const DataSourceFigmaFileData = z.object({
-  lastUpdatedAt: z.coerce.date(),
-});
-
-export const DataSourceFigmaFileVersionData = z.object({
-  id: z.string(),
-  label: z.string().optional(),
-  description: z.string().optional(),
-  createdAt: z.coerce.date(),
-});
-
-export const DataSourceFigmaScope = z.object({
-  assets: z.boolean(),
-  components: z.boolean(),
-  documentationFrames: z.boolean(),
-  tokens: z.boolean(),
-  themePersistentId: z.string().optional(),
-  isUnpublishedContentFallbackEnabled: z.boolean(),
-});
-
-export const DataSourceFigmaImportMetadata = z.object({
-  fileData: DataSourceFigmaFileData.optional(),
-  importedPublishedVersion: DataSourceFigmaFileVersionData.optional(),
-});
-
-export const DataSourceFigmaRemote = z.object({
-  type: z.literal(DataSourceRemoteType.Enum.Figma),
-  fileId: z.string(),
-  preferredCredentialId: z.string().optional(),
-  ownerId: z.string(), // todo remove or keep to reference who created data source
-  ownerName: z.string(), // todo probably remove
-  scope: DataSourceFigmaScope,
-  state: DataSourceFigmaState,
-  requiresSync: z
-    .boolean()
-    .optional()
-    .transform(v => v ?? false),
-  lastImportMetadata: DataSourceFigmaImportMetadata.optional(),
-  downloadChunkSize: z.number().optional(),
-  figmaRenderChunkSize: z.number().optional(),
-  maxFileDepth: z.number().optional(),
-});
-
-export type DataSourceFigmaFileData = z.infer<typeof DataSourceFigmaFileData>;
-export type DataSourceFigmaFileVersionData = z.infer<typeof DataSourceFigmaFileVersionData>;
-export type DataSourceFigmaScope = z.infer<typeof DataSourceFigmaScope>;
-export type DataSourceFigmaImportMetadata = z.infer<typeof DataSourceFigmaImportMetadata>;
-export type DataSourceFigmaRemote = z.infer<typeof DataSourceFigmaRemote>;
-
-//
-// Token Studio
-//
-
-export const DataSourceTokenStudioRemote = z.object({
-  type: z.literal(DataSourceRemoteType.Enum.TokenStudio),
-});
-
-export type DataSourceTokenStudioRemote = z.infer<typeof DataSourceTokenStudioRemote>;
-
-//
-// Figma Variables Plugin
-//
-
-export const DataSourceUploadImportMetadata = z.record(z.any());
-
-export const DataSourceUploadRemote = z.object({
-  type: z.literal(DataSourceRemoteType.Enum.FigmaVariablesPlugin),
-  remoteId: z.string(),
-  remoteSourceType: DataSourceUploadRemoteSource,
-  lastImportMetadata: DataSourceUploadImportMetadata.optional(),
-  warnings: nullishToOptional(ImportWarning.array()),
-  isTokenTypeSplitEnabled: z.boolean(),
-  isCollectionsMigrationCompleted: z.boolean(),
-});
-
-export type DataSourceUploadImportMetadata = z.infer<typeof DataSourceUploadImportMetadata>;
-export type DataSourceUploadRemote = z.infer<typeof DataSourceUploadRemote>;
-
-//
-// Base
-//
-
-export const DataSourceRemote = z.discriminatedUnion("type", [
-  DataSourceFigmaRemote,
-  DataSourceUploadRemote,
-  DataSourceTokenStudioRemote,
-]);
-
-export const DataSource = z.object({
-  id: z.string(),
-
-  name: z.string(),
-  thumbnailUrl: z.string().optional(),
-
-  createdAt: z.coerce.date().optional(),
-
-  lastImportedAt: z.coerce.date().optional(),
-  lastImportSummary: SourceImportSummary.optional(),
-
-  designSystemId: z.string(),
-  brandPersistentId: z.string(),
-  autoImportMode: DataSourceAutoImportMode,
-  stats: DataSourceStats,
-
-  remote: DataSourceRemote,
-
-  sortOrder: z.number(),
-});
-
-export const DataSourceVersion = z.object({
-  id: z.string(),
-  createdAt: z.coerce.date(),
-  label: z.string().nullish(),
-  description: z.string().nullish(),
-});
-
-export type DataSourceVersion = z.infer<typeof DataSourceVersion>;
-
-export type DataSourceRemote = z.infer<typeof DataSourceRemote>;
-export type DataSource = z.infer<typeof DataSource>;
-
-export type CreateDataSource = OmitStrict<DbCreateInputOmit<DataSource>, "sortOrder">;
-export type UpdateDataSource = OmitStrict<DbUpdate<DataSource>, "brandPersistentId" | "designSystemId">;
-
-function zeroNumberByDefault() {
-  return z
-    .number()
-    .nullish()
-    .transform(v => v ?? 0);
-}

package/src/dsm/data-sources/import-job.ts

@@ -1,30 +0,0 @@
-import { z } from "zod";
-import { DbCreateInputOmit, DbUpdate } from "../../helpers";
-import { OmitStrict } from "../../utils";
-import { DataSourceRemoteType } from "./data-source";
-import { Entity } from "../../common";
-
-export const ImportJobState = z.enum(["PendingInput", "Queued", "InProgress", "Failed", "Success"]);
-export const ImportJobOperation = z.enum(["Check", "Import"]);
-
-export const ImportJob = Entity.extend({
-  designSystemId: z.string(),
-  designSystemVersionId: z.string(),
-  sourceIds: z.array(z.string()),
-  state: ImportJobState,
-  createdByUserId: z.string().optional(),
-  importContextId: z.string(),
-  error: z.string().optional(),
-  sourceType: DataSourceRemoteType,
-  importContextCleanedUp: z.boolean(),
-});
-
-export type ImportJobState = z.infer<typeof ImportJobState>;
-export type ImportJobOperation = z.infer<typeof ImportJobOperation>;
-export type ImportJob = z.infer<typeof ImportJob>;
-
-export type CreateImportJob = DbCreateInputOmit<ImportJob>;
-export type UpdateImportJob = OmitStrict<
-  DbUpdate<ImportJob>,
-  "designSystemId" | "createdByUserId" | "sourceIds" | "importContextId"
->;

package/src/dsm/data-sources/import-summary.ts

@@ -1,70 +0,0 @@
-import { z } from "zod";
-import { nullishToOptional } from "../../helpers";
-import { DesignTokenType } from "../elements";
-import { ImportWarning } from "../import/warning";
-
-export const FileStructureStats = z.object({
-  frames: zeroNumberByDefault(),
-  components: zeroNumberByDefault(),
-  componentSets: zeroNumberByDefault(),
-});
-
-const SourceImportSummaryByTokenTypeKey = DesignTokenType.or(
-  // Backward compatibility
-  z.enum(["Measure", "Radius", "GenericToken", "Font", "Text"])
-);
-
-export const SourceImportSummaryByTokenType = z.record(SourceImportSummaryByTokenTypeKey, z.number());
-
-export const SourceImportTokenSummary = z.object({
-  tokensCreated: zeroNumberByDefault(),
-  tokensUpdated: zeroNumberByDefault(),
-  tokensDeleted: zeroNumberByDefault(),
-  tokensCreatedPerType: SourceImportSummaryByTokenType.nullish().transform(v => v ?? {}),
-  tokensUpdatedPerType: SourceImportSummaryByTokenType.nullish().transform(v => v ?? {}),
-  tokensDeletedPerType: SourceImportSummaryByTokenType.nullish().transform(v => v ?? {}),
-});
-
-export const SourceImportComponentSummary = z.object({
-  componentsCreated: zeroNumberByDefault(),
-  componentsUpdated: zeroNumberByDefault(),
-  componentsDeleted: zeroNumberByDefault(),
-  componentAssetsCreated: zeroNumberByDefault(),
-  componentAssetsUpdated: zeroNumberByDefault(),
-  componentAssetsDeleted: zeroNumberByDefault(),
-});
-
-export const SourceImportFrameSummary = z.object({
-  assetsInFile: nullishToOptional(FileStructureStats.optional()),
-  invalidReferencesCount: nullishToOptional(z.number().optional()),
-});
-
-export const SourceImportSummary = z.object({
-  sourceId: nullishToOptional(z.string()),
-  brandId: nullishToOptional(z.string()),
-  versionId: nullishToOptional(z.string()),
-  error: nullishToOptional(z.any()),
-  isFailed: z.boolean(),
-  warnings: z
-    .array(ImportWarning)
-    .nullish()
-    .transform(v => v ?? []),
-
-  ...SourceImportTokenSummary.shape,
-  ...SourceImportComponentSummary.shape,
-  ...FileStructureStats.shape,
-});
-
-export type FileStructureStats = z.infer<typeof FileStructureStats>;
-export type SourceImportSummaryByTokenType = z.infer<typeof SourceImportSummaryByTokenType>;
-export type SourceImportTokenSummary = z.infer<typeof SourceImportTokenSummary>;
-export type SourceImportComponentSummary = z.infer<typeof SourceImportComponentSummary>;
-export type SourceImportFrameSummary = z.infer<typeof SourceImportFrameSummary>;
-export type SourceImportSummary = z.infer<typeof SourceImportSummary>;
-
-function zeroNumberByDefault() {
-  return z
-    .number()
-    .nullish()
-    .transform(v => v ?? 0);
-}

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

@@ -1,3 +0,0 @@
-export * from "./data-source";
-export * from "./import-job";
-export * from "./import-summary";

package/src/dsm/design-system.ts

@@ -1,47 +0,0 @@
-import { z } from "zod";
-import { DbCreateInputOmit, DbUpdate, nullishToOptional } from "../helpers";
-import { OmitStrict } from "../utils";
-
-//
-// Enums
-//
-
-export const DesignSystemAccessMode = z.enum(["Open", "InviteOnly"]);
-export type DesignSystemAccessMode = z.infer<typeof DesignSystemAccessMode>;
-
-//
-// Model
-//
-
-export const DesignSystemSwitcher = z.object({
-  isEnabled: z.boolean(),
-  designSystemIds: z.array(z.string()),
-});
-
-export const DesignSystem = z.object({
-  id: z.string(),
-  workspaceId: z.string(),
-  name: z.string(),
-  description: z.string(),
-  docExporterId: nullishToOptional(z.string()),
-  docSlug: z.string(),
-  docUserSlug: nullishToOptional(z.string()),
-  docSlugDeprecated: z.string(),
-  isMultibrand: z.boolean(),
-  docViewUrl: nullishToOptional(z.string()),
-  basePrefixes: z.array(z.string()),
-  designSystemSwitcher: nullishToOptional(DesignSystemSwitcher),
-  isApprovalFeatureEnabled: z.boolean(),
-  approvalRequiredForPublishing: z.boolean(),
-  accessMode: DesignSystemAccessMode,
-  membersGenerated: z.boolean(),
-
-  createdAt: z.coerce.date(),
-  updatedAt: z.coerce.date(),
-});
-
-export type DesignSystemSwitcher = z.infer<typeof DesignSystemSwitcher>;
-export type DesignSystem = z.infer<typeof DesignSystem>;
-
-export type CreateDesignSystem = DbCreateInputOmit<DesignSystem>;
-export type UpdateDesignSystem = OmitStrict<DbUpdate<DesignSystem>, "workspaceId" | "docSlug" | "docSlugDeprecated">;

package/src/dsm/documentation/approvals/approval-state.ts

@@ -1,4 +0,0 @@
-import { z } from "zod";
-
-export const DocumentationPageApprovalState = z.enum(["ReadyForReview", "ChangesRequested", "Approved"]);
-export type DocumentationPageApprovalState = z.infer<typeof DocumentationPageApprovalState>;

package/src/dsm/documentation/approvals/approval.ts

@@ -1,18 +0,0 @@
-import { z } from "zod";
-import { DbCreateInputOmit } from "../../../helpers/db";
-import { DocumentationPageApprovalState } from "../approvals/approval-state";
-
-export const DocumentationPageApproval = z.object({
-  id: z.string(),
-  approvalState: DocumentationPageApprovalState,
-  persistentId: z.string(),
-  pageId: z.string(),
-  pagePersistentId: z.string(),
-  updatedByUserId: z.string(),
-  designSystemVersionId: z.string(),
-  updatedAt: z.coerce.date(),
-  createdAt: z.coerce.date(),
-});
-
-export type CreateDocumentationPageApproval = DbCreateInputOmit<DocumentationPageApproval>;
-export type DocumentationPageApproval = z.infer<typeof DocumentationPageApproval>;

package/src/dsm/documentation/approvals/index.ts

@@ -1,2 +0,0 @@
-export * from "./approval-state";
-export * from "./approval";

package/src/dsm/documentation/block-definitions/aux.ts

@@ -1,10 +0,0 @@
-import { z } from "zod";
-
-export const PageBlockDefinitionAppearance = z.object({
-  isBordered: z.boolean().optional(),
-  hasBackground: z.boolean().optional(),
-  isEditorPresentationDifferent: z.boolean().optional(),
-  showBlockHeaderInEditor: z.boolean().optional(),
-});
-
-export type PageBlockDefinitionAppearance = z.infer<typeof PageBlockDefinitionAppearance>;

package/src/dsm/documentation/block-definitions/definition.ts

@@ -1,76 +0,0 @@
-import { z } from "zod";
-import { PageBlockDefinitionAppearance } from "./aux";
-import { PageBlockDefinitionItem } from "./item";
-
-//
-// Enums
-//
-
-export const PageBlockCategory = z.enum([
-  "Text",
-  "Layout",
-  "Media",
-  "Embed",
-  "Figma",
-  "Code",
-  "Guidelines",
-  "Tokens",
-  "Components",
-  "Assets",
-  "Data",
-  "Other",
-]);
-
-export const PageBlockBehaviorDataType = z.enum(["Item", "Token", "Asset", "Component", "FigmaNode", "FigmaComponent"]);
-export const PageBlockBehaviorSelectionType = z.enum(["Entity", "Group", "EntityAndGroup"]);
-
-export type PageBlockCategory = z.infer<typeof PageBlockCategory>;
-export type PageBlockBehaviorDataType = z.infer<typeof PageBlockBehaviorDataType>;
-export type PageBlockBehaviorSelectionType = z.infer<typeof PageBlockBehaviorSelectionType>;
-
-//
-// Definitions
-//
-
-export const PageBlockDefinitionBehavior = z.object({
-  dataType: PageBlockBehaviorDataType,
-  items: z
-    .object({
-      numberOfItems: z.number(),
-      allowLinks: z.boolean(),
-      newItemLabel: z.string().optional(),
-    })
-    .optional(),
-  entities: z
-    .object({
-      selectionType: PageBlockBehaviorSelectionType,
-      maxSelected: z.number(),
-    })
-    .optional(),
-});
-
-export const PageBlockDefinitionOnboarding = z.object({
-  helpText: z.string(),
-  documentationLink: z.string().optional(),
-});
-
-export const PageBlockDefinition = z.object({
-  id: z.string(),
-  name: z.string(),
-  description: z.string(),
-  category: PageBlockCategory,
-  icon: z.string().optional(),
-  documentationLink: z.string().optional(),
-  searchKeywords: z.array(z.string()).optional(),
-  item: PageBlockDefinitionItem,
-  behavior: PageBlockDefinitionBehavior,
-  editorOptions: z.object({
-    onboarding: PageBlockDefinitionOnboarding.optional(),
-    newItemLabel: z.string().optional(),
-  }),
-  appearance: PageBlockDefinitionAppearance.optional(),
-});
-
-export type PageBlockDefinitionBehavior = z.infer<typeof PageBlockDefinitionBehavior>;
-export type PageBlockDefinitionOnboarding = z.infer<typeof PageBlockDefinitionOnboarding>;
-export type PageBlockDefinition = z.infer<typeof PageBlockDefinition>;

package/src/dsm/documentation/block-definitions/index.ts

@@ -1,4 +0,0 @@
-export * from "./aux";
-export * from "./definition";
-export * from "./item";
-export * from "./variant";