@fireproof/core-types-base 0.0.2-dev-test → 0.22.0-keybag

package/key-bag-if.d.ts

@@ -6,6 +6,5 @@ export interface KeyBagIf {
     readonly rt: KeyBagRuntime;
     subtleKey(materialStrOrUint8: string | Uint8Array): Promise<CryptoKey>;
     ensureKeyFromUrl(url: URI, keyFactory: () => string): Promise<Result<URI>>;
-    flush(): Promise<void>;
     getNamedKey(name: string, failIfNotFound?: boolean, material?: string | Uint8Array): Promise<Result<KeysByFingerprint>>;
 }

package/key-bag-if.ts

@@ -9,7 +9,7 @@ export interface KeyBagIf {
   subtleKey(materialStrOrUint8: string | Uint8Array): Promise<CryptoKey>;
 
   ensureKeyFromUrl(url: URI, keyFactory: () => string): Promise<Result<URI>>;
-  flush(): Promise<void>;
+  // flush(): Promise<void>;
 
   getNamedKey(name: string, failIfNotFound?: boolean, material?: string | Uint8Array): Promise<Result<KeysByFingerprint>>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fireproof/core-types-base",
-  "version": "0.0.2-dev-test",
+  "version": "0.22.0-keybag",
   "description": "Live ledger for the web.",
   "type": "module",
   "main": "./index.js",
@@ -20,7 +20,7 @@
     "Meno Abels"
   ],
   "author": "J Chris Anderson",
