@runkids/figlens 0.0.0-stage → 0.1.2

package/README.md

@@ -1,3 +1,36 @@
-# Temporary Holding Version
+<p align="center">
+  <img src="https://raw.githubusercontent.com/runkids/figlens/main/assets/logo.png" alt="figlens" width="320">
+</p>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @runkids/figlens
+
+Build UI anywhere. Just bring a `.fig`.
+
+Give your AI coding agent a saved Figma file (**File > Save local copy**). figlens reads the design offline, on your laptop, a CI runner or a cloud AI server. No Figma installation, login or API key needed.
+
+This package runs the native `figlens` binary: the first run downloads the release build for your platform, checks it against the release's `SHA256SUMS` and caches it. Node.js 18 or later; macOS, Linux and Windows.
+
+## Use it
+
+```sh
+npx @runkids/figlens tree design.fig --depth 2                 # pages and frames, with their ids
+npx @runkids/figlens nodes design.fig 12:345 > frame.json      # a frame as Figma REST JSON
+npx @runkids/figlens bundle design.fig 12:345 frame.zip        # nodes, variables, assets and a reference render
+npx @runkids/figlens export design.fig 12:345 frame.png --scale 2
+```
+
+Or install it once: `npm i -g @runkids/figlens`, then run `figlens`.
+
+## MCP server
+
+Let your agent call `tree`, `nodes`, `variables`, `bundle` and `export` as tools:
+
+```json
+{ "mcpServers": { "figlens": { "command": "npx", "args": ["-y", "@runkids/figlens", "mcp"] } } }
+```
+
+## More
+
+Documentation, the design bundle layout, accuracy measurements and other install methods (Homebrew, install scripts): [github.com/runkids/figlens](https://github.com/runkids/figlens).
+
+MIT license.

package/bin/figlens.js

@@ -0,0 +1,67 @@
+#!/usr/bin/env node
+// `npx @runkids/figlens ...`: downloads this version's release binary on first use, checks it against
+// the release's SHA256SUMS, caches it, then runs it. No install script: npx and pnpm may skip those.
+const { spawnSync } = require("node:child_process");
+const crypto = require("node:crypto");
+const fs = require("node:fs");
+const os = require("node:os");
+const path = require("node:path");
+const { asset } = require("../target.js");
+const { version } = require("../package.json");
+
+const cacheRoot =
+  process.env.XDG_CACHE_HOME ||
+  (process.platform === "win32" ? process.env.LOCALAPPDATA : null) ||
+  path.join(os.homedir(), ".cache");
+const { archive, binary } = asset(process.platform, process.arch, version);
+const dir = path.join(cacheRoot, "figlens", "npm", version);
+const bin = path.join(dir, binary);
+
+async function download(url) {
+  const res = await fetch(url);
+  if (!res.ok) throw new Error(`${url}: HTTP ${res.status}`);
+  return Buffer.from(await res.arrayBuffer());
+}
+
+async function install() {
+  const base = `https://github.com/runkids/figlens/releases/download/v${version}`;
+  const [bytes, sums] = await Promise.all([
+    download(`${base}/${archive}`),
+    download(`${base}/SHA256SUMS`),
+  ]);
+  const want = sums
+    .toString()
+    .split("\n")
+    .find((line) => line.trim().endsWith(archive));
+  const got = crypto.createHash("sha256").update(bytes).digest("hex");
+  if (!want || want.split(/\s+/)[0] !== got) {
+    throw new Error(`${archive} does not match the release's SHA256SUMS`);
+  }
+  // Extract next to the cache, then rename into place, so a half-written binary is never run.
+  fs.mkdirSync(path.dirname(dir), { recursive: true });
+  const tmp = fs.mkdtempSync(path.join(path.dirname(dir), ".tmp-"));
+  try {
+    fs.writeFileSync(path.join(tmp, archive), bytes);
+    // bsdtar ships with Windows 10+ and extracts zips as well.
+    const tar = spawnSync("tar", ["-xf", archive, binary], { cwd: tmp, stdio: "inherit" });
+    if (tar.status !== 0) throw new Error("tar could not extract the archive");
+    fs.rmSync(path.join(tmp, archive));
+    fs.rmSync(dir, { recursive: true, force: true });
+    fs.renameSync(tmp, dir);
+  } catch (e) {
+    fs.rmSync(tmp, { recursive: true, force: true });
+    throw e;
+  }
+}
+
+async function main() {
+  if (!fs.existsSync(bin)) await install();
+  const run = spawnSync(bin, process.argv.slice(2), { stdio: "inherit" });
+  if (run.error) throw run.error;
+  process.exit(run.status ?? 1);
+}
+
+main().catch((e) => {
+  console.error(`figlens: ${e.message}`);
+  process.exit(1);
+});

package/package.json

@@ -1,6 +1,37 @@
 {
   "name": "@runkids/figlens",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.2",
+  "description": "Read Figma .fig files offline: REST nodes, variables, assets, renders and design bundles for AI agents",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/runkids/figlens.git"
+  },
+  "homepage": "https://github.com/runkids/figlens",
+  "keywords": [
+    "figma",
+    "fig",
+    "design-to-code",
+    "cli",
+    "ai"
+  ],
+  "bin": {
+    "figlens": "bin/figlens.js"
+  },
+  "files": [
+    "bin/",
+    "target.js"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "cpu": [
+    "arm64",
+    "x64"
+  ]
+}

package/target.js

@@ -0,0 +1,18 @@
+// The release archive for a Node platform and arch (see scripts/build-dist.sh).
+const OS = { darwin: "apple-darwin", linux: "unknown-linux-musl", win32: "pc-windows-gnu" };
+const ARCH = { arm64: "aarch64", x64: "x86_64" };
+
+function asset(platform, arch, version) {
+  // Windows on ARM runs the x64 build under emulation; there is no aarch64 Windows build.
+  const cpu = platform === "win32" ? "x64" : arch;
+  if (!OS[platform] || !ARCH[cpu]) {
+    throw new Error(`figlens has no build for ${platform}/${arch}`);
+  }
+  const windows = platform === "win32";
+  return {
+    archive: `figlens-${version}-${ARCH[cpu]}-${OS[platform]}.${windows ? "zip" : "tar.gz"}`,
+    binary: windows ? "figlens.exe" : "figlens",
+  };
+}
+
+module.exports = { asset };