@yydb/light-db 0.0.0 → 0.0.10

package/dist/index.js

@@ -1,729 +1,19 @@
-"use strict";
 /**
- * LightDB 存储引擎
+ * `@yydb/light-db`
  *
- * 这是一个高性能的 TypeScript 数据库存储层实现。
- * 提供完整的 WAL（预写日志）、检查点、崩溃恢复和索引管理功能。
+ * 浏览器专用的纯 TypeScript 数据库，与 `@yydb/yydb` 保持同构的用户 API。
+ * 公共类型只有 `Uint8Array` 与 `Promise`，不依赖 Node `Buffer`、文件系统或 WASM。
  *
  * @packageDocumentation
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BPlusTreeNodeType =
-    exports.IndexType =
-    exports.createStorageEngine =
-    exports.StorageEngine =
-    exports.RecoveryPhase =
-    exports.RecoveryValidator =
-    exports.FastRecoveryManager =
-    exports.RecoveryManager =
-    exports.IncrementalCheckpointManager =
-    exports.AutoCheckpointScheduler =
-    exports.CheckpointManager =
-    exports.WalIndexManager =
-    exports.ShmFileManager =
-    exports.ShmHashTable =
-    exports.ShmSerializer =
-    exports.WalManager =
-    exports.WalReader =
-    exports.WalWriter =
-    exports.WalRecordSerializer =
-    exports.PageManager =
-    exports.LightFileManager =
-    exports.LightFileSerializer =
-    exports.FileHandleWrapper =
-    exports.FileUtils =
-    exports.BufferReader =
-    exports.BufferWriter =
-    exports.BinaryUtils =
-    exports.ConfigurationError =
-    exports.SerializationError =
-    exports.PageError =
-    exports.CheckpointError =
-    exports.RecoveryError =
-    exports.WalError =
-    exports.ChecksumError =
-    exports.FileFormatError =
-    exports.FileOperationError =
-    exports.StorageError =
-    exports.FILE_EXTENSIONS =
-    exports.OperationType =
-    exports.PAGE_HEADER_SIZE =
-    exports.SHM_DEFAULT_CAPACITY =
-    exports.SHM_ENTRY_SIZE =
-    exports.SHM_HEADER_SIZE =
-    exports.WAL_RECORD_HEADER_SIZE =
-    exports.HEADER_SIZE =
-    exports.DEFAULT_WAL_THRESHOLD =
-    exports.DEFAULT_PAGE_SIZE =
-    exports.LIGHT_VERSION =
-    exports.LIGHT_MAGIC_STRING =
-    exports.LIGHT_MAGIC =
-        void 0;
-exports.GeneratorUtils =
-    exports.lazyIterator =
-    exports.lazy =
-    exports.LazyQueryBuilder =
-    exports.LazyQueryIterator =
-    exports.ReentrantRWLock =
-    exports.RWLockManager =
-    exports.RWLock =
-    exports.WriteLockHandle =
-    exports.ReadLockHandle =
-    exports.BatchWriteManager =
-    exports.BatchWalWriter =
-    exports.BufferConcatenator =
-    exports.FastSerializer =
-    exports.OptimizedBufferReader =
-    exports.OptimizedBufferWriter =
-    exports.getGlobalBufferPool =
-    exports.BufferPool =
-    exports.ColumnarStorage =
-    exports.ColumnType =
-    exports.openDatabase =
-    exports.defineCollectionSchema =
-    exports.LightDB =
-    exports.TransactionManager =
-    exports.Transaction =
-    exports.TransactionError =
-    exports.CollectionError =
-    exports.Collection =
-    exports.QueryBuilder =
-    exports.QueryParser =
-    exports.IndexManager =
-    exports.SecondaryIndex =
-    exports.PrimaryIndex =
-    exports.BPlusTree =
-    exports.RangeQueryError =
-    exports.IndexConsistencyError =
-    exports.IndexOperationError =
-    exports.IndexConfigError =
-    exports.IndexExistsError =
-    exports.IndexNotFoundError =
-    exports.KeyNotFoundError =
-    exports.DuplicateKeyError =
-    exports.IndexError =
-        void 0;
-exports.openStorageEngine = openStorageEngine;
-// 常量导出
-var constants_1 = require("./constants");
-Object.defineProperty(exports, "LIGHT_MAGIC", {
-    enumerable: true,
-    get: function () {
-        return constants_1.LIGHT_MAGIC;
-    },
-});
-Object.defineProperty(exports, "LIGHT_MAGIC_STRING", {
-    enumerable: true,
-    get: function () {
-        return constants_1.LIGHT_MAGIC_STRING;
-    },
-});
-Object.defineProperty(exports, "LIGHT_VERSION", {
-    enumerable: true,
-    get: function () {
-        return constants_1.LIGHT_VERSION;
-    },
-});
-Object.defineProperty(exports, "DEFAULT_PAGE_SIZE", {
-    enumerable: true,
-    get: function () {
-        return constants_1.DEFAULT_PAGE_SIZE;
-    },
-});
-Object.defineProperty(exports, "DEFAULT_WAL_THRESHOLD", {
-    enumerable: true,
-    get: function () {
-        return constants_1.DEFAULT_WAL_THRESHOLD;
-    },
-});
-Object.defineProperty(exports, "HEADER_SIZE", {
-    enumerable: true,
-    get: function () {
-        return constants_1.HEADER_SIZE;
-    },
-});
-Object.defineProperty(exports, "WAL_RECORD_HEADER_SIZE", {
-    enumerable: true,
-    get: function () {
-        return constants_1.WAL_RECORD_HEADER_SIZE;
-    },
-});
-Object.defineProperty(exports, "SHM_HEADER_SIZE", {
-    enumerable: true,
-    get: function () {
-        return constants_1.SHM_HEADER_SIZE;
-    },
-});
-Object.defineProperty(exports, "SHM_ENTRY_SIZE", {
-    enumerable: true,
-    get: function () {
-        return constants_1.SHM_ENTRY_SIZE;
-    },
-});
-Object.defineProperty(exports, "SHM_DEFAULT_CAPACITY", {
-    enumerable: true,
-    get: function () {
-        return constants_1.SHM_DEFAULT_CAPACITY;
-    },
-});
-Object.defineProperty(exports, "PAGE_HEADER_SIZE", {
-    enumerable: true,
-    get: function () {
-        return constants_1.PAGE_HEADER_SIZE;
-    },
-});
-Object.defineProperty(exports, "OperationType", {
-    enumerable: true,
-    get: function () {
-        return constants_1.OperationType;
-    },
-});
-Object.defineProperty(exports, "FILE_EXTENSIONS", {
-    enumerable: true,
-    get: function () {
-        return constants_1.FILE_EXTENSIONS;
-    },
-});
-// 错误类导出
-var errors_1 = require("./errors");
-Object.defineProperty(exports, "StorageError", {
-    enumerable: true,
-    get: function () {
-        return errors_1.StorageError;
-    },
-});
-Object.defineProperty(exports, "FileOperationError", {
-    enumerable: true,
-    get: function () {
-        return errors_1.FileOperationError;
-    },
-});
-Object.defineProperty(exports, "FileFormatError", {
-    enumerable: true,
-    get: function () {
-        return errors_1.FileFormatError;
-    },
-});
-Object.defineProperty(exports, "ChecksumError", {
-    enumerable: true,
-    get: function () {
-        return errors_1.ChecksumError;
-    },
-});
-Object.defineProperty(exports, "WalError", {
-    enumerable: true,
-    get: function () {
-        return errors_1.WalError;
-    },
-});
-Object.defineProperty(exports, "RecoveryError", {
-    enumerable: true,
-    get: function () {
-        return errors_1.RecoveryError;
-    },
-});
-Object.defineProperty(exports, "CheckpointError", {
-    enumerable: true,
-    get: function () {
-        return errors_1.CheckpointError;
-    },
-});
-Object.defineProperty(exports, "PageError", {
-    enumerable: true,
-    get: function () {
-        return errors_1.PageError;
-    },
-});
-Object.defineProperty(exports, "SerializationError", {
-    enumerable: true,
-    get: function () {
-        return errors_1.SerializationError;
-    },
-});
-Object.defineProperty(exports, "ConfigurationError", {
-    enumerable: true,
-    get: function () {
-        return errors_1.ConfigurationError;
-    },
-});
-// 工具类导出
-var utils_1 = require("./utils");
-Object.defineProperty(exports, "BinaryUtils", {
-    enumerable: true,
-    get: function () {
-        return utils_1.BinaryUtils;
-    },
-});
-Object.defineProperty(exports, "BufferWriter", {
-    enumerable: true,
-    get: function () {
-        return utils_1.BufferWriter;
-    },
-});
-Object.defineProperty(exports, "BufferReader", {
-    enumerable: true,
-    get: function () {
-        return utils_1.BufferReader;
-    },
-});
-Object.defineProperty(exports, "FileUtils", {
-    enumerable: true,
-    get: function () {
-        return utils_1.FileUtils;
-    },
-});
-Object.defineProperty(exports, "FileHandleWrapper", {
-    enumerable: true,
-    get: function () {
-        return utils_1.FileHandleWrapper;
-    },
-});
-// 存储组件导出
-var storage_1 = require("./storage");
-Object.defineProperty(exports, "LightFileSerializer", {
-    enumerable: true,
-    get: function () {
-        return storage_1.LightFileSerializer;
-    },
-});
-Object.defineProperty(exports, "LightFileManager", {
-    enumerable: true,
-    get: function () {
-        return storage_1.LightFileManager;
-    },
-});
-Object.defineProperty(exports, "PageManager", {
-    enumerable: true,
-    get: function () {
-        return storage_1.PageManager;
-    },
-});
-var storage_2 = require("./storage");
-Object.defineProperty(exports, "WalRecordSerializer", {
-    enumerable: true,
-    get: function () {
-        return storage_2.WalRecordSerializer;
-    },
-});
-Object.defineProperty(exports, "WalWriter", {
-    enumerable: true,
-    get: function () {
-        return storage_2.WalWriter;
-    },
-});
-Object.defineProperty(exports, "WalReader", {
-    enumerable: true,
-    get: function () {
-        return storage_2.WalReader;
-    },
-});
-Object.defineProperty(exports, "WalManager", {
-    enumerable: true,
-    get: function () {
-        return storage_2.WalManager;
-    },
-});
-var storage_3 = require("./storage");
-Object.defineProperty(exports, "ShmSerializer", {
-    enumerable: true,
-    get: function () {
-        return storage_3.ShmSerializer;
-    },
-});
-Object.defineProperty(exports, "ShmHashTable", {
-    enumerable: true,
-    get: function () {
-        return storage_3.ShmHashTable;
-    },
-});
-Object.defineProperty(exports, "ShmFileManager", {
-    enumerable: true,
-    get: function () {
-        return storage_3.ShmFileManager;
-    },
-});
-Object.defineProperty(exports, "WalIndexManager", {
-    enumerable: true,
-    get: function () {
-        return storage_3.WalIndexManager;
-    },
-});
-var storage_4 = require("./storage");
-Object.defineProperty(exports, "CheckpointManager", {
-    enumerable: true,
-    get: function () {
-        return storage_4.CheckpointManager;
-    },
-});
-Object.defineProperty(exports, "AutoCheckpointScheduler", {
-    enumerable: true,
-    get: function () {
-        return storage_4.AutoCheckpointScheduler;
-    },
-});
-Object.defineProperty(exports, "IncrementalCheckpointManager", {
-    enumerable: true,
-    get: function () {
-        return storage_4.IncrementalCheckpointManager;
-    },
-});
-var storage_5 = require("./storage");
-Object.defineProperty(exports, "RecoveryManager", {
-    enumerable: true,
-    get: function () {
-        return storage_5.RecoveryManager;
-    },
-});
-Object.defineProperty(exports, "FastRecoveryManager", {
-    enumerable: true,
-    get: function () {
-        return storage_5.FastRecoveryManager;
-    },
-});
-Object.defineProperty(exports, "RecoveryValidator", {
-    enumerable: true,
-    get: function () {
-        return storage_5.RecoveryValidator;
-    },
-});
-Object.defineProperty(exports, "RecoveryPhase", {
-    enumerable: true,
-    get: function () {
-        return storage_5.RecoveryPhase;
-    },
-});
-var storage_6 = require("./storage");
-Object.defineProperty(exports, "StorageEngine", {
-    enumerable: true,
-    get: function () {
-        return storage_6.StorageEngine;
-    },
-});
-Object.defineProperty(exports, "createStorageEngine", {
-    enumerable: true,
-    get: function () {
-        return storage_6.createStorageEngine;
-    },
-});
-const storage_7 = require("./storage");
-/**
- * 打开存储引擎
- *
- * @param basePath - 数据库文件存储路径
- * @param dbName - 数据库名称
- * @param options - 配置选项
- * @returns 初始化完成的存储引擎实例
- *
- * @example
- * ```typescript
- * import { openStorageEngine } from '@yydb/light-db';
- *
- * const engine = await openStorageEngine('./data', 'mydb', {
- *   pageSize: 4096,
- *   walThreshold: 16 * 1024 * 1024,
- *   autoCheckpoint: true
- * });
- *
- * // 插入数据
- * await engine.insert('key1', Buffer.from('value1'));
- *
- * // 读取数据
- * const value = await engine.get('key1');
- *
- * // 关闭引擎
- * await engine.close();
- * ```
- */
-async function openStorageEngine(basePath, dbName, options) {
-    return (0, storage_7.createStorageEngine)(basePath, dbName, options);
-}
-// 索引引擎导出
-var indexes_1 = require("./indexes");
-Object.defineProperty(exports, "IndexType", {
-    enumerable: true,
-    get: function () {
-        return indexes_1.IndexType;
-    },
-});
-Object.defineProperty(exports, "BPlusTreeNodeType", {
-    enumerable: true,
-    get: function () {
-        return indexes_1.BPlusTreeNodeType;
-    },
-});
-var indexes_2 = require("./indexes");
-Object.defineProperty(exports, "IndexError", {
-    enumerable: true,
-    get: function () {
-        return indexes_2.IndexError;
-    },
-});
-Object.defineProperty(exports, "DuplicateKeyError", {
-    enumerable: true,
-    get: function () {
-        return indexes_2.DuplicateKeyError;
-    },
-});
-Object.defineProperty(exports, "KeyNotFoundError", {
-    enumerable: true,
-    get: function () {
-        return indexes_2.KeyNotFoundError;
-    },
-});
-Object.defineProperty(exports, "IndexNotFoundError", {
-    enumerable: true,
-    get: function () {
-        return indexes_2.IndexNotFoundError;
-    },
-});
-Object.defineProperty(exports, "IndexExistsError", {
-    enumerable: true,
-    get: function () {
-        return indexes_2.IndexExistsError;
-    },
-});
-Object.defineProperty(exports, "IndexConfigError", {
-    enumerable: true,
-    get: function () {
-        return indexes_2.IndexConfigError;
-    },
-});
-Object.defineProperty(exports, "IndexOperationError", {
-    enumerable: true,
-    get: function () {
-        return indexes_2.IndexOperationError;
-    },
-});
-Object.defineProperty(exports, "IndexConsistencyError", {
-    enumerable: true,
-    get: function () {
-        return indexes_2.IndexConsistencyError;
-    },
-});
-Object.defineProperty(exports, "RangeQueryError", {
-    enumerable: true,
-    get: function () {
-        return indexes_2.RangeQueryError;
-    },
-});
-var indexes_3 = require("./indexes");
-Object.defineProperty(exports, "BPlusTree", {
-    enumerable: true,
-    get: function () {
-        return indexes_3.BPlusTree;
-    },
-});
-var indexes_4 = require("./indexes");
-Object.defineProperty(exports, "PrimaryIndex", {
-    enumerable: true,
-    get: function () {
-        return indexes_4.PrimaryIndex;
-    },
-});
-var indexes_5 = require("./indexes");
-Object.defineProperty(exports, "SecondaryIndex", {
-    enumerable: true,
-    get: function () {
-        return indexes_5.SecondaryIndex;
-    },
-});
-var indexes_6 = require("./indexes");
-Object.defineProperty(exports, "IndexManager", {
-    enumerable: true,
-    get: function () {
-        return indexes_6.IndexManager;
-    },
-});
-var collection_1 = require("./collection");
-Object.defineProperty(exports, "QueryParser", {
-    enumerable: true,
-    get: function () {
-        return collection_1.QueryParser;
-    },
-});
-var collection_2 = require("./collection");
-Object.defineProperty(exports, "QueryBuilder", {
-    enumerable: true,
-    get: function () {
-        return collection_2.QueryBuilder;
-    },
-});
-var collection_3 = require("./collection");
-Object.defineProperty(exports, "Collection", {
-    enumerable: true,
-    get: function () {
-        return collection_3.Collection;
-    },
-});
-Object.defineProperty(exports, "CollectionError", {
-    enumerable: true,
-    get: function () {
-        return collection_3.CollectionError;
-    },
-});
-var api_1 = require("./api");
-Object.defineProperty(exports, "TransactionError", {
-    enumerable: true,
-    get: function () {
-        return api_1.TransactionError;
-    },
-});
-Object.defineProperty(exports, "Transaction", {
-    enumerable: true,
-    get: function () {
-        return api_1.Transaction;
-    },
-});
-Object.defineProperty(exports, "TransactionManager", {
-    enumerable: true,
-    get: function () {
-        return api_1.TransactionManager;
-    },
-});
-var api_2 = require("./api");
-Object.defineProperty(exports, "LightDB", {
-    enumerable: true,
-    get: function () {
-        return api_2.LightDB;
-    },
-});
-Object.defineProperty(exports, "defineCollectionSchema", {
-    enumerable: true,
-    get: function () {
-        return api_2.defineCollectionSchema;
-    },
-});
-Object.defineProperty(exports, "openDatabase", {
-    enumerable: true,
-    get: function () {
-        return api_2.openDatabase;
-    },
-});
-// 性能优化模块导出
-var performance_1 = require("./performance");
-Object.defineProperty(exports, "ColumnType", {
-    enumerable: true,
-    get: function () {
-        return performance_1.ColumnType;
-    },
-});
-var performance_2 = require("./performance");
-Object.defineProperty(exports, "ColumnarStorage", {
-    enumerable: true,
-    get: function () {
-        return performance_2.ColumnarStorage;
-    },
-});
-var performance_3 = require("./performance");
-Object.defineProperty(exports, "BufferPool", {
-    enumerable: true,
-    get: function () {
-        return performance_3.BufferPool;
-    },
-});
-Object.defineProperty(exports, "getGlobalBufferPool", {
-    enumerable: true,
-    get: function () {
-        return performance_3.getGlobalBufferPool;
-    },
-});
-Object.defineProperty(exports, "OptimizedBufferWriter", {
-    enumerable: true,
-    get: function () {
-        return performance_3.OptimizedBufferWriter;
-    },
-});
-Object.defineProperty(exports, "OptimizedBufferReader", {
-    enumerable: true,
-    get: function () {
-        return performance_3.OptimizedBufferReader;
-    },
-});
-Object.defineProperty(exports, "FastSerializer", {
-    enumerable: true,
-    get: function () {
-        return performance_3.FastSerializer;
-    },
-});
-Object.defineProperty(exports, "BufferConcatenator", {
-    enumerable: true,
-    get: function () {
-        return performance_3.BufferConcatenator;
-    },
-});
-var performance_4 = require("./performance");
-Object.defineProperty(exports, "BatchWalWriter", {
-    enumerable: true,
-    get: function () {
-        return performance_4.BatchWalWriter;
-    },
-});
-Object.defineProperty(exports, "BatchWriteManager", {
-    enumerable: true,
-    get: function () {
-        return performance_4.BatchWriteManager;
-    },
-});
-var performance_5 = require("./performance");
-Object.defineProperty(exports, "ReadLockHandle", {
-    enumerable: true,
-    get: function () {
-        return performance_5.ReadLockHandle;
-    },
-});
-Object.defineProperty(exports, "WriteLockHandle", {
-    enumerable: true,
-    get: function () {
-        return performance_5.WriteLockHandle;
-    },
-});
-Object.defineProperty(exports, "RWLock", {
-    enumerable: true,
-    get: function () {
-        return performance_5.RWLock;
-    },
-});
-Object.defineProperty(exports, "RWLockManager", {
-    enumerable: true,
-    get: function () {
-        return performance_5.RWLockManager;
-    },
-});
-Object.defineProperty(exports, "ReentrantRWLock", {
-    enumerable: true,
-    get: function () {
-        return performance_5.ReentrantRWLock;
-    },
-});
-var performance_6 = require("./performance");
-Object.defineProperty(exports, "LazyQueryIterator", {
-    enumerable: true,
-    get: function () {
-        return performance_6.LazyQueryIterator;
-    },
-});
-Object.defineProperty(exports, "LazyQueryBuilder", {
-    enumerable: true,
-    get: function () {
-        return performance_6.LazyQueryBuilder;
-    },
-});
-Object.defineProperty(exports, "lazy", {
-    enumerable: true,
-    get: function () {
-        return performance_6.lazy;
-    },
-});
-Object.defineProperty(exports, "lazyIterator", {
-    enumerable: true,
-    get: function () {
-        return performance_6.lazyIterator;
-    },
-});
-Object.defineProperty(exports, "GeneratorUtils", {
-    enumerable: true,
-    get: function () {
-        return performance_6.GeneratorUtils;
-    },
-});
-//# sourceMappingURL=index.js.map
+// 错误模型
+export { LightDbError, LightDbErrorCodes } from './errors';
+// 编解码
+export { BinaryUtils, ByteWriter, ByteReader, ChecksumMismatchError, crc32, checksumMatches, DEFAULT_PAGE_SIZE, SNAPSHOT_MAGIC, SNAPSHOT_VERSION, SNAPSHOT_HEADER_SIZE, PAGE_HEADER_SIZE, RecordTooLargeError, SnapshotFormatError, WalOperation, encodeSnapshot, decodeSnapshot, encodeWalRecord, decodeWalRecord, } from './codec';
+// 存储平台边界
+export { STORAGE_FILES, MemoryStorageAdapter, MemoryStorageBackend, OpfsStorageAdapter, OpfsStorageAdapterFactory, isOpfsAvailable, IndexedDbStorageAdapter, IndexedDbStorageAdapterFactory, isIndexedDbAvailable, } from './storage';
+// 数据库语义
+export { StorageEngine, DEFAULT_WAL_THRESHOLD, acquireWriterLease, listenDatabaseEvents } from './core';
+// 作者面
+export { BrowserDatabase, openLightDatabase, Transaction, SCHEMA_KEY, RESERVED_KEY_PREFIX, documentVersion, parseSchemaDocument, encodeSchema, decodeSchema, } from './api';
+//# sourceMappingURL=index.js.map