@ic-reactor/vite-plugin 0.5.1 → 0.7.0

package/README.md

@@ -38,12 +38,12 @@ pnpm add @ic-reactor/react @tanstack/react-query @icp-sdk/core
 // vite.config.ts
 import { defineConfig } from "vite"
 import react from "@vitejs/plugin-react"
-import { icReactorPlugin } from "@ic-reactor/vite-plugin"
+import { icReactor } from "@ic-reactor/vite-plugin"
 
 export default defineConfig({
   plugins: [
     react(),
-    icReactorPlugin({
+    icReactor({
       canisters: [
         {
           name: "backend",
@@ -87,6 +87,23 @@ function MyComponent() {
 }
 ```
 
+### Reactor Mode (per canister)
+
+By default, generated hooks use `DisplayReactor` (backward compatible). Set `mode` on a canister to choose the generated reactor class (`Reactor`, `DisplayReactor`, `CandidReactor`, `CandidDisplayReactor`, or `MetadataDisplayReactor`).
+
+```ts
+icReactor({
+  canisters: [
+    { name: "backend", didFile: "./backend/backend.did" },
+    {
+      name: "workflow_engine",
+      mode: "Reactor",
+      didFile: "./workflow/workflow_engine.did",
+    },
+  ],
+})
+```
+
 ## Configuration
 
 ### Plugin Options
@@ -100,13 +117,14 @@ function MyComponent() {
 
 ### Canister Config
 
-| Option              | Type     | Description                                     | Required |
-| :------------------ | :------- | :---------------------------------------------- | :------- |
-| `name`              | `string` | Name of the canister (used for variable names). | Yes      |
-| `didFile`           | `string` | Path to the `.did` file.                        | Yes      |
-| `outDir`            | `string` | Override output directory for this canister.    | No       |
-| `clientManagerPath` | `string` | Override client manager path.                   | No       |
-| `canisterId`        | `string` | Optional fixed canister ID.                     | No       |
+| Option              | Type                                                                                                     | Description                                     | Required |
+| :------------------ | :------------------------------------------------------------------------------------------------------- | :---------------------------------------------- | :------- |
+| `name`              | `string`                                                                                                 | Name of the canister (used for variable names). | Yes      |
+| `didFile`           | `string`                                                                                                 | Path to the `.did` file.                        | Yes      |
+| `outDir`            | `string`                                                                                                 | Override output directory for this canister.    | No       |
+| `clientManagerPath` | `string`                                                                                                 | Override client manager path.                   | No       |
+| `mode`              | `"Reactor" \| "DisplayReactor" \| "CandidReactor" \| "CandidDisplayReactor" \| "MetadataDisplayReactor"` | Reactor class for generated hooks.              | No       |
+| `canisterId`        | `string`                                                                                                 | Optional fixed canister ID.                     | No       |
 
 ## Local Development (Environment Injection)
 

package/dist/index.cjs

@@ -30,7 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  icReactorPlugin: () => icReactorPlugin
+  icReactor: () => icReactor
 });
 module.exports = __toCommonJS(index_exports);
 var import_node_path = __toESM(require("path"), 1);
@@ -78,7 +78,7 @@ function buildIcEnvCookie(canisterIds, rootKey) {
 }
 
 // src/index.ts
-function icReactorPlugin(options) {
+function icReactor(options) {
   const {
     canisters,
     outDir = "src/declarations",
@@ -185,5 +185,5 @@ function icReactorPlugin(options) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  icReactorPlugin
+  icReactor
 });

package/dist/index.d.cts

@@ -31,6 +31,6 @@ interface IcReactorPluginOptions {
      */
     injectEnvironment?: boolean;
 }
-declare function icReactorPlugin(options: IcReactorPluginOptions): any;
+declare function icReactor(options: IcReactorPluginOptions): any;
 
-export { type IcReactorPluginOptions, icReactorPlugin };
+export { type IcReactorPluginOptions, icReactor };

package/dist/index.d.ts

@@ -31,6 +31,6 @@ interface IcReactorPluginOptions {
      */
     injectEnvironment?: boolean;
 }
-declare function icReactorPlugin(options: IcReactorPluginOptions): any;
+declare function icReactor(options: IcReactorPluginOptions): any;
 
-export { type IcReactorPluginOptions, icReactorPlugin };
+export { type IcReactorPluginOptions, icReactor };

package/dist/index.js

@@ -46,7 +46,7 @@ function buildIcEnvCookie(canisterIds, rootKey) {
 }
 
 // src/index.ts
-function icReactorPlugin(options) {
+function icReactor(options) {
   const {
     canisters,
     outDir = "src/declarations",
@@ -152,5 +152,5 @@ function icReactorPlugin(options) {
   return plugin;
 }
 export {
-  icReactorPlugin
+  icReactor
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ic-reactor/vite-plugin",
-  "version": "0.5.1",
+  "version": "0.7.0",
   "description": "Vite plugin for zero-config IC reactor generation from Candid files",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -37,7 +37,7 @@
     "url": "https://github.com/B3Pay/ic-reactor/issues"
   },
   "dependencies": {
-    "@ic-reactor/codegen": "0.5.1"
+    "@ic-reactor/codegen": "0.7.0"
   },
   "peerDependencies": {
     "vite": "^4.2.0 || ^5.0.0 || ^6.0.0 || ^7.0.0"

package/src/index.test.ts

@@ -1,5 +1,5 @@
 import { describe, it, expect, vi, beforeEach } from "vitest"
-import { icReactorPlugin, type IcReactorPluginOptions } from "./index"
+import { icReactor, type IcReactorPluginOptions } from "./index"
 import path from "path"
 import { execFileSync } from "child_process"
 import { runCanisterPipeline } from "@ic-reactor/codegen"
@@ -24,7 +24,7 @@ vi.mock("fs", () => ({
   },
 }))
 
-describe("icReactorPlugin", () => {
+describe("icReactor", () => {
   const mockOptions: IcReactorPluginOptions = {
     canisters: [
       {
@@ -60,7 +60,7 @@ describe("icReactorPlugin", () => {
   })
 
   it("should return correct plugin structure", () => {
-    const plugin = icReactorPlugin(mockOptions)
+    const plugin = icReactor(mockOptions)
     expect(plugin.name).toBe("ic-reactor-plugin")
     expect(plugin.buildStart).toBeDefined()
     expect(plugin.handleHotUpdate).toBeDefined()
@@ -89,7 +89,7 @@ describe("icReactorPlugin", () => {
         }
       )
 
-      const plugin = icReactorPlugin(mockOptions)
+      const plugin = icReactor(mockOptions)
       const config = (plugin as any).config({}, { command: "serve" })
 
       expect(config.server.headers["Set-Cookie"]).toContain("ic_env=")
@@ -107,7 +107,7 @@ describe("icReactorPlugin", () => {
         throw new Error("Command not found")
       })
 
-      const plugin = icReactorPlugin(mockOptions)
+      const plugin = icReactor(mockOptions)
       const config = (plugin as any).config({}, { command: "serve" })
 
       expect(config.server.headers).toBeUndefined()
@@ -115,7 +115,7 @@ describe("icReactorPlugin", () => {
     })
 
     it("should return empty config for build command", () => {
-      const plugin = icReactorPlugin(mockOptions)
+      const plugin = icReactor(mockOptions)
       const config = (plugin as any).config({}, { command: "build" })
 
       expect(config).toEqual({})
@@ -124,7 +124,7 @@ describe("icReactorPlugin", () => {
 
   describe("buildStart", () => {
     it("should generate declarations and reactor file", async () => {
-      const plugin = icReactorPlugin(mockOptions)
+      const plugin = icReactor(mockOptions)
       await (plugin.buildStart as any)()
 
       expect(runCanisterPipeline).toHaveBeenCalledWith({
@@ -147,7 +147,7 @@ describe("icReactorPlugin", () => {
         error: "Failed to generate",
       })
 
-      const plugin = icReactorPlugin(mockOptions)
+      const plugin = icReactor(mockOptions)
       await (plugin.buildStart as any)()
 
       expect(consoleErrorSpy).toHaveBeenCalledWith(
@@ -156,11 +156,37 @@ describe("icReactorPlugin", () => {
 
       consoleErrorSpy.mockRestore()
     })
+
+    it("should pass canister mode through to codegen via canister config", async () => {
+      const plugin = icReactor({
+        canisters: [
+          {
+            ...mockOptions.canisters[0],
+            mode: "Reactor",
+          },
+        ],
+        outDir: mockOptions.outDir,
+      })
+
+      await (plugin.buildStart as any)()
+
+      expect(runCanisterPipeline).toHaveBeenCalledWith({
+        canisterConfig: {
+          ...mockOptions.canisters[0],
+          mode: "Reactor",
+        },
+        projectRoot: expect.any(String),
+        globalConfig: {
+          outDir: "src/declarations",
+          clientManagerPath: "../../clients",
+        },
+      })
+    })
   })
 
   describe("handleHotUpdate", () => {
     it("should restart server when .did file changes", async () => {
-      const plugin = icReactorPlugin(mockOptions)
+      const plugin = icReactor(mockOptions)
       const ctx = {
         file: "/absolute/path/to/src/declarations/test.did",
         server: mockServer,
@@ -181,7 +207,7 @@ describe("icReactorPlugin", () => {
     })
 
     it("should ignore other files", () => {
-      const plugin = icReactorPlugin(mockOptions)
+      const plugin = icReactor(mockOptions)
       const ctx = {
         file: "/some/other/file.ts",
         server: mockServer,

package/src/index.ts

@@ -39,7 +39,7 @@ export interface IcReactorPluginOptions {
   injectEnvironment?: boolean
 }
 
-export function icReactorPlugin(options: IcReactorPluginOptions): any {
+export function icReactor(options: IcReactorPluginOptions): any {
   const {
     canisters,
     outDir = "src/declarations",