@supernova-studio/client 0.58.7 → 0.58.9

package/package.json

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

package/src/api/dto/design-systems/data-source.ts

@@ -10,6 +10,12 @@ import {
 } from "@supernova-studio/model";
 import { z } from "zod";
 
+//
+// Read
+//
+
+export const DTODataSourceFigmaScope = DataSourceFigmaScope;
+
 const DTODataSourceFigmaFileVersion = z.object({
   id: z.string(),
   created_at: z.coerce.date(),
@@ -36,7 +42,7 @@ export const DTODataSourceFigma = z.object({
   id: z.string(),
   type: z.literal(DataSourceRemoteType.Enum.Figma),
   fileName: z.string(),
-  scope: DataSourceFigmaScope,
+  scope: DTODataSourceFigmaScope,
   brandId: z.string(),
   themeId: z.string().nullish(),
   cloud: DTODataSourceFigmaCloud.nullish(),
@@ -104,7 +110,7 @@ export const DTODataSourcesListResponse = z.object({
   sources: z.array(DTODataSource),
 });
 
-export const DTODataSourceCreationResponse = z.object({
+export const DTODataSourceResponse = z.object({
   source: DTODataSource,
 });
 
@@ -112,5 +118,24 @@ export type DTODataSourceFigma = z.infer<typeof DTODataSourceFigma>;
 export type DTODataSourceTokenStudio = z.infer<typeof DTODataSourceTokenStudio>;
 export type DTODataSourceFigmaVariablesPlugin = z.infer<typeof DTODataSourceFigmaVariablesPlugin>;
 export type DTODataSource = z.infer<typeof DTODataSource>;
-export type DTODataSourceCreationResponse = z.infer<typeof DTODataSourceCreationResponse>;
+export type DTODataSourceResponse = z.infer<typeof DTODataSourceResponse>;
 export type DTODataSourcesListResponse = z.infer<typeof DTODataSourcesListResponse>;
+
+//
+// Write
+//
+
+export const DTODataSourceFigmaCreatePayload = z.object({
+  brandPersistentId: z.string(),
+  figmaFileUrl: z.string(),
+  scope: DTODataSourceFigmaScope,
+  autoImportMode: DataSourceAutoImportMode,
+});
+
+export const DTODataSourceFigmaImportPayload = z.object({
+  sourceIds: z.array(z.string()),
+});
+
+export type DTODataSourceFigmaScope = z.infer<typeof DTODataSourceFigmaScope>;
+export type DTODataSourceFigmaCreatePayload = z.infer<typeof DTODataSourceFigmaCreatePayload>;
+export type DTODataSourceFigmaImportPayload = z.infer<typeof DTODataSourceFigmaImportPayload>;

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

@@ -1,10 +1,23 @@
 import { z } from "zod";
-import { DTODataSourcesListResponse } from "../../dto";
+import {
+  DTODataSourceFigmaCreatePayload,
+  DTODataSourceFigmaImportPayload,
+  DTODataSourceResponse,
+  DTODataSourcesListResponse,
+  DTOImportJobResponse,
+} from "../../dto";
 import { RequestExecutor } from "../../transport/request-executor";
 
 export class DesignSystemSourcesEndpoint {
   constructor(private readonly requestExecutor: RequestExecutor) {}
 
+  create(dsId: string, payload: DTODataSourceFigmaCreatePayload) {
+    return this.requestExecutor.json(`/design-systems/${dsId}/sources`, DTODataSourceResponse, {
+      method: "POST",
+      body: payload,
+    });
+  }
+
   list(dsId: string) {
     return this.requestExecutor.json(`/design-systems/${dsId}/sources`, DTODataSourcesListResponse);
   }
@@ -12,4 +25,11 @@ export class DesignSystemSourcesEndpoint {
   delete(dsId: string, sourceId: string) {
     return this.requestExecutor.json(`/design-systems/${dsId}/sources/${sourceId}`, z.any(), { method: "DELETE" });
   }
+
+  figmaImport(dsId: string, payload: DTODataSourceFigmaImportPayload) {
+    return this.requestExecutor.json(`/design-systems/${dsId}/versions/head/cloud-import`, DTOImportJobResponse, {
+      method: "POST",
+      body: payload,
+    });
+  }
 }

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

@@ -0,0 +1,23 @@
+import { DTODocumentationStructure, DTODocumentationStructureItem, DTOImportJobResponse } from "../../../dto";
+import { RequestExecutor } from "../../../transport/request-executor";
+
+export class DocumentationEndpoint {
+  constructor(private readonly requestExecutor: RequestExecutor) {}
+
+  getStructure(designSystemId: string, versionId: string) {
+    return this.requestExecutor.json(
+      `/design-systems/${designSystemId}/versions/${versionId}/documentation/structure`,
+      DTODocumentationStructure
+    );
+  }
+
+  async getDocStructure(dsId: string, vId: string) {
+    return await this.requestExecutor.json(
+      `/design-systems/${dsId}/versions/${vId}/documentation/structure`,
+      DTODocumentationStructure,
+      {
+        method: "GET",
+      }
+    );
+  }
+}

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

@@ -0,0 +1,98 @@
+import {
+  DTOCreateDocumentationGroupInput,
+  DTOCreateDocumentationPageInputV2,
+  DTOCreateDocumentationTabInput,
+  DTOElementActionOutput,
+  DTOMoveDocumentationGroupInput,
+  DTOUpdateDocumentationGroupInput,
+  DTOUpdateDocumentationPageInputV2,
+} from "../../../dto";
+import { RequestExecutor } from "../../../transport/request-executor";
+
+export class ElementsActionEndpoint {
+  constructor(private readonly requestExecutor: RequestExecutor) {}
+
+  async createDocPage(dsId: string, vId: string, input: DTOCreateDocumentationPageInputV2) {
+    return this.requestExecutor.json(
+      `/design-systems/${dsId}/versions/${vId}/elements-action`,
+      DTOElementActionOutput,
+      {
+        body: {
+          type: "DocumentationPageCreate",
+          input,
+        },
+        method: "POST",
+      }
+    );
+  }
+
+  async createDocGroup(dsId: string, vId: string, input: DTOCreateDocumentationGroupInput) {
+    return this.requestExecutor.json(
+      `/design-systems/${dsId}/versions/${vId}/elements-action`,
+      DTOElementActionOutput,
+      {
+        body: {
+          type: "DocumentationGroupCreate",
+          input,
+        },
+        method: "POST",
+      }
+    );
+  }
+
+  async moveDocGroup(dsId: string, vId: string, input: DTOMoveDocumentationGroupInput) {
+    return this.requestExecutor.json(
+      `/design-systems/${dsId}/versions/${vId}/elements-action`,
+      DTOElementActionOutput,
+      {
+        body: {
+          type: "DocumentationGroupMove",
+          input,
+        },
+        method: "POST",
+      }
+    );
+  }
+
+  async updateDocPage(dsId: string, vId: string, input: DTOUpdateDocumentationPageInputV2) {
+    return this.requestExecutor.json(
+      `/design-systems/${dsId}/versions/${vId}/elements-action`,
+      DTOElementActionOutput,
+      {
+        body: {
+          type: "DocumentationPageUpdate",
+          input,
+        },
+        method: "POST",
+      }
+    );
+  }
+
+  async updateDocGroup(dsId: string, vId: string, input: DTOUpdateDocumentationGroupInput) {
+    return this.requestExecutor.json(
+      `/design-systems/${dsId}/versions/${vId}/elements-action`,
+      DTOElementActionOutput,
+      {
+        body: {
+          type: "DocumentationGroupUpdate",
+          input,
+        },
+        method: "POST",
+      }
+    );
+  }
+
+  async createDocTab(dsId: string, vId: string, input: DTOCreateDocumentationTabInput) {
+    return this.requestExecutor.json(
+      `/design-systems/${dsId}/versions/${vId}/elements-action`,
+      DTOElementActionOutput,
+      {
+        body: {
+          type: "DocumentationTabCreate",
+          input,
+        },
+        method: "POST",
+      }
+    );
+  }
+}

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

@@ -1,6 +1,7 @@
 export * from "./brands";
 export * from "./components";
-export * from "./elements-actions";
+export * from "./documentation";
+export * from "./elements-action";
 export * from "./import-jobs";
 export * from "./overrides";
 export * from "./property-definitions";

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

@@ -7,7 +7,8 @@ import { DTOCreateVersionInput } from "../../../payloads";
 import { RequestExecutor } from "../../../transport/request-executor";
 import { BrandsEndpoint } from "./brands";
 import { DesignSystemComponentEndpoint } from "./components";
-import { ElementsActionsEndpoint } from "./elements-actions";
+import { DocumentationEndpoint } from "./documentation";
+import { ElementsActionEndpoint } from "./elements-action";
 import { ImportJobsEndpoint } from "./import-jobs";
 import { ElementPropertyDefinitionsEndpoint } from "./property-definitions";
 import { ElementPropertyValuesEndpoint } from "./property-values";
@@ -27,8 +28,9 @@ export class DesignSystemVersionsEndpoint {
   readonly stats: VersionStatsEndpoint;
   readonly elementPropertyDefinitions: ElementPropertyDefinitionsEndpoint;
   readonly elementPropertyValues: ElementPropertyValuesEndpoint;
-  readonly elementsActions: ElementsActionsEndpoint;
+  readonly elementsAction: ElementsActionEndpoint;
   readonly designSystemComponents: DesignSystemComponentEndpoint;
+  readonly documentation: DocumentationEndpoint;
 
   constructor(private readonly requestExecutor: RequestExecutor) {
     this.themes = new ThemesEndpoint(requestExecutor);
@@ -40,8 +42,9 @@ export class DesignSystemVersionsEndpoint {
     this.stats = new VersionStatsEndpoint(requestExecutor);
     this.elementPropertyDefinitions = new ElementPropertyDefinitionsEndpoint(requestExecutor);
     this.elementPropertyValues = new ElementPropertyValuesEndpoint(requestExecutor);
-    this.elementsActions = new ElementsActionsEndpoint(requestExecutor);
+    this.elementsAction = new ElementsActionEndpoint(requestExecutor);
     this.designSystemComponents = new DesignSystemComponentEndpoint(requestExecutor);
+    this.documentation = new DocumentationEndpoint(requestExecutor);
   }
 
   list(dsId: string) {

package/src/api/endpoints/workspaces/workspaces.ts

@@ -3,6 +3,7 @@ import { DTOWorkspaceCreateInput, DTOWorkspaceResponse } from "../../dto";
 import { RequestExecutor } from "../../transport/request-executor";
 import { WorkspaceInvitationsEndpoint } from "./workspace-invites";
 import { WorkspaceMembersEndpoint } from "./workspace-members";
+import { DTOTransferOwnershipPayload } from "../../payloads";
 
 // TODO Response types
 export class WorkspacesEndpoint {
@@ -36,4 +37,11 @@ export class WorkspacesEndpoint {
   subscription(workspaceId: string) {
     return this.requestExecutor.json(`/workspaces/${workspaceId}/subscription`, z.any(), { method: "GET" });
   }
+
+  transferOwnership(workspaceId: string, body: DTOTransferOwnershipPayload) {
+    return this.requestExecutor.json(`/workspaces/${workspaceId}/ownership`, DTOWorkspaceResponse, {
+      method: "PUT",
+      body,
+    });
+  }
 }

package/src/api/payloads/workspaces/index.ts

@@ -1,2 +1,3 @@
+export * from "./transfer-ownership";
 export * from "./workspace-configuration";
 export * from "./workspace-integrations";

package/src/api/payloads/workspaces/transfer-ownership.ts

@@ -0,0 +1,7 @@
+import { z } from "zod";
+
+export const DTOTransferOwnershipPayload = z.object({
+  newOwnerId: z.string(),
+});
+
+export type DTOTransferOwnershipPayload = z.infer<typeof DTOTransferOwnershipPayload>;

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

@@ -1,20 +0,0 @@
-import { DTOCreateDocumentationPageInputV2, DTOElementActionOutput } from "../../../dto";
-import { RequestExecutor } from "../../../transport/request-executor";
-
-export class ElementsActionsEndpoint {
-  constructor(private readonly requestExecutor: RequestExecutor) {}
-
-  async createDocPage(dsId: string, vId: string, input: DTOCreateDocumentationPageInputV2) {
-    return this.requestExecutor.json(
-      `/design-systems/${dsId}/versions/${vId}/elements-action`,
-      DTOElementActionOutput,
-      {
-        body: {
-          type: "DocumentationPageCreate",
-          input,
-        },
-        method: "POST",
-      }
-    );
-  }
-}