localdb-ces6q 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Joon Ho Cho
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# typescript-esmodule-library-template
+TypeScript ECMAScript Module Library Template

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "localdb-ces6q",
+  "version": "0.0.2",
+  "description": "TypeScript ECMAScript Module Library Template",
+  "type": "module",
+  "module": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc -w",
+    "format": "prettier --write {src,test}/**/*.{ts,tsx,js,jsx}",
+    "pub": "node publish.js",
+    "test": "jest -c ./jest.config.ts",
+    "test:cov": "jest -c ./jest.config.ts --collect-coverage",
+    "test:watch": "jest -c ./jest.config.ts --watch",
+    "typecheck": "tsc --noEmit",
+    "typecheck:watch": "tsc --noEmit -w"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/joonhocho/localdb.git"
+  },
+  "author": "",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/joonhocho/localdb/issues"
+  },
+  "homepage": "https://github.com/joonhocho/localdb#readme",
+  "dependencies": {
+    "util-3gcvv": "^0.4.6"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.21.3",
+    "@babel/preset-env": "^7.20.2",
+    "@babel/preset-typescript": "^7.21.0",
+    "@jest/globals": "^29.5.0",
+    "@types/jest": "^29.4.2",
+    "@types/react": "^18.0.28",
+    "jest-ts-webcompat-resolver": "^1.0.0",
+    "prettier": "^2.8.4",
+    "react": "^18.2.0",
+    "shelljs": "^0.8.5",
+    "ts-jest": "^29.0.5",
+    "typescript": "^4.9.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false
+}

package/src/LocalDB.d.ts

