@enbox/dwn-sdk-js 0.0.1

package/dist/types/src/store/blockstore-level.d.ts

@@ -0,0 +1,34 @@
+import { CID } from 'multiformats';
+import type { AbortOptions, AwaitIterable } from 'interface-store';
+import type { Blockstore, Pair } from 'interface-blockstore';
+import { createLevelDatabase, LevelWrapper } from './level-wrapper.js';
+/**
+ * Blockstore implementation using LevelDB for storing the actual messages (in the case of MessageStore)
+ * or the data associated with messages (in the case of a DataStore).
+ */
+export declare class BlockstoreLevel implements Blockstore {
+    config: BlockstoreLevelConfig;
+    db: LevelWrapper<Uint8Array>;
+    constructor(config: BlockstoreLevelConfig, db?: LevelWrapper<Uint8Array>);
+    open(): Promise<void>;
+    close(): Promise<void>;
+    partition(name: string): Promise<BlockstoreLevel>;
+    put(key: CID | string, val: Uint8Array, options?: AbortOptions): Promise<CID>;
+    get(key: CID | string, options?: AbortOptions): Promise<Uint8Array>;
+    has(key: CID | string, options?: AbortOptions): Promise<boolean>;
+    delete(key: CID | string, options?: AbortOptions): Promise<void>;
+    isEmpty(options?: AbortOptions): Promise<boolean>;
+    putMany(source: AwaitIterable<Pair>, options?: AbortOptions): AsyncIterable<CID>;
+    getMany(source: AwaitIterable<CID>, options?: AbortOptions): AsyncIterable<Pair>;
+    getAll(options?: AbortOptions): AsyncIterable<Pair>;
+    deleteMany(source: AwaitIterable<CID>, options?: AbortOptions): AsyncIterable<CID>;
+    /**
+     * deletes all entries
+     */
+    clear(): Promise<void>;
+}
+export type BlockstoreLevelConfig = {
+    location: string;
+    createLevelDatabase?: typeof createLevelDatabase;
+};
+//# sourceMappingURL=blockstore-level.d.ts.map

package/dist/types/src/store/blockstore-level.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blockstore-level.d.ts","sourceRoot":"","sources":["../../../../src/store/blockstore-level.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACnC,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAE7D,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAOvE;;;GAGG;AACH,qBAAa,eAAgB,YAAW,UAAU;IAChD,MAAM,EAAE,qBAAqB,CAAC;IAE9B,EAAE,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC;gBAEjB,MAAM,EAAE,qBAAqB,EAAE,EAAE,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC;IASlE,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAKjD,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC;IAK7E,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC;IAKnE,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAIhE,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhE,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/C,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC,GAAG,CAAC;IAQhF,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC,IAAI,CAAC;IAShF,MAAM,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC,IAAI,CAAC;IAYnD,UAAU,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC,GAAG,CAAC;IAQ1F;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAG7B;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,mBAAmB,CAAC,EAAE,OAAO,mBAAmB,CAAC;CAClD,CAAC"}

package/dist/types/src/store/blockstore-mock.d.ts

@@ -0,0 +1,27 @@
+import { CID } from 'multiformats';
+import type { AbortOptions, AwaitIterable } from 'interface-store';
+import type { Blockstore, Pair } from 'interface-blockstore';
+/**
+ * Mock implementation for the Blockstore interface.
+ *
+ * WARNING!!! Purely to be used with `ipfs-unixfs-importer` to compute CID without needing consume any memory.
+ * This is particularly useful when dealing with large files and a necessity in a large-scale production service environment.
+ */
+export declare class BlockstoreMock implements Blockstore {
+    open(): Promise<void>;
+    close(): Promise<void>;
+    put(key: CID, _val: Uint8Array, _options?: AbortOptions): Promise<CID>;
+    get(_key: CID, _options?: AbortOptions): Promise<Uint8Array>;
+    has(_key: CID, _options?: AbortOptions): Promise<boolean>;
+    delete(_key: CID, _options?: AbortOptions): Promise<void>;
+    isEmpty(_options?: AbortOptions): Promise<boolean>;
+    putMany(source: AwaitIterable<Pair>, options?: AbortOptions): AsyncIterable<CID>;
+    getMany(source: AwaitIterable<CID>, options?: AbortOptions): AsyncIterable<Pair>;
+    getAll(options?: AbortOptions): AsyncIterable<Pair>;
+    deleteMany(source: AwaitIterable<CID>, options?: AbortOptions): AsyncIterable<CID>;
+    /**
+     * deletes all entries
+     */
+    clear(): Promise<void>;
+}
+//# sourceMappingURL=blockstore-mock.d.ts.map

