@xyo-network/archivist-indexeddb 4.1.2 → 4.1.4

package/dist/browser/index.d.ts

@@ -1,105 +1,5 @@
-import { Hash, Hex } from '@xylabs/hex';
-import { ObjectStore } from '@xylabs/indexed-db';
-import { AbstractArchivist } from '@xyo-network/archivist-abstract';
-import { ArchivistConfig, ArchivistParams, ArchivistModuleEventData, ArchivistNextOptions } from '@xyo-network/archivist-model';
-import { WithStorageMeta, Schema, Payload } from '@xyo-network/payload-model';
-import { IDBPDatabase } from 'idb';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-
-declare const IndexedDbArchivistSchema: "network.xyo.archivist.indexeddb";
-type IndexedDbArchivistSchema = typeof IndexedDbArchivistSchema;
-
-type IndexedDbArchivistConfigSchema = `${IndexedDbArchivistSchema}.config`;
-declare const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema;
-type IndexedDbArchivistConfig<TStoreName extends string = string> = ArchivistConfig<{
-    /**
-     * The database name
-     */
-    dbName?: string;
-    /**
-     * The version of the DB, defaults to 1
-     */
-    dbVersion?: number;
-    schema: IndexedDbArchivistConfigSchema;
-    /**
-     * The name of the object store
-     */
-    storeName?: TStoreName;
-}>;
-
-type IndexedDbArchivistParams = ArchivistParams<AnyConfigSchema<IndexedDbArchivistConfig>>;
-
-interface PayloadStore {
-    [s: string]: WithStorageMeta;
-}
-declare class IndexedDbArchivist<TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends AbstractArchivist<TParams, TEventData> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    static readonly defaultDbName = "archivist";
-    static readonly defaultDbVersion = 1;
-    static readonly defaultStoreName = "payloads";
-    static readonly labels: {
-        "network.xyo.storage.class": string;
-    };
-    private static readonly dataHashIndex;
-    private static readonly hashIndex;
-    private static readonly schemaIndex;
-    private static readonly sequenceIndex;
-    static readonly hashIndexName: string;
-    static readonly dataHashIndexName: string;
-    static readonly schemaIndexName: string;
-    static readonly sequenceIndexName: string;
-    private _dbName?;
-    private _dbVersion?;
-    private _payloadCount;
-    private _storeName?;
-    /**
-     * The database name. If not supplied via config, it defaults
-     * to the module name (not guaranteed to be unique) and if module
-     * name is not supplied, it defaults to `archivist`. This behavior
-     * biases towards a single, isolated DB per archivist which seems to
-     * make the most sense for 99% of use cases.
-     */
-    get dbName(): string;
-    /**
-     * The database version. If not supplied via config, it defaults to 1.
-     */
-    get dbVersion(): number;
-    get queries(): string[];
-    /**
-     * The name of the object store. If not supplied via config, it defaults
-     * to `payloads`.
-     */
-    get storeName(): string;
-    /**
-     * The indexes to create on the store
-     */
-    private get indexes();
-    protected allHandler(): Promise<WithStorageMeta<Payload>[]>;
-    protected clearHandler(): Promise<void>;
-    protected deleteHandler(hashes: Hash[]): Promise<WithStorageMeta<Payload>[]>;
-    protected getFromCursor(db: IDBPDatabase<ObjectStore>, storeName: string, order?: 'asc' | 'desc', limit?: number, cursor?: Hex, open?: boolean): Promise<WithStorageMeta[]>;
-    /**
-     * Uses an index to get a payload by the index value, but returns the value with the primary key (from the root store)
-     * @param db The db instance to use
-     * @param storeName The name of the store to use
-     * @param indexName The index to use
-     * @param key The key to get from the index
-     * @returns The primary key and the payload, or undefined if not found
-     */
-    protected getFromIndexWithPrimaryKey(db: IDBPDatabase<ObjectStore>, storeName: string, indexName: string, key: IDBValidKey): Promise<[number, WithStorageMeta] | undefined>;
-    protected getHandler(hashes: string[]): Promise<WithStorageMeta[]>;
-    protected insertHandler(payloads: WithStorageMeta<Payload>[]): Promise<WithStorageMeta<Payload>[]>;
-    protected nextHandler(options?: ArchivistNextOptions): Promise<WithStorageMeta<Payload>[]>;
-    protected payloadCountHandler(): number;
-    protected startHandler(): Promise<void>;
-    /**
-     * Executes a callback with the initialized DB and then closes the db
-     * @param callback The method to execute with the initialized DB
-     * @returns
-     */
-    private useDb;
-}
-
-export { IndexedDbArchivist, IndexedDbArchivistConfigSchema, IndexedDbArchivistSchema };
-export type { IndexedDbArchivistConfig, IndexedDbArchivistParams, PayloadStore };
+export * from './Archivist.ts';
+export * from './Config.ts';
+export * from './Params.ts';
+export * from './Schema.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/archivist-indexeddb",
-  "version": "4.1.2",
+  "version": "4.1.4",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,29 +29,29 @@
   "module": "dist/browser/index.mjs",
   "types": "dist/browser/index.d.ts",
   "dependencies": {
-    "@xylabs/array": "^4.13.15",
-    "@xylabs/assert": "^4.13.15",
-    "@xylabs/exists": "^4.13.15",
-    "@xylabs/hex": "^4.13.15",
-    "@xylabs/indexed-db": "^4.13.15",
-    "@xylabs/typeof": "^4.13.15",
-    "@xyo-network/archivist-abstract": "^4.1.2",
-    "@xyo-network/archivist-model": "^4.1.2",
-    "@xyo-network/module-model": "^4.1.2",
-    "@xyo-network/payload-builder": "^4.1.2",
-    "@xyo-network/payload-model": "^4.1.2",
+    "@xylabs/array": "^4.13.16",
+    "@xylabs/assert": "^4.13.16",
+    "@xylabs/exists": "^4.13.16",
+    "@xylabs/hex": "^4.13.16",
+    "@xylabs/indexed-db": "^4.13.16",
+    "@xylabs/typeof": "^4.13.16",
+    "@xyo-network/archivist-abstract": "^4.1.4",
+    "@xyo-network/archivist-model": "^4.1.4",
+    "@xyo-network/module-model": "^4.1.4",
+    "@xyo-network/payload-builder": "^4.1.4",
+    "@xyo-network/payload-model": "^4.1.4",
     "idb": "^8.0.3"
   },
   "devDependencies": {
-    "@xylabs/delay": "^4.13.15",
-    "@xylabs/object": "^4.13.15",
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.23",
-    "@xylabs/tsconfig": "^7.0.0-rc.23",
-    "@xyo-network/account": "^4.1.2",
-    "@xyo-network/account-model": "^4.1.2",
-    "@xyo-network/archivist-acceptance-tests": "^4.1.2",
-    "@xyo-network/id-payload-plugin": "^4.1.2",
-    "@xyo-network/payload-wrapper": "^4.1.2",
+    "@xylabs/delay": "^4.13.16",
+    "@xylabs/object": "^4.13.16",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig": "^7.0.0-rc.27",
+    "@xyo-network/account": "^4.1.4",
+    "@xyo-network/account-model": "^4.1.4",
+    "@xyo-network/archivist-acceptance-tests": "^4.1.4",
+    "@xyo-network/id-payload-plugin": "^4.1.4",
+    "@xyo-network/payload-wrapper": "^4.1.4",
     "fake-indexeddb": "^6.0.1",
     "typescript": "^5.8.3",
     "uuid": "^11.1.0",