@ic-reactor/vite-plugin 0.6.0 → 0.7.0

package/README.md

@@ -87,56 +87,23 @@ function MyComponent() {
 }
 ```
 
-### Reactor Mode (raw vs display)
+### Reactor Mode (per canister)
 
-By default, generated hooks use `DisplayReactor` (backward compatible). You can switch the default globally, and override specific canisters that need raw Candid shapes.
+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", didFile: "./workflow/workflow_engine.did" },
-  ],
-  reactor: {
-    defaultMode: "display",
-    canisters: {
-      workflow_engine: "raw",
+    {
+      name: "workflow_engine",
+      mode: "Reactor",
+      didFile: "./workflow/workflow_engine.did",
     },
-  },
+  ],
 })
 ```
 
-Generated canister folders now contain:
-
-- `index.generated.ts` (overwritten on regenerate)
-- `index.ts` (created once if missing, never overwritten)
-
-The generated implementation exports both factories so apps can opt in explicitly without editing generated files:
-
-```ts
-// display-default canister (generated)
-export function createBackendRawReactor() {
-  /* ... */
-}
-export function createBackendDisplayReactor() {
-  /* ... */
-}
-export const backendReactor = createBackendDisplayReactor()
-export const BackendReactorMode = "display" as const
-```
-
-```ts
-// raw-default canister (generated)
-export function createWorkflowEngineRawReactor() {
-  /* ... */
-}
-export function createWorkflowEngineDisplayReactor() {
-  /* ... */
-}
-export const workflowEngineReactor = createWorkflowEngineRawReactor()
-export const WorkflowEngineReactorMode = "raw" as const
-```
-
 ## Configuration
 
 ### Plugin Options
@@ -147,24 +114,17 @@ export const WorkflowEngineReactorMode = "raw" as const
 | `outDir`            | `string`           | Base output directory for generated files.          | `"src/declarations"` |
 | `clientManagerPath` | `string`           | Path to client manager import.                      | `"../../clients"`    |
 | `injectEnvironment` | `boolean`          | Inject `ic_env` cookie for local development.       | `true`               |
-| `reactor`           | `ReactorConfig`    | Default/per-canister raw vs display reactor mode.   | display default      |
 
 ### 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       |
-
-### ReactorConfig
-
-| Option        | Type                                 | Description                              | Required |
-| :------------ | :----------------------------------- | :--------------------------------------- | :------- |
-| `defaultMode` | `"raw" \| "display"`                 | Global default mode for generated hooks. | No       |
-| `canisters`   | `Record<string, "raw" \| "display">` | Per-canister overrides keyed by name.    | 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

@@ -83,16 +83,12 @@ function icReactor(options) {
     canisters,
     outDir = "src/declarations",
     clientManagerPath = "../../clients",
-    injectEnvironment = true,
-    reactor
+    injectEnvironment = true
   } = options;
   const globalConfig = {
     outDir,
     clientManagerPath
   };
-  if (reactor != null) {
-    globalConfig.reactor = reactor;
-  }
   const plugin = {
     name: "ic-reactor-plugin",
     enforce: "pre",

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { CanisterConfig, ReactorGenerationConfig } from '@ic-reactor/codegen';
+import { CanisterConfig } from '@ic-reactor/codegen';
 
 /**
  * @ic-reactor/vite-plugin
@@ -30,11 +30,6 @@ interface IcReactorPluginOptions {
      * Default: true
      */
     injectEnvironment?: boolean;
-    /**
-     * Reactor generation behavior.
-     * Controls whether generated default hooks use raw (Reactor) or display (DisplayReactor).
-     */
-    reactor?: ReactorGenerationConfig;
 }
 declare function icReactor(options: IcReactorPluginOptions): any;
 

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { CanisterConfig, ReactorGenerationConfig } from '@ic-reactor/codegen';
+import { CanisterConfig } from '@ic-reactor/codegen';
 
 /**
  * @ic-reactor/vite-plugin
@@ -30,11 +30,6 @@ interface IcReactorPluginOptions {
      * Default: true
      */
     injectEnvironment?: boolean;
-    /**
-     * Reactor generation behavior.
-     * Controls whether generated default hooks use raw (Reactor) or display (DisplayReactor).
-     */
-    reactor?: ReactorGenerationConfig;
 }
 declare function icReactor(options: IcReactorPluginOptions): any;
 

package/dist/index.js

@@ -51,16 +51,12 @@ function icReactor(options) {
     canisters,
     outDir = "src/declarations",
     clientManagerPath = "../../clients",
-    injectEnvironment = true,
-    reactor
+    injectEnvironment = true
   } = options;
   const globalConfig = {
     outDir,
     clientManagerPath
   };
-  if (reactor != null) {
-    globalConfig.reactor = reactor;
-  }
   const plugin = {
     name: "ic-reactor-plugin",
     enforce: "pre",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ic-reactor/vite-plugin",
-  "version": "0.6.0",
+  "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.6.0"
+    "@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

@@ -157,31 +157,28 @@ describe("icReactor", () => {
       consoleErrorSpy.mockRestore()
     })
 
-    it("should pass reactor mode config to codegen", async () => {
+    it("should pass canister mode through to codegen via canister config", async () => {
       const plugin = icReactor({
-        ...mockOptions,
-        reactor: {
-          defaultMode: "display",
-          canisters: {
-            test_canister: "raw",
+        canisters: [
+          {
+            ...mockOptions.canisters[0],
+            mode: "Reactor",
           },
-        },
+        ],
+        outDir: mockOptions.outDir,
       })
 
       await (plugin.buildStart as any)()
 
       expect(runCanisterPipeline).toHaveBeenCalledWith({
-        canisterConfig: mockOptions.canisters[0],
+        canisterConfig: {
+          ...mockOptions.canisters[0],
+          mode: "Reactor",
+        },
         projectRoot: expect.any(String),
         globalConfig: {
           outDir: "src/declarations",
           clientManagerPath: "../../clients",
-          reactor: {
-            defaultMode: "display",
-            canisters: {
-              test_canister: "raw",
-            },
-          },
         },
       })
     })

package/src/index.ts

@@ -13,7 +13,6 @@ import {
   runCanisterPipeline,
   type CanisterConfig,
   type CodegenConfig,
-  type ReactorGenerationConfig,
 } from "@ic-reactor/codegen"
 import { getIcEnvironmentInfo, buildIcEnvCookie } from "./env.js"
 
@@ -38,11 +37,6 @@ export interface IcReactorPluginOptions {
    * Default: true
    */
   injectEnvironment?: boolean
-  /**
-   * Reactor generation behavior.
-   * Controls whether generated default hooks use raw (Reactor) or display (DisplayReactor).
-   */
-  reactor?: ReactorGenerationConfig
 }
 
 export function icReactor(options: IcReactorPluginOptions): any {
@@ -51,20 +45,13 @@ export function icReactor(options: IcReactorPluginOptions): any {
     outDir = "src/declarations",
     clientManagerPath = "../../clients",
     injectEnvironment = true,
-    reactor,
   } = options
 
   // Construct a partial CodegenConfig to pass to the pipeline
-  const globalConfig: Pick<
-    CodegenConfig,
-    "outDir" | "clientManagerPath" | "reactor"
-  > = {
+  const globalConfig: Pick<CodegenConfig, "outDir" | "clientManagerPath"> = {
     outDir,
     clientManagerPath,
   }
-  if (reactor != null) {
-    globalConfig.reactor = reactor
-  }
 
   const plugin: Plugin = {
     name: "ic-reactor-plugin",