package/dist/types/src/store/blockstore-mock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blockstore-mock.d.ts","sourceRoot":"","sources":["../../../../src/store/blockstore-mock.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACnC,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;;GAKG;AACH,qBAAa,cAAe,YAAW,UAAU;IAEzC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAGrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAGtB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC;IAItE,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC;IAI5D,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAIzD,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAGzD,OAAO,CAAC,QAAQ,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAIhD,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC,GAAG,CAAC;IAQhF,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC,IAAI,CAAC;IAShF,MAAM,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC,IAAI,CAAC;IAYnD,UAAU,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC,GAAG,CAAC;IAQ1F;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAE7B"}

package/dist/types/src/store/data-store-level.d.ts

@@ -0,0 +1,34 @@
+import type { DataStore, DataStoreGetResult, DataStorePutResult } from '../types/data-store.js';
+import { BlockstoreLevel } from './blockstore-level.js';
+import { createLevelDatabase } from './level-wrapper.js';
+import { Readable } from 'readable-stream';
+/**
+ * A simple implementation of {@link DataStore} that works in both the browser and server-side.
+ * Leverages LevelDB under the hood.
+ *
+ * It has the following structure (`+` represents an additional sublevel/partition):
+ *   'data' + <tenant> + <recordId> + <dataCid> -> <data>
+ */
+export declare class DataStoreLevel implements DataStore {
+    config: DataStoreLevelConfig;
+    blockstore: BlockstoreLevel;
+    constructor(config?: DataStoreLevelConfig);
+    open(): Promise<void>;
+    close(): Promise<void>;
+    put(tenant: string, recordId: string, dataCid: string, dataStream: Readable): Promise<DataStorePutResult>;
+    get(tenant: string, recordId: string, dataCid: string): Promise<DataStoreGetResult | undefined>;
+    delete(tenant: string, recordId: string, dataCid: string): Promise<void>;
+    /**
+     * Deletes everything in the store. Mainly used in tests.
+     */
+    clear(): Promise<void>;
+    /**
+     * Gets the blockstore used for storing data for the given `tenant -> `recordId` -> `dataCid`.
+     */
+    private getBlockstoreForStoringData;
+}
+export type DataStoreLevelConfig = {
+    blockstoreLocation?: string;
+    createLevelDatabase?: typeof createLevelDatabase;
+};
+//# sourceMappingURL=data-store-level.d.ts.map

package/dist/types/src/store/data-store-level.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-store-level.d.ts","sourceRoot":"","sources":["../../../../src/store/data-store-level.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAEhG,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAGzD,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C;;;;;;GAMG;AACH,qBAAa,cAAe,YAAW,SAAS;IAC9C,MAAM,EAAE,oBAAoB,CAAC;IAE7B,UAAU,EAAE,eAAe,CAAC;gBAEhB,MAAM,GAAE,oBAAyB;IAahC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAclG,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC;IAmC/F,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKrF;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAInC;;OAEG;YACW,2BAA2B;CAQ1C;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,mBAAmB,CAAC,EAAE,OAAO,mBAAmB,CAAC;CAClD,CAAC"}

package/dist/types/src/store/index-level.d.ts

