@dereekb/dbx-firebase 8.12.5 → 8.12.8

package/lib/auth/service/firebase.auth.rxjs.d.ts

@@ -1,21 +1,23 @@
 import { AuthUserState } from '@dereekb/dbx-core';
+import { ObservableOrValue } from '@dereekb/rxjs';
 import { IdTokenResult } from 'firebase/auth';
 import { Observable } from 'rxjs';
-import { DbxFirebaseAuthService } from './firebase.auth.service';
+import { AuthUserStateObsFunction, DbxFirebaseAuthService } from './firebase.auth.service';
 /**
- * Derives a user state from the input firebase auth service.
+ * Creates a AuthUserStateObsFunction that derives a user state from the input firebase auth service, and the optional stateForLoggedInUser input
  *
- * @param dbxFirebaseAuthService
  * @param stateForLoggedInUser Optional function that returns an observable for the user's state if they are logged in and not an anonymous user.
  * @returns
  */
-export declare function authUserStateFromFirebaseAuthService(dbxFirebaseAuthService: DbxFirebaseAuthService, stateForLoggedInUser?: (dbxFirebaseAuthService: DbxFirebaseAuthService) => Observable<AuthUserState>): Observable<AuthUserState>;
+export declare function authUserStateFromFirebaseAuthServiceFunction(stateForLoggedInUser?: AuthUserStateObsFunction): AuthUserStateObsFunction;
+export declare type StateFromTokenFunction = (token: IdTokenResult) => ObservableOrValue<AuthUserState>;
+export declare function stateFromTokenForLoggedInUserFunction(stateFromToken: StateFromTokenFunction, defaultState?: AuthUserState): AuthUserStateObsFunction;
 /**
  * Convenience function to read a value from an IdTokenResult off of the current user.
  *
  * @param dbxFirebaseAuthService
- * @param readBooleanFromIdToken
+ * @param readValueFromIdToken
  * @param defaultValue
  * @returns
  */
-export declare function readValueFromIdToken<T>(dbxFirebaseAuthService: DbxFirebaseAuthService, readBooleanFromIdToken: (idToken: IdTokenResult) => Observable<T>, defaultValue: T): Observable<T>;
+export declare function readValueFromIdToken<T>(dbxFirebaseAuthService: DbxFirebaseAuthService, readValueFromIdToken: (idToken: IdTokenResult) => ObservableOrValue<T>, defaultValue: T): Observable<T>;

package/lib/auth/service/firebase.auth.service.d.ts

