David Snelling d8de4083f5 **fix(cache): remove outdated ES module compatibility solution and enhance shims for 'os' and 'url' modules**

- Removed `SOLUTION.md` as it contained an outdated explanation of ES module compatibility fixes for cache detection.
- Updated `rollup.config.js`:
  - Added detailed shims for 'url' and 'os' modules to ensure proper functionality in browser environments:
    - **OS Shim**: Provided reasonable defaults for `totalmem()`, `freemem()`, `platform()`, and `arch()` to maintain compatibility and consistency.
    - **URL Shim**: Added `fileURLToPath` and `pathToFileURL` to handle browser-specific file paths.
  - Updated `nodeBuiltins` to include `'node:url'` and `'node:os'` for handling edge cases in module resolution.

**Purpose**: Streamline codebase by removing redundant documentation and enhancing compatibility shims for ES modules, ensuring seamless operation in browser environments.

2025-08-01 15:35:41 -07:00

1.7 KiB

Raw Blame History

Changes Summary

Issue Description

The build process was failing with a TypeScript error:

(!) [plugin typescript] src/utils/embedding.ts (227:11): @rollup/plugin-typescript TS2741: Property 'init' is missing in type '{ embed: (sentences: string | string[]) => Promise<any>; dispose: () => Promise<void>; }' but required in type 'EmbeddingModel'.

The error occurred because the model object created when loading the Universal Sentence Encoder from local files was missing the required init() method defined in the EmbeddingModel interface.

Changes Made

Added the missing init() method to the model object in src/utils/embedding.ts:
- The model object created when loading from local files now includes an init() method
- Since the model is already loaded at this point, the method is implemented as a no-op that logs a message
- This ensures the object fully implements the EmbeddingModel interface
Updated documentation in SOLUTION.md:
- Added a new section explaining the TypeScript interface compliance requirements
- Documented the need for all three methods (init(), embed(), and dispose()) to be implemented

Verification

The build process now completes successfully without TypeScript errors. The warnings about unresolved dependencies for 'url' and 'os' modules are expected and unrelated to our fix.

Technical Details

The EmbeddingModel interface in src/coreTypes.ts requires three methods:

init(): For initializing the model
embed(): For converting text to embeddings
dispose(): For cleaning up resources

When loading the model from local files, we now ensure all three methods are implemented, maintaining type safety and consistent behavior across different loading methods.