@noir-lang/noir_wasm 0.23.0-f466fa1.nightly → 0.24.0

package/dist/types/build/cjs/index.d.ts

@@ -3,9 +3,9 @@ export function compile_(entry_point: string, contracts: boolean | undefined, de
 export function init_log_level(filter: string): void;
 export function build_info(): any;
 export function __wbindgen_object_drop_ref(arg0: any): void;
-export function __wbg_constructor_28ca684b2f9696ac(...args: any[]): any;
+export function __wbg_constructor_05d6d198f3477d6f(...args: any[]): any;
 export function __wbindgen_is_undefined(arg0: any): boolean;
-export function __wbg_constructor_287b714b768ecf13(...args: any[]): any;
+export function __wbg_constructor_e8767839abf8a966(...args: any[]): any;
 export function __wbg_new_abda76e883ba8a5f(...args: any[]): any;
 export function __wbg_stack_658279fe44541cf6(...args: any[]): any;
 export function __wbg_error_f851667af71bcfc6(...args: any[]): any;

package/dist/types/src/index.d.cts

@@ -3,6 +3,36 @@ import { createNodejsFileManager } from './noir/file-manager/nodejs-file-manager
 import { LogFn } from './utils';
 import { CompilationResult } from './types/noir_artifact';
 import { inflateDebugSymbols } from './noir/debug';
+/**
+ * Compiles a Noir project
+ *
+ * @param fileManager - The file manager to use
+ * @param projectPath - The path to the project inside the file manager. Defaults to the root of the file manager
+ * @param logFn - A logging function. If not provided, console.log will be used
+ * @param debugLogFn - A debug logging function. If not provided, logFn will be used
+ *
+ * @example
+ * ```typescript
+ * // Node.js
+ *
+ * import { compile, createFileManager } from '@noir-lang/noir_wasm';
+ *
+ * const fm = createFileManager(myProjectPath);
+ * const myCompiledCode = await compile(fm);
+ * ```
+ *
+ * ```typescript
+ * // Browser
+ *
+ * import { compile, createFileManager } from '@noir-lang/noir_wasm';
+ *
+ * const fm = createFileManager('/');
+ * for (const path of files) {
+ *   await fm.writeFile(path, await getFileAsStream(path));
+ * }
+ * const myCompiledCode = await compile(fm);
+ * ```
+ */
 declare function compile(fileManager: FileManager, projectPath?: string, logFn?: LogFn, debugLogFn?: LogFn): Promise<CompilationResult>;
 declare const createFileManager: typeof createNodejsFileManager;
 export { compile, createFileManager, inflateDebugSymbols, CompilationResult };

package/dist/types/src/index.d.mts

@@ -3,6 +3,36 @@ import { createNodejsFileManager } from './noir/file-manager/nodejs-file-manager
 import { LogFn } from './utils';
 import { CompilationResult } from './types/noir_artifact';
 import { inflateDebugSymbols } from './noir/debug';
+/**
+ * Compiles a Noir project
+ *
+ * @param fileManager - The file manager to use
+ * @param projectPath - The path to the project inside the file manager. Defaults to the root of the file manager
+ * @param logFn - A logging function. If not provided, console.log will be used
+ * @param debugLogFn - A debug logging function. If not provided, logFn will be used
+ *
+ * @example
+ * ```typescript
+ * // Node.js
+ *
+ * import { compile, createFileManager } from '@noir-lang/noir_wasm';
+ *
+ * const fm = createFileManager(myProjectPath);
+ * const myCompiledCode = await compile(fm);
+ * ```
+ *
+ * ```typescript
+ * // Browser
+ *
+ * import { compile, createFileManager } from '@noir-lang/noir_wasm';
+ *
+ * const fm = createFileManager('/');
+ * for (const path of files) {
+ *   await fm.writeFile(path, await getFileAsStream(path));
+ * }
+ * const myCompiledCode = await compile(fm);
+ * ```
+ */
 declare function compile(fileManager: FileManager, projectPath?: string, logFn?: LogFn, debugLogFn?: LogFn): Promise<CompilationResult>;
 declare const createFileManager: typeof createNodejsFileManager;
 export { compile, createFileManager, inflateDebugSymbols, CompilationResult };

package/dist/types/src/noir/debug.d.ts

@@ -1,2 +1,5 @@
-/** Decompresses and decodes the debug symbols */
+/**
+ * Decompresses and decodes the debug symbols
+ * @param debugSymbols - The base64 encoded debug symbols
+ */
 export declare function inflateDebugSymbols(debugSymbols: string): any;

package/dist/types/src/noir/file-manager/nodejs-file-manager.d.ts

@@ -1,7 +1,8 @@
 import { FileManager } from './file-manager';
 export declare function readdirRecursive(dir: string): Promise<string[]>;
 /**
- * Creates a new FileManager instance based on nodejs fs
- * @param dataDir - where to store files
+ * Creates a new FileManager instance based on fs in node and memfs in the browser (via webpack alias)
+ *
+ * @param dataDir - root of the file system
  */
 export declare function createNodejsFileManager(dataDir: string): FileManager;

package/dist/types/src/types/noir_artifact.d.ts

@@ -1,4 +1,4 @@
-import { Abi, AbiType } from '@noir-lang/noirc_abi';
+import { Abi, AbiType } from '@noir-lang/types';
 /**
  * A named type.
  */