@dereekb/firebase-server 3.0.0

package/src/lib/nest/app.d.ts

@@ -0,0 +1,36 @@
+import { ClassType, Getter } from '@dereekb/util';
+import { INestApplicationContext, Provider } from '@nestjs/common';
+import * as express from 'express';
+import * as admin from 'firebase-admin';
+export interface NestServer {
+    server: express.Express;
+    nest: NestAppPromiseGetter;
+}
+export declare type NestAppPromiseGetter = Getter<Promise<INestApplicationContext>>;
+export interface NestServerInstance<T> {
+    /**
+     * Initializes and returns the Nest Server.
+     *
+     * If already initialized the server will not be initialized again.
+     */
+    initNestServer(firebaseApp: admin.app.App): NestServer;
+    /**
+     * Terminates the nest server for the input app.
+     *
+     * @param firebaseApp
+     */
+    removeNestServer(firebaseApp: admin.app.App): Promise<boolean>;
+}
+export declare class FirebaseNestServerRootModule {
+}
+export interface NestServerInstanceConfig<T> {
+    /**
+     * Module to instantiate.
+     */
+    readonly moduleClass: ClassType<T>;
+    /**
+     * Additional providers to provide globally.
+     */
+    providers?: Provider<any>[];
+}
+export declare function nestServerInstance<T>(config: NestServerInstanceConfig<T>): NestServerInstance<T>;

package/src/lib/nest/app.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nestServerInstance = exports.FirebaseNestServerRootModule = void 0;
+const tslib_1 = require("tslib");
+const util_1 = require("@dereekb/util");
+const core_1 = require("@nestjs/core");
+const platform_express_1 = require("@nestjs/platform-express");
+const express = require("express");
+const firebase_nest_1 = require("../firebase/firebase.nest");
+class FirebaseNestServerRootModule {
+}
+exports.FirebaseNestServerRootModule = FirebaseNestServerRootModule;
+function nestServerInstance(config) {
+    const { moduleClass, providers: additionalProviders } = config;
+    const serversCache = new Map();
+    const initNestServer = (firebaseApp) => {
+        const appName = firebaseApp.name;
+        let nestServer = serversCache.get(appName);
+        if (!nestServer) {
+            const server = express();
+            const createNestServer = (expressInstance) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                const providers = [(0, firebase_nest_1.firebaseServerAppTokenProvider)((0, util_1.asGetter)(firebaseApp))];
+                if (additionalProviders) {
+                    (0, util_1.mergeArrayOrValueIntoArray)(providers, additionalProviders);
+                }
+                const providersModule = {
+                    module: FirebaseNestServerRootModule,
+                    imports: [moduleClass],
+                    providers,
+                    exports: providers,
+                    global: true
+                };
+                const nestApp = yield core_1.NestFactory.create(providersModule, new platform_express_1.ExpressAdapter(expressInstance));
+                return nestApp.init();
+            });
+            const nest = createNestServer(server)
+                .then(v => {
+                console.log('Nest Ready');
+                return v;
+            })
+                .catch(err => {
+                console.error('Nest broken', err);
+                throw err;
+            });
+            nestServer = { server, nest: (0, util_1.makeGetter)(nest) };
+            serversCache.set(appName, nestServer);
+        }
+        return nestServer;
+    };
+    const removeNestServer = (firebaseApp) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const appName = firebaseApp.name;
+        let nestServer = serversCache.get(appName);
+        let removed;
+        if (nestServer) {
+            removed = nestServer.nest().then(x => {
+                serversCache.delete(appName);
+                return x.close().then(x => true);
+            });
+        }
+        else {
+            removed = Promise.resolve(false);
+        }
+        return removed;
+    });
+    return {
+        initNestServer,
+        removeNestServer
+    };
+}
+exports.nestServerInstance = nestServerInstance;
+//# sourceMappingURL=app.js.map

