@dereekb/dbx-firebase 13.2.2 → 13.3.0

package/fesm2022/dereekb-dbx-firebase.mjs

@@ -461,6 +461,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
  */
 const DBX_FIREBASE_LOGIN_TERMS_OF_SERVICE_URLS_CONFIG = new InjectionToken('DBX_FIREBASE_LOGIN_TERMS_OF_SERVICE_URLS_CONFIG');
 
+/** Default terms of service display component with links to Terms and Privacy Policy URLs. */
 class DbxFirebaseLoginTermsSimpleComponent {
     dbxFirebaseLoginTermsConfig = inject(DBX_FIREBASE_LOGIN_TERMS_OF_SERVICE_URLS_CONFIG);
     tosAnchor = {
@@ -495,6 +496,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }] });
 
+/** Default password config requiring a minimum of 6 characters (Firebase Auth minimum). */
 const DEFAULT_FIREBASE_AUTH_LOGIN_PASSWORD_CONFIG = {
     minLength: 6
 };
@@ -613,7 +615,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             type: Injectable
         }], ctorParameters: () => [] });
 
+/** Category for built-in login methods (email, phone, anonymous). */
 const DEFAULT_FIREBASE_LOGIN_METHOD_CATEGORY = 'default';
+/** Category for OAuth-based login methods (Google, Facebook, etc.). */
 const OAUTH_FIREBASE_LOGIN_METHOD_CATEGORY = 'oauth';
 
 /**
@@ -623,7 +627,9 @@ class DbxFirebaseLoginContext extends DbxInjectionContext {
 }
 
 /**
- * Login button and action.
+ * Renders a styled login button that triggers a login action handler on click.
+ *
+ * Displays a logo image or icon alongside the login text with configurable colors.
  */
 class DbxFirebaseLoginButtonComponent {
     config = model(null, ...(ngDevMode ? [{ debugName: "config" }] : []));
@@ -696,6 +702,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                     changeDetection: ChangeDetectionStrategy.OnPush
                 }]
         }], propDecorators: { config: [{ type: i0.Input, args: [{ isSignal: true, alias: "config", required: false }] }, { type: i0.Output, args: ["configChange"] }] } });
