@nu-art/firebase-backend 0.401.9 → 0.500.6

package/firestore-v3/FirestoreWrapperBEV3.js

@@ -1,154 +0,0 @@
-/*
- * Firebase is a simpler Typescript wrapper to all of firebase services.
- *
- * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { FirestoreCollectionV3, } from './FirestoreCollectionV3.js';
-import { FirebaseBaseWrapper } from '../auth/FirebaseBaseWrapper.js';
-import { Promise_all_sequentially } from '@nu-art/ts-common';
-import { DocumentReference, DocumentSnapshot, getFirestore, QuerySnapshot, } from 'firebase-admin/firestore';
-export class FirestoreWrapperBEV3 extends FirebaseBaseWrapper {
-    firestore;
-    collections = {};
-    constructor(firebaseSession, dbName) {
-        super(firebaseSession);
-        if (dbName)
-            this.firestore = getFirestore(firebaseSession.app, dbName);
-        else
-            this.firestore = getFirestore(firebaseSession.app);
-    }
-    runTransaction = async (processor, transaction) => {
-        if (transaction) // if a transaction was provided to be used, use it
-            return processor(transaction);
-        const postTransactionActions = [];
-        const toRet = await this.firestore.runTransaction(async (transaction) => {
-            const writeActions = [];
-            const transactionUpdates = {};
-            // @ts-ignore
-            transaction.postTransaction = (action) => {
-                return postTransactionActions.push(action);
-            };
-            // @ts-ignore
-            transaction.__nu_art__WriteActions = writeActions;
-            const originSet = transaction.set.bind(transaction);
-            const originDelete = transaction.delete.bind(transaction);
-            const originCreate = transaction.create.bind(transaction);
-            const originGet = transaction.get.bind(transaction);
-            const originGetAll = transaction.getAll.bind(transaction);
-            const getMockDocumentSnapshot = (data, _id, exists = true) => {
-                return {
-                    id: _id,
-                    ref: {}, // Mock DocumentReference
-                    exists,
-                    data: () => (exists ? data : undefined),
-                    get: (fieldPath) => data[fieldPath],
-                    metadata: {}, // Mock metadata
-                };
-            };
-            const updateTransactionUpdates = async (data, exists = true) => {
-                let _data;
-                let _id;
-                if (data instanceof DocumentReference) {
-                    _id = data.id;
-                    _data = (await data.get()).data();
-                }
-                else {
-                    _id = data._id;
-                    _data = data;
-                }
-                transactionUpdates[_id] = getMockDocumentSnapshot(_data, _id, exists);
-            };
-            transaction.set = (documentRef, data) => {
-                updateTransactionUpdates(data);
-                writeActions.push(() => originSet(documentRef, data));
-                return transaction;
-            };
-            transaction.create = (documentRef, data) => {
-                updateTransactionUpdates(data);
-                writeActions.push(() => originCreate(documentRef, data));
-                return transaction;
-            };
-            transaction.delete = (documentRef, precondition) => {
-                // update deletions
-                updateTransactionUpdates(documentRef, false);
-                writeActions.push(() => originDelete(documentRef, precondition));
-                return transaction;
-            };
-            // @ts-ignore
-            transaction.get = async (args) => {
-                // @ts-ignore
-                const doc = await originGet(args);
-                // handle doc snapshot
-                if (doc instanceof DocumentSnapshot) {
-                    const document = doc.data();
-                    if (!document)
-                        return doc;
-                    return transactionUpdates[document._id] ?? doc;
-                }
-                // handle query snapshot
-                if (doc instanceof QuerySnapshot) {
-                    const docs = doc.docs;
-                    // @ts-ignore
-                    return {
-                        docs: docs.map(doc => {
-                            const _doc = doc.data();
-                            if (!_doc)
-                                return doc;
-                            return transactionUpdates[_doc._id] ?? doc;
-                        })
-                    };
-                }
-                return doc;
-            };
-            // @ts-ignore
-            transaction.getAll = async (...documentRefsOrReadOptions) => {
-                const docs = await originGetAll(...documentRefsOrReadOptions);
-                return docs.map(doc => {
-                    const _doc = doc.data();
-                    if (!_doc)
-                        return doc;
-                    return transactionUpdates[_doc._id] ?? doc;
-                });
-            };
-            const toRet = await processor(transaction);
-            writeActions.forEach(action => action());
-            return toRet;
-        });
-        await Promise_all_sequentially(postTransactionActions);
-        return toRet;
-    };
-    getCollection(dbDef, hooks) {
-        const collection = this.collections[dbDef.dbKey];
-        if (collection)
-            return collection;
-        return this.collections[dbDef.dbKey] = new FirestoreCollectionV3(this, dbDef, hooks);
-    }
-    listen(collection, doc) {
-        collection.wrapper.firestore.doc(`${collection.collection.path}/${doc}`).onSnapshot(() => {
-            this.logInfo('received snapshot!');
-        });
-    }
-    // public async deleteCollection(name: string) {
-    // 	return this.getCollection(name).deleteAll();
-    // }
-    async listCollections() {
-        if (!this.firestore.listCollections)
-            return [];
-        return this.firestore.listCollections();
-    }
-    isEmulator() {
-        return !!process.env.FIRESTORE_EMULATOR_HOST || false;
-    }
-}

package/firestore-v3/consts.d.ts

@@ -1,13 +0,0 @@
-import { Dispatcher, UniqueId } from '@nu-art/ts-common';
-import { CanDeleteDBEntitiesProto } from './types.js';
-import { MemKey } from '@nu-art/ts-common/mem-storage/MemStorage';
-import { PotentialDependenciesToDelete } from '@nu-art/firebase-shared';
-export declare const canDeleteDispatcherV3: Dispatcher<CanDeleteDBEntitiesProto, "__canDeleteEntitiesProto", [type: any, itemIds: string[], transaction?: FirebaseFirestore.Transaction | undefined], import("@nu-art/firebase-shared").DB_EntityDependencyV2>;
-export type MemKey_DeletedDocs_Type = {
-    transaction: FirebaseFirestore.Transaction;
-    deleted: {
-        [dbKey: string]: Set<UniqueId>;
-    };
-};
-export declare const MemKey_DeletedDocs: MemKey<MemKey_DeletedDocs_Type[]>;
-export declare function addDeletedToTransaction(transaction: FirebaseFirestore.Transaction | undefined, deleted: PotentialDependenciesToDelete): void;

package/firestore-v3/consts.js

@@ -1,18 +0,0 @@
-import { Dispatcher } from '@nu-art/ts-common';
-import { MemKey } from '@nu-art/ts-common/mem-storage/MemStorage';
-export const canDeleteDispatcherV3 = new Dispatcher('__canDeleteEntitiesProto');
-export const MemKey_DeletedDocs = new MemKey('deleted--docs');
-export function addDeletedToTransaction(transaction, deleted) {
-    if (!transaction)
-        return;
-    const storage = MemKey_DeletedDocs.get([]);
-    let item = storage.find(i => i.transaction === transaction);
-    if (!item) {
-        item = { transaction, deleted: {} };
-        storage.push(item);
-    }
-    if (!item.deleted[deleted.dbKey])
-        item.deleted[deleted.dbKey] = new Set();
-    deleted.ids.forEach(id => item.deleted[deleted.dbKey].add(id));
-    MemKey_DeletedDocs.set(storage);
-}

package/firestore-v3/types.d.ts

@@ -1,6 +0,0 @@
-import { DBProto } from '@nu-art/ts-common';
-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>;
-};

package/firestore-v3/types.js

@@ -1 +0,0 @@
-export {};

package/functions/firebase-function.d.ts

@@ -1,38 +0,0 @@
-import { Express } from 'express';
-import { StringMap } from '@nu-art/ts-common';
-import { HttpsFunction, HttpsOptions } from 'firebase-functions/v2/https';
-export interface TBR_ExpressFunctionInterface {
-    getExpressFunction(): Firebase_ExpressFunction;
-}
-export interface FirebaseFunctionInterface {
-    getFunction(): HttpsFunction;
-    onFunctionReady(): Promise<void>;
-}
-export declare class Firebase_ExpressFunction implements FirebaseFunctionInterface {
-    private readonly express;
-    private function;
-    private toBeExecuted;
-    private isReady;
-    private toBeResolved;
-    private name;
-    static config: HttpsOptions;
-    constructor(_express: Express);
-    setName(name: string): this;
-    static setConfig(config: HttpsOptions): void;
-    getName(): string;
-    getFunction: () => HttpsFunction;
-    onFunctionReady: () => Promise<void>;
-}
-export type FirestoreConfigs = {
-    runTimeOptions?: HttpsOptions;
-    configs: any;
-};
-export type BucketConfigs = {
-    runtimeOpts?: HttpsOptions;
-    path: string;
-    bucketName?: string;
-};
-export type TopicMessage = {
-    data: string;
-    attributes: StringMap;
-};

package/functions/firebase-function.js

@@ -1,53 +0,0 @@
-import { addItemToArray } from '@nu-art/ts-common';
-import { onRequest } from 'firebase-functions/v2/https';
-export class Firebase_ExpressFunction {
-    express;
-    function;
-    toBeExecuted = [];
-    isReady = false;
-    toBeResolved;
-    name = 'api';
-    static config = {};
-    constructor(_express) {
-        this.express = _express;
-    }
-    setName(name) {
-        this.name = name;
-        return this;
-    }
-    static setConfig(config) {
-        this.config = config;
-    }
-    getName() {
-        return this.name;
-    }
-    getFunction = () => {
-        if (this.function)
-            return this.function;
-        const realFunction = onRequest(Firebase_ExpressFunction.config, this.express);
-        return this.function = onRequest(Firebase_ExpressFunction.config, (req, res) => {
-            if (this.isReady) {
-                return realFunction(req, res);
-            }
-            return new Promise((resolve) => {
-                // @ts-ignore
-                addItemToArray(this.toBeExecuted, () => realFunction(req, res));
-                this.toBeResolved = resolve;
-            });
-        });
-    };
-    onFunctionReady = async () => {
-        this.isReady = true;
-        const toBeExecuted = this.toBeExecuted;
-        this.toBeExecuted = [];
-        for (const toExecute of toBeExecuted) {
-            try {
-                await toExecute();
-            }
-            catch (e) {
-                console.error('Error running function: ', e);
-            }
-        }
-        this.toBeResolved && this.toBeResolved();
-    };
-}

package/v1.d.ts

@@ -1,21 +0,0 @@
-export * from './auth/firebase-session.js';
-export * from './auth/FirebaseSession_Admin.js';
-export * from './functions/firebase-function.js';
-export * from './ModuleBE_Firebase.js';
-export * from './firestore/FirestoreInterface.js';
-export * from './firestore/FirestoreCollection.js';
-export * from './firestore/FirestoreTransaction.js';
-export * from './firestore/FirestoreWrapperBE.js';
-export * from './firestore/types.js';
-export * from './database/DatabaseWrapperBE.js';
-export * from './storage/types.js';
-export * from './storage/StorageWrapperBE.js';
-export * from './push/PushMessagesWrapperBE.js';
-export * from './push/types.js';
-export * from './functions-v2/ModuleBE_BaseFunction.js';
-export * from './functions-v2/ModuleBE_ExpressFunction_V2.js';
-export * from './functions-v2/ModuleBE_FirebaseDBListener.js';
-export * from './functions-v2/ModuleBE_FirebaseScheduler.js';
-export * from './functions-v2/ModuleBE_FirestoreListener.js';
-export * from './functions-v2/ModuleBE_PubSubFunction.js';
-export * from './functions-v2/ModuleBE_StorageListener.js';

package/v1.js

@@ -1,38 +0,0 @@
-/*
- * Firebase is a simpler Typescript wrapper to all of firebase services.
- *
- * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-export * from './auth/firebase-session.js';
-export * from './auth/FirebaseSession_Admin.js';
-export * from './functions/firebase-function.js';
-export * from './ModuleBE_Firebase.js';
-export * from './firestore/FirestoreInterface.js';
-export * from './firestore/FirestoreCollection.js';
-export * from './firestore/FirestoreTransaction.js';
-export * from './firestore/FirestoreWrapperBE.js';
-export * from './firestore/types.js';
-export * from './database/DatabaseWrapperBE.js';
-export * from './storage/types.js';
-export * from './storage/StorageWrapperBE.js';
-export * from './push/PushMessagesWrapperBE.js';
-export * from './push/types.js';
-export * from './functions-v2/ModuleBE_BaseFunction.js';
-export * from './functions-v2/ModuleBE_ExpressFunction_V2.js';
-export * from './functions-v2/ModuleBE_FirebaseDBListener.js';
-export * from './functions-v2/ModuleBE_FirebaseScheduler.js';
-export * from './functions-v2/ModuleBE_FirestoreListener.js';
-export * from './functions-v2/ModuleBE_PubSubFunction.js';
-export * from './functions-v2/ModuleBE_StorageListener.js';