@supernova-studio/client 0.59.12 → 1.0.0-alpha.11

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/events/design-system.ts

@@ -1,21 +0,0 @@
-import { DataSourceRemoteType } from "@supernova-studio/model";
-import { z } from "zod";
-
-export const DTOEventFigmaNodesRendered = z.object({
-  type: z.literal("DesignSystem.FigmaNodesRendered"),
-  designSystemId: z.string(),
-  versionId: z.string(),
-  figmaNodePersistentIds: z.string().array(),
-});
-
-export const DTOEventDataSourcesImported = z.object({
-  type: z.literal("DesignSystem.ImportJobFinished"),
-  designSystemId: z.string(),
-  versionId: z.string(),
-  importJobId: z.string(),
-  dataSourceType: DataSourceRemoteType,
-  dataSourceIds: z.string().array(),
-});
-
-export type DTOEventFigmaNodesRendered = z.infer<typeof DTOEventFigmaNodesRendered>;
-export type DTOEventDataSourcesImported = z.infer<typeof DTOEventDataSourcesImported>;

package/src/events/event.ts

@@ -1,6 +0,0 @@
-import { z } from "zod";
-import { DTOEventDataSourcesImported, DTOEventFigmaNodesRendered } from "./design-system";
-
-export const DTOEvent = z.discriminatedUnion("type", [DTOEventDataSourcesImported, DTOEventFigmaNodesRendered]);
-
-export type DTOEvent = z.infer<typeof DTOEvent>;

package/src/events/index.ts

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

package/src/index.ts

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

package/src/utils/figma.ts

