@fireproof/core 0.19.8-dev → 0.19.8-dev-alldocs-export

package/index.d.ts

@@ -10,6 +10,7 @@ import { BlockFetcher as BlockFetcher$1 } from '@web3-storage/pail/api';
 import { ProllyNode as ProllyNode$1 } from 'prolly-trees/db-index';
 import { EventBlock } from '@web3-storage/pail/clock';
 import { PathLike, MakeDirectoryOptions, Stats, ObjectEncodingOptions, Dirent } from 'node:fs';
+import { RunResult } from 'better-sqlite3';
 
 interface GatewayOpts {
     readonly gateway: Gateway;
@@ -443,78 +444,79 @@ declare class ConnectREST extends ConnectionBase {
 declare function toURL(pathOrUrl: string | URL, isIndex?: string): URL;
 interface StoreFactoryItem {
     readonly protocol: string;
+    readonly overrideBaseURL?: string;
     readonly data: (logger: Logger) => Promise<Gateway>;
     readonly meta: (logger: Logger) => Promise<Gateway>;
     readonly wal: (logger: Logger) => Promise<Gateway>;
     readonly test: (logger: Logger) => Promise<TestStore>;
 }
-declare function registerStoreProtocol(item: StoreFactoryItem): void;
+declare function registerStoreProtocol(item: StoreFactoryItem): () => void;
 declare function testStoreFactory(url: URL, ilogger?: Logger): Promise<TestStore>;
 declare function toStoreRuntime(opts: StoreOpts, ilogger: Logger): StoreRuntime;
 
 declare function parseCarFile<T>(reader: CarReader, logger: Logger): Promise<CarHeader<T>>;
 
-type index$2_AnyAnyLink = AnyAnyLink;
-type index$2_AnyBlock = AnyBlock;
-type index$2_AnyLink = AnyLink;
-type index$2_BaseBlockstore = BaseBlockstore;
-declare const index$2_BaseBlockstore: typeof BaseBlockstore;
-type index$2_BlobLike = BlobLike;
-type index$2_BlockFetcher = BlockFetcher;
-type index$2_CarClockHead = CarClockHead;
-type index$2_CarGroup = CarGroup;
-type index$2_CarTransaction = CarTransaction;
-declare const index$2_CarTransaction: typeof CarTransaction;
-type index$2_CommitOpts = CommitOpts;
-type index$2_CompactionFetcher = CompactionFetcher;
-declare const index$2_CompactionFetcher: typeof CompactionFetcher;
-type index$2_ConnectREST = ConnectREST;
-declare const index$2_ConnectREST: typeof ConnectREST;
-type index$2_Connectable = Connectable;
-type index$2_Connection = Connection;
-type index$2_ConnectionBase = ConnectionBase;
-declare const index$2_ConnectionBase: typeof ConnectionBase;
-type index$2_CryptoOpts = CryptoOpts;
-type index$2_DataSaveOpts = DataSaveOpts;
-type index$2_DataStore = DataStore;
-declare const index$2_DataStore: typeof DataStore;
-type index$2_DbMeta = DbMeta;
-type index$2_DbMetaEventBlock = DbMetaEventBlock;
-type index$2_DownloadDataFnParams = DownloadDataFnParams;
-type index$2_DownloadMetaFnParams = DownloadMetaFnParams;
-type index$2_EncryptedBlockstore = EncryptedBlockstore;
-declare const index$2_EncryptedBlockstore: typeof EncryptedBlockstore;
-type index$2_Gateway = Gateway;
-type index$2_GatewayOpts = GatewayOpts;
-type index$2_GetResult = GetResult;
-type index$2_Loadable = Loadable;
-declare const index$2_Loadable: typeof Loadable;
-type index$2_Loader = Loader;
-declare const index$2_Loader: typeof Loader;
-type index$2_MetaStore = MetaStore;
-declare const index$2_MetaStore: typeof MetaStore;
-type index$2_NotFoundError = NotFoundError;
-declare const index$2_NotFoundError: typeof NotFoundError;
-type index$2_RemoteWAL = RemoteWAL;
-declare const index$2_RemoteWAL: typeof RemoteWAL;
-type index$2_StoreFactory = StoreFactory;
-type index$2_StoreFactoryItem = StoreFactoryItem;
-type index$2_StoreOpts = StoreOpts;
-type index$2_StoreRuntime = StoreRuntime;
-type index$2_TestStore = TestStore;
-type index$2_TransactionMeta = TransactionMeta;
-type index$2_UploadDataFnParams = UploadDataFnParams;
-type index$2_UploadMetaFnParams = UploadMetaFnParams;
-type index$2_VoidResult = VoidResult;
-type index$2_WALState = WALState;
-declare const index$2_isNotFoundError: typeof isNotFoundError;
-declare const index$2_parseCarFile: typeof parseCarFile;
-declare const index$2_registerStoreProtocol: typeof registerStoreProtocol;
-declare const index$2_testStoreFactory: typeof testStoreFactory;
-declare const index$2_toStoreRuntime: typeof toStoreRuntime;
-declare const index$2_toURL: typeof toURL;
-declare namespace index$2 {
-  export { type index$2_AnyAnyLink as AnyAnyLink, type index$2_AnyBlock as AnyBlock, type index$2_AnyLink as AnyLink, index$2_BaseBlockstore as BaseBlockstore, type index$2_BlobLike as BlobLike, type index$2_BlockFetcher as BlockFetcher, type index$2_CarClockHead as CarClockHead, type index$2_CarGroup as CarGroup, index$2_CarTransaction as CarTransaction, type index$2_CommitOpts as CommitOpts, index$2_CompactionFetcher as CompactionFetcher, index$2_ConnectREST as ConnectREST, type index$2_Connectable as Connectable, type index$2_Connection as Connection, index$2_ConnectionBase as ConnectionBase, type index$2_CryptoOpts as CryptoOpts, type index$2_DataSaveOpts as DataSaveOpts, index$2_DataStore as DataStore, type index$2_DbMeta as DbMeta, type index$2_DbMetaEventBlock as DbMetaEventBlock, type index$2_DownloadDataFnParams as DownloadDataFnParams, type index$2_DownloadMetaFnParams as DownloadMetaFnParams, index$2_EncryptedBlockstore as EncryptedBlockstore, type index$2_Gateway as Gateway, type index$2_GatewayOpts as GatewayOpts, type index$2_GetResult as GetResult, index$2_Loadable as Loadable, index$2_Loader as Loader, index$2_MetaStore as MetaStore, index$2_NotFoundError as NotFoundError, index$2_RemoteWAL as RemoteWAL, type index$2_StoreFactory as StoreFactory, type index$2_StoreFactoryItem as StoreFactoryItem, type index$2_StoreOpts as StoreOpts, type index$2_StoreRuntime as StoreRuntime, type index$2_TestStore as TestStore, type index$2_TransactionMeta as TransactionMeta, type index$2_UploadDataFnParams as UploadDataFnParams, type index$2_UploadMetaFnParams as UploadMetaFnParams, type index$2_VoidResult as VoidResult, type index$2_WALState as WALState, index$2_isNotFoundError as isNotFoundError, index$2_parseCarFile as parseCarFile, index$2_registerStoreProtocol as registerStoreProtocol, index$2_testStoreFactory as testStoreFactory, index$2_toStoreRuntime as toStoreRuntime, index$2_toURL as toURL };
+type index$3_AnyAnyLink = AnyAnyLink;
+type index$3_AnyBlock = AnyBlock;
+type index$3_AnyLink = AnyLink;
+type index$3_BaseBlockstore = BaseBlockstore;
+declare const index$3_BaseBlockstore: typeof BaseBlockstore;
+type index$3_BlobLike = BlobLike;
+type index$3_BlockFetcher = BlockFetcher;
+type index$3_CarClockHead = CarClockHead;
+type index$3_CarGroup = CarGroup;
+type index$3_CarTransaction = CarTransaction;
+declare const index$3_CarTransaction: typeof CarTransaction;
+type index$3_CommitOpts = CommitOpts;
+type index$3_CompactionFetcher = CompactionFetcher;
+declare const index$3_CompactionFetcher: typeof CompactionFetcher;
+type index$3_ConnectREST = ConnectREST;
+declare const index$3_ConnectREST: typeof ConnectREST;
+type index$3_Connectable = Connectable;
+type index$3_Connection = Connection;
+type index$3_ConnectionBase = ConnectionBase;
+declare const index$3_ConnectionBase: typeof ConnectionBase;
+type index$3_CryptoOpts = CryptoOpts;
+type index$3_DataSaveOpts = DataSaveOpts;
+type index$3_DataStore = DataStore;
+declare const index$3_DataStore: typeof DataStore;
+type index$3_DbMeta = DbMeta;
+type index$3_DbMetaEventBlock = DbMetaEventBlock;
+type index$3_DownloadDataFnParams = DownloadDataFnParams;
+type index$3_DownloadMetaFnParams = DownloadMetaFnParams;
+type index$3_EncryptedBlockstore = EncryptedBlockstore;
+declare const index$3_EncryptedBlockstore: typeof EncryptedBlockstore;
+type index$3_Gateway = Gateway;
+type index$3_GatewayOpts = GatewayOpts;
+type index$3_GetResult = GetResult;
+type index$3_Loadable = Loadable;
+declare const index$3_Loadable: typeof Loadable;
+type index$3_Loader = Loader;
+declare const index$3_Loader: typeof Loader;
+type index$3_MetaStore = MetaStore;
+declare const index$3_MetaStore: typeof MetaStore;
+type index$3_NotFoundError = NotFoundError;
+declare const index$3_NotFoundError: typeof NotFoundError;
+type index$3_RemoteWAL = RemoteWAL;
+declare const index$3_RemoteWAL: typeof RemoteWAL;
+type index$3_StoreFactory = StoreFactory;
+type index$3_StoreFactoryItem = StoreFactoryItem;
+type index$3_StoreOpts = StoreOpts;
+type index$3_StoreRuntime = StoreRuntime;
+type index$3_TestStore = TestStore;
+type index$3_TransactionMeta = TransactionMeta;
+type index$3_UploadDataFnParams = UploadDataFnParams;
+type index$3_UploadMetaFnParams = UploadMetaFnParams;
+type index$3_VoidResult = VoidResult;
+type index$3_WALState = WALState;
+declare const index$3_isNotFoundError: typeof isNotFoundError;
+declare const index$3_parseCarFile: typeof parseCarFile;
+declare const index$3_registerStoreProtocol: typeof registerStoreProtocol;
+declare const index$3_testStoreFactory: typeof testStoreFactory;
+declare const index$3_toStoreRuntime: typeof toStoreRuntime;
+declare const index$3_toURL: typeof toURL;
+declare namespace index$3 {
+  export { type index$3_AnyAnyLink as AnyAnyLink, type index$3_AnyBlock as AnyBlock, type index$3_AnyLink as AnyLink, index$3_BaseBlockstore as BaseBlockstore, type index$3_BlobLike as BlobLike, type index$3_BlockFetcher as BlockFetcher, type index$3_CarClockHead as CarClockHead, type index$3_CarGroup as CarGroup, index$3_CarTransaction as CarTransaction, type index$3_CommitOpts as CommitOpts, index$3_CompactionFetcher as CompactionFetcher, index$3_ConnectREST as ConnectREST, type index$3_Connectable as Connectable, type index$3_Connection as Connection, index$3_ConnectionBase as ConnectionBase, type index$3_CryptoOpts as CryptoOpts, type index$3_DataSaveOpts as DataSaveOpts, index$3_DataStore as DataStore, type index$3_DbMeta as DbMeta, type index$3_DbMetaEventBlock as DbMetaEventBlock, type index$3_DownloadDataFnParams as DownloadDataFnParams, type index$3_DownloadMetaFnParams as DownloadMetaFnParams, index$3_EncryptedBlockstore as EncryptedBlockstore, type index$3_Gateway as Gateway, type index$3_GatewayOpts as GatewayOpts, type index$3_GetResult as GetResult, index$3_Loadable as Loadable, index$3_Loader as Loader, index$3_MetaStore as MetaStore, index$3_NotFoundError as NotFoundError, index$3_RemoteWAL as RemoteWAL, type index$3_StoreFactory as StoreFactory, type index$3_StoreFactoryItem as StoreFactoryItem, type index$3_StoreOpts as StoreOpts, type index$3_StoreRuntime as StoreRuntime, type index$3_TestStore as TestStore, type index$3_TransactionMeta as TransactionMeta, type index$3_UploadDataFnParams as UploadDataFnParams, type index$3_UploadMetaFnParams as UploadMetaFnParams, type index$3_VoidResult as VoidResult, type index$3_WALState as WALState, index$3_isNotFoundError as isNotFoundError, index$3_parseCarFile as parseCarFile, index$3_registerStoreProtocol as registerStoreProtocol, index$3_testStoreFactory as testStoreFactory, index$3_toStoreRuntime as toStoreRuntime, index$3_toURL as toURL };
 }
 
 type Falsy = false | null | undefined;
@@ -598,7 +600,7 @@ interface IndexTransactionMeta {
 interface FileTransactionMeta {
     readonly files?: AnyLink[];
 }
-type MetaType = CRDTMeta | IndexTransactionMeta | FileTransactionMeta;
+type MetaType$1 = CRDTMeta | IndexTransactionMeta | FileTransactionMeta;
 interface IdxMeta {
     readonly byId: AnyLink;
     readonly byKey: AnyLink;
@@ -618,6 +620,11 @@ interface QueryOpts<K extends IndexKeyType> {
     readonly keys?: DocFragment[];
     prefix?: IndexKeyType;
 }
+interface AllDocsQueryOpts extends QueryOpts<string> {
+    readonly key?: string;
+    readonly keys?: string[];
+    prefix?: string;
+}
 type EmitFn = (k: IndexKeyType, v?: DocFragment) => void;
 type MapFn<T extends DocTypes> = (doc: DocWithId<T>, emit: EmitFn) => DocFragment | unknown;
 interface ChangesOptions {
@@ -642,7 +649,7 @@ type NoUpdateListenerFn = () => Promise<void> | void;
 type ListenerFn<T extends DocTypes> = UpdateListenerFn<T> | NoUpdateListenerFn;
 
 interface WriteQueue<T extends DocTypes> {
-    push(task: DocUpdate<T>): Promise<MetaType>;
+    push(task: DocUpdate<T>): Promise<MetaType$1>;
 }
 
 declare class IndexTree<K extends IndexKeyType, R extends DocFragment> {
@@ -679,7 +686,7 @@ interface ProllyNode<K extends IndexKeyType, T extends DocFragment> extends Prol
     readonly block: Promise<Block>;
 }
 
-declare function index$1<K extends IndexKeyType = string, T extends DocTypes = NonNullable<unknown>, R extends DocFragment = T>({ _crdt }: {
+declare function index$2<K extends IndexKeyType = string, T extends DocTypes = NonNullable<unknown>, R extends DocFragment = T>({ _crdt }: {
     _crdt: CRDT<T> | CRDT<NonNullable<unknown>>;
 }, name: string, mapFn?: MapFn<T>, meta?: IdxMeta): Index<K, T, R>;
 declare class Index<K extends IndexKeyType, T extends DocTypes, R extends DocFragment = T> {
@@ -788,7 +795,7 @@ declare class Database<DT extends DocTypes = NonNullable<unknown>> implements Co
     put<T extends DocTypes>(doc: DocSet<T>): Promise<DbResponse>;
     del(id: string): Promise<DbResponse>;
     changes<T extends DocTypes>(since?: ClockHead, opts?: ChangesOptions): Promise<ChangesResponse<T>>;
-    allDocs<T extends DocTypes>(): Promise<{
+    allDocs<T extends DocTypes>(opts?: AllDocsQueryOpts): Promise<{
         rows: {
             key: string;
             value: DocWithId<T>;
@@ -885,6 +892,104 @@ declare function getPath(url: URL, logger: Logger): Promise<string>;
 declare function getFileName(url: URL, key: string, logger: Logger): string;
 declare function ensureIndexName(url: URL, name: string): string;
 
+interface DBConnection {
+    connect(): Promise<void>;
+    readonly opts: SQLOpts;
+}
+interface SQLStore<IType, KType, OType = IType[]> {
+    readonly dbConn: DBConnection;
+    start(url: URL): Promise<void>;
+    insert(url: URL, ose: IType): Promise<RunResult>;
+    select(url: URL, car: KType): Promise<OType>;
+    delete(url: URL, car: KType): Promise<RunResult>;
+    close(url: URL): Promise<Result<void>>;
+    destroy(url: URL): Promise<Result<void>>;
+}
+interface SQLTableNames {
+    readonly data: string;
+    readonly meta: string;
+    readonly wal: string;
+}
+declare const DefaultSQLTableNames: SQLTableNames;
+interface SQLOpts {
+    readonly url: URL;
+    readonly sqlFlavor: "sqlite" | "mysql" | "postgres";
+    readonly tableNames: SQLTableNames;
+    readonly logger: Logger;
+    readonly textEncoder: TextEncoder;
+    readonly textDecoder: TextDecoder;
+}
+interface WalKey {
+    readonly name: string;
+    readonly branch: string;
+}
+interface WalRecord extends WalKey {
+    readonly state: Uint8Array;
+    readonly updated_at: Date;
+}
+type WalSQLStore = SQLStore<WalRecord, WalKey>;
+interface MetaType {
+    readonly name: string;
+    readonly branch: string;
+    readonly meta: Uint8Array;
+}
+interface MetaRecordKey {
+    readonly name: string;
+    readonly branch: string;
+}
+interface MetaRecord extends MetaRecordKey {
+    readonly meta: Uint8Array;
+    readonly updated_at: Date;
+}
+type MetaSQLStore = SQLStore<MetaRecord, MetaRecordKey>;
+interface DataRecord {
+    readonly name: string;
+    readonly car: string;
+    readonly data: Uint8Array;
+    readonly updated_at: Date;
+}
+type DataSQLStore = SQLStore<DataRecord, string>;
+
+declare function ensureSQLOpts(url: URL, opts: Partial<SQLOpts>, componentName: string, ctx?: Record<string, unknown>): SQLOpts;
+
+type index$1_DBConnection = DBConnection;
+type index$1_DataRecord = DataRecord;
+type index$1_DataSQLStore = DataSQLStore;
+declare const index$1_DefaultSQLTableNames: typeof DefaultSQLTableNames;
+type index$1_MetaRecord = MetaRecord;
+type index$1_MetaRecordKey = MetaRecordKey;
+type index$1_MetaSQLStore = MetaSQLStore;
+type index$1_MetaType = MetaType;
+type index$1_SQLOpts = SQLOpts;
+type index$1_SQLStore<IType, KType, OType = IType[]> = SQLStore<IType, KType, OType>;
+type index$1_SQLTableNames = SQLTableNames;
+type index$1_WalKey = WalKey;
+type index$1_WalRecord = WalRecord;
+type index$1_WalSQLStore = WalSQLStore;
+declare const index$1_ensureSQLOpts: typeof ensureSQLOpts;
+declare namespace index$1 {
+  export { type index$1_DBConnection as DBConnection, type index$1_DataRecord as DataRecord, type index$1_DataSQLStore as DataSQLStore, index$1_DefaultSQLTableNames as DefaultSQLTableNames, type index$1_MetaRecord as MetaRecord, type index$1_MetaRecordKey as MetaRecordKey, type index$1_MetaSQLStore as MetaSQLStore, type index$1_MetaType as MetaType, type index$1_SQLOpts as SQLOpts, type index$1_SQLStore as SQLStore, type index$1_SQLTableNames as SQLTableNames, type index$1_WalKey as WalKey, type index$1_WalRecord as WalRecord, type index$1_WalSQLStore as WalSQLStore, index$1_ensureSQLOpts as ensureSQLOpts };
+}
+
+declare function toCryptoOpts(cryptoOpts?: Partial<CryptoOpts>): CryptoOpts;
+
+declare const crypto$1_toCryptoOpts: typeof toCryptoOpts;
+declare namespace crypto$1 {
+  export { crypto$1_toCryptoOpts as toCryptoOpts };
+}
+
+declare function encodeFile(blob: BlobLike): Promise<{
+    cid: AnyLink;
+    blocks: AnyBlock[];
+}>;
+declare function decodeFile(blocks: unknown, cid: AnyLink, meta: DocFileMeta): Promise<File>;
+
+declare const files_decodeFile: typeof decodeFile;
+declare const files_encodeFile: typeof encodeFile;
+declare namespace files {
+  export { files_decodeFile as decodeFile, files_encodeFile as encodeFile };
+}
+
 declare const FILESTORE_VERSION = "v0.19-file";
 
 declare const INDEXDB_VERSION = "v0.19-indexdb";
@@ -898,14 +1003,15 @@ declare const index_SQLITE_VERSION: typeof SQLITE_VERSION;
 declare const index_SysContainer: typeof SysContainer;
 declare const index_dataDir: typeof dataDir;
 declare const index_ensureIndexName: typeof ensureIndexName;
+declare const index_files: typeof files;
 declare const index_getFileName: typeof getFileName;
 declare const index_getPath: typeof getPath;
 declare const index_join: typeof join;
 declare namespace index {
-  export { index_FILESTORE_VERSION as FILESTORE_VERSION, index_INDEXDB_VERSION as INDEXDB_VERSION, type index_NodeMap as NodeMap, index_SQLITE_VERSION as SQLITE_VERSION, index_SysContainer as SysContainer, index_dataDir as dataDir, index_ensureIndexName as ensureIndexName, index_getFileName as getFileName, index_getPath as getPath, index_join as join };
+  export { index_FILESTORE_VERSION as FILESTORE_VERSION, index_INDEXDB_VERSION as INDEXDB_VERSION, type index_NodeMap as NodeMap, index_SQLITE_VERSION as SQLITE_VERSION, index_SysContainer as SysContainer, crypto$1 as crypto, index_dataDir as dataDir, index_ensureIndexName as ensureIndexName, index_files as files, index_getFileName as getFileName, index_getPath as getPath, index_join as join, index$1 as sql };
 }
 
 declare const PACKAGE_VERSION: string;
 
-export { CRDT, type CRDTMeta, type ChangesOptions, type ChangesResponse, type ChangesResponseRow, type ClockHead, type ClockLink, type ConfigOpts, Database, type DbResponse, type DocBase, type DocFileMeta, type DocFiles, type DocFragment, type DocLiteral, type DocObject, type DocRecord, type DocSet, type DocTypes, type DocUpdate, type DocValue, type DocWithId, type Falsy, type FileTransactionMeta, type IdxMeta, type IdxMetaMap, Index, type IndexKey, type IndexKeyType, type IndexRow, type IndexRows, type IndexTransactionMeta, type IndexUpdate, type IndexUpdateString, type Joiner, type KeyLiteral, type ListenerFn, type LoggerOpts, type MapFn, type MetaType, type NoUpdateListenerFn, PACKAGE_VERSION, type QueryOpts, type UnknownDoc, type UpdateListenerFn, index$2 as blockstore, index$2 as bs, ensureLogger, exception2Result, exceptionWrapper, falsyToUndef, fireproof, getKey, getName, getStore, index$1 as index, isFalsy, index as rt, throwFalsy };
+export { type AllDocsQueryOpts, CRDT, type CRDTMeta, type ChangesOptions, type ChangesResponse, type ChangesResponseRow, type ClockHead, type ClockLink, type ConfigOpts, Database, type DbResponse, type DocBase, type DocFileMeta, type DocFiles, type DocFragment, type DocLiteral, type DocObject, type DocRecord, type DocSet, type DocTypes, type DocUpdate, type DocValue, type DocWithId, type Falsy, type FileTransactionMeta, type IdxMeta, type IdxMetaMap, Index, type IndexKey, type IndexKeyType, type IndexRow, type IndexRows, type IndexTransactionMeta, type IndexUpdate, type IndexUpdateString, type Joiner, type KeyLiteral, type ListenerFn, type LoggerOpts, type MapFn, type MetaType$1 as MetaType, type NoUpdateListenerFn, PACKAGE_VERSION, type QueryOpts, type UnknownDoc, type UpdateListenerFn, index$3 as blockstore, index$3 as bs, ensureLogger, exception2Result, exceptionWrapper, falsyToUndef, fireproof, getKey, getName, getStore, index$2 as index, isFalsy, index as rt, index as runtime, throwFalsy };
 declare module '@fireproof/core'