@ic-reactor/codegen 0.4.0 → 0.5.0

package/src/bindgen.ts

@@ -1,101 +0,0 @@
-/**
- * Bindgen utilities
- *
- * Generates TypeScript declarations from Candid files using @ic-reactor/parser.
- */
-
-import { didToJs, didToTs } from "@ic-reactor/parser"
-import path from "node:path"
-import fs from "node:fs"
-
-export interface BindgenOptions {
-  /** Path to the .did file */
-  didFile: string
-  /** Output directory for generated declarations */
-  outDir: string
-  /** Canister name (used for naming) */
-  canisterName: string
-}
-
-export interface BindgenResult {
-  success: boolean
-  declarationsDir: string
-  error?: string
-}
-
-/**
- * Generate TypeScript declarations from a Candid file
- *
- * This creates:
- * - declarations/<canisterName>.js - IDL factory
- * - declarations/<canisterName>.d.ts - Types
- */
-export async function generateDeclarations(
-  options: BindgenOptions
-): Promise<BindgenResult> {
-  const { didFile, outDir } = options
-
-  // Ensure the .did file exists
-  if (!fs.existsSync(didFile)) {
-    return {
-      success: false,
-      declarationsDir: "",
-      error: `DID file not found: ${didFile}`,
-    }
-  }
-
-  const declarationsDir = path.join(outDir, "declarations")
-  const didFileName = path.basename(didFile) // e.g., "my_canister.did"
-
-  try {
-    // Read content first so we can safely delete the directory if didFile is inside it
-    const didContent = fs.readFileSync(didFile, "utf-8")
-
-    // Ensure the output directory exists
-    if (!fs.existsSync(outDir)) {
-      fs.mkdirSync(outDir, { recursive: true })
-    }
-
-    // Clean existing declarations before regenerating
-    if (fs.existsSync(declarationsDir)) {
-      fs.rmSync(declarationsDir, { recursive: true, force: true })
-    }
-    fs.mkdirSync(declarationsDir, { recursive: true })
-
-    const jsContent = didToJs(didContent)
-    const tsContent = didToTs(didContent)
-
-    // Write .did, .js and .d.ts
-    const baseName = didFileName.replace(/\.did$/, "")
-    const jsPath = path.join(declarationsDir, baseName + ".js")
-    const dtsPath = path.join(declarationsDir, baseName + ".d.ts")
-    const didPath = path.join(declarationsDir, didFileName)
-
-    fs.writeFileSync(jsPath, jsContent)
-    fs.writeFileSync(dtsPath, tsContent)
-    fs.writeFileSync(didPath, didContent)
-
-    return {
-      success: true,
-      declarationsDir,
-    }
-  } catch (error) {
-    return {
-      success: false,
-      declarationsDir,
-      error: error instanceof Error ? error.message : String(error),
-    }
-  }
-}
-
-/**
- * Check if declarations already exist for a canister
- */
-export function declarationsExist(
-  outDir: string,
-  canisterName: string
-): boolean {
-  const declarationsDir = path.join(outDir, "declarations")
-  const didTsPath = path.join(declarationsDir, `${canisterName}.d.ts`)
-  return fs.existsSync(didTsPath)
-}

package/src/templates/__snapshots__/client.test.ts.snap

@@ -1,35 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`Client File Generation > generates correctly with custom query client 1`] = `
-"import { ClientManager } from "@ic-reactor/react"
-import { queryClient } from "../query-client"
-
-/**
- * IC Reactor Client Manager
- * 
- * Auto-generated by @ic-reactor/codegen
- */
-export const clientManager = new ClientManager({
-  queryClient,
-  withCanisterEnv: true,
-})
-"
-`;
-
-exports[`Client File Generation > generates correctly with default host 1`] = `
-"import { ClientManager } from "@ic-reactor/react"
-import { QueryClient } from "@tanstack/react-query"
-
-export const queryClient = new QueryClient()
-
-/**
- * IC Reactor Client Manager
- * 
- * Auto-generated by @ic-reactor/codegen
- */
-export const clientManager = new ClientManager({
-  queryClient,
-  withCanisterEnv: true,
-})
-"
-`;

package/src/templates/__snapshots__/reactor.test.ts.snap

@@ -1,28 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`Reactor File Generation > Standard Mode > generates correctly 1`] = `
-"import { DisplayReactor, createActorHooks } from "@ic-reactor/react"
-import { clientManager } from "../../client"
-import { idlFactory, type _SERVICE } from "./declarations/my_canister"
-
-export type MyCanisterService = _SERVICE
-
-/**
- * MyCanister Display Reactor
- */
-export const myCanisterReactor = new DisplayReactor<MyCanisterService>({
-  clientManager,
-  idlFactory,
-  name: "my_canister",
-})
-
-export const {
-  useActorQuery: useMyCanisterQuery,
-  useActorSuspenseQuery: useMyCanisterSuspenseQuery,
-  useActorInfiniteQuery: useMyCanisterInfiniteQuery,
-  useActorSuspenseInfiniteQuery: useMyCanisterSuspenseInfiniteQuery,
-  useActorMutation: useMyCanisterMutation,
-  useActorMethod: useMyCanisterMethod,
-} = createActorHooks(myCanisterReactor)
-"
-`;

package/src/templates/client.test.ts