@@ -0,0 +1,171 @@
+import type { Filter, KeyValues, PaginationCursor, QueryOptions } from '../types/query-types.js';
+import { createLevelDatabase, LevelWrapper } from './level-wrapper.js';
+export type IndexLevelConfig = {
+    location: string;
+    createLevelDatabase?: typeof createLevelDatabase;
+};
+export type IndexedItem = {
+    messageCid: string;
+    indexes: KeyValues;
+};
+export interface IndexLevelOptions {
+    signal?: AbortSignal;
+}
+/**
+ * A LevelDB implementation for indexing the messages and events stored in the DWN.
+ */
+export declare class IndexLevel {
+    db: LevelWrapper<string>;
+    config: IndexLevelConfig;
+    constructor(config: IndexLevelConfig);
+    open(): Promise<void>;
+    close(): Promise<void>;
+    /**
+     * deletes everything in the underlying index db.
+     */
+    clear(): Promise<void>;
+    /**
+     * Put an item into the index using information that will allow it to be queried for.
+     *
+     * @param tenant
+     * @param messageCid a unique ID that represents the item being indexed, this is also used as the cursor value in a query.
+     * @param indexes - (key-value pairs) to be included as part of indexing this item. Must include at least one indexing property.
+     * @param options IndexLevelOptions that include an AbortSignal.
+     */
+    put(tenant: string, messageCid: string, indexes: KeyValues, options?: IndexLevelOptions): Promise<void>;
+    /**
+     *  Deletes all of the index data associated with the item.
+     */
+    delete(tenant: string, messageCid: string, options?: IndexLevelOptions): Promise<void>;
+    /**
+     * Creates an IndexLevel `put` operation for indexing an item, creating a partition by `tenant` and by `indexName`
+     */
+    private createPutIndexedItemOperation;
+    /**
+     * Creates an IndexLevel `del` operation for deleting an item, creating a partition by `tenant` and by `indexName`
+     */
+    private createDeleteIndexedItemOperation;
+    /**
+     * Wraps the given operation as an operation for the specified index partition.
+     */
+    private createOperationForIndexPartition;
+    /**
+     * Wraps the given operation as an operation for the messageCid to indexes lookup partition.
+     */
+    private createOperationForIndexesLookupPartition;
+    private static getIndexPartitionName;
+    /**
+     * Gets the index partition of the given indexName.
+     */
+    private getIndexPartition;
+    /**
+     * Gets the messageCid to indexes lookup partition.
+     */
+    private getIndexesLookupPartition;
+    /**
+     * Queries the index for items that match the filters. If no filters are provided, all items are returned.
+     *
+     * @param filters Array of filters that are treated as an OR query.
+     * @param queryOptions query options for sort and pagination, requires at least `sortProperty`. The default sort direction is ascending.
+     * @param options IndexLevelOptions that include an AbortSignal.
+     * @returns {IndexedItem[]} an array of `IndexedItem` that match the given filters.
+     */
+    query(tenant: string, filters: Filter[], queryOptions: QueryOptions, options?: IndexLevelOptions): Promise<IndexedItem[]>;
+    /**
+     * Queries the sort property index for items that match the filters. If no filters are provided, all items are returned.
+     * This query is a linear iterator over the sorted index, checking each item for a match.
+     * If a cursor is provided it starts the iteration from the cursor point.
+     */
+    queryWithIteratorPaging(tenant: string, filters: Filter[], queryOptions: QueryOptions, options?: IndexLevelOptions): Promise<IndexedItem[]>;
+    /**
+     * Creates an AsyncGenerator that returns each sorted index item given a specific sortProperty.
+     * If a cursor is passed, the starting value (gt or lt) is derived from that.
+     */
+    private getIndexIterator;
+    /**
+     * Creates the starting point for a LevelDB query given an messageCid as a cursor and the indexed property.
+     * Used as (gt) for ascending queries, or (lt) for descending queries.
+     */
+    private createStartingKeyFromCursor;
+    /**
+     * Returns a PaginationCursor using the last item of a given array of IndexedItems.
+     * If the given array is empty, undefined is returned.
+     *
+     * @throws {DwnError} if the sort property or cursor value is invalid.
+     */
+    static createCursorFromLastArrayItem(items: IndexedItem[], sortProperty: string): PaginationCursor | undefined;
+    /**
+     * Creates a PaginationCursor from a given IndexedItem and sortProperty.
+     *
+     * @throws {DwnError} if the sort property or cursor value is invalid.
+     */
+    static createCursorFromItem(item: IndexedItem, sortProperty: string): PaginationCursor;
+    /**
+     * Queries the provided searchFilters asynchronously, returning results that match the matchFilters.
+     *
+     * @param filters the filters passed to the parent query.
+     * @param searchFilters the modified filters used for the LevelDB query to search for a subset of items to match against.
+     *
+     * @throws {DwnErrorCode.IndexLevelInMemoryInvalidSortProperty} if an invalid sort property is provided.
+     */
+    queryWithInMemoryPaging(tenant: string, filters: Filter[], queryOptions: QueryOptions, options?: IndexLevelOptions): Promise<IndexedItem[]>;
+    /**
+     * Execute a filtered query against a single filter and return all results.
+     */
+    private executeSingleFilterQuery;
+    private getAllItems;
+    /**
+     * Returns items that match the exact property and value.
+     */
+    private filterExactMatches;
+    /**
+     * Returns items that match the range filter.
+     */
+    private filterRangeMatches;
+    /**
+     * Sorts Items lexicographically in ascending or descending order given a specific indexName, using the messageCid as a tie breaker.
+     * We know the indexes include the indexName and they are only of string or number type and not Arrays or booleans.
+     * because they have already been checked within executeSingleFilterQuery.
+     */
+    private sortItems;
+    /**
+     * Find the starting position for pagination within the IndexedItem array.
+     * Returns the index of the first item found which is either greater than or less than the given cursor, depending on sort order.
+     */
+    private findCursorStartingIndex;
+    /**
+     * Gets the indexes given an messageCid. This is a reverse lookup to construct starting keys, as well as deleting indexed items.
+     */
+    private getIndexes;
+    /**
+     * Given a key from an indexed partitioned property key.
+     *  ex:
+     *    key: '"2023-05-25T11:22:33.000000Z"\u0000bayfreigu....'
+     *    returns "2023-05-25T11:22:33.000000Z"
+     */
+    private extractIndexValueFromKey;
+    /**
+     * Joins the given values using the `\x00` (\u0000) character.
+     */
+    private static delimiter;
+    private static keySegmentJoin;
+    /**
+     *  Encodes a numerical value as a string for lexicographical comparison.
+     *  If the number is positive it simply pads it with leading zeros.
+     *  ex.: input:  1024 => "0000000000001024"
+     *       input: -1024 => "!9007199254739967"
+     *
+     * @param value the number to encode.
+     * @returns a string representation of the number.
+     */
+    static encodeNumberValue(value: number): string;
+    /**
+     * Encodes an indexed value to a string
+     *
+     * NOTE: we currently only use this for strings, numbers and booleans.
+     */
+    static encodeValue(value: string | number | boolean): string;
+    private static shouldQueryWithInMemoryPaging;
+    static isFilterConcise(filter: Filter, queryOptions: QueryOptions): boolean;
+}
+//# sourceMappingURL=index-level.d.ts.map

