@tokamakdev/tok 0.1.1-beta.56 → 0.1.1-beta.58

package/README.md

@@ -1,13 +1,32 @@
 # @tokamakdev/tok
 
-The tokamak CLI, published from the tokamak workspace. The version is the
-workspace Cargo version, with a `-beta.N` suffix for automated pre-releases.
+The tokamak CLI, Vite plugin and app API, published from the tokamak
+workspace. The version is the workspace Cargo version, with a `-beta.N` suffix
+for automated pre-releases.
 
 ```sh
 npm install --save-dev @tokamakdev/tok
 npx tok targets
 ```
 
+| Entry | Contents |
+| --- | --- |
+| `@tokamakdev/tok` | The `Config` type of `src/tokamak.ts` |
+| `@tokamakdev/tok/vite` | The Vite plugin, `tokamak()` |
+| `tok` | The CLI |
+
+The Vite plugin goes next to Cloudflare's:
+
+```ts
+import { cloudflare } from "@cloudflare/vite-plugin";
+import { tokamak } from "@tokamakdev/tok/vite";
+import { defineConfig } from "vite";
+
+export default defineConfig({ plugins: [cloudflare(), tokamak()] });
+```
+
+It does nothing unless `tok` runs the build or development command.
+
 The package installs the `tok` binary for the current machine through an
 optional dependency (`@tokamakdev/tok-darwin-arm64`, `-darwin-x64`,
 `-linux-x64`, or `-win32-x64`), and the platform packs the machine can build

package/dist/index.d.mts

@@ -0,0 +1,28 @@
+/** A setting value. */
+export type Value = string | number | boolean;
+/** One platform's settings: the shared keys and the settings its platform pack declares. */
+export interface PlatformConfig {
+    /** Display name. */
+    name?: string;
+    /** Application identifier. */
+    identifier?: string;
+    /** Icon in the platform's format, relative to the configuration file. */
+    icon?: string;
+    /** A setting the platform pack declares; `tok` validates it. */
+    [key: string]: Value | undefined;
+}
+/** The app's tokamak configuration, exported as `config` from `src/tokamak.ts`. */
+export interface Config {
+    /** Display name for every platform. */
+    name?: string;
+    /** Application identifier for every platform. */
+    identifier?: string;
+    /** Icon for every platform, relative to the configuration file. */
+    icon?: string;
+    /** App version. */
+    version?: string;
+    android?: PlatformConfig;
+    ios?: PlatformConfig;
+    macos?: PlatformConfig;
+    windows?: PlatformConfig;
+}

package/dist/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/vite.d.mts

@@ -0,0 +1,6 @@
+import { type Plugin } from "vite";
+/**
+ * Reports the build's tokamak configuration and development server address to
+ * `tok`. Without `TOKAMAK_VITE_OUTPUT`, which `tok` sets, it adds no hooks.
+ */
+export declare function tokamak(): Plugin[];

package/dist/vite.mjs

@@ -0,0 +1,77 @@
+import fs from "node:fs";
+import path from "node:path";
+import { normalizePath, runnerImport } from "vite";
+/** Configuration files tried in order when `tok` names none. */
+const CONFIG_FILES = ["src/tokamak.ts", "src/tokamak.js"];
+/** The files each output directory's `config.json` was read from, once written. */
+const written = new Map();
+/**
+ * Reports the build's tokamak configuration and development server address to
+ * `tok`. Without `TOKAMAK_VITE_OUTPUT`, which `tok` sets, it adds no hooks.
+ */
+export function tokamak() {
+    const output = process.env.TOKAMAK_VITE_OUTPUT;
+    if (!output) {
+        return [];
+    }
+    let config;
+    const write = () => {
+        const file = findConfigFile(config.root);
+        const files = writeConfig(output, file, config);
+        // A file that fails to load stays watched, so fixing it rewrites `config.json`.
+        written.set(output, files.catch(() => (file ? [file] : [])));
+        return files;
+    };
+    return [
+        {
+            name: "tokamak",
+            async configResolved(resolved) {
+                config = resolved;
+                await (written.has(output) ? written.get(output) : write());
+            },
+            async watchChange(id) {
+                if ((await written.get(output))?.includes(id)) {
+                    await write();
+                }
+            },
+            configureServer(server) {
+                server.httpServer?.on("listening", () => {
+                    const urls = server.resolvedUrls;
+                    writeJson(output, "server.json", { url: urls?.local[0] ?? urls?.network[0] });
+                });
+            },
+        },
+    ];
+}
+/** The configuration file `TOKAMAK_CONFIG` names, or the first default under `root` that exists. */
+function findConfigFile(root) {
+    const named = process.env.TOKAMAK_CONFIG;
+    if (named) {
+        if (!fs.existsSync(named)) {
+            throw new Error(`tokamak configuration file not found: ${named}`);
+        }
+        return normalizePath(path.resolve(named));
+    }
+    const file = CONFIG_FILES.map((name) => path.resolve(root, name)).find((candidate) => fs.existsSync(candidate));
+    return file && normalizePath(file);
+}
+/**
+ * Writes the file's `config` export, with the file's path, to `config.json`,
+ * returning the files it was read from.
+ */
+async function writeConfig(output, file, config) {
+    if (!file) {
+        writeJson(output, "config.json", { config: {} });
+        return [];
+    }
+    const { module, dependencies } = await runnerImport(file, {
+        root: config.root,
+        resolve: { alias: config.resolve.alias, tsconfigPaths: config.resolve.tsconfigPaths },
+    });
+    writeJson(output, "config.json", { file, config: module.config ?? {} });
+    return [file, ...dependencies.map(normalizePath)];
+}
+function writeJson(output, name, value) {
+    fs.mkdirSync(output, { recursive: true });
+    fs.writeFileSync(path.join(output, name), `${JSON.stringify(value, null, 2)}\n`);
+}

