@nu-art/firebase-backend 0.401.8 → 0.500.0

package/firestore-v3/DocWrapperV3.d.ts

@@ -1,12 +1,13 @@
-import { DBProto, UniqueId } from '@nu-art/ts-common';
+import { DB_Prototype } from '@nu-art/db-api-shared';
+import { TS_Object, UniqueId } from '@nu-art/ts-common';
 import { FirestoreType_DocumentReference } from '../firestore/types.js';
 import { Transaction } from 'firebase-admin/firestore';
 import { FirestoreCollectionV3 } from './FirestoreCollectionV3.js';
 import type { firestore as Fa } from 'firebase-admin';
-export type UpdateObject<Proto extends DBProto<any>> = {
+export type UpdateObject<DBType extends TS_Object> = {
     _id: UniqueId;
-} & Fa.UpdateData<Proto['dbType']>;
-export declare class DocWrapperV3<Proto extends DBProto<any>> {
+} & Fa.UpdateData<DBType>;
+export declare class DocWrapperV3<Proto extends DB_Prototype> {
     readonly ref: FirestoreType_DocumentReference<Proto['dbType']>;
     readonly collection: FirestoreCollectionV3<Proto>;
     data?: Proto['dbType'];

package/firestore-v3/FirestoreCollectionV3.d.ts

@@ -1,4 +1,5 @@
-import { CustomException, DBDef_V3, DBProto, InvalidResult, Logger, UniqueId } from '@nu-art/ts-common';
+import { Database, DB_Prototype } from '@nu-art/db-api-shared';
+import { CustomException, InvalidResult, Logger, TS_Object, UniqueId } from '@nu-art/ts-common';
 import { FirestoreType_Collection, FirestoreType_DocumentReference } from '../firestore/types.js';
 import { Clause_Where, FirestoreQuery, MultiWriteOperation } from '@nu-art/firebase-shared';
 import { FirestoreWrapperBEV3 } from './FirestoreWrapperBEV3.js';
@@ -6,20 +7,20 @@ import { Transaction } from 'firebase-admin/firestore';
 import { firestore } from 'firebase-admin';
 import { DocWrapperV3, UpdateObject } from './DocWrapperV3.js';
 import UpdateData = firestore.UpdateData;
-export type PostWriteProcessingData<Proto extends DBProto<any>> = {
-    before?: Proto['dbType'] | Proto['dbType'][];
-    updated?: Proto['dbType'] | Proto['dbType'][];
-    deleted?: Proto['dbType'] | Proto['dbType'][] | null;
+export type PostWriteProcessingData<DBType extends TS_Object> = {
+    before?: DBType | DBType[];
+    updated?: DBType | DBType[];
+    deleted?: DBType | DBType[] | null;
 };
 export type CollectionActionType = 'create' | 'set' | 'update' | 'delete';
-export type FirestoreCollectionHooks<Proto extends DBProto<any>> = {
-    canDeleteItems: (dbItems: Proto['dbType'][], transaction?: Transaction) => Promise<void>;
-    preWriteProcessing?: (dbInstance: Proto['dbType'], originalDbInstance?: Proto['dbType'], transaction?: Transaction) => Promise<void>;
-    manipulateQuery?: (query: FirestoreQuery<Proto['dbType']>) => FirestoreQuery<Proto['dbType']>;
-    postWriteProcessing?: (data: PostWriteProcessingData<Proto>, actionType: CollectionActionType, transaction?: Transaction) => Promise<void>;
-    upgradeInstances: (instances: Proto['dbType'][]) => Promise<any>;
+export type FirestoreCollectionHooks<DBType extends TS_Object> = {
+    canDeleteItems: (dbItems: DBType[], transaction?: Transaction) => Promise<void>;
+    preWriteProcessing?: (dbInstance: DBType, originalDbInstance?: DBType, transaction?: Transaction) => Promise<void>;
+    manipulateQuery?: (query: FirestoreQuery<DBType>) => FirestoreQuery<DBType>;
+    postWriteProcessing?: (data: PostWriteProcessingData<DBType>, actionType: CollectionActionType, transaction?: Transaction) => Promise<void>;
+    upgradeInstances: (instances: DBType[]) => Promise<any>;
 };
-export type MultiWriteItem<Op extends MultiWriteOperation, Proto extends DBProto<any>> = Op extends 'delete' ? undefined : Op extends 'update' ? UpdateObject<Proto['dbType']> : Proto;
+export type MultiWriteItem<Op extends MultiWriteOperation, DBType extends TS_Object> = Op extends 'delete' ? undefined : Op extends 'update' ? UpdateObject<DBType> : DBType;
 type MultiWriteType = 'bulk' | 'batch';
 /**
  * # <ins>FirestoreBulkException</ins>
@@ -32,14 +33,14 @@ export declare class FirestoreBulkException extends CustomException {
 /**
  * FirestoreCollection is a class for handling Firestore collections.
  */
-export declare class FirestoreCollectionV3<Proto extends DBProto<any>> extends Logger {
+export declare class FirestoreCollectionV3<Proto extends DB_Prototype> extends Logger {
     readonly wrapper: FirestoreWrapperBEV3;
     readonly collection: FirestoreType_Collection;
-    readonly dbDef: DBDef_V3<Proto>;
+    readonly dbDef: Database<Proto>;
     readonly uniqueKeys: Proto['uniqueKeys'][] | string[];
     private readonly validator;
     readonly hooks?: FirestoreCollectionHooks<Proto['dbType']>;
-    constructor(wrapper: FirestoreWrapperBEV3, _dbDef: DBDef_V3<Proto>, hooks?: FirestoreCollectionHooks<Proto['dbType']>);
+    constructor(wrapper: FirestoreWrapperBEV3, _dbDef: Database<Proto>, hooks?: FirestoreCollectionHooks<Proto['dbType']>);
     doc: Readonly<{
         _: (ref: FirestoreType_DocumentReference<Proto["dbType"]>, data?: Proto["dbType"]) => DocWrapperV3<Proto>;
         unique: (id: Proto["uniqueParam"]) => DocWrapperV3<Proto>;
@@ -150,5 +151,5 @@ export declare class FirestoreCollectionV3<Proto extends DBProto<any>> extends L
  * If the collection has unique keys, assert they exist, and use them to generate the _id.
  * In the case an _id already exists, verify it is not different from the uniqueKeys-generated _id.
  */
-export declare const assertUniqueId: <Proto extends DBProto<any>>(item: Proto["dbType"], keys: Proto["uniqueKeys"]) => string;
+export declare const assertUniqueId: <Proto extends DB_Prototype>(item: Proto["dbType"], keys: Proto["uniqueKeys"]) => Proto["dbType"]["_id"];
 export {};

package/firestore-v3/FirestoreCollectionV3.js

@@ -15,7 +15,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { __stringify, _keys, ApiException, BadImplementationException, batchActionParallel, compare, Const_UniqueKeys, CustomException, DB_Object_validator, dbIdLength, dbObjectToId, deepClone, DefaultDBVersion, Exception, exists, filterDuplicates, filterInstances, generateHex, keepPartialObject, Logger, MUSTNeverHappenException, StaticLogger, tsValidateResult, tsValidateUniqueId, ValidationException } from '@nu-art/ts-common';
+import { dbObjectToId } from '@nu-art/db-api-shared';
+import { __stringify, _keys, ApiException, BadImplementationException, batchActionParallel, compare, Const_UniqueKeys, CustomException, DB_Object_validator, dbIdLength, deepClone, DefaultDBVersion, Exception, exists, filterDuplicates, filterInstances, generateHex, keepPartialObject, Logger, MUSTNeverHappenException, StaticLogger, tsValidateResult, tsValidateUniqueId, ValidationException } from '@nu-art/ts-common';
 import { FirestoreInterfaceV3 } from './FirestoreInterfaceV3.js';
 import { DocWrapperV3 } from './DocWrapperV3.js';
 import { composeDbObjectUniqueId } from '@nu-art/firebase-shared';
@@ -73,7 +74,6 @@ export class FirestoreCollectionV3 extends Logger {
         this.validator = getDbDefValidator(_dbDef);
         this.hooks = hooks;
     }
-    // ############################## DocWrapper ##############################
     doc = Object.freeze({
         _: (ref, data) => {
             if (tsValidateResult(ref.id, tsValidateUniqueId))
@@ -84,9 +84,12 @@ export class FirestoreCollectionV3 extends Logger {
         unique: (id) => {
             if (!id)
                 throw new MUSTNeverHappenException('Did not receive an _id at doc.unique!');
+            let idStr;
             if (typeof id !== 'string')
-                id = assertUniqueId(id, this.uniqueKeys);
-            const doc = this.wrapper.firestore.doc(`${this.collection.path}/${id}`);
+                idStr = assertUniqueId(id, this.uniqueKeys);
+            else
+                idStr = id;
+            const doc = this.wrapper.firestore.doc(`${this.collection.path}/${idStr}`);
             return this.doc._(doc);
         },
         item: (item) => {
@@ -105,7 +108,6 @@ export class FirestoreCollectionV3 extends Logger {
             return (await this._customQuery(query, false, transaction)).map(_snapshot => this.doc._(_snapshot.ref, _snapshot.data()));
         },
     });
-    // ############################## Query ##############################
     getAll = async (docs, transaction) => {
         if (docs.length === 0)
             return [];
@@ -155,7 +157,6 @@ export class FirestoreCollectionV3 extends Logger {
             return toCreate(transaction);
         }
     };
-    // ############################## Create ##############################
     _createAll = async (preDBItems, transaction, multiWriteType = defaultMultiWriteType) => {
         if (preDBItems.length === 1)
             return [await this.create.item(preDBItems[0], transaction)];
@@ -174,7 +175,6 @@ export class FirestoreCollectionV3 extends Logger {
             .create(preDBItem, transaction),
         all: this._createAll,
     });
-    // ############################## Set ##############################
     _setAll = async (items, transaction, multiWriteType = defaultMultiWriteType, performUpgrade = true) => {
         //Get all items
         const docs = this.doc.allItems(items);
@@ -220,7 +220,6 @@ export class FirestoreCollectionV3 extends Logger {
     upgradeInstances = (items) => {
         return this._setAll(items, undefined, defaultMultiWriteType, false);
     };
-    // ############################## Update ##############################
     _updateAll = async (updateData, multiWriteType = defaultMultiWriteType) => {
         const docs = this.doc.all(updateData.map(_data => _data._id));
         const toUpdate = await Promise.all(docs.map(async (_doc, i) => await _doc.prepareForUpdate(updateData[i])));
@@ -235,7 +234,6 @@ export class FirestoreCollectionV3 extends Logger {
     // 	item: (updateData: UpdateObject<Proto['dbType']>) => this.doc.unique(updateData._id).update(updateData),
     // 	all: this._updateAll,
     // });
-    // ############################## Delete ##############################
     _deleteQuery = async (query, transaction, multiWriteType = defaultMultiWriteType) => {
         if (!exists(query) || compare(query, _EmptyQuery))
             throw new MUSTNeverHappenException('An empty query was passed to delete.query!');
@@ -334,7 +332,6 @@ export class FirestoreCollectionV3 extends Logger {
         },
         yes: { iam: { sure: { iwant: { todelete: { the: { collection: { delete: this.deleteCollection } } } } } } }
     });
-    // ############################## Multi Write ##############################
     /**
      * @param writer Type of BulkWriter - can be Bulk writer or Batch writer
      * @param doc
@@ -392,7 +389,6 @@ export class FirestoreCollectionV3 extends Logger {
             await batch.commit();
         }
     };
-    // ############################## General ##############################
     /**
      * A firestore transaction is run globally on the firestore project and not specifically on any collection, locking specific documents in the project.
      * @param processor
@@ -460,7 +456,7 @@ export class FirestoreCollectionV3 extends Logger {
 export const assertUniqueId = (item, keys) => {
     // If there are no specific uniqueKeys, generate a random _id.
     if (compare(keys, Const_UniqueKeys))
-        return item._id ?? generateHex(dbIdLength);
+        return (item._id ?? generateHex(dbIdLength));
     const _id = composeDbObjectUniqueId(item, keys);
     // If the item has an _id, and it matches the uniqueKeys-generated _id, all is well.
     // If the uniqueKeys-generated _id doesn't match the existing _id, this means someone had changed the uniqueKeys or _id which must never happen.

package/firestore-v3/FirestoreInterfaceV3.d.ts

@@ -1,10 +1,10 @@
 import { FirestoreQuery } from '@nu-art/firebase-shared';
 import { FirestoreType_DocumentSnapshot } from '../firestore/types.js';
 import { FirestoreCollectionV3 } from './FirestoreCollectionV3.js';
-import { DBProto } from '@nu-art/ts-common';
+import { DB_Prototype } from '@nu-art/db-api-shared';
 import { Query } from 'firebase-admin/firestore';
 export declare class FirestoreInterfaceV3 {
-    static buildQuery<Proto extends DBProto<any>>(collection: FirestoreCollectionV3<Proto>, query?: FirestoreQuery<Proto['dbType']>): Query<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>;
+    static buildQuery<Proto extends DB_Prototype>(collection: FirestoreCollectionV3<Proto>, query?: FirestoreQuery<Proto['dbType']>): Query<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>;
     private static isQueryObject;
     static assertUniqueDocument(results: FirestoreType_DocumentSnapshot[], query: FirestoreQuery<any>, collectionName: string): (FirestoreType_DocumentSnapshot | undefined);
 }

package/firestore-v3/FirestoreWrapperBEV3.d.ts

@@ -2,15 +2,15 @@ import { FirestoreCollectionHooks, FirestoreCollectionV3 } from './FirestoreColl
 import { FirestoreType, FirestoreType_Collection } from '../firestore/types.js';
 import { FirebaseSession } from '../auth/firebase-session.js';
 import { FirebaseBaseWrapper } from '../auth/FirebaseBaseWrapper.js';
-import { DBDef_V3, DBProto } from '@nu-art/ts-common';
+import { Database, DB_Prototype } from '@nu-art/db-api-shared';
 import { Transaction } from 'firebase-admin/firestore';
 export declare class FirestoreWrapperBEV3 extends FirebaseBaseWrapper {
     readonly firestore: FirestoreType;
     private readonly collections;
     constructor(firebaseSession: FirebaseSession<any>, dbName?: string);
     runTransaction: <ReturnType>(processor: (transaction: Transaction) => Promise<ReturnType>, transaction?: Transaction) => Promise<ReturnType>;
-    getCollection<Proto extends DBProto<any>>(dbDef: DBDef_V3<Proto>, hooks?: FirestoreCollectionHooks<Proto['dbType']>): FirestoreCollectionV3<Proto>;
-    listen<Proto extends DBProto<any>>(collection: FirestoreCollectionV3<Proto>, doc: string): void;
+    getCollection<Proto extends DB_Prototype>(dbDef: Database<Proto>, hooks?: FirestoreCollectionHooks<Proto['dbType']>): FirestoreCollectionV3<Proto>;
+    listen<Proto extends DB_Prototype>(collection: FirestoreCollectionV3<Proto>, doc: string): void;
     listCollections(): Promise<FirestoreType_Collection[]>;
     isEmulator(): boolean;
 }

package/firestore-v3/types.d.ts

@@ -1,6 +1,6 @@
-import { DBProto } from '@nu-art/ts-common';
+import { DB_Prototype } from '@nu-art/db-api-shared';
 import { DB_EntityDependencyV2 } from '@nu-art/firebase-shared';
 import { Transaction } from 'firebase-admin/firestore';
 export type CanDeleteDBEntitiesProto = {
-    __canDeleteEntitiesProto: <T extends DBProto<any>>(type: T['dbKey'], itemIds: string[], transaction?: Transaction) => Promise<DB_EntityDependencyV2>;
+    __canDeleteEntitiesProto: <T extends DB_Prototype>(type: T['dbKey'], itemIds: string[], transaction?: Transaction) => Promise<DB_EntityDependencyV2>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nu-art/firebase-backend",
-  "version": "0.401.8",
+  "version": "0.500.0",
   "description": "Storm - Express & Typescript based backend framework Backend",
   "keywords": [
     "TacB0sS",
@@ -30,17 +30,19 @@
   "scripts": {
     "build": "tsc",
     "run-tests": "firebase emulators:exec \"npm run test\"",
-    "test": "ts-mocha -w -p src/test/tsconfig.json --timeout 0 --inspect=8107 --watch-files '**/*.ts' src/test/firestore-v2/__test.ts",
+    "test": "ts-mocha -p src/test/tsconfig.json --timeout 0 'src/test/**/*.test.firebase.ts'",
+    "test:watch": "ts-mocha -w -p src/test/tsconfig.json --timeout 0 --inspect=8107 --watch-files '**/*.ts' 'src/test/**/*.test.firebase.ts'",
     "rtv2": "firebase emulators:exec \"npm run test-v2\"",
-    "test-v2": "ts-mocha -w -p src/test/tsconfig.json --timeout 0 --inspect=8107 --watch-files '**/*.ts' src/test/firestore-v2/__test.ts"
+    "test-v2": "ts-mocha -p src/test/tsconfig.json --timeout 0 'src/test/**/*.test.firebase.ts'"
   },
   "dependencies": {
-    "@nu-art/firebase-shared": "0.401.8",
+    "@nu-art/db-api-shared": "0.500.0",
+    "@nu-art/firebase-shared": "0.500.0",
     "@google-cloud/common": "^5.0.2",
     "@google-cloud/firestore": "^7.11.0",
     "@google-cloud/storage": "^7.15.0",
-    "@nu-art/google-services-backend": "0.401.8",
-    "@nu-art/ts-common": "0.401.8",
+    "@nu-art/google-services-backend": "0.500.0",
+    "@nu-art/ts-common": "0.500.0",
     "express": "^4.18.2",
     "firebase": "^11.9.0",
     "firebase-admin": "13.4.0",
@@ -51,7 +53,7 @@
     "ws": "^8.13.0"
   },
   "devDependencies": {
-    "@nu-art/testalot": "0.401.8",
+    "@nu-art/testalot": "0.500.0",
     "@types/compression": "^1.0.1",
     "@types/chai": "^4.3.4",
     "@types/mocha": "^10.0.1",