-  "license": "Apache-2.0 OR MIT",
+  "license": "AFL-2.0",
   "homepage": "https://use-fireproof.com",
   "gptdoc": "import { fireproof } from 'use-fireproof'; const db = fireproof('app-db-name'); const ok = await db.put({ anyField: ['any','json'] }); const doc = await db.get(ok.id); await db.del(doc._id); db.subscribe(myRedrawFn); const result = await db.query('anyField', {range : ['a', 'z']}); result.rows.map(({ key }) => key);",
   "repository": {
@@ -32,11 +32,11 @@
   },
   "dependencies": {
     "@adviser/cement": "^0.4.20",
-    "@fireproof/core-types-blockstore": "0.0.2-dev-test",
+    "@fireproof/core-types-blockstore": "0.22.0-keybag",
     "@web3-storage/pail": "^0.6.2",
     "multiformats": "^13.3.7",
     "prolly-trees": "^1.0.4",
-    "@fireproof/vendor": "0.0.2-dev-test"
+    "@fireproof/vendor": "0.22.0-keybag"
   },
   "scripts": {
     "build": "tsc"

package/types.d.ts

@@ -1,8 +1,8 @@
 import type { EventLink } from "@web3-storage/pail/clock/api";
 import type { Operation } from "@web3-storage/pail/crdt/api";
 import type { Block } from "multiformats";
-import { EnvFactoryOpts, Env, Logger, CryptoRuntime, Result, CoerceURI, AppContext, URI } from "@adviser/cement";
-import type { DbMeta, AnyLink, StoreUrlsOpts, StoreEnDeFile, Loadable, TransactionMeta, TransactionWrapper, BlockstoreRuntime, StoreURIRuntime, DataAndMetaAndWalStore, UrlAndInterceptor, MetaStore, WALStore, BaseStore, FileStore, CarStore, FPBlock } from "@fireproof/core-types-blockstore";
+import { EnvFactoryOpts, Env, Logger, CryptoRuntime, Result, CoerceURI, AppContext, URI, CTCryptoKey } from "@adviser/cement";
+import type { DbMeta, AnyLink, StoreUrlsOpts, StoreEnDeFile, Loadable, TransactionWrapper, BlockstoreRuntime, StoreURIRuntime, DataAndMetaAndWalStore, UrlAndInterceptor, MetaStore, WALStore, BaseStore, FileStore, CarStore, FPBlock, BlockFetcher } from "@fireproof/core-types-blockstore";
 import type { IndexIf } from "./indexer.js";
 import { SerdeGatewayInterceptor } from "@fireproof/core-types-blockstore";
 export declare class NotFoundError extends Error {
@@ -135,6 +135,7 @@ export interface ConfigOpts extends Partial<SuperThisOpts> {
     readonly writeQueue?: Partial<WriteQueueParams>;
     readonly gatewayInterceptor?: SerdeGatewayInterceptor;
     readonly autoCompact?: number;
+    readonly compactStrategy?: string;
     readonly storeUrls?: StoreUrlsOpts;
     readonly storeEnDe?: StoreEnDeFile;
     readonly threshold?: number;
@@ -439,10 +440,26 @@ export type TraceFn = (traceEvent: TraceEvent) => void;
 export interface Tracer {
     readonly tracer: TraceFn;
 }
+export type TransactionMeta = unknown;
+export interface CompactStrategyContext extends BlockFetcher {
+    readonly transactions: Set<CarTransaction>;
+    readonly clock?: CRDTClock;
+    readonly lastTxMeta: TransactionMeta;
+    readonly loader: Loadable;
+    readonly logger: Logger;
+    readonly blockstore: BlockFetcher;
+    readonly loggedBlocks: CarTransaction;
+    get(cid: AnyLink): Promise<FPBlock | Falsy>;
+}
+export interface CompactStrategy {
+    readonly name: string;
+    compact(block: CompactStrategyContext): Promise<TransactionMeta>;
+}
 export interface LedgerOpts extends Tracer {
     readonly name: string;
     readonly meta?: DbMeta;
     readonly gatewayInterceptor?: SerdeGatewayInterceptor;
+    readonly compactStrategy?: string;
     readonly ctx: AppContext;
     readonly writeQueue: WriteQueueParams;
     readonly storeUrls: StoreURIRuntime;
@@ -474,13 +491,44 @@ export interface V2StorageKeyItem {
     readonly fingerPrint: string;
     readonly default: boolean;
 }
-export interface KeysItem {
+export interface V2KeysItem {
     readonly name: string;
     readonly keys: Record<string, V2StorageKeyItem>;
 }
+export interface KeyMaterial {
+    readonly key: Uint8Array;
+    readonly keyStr: string;
+}
+export interface KeyWithFingerPrint {
+    readonly default: boolean;
+    readonly fingerPrint: string;
+    readonly key: CTCryptoKey;
+    extract(): Promise<KeyMaterial>;
+    asV2StorageKeyItem(): Promise<V2StorageKeyItem>;
+}
+export interface KeyUpsertResultModified {
+    readonly modified: true;
+    readonly kfp: KeyWithFingerPrint;
+}
+export declare function isKeyUpsertResultModified(r: KeyUpsertResult): r is KeyUpsertResultModified;
+export interface KeyUpsertResultNotModified {
+    readonly modified: false;
+}
+export type KeyUpsertResult = KeyUpsertResultModified | KeyUpsertResultNotModified;
+export interface KeysByFingerprint {
+    readonly id: string;
+    readonly name: string;
+    get(fingerPrint?: string | Uint8Array): Promise<KeyWithFingerPrint | undefined>;
+    upsert(key: string | Uint8Array, def?: boolean): Promise<Result<KeyUpsertResult>>;
+    asV2KeysItem(): Promise<V2KeysItem>;
+}
+export interface KeysItem {
+    readonly name: string;
+    readonly keys: Record<string, KeyWithFingerPrint>;
+}
 export interface KeyBagProvider {
-    get(id: string): Promise<V1StorageKeyItem | KeysItem | undefined>;
-    set(item: KeysItem): Promise<void>;
+    get(id: string): Promise<V1StorageKeyItem | V2KeysItem | undefined>;
+    set(item: V2KeysItem): Promise<void>;
     del(id: string): Promise<void>;
 }
 export interface KeyBagRuntime {

package/types.js

@@ -66,6 +66,9 @@ export class DataAndMetaAndWalAndBaseStore {
         }
     }
 }
+export function isKeyUpsertResultModified(r) {
+    return r.modified;
+}
 export function defaultWriteQueueOpts(opts = {}) {
     return {
         ...opts,

package/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AAGA,OAAO,EAA8C,MAAM,EAA8B,MAAM,iBAAiB,CAAC;AAyBjH,MAAM,OAAO,aAAc,SAAQ,KAAK;IAC7B,IAAI,GAAG,QAAQ,CAAC;CAC1B;AAMD,MAAM,UAAU,OAAO,CAAC,KAAc;IACpC,OAAO,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;AAClE,CAAC;AAED,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,QAAQ;IACjB,SAAS,EAAE,UAAU;IACrB,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,UAAU;IACrB,SAAS,EAAE,UAAU;IACrB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,QAAQ,EAAE,KAAK;IACf,QAAQ,EAAE,KAAK;IACf,SAAS,EAAE,YAAY;IACvB,UAAU,EAAE,YAAY;IACxB,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,UAAU;IACxB,cAAc,EAAE,cAAc;IAC9B,sBAAsB,EAAE,qBAAqB;IAC7C,mBAAmB,EAAE,kBAAkB;IACvC,WAAW,EAAE,6DAA6D;IAC1E,UAAU,EAAE,WAAW;CAExB,CAAC;AAGF,MAAM,UAAU,UAAU,CAAI,KAAgB;IAC5C,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,YAAY,CAAI,KAAgB;IAC9C,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAuFD,MAAM,UAAU,yBAAyB,CAAC,KAAiB;IACzD,OAAO,KAAK,CAAC,KAAK,KAAK,oBAAoB,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAiB;IACzD,OAAO,KAAK,CAAC,KAAK,KAAK,oBAAoB,CAAC;AAC9C,CAAC;AAgYD,MAAM,OAAO,6BAA6B;IAC/B,GAAG,CAAwB;IAC3B,IAAI,CAAY;IAChB,GAAG,CAAW;IACd,IAAI,CAAY;IAChB,UAAU,CAAc;IAEjC,YAAY,GAA2B;QACrC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;CACF;AA+KD,MAAM,UAAU,qBAAqB,CAAC,OAAkC,EAAE;IACxE,OAAO;QACL,GAAG,IAAI;QACP,SAAS,EAAE,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE;KACtE,CAAC;AACJ,CAAC;AAMD,MAAM,UAAU,eAAe,CAAC,CAAoC;IAClE,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjB,IAAI,CAAC,CAAC,IAAI,EAAE;YAAE,OAAO,KAAK,CAAC;QAC3B,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;IACd,CAAC;IACD,IAAK,CAAmB,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACxD,OAAO,KAAK,CAAC;AACf,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AAGA,OAAO,EAA8C,MAAM,EAA2C,MAAM,iBAAiB,CAAC;AAyB9H,MAAM,OAAO,aAAc,SAAQ,KAAK;IAC7B,IAAI,GAAG,QAAQ,CAAC;CAC1B;AAMD,MAAM,UAAU,OAAO,CAAC,KAAc;IACpC,OAAO,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;AAClE,CAAC;AAED,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,QAAQ;IACjB,SAAS,EAAE,UAAU;IACrB,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,UAAU;IACrB,SAAS,EAAE,UAAU;IACrB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,QAAQ,EAAE,KAAK;IACf,QAAQ,EAAE,KAAK;IACf,SAAS,EAAE,YAAY;IACvB,UAAU,EAAE,YAAY;IACxB,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,UAAU;IACxB,cAAc,EAAE,cAAc;IAC9B,sBAAsB,EAAE,qBAAqB;IAC7C,mBAAmB,EAAE,kBAAkB;IACvC,WAAW,EAAE,6DAA6D;IAC1E,UAAU,EAAE,WAAW;CAExB,CAAC;AAGF,MAAM,UAAU,UAAU,CAAI,KAAgB;IAC5C,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,YAAY,CAAI,KAAgB;IAC9C,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAuFD,MAAM,UAAU,yBAAyB,CAAC,KAAiB;IACzD,OAAO,KAAK,CAAC,KAAK,KAAK,oBAAoB,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAiB;IACzD,OAAO,KAAK,CAAC,KAAK,KAAK,oBAAoB,CAAC;AAC9C,CAAC;AAkYD,MAAM,OAAO,6BAA6B;IAC/B,GAAG,CAAwB;IAC3B,IAAI,CAAY;IAChB,GAAG,CAAW;IACd,IAAI,CAAY;IAChB,UAAU,CAAc;IAEjC,YAAY,GAA2B;QACrC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;CACF;AAwLD,MAAM,UAAU,yBAAyB,CAAC,CAAkB;IAC1D,OAAO,CAAC,CAAC,QAAQ,CAAC;AACpB,CAAC;AAsDD,MAAM,UAAU,qBAAqB,CAAC,OAAkC,EAAE;IACxE,OAAO;QACL,GAAG,IAAI;QACP,SAAS,EAAE,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE;KACtE,CAAC;AACJ,CAAC;AAMD,MAAM,UAAU,eAAe,CAAC,CAAoC;IAClE,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjB,IAAI,CAAC,CAAC,IAAI,EAAE;YAAE,OAAO,KAAK,CAAC;QAC3B,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;IACd,CAAC;IACD,IAAK,CAAmB,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACxD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/types.ts

@@ -1,7 +1,7 @@
 import type { EventLink } from "@web3-storage/pail/clock/api";
 import type { Operation } from "@web3-storage/pail/crdt/api";
 import type { Block } from "multiformats";
-import { EnvFactoryOpts, Env, Logger, CryptoRuntime, Result, CoerceURI, AppContext, URI } from "@adviser/cement";
+import { EnvFactoryOpts, Env, Logger, CryptoRuntime, Result, CoerceURI, AppContext, URI, CTCryptoKey } from "@adviser/cement";
 
 import type {
   DbMeta,
@@ -9,7 +9,6 @@ import type {
   StoreUrlsOpts,
   StoreEnDeFile,
   Loadable,
-  TransactionMeta,
   TransactionWrapper,
   BlockstoreRuntime,
   StoreURIRuntime,
@@ -21,6 +20,7 @@ import type {
   FileStore,
   CarStore,
   FPBlock,
+  BlockFetcher,
 } from "@fireproof/core-types-blockstore";
 
 import type { IndexIf } from "./indexer.js";
@@ -183,6 +183,8 @@ export interface ConfigOpts extends Partial<SuperThisOpts> {
   readonly writeQueue?: Partial<WriteQueueParams>;
   readonly gatewayInterceptor?: SerdeGatewayInterceptor;
   readonly autoCompact?: number;
+  // could be registered with registerCompactStrategy(name: string, compactStrategy: CompactStrategy)
+  readonly compactStrategy?: string; // default "FULL" other "fireproof" , "no-op"
   readonly storeUrls?: StoreUrlsOpts;
   readonly storeEnDe?: StoreEnDeFile;
   readonly threshold?: number;
@@ -635,12 +637,34 @@ export interface Tracer {
   readonly tracer: TraceFn;
 }
 
+export type TransactionMeta = unknown;
+export interface CompactStrategyContext extends BlockFetcher {
+  readonly transactions: Set<CarTransaction>;
+  readonly clock?: CRDTClock;
+  readonly lastTxMeta: TransactionMeta;
+  readonly loader: Loadable;
+  readonly logger: Logger;
+  readonly blockstore: BlockFetcher;
+  // loader: Loader | null = null
+  readonly loggedBlocks: CarTransaction;
+
+  get(cid: AnyLink): Promise<FPBlock | Falsy>;
+}
+
+export interface CompactStrategy {
+  readonly name: string;
+  compact(block: CompactStrategyContext): Promise<TransactionMeta>;
+}
+
 export interface LedgerOpts extends Tracer {
   readonly name: string;
   // readonly public?: boolean;
   readonly meta?: DbMeta;
   readonly gatewayInterceptor?: SerdeGatewayInterceptor;
 
+  // could be registered with registerCompactStrategy(name: string, compactStrategy: CompactStrategy)
+  readonly compactStrategy?: string; // default "FULL"
+
   readonly ctx: AppContext;
   readonly writeQueue: WriteQueueParams;
   readonly storeUrls: StoreURIRuntime;
@@ -710,14 +734,57 @@ export interface V2StorageKeyItem {
   readonly fingerPrint: string;
   readonly default: boolean;
 }
-export interface KeysItem {
+
+// Serialized Version
+export interface V2KeysItem {
   readonly name: string;
   readonly keys: Record<string, V2StorageKeyItem>;
 }
 
+export interface KeyMaterial {
+  readonly key: Uint8Array;
+  readonly keyStr: string;
+}
+
+export interface KeyWithFingerPrint {
+  readonly default: boolean;
+  readonly fingerPrint: string;
+  readonly key: CTCryptoKey;
+  extract(): Promise<KeyMaterial>;
+  asV2StorageKeyItem(): Promise<V2StorageKeyItem>;
+}
+
+export interface KeyUpsertResultModified {
+  readonly modified: true;
+  readonly kfp: KeyWithFingerPrint;
+}
+
+export function isKeyUpsertResultModified(r: KeyUpsertResult): r is KeyUpsertResultModified {
+  return r.modified;
+}
+
+export interface KeyUpsertResultNotModified {
+  readonly modified: false;
+}
+
+export type KeyUpsertResult = KeyUpsertResultModified | KeyUpsertResultNotModified;
+
+export interface KeysByFingerprint {
+  readonly id: string;
+  readonly name: string;
+  get(fingerPrint?: string | Uint8Array): Promise<KeyWithFingerPrint | undefined>;
+  upsert(key: string | Uint8Array, def?: boolean): Promise<Result<KeyUpsertResult>>;
+  asV2KeysItem(): Promise<V2KeysItem>;
+}
+
+export interface KeysItem {
+  readonly name: string;
+  readonly keys: Record<string, KeyWithFingerPrint>;
+}
+
 export interface KeyBagProvider {
-  get(id: string): Promise<V1StorageKeyItem | KeysItem | undefined>;
-  set(item: KeysItem): Promise<void>;
+  get(id: string): Promise<V1StorageKeyItem | V2KeysItem | undefined>;
+  set(item: V2KeysItem): Promise<void>;
   del(id: string): Promise<void>;
 }