@animaapp/anima-sdk 0.1.0

package/src/types.ts

@@ -0,0 +1,77 @@
+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;
+};
+
+export type AnimaSDKResult = BaseResult & {
+  files: AnimaFiles;
+};
+
+export type CodegenResult = BaseResult & {
+  files: Record<string, { code: string; type: "code" }>;
+};
+
+export type GetCodeParams = {
+  fileKey: string;
+  figmaToken: string;
+  nodesId: string[];
+  settings: CodegenSettings;
+};
+
+export type GetCodeHandler =
+  | ((message: SSECodgenMessage) => void)
+  | {
+      onStart?: ({ sessionId }: { sessionId: string }) => void;
+      onPreCodegen?: ({ message }: { message: string }) => void;
+      onAssetsUploaded?: () => void;
+      onFigmaMetadata?: ({
+        figmaFileName,
+        figmaSelectedFrameName,
+      }: {
+        figmaFileName: string;
+        figmaSelectedFrameName: string;
+      }) => void;
+      onGeneratingCode?: ({
+        status,
+        progress,
+        files,
+      }: {
+        status: "success" | "running" | "failure";
+        progress: number;
+        files: AnimaFiles;
+      }) => void;
+      onCodegenCompleted?: () => void;
+    };
+
+// TODO: `SSECodgenMessage` and `SSECodgenMessageErrorPayload` should be imported from `anima-public-api`
+export type SSECodgenMessage =
+  | { type: "start"; sessionId: string }
+  | { type: "pre_codegen"; message: string }
+  | {
+      type: "figma_metadata";
+      figmaFileName: string;
+      figmaSelectedFrameName: string;
+    }
+  | { type: "generating_code"; payload: any }
+  | { type: "codegen_completed" }
+  | { type: "assets_uploaded" }
+  | { type: "aborted" }
+  | { type: "error"; payload: SSECodgenMessageErrorPayload }
+  | { type: "done" };
+export type SSECodgenMessageErrorPayload = {
+  errorName: string;
+  task?: string;
+  reason: CodegenErrorReason;
+};

package/src/utils.ts

@@ -0,0 +1,53 @@
+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,
+}: {
+  fileKey: string;
+  nodeId: string;
+}) => {
+  const url = new URL("https://www.figma.com");
+  url.pathname = `design/${fileKey}`;
+
+  if (nodeId) {
+    url.searchParams.set("node-id", nodeId.replace(":", "-"));
+  }
+
+  return url;
+};
+
+class ResponseError extends Error {
+  response: Response;
+
+  constructor(message: string, res: Response) {
+    super(message);
+    this.response = res;
+  }
+}

package/vite.config.ts

@@ -0,0 +1,24 @@
+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,
+    }),
+  ],
+});