@supernova-studio/client 0.9.3 → 0.10.1

package/dist/index.mjs

@@ -1,6 +1,3 @@
-// src/api/dto/documentation-v1.ts
-import { z as z125 } from "zod";
-
 // ../model/dist/index.mjs
 import { z } from "zod";
 import { z as z2 } from "zod";
@@ -880,7 +877,7 @@ var PageBlockV1 = PageBlockBaseV1.extend({
   )
 });
 var PageBlockLinkType = z33.enum(["DocumentationItem", "PageHeading", "Url"]);
-var PageBlockImageType = z33.enum(["Upload", "Asset", "FigmaFrame"]);
+var PageBlockImageType = z33.enum(["Upload", "Asset", "FigmaNode"]);
 var PageBlockImageAlignment = z33.enum(["Left", "Center", "Stretch"]);
 var PageBlockTableCellAlignment = z33.enum(["Left", "Center", "Right"]);
 var PageBlockPreviewContainerSize = z33.enum(["Centered", "NaturalHeight"]);
@@ -979,6 +976,21 @@ var PageBlockItemEmbedValue = z33.object({
   caption: z33.string().optional(),
   height: z33.number().optional()
 });
+var PageBlockItemFigmaNodeValue = z33.object({
+  selectedPropertyIds: z33.array(z33.string()).optional(),
+  showSearch: z33.boolean().optional(),
+  previewContainerSize: PageBlockPreviewContainerSize.optional(),
+  backgroundColor: z33.string().optional(),
+  value: z33.array(
+    z33.object({
+      entityId: z33.string(),
+      entityMeta: z33.object({
+        title: z33.string().optional(),
+        description: z33.string().optional()
+      }).optional()
+    })
+  )
+});
 var PageBlockItemImageValue = z33.object({
   alt: z33.string().optional(),
   caption: z33.string().optional(),
@@ -1864,6 +1876,7 @@ var PageBlockDefinitionPropertyType = z85.enum([
   "ComponentProperty",
   "Asset",
   "AssetProperty",
+  "FigmaNode",
   "EmbedURL",
   "URL",
   "Markdown",
@@ -1898,6 +1911,7 @@ var PageBlockDefinitionTextPropertyStyle = z85.enum([
   "SmallBold",
   "SmallSemibold"
 ]);
+var PageBlockDefinitionTextPropertyColor = z85.enum(["Neutral", "NeutralFaded"]);
 var PageBlockDefinitionBooleanPropertyStyle = z85.enum(["SegmentedControl", "ToggleButton", "Checkbox"]);
 var PageBlockDefinitionSingleSelectPropertyStyle = z85.enum([
   "SegmentedControl",
@@ -1906,20 +1920,60 @@ var PageBlockDefinitionSingleSelectPropertyStyle = z85.enum([
   "Checkbox"
 ]);
 var PageBlockDefinitionMultiSelectPropertyStyle = z85.enum(["SegmentedControl", "Select", "Checkbox"]);
-var PageBlockDefinitionPropertyOptions = z85.object({
-  richTextStyle: PageBlockDefinitionRichTextPropertyStyle.optional(),
-  multiRichTextStyle: PageBlockDefinitionMultiRichTextPropertyStyle.optional(),
+var PageBlockDefinitionImageAspectRatio = z85.enum(["Auto", "Square", "Landscape", "Portrait", "Wide"]);
+var PageBlockDefinitionImageWidth = z85.enum(["Full", "Icon", "Small", "Medium", "Large", "Poster"]);
+var PageBlockDefinitionSelectChoice = z85.object({
+  value: z85.string(),
+  name: z85.string(),
+  icon: z85.string().optional()
+});
+var PageBlockDefinitionUntypedPropertyOptions = z85.record(z85.any());
+var PageBlockDefinitionRichTextOptions = z85.object({
+  richTextStyle: PageBlockDefinitionRichTextPropertyStyle.optional()
+});
+var PageBlockDefinitionMutiRichTextOptions = z85.object({
+  multiRichTextStyle: PageBlockDefinitionMultiRichTextPropertyStyle.optional()
+});
+var PageBlockDefinitionTextOptions = z85.object({
+  placeholder: z85.string().optional(),
+  defaultValue: z85.string().optional(),
   textStyle: PageBlockDefinitionTextPropertyStyle.optional(),
+  color: PageBlockDefinitionTextPropertyColor.optional()
+});
+var PageBlockDefinitionSelectOptions = z85.object({
+  singleSelectStyle: PageBlockDefinitionSingleSelectPropertyStyle.optional(),
+  defaultChoice: z85.string(),
+  choices: z85.array(PageBlockDefinitionSelectChoice)
+});
+var PageBlockDefinitionImageOptions = z85.object({
+  width: PageBlockDefinitionImageWidth.optional(),
+  aspectRatio: PageBlockDefinitionImageAspectRatio.optional(),
+  allowCaption: z85.boolean().optional(),
+  recommendation: z85.string().optional()
+});
+var PageBlockDefinitionBooleanOptions = z85.object({
+  defaultvalue: z85.boolean().optional(),
+  booleanStyle: PageBlockDefinitionBooleanPropertyStyle.optional()
+});
+var PageBlockDefinitionNumberOptions = z85.object({
+  defaultValue: z85.number(),
+  min: z85.number().optional(),
+  max: z85.number().optional(),
+  step: z85.number().optional(),
   placeholder: z85.string().optional()
-}).and(z85.record(z85.any()));
+});
+var PageBlockDefinitionComponentOptions = z85.object({
+  renderLayoutAs: z85.enum(["List", "Table"]).optional(),
+  allowPropertySelection: z85.boolean().optional()
+});
 var PageBlockDefinitionProperty = z85.object({
   id: z85.string(),
   name: z85.string(),
   type: PageBlockDefinitionPropertyType,
   description: z85.string().optional(),
   // TODO Docs
-  options: PageBlockDefinitionPropertyOptions.optional(),
-  variantOptions: z85.record(PageBlockDefinitionPropertyOptions).optional()
+  options: PageBlockDefinitionUntypedPropertyOptions.optional(),
+  variantOptions: z85.record(PageBlockDefinitionUntypedPropertyOptions).optional()
 });
 var PageBlockDefinitionItem = z85.object({
   properties: z85.array(PageBlockDefinitionProperty),
@@ -1941,7 +1995,7 @@ var PageBlockCategory = z86.enum([
   "Data",
   "Other"
 ]);
-var PageBlockBehaviorDataType = z86.enum(["Item", "Token", "Asset", "Component", "FigmaFrame"]);
+var PageBlockBehaviorDataType = z86.enum(["Item", "Token", "Asset", "Component", "FigmaNode"]);
 var PageBlockBehaviorSelectionType = z86.enum(["Entity", "Group", "EntityAndGroup"]);
 var PageBlockDefinitionBehavior = z86.object({
   dataType: PageBlockBehaviorDataType,
@@ -2134,22 +2188,22 @@ var UpdateMembershipRolesInput = z97.object({
 });
 var DesignSystemSwitcher = z98.object({
   isEnabled: z98.boolean(),
-  designSystemIds: z98.string()
+  designSystemIds: z98.array(z98.string())
 });
 var DesignSystem = z98.object({
   id: z98.string(),
   workspaceId: z98.string(),
   name: z98.string(),
   description: z98.string(),
-  docExporterId: z98.string().nullish(),
+  docExporterId: nullishToOptional(z98.string()),
   docSlug: z98.string(),
-  docUserSlug: z98.string().nullish(),
+  docUserSlug: nullishToOptional(z98.string()),
   docSlugDeprecated: z98.string(),
   isPublic: z98.boolean(),
   isMultibrand: z98.boolean(),
-  docViewUrl: z98.string().nullish(),
+  docViewUrl: nullishToOptional(z98.string()),
   basePrefixes: z98.array(z98.string()),
-  designSystemSwitcher: DesignSystemSwitcher.nullish(),
+  designSystemSwitcher: nullishToOptional(DesignSystemSwitcher),
   createdAt: z98.date(),
   updatedAt: z98.date()
 });
@@ -2212,25 +2266,120 @@ var PublishedDoc = z101.object({
   usesLocalizations: z101.boolean(),
   wasPublishedWithLocalizations: z101.boolean()
 });
-var ExportJobStatus = z102.union([
-  z102.literal("Success"),
-  z102.literal("InProgress"),
-  z102.literal("Timeout"),
-  z102.literal("Failed")
-]);
-var ExportJob = z102.object({
-  id: z102.string(),
-  workspaceId: z102.string(),
-  designSystemId: z102.string(),
-  designSystemVersionId: z102.string(),
-  status: ExportJobStatus,
-  docsUrl: z102.string().nullish(),
-  scheduleId: z102.string().nullish(),
-  exporterId: z102.string().nullish(),
-  createdAt: z102.date(),
-  environment: PublishedDocEnvironment,
-  finishedAt: z102.date().nullish()
-});
+var ExporterJobDestination = z102.enum(["s3", "webhookUrl", "github", "documentation", "azure", "gitlab"]);
+var ExporterJobStatus = z102.enum(["InProgress", "Success", "Failed", "Timeout"]);
+var ExporterJobLogEntryType = z102.enum(["success", "info", "warning", "error", "user"]);
+var ExporterJobLogEntry = z102.object({
+  id: z102.string().optional(),
+  time: z102.coerce.date(),
+  type: ExporterJobLogEntryType,
+  message: z102.string()
+});
+var ExporterJobResultPullRequestDestination = z102.object({
+  pullRequestUrl: z102.string()
+});
+var ExporterJobResultS3Destination = z102.object({
+  bucket: z102.string(),
+  urlPrefix: z102.string().optional(),
+  path: z102.string(),
+  files: z102.array(z102.string())
+});
+var ExporterJobResultDocsDestination = z102.object({
+  url: z102.string()
+});
+var ExporterJobResult = z102.object({
+  error: z102.string().optional(),
+  logs: z102.array(ExporterJobLogEntry).optional(),
+  s3: ExporterJobResultS3Destination.optional(),
+  github: ExporterJobResultPullRequestDestination.optional(),
+  azure: ExporterJobResultPullRequestDestination.optional(),
+  gitlab: ExporterJobResultPullRequestDestination.optional(),
+  bitbucket: ExporterJobResultPullRequestDestination.optional(),
+  sndocs: ExporterJobResultDocsDestination.optional()
+});
+var ExporterDestinationSnDocs = z102.object({
+  environment: PublishedDocEnvironment
+});
+var ExporterDestinationS3 = z102.object({});
+var ExporterDestinationGithub = z102.object({
+  connectionId: z102.string(),
+  url: z102.string(),
+  branch: z102.string(),
+  relativePath: z102.string(),
+  // +
+  userId: z102.coerce.string()
+});
+var ExporterDestinationAzure = z102.object({
+  connectionId: z102.string(),
+  organizationId: z102.string(),
+  projectId: z102.string(),
+  repositoryId: z102.string(),
+  branch: z102.string(),
+  relativePath: z102.string(),
+  // +
+  userId: z102.coerce.string(),
+  url: z102.string()
+});
+var ExporterDestinationGitlab = z102.object({
+  connectionId: z102.string(),
+  projectId: z102.string(),
+  branch: z102.string(),
+  relativePath: z102.string(),
+  // +
+  userId: z102.coerce.string(),
+  url: z102.string()
+});
+var BITBUCKET_SLUG = /^[-a-zA-Z0-9~]*$/;
+var BITBUCKET_MAX_LENGTH = 64;
+var ExporterDestinationBitbucket = z102.object({
+  connectionId: z102.string(),
+  workspaceSlug: z102.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
+  projectKey: z102.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
+  repoSlug: z102.string().max(BITBUCKET_MAX_LENGTH).regex(BITBUCKET_SLUG),
+  branch: z102.string(),
+  relativePath: z102.string(),
+  // +
+  userId: z102.coerce.string(),
+  url: z102.string()
+});
+var ExporterJob = z102.object({
+  id: z102.coerce.string(),
+  createdAt: z102.coerce.date(),
+  finishedAt: z102.coerce.date().optional(),
+  designSystemId: z102.coerce.string(),
+  designSystemVersionId: z102.coerce.string(),
+  workspaceId: z102.coerce.string(),
+  scheduleId: z102.coerce.string().nullish(),
+  exporterId: z102.coerce.string(),
+  brandId: z102.coerce.string().optional(),
+  themeId: z102.coerce.string().optional(),
+  estimatedExecutionTime: z102.number().optional(),
+  status: ExporterJobStatus,
+  result: ExporterJobResult.optional(),
+  createdByUserId: z102.string().optional(),
+  // CodegenDestinationsModel
+  webhookUrl: z102.string().optional(),
+  destinationSnDocs: ExporterDestinationSnDocs.optional(),
+  destinationS3: ExporterDestinationS3.optional(),
+  destinationGithub: ExporterDestinationGithub.optional(),
+  destinationAzure: ExporterDestinationAzure.optional(),
+  destinationGitlab: ExporterDestinationGitlab.optional(),
+  destinationBitbucket: ExporterDestinationBitbucket.optional()
+});
+var ExporterJobFindByFilter = ExporterJob.pick({
+  exporterId: true,
+  designSystemVersionId: true,
+  destinations: true,
+  createdByUserId: true,
+  status: true,
+  scheduleId: true,
+  designSystemId: true,
+  themeId: true,
+  brandId: true
+}).extend({
+  destinations: z102.array(ExporterJobDestination),
+  docsEnvironment: PublishedDocEnvironment
+}).partial();
 var ExporterWorkspaceMembershipRole = z103.enum(["Owner", "OwnerArchived", "User"]);
 var ExporterWorkspaceMembership = z104.object({
   id: z104.string(),
@@ -2246,13 +2395,6 @@ var GitProviderNames = /* @__PURE__ */ ((GitProviderNames2) => {
   return GitProviderNames2;
 })(GitProviderNames || {});
 var GitProvider = z105.nativeEnum(GitProviderNames);
-var PulsarContributionVariant = z106.object({
-  key: z106.string(),
-  name: z106.string(),
-  isDefault: z106.boolean().optional(),
-  description: z106.string().optional(),
-  thumbnailURL: z106.string().optional()
-});
 var PulsarPropertyType = z106.enum([
   "string",
   "number",
@@ -2266,47 +2408,56 @@ var PulsarPropertyType = z106.enum([
   "tokenProperties",
   "tokenType"
 ]);
-var BasePulsarProperty = z106.object({
+var PulsarBaseProperty = z106.object({
   label: z106.string(),
   key: z106.string(),
-  description: z106.string().optional(),
+  description: z106.string().nullish(),
   type: PulsarPropertyType,
-  values: z106.array(z106.string()).optional(),
+  values: z106.array(z106.string()).nullish(),
   default: z106.union([z106.string(), z106.boolean(), z106.number()]).nullish(),
   // PulsarPropertyValueType //is optional?
   inputType: z106.enum(["code", "plain"]).optional(),
   //is optional?
-  isMultiline: z106.boolean().optional()
+  isMultiline: z106.boolean().nullish()
+});
+var PulsarContributionConfigurationProperty = PulsarBaseProperty.extend({
+  category: z106.string()
+});
+var PulsarContributionVariant = z106.object({
+  key: z106.string(),
+  name: z106.string(),
+  isDefault: z106.boolean().nullish(),
+  description: z106.string().nullish(),
+  thumbnailURL: z106.string().nullish()
 });
-var PulsarContributionBlock = z106.object({
+var PulsarCustomBlock = z106.object({
   title: z106.string(),
   key: z106.string(),
   category: z106.string(),
-  description: z106.string().optional(),
+  description: nullishToOptional(z106.string()),
   iconURL: z106.string(),
   mode: z106.enum(["array", "block"]),
-  properties: z106.array(BasePulsarProperty)
+  properties: z106.array(PulsarBaseProperty)
 });
-var PulsarContributionConfigurationProperty = BasePulsarProperty.extend({ category: z106.string() });
 var ExporterType = z107.enum(["code", "documentation"]);
 var ExporterSource = z107.enum(["git", "upload"]);
 var ExporterTag = z107.string().regex(/^[0-9a-zA-Z]+(\s[0-9a-zA-Z]+)*$/);
 var ExporterDetails = z107.object({
-  packageId: z107.string().max(255),
-  version: z107.string(),
   description: z107.string(),
+  version: z107.string(),
+  routingVersion: nullishToOptional(z107.string()),
   author: nullishToOptional(z107.string()),
   organization: nullishToOptional(z107.string()),
   homepage: nullishToOptional(z107.string()),
   readme: nullishToOptional(z107.string()),
-  tags: z107.array(ExporterTag).default([]),
-  routingVersion: nullishToOptional(z107.string()),
+  tags: nullishToOptional(z107.array(ExporterTag)).default([]),
+  packageId: nullishToOptional(z107.string().max(255)),
   iconURL: nullishToOptional(z107.string()),
-  configurationProperties: z107.array(PulsarContributionConfigurationProperty).default([]),
-  customBlocks: z107.array(PulsarContributionBlock).default([]),
-  blockVariants: z107.record(z107.string(), z107.array(PulsarContributionVariant)).default({}),
-  usesBrands: z107.boolean().default(false),
-  usesThemes: z107.boolean().default(false),
+  configurationProperties: nullishToOptional(z107.array(PulsarContributionConfigurationProperty)).default([]),
+  customBlocks: nullishToOptional(z107.array(PulsarCustomBlock)).default([]),
+  blockVariants: nullishToOptional(z107.record(z107.string(), z107.array(PulsarContributionVariant))).default({}),
+  usesBrands: nullishToOptional(z107.boolean()).default(false),
+  usesThemes: nullishToOptional(z107.boolean()).default(false),
   source: ExporterSource,
   gitProvider: nullishToOptional(GitProvider),
   gitUrl: nullishToOptional(z107.string()),
@@ -2319,8 +2470,8 @@ var Exporter = z107.object({
   name: z107.string(),
   isPrivate: z107.boolean(),
   details: ExporterDetails,
-  exporterType: ExporterType.default("code"),
-  storagePath: z107.string().default("")
+  exporterType: nullishToOptional(ExporterType).default("code"),
+  storagePath: nullishToOptional(z107.string()).default("")
 });
 var CustomDomain = z108.object({
   id: z108.string(),
@@ -2517,7 +2668,16 @@ var ContentLoaderPayload = z124.object({
   })
 );
 
+// src/api/dto/design-system.ts
+var DesignSystemDTO = DesignSystem.omit({
+  name: true,
+  description: true
+}).extend({
+  meta: ObjectMeta
+});
+
 // src/api/dto/documentation-v1.ts
+import { z as z125 } from "zod";
 var DocumentationPageV1DTO = DocumentationPageV1.omit({
   data: true,
   meta: true,
@@ -4131,7 +4291,8 @@ function serializeAsRichTextBlock(input) {
   const blockItem = BlockParsingUtils.singleBlockItem(block);
   const textPropertyValue = BlockParsingUtils.richTextPropertyValue(blockItem, richTextProperty.id);
   const enrichedInput = { ...input, richTextPropertyValue: textPropertyValue };
-  const style = richTextProperty.options?.richTextStyle ?? "Default";
+  const parsedOptions = PageBlockDefinitionRichTextOptions.optional().parse(richTextProperty.options);
+  const style = parsedOptions?.richTextStyle ?? "Default";
   switch (style) {
     case "Callout":
       return serializeAsCallout(enrichedInput);
@@ -4183,11 +4344,12 @@ function serializeAsCallout(input) {
   };
 }
 function serializeAsMultiRichTextBlock(input) {
-  const { block, definition, property: richTextProperty } = input;
+  const { block, definition, property: multiRichTextProperty } = input;
   const blockItem = BlockParsingUtils.singleBlockItem(block);
-  const textPropertyValue = BlockParsingUtils.multiRichTextPropertyValue(blockItem, richTextProperty.id);
+  const textPropertyValue = BlockParsingUtils.multiRichTextPropertyValue(blockItem, multiRichTextProperty.id);
   const enrichedInput = { ...input, multiRichTextPropertyValue: textPropertyValue };
-  const style = richTextProperty.options?.multiRichTextStyle ?? "Default";
+  const parsedOptions = PageBlockDefinitionMutiRichTextOptions.optional().parse(multiRichTextProperty.options);
+  const style = parsedOptions?.multiRichTextStyle ?? "Default";
   switch (style) {
     case "Default":
       return serializeAsMultiParagraph(enrichedInput);
@@ -6644,7 +6806,7 @@ var blocks = [
     }
   },
   {
-    id: "io.supernova.block.figma-frames",
+    id: "io.supernova.block.figma-nodes",
     name: "Figma frames",
     description: "Display Figma frames as images",
     category: "Figma",
@@ -6707,7 +6869,7 @@ var blocks = [
       defaultVariantKey: "bordered"
     },
     behavior: {
-      dataType: "FigmaFrame",
+      dataType: "FigmaNode",
       entities: {
         selectionType: "Entity",
         maxSelected: 0
@@ -7422,6 +7584,8 @@ function valueSchemaForPropertyType(type) {
       return PageBlockItemAssetValue;
     case "AssetProperty":
       return PageBlockItemAssetPropertyValue;
+    case "FigmaNode":
+      return PageBlockItemFigmaNodeValue;
     case "EmbedURL":
       return PageBlockItemEmbedValue;
     case "URL":
@@ -7477,6 +7641,7 @@ export {
   BulkEditDocPageElementsInput,
   CreateBulkElementsInput,
   DeleteBulkElementsInput,
+  DesignSystemDTO,
   DocumentationGroupDTO,
   DocumentationGroupStructureDTO,
   DocumentationHierarchyV2DTO,