@animaapp/anima-sdk 0.3.1 → 0.3.4

package/src/figma/utils.ts

@@ -1,73 +0,0 @@
-import type { GetFileResponse, Node } from '@figma/rest-api-spec';
-import { FigmaRestApi } from '@animaapp/http-client-figma';
-import { handleFigmaApiError, type FigmaApiError } from './figmaError';
-
-export type FigmaNode = Node;
-export type GetFileParams = { fileKey: string; authToken?: string; figmaRestApi?: FigmaRestApi };
-
-export type FigmaPage = { id: string; name: string };
-export type GetFilePagesParams = {
-  fileKey: string;
-  authToken?: string;
-  figmaRestApi?: FigmaRestApi;
-  params?: Record<string, string | number | undefined>;
-};
-export type GetFilePagesResult = FigmaPage[] | undefined;
-export type GetFileNodesParams = {
-  fileKey: string;
-  authToken?: string;
-  nodeIds: string[];
-  figmaRestApi?: FigmaRestApi;
-  params?: Record<string, string | number>;
-};
-
-export type GetFigmaFileResult = GetFileResponse | undefined;
-
-export const getFigmaFile = async ({
-  fileKey,
-  authToken,
-  figmaRestApi = new FigmaRestApi(),
-  params = {},
-}: GetFilePagesParams): Promise<GetFigmaFileResult> => {
-  if (authToken) {
-    figmaRestApi.token = authToken;
-  }
-
-  try {
-    const rootFile = await figmaRestApi.files.get({
-      fileKey,
-      params,
-    });
-
-    return rootFile;
-  } catch (error) {
-    console.error(error);
-    throw error;
-  }
-};
-
-export const getFileNodes = async ({
-  fileKey,
-  authToken,
-  nodeIds,
-  figmaRestApi = new FigmaRestApi(),
-  params = {},
-}: GetFileNodesParams) => {
-  if (authToken) {
-    figmaRestApi.token = authToken;
-  }
-
-  try {
-    const data = await figmaRestApi.nodes.get({
-      fileKey,
-      nodeIds,
-      params: {
-        ...params,
-      },
-    });
-
-    return data.nodes;
-  } catch (error) {
-    return handleFigmaApiError(error as FigmaApiError, fileKey);
-  }
-};

package/src/index.ts

@@ -1,7 +0,0 @@
-export * from "./anima";
-export * from "./types";
-export * from "./errors";
-export * from "./utils";
-export * from "./figma";
-export * from "./settings";
-export * from "./dataStream";

package/src/settings.ts

@@ -1,68 +0,0 @@
-import { z } from "zod";
-
-const CodegenSettingsSchema = z
-  .object({
-    language: z.enum(["typescript", "javascript"]).optional(),
-    disableMarkedForExport: z.boolean().optional(),
-  })
-  .and(
-    z.union([
-      z.object({
-        framework: z.literal("react"),
-        model: z.string().optional(),
-        styling: z.enum([
-          "plain_css",
-          "css_modules",
-          "styled_components",
-          "tailwind",
-          "sass",
-          "scss",
-          "inline_styles",
-        ]),
-        uiLibrary: z.enum(["mui", "antd", "radix", "shadcn"]).optional(),
-        enableUILibraryTheming: z.boolean().optional(),
-        enableCompactStructure: z.boolean().optional(),
-        enableAutoSplit: z.boolean().optional(),
-        autoSplitThreshold: z.number().optional(),
-      }),
-      z.object({
-        framework: z.literal("html"),
-        styling: z.enum(["plain_css", "inline_styles"]),
-        enableTranslation: z.boolean().optional(),
-      }),
-    ])
-  );
-
-// We don't use the z.infer method here because the types returned by zod aren't ergonic
-export type CodegenSettings = {
-  language?: "typescript" | "javascript";
-  model?: string;
-  framework: "react" | "html";
-  styling:
-    | "plain_css"
-    | "css_modules"
-    | "styled_components"
-    | "tailwind"
-    | "sass"
-    | "scss"
-    | "inline_styles";
-  uiLibrary?: "mui" | "antd" | "radix" | "shadcn";
-  enableTranslation?: boolean;
-  enableUILibraryTheming?: boolean;
-  enableCompactStructure?: boolean;
-  enableAutoSplit?: boolean;
-  autoSplitThreshold?: number;
-  disableMarkedForExport?: boolean;
-};
-
-export const validateSettings = (obj: unknown): CodegenSettings => {
-  const parsedObj = CodegenSettingsSchema.safeParse(obj);
-
-  if (parsedObj.success === false) {
-    const error = new Error("Invalid codegen settings");
-    error.cause = parsedObj.error;
-    throw error;
-  }
-
-  return parsedObj.data;
-};

