@supernova-studio/client 0.55.16 → 0.55.17

package/package.json

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

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

@@ -0,0 +1,25 @@
+import { ObjectMeta } from "@supernova-studio/model";
+import { z } from "zod";
+
+export const DTOTokenCollection = z.object({
+  id: z.string(),
+  persistentId: z.string(),
+  designSystemVersionId: z.string(),
+
+  meta: ObjectMeta,
+
+  createdAt: z.coerce.date(),
+  updatedAt: z.coerce.date(),
+
+  origin: z.object({
+    id: z.string(),
+    sourceId: z.string(),
+  }),
+});
+
+export const DTOTokenCollectionsListReponse = z.object({
+  collections: DTOTokenCollection.array(),
+});
+
+export type DTOTokenCollection = z.infer<typeof DTOTokenCollection>;
+export type DTOTokenCollectionsListReponse = z.infer<typeof DTOTokenCollectionsListReponse>;

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

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

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

@@ -1,6 +1,7 @@
 import { DesignSystem, DesignSystemAccessMode, ObjectMeta, WorkspaceRoleSchema } from "@supernova-studio/model";
 import { z } from "zod";
 import { DTODesignSystemMembersUpdatePayload } from "./members";
+import { DTODesignSystemRole } from "./role";
 
 //
 // Read
@@ -21,7 +22,16 @@ export const DTODesignSystem = DesignSystem.omit({
    */
   isAvailableToUser: z.boolean(),
 
+  /**
+   * @deprecated
+   */
   role: WorkspaceRoleSchema.optional(),
+
+  /**
+   * User's role within the design system that can come either from
+   * the design system or workspace.
+   */
+  effectiveRole: DTODesignSystemRole.optional(),
 });
 
 export const DTODesignSystemResponse = z.object({

package/src/api/dto/design-systems/index.ts

@@ -4,5 +4,6 @@ export * from "./design-system";
 export * from "./elements-diff";
 export * from "./exporter-property";
 export * from "./members";
+export * from "./role";
 export * from "./version";
 export * from "./view";

package/src/api/dto/design-systems/members.ts

@@ -1,5 +1,6 @@
 import { DesignSystemMembershipUpdates } from "@supernova-studio/model";
 import { z } from "zod";
+import { DTODesignSystemRole } from "./role";
 
 //
 // Read
@@ -7,11 +8,23 @@ import { z } from "zod";
 
 export const DTODesignSystemMember = z.object({
   userId: z.string(),
+
+  /**
+   * Role that the member has in the design system,
+   * undefined if set to inherit from workspace
+   */
+  designSystemRole: DTODesignSystemRole.optional(),
 });
 
 export const DTODesignSystemInvitation = z.object({
   id: z.string(),
   workspaceInvitationId: z.string(),
+
+  /**
+   * Role that the invitation has in the design system,
+   * undefined if set to inherit from workspace
+   */
+  designSystemRole: DTODesignSystemRole.optional(),
 });
 
 export const DTODesignSystemMemberListResponse = z.object({

package/src/api/dto/design-systems/role.ts

@@ -0,0 +1,11 @@
+import { WorkspaceRole } from "@supernova-studio/model";
+import { z } from "zod";
+
+export const DTODesignSystemRole = z.enum([
+  WorkspaceRole.Admin,
+  WorkspaceRole.Contributor,
+  WorkspaceRole.Creator,
+  WorkspaceRole.Viewer,
+]);
+
+export type DTODesignSystemRole = z.infer<typeof DTODesignSystemRole>;

package/src/api/dto/index.ts

@@ -1,5 +1,6 @@
 export * from "./aux";
 export * from "./bff";
+export * from "./collections";
 export * from "./design-systems";
 export * from "./documentation";
 export * from "./elements";

package/src/api/endpoints/index.ts

@@ -1,6 +1,7 @@
 export * from "./design-system-members";
 export * from "./design-system-versions";
 export * from "./design-systems";
+export * from "./token-collections";
 export * from "./users";
 export * from "./workspace-invites";
 export * from "./workspace-members";

package/src/api/endpoints/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(dsId: string, vId: string) {
+    return this.requestExecutor.json(
+      `/design-systems/${dsId}/versions/${vId}/token-collections`,
+      DTOTokenCollectionsListReponse
+    );
+  }
+}