@@ -1,20 +0,0 @@
-import { describe, it, expect } from "vitest"
-import { generateClientFile } from "./client"
-
-describe("Client File Generation", () => {
-  it("generates correctly with default host", () => {
-    const result = generateClientFile()
-    expect(result).toMatchSnapshot()
-    expect(result).toContain(
-      'import { QueryClient } from "@tanstack/react-query'
-    )
-  })
-
-  it("generates correctly with custom query client", () => {
-    const result = generateClientFile({
-      queryClientPath: "../query-client",
-    })
-    expect(result).toMatchSnapshot()
-    expect(result).toContain('import { queryClient } from "../query-client"')
-  })
-})

package/src/templates/client.ts

@@ -1,37 +0,0 @@
-/**
- * Client Manager Generator
- */
-
-export interface ClientGeneratorOptions {
-  /** Optional path to an existing queryClient */
-  queryClientPath?: string
-}
-
-/**
- * Generate a central client manager file
- */
-export function generateClientFile(
-  options: ClientGeneratorOptions = {}
-): string {
-  const { queryClientPath } = options
-
-  return `import { ClientManager } from "@ic-reactor/react"
-${
-  queryClientPath
-    ? `import { queryClient } from "${queryClientPath}"`
-    : `import { QueryClient } from "@tanstack/react-query"
-
-export const queryClient = new QueryClient()`
-}
-
-/**
- * IC Reactor Client Manager
- * 
- * Auto-generated by @ic-reactor/codegen
- */
-export const clientManager = new ClientManager({
-  queryClient,
-  withCanisterEnv: true,
-})
-`
-}

package/src/templates/reactor.test.ts

@@ -1,23 +0,0 @@
-import { describe, it, expect } from "vitest"
-import { generateReactorFile, type ReactorGeneratorOptions } from "./reactor"
-
-describe("Reactor File Generation", () => {
-  const baseOptions: ReactorGeneratorOptions = {
-    canisterName: "my_canister",
-    didFile: "path/to/my_canister.did",
-    clientManagerPath: "../../client",
-  }
-
-  describe("Standard Mode", () => {
-    it("generates correctly", () => {
-      const result = generateReactorFile(baseOptions)
-      expect(result).toMatchSnapshot()
-    })
-
-    it("uses default client path if not provided", () => {
-      const options = { ...baseOptions, canisterConfig: { didFile: "foo.did" } }
-      const result = generateReactorFile(options)
-      expect(result).toContain('import { clientManager } from "../../client"')
-    })
-  })
-})

package/src/templates/reactor.ts

@@ -1,99 +0,0 @@
-/**
- * Reactor file template generator
- *
- * Generates the reactor instance file for a canister using DisplayReactor.
- * Standardizes the output to include typed hooks and clean imports.
- */
-
-import path from "node:path"
-import { toPascalCase, getReactorName, getServiceTypeName } from "../naming.js"
-
-export type ReactorGeneratorOptions = {
-  canisterName: string
-  didFile: string
-  clientManagerPath?: string
-}
-
-/**
- * Generate the reactor file content
- */
-export function generateReactorFile(options: ReactorGeneratorOptions): string {
-  const pascalName = toPascalCase(options.canisterName)
-  const reactorName = getReactorName(options.canisterName)
-  const serviceName = getServiceTypeName(options.canisterName)
-  // Always use DisplayReactor for now
-  const reactorType = "DisplayReactor"
-
-  const didFileName = path.basename(options.didFile)
-  const baseName = didFileName.replace(/\.did$/, "")
-  const declarationsPath = `./declarations/${baseName}`
-  const clientManagerPath = options.clientManagerPath ?? "../../clients"
-
-  const vars: TemplateVars = {
-    canisterName: options.canisterName,
-    pascalName,
-    reactorName,
-    serviceName,
-    reactorType,
-    clientManagerPath,
-    declarationsPath,
-  }
-
-  // If we have DID content, we can generate method-specific hooks (clean & typed)
-  return generateStandardReactorFile(vars)
-}
-
-// ═══════════════════════════════════════════════════════════════════════════
-// SHARED TYPES
-// ═══════════════════════════════════════════════════════════════════════════
-
-interface TemplateVars {
-  canisterName: string
-  pascalName: string
-  reactorName: string
-  serviceName: string
-  reactorType: string
-  clientManagerPath: string
-  declarationsPath: string
-}
-
-// ═══════════════════════════════════════════════════════════════════════════
-// STANDARD MODE
-// ═══════════════════════════════════════════════════════════════════════════
-
-function generateStandardReactorFile(vars: TemplateVars): string {
-  const {
-    pascalName,
-    reactorName,
-    serviceName,
-    reactorType,
-    clientManagerPath,
-    declarationsPath,
-    canisterName,
-  } = vars
-
-  return `import { ${reactorType}, createActorHooks } from "@ic-reactor/react"
-import { clientManager } from "${clientManagerPath}"
-import { idlFactory, type _SERVICE } from "${declarationsPath}"
-
-export type ${serviceName} = _SERVICE
-
-/**
- * ${pascalName} Display Reactor
- */
-export const ${reactorName} = new ${reactorType}<${serviceName}>({
-  clientManager,
-  idlFactory,
-  name: "${canisterName}",
-})
-
-export const {
-  useActorQuery: use${pascalName}Query,
-  useActorSuspenseQuery: use${pascalName}SuspenseQuery,
-  useActorInfiniteQuery: use${pascalName}InfiniteQuery,
-  useActorSuspenseInfiniteQuery: use${pascalName}SuspenseInfiniteQuery,
-  useActorMutation: use${pascalName}Mutation,
-  useActorMethod: use${pascalName}Method,
-} = createActorHooks(${reactorName})
-`
-}