@ic-reactor/codegen 0.2.0 → 0.3.0

package/src/templates/infiniteQuery.test.ts

@@ -1,42 +0,0 @@
-import { describe, it, expect } from "vitest"
-import {
-  generateInfiniteQueryHook,
-  InfiniteQueryHookOptions,
-} from "./infiniteQuery"
-import type { MethodInfo } from "../types"
-
-describe("Infinite Query Hook Generation", () => {
-  const listItems: MethodInfo = {
-    name: "list_items",
-    type: "query",
-    hasArgs: true,
-  }
-
-  it("generates infinite query hook correctly", () => {
-    const options: InfiniteQueryHookOptions = {
-      canisterName: "my_canister",
-      method: listItems,
-      type: "infiniteQuery",
-    }
-    const result = generateInfiniteQueryHook(options)
-    expect(result).toMatchSnapshot()
-    expect(result).toContain("createInfiniteQuery(myCanisterReactor, {")
-    expect(result).toContain(
-      "export const useListItemsInfiniteQuery = listItemsInfiniteQuery.useInfiniteQuery"
-    )
-    // Should contain default pagination logic placeholders
-    expect(result).toContain("initialPageParam: 0 as PageCursor")
-  })
-
-  it("handles suspense infinite query type", () => {
-    const options: InfiniteQueryHookOptions = {
-      canisterName: "my_canister",
-      method: listItems,
-      type: "suspenseInfiniteQuery",
-    }
-    const result = generateInfiniteQueryHook(options)
-    expect(result).toContain(
-      "export const useListItemsSuspenseInfiniteQuery = listItemsSuspenseInfiniteQuery.useInfiniteQuery"
-    )
-  })
-})

package/src/templates/infiniteQuery.ts

@@ -1,74 +0,0 @@
-/**
- * Infinite Query hook template generator
- *
- * Generates createInfiniteQuery-based hooks for paginated canister methods.
- */
-
-import type { MethodInfo, HookType } from "../types.js"
-import {
-  getReactorName,
-  getServiceTypeName,
-  getHookExportName,
-  getReactHookName,
-} from "../naming.js"
-
-export interface InfiniteQueryHookOptions {
-  canisterName: string
-  method: MethodInfo
-  type?: HookType
-}
-
-/**
- * Generate an infinite query hook file content
- */
-export function generateInfiniteQueryHook(
-  options: InfiniteQueryHookOptions
-): string {
-  const { canisterName, method, type = "infiniteQuery" } = options
-
-  const reactorName = getReactorName(canisterName)
-  const serviceName = getServiceTypeName(canisterName)
-  const hookExportName = getHookExportName(method.name, type)
-  const reactHookName = getReactHookName(method.name, type)
-
-  return `/**
- * Infinite Query: ${method.name}
- *
- * Auto-generated by @ic-reactor/codegen
- *
- * ⚠️ CUSTOMIZATION REQUIRED: Configure getArgs and getNextPageParam below.
- *
- * @example
- * const { data, fetchNextPage, hasNextPage } = ${hookExportName}.useInfiniteQuery()
- * const allItems = data?.pages.flatMap(page => page.items) ?? []
- */
-
-import { createInfiniteQuery } from "@ic-reactor/react"
-import { ${reactorName}, type ${serviceName} } from "../reactor"
-
-/** Define your pagination cursor type */
-type PageCursor = number
-
-export const ${hookExportName} = createInfiniteQuery(${reactorName}, {
-  functionName: "${method.name}",
-
-  initialPageParam: 0 as PageCursor,
-
-  /** Convert page param to method arguments — customize for your API */
-  getArgs: (pageParam: PageCursor) => {
-    return [{ offset: pageParam, limit: 10 }] as Parameters<${serviceName}["${method.name}"]>
-  },
-
-  /** Extract next page param — return undefined when no more pages */
-  getNextPageParam: (lastPage, allPages, lastPageParam) => {
-    // Example: offset-based
-    // if (lastPage.items.length < 10) return undefined
-    // return lastPageParam + 10
-    return undefined
-  },
-})
-
-/** React hook for paginated ${method.name} */
-export const ${reactHookName} = ${hookExportName}.useInfiniteQuery
-`
-}

package/src/templates/mutation.test.ts