+/** Container component that wraps login button content with consistent spacing. */
 class DbxFirebaseLoginButtonContainerComponent {
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.0", ngImport: i0, type: DbxFirebaseLoginButtonContainerComponent, deps: [], target: i0.ɵɵFactoryTarget.Component });
     static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "21.2.0", type: DbxFirebaseLoginButtonContainerComponent, isStandalone: true, selector: "dbx-firebase-login-button-container", ngImport: i0, template: `
@@ -716,16 +723,22 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                     standalone: true
                 }]
         }] });
+/** Default template for configured login button components. */
 const DEFAULT_CONFIGURED_DBX_FIREBASE_LOGIN_BUTTON_TEMPLATE = `
   <dbx-firebase-login-button-container>
     <dbx-firebase-login-button [config]="configSignal()"></dbx-firebase-login-button>
   </dbx-firebase-login-button-container>
 `;
+/** Shared component configuration for OAuth-style login button components. */
 const DBX_CONFIGURED_DBX_FIREBASE_LOGIN_BUTTON_COMPONENT_CONFIGURATION = {
     template: DEFAULT_CONFIGURED_DBX_FIREBASE_LOGIN_BUTTON_TEMPLATE,
     imports: [DbxFirebaseLoginButtonComponent, DbxFirebaseLoginButtonContainerComponent],
     changeDetection: ChangeDetectionStrategy.OnPush
 };
+/**
+ * Abstract base directive for login provider buttons that auto-configures appearance
+ * from the registered provider assets and delegates login handling to subclasses.
+ */
 class AbstractConfiguredDbxFirebaseLoginButtonDirective {
     dbxFirebaseAuthService = inject(DbxFirebaseAuthService);
     dbxFirebaseAuthLoginService = inject(DbxFirebaseAuthLoginService);
@@ -760,6 +773,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             type: Directive
         }] });
 
+/** Login button component for anonymous (guest) authentication. */
 class DbxFirebaseLoginAnonymousComponent extends AbstractConfiguredDbxFirebaseLoginButtonDirective {
     loginProvider = 'anonymous';
     handleLogin() {
@@ -779,6 +793,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }] });
 
+/** Formly-based form component for password recovery, containing a single email field. */
 class DbxFirebaseEmailRecoveryFormComponent extends AbstractSyncFormlyFormDirective {
     fields = [emailField({ required: true })];
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.0", ngImport: i0, type: DbxFirebaseEmailRecoveryFormComponent, deps: null, target: i0.ɵɵFactoryTarget.Component });
@@ -796,6 +811,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }] });
 
+/**
+ * Formly-based email/password login form that adapts fields based on login vs. register mode.
+ *
+ * In register mode, includes a password verification field.
+ */
 class DbxFirebaseEmailFormComponent extends AbstractConfigAsyncFormlyFormDirective {
     fields$ = this.currentConfig$.pipe(map((config) => {
         const loginMode = config?.loginMode ?? 'login';
@@ -818,6 +838,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }] });
 
+/**
+ * Full email login/registration flow component with login form, password recovery, and recovery confirmation states.
+ *
+ * Opened via the {@link DbxFirebaseLoginContext} injection context from the email login button.
+ */
 class DbxFirebaseLoginEmailContentComponent {
     dbxFirebaseAuthService = inject(DbxFirebaseAuthService);
     config = inject(DBX_INJECTION_COMPONENT_DATA);
@@ -906,6 +931,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             args: [{ imports: [NgTemplateOutlet, DbxErrorComponent, DbxLinkComponent, DbxActionErrorDirective, DbxActionFormDirective, MatButtonModule, DbxActionModule, DbxButtonComponent, DbxButtonSpacerDirective, DbxFirebaseEmailFormComponent, DbxFirebaseEmailRecoveryFormComponent, DbxFormSourceDirective], changeDetection: ChangeDetectionStrategy.OnPush, standalone: true, template: "<div class=\"dbx-firebase-login-email-content\">\n  @switch (emailModeSignal()) {\n    @case ('login') {\n      <ng-container *ngTemplateOutlet=\"loginView\"></ng-container>\n    }\n    @case ('recover') {\n      <ng-container *ngTemplateOutlet=\"resetPassword\"></ng-container>\n    }\n    @case ('recoversent') {\n      <ng-container *ngTemplateOutlet=\"resetPasswordSent\"></ng-container>\n    }\n  }\n</div>\n\n<!-- Login View -->\n<ng-template #loginView>\n  <ng-container dbxAction [dbxActionHandler]=\"handleLoginAction\">\n    <dbx-firebase-email-form [config]=\"formConfig\" dbxActionForm [dbxFormSource]=\"emailFormValueSignal()\"></dbx-firebase-email-form>\n    @if (isLoginMode) {\n      <div class=\"dbx-firebase-login-email-forgot-prompt\">\n        <dbx-link [anchor]=\"forgotAnchor\">Forgot Password?</dbx-link>\n      </div>\n    }\n    <div class=\"dbx-flex\">\n      <dbx-button class=\"dbx-button-wide\" [text]=\"buttonText\" [raised]=\"true\" color=\"primary\" dbxActionButton></dbx-button>\n      <dbx-button-spacer></dbx-button-spacer>\n      <span class=\"dbx-spacer\"></span>\n      <button mat-flat-button (click)=\"onCancel()\">Cancel</button>\n    </div>\n    <dbx-error dbxActionError></dbx-error>\n  </ng-container>\n</ng-template>\n\n<!-- Reset Password View -->\n<ng-template #resetPassword>\n  <div class=\"dbx-firebase-login-email-content-recovery\" dbxAction [dbxActionHandler]=\"handleRecoveryAction\" [dbxActionSuccessHandler]=\"handleRecoverySuccess\">\n    <dbx-firebase-email-recovery-form dbxActionForm [dbxFormSource]=\"recoveryFormValueSignal()\"></dbx-firebase-email-recovery-form>\n    <p class=\"dbx-hint\">An email will be sent to the above address to help you reset your password.</p>\n    <div class=\"dbx-flex\">\n      <dbx-button class=\"dbx-button-wide\" text=\"Send Recovery Email\" [raised]=\"true\" color=\"primary\" dbxActionButton></dbx-button>\n      <span class=\"dbx-spacer\"></span>\n      <button mat-flat-button (click)=\"onCancelReset()\">Cancel Recovery</button>\n    </div>\n    <dbx-error dbxActionError></dbx-error>\n  </div>\n</ng-template>\n\n<!-- Reset Password Sent -->\n<ng-template #resetPasswordSent>\n  <div class=\"dbx-firebase-login-email-content-recovery-sent\">\n    <p class=\"dbx-hint\">A recovery email was sent to the specified address. Please check your email for next steps.</p>\n    <button mat-raised-button (click)=\"clickedRecoveryAcknowledged()\">Ok</button>\n  </div>\n</ng-template>\n" }]
         }] });
 
+/** Login button component for email/password authentication. Opens the email login context on click. */
 class DbxFirebaseLoginEmailComponent extends AbstractConfiguredDbxFirebaseLoginButtonDirective {
     loginProvider = 'email';
     handleLogin() {
@@ -925,6 +951,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }] });
 
+/** Login button component for Facebook OAuth authentication. */
 class DbxFirebaseLoginFacebookComponent extends AbstractConfiguredDbxFirebaseLoginButtonDirective {
     loginProvider = 'facebook';
     handleLogin() {
@@ -944,6 +971,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }] });
 
+/** Login button component for GitHub OAuth authentication. */
 class DbxFirebaseLoginGitHubComponent extends AbstractConfiguredDbxFirebaseLoginButtonDirective {
     loginProvider = 'github';
     handleLogin() {
@@ -963,6 +991,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }] });
 
+/** Login button component for Google OAuth authentication. */
 class DbxFirebaseLoginGoogleComponent extends AbstractConfiguredDbxFirebaseLoginButtonDirective {
     loginProvider = 'google';
     handleLogin() {
@@ -982,6 +1011,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }] });
 
+/** Login button component for Twitter OAuth authentication. */
 class DbxFirebaseLoginTwitterComponent extends AbstractConfiguredDbxFirebaseLoginButtonDirective {
     loginProvider = 'twitter';
     handleLogin() {
@@ -1001,6 +1031,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }] });
 
+/** Registration button component for email/password. Opens the email login context in register mode. */
 class DbxFirebaseRegisterEmailComponent extends AbstractConfiguredDbxFirebaseLoginButtonDirective {
     loginProvider = 'email';
     handleLogin() {
@@ -1168,6 +1199,7 @@ function provideDbxFirebaseLogin(config) {
     return makeEnvironmentProviders(providers);
 }
 
+/** Login button component for Apple OAuth authentication. */
 class DbxFirebaseLoginAppleComponent extends AbstractConfiguredDbxFirebaseLoginButtonDirective {
     loginProvider = 'apple';
     handleLogin() {
@@ -1188,7 +1220,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
         }] });
 
 /**
- * Pre-configured login component that displays all configured login types.
+ * Renders a list of login provider buttons, filtered by enabled types and categories.
+ *
+ * Switches between login and registration component classes based on the current login mode.
  */
 class DbxFirebaseLoginListComponent {
     dbxFirebaseAuthLoginService = inject(DbxFirebaseAuthLoginService);
@@ -1254,7 +1288,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
         }], propDecorators: { loginMode: [{ type: i0.Input, args: [{ isSignal: true, alias: "loginMode", required: false }] }], providerTypes: [{ type: i0.Input, args: [{ isSignal: true, alias: "providerTypes", required: false }] }], omitProviderTypes: [{ type: i0.Input, args: [{ isSignal: true, alias: "omitProviderTypes", required: false }] }], providerCategories: [{ type: i0.Input, args: [{ isSignal: true, alias: "providerCategories", required: false }] }] } });
 
 /**
- * DbxFirebaseLoginContext implementation.
+ * Directive providing a {@link DbxFirebaseLoginContext} for login component injection.
+ *
+ * Apply to a host element to establish a login context scope for child login components.
  */
 class DbxFirebaseLoginContextDirective extends AbstractForwardDbxInjectionContextDirective {
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.0", ngImport: i0, type: DbxFirebaseLoginContextDirective, deps: null, target: i0.ɵɵFactoryTarget.Directive });
@@ -1313,6 +1349,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }], propDecorators: { loginMode: [{ type: i0.Input, args: [{ isSignal: true, alias: "loginMode", required: false }] }], providerTypes: [{ type: i0.Input, args: [{ isSignal: true, alias: "providerTypes", required: false }] }], omitProviderTypes: [{ type: i0.Input, args: [{ isSignal: true, alias: "omitProviderTypes", required: false }] }], providerCategories: [{ type: i0.Input, args: [{ isSignal: true, alias: "providerCategories", required: false }] }] } });
 
+/** Navigation component that allows users to return to the login method selection list. */
 class DbxFirebaseLoginContextBackButtonComponent {
     cancelLogin = output();
     anchor = {
@@ -1335,6 +1372,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }], propDecorators: { cancelLogin: [{ type: i0.Output, args: ["cancelLogin"] }] } });
 
+/** Login button component for Microsoft OAuth authentication. */
 class DbxFirebaseLoginMicrosoftComponent extends AbstractConfiguredDbxFirebaseLoginButtonDirective {
     loginProvider = 'microsoft';
     handleLogin() {
@@ -1354,6 +1392,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }] });
 
+/** Renders the configured terms of service component via dynamic injection from the login service. */
 class DbxFirebaseLoginTermsComponent {
     dbxFirebaseAuthLoginService = inject(DbxFirebaseAuthLoginService);
     config = {
@@ -3369,6 +3408,10 @@ function dbxFirebaseModelEntityWidgetInjectionConfigFactory(injector) {
     };
 }
 
+/**
+ * Renders a single model entity as an expansion panel with display info, widget injection,
+ * and loading state from the entity's document store.
+ */
 class DbxFirebaseModelEntitiesEntityComponent {
     widgetInjectionConfigFactory = dbxFirebaseModelEntityWidgetInjectionConfigFactory();
     entitiesWidgetService = inject(DbxFirebaseModelEntitiesWidgetService);
@@ -3431,6 +3474,12 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             args: [{ selector: 'dbx-firebase-model-entities-entity', imports: [DbxInjectionComponent, DbxLoadingComponent, MatExpansionPanel, MatExpansionPanelHeader, MatExpansionPanelTitle, MatExpansionPanelContent, MatIcon], changeDetection: ChangeDetectionStrategy.OnPush, standalone: true, template: "<mat-expansion-panel>\n  <mat-expansion-panel-header>\n    <mat-panel-title>\n      @if (displayInfoSignal(); as displayInfo) {\n        <div class=\"dbx-list-two-line-item\">\n          <div class=\"item-left\">\n            <span class=\"dbx-pb2 dbx-flex-bar\">\n              @if (displayInfo.icon) {\n                <mat-icon class=\"dbx-button-spacer\">{{ displayInfo.icon }}</mat-icon>\n              }\n              <span>{{ displayInfo.title }}</span>\n            </span>\n            <span>\n              <span class=\"dbx-hint dbx-small\">{{ modelTypeSignal() }}</span>\n              @if (displayNameSignal(); as displayName) {\n                <span class=\"dbx-small dbx-u dbx-pl2\">{{ displayName }}</span>\n              }\n            </span>\n          </div>\n        </div>\n      }\n    </mat-panel-title>\n  </mat-expansion-panel-header>\n  <ng-template matExpansionPanelContent>\n    <div class=\"dbx-firebase-model-entities-entity-panel-content\">\n      <dbx-loading [context]=\"loadingContext\">\n        @if (entityWidgetConfigSignal(); as config) {\n          <div class=\"dbx-pb3 dbx-firebase-model-entities-entity-content\">\n            <dbx-injection [config]=\"config\"></dbx-injection>\n          </div>\n        }\n        @if (commonWidgetConfigSignal(); as config) {\n          <div class=\"dbx-pb3 dbx-firebase-model-entities-common-content\">\n            <dbx-injection [config]=\"config\"></dbx-injection>\n          </div>\n        }\n        @if (debugWidgetConfigSignal(); as config) {\n          <div class=\"dbx-pb3 dbx-firebase-model-entities-debug-content\">\n            <dbx-injection [config]=\"config\"></dbx-injection>\n          </div>\n        }\n      </dbx-loading>\n    </div>\n  </ng-template>\n</mat-expansion-panel>\n" }]
         }], propDecorators: { entity: [{ type: i0.Input, args: [{ isSignal: true, alias: "entity", required: true }] }] } });
 
+/**
+ * Renders a list of model entities as an expandable accordion.
+ *
+ * Groups entities by registration status (registered vs unregistered) and sorts
+ * by widget priority. Supports toggling visibility of unregistered entity types.
+ */
 class DbxFirebaseModelEntitiesComponent {
     entitiesWidgetService = inject(DbxFirebaseModelEntitiesWidgetService);
     /**
@@ -3541,6 +3590,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
         }], propDecorators: { multi: [{ type: i0.Input, args: [{ isSignal: true, alias: "multi", required: false }] }], onlyShowRegisteredTypes: [{ type: i0.Input, args: [{ isSignal: true, alias: "onlyShowRegisteredTypes", required: false }] }], entities: [{ type: i0.Input, args: [{ isSignal: true, alias: "entities", required: false }] }] } });
 
 const DEFAULT_DBX_FIREBASE_MODEL_ENTITIES_COMPONENT_POPOVER_KEY = 'entities';
+/** Popover component that displays model entities in a scrollable panel with configurable header and empty text. */
 class DbxFirebaseModelEntitiesPopoverComponent extends AbstractPopoverDirective {
     entities$ = this.popover.data?.entities$;
     static openPopover(popupService, config, popoverKey) {
@@ -3578,6 +3628,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             args: [{ imports: [DbxPopoverContentComponent, DbxPopoverHeaderComponent, DbxPopoverScrollContentDirective, DbxFirebaseModelEntitiesComponent], changeDetection: ChangeDetectionStrategy.OnPush, standalone: true, template: "<dbx-popover-content>\n  <!-- Header -->\n  <dbx-popover-header [icon]=\"icon\" [header]=\"header\"></dbx-popover-header>\n  <!-- Content -->\n  <dbx-popover-scroll-content>\n    <dbx-firebase-model-entities [entities]=\"entities$\" [onlyShowRegisteredTypes]=\"onlyShowRegisteredTypes\">\n      <p empty>{{ emptyText }}</p>\n    </dbx-firebase-model-entities>\n  </dbx-popover-scroll-content>\n</dbx-popover-content>\n" }]
         }] });
 
+/** Button component that opens an entities popover showing model entities from the injected source. */
 class DbxFirebaseModelEntitiesPopoverButtonComponent extends AbstractPopoverRefDirective {
     _dbxPopoverService = inject(DbxPopoverService);
     entitiesSource = inject(DbxFirebaseModelEntitiesSource);
@@ -3720,6 +3771,10 @@ function removeStore(state, store) {
     return nextState;
 }
 
+/**
+ * Factory that creates a {@link DbxFirebaseModelEntitiesSource} from a {@link DbxFirebaseDocumentStoreContextStore},
+ * mapping its entries into model entities grouped by identity.
+ */
 const dbxFirebaseDocumentStoreContextModelEntitiesSourceFactory = (storeContextStore) => {
     const entities$ = storeContextStore.entriesGroupedByIdentity$.pipe(map((entries) => entries.map((entry) => ({ store: entry.store, modelIdentity: entry.modelIdentity }))));
     const source = {
@@ -3727,6 +3782,7 @@ const dbxFirebaseDocumentStoreContextModelEntitiesSourceFactory = (storeContextS
     };
     return source;
 };
+/** Directive that provides a {@link DbxFirebaseModelEntitiesSource} from the current document store context. */
 class DbxFirebaseDocumentStoreContextModelEntitiesSourceDirective {
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.0", ngImport: i0, type: DbxFirebaseDocumentStoreContextModelEntitiesSourceDirective, deps: [], target: i0.ɵɵFactoryTarget.Directive });
     static ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "21.2.0", type: DbxFirebaseDocumentStoreContextModelEntitiesSourceDirective, isStandalone: true, selector: "[dbxFirebaseDocumentStoreContextModelEntitiesSource]", providers: [
@@ -3803,7 +3859,7 @@ class DbxFirebaseModelKeyComponent {
     sref$ = this.modelTypeInstance$.pipe(switchMap((x) => x?.segueRef$ ?? of(undefined)));
     srefSignal = toSignal(this.sref$);
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.0", ngImport: i0, type: DbxFirebaseModelKeyComponent, deps: [], target: i0.ɵɵFactoryTarget.Component });
-    static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "17.0.0", version: "21.2.0", type: DbxFirebaseModelKeyComponent, isStandalone: true, selector: "dbx-firebase-model-key", inputs: { modelKey: { classPropertyName: "modelKey", publicName: "modelKey", isSignal: true, isRequired: false, transformFunction: null } }, ngImport: i0, template: "<div class=\"dbx-firebase-model-key\">\n  @if (modelKey(); as key) {\n    <!-- Key Data -->\n    <dbx-detail-block icon=\"key\" header=\"Model Key\">\n      <dbx-click-to-copy-text [highlighted]=\"true\" class=\"dbx-block\">{{ key }}</dbx-click-to-copy-text>\n      <dbx-click-to-copy-text [highlighted]=\"true\" class=\"dbx-block\">{{ modelKeyIdSignal() }}</dbx-click-to-copy-text>\n      <dbx-click-to-copy-text [highlighted]=\"true\" class=\"dbx-block\" [copyText]=\"oneWayFlatModelKeySignal()\">(Flat) {{ oneWayFlatModelKeySignal() }}</dbx-click-to-copy-text>\n      <dbx-click-to-copy-text [highlighted]=\"true\" class=\"dbx-block\" [copyText]=\"twoWayFlatModelKeySignal()\">(Encoded Flat) {{ twoWayFlatModelKeySignal() }}</dbx-click-to-copy-text>\n    </dbx-detail-block>\n\n    <!-- Type Info -->\n    @if (typeInfoSignal(); as typeInfo) {\n      <!-- Model Meta Data -->\n      <div>\n        <dbx-detail-block [icon]=\"typeInfo.icon\" header=\"Model Type\">\n          <dbx-click-to-copy-text class=\"dbx-block\">{{ typeInfo.modelType }}</dbx-click-to-copy-text>\n          @if (typeInfo.icon) {\n            <dbx-click-to-copy-text [copyText]=\"typeInfo.icon\" class=\"dbx-block\">\n              Icon:\n              <span class=\"dbx-u\">{{ typeInfo.icon }}</span>\n            </dbx-click-to-copy-text>\n          } @else {\n            <span class=\"dbx-notice\">No Icon For Type</span>\n          }\n        </dbx-detail-block>\n        <dbx-detail-block icon=\"dataset\" header=\"Collection Name\">\n          <dbx-click-to-copy-text class=\"dbx-block\">{{ typeInfo.identity.collectionName }}</dbx-click-to-copy-text>\n        </dbx-detail-block>\n      </div>\n\n      <!-- Segue Info -->\n      @if (typeCanSegueToView()) {\n        <dbx-detail-block icon=\"arrow_forward\" header=\"Segue To View\">\n          <div class=\"dbx-hint dbx-small\">This model has a unique view within the app.</div>\n          <dbx-anchor [anchor]=\"srefSignal()\"><dbx-button text=\"Go To View\"></dbx-button></dbx-anchor>\n        </dbx-detail-block>\n      } @else {\n        <dbx-detail-block class=\"dbx-warn\" icon=\"warning\" header=\"No Segue View\">\n          <span>This type provides no information for segue directly.</span>\n        </dbx-detail-block>\n      }\n    } @else {\n      <dbx-detail-block class=\"dbx-warn\" icon=\"warning\" header=\"No Type Info\">\n        <span>There is no type info registered for this model type.</span>\n      </dbx-detail-block>\n    }\n  } @else {\n    <div class=\"dbx-firebase-model-key-empty\">No model key provided</div>\n  }\n</div>\n", dependencies: [{ kind: "component", type: DbxDetailBlockComponent, selector: "dbx-detail-block", inputs: ["icon", "header", "alignHeader", "bigHeader"] }, { kind: "component", type: DbxButtonComponent, selector: "dbx-button", inputs: ["bar", "type", "buttonStyle", "color", "spinnerColor", "customButtonColor", "customTextColor", "customSpinnerColor", "basic", "tonal", "raised", "stroked", "flat", "iconOnly", "fab", "mode"] }, { kind: "component", type: DbxClickToCopyTextComponent, selector: "dbx-click-to-copy-text", inputs: ["copyText", "highlighted", "clipboardSnackbarMessagesConfig", "clipboardSnackbarMessagesEnabled", "clickToCopyIcon", "clickIconToCopyOnly"] }, { kind: "component", type: DbxAnchorComponent, selector: "dbx-anchor, [dbx-anchor]", inputs: ["block"] }] });
+    static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "17.0.0", version: "21.2.0", type: DbxFirebaseModelKeyComponent, isStandalone: true, selector: "dbx-firebase-model-key", inputs: { modelKey: { classPropertyName: "modelKey", publicName: "modelKey", isSignal: true, isRequired: false, transformFunction: null } }, ngImport: i0, template: "<div class=\"dbx-firebase-model-key\">\n  @if (modelKey(); as key) {\n    <!-- Key Data -->\n    <dbx-detail-block icon=\"key\" header=\"Model Key\">\n      <dbx-click-to-copy-text [highlighted]=\"true\" class=\"dbx-block\">{{ key }}</dbx-click-to-copy-text>\n      <dbx-click-to-copy-text [highlighted]=\"true\" class=\"dbx-block\">{{ modelKeyIdSignal() }}</dbx-click-to-copy-text>\n      <dbx-click-to-copy-text [highlighted]=\"true\" class=\"dbx-block\" [copyText]=\"oneWayFlatModelKeySignal()\">(Flat) {{ oneWayFlatModelKeySignal() }}</dbx-click-to-copy-text>\n      <dbx-click-to-copy-text [highlighted]=\"true\" class=\"dbx-block\" [copyText]=\"twoWayFlatModelKeySignal()\">(Encoded Flat) {{ twoWayFlatModelKeySignal() }}</dbx-click-to-copy-text>\n    </dbx-detail-block>\n\n    <!-- Type Info -->\n    @if (typeInfoSignal(); as typeInfo) {\n      <!-- Model Meta Data -->\n      <div>\n        <dbx-detail-block [icon]=\"typeInfo.icon\" header=\"Model Type\">\n          <dbx-click-to-copy-text class=\"dbx-block\">{{ typeInfo.modelType }}</dbx-click-to-copy-text>\n          @if (typeInfo.icon) {\n            <dbx-click-to-copy-text [copyText]=\"typeInfo.icon\" class=\"dbx-block\">\n              Icon:\n              <span class=\"dbx-u\">{{ typeInfo.icon }}</span>\n            </dbx-click-to-copy-text>\n          } @else {\n            <span class=\"dbx-notice\">No Icon For Type</span>\n          }\n        </dbx-detail-block>\n        <dbx-detail-block icon=\"dataset\" header=\"Collection Name\">\n          <dbx-click-to-copy-text class=\"dbx-block\">{{ typeInfo.identity.collectionName }}</dbx-click-to-copy-text>\n        </dbx-detail-block>\n      </div>\n\n      <!-- Segue Info -->\n      @if (typeCanSegueToView()) {\n        <dbx-detail-block icon=\"arrow_forward\" header=\"Segue To View\">\n          <div class=\"dbx-hint dbx-small\">This model has a unique view within the app.</div>\n          <dbx-anchor [anchor]=\"srefSignal()\"><dbx-button text=\"Go To View\"></dbx-button></dbx-anchor>\n        </dbx-detail-block>\n      } @else {\n        <dbx-detail-block class=\"dbx-warn\" icon=\"warning\" header=\"No Segue View\">\n          <span>This type provides no information for segue directly.</span>\n        </dbx-detail-block>\n      }\n    } @else {\n      <dbx-detail-block class=\"dbx-warn\" icon=\"warning\" header=\"No Type Info\">\n        <span>There is no type info registered for this model type.</span>\n      </dbx-detail-block>\n    }\n  } @else {\n    <div class=\"dbx-firebase-model-key-empty\">No model key provided</div>\n  }\n</div>\n", dependencies: [{ kind: "component", type: DbxDetailBlockComponent, selector: "dbx-detail-block", inputs: ["icon", "header", "alignHeader", "bigHeader"] }, { kind: "component", type: DbxButtonComponent, selector: "dbx-button", inputs: ["bar", "type", "buttonStyle", "color", "spinnerColor", "customButtonColor", "customTextColor", "customSpinnerColor", "basic", "tonal", "raised", "stroked", "flat", "iconOnly", "fab", "mode"] }, { kind: "component", type: DbxClickToCopyTextComponent, selector: "dbx-click-to-copy-text", inputs: ["copyText", "showIcon", "highlighted", "clipboardSnackbarMessagesConfig", "clipboardSnackbarMessagesEnabled", "clickToCopyIcon", "clickIconToCopyOnly"] }, { kind: "component", type: DbxAnchorComponent, selector: "dbx-anchor, [dbx-anchor]", inputs: ["block"] }] });
 }
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImport: i0, type: DbxFirebaseModelKeyComponent, decorators: [{
             type: Component,
@@ -4565,15 +4621,17 @@ AbstractRootSingleItemDbxFirebaseDocument = __decorate([
  *
  * @param store
  * @param fn
+ * @param config - Optional config with an `onResult` callback.
  * @returns
  */
-function firebaseDocumentStoreCreateFunction(store, fn) {
+function firebaseDocumentStoreCreateFunction(store, fn, config) {
     return (params) => loadingStateFromObs(lazyFrom(() => fn(params).then((result) => {
         const modelKeys = result.modelKeys;
         const firstKey = firstValue(modelKeys);
         if (firstKey) {
             store.setKey(firstKey);
         }
+        config?.onResult?.(params, result);
         return result;
     })));
 }
@@ -4611,10 +4669,13 @@ function firebaseDocumentStoreReadFunction(store, fn) {
  * @param fn
  * @returns
  */
-function firebaseDocumentStoreUpdateFunction(store, fn) {
+function firebaseDocumentStoreUpdateFunction(store, fn, config) {
     return (params) => loadingStateFromObs(store.key$.pipe(first(), exhaustMap((key) => fn({
         ...params,
         key // inject key into the parameters.
+    }).then((result) => {
+        config?.onResult?.(params, result);
+        return result;
     })), shareReplay(1)));
 }
 // MARK: Delete
@@ -4875,6 +4936,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }] });
 
+/** Collection store for querying SystemState documents. */
 class SystemStateCollectionStore extends AbstractDbxFirebaseCollectionStore {
     constructor() {
         super({ firestoreCollection: inject(SystemStateFirestoreCollections).systemStateCollection });
@@ -4886,6 +4948,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             type: Injectable
         }], ctorParameters: () => [] });
 
+/** Directive providing a {@link SystemStateCollectionStore} for querying system state documents. */
 class DbxFirebaseSystemStateCollectionStoreDirective extends DbxFirebaseCollectionStoreDirective {
     constructor() {
         super(inject(SystemStateCollectionStore));
@@ -4901,6 +4964,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }], ctorParameters: () => [] });
 
+/** Document store for a single typed SystemState document. */
 class SystemStateDocumentStore extends AbstractDbxFirebaseDocumentStore {
     constructor() {
         super({ firestoreCollection: inject(SystemStateFirestoreCollections).systemStateCollection });
@@ -4938,6 +5002,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                     type: Optional
                 }] }] });
 
+/** Directive providing a {@link SystemStateDocumentStore} for accessing a single system state document. */
 class DbxFirebaseSystemStateDocumentStoreDirective extends DbxFirebaseDocumentStoreDirective {
     constructor() {
         super(inject((SystemStateDocumentStore)));
@@ -4990,6 +5055,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             type: Injectable
         }] });
 
+/** Selection list wrapper for notification items with view-only default selection mode. */
 class DbxFirebaseNotificationItemListComponent extends AbstractDbxSelectionListWrapperDirective {
     constructor() {
         super({
@@ -5011,6 +5077,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                     standalone: true
                 }]
         }], ctorParameters: () => [] });
+/** List view component that renders notification items using the selection list pattern. */
 class DbxFirebaseNotificationItemListViewComponent extends AbstractDbxSelectionListViewDirective {
     config = {
         componentClass: DbxFirebaseNotificationItemListViewItemComponent,
@@ -5030,6 +5097,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                     standalone: true
                 }]
         }] });
+/** Individual list view item component rendering a notification's subject, message, and date. */
 class DbxFirebaseNotificationItemListViewItemComponent extends AbstractDbxValueListViewItemComponent {
     dbxFirebaseNotificationTemplateService = inject(DbxFirebaseNotificationTemplateService);
     pairGetter = cachedGetter(() => this.dbxFirebaseNotificationTemplateService.notificationItemSubjectMessagePairForNotificationSummaryItem(this.itemValue));
@@ -5071,6 +5139,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }] });
 
+/** Presentational component for notification item content, displaying subject, message, and date. */
 class DbxFirebaseNotificationItemContentComponent {
     subject = input(...(ngDevMode ? [undefined, { debugName: "subject" }] : []));
     message = input(...(ngDevMode ? [undefined, { debugName: "message" }] : []));
@@ -5144,6 +5213,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             type: Injectable
         }] });
 
+/**
+ * Renders a notification item using the widget system, resolving the appropriate
+ * display component based on the notification's template type.
+ */
 class DbxFirebaseNotificationItemViewComponent {
     item = input(...(ngDevMode ? [undefined, { debugName: "item" }] : []));
     configSignal = computed(() => {
@@ -5177,6 +5250,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }], propDecorators: { item: [{ type: i0.Input, args: [{ isSignal: true, alias: "item", required: false }] }] } });
 
+/**
+ * Abstract base directive for notification item widget display components.
+ *
+ * Provides typed access to the {@link NotificationItem} data for custom rendering.
+ */
 class AbstractDbxFirebaseNotificationItemWidgetComponent extends AbstractDbxWidgetComponent {
     get notificationItem() {
         return this.data;
@@ -5188,6 +5266,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             type: Directive
         }] });
 
+/** Default notification item view component that renders subject, message, and creation date. */
 class DbxFirebaseNotificationItemDefaultViewComponent extends AbstractDbxFirebaseNotificationItemWidgetComponent {
     get subject() {
         return this.notificationItem.s;
@@ -5309,6 +5388,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }], propDecorators: { buttonElement: [{ type: i0.ViewChild, args: ['button', { ...{ read: ElementRef }, isSignal: true }] }], config: [{ type: i0.Input, args: [{ isSignal: true, alias: "config", required: false }] }] } });
 
+/** Document store for a single NotificationBox, providing derived observables for creation date, recipients, and update functions. */
 class NotificationBoxDocumentStore extends AbstractDbxFirebaseDocumentStore {
     notificationFunctions = inject(NotificationFunctions);
     constructor() {
@@ -5325,6 +5405,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             type: Injectable
         }], ctorParameters: () => [] });
 
+/** Document store for a single Notification, providing derived observables for creation date, send state, and update functions. */
 class NotificationDocumentStore extends AbstractDbxFirebaseDocumentWithParentStore {
     notificationFunctions = inject(NotificationFunctions);
     constructor() {
@@ -5347,6 +5428,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             type: Injectable
         }], ctorParameters: () => [] });
 
+/** Directive providing a {@link NotificationDocumentStore} for accessing a single notification document. */
 class DbxFirebaseNotificationDocumentStoreDirective extends DbxFirebaseDocumentStoreDirective {
     constructor() {
         super(inject(NotificationDocumentStore));
@@ -5363,6 +5445,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }], ctorParameters: () => [] });
 
+/** Collection store for Notification documents, scoped to a parent NotificationBox when available. */
 class NotificationCollectionStore extends AbstractDbxFirebaseCollectionWithParentStore {
     constructor() {
         super({ collectionFactory: inject(NotificationFirestoreCollections).notificationCollectionFactory, collectionGroup: inject(NotificationFirestoreCollections).notificationCollectionGroup });
@@ -5378,6 +5461,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             type: Injectable
         }], ctorParameters: () => [] });
 
+/** Directive providing a {@link NotificationCollectionStore} for querying notifications within a template. */
 class DbxFirebaseNotificationCollectionStoreDirective extends DbxFirebaseCollectionWithParentStoreDirective {
     constructor() {
         super(inject(NotificationCollectionStore));
@@ -5394,6 +5478,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }], ctorParameters: () => [] });
 
+/** Directive providing a {@link NotificationBoxDocumentStore} for accessing a single notification box document. */
 class DbxFirebaseNotificationBoxDocumentStoreDirective extends DbxFirebaseDocumentStoreDirective {
     constructor() {
         super(inject(NotificationBoxDocumentStore));
@@ -5410,6 +5495,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }], ctorParameters: () => [] });
 
+/** Collection store for querying NotificationBox documents. */
 class NotificationBoxCollectionStore extends AbstractDbxFirebaseCollectionStore {
     constructor() {
         super({ firestoreCollection: inject(NotificationFirestoreCollections).notificationBoxCollection });
@@ -5421,6 +5507,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             type: Injectable
         }], ctorParameters: () => [] });
 
+/** Directive providing a {@link NotificationBoxCollectionStore} for querying notification boxes. */
 class DbxFirebaseNotificationBoxCollectionStoreDirective extends DbxFirebaseCollectionStoreDirective {
     constructor() {
         super(inject(NotificationBoxCollectionStore));
@@ -5437,6 +5524,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }], ctorParameters: () => [] });
 
+/** Collection store for querying NotificationSummary documents. */
 class NotificationSummaryCollectionStore extends AbstractDbxFirebaseCollectionStore {
     constructor() {
         super({ firestoreCollection: inject(NotificationFirestoreCollections).notificationSummaryCollection });
@@ -5448,6 +5536,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             type: Injectable
         }], ctorParameters: () => [] });
 
+/** Directive providing a {@link NotificationSummaryCollectionStore} for querying notification summaries. */
 class DbxFirebaseNotificationSummaryCollectionStoreDirective extends DbxFirebaseCollectionStoreDirective {
     constructor() {
         super(inject(NotificationSummaryCollectionStore));
@@ -5464,6 +5553,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }], ctorParameters: () => [] });
 
+/** Document store for a single NotificationSummary, providing derived observables for items, timestamps, sync state, and update functions. */
 class NotificationSummaryDocumentStore extends AbstractDbxFirebaseDocumentStore {
     notificationFunctions = inject(NotificationFunctions);
     constructor() {
@@ -5491,6 +5581,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             type: Injectable
         }], ctorParameters: () => [] });
 
+/** Directive providing a {@link NotificationSummaryDocumentStore} for accessing a single notification summary. */
 class DbxFirebaseNotificationSummaryDocumentStoreDirective extends DbxFirebaseDocumentStoreDirective {
     constructor() {
         super(inject(NotificationSummaryDocumentStore));
@@ -5507,6 +5598,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }], ctorParameters: () => [] });
 
+/** Collection store for querying NotificationUser documents. */
 class NotificationUserCollectionStore extends AbstractDbxFirebaseCollectionStore {
     constructor() {
         super({ firestoreCollection: inject(NotificationFirestoreCollections).notificationUserCollection });
@@ -5518,6 +5610,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             type: Injectable
         }], ctorParameters: () => [] });
 
+/** Directive providing a {@link NotificationUserCollectionStore} for querying notification user documents. */
 class DbxFirebaseNotificationUserCollectionStoreDirective extends DbxFirebaseCollectionStoreDirective {
     constructor() {
         super(inject(NotificationUserCollectionStore));
@@ -5534,6 +5627,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }], ctorParameters: () => [] });
 
+/** Document store for a single NotificationUser with update and resync functions. */
 class NotificationUserDocumentStore extends AbstractDbxFirebaseDocumentStore {
     notificationFunctions = inject(NotificationFunctions);
     constructor() {
@@ -5548,6 +5642,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             type: Injectable
         }], ctorParameters: () => [] });
 
+/** Directive providing a {@link NotificationUserDocumentStore} for accessing a single notification user document. */
 class DbxFirebaseNotificationUserDocumentStoreDirective extends DbxFirebaseDocumentStoreDirective {
     constructor() {
         super(inject(NotificationUserDocumentStore));
@@ -6822,6 +6917,16 @@ function provideDbxFirebaseStorageFileService() {
     return makeEnvironmentProviders(providers);
 }
 
+/**
+ * Angular pipe that flattens a Firestore model key path into a single string identifier.
+ *
+ * Returns an empty string for null/undefined input.
+ *
+ * @example
+ * ```html
+ * <span>{{ document.key | flatFirestoreModelKey }}</span>
+ * ```
+ */
 class FlatFirestoreModelKeyPipe {
     transform(input) {
         if (input != null) {
@@ -6839,6 +6944,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             args: [{ name: 'flatFirestoreModelKey', standalone: true }]
         }] });
 
+/**
+ * Angular pipe that converts a Firestore model key to a two-way flat key format,
+ * enabling reversible encoding/decoding of the full path.
+ *
+ * Returns an empty string for null/undefined input.
+ *
+ * @example
+ * ```html
+ * <span>{{ document.key | twoWayFlatFirestoreModelKey }}</span>
+ * ```
+ */
 class TwoWayFlatFirestoreModelKeyPipe {
     transform(input) {
         if (input != null) {