@ic-reactor/codegen 0.12.1 → 0.13.0

package/dist/index.d.cts

@@ -190,6 +190,18 @@ declare function assertSafeCanisterName(name: unknown): asserts name is string;
  * remote host at import time, inside the user's own bundle.
  */
 declare function assertSafeModuleSpecifier(label: string, specifier: unknown): asserts specifier is string;
+/**
+ * Derive the declarations file stem from a `.did` path and assert it is usable
+ * both as a file name and as the tail of the import specifier we emit.
+ *
+ * `path.basename` is happy to hand back `"."` or `".."`: a `didFile` of
+ * `"canisters/.."` makes the generated reactor `import … from
+ * "./declarations/.."`, a *directory* reference — reported as a successful
+ * generation, rejected by the consumer's bundler. Validating the derived
+ * specifier here is the same treatment `clientManagerPath` gets, for the same
+ * reason: it is config-supplied text that ends up inside an `import`.
+ */
+declare function resolveDeclarationsBaseName(didFile: unknown): string;
 /** Reactor classes the generator knows how to emit an import for. */
 declare const REACTOR_CLASS_NAMES: readonly ReactorClassName[];
 /** Runtime targets the generator knows how to emit. */
@@ -250,34 +262,6 @@ interface ValidateCanisterConfigOptions {
  */
 declare function assertSafeCanisterConfig(options: ValidateCanisterConfigOptions): ValidatedCanisterPaths;
 
-/**
- * Candid Parser Utilities
- *
- * Parses Candid .did files to extract service method signatures.
- * Used by the CLI for listing methods and by advanced generators.
- */
-type MethodType = "query" | "mutation";
-interface MethodInfo {
-    /** Method name as it appears in the Candid service */
-    name: string;
-    /** "query" for read-only calls, "mutation" for update calls */
-    type: MethodType;
-    /** True if the method takes at least one argument */
-    hasArgs: boolean;
-}
-/**
- * Extract method information from raw Candid source text.
- *
- * Compiles the Candid to JS and inspects the IDL.Service definition.
- */
-declare function extractMethods(didContent: string): MethodInfo[];
-/**
- * Parse a .did file from disk and return its methods.
- *
- * @throws if the file does not exist or fails to parse
- */
-declare function parseDIDFile(didFilePath: string): MethodInfo[];
-
 /**
  * Declarations Generator
  *
@@ -304,17 +288,17 @@ interface DeclarationsGeneratorResult {
     files: GeneratorResult[];
     error?: string;
 }
-/**
- * Generate TypeScript declarations from a Candid file.
- *
- * Always cleans and regenerates the declarations directory to ensure
- * it's in sync with the source .did file.
- */
 declare function generateDeclarations(options: DeclarationsGeneratorOptions): Promise<DeclarationsGeneratorResult>;
 /**
  * Check if declarations already exist for a canister.
+ *
+ * Declarations are written under the *.did basename*, which need not equal the
+ * canister name — `{ name: "backend", didFile: "service.did" }` writes
+ * `declarations/service.d.ts`. Pass `didFile` for an exact answer; without it
+ * this falls back to any `.d.ts` in the directory, because a bare
+ * `<canisterName>.d.ts` check reports "missing" for perfectly good output.
  */
-declare function declarationsExist(outDir: string, canisterName: string): boolean;
+declare function declarationsExist(outDir: string, canisterName: string, didFile?: string): boolean;
 
 /**
  * Reactor File Generator
@@ -393,4 +377,4 @@ interface ClientGeneratorOptions {
  */
 declare function generateClientFile(options?: ClientGeneratorOptions): string;
 
-export { CANISTER_NAME_PATTERN, CODEGEN_TARGETS, type CanisterConfig, type ClientGeneratorOptions, type CodegenConfig, CodegenConfigError, type CodegenTarget, type DeclarationsGeneratorOptions, type DeclarationsGeneratorResult, type GeneratorResult, type MethodInfo, type MethodType, type PipelineOptions, type PipelineResult, REACTOR_CLASS_NAMES, type ReactorClassName, type ReactorGeneratorOptions, type ValidateCanisterConfigOptions, type ValidatedCanisterPaths, assertContainedPath, assertOneOf, assertSafeCanisterConfig, assertSafeCanisterName, assertSafeModuleSpecifier, declarationsExist, extractMethods, generateClientFile, generateDeclarations, generateReactorEntryFile, generateReactorFile, getReactorName, getServiceTypeName, parseDIDFile, resolveContainedOutDir, runCanisterPipeline, toPascalCase };
+export { CANISTER_NAME_PATTERN, CODEGEN_TARGETS, type CanisterConfig, type ClientGeneratorOptions, type CodegenConfig, CodegenConfigError, type CodegenTarget, type DeclarationsGeneratorOptions, type DeclarationsGeneratorResult, type GeneratorResult, type PipelineOptions, type PipelineResult, REACTOR_CLASS_NAMES, type ReactorClassName, type ReactorGeneratorOptions, type ValidateCanisterConfigOptions, type ValidatedCanisterPaths, assertContainedPath, assertOneOf, assertSafeCanisterConfig, assertSafeCanisterName, assertSafeModuleSpecifier, declarationsExist, generateClientFile, generateDeclarations, generateReactorEntryFile, generateReactorFile, getReactorName, getServiceTypeName, resolveContainedOutDir, resolveDeclarationsBaseName, runCanisterPipeline, toPascalCase };

package/dist/index.d.ts

@@ -190,6 +190,18 @@ declare function assertSafeCanisterName(name: unknown): asserts name is string;
  * remote host at import time, inside the user's own bundle.
  */
 declare function assertSafeModuleSpecifier(label: string, specifier: unknown): asserts specifier is string;
+/**
+ * Derive the declarations file stem from a `.did` path and assert it is usable
+ * both as a file name and as the tail of the import specifier we emit.
+ *
+ * `path.basename` is happy to hand back `"."` or `".."`: a `didFile` of
+ * `"canisters/.."` makes the generated reactor `import … from
+ * "./declarations/.."`, a *directory* reference — reported as a successful
+ * generation, rejected by the consumer's bundler. Validating the derived
+ * specifier here is the same treatment `clientManagerPath` gets, for the same
+ * reason: it is config-supplied text that ends up inside an `import`.
+ */
+declare function resolveDeclarationsBaseName(didFile: unknown): string;
 /** Reactor classes the generator knows how to emit an import for. */
 declare const REACTOR_CLASS_NAMES: readonly ReactorClassName[];
 /** Runtime targets the generator knows how to emit. */
@@ -250,34 +262,6 @@ interface ValidateCanisterConfigOptions {
  */
 declare function assertSafeCanisterConfig(options: ValidateCanisterConfigOptions): ValidatedCanisterPaths;
 
-/**
- * Candid Parser Utilities
- *
- * Parses Candid .did files to extract service method signatures.
- * Used by the CLI for listing methods and by advanced generators.
- */
-type MethodType = "query" | "mutation";
-interface MethodInfo {
-    /** Method name as it appears in the Candid service */
-    name: string;
-    /** "query" for read-only calls, "mutation" for update calls */
-    type: MethodType;
-    /** True if the method takes at least one argument */
-    hasArgs: boolean;
-}
-/**
- * Extract method information from raw Candid source text.
- *
- * Compiles the Candid to JS and inspects the IDL.Service definition.
- */
-declare function extractMethods(didContent: string): MethodInfo[];
-/**
- * Parse a .did file from disk and return its methods.
- *
- * @throws if the file does not exist or fails to parse
- */
-declare function parseDIDFile(didFilePath: string): MethodInfo[];
-
 /**
  * Declarations Generator
  *
@@ -304,17 +288,17 @@ interface DeclarationsGeneratorResult {
     files: GeneratorResult[];
     error?: string;
 }
-/**
- * Generate TypeScript declarations from a Candid file.
- *
- * Always cleans and regenerates the declarations directory to ensure
- * it's in sync with the source .did file.
- */
 declare function generateDeclarations(options: DeclarationsGeneratorOptions): Promise<DeclarationsGeneratorResult>;
 /**
  * Check if declarations already exist for a canister.
+ *
+ * Declarations are written under the *.did basename*, which need not equal the
+ * canister name — `{ name: "backend", didFile: "service.did" }` writes
+ * `declarations/service.d.ts`. Pass `didFile` for an exact answer; without it
+ * this falls back to any `.d.ts` in the directory, because a bare
+ * `<canisterName>.d.ts` check reports "missing" for perfectly good output.
  */
-declare function declarationsExist(outDir: string, canisterName: string): boolean;
+declare function declarationsExist(outDir: string, canisterName: string, didFile?: string): boolean;
 
 /**
  * Reactor File Generator
@@ -393,4 +377,4 @@ interface ClientGeneratorOptions {
  */
 declare function generateClientFile(options?: ClientGeneratorOptions): string;
 
-export { CANISTER_NAME_PATTERN, CODEGEN_TARGETS, type CanisterConfig, type ClientGeneratorOptions, type CodegenConfig, CodegenConfigError, type CodegenTarget, type DeclarationsGeneratorOptions, type DeclarationsGeneratorResult, type GeneratorResult, type MethodInfo, type MethodType, type PipelineOptions, type PipelineResult, REACTOR_CLASS_NAMES, type ReactorClassName, type ReactorGeneratorOptions, type ValidateCanisterConfigOptions, type ValidatedCanisterPaths, assertContainedPath, assertOneOf, assertSafeCanisterConfig, assertSafeCanisterName, assertSafeModuleSpecifier, declarationsExist, extractMethods, generateClientFile, generateDeclarations, generateReactorEntryFile, generateReactorFile, getReactorName, getServiceTypeName, parseDIDFile, resolveContainedOutDir, runCanisterPipeline, toPascalCase };
+export { CANISTER_NAME_PATTERN, CODEGEN_TARGETS, type CanisterConfig, type ClientGeneratorOptions, type CodegenConfig, CodegenConfigError, type CodegenTarget, type DeclarationsGeneratorOptions, type DeclarationsGeneratorResult, type GeneratorResult, type PipelineOptions, type PipelineResult, REACTOR_CLASS_NAMES, type ReactorClassName, type ReactorGeneratorOptions, type ValidateCanisterConfigOptions, type ValidatedCanisterPaths, assertContainedPath, assertOneOf, assertSafeCanisterConfig, assertSafeCanisterName, assertSafeModuleSpecifier, declarationsExist, generateClientFile, generateDeclarations, generateReactorEntryFile, generateReactorFile, getReactorName, getServiceTypeName, resolveContainedOutDir, resolveDeclarationsBaseName, runCanisterPipeline, toPascalCase };