package/dist/types/src/store/index-level.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-level.d.ts","sourceRoot":"","sources":["../../../../src/store/index-level.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAe,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,YAAY,EAAe,MAAM,yBAAyB,CAAC;AAM3H,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAIvE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,mBAAmB,CAAC,EAAE,OAAO,mBAAmB,CAAA;CACjD,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,SAAS,CAAA;CAAE,CAAC;AAIrE,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,qBAAa,UAAU;IACrB,EAAE,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IACzB,MAAM,EAAE,gBAAgB,CAAC;gBAEb,MAAM,EAAE,gBAAgB;IAa9B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B;;;;;;;OAOG;IACG,GAAG,CACP,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,SAAS,EAClB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC;IAqChB;;OAEG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgC5F;;OAEG;YACW,6BAA6B;IAoB3C;;OAEG;YACW,gCAAgC;IAmB9C;;OAEG;YACW,gCAAgC;IAW9C;;OAEG;YACW,wCAAwC;IAOtD,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAKpC;;OAEG;YACW,iBAAiB;IAK/B;;OAEG;YACW,yBAAyB;IAIvC;;;;;;;OAOG;IACG,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAS/H;;;;OAIG;IACG,uBAAuB,CAC3B,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EAAE,EACjB,YAAY,EAAE,YAAY,EAC1B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,WAAW,EAAE,CAAC;IAqBzB;;;OAGG;YACa,gBAAgB;IA2BhC;;;OAGG;IACH,OAAO,CAAC,2BAA2B;IAKnC;;;;;OAKG;IACH,MAAM,CAAC,6BAA6B,CAAC,KAAK,EAAE,WAAW,EAAE,EAAE,YAAY,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAM9G;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CAAC,IAAI,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,GAAG,gBAAgB;IAmBtF;;;;;;;OAOG;IACG,uBAAuB,CAC3B,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EAAE,EACjB,YAAY,EAAE,YAAY,EAC1B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,WAAW,EAAE,CAAC;IAsCzB;;OAEG;YACW,wBAAwB;YA8DxB,WAAW;IASzB;;OAEG;YACW,kBAAkB;IAwBhC;;OAEG;YACW,kBAAkB;IA2ChC;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAYjB;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAe/B;;OAEG;YACW,UAAU;IAWxB;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB;IAKhC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,SAAS,CAAU;IAClC,OAAO,CAAC,MAAM,CAAC,cAAc;IAI7B;;;;;;;;OAQG;IACH,MAAM,CAAC,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAU/C;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM;IAS5D,OAAO,CAAC,MAAM,CAAC,6BAA6B;WAW9B,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,GAAG,OAAO;CAuBnF"}

package/dist/types/src/store/level-wrapper.d.ts