package/package.json

@@ -1,35 +1,66 @@
 {
   "name": "@tokamakdev/tok",
-  "version": "0.1.1-beta.56",
-  "description": "The tokamak CLI: build native apps from a Cloudflare Workers codebase",
+  "version": "0.1.1-beta.58",
+  "description": "The tokamak CLI, Vite plugin and app API: build native apps from a Cloudflare Workers codebase",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/mantty/tokamak.git",
     "directory": "tokamak-cli/npm"
   },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./vite": {
+      "types": "./dist/vite.d.mts",
+      "default": "./dist/vite.mjs"
+    }
+  },
   "bin": {
     "tok": "bin/tok.js"
   },
   "files": [
     "bin",
+    "dist",
     "platform.js",
     "README.md"
   ],
+  "scripts": {
+    "build": "tsc",
+    "prepack": "npm run build",
+    "test": "node --test"
+  },
   "engines": {
     "node": ">=18"
   },
+  "peerDependencies": {
+    "@cloudflare/vite-plugin": "^1.0.0",
+    "vite": "^7.0.0 || ^8.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@cloudflare/vite-plugin": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@cloudflare/vite-plugin": "1.62.5",
+    "@types/node": "22.19.15",
+    "typescript": "5.9.3",
+    "vite": "8.3.2"
+  },
   "optionalDependencies": {
-    "@tokamakdev/platform-android-arm64": "0.1.1-beta.56",
-    "@tokamakdev/platform-ios-arm64": "0.1.1-beta.56",
-    "@tokamakdev/platform-ios-simulator-arm64": "0.1.1-beta.56",
-    "@tokamakdev/platform-ios-simulator-x64": "0.1.1-beta.56",
-    "@tokamakdev/platform-macos-arm64": "0.1.1-beta.56",
-    "@tokamakdev/platform-macos-x64": "0.1.1-beta.56",
-    "@tokamakdev/platform-windows-x64": "0.1.1-beta.56",
-    "@tokamakdev/tok-darwin-arm64": "0.1.1-beta.56",
-    "@tokamakdev/tok-darwin-x64": "0.1.1-beta.56",
-    "@tokamakdev/tok-linux-x64": "0.1.1-beta.56",
-    "@tokamakdev/tok-win32-x64": "0.1.1-beta.56"
+    "@tokamakdev/platform-android-arm64": "0.1.1-beta.58",
+    "@tokamakdev/platform-ios-arm64": "0.1.1-beta.58",
+    "@tokamakdev/platform-ios-simulator-arm64": "0.1.1-beta.58",
+    "@tokamakdev/platform-ios-simulator-x64": "0.1.1-beta.58",
+    "@tokamakdev/platform-macos-arm64": "0.1.1-beta.58",
+    "@tokamakdev/platform-macos-x64": "0.1.1-beta.58",
+    "@tokamakdev/platform-windows-x64": "0.1.1-beta.58",
+    "@tokamakdev/tok-darwin-arm64": "0.1.1-beta.58",
+    "@tokamakdev/tok-darwin-x64": "0.1.1-beta.58",
+    "@tokamakdev/tok-linux-x64": "0.1.1-beta.58",
+    "@tokamakdev/tok-win32-x64": "0.1.1-beta.58"
   },
   "publishConfig": {
     "access": "public"