npm - @stevenkellner/team-conduct-api - Versions diffs - 2.0.14 → 2.0.16 - Mend

@stevenkellner/team-conduct-api 2.0.14 → 2.0.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

package/lib/src/firebase/FirebaseConfiguration.d.ts +5 -0
package/lib/src/firebase/FirebaseConfiguration.js +7 -0
package/lib/src/firebase/Firestore.d.ts +2 -1
package/lib/src/firebase/Firestore.js +4 -0
package/lib/src/functions/firebaseFunctionsContext.d.ts +1 -34
package/lib/src/functions/firebaseFunctionsContext.js +33 -33
package/lib/test/firebase/FirebaseConfiguration.test.js +3 -0
package/lib/test/firebase/firebase-utils.js +1 -0
package/package.json +2 -2
package/src/firebase/FirebaseConfiguration.ts +12 -0
package/src/firebase/Firestore.ts +5 -1
package/src/functions/firebaseFunctionsContext.ts +41 -40

package/lib/src/firebase/FirebaseConfiguration.d.ts CHANGED Viewed

@@ -1,5 +1,6 @@
 import { FirestoreScheme } from './FirestoreScheme';
 import { Messaging } from './Messaging';
+import { Firestore as FirebaseFirestore } from 'firebase-admin/firestore';
 /**
  * Singleton configuration manager for Firebase services.
  *
@@ -12,6 +13,7 @@ export declare class FirebaseConfiguration {
      */
     static readonly shared: FirebaseConfiguration;
     private configured;
+    private _firebaseFirestore;
     private _baseFirestoreDocument;
     private _messaging;
     /**
@@ -28,6 +30,7 @@ export declare class FirebaseConfiguration {
      * @throws Error if already configured
      */
     configure(configuration: {
+        firebaseFirestore: FirebaseFirestore;
         baseFirestoreDocument: FirestoreScheme;
         messaging: Messaging;
     }): void;
