@fireproof/core-types-base 0.23.11 → 0.23.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/package.json +4 -4
  2. package/types.d.ts +18 -18
  3. package/types.js.map +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fireproof/core-types-base",
3
- "version": "0.23.11",
3
+ "version": "0.23.13",
4
4
  "description": "Live ledger for the web.",
5
5
  "type": "module",
6
6
  "main": "./index.js",
@@ -31,9 +31,9 @@
31
31
  "url": "https://github.com/fireproof-storage/fireproof/issues"
32
32
  },
33
33
  "dependencies": {
34
- "@adviser/cement": "^0.4.25",
35
- "@fireproof/core-types-blockstore": "0.23.11",
36
- "@fireproof/vendor": "0.23.11",
34
+ "@adviser/cement": "^0.4.26",
35
+ "@fireproof/core-types-blockstore": "0.23.13",
36
+ "@fireproof/vendor": "0.23.13",
37
37
  "@web3-storage/pail": "^0.6.2",
38
38
  "multiformats": "^13.4.0",
39
39
  "prolly-trees": "^1.0.4"
package/types.d.ts CHANGED
@@ -198,10 +198,13 @@ export interface FPIndexRow<K extends IndexKeyType, T extends DocObject, R exten
198
198
  readonly value: R;
199
199
  readonly doc?: DocWithId<T>;
200
200
  }
