@supernova-studio/client 0.58.19 → 1.0.0-alpha.3

package/src/api/conversion/integrations/git.ts

@@ -1,37 +0,0 @@
-import { GitBranch, GitOrganization, GitProject, GitRepository } from "@supernova-studio/model";
-import { DTOGitBranch, DTOGitOrganization, DTOGitProject, DTOGitRepository } from "../../dto";
-
-export function gitOrganizationToDto(org: GitOrganization): DTOGitOrganization {
-  return {
-    id: org.id,
-    name: org.name,
-    url: org.url,
-    slug: org.slug,
-  };
-}
-
-export function gitProjectToDto(project: GitProject): DTOGitProject {
-  return {
-    id: project.id,
-    name: project.name,
-    url: project.url,
-    slug: project.slug,
-  };
-}
-
-export function gitRepositoryToDto(repo: GitRepository): DTOGitRepository {
-  return {
-    id: repo.id,
-    name: repo.name,
-    url: repo.url,
-    slug: repo.slug,
-    defaultBranch: repo.defaultBranch,
-  };
-}
-
-export function gitBranchToDto(branch: GitBranch): DTOGitBranch {
-  return {
-    name: branch.name,
-    lastCommitId: branch.lastCommitId,
-  };
-}

package/src/api/conversion/integrations/index.ts

@@ -1,2 +0,0 @@
-export * from "./git";
-export * from "./integration";

package/src/api/conversion/integrations/integration.ts

@@ -1,37 +0,0 @@
-import { ExtendedIntegration, IntegrationCredentials } from "@supernova-studio/model";
-import { DTOIntegration, DTOIntegrationCredentials } from "../../dto";
-
-export function integrationToDto(integration: ExtendedIntegration): DTOIntegration {
-  return {
-    id: integration.id,
-    workspaceId: integration.workspaceId,
-    type: integration.type,
-    createdAt: integration.createdAt,
-    integrationCredentials: integration.integrationCredentials?.map(integrationCredentialToDto),
-    integrationDesignSystems: integration.integrationDesignSystems ?? undefined,
-  };
-}
-
-export function integrationCredentialToDto(credential: IntegrationCredentials): DTOIntegrationCredentials {
-  return {
-    id: credential.id,
-
-    createdAt: credential.createdAt,
-    refreshedAt: credential.refreshedAt,
-    expiresAt: credential.expiresAt,
-
-    integrationId: credential.integrationId,
-    type: credential.type,
-
-    userId: credential.userId,
-    user: credential.user,
-
-    customUrl: credential.customUrl,
-
-    profile: credential.profile,
-    tokenName: credential.tokenName,
-    username: credential.username,
-    appInstallationId: credential.appInstallationId,
-    state: credential.state,
-  };
-}

package/src/api/dto/aux/color.ts

