w3pk 0.10.2 → 0.10.3

package/dist/inspect/node.d.mts

@@ -1,112 +0,0 @@
-/**
- * Node.js Inspection Module
- *
- * Provides filesystem-based code inspection capabilities for analyzing web3 applications
- * from the server-side or during development. Scans application source code and generates
- * security reports via the Rukh API.
- *
- * @module inspect/node
- */
-/**
- * Configuration options for Node.js-based application inspection
- */
-interface InspectOptions {
-    /**
-     * The root directory of the application to inspect
-     * @default process.cwd()
-     */
-    appPath?: string;
-    /**
-     * File patterns to include (glob patterns)
-     * @default ['**\/*.ts', '**\/*.tsx', '**\/*.js', '**\/*.jsx', '**\/*.json']
-     */
-    includePatterns?: string[];
-    /**
-     * Directories to exclude from inspection
-     * @default ['node_modules', 'dist', '.next', '.git', 'build', 'coverage']
-     */
-    excludeDirs?: string[];
-    /**
-     * Maximum file size in KB to include
-     * @default 500
-     */
-    maxFileSizeKB?: number;
-    /**
-     * Maximum total size in KB for all collected code (prevents exceeding API token limits)
-     * @default 100
-     */
-    maxTotalSizeKB?: number;
-    /**
-     * Focus mode: filters files to only include those relevant to specific features
-     * - 'transactions': Only files with signing, transactions, or blockchain operations
-     * - 'all': Include all files (default)
-     * @default 'all'
-     */
-    focusMode?: 'transactions' | 'all';
-}
-/**
- * Result of the code gathering operation
- */
-interface InspectResult {
-    /**
-     * The generated markdown content with all collected code
-     */
-    markdown: string;
-    /**
-     * List of files that were included
-     */
-    includedFiles: string[];
-    /**
-     * Total size in KB of all included files
-     */
-    totalSizeKB: number;
-}
-/**
- * Gathers application code and generates a markdown document
- *
- * @param options - Configuration options for the inspection
- * @returns An object containing the markdown content and metadata
- *
- * @example
- * ```typescript
- * const result = await gatherCode({
- *   appPath: '../genji-passkey',
- *   includePatterns: ['**\/*.ts', '**\/*.tsx']
- * });
- *
- * console.log(`Collected ${result.includedFiles.length} files`);
- * console.log(`Total size: ${result.totalSizeKB} KB`);
- * ```
- */
-declare function gatherCode(options?: InspectOptions): Promise<InspectResult>;
-/**
- * Inspects an application and returns a security report via Rukh API
- *
- * @param appPath - Path to the application to inspect
- * @param rukhUrl - The Rukh API endpoint URL
- * @param context - The context name to use (should have an instruction file with report format)
- * @param model - The AI model to use ('anthropic', 'mistral', or 'openai')
- * @param focusMode - Focus on 'transactions' or include 'all' files
- * @returns A markdown-formatted security report
- *
- * @example
- * ```typescript
- * const report = await inspect(
- *   '../genji-passkey',
- *   'https://rukh.w3hc.org',
- *   'w3pk',
- *   'anthropic',
- *   'transactions'
- * );
- *
- * console.log(report);
- * // Outputs:
- * // # Genji Passkey Report
- * // ## Available Methods
- * // ### Method #1: Sign Message
- * // ...
- * ```
- */
-declare function inspect(appPath: string, rukhUrl?: string, context?: string, model?: 'anthropic' | 'mistral' | 'openai', focusMode?: 'transactions' | 'all'): Promise<string>;
-
-export { type InspectOptions, type InspectResult, gatherCode, inspect };

package/dist/inspect/node.d.ts

@@ -1,112 +0,0 @@
-/**
- * Node.js Inspection Module
- *
- * Provides filesystem-based code inspection capabilities for analyzing web3 applications
- * from the server-side or during development. Scans application source code and generates
- * security reports via the Rukh API.
- *
- * @module inspect/node
- */
-/**
- * Configuration options for Node.js-based application inspection
- */
-interface InspectOptions {
-    /**
-     * The root directory of the application to inspect
-     * @default process.cwd()
-     */
-    appPath?: string;
-    /**
-     * File patterns to include (glob patterns)
-     * @default ['**\/*.ts', '**\/*.tsx', '**\/*.js', '**\/*.jsx', '**\/*.json']
-     */
-    includePatterns?: string[];
-    /**
-     * Directories to exclude from inspection
-     * @default ['node_modules', 'dist', '.next', '.git', 'build', 'coverage']
-     */
-    excludeDirs?: string[];
-    /**
-     * Maximum file size in KB to include
-     * @default 500
-     */
-    maxFileSizeKB?: number;
-    /**
-     * Maximum total size in KB for all collected code (prevents exceeding API token limits)
-     * @default 100
-     */
-    maxTotalSizeKB?: number;
-    /**
-     * Focus mode: filters files to only include those relevant to specific features
-     * - 'transactions': Only files with signing, transactions, or blockchain operations
-     * - 'all': Include all files (default)
-     * @default 'all'
-     */
-    focusMode?: 'transactions' | 'all';
-}
-/**
- * Result of the code gathering operation
- */
-interface InspectResult {
-    /**
-     * The generated markdown content with all collected code
-     */
-    markdown: string;
-    /**
-     * List of files that were included
-     */
-    includedFiles: string[];
-    /**
-     * Total size in KB of all included files
-     */
-    totalSizeKB: number;
-}
-/**
- * Gathers application code and generates a markdown document
- *
- * @param options - Configuration options for the inspection
- * @returns An object containing the markdown content and metadata
- *
- * @example
- * ```typescript
- * const result = await gatherCode({
- *   appPath: '../genji-passkey',
- *   includePatterns: ['**\/*.ts', '**\/*.tsx']
- * });
- *
- * console.log(`Collected ${result.includedFiles.length} files`);
- * console.log(`Total size: ${result.totalSizeKB} KB`);
- * ```
- */
-declare function gatherCode(options?: InspectOptions): Promise<InspectResult>;
-/**
- * Inspects an application and returns a security report via Rukh API
- *
- * @param appPath - Path to the application to inspect
- * @param rukhUrl - The Rukh API endpoint URL
- * @param context - The context name to use (should have an instruction file with report format)
- * @param model - The AI model to use ('anthropic', 'mistral', or 'openai')
- * @param focusMode - Focus on 'transactions' or include 'all' files
- * @returns A markdown-formatted security report
- *
- * @example
- * ```typescript
- * const report = await inspect(
- *   '../genji-passkey',
- *   'https://rukh.w3hc.org',
- *   'w3pk',
- *   'anthropic',
- *   'transactions'
- * );
- *
- * console.log(report);
- * // Outputs:
- * // # Genji Passkey Report
- * // ## Available Methods
- * // ### Method #1: Sign Message
- * // ...
- * ```
- */
-declare function inspect(appPath: string, rukhUrl?: string, context?: string, model?: 'anthropic' | 'mistral' | 'openai', focusMode?: 'transactions' | 'all'): Promise<string>;
-
-export { type InspectOptions, type InspectResult, gatherCode, inspect };