@supernova-studio/client 0.55.33 → 0.55.34

package/package.json

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

package/src/api/dto/design-systems/import-job.ts

@@ -0,0 +1,60 @@
+import {
+  DataSourceAutoImportMode,
+  DataSourceFigmaScope,
+  DataSourceRemoteType,
+  ImportJobState,
+} from "@supernova-studio/model";
+import { z } from "zod";
+
+//
+// Read
+//
+
+export const DTOImportJob = z.object({
+  id: z.string(),
+  designSystemId: z.string(),
+  designSystemVersionId: z.string(),
+  operation: z.literal("Import"),
+  createdAt: z.coerce.date(),
+  stateChangedAt: z.coerce.date(),
+  state: ImportJobState,
+  sourceIds: z.string().array(),
+});
+
+export const DTOImportJobResponse = z.object({
+  job: DTOImportJob,
+});
+
+export type DTOImportJob = z.infer<typeof DTOImportJob>;
+export type DTOImportJobResponse = z.infer<typeof DTOImportJobResponse>;
+
+//
+// Write
+//
+
+export const DTOBffFigmaImportRequestBody = z.object({
+  type: z.literal(DataSourceRemoteType.Enum.Figma),
+  brandPersistentId: z.string().optional(),
+  fileId: z.string(),
+  scope: DataSourceFigmaScope,
+  autoImportMode: DataSourceAutoImportMode,
+});
+
+export const DTOBffUploadImportRequestBody = z.object({
+  type: z
+    .enum([DataSourceRemoteType.Enum.FigmaVariablesPlugin, "Upload"])
+    .transform(v => DataSourceRemoteType.Enum.FigmaVariablesPlugin),
+  brandPersistentId: z.string().optional(),
+  sourceName: z.string().optional(),
+  remoteId: z.string(),
+  payload: z.any(),
+});
+
+export const DTOBffImportRequestBody = z.discriminatedUnion("type", [
+  DTOBffFigmaImportRequestBody,
+  DTOBffUploadImportRequestBody,
+]);
+
+export type DTOBffFigmaImportRequestBody = z.infer<typeof DTOBffFigmaImportRequestBody>;
+export type DTOBffUploadImportRequestBody = z.infer<typeof DTOBffUploadImportRequestBody>;
+export type DTOBffImportRequestBody = z.infer<typeof DTOBffImportRequestBody>;

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

@@ -3,6 +3,7 @@ export * from "./data-source";
 export * from "./design-system";
 export * from "./elements-diff";
 export * from "./exporter-property";
+export * from "./import-job";
 export * from "./members";
 export * from "./role";
 export * from "./stats";

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

@@ -0,0 +1,13 @@
+import { DTOBffImportRequestBody, DTOImportJobResponse } from "../../dto";
+import { RequestExecutor } from "../../transport/request-executor";
+
+export class DesignSystemBffEndpoint {
+  constructor(private readonly requestExecutor: RequestExecutor) {}
+
+  import(dsId: string, payload: DTOBffImportRequestBody) {
+    return this.requestExecutor.json(`/design-systems/${dsId}/bff/import`, DTOImportJobResponse, {
+      method: "POST",
+      body: payload,
+    });
+  }
+}

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

@@ -2,17 +2,19 @@ import { z } from "zod";
 import { DTODesignSystemCreateInput, DTODesignSystemResponse, DTODesignSystemsListResponse } from "../../dto";
 import { DTODesignSystemUpdateAccessModeInput, DTODesignSystemUpdateInput } from "../../payloads";
 import { RequestExecutor } from "../../transport/request-executor";
-import { DesignSystemMembersEndpoint } from "./design-system-members";
-import { DesignSystemVersionsEndpoint } from "./design-system-versions";
-import { TokensEndpoint } from "./versions";
+import { DesignSystemBffEndpoint } from "./bff";
+import { DesignSystemMembersEndpoint } from "./members";
+import { DesignSystemVersionsEndpoint } from "./versions";
 
 export class DesignSystemsEndpoint {
   readonly members: DesignSystemMembersEndpoint;
   readonly versions: DesignSystemVersionsEndpoint;
+  readonly bff: DesignSystemBffEndpoint;
 
   constructor(private readonly requestExecutor: RequestExecutor) {
     this.members = new DesignSystemMembersEndpoint(requestExecutor);
     this.versions = new DesignSystemVersionsEndpoint(requestExecutor);
+    this.bff = new DesignSystemBffEndpoint(requestExecutor);
   }
 
   create(body: DTODesignSystemCreateInput) {

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

@@ -1,4 +1,5 @@
 export * from "./versions";
-export * from "./design-system-members";
-export * from "./design-system-versions";
+export * from "./bff";
 export * from "./design-systems";
+export * from "./members";
+export * from "./versions";

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

@@ -1,4 +1,4 @@
-import { z } from "zod";
+import { DTOBrandGetResponse, DTOBrandsListResponse } from "../../../dto";
 import { RequestExecutor } from "../../../transport/request-executor";
 
 export class BrandsEndpoint {
@@ -7,11 +7,14 @@ export class BrandsEndpoint {
   get(designSystemId: string, versionId: string, brandId: string) {
     return this.requestExecutor.json(
       `/design-systems/${designSystemId}/versions/${versionId}/brands/${brandId}`,
-      z.any()
+      DTOBrandGetResponse
     );
   }
 
   list(designSystemId: string, versionId: string) {
-    return this.requestExecutor.json(`/design-systems/${designSystemId}/versions/${versionId}/brands`, z.any());
+    return this.requestExecutor.json(
+      `/design-systems/${designSystemId}/versions/${versionId}/brands`,
+      DTOBrandsListResponse
+    );
   }
 }

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

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

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

@@ -1,4 +1,5 @@
 export * from "./brands";
+export * from "./import-jobs";
 export * from "./overrides";
 export * from "./stats";
 export * from "./themes";

package/src/api/endpoints/design-system/{design-system-versions.ts → versions.ts}

@@ -1,18 +1,22 @@
 import { DTODesignSystemVersionsListResponse } from "../../dto";
 import { RequestExecutor } from "../../transport/request-executor";
-import { TokensEndpoint, VersionStatsEndpoint } from "./versions";
 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);
   }