@dereekb/dbx-firebase 13.11.2 → 13.11.4

package/types/dereekb-dbx-firebase.d.ts

@@ -345,6 +345,7 @@ declare class DbxFirebaseAnalyticsUserEventsListenerService implements Initializ
  * Creates a EnvironmentProviders that provides a DbxFirebaseAnalyticsUserEventsListenerService and initialize it when the app is initialized.
  *
  * @returns EnvironmentProviders
+ * @__NO_SIDE_EFFECTS__
  */
 declare function provideDbxFirebaseAnalyticsUserEventsListenerService(): EnvironmentProviders;
 
@@ -1095,6 +1096,7 @@ declare class DbxFirebaseRegisterEmailComponent extends AbstractConfiguredDbxFir
  *
  * @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__
  */
 declare function authUserStateFromFirebaseAuthServiceFunction(stateForLoggedInUser?: AuthUserStateObsFunction): AuthUserStateObsFunction;
 type StateFromTokenFunction = (token: IdTokenResult) => ObservableOrValue<AuthUserState>;
@@ -1104,6 +1106,7 @@ type StateFromTokenFunction = (token: IdTokenResult) => ObservableOrValue<AuthUs
  * @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__
  */
 declare function stateFromTokenForLoggedInUserFunction(stateFromToken: StateFromTokenFunction, defaultState?: AuthUserState): AuthUserStateObsFunction;
 /**
@@ -1166,6 +1169,7 @@ interface AuthRolesObsWithClaimsServiceConfig<T extends AuthClaimsObject> extend
  *
  * @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__
  */
 declare function authRolesObsWithClaimsService<T extends AuthClaimsObject>(config: AuthRolesObsWithClaimsServiceConfig<T>): (dbxFirebaseAuthService: DbxFirebaseAuthService) => Observable<AuthRoleSet>;
 type DefaultDbxFirebaseAuthServiceDelegateWithClaimsServiceConfig<T extends AuthClaimsObject> = AuthRolesObsWithClaimsServiceConfig<T> & Partial<Pick<DbxFirebaseAuthServiceDelegate, 'sendPasswordReset' | 'completePasswordReset'>>;
@@ -1176,6 +1180,7 @@ type DefaultDbxFirebaseAuthServiceDelegateWithClaimsServiceConfig<T extends Auth
  *
  * @param config - Configuration with the claims service and optional auth state customization.
  * @returns A DbxFirebaseAuthServiceDelegate configured for claims-based auth.
+ * @__NO_SIDE_EFFECTS__
  */
 declare function defaultDbxFirebaseAuthServiceDelegateWithClaimsService<T extends AuthClaimsObject>(config: DefaultDbxFirebaseAuthServiceDelegateWithClaimsServiceConfig<T>): DbxFirebaseAuthServiceDelegate;
 
