@pantoken/compose 0.1.0

package/README.md

@@ -0,0 +1,54 @@
+# @pantoken/compose
+
+Emit Instructure design tokens as a Jetpack Compose (Kotlin) object, via Style Dictionary. It's the
+modern Android counterpart to `@pantoken/android`'s resource XML: it flattens the token IR to
+concrete, single-mode values and keeps the natively-typed tokens (colours, dimensions, numbers).
+
+## Install
+
+```sh
+npm i @pantoken/compose
+```
+
+## Usage
+
+```ts
+import { generateCompose } from "@pantoken/compose";
+
+const file = await generateCompose({
+  outDir: "./app/src/main/kotlin",
+  theme: "rebrand",
+  className: "PanTokens", // the generated Kotlin object name (default)
+});
+```
+
+Or via the CLI:
+
+```sh
+pantoken generate compose --out ./app/src/main/kotlin
+pantoken generate compose --out ./app/src/main/kotlin --theme canvas --class BrandTokens
+```
+
+## Output
+
+A single Kotlin file (named after `className`) declaring a Compose object of `Color`, `Dp`, and
+numeric constants. Reference them straight from composables. Use this for Compose UIs; for the
+Android View-system (XML) resources, use `@pantoken/android`.
+
+## API
+
+- **`generateCompose(options): Promise<string>`** — emit Kotlin for a named theme (from the vendored
+  `@pantoken/tokens` IR). Returns the written file path.
+- **`toCompose(tokens, options): Promise<string>`** — same, but for an explicit token IR. Returns
+  the written file path.
+- **`GenerateComposeOptions`** — the `outDir`, `theme`, `mode`, and `className` options both take.
+
+## Related
+
+- Pairs with `@pantoken/android` for the Android View-system (XML) counterpart.
+- 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,50 @@
+import { Mode } from "@pantoken/core";
+import { Theme, Token } from "@pantoken/model";
+
+//#region src/index.d.ts
+/** Options for {@link generateCompose} / {@link toCompose}. */
+interface GenerateComposeOptions {
+  outDir: string;
+  theme?: Theme;
+  mode?: Mode;
+  /** The generated Kotlin object name (default `PanTokens`). */
+  className?: string;
+}
+/**
+ * Emit Compose Kotlin for an explicit token IR. Returns the written file path.
+ *
+ * @example Emit a specific theme's IR
+ * ```ts
+ * import { toCompose } from "@pantoken/compose";
+ * import { byTheme } from "@pantoken/tokens";
+ *
+ * const file = await toCompose(byTheme("canvas"), { outDir: "./ui/tokens" });
+ * // writes ./ui/tokens/PanTokens.kt (object PanTokens { … })
+ * ```
+ *
+ * @example Dark mode with a custom object name
+ * ```ts
+ * import { toCompose } from "@pantoken/compose";
+ * import { byTheme } from "@pantoken/tokens";
+ *
+ * await toCompose(byTheme("rebrand"), {
+ *   outDir: "./ui/tokens",
+ *   mode: "dark",
+ *   className: "InstUITokens", // writes InstUITokens.kt
+ * });
+ * ```
+ */
+declare function toCompose(tokens: readonly Token[], options: GenerateComposeOptions): Promise<string>;
+/**
+ * Emit Compose Kotlin for a named theme. Returns the written file path.
+ *
+ * @example
+ * ```ts
+ * import { generateCompose } from "@pantoken/compose";
+ *
+ * const file = await generateCompose({ outDir: "./ui/tokens", theme: "rebrand" });
+ * ```
+ */
+declare function generateCompose(options: GenerateComposeOptions): Promise<string>;
+//#endregion
+export { GenerateComposeOptions, generateCompose as default, generateCompose, toCompose };

package/dist/index.mjs

@@ -0,0 +1,68 @@
+import { toStyleDictionary } from "@pantoken/core";
+import { buildPlatform } from "@pantoken/sd-config";
+import { byTheme } from "@pantoken/tokens";
+//#region src/index.ts
+/**
+* `@pantoken/compose` — emit Instructure design tokens as Jetpack Compose (Kotlin), via Style
+* Dictionary. It flattens the IR to concrete, single-mode values and keeps the natively-typed
+* tokens (colours, dimensions, numbers).
+*
+* @module
+* @experimental
+*/
+const NATIVE_TYPES = /* @__PURE__ */ new Set([
+	"color",
+	"dimension",
+	"number"
+]);
+/**
+* Emit Compose Kotlin for an explicit token IR. Returns the written file path.
+*
+* @example Emit a specific theme's IR
+* ```ts
+* import { toCompose } from "@pantoken/compose";
+* import { byTheme } from "@pantoken/tokens";
+*
+* const file = await toCompose(byTheme("canvas"), { outDir: "./ui/tokens" });
+* // writes ./ui/tokens/PanTokens.kt (object PanTokens { … })
+* ```
+*
+* @example Dark mode with a custom object name
+* ```ts
+* import { toCompose } from "@pantoken/compose";
+* import { byTheme } from "@pantoken/tokens";
+*
+* await toCompose(byTheme("rebrand"), {
+*   outDir: "./ui/tokens",
+*   mode: "dark",
+*   className: "InstUITokens", // writes InstUITokens.kt
+* });
+* ```
+*/
+async function toCompose(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";
+	return buildPlatform({
+		dictionary: native,
+		platform: "compose",
+		outDir: options.outDir,
+		className,
+		fileName: className
+	});
+}
+/**
+* Emit Compose Kotlin for a named theme. Returns the written file path.
+*
+* @example
+* ```ts
+* import { generateCompose } from "@pantoken/compose";
+*
+* const file = await generateCompose({ outDir: "./ui/tokens", theme: "rebrand" });
+* ```
+*/
+async function generateCompose(options) {
+	return toCompose(byTheme(options.theme ?? "rebrand"), options);
+}
+//#endregion
+export { generateCompose as default, generateCompose, toCompose };

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@pantoken/compose",
+  "version": "0.1.0",
+  "description": "Emit Instructure design tokens as Jetpack Compose (Kotlin) via Style Dictionary.",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@pantoken/model": "0.1.0",
+    "@pantoken/tokens": "0.1.0",
+    "@pantoken/sd-config": "0.1.0",
+    "@pantoken/core": "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"
+  }
+}