@dereekb/dbx-firebase 5.3.0 → 7.0.1

package/lib/auth/auth.d.ts

@@ -1,3 +1,5 @@
+import { FirebaseAuthToken } from '@dereekb/firebase';
 import { User, UserInfo } from 'firebase/auth';
 export declare type AuthUserInfo = Omit<UserInfo, 'providerId'>;
 export declare function authUserInfoFromAuthUser(user: User): AuthUserInfo;
+export declare function firebaseAuthTokenFromUser(user: User): FirebaseAuthToken;

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

@@ -1,13 +1,15 @@
 import { AuthUserState, DbxAuthService, AuthUserIdentifier } from '@dereekb/dbx-core';
 import { Auth, User, IdTokenResult, ParsedToken, AuthProvider, PopupRedirectResolver, UserCredential } from '@angular/fire/auth';
 import { Observable } from 'rxjs';
-import { AuthRoleSet, Maybe } from '@dereekb/util';
+import { AuthClaims, AuthClaimsObject, AuthRoleClaimsService, AuthRoleSet, Maybe } from '@dereekb/util';
 import { AuthUserInfo } from '../auth';
+import { FirebaseAuthContextInfo, FirebaseAuthToken } from '@dereekb/firebase';
 import * as i0 from "@angular/core";
 export declare abstract class DbxFirebaseAuthServiceDelegate {
     abstract authUserStateObs(dbxFirebaseAuthService: DbxFirebaseAuthService): Observable<AuthUserState>;
     abstract authRolesObs(dbxFirebaseAuthService: DbxFirebaseAuthService): Observable<AuthRoleSet>;
     abstract isOnboarded(dbxFirebaseAuthService: DbxFirebaseAuthService): Observable<boolean>;
+    abstract authRoleClaimsService?: Maybe<AuthRoleClaimsService<AuthClaimsObject>>;
 }
 export declare const DEFAULT_DBX_FIREBASE_AUTH_SERVICE_DELEGATE: DbxFirebaseAuthServiceDelegate;
 export declare class DbxFirebaseAuthService implements DbxAuthService {
@@ -30,7 +32,10 @@ export declare class DbxFirebaseAuthService implements DbxAuthService {
     readonly authUserState$: Observable<AuthUserState>;
     readonly authRoles$: Observable<AuthRoleSet>;
     readonly isOnboarded$: Observable<boolean>;
+    private _authRoleClaimsService?;
     constructor(firebaseAuth: Auth, delegate: DbxFirebaseAuthServiceDelegate);
+    rolesForClaims<T extends AuthClaimsObject = AuthClaimsObject>(claims: AuthClaims<T>): AuthRoleSet;
+    getAuthContextInfo(): Promise<Maybe<DbxFirebaseAuthContextInfo>>;
     logInWithGoogle(): Promise<UserCredential>;
     logInWithFacebook(): Promise<UserCredential>;
     logInWithTwitter(): Promise<UserCredential>;
@@ -47,3 +52,16 @@ export declare class DbxFirebaseAuthService implements DbxAuthService {
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseAuthService, [null, { optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<DbxFirebaseAuthService>;
 }
+/**
+ * FirebaseAuthContextInfo implementation from DbxFirebaseAuthService.
+ */
+export declare class DbxFirebaseAuthContextInfo implements FirebaseAuthContextInfo {
+    readonly service: DbxFirebaseAuthService;
+    readonly user: User;
+    private _token;
+    constructor(service: DbxFirebaseAuthService, user: User);
+    get uid(): string;
+    loadClaims(): Promise<AuthClaims<AuthClaimsObject>>;
+    loadAuthRoles(): Promise<AuthRoleSet>;
+    get token(): FirebaseAuthToken;
+}

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

@@ -9,6 +9,5 @@ export interface AuthRolesObsWithClaimsServiceConfig<T extends AuthClaimsObject>
     readonly addAuthUserStateToRoles?: boolean;
 }
 export declare function authRolesObsWithClaimsService<T extends AuthClaimsObject>(config: AuthRolesObsWithClaimsServiceConfig<T>): (dbxFirebaseAuthService: DbxFirebaseAuthService) => Observable<AuthRoleSet>;
-export interface DefaultDbxFirebaseAuthServiceDelegateWithClaimsServiceConfig<T extends AuthClaimsObject> extends AuthRolesObsWithClaimsServiceConfig<T> {
-}
+export declare type DefaultDbxFirebaseAuthServiceDelegateWithClaimsServiceConfig<T extends AuthClaimsObject> = AuthRolesObsWithClaimsServiceConfig<T>;
 export declare function defaultDbxFirebaseAuthServiceDelegateWithClaimsService<T extends AuthClaimsObject>(config: DefaultDbxFirebaseAuthServiceDelegateWithClaimsServiceConfig<T>): DbxFirebaseAuthServiceDelegate;

package/lib/model/store/index.d.ts

@@ -5,6 +5,7 @@ export * from './store.collection.change.if.directive';
 export * from './store.collection.directive';
 export * from './store.collection.list.directive';
 export * from './store.document';
+export * from './store.document.crud';
 export * from './store.document.auth.directive';
 export * from './store.document.directive';
 export * from './store.document.router.directive';

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

@@ -0,0 +1,27 @@
+import { FirestoreModelKeyRef, ModelFirebaseCreateFunction, ModelFirebaseDeleteFunction, ModelFirebaseUpdateFunction, OnCallCreateModelResult } from '@dereekb/firebase';
+import { LoadingState } from '@dereekb/rxjs';
+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>>;
+/**
+ * Creates a function for a store that DbxFirebaseDocumentStore captures the ModelFirebaseCreateFunction result and sets the key of the created value.
+ *
+ * @param store
+ * @param fn
+ * @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.
+ *
+ * @param store
+ * @param fn
+ * @returns
+ */
+export declare function firebaseDocumentStoreDeleteFunction<I>(store: DbxFirebaseDocumentStore<any, any>, fn: ModelFirebaseDeleteFunction<I>): DbxFirebaseDocumentStoreDeleteFunction<I>;

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

@@ -1,18 +1,22 @@
 import { Observable, Subscription } from 'rxjs';
-import { DocumentSnapshot, DocumentReference, FirestoreCollection, FirestoreDocument, DocumentDataWithId } from '@dereekb/firebase';
+import { DocumentSnapshot, DocumentReference, FirestoreCollection, FirestoreDocument, DocumentDataWithId, FirestoreModelId, FirestoreModelKey, FirestoreCollectionLike, FirestoreModelIdentity } from '@dereekb/firebase';
 import { LoadingState, ObservableOrValue } from '@dereekb/rxjs';
-import { Maybe, ModelKey } from '@dereekb/util';
+import { Maybe } from '@dereekb/util';
 import { LockSetComponent, LockSetComponentStore } from '@dereekb/dbx-core';
 import * as i0 from "@angular/core";
 export interface DbxFirebaseDocumentStore<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends LockSetComponent {
+    readonly firestoreCollectionLike$: Observable<FirestoreCollectionLike<T, D>>;
     readonly firestoreCollection$: Observable<FirestoreCollection<T, D>>;
-    readonly currentInputId$: Observable<Maybe<ModelKey>>;
-    readonly inputId$: Observable<ModelKey>;
+    readonly currentInputId$: Observable<Maybe<FirestoreModelId>>;
+    readonly inputId$: Observable<FirestoreModelId>;
+    readonly currentInputKey$: Observable<Maybe<FirestoreModelKey>>;
+    readonly inputKey$: Observable<FirestoreModelKey>;
     readonly currentInputRef$: Observable<Maybe<DocumentReference<T>>>;
     readonly inputRef$: Observable<DocumentReference<T>>;
     readonly currentDocument$: Observable<Maybe<D>>;
     readonly document$: Observable<D>;
-    readonly id$: Observable<ModelKey>;
+    readonly id$: Observable<FirestoreModelId>;
+    readonly key$: Observable<FirestoreModelKey>;
     readonly ref$: Observable<DocumentReference<T>>;
     readonly documentLoadingState$: Observable<LoadingState<D>>;
     readonly snapshot$: Observable<DocumentSnapshot<T>>;
@@ -21,32 +25,49 @@ export interface DbxFirebaseDocumentStore<T, D extends FirestoreDocument<T> = Fi
     readonly data$: Observable<DocumentDataWithId<T>>;
     readonly dataLoadingState$: Observable<LoadingState<DocumentDataWithId<T>>>;
     readonly exists$: Observable<boolean>;
-    setId: (observableOrValue: ObservableOrValue<Maybe<string>>) => Subscription;
+    readonly modelIdentity$: Observable<FirestoreModelIdentity>;
+    setId: (observableOrValue: ObservableOrValue<Maybe<FirestoreModelId>>) => Subscription;
+    setKey: (observableOrValue: ObservableOrValue<Maybe<FirestoreModelKey>>) => Subscription;
     setRef: (observableOrValue: ObservableOrValue<Maybe<DocumentReference<T>>>) => Subscription;
     /**
-     * Sets the firestore collection to retrieve document from.
+     * Clears the key/id/ref and current document from the store.
+     */
+    clearRefs: () => void;
+    /**
+     * Sets the FirestoreCollection to retrieve documents from.
      */
     readonly setFirestoreCollection: (() => void) | ((observableOrValue: ObservableOrValue<Maybe<FirestoreCollection<T, D>>>) => Subscription);
+    /**
+     * Sets the FirestoreCollectionLike to retrieve documents from.
+     */
+    readonly setFirestoreCollectionLike: (() => void) | ((observableOrValue: ObservableOrValue<Maybe<FirestoreCollectionLike<T, D>>>) => Subscription);
 }
 export interface DbxFirebaseDocumentStoreContextState<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
+    readonly firestoreCollectionLike?: Maybe<FirestoreCollectionLike<T, D>>;
     readonly firestoreCollection?: Maybe<FirestoreCollection<T, D>>;
-    readonly id?: Maybe<ModelKey>;
+    readonly id?: Maybe<FirestoreModelId>;
+    readonly key?: Maybe<FirestoreModelKey>;
     readonly ref?: Maybe<DocumentReference<T>>;
 }
 /**
  * Used for storing the state of a Person and related email threads.
  */
 export declare class AbstractDbxFirebaseDocumentStore<T, D extends FirestoreDocument<T> = FirestoreDocument<T>, C extends DbxFirebaseDocumentStoreContextState<T, D> = DbxFirebaseDocumentStoreContextState<T, D>> extends LockSetComponentStore<C> implements DbxFirebaseDocumentStore<T, D> {
+    readonly currentFirestoreCollectionLike$: Observable<Maybe<FirestoreCollectionLike<T, D>>>;
     readonly currentFirestoreCollection$: Observable<Maybe<FirestoreCollection<T, D>>>;
+    readonly firestoreCollectionLike$: Observable<FirestoreCollectionLike<T, D>>;
     readonly firestoreCollection$: Observable<FirestoreCollection<T, D>>;
-    readonly currentInputId$: Observable<Maybe<ModelKey>>;
-    readonly inputId$: Observable<ModelKey>;
+    readonly currentInputId$: Observable<Maybe<FirestoreModelId>>;
+    readonly inputId$: Observable<FirestoreModelId>;
+    readonly currentInputKey$: Observable<Maybe<FirestoreModelKey>>;
+    readonly inputKey$: Observable<FirestoreModelKey>;
     readonly currentInputRef$: Observable<Maybe<DocumentReference<T>>>;
     readonly inputRef$: Observable<DocumentReference<T>>;
     readonly currentDocument$: Observable<Maybe<D>>;
     readonly document$: Observable<D>;
     readonly documentLoadingState$: Observable<LoadingState<D>>;
-    readonly id$: Observable<ModelKey>;
+    readonly id$: Observable<FirestoreModelId>;
+    readonly key$: Observable<FirestoreModelKey>;
     readonly ref$: Observable<DocumentReference<T>>;
     readonly snapshot$: Observable<DocumentSnapshot<T>>;
     readonly snapshotLoadingState$: Observable<LoadingState<DocumentSnapshot<T>>>;
@@ -55,15 +76,22 @@ export declare class AbstractDbxFirebaseDocumentStore<T, D extends FirestoreDocu
     readonly dataLoadingState$: Observable<LoadingState<DocumentDataWithId<T>>>;
     readonly exists$: Observable<boolean>;
     readonly doesNotExist$: Observable<boolean>;
+    readonly modelIdentity$: Observable<FirestoreModelIdentity>;
     /**
      * Sets the id of the document to load.
      */
     readonly setId: (observableOrValue: Maybe<string> | Observable<Maybe<string>>) => Subscription;
+    /**
+     * Sets the key of the document to load.
+     */
+    readonly setKey: (observableOrValue: Maybe<string> | Observable<Maybe<string>>) => Subscription;
     /**
      * Sets the ref of the document to load.
      */
     readonly setRef: (observableOrValue: Maybe<DocumentReference<T>> | Observable<Maybe<DocumentReference<T>>>) => Subscription;
+    readonly clearRefs: () => void;
     readonly setFirestoreCollection: (() => void) | ((observableOrValue: Maybe<FirestoreCollection<T, D>> | Observable<Maybe<FirestoreCollection<T, D>>>) => Subscription);
+    readonly setFirestoreCollectionLike: (() => void) | ((observableOrValue: Maybe<FirestoreCollectionLike<T, D, import("@dereekb/firebase").LimitedFirestoreDocumentAccessor<T, D>>> | Observable<Maybe<FirestoreCollectionLike<T, D, import("@dereekb/firebase").LimitedFirestoreDocumentAccessor<T, D>>>>) => Subscription);
     static ɵfac: i0.ɵɵFactoryDeclaration<AbstractDbxFirebaseDocumentStore<any, any, any>, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AbstractDbxFirebaseDocumentStore<any, any, any>>;
 }

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

@@ -1,4 +1,4 @@
-import { Observable, Subscription } from 'rxjs';
+import { Observable } from 'rxjs';
 import { FirestoreDocument, FirestoreCollectionWithParentFactory, FirestoreCollection } from '@dereekb/firebase';
 import { Maybe } from '@dereekb/util';
 import { AbstractDbxFirebaseDocumentStore, DbxFirebaseDocumentStore, DbxFirebaseDocumentStoreContextState } from './store.document';
@@ -22,11 +22,11 @@ export declare class AbstractDbxFirebaseDocumentWithParentStore<T, PT, D extends
     /**
      * Sets the collection factory function to use.
      */
-    readonly setCollectionFactory: (observableOrValue: FirestoreCollectionWithParentFactory<T, PT, D, PD, import("@dereekb/firebase").FirestoreCollectionWithParent<T, PT, D, PD>> | Observable<FirestoreCollectionWithParentFactory<T, PT, D, PD, import("@dereekb/firebase").FirestoreCollectionWithParent<T, PT, D, PD>>>) => Subscription;
+    readonly setCollectionFactory: (observableOrValue: FirestoreCollectionWithParentFactory<T, PT, D, PD, import("@dereekb/firebase").FirestoreCollectionWithParent<T, PT, D, PD>> | Observable<FirestoreCollectionWithParentFactory<T, PT, D, PD, import("@dereekb/firebase").FirestoreCollectionWithParent<T, PT, D, PD>>>) => import("rxjs").Subscription;
     /**
      * Sets the parent on the current state.
      */
-    readonly _setParentDocument: (() => void) | ((observableOrValue: Maybe<PD> | Observable<Maybe<PD>>) => Subscription) | (PD extends void ? () => void : (observableOrValue: Maybe<PD> | Observable<Maybe<PD>>) => Subscription);
+    readonly _setParentDocument: (() => void) | ((observableOrValue: Maybe<PD> | Observable<Maybe<PD>>) => import("rxjs").Subscription) | (PD extends void ? () => void : (observableOrValue: Maybe<PD> | Observable<Maybe<PD>>) => import("rxjs").Subscription);
     static ɵfac: i0.ɵɵFactoryDeclaration<AbstractDbxFirebaseDocumentWithParentStore<any, any, any, any, any>, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AbstractDbxFirebaseDocumentWithParentStore<any, any, any, any, any>>;
 }

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@dereekb/dbx-firebase",
-  "version": "5.3.0",
+  "version": "7.0.1",
   "peerDependencies": {
     "@angular/common": "^13.0.0",
     "@angular/core": "^13.0.0",
-    "@dereekb/util": "5.3.0",
+    "@dereekb/util": "7.0.1",
     "firebase": "^9.8.0",
     "rxjs": "^7.0.0",
     "@angular/fire": "^7.3.0-canary.8d5bc12",
-    "@dereekb/dbx-core": "5.3.0",
+    "@dereekb/firebase": "7.0.1",
+    "@dereekb/dbx-core": "7.0.1",
     "@angular/material": "^13.0.0",
-    "@dereekb/dbx-web": "5.3.0",
-    "@dereekb/dbx-form": "5.3.0",
-    "@dereekb/firebase": "5.3.0"
+    "@dereekb/dbx-web": "7.0.1",
+    "@dereekb/dbx-form": "7.0.1"
   },
   "dependencies": {
     "tslib": "^2.3.0"