201
- export interface IndexRows<T extends DocObject, K extends IndexKeyType = string, R extends DocFragment = T> {
201
+ export interface IndexRowsWithoutDocs<T extends DocObject, K extends IndexKeyType = string, R extends DocFragment = T> {
202
202
  readonly rows: FPIndexRow<K, T, R>[];
203
+ }
204
+ export interface IndexRowsWithDocs<T extends DocObject, K extends IndexKeyType = string, R extends DocFragment = T> extends IndexRowsWithoutDocs<T, K, R> {
203
205
  readonly docs: DocWithId<T>[];
204
206
  }
207
+ export type IndexRows<T extends DocObject, K extends IndexKeyType = string, R extends DocFragment = T> = IndexRowsWithoutDocs<T, K, R> | IndexRowsWithDocs<T, K, R>;
205
208
  export interface CRDTMeta {
206
209
  readonly head: ClockHead;
207
210
  }
@@ -223,15 +226,15 @@ export interface IdxMetaMap {
223
226
  readonly indexes?: Map<string, IdxMeta>;
224
227
  }
225
228
  export interface QueryOpts<K extends IndexKeyType> {
226
- readonly descending?: boolean;
227
- readonly limit?: number;
228
- includeDocs?: boolean;
229
- readonly range?: [IndexKeyType, IndexKeyType];
230
- readonly key?: DocFragment;
231
- readonly keys?: DocFragment[];
232
- prefix?: IndexKeyType;
233
- }
234
- export interface AllDocsQueryOpts extends QueryOpts<string> {
229
+ readonly descending: boolean;
230
+ readonly limit: number;
231
+ readonly includeDocs: boolean;
232
+ readonly range: [IndexKeyType, IndexKeyType];
233
+ readonly key: DocFragment;
234
+ readonly keys: DocFragment[];
235
+ readonly prefix: IndexKeyType;
236
+ }
237
+ export interface AllDocsQueryOpts extends Omit<QueryOpts<string>, "includeDocs"> {
235
238
  readonly key: string;
236
239
  readonly keys: string[];
237
240
  readonly prefix: string;
@@ -422,17 +425,14 @@ export interface Database extends ReadyCloseDestroy, HasLogger, HasSuperThis {
422
425
  remove(id: string): Promise<DocResponse>;
423
426
  changes<T extends DocTypes>(since?: ClockHead, opts?: ChangesOptions): Promise<ChangesResponse<T>>;
424
427
  allDocs<T extends DocTypes>(opts?: Partial<AllDocsQueryOpts>): Promise<AllDocsResponse<T>>;
425
- allDocuments<T extends DocTypes>(): Promise<{
426
- rows: {
427
- key: string;
428
- value: DocWithId<T>;
429
- }[];
430
- clock: ClockHead;
431
- }>;
428
+ allDocuments<T extends DocTypes>(opts?: Partial<AllDocsQueryOpts>): Promise<AllDocsResponse<T>>;
432
429
  subscribe<T extends DocTypes>(listener: ListenerFn<T>, updates?: boolean): () => void;
433
- query<T extends DocTypes, K extends IndexKeyType = string, R extends DocFragment = T>(field: string | MapFn<T>, opts?: QueryOpts<K>): Promise<IndexRows<T, K, R>>;
430
+ query<T extends DocTypes, K extends IndexKeyType = string, R extends DocFragment = T, O extends Partial<QueryOpts<K>> = Partial<QueryOpts<K>>>(field: string | MapFn<T>, opts?: O): Promise<QueryResult<T, K, R, O>>;
434
431
  compact(): Promise<void>;
435
432
  }
433
+ export type QueryResult<T extends DocTypes, K extends IndexKeyType = string, R extends DocFragment = T, O extends Partial<QueryOpts<K>> = Partial<QueryOpts<K>>> = O extends {
434
+ includeDocs: false;
435
+ } ? IndexRowsWithoutDocs<T, K, R> : IndexRowsWithDocs<T, K, R>;
436
436
  export interface WriteQueue<T extends DocUpdate<S>, S extends DocTypes = DocTypes> {
437
437
  push(task: T): Promise<MetaType>;
438
438
  bulk(tasks: T[]): Promise<MetaType>;
package/types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../jsr/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,EAAkB;IACtD,OAAO,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;AAAA,CACjE;AAED,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,QAAQ,EAAE,uBAAuB;IAC1C,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,EAAE,8BAA8B;IAClD,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,EAAE,uDAAuD;IACpF,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,EAAK;IACjD,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,KAAK,CAAC;AAAA,CACd;AAED,MAAM,UAAU,YAAY,CAAI,KAAgB,EAAiB;IAC/D,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,KAAK,CAAC;AAAA,CACd;AAuFD,MAAM,UAAU,yBAAyB,CAAC,KAAiB,EAAoC;IAC7F,OAAO,KAAK,CAAC,KAAK,KAAK,oBAAoB,CAAC;AAAA,CAC7C;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAiB,EAAoC;IAC7F,OAAO,KAAK,CAAC,KAAK,KAAK,oBAAoB,CAAC;AAAA,CAC7C;AA2YD,MAAM,OAAO,6BAA6B;IAC/B,GAAG,CAAwB;IAC3B,IAAI,CAAY;IAChB,GAAG,CAAW;IACd,IAAI,CAAY;IAChB,UAAU,CAAc;IAEjC,YAAY,GAA2B,EAAE;QACvC,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;IAAA,CACF;CACF;AAwLD,MAAM,UAAU,yBAAyB,CAAC,CAAkB,EAAgC;IAC1F,OAAO,CAAC,CAAC,QAAQ,CAAC;AAAA,CACnB;AAsDD,MAAM,UAAU,qBAAqB,CAAC,IAAI,GAA8B,EAAE,EAAoB;IAC5F,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;AAAA,CACH;AAMD,MAAM,UAAU,eAAe,CAAC,CAAoC,EAAsB;IACxF,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;AAAA,CACd"}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../jsr/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,EAAkB;IACtD,OAAO,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;AAAA,CACjE;AAED,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,QAAQ,EAAE,uBAAuB;IAC1C,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,EAAE,8BAA8B;IAClD,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,EAAE,uDAAuD;IACpF,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,EAAK;IACjD,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,KAAK,CAAC;AAAA,CACd;AAED,MAAM,UAAU,YAAY,CAAI,KAAgB,EAAiB;IAC/D,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,KAAK,CAAC;AAAA,CACd;AAuFD,MAAM,UAAU,yBAAyB,CAAC,KAAiB,EAAoC;IAC7F,OAAO,KAAK,CAAC,KAAK,KAAK,oBAAoB,CAAC;AAAA,CAC7C;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAiB,EAAoC;IAC7F,OAAO,KAAK,CAAC,KAAK,KAAK,oBAAoB,CAAC;AAAA,CAC7C;AAoZD,MAAM,OAAO,6BAA6B;IAC/B,GAAG,CAAwB;IAC3B,IAAI,CAAY;IAChB,GAAG,CAAW;IACd,IAAI,CAAY;IAChB,UAAU,CAAc;IAEjC,YAAY,GAA2B,EAAE;QACvC,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;IAAA,CACF;CACF;AAkND,MAAM,UAAU,yBAAyB,CAAC,CAAkB,EAAgC;IAC1F,OAAO,CAAC,CAAC,QAAQ,CAAC;AAAA,CACnB;AAsDD,MAAM,UAAU,qBAAqB,CAAC,IAAI,GAA8B,EAAE,EAAoB;IAC5F,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;AAAA,CACH;AAMD,MAAM,UAAU,eAAe,CAAC,CAAoC,EAAsB;IACxF,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;AAAA,CACd"}