@dereekb/dbx-firebase 13.11.2 → 13.11.4

package/fesm2022/dereekb-dbx-firebase.mjs

@@ -140,6 +140,7 @@ function firebaseAuthTokenFromUser(user) {
  *
  * @param stateForLoggedInUser Optional function that returns an observable for the user's state if they are logged in and not an anonymous user.
  * @returns
+ * @__NO_SIDE_EFFECTS__
  */
 function authUserStateFromFirebaseAuthServiceFunction(stateForLoggedInUser = () => of('user')) {
     return (dbxFirebaseAuthService) => {
@@ -161,6 +162,7 @@ function authUserStateFromFirebaseAuthServiceFunction(stateForLoggedInUser = ()
  * @param stateFromToken - Function that maps an IdTokenResult to an AuthUserState.
  * @param defaultState - The fallback state when no token is available. Defaults to 'user'.
  * @returns An AuthUserStateObsFunction that reads state from the ID token.
+ * @__NO_SIDE_EFFECTS__
  */
 function stateFromTokenForLoggedInUserFunction(stateFromToken, defaultState = 'user') {
     return (dbxFirebaseAuthService) => {
@@ -558,6 +560,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.11", ngImpo
  * Creates a EnvironmentProviders that provides a DbxFirebaseAnalyticsUserEventsListenerService and initialize it when the app is initialized.
  *
  * @returns EnvironmentProviders
+ * @__NO_SIDE_EFFECTS__
  */
 function provideDbxFirebaseAnalyticsUserEventsListenerService() {
     const providers = [
@@ -1488,6 +1491,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.11", ngImpo
  * Factory function for creating the default Firebase auth login providers.
  *
  * @returns Array of DbxFirebaseAuthLoginProvider
+ * @__NO_SIDE_EFFECTS__
  */
 function defaultFirebaseAuthLoginProvidersFactory() {
     // Brand logos from @firebase-oss/ui-core via jsdelivr CDN.
@@ -2048,6 +2052,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.11", ngImpo
  *
  * @param config - Configuration specifying the claims service and optional auth user state inclusion.
  * @returns A function that, given a DbxFirebaseAuthService, returns an Observable of the decoded AuthRoleSet.
+ * @__NO_SIDE_EFFECTS__
  */
 function authRolesObsWithClaimsService(config) {
     const { addAuthUserStateToRoles: addAuthUserState, claimsService } = config;
@@ -2066,6 +2071,7 @@ function authRolesObsWithClaimsService(config) {
  *
  * @param config - Configuration with the claims service and optional auth state customization.
  * @returns A DbxFirebaseAuthServiceDelegate configured for claims-based auth.
+ * @__NO_SIDE_EFFECTS__
  */
 function defaultDbxFirebaseAuthServiceDelegateWithClaimsService(config) {
     if (filterMaybeArrayValues([config.stateForLoggedInUser, config.stateForLoggedInUserToken, config.authUserStateObs]).length > 1) {
@@ -2788,6 +2794,7 @@ function parseDbxFirebaseEmulatorsConfig(config) {
  * ```ts
  * const appCheck = createDbxFirebaseAppCheck({ app, options });
  * ```
+ * @__NO_SIDE_EFFECTS__
  */
 function createDbxFirebaseAppCheck(params) {
     const { app, options } = params;
@@ -2819,6 +2826,7 @@ function createDbxFirebaseAppCheck(params) {
  * ```ts
  * const firestore = createDbxFirebaseFirestore({ app, options, emulators });
  * ```
+ * @__NO_SIDE_EFFECTS__
  */
 function createDbxFirebaseFirestore(params) {
     const { app, options, emulators } = params;
@@ -2847,6 +2855,7 @@ function createDbxFirebaseFirestore(params) {
  * ```ts
  * const auth = createDbxFirebaseAuth({ app, emulators });
  * ```
+ * @__NO_SIDE_EFFECTS__
  */
 function createDbxFirebaseAuth(params) {
     const { app, emulators } = params;
@@ -2866,6 +2875,7 @@ function createDbxFirebaseAuth(params) {
  * ```ts
  * const storage = createDbxFirebaseStorage({ app, emulators });
  * ```
+ * @__NO_SIDE_EFFECTS__
  */
 function createDbxFirebaseStorage(params) {
     const { app, emulators } = params;
@@ -2885,6 +2895,7 @@ function createDbxFirebaseStorage(params) {
  * ```ts
  * const functions = createDbxFirebaseFunctions({ app, options, emulators });
  * ```
+ * @__NO_SIDE_EFFECTS__
  */
 function createDbxFirebaseFunctions(params) {
     const { app, options, emulators } = params;
@@ -3005,6 +3016,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.11", ngImpo
  *
  * @param config Configuration for provideDbxFirebaseFunctions().
  * @returns EnvironmentProviders for the LazyFirebaseFunctions type.
+ * @__NO_SIDE_EFFECTS__
  */
 function provideDbxFirebaseFunctions(config) {
     const providers = [
@@ -3504,6 +3516,7 @@ function dbxFirebaseDocumentLoaderInstanceWithAccessor(accessor) {
  *
  * @param context$ - Observable of the in-context Firebase models service.
  * @returns A factory function for creating model service instances by type and key.
+ * @__NO_SIDE_EFFECTS__
  */
 function dbxFirebaseInContextFirebaseModelServiceInstanceFactory(context$) {
     return (type, keyObs) => {
@@ -3589,6 +3602,7 @@ class DbxFirebaseModelContextService {
  *
  * @param config - Configuration providing the model service factory and entity map observable.
  * @returns A factory function that creates model info instances from observable model keys.
+ * @__NO_SIDE_EFFECTS__
  */
 function dbxFirebaseModelContextServiceInfoInstanceFactory(config) {
     const { modelService, entityMap$ } = config;
@@ -3625,6 +3639,7 @@ function firebaseContextServiceEntityMap() {
  *
  * @param config Configuration
  * @returns EnvironmentProviders
+ * @__NO_SIDE_EFFECTS__
  */
 function provideDbxFirebaseModelContextService(config) {
     const { dbxFirebaseModelContextServiceClass, dbxFirebaseModelContextServiceFactory } = config;
@@ -3722,6 +3737,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.11", ngImpo
  *
  * @param service - The model types service used to resolve type info and instances.
  * @returns A factory that accepts model keys and returns an Observable of instance pairs with display info and segue refs.
+ * @__NO_SIDE_EFFECTS__
  */
 function dbxFirebaseModelTypesServiceInstancePairForKeysFactory(service) {
     return (keys) => {
@@ -4102,6 +4118,7 @@ const DBX_FIREBASE_MODEL_ENTITY_WITH_STORE_TOKEN = new InjectionToken('DbxFireba
  *
  * @param injector Optional injector to use for the components.
  * @returns
+ * @__NO_SIDE_EFFECTS__
  */
 function dbxFirebaseModelEntityWidgetInjectionConfigFactory(injector) {
     return (entry, entity) => {
@@ -4417,6 +4434,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.11", ngImpo
  *
  * @param config Configuration
  * @returns EnvironmentProviders
+ * @__NO_SIDE_EFFECTS__
  */
 function provideDbxFirebaseModelEntitiesWidgetService(config) {
     const { dbxFirebaseModelEntitiesWidgetServiceConfigFactory } = config;
@@ -4874,7 +4892,42 @@ function provideDbxFirebaseCollectionStoreDirective(sourceType, storeType) {
 }
 
 /**
- * Used to watch query doc changes and respond to them accordingly.
+ * Watches a sibling {@link DbxFirebaseCollectionStoreDirective}'s query inputs
+ * (constraints, collection mode, refs, etc.) and, when set to `'auto'`, calls
+ * `store.restart()` so the collection re-runs and pulls fresh results.
+ *
+ * Use this directive when a `DbxFirebaseCollectionStoreDirective` subclass has
+ * query inputs that change at runtime — by default the store does not react to
+ * those changes, so this directive bridges the gap by composing
+ * {@link dbxFirebaseCollectionChangeWatcher} with
+ * {@link dbxFirebaseCollectionChangeTriggerForWatcher}.
+ *
+ * Modes (`DbxFirebaseCollectionChangeWatcherTriggerMode`):
+ * - `'auto'` — automatically `restart()` the store when the query changes.
+ * - `'off'` (default) — observe only; consumers may read `triggered$` / `event$` themselves.
+ *
+ * @dbxWebComponent
+ * @dbxWebSlug firebase-collection-change
+ * @dbxWebCategory action
+ * @dbxWebKind directive
+ * @dbxWebRelated firebase-collection-store
+ * @dbxWebInputName dbxFirebaseCollectionChange
+ * @dbxWebInputType DbxFirebaseCollectionChangeWatcherTriggerMode
+ * @dbxWebInputRequired false
+ * @dbxWebMinimalExample ```html
+ * <my-items-list dbxFirebaseItemCollection [dbxFirebaseCollectionChange]="'auto'"></my-items-list>
+ * ```
+ *
+ * @example
+ * ```html
+ * <!-- dbxFirebaseItemCollection extends DbxFirebaseCollectionStoreDirective; -->
+ * <!-- when [constraints] changes, the store restarts and reloads. -->
+ * <my-items-list
+ *   dbxFirebaseItemCollection
+ *   [constraints]="currentConstraints()"
+ *   [dbxFirebaseCollectionChange]="'auto'">
+ * </my-items-list>
+ * ```
  */
 class DbxFirebaseCollectionChangeDirective {
     dbxFirebaseCollectionStoreDirective = inject((DbxFirebaseCollectionStoreDirective));
@@ -5119,6 +5172,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.11", ngImpo
  * @param store
  * @param fn
  * @returns
+ * @__NO_SIDE_EFFECTS__
  */
 function firebaseCollectionStoreCreateFunction(store, fn) {
     return (params) => loadingStateFromObs(lazyFrom(() => fn(params).then((result) => {
@@ -5133,6 +5187,7 @@ function firebaseCollectionStoreCreateFunction(store, fn) {
  *
  * @param fn
  * @returns
+ * @__NO_SIDE_EFFECTS__
  */
 function firebaseCollectionStoreCrudFunction(fn) {
     return (params) => loadingStateFromObs(from(fn(params)).pipe(shareReplay(1)));
@@ -5373,6 +5428,7 @@ AbstractRootSingleItemDbxFirebaseDocument = __decorate([
  * @param fn - The Firebase create function to wrap.
  * @param config - Optional config with an `onResult` callback.
  * @returns A function that executes the create and sets the resulting key on the store.
+ * @__NO_SIDE_EFFECTS__
  */
 function firebaseDocumentStoreCreateFunction(store, fn, config) {
     return (params) => loadingStateFromObs(lazyFrom(() => fn(params).then((result) => {
@@ -5390,6 +5446,7 @@ function firebaseDocumentStoreCreateFunction(store, fn, config) {
  *
  * @param fn
  * @returns
+ * @__NO_SIDE_EFFECTS__
  */
 function firebaseDocumentStoreCrudFunction(fn) {
     return (params) => loadingStateFromObs(from(fn(params)).pipe(shareReplay(1)));
@@ -5405,6 +5462,7 @@ function firebaseDocumentStoreCrudFunction(fn) {
  * @param store
  * @param fn
  * @returns
+ * @__NO_SIDE_EFFECTS__
  */
 function firebaseDocumentStoreReadFunction(store, fn) {
     return firebaseDocumentStoreUpdateFunction(store, fn);
@@ -5419,6 +5477,7 @@ function firebaseDocumentStoreReadFunction(store, fn) {
  * @param fn - The Firebase update function to wrap.
  * @param config - Optional config with an `onResult` callback.
  * @returns A function that executes the update with the store's key injected.
+ * @__NO_SIDE_EFFECTS__
  */
 function firebaseDocumentStoreUpdateFunction(store, fn, config) {
     return (params) => loadingStateFromObs(store.key$.pipe(first(), exhaustMap((key) => fn({
@@ -5438,6 +5497,7 @@ function firebaseDocumentStoreUpdateFunction(store, fn, config) {
  * @param store
  * @param fn
  * @returns
+ * @__NO_SIDE_EFFECTS__
  */
 function firebaseDocumentStoreDeleteFunction(store, fn) {
     return (params) => loadingStateFromObs(store.key$.pipe(first(), exhaustMap((key) => fn({
@@ -7695,6 +7755,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.11", ngImpo
  *
  * @param storageAccessorFactory - The factory used to create prefixed storage accessors.
  * @returns A StorageAccessor scoped to the storage file download cache.
+ * @__NO_SIDE_EFFECTS__
  */
 function defaultDbxFirebaseStorageFileDownloadStorageAccessorFactory(storageAccessorFactory) {
     return storageAccessorFactory.createStorageAccessor({
@@ -7705,6 +7766,7 @@ function defaultDbxFirebaseStorageFileDownloadStorageAccessorFactory(storageAcce
  * Creates EnvironmentProviders for the storage file download service and its dependencies.
  *
  * @returns EnvironmentProviders that register the storage file download storage accessor, storage, and service.
+ * @__NO_SIDE_EFFECTS__
  */
 function provideDbxFirebaseStorageFileService() {
     const providers = [
@@ -7880,6 +7942,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.11", ngImpo
  *
  * @param base Optional base configuration to use.
  * @returns Factory function for the DbxFirebaseStorageContext.
+ * @__NO_SIDE_EFFECTS__
  */
 function dbxFirebaseStorageProvidersContextConfigFactory(base) {
     return (app) => {
@@ -7930,6 +7993,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.11", ngImpo
  *
  * @param config Configuration
  * @returns EnvironmentProviders
+ * @__NO_SIDE_EFFECTS__
  */
 function provideDbxFirebaseModelTypesService(config) {
     const { dbxFirebaseModelTypesServiceConfigFactory } = config;