@@ -0,0 +1,48 @@
+import type { AbstractBatchOperation, AbstractDatabaseOptions, AbstractIteratorOptions } from 'abstract-level';
+import { Level } from 'level';
+export type CreateLevelDatabaseOptions<V> = AbstractDatabaseOptions<string, V>;
+export type LevelDatabase<V> = Level<string, V>;
+export declare function createLevelDatabase<V>(location: string, options?: CreateLevelDatabaseOptions<V>): Promise<LevelDatabase<V>>;
+export interface LevelWrapperOptions {
+    signal?: AbortSignal;
+}
+export type LevelWrapperBatchOperation<V> = AbstractBatchOperation<Level<string, V>, string, V>;
+export type LevelWrapperIteratorOptions<V> = AbstractIteratorOptions<string, V>;
+export declare class LevelWrapper<V> {
+    config: LevelWrapperConfig<V>;
+    db: LevelDatabase<V>;
+    /**
+     * @param config.location - must be a directory path (relative or absolute) where `Level`` will
+     * store its files, or in browsers, the name of the {@link https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase `IDBDatabase`}
+     * to be opened.
+     */
+    constructor(config: LevelWrapperConfig<V>, db?: LevelDatabase<V>);
+    open(): Promise<void>;
+    close(): Promise<void>;
+    partition(name: string): Promise<LevelWrapper<V>>;
+    get(key: string, options?: LevelWrapperOptions): Promise<V | undefined>;
+    has(key: string, options?: LevelWrapperOptions): Promise<boolean>;
+    keys(options?: LevelWrapperOptions): AsyncGenerator<string>;
+    iterator(iteratorOptions?: LevelWrapperIteratorOptions<V>, options?: LevelWrapperOptions): AsyncGenerator<[string, V]>;
+    put(key: string, value: V, options?: LevelWrapperOptions): Promise<void>;
+    delete(key: string, options?: LevelWrapperOptions): Promise<void>;
+    isEmpty(options?: LevelWrapperOptions): Promise<boolean>;
+    clear(): Promise<void>;
+    batch(operations: Array<LevelWrapperBatchOperation<V>>, options?: LevelWrapperOptions): Promise<void>;
+    /**
+     * Wraps the given LevelWrapperBatchOperation as an operation for the specified partition.
+     */
+    createPartitionOperation(partitionName: string, operation: LevelWrapperBatchOperation<V>): LevelWrapperBatchOperation<V>;
+    private compactUnderlyingStorage;
+    /**
+     * Gets the min and max key value of this partition.
+     */
+    private get sublevelRange();
+    private get root();
+    private createLevelDatabase;
+}
+export type LevelWrapperConfig<V> = CreateLevelDatabaseOptions<V> & {
+    location: string;
+    createLevelDatabase?: typeof createLevelDatabase;
+};
+//# sourceMappingURL=level-wrapper.d.ts.map

package/dist/types/src/store/level-wrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"level-wrapper.d.ts","sourceRoot":"","sources":["../../../../src/store/level-wrapper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,uBAAuB,EAAiB,MAAM,gBAAgB,CAAC;AAG9H,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAE9B,MAAM,MAAM,0BAA0B,CAAC,CAAC,IAAI,uBAAuB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AAE/E,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AAEhD,wBAAsB,mBAAmB,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,0BAA0B,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAIjI;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,MAAM,0BAA0B,CAAC,CAAC,IAAI,sBAAsB,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;AAEhG,MAAM,MAAM,2BAA2B,CAAC,CAAC,IAAI,uBAAuB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AAKhF,qBAAa,YAAY,CAAC,CAAC;IACzB,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAE9B,EAAE,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAErB;;;;OAIG;gBACS,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC;IAS1D,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAmCrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAgCtB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IASjD,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,CAAC,GAAC,SAAS,CAAC;IAmBrE,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/D,IAAI,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,cAAc,CAAC,MAAM,CAAC;IAY3D,QAAQ,CAAC,eAAe,CAAC,EAAE,2BAA2B,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,cAAc,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAYxH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQxE,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQjE,OAAO,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAOxD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAQtB,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ3G;;OAEG;IACH,wBAAwB,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,0BAA0B,CAAC,CAAC,CAAC,GAAG,0BAA0B,CAAC,CAAC,CAAC;YAO1G,wBAAwB;IAkBtC;;OAEG;IACH,OAAO,KAAK,aAAa,GAYxB;IAED,OAAO,KAAK,IAAI,GAMf;YAEa,mBAAmB;CAMlC;AAED,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,0BAA0B,CAAC,CAAC,CAAC,GAAG;IAClE,QAAQ,EAAE,MAAM,CAAC;IACjB,mBAAmB,CAAC,EAAE,OAAO,mBAAmB,CAAC;CAClD,CAAC"}

package/dist/types/src/store/message-store-level.d.ts

