@supernova-studio/client 0.23.0 → 0.25.0

package/package.json

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

package/src/api/dto/elements/documentation/group.ts

@@ -52,7 +52,7 @@ export const DTOCreateDocumentationGroupInput = z.object({
 
 export const DTOUpdateDocumentationGroupInput = z.object({
   // Identifier of the group to update
-  id: z.string().uuid(),
+  id: z.string(),
 
   // Group properties
   title: z.string().optional(),
@@ -61,7 +61,7 @@ export const DTOUpdateDocumentationGroupInput = z.object({
 
 export const DTOMoveDocumentationGroupInput = z.object({
   // Identifier of the group to update
-  id: z.string().uuid(),
+  id: z.string(),
 
   // Group placement properties
   parentPersistentId: z.string().uuid(),

package/src/api/dto/elements/elements-action-v2.ts

@@ -27,7 +27,7 @@ import {
   DTODocumentationTabGroupDeleteActionInputV2,
   DTODocumentationTabGroupDeleteActionOutputV2,
 } from "./documentation/group-action";
-import { DTOFigmaNodeActionInput, DTOFigmaNodeActionOutput } from "./figma-nodes/node-actions-v2";
+import { DTOFigmaNodeRenderActionInput, DTOFigmaNodeRenderActionOutput } from "./figma-nodes/node-actions-v2";
 
 //
 // Read
@@ -51,7 +51,7 @@ export const DTOElementActionOutput = z.discriminatedUnion("type", [
   DTODocumentationTabGroupDeleteActionOutputV2,
 
   // // Figma frames
-  DTOFigmaNodeActionOutput,
+  DTOFigmaNodeRenderActionOutput,
 ]);
 
 export type DTOElementActionOutput = z.infer<typeof DTOElementActionOutput>;
@@ -78,7 +78,7 @@ export const DTOElementActionInput = z.discriminatedUnion("type", [
   DTODocumentationTabGroupDeleteActionInputV2,
 
   // Figma frames
-  DTOFigmaNodeActionInput,
+  DTOFigmaNodeRenderActionInput,
 ]);
 
 export type DTOElementActionInput = z.infer<typeof DTOElementActionInput>;

package/src/api/dto/elements/figma-nodes/figma-node.ts

@@ -35,7 +35,7 @@ export type DTOFigmaNode = z.infer<typeof DTOFigmaNode>;
 // Write
 //
 
-export const DTOFigmaNodeCreateInput = z.object({
+export const DTOFigmaNodeRenderInput = z.object({
   // Id of a design system's data source representing a linked Figma file
   sourceId: z.string(),
 
@@ -43,4 +43,4 @@ export const DTOFigmaNodeCreateInput = z.object({
   figmaFileNodeId: z.string(),
 });
 
-export type DTOFigmaNodeCreateInput = z.infer<typeof DTOFigmaNodeCreateInput>;
+export type DTOFigmaNodeRenderInput = z.infer<typeof DTOFigmaNodeRenderInput>;

package/src/api/dto/elements/figma-nodes/node-actions-v2.ts

@@ -1,24 +1,24 @@
 import { z } from "zod";
-import { DTOFigmaNode, DTOFigmaNodeCreateInput } from "./figma-node";
+import { DTOFigmaNode, DTOFigmaNodeRenderInput } from "./figma-node";
 
 //
 // Read
 //
 
-export const DTOFigmaNodeActionOutput = z.object({
+export const DTOFigmaNodeRenderActionOutput = z.object({
   type: z.literal("FigmaNodeRender"),
   figmaNodes: z.array(DTOFigmaNode),
 });
 
-export type DTOFigmaNodeActionOutput = z.infer<typeof DTOFigmaNodeActionOutput>;
+export type DTOFigmaNodeRenderActionOutput = z.infer<typeof DTOFigmaNodeRenderActionOutput>;
 
 //
 // Read
 //
 
-export const DTOFigmaNodeActionInput = z.object({
+export const DTOFigmaNodeRenderActionInput = z.object({
   type: z.literal("FigmaNodeRender"),
-  input: DTOFigmaNodeCreateInput.array(),
+  input: DTOFigmaNodeRenderInput.array(),
 });
 
-export type DTOFigmaNodeActionInput = z.infer<typeof DTOFigmaNodeActionInput>;
+export type DTOFigmaNodeRenderActionInput = z.infer<typeof DTOFigmaNodeRenderActionInput>;

package/src/api/dto/elements/get-elements-v2.ts

@@ -5,10 +5,10 @@ import { DTOFigmaNode } from "./figma-nodes";
 // Read
 //
 
-export const DTOElementGetTypeFilter = z.enum(["FigmaNode"]);
+export const DTOElementsGetTypeFilter = z.enum(["FigmaNode"]);
 
-export const DTOElementGetQuerySchema = z.object({
-  types: z.string().transform(val => val.split(",").map(v => DTOElementGetTypeFilter.parse(v))),
+export const DTOElementsGetQuerySchema = z.object({
+  types: z.string().transform(val => val.split(",").map(v => DTOElementsGetTypeFilter.parse(v))),
 });
 
 export const DTOElementsGetOutput = z.object({
@@ -16,6 +16,6 @@ export const DTOElementsGetOutput = z.object({
 });
 
 export type DTOElementsGetOutput = z.infer<typeof DTOElementsGetOutput>;
-export type DTOElementGetQueryRaw = z.input<typeof DTOElementGetQuerySchema>;
-export type DTOElementGetQueryParsed = z.output<typeof DTOElementGetQuerySchema>;
-export type DTOElementGetTypeFilter = z.infer<typeof DTOElementGetTypeFilter>;
+export type DTOElementsGetQueryRaw = z.input<typeof DTOElementsGetQuerySchema>;
+export type DTOElementsGetQueryParsed = z.output<typeof DTOElementsGetQuerySchema>;
+export type DTOElementsGetTypeFilter = z.infer<typeof DTOElementsGetTypeFilter>;

package/src/api/dto/index.ts

@@ -1,3 +1,4 @@
 export * from "./design-systems";
 export * from "./documentation";
 export * from "./elements";
+export * from "./workspaces";

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

@@ -0,0 +1,3 @@
+export * from "./membership";
+export * from "./npm-registry";
+export * from "./workspace";

package/src/api/dto/workspaces/membership.ts

@@ -0,0 +1,29 @@
+import { z } from "zod";
+import { DTOWorkspace } from "./workspace";
+
+//
+// Read
+//
+
+export const DTOWorkspaceRole = z.enum(["Owner", "Admin", "Creator", "Viewer", "Billing"]);
+
+export const DTOUserWorkspaceMembership = z.object({
+  // Workspace the user is a member of
+  workspace: DTOWorkspace,
+
+  // Assigned role the user has in the workspace
+  role: DTOWorkspaceRole,
+
+  // Role that determines actual permissions the user has in the workspace
+  // E.g. this is different from the default role when editors are downgraded to viewers
+  // when a workspace's subscription is downgraded to free tier
+  effectiveRole: DTOWorkspaceRole,
+});
+
+export const DTOUserWorkspaceMembershipsResponse = z.object({
+  membership: z.array(DTOUserWorkspaceMembership),
+});
+
+export type DTOWorkspaceRole = z.infer<typeof DTOWorkspaceRole>;
+export type DTOUserWorkspaceMembership = z.infer<typeof DTOUserWorkspaceMembership>;
+export type DTOUserWorkspaceMembershipsResponse = z.infer<typeof DTOUserWorkspaceMembershipsResponse>;

package/src/api/dto/workspaces/npm-registry.ts

@@ -0,0 +1,31 @@
+import { NpmRegistryAuthType, NpmRegistryType } from "@supernova-studio/model";
+import { z } from "zod";
+
+//
+// Read
+//
+
+export const DTONpmRegistryConfig = z.object({
+  // Registry basic configuration
+  registryType: NpmRegistryType,
+  registryUrl: z.string(),
+  customRegistryUrl: z.string().optional(),
+
+  // URL of Supernova NPM packages proxy
+  proxyUrl: z.string(),
+
+  // Auth configuration
+  authType: NpmRegistryAuthType,
+  accessToken: z.literal("redacted").optional(),
+  username: z.string().optional(),
+  password: z.literal("redacted").optional(),
+
+  // NPM package scopes for whih the proxy should be enabled
+  enabledScopes: z.array(z.string()),
+
+  // True if client should bypass Supernova proxy and connect directly to the registry
+  // (e.g. when the NPM registry is behind a VPN or firewall which prevents Supernova from accessing it)
+  bypassProxy: z.boolean(),
+});
+
+export type DTONpmRegistryConfig = z.infer<typeof DTONpmRegistryConfig>;

package/src/api/dto/workspaces/workspace.ts

@@ -0,0 +1,16 @@
+import { Subscription, WorkspaceProfile } from "@supernova-studio/model";
+import { z } from "zod";
+import { DTONpmRegistryConfig } from "./npm-registry";
+
+//
+// Read
+//
+
+export const DTOWorkspace = z.object({
+  id: z.string(),
+  profile: WorkspaceProfile,
+  subscription: Subscription,
+  npmRegistry: DTONpmRegistryConfig.optional(),
+});
+
+export type DTOWorkspace = z.infer<typeof DTOWorkspace>;

package/src/yjs/docs-editor/blocks-to-prosemirror.ts

@@ -15,6 +15,7 @@ import {
   PageBlockItemTableRow,
   PageBlockDefinitionRichTextOptions,
   PageBlockDefinitionMutiRichTextOptions,
+  PageBlockItemImageValue,
 } from "@supernova-studio/model";
 import { PageBlockEditorModel } from "./model/block";
 import { ProsemirrorNode, ProsemirrorMark } from "./prosemirror/types";
@@ -354,6 +355,10 @@ function serializeTableNode(node: PageBlockItemTableNode): ProsemirrorNode {
     case "RichText":
       return {
         type: "paragraph",
+        attrs: {
+          id: node.id,
+          definitionId: "io.supernova.block.rich-text",
+        },
         ...serializeRichTextNodePart(node.value),
       };
 
@@ -361,7 +366,18 @@ function serializeTableNode(node: PageBlockItemTableNode): ProsemirrorNode {
       return {
         type: "image",
         attrs: {
-          src: node.value?.resource?.url,
+          id: node.id,
+          definitionId: "io.supernova.block.image",
+          items: JSON.stringify([
+            {
+              id: node.id,
+              props: {
+                image: {
+                  value: node.value,
+                } satisfies PageBlockItemImageValue,
+              },
+            },
+          ]),
         },
       };
   }