@supernova-studio/model 0.4.1 → 0.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supernova-studio/model",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "Supernova Data Models",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,7 +25,8 @@
     "build": "tsup",
     "typecheck": "tsc --noEmit",
     "publish": "npm run build && npm publish",
-    "test:unit": "vitest run"
+    "test:unit": "vitest run",
+    "index": "node ./create-indexes.js"
   },
   "author": "",
   "license": "ISC",

package/src/dsm/elements/data/base.ts

@@ -1,4 +1,4 @@
-import { ZodSchema, z } from "zod";
+import { ZodSchema, ZodTypeDef, z } from "zod";
 
 export const TokenDataAliasSchema = z.object({
   aliasTo: z
@@ -8,11 +8,11 @@ export const TokenDataAliasSchema = z.object({
     .transform(v => v ?? undefined),
 });
 
-export function tokenAliasOrValue<T extends ZodSchema>(value: T) {
+export function tokenAliasOrValue<I, O>(value: ZodSchema<I, ZodTypeDef, O>) {
   return TokenDataAliasSchema.extend({
     value: value
       .optional()
       .nullable()
-      .transform(v => (v ?? undefined) as z.output<T> | undefined),
+      .transform(v => (v ?? undefined) as z.output<typeof value> | undefined),
   });
 }

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

@@ -181,6 +181,7 @@ export const PageBlockItemTextValue = z.object({
 export const PageBlockItemTokenValue = z.object({
   selectedPropertyIds: z.array(z.string()).optional(),
   selectedThemeIds: z.array(z.string()).optional(),
+  themeDisplayMode: z.enum(["Split", "Override"]).optional(),
   value: z.array(
     z.object({
       entityId: z.string(),

package/src/dsm/elements/data/documentation.ts

@@ -1,8 +1,9 @@
 import { z } from "zod";
+import { DocumentationItemHeader } from "./item-header";
 
 export const DocumentationItemConfiguration = z.object({
   showSidebar: z.boolean(),
-  header: z.any(),
+  header: DocumentationItemHeader,
 });
 
 export type DocumentationItemConfiguration = z.infer<typeof DocumentationItemConfiguration>;

package/src/dsm/elements/data/index.ts

@@ -19,12 +19,15 @@ export * from "./font-size";
 export * from "./font-weight";
 export * from "./gradient";
 export * from "./group";
+export * from "./item-header";
 export * from "./letter-spacing";
 export * from "./line-height";
 export * from "./opacity";
+export * from "./page-asset";
 export * from "./paragraph-indent";
 export * from "./paragraph-spacing";
 export * from "./product-copy";
+export * from "./safe-id";
 export * from "./shadow";
 export * from "./size";
 export * from "./space";

package/src/dsm/elements/data/item-header.ts

@@ -0,0 +1,49 @@
+import { z } from "zod";
+import { DocumentationPageAsset } from "./page-asset";
+import { ColorTokenData } from "./color";
+
+//
+// Consts
+//
+
+export const colorValueRegex = /^#[a-f0-9]{8}$/;
+export const colorValueFormatDescription = "Must match /^#[a-f0-9]{8}$/";
+
+//
+// Enums
+//
+
+export const DocumentationItemHeaderAlignmentSchema = z.enum(["Left", "Center"]);
+export const DocumentationItemHeaderImageScaleTypeSchema = z.enum(["AspectFill", "AspectFit"]);
+
+export const DocumentationItemHeaderAlignment = DocumentationItemHeaderAlignmentSchema.enum;
+export const DocumentationItemHeaderImageScaleType = DocumentationItemHeaderImageScaleTypeSchema.enum;
+
+export type DocumentationItemHeaderImageScaleType = z.infer<typeof DocumentationItemHeaderImageScaleTypeSchema>;
+export type DocumentationItemHeaderAlignment = z.infer<typeof DocumentationItemHeaderAlignmentSchema>;
+
+//
+// Definitions
+//
+
+export const DocumentationItemHeader = z.object({
+  description: z.string(),
+  alignment: DocumentationItemHeaderAlignmentSchema,
+  foregroundColor: ColorTokenData.nullish(),
+  backgroundColor: ColorTokenData.nullish(),
+  backgroundImageAsset: DocumentationPageAsset.nullish(),
+  backgroundImageScaleType: DocumentationItemHeaderImageScaleTypeSchema,
+  showBackgroundOverlay: z.boolean(),
+  showCoverText: z.boolean(),
+  minHeight: z.number().nullish(),
+});
+
+export type DocumentationItemHeader = z.infer<typeof DocumentationItemHeader>;
+
+export const defaultDocumentationItemHeader: DocumentationItemHeader = {
+  alignment: DocumentationItemHeaderAlignment.Left,
+  backgroundImageScaleType: DocumentationItemHeaderImageScaleType.AspectFill,
+  description: "",
+  showBackgroundOverlay: false,
+  showCoverText: true,
+};

package/src/dsm/elements/data/page-asset.ts

@@ -0,0 +1,27 @@
+import { z } from "zod";
+import { SafeIdSchema } from "./safe-id";
+import { PageBlockFrame } from "./documentation-block-v1";
+
+export const DocumentationPageAssetType = z.enum(["image", "figmaFrame"]);
+export type DocumentationPageAssetType = z.infer<typeof DocumentationPageAssetType>;
+
+export const DocumentationPageImageAsset = z.object({
+  type: z.literal(DocumentationPageAssetType.Enum.image),
+  url: z.string().url().optional(),
+  id: SafeIdSchema,
+});
+
+export const DocumentationPageFrameAsset = z.object({
+  type: z.literal(DocumentationPageAssetType.Enum.figmaFrame),
+  url: z.string().url().optional(),
+  figmaFrame: PageBlockFrame,
+});
+
+export const DocumentationPageAsset = z.discriminatedUnion("type", [
+  DocumentationPageImageAsset,
+  DocumentationPageFrameAsset,
+]);
+
+export type DocumentationPageImageAsset = z.infer<typeof DocumentationPageImageAsset>;
+export type DocumentationPageFrameAsset = z.infer<typeof DocumentationPageFrameAsset>;
+export type DocumentationPageAsset = z.infer<typeof DocumentationPageAsset>;

package/src/dsm/elements/data/safe-id.ts

@@ -0,0 +1,13 @@
+import { z } from "zod";
+
+const RESERVED_OBJECT_ID_PREFIX = "x-sn-reserved-";
+
+// Really only checks if the schema does not have the reserved prefix
+export const SafeIdSchema = z.string().refine(
+  value => {
+    return !value.startsWith(RESERVED_OBJECT_ID_PREFIX);
+  },
+  {
+    message: `ID value can't start with ${RESERVED_OBJECT_ID_PREFIX}`,
+  }
+);

package/src/dsm/elements/documentation-page-v1.ts

@@ -14,17 +14,3 @@ export type DocumentationPageV1 = z.infer<typeof DocumentationPageV1>;
 
 export type CreateDocumentationPageV1 = DbCreateInputOmit<DocumentationPageV1>;
 export type UpdateDocumentationPageV1 = OmitStrict<DbUpdate<DocumentationPageV1>, "designSystemVersionId">;
-
-export const DocumentationPageDTOV1 = DocumentationPageV1.omit({
-  data: true,
-  meta: true,
-  parentPersistentId: true,
-  sortOrder: true,
-})
-  .extend(DocumentationPageV1.shape.data.shape)
-  .extend({
-    title: z.string(),
-    path: z.string(),
-  });
-
-export type DocumentationPageDTOV1 = z.infer<typeof DocumentationPageDTOV1>;

package/src/dsm/elements/group.ts

@@ -5,6 +5,7 @@ import { DbCreateInputOmit, DbUpdate } from "../../helpers";
 import { OmitStrict } from "../../helpers";
 import { DocumentationGroupBehavior, ElementGroupData } from "./data";
 import { DocumentationItemConfiguration } from "./data";
+
 export const ElementGroup = DesignElementBase.extend(DesignElementGroupablePart.shape)
   .extend(DesignElementSlugPart.shape)
   .extend(DesignElementBrandedPart.partial().shape)
@@ -34,26 +35,3 @@ export type ElementGroupsDiff = {
   toUpdate: UpdateElementGroup[];
   toDelete: ElementGroup["id"][];
 };
-
-//
-// DTO
-//
-
-export const DocumentationGroupDTO = ElementGroup.omit({
-  sortOrder: true,
-  parentPersistentId: true,
-  brandPersistentId: true,
-  meta: true,
-  childType: true,
-  data: true,
-  shortPersistentId: true,
-}).extend({
-  title: z.string(),
-  isRoot: z.boolean(),
-  childrenIds: z.array(z.string()),
-  groupBehavior: DocumentationGroupBehavior,
-  configuration: DocumentationItemConfiguration,
-  shortPersistentId: z.string(),
-});
-
-export type DocumentationGroupDTO = z.infer<typeof DocumentationGroupDTO>;

package/src/dsm/elements/raw-element.ts

@@ -43,7 +43,7 @@ export const DesignTokenType = z.enum([
   "Font",
 ]);
 
-export const tokenElementTypes: ReadonlyArray<DesignTokenType> = [...DesignTokenType.options.filter(v => v !== "Font")];
+export const tokenElementTypes: DesignTokenType[] = [...DesignTokenType.options.filter(v => v !== "Font")];
 
 export type DesignTokenType = z.infer<typeof DesignTokenType>;
 
@@ -118,8 +118,8 @@ export const DesignElement = ShallowDesignElement.extend({
   createdAt: z.date(),
   updatedAt: z.date(),
   exportProperties: DesignSystemElementExportProps.optional(),
-  data: z.any(), // TODO this should be an object, not any.
-  origin: z.any().optional(), // TODO object, not any.
+  data: z.record(z.any()),
+  origin: z.record(z.any()).optional(),
 });
 
 export type ShallowDesignElement = z.infer<typeof ShallowDesignElement>;

package/src/helpers/nullish-to-optional.ts

@@ -1,9 +1,9 @@
-import { ZodType, z } from "zod";
+import { ZodType, ZodTypeDef, z } from "zod";
 
 /**
  * Allows both null and undefined as input values in addition to the actual value,
  * but coerces them both to undefined.
  */
-export function nullishToOptional<T>(type: ZodType<T>) {
+export function nullishToOptional<I, O>(type: ZodType<I, ZodTypeDef, O>) {
   return type.nullish().transform(t => t ?? undefined);
 }

package/src/multiplayer/index.ts

@@ -1,2 +1,3 @@
 export * from "./design-system-version-room";
 export * from "./documentation-page-room";
+export * from "./room-type";

package/src/multiplayer/room-type.ts

@@ -0,0 +1,10 @@
+import { z } from "zod";
+
+export enum RoomTypeEnum {
+  DocumentationPage = "documentation-page",
+  DesignSystemVersion = "design-system-version",
+}
+export const RoomTypeSchema = z.nativeEnum(RoomTypeEnum);
+
+export type RoomType = z.infer<typeof RoomTypeSchema>;
+export const RoomType = RoomTypeSchema.enum;

package/src/utils/index.ts

@@ -1 +1,2 @@
 export * from "./content-loader-instruction";
+export * from "./validation";