@nu-art/firebase-shared 0.400.5

package/consts.d.ts

@@ -0,0 +1,4 @@
+export declare const _EmptyQuery: Readonly<{
+    where: {};
+}>;
+export declare const maxBatch = 500;

package/consts.js

@@ -0,0 +1,2 @@
+export const _EmptyQuery = Object.freeze({ where: {} });
+export const maxBatch = 500;

package/index.d.ts

@@ -0,0 +1,3 @@
+export * from './consts.js';
+export * from './types.js';
+export * from './utils.js';

package/index.js

@@ -0,0 +1,3 @@
+export * from './consts.js';
+export * from './types.js';
+export * from './utils.js';

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@nu-art/firebase-shared",
+  "version": "0.400.5",
+  "description": "Storm - Express & Typescript based backend framework Shared",
+  "keywords": [
+    "TacB0sS",
+    "infra",
+    "nu-art",
+    "storm",
+    "thunderstorm",
+    "typescript"
+  ],
+  "homepage": "https://github.com/nu-art-js/firebase",
+  "bugs": {
+    "url": "https://github.com/nu-art-js/firebase/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com:nu-art-js/firebase.git"
+  },
+  "publishConfig": {
+    "directory": "dist",
+    "linkDirectory": true
+  },
+  "license": "Apache-2.0",
+  "author": "TacB0sS",
+  "files": [
+    "**/*"
+  ],
+  "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",
+    "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"
+  },
+  "dependencies": {
+    "@nu-art/ts-common": "0.400.5",
+    "@google-cloud/common": "^5.0.2",
+    "@google-cloud/storage": "^7.15.0",
+    "@google-cloud/firestore": "^7.11.0",
+    "google-auth-library": "^10.0.0",
+    "express": "^4.18.2",
+    "firebase": "^11.9.0",
+    "firebase-admin": "13.4.0",
+    "firebase-functions": "6.3.2",
+    "ws": "^8.13.0",
+    "http-proxy": "1.18.1",
+    "url": "0.11.3"
+  },
+  "devDependencies": {
+    "@types/compression": "^1.0.1",
+    "@types/chai": "^4.3.4",
+    "@types/mocha": "^10.0.1",
+    "@types/http-proxy": "1.17.14",
+    "teeny-request": "~7.2.0",
+    "@types/ws": "^8.5.5"
+  },
+  "unitConfig": {
+    "type": "typescript-lib"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js"
+    },
+    "./*": {
+      "types": "./*.d.ts",
+      "import": "./*.js"
+    }
+  }
+}

package/types.d.ts

@@ -0,0 +1,105 @@
+import { MandatoryKeys, RequireOptionals, TS_Object, UniqueId } from '@nu-art/ts-common';
+import { ResponseError } from '@nu-art/ts-common/core/exceptions/types';
+/**
+ * Test test
+ * token: pah
+ */
+export type Firebase_Message = {
+    token?: string;
+    topic?: string;
+    condition?: string;
+};
+export interface Firebase_Messaging {
+    send(message: Firebase_Message, dryRun?: boolean): Promise<string>;
+}
+export type FirebaseConfig = {
+    id: string;
+    projectId: string;
+    apiKey: string;
+    authDomain: string;
+    databaseURL?: string;
+    storageBucket?: string;
+    messagingSenderId: string;
+    local?: boolean;
+};
+type Comparator = 'in' | 'array-contains' | 'array-contains-any' | '>' | '>=' | '<' | '<=' | '==';
+export type QueryComparator<T> = {
+    $ac: T extends (infer I)[] ? I : never;
+} | {
+    $aca: T extends (infer I)[] ? I[] : never;
+} | {
+    $nin: T extends (any)[] ? never : T[];
+} | {
+    $in: T extends (any)[] ? never : T[];
+} | {
+    $gt: number;
+} | {
+    $gte: number;
+} | {
+    $lt: number;
+} | {
+    $lte: number;
+} | {
+    $eq: number;
+} | {
+    $neq: T;
+};
+export declare const ComparatorMap: {
+    [k in keyof QueryComparator<any>]: Comparator;
+};
+export type FilterKeys<T extends TS_Object> = MandatoryKeys<T, string | number>[];
+export type FirestoreType_OrderByDirection = 'desc' | 'asc';
+export type WhereValue<Value> = QueryComparator<Value> | (Value extends TS_Object ? Clause_Where<Value> : Value | [Value]);
+export type Clause_Where<T extends TS_Object> = {
+    [P in keyof T]?: WhereValue<T[P]>;
+};
+export type Clause_OrderBy<T extends TS_Object> = [{
+    key: keyof T;
+    order: FirestoreType_OrderByDirection;
+}];
+export type Clause_Select<T extends TS_Object, K extends keyof T = keyof T> = K[];
+export type FirestoreQuery<T extends TS_Object> = RequireOptionals<FirestoreQueryImpl<T>>;
+export type FirestoreQueryImpl<T extends TS_Object> = {
+    select?: Clause_Select<T>;
+    orderBy?: Clause_OrderBy<T>;
+    where?: Clause_Where<T>;
+    withDeleted?: boolean;
+    limit?: number | {
+        page?: number;
+        itemsCount: number;
+    };
+};
+export type FirebaseProjectCollections = {
+    projectId: string;
+    collections: string[];
+};
+/**
+ * Only for MemKey_DeletedDocs
+ */
+export type PotentialDependenciesToDelete<Type extends string = string> = {
+    dbKey: Type;
+    ids: string[];
+};
+export type DB_EntityDependency<Type extends string = string> = {
+    collectionKey: Type;
+    conflictingIds: string[];
+};
+export type EntityRef = {
+    dbKey: string;
+    id: UniqueId;
+};
+export type EntityRefs = {
+    dbKey: string;
+    ids: UniqueId[];
+};
+export type Conflict = {
+    target: EntityRef;
+    conflicts: EntityRefs;
+};
+export type DB_EntityDependencyV2 = {
+    originalItemsToDelete: EntityRef[];
+    issues: Conflict[];
+};
+export type EntityDependencyError = ResponseError<'has-dependencies', DB_EntityDependencyV2[]>;
+export type MultiWriteOperation = 'create' | 'set' | 'update' | 'delete';
+export {};

package/types.js

@@ -0,0 +1,29 @@
+/*
+ * 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 const ComparatorMap = {
+    $nin: 'not-in',
+    $in: 'in',
+    $ac: 'array-contains',
+    $aca: 'array-contains-any',
+    $gt: '>',
+    $gte: '>=',
+    $lt: '<',
+    $lte: '<=',
+    $eq: '==',
+    $neq: '!=',
+};

package/utils.d.ts

@@ -0,0 +1,2 @@
+import { DB_Object, PreDB } from "@nu-art/ts-common";
+export declare const composeDbObjectUniqueId: <T extends PreDB<DB_Object>, K extends (keyof T)[]>(item: T, keys: K) => string;

package/utils.js

@@ -0,0 +1,9 @@
+import { __stringify, exists, md5, MUSTNeverHappenException } from "@nu-art/ts-common";
+export const composeDbObjectUniqueId = (item, keys) => {
+    const _unique = keys.reduce((aggregatedValues, _key) => {
+        if (!exists(item[_key]))
+            throw new MUSTNeverHappenException(`Unique key missing from db item!\nkey: ${_key}\nitem:${__stringify(item, true)}`);
+        return aggregatedValues + String(item[_key]);
+    }, '');
+    return md5(_unique);
+};