@supernova-studio/model 0.57.9 → 0.57.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supernova-studio/model",
-  "version": "0.57.9",
+  "version": "0.57.11",
   "description": "Supernova Data Models",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/dsm/collection.ts

@@ -0,0 +1,49 @@
+import { z } from "zod";
+import { DbCreateInputOmit, DbUpdate } from "../helpers";
+import { OmitStrict } from "../utils";
+import { ColorTokenInlineData } from "./properties";
+
+export const CollectionOrigin = z.object({
+  id: z.string(),
+  sourceId: z.string(),
+});
+
+export const Collection = z.object({
+  id: z.string(),
+  persistentId: z.string(),
+
+  designSystemVersionId: z.string(),
+
+  name: z.string(),
+  description: z.string(),
+  backgroundColor: ColorTokenInlineData.optional(),
+
+  /**
+   * ID of Select element property definition's option that corresponds to this collection.
+   *
+   * Each collection is represented by an option in a special kind of element property that
+   * is present in each design system where a collections are present. The property is maintained
+   * automatically and is not available to the user (see immutable element properties).
+   *
+   * Collections have an immutable element property that allows bridging places where element properites
+   * can be selected (e.g. documentation blocks) with the concept of collection without having to add
+   * specific logic for collection selection.
+   */
+  elementPropertyOptionId: z.string(),
+
+  createdAt: z.coerce.date(),
+  updatedAt: z.coerce.date(),
+
+  origin: CollectionOrigin.optional(),
+});
+
+export type CollectionOrigin = z.infer<typeof CollectionOrigin>;
+export type Collection = z.infer<typeof Collection>;
+
+export type CreateCollection = OmitStrict<DbCreateInputOmit<Collection>, "elementPropertyOptionId">;
+export type UpdateCollection = OmitStrict<
+  DbUpdate<Collection>,
+  "designSystemVersionId" | "origin" | "elementPropertyOptionId"
+> & {
+  origin?: Partial<CollectionOrigin>;
+};

package/src/dsm/import/collection.ts

@@ -0,0 +1,16 @@
+import { z } from "zod";
+import { CollectionOrigin } from "../collection";
+
+export const CollectionImportModelInput = z.object({
+  id: z.string(),
+  name: z.string(),
+});
+
+export const CollectionImportModel = z.object({
+  id: z.string(),
+  name: z.string(),
+  origin: CollectionOrigin,
+});
+
+export type CollectionImportModelInput = z.infer<typeof CollectionImportModelInput>;
+export type CollectionImportModel = z.infer<typeof CollectionImportModel>;

package/src/dsm/import/index.ts

@@ -1,6 +1,7 @@
 export * from "./support";
 export * from "./asset";
 export * from "./base";
+export * from "./collection";
 export * from "./component";
 export * from "./data-source";
 export * from "./figma-frames";

package/src/dsm/import/support/import-model-collections.ts

@@ -1,4 +1,5 @@
 import { z } from "zod";
+import { CollectionImportModel, CollectionImportModelInput } from "../collection";
 import { AssetImportModelInput, FigmaComponentImportModel, FigmaComponentImportModelInput } from "../component";
 import { DataSourceImportModel } from "../data-source";
 import { FigmaFileStructureImportModel, FigmaFileStructureImportModelInput } from "../figma-frames";
@@ -17,6 +18,7 @@ export const ImportModelInputCollection = z.object({
   themeUpdates: z.array(ThemeUpdateImportModelInput).default([]),
   themes: z.array(ThemeImportModelInput).default([]),
   figmaFileStructure: FigmaFileStructureImportModelInput.optional(),
+  collections: z.array(CollectionImportModelInput),
 });
 
 export const ImportModelCollection = z.object({
@@ -26,6 +28,7 @@ export const ImportModelCollection = z.object({
   themeUpdates: z.array(ThemeUpdateImportModel).default([]),
   themes: z.array(ThemeImportModel).default([]),
   figmaFileStructures: z.array(FigmaFileStructureImportModel),
+  collections: z.array(CollectionImportModel),
 });
 
 export type ImportModelCollection = z.infer<typeof ImportModelCollection>;
@@ -42,5 +45,6 @@ export function addImportModelCollections(
     themeUpdates: [...lhs.themeUpdates, ...rhs.themeUpdates],
     themes: [...lhs.themes, ...rhs.themes],
     figmaFileStructures: [...lhs.figmaFileStructures, ...rhs.figmaFileStructures],
+    collections: [...lhs.collections, ...rhs.collections],
   };
 }

package/src/dsm/index.ts

@@ -9,6 +9,7 @@ export * from "./membership";
 export * from "./properties";
 export * from "./views";
 export * from "./brand";
+export * from "./collection";
 export * from "./design-system";
 export * from "./exporter-property-values-collection";
 export * from "./published-doc-page";