@supernova-studio/client 0.58.19 → 1.0.0-alpha.3

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

@@ -1,47 +0,0 @@
-import { z } from "zod";
-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 {
-  public members: WorkspaceMembersEndpoint;
-  public invitations: WorkspaceInvitationsEndpoint;
-
-  constructor(private readonly requestExecutor: RequestExecutor) {
-    this.members = new WorkspaceMembersEndpoint(requestExecutor);
-    this.invitations = new WorkspaceInvitationsEndpoint(requestExecutor);
-  }
-
-  create(body: DTOWorkspaceCreateInput) {
-    return this.requestExecutor.json("/workspaces", DTOWorkspaceResponse, {
-      method: "POST",
-      body: {
-        ...body,
-        product: "free",
-        priceId: "yearly",
-      },
-    });
-  }
-
-  get(workspaceId: string) {
-    return this.requestExecutor.json(`/workspaces/${workspaceId}`, DTOWorkspaceResponse, { method: "GET" });
-  }
-
-  delete(workspaceId: string) {
-    return this.requestExecutor.json(`/workspaces/${workspaceId}`, z.any(), { method: "DELETE" });
-  }
-
-  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/index.ts

@@ -1,6 +0,0 @@
-export * from "./conversion";
-export * from "./dto";
-export * from "./endpoints";
-export * from "./payloads";
-export * from "./transport";
-export * from "./client";

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

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

package/src/api/payloads/design-systems/update-design-system.ts

@@ -1,29 +0,0 @@
-import { DesignSystem, DesignSystemAccessMode, ObjectMeta } from "@supernova-studio/model";
-import { z } from "zod";
-
-export const DTODesignSystemUpdateInput = DesignSystem.partial()
-  .omit({
-    id: true,
-    workspaceId: true,
-    createdAt: true,
-    updatedAt: true,
-    docSlug: true,
-    docViewUrl: true,
-    accessMode: true,
-  })
-  .extend({
-    meta: ObjectMeta.partial().optional(),
-  });
-
-export const DTODesignSystemUpdateAccessModeInput = z.object({
-  accessMode: DesignSystemAccessMode,
-  retain: z
-    .object({
-      userIds: z.string().array(),
-      inviteIds: z.string().array(),
-    })
-    .optional(),
-});
-
-export type DTODesignSystemUpdateInput = z.infer<typeof DTODesignSystemUpdateInput>;
-export type DTODesignSystemUpdateAccessModeInput = z.infer<typeof DTODesignSystemUpdateAccessModeInput>;

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

@@ -1,29 +0,0 @@
-import { z } from "zod";
-
-export const ObjectMeta = z.object({
-  name: z.string().max(150).optional(),
-  description: z.string().max(2000).optional(),
-});
-
-export function validateDesignSystemVersion(version: string) {
-  const urlCompliantRegex = /^[a-zA-Z0-9+.-]+$/;
-  return urlCompliantRegex.test(version);
-}
-
-export const DTOCreateVersionInput = z.object({
-  meta: ObjectMeta,
-  version: z.string().refine(validateDesignSystemVersion, {
-    message: "Invalid semantic versioning format",
-  }),
-  changeLog: z.string().optional(),
-});
-
-export type DTOCreateVersionInput = z.infer<typeof DTOCreateVersionInput>;
-
-export const DTOUpdateVersionInput = z.object({
-  meta: ObjectMeta,
-  version: z.string(), // required for PUT, but not editable
-  changeLog: z.string(),
-});
-
-export type DTOUpdateVersionInput = z.infer<typeof DTOUpdateVersionInput>;

package/src/api/payloads/documentation/block-definitions.ts

@@ -1,12 +0,0 @@
-import { z } from "zod";
-import { DTOPageBlockDefinition } from "../../dto/documentation/block-definition";
-
-//
-// Read
-//
-
-export const DTOGetBlockDefinitionsOutput = z.object({
-  definitions: z.array(DTOPageBlockDefinition),
-});
-
-export type DTOGetBlockDefinitionsOutput = z.infer<typeof DTOGetBlockDefinitionsOutput>;

package/src/api/payloads/documentation/design-data-doc-diff.ts

@@ -1,7 +0,0 @@
-import { z } from "zod";
-
-export const DTODocumentationPublishTypeQueryParams = z.object({
-  environment: z.enum(["Live", "Preview"]),
-});
-
-export type DTODocumentationPublishTypeQueryParams = z.infer<typeof DTODocumentationPublishTypeQueryParams>;

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

@@ -1,2 +0,0 @@
-export * from "./block-definitions";
-export * from "./design-data-doc-diff";

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

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

package/src/api/payloads/export/pipeline.ts

@@ -1,50 +0,0 @@
-import {
-  ExporterDestinationAzure,
-  ExporterDestinationBitbucket,
-  ExporterDestinationDocs,
-  ExporterDestinationGithub,
-  ExporterDestinationGitlab,
-  ExporterDestinationS3,
-  GitObjectsQuery,
-  PipelineDestinationType,
-  PipelineEventType,
-} from "@supernova-studio/model";
-import { z } from "zod";
-import { DTOExporterPropertyDefinitionValueMap } from "../../dto/export/exporter-property";
-
-export const DTOPipelineCreateBody = z.object({
-  name: z.string(),
-  exporterId: z.string(),
-  designSystemId: z.string(),
-  isEnabled: z.boolean(),
-  eventType: PipelineEventType,
-  brandPersistentId: z.string().optional(),
-  themePersistentId: z.string().optional(),
-  themePersistentIds: z.string().array().optional(),
-
-  exporterConfiguration: DTOExporterPropertyDefinitionValueMap.optional(),
-
-  destination: PipelineDestinationType.optional(),
-  gitQuery: GitObjectsQuery,
-  destinations: z.object({
-    s3: ExporterDestinationS3.nullish(),
-    azure: ExporterDestinationAzure.nullish(),
-    bitbucket: ExporterDestinationBitbucket.nullish(),
-    github: ExporterDestinationGithub.nullish(),
-    gitlab: ExporterDestinationGitlab.nullish(),
-    documentation: ExporterDestinationDocs.nullish(),
-    webhookUrl: z.string().nullish(),
-  }),
-});
-
-export const DTOPipelineUpdateBody = DTOPipelineCreateBody.extend({
-  id: z.string(),
-});
-
-export const DTOPipelineTriggerBody = z.object({
-  designSystemVersionId: z.string(),
-});
-
-export type DTOPipelineCreateBody = z.infer<typeof DTOPipelineCreateBody>;
-export type DTOPipelineUpdateBody = z.infer<typeof DTOPipelineUpdateBody>;
-export type DTOPipelineTriggerBody = z.infer<typeof DTOPipelineTriggerBody>;

package/src/api/payloads/index.ts

@@ -1,6 +0,0 @@
-export * from "./design-systems";
-export * from "./documentation";
-export * from "./export";
-export * from "./liveblocks";
-export * from "./users";
-export * from "./workspaces";

package/src/api/payloads/liveblocks/auth.ts

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

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

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

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

@@ -1,2 +0,0 @@
-export * from "./notifications";
-export * from "./profile";

package/src/api/payloads/users/notifications/index.ts

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

package/src/api/payloads/users/notifications/notification-settings.ts

@@ -1,17 +0,0 @@
-import { UserNotificationSettings } from "@supernova-studio/model";
-import { z } from "zod";
-
-export const DTOUpdateUserNotificationSettingsPayload = z.object({
-    notificationSettings: UserNotificationSettings,
-});
-
-export type DTOUpdateUserNotificationSettingsPayload = z.infer<typeof DTOUpdateUserNotificationSettingsPayload>;
-
-
-export const DTOUserNotificationSettingsResponse = z.object({
-    userId: z.string(),
-    workspaceId: z.string(),
-    notificationSettings: UserNotificationSettings,
-});
-
-export type DTOUserNotificationSettingsResponse = z.infer<typeof DTOUserNotificationSettingsResponse>;

package/src/api/payloads/users/profile/index.ts

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

package/src/api/payloads/users/profile/update.ts

@@ -1,4 +0,0 @@
-import { UserProfileUpdate } from "@supernova-studio/model";
-
-
-export const DTOUserProfileUpdatePayload = UserProfileUpdate;

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

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

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

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

package/src/api/payloads/workspaces/workspace-configuration.ts

@@ -1,50 +0,0 @@
-import { z } from "zod";
-import { SsoProvider, WorkspaceIpSettings, WorkspaceProfile } from "@supernova-studio/model";
-
-const prohibitedSsoKeys = ["providerId", "metadataXml", "emailDomains"];
-
-export function validateSsoPayload(ssoPayload: Partial<SsoProvider> | undefined) {
-  const keys = [];
-  let valid = true;
-  if (!ssoPayload) {
-    valid = true;
-    return {
-      valid,
-      keys: [],
-    };
-  }
-  for (const key of Object.keys(ssoPayload)) {
-    if (prohibitedSsoKeys.includes(key)) {
-      keys.push(key);
-      valid = false;
-    }
-  }
-  return {
-    valid,
-    keys,
-  };
-}
-
-export const NpmRegistryInput = z.object({
-  enabledScopes: z.array(z.string()),
-  customRegistryUrl: z.string().optional(),
-  bypassProxy: z.boolean().optional(),
-  npmProxyRegistryConfigId: z.string().optional(),
-  npmProxyVersion: z.number().optional(),
-  registryType: z.string(),
-  authType: z.string(),
-  authHeaderName: z.string(),
-  authHeaderValue: z.string(),
-  accessToken: z.string(),
-  username: z.string(),
-  password: z.string(),
-});
-
-export const WorkspaceConfigurationPayload = z.object({
-  ipWhitelist: WorkspaceIpSettings.partial().optional(),
-  sso: SsoProvider.partial().optional(),
-  npmRegistrySettings: NpmRegistryInput.partial().optional(),
-  profile: WorkspaceProfile.partial().optional(),
-});
-
-export type WorkspaceConfigurationPayload = z.infer<typeof WorkspaceConfigurationPayload>;

package/src/api/payloads/workspaces/workspace-integrations.ts

@@ -1,26 +0,0 @@
-import { IntegrationToken, IntegrationType } from "@supernova-studio/model";
-import { z } from "zod";
-
-export const DTOWorkspaceIntegrationOauthInput = z.object({
-  type: IntegrationType,
-});
-
-export type DTOWorkspaceIntegrationOauthInput = z.infer<typeof DTOWorkspaceIntegrationOauthInput>;
-
-export const DTOWorkspaceIntegrationPATInput = z.object({
-  userId: z.string(),
-  type: IntegrationType,
-  token: IntegrationToken,
-});
-
-export type DTOWorkspaceIntegrationPATInput = z.infer<typeof DTOWorkspaceIntegrationPATInput>;
-
-export const DTOWorkspaceIntegrationGetGitObjectsInput = z.object({
-  organization: z.string().optional(), // Azure Organization | Bitbucket Workspace slug | Gitlab Group and Sub-Groups | Github Account (User or Organization)
-  project: z.string().optional(), // Only for Bitbucket and Azure
-  repository: z.string().optional(), // For all providers. Pay attention for Gitlab, they call repositories "projects".
-  branch: z.string().optional(), // For all providers, useful for PR creations.
-  user: z.string().optional(), // Only for Gitlab User Repositories
-});
-
-export type DTOWorkspaceIntegrationGetGitObjectsInput = z.infer<typeof DTOWorkspaceIntegrationGetGitObjectsInput>;

package/src/api/transport/index.ts

@@ -1,2 +0,0 @@
-export * from "./request-executor-error";
-export * from "./request-executor";

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

@@ -1,66 +0,0 @@
-import { SupernovaExceptionType } from "@supernova-studio/model";
-
-export type RequestExecutorErrorType = "ServerError" | "ResponseParsingError";
-export type RequestEexecutorServerErrorCode = SupernovaExceptionType | undefined;
-
-export class RequestExecutorError extends Error {
-  readonly type: RequestExecutorErrorType;
-  readonly errorCode: RequestEexecutorServerErrorCode | undefined;
-  readonly serverErrorType: SupernovaExceptionType | undefined;
-
-  static tryParseErrorCode(body: string) {
-    try {
-      const errorObj = JSON.parse(body);
-      if (errorObj && typeof errorObj.errorCode === "string") {
-        return errorObj.errorCode;
-      }
-      return null;
-    } catch (e) {
-      return null;
-    }
-  }
-
-  static tryParseServerErrorType(body: string) {
-    try {
-      const errorObj = JSON.parse(body);
-      if (errorObj && typeof errorObj.errorCode === "string") {
-        return errorObj.type;
-      }
-      return null;
-    } catch (e) {
-      return null;
-    }
-  }
-
-  static serverError(endpoint: string, status: number, bodyText: string) {
-    return new RequestExecutorError(
-      "ServerError",
-      `Endpoint ${endpoint} returned ${status}\n${bodyText}`,
-      this.tryParseErrorCode(bodyText),
-      this.tryParseServerErrorType(bodyText)
-    );
-  }
-
-  static responseParsingError(endpoint: string, cause: Error) {
-    return new RequestExecutorError(
-      "ResponseParsingError",
-      `Endpoint ${endpoint} returned incompatible JSON`,
-      undefined,
-      undefined,
-      cause
-    );
-  }
-
-  private constructor(
-    type: RequestExecutorErrorType,
-    message: string,
-    errorCode: RequestEexecutorServerErrorCode | undefined,
-    serverErrorType?: SupernovaExceptionType | undefined,
-    cause?: unknown
-  ) {
-    super(`${type}: ${message}`, { cause });
-    this.type = type;
-    this.errorCode = errorCode;
-    this.serverErrorType = serverErrorType;
-  }
-}

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

@@ -1,87 +0,0 @@
-import fetch, { RequestInit } from "node-fetch";
-import { z, ZodSchema, ZodTypeDef } from "zod";
-import { RequestExecutorError } from "./request-executor-error";
-
-export type RequestExecutorConfig = {
-  host: string;
-  accessToken?: string;
-};
-
-export type RequestExecutorJSONRequest = Omit<RequestInit, "body"> & {
-  body?: object;
-  query?: URLSearchParams;
-};
-
-const ResponseWrapper = z.object({
-  result: z.record(z.any()),
-});
-
-export class RequestExecutor {
-  private readonly testServerConfig: RequestExecutorConfig;
-
-  constructor(testServerConfig: RequestExecutorConfig) {
-    this.testServerConfig = testServerConfig;
-  }
-
-  async json<O, I>(
-    path: `/${string}`,
-    schema: ZodSchema<O, ZodTypeDef, I>,
-    requestInit: RequestExecutorJSONRequest = {}
-  ) {
-    // Headers
-    const defaultHeaders: Record<string, string> = {
-      Accept: "application/json",
-    };
-
-    if (requestInit.body) defaultHeaders["Content-Type"] = "application/json";
-    if (this.testServerConfig.accessToken) {
-      defaultHeaders["Authorization"] = `Bearer ${this.testServerConfig.accessToken}`;
-    }
-
-    // Body
-    let body: string | undefined;
-    if (requestInit.body && typeof requestInit.body === "object") body = JSON.stringify(requestInit.body);
-
-    const response = await fetch(this.fullUrl(path, requestInit.query), {
-      ...requestInit,
-      headers: {
-        ...requestInit.headers,
-        ...defaultHeaders,
-      },
-      body: body,
-    });
-
-    const endpoint = `${requestInit.method ?? "GET"} ${path}`;
-
-    if (!response.ok) {
-      const bodyString = await response.text();
-      throw RequestExecutorError.serverError(endpoint, response.status, bodyString);
-    }
-
-    const json = await response.json();
-    const wrapperParseResult = ResponseWrapper.safeParse(json);
-    if (!wrapperParseResult.success) {
-      console.error(`Response was:`);
-      console.error(json);
-      throw RequestExecutorError.responseParsingError(endpoint, wrapperParseResult.error);
-    }
-
-    const responseParseResult = schema.safeParse(wrapperParseResult.data.result);
-    if (!responseParseResult.success) {
-      console.error(`Response was:`);
-      console.error(wrapperParseResult.data.result);
-      throw RequestExecutorError.responseParsingError(endpoint, responseParseResult.error);
-    }
-
-    return responseParseResult.data;
-  }
-
-  private fullUrl(path: string, query: URLSearchParams | undefined): string {
-    let url = `https://${this.testServerConfig.host}/api/v2${path}`;
-
-    const queryString = query?.toString();
-    if (queryString) url += `?${queryString}`;
-
-    return url;
-  }
-}

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from "./api";
-export * from "./utils";
-export * from "./yjs";

package/src/utils/figma.ts

@@ -1,53 +0,0 @@
-const figmaFileIdRegex = /^[0-9a-zA-Z]{22,128}$/;
-const nodeIdRegex = /^d+-d+$/;
-const nodeTypeRegex = /^[0-9a-zA-Z]^/;
-
-type ParsedFigmaFileURL = {
-  fileId: string;
-  fileName: string | null;
-  nodeId: string | null;
-  nodeType: string | null;
-};
-
-export const FigmaUtils = {
-  tryParseFigmaFileURL(urlString: string): ParsedFigmaFileURL | null {
-    if (!URL.canParse(urlString)) return null;
-
-    // Validate that this is a Figma URL
-    const url = new URL(urlString);
-    if (!url.hostname.endsWith("figma.com")) return null;
-
-    // Validate that the URL type is the correct one (pointing to a design file)
-    const pathSegments = url.pathname.split("/");
-    if (pathSegments[0] !== "design" && pathSegments[0] !== "file") return null;
-
-    // Validate Figma file ID
-    const fileId = pathSegments[1];
-    if (!fileId || !fileId.match(figmaFileIdRegex)) return null;
-
-    // Parse Figma file name
-    let fileName: string | null = null;
-    const rawFileName = pathSegments[2];
-    if (rawFileName) {
-      fileName = rawFileName.replaceAll("-", " ");
-    }
-
-    // Parse node id
-    let nodeId: string | null = null;
-    const nodeIdRaw = url.searchParams.get("node-id");
-    if (nodeIdRaw && nodeIdRaw.match(nodeIdRegex)) {
-      nodeId = nodeIdRaw.replace("-", ":");
-    }
-
-    // Parse node type
-    let nodeType: string | null = null;
-    const nodeTypeRaw = url.searchParams.get("node-type");
-    if (nodeTypeRaw && nodeTypeRaw.match(nodeTypeRegex)) {
-      nodeType = nodeTypeRaw;
-    }
-
-    return { fileId, fileName, nodeId, nodeType };
-  },
-};
-
-// https://www.figma.com/design/U3Mg3I8WbvqF6CcZtRJM7w?node-id=2-3&t=9Qev2vhsldyFMhuE-1

package/src/utils/hash.ts

@@ -1,62 +0,0 @@
-function hash(input: string): string {
-  return farmhash(input).toString(16);
-}
-
-function farmhash(input: string): number {
-  const seed = 0x9e3779b9;
-  let hash = seed;
-
-  for (let i = 0; i < input.length; i++) {
-    const charCode = input.charCodeAt(i);
-    hash ^= charCode;
-    hash = Math.imul(hash, 0x5bd1e995);
-    hash ^= hash >>> 15;
-  }
-
-  hash = Math.imul(hash, 0x5bd1e995);
-  hash ^= hash >>> 13;
-  hash = Math.imul(hash, 0x5bd1e995);
-  hash ^= hash >>> 15;
-
-  return hash >>> 0;
-}
-
-function prepareObject(obj: any): any {
-  if (obj === null || typeof obj !== "object") {
-    return obj;
-  }
-  if (Array.isArray(obj)) {
-    return obj.map(prepareObject);
-  }
-  const sortedObj: any = {};
-  for (const key of Object.keys(obj).sort()) {
-    if (obj[key] === null || obj[key] === undefined) {
-      continue;
-    }
-    sortedObj[key] = prepareObject(obj[key]);
-  }
-  return sortedObj;
-}
-
-export function generateHash(input: object | string, debug = false): string {
-  if (typeof input === "object") {
-    const sanitized = JSON.stringify(prepareObject(input));
-    if (debug) {
-      console.log("Hashing sanitized string:");
-      console.log(sanitized);
-    }
-    return hash(sanitized);
-  } else {
-    try {
-      const obj = JSON.parse(input);
-      const sanitized = JSON.stringify(prepareObject(obj));
-      if (debug) {
-        console.log("Hashing sanitized string:");
-        console.log(sanitized);
-      }
-      return hash(sanitized);
-    } catch {
-      return hash(input);
-    }
-  }
-}

package/src/utils/index.ts

@@ -1,3 +0,0 @@
-export * from "./figma";
-export * from "./hash";
-export * from "./query";

package/src/utils/query.ts

@@ -1,18 +0,0 @@
-type CompatibleValue = number | string | boolean | undefined;
-type QueryObject = Record<string, CompatibleValue | CompatibleValue[]>;
-
-export function serializeQuery(query: QueryObject): URLSearchParams {
-  const queryWithStrings = Object.fromEntries(
-    Object.entries(query)
-      .filter(e => !!e[1])
-      .map(([k, v]) => {
-        if (Array.isArray(v)) {
-          return [k, v.join(", ")];
-        } else {
-          return [k, v!.toString()];
-        }
-      })
-  );
-
-  return new URLSearchParams(queryWithStrings);
-}