@@ -1,43 +0,0 @@
-import { describe, it, expect } from "vitest"
-import { generateMutationHook, MutationHookOptions } from "./mutation"
-import type { MethodInfo } from "../types"
-
-describe("Mutation Hook Generation", () => {
-  const methodWithArgs: MethodInfo = {
-    name: "create_item",
-    type: "mutation",
-    hasArgs: true,
-  }
-
-  const methodNoArgs: MethodInfo = {
-    name: "init_system",
-    type: "mutation",
-    hasArgs: false,
-  }
-
-  it("generates hook correctly for mutation with args", () => {
-    const options: MutationHookOptions = {
-      canisterName: "my_canister",
-      method: methodWithArgs,
-    }
-    const result = generateMutationHook(options)
-    expect(result).toMatchSnapshot()
-    expect(result).toContain("createMutation(myCanisterReactor, {")
-    expect(result).toContain(
-      "export const useCreateItemMutation = createItemMutation.useMutation"
-    )
-  })
-
-  it("generates hook correctly for mutation without args", () => {
-    const options: MutationHookOptions = {
-      canisterName: "my_canister",
-      method: methodNoArgs,
-    }
-    const result = generateMutationHook(options)
-    expect(result).toMatchSnapshot()
-    expect(result).toContain("createMutation(myCanisterReactor, {")
-    expect(result).toContain(
-      "export const executeInitSystem = initSystemMutation.execute"
-    )
-  })
-})

package/src/templates/mutation.ts

@@ -1,51 +0,0 @@
-/**
- * Mutation hook template generator
- *
- * Generates createMutation-based hooks for canister update methods.
- */
-
-import type { MethodInfo } from "../types.js"
-import { toPascalCase, getHookExportName, getReactorName } from "../naming.js"
-
-export interface MutationHookOptions {
-  canisterName: string
-  method: MethodInfo
-}
-
-/**
- * Generate a mutation hook file content
- */
-export function generateMutationHook(options: MutationHookOptions): string {
-  const { canisterName, method } = options
-
-  const pascalMethod = toPascalCase(method.name)
-  const reactorName = getReactorName(canisterName)
-  const hookExportName = getHookExportName(method.name, "mutation")
-
-  return `/**
- * Mutation: ${method.name}
- *
- * Auto-generated by @ic-reactor/codegen
- *
- * @example
- * const { mutate, isPending } = ${hookExportName}.useMutation()
- * mutate(${method.hasArgs ? "[arg1, arg2]" : "[]"})
- *
- * // Direct execution (outside React)
- * const result = await ${hookExportName}.execute(${method.hasArgs ? "[arg1, arg2]" : "[]"})
- */
-
-import { createMutation } from "@ic-reactor/react"
-import { ${reactorName} } from "../reactor"
-
-export const ${hookExportName} = createMutation(${reactorName}, {
-  functionName: "${method.name}",
-})
-
-/** React hook for ${method.name} */
-export const use${pascalMethod}Mutation = ${hookExportName}.useMutation
-
-/** Execute ${method.name} directly (outside React) */
-export const execute${pascalMethod} = ${hookExportName}.execute
-`
-}

package/src/templates/query.test.ts

@@ -1,44 +0,0 @@
-import { describe, it, expect } from "vitest"
-import { generateQueryHook, QueryHookOptions } from "./query"
-import type { MethodInfo } from "../types"
-
-describe("Query Hook Generation", () => {
-  const methodWithArgs: MethodInfo = {
-    name: "get_user",
-    type: "query",
-    hasArgs: true,
-  }
-
-  const methodNoArgs: MethodInfo = {
-    name: "list_items",
-    type: "query",
-    hasArgs: false,
-  }
-
-  it("generates hook for query with arguments (factory)", () => {
-    const options: QueryHookOptions = {
-      canisterName: "my_canister",
-      method: methodWithArgs,
-    }
-    expect(generateQueryHook(options)).toMatchSnapshot()
-  })
-
-  it("generates hook for query without arguments (static)", () => {
-    const options: QueryHookOptions = {
-      canisterName: "my_canister",
-      method: methodNoArgs,
-    }
-    expect(generateQueryHook(options)).toMatchSnapshot()
-  })
-
-  it("generates suspense hooks correctly", () => {
-    const options: QueryHookOptions = {
-      canisterName: "my_canister",
-      method: methodWithArgs,
-      type: "suspenseQuery",
-    }
-    const result = generateQueryHook(options)
-    expect(result).toMatchSnapshot()
-    expect(result).toContain("createSuspenseQueryFactory")
-  })
-})

package/src/templates/query.ts