package/src/types.ts

@@ -1,106 +0,0 @@
-import type { CodegenErrorReason } from "./errors";
-import type { CodegenSettings } from "./settings";
-
-export type AnimaFiles = Record<
-  string,
-  {
-    content: string;
-    isBinary: boolean;
-  }
->;
-
-export type BaseResult = {
-  sessionId: string;
-  figmaFileName: string;
-  figmaSelectedFrameName: string;
-  tokenUsage: number;
-};
-
-export type AnimaSDKResult = BaseResult & {
-  files: AnimaFiles;
-  assets?: Array<{ name: string; url: string }>;
-};
-
-export type CodegenResult = BaseResult & {
-  files: Record<string, { code: string; type: "code" }>;
-};
-
-export type AssetsStorage =
-  | { strategy: "host" }
-  | { strategy: "external"; url: string };
-
-export type TrackingInfos = {
-  externalId: string;
-}
-
-export type GetCodeParams = {
-  fileKey: string;
-  figmaToken?: string;
-  nodesId: string[];
-  assetsStorage?: AssetsStorage;
-  settings: CodegenSettings;
-  tracking?: TrackingInfos;
-};
-
-export type GetCodeHandler =
-  | ((message: SSECodgenMessage) => void)
-  | {
-      onQueueing?: () => void;
-      onStart?: ({ sessionId }: { sessionId: string }) => void;
-      onPreCodegen?: ({ message }: { message: string }) => void;
-      onAssetsUploaded?: () => void;
-      onAssetsList?: ({
-        assets,
-      }: {
-        assets: Array<{ name: string; url: string }>;
-      }) => void;
-      onFigmaMetadata?: ({
-        figmaFileName,
-        figmaSelectedFrameName,
-      }: {
-        figmaFileName: string;
-        figmaSelectedFrameName: string;
-      }) => void;
-      onGeneratingCode?: ({
-        status,
-        progress,
-        files,
-      }: {
-        status: "success" | "running" | "failure";
-        progress: number;
-        files: AnimaFiles;
-      }) => void;
-      onCodegenCompleted?: () => void;
-    };
-
-export type GeneratingCodePayload = {
-  status: "success" | "running" | "failure";
-  progress: number;
-  files: AnimaFiles;
-};
-
-// TODO: `SSECodgenMessage` and `SSECodgenMessageErrorPayload` should be imported from `anima-public-api`
-export type SSECodgenMessage =
-  | { type: "queueing" }
-  | { type: "start"; sessionId: string }
-  | { type: "pre_codegen"; message: string }
-  | {
-      type: "figma_metadata";
-      figmaFileName: string;
-      figmaSelectedFrameName: string;
-    }
-  | { type: "generating_code"; payload: GeneratingCodePayload }
-  | { type: "codegen_completed" }
-  | { type: "assets_uploaded" }
-  | {
-      type: "assets_list";
-      payload: { assets: Array<{ name: string; url: string }> };
-    }
-  | { type: "aborted" }
-  | { type: "error"; payload: SSECodgenMessageErrorPayload }
-  | { type: "done"; payload: { sessionId: string; tokenUsage: number } };
-export type SSECodgenMessageErrorPayload = {
-  errorName: string;
-  task?: string;
-  reason: CodegenErrorReason;
-};

package/src/utils/figma.spec.ts

@@ -1,31 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { formatToFigmaLink } from "./figma";
-
-describe("# figma", () => {
-  describe(".formatToFigmaLink", () => {
-    it("generates a link with file key and node id", () => {
-      const url = formatToFigmaLink({
-        fileKey: "file-key",
-        nodeId: "1:2",
-      });
-
-      expect(url.href).toBe(
-        "https://www.figma.com/design/file-key?node-id=1-2"
-      );
-    });
-
-    describe('when the "duplicate" flag is enabled', () => {
-      it("generates a link including the '/duplicated' path", () => {
-        const url = formatToFigmaLink({
-          fileKey: "file-key",
-          nodeId: "1:2",
-          duplicate: true,
-        });
-
-        expect(url.href).toBe(
-          "https://www.figma.com/design/file-key/duplicate?node-id=1-2"
-        );
-      });
-    });
-  });
-});

package/src/utils/figma.ts