package/src/lib/nest/app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../../../../../../packages/firebase-server/src/lib/nest/app.ts"],"names":[],"mappings":";;;;AAAA,wCAAoG;AAEpG,uCAA2C;AAC3C,+DAA0D;AAC1D,mCAAmC;AACnC,6DAA2E;AA2B3E,MAAa,4BAA4B;CAAI;AAA7C,oEAA6C;AAa7C,SAAgB,kBAAkB,CAAI,MAAmC;IACvE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;IAC/D,MAAM,YAAY,GAAG,IAAI,GAAG,EAAsB,CAAC;IAEnD,MAAM,cAAc,GAAG,CAAC,WAA0B,EAAc,EAAE;QAChE,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC;QACjC,IAAI,UAAU,GAAG,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAE3C,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,MAAM,GAAG,OAAO,EAAE,CAAC;YACzB,MAAM,gBAAgB,GAAG,CAAO,eAAgC,EAAE,EAAE;gBAClE,MAAM,SAAS,GAAG,CAAC,IAAA,8CAA8B,EAAC,IAAA,eAAQ,EAAC,WAAW,CAAC,CAAC,CAAC,CAAC;gBAE1E,IAAI,mBAAmB,EAAE;oBACvB,IAAA,iCAA0B,EAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;iBAC5D;gBAED,MAAM,eAAe,GAAkB;oBACrC,MAAM,EAAE,4BAA4B;oBACpC,OAAO,EAAE,CAAC,WAAW,CAAC;oBACtB,SAAS;oBACT,OAAO,EAAE,SAAS;oBAClB,MAAM,EAAE,IAAI;iBACb,CAAC;gBAEF,MAAM,OAAO,GAAG,MAAM,kBAAW,CAAC,MAAM,CACtC,eAAe,EACf,IAAI,iCAAc,CAAC,eAAe,CAAC,CACpC,CAAC;gBAEF,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC;YACxB,CAAC,CAAA,CAAC;YAEF,MAAM,IAAI,GAA8B,gBAAgB,CAAC,MAAM,CAAC;iBAC7D,IAAI,CAAC,CAAC,CAAC,EAAE;gBACR,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;gBAC1B,OAAO,CAAC,CAAC;YACX,CAAC,CAAC;iBACD,KAAK,CAAC,GAAG,CAAC,EAAE;gBACX,OAAO,CAAC,KAAK,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;gBAClC,MAAM,GAAG,CAAC;YACZ,CAAC,CAA8B,CAAC;YAElC,UAAU,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,IAAA,iBAAU,EAAC,IAAI,CAAC,EAAE,CAAC;YAChD,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;SACvC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,CAAO,WAA0B,EAAoB,EAAE;QAC9E,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC;QACjC,IAAI,UAAU,GAAG,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,OAAyB,CAAC;QAE9B,IAAI,UAAU,EAAE;YACd,OAAO,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;gBACnC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAC7B,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;YACnC,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SAClC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC,CAAA,CAAC;IAEF,OAAO;QACL,cAAc;QACd,gBAAgB;KACjB,CAAC;AACJ,CAAC;AAvED,gDAuEC"}

package/src/lib/nest/function/context.d.ts

@@ -0,0 +1,12 @@
+import { TransformAndValidateFunctionResultFactory, TransformAndValidateObjectFactory } from "@dereekb/model";
+import { FirebaseServerActionsTransformContext } from "./transform";
+/**
+ * Context used for building FirebaseServerActions. It contains references to reusable factories.
+ */
+export interface FirebaseServerActionsContext extends FirebaseServerActionsTransformContext {
+}
+export declare abstract class AbstractFirebaseServerActionsContext implements FirebaseServerActionsContext {
+    abstract readonly firebaseServerActionTransformFactory: TransformAndValidateObjectFactory;
+    abstract readonly firebaseServerActionTransformFunctionFactory: TransformAndValidateFunctionResultFactory<any>;
+}
+export declare function firebaseServerActionsContext(): FirebaseServerActionsContext;

package/src/lib/nest/function/context.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.firebaseServerActionsContext = exports.AbstractFirebaseServerActionsContext = void 0;
+const transform_1 = require("./transform");
+class AbstractFirebaseServerActionsContext {
+}
+exports.AbstractFirebaseServerActionsContext = AbstractFirebaseServerActionsContext;
+function firebaseServerActionsContext() {
+    return Object.assign({}, (0, transform_1.firebaseServerActionsTransformContext)());
+}
+exports.firebaseServerActionsContext = firebaseServerActionsContext;
+//# sourceMappingURL=context.js.map

package/src/lib/nest/function/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../../../../../packages/firebase-server/src/lib/nest/function/context.ts"],"names":[],"mappings":";;;AACA,2CAA2G;AAO3G,MAAsB,oCAAoC;CAGzD;AAHD,oFAGC;AAED,SAAgB,4BAA4B;IAC1C,yBACK,IAAA,iDAAqC,GAAE,EAC1C;AACJ,CAAC;AAJD,oEAIC"}

package/src/lib/nest/function/index.d.ts

@@ -0,0 +1,4 @@
+export * from './context';
+export * from './nest';
+export * from './nest.utility';
+export * from './transform';