@@ -1,71 +0,0 @@
-/**
- * Query hook template generator
- *
- * Generates createQuery/createQueryFactory-based hooks for canister query methods.
- */
-
-import type { MethodInfo, HookType } from "../types.js"
-import { getHookExportName, getReactorName } from "../naming.js"
-
-export interface QueryHookOptions {
-  canisterName: string
-  method: MethodInfo
-  type?: HookType
-}
-
-/**
- * Generate a query hook file content
- */
-export function generateQueryHook(options: QueryHookOptions): string {
-  const { canisterName, method, type = "query" } = options
-
-  const reactorName = getReactorName(canisterName)
-  const hookExportName = getHookExportName(method.name, type)
-
-  const isSuspense = type === "suspenseQuery"
-  const creatorFn = isSuspense ? "createSuspenseQuery" : "createQuery"
-  const factoryFn = isSuspense
-    ? "createSuspenseQueryFactory"
-    : "createQueryFactory"
-  const hookName = isSuspense ? "useSuspenseQuery" : "useQuery"
-
-  if (method.hasArgs) {
-    return `/**
- * Query Factory: ${method.name}
- *
- * Auto-generated by @ic-reactor/codegen
- *
- * @example
- * const { data } = ${hookExportName}([arg1, arg2]).${hookName}()
- * const data = await ${hookExportName}([arg1, arg2]).fetch()
- * ${hookExportName}([arg1, arg2]).invalidate()
- */
-
-import { ${factoryFn} } from "@ic-reactor/react"
-import { ${reactorName} } from "../reactor"
-
-export const ${hookExportName} = ${factoryFn}(${reactorName}, {
-  functionName: "${method.name}",
-})
-`
-  }
-
-  return `/**
- * Query: ${method.name}
- *
- * Auto-generated by @ic-reactor/codegen
- *
- * @example
- * const { data } = ${hookExportName}.${hookName}()
- * const data = await ${hookExportName}.fetch()
- * ${hookExportName}.invalidate()
- */
-
-import { ${creatorFn} } from "@ic-reactor/react"
-import { ${reactorName} } from "../reactor"
-
-export const ${hookExportName} = ${creatorFn}(${reactorName}, {
-  functionName: "${method.name}",
-})
-`
-}

package/src/types.ts

@@ -1,78 +0,0 @@
-/**
- * Shared types for IC Reactor code generation
- */
-
-/**
- * Information about a canister method extracted from a .did file
- */
-export interface MethodInfo {
-  /** Method name as defined in the Candid interface */
-  name: string
-  /** Whether this method is a query or update (mutation) */
-  type: "query" | "mutation"
-  /** Whether the method accepts arguments */
-  hasArgs: boolean
-  /** Human-readable description of the arguments */
-  argsDescription?: string
-  /** Human-readable description of the return type */
-  returnDescription?: string
-}
-
-/**
- * Configuration for a single canister
- */
-export interface CanisterConfig {
-  /** Name of the canister (used for variable naming) */
-  name?: string
-  /** Path to the .did file */
-  didFile: string
-  /** Output directory (default: ./src/canisters/<name>) */
-  outDir?: string
-  /** Use DisplayReactor for automatic type transformations (default: true) */
-  useDisplayReactor?: boolean
-  /**
-   * Path to import ClientManager from (relative to generated file).
-   * The file at this path should export: { clientManager: ClientManager }
-   * Default: "../../lib/client"
-   */
-  clientManagerPath?: string
-  /** Custom canister ID (optional, uses environment by default) */
-  canisterId?: string
-}
-
-/**
- * Hook generation type
- */
-export type HookType =
-  | "query"
-  | "suspenseQuery"
-  | "infiniteQuery"
-  | "suspenseInfiniteQuery"
-  | "mutation"
-
-/**
- * Options for generating a hook file
- */
-export interface GeneratorOptions {
-  canisterName: string
-  methodName: string
-  methodType: "query" | "mutation"
-  hasArgs: boolean
-  outDir: string
-}
-
-/**
- * Options for reactor file generation
- */
-export interface ReactorGeneratorOptions {
-  canisterName: string
-  canisterConfig: CanisterConfig
-  /** Global default clientManagerPath */
-  globalClientManagerPath?: string
-  /** Whether declarations have been generated */
-  hasDeclarations?: boolean
-  /** Whether to generate advanced per-method hooks (default: false) */
-  advanced?: boolean
-  /** DID content (required when advanced=true) */
-  didContent?: string
-}