@@ -1,72 +0,0 @@
-const figmaFileIdRegex = /^[0-9a-zA-Z]{22,128}$/;
-const nodeIdRegex = /^\d+-\d+$/;
-const nodeTypeRegex = /^[0-9a-zA-Z]^/;
-
-export enum ParsedFigmaFileURLError {
-  InvalidUrl = "InvalidUrl",
-  InvalidFigmaFileId = "InvalidFigmaFileId",
-}
-
-type ParsedFigmaFileURL =
-  | {
-      status: "Success";
-      fileId: string;
-      fileName: string | null;
-      nodeId: string | null;
-      nodeType: string | null;
-    }
-  | {
-      status: "Error";
-      error: ParsedFigmaFileURLError;
-    };
-
-export const FigmaUtils = {
-  tryParseFigmaFileURL(urlString: string): ParsedFigmaFileURL {
-    if (!URL.canParse(urlString)) {
-      return { status: "Error", error: ParsedFigmaFileURLError.InvalidUrl };
-    }
-
-    // Validate that this is a Figma URL
-    const url = new URL(urlString);
-    if (!url.hostname.endsWith("figma.com")) {
-      return { status: "Error", error: ParsedFigmaFileURLError.InvalidUrl };
-    }
-
-    // Validate that the URL type is the correct one (pointing to a design file)
-    const pathSegments = url.pathname.split("/");
-    if (pathSegments[1] !== "design" && pathSegments[1] !== "file") {
-      return { status: "Error", error: ParsedFigmaFileURLError.InvalidUrl };
-    }
-
-    // Validate Figma file ID
-    const fileId = pathSegments[2];
-    if (!fileId || !fileId.match(figmaFileIdRegex)) {
-      return { status: "Error", error: ParsedFigmaFileURLError.InvalidFigmaFileId };
-    }
-
-    // Parse Figma file name
-    let fileName: string | null = null;
-    const rawFileName = pathSegments[3];
-    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 { status: "Success", 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);
-}

package/src/yjs/design-system-content/documentation-hierarchy.ts

@@ -1,35 +0,0 @@
-import * as Y from "yjs";
-import { z } from "zod";
-import { DTODocumentationHierarchyV2 } from "../../api";
-import { FrontendVersionRoomYDoc } from "../version-room/frontend";
-
-// We store pages and groups in the same way they are stored in the database.
-// This means that instead of groups having childrenIds array, all items have
-// parentPersistentId property that points to the parent item in the tree.
-// Upon read this gets converted to the format that client expects, which is
-// ordered childrenIds array on all groups.
-//
-// The decision behind it is that we potentially want to get rid of childrenIds
-// array entirely because it makes group updates more complicated. For now
-// resolving it on fly is a tradeoff for not rewriting client to stop relying
-// on children ids array.
-
-//
-// Types
-//
-
-export const DocumentationHierarchySettings = z.object({
-  routingVersion: z.string(),
-  isDraftFeatureAdopted: z.boolean(),
-  isApprovalFeatureEnabled: z.boolean(),
-  approvalRequiredForPublishing: z.boolean(),
-});
-
-export type DocumentationHierarchySettings = z.infer<typeof DocumentationHierarchySettings>;
-
-/**
- * @deprecated - Use FrontendVersionRoomYDoc.getDocumentationHierarchy
- */
-export function yjsToDocumentationHierarchy(doc: Y.Doc): DTODocumentationHierarchyV2 {
-  return new FrontendVersionRoomYDoc(doc).getDocumentationHierarchy();
-}

package/src/yjs/design-system-content/index.ts

@@ -1,2 +0,0 @@
-export * from "./documentation-hierarchy";
-export * from "./item-configuration";

package/src/yjs/design-system-content/item-configuration.ts

@@ -1,93 +0,0 @@
-import { DocumentationItemHeaderV2 } from "@supernova-studio/model";
-import * as Y from "yjs";
-import { z } from "zod";
-import { DTODocumentationItemConfigurationV2 } from "../../api/dto/elements/documentation/item-configuration-v2";
-
-//
-// Types
-//
-
-export const DTODocumentationPageRoomHeaderData = z.object({
-  title: z.string(),
-  configuration: DTODocumentationItemConfigurationV2,
-});
-
-export const DTODocumentationPageRoomHeaderDataUpdate = z.object({
-  title: z.string().optional(),
-  configuration: DTODocumentationItemConfigurationV2.omit({ header: true })
-    .extend({ header: DocumentationItemHeaderV2.partial() })
-    .optional(),
-});
-
-export type DTODocumentationPageRoomHeaderData = z.infer<typeof DTODocumentationPageRoomHeaderData>;
-export type DTODocumentationPageRoomHeaderDataUpdate = z.infer<typeof DTODocumentationPageRoomHeaderDataUpdate>;
-
-//
-// YJS Bindings
-//
-
-export function itemConfigurationToYjs(yDoc: Y.Doc, item: DTODocumentationPageRoomHeaderDataUpdate) {
-  yDoc.transact(trx => {
-    const { title, configuration } = item;
-
-    const header = configuration?.header;
-
-    if (title !== undefined) {
-      const headerYMap = trx.doc.getMap("itemTitle");
-      headerYMap.set("title", title);
-    }
-
-    if (header) {
-      const headerYMap = trx.doc.getMap("itemHeader");
-
-      header.description !== undefined && headerYMap.set("description", header.description);
-      header.alignment !== undefined && headerYMap.set("alignment", header.alignment);
-      header.foregroundColor !== undefined && headerYMap.set("foregroundColor", header.foregroundColor);
-      header.backgroundColor !== undefined && headerYMap.set("backgroundColor", header.backgroundColor);
-      header.backgroundImageAsset !== undefined && headerYMap.set("backgroundImageAsset", header.backgroundImageAsset);
-      header.backgroundImageScaleType !== undefined &&
-        headerYMap.set("backgroundImageScaleType", header.backgroundImageScaleType);
-      header.showBackgroundOverlay !== undefined &&
-        headerYMap.set("showBackgroundOverlay", header.showBackgroundOverlay);
-      header.showCoverText !== undefined && headerYMap.set("showCoverText", header.showCoverText);
-      header.minHeight !== undefined && headerYMap.set("minHeight", header.minHeight);
-    }
-
-    const configYMap = trx.doc.getMap("itemConfiguration");
-
-    configuration?.showSidebar !== undefined && configYMap.set("showSidebar", configuration.showSidebar);
-    configuration?.isHidden !== undefined && configYMap.set("isHidden", configuration.isHidden);
-    configuration?.isPrivate !== undefined && configYMap.set("isPrivate", configuration.isPrivate);
-  });
-}
-
-export function yjsToItemConfiguration(yDoc: Y.Doc): DTODocumentationPageRoomHeaderData {
-  const title = yDoc.getMap("itemTitle").get("title");
-
-  const headerYMap = yDoc.getMap("itemHeader");
-  const rawHeader = {
-    description: headerYMap.get("description"),
-    alignment: headerYMap.get("alignment"),
-    foregroundColor: headerYMap.get("foregroundColor"),
-    backgroundColor: headerYMap.get("backgroundColor"),
-    backgroundImageAsset: headerYMap.get("backgroundImageAsset"),
-    backgroundImageScaleType: headerYMap.get("backgroundImageScaleType"),
-    showBackgroundOverlay: headerYMap.get("showBackgroundOverlay"),
-    showCoverText: headerYMap.get("showCoverText"),
-    minHeight: headerYMap.get("minHeight"),
-  };
-
-  const configYMap = yDoc.getMap("itemConfiguration");
-
-  const rawConfig = {
-    showSidebar: configYMap.get("showSidebar"),
-    isHidden: configYMap.get("isHidden") ?? false,
-    isPrivate: configYMap.get("isPrivate") ?? false,
-    header: rawHeader,
-  } satisfies Record<keyof DTODocumentationItemConfigurationV2, unknown>;
-
-  return {
-    title: z.string().parse(title),
-    configuration: DTODocumentationItemConfigurationV2.parse(rawConfig),
-  };
-}