@supernova-studio/model 0.0.9 → 0.3.0

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

@@ -8,6 +8,7 @@ import { PageBlockDefinitionVariant } from "./variant";
 
 export const PageBlockDefinitionPropertyType = z.enum([
   "RichText",
+  "MultiRichText",
   "Text",
   "Boolean",
   "Number",
@@ -29,6 +30,7 @@ export const PageBlockDefinitionPropertyType = z.enum([
   "Table",
   "Divider",
   "Storybook",
+  "Color",
 ]);
 
 export const PageBlockDefinitionRichTextPropertyStyle = z.enum([
@@ -39,11 +41,11 @@ export const PageBlockDefinitionRichTextPropertyStyle = z.enum([
   "Title5",
   "Quote",
   "Callout",
-  "OL",
-  "UL",
   "Default",
 ]);
 
+export const PageBlockDefinitionMultiRichTextPropertyStyle = z.enum(["OL", "UL", "Default"]);
+
 export const PageBlockDefinitionTextPropertyStyle = z.enum([
   "Title1",
   "Title2",
@@ -69,6 +71,9 @@ export const PageBlockDefinitionMultiSelectPropertyStyle = z.enum(["SegmentedCon
 
 export type PageBlockDefinitionPropertyType = z.infer<typeof PageBlockDefinitionPropertyType>;
 export type PageBlockDefinitionRichTextPropertyStyle = z.infer<typeof PageBlockDefinitionRichTextPropertyStyle>;
+export type PageBlockDefinitionMultiRichTextPropertyStyle = z.infer<
+  typeof PageBlockDefinitionMultiRichTextPropertyStyle
+>;
 export type PageBlockDefinitionTextPropertyStyle = z.infer<typeof PageBlockDefinitionTextPropertyStyle>;
 export type PageBlockDefinitionBooleanPropertyStyle = z.infer<typeof PageBlockDefinitionBooleanPropertyStyle>;
 export type PageBlockDefinitionSingleSelectPropertyStyle = z.infer<typeof PageBlockDefinitionSingleSelectPropertyStyle>;
@@ -81,6 +86,7 @@ export type PageBlockDefinitionMultiSelectPropertyStyle = z.infer<typeof PageBlo
 export const PageBlockDefinitionPropertyOptions = z
   .object({
     richTextStyle: PageBlockDefinitionRichTextPropertyStyle.optional(),
+    multiRichTextStyle: PageBlockDefinitionMultiRichTextPropertyStyle.optional(),
     textStyle: PageBlockDefinitionTextPropertyStyle.optional(),
     placeholder: z.string().optional(),
   })

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

@@ -219,6 +219,15 @@ export const PageBlockText = z.object({
   spans: z.array(PageBlockTextSpan),
 });
 
+export type PageBlockCalloutType = z.infer<typeof PageBlockCalloutType>;
+export type PageBlockCodeLanguage = z.infer<typeof PageBlockCodeLanguage>;
+export type PageBlockAlignment = z.infer<typeof PageBlockAlignment>;
+export type PageBlockThemeType = z.infer<typeof PageBlockThemeType>;
+export type PageBlockAssetType = z.infer<typeof PageBlockAssetType>;
+export type PageBlockTilesAlignment = z.infer<typeof PageBlockTilesAlignment>;
+export type PageBlockTilesLayout = z.infer<typeof PageBlockTilesLayout>;
+export type PageBlockTextSpanAttributeType = z.infer<typeof PageBlockTextSpanAttributeType>;
+
 export type PageBlockTypeV1 = z.infer<typeof PageBlockTypeV1>;
 export type PageBlockTextSpanAttribute = z.infer<typeof PageBlockTextSpanAttribute>;
 export type PageBlockTextSpan = z.infer<typeof PageBlockTextSpan>;

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

@@ -1,33 +1,39 @@
 import { z } from "zod";
 import { ColorValue } from "./color";
-import { PageBlockCalloutType } from "./documentation-block-v1";
+import { PageBlockCalloutType, PageBlockCodeLanguage, PageBlockText } from "./documentation-block-v1";
+import { Size } from "../primitives";
+import { DesignTokenType } from "../raw-element";
 
 //
 // Enums
 //
 
-export const PageBlockLinkType = z.enum(["Page", "PageHeading", "Group", "Url"]);
+export const PageBlockLinkType = z.enum(["DocumentationItem", "PageHeading", "Url"]);
+export const PageBlockImageType = z.enum(["Upload", "Asset", "FigmaFrame"]);
+export const PageBlockImageAlignment = z.enum(["Left", "Center", "Stretch"]);
 
 export type PageBlockLinkType = z.infer<typeof PageBlockLinkType>;
+export type PageBlockImageType = z.infer<typeof PageBlockImageType>;
+export type PageBlockImageAlignment = z.infer<typeof PageBlockImageAlignment>;
 
 //
-// Definitions
+// Definitions - Block
 //
 
 export const PageBlockAppearanceV2 = z.object({
   itemBackgroundColor: ColorValue,
 });
 
-export const PageBlockItemPropertyValue = z.object({
-  value: z.any(),
-  calloutType: PageBlockCalloutType.optional(),
-});
+export const PageBlockItemUntypedValue = z
+  .object({
+    value: z.any(),
+  })
+  .and(z.record(z.any()));
 
 export const PageBlockLinkV2 = z.object({
   type: PageBlockLinkType,
-  pageId: z.string().optional(),
+  documentationItemId: z.string().optional(),
   pageHeadingId: z.string().optional(),
-  groupId: z.string().optional(),
   url: z.string().optional(),
   openInNewTab: z.boolean().optional(),
 });
@@ -35,7 +41,7 @@ export const PageBlockLinkV2 = z.object({
 export const PageBlockItemV2 = z.object({
   id: z.string(),
   linksTo: PageBlockLinkV2.optional(),
-  props: z.record(PageBlockItemPropertyValue),
+  props: z.record(PageBlockItemUntypedValue),
 });
 
 export const PageBlockDataV2 = z.object({
@@ -47,7 +53,181 @@ export const PageBlockDataV2 = z.object({
 });
 
 export type PageBlockAppearanceV2 = z.infer<typeof PageBlockAppearanceV2>;
-export type PageBlockItemPropertyValue = z.infer<typeof PageBlockItemPropertyValue>;
+export type PageBlockItemUntypedValue = z.infer<typeof PageBlockItemUntypedValue>;
 export type PageBlockLinkV2 = z.infer<typeof PageBlockLinkV2>;
 export type PageBlockItemV2 = z.infer<typeof PageBlockItemV2>;
 export type PageBlockDataV2 = z.infer<typeof PageBlockDataV2>;
+
+//
+// Definitions - Typed Values
+//
+
+export const PageBlockItemImageReference = z.object({
+  type: PageBlockImageType,
+  url: z.string(),
+  assetId: z.string().optional(),
+  size: Size.optional(),
+  figmaFile: z
+    .object({
+      sourceId: z.string(),
+      frameId: z.string(),
+    })
+    .optional(),
+});
+
+export const PageBlockItemAssetValue = z.object({
+  selectedPropertyIds: z.array(z.string()).optional(),
+  showSearch: z.boolean().optional(),
+  previewContainerSize: z.enum(["Centered", "NaturalHeight"]).optional(),
+  backgroundColor: z.string().optional(),
+  value: z.array(
+    z.object({
+      entityId: z.string(),
+      entityType: z.enum(["Asset", "AssetGroup"]),
+    })
+  ),
+});
+
+export const PageBlockItemAssetPropertyValue = z.object({
+  value: z.array(z.string()),
+});
+
+export const PageBlockItemBooleanValue = z.object({
+  value: z.boolean(),
+});
+
+export const PageBlockItemCodeValue = z.object({
+  format: PageBlockCodeLanguage.optional(),
+  caption: z.string().optional(),
+  value: z.string(),
+});
+
+export const PageBlockItemSandboxValue = z.object({
+  showCode: z.boolean().optional(),
+  backgroundColor: z.string().optional(),
+  alignPreview: z.enum(["Left", "Center"]).optional(),
+  value: z.string(),
+});
+
+export const PageBlockItemColorValue = z.record(z.any());
+
+export const PageBlockItemComponentValue = z.object({
+  selectedPropertyIds: z.array(z.string()).optional(),
+  value: z.array(
+    z.object({
+      entityId: z.string(),
+      entityType: z.enum(["Component", "ComponentGroup"]),
+    })
+  ),
+});
+
+export const PageBlockItemComponentPropertyValue = z.object({
+  value: z.string(),
+});
+
+export const PageBlockItemDividerValue = z.object({});
+
+export const PageBlockItemEmbedValue = z.object({
+  value: z.string().optional(),
+  caption: z.string().optional(),
+  height: z.number().optional(),
+});
+
+export const PageBlockItemImageValue = z.object({
+  alt: z.string().optional(),
+  caption: z.string().optional(),
+  alignment: PageBlockImageAlignment.optional(),
+  value: PageBlockItemImageReference.optional(),
+});
+
+export const PageBlockItemMarkdownValue = z.object({
+  value: z.string(),
+});
+
+export const PageBlockItemMultiRichTextValue = z.object({
+  value: PageBlockText.array(),
+});
+
+export const PageBlockItemMultiSelectValue = z.object({
+  value: z.array(z.string()),
+});
+
+export const PageBlockItemNumberValue = z.object({
+  value: z.number(),
+});
+
+export const PageBlockItemRichTextValue = z.object({
+  value: PageBlockText,
+  calloutType: PageBlockCalloutType.optional(),
+});
+
+export const PageBlockItemSingleSelectValue = z.object({
+  value: z.string(),
+});
+
+export const PageBlockItemStorybookValue = z.object({
+  caption: z.string().optional(),
+  height: z.number().optional(),
+  showAddons: z.boolean().optional(),
+  value: z.string(),
+});
+
+export const PageBlockItemTableValue = z.object({
+  value: z.any(),
+});
+
+export const PageBlockItemTextValue = z.object({
+  value: z.string(),
+});
+
+export const PageBlockItemTokenValue = z.object({
+  selectedPropertyIds: z.array(z.string()).optional(),
+  selectedThemeIds: z.array(z.string()).optional(),
+  value: z.array(
+    z.object({
+      entityId: z.string(),
+      entityType: z.enum(["Token", "TokenGroup"]),
+    })
+  ),
+});
+
+export const PageBlockItemTokenPropertyValue = z.object({
+  selectedPropertyIds: z.array(z.string()).optional(),
+  selectedThemeIds: z.array(z.string()).optional(),
+  value: z.array(z.string()),
+});
+
+export const PageBlockItemTokenTypeValue = z.object({
+  value: z.array(DesignTokenType),
+});
+
+export const PageBlockItemUrlValue = z.object({
+  value: z.string(),
+});
+
+export type PageBlockItemImageReference = z.infer<typeof PageBlockItemImageReference>;
+
+export type PageBlockItemAssetValue = z.infer<typeof PageBlockItemAssetValue>;
+export type PageBlockItemAssetPropertyValue = z.infer<typeof PageBlockItemAssetPropertyValue>;
+export type PageBlockItemBooleanValue = z.infer<typeof PageBlockItemBooleanValue>;
+export type PageBlockItemCodeValue = z.infer<typeof PageBlockItemCodeValue>;
+export type PageBlockItemSandboxValue = z.infer<typeof PageBlockItemSandboxValue>;
+export type PageBlockItemColorValue = z.infer<typeof PageBlockItemColorValue>;
+export type PageBlockItemComponentValue = z.infer<typeof PageBlockItemComponentValue>;
+export type PageBlockItemComponentPropertyValue = z.infer<typeof PageBlockItemComponentPropertyValue>;
+export type PageBlockItemDividerValue = z.infer<typeof PageBlockItemDividerValue>;
+export type PageBlockItemEmbedValue = z.infer<typeof PageBlockItemEmbedValue>;
+export type PageBlockItemImageValue = z.infer<typeof PageBlockItemImageValue>;
+export type PageBlockItemMarkdownValue = z.infer<typeof PageBlockItemMarkdownValue>;
+export type PageBlockItemMultiRichTextValue = z.infer<typeof PageBlockItemMultiRichTextValue>;
+export type PageBlockItemMultiSelectValue = z.infer<typeof PageBlockItemMultiSelectValue>;
+export type PageBlockItemNumberValue = z.infer<typeof PageBlockItemNumberValue>;
+export type PageBlockItemRichTextValue = z.infer<typeof PageBlockItemRichTextValue>;
+export type PageBlockItemSingleSelectValue = z.infer<typeof PageBlockItemSingleSelectValue>;
+export type PageBlockItemStorybookValue = z.infer<typeof PageBlockItemStorybookValue>;
+export type PageBlockItemTableValue = z.infer<typeof PageBlockItemTableValue>;
+export type PageBlockItemTextValue = z.infer<typeof PageBlockItemTextValue>;
+export type PageBlockItemTokenValue = z.infer<typeof PageBlockItemTokenValue>;
+export type PageBlockItemTokenPropertyValue = z.infer<typeof PageBlockItemTokenPropertyValue>;
+export type PageBlockItemTokenTypeValue = z.infer<typeof PageBlockItemTokenTypeValue>;
+export type PageBlockItemUrlValue = z.infer<typeof PageBlockItemUrlValue>;

package/src/helpers/index.ts

@@ -1,4 +1,3 @@
 export * from "./common";
 export * from "./db";
 export * from "./nullish-to-optional";
-export * from "./slug-helper";

package/src/utils/validation.ts

@@ -0,0 +1,4 @@
+// Consists of lowercased letters, digits and hyphens.
+// Can not start or end with hyphen.
+// Warning: does not forbid consecutive hyphens
+export const slugRegex = /^[a-z0-9][a-z0-9-]*[a-z0-9]$/;

package/src/workspace/workspace-create.ts

@@ -1,7 +1,7 @@
 import { z } from "zod";
 import { UserInvites } from "./user-invite";
-import { SLUG_REGEX } from "../helpers";
 import { ProductCodeSchema } from "../billing";
+import { slugRegex } from "../utils/validation";
 
 const WORKSPACE_NAME_MIN_LENGTH: number = 2;
 const WORKSPACE_NAME_MAX_LENGTH: number = 64;
@@ -15,7 +15,7 @@ export const CreateWorkspaceInput = z.object({
   billingEmail: z.string().email().optional(),
   handle: z
     .string()
-    .regex(SLUG_REGEX)
+    .regex(slugRegex)
     .min(HANDLE_MIN_LENGTH)
     .max(HANDLE_MAX_LENGTH)
     .refine(value => value?.length > 0)

package/index.ts

@@ -1 +0,0 @@
-export * from './src';