@pantoken/flutter 0.1.0

package/README.md

@@ -0,0 +1,57 @@
+# @pantoken/flutter
+
+Emit Instructure design tokens as a Flutter (Dart) class, via Style Dictionary. It flattens the
+token IR to concrete, single-mode values and keeps the natively-typed tokens (colours, dimensions,
+numbers).
+
+## Install
+
+```sh
+npm i @pantoken/flutter
+```
+
+## Usage
+
+```ts
+import { generateFlutter } from "@pantoken/flutter";
+
+const file = await generateFlutter({
+  outDir: "./lib/tokens",
+  theme: "rebrand",
+  className: "PanTokens", // the generated Dart class name (default)
+  icons: ["add", "check"], // optional: also copy SVG assets + a PanTokensIcons manifest
+});
+```
+
+Or via the CLI:
+
+```sh
+pantoken generate flutter --out ./lib/tokens
+pantoken generate flutter --out ./lib/tokens --theme canvas --icons add,check
+```
+
+## Output
+
+- A single Dart file (named after `className`, lower-cased) declaring a class of `Color`, `double`,
+  and numeric constants.
+- With `icons` set: the requested glyphs copied to `assets/pantoken/icons/*.svg` plus a
+  `pantoken_icons.dart` manifest (a `PanTokensIcons` class) for use with `flutter_svg`. Register the
+  asset directory in your `pubspec.yaml`.
+
+## API
+
+- **`generateFlutter(options): Promise<string>`** — emit Dart for a named theme (from the vendored
+  `@pantoken/tokens` IR). Returns the written file path.
+- **`toFlutter(tokens, options): Promise<string>`** — same, but for an explicit token IR. Returns
+  the written file path.
+- **`GenerateFlutterOptions`** — the `outDir`, `theme`, `mode`, `className`, and `icons` options
+  both take.
+
+## Related
+
+- Uses `@pantoken/tokens` for the vendored token IR and `@pantoken/sd-config` for the Style
+  Dictionary platforms.
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,53 @@
+import { Mode } from "@pantoken/core";
+import { Theme, Token } from "@pantoken/model";
+
+//#region src/index.d.ts
+/** Options for {@link generateFlutter} / {@link toFlutter}. */
+interface GenerateFlutterOptions {
+  outDir: string;
+  theme?: Theme;
+  mode?: Mode;
+  /** The generated Dart class name (default `PanTokens`). */
+  className?: string;
+  /** Icon names to also copy as SVG assets + a `PanTokensIcons` Dart manifest (for `flutter_svg`). */
+  icons?: string[];
+}
+/**
+ * Emit Flutter Dart for an explicit token IR. Returns the written file path.
+ *
+ * @example Emit a specific theme's IR
+ * ```ts
+ * import { toFlutter } from "@pantoken/flutter";
+ * import { byTheme } from "@pantoken/tokens";
+ *
+ * const file = await toFlutter(byTheme("canvas"), { outDir: "./lib/tokens" });
+ * // writes ./lib/tokens/pantokens.dart (class PanTokens { … })
+ * ```
+ *
+ * @example Dark mode with SVG icon assets and manifest
+ * ```ts
+ * import { toFlutter } from "@pantoken/flutter";
+ * import { byTheme } from "@pantoken/tokens";
+ *
+ * await toFlutter(byTheme("rebrand"), {
+ *   outDir: "./lib/tokens",
+ *   mode: "dark",
+ *   className: "InstUITokens",
+ *   icons: ["add", "check"], // copies SVGs + writes pantoken_icons.dart
+ * });
+ * ```
+ */
+declare function toFlutter(tokens: readonly Token[], options: GenerateFlutterOptions): Promise<string>;
+/**
+ * Emit Flutter Dart for a named theme. Returns the written file path.
+ *
+ * @example
+ * ```ts
+ * import { generateFlutter } from "@pantoken/flutter";
+ *
+ * const file = await generateFlutter({ outDir: "./lib/tokens", theme: "rebrand" });
+ * ```
+ */
+declare function generateFlutter(options: GenerateFlutterOptions): Promise<string>;
+//#endregion
+export { GenerateFlutterOptions, generateFlutter as default, generateFlutter, toFlutter };

package/dist/index.mjs

