@xylabs/indexed-db 4.13.15 → 4.13.17

package/README.md

@@ -1,63 +1,54 @@
-[![logo][]](https://xylabs.com)
-
 # @xylabs/indexed-db
 
+[![logo][]](https://xylabs.com)
+
+[![main-build][]][main-build-link]
 [![npm-badge][]][npm-link]
 [![npm-downloads-badge][]][npm-link]
 [![jsdelivr-badge][]][jsdelivr-link]
 [![npm-license-badge][]](LICENSE)
+[![codacy-badge][]][codacy-link]
+[![codeclimate-badge][]][codeclimate-link]
+[![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-> XY Labs Indexed DB Helpers
-
-## Table of Contents
-
--   [Description](#description)
--   [Install](#install)
--   [Maintainers](#maintainers)
--   [License](#license)
--   [Credits](#credits)
-
-## Description
+Version: 4.13.15
 
-Various Indexed DB Helper Functions
+Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
-## Install
-
-Using npm:
-
-```sh
-npm i --save @xylabs/indexed-db
-```
+## Documentation
 
-Using yarn:
+Coming Soon!
 
-```sh
-yarn add @xylabs/indexed-db
-```
-
-## Documentation
-[Developer Reference](https://xylabs.github.io/sdk-js)
+Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 
 ## Maintainers
 
 -   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Joel Carter](https://github.com/JoelBCarter)
 -   [Matt Jones](https://github.com/jonesmac)
+-   [Joel Carter](https://github.com/JoelBCarter)
 -   [Jordan Trouw](https://github.com/jordantrouw)
 
 ## License
 
-See the [LICENSE](LICENSE) file for license details
+> See the [LICENSE](LICENSE) file for license details
 
 ## Credits
 
-[Made with 🔥and ❄️ by XY Labs](https://xylabs.com)
+[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
 
 [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
 
+[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
+[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/indexed-db.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/indexed-db
+[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
+[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
+[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
+[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
+[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
+[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
 
 [npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/indexed-db
 [npm-license-badge]: https://img.shields.io/npm/l/@xylabs/indexed-db

package/dist/browser/index.d.ts

@@ -1,74 +1,12 @@
-import { Logger } from '@xylabs/logger';
-import { DBSchema, IDBPDatabase, StoreNames, StoreValue, StoreKey, IDBPObjectStore } from 'idb';
-import { EmptyObject } from '@xylabs/object';
-import { KeyValueStore } from '@xylabs/storage';
-
-/**
- * The index direction (1 for ascending, -1 for descending)
- */
-type IndexDirection = -1 | 1;
-/**
- * Description of index(es) to be created on a store
- */
-type IndexDescription = {
-    /**
-     * The key(s) to index
-     */
-    key: Record<string, IndexDirection>;
-    /**
-     * Is the indexed value an array
-     */
-    multiEntry?: boolean;
-    /**
-     * If true, the index must enforce uniqueness on the key
-     */
-    unique?: boolean;
-};
-declare const IndexSeparator = "-";
-/**
- * Given an index description, this will build the index
- * name in standard form
- * @param index The index description
- * @returns The index name in standard form
- */
-declare const buildStandardIndexName: (index: IndexDescription) => string;
-
-declare function checkDbNeedsUpgrade(dbName: string, stores: Record<string, IndexDescription[]>, logger?: Logger): Promise<number>;
-
-declare function createStoreDuringUpgrade<DBTypes extends DBSchema | unknown = unknown>(db: IDBPDatabase<DBTypes>, storeName: StoreNames<DBTypes>, indexes: IndexDescription[], logger?: Logger): void;
-
-interface ObjectStore<T extends EmptyObject = EmptyObject> {
-    [s: string]: T;
-}
-
-declare function getExistingIndexes<T extends EmptyObject = EmptyObject>(db: IDBPDatabase<ObjectStore<T>> | string, storeName: StoreNames<ObjectStore<T>>, logger?: Logger): Promise<IndexDescription[] | null>;
-
-/**
- * An IndexedDB key/value store.
- */
-declare class IndexedDbKeyValueStore<T extends DBSchema, S extends StoreNames<T>> implements KeyValueStore<StoreValue<T, S>, StoreKey<T, S>> {
-    readonly dbName: string;
-    readonly storeName: S;
-    constructor(dbName: string, storeName: S);
-    clear?(): Promise<void>;
-    delete(key: StoreKey<T, S>): Promise<void>;
-    get(key: StoreKey<T, S>): Promise<StoreValue<T, S> | undefined>;
-    keys?(): Promise<StoreKey<T, S>[]>;
-    set(key: StoreKey<T, S>, value: StoreValue<T, S>): Promise<void>;
-    withDb<R = StoreValue<T, S>>(callback: (db: IDBPDatabase<T>) => Promise<R> | R): Promise<R>;
-}
-
-declare function withDb<DBTypes extends DBSchema | unknown = unknown, R = EmptyObject>(dbName: string, callback: (db: IDBPDatabase<DBTypes>) => Promise<R> | R, expectedIndexes?: Record<string, IndexDescription[]>, logger?: Logger, lock?: boolean): Promise<R>;
-
-declare function withDbByVersion<DBTypes extends DBSchema | unknown = unknown, R = EmptyObject>(dbName: string, callback: (db: IDBPDatabase<DBTypes>) => Promise<R> | R, version?: number, expectedIndexes?: Record<string, IndexDescription[]>, logger?: Logger, lock?: boolean): Promise<R>;
-
-declare function withReadOnlyStore<T extends EmptyObject = EmptyObject, R = T>(db: IDBPDatabase<ObjectStore<T>>, storeName: StoreNames<ObjectStore<T>>, callback: (store: IDBPObjectStore<ObjectStore<T>, [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, 'readonly'> | null) => Promise<R> | R, logger?: Logger): Promise<R>;
-
-declare function withReadWriteStore<T extends EmptyObject = EmptyObject, R = T>(db: IDBPDatabase<ObjectStore<T>>, storeName: StoreNames<ObjectStore<T>>, callback: (store: IDBPObjectStore<ObjectStore<T>, [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, 'readwrite'> | null) => Promise<R> | R, logger?: Logger): Promise<R>;
-
-declare function withStore<T extends EmptyObject = EmptyObject, R = T, M extends 'readonly' | 'readwrite' = 'readonly'>(db: IDBPDatabase<ObjectStore<T>>, storeName: StoreNames<ObjectStore<T>>, callback: (store: IDBPObjectStore<ObjectStore<T>, [
-    StoreNames<ObjectStore<T>>
-], StoreNames<ObjectStore<T>>, M> | null) => Promise<R> | R, mode: M, logger?: Logger): Promise<R>;
-
-export { IndexSeparator, IndexedDbKeyValueStore, buildStandardIndexName, checkDbNeedsUpgrade, createStoreDuringUpgrade, getExistingIndexes, withDb, withDbByVersion, withReadOnlyStore, withReadWriteStore, withStore };
-export type { IndexDescription, IndexDirection, ObjectStore };
+export * from './checkDbNeedsUpgrade.ts';
+export * from './createStoreDuringUpgrade.ts';
+export * from './getExistingIndexes.ts';
+export * from './IndexDescription.ts';
+export * from './IndexedDbKeyValueStore.ts';
+export * from './ObjectStore.ts';
+export * from './withDb.ts';
+export * from './withDbByVersion.ts';
+export * from './withReadOnlyStore.ts';
+export * from './withReadWriteStore.ts';
+export * from './withStore.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/browser/spec/upgrade.spec.d.ts

@@ -0,0 +1,2 @@
+import 'fake-indexeddb/auto';
+//# sourceMappingURL=upgrade.spec.d.ts.map

package/dist/browser/spec/upgrade.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upgrade.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/upgrade.spec.ts"],"names":[],"mappings":"AAGA,OAAO,qBAAqB,CAAA"}

package/dist/neutral/index.d.ts

@@ -1,74 +1,12 @@
-import { Logger } from '@xylabs/logger';
-import { DBSchema, IDBPDatabase, StoreNames, StoreValue, StoreKey, IDBPObjectStore } from 'idb';
-import { EmptyObject } from '@xylabs/object';
-import { KeyValueStore } from '@xylabs/storage';
-
-/**
- * The index direction (1 for ascending, -1 for descending)
- */
-type IndexDirection = -1 | 1;
-/**
- * Description of index(es) to be created on a store
- */
-type IndexDescription = {
-    /**
-     * The key(s) to index
-     */
-    key: Record<string, IndexDirection>;
-    /**
-     * Is the indexed value an array
-     */
-    multiEntry?: boolean;
-    /**
-     * If true, the index must enforce uniqueness on the key
-     */
-    unique?: boolean;
-};
-declare const IndexSeparator = "-";
-/**
- * Given an index description, this will build the index
- * name in standard form
- * @param index The index description
- * @returns The index name in standard form
- */
-declare const buildStandardIndexName: (index: IndexDescription) => string;
-
-declare function checkDbNeedsUpgrade(dbName: string, stores: Record<string, IndexDescription[]>, logger?: Logger): Promise<number>;
-
-declare function createStoreDuringUpgrade<DBTypes extends DBSchema | unknown = unknown>(db: IDBPDatabase<DBTypes>, storeName: StoreNames<DBTypes>, indexes: IndexDescription[], logger?: Logger): void;
-
-interface ObjectStore<T extends EmptyObject = EmptyObject> {
-    [s: string]: T;
-}
-
-declare function getExistingIndexes<T extends EmptyObject = EmptyObject>(db: IDBPDatabase<ObjectStore<T>> | string, storeName: StoreNames<ObjectStore<T>>, logger?: Logger): Promise<IndexDescription[] | null>;
-
-/**
- * An IndexedDB key/value store.
- */
-declare class IndexedDbKeyValueStore<T extends DBSchema, S extends StoreNames<T>> implements KeyValueStore<StoreValue<T, S>, StoreKey<T, S>> {
-    readonly dbName: string;
-    readonly storeName: S;
-    constructor(dbName: string, storeName: S);
-    clear?(): Promise<void>;
-    delete(key: StoreKey<T, S>): Promise<void>;
-    get(key: StoreKey<T, S>): Promise<StoreValue<T, S> | undefined>;
-    keys?(): Promise<StoreKey<T, S>[]>;
-    set(key: StoreKey<T, S>, value: StoreValue<T, S>): Promise<void>;
-    withDb<R = StoreValue<T, S>>(callback: (db: IDBPDatabase<T>) => Promise<R> | R): Promise<R>;
-}
-
-declare function withDb<DBTypes extends DBSchema | unknown = unknown, R = EmptyObject>(dbName: string, callback: (db: IDBPDatabase<DBTypes>) => Promise<R> | R, expectedIndexes?: Record<string, IndexDescription[]>, logger?: Logger, lock?: boolean): Promise<R>;
-
-declare function withDbByVersion<DBTypes extends DBSchema | unknown = unknown, R = EmptyObject>(dbName: string, callback: (db: IDBPDatabase<DBTypes>) => Promise<R> | R, version?: number, expectedIndexes?: Record<string, IndexDescription[]>, logger?: Logger, lock?: boolean): Promise<R>;
-
-declare function withReadOnlyStore<T extends EmptyObject = EmptyObject, R = T>(db: IDBPDatabase<ObjectStore<T>>, storeName: StoreNames<ObjectStore<T>>, callback: (store: IDBPObjectStore<ObjectStore<T>, [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, 'readonly'> | null) => Promise<R> | R, logger?: Logger): Promise<R>;
-
-declare function withReadWriteStore<T extends EmptyObject = EmptyObject, R = T>(db: IDBPDatabase<ObjectStore<T>>, storeName: StoreNames<ObjectStore<T>>, callback: (store: IDBPObjectStore<ObjectStore<T>, [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, 'readwrite'> | null) => Promise<R> | R, logger?: Logger): Promise<R>;
-
-declare function withStore<T extends EmptyObject = EmptyObject, R = T, M extends 'readonly' | 'readwrite' = 'readonly'>(db: IDBPDatabase<ObjectStore<T>>, storeName: StoreNames<ObjectStore<T>>, callback: (store: IDBPObjectStore<ObjectStore<T>, [
-    StoreNames<ObjectStore<T>>
-], StoreNames<ObjectStore<T>>, M> | null) => Promise<R> | R, mode: M, logger?: Logger): Promise<R>;
-
-export { IndexSeparator, IndexedDbKeyValueStore, buildStandardIndexName, checkDbNeedsUpgrade, createStoreDuringUpgrade, getExistingIndexes, withDb, withDbByVersion, withReadOnlyStore, withReadWriteStore, withStore };
-export type { IndexDescription, IndexDirection, ObjectStore };
+export * from './checkDbNeedsUpgrade.ts';
+export * from './createStoreDuringUpgrade.ts';
+export * from './getExistingIndexes.ts';
+export * from './IndexDescription.ts';
+export * from './IndexedDbKeyValueStore.ts';
+export * from './ObjectStore.ts';
+export * from './withDb.ts';
+export * from './withDbByVersion.ts';
+export * from './withReadOnlyStore.ts';
+export * from './withReadWriteStore.ts';
+export * from './withStore.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/neutral/spec/upgrade.spec.d.ts

@@ -0,0 +1,2 @@
+import 'fake-indexeddb/auto';
+//# sourceMappingURL=upgrade.spec.d.ts.map

package/dist/neutral/spec/upgrade.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upgrade.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/upgrade.spec.ts"],"names":[],"mappings":"AAGA,OAAO,qBAAqB,CAAA"}

package/dist/node/index.d.ts

@@ -1,74 +1,12 @@
-import { Logger } from '@xylabs/logger';
-import { DBSchema, IDBPDatabase, StoreNames, StoreValue, StoreKey, IDBPObjectStore } from 'idb';
-import { EmptyObject } from '@xylabs/object';
-import { KeyValueStore } from '@xylabs/storage';
-
-/**
- * The index direction (1 for ascending, -1 for descending)
- */
-type IndexDirection = -1 | 1;
-/**
- * Description of index(es) to be created on a store
- */
-type IndexDescription = {
-    /**
-     * The key(s) to index
-     */
-    key: Record<string, IndexDirection>;
-    /**
-     * Is the indexed value an array
-     */
-    multiEntry?: boolean;
-    /**
-     * If true, the index must enforce uniqueness on the key
-     */
-    unique?: boolean;
-};
-declare const IndexSeparator = "-";
-/**
- * Given an index description, this will build the index
- * name in standard form
- * @param index The index description
- * @returns The index name in standard form
- */
-declare const buildStandardIndexName: (index: IndexDescription) => string;
-
-declare function checkDbNeedsUpgrade(dbName: string, stores: Record<string, IndexDescription[]>, logger?: Logger): Promise<number>;
-
-declare function createStoreDuringUpgrade<DBTypes extends DBSchema | unknown = unknown>(db: IDBPDatabase<DBTypes>, storeName: StoreNames<DBTypes>, indexes: IndexDescription[], logger?: Logger): void;
-
-interface ObjectStore<T extends EmptyObject = EmptyObject> {
-    [s: string]: T;
-}
-
-declare function getExistingIndexes<T extends EmptyObject = EmptyObject>(db: IDBPDatabase<ObjectStore<T>> | string, storeName: StoreNames<ObjectStore<T>>, logger?: Logger): Promise<IndexDescription[] | null>;
-
-/**
- * An IndexedDB key/value store.
- */
-declare class IndexedDbKeyValueStore<T extends DBSchema, S extends StoreNames<T>> implements KeyValueStore<StoreValue<T, S>, StoreKey<T, S>> {
-    readonly dbName: string;
-    readonly storeName: S;
-    constructor(dbName: string, storeName: S);
-    clear?(): Promise<void>;
-    delete(key: StoreKey<T, S>): Promise<void>;
-    get(key: StoreKey<T, S>): Promise<StoreValue<T, S> | undefined>;
-    keys?(): Promise<StoreKey<T, S>[]>;
-    set(key: StoreKey<T, S>, value: StoreValue<T, S>): Promise<void>;
-    withDb<R = StoreValue<T, S>>(callback: (db: IDBPDatabase<T>) => Promise<R> | R): Promise<R>;
-}
-
-declare function withDb<DBTypes extends DBSchema | unknown = unknown, R = EmptyObject>(dbName: string, callback: (db: IDBPDatabase<DBTypes>) => Promise<R> | R, expectedIndexes?: Record<string, IndexDescription[]>, logger?: Logger, lock?: boolean): Promise<R>;
-
-declare function withDbByVersion<DBTypes extends DBSchema | unknown = unknown, R = EmptyObject>(dbName: string, callback: (db: IDBPDatabase<DBTypes>) => Promise<R> | R, version?: number, expectedIndexes?: Record<string, IndexDescription[]>, logger?: Logger, lock?: boolean): Promise<R>;
-
-declare function withReadOnlyStore<T extends EmptyObject = EmptyObject, R = T>(db: IDBPDatabase<ObjectStore<T>>, storeName: StoreNames<ObjectStore<T>>, callback: (store: IDBPObjectStore<ObjectStore<T>, [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, 'readonly'> | null) => Promise<R> | R, logger?: Logger): Promise<R>;
-
-declare function withReadWriteStore<T extends EmptyObject = EmptyObject, R = T>(db: IDBPDatabase<ObjectStore<T>>, storeName: StoreNames<ObjectStore<T>>, callback: (store: IDBPObjectStore<ObjectStore<T>, [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, 'readwrite'> | null) => Promise<R> | R, logger?: Logger): Promise<R>;
-
-declare function withStore<T extends EmptyObject = EmptyObject, R = T, M extends 'readonly' | 'readwrite' = 'readonly'>(db: IDBPDatabase<ObjectStore<T>>, storeName: StoreNames<ObjectStore<T>>, callback: (store: IDBPObjectStore<ObjectStore<T>, [
-    StoreNames<ObjectStore<T>>
-], StoreNames<ObjectStore<T>>, M> | null) => Promise<R> | R, mode: M, logger?: Logger): Promise<R>;
-
-export { IndexSeparator, IndexedDbKeyValueStore, buildStandardIndexName, checkDbNeedsUpgrade, createStoreDuringUpgrade, getExistingIndexes, withDb, withDbByVersion, withReadOnlyStore, withReadWriteStore, withStore };
-export type { IndexDescription, IndexDirection, ObjectStore };
+export * from './checkDbNeedsUpgrade.ts';
+export * from './createStoreDuringUpgrade.ts';
+export * from './getExistingIndexes.ts';
+export * from './IndexDescription.ts';
+export * from './IndexedDbKeyValueStore.ts';
+export * from './ObjectStore.ts';
+export * from './withDb.ts';
+export * from './withDbByVersion.ts';
+export * from './withReadOnlyStore.ts';
+export * from './withReadWriteStore.ts';
+export * from './withStore.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/spec/upgrade.spec.d.ts

@@ -0,0 +1,2 @@
+import 'fake-indexeddb/auto';
+//# sourceMappingURL=upgrade.spec.d.ts.map

package/dist/node/spec/upgrade.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upgrade.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/upgrade.spec.ts"],"names":[],"mappings":"AAGA,OAAO,qBAAqB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/indexed-db",
-  "version": "4.13.15",
+  "version": "4.13.17",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "hex",
@@ -49,16 +49,16 @@
     "packages/**/*"
   ],
   "dependencies": {
-    "@xylabs/exists": "^4.13.15",
-    "@xylabs/logger": "^4.13.15",
-    "@xylabs/object": "^4.13.15",
-    "@xylabs/storage": "^4.13.15",
+    "@xylabs/exists": "^4.13.17",
+    "@xylabs/logger": "^4.13.17",
+    "@xylabs/object": "^4.13.17",
+    "@xylabs/storage": "^4.13.17",
     "async-mutex": "^0.5.0",
     "idb": "^8.0.3"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
-    "@xylabs/tsconfig-dom": "^7.0.0-rc.20",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig-dom": "^7.0.0-rc.27",
     "fake-indexeddb": "^6.0.1",
     "jsdom": "^26.1.0",
     "typescript": "^5.8.3",

package/build/browser/index.d.ts

@@ -1,12 +0,0 @@
-export * from './checkDbNeedsUpgrade.ts';
-export * from './createStoreDuringUpgrade.ts';
-export * from './getExistingIndexes.ts';
-export * from './IndexDescription.ts';
-export * from './IndexedDbKeyValueStore.ts';
-export * from './ObjectStore.ts';
-export * from './withDb.ts';
-export * from './withDbByVersion.ts';
-export * from './withReadOnlyStore.ts';
-export * from './withReadWriteStore.ts';
-export * from './withStore.ts';
-//# sourceMappingURL=index.d.ts.map

package/build/neutral/index.d.ts

@@ -1,12 +0,0 @@
-export * from './checkDbNeedsUpgrade.ts';
-export * from './createStoreDuringUpgrade.ts';
-export * from './getExistingIndexes.ts';
-export * from './IndexDescription.ts';
-export * from './IndexedDbKeyValueStore.ts';
-export * from './ObjectStore.ts';
-export * from './withDb.ts';
-export * from './withDbByVersion.ts';
-export * from './withReadOnlyStore.ts';
-export * from './withReadWriteStore.ts';
-export * from './withStore.ts';
-//# sourceMappingURL=index.d.ts.map

package/build/node/index.d.ts

@@ -1,12 +0,0 @@
-export * from './checkDbNeedsUpgrade.ts';
-export * from './createStoreDuringUpgrade.ts';
-export * from './getExistingIndexes.ts';
-export * from './IndexDescription.ts';
-export * from './IndexedDbKeyValueStore.ts';
-export * from './ObjectStore.ts';
-export * from './withDb.ts';
-export * from './withDbByVersion.ts';
-export * from './withReadOnlyStore.ts';
-export * from './withReadWriteStore.ts';
-export * from './withStore.ts';
-//# sourceMappingURL=index.d.ts.map