@supernova-studio/model 0.0.8 → 0.2.2

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,14 +1,19 @@
 import { z } from "zod";
 import { ColorValue } from "./color";
-import { PageBlockCalloutType } from "./documentation-block-v1";
+import { PageBlockCalloutType, PageBlockText } from "./documentation-block-v1";
+import { Size } from "../primitives";
 
 //
 // 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
@@ -18,16 +23,56 @@ export const PageBlockAppearanceV2 = z.object({
   itemBackgroundColor: ColorValue,
 });
 
-export const PageBlockItemPropertyValue = z.object({
-  value: z.any(),
+export const PageBlockItemUntypedPropertyValue = z
+  .object({
+    value: z.any(),
+  })
+  .and(z.record(z.any()));
+
+export const PageBlockItemRichTextPropertyValue = z.object({
+  value: PageBlockText,
   calloutType: PageBlockCalloutType.optional(),
 });
 
+export const PageBlockItemEmbedPropertyValue = z.object({
+  value: z.string().optional(),
+  caption: z.string().optional(),
+  height: z.number().optional(),
+});
+
+export const PageBlockItemMultiRichTextPropertyValue = z.object({
+  value: PageBlockText.array(),
+});
+
+export const PageBlockItemTextPropertyValue = z.object({
+  value: z.string(),
+  calloutType: PageBlockCalloutType.optional(),
+});
+
+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 PageBlockItemImageValue = z.object({
+  alt: z.string().optional(),
+  caption: z.string().optional(),
+  alignment: PageBlockImageAlignment.optional(),
+  value: PageBlockItemImageReference.optional(),
+});
+
 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 +80,7 @@ export const PageBlockLinkV2 = z.object({
 export const PageBlockItemV2 = z.object({
   id: z.string(),
   linksTo: PageBlockLinkV2.optional(),
-  props: z.record(PageBlockItemPropertyValue),
+  props: z.record(PageBlockItemUntypedPropertyValue),
 });
 
 export const PageBlockDataV2 = z.object({
@@ -47,7 +92,14 @@ export const PageBlockDataV2 = z.object({
 });
 
 export type PageBlockAppearanceV2 = z.infer<typeof PageBlockAppearanceV2>;
-export type PageBlockItemPropertyValue = z.infer<typeof PageBlockItemPropertyValue>;
+export type PageBlockItemUntypedPropertyValue = z.infer<typeof PageBlockItemUntypedPropertyValue>;
+export type PageBlockItemRichTextPropertyValue = z.infer<typeof PageBlockItemRichTextPropertyValue>;
+export type PageBlockItemMultiRichTextPropertyValue = z.infer<typeof PageBlockItemMultiRichTextPropertyValue>;
+export type PageBlockItemTextPropertyValue = z.infer<typeof PageBlockItemTextPropertyValue>;
+export type PageBlockItemEmbedPropertyValue = z.infer<typeof PageBlockItemEmbedPropertyValue>;
+export type PageBlockItemImageValue = z.infer<typeof PageBlockItemImageValue>;
+export type PageBlockItemImageReference = z.infer<typeof PageBlockItemImageReference>;
+
 export type PageBlockLinkV2 = z.infer<typeof PageBlockLinkV2>;
 export type PageBlockItemV2 = z.infer<typeof PageBlockItemV2>;
 export type PageBlockDataV2 = z.infer<typeof PageBlockDataV2>;

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';