package/src/lib/nest/function/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./context"), exports);
+tslib_1.__exportStar(require("./nest"), exports);
+tslib_1.__exportStar(require("./nest.utility"), exports);
+tslib_1.__exportStar(require("./transform"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/nest/function/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/firebase-server/src/lib/nest/function/index.ts"],"names":[],"mappings":";;;AAAA,oDAA0B;AAC1B,iDAAuB;AACvB,yDAA+B;AAC/B,sDAA4B"}

package/src/lib/nest/function/nest.d.ts

@@ -0,0 +1,91 @@
+import { PromiseOrValue, Getter } from '@dereekb/util';
+import { INestApplicationContext } from '@nestjs/common';
+import * as functions from 'firebase-functions';
+import { EventContext } from 'firebase-functions';
+import { RunnableHttpFunction } from '../../function/type';
+/**
+ * Getter for an INestApplicationContext promise. Nest should be initialized when the promise resolves.
+ */
+export declare type NestApplicationPromiseGetter = Getter<Promise<INestApplicationContext>>;
+/**
+ * Generates a function from the passed NestApplicationPromiseGetter/context.
+ *
+ * This pattern is available to allow generating similar content for differenting contexts, such as production and testing.
+ */
+export declare type NestApplicationFunctionFactory<F> = (nestAppPromiseGetter: NestApplicationPromiseGetter) => F;
+export declare type NestApplicationRunnableHttpFunctionFactory<I> = NestApplicationFunctionFactory<RunnableHttpFunction<I>>;
+/**
+ * Runnable function that is passed an INestApplicationContext in addition to the usual data/context provided by firebase.
+ */
+export declare type OnCallWithNestApplication<I = any, O = any> = (nest: INestApplicationContext, data: I, context: functions.https.CallableContext) => O;
+/**
+ * Factory function for generating a NestApplicationFunctionFactory for a HttpsFunctions/Runnable firebase function.
+ */
+export declare type OnCallWithNestApplicationFactory = <I, O>(fn: OnCallWithNestApplication<I, O>) => NestApplicationRunnableHttpFunctionFactory<I>;
+/**
+ * Creates a factory for generating OnCallWithNestApplication functions.
+ *
+ * @param nestAppPromiseGetter
+ * @returns
+ */
+export declare function onCallWithNestApplicationFactory(): OnCallWithNestApplicationFactory;
+/**
+ * Runnable function that is passed an arbitrary nest context object in addition to the usual data/context provided by firebase.
+ */
+export declare type OnCallWithNestContext<C, I = any, O = any> = (nestContext: C, data: I, context: functions.https.CallableContext) => O;
+/**
+ * Factory function for generating HttpsFunctions/Runnable firebase function that returns the value from the input OnCallWithNestContext function.
+ */
+export declare type OnCallWithNestContextFactory<C> = <I, O>(fn: OnCallWithNestContext<C, I, O>) => NestApplicationRunnableHttpFunctionFactory<I>;
+/**
+ * Getter for an INestApplicationContext promise. Nest should be initialized when the promise resolves.
+ */
+export declare type MakeNestContext<C> = (nest: INestApplicationContext) => C;
+/**
+ * Creates a factory for generating OnCallWithNestContext functions with a nest context object that is generated by the input function.
+ *
+ * @param appFactory
+ * @param makeNestContext
+ * @returns
+ */
+export declare function onCallWithNestContextFactory<C>(appFactory: OnCallWithNestApplicationFactory, makeNestContext: MakeNestContext<C>): OnCallWithNestContextFactory<C>;
+/**
+ * Abstract class that wraps an INestApplicationContext value.
+ */
+export declare abstract class AbstractNestContext {
+    readonly nest: INestApplicationContext;
+    constructor(nest: INestApplicationContext);
+}
+export declare type FirestoreEventHandler<I = any, O = any> = (data: I, context: EventContext) => PromiseOrValue<O>;
+export declare type NestApplicationEventHandler<I = any, O = any> = (nest: INestApplicationContext, data: I, context: EventContext) => PromiseOrValue<O>;
+export declare type NestApplicationEventHandlerBuilder<I = any, O = any> = (handler: NestApplicationEventHandler<I, O>) => FirestoreEventHandler<I, O>;
+export declare type OnEventWithNestApplicationBuilder<I = any, O = any> = (nest: NestApplicationEventHandlerBuilder<I, O>) => functions.CloudFunction<O>;
+/**
+ * Factory function for generating a CloudFunctionHandler via a NestApplicationCloudFunctionHandler.
+ */
+export declare type OnEventWithNestApplicationFactory = <I, O>(fn: OnEventWithNestApplicationBuilder<I, O>) => NestApplicationFunctionFactory<functions.CloudFunction<O>>;
+/**
+ * Creates a factory for generating OnEventWithNestApplicationBuilder values.
+ *
+ * @param nestAppPromiseGetter
+ * @returns
+ */
+export declare function onEventWithNestApplicationFactory(): OnEventWithNestApplicationFactory;
+export declare type NestContextEventHandler<C, I = any, O = any> = (nest: C, data: I, context: EventContext) => Promise<O>;
+export declare type NestContextEventHandlerBuilder<C, I = any, O = any> = (handler: NestContextEventHandler<C, I, O>) => FirestoreEventHandler<I, O>;
+/**
+ * Runnable function that is passed an arbitrary nest context object in addition to the usual data/context provided by firebase.
+ */
+export declare type OnEventWithNestContextBuilder<C, I = any, O = any> = (nest: NestContextEventHandlerBuilder<C, I, O>) => functions.CloudFunction<O>;
+/**
+ * Factory function for generating a firebase CloudFunction for a specific event.
+ */
+export declare type OnEventWithNestContextFactory<C> = <I, O = any>(fn: OnEventWithNestContextBuilder<C, I, O>) => NestApplicationFunctionFactory<functions.CloudFunction<O>>;
+/**
+ * Creates a factory for generating OnCallWithNestContext functions with a nest context object that is generated by the input function.
+ *
+ * @param appFactory
+ * @param makeNestContext
+ * @returns
+ */
+export declare function onEventWithNestContextFactory<C>(makeNestContext: MakeNestContext<C>): OnEventWithNestContextFactory<C>;

package/src/lib/nest/function/nest.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onEventWithNestContextFactory = exports.onEventWithNestApplicationFactory = exports.AbstractNestContext = exports.onCallWithNestContextFactory = exports.onCallWithNestApplicationFactory = void 0;
+const functions = require("firebase-functions");
+/**
+ * Creates a factory for generating OnCallWithNestApplication functions.
+ *
+ * @param nestAppPromiseGetter
+ * @returns
+ */
+function onCallWithNestApplicationFactory() {
+    return (fn) => {
+        return (nestAppPromiseGetter) => functions.https.onCall((data, context) => nestAppPromiseGetter().then(x => fn(x, data, context)));
+    };
+}
+exports.onCallWithNestApplicationFactory = onCallWithNestApplicationFactory;
+/**
+ * Creates a factory for generating OnCallWithNestContext functions with a nest context object that is generated by the input function.
+ *
+ * @param appFactory
+ * @param makeNestContext
+ * @returns
+ */
+function onCallWithNestContextFactory(appFactory, makeNestContext) {
+    return (fn) => appFactory((nest, data, context) => fn(makeNestContext(nest), data, context));
+}
+exports.onCallWithNestContextFactory = onCallWithNestContextFactory;
+/**
+ * Abstract class that wraps an INestApplicationContext value.
+ */
+class AbstractNestContext {
+    constructor(nest) {
+        this.nest = nest;
+    }
+}
+exports.AbstractNestContext = AbstractNestContext;
+/**
+ * Creates a factory for generating OnEventWithNestApplicationBuilder values.
+ *
+ * @param nestAppPromiseGetter
+ * @returns
+ */
+function onEventWithNestApplicationFactory() {
+    return (fn) => {
+        return (nestAppPromiseGetter) => {
+            const handlerBuilder = (handler) => {
+                const fnHandler = (data, context) => nestAppPromiseGetter().then(nest => handler(nest, data, context));
+                return fnHandler;
+            };
+            return fn(handlerBuilder);
+        };
+    };
+}
+exports.onEventWithNestApplicationFactory = onEventWithNestApplicationFactory;
+/**
+ * Creates a factory for generating OnCallWithNestContext functions with a nest context object that is generated by the input function.
+ *
+ * @param appFactory
+ * @param makeNestContext
+ * @returns
+ */
+function onEventWithNestContextFactory(makeNestContext) {
+    return (fn) => {
+        return (nestAppPromiseGetter) => {
+            const handlerBuilder = (handler) => {
+                const fnHandler = (data, context) => nestAppPromiseGetter().then(nest => handler(makeNestContext(nest), data, context));
+                return fnHandler;
+            };
+            return fn(handlerBuilder);
+        };
+    };
+}
+exports.onEventWithNestContextFactory = onEventWithNestContextFactory;
+//# sourceMappingURL=nest.js.map

package/src/lib/nest/function/nest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nest.js","sourceRoot":"","sources":["../../../../../../../packages/firebase-server/src/lib/nest/function/nest.ts"],"names":[],"mappings":";;;AAEA,gDAAgD;AA6BhD;;;;;GAKG;AACH,SAAgB,gCAAgC;IAC9C,OAAO,CAAO,EAAmC,EAAE,EAAE;QACnD,OAAO,CAAC,oBAAkD,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAO,EAAE,OAAwC,EAAE,EAAE,CAAC,oBAAoB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACvM,CAAC,CAAC;AACJ,CAAC;AAJD,4EAIC;AAiBD;;;;;;GAMG;AACH,SAAgB,4BAA4B,CAAI,UAA4C,EAAE,eAAmC;IAC/H,OAAO,CAAO,EAAkC,EAAE,EAAE,CAAC,UAAU,CAAO,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;AAC3I,CAAC;AAFD,oEAEC;AAED;;GAEG;AACH,MAAsB,mBAAmB;IACvC,YAAqB,IAA6B;QAA7B,SAAI,GAAJ,IAAI,CAAyB;IAAI,CAAC;CACxD;AAFD,kDAEC;AAcD;;;;;GAKG;AACH,SAAgB,iCAAiC;IAC/C,OAAO,CAAO,EAA2C,EAAE,EAAE;QAC3D,OAAO,CAAC,oBAAkD,EAAE,EAAE;YAC5D,MAAM,cAAc,GAA6C,CAAC,OAAO,EAAE,EAAE;gBAC3E,MAAM,SAAS,GAAgC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,oBAAoB,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;gBACpI,OAAO,SAAS,CAAC;YACnB,CAAC,CAAC;YAEF,OAAO,EAAE,CAAC,cAAc,CAAC,CAAC;QAC5B,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAXD,8EAWC;AAeD;;;;;;GAMG;AACH,SAAgB,6BAA6B,CAAI,eAAmC;IAClF,OAAO,CAAa,EAA0C,EAAE,EAAE;QAChE,OAAO,CAAC,oBAAkD,EAAE,EAAE;YAC5D,MAAM,cAAc,GAA4C,CAAC,OAAO,EAAE,EAAE;gBAC1E,MAAM,SAAS,GAAgC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,oBAAoB,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;gBACrJ,OAAO,SAAS,CAAC;YACnB,CAAC,CAAC;YAEF,OAAO,EAAE,CAAC,cAAc,CAAC,CAAC;QAC5B,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAXD,sEAWC"}

package/src/lib/nest/function/nest.utility.d.ts

@@ -0,0 +1,10 @@
+import { CallableContextWithAuthData } from "../../function/context";
+import { OnCallWithNestContext } from "./nest";
+export declare type OnCallWithAuthorizedNestContext<C, I = any, O = any> = (nestContext: C, data: I, context: CallableContextWithAuthData) => O;
+/**
+ * Creates an OnCallWithNestContext wrapper that validates the input CallableContext to assert the context has auth data before entering the function.
+ *
+ * @param fn
+ * @returns
+ */
+export declare function inAuthContext<C, I, O>(fn: OnCallWithAuthorizedNestContext<C, I, O>): OnCallWithNestContext<C, I, O>;

package/src/lib/nest/function/nest.utility.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.inAuthContext = void 0;
+const context_1 = require("../../function/context");
+const error_1 = require("../../function/error");
+/**
+ * Creates an OnCallWithNestContext wrapper that validates the input CallableContext to assert the context has auth data before entering the function.
+ *
+ * @param fn
+ * @returns
+ */
+function inAuthContext(fn) {
+    return (nestContext, data, context) => {
+        if ((0, context_1.isContextWithAuthData)(context)) {
+            return fn(nestContext, data, context);
+        }
+        else {
+            throw (0, error_1.unauthenticatedContextHasNoUidError)();
+        }
+    };
+}
+exports.inAuthContext = inAuthContext;
+//# sourceMappingURL=nest.utility.js.map

package/src/lib/nest/function/nest.utility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nest.utility.js","sourceRoot":"","sources":["../../../../../../../packages/firebase-server/src/lib/nest/function/nest.utility.ts"],"names":[],"mappings":";;;AACA,oDAA4F;AAC5F,gDAA2E;AAK3E;;;;;GAKG;AACH,SAAgB,aAAa,CAAU,EAA4C;IACjF,OAAO,CAAC,WAAc,EAAE,IAAO,EAAE,OAAwC,EAAE,EAAE;QAC3E,IAAI,IAAA,+BAAqB,EAAC,OAAO,CAAC,EAAE;YAClC,OAAO,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;SACvC;aAAM;YACL,MAAM,IAAA,2CAAmC,GAAE,CAAC;SAC7C;IACH,CAAC,CAAA;AACH,CAAC;AARD,sCAQC"}

package/src/lib/nest/function/transform.d.ts

@@ -0,0 +1,10 @@
+import { TransformAndValidateFunctionResultFactory, TransformAndValidateObjectFactory } from "@dereekb/model";
+/**
+ * Context used for transforming content.
+ */
+export interface FirebaseServerActionsTransformContext {
+    readonly firebaseServerActionTransformFactory: TransformAndValidateObjectFactory;
+    readonly firebaseServerActionTransformFunctionFactory: TransformAndValidateFunctionResultFactory;
+}
+export declare function firebaseServerActionsTransformContext(): FirebaseServerActionsTransformContext;
+export declare function firebaseServerActionsTransformFactory(): TransformAndValidateObjectFactory;

package/src/lib/nest/function/transform.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.firebaseServerActionsTransformFactory = exports.firebaseServerActionsTransformContext = void 0;
+const model_1 = require("@dereekb/model");
+const common_1 = require("@nestjs/common");
+const firebase_functions_1 = require("firebase-functions");
+function firebaseServerActionsTransformContext() {
+    const firebaseServerActionTransformFactory = firebaseServerActionsTransformFactory();
+    const firebaseServerActionTransformFunctionFactory = (0, model_1.toTransformAndValidateFunctionResultFactory)(firebaseServerActionTransformFactory);
+    return {
+        firebaseServerActionTransformFactory,
+        firebaseServerActionTransformFunctionFactory
+    };
+}
+exports.firebaseServerActionsTransformContext = firebaseServerActionsTransformContext;
+function firebaseServerActionsTransformFactory() {
+    const nestValidationExceptionFactory = new common_1.ValidationPipe().createExceptionFactory();
+    return (0, model_1.transformAndValidateObjectFactory)({
+        handleValidationError: (validationError) => {
+            const nestError = nestValidationExceptionFactory(validationError);
+            const details = nestError.getResponse();
+            throw new firebase_functions_1.https.HttpsError('invalid-argument', 'Parameters validation check failed.', details);
+        }
+    });
+}
+exports.firebaseServerActionsTransformFactory = firebaseServerActionsTransformFactory;
+//# sourceMappingURL=transform.js.map

package/src/lib/nest/function/transform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform.js","sourceRoot":"","sources":["../../../../../../../packages/firebase-server/src/lib/nest/function/transform.ts"],"names":[],"mappings":";;;AACA,0CAA8L;AAC9L,2CAA+D;AAC/D,2DAA2C;AAU3C,SAAgB,qCAAqC;IACnD,MAAM,oCAAoC,GAAG,qCAAqC,EAAE,CAAC;IACrF,MAAM,4CAA4C,GAAG,IAAA,mDAA2C,EAAC,oCAAoC,CAAC,CAAC;IAEvI,OAAO;QACL,oCAAoC;QACpC,4CAA4C;KAC7C,CAAC;AACJ,CAAC;AARD,sFAQC;AAED,SAAgB,qCAAqC;IACnD,MAAM,8BAA8B,GAAG,IAAI,uBAAc,EAAE,CAAC,sBAAsB,EAAE,CAAC;IAErF,OAAO,IAAA,yCAAiC,EAAC;QACvC,qBAAqB,EAAE,CAAC,eAAkC,EAAE,EAAE;YAC5D,MAAM,SAAS,GAAG,8BAA8B,CAAC,eAAe,CAAC,CAAC;YAClE,MAAM,OAAO,GAAI,SAA2B,CAAC,WAAW,EAAE,CAAC;YAC3D,MAAM,IAAI,0BAAK,CAAC,UAAU,CAAC,kBAAkB,EAAE,qCAAqC,EAAE,OAAO,CAAC,CAAC;QACjG,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAVD,sFAUC"}

package/src/lib/nest/index.d.ts

@@ -0,0 +1,2 @@
+export * from './function';
+export * from './app';

package/src/lib/nest/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./function"), exports);
+tslib_1.__exportStar(require("./app"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/nest/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/firebase-server/src/lib/nest/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,gDAAsB"}

package/src/test/firebase/firebase.admin.auth.d.ts

@@ -0,0 +1,132 @@
+import { FirebaseAuthUserId } from '@dereekb/firebase';
+import { AbstractChildJestTestContextFixture, Factory, JestTestContextFixture, GetterOrValue, PromiseOrValue } from "@dereekb/util";
+import { FirebaseAdminTestContext } from "./firebase.admin";
+import { CreateRequest } from 'firebase-admin/lib/auth/auth-config';
+import { UserRecord } from 'firebase-admin/lib/auth/user-record';
+import { DecodedIdToken } from 'firebase-admin/lib/auth/token-verifier';
+import { Auth } from 'firebase-admin/lib/auth/auth';
+import { CallableContextOptions, ContextOptions, WrappedFunction, WrappedScheduledFunction } from 'firebase-functions-test/lib/main';
+import { EventContext } from 'firebase-functions/lib/cloud-functions';
+/**
+ * Testing context for a single user.
+ */
+export interface AuthorizedUserTestContext {
+    readonly uid: FirebaseAuthUserId;
+    loadUserRecord(): Promise<UserRecord>;
+    loadIdToken(): Promise<string>;
+    loadDecodedIdToken(): Promise<DecodedIdToken>;
+    makeContextOptions(): Promise<ContextOptions>;
+    callCloudFunction<O = any, I = any>(fn: WrappedScheduledFunction | WrappedFunction<I>, params: any): Promise<O>;
+}
+export declare class AuthorizedUserTestContextFixture<PI extends FirebaseAdminTestContext = FirebaseAdminTestContext, PF extends JestTestContextFixture<PI> = JestTestContextFixture<PI>, I extends AuthorizedUserTestContextInstance<PI> = AuthorizedUserTestContextInstance<PI>> extends AbstractChildJestTestContextFixture<I, PF> implements AuthorizedUserTestContext {
+    get uid(): FirebaseAuthUserId;
+    loadUserRecord(): Promise<UserRecord>;
+    loadIdToken(): Promise<string>;
+    loadDecodedIdToken(): Promise<DecodedIdToken>;
+    makeContextOptions(): Promise<ContextOptions>;
+    callCloudFunction<O = any, I = any>(fn: WrappedScheduledFunction | WrappedFunction<I>, params: any): Promise<O>;
+}
+export interface CallEventFunctionEventContext extends Partial<Omit<EventContext, 'auth'>> {
+}
+export declare class AuthorizedUserTestContextInstance<PI extends FirebaseAdminTestContext = FirebaseAdminTestContext> implements AuthorizedUserTestContext {
+    readonly uid: FirebaseAuthUserId;
+    readonly testContext: PI;
+    constructor(uid: FirebaseAuthUserId, testContext: PI);
+    loadUserRecord(): Promise<UserRecord>;
+    loadIdToken(): Promise<string>;
+    loadDecodedIdToken(): Promise<DecodedIdToken>;
+    makeContextOptions(): Promise<ContextOptions>;
+    callCloudFunction<O = any, I = any>(fn: WrappedScheduledFunction | WrappedFunction<I>, params: any): Promise<O>;
+    callEventCloudFunction<O = any, I = any>(fn: WrappedScheduledFunction | WrappedFunction<I>, params: any, contextOptions?: CallEventFunctionEventContext): Promise<O>;
+}
+/**
+ * Generated user details. Used by AuthorizedUserTestContextParams.
+ */
+export interface AuthorizedUserTestContextDetailsTemplate {
+    /**
+     * Additional user details to add onto the user.
+     */
+    details?: Partial<Omit<CreateRequest, 'uid'>>;
+    /**
+     * Custom claims object to add to a user's tokens.
+     */
+    claims?: object;
+}
+/**
+ * authorizedUserContext/authorizedUserContextFactory parameters.
+ */
+export interface AuthorizedUserTestContextParams<PI extends FirebaseAdminTestContext = FirebaseAdminTestContext, PF extends JestTestContextFixture<PI> = JestTestContextFixture<PI>, I extends AuthorizedUserTestContextInstance<PI> = AuthorizedUserTestContextInstance<PI>, F extends AuthorizedUserTestContextFixture<PI, PF, I> = AuthorizedUserTestContextFixture<PI, PF, I>, C extends AuthorizedUserTestContextFactoryParams<PI, PF> = AuthorizedUserTestContextFactoryParams<PI, PF>> {
+    f: PF;
+    /**
+     * uid value/getter to use. If not provided, a random one will be generated.
+     */
+    uid?: GetterOrValue<FirebaseAuthUserId>;
+    /**
+     * Additional user details to attach to the create request.
+     */
+    makeUserDetails?: (uid: FirebaseAuthUserId, params: C) => AuthorizedUserTestContextDetailsTemplate;
+    /**
+     * Creates the custom fixture. If not defined, a AuthorizedUserTestContextFixture is created.
+     */
+    makeFixture?: (parent: PF) => F;
+    /**
+     * Custom make instance function. If not defined, a AuthorizedUserTestContextInstance will be generated.
+     */
+    makeInstance?: (uid: FirebaseAuthUserId, testInstance: PI, params: C, userRecord: UserRecord) => PromiseOrValue<I>;
+    /**
+     * Optional function to initialize the user for this instance.
+     */
+    initUser?: (instance: I, params: C) => Promise<void>;
+}
+/**
+ * Convenience function for using authorizedUserContextFactory directly and passing buildTests.
+ */
+export declare function authorizedUserContext<PI extends FirebaseAdminTestContext = FirebaseAdminTestContext, PF extends JestTestContextFixture<PI> = JestTestContextFixture<PI>, I extends AuthorizedUserTestContextInstance<PI> = AuthorizedUserTestContextInstance<PI>, F extends AuthorizedUserTestContextFixture<PI, PF, I> = AuthorizedUserTestContextFixture<PI, PF, I>>(config: AuthorizedUserTestContextParams<PI, PF, I, F>, buildTests: (u: F) => void): void;
+export declare type AuthorizedUserTestContextFactoryConfig<PI extends FirebaseAdminTestContext = FirebaseAdminTestContext, PF extends JestTestContextFixture<PI> = JestTestContextFixture<PI>, I extends AuthorizedUserTestContextInstance<PI> = AuthorizedUserTestContextInstance<PI>, F extends AuthorizedUserTestContextFixture<PI, PF, I> = AuthorizedUserTestContextFixture<PI, PF, I>> = Omit<AuthorizedUserTestContextParams<PI, PF, I, F>, 'f'>;
+export interface AuthorizedUserTestContextFactoryParams<PI extends FirebaseAdminTestContext = FirebaseAdminTestContext, PF extends JestTestContextFixture<PI> = JestTestContextFixture<PI>> {
+    f: PF;
+    user?: CreateRequest;
+}
+/**
+ * Creates a new Jest Context that has a random user for authorization for use in firebase server tests.
+ */
+export declare function authorizedUserContextFactory<PI extends FirebaseAdminTestContext = FirebaseAdminTestContext, PF extends JestTestContextFixture<PI> = JestTestContextFixture<PI>, I extends AuthorizedUserTestContextInstance<PI> = AuthorizedUserTestContextInstance<PI>, F extends AuthorizedUserTestContextFixture<PI, PF, I> = AuthorizedUserTestContextFixture<PI, PF, I>, C extends AuthorizedUserTestContextFactoryParams<PI, PF> = AuthorizedUserTestContextFactoryParams<PI, PF>>(config: AuthorizedUserTestContextFactoryConfig<PI, PF, I, F>): (params: C, buildTests: (u: F) => void) => void;
+/**
+ * Incrementing number factory for generating test UID values.
+ *
+ * Has the format 'test-uid-<number>'
+ */
+export declare const testUidFactory: Factory<FirebaseAuthUserId>;
+export declare type TestEncodedFirestoreToken = string;
+/**
+ * Structure of the token created by Auth.createCustomToken().
+ */
+export declare type DecodedFirestoreCreateCustomTokenResult = {
+    claims?: any;
+} & Pick<DecodedIdToken, 'uid' | 'sub' | 'iss' | 'exp' | 'iat' | 'aud'>;
+/**
+ * Creates a CallableContextOptions with auth attached corresponding to the input UserRecord.
+ *
+ * @param auth
+ * @param userRecord
+ * @returns
+ */
+export declare function createTestFunctionContextOptions(auth: Auth, userRecord: UserRecord): Promise<CallableContextOptions>;
+/**
+ * Creates and decodes a firestore token used for testing.
+ *
+ * @param auth
+ * @param userRecord
+ * @returns
+ */
+export declare function createTestFirestoreTokenForUserRecord(auth: Auth, userRecord: UserRecord): Promise<DecodedIdToken>;
+/**
+ * Creates an encoded firestore token used for testing.
+ *
+ * @param auth
+ * @param userRecord
+ * @returns
+ */
+export declare function createEncodedTestFirestoreTokenForUserRecord(auth: Auth, userRecord: UserRecord): Promise<TestEncodedFirestoreToken>;
+export declare function decodeEncodedCreateCustomTokenResult(token: TestEncodedFirestoreToken): DecodedIdToken;
+export declare function testFirestoreClaimsFromUserRecord(userRecord: UserRecord): object;