@@ -1,59 +0,0 @@
-export const isValidFigmaUrl = (
-  figmaLink: string
-): [hasCorrectPrefix: boolean, fileKey: string, nodeId: string] => {
-  if (!figmaLink) {
-    return [false, "", ""];
-  }
-
-  try {
-    const url = new URL(figmaLink);
-    const path = url.pathname;
-
-    if (url.origin !== "https://www.figma.com") {
-      return [false, "", ""];
-    }
-
-    const nodeId = (url.searchParams.get("node-id") ?? "").replace(/-/g, ":");
-    const fileKey = path.split("/")[2];
-    const hasCorrectPrefix =
-      (path.startsWith("/file/") &&
-        url.searchParams.get("type") !== "whiteboard") ||
-      path.startsWith("/design/");
-
-    return [hasCorrectPrefix && fileKey.length === 22, fileKey, nodeId];
-  } catch {
-    return [false, "", ""];
-  }
-};
-
-export const formatToFigmaLink = ({
-  fileKey,
-  nodeId,
-  duplicate,
-}: {
-  fileKey: string;
-  nodeId: string;
-  duplicate?: boolean;
-}) => {
-  const url = new URL("https://www.figma.com");
-  url.pathname = `design/${fileKey}`;
-
-  if (duplicate) {
-    url.pathname = `${url.pathname}/duplicate`;
-  }
-
-  if (nodeId) {
-    url.searchParams.set("node-id", nodeId.replace(":", "-"));
-  }
-
-  return url;
-};
-
-export class ResponseError extends Error {
-  response: Response;
-
-  constructor(message: string, res: Response) {
-    super(message);
-    this.response = res;
-  }
-}

package/src/utils/files.ts

@@ -1,95 +0,0 @@
-import { AnimaFiles } from "../types";
-
-export const getRelatedScreenFiles = ({
-  files,
-  screenPath = "src/screens",
-}: {
-  files: AnimaFiles;
-  screenPath?: string;
-}) => {
-  const result: AnimaFiles = {};
-  const processed = new Set<string>();
-
-  function processFile(filePath: string) {
-    if (processed.has(filePath) || !files[filePath]) {
-      return;
-    }
-
-    processed.add(filePath);
-    result[filePath] = files[filePath];
-
-    const imports = parseImports(files[filePath].content);
-
-    imports.forEach((importPath) => {
-      try {
-        const resolvedPath = resolveImportPath(filePath, importPath);
-
-        if (resolvedPath.startsWith("src/")) {
-          const importDir = resolvedPath.split("/").slice(0, -1).join("/");
-          const dirFiles = getAllFilesInDirectory(files, importDir);
-          dirFiles.forEach((file) => {
-            if (!processed.has(file)) {
-              processFile(file);
-            }
-          });
-        }
-      } catch (error) {
-        console.warn(
-          `Failed to resolve import ${importPath} in ${filePath}:`,
-          error
-        );
-      }
-    });
-  }
-
-  Object.entries(files).forEach(([key, value]) => {
-    if (key.startsWith(screenPath)) {
-      processFile(key);
-    } else if (!key.startsWith("src/")) {
-      result[key] = value;
-    }
-  });
-
-  return result;
-};
-
-function parseImports(content: string): string[] {
-  const importRegex = /import.*?["']([^"']+)["']/g;
-  const exports = /export.*from\s+["']([^"']+)["']/g;
-  const imports: string[] = [];
-  let match;
-
-  while ((match = importRegex.exec(content)) !== null) {
-    imports.push(match[1]);
-  }
-
-  while ((match = exports.exec(content)) !== null) {
-    imports.push(match[1]);
-  }
-
-  return [...new Set(imports)];
-}
-
-function resolveImportPath(basePath: string, importPath: string): string {
-  if (!importPath.startsWith(".")) {
-    return importPath;
-  }
-
-  const baseDir = basePath.split("/").slice(0, -1);
-  const importParts = importPath.split("/");
-  const resolvedParts: string[] = [...baseDir];
-
-  for (const part of importParts) {
-    if (part === "..") {
-      resolvedParts.pop();
-    } else if (part !== ".") {
-      resolvedParts.push(part);
-    }
-  }
-
-  return resolvedParts.join("/");
-}
-
-function getAllFilesInDirectory(files: AnimaFiles, dirPath: string): string[] {
-  return Object.keys(files).filter((file) => file.startsWith(dirPath));
-}

package/src/utils/index.ts

@@ -1,2 +0,0 @@
-export * from "./figma";
-export * from "./files";

package/vite.config.ts

@@ -1,24 +0,0 @@
-import { defineConfig } from "vite";
-import dts from "vite-plugin-dts";
-import tsconfigPaths from "vite-tsconfig-paths";
-
-export default defineConfig({
-  build: {
-    lib: {
-      entry: "./src/index.ts",
-      formats: ["cjs", "es"],
-      fileName: "index",
-    },
-    outDir: "./dist",
-    emptyOutDir: true,
-    target: "es6",
-    sourcemap: true,
-  },
-  plugins: [
-    tsconfigPaths(),
-    dts({
-      rollupTypes: true,
-      insertTypesEntry: true,
-    }),
-  ],
-});