@stevenkellner/team-conduct-api 2.0.13 → 2.0.15

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

@@ -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

@@ -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

@@ -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

@@ -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/user/register.d.ts

@@ -4,11 +4,18 @@ import { ObjectTypeBuilder } from '@stevenkellner/typescript-common-functionalit
 export declare namespace UserRegisterFunction {
     type Parameters = {
         userId: User.Id;
+        signInType: User.SignInType;
     };
 }
 export declare class UserRegisterFunction implements FirebaseFunction<UserRegisterFunction.Parameters, User> {
     parametersBuilder: ObjectTypeBuilder<{
         userId: string;
+        signInType: {
+            type: "email";
+            email: string;
+        } | {
+            type: "google" | "apple";
+        };
     }, UserRegisterFunction.Parameters>;
     returnTypeBuilder: User.TypeBuilder;
 }

package/lib/src/functions/user/register.js

@@ -5,7 +5,8 @@ const types_1 = require("../../types");
 const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
 class UserRegisterFunction {
     parametersBuilder = new typescript_common_functionality_1.ObjectTypeBuilder({
-        userId: types_1.User.Id.builder
+        userId: types_1.User.Id.builder,
+        signInType: types_1.User.SignInType.builder
     });
     returnTypeBuilder = types_1.User.builder;
 }

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

@@ -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

@@ -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

@@ -1,6 +1,6 @@
 {
     "name": "@stevenkellner/team-conduct-api",
-    "version": "2.0.13",
+    "version": "2.0.15",
     "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

@@ -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

@@ -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/user/register.ts

@@ -5,14 +5,16 @@ import { Flattable, ObjectTypeBuilder } from '@stevenkellner/typescript-common-f
 export namespace UserRegisterFunction {
 
     export type Parameters = {
-        userId: User.Id
+        userId: User.Id,
+        signInType: User.SignInType
     };
 }
 
 export class UserRegisterFunction implements FirebaseFunction<UserRegisterFunction.Parameters, User> {
 
     public parametersBuilder = new ObjectTypeBuilder<Flattable.Flatten<UserRegisterFunction.Parameters>, UserRegisterFunction.Parameters>({
-        userId: User.Id.builder
+        userId: User.Id.builder,
+        signInType: User.SignInType.builder
     });
 
     public returnTypeBuilder = User.builder;