@@ -0,0 +1,46 @@
+import type { Filter, KeyValues, PaginationCursor, QueryOptions } from '../types/query-types.js';
+import type { GenericMessage, MessageSort, Pagination } from '../types/message-types.js';
+import type { MessageStore, MessageStoreOptions } from '../types/message-store.js';
+import { BlockstoreLevel } from './blockstore-level.js';
+import { createLevelDatabase } from './level-wrapper.js';
+import { IndexLevel } from './index-level.js';
+/**
+ * A simple implementation of {@link MessageStore} that works in both the browser and server-side.
+ * Leverages LevelDB under the hood.
+ */
+export declare class MessageStoreLevel implements MessageStore {
+    config: MessageStoreLevelConfig;
+    blockstore: BlockstoreLevel;
+    index: IndexLevel;
+    /**
+     * @param {MessageStoreLevelConfig} config
+     * @param {string} config.blockstoreLocation - must be a directory path (relative or absolute) where
+     *  LevelDB will store its files, or in browsers, the name of the
+     * {@link https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase IDBDatabase} to be opened.
+     * @param {string} config.indexLocation - same as config.blockstoreLocation
+     */
+    constructor(config?: MessageStoreLevelConfig);
+    open(): Promise<void>;
+    close(): Promise<void>;
+    get(tenant: string, cidString: string, options?: MessageStoreOptions): Promise<GenericMessage | undefined>;
+    query(tenant: string, filters: Filter[], messageSort?: MessageSort, pagination?: Pagination, options?: MessageStoreOptions): Promise<{
+        messages: GenericMessage[];
+        cursor?: PaginationCursor;
+    }>;
+    /**
+     * Builds the IndexLevel QueryOptions object given MessageStore sort and pagination parameters.
+     */
+    static buildQueryOptions(messageSort?: MessageSort, pagination?: Pagination): QueryOptions;
+    delete(tenant: string, cidString: string, options?: MessageStoreOptions): Promise<void>;
+    put(tenant: string, message: GenericMessage, indexes: KeyValues, options?: MessageStoreOptions): Promise<void>;
+    /**
+     * deletes everything in the underlying blockstore and indices.
+     */
+    clear(): Promise<void>;
+}
+export type MessageStoreLevelConfig = {
+    blockstoreLocation?: string;
+    indexLocation?: string;
+    createLevelDatabase?: typeof createLevelDatabase;
+};
+//# sourceMappingURL=message-store-level.d.ts.map

package/dist/types/src/store/message-store-level.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"message-store-level.d.ts","sourceRoot":"","sources":["../../../../src/store/message-store-level.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACjG,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACzF,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAKnF,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAGxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAEzD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAM9C;;;GAGG;AACH,qBAAa,iBAAkB,YAAW,YAAY;IACpD,MAAM,EAAE,uBAAuB,CAAC;IAEhC,UAAU,EAAE,eAAe,CAAC;IAC5B,KAAK,EAAE,UAAU,CAAC;IAElB;;;;;;OAMG;gBACS,MAAM,GAAE,uBAA4B;IAmB1C,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAKrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAKtB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAkB1G,KAAK,CACT,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EAAE,EACjB,WAAW,CAAC,EAAE,WAAW,EACzB,UAAU,CAAC,EAAE,UAAU,EACvB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC;QAAE,QAAQ,EAAE,cAAc,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,gBAAgB,CAAA;KAAC,CAAC;IA4BpE;;OAEG;IACH,MAAM,CAAC,iBAAiB,CAAC,WAAW,GAAE,WAAgB,EAAE,UAAU,GAAE,UAAe,GAAG,YAAY;IA6B5F,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAUvF,GAAG,CACP,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,cAAc,EACvB,OAAO,EAAE,SAAS,EAClB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,IAAI,CAAC;IAiBhB;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAI7B;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,OAAO,mBAAmB,CAAC;CAClD,CAAC"}

package/dist/types/src/store/resumable-task-store-level.d.ts

@@ -0,0 +1,28 @@
+import type { ManagedResumableTask, ResumableTaskStore } from '../types/resumable-task-store.js';
+import { createLevelDatabase, LevelWrapper } from './level-wrapper.js';
+export type ResumableTaskStoreLevelConfig = {
+    location?: string;
+    createLevelDatabase?: typeof createLevelDatabase;
+};
+/**
+ * A simple single-instance implementation of {@link ResumableTaskStore} that works in both browsers and node.js.
+ * Leverages LevelDB under the hood.
+ */
+export declare class ResumableTaskStoreLevel implements ResumableTaskStore {
+    private static readonly taskTimeoutInSeconds;
+    db: LevelWrapper<string>;
+    config: ResumableTaskStoreLevelConfig;
+    constructor(config: ResumableTaskStoreLevelConfig);
+    open(): Promise<void>;
+    close(): Promise<void>;
+    register(task: any, timeoutInSeconds: number): Promise<ManagedResumableTask>;
+    grab(count: number): Promise<ManagedResumableTask[]>;
+    read(taskId: string): Promise<ManagedResumableTask | undefined>;
+    extend(taskId: string, timeoutInSeconds: number): Promise<void>;
+    delete(taskId: string): Promise<void>;
+    /**
+     * Deletes everything in the store. Mainly used in tests.
+     */
+    clear(): Promise<void>;
+}
+//# sourceMappingURL=resumable-task-store-level.d.ts.map

package/dist/types/src/store/resumable-task-store-level.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resumable-task-store-level.d.ts","sourceRoot":"","sources":["../../../../src/store/resumable-task-store-level.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAGjG,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvE,MAAM,MAAM,6BAA6B,GAAG;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mBAAmB,CAAC,EAAE,OAAO,mBAAmB,CAAA;CACjD,CAAC;AAEF;;;GAGG;AACH,qBAAa,uBAAwB,YAAW,kBAAkB;IAChE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAM;IAElD,EAAE,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IACzB,MAAM,EAAE,6BAA6B,CAAC;gBAE1B,MAAM,EAAE,6BAA6B;IAgB3C,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAIf,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAe5E,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;IA4BpD,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;IAW/D,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAW/D,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlD;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAGpC"}