@@ -5,9 +5,13 @@ import { AuthClaims, AuthClaimsObject, AuthRoleClaimsService, AuthRoleSet, Maybe
 import { AuthUserInfo } from '../auth';
 import { FirebaseAuthContextInfo, FirebaseAuthToken } from '@dereekb/firebase';
 import * as i0 from "@angular/core";
+/**
+ * Returns an observable that returns the state of the
+ */
+export declare type AuthUserStateObsFunction = (dbxFirebaseAuthService: DbxFirebaseAuthService) => Observable<AuthUserState>;
 export declare abstract class DbxFirebaseAuthServiceDelegate {
     fullControlOfAuthUserState?: boolean;
-    abstract authUserStateObs(dbxFirebaseAuthService: DbxFirebaseAuthService): Observable<AuthUserState>;
+    abstract authUserStateObs: AuthUserStateObsFunction;
     abstract authRolesObs(dbxFirebaseAuthService: DbxFirebaseAuthService): Observable<AuthRoleSet>;
     abstract isOnboarded(dbxFirebaseAuthService: DbxFirebaseAuthService): Observable<boolean>;
     /**
@@ -33,6 +37,8 @@ export declare class DbxFirebaseAuthService implements DbxAuthService {
     readonly onLogOut$: Observable<void>;
     readonly userIdentifier$: Observable<AuthUserIdentifier>;
     readonly uid$: Observable<AuthUserIdentifier>;
+    readonly currentIdTokenString$: Observable<Maybe<string>>;
+    readonly idTokenString$: Observable<string>;
     readonly idTokenResult$: Observable<IdTokenResult>;
     readonly claims$: Observable<ParsedToken>;
     readonly currentAuthContextInfo$: Observable<Maybe<DbxFirebaseAuthContextInfo>>;

package/lib/auth/service/firebase.auth.service.delegate.d.ts

@@ -1,7 +1,19 @@
 import { AuthClaimsObject, AuthRoleClaimsService, AuthRoleSet } from '@dereekb/util';
 import { Observable } from 'rxjs';
-import { DbxFirebaseAuthService, DbxFirebaseAuthServiceDelegate } from './firebase.auth.service';
-export interface AuthRolesObsWithClaimsServiceConfig<T extends AuthClaimsObject> extends Partial<Pick<DbxFirebaseAuthServiceDelegate, 'isAdminInAuthRoleSet'>> {
+import { StateFromTokenFunction } from './firebase.auth.rxjs';
+import { AuthUserStateObsFunction, DbxFirebaseAuthService, DbxFirebaseAuthServiceDelegate } from './firebase.auth.service';
+export interface AuthRolesObsWithClaimsServiceConfig<T extends AuthClaimsObject> extends Partial<Pick<DbxFirebaseAuthServiceDelegate, 'isAdminInAuthRoleSet' | 'authUserStateObs'>> {
+    /**
+     * (Optional) alternative to supplying authUserStateObs. Is passed to authUserStateFromFirebaseAuthService.
+     */
+    readonly stateForLoggedInUser?: AuthUserStateObsFunction;
+    /**
+     * (Optional) alternative to supplying authUserStateObs.
+     */
+    readonly stateForLoggedInUserToken?: StateFromTokenFunction;
+    /**
+     * Claims service to use for decoding.
+     */
     readonly claimsService: AuthRoleClaimsService<T>;
     /**
      * Whether or not to also add the current AuthUserState value to decoded roles.

package/lib/model/store/store.document.crud.d.ts

@@ -1,7 +1,7 @@
-import { FirestoreModelKeyRef, ModelFirebaseCreateFunction, ModelFirebaseDeleteFunction, ModelFirebaseUpdateFunction, OnCallCreateModelResult } from '@dereekb/firebase';
+import { ModelFirebaseCreateFunction, ModelFirebaseDeleteFunction, ModelFirebaseUpdateFunction, OnCallCreateModelResult, TargetModelParams, InferredTargetModelParams } from '@dereekb/firebase';
 import { LoadingState } from '@dereekb/rxjs';
+import { PartialOnKeys } from '@dereekb/util';
 import { Observable } from 'rxjs';
-import { Writable } from 'ts-essentials';
 import { DbxFirebaseDocumentStore } from './store.document';
 export declare type DbxFirebaseDocumentStoreCreateFunction<I, O extends OnCallCreateModelResult = OnCallCreateModelResult> = (params: I) => Observable<LoadingState<O>>;
 /**
@@ -12,16 +12,32 @@ export declare type DbxFirebaseDocumentStoreCreateFunction<I, O extends OnCallCr
  * @returns
  */
 export declare function firebaseDocumentStoreCreateFunction<I, O extends OnCallCreateModelResult = OnCallCreateModelResult>(store: DbxFirebaseDocumentStore<any, any>, fn: ModelFirebaseCreateFunction<I, O>): DbxFirebaseDocumentStoreCreateFunction<I, O>;
-export declare type DbxFirebaseDocumentStoreUpdateParams = Partial<Writable<FirestoreModelKeyRef>>;
-export declare type DbxFirebaseDocumentStoreUpdateFunction<I extends DbxFirebaseDocumentStoreUpdateParams> = (params: I) => Observable<LoadingState<void>>;
-export declare function firebaseDocumentStoreUpdateFunction<I extends DbxFirebaseDocumentStoreUpdateParams>(store: DbxFirebaseDocumentStore<any, any>, fn: ModelFirebaseUpdateFunction<I>): DbxFirebaseDocumentStoreUpdateFunction<I>;
-export declare type DbxFirebaseDocumentStoreDeleteParams = Partial<Writable<FirestoreModelKeyRef>>;
-export declare type DbxFirebaseDocumentStoreDeleteFunction<I extends DbxFirebaseDocumentStoreDeleteParams> = (params: I) => Observable<LoadingState<void>>;
 /**
- * Deletes a function for a store that DbxFirebaseDocumentStore captures the ModelFirebaseDeleteFunction result and sets the key of the created value.
+ * A parameter that refers to a specific key.
+ */
+export declare type DbxFirebaseDocumentStoreFunctionParams = TargetModelParams | InferredTargetModelParams;
+/**
+ * Used for the input to related functions
+ */
+export declare type DbxFirebaseDocumentStoreFunctionParamsInput<I extends DbxFirebaseDocumentStoreFunctionParams> = PartialOnKeys<I, 'key'>;
+export declare type DbxFirebaseDocumentStoreFunction<I extends DbxFirebaseDocumentStoreFunctionParams, O = void> = (params: DbxFirebaseDocumentStoreFunctionParamsInput<I>) => Observable<LoadingState<O>>;
+/**
+ * Creates a DbxFirebaseDocumentStoreFunction for update.
+ *
+ * The store's current key is always injected into the params of the request.
+ *
+ * @param store
+ * @param fn
+ * @returns
+ */
+export declare function firebaseDocumentStoreUpdateFunction<I extends DbxFirebaseDocumentStoreFunctionParams, O = void>(store: DbxFirebaseDocumentStore<any, any>, fn: ModelFirebaseUpdateFunction<I, O>): DbxFirebaseDocumentStoreFunction<I, O>;
+/**
+ * Creates a DbxFirebaseDocumentStoreFunction for delete.
+ *
+ * The store's current key is always injected into the params of the request.
  *
  * @param store
  * @param fn
  * @returns
  */
-export declare function firebaseDocumentStoreDeleteFunction<I>(store: DbxFirebaseDocumentStore<any, any>, fn: ModelFirebaseDeleteFunction<I>): DbxFirebaseDocumentStoreDeleteFunction<I>;
+export declare function firebaseDocumentStoreDeleteFunction<I extends DbxFirebaseDocumentStoreFunctionParams, O = void>(store: DbxFirebaseDocumentStore<any, any>, fn: ModelFirebaseDeleteFunction<I, O>): DbxFirebaseDocumentStoreFunction<I, O>;

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@dereekb/dbx-firebase",
-  "version": "8.12.5",
+  "version": "8.12.8",
   "peerDependencies": {
     "@angular/common": "^13.0.0",
     "@angular/core": "^13.0.0",
-    "@dereekb/util": "8.12.5",
+    "@dereekb/util": "8.12.8",
     "firebase": "^9.8.0",
     "rxjs": "^7.0.0",
     "@angular/fire": "^7.4.1",
-    "@dereekb/firebase": "8.12.5",
-    "@dereekb/dbx-core": "8.12.5",
+    "@dereekb/firebase": "8.12.8",
+    "@dereekb/dbx-core": "8.12.8",
     "@angular/material": "^13.0.0",
-    "@dereekb/dbx-web": "8.12.5",
-    "@dereekb/dbx-form": "8.12.5"
+    "@dereekb/dbx-web": "8.12.8",
+    "@dereekb/dbx-form": "8.12.8"
   },
   "dependencies": {
     "tslib": "^2.3.0"