@@ -1651,6 +1656,7 @@ interface CreateDbxFirebaseAppCheckParams {
  * ```ts
  * const appCheck = createDbxFirebaseAppCheck({ app, options });
  * ```
+ * @__NO_SIDE_EFFECTS__
  */
 declare function createDbxFirebaseAppCheck(params: CreateDbxFirebaseAppCheckParams): AppCheck;
 /**
@@ -1671,6 +1677,7 @@ interface CreateDbxFirebaseFirestoreParams {
  * ```ts
  * const firestore = createDbxFirebaseFirestore({ app, options, emulators });
  * ```
+ * @__NO_SIDE_EFFECTS__
  */
 declare function createDbxFirebaseFirestore(params: CreateDbxFirebaseFirestoreParams): Firestore;
 /**
@@ -1690,6 +1697,7 @@ interface CreateDbxFirebaseAuthParams {
  * ```ts
  * const auth = createDbxFirebaseAuth({ app, emulators });
  * ```
+ * @__NO_SIDE_EFFECTS__
  */
 declare function createDbxFirebaseAuth(params: CreateDbxFirebaseAuthParams): Auth;
 /**
@@ -1709,6 +1717,7 @@ interface CreateDbxFirebaseStorageParams {
  * ```ts
  * const storage = createDbxFirebaseStorage({ app, emulators });
  * ```
+ * @__NO_SIDE_EFFECTS__
  */
 declare function createDbxFirebaseStorage(params: CreateDbxFirebaseStorageParams): FirebaseStorage;
 /**
@@ -1729,6 +1738,7 @@ interface CreateDbxFirebaseFunctionsParams {
  * ```ts
  * const functions = createDbxFirebaseFunctions({ app, options, emulators });
  * ```
+ * @__NO_SIDE_EFFECTS__
  */
 declare function createDbxFirebaseFunctions(params: CreateDbxFirebaseFunctionsParams): Functions;
 
@@ -1893,6 +1903,7 @@ interface ProvideDbxFirebaseFunctionsConfig<T, M extends FirebaseFunctionsMap =
  *
  * @param config Configuration for provideDbxFirebaseFunctions().
  * @returns EnvironmentProviders for the LazyFirebaseFunctions type.
+ * @__NO_SIDE_EFFECTS__
  */
 declare function provideDbxFirebaseFunctions<T, M extends FirebaseFunctionsMap = FirebaseFunctionsMap>(config: ProvideDbxFirebaseFunctionsConfig<T, M>): EnvironmentProviders;
 
@@ -2361,6 +2372,7 @@ type DbxFirebaseInContextFirebaseModelServiceInstanceFactory<S extends InContext
  *
  * @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__
  */
 declare function dbxFirebaseInContextFirebaseModelServiceInstanceFactory<S extends InContextFirebaseModelsService<any>, C extends FirebasePermissionErrorContext = FirebasePermissionErrorContext>(context$: Observable<S>): DbxFirebaseInContextFirebaseModelServiceInstanceFactory<S, C>;
 interface DbxFirebaseInContextFirebaseModelServiceInstance<D extends FirestoreDocument<any>, R extends GrantedRole = GrantedRole, C extends FirebasePermissionErrorContext = FirebasePermissionErrorContext> extends DbxFirebaseInContextFirebaseModelInfoServiceInstance<D, R> {
@@ -2397,6 +2409,7 @@ interface DbxFirebaseModelContextServiceInfoInstanceFactoryConfig<S extends InCo
  *
  * @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__
  */
 declare function dbxFirebaseModelContextServiceInfoInstanceFactory<S extends InContextFirebaseModelsService<any>, C extends FirebasePermissionErrorContext = FirebasePermissionErrorContext>(config: DbxFirebaseModelContextServiceInfoInstanceFactoryConfig<S, C>): DbxFirebaseModelContextServiceInfoInstanceFactory;
 /**
@@ -2421,6 +2434,7 @@ interface ProvideDbxFirebaseModelContextServiceConfig<T extends DbxFirebaseModel
  *
  * @param config Configuration
  * @returns EnvironmentProviders
+ * @__NO_SIDE_EFFECTS__
  */
 declare function provideDbxFirebaseModelContextService<T extends DbxFirebaseModelContextService>(config: ProvideDbxFirebaseModelContextServiceConfig<T>): EnvironmentProviders;
 
@@ -2490,6 +2504,7 @@ type DbxFirebaseModelTypesServiceInstancePairForKeysFactory = (keys: ArrayOrValu
  *
  * @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__
  */
 declare function dbxFirebaseModelTypesServiceInstancePairForKeysFactory(service: DbxFirebaseModelTypesService): DbxFirebaseModelTypesServiceInstancePairForKeysFactory;
 /**
@@ -3150,6 +3165,7 @@ interface ProvideDbxFirebaseModelEntitiesWidgetServiceConfig {
  *
  * @param config Configuration
  * @returns EnvironmentProviders
+ * @__NO_SIDE_EFFECTS__
  */
 declare function provideDbxFirebaseModelEntitiesWidgetService(config: ProvideDbxFirebaseModelEntitiesWidgetServiceConfig): EnvironmentProviders;
 
@@ -3269,6 +3285,7 @@ type DbxFirebaseModelEntitiesWidgetInjectionConfigFactory = (entry: DbxFirebaseM
  *
  * @param injector Optional injector to use for the components.
  * @returns
+ * @__NO_SIDE_EFFECTS__
  */
 declare function dbxFirebaseModelEntityWidgetInjectionConfigFactory(injector?: Maybe<Injector>): DbxFirebaseModelEntitiesWidgetInjectionConfigFactory;
 
@@ -3553,7 +3570,42 @@ declare class DbxFirebaseCollectionListDirective<T> {
 }
 
 /**
- * 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>
+ * ```
  */
 declare class DbxFirebaseCollectionChangeDirective<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>, S extends DbxFirebaseCollectionStore<T, D> = DbxFirebaseCollectionStore<T, D>> implements DbxFirebaseCollectionChangeWatcher<S> {
     readonly dbxFirebaseCollectionStoreDirective: DbxFirebaseCollectionStoreDirective<T, D, S>;
@@ -3621,6 +3673,7 @@ type DbxFirebaseCollectionStoreCreateFunction<I, O extends OnCallCreateModelResu
  * @param store
  * @param fn
  * @returns
+ * @__NO_SIDE_EFFECTS__
  */
 declare function firebaseCollectionStoreCreateFunction<I, O extends OnCallCreateModelResult = OnCallCreateModelResult>(store: DbxFirebaseCollectionStore<any, any>, fn: ModelFirebaseCreateFunction<I, O>): DbxFirebaseCollectionStoreCreateFunction<I, O>;
 type DbxFirebaseCollectionStoreCrudFunction<I, O = void> = (input: I) => Observable<LoadingState<O>>;
@@ -3629,6 +3682,7 @@ type DbxFirebaseCollectionStoreCrudFunction<I, O = void> = (input: I) => Observa
  *
  * @param fn
  * @returns
+ * @__NO_SIDE_EFFECTS__
  */
 declare function firebaseCollectionStoreCrudFunction<I, O = void>(fn: ModelFirebaseCrudFunction<I, O>): DbxFirebaseCollectionStoreCrudFunction<I, O>;
 
@@ -3747,6 +3801,7 @@ type DbxFirebaseDocumentStoreCreateFunction<I, O extends OnCallCreateModelResult
  * @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__
  */
 declare function firebaseDocumentStoreCreateFunction<I, O extends OnCallCreateModelResult = OnCallCreateModelResult>(store: DbxFirebaseDocumentStore<any, any>, fn: ModelFirebaseCreateFunction<I, O>, config?: FirebaseDocumentStoreFunctionConfig<I, O>): DbxFirebaseDocumentStoreCreateFunction<I, O>;
 type DbxFirebaseDocumentStoreCrudFunction<I, O = void> = (input: I) => Observable<LoadingState<O>>;
@@ -3755,6 +3810,7 @@ type DbxFirebaseDocumentStoreCrudFunction<I, O = void> = (input: I) => Observabl
  *
  * @param fn
  * @returns
+ * @__NO_SIDE_EFFECTS__
  */
 declare function firebaseDocumentStoreCrudFunction<I, O = void>(fn: ModelFirebaseCrudFunction<I, O>): DbxFirebaseDocumentStoreCrudFunction<I, O>;
 /**
@@ -3776,6 +3832,7 @@ type DbxFirebaseDocumentStoreFunction<I extends DbxFirebaseDocumentStoreFunction
  * @param store
  * @param fn
  * @returns
+ * @__NO_SIDE_EFFECTS__
  */
 declare function firebaseDocumentStoreReadFunction<I extends DbxFirebaseDocumentStoreFunctionParams, O>(store: DbxFirebaseDocumentStore<any, any>, fn: ModelFirebaseReadFunction<I, O>): DbxFirebaseDocumentStoreFunction<I, O>;
 /**
@@ -3787,6 +3844,7 @@ declare function firebaseDocumentStoreReadFunction<I extends DbxFirebaseDocument
  * @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__
  */
 declare function firebaseDocumentStoreUpdateFunction<I extends DbxFirebaseDocumentStoreFunctionParams, O = void>(store: DbxFirebaseDocumentStore<any, any>, fn: ModelFirebaseUpdateFunction<I, O>, config?: FirebaseDocumentStoreFunctionConfig<DbxFirebaseDocumentStoreFunctionParamsInput<I>, O>): DbxFirebaseDocumentStoreFunction<I, O>;
 /**
@@ -3797,6 +3855,7 @@ declare function firebaseDocumentStoreUpdateFunction<I extends DbxFirebaseDocume
  * @param store
  * @param fn
  * @returns
+ * @__NO_SIDE_EFFECTS__
  */
 declare function firebaseDocumentStoreDeleteFunction<I extends DbxFirebaseDocumentStoreFunctionParams, O = void>(store: DbxFirebaseDocumentStore<any, any>, fn: ModelFirebaseDeleteFunction<I, O>): DbxFirebaseDocumentStoreFunction<I, O>;
 
@@ -5241,12 +5300,14 @@ declare class DbxFirebaseStorageFileUploadModule {
  *
  * @param storageAccessorFactory - The factory used to create prefixed storage accessors.
  * @returns A StorageAccessor scoped to the storage file download cache.
+ * @__NO_SIDE_EFFECTS__
  */
 declare function defaultDbxFirebaseStorageFileDownloadStorageAccessorFactory(storageAccessorFactory: SimpleStorageAccessorFactory): StorageAccessor<DbxFirebaseStorageFileDownloadUserCache>;
 /**
  * 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__
  */
 declare function provideDbxFirebaseStorageFileService(): EnvironmentProviders;
 
@@ -5350,6 +5411,7 @@ type DbxFirebaseStorageContextConfigFactory = (app: FirebaseApp, injector: Injec
  *
  * @param base Optional base configuration to use.
  * @returns Factory function for the DbxFirebaseStorageContext.
+ * @__NO_SIDE_EFFECTS__
  */
 declare function dbxFirebaseStorageProvidersContextConfigFactory(base?: FirebaseStorageContextFactoryConfig): DbxFirebaseStorageContextConfigFactory;
 /**