package/dist/types/src/store/storage-controller.d.ts

@@ -0,0 +1,46 @@
+import type { DataStore } from '../types/data-store.js';
+import type { EventLog } from '../types/event-log.js';
+import type { EventStream } from '../types/subscriptions.js';
+import type { GenericMessage } from '../types/message-types.js';
+import type { MessageStore } from '../types/message-store.js';
+import type { RecordsDeleteMessage } from '../types/records-types.js';
+export type ResumableRecordsDeleteData = {
+    tenant: string;
+    message: RecordsDeleteMessage;
+};
+/**
+ * A class that provides an abstraction for the usage of MessageStore, DataStore, and EventLog.
+ */
+export declare class StorageController {
+    private messageStore;
+    private dataStore;
+    private eventLog;
+    private eventStream?;
+    constructor({ messageStore, dataStore, eventLog, eventStream }: {
+        messageStore: MessageStore;
+        dataStore: DataStore;
+        eventLog: EventLog;
+        eventStream?: EventStream;
+    });
+    performRecordsDelete({ tenant, message }: ResumableRecordsDeleteData): Promise<void>;
+    /**
+     * Deletes the data referenced by the given message if needed.
+     * @param message The message to check if the data it references should be deleted.
+     */
+    private static deleteFromDataStoreIfNeeded;
+    /**
+     * Purges (permanent hard-delete) all descendant's data of the given `recordId`.
+     */
+    static purgeRecordDescendants(tenant: string, recordId: string, messageStore: MessageStore, dataStore: DataStore, eventLog: EventLog): Promise<void>;
+    /**
+     * Purges (permanent hard-delete) all messages of the SAME `recordId` given and their associated data and events.
+     * Assumes that the given `recordMessages` are all of the same `recordId`.
+     */
+    private static purgeRecordMessages;
+    /**
+     * Deletes all messages in `existingMessages` that are older than the `newestMessage` in the given tenant,
+     * but keep the initial write write for future processing by ensuring its `isLatestBaseState` index is "false".
+     */
+    static deleteAllOlderMessagesButKeepInitialWrite(tenant: string, existingMessages: GenericMessage[], newestMessage: GenericMessage, messageStore: MessageStore, dataStore: DataStore, eventLog: EventLog): Promise<void>;
+}
+//# sourceMappingURL=storage-controller.d.ts.map

package/dist/types/src/store/storage-controller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-controller.d.ts","sourceRoot":"","sources":["../../../../src/store/storage-controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,oBAAoB,EAA+C,MAAM,2BAA2B,CAAC;AAUnH,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,oBAAoB,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,qBAAa,iBAAiB;IAE5B,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,WAAW,CAAC,CAAc;gBAEf,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE;QACrE,YAAY,EAAE,YAAY,CAAC;QAC3B,SAAS,EAAE,SAAS,CAAC;QACrB,QAAQ,EAAE,QAAQ,CAAC;QACnB,WAAW,CAAC,EAAE,WAAW,CAAA;KAAC;IAQf,oBAAoB,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;IA0CjG;;;OAGG;mBACkB,2BAA2B;IA2BhD;;OAEG;WACiB,sBAAsB,CACxC,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,YAAY,EAC1B,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,QAAQ,GACjB,OAAO,CAAC,IAAI,CAAC;IAoChB;;;OAGG;mBACkB,mBAAmB;IA2BxC;;;OAGG;WACiB,yCAAyC,CAC3D,MAAM,EAAE,MAAM,EACd,gBAAgB,EAAE,cAAc,EAAE,EAClC,aAAa,EAAE,cAAc,EAC7B,YAAY,EAAE,YAAY,EAC1B,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,QAAQ,GACjB,OAAO,CAAC,IAAI,CAAC;CAqCjB"}

package/dist/types/src/types/cache.d.ts

@@ -0,0 +1,16 @@
+/**
+ * A generalized cache interface.
+ * The motivation behind this interface is so that code that depend on the cache can remain independent to the underlying implementation.
+ */
+export interface Cache {
+    /**
+     * Sets a key-value pair. Does not throw error.
+     */
+    set(key: string, value: any): Promise<void>;
+    /**
+     * Gets the value corresponding to the given key.
+     * @returns value stored corresponding to the given key; `undefined` if key is not found or expired
+     */
+    get(key: string): Promise<any | undefined>;
+}
+//# sourceMappingURL=cache.d.ts.map

package/dist/types/src/types/cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../../../src/types/cache.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,GAAG,SAAS,CAAC,CAAC;CAC5C"}