@@ -1,7 +0,0 @@
-import { z } from "zod";
-
-export const DTOColorTokenInlineData = z.object({
-  value: z.string().regex(/^#[a-f0-9]{6,8}$/),
-});
-
-export type DTOColorTokenInlineData = z.infer<typeof DTOColorTokenInlineData>;

package/src/api/dto/aux/index.ts

@@ -1,3 +0,0 @@
-export * from "./color";
-export * from "./meta";
-export * from "./pagination";

package/src/api/dto/aux/meta.ts

@@ -1,8 +0,0 @@
-import { z } from "zod";
-
-export const DTOObjectMeta = z.object({
-  name: z.string().max(512),
-  description: z.string().max(2048).optional(),
-});
-
-export type DTOObjectMeta = z.infer<typeof DTOObjectMeta>;

package/src/api/dto/aux/pagination.ts

@@ -1,8 +0,0 @@
-import { z } from "zod";
-
-export const DTOPagination = z.object({
-  limit: z.string().optional(),
-  offset: z.string().optional(),
-});
-
-export type DTOPagination = z.infer<typeof DTOPagination>;

package/src/api/dto/bff/app-bootstrap-data.ts

@@ -1,20 +0,0 @@
-import { z } from "zod";
-import { DTOBrand, DTODesignSystem, DTODesignSystemVersion } from "../design-systems";
-import { DTOUserWorkspaceMembership } from "../workspaces";
-
-export const DTOAppBootstrapDataQuery = z.object({
-  preferredWorkspaceId: z.string().optional(),
-  preferredDesignSystemId: z.string().optional(),
-  preferredVersionId: z.string().optional(),
-  preferredBrandId: z.string().optional(),
-});
-
-export const DTOAppBootstrapDataResponse = z.object({
-  workspaceMembership: DTOUserWorkspaceMembership.optional(),
-  designSystem: DTODesignSystem.optional(),
-  version: DTODesignSystemVersion.optional(),
-  brand: DTOBrand.optional(),
-});
-
-export type DTOAppBootstrapDataQuery = z.infer<typeof DTOAppBootstrapDataQuery>;
-export type DTOAppBootstrapDataResponse = z.infer<typeof DTOAppBootstrapDataResponse>;

package/src/api/dto/bff/index.ts

@@ -1 +0,0 @@
-export * from "./app-bootstrap-data";

package/src/api/dto/collections/index.ts

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

package/src/api/dto/collections/token-collection.ts

@@ -1,24 +0,0 @@
-import { CollectionOrigin, ColorTokenInlineData, ObjectMeta } from "@supernova-studio/model";
-import { z } from "zod";
-
-export const DTOTokenCollection = z.object({
-  id: z.string(),
-  persistentId: z.string(),
-  designSystemVersionId: z.string(),
-
-  meta: ObjectMeta,
-  backgroundColor: ColorTokenInlineData.optional(),
-  elementPropertyOptionId: z.string(),
-
-  createdAt: z.coerce.date(),
-  updatedAt: z.coerce.date(),
-
-  origin: CollectionOrigin.optional(),
-});
-
-export const DTOTokenCollectionsListReponse = z.object({
-  collections: DTOTokenCollection.array(),
-});
-
-export type DTOTokenCollection = z.infer<typeof DTOTokenCollection>;
-export type DTOTokenCollectionsListReponse = z.infer<typeof DTOTokenCollectionsListReponse>;

package/src/api/dto/design-systems/brand.ts

@@ -1,44 +0,0 @@
-import { ObjectMeta } from "@supernova-studio/model";
-import { z } from "zod";
-import { DTOObjectMeta } from "../aux";
-
-//
-// Read
-//
-
-export const DTOBrand = z.object({
-  id: z.string(),
-  designSystemVersionId: z.string(),
-  persistentId: z.string(),
-  meta: ObjectMeta,
-});
-
-export const DTOBrandGetResponse = z.object({ brand: DTOBrand });
-
-export const DTOBrandCreateResponse = z.object({
-  brand: DTOBrand,
-});
-
-export const DTOBrandsListResponse = z.object({ brands: z.array(DTOBrand) });
-
-export type DTOBrand = z.infer<typeof DTOBrand>;
-export type DTOBrandGetResponse = z.infer<typeof DTOBrandGetResponse>;
-export type DTOBrandCreateResponse = z.infer<typeof DTOBrandCreateResponse>;
-export type DTOBrandsListResponse = z.infer<typeof DTOBrandsListResponse>;
-
-//
-// Write
-//
-
-export const DTOBrandCreatePayload = z.object({
-  persistentId: z.string().uuid(),
-  meta: DTOObjectMeta,
-});
-
-export const DTOBrandUpdatePayload = z.object({
-  meta: DTOObjectMeta.optional(),
-  persistentId: z.string(),
-});
-
-export type DTOBrandCreatePayload = z.infer<typeof DTOBrandCreatePayload>;
-export type DTOBrandUpdatePayload = z.infer<typeof DTOBrandUpdatePayload>;

package/src/api/dto/design-systems/component.ts

@@ -1,40 +0,0 @@
-import { z } from "zod";
-import { DTOObjectMeta } from "../aux";
-
-//
-// Read
-//
-
-export const DTODesignSystemComponent = z.object({
-  id: z.string(),
-  persistentId: z.string(),
-  designSystemVersionId: z.string(),
-  brandId: z.string(),
-  meta: DTOObjectMeta,
-  createdAt: z.coerce.date(),
-  updatedAt: z.coerce.date(),
-});
-
-export const DTODesignSystemComponentResponse = z.object({
-  designSystemComponent: DTODesignSystemComponent,
-});
-
-export const DTODesignSystemComponentListResponse = z.object({
-  designSystemComponents: DTODesignSystemComponent.array(),
-});
-
-export type DTODesignSystemComponent = z.infer<typeof DTODesignSystemComponent>;
-export type DTODesignSystemComponentResponse = z.infer<typeof DTODesignSystemComponentResponse>;
-export type DTODesignSystemComponentListResponse = z.infer<typeof DTODesignSystemComponentListResponse>;
-
-//
-// Write
-//
-
-export const DTODesignSystemComponentCreateInput = z.object({
-  brandId: z.string(), // Persistent ID,
-  persistentId: z.string(),
-  meta: DTOObjectMeta,
-});
-
-export type DTODesignSystemComponentCreateInput = z.infer<typeof DTODesignSystemComponentCreateInput>;

package/src/api/dto/design-systems/contact.ts

@@ -1,11 +0,0 @@
-import { z } from "zod";
-import { DTOUser } from "../users";
-
-export const DTODesignSystemContactsResponse = z.object({
-  contacts: z.object({
-    workspace: z.array(DTOUser),
-    designSystem: z.array(DTOUser),
-  }),
-});
-
-export type DTODesignSystemContactsResponse = z.infer<typeof DTODesignSystemContactsResponse>;

package/src/api/dto/design-systems/data-source.ts

@@ -1,141 +0,0 @@
-import {
-  DataSourceAutoImportMode,
-  DataSourceFigmaScope,
-  DataSourceFigmaState,
-  DataSourceRemoteType,
-  DataSourceStats,
-  DataSourceUploadImportMetadata,
-  DataSourceUploadRemoteSource,
-  SourceImportSummary,
-} from "@supernova-studio/model";
-import { z } from "zod";
-
-//
-// Read
-//
-
-export const DTODataSourceFigmaScope = DataSourceFigmaScope;
-
-const DTODataSourceFigmaFileVersion = z.object({
-  id: z.string(),
-  created_at: z.coerce.date(),
-  label: z.string(),
-  description: z.string(),
-});
-
-export const DTODataSourceFigmaCloud = z.object({
-  fileId: z.string(),
-  state: DataSourceFigmaState,
-  autoImportMode: DataSourceAutoImportMode,
-  fileThumbnailUrl: z.string().optional(),
-  lastImportResult: SourceImportSummary.nullish(),
-  lastImportedAt: z.coerce.date().nullish(),
-  lastImportedVersion: DTODataSourceFigmaFileVersion.nullish(),
-  lastUpdatesCheckedAt: z.date().nullish(),
-  ownerId: z.string(),
-  ownerUserName: z.string().optional(),
-  preferredCredentialId: z.string().optional(),
-  stats: DataSourceStats,
-});
-
-export const DTODataSourceFigma = z.object({
-  id: z.string(),
-  type: z.literal(DataSourceRemoteType.Enum.Figma),
-  fileName: z.string(),
-  scope: DTODataSourceFigmaScope,
-  brandId: z.string(),
-  themeId: z.string().nullish(),
-  cloud: DTODataSourceFigmaCloud.nullish(),
-});
-
-// TS is not yet implemented in new BE
-export const DTODataSourceTokenStudio = z.object({
-  id: z.string(),
-  type: z.literal(DataSourceRemoteType.Enum.TokenStudio),
-  fileName: z.string(),
-  brandId: z.string(),
-  themeId: z.string().nullish(),
-  tokenStudio: z.object({
-    settings: z.object({
-      dryRun: z.boolean(),
-      verbose: z.boolean(),
-      preciseCopy: z.boolean(),
-    }),
-    connectionName: z.string(),
-    lastImportedAt: z.coerce.date(),
-    lastImportedResults: z.array(
-      z.object({
-        mapping: z.object({
-          tokenSets: z.array(z.string()),
-          supernovaBrand: z.string(),
-          supernovaTheme: z.string().optional(),
-        }),
-        isFailed: z.boolean(),
-        tokensCreated: z.number(),
-        tokensDeleted: z.number(),
-        tokensUpdated: z.number(),
-      })
-    ),
-  }),
-});
-
-export const DTODataSourceFigmaVariablesPlugin = z.object({
-  id: z.string(),
-  type: z.literal(DataSourceRemoteType.Enum.FigmaVariablesPlugin),
-  fileName: z.string(),
-  brandId: z.string(),
-  upload: z.object({
-    remoteId: z.string(),
-    remoteSourceType: DataSourceUploadRemoteSource,
-    lastImportedAt: z.coerce.date().optional(),
-    lastImportMetadata: DataSourceUploadImportMetadata.optional(),
-    isTokenTypeSplitEnabled: z.boolean(),
-  }),
-  figmaVariablesPlugin: z.object({
-    fileId: z.string(),
-    lastImportedAt: z.coerce.date().optional(),
-    lastImportMetadata: DataSourceUploadImportMetadata.optional(),
-    isTokenTypeSplitEnabled: z.boolean(),
-    isCollectionsMigrationCompleted: z.boolean().default(false),
-  }),
-});
-
-export const DTODataSource = z.discriminatedUnion("type", [
-  DTODataSourceFigma,
-  DTODataSourceFigmaVariablesPlugin,
-  DTODataSourceTokenStudio,
-]);
-
-export const DTODataSourcesListResponse = z.object({
-  sources: z.array(DTODataSource),
-});
-
-export const DTODataSourceResponse = z.object({
-  source: DTODataSource,
-});
-
-export type DTODataSourceFigma = z.infer<typeof DTODataSourceFigma>;
-export type DTODataSourceTokenStudio = z.infer<typeof DTODataSourceTokenStudio>;
-export type DTODataSourceFigmaVariablesPlugin = z.infer<typeof DTODataSourceFigmaVariablesPlugin>;
-export type DTODataSource = z.infer<typeof DTODataSource>;
-export type DTODataSourceResponse = z.infer<typeof DTODataSourceResponse>;
-export type DTODataSourcesListResponse = z.infer<typeof DTODataSourcesListResponse>;
-
-//
-// Write
-//
-
-export const DTODataSourceFigmaCreatePayload = z.object({
-  brandPersistentId: z.string(),
-  figmaFileUrl: z.string(),
-  scope: DTODataSourceFigmaScope,
-  autoImportMode: DataSourceAutoImportMode,
-});
-
-export const DTODataSourceFigmaImportPayload = z.object({
-  sourceIds: z.array(z.string()),
-});
-
-export type DTODataSourceFigmaScope = z.infer<typeof DTODataSourceFigmaScope>;
-export type DTODataSourceFigmaCreatePayload = z.infer<typeof DTODataSourceFigmaCreatePayload>;
-export type DTODataSourceFigmaImportPayload = z.infer<typeof DTODataSourceFigmaImportPayload>;

package/src/api/dto/design-systems/design-system.ts

@@ -1,68 +0,0 @@
-import { DesignSystem, DesignSystemAccessMode, ObjectMeta, WorkspaceRoleSchema } from "@supernova-studio/model";
-import { z } from "zod";
-import { DTODesignSystemMembersUpdatePayload } from "./members";
-import { DTODesignSystemRole } from "./role";
-
-//
-// Read
-//
-
-export const DTODesignSystem = DesignSystem.omit({
-  name: true,
-  description: true,
-  docExporterId: true,
-}).extend({
-  meta: ObjectMeta,
-  docExporterId: z.string(),
-  sources: z.array(z.any()),
-  isPublic: z.literal(true),
-
-  /**
-   * Whether or not user who is requesting the design system
-   * has access to the design system's contents.
-   */
-  isAvailableToUser: z.boolean(),
-
-  /**
-   * @deprecated
-   */
-  role: WorkspaceRoleSchema.optional(),
-
-  /**
-   * User's role within the design system that can come either from
-   * the design system or workspace.
-   */
-  effectiveRole: DTODesignSystemRole.optional(),
-});
-
-export const DTODesignSystemResponse = z.object({
-  designSystem: DTODesignSystem,
-});
-
-export const DTODesignSystemsListResponse = z.object({
-  designSystems: DTODesignSystem.array(),
-});
-
-export type DTODesignSystem = z.infer<typeof DTODesignSystem>;
-export type DTODesignSystemResponse = z.infer<typeof DTODesignSystemResponse>;
-export type DTODesignSystemsListResponse = z.infer<typeof DTODesignSystemsListResponse>;
-
-//
-// Write
-//
-
-export const DTODesignSystemCreateInput = z.object({
-  workspaceId: z.string(),
-  meta: ObjectMeta.optional(),
-  name: z.string().min(2).max(64).optional(),
-  description: z.string().max(1024).optional(),
-  accessMode: DesignSystemAccessMode.optional(),
-
-  invites: DTODesignSystemMembersUpdatePayload.pick({
-    usersToInvite: true,
-    invitesToInvite: true,
-    emailsToInvite: true,
-  }).optional(),
-});
-
-export type DTODesignSystemCreateInput = z.infer<typeof DTODesignSystemCreateInput>;

package/src/api/dto/design-systems/elements-diff.ts

@@ -1,14 +0,0 @@
-import { z } from "zod";
-
-export const DTODiffCountBase = z.object({
-  created: z.number(),
-  updated: z.number(),
-  deleted: z.number(),
-});
-
-export const DTODesignElementsDataDiffResponse = z.object({
-  tokens: DTODiffCountBase,
-  assets: DTODiffCountBase,
-});
-
-export type DTODesignElementsDataDiffResponse = z.infer<typeof DTODesignElementsDataDiffResponse>;

package/src/api/dto/design-systems/figma-variables.ts

@@ -1,108 +0,0 @@
-import { z } from "zod";
-
-const DimensionsVariableScopeSchema = z.enum([
-  "CORNER_RADIUS",
-  "WIDTH_HEIGHT",
-  "GAP",
-  "STROKE_FLOAT",
-  "EFFECT_FLOAT",
-  "OPACITY",
-  "FONT_SIZE",
-  "LINE_HEIGHT",
-  "LETTER_SPACING",
-  "PARAGRAPH_SPACING",
-  "PARAGRAPH_INDENT",
-  "FONT_WEIGHT",
-]);
-
-const StringVariableScopeSchema = z.enum(["TEXT_CONTENT", "FONT_FAMILY", "FONT_STYLE"]);
-
-export type DimensionsVariableScopeType = z.infer<typeof DimensionsVariableScopeSchema>;
-export const DimensionsVariableScopeType = DimensionsVariableScopeSchema.enum;
-
-export type StringVariableScopeType = z.infer<typeof StringVariableScopeSchema>;
-export const StringVariableScopeType = StringVariableScopeSchema.enum;
-
-const VariableScope = z.string();
-
-const ReferencedVariableOrigin = z.object({
-  name: z.string(),
-  remote: z.boolean(),
-});
-
-export const RGB = z.object({
-  r: z.number(),
-  g: z.number(),
-  b: z.number(),
-});
-
-export const RGBA = RGB.extend({
-  a: z.number(),
-});
-
-export const VariableAlias = z.object({
-  type: z.literal("VARIABLE_ALIAS"),
-  id: z.string(),
-  resolvedValue: z.boolean().or(z.number()).or(z.string()).or(RGBA).or(RGB).optional(),
-  referenceOrigin: ReferencedVariableOrigin.optional().or(z.null()),
-});
-
-export const VariableValue = z.boolean().or(z.number()).or(z.string()).or(RGBA).or(RGB).or(VariableAlias);
-export const ResolvedVariableType = z.enum(["BOOLEAN", "FLOAT", "STRING", "COLOR"]);
-
-export const Variable = z.object({
-  id: z.string(),
-  name: z.string(),
-  key: z.string(),
-  variableCollectionId: z.string(),
-  resolvedType: ResolvedVariableType,
-  valuesByMode: z.record(VariableValue),
-  remote: z.boolean(),
-  description: z.string(),
-  hiddenFromPublishing: z.boolean(),
-  scopes: z.array(VariableScope),
-  codeSyntax: z.record(z.any()).optional(),
-});
-
-export const VariableMode = z.object({
-  modeId: z.string(),
-  name: z.string(),
-});
-
-export const Collection = z.object({
-  id: z.string(),
-  name: z.string(),
-  modes: z.array(VariableMode),
-  defaultModeId: z.string(),
-  remote: z.boolean(),
-  hiddenFromPublishing: z.boolean(),
-});
-
-export const VariablesMapping = z.object({
-  variableCollections: z.array(z.string()).min(1),
-  variableMode: z.string().min(1),
-  supernovaBrand: z.string().min(1),
-  supernovaTheme: z.string().min(1).optional().or(z.null()),
-});
-
-export const FormattedCollections = z.object({
-  variables: z.record(z.string(), Variable),
-  variableCollections: z.record(z.string(), Collection),
-  mappings: z.array(VariablesMapping).optional(),
-  variablesOrder: z.string().array().optional(),
-});
-
-//
-// Types
-//
-
-export type RGB = z.infer<typeof RGB>;
-export type RGBA = z.infer<typeof RGBA>;
-export type ResolvedVariableType = z.infer<typeof ResolvedVariableType>;
-export type Variable = z.infer<typeof Variable>;
-export type VariableAlias = z.infer<typeof VariableAlias>;
-export type VariableValue = z.infer<typeof VariableValue>;
-export type VariableMode = z.infer<typeof VariableMode>;
-export type Collection = z.infer<typeof Collection>;
-export type VariablesMapping = z.infer<typeof VariablesMapping>;
-export type FormattedCollections = z.infer<typeof FormattedCollections>;

package/src/api/dto/design-systems/import-job.ts

@@ -1,61 +0,0 @@
-import {
-  DataSourceAutoImportMode,
-  DataSourceFigmaScope,
-  DataSourceRemoteType,
-  ImportJobState,
-} from "@supernova-studio/model";
-import { z } from "zod";
-
-//
-// Read
-//
-
-export const DTOImportJob = z.object({
-  id: z.string(),
-  designSystemId: z.string(),
-  designSystemVersionId: z.string(),
-  operation: z.literal("Import"),
-  createdAt: z.coerce.date(),
-  stateChangedAt: z.coerce.date(),
-  state: ImportJobState,
-  sourceIds: z.string().array(),
-});
-
-export const DTOImportJobResponse = z.object({
-  job: DTOImportJob,
-});
-
-export type DTOImportJob = z.infer<typeof DTOImportJob>;
-export type DTOImportJobResponse = z.infer<typeof DTOImportJobResponse>;
-
-//
-// Write
-//
-
-export const DTOBffFigmaImportRequestBody = z.object({
-  type: z.literal(DataSourceRemoteType.Enum.Figma),
-  brandPersistentId: z.string().optional(),
-  fileId: z.string(),
-  scope: DataSourceFigmaScope,
-  autoImportMode: DataSourceAutoImportMode,
-});
-
-export const DTOBffUploadImportRequestBody = z.object({
-  type: z
-    .enum([DataSourceRemoteType.Enum.FigmaVariablesPlugin, "Upload"])
-    .transform(v => DataSourceRemoteType.Enum.FigmaVariablesPlugin),
-  brandPersistentId: z.string().optional(),
-  sourceName: z.string().optional(),
-  remoteId: z.string(),
-  isTokenTypeSplitEnabled: z.boolean().optional(),
-  payload: z.any(),
-});
-
-export const DTOBffImportRequestBody = z.discriminatedUnion("type", [
-  DTOBffFigmaImportRequestBody,
-  DTOBffUploadImportRequestBody,
-]);
-
-export type DTOBffFigmaImportRequestBody = z.infer<typeof DTOBffFigmaImportRequestBody>;
-export type DTOBffUploadImportRequestBody = z.infer<typeof DTOBffUploadImportRequestBody>;
-export type DTOBffImportRequestBody = z.infer<typeof DTOBffImportRequestBody>;

package/src/api/dto/design-systems/index.ts

@@ -1,13 +0,0 @@
-export * from "./brand";
-export * from "./component";
-export * from "./contact";
-export * from "./data-source";
-export * from "./design-system";
-export * from "./elements-diff";
-export * from "./figma-variables";
-export * from "./import-job";
-export * from "./members";
-export * from "./role";
-export * from "./stats";
-export * from "./version";
-export * from "./view";