@@ -39,9 +42,11 @@ export declare class FirebaseConfiguration {
      * @param configuration - New configuration object containing Firestore and Messaging services
      */
     reconfigure(configuration: {
+        firebaseFirestore: FirebaseFirestore;
         baseFirestoreDocument: FirestoreScheme;
         messaging: Messaging;
     }): void;
+    get firebaseFirestore(): FirebaseFirestore;
     /**
      * Gets the base Firestore document reference.
      *

package/lib/src/firebase/FirebaseConfiguration.js CHANGED Viewed

@@ -13,6 +13,7 @@ class FirebaseConfiguration {
      */
     static shared = new FirebaseConfiguration();
     configured = false;
+    _firebaseFirestore = null;
     _baseFirestoreDocument = null;
     _messaging = null;
     /**
@@ -31,6 +32,7 @@ class FirebaseConfiguration {
     configure(configuration) {
         if (this.configured)
             throw new Error('Configuration is already configured');
+        this._firebaseFirestore = configuration.firebaseFirestore;
         this._baseFirestoreDocument = configuration.baseFirestoreDocument;
         this._messaging = configuration.messaging;
         this.configured = true;
@@ -46,6 +48,11 @@ class FirebaseConfiguration {
         this.configured = false;
         this.configure(configuration);
     }
+    get firebaseFirestore() {
+        if (!this.configured || !this._firebaseFirestore)
+            throw new Error('Configuration.firebaseFirestore is not configured');
+        return this._firebaseFirestore;
+    }
     /**
      * Gets the base Firestore document reference.
      *

package/lib/src/firebase/Firestore.d.ts CHANGED Viewed

@@ -1,4 +1,4 @@
-import { FirestoreCollection, FirestoreDocument, UserAuthId } from '@stevenkellner/firebase-function';
+import { FirestoreBatch, FirestoreCollection, FirestoreDocument, UserAuthId } from '@stevenkellner/firebase-function';
 import { FirestoreScheme } from './FirestoreScheme';
 import { Fine, FineTemplate, Invitation, Person, User, Team } from '../types';
 /**
@@ -68,6 +68,7 @@ export declare class Firestore {
      * @private
      */
     protected get base(): FirestoreScheme;
+    batch(): FirestoreBatch;
     /**
      * Gets a reference to a team document.
      *

package/lib/src/firebase/Firestore.js CHANGED Viewed

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Firestore = void 0;
+const firebase_function_1 = require("@stevenkellner/firebase-function");
 const _1 = require(".");
 /**
  * Accessor class for Firestore documents and collections.
@@ -75,6 +76,9 @@ class Firestore {
     get base() {
         return _1.FirebaseConfiguration.shared.baseFirestoreDocument;
     }
+    batch() {
+        return new firebase_function_1.FirestoreBatch(_1.FirebaseConfiguration.shared.firebaseFirestore);
+    }
     /**
      * Gets a reference to a team document.
      *

package/lib/src/functions/firebaseFunctionsContext.d.ts CHANGED Viewed

@@ -1,40 +1,7 @@
-import { TeamNewFunction, UserRegisterFunction, PaypalMeEditFunction, NotificationRegisterFunction, NotificationSubscribeFunction, InvitationGetInvitationFunction, InvitationRegisterFunction, PersonAddFunction, PersonDeleteFunction, PersonUpdateFunction, UserKickoutFunction, UserRoleEditFunction, FineTemplateAddFunction, FineTemplateDeleteFunction, FineTemplateUpdateFunction, FineAddFunction, FineDeleteFunction, FineUpdateFunction } from '.';
+import { UserRegisterFunction } from '.';
 export declare const firebaseFunctionsContext: {
-    team: {
-        new: import("@stevenkellner/firebase-function").FirebaseFunctionContext<TeamNewFunction.Parameters, import("..").User>;
-    };
     user: {
         login: import("@stevenkellner/firebase-function").FirebaseFunctionContext<null, import("..").User>;
         register: import("@stevenkellner/firebase-function").FirebaseFunctionContext<UserRegisterFunction.Parameters, import("..").User>;
     };
-    paypalMe: {
-        edit: import("@stevenkellner/firebase-function").FirebaseFunctionContext<PaypalMeEditFunction.Parameters, void>;
-    };
-    notification: {
-        register: import("@stevenkellner/firebase-function").FirebaseFunctionContext<NotificationRegisterFunction.Parameters, void>;
-        subscribe: import("@stevenkellner/firebase-function").FirebaseFunctionContext<NotificationSubscribeFunction.Parameters, void>;
-    };
-    invitation: {
-        invite: import("@stevenkellner/firebase-function").FirebaseFunctionContext<import("..").Invitation, import("@stevenkellner/typescript-common-functionality").Tagged<string, "invitation">>;
-        withdraw: import("@stevenkellner/firebase-function").FirebaseFunctionContext<import("..").Invitation, void>;
-        getInvitation: import("@stevenkellner/firebase-function").FirebaseFunctionContext<import("@stevenkellner/typescript-common-functionality").Tagged<string, "invitation">, InvitationGetInvitationFunction.ReturnType>;
-        register: import("@stevenkellner/firebase-function").FirebaseFunctionContext<InvitationRegisterFunction.Parameters, import("..").User>;
-    };
-    person: {
-        add: import("@stevenkellner/firebase-function").FirebaseFunctionContext<PersonAddFunction.Parameters, void>;
-        update: import("@stevenkellner/firebase-function").FirebaseFunctionContext<PersonUpdateFunction.Parameters, void>;
-        delete: import("@stevenkellner/firebase-function").FirebaseFunctionContext<PersonDeleteFunction.Parameters, void>;
-        kickout: import("@stevenkellner/firebase-function").FirebaseFunctionContext<UserKickoutFunction.Parameters, void>;
-        roleEdit: import("@stevenkellner/firebase-function").FirebaseFunctionContext<UserRoleEditFunction.Parameters, void>;
-    };
-    fineTemplate: {
-        add: import("@stevenkellner/firebase-function").FirebaseFunctionContext<FineTemplateAddFunction.Parameters, void>;
-        update: import("@stevenkellner/firebase-function").FirebaseFunctionContext<FineTemplateUpdateFunction.Parameters, void>;
-        delete: import("@stevenkellner/firebase-function").FirebaseFunctionContext<FineTemplateDeleteFunction.Parameters, void>;
-    };
-    fine: {
-        add: import("@stevenkellner/firebase-function").FirebaseFunctionContext<FineAddFunction.Parameters, void>;
-        update: import("@stevenkellner/firebase-function").FirebaseFunctionContext<FineUpdateFunction.Parameters, void>;
-        delete: import("@stevenkellner/firebase-function").FirebaseFunctionContext<FineDeleteFunction.Parameters, void>;
-    };
 };

package/lib/src/functions/firebaseFunctionsContext.js CHANGED Viewed

@@ -4,41 +4,41 @@ exports.firebaseFunctionsContext = void 0;
 const firebase_function_1 = require("@stevenkellner/firebase-function");
 const _1 = require(".");
 exports.firebaseFunctionsContext = firebase_function_1.FirebaseFunctionsContext.build(builder => ({
-    team: {
-        new: builder.function(_1.TeamNewFunction)
-    },
+    // team: {
+    //     new: builder.function(TeamNewFunction)
+    // },
     user: {
         login: builder.function(_1.UserLoginFunction),
         register: builder.function(_1.UserRegisterFunction)
-    },
-    paypalMe: {
-        edit: builder.function(_1.PaypalMeEditFunction)
-    },
-    notification: {
-        register: builder.function(_1.NotificationRegisterFunction),
-        subscribe: builder.function(_1.NotificationSubscribeFunction)
-    },
-    invitation: {
-        invite: builder.function(_1.InvitationInviteFunction),
-        withdraw: builder.function(_1.InvitationWithdrawFunction),
-        getInvitation: builder.function(_1.InvitationGetInvitationFunction),
-        register: builder.function(_1.InvitationRegisterFunction)
-    },
-    person: {
-        add: builder.function(_1.PersonAddFunction),
-        update: builder.function(_1.PersonUpdateFunction),
-        delete: builder.function(_1.PersonDeleteFunction),
-        kickout: builder.function(_1.UserKickoutFunction),
-        roleEdit: builder.function(_1.UserRoleEditFunction)
-    },
-    fineTemplate: {
-        add: builder.function(_1.FineTemplateAddFunction),
-        update: builder.function(_1.FineTemplateUpdateFunction),
-        delete: builder.function(_1.FineTemplateDeleteFunction)
-    },
-    fine: {
-        add: builder.function(_1.FineAddFunction),
-        update: builder.function(_1.FineUpdateFunction),
-        delete: builder.function(_1.FineDeleteFunction)
     }
+    // paypalMe: {
+    //     edit: builder.function(PaypalMeEditFunction)
+    // },
+    // notification: {
+    //     register: builder.function(NotificationRegisterFunction),
+    //     subscribe: builder.function(NotificationSubscribeFunction)
+    // },
+    // invitation: {
+    //     invite: builder.function(InvitationInviteFunction),
+    //     withdraw: builder.function(InvitationWithdrawFunction),
+    //     getInvitation: builder.function(InvitationGetInvitationFunction),
+    //     register: builder.function(InvitationRegisterFunction)
+    // },
+    // person: {
+    //     add: builder.function(PersonAddFunction),
+    //     update: builder.function(PersonUpdateFunction),
+    //     delete: builder.function(PersonDeleteFunction),
+    //     kickout: builder.function(UserKickoutFunction),
+    //     roleEdit: builder.function(UserRoleEditFunction)
+    // },
+    // fineTemplate: {
+    //     add: builder.function(FineTemplateAddFunction),
+    //     update: builder.function(FineTemplateUpdateFunction),
+    //     delete: builder.function(FineTemplateDeleteFunction)
+    // },
+    // fine: {
+    //     add: builder.function(FineAddFunction),
+    //     update: builder.function(FineUpdateFunction),
+    //     delete: builder.function(FineDeleteFunction)
+    // }
 }));

package/lib/test/firebase/FirebaseConfiguration.test.js CHANGED Viewed

@@ -21,6 +21,7 @@ describe('FirebaseConfiguration', () => {
         // For now, we'll test the error cases that don't require full configuration.
         it('should throw error when configuring twice', () => {
             // Create a mock configuration
+            const mockFirebaseFirestore = {};
             const mockFirestore = {};
             const mockMessaging = {
                 sendEachForMulticast: async () => ({
@@ -35,11 +36,13 @@ describe('FirebaseConfiguration', () => {
                 // If already configured, this should throw
                 try {
                     FirebaseConfiguration_1.FirebaseConfiguration.shared.configure({
+                        firebaseFirestore: mockFirebaseFirestore,
                         baseFirestoreDocument: mockFirestore,
                         messaging: mockMessaging
                     });
                     // If it succeeds, try configuring again to test the double-configuration error
                     FirebaseConfiguration_1.FirebaseConfiguration.shared.configure({
+                        firebaseFirestore: mockFirebaseFirestore,
                         baseFirestoreDocument: mockFirestore,
                         messaging: mockMessaging
                     });

package/lib/test/firebase/firebase-utils.js CHANGED Viewed

@@ -127,6 +127,7 @@ async function expectThrowsFunctionsError(fn, expectedCode, message = null) {
 }
 function configureFirebase(collections, messaging) {
     src_1.FirebaseConfiguration.shared.reconfigure({
+        firebaseFirestore: undefined,
         baseFirestoreDocument: Document.colls(collections),
         messaging: messaging
     });

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "@stevenkellner/team-conduct-api",
-    "version": "2.0.14",
+    "version": "2.0.16",
     "description": "Firebase API for Team Conduct",
     "license": "MIT",
     "author": "Steven Kellner",
@@ -22,7 +22,7 @@
         "release": "npm run rebuild && npm run lint && npm version patch && git push --follow-tags"
     },
     "dependencies": {
-        "@stevenkellner/firebase-function": "^1.4.143",
+        "@stevenkellner/firebase-function": "^1.4.144",
         "@stevenkellner/typescript-common-functionality": "^1.0.61"
     },
     "devDependencies": {

package/src/firebase/FirebaseConfiguration.ts CHANGED Viewed

@@ -1,5 +1,6 @@
 import { FirestoreScheme } from './FirestoreScheme';
 import { Messaging } from './Messaging';
+import { Firestore as FirebaseFirestore } from 'firebase-admin/firestore';
 /**
  * Singleton configuration manager for Firebase services.
@@ -16,6 +17,8 @@ export class FirebaseConfiguration {
     private configured: boolean = false;
+    private _firebaseFirestore: FirebaseFirestore | null = null;
     private _baseFirestoreDocument: FirestoreScheme | null = null;
     private _messaging: Messaging | null = null;
@@ -35,11 +38,13 @@ export class FirebaseConfiguration {
      * @throws Error if already configured
      */
     public configure(configuration: {
+        firebaseFirestore: FirebaseFirestore,
         baseFirestoreDocument: FirestoreScheme,
         messaging: Messaging
     }) {
         if (this.configured)
             throw new Error('Configuration is already configured');
+        this._firebaseFirestore = configuration.firebaseFirestore;
         this._baseFirestoreDocument = configuration.baseFirestoreDocument;
         this._messaging = configuration.messaging;
         this.configured = true;
@@ -53,6 +58,7 @@ export class FirebaseConfiguration {
      * @param configuration - New configuration object containing Firestore and Messaging services
      */
     public reconfigure(configuration: {
+        firebaseFirestore: FirebaseFirestore,
         baseFirestoreDocument: FirestoreScheme,
         messaging: Messaging
     }) {
@@ -60,6 +66,12 @@ export class FirebaseConfiguration {
         this.configure(configuration);
     }
+    public get firebaseFirestore(): FirebaseFirestore {
+        if (!this.configured || !this._firebaseFirestore)
+            throw new Error('Configuration.firebaseFirestore is not configured');
+        return this._firebaseFirestore;
+    }
     /**
      * Gets the base Firestore document reference.
      *

package/src/firebase/Firestore.ts CHANGED Viewed

@@ -1,4 +1,4 @@
-import { FirestoreCollection, FirestoreDocument, UserAuthId } from '@stevenkellner/firebase-function';
+import { FirestoreBatch, FirestoreCollection, FirestoreDocument, UserAuthId } from '@stevenkellner/firebase-function';
 import { FirestoreScheme } from './FirestoreScheme';
 import { Fine, FineTemplate, Invitation, Person, User, Team } from '../types';
 import { FirebaseConfiguration } from '.';
@@ -81,6 +81,10 @@ export class Firestore {
         return FirebaseConfiguration.shared.baseFirestoreDocument;
     }
+    public batch(): FirestoreBatch {
+        return new FirestoreBatch(FirebaseConfiguration.shared.firebaseFirestore);
+    }
     /**
      * Gets a reference to a team document.
      *

package/src/functions/firebaseFunctionsContext.ts CHANGED Viewed

@@ -1,49 +1,50 @@
 import { FirebaseFunctionsContext } from '@stevenkellner/firebase-function';
-import { TeamNewFunction,
-    UserLoginFunction, UserRegisterFunction,
-    PaypalMeEditFunction, NotificationRegisterFunction, NotificationSubscribeFunction,
-    InvitationInviteFunction, InvitationWithdrawFunction, InvitationGetInvitationFunction, InvitationRegisterFunction,
-    PersonAddFunction, PersonDeleteFunction, PersonUpdateFunction, UserKickoutFunction, UserRoleEditFunction,
-    FineTemplateAddFunction, FineTemplateDeleteFunction, FineTemplateUpdateFunction,
-    FineAddFunction, FineDeleteFunction, FineUpdateFunction
+import {
+    // TeamNewFunction,
+    UserLoginFunction, UserRegisterFunction
+    // PaypalMeEditFunction, NotificationRegisterFunction, NotificationSubscribeFunction,
+    // InvitationInviteFunction, InvitationWithdrawFunction, InvitationGetInvitationFunction, InvitationRegisterFunction,
+    // PersonAddFunction, PersonDeleteFunction, PersonUpdateFunction, UserKickoutFunction, UserRoleEditFunction,
+    // FineTemplateAddFunction, FineTemplateDeleteFunction, FineTemplateUpdateFunction,
+    // FineAddFunction, FineDeleteFunction, FineUpdateFunction
 } from '.';
 export const firebaseFunctionsContext = FirebaseFunctionsContext.build(builder => ({
-    team: {
-        new: builder.function(TeamNewFunction)
-    },
+    // team: {
+    //     new: builder.function(TeamNewFunction)
+    // },
     user: {
         login: builder.function(UserLoginFunction),
         register: builder.function(UserRegisterFunction)
-    },
-    paypalMe: {
-        edit: builder.function(PaypalMeEditFunction)
-    },
-    notification: {
-        register: builder.function(NotificationRegisterFunction),
-        subscribe: builder.function(NotificationSubscribeFunction)
-    },
-    invitation: {
-        invite: builder.function(InvitationInviteFunction),
-        withdraw: builder.function(InvitationWithdrawFunction),
-        getInvitation: builder.function(InvitationGetInvitationFunction),
-        register: builder.function(InvitationRegisterFunction)
-    },
-    person: {
-        add: builder.function(PersonAddFunction),
-        update: builder.function(PersonUpdateFunction),
-        delete: builder.function(PersonDeleteFunction),
-        kickout: builder.function(UserKickoutFunction),
-        roleEdit: builder.function(UserRoleEditFunction)
-    },
-    fineTemplate: {
-        add: builder.function(FineTemplateAddFunction),
-        update: builder.function(FineTemplateUpdateFunction),
-        delete: builder.function(FineTemplateDeleteFunction)
-    },
-    fine: {
-        add: builder.function(FineAddFunction),
-        update: builder.function(FineUpdateFunction),
-        delete: builder.function(FineDeleteFunction)
     }
+    // paypalMe: {
+    //     edit: builder.function(PaypalMeEditFunction)
+    // },
+    // notification: {
+    //     register: builder.function(NotificationRegisterFunction),
+    //     subscribe: builder.function(NotificationSubscribeFunction)
+    // },
+    // invitation: {
+    //     invite: builder.function(InvitationInviteFunction),
+    //     withdraw: builder.function(InvitationWithdrawFunction),
+    //     getInvitation: builder.function(InvitationGetInvitationFunction),
+    //     register: builder.function(InvitationRegisterFunction)
+    // },
+    // person: {
+    //     add: builder.function(PersonAddFunction),
+    //     update: builder.function(PersonUpdateFunction),
+    //     delete: builder.function(PersonDeleteFunction),
+    //     kickout: builder.function(UserKickoutFunction),
+    //     roleEdit: builder.function(UserRoleEditFunction)
+    // },
+    // fineTemplate: {
+    //     add: builder.function(FineTemplateAddFunction),
+    //     update: builder.function(FineTemplateUpdateFunction),
+    //     delete: builder.function(FineTemplateDeleteFunction)
+    // },
+    // fine: {
+    //     add: builder.function(FineAddFunction),
+    //     update: builder.function(FineUpdateFunction),
+    //     delete: builder.function(FineDeleteFunction)
+    // }
 }));