package/dist/types/src/types/data-store.d.ts

@@ -0,0 +1,57 @@
+import type { Readable } from 'readable-stream';
+/**
+ * The interface that defines how to store and fetch data associated with a message.
+ */
+export interface DataStore {
+    /**
+     * Opens a connection to the underlying store.
+     */
+    open(): Promise<void>;
+    /**
+     * Closes the connection to the underlying store.
+     */
+    close(): Promise<void>;
+    /**
+     * Stores the given data.
+     * @param recordId The logical ID of the record that references the data.
+     * @param dataCid The IPFS CID of the data.
+     */
+    put(tenant: string, recordId: string, dataCid: string, dataStream: Readable): Promise<DataStorePutResult>;
+    /**
+     * Fetches the specified data.
+     * @param recordId The logical ID of the record that references the data.
+     * @param dataCid The IPFS CID of the data.
+     * @returns the data size and data stream if found, otherwise `undefined`.
+     */
+    get(tenant: string, recordId: string, dataCid: string): Promise<DataStoreGetResult | undefined>;
+    /**
+     * Deletes the specified data. No-op if the data does not exist.
+     * @param recordId The logical ID of the record that references the data.
+     * @param dataCid The IPFS CID of the data.
+     */
+    delete(tenant: string, recordId: string, dataCid: string): Promise<void>;
+    /**
+     * Clears the entire store. Mainly used for testing to cleaning up in test environments.
+     */
+    clear(): Promise<void>;
+}
+/**
+ * Result of a data store `put()` method call.
+ */
+export type DataStorePutResult = {
+    /**
+     * The number of bytes of the data stored.
+     */
+    dataSize: number;
+};
+/**
+ * Result of a data store `get()` method call if the data exists.
+ */
+export type DataStoreGetResult = {
+    /**
+     * The number of bytes of the data stored.
+     */
+    dataSize: number;
+    dataStream: Readable;
+};
+//# sourceMappingURL=data-store.d.ts.map

package/dist/types/src/types/data-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-store.d.ts","sourceRoot":"","sources":["../../../../src/types/data-store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtB;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;;;OAIG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAE1G;;;;;OAKG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAC;IAEhG;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzE;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,QAAQ,CAAC;CACtB,CAAC"}

package/dist/types/src/types/event-log.d.ts

@@ -0,0 +1,52 @@
+import type { Filter, KeyValues, PaginationCursor } from './query-types.js';
+export interface EventLog {
+    /**
+     * opens a connection to the underlying store
+     */
+    open(): Promise<void>;
+    /**
+     * closes the connection to the underlying store
+     */
+    close(): Promise<void>;
+    /**
+     * adds an event to a tenant's event log
+     * @param tenant - the tenant's DID
+     * @param messageCid - the CID of the message
+     * @param indexes - (key-value pairs) to be included as part of indexing this event.
+     */
+    append(tenant: string, messageCid: string, indexes: KeyValues): Promise<void>;
+    /**
+     * Retrieves all of a tenant's events that occurred after the cursor provided.
+     * If no cursor is provided, all events for a given tenant will be returned.
+     *
+     * The cursor is a messageCid.
+     *
+     * Returns an array of messageCids that represent the events.
+     */
+    getEvents(tenant: string, cursor?: PaginationCursor): Promise<{
+        events: string[];
+        cursor?: PaginationCursor;
+    }>;
+    /**
+     * retrieves a filtered set of events that occurred after a the cursor provided, accepts multiple filters.
+     *
+     * If no cursor is provided, all events for a given tenant and filter combo will be returned.
+     * The cursor is a messageCid.
+     *
+     * Returns an array of messageCids that represent the events.
+     */
+    queryEvents(tenant: string, filters: Filter[], cursor?: PaginationCursor): Promise<{
+        events: string[];
+        cursor?: PaginationCursor;
+    }>;
+    /**
+     * deletes any events that have any of the messageCids provided
+     * @returns {Promise<number>} the number of events deleted
+     */
+    deleteEventsByCid(tenant: string, messageCids: Array<string>): Promise<void>;
+    /**
+     * Clears the entire store. Mainly used for cleaning up in test environment.
+     */
+    clear(): Promise<void>;
+}
+//# sourceMappingURL=event-log.d.ts.map

package/dist/types/src/types/event-log.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-log.d.ts","sourceRoot":"","sources":["../../../../src/types/event-log.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAE5E,MAAM,WAAW,QAAQ;IACxB;;OAEG;IACF,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtB;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7E;;;;;;;OAOG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,gBAAgB,CAAA;KAAE,CAAC,CAAA;IAE9G;;;;;;;OAOG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,gBAAgB,CAAA;KAAE,CAAC,CAAA;IAEnI;;;OAGG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5E;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB"}