@supernova-studio/client 0.58.10 → 0.58.11

package/package.json

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

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

@@ -1,5 +1,10 @@
-import { z } from "zod";
 import { ObjectMeta } from "@supernova-studio/model";
+import { z } from "zod";
+import { DTOObjectMeta } from "../aux";
+
+//
+// Read
+//
 
 export const DTOBrand = z.object({
   id: z.string(),
@@ -20,3 +25,20 @@ export type DTOBrand = z.infer<typeof DTOBrand>;
 export type DTOBrandGetResponse = z.infer<typeof DTOBrandGetResponse>;
 export type DTOBrandCreateResponse = z.infer<typeof DTOBrandCreateResponse>;
 export type DTOBrandsListResponse = z.infer<typeof DTOBrandsListResponse>;
+
+//
+// Write
+//
+
+export const DTOBrandCreatePayload = z.object({
+  persistentId: z.string().uuid(),
+  meta: DTOObjectMeta,
+});
+
+export const DTOBrandUpdatePayload = z.object({
+  meta: DTOObjectMeta.optional(),
+  persistentId: z.string(),
+});
+
+export type DTOBrandCreatePayload = z.infer<typeof DTOBrandCreatePayload>;
+export type DTOBrandUpdatePayload = z.infer<typeof DTOBrandUpdatePayload>;

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

@@ -1,10 +1,40 @@
-import { ObjectMeta } from "@supernova-studio/model";
 import { z } from "zod";
+import { DTOObjectMeta } from "../aux";
+
+//
+// Read
+//
+
+export const DTODesignSystemComponent = z.object({
+  id: z.string(),
+  persistentId: z.string(),
+  designSystemVersionId: z.string(),
+  brandId: z.string(),
+  meta: DTOObjectMeta,
+  createdAt: z.coerce.date(),
+  updatedAt: z.coerce.date(),
+});
+
+export const DTODesignSystemComponentResponse = z.object({
+  designSystemComponent: DTODesignSystemComponent,
+});
+
+export const DTODesignSystemComponentListResponse = z.object({
+  designSystemComponents: DTODesignSystemComponent.array(),
+});
+
+export type DTODesignSystemComponent = z.infer<typeof DTODesignSystemComponent>;
+export type DTODesignSystemComponentResponse = z.infer<typeof DTODesignSystemComponentResponse>;
+export type DTODesignSystemComponentListResponse = z.infer<typeof DTODesignSystemComponentListResponse>;
+
+//
+// Write
+//
 
 export const DTODesignSystemComponentCreateInput = z.object({
   brandId: z.string(), // Persistent ID,
   persistentId: z.string(),
-  meta: ObjectMeta,
+  meta: DTOObjectMeta,
 });
 
 export type DTODesignSystemComponentCreateInput = z.infer<typeof DTODesignSystemComponentCreateInput>;

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

@@ -1,5 +1,5 @@
-import { DTOBrandGetResponse, DTOBrandsListResponse } from "../../../dto";
-import { DTOCreateBrandInput } from "../../../payloads";
+import { z } from "zod";
+import { DTOBrandCreatePayload, DTOBrandGetResponse, DTOBrandsListResponse, DTOBrandUpdatePayload } from "../../../dto";
 import { RequestExecutor } from "../../../transport/request-executor";
 
 export class BrandsEndpoint {
@@ -19,7 +19,7 @@ export class BrandsEndpoint {
     );
   }
 
-  create(designSystemId: string, versionId: string, body: DTOCreateBrandInput) {
+  create(designSystemId: string, versionId: string, body: DTOBrandCreatePayload) {
     return this.requestExecutor.json(
       `/design-systems/${designSystemId}/versions/${versionId}/brands`,
       DTOBrandGetResponse,
@@ -29,4 +29,17 @@ export class BrandsEndpoint {
       }
     );
   }
+
+  update(dsId: string, vId: string, brandId: string, body: DTOBrandUpdatePayload) {
+    return this.requestExecutor.json(`/design-systems/${dsId}/versions/${vId}/brands/${brandId}`, DTOBrandGetResponse, {
+      method: "PUT",
+      body,
+    });
+  }
+
+  delete(dsId: string, vId: string, brandId: string) {
+    return this.requestExecutor.json(`/design-systems/${dsId}/versions/${vId}/brands/${brandId}`, z.any(), {
+      method: "DELETE",
+    });
+  }
 }

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

@@ -1,15 +1,28 @@
-import { DTOElementActionOutput } from "../../../dto";
+import {
+  DTODesignSystemComponentCreateInput,
+  DTODesignSystemComponentListResponse,
+  DTODesignSystemComponentResponse,
+} from "../../../dto/design-systems/component";
 import { RequestExecutor } from "../../../transport/request-executor";
-import { DTODesignSystemComponentCreateInput } from "../../../dto/design-systems/component";
-import { z } from "zod";
 
 export class DesignSystemComponentEndpoint {
   constructor(private readonly requestExecutor: RequestExecutor) {}
 
+  async list(dsId: string, vId: string) {
+    return this.requestExecutor.json(
+      `/design-systems/${dsId}/versions/${vId}/design-system-components`,
+      DTODesignSystemComponentListResponse
+    );
+  }
+
   async create(dsId: string, vId: string, body: DTODesignSystemComponentCreateInput) {
-    return this.requestExecutor.json(`/design-systems/${dsId}/versions/${vId}/design-system-components`, z.any(), {
-      body,
-      method: "POST",
-    });
+    return this.requestExecutor.json(
+      `/design-systems/${dsId}/versions/${vId}/design-system-components`,
+      DTODesignSystemComponentResponse,
+      {
+        body,
+        method: "POST",
+      }
+    );
   }
 }

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

@@ -1,3 +1,2 @@
-export * from "./brand";
 export * from "./update-design-system";
 export * from "./version";

package/src/api/transport/request-executor-error.ts

@@ -5,7 +5,7 @@ export type RequestEexecutorServerErrorCode = SupernovaExceptionType | undefined
 
 export class RequestExecutorError extends Error {
   readonly type: RequestExecutorErrorType;
-  readonly errorCode: RequestEexecutorServerErrorCode;
+  readonly errorCode: RequestEexecutorServerErrorCode | undefined;
   readonly serverErrorType: SupernovaExceptionType | undefined;
 
   static tryParseErrorCode(body: string) {

package/src/api/payloads/design-systems/brand.ts

@@ -1,12 +0,0 @@
-import { z } from "zod";
-
-// TODO make sure these are all accurate.
-export const DTOCreateBrandInput = z.object({
-  persistentId: z.string().uuid(),
-  meta: z.object({
-    name: z.string(),
-    description: z.string(),
-  }),
-});
-
-export type DTOCreateBrandInput = z.infer<typeof DTOCreateBrandInput>;