@@ -0,0 +1,87 @@
+import { mkdirSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+import { flutterIconManifest, getIconSvgs, toStyleDictionary } from "@pantoken/core";
+import { buildPlatform } from "@pantoken/sd-config";
+import { byTheme } from "@pantoken/tokens";
+//#region src/index.ts
+/**
+* `@pantoken/flutter` — emit Instructure design tokens as Flutter (Dart), via Style Dictionary. It
+* flattens the IR to concrete, single-mode values and keeps the natively-typed tokens.
+*
+* @module
+* @experimental
+*/
+const NATIVE_TYPES = /* @__PURE__ */ new Set([
+	"color",
+	"dimension",
+	"number"
+]);
+const ICON_ASSET_DIR = "assets/pantoken/icons";
+/** Copy the requested icon SVGs under `assets/pantoken/icons` and write a Dart manifest. */
+function writeFlutterIcons(tokens, names, outDir) {
+	const svgs = getIconSvgs(tokens);
+	const dir = join(outDir, ICON_ASSET_DIR);
+	mkdirSync(dir, { recursive: true });
+	const written = [];
+	for (const name of names) {
+		const svg = svgs.get(name);
+		if (!svg) continue;
+		writeFileSync(join(dir, `${name}.svg`), svg);
+		written.push(name);
+	}
+	writeFileSync(join(outDir, "pantoken_icons.dart"), flutterIconManifest(written, ICON_ASSET_DIR));
+}
+/**
+* Emit Flutter Dart for an explicit token IR. Returns the written file path.
+*
+* @example Emit a specific theme's IR
+* ```ts
+* import { toFlutter } from "@pantoken/flutter";
+* import { byTheme } from "@pantoken/tokens";
+*
+* const file = await toFlutter(byTheme("canvas"), { outDir: "./lib/tokens" });
+* // writes ./lib/tokens/pantokens.dart (class PanTokens { … })
+* ```
+*
+* @example Dark mode with SVG icon assets and manifest
+* ```ts
+* import { toFlutter } from "@pantoken/flutter";
+* import { byTheme } from "@pantoken/tokens";
+*
+* await toFlutter(byTheme("rebrand"), {
+*   outDir: "./lib/tokens",
+*   mode: "dark",
+*   className: "InstUITokens",
+*   icons: ["add", "check"], // copies SVGs + writes pantoken_icons.dart
+* });
+* ```
+*/
+async function toFlutter(tokens, options) {
+	const dictionary = toStyleDictionary(tokens, options.mode ?? "light");
+	const native = Object.fromEntries(Object.entries(dictionary).filter(([, leaf]) => NATIVE_TYPES.has(leaf.type)));
+	const className = options.className ?? "PanTokens";
+	const file = await buildPlatform({
+		dictionary: native,
+		platform: "flutter",
+		outDir: options.outDir,
+		className,
+		fileName: className.toLowerCase()
+	});
+	if (options.icons?.length) writeFlutterIcons(tokens, options.icons, options.outDir);
+	return file;
+}
+/**
+* Emit Flutter Dart for a named theme. Returns the written file path.
+*
+* @example
+* ```ts
+* import { generateFlutter } from "@pantoken/flutter";
+*
+* const file = await generateFlutter({ outDir: "./lib/tokens", theme: "rebrand" });
+* ```
+*/
+async function generateFlutter(options) {
+	return toFlutter(byTheme(options.theme ?? "rebrand"), options);
+}
+//#endregion
+export { generateFlutter as default, generateFlutter, toFlutter };

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@pantoken/flutter",
+  "version": "0.1.0",
+  "description": "Emit Instructure design tokens as Flutter (Dart) via Style Dictionary.",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@pantoken/core": "0.1.0",
+    "@pantoken/tokens": "0.1.0",
+    "@pantoken/model": "0.1.0",
+    "@pantoken/sd-config": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.13.3",
+    "typescript": "^6.0.3",
+    "vite": "npm:@voidzero-dev/vite-plus-core@0.2.4",
+    "vite-plus": "0.2.4"
+  },
+  "scripts": {
+    "build": "vp pack",
+    "dev": "vp pack --watch",
+    "test": "vp test",
+    "check": "vp check"
+  }
+}