@@ -0,0 +1,102 @@
+import { Debounce } from 'util-3gcvv/class/Debounce.js';
+import { SortedArray } from 'util-3gcvv/class/SortedArray.js';
+import { LocalDBState } from './LocalDBState.js';
+import type { KeyOf } from 'util-3gcvv/types/types.js';
+import type { Collection, Collections, CollectionsChange, CollectionsChangeMap, ColListener, DBListener, DocListener, FieldListener, ICollectionConfig, ICollectionsConfig, ICollectionsFields, IDBOperation, IDBOperationHistoryItem, IDBQuery, IDBTxOptions, IDocument } from './types.js';
+export declare class LocalDB<CollectionTypes extends Record<string, IDocument>> {
+    protected _options?: IDBTxOptions;
+    protected _collectionNames: Array<KeyOf<CollectionTypes>>;
+    protected _collections: Collections<CollectionTypes>;
+    protected _config: ICollectionsConfig<CollectionTypes>;
+    protected _fields: ICollectionsFields<CollectionTypes>;
+    protected _saveCols: {
+        [ColName in KeyOf<CollectionTypes>]: Debounce<() => void>;
+    };
+    protected _indexes: {
+        [ColName in KeyOf<CollectionTypes>]: Record<string, SortedArray<CollectionTypes[ColName]>>;
+    };
+    protected _txChangedFields: CollectionsChangeMap<CollectionTypes>;
+    protected _txChanges: CollectionsChange<CollectionTypes>;
+    protected _txKey: string | null;
+    protected _txOps: IDBOperationHistoryItem[];
+    protected _txRollbacks: VoidFunction[];
+    protected _txSnapshot: Collections<CollectionTypes> | null;
+    protected _txOptions: IDBTxOptions | null;
+    protected _noEvent: boolean;
+    protected _undoable: boolean;
+    protected _inUndoOrRedo: boolean;
+    protected _opQueue: IDBOperation[];
+    protected _commiting: boolean;
+    protected _listenerId: number;
+    protected _dbListeners: Array<{
+        lid: number;
+        handler: DBListener<CollectionTypes>;
+    }>;
+    protected _colListeners: Array<{
+        lid: number;
+        collection: KeyOf<CollectionTypes>;
+        handler: ColListener<CollectionTypes, any>;
+    }>;
+    protected _docListeners: Array<{
+        lid: number;
+        collection: KeyOf<CollectionTypes>;
+        id: string;
+        handler: DocListener<CollectionTypes, any>;
+    }>;
+    protected _fieldListeners: Array<{
+        lid: number;
+        collection: KeyOf<CollectionTypes>;
+        id: string;
+        field: string;
+        handler: FieldListener<CollectionTypes, any, any>;
+    }>;
+    state: LocalDBState;
+    constructor(config: ICollectionsConfig<CollectionTypes>, initialData?: Collections<CollectionTypes>, options?: IDBTxOptions);
+    destroy(): void;
+    toJSON(): Collections<CollectionTypes>;
+    equals(other: Collections<CollectionTypes>): boolean;
+    defineCollection<Data extends IDocument>(colName: string, config: ICollectionConfig<CollectionTypes, Data>, initialData?: {
+        [id in string]: Data;
+    }): void;
+    deleteCollection<ColName extends KeyOf<CollectionTypes>>(col: ColName): void;
+    existsCollection(col: string): boolean;
+    get collectionNames(): Array<KeyOf<CollectionTypes>>;
+    beginTx(options?: IDBTxOptions | undefined): string | null;
+    endTx(txKey: string | null): void;
+    protected _rollback(): void;
+    tx(fn: () => void, options?: IDBTxOptions): void;
+    undoableTx(fn: () => void, options?: IDBTxOptions): void;
+    subToDB(handler: DBListener<CollectionTypes>): () => void;
+    unsubFromDB(lid: number): void;
+    subToCol<ColName extends KeyOf<CollectionTypes>>(collection: ColName, handler: ColListener<CollectionTypes, ColName>): () => void;
+    unsubFromCol(lid: number): void;
+    subToDoc<ColName extends KeyOf<CollectionTypes>>(collection: ColName, id: string, handler: DocListener<CollectionTypes, ColName>): () => void;
+    unsubFromDoc(lid: number): void;
+    subToField<ColName extends KeyOf<CollectionTypes>, Field extends KeyOf<CollectionTypes[ColName]>>(collection: ColName, id: string, field: Field, handler: FieldListener<CollectionTypes, ColName, Field>): () => void;
+    unsubFromField(lid: number): void;
+    collection<ColName extends KeyOf<CollectionTypes>>(colName: ColName): Collection<CollectionTypes, ColName>;
+    doc<ColName extends KeyOf<CollectionTypes>>(colName: ColName, id: string): CollectionTypes[ColName] | undefined;
+    docs<ColName extends KeyOf<CollectionTypes>>(colName: ColName, ids: string[]): Array<CollectionTypes[ColName] | undefined>;
+    docsOrderBy<ColName extends KeyOf<CollectionTypes>>(colName: ColName, index: string): Array<CollectionTypes[ColName]>;
+    query<ColName extends KeyOf<CollectionTypes>>({ collection, orderBy, limit, startAfter, startAt, endAfter, endAt, }: IDBQuery<CollectionTypes, ColName>): Array<CollectionTypes[ColName]>;
+    setDoc<ColName extends KeyOf<CollectionTypes>>(colName: ColName, doc: CollectionTypes[ColName], options?: IDBTxOptions): void;
+    setDocs<ColName extends KeyOf<CollectionTypes>>(colName: ColName, docs: Array<CollectionTypes[ColName]>, options?: IDBTxOptions): void;
+    protected _updateDoc<ColName extends KeyOf<CollectionTypes>>(colName: ColName, prev: CollectionTypes[ColName], update: Partial<CollectionTypes[ColName]>): {
+        next: CollectionTypes[ColName];
+        changedKeys: Array<KeyOf<CollectionTypes[ColName]>>;
+    } | null;
+    updateDoc<ColName extends KeyOf<CollectionTypes>>(colName: ColName, id: string, updater: Partial<CollectionTypes[ColName]> | ((prev: CollectionTypes[ColName]) => Partial<CollectionTypes[ColName]> | null | undefined), options?: IDBTxOptions): void;
+    updateDocs<ColName extends KeyOf<CollectionTypes>>(colName: ColName, updater: Record<string, Partial<CollectionTypes[ColName]>> | ((prev: Collections<CollectionTypes>[ColName]) => Record<string, Partial<CollectionTypes[ColName]> | null | undefined> | null | undefined), options?: IDBTxOptions): void;
+    deleteDoc<ColName extends KeyOf<CollectionTypes>>(colName: ColName, id: string, options?: IDBTxOptions): void;
+    deleteDocs<ColName extends KeyOf<CollectionTypes>>(colName: ColName, ids: string[], options?: IDBTxOptions): void;
+    protected _commitChanges(): void;
+    protected _flushQueue(): void;
+    protected _pushHistory(): void;
+    undo(): void;
+    redo(): void;
+    loadCollectionFromStorage<ColName extends KeyOf<CollectionTypes>>(collection: ColName): Record<string, CollectionTypes[ColName]> | undefined;
+    saveCollectionToStorage<ColName extends KeyOf<CollectionTypes>>(collection: ColName): void;
+    protected loadFromStorage(): void;
+    saveToStorage(): void;
+    saveDebounced: Debounce<() => void>;
+}