@supernova-studio/client 0.57.9 → 0.57.11

package/package.json

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

package/src/api/dto/collections/index.ts

@@ -1 +1 @@
-export * from "./collection";
+export * from "./token-collection";

package/src/api/dto/collections/{collection.ts → token-collection.ts}

@@ -1,4 +1,4 @@
-import { ObjectMeta } from "@supernova-studio/model";
+import { CollectionOrigin, ColorTokenInlineData, ObjectMeta } from "@supernova-studio/model";
 import { z } from "zod";
 
 export const DTOTokenCollection = z.object({
@@ -7,14 +7,13 @@ export const DTOTokenCollection = z.object({
   designSystemVersionId: z.string(),
 
   meta: ObjectMeta,
+  backgroundColor: ColorTokenInlineData.optional(),
+  elementPropertyOptionId: z.string(),
 
   createdAt: z.coerce.date(),
   updatedAt: z.coerce.date(),
 
-  origin: z.object({
-    id: z.string(),
-    sourceId: z.string(),
-  }),
+  origin: CollectionOrigin.optional(),
 });
 
 export const DTOTokenCollectionsListReponse = z.object({

package/src/api/dto/elements/properties/property-definitions-actions-v2.ts

@@ -1,9 +1,9 @@
 import { z } from "zod";
 import {
-  DTOCreateElementPropertyDefinitionInputV2,
-  DTODeleteElementPropertyDefinitionInputV2,
   DTOElementPropertyDefinition,
-  DTOUpdateElementPropertyDefinitionInputV2,
+  DTOElementPropertyDefinitionCreatePayload,
+  DTOElementPropertyDefinitionDeletePayload,
+  DTOElementPropertyDefinitionUpdatePayload,
 } from "./property-definitions";
 
 // Outputs
@@ -35,17 +35,17 @@ export type DTOPropertyDefinitionDeleteActionOutputV2 = z.infer<typeof DTOProper
 
 export const DTOPropertyDefinitionCreateActionInputV2 = z.object({
   type: z.literal("PropertyDefinitionCreate"),
-  input: DTOCreateElementPropertyDefinitionInputV2,
+  input: DTOElementPropertyDefinitionCreatePayload,
 });
 
 export const DTOPropertyDefinitionUpdateActionInputV2 = z.object({
   type: z.literal("PropertyDefinitionUpdate"),
-  input: DTOUpdateElementPropertyDefinitionInputV2,
+  input: DTOElementPropertyDefinitionUpdatePayload,
 });
 
 export const DTOPropertyDefinitionDeleteActionInputV2 = z.object({
   type: z.literal("PropertyDefinitionDelete"),
-  input: DTODeleteElementPropertyDefinitionInputV2,
+  input: DTOElementPropertyDefinitionDeletePayload,
 });
 
 export type DTOPropertyDefinitionCreateActionInputV2 = z.infer<typeof DTOPropertyDefinitionCreateActionInputV2>;

package/src/api/dto/elements/properties/property-definitions.ts

@@ -3,6 +3,7 @@ import {
   ElementPropertyLinkType,
   ElementPropertyTargetType,
   ElementPropertyTypeSchema,
+  nullishToOptional,
   ObjectMeta,
 } from "@supernova-studio/model";
 import { z } from "zod";
@@ -18,8 +19,8 @@ export const DTOElementPropertyDefinition = z.object({
   type: ElementPropertyTypeSchema,
   targetElementType: ElementPropertyTargetType,
   codeName: z.string().regex(CODE_NAME_REGEX),
-  options: z.array(ElementPropertyDefinitionOption).optional(),
-  linkElementType: ElementPropertyLinkType.optional(),
+  options: nullishToOptional(z.array(ElementPropertyDefinitionOption)),
+  linkElementType: nullishToOptional(ElementPropertyLinkType),
 });
 
 export type DTOElementPropertyDefinition = z.infer<typeof DTOElementPropertyDefinition>;
@@ -28,24 +29,27 @@ export type DTOElementPropertyDefinition = z.infer<typeof DTOElementPropertyDefi
 // Read
 //
 
-export const DTOElementPropertyDefinitionsGetResponse = z.object({
+export const DTOElementPropertyDefinitionListResponse = z.object({
   definitions: z.array(DTOElementPropertyDefinition),
 });
 
-export type DTOElementPropertyDefinitionsGetResponse = z.infer<typeof DTOElementPropertyDefinitionsGetResponse>;
+export const DTOElementPropertyDefinitionResponse = z.object({
+  definition: DTOElementPropertyDefinition,
+});
+
+export type DTOElementPropertyDefinitionListResponse = z.infer<typeof DTOElementPropertyDefinitionListResponse>;
+export type DTOElementPropertyDefinitionResponse = z.infer<typeof DTOElementPropertyDefinitionResponse>;
 
 //
 // Write
 //
 
-export const DTOCreateElementPropertyDefinitionInputV2 = DTOElementPropertyDefinition.omit({
+export const DTOElementPropertyDefinitionCreatePayload = DTOElementPropertyDefinition.omit({
   id: true,
   designSystemVersionId: true,
 });
 
-export type DTOCreateElementPropertyDefinitionInputV2 = z.infer<typeof DTOCreateElementPropertyDefinitionInputV2>;
-
-export const DTOUpdateElementPropertyDefinitionInputV2 = z.object({
+export const DTOElementPropertyDefinitionUpdatePayload = z.object({
   id: z.string(),
   name: z.string().optional(),
   description: z.string().optional(),
@@ -53,10 +57,10 @@ export const DTOUpdateElementPropertyDefinitionInputV2 = z.object({
   options: z.array(ElementPropertyDefinitionOption).optional(),
 });
 
-export type DTOUpdateElementPropertyDefinitionInputV2 = z.infer<typeof DTOUpdateElementPropertyDefinitionInputV2>;
-
-export const DTODeleteElementPropertyDefinitionInputV2 = z.object({
+export const DTOElementPropertyDefinitionDeletePayload = z.object({
   id: z.string(),
 });
 
-export type DTODeleteElementPropertyDefinitionInputV2 = z.infer<typeof DTODeleteElementPropertyDefinitionInputV2>;
+export type DTOElementPropertyDefinitionCreatePayload = z.infer<typeof DTOElementPropertyDefinitionCreatePayload>;
+export type DTOElementPropertyDefinitionUpdatePayload = z.infer<typeof DTOElementPropertyDefinitionUpdatePayload>;
+export type DTOElementPropertyDefinitionDeletePayload = z.infer<typeof DTOElementPropertyDefinitionDeletePayload>;

package/src/api/dto/elements/properties/property-values.ts

@@ -1,5 +1,9 @@
 import { z } from "zod";
 
+//
+// Read
+//
+
 export const DTOElementPropertyValue = z.object({
   id: z.string(),
   designSystemVersionId: z.string(),
@@ -9,9 +13,26 @@ export const DTOElementPropertyValue = z.object({
   valuePreview: z.string().optional(),
 });
 
-export const DTOElementPropertyValuesGetResponse = z.object({
+export const DTOElementPropertyValueListResponse = z.object({
   values: z.array(DTOElementPropertyValue),
 });
 
+export const DTOElementPropertyValueResponse = z.object({
+  value: DTOElementPropertyValue,
+});
+
 export type DTOElementPropertyValue = z.infer<typeof DTOElementPropertyValue>;
-export type DTOElementPropertyValuesGetResponse = z.infer<typeof DTOElementPropertyValuesGetResponse>;
+export type DTOElementPropertyValueListResponse = z.infer<typeof DTOElementPropertyValueListResponse>;
+export type DTOElementPropertyValueResponse = z.infer<typeof DTOElementPropertyValueResponse>;
+
+//
+// Create
+//
+
+export const DTOElementPropertyValueUpsertPaylod = z.object({
+  definitionId: z.string(),
+  targetElementId: z.string(),
+  value: z.string().or(z.number()).or(z.boolean()),
+});
+
+export type DTOElementPropertyValueUpsertPaylod = z.infer<typeof DTOElementPropertyValueUpsertPaylod>;

package/src/api/endpoints/design-system/design-systems.ts

@@ -5,7 +5,7 @@ import { RequestExecutor } from "../../transport/request-executor";
 import { DesignSystemBffEndpoint } from "./bff";
 import { DesignSystemMembersEndpoint } from "./members";
 import { DesignSystemSourcesEndpoint } from "./sources";
-import { DesignSystemVersionsEndpoint } from "./versions";
+import { DesignSystemVersionsEndpoint } from "./versions/versions";
 
 export class DesignSystemsEndpoint {
   readonly members: DesignSystemMembersEndpoint;

package/src/api/endpoints/design-system/index.ts

@@ -3,4 +3,3 @@ export * from "./bff";
 export * from "./design-systems";
 export * from "./members";
 export * from "./sources";
-export * from "./versions";

package/src/api/endpoints/design-system/versions/index.ts

@@ -1,6 +1,10 @@
 export * from "./brands";
 export * from "./import-jobs";
 export * from "./overrides";
+export * from "./property-definitions";
+export * from "./property-values";
 export * from "./stats";
 export * from "./themes";
+export * from "./token-collections";
 export * from "./tokens";
+export * from "./versions";

package/src/api/endpoints/design-system/versions/property-definitions.ts

@@ -0,0 +1,25 @@
+import {
+  DTOElementPropertyDefinitionCreatePayload,
+  DTOElementPropertyDefinitionListResponse,
+  DTOElementPropertyDefinitionResponse,
+} from "../../../dto";
+import { RequestExecutor } from "../../../transport/request-executor";
+
+export class ElementPropertyDefinitionsEndpoint {
+  constructor(private readonly requestExecutor: RequestExecutor) {}
+
+  list(designSystemId: string, versionId: string) {
+    return this.requestExecutor.json(
+      `/design-systems/${designSystemId}/versions/${versionId}/element-properties/definitions`,
+      DTOElementPropertyDefinitionListResponse
+    );
+  }
+
+  create(designSystemId: string, versionId: string, body: DTOElementPropertyDefinitionCreatePayload) {
+    return this.requestExecutor.json(
+      `/design-systems/${designSystemId}/versions/${versionId}/element-properties/definitions`,
+      DTOElementPropertyDefinitionResponse,
+      { method: "POST", body }
+    );
+  }
+}

package/src/api/endpoints/design-system/versions/property-values.ts

@@ -0,0 +1,25 @@
+import {
+  DTOElementPropertyValueListResponse,
+  DTOElementPropertyValueResponse,
+  DTOElementPropertyValueUpsertPaylod,
+} from "../../../dto";
+import { RequestExecutor } from "../../../transport/request-executor";
+
+export class ElementPropertyValuesEndpoint {
+  constructor(private readonly requestExecutor: RequestExecutor) {}
+
+  list(designSystemId: string, versionId: string) {
+    return this.requestExecutor.json(
+      `/design-systems/${designSystemId}/versions/${versionId}/element-properties/values`,
+      DTOElementPropertyValueListResponse
+    );
+  }
+
+  upsert(designSystemId: string, versionId: string, body: DTOElementPropertyValueUpsertPaylod) {
+    return this.requestExecutor.json(
+      `/design-systems/${designSystemId}/versions/${versionId}/element-properties/values`,
+      DTOElementPropertyValueResponse,
+      { method: "POST", body }
+    );
+  }
+}

package/src/api/endpoints/design-system/versions/token-collections.ts

@@ -0,0 +1,13 @@
+import { DTOTokenCollectionsListReponse } from "../../../dto";
+import { RequestExecutor } from "../../../transport/request-executor";
+
+export class TokenCollectionsEndpoint {
+  constructor(private readonly requestExecutor: RequestExecutor) {}
+
+  list(designSystemId: string, versionId: string) {
+    return this.requestExecutor.json(
+      `/design-systems/${designSystemId}/versions/${versionId}/token-collections`,
+      DTOTokenCollectionsListReponse
+    );
+  }
+}

package/src/api/endpoints/design-system/versions/versions.ts

@@ -0,0 +1,36 @@
+import { DTODesignSystemVersionsListResponse } from "../../../dto";
+import { RequestExecutor } from "../../../transport/request-executor";
+import { BrandsEndpoint } from "./brands";
+import { ImportJobsEndpoint } from "./import-jobs";
+import { ElementPropertyDefinitionsEndpoint } from "./property-definitions";
+import { ElementPropertyValuesEndpoint } from "./property-values";
+import { VersionStatsEndpoint } from "./stats";
+import { ThemesEndpoint } from "./themes";
+import { TokenCollectionsEndpoint } from "./token-collections";
+import { TokensEndpoint } from "./tokens";
+
+export class DesignSystemVersionsEndpoint {
+  readonly themes: ThemesEndpoint;
+  readonly brands: BrandsEndpoint;
+  readonly tokenCollections: TokenCollectionsEndpoint;
+  readonly importJobs: ImportJobsEndpoint;
+  readonly tokens: TokensEndpoint;
+  readonly stats: VersionStatsEndpoint;
+  readonly elementPropertyDefinitions: ElementPropertyDefinitionsEndpoint;
+  readonly elementPropertyValues: ElementPropertyValuesEndpoint;
+
+  constructor(private readonly requestExecutor: RequestExecutor) {
+    this.themes = new ThemesEndpoint(requestExecutor);
+    this.brands = new BrandsEndpoint(requestExecutor);
+    this.tokenCollections = new TokenCollectionsEndpoint(requestExecutor);
+    this.importJobs = new ImportJobsEndpoint(requestExecutor);
+    this.tokens = new TokensEndpoint(requestExecutor);
+    this.stats = new VersionStatsEndpoint(requestExecutor);
+    this.elementPropertyDefinitions = new ElementPropertyDefinitionsEndpoint(requestExecutor);
+    this.elementPropertyValues = new ElementPropertyValuesEndpoint(requestExecutor);
+  }
+
+  list(dsId: string) {
+    return this.requestExecutor.json(`/design-systems/${dsId}/versions`, DTODesignSystemVersionsListResponse);
+  }
+}

package/src/api/endpoints/index.ts

@@ -1,5 +1,4 @@
 export * from "./codegen";
 export * from "./design-system";
 export * from "./workspaces";
-export * from "./token-collections";
 export * from "./users";

package/src/api/endpoints/design-system/versions.ts

@@ -1,27 +0,0 @@
-import { DTODesignSystemVersionsListResponse } from "../../dto";
-import { RequestExecutor } from "../../transport/request-executor";
-import { BrandsEndpoint } from "./versions/brands";
-import { ImportJobsEndpoint } from "./versions/import-jobs";
-import { VersionStatsEndpoint } from "./versions/stats";
-import { ThemesEndpoint } from "./versions/themes";
-import { TokensEndpoint } from "./versions/tokens";
-
-export class DesignSystemVersionsEndpoint {
-  readonly themes: ThemesEndpoint;
-  readonly brands: BrandsEndpoint;
-  readonly importJobs: ImportJobsEndpoint;
-  readonly tokens: TokensEndpoint;
-  readonly stats: VersionStatsEndpoint;
-
-  constructor(private readonly requestExecutor: RequestExecutor) {
-    this.themes = new ThemesEndpoint(requestExecutor);
-    this.brands = new BrandsEndpoint(requestExecutor);
-    this.importJobs = new ImportJobsEndpoint(requestExecutor);
-    this.tokens = new TokensEndpoint(requestExecutor);
-    this.stats = new VersionStatsEndpoint(requestExecutor);
-  }
-
-  list(dsId: string) {
-    return this.requestExecutor.json(`/design-systems/${dsId}/versions`, DTODesignSystemVersionsListResponse);
-  }
-}

package/src/api/endpoints/token-collections.ts

@@ -1,13 +0,0 @@
-import { DTOTokenCollectionsListReponse } from "../dto";
-import { RequestExecutor } from "../transport/request-executor";
-
-export class TokenCollectionsEndpoint {
-  constructor(private readonly requestExecutor: RequestExecutor) {}
-
-  list(dsId: string, vId: string) {
-    return this.requestExecutor.json(
-      `/design-systems/${dsId}/versions/${vId}/token-collections`,
-      DTOTokenCollectionsListReponse
-    );
-  }
-}