@dereekb/dbx-firebase 13.4.0 → 13.4.2

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "@dereekb/dbx-firebase",
-  "version": "13.4.0",
+  "version": "13.4.2",
   "peerDependencies": {
     "@angular/common": "^21.0.0",
     "@angular/core": "^21.0.0",
     "@angular/fire": "21.0.0-rc.0-canary.ac3dd7c",
     "@angular/material": "^21.0.0",
-    "@dereekb/date": "13.4.0",
-    "@dereekb/dbx-analytics": "13.4.0",
-    "@dereekb/dbx-core": "13.4.0",
-    "@dereekb/dbx-form": "13.4.0",
-    "@dereekb/dbx-web": "13.4.0",
-    "@dereekb/firebase": "13.4.0",
-    "@dereekb/model": "13.4.0",
-    "@dereekb/rxjs": "13.4.0",
-    "@dereekb/util": "13.4.0",
+    "@dereekb/date": "13.4.2",
+    "@dereekb/dbx-analytics": "13.4.2",
+    "@dereekb/dbx-core": "13.4.2",
+    "@dereekb/dbx-form": "13.4.2",
+    "@dereekb/dbx-web": "13.4.2",
+    "@dereekb/firebase": "13.4.2",
+    "@dereekb/model": "13.4.2",
+    "@dereekb/rxjs": "13.4.2",
+    "@dereekb/util": "13.4.2",
     "@ngrx/component-store": "^21.0.0",
     "@ngx-formly/core": "git+https://git@github.com/dereekb/ngx-formly#996d1041c8d2afbe429985a5ad394e59327bfa1d",
     "firebase": "^12.0.0",

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

@@ -240,19 +240,55 @@ interface OidcEntryClientFormFieldsConfig {
  * Creates fields for the OAuth client create form.
  *
  * Includes `token_endpoint_auth_method` which is immutable after creation.
+ *
+ * @param config - Optional configuration for field generation, including mode and allowed auth methods.
+ * @returns Array of FormlyFieldConfig for the client creation form.
  */
 declare function oidcEntryClientFormFields(config?: OidcEntryClientFormFieldsConfig): FormlyFieldConfig[];
+/**
+ * Creates a value selection field for choosing the token endpoint authentication method.
+ *
+ * @param config - Optional configuration to filter the available auth method options.
+ * @returns A FormlyFieldConfig for the token endpoint auth method selector.
+ */
 declare function oidcClientTokenEndpointAuthMethodField(config?: OidcEntryClientFormFieldsConfig): FormlyFieldConfig;
 /**
  * Creates fields for updating an existing OAuth client.
  *
  * Excludes `token_endpoint_auth_method` (immutable after creation).
+ *
+ * @returns Array of FormlyFieldConfig for the client update form.
  */
 declare function oidcEntryClientUpdateFormFields(): FormlyFieldConfig[];
+/**
+ * Creates a text field for the OAuth client display name.
+ *
+ * @returns A FormlyFieldConfig for the client name input.
+ */
 declare function oidcClientNameField(): FormlyFieldConfig;
+/**
+ * Creates a searchable chip field for entering redirect URIs.
+ *
+ * @returns A FormlyFieldConfig for the redirect URIs input.
+ */
 declare function oidcClientRedirectUrisField(): FormlyFieldConfig;
+/**
+ * Creates a text field for the client's JWKS URI. Only visible when using private_key_jwt authentication.
+ *
+ * @returns A FormlyFieldConfig for the JWKS URI input.
+ */
 declare function oidcClientJwksUriField(): FormlyFieldConfig;
+/**
+ * Creates a text field for the optional client logo URL.
+ *
+ * @returns A FormlyFieldConfig for the logo URI input.
+ */
 declare function oidcClientLogoUriField(): FormlyFieldConfig;
+/**
+ * Creates a text field for the optional client homepage URL.
+ *
+ * @returns A FormlyFieldConfig for the homepage URL input.
+ */
 declare function oidcClientHomepageUriField(): FormlyFieldConfig;
 interface OidcEntryClientTestFormFieldsConfig {
     readonly redirectUris: OidcRedirectUri[];
@@ -260,10 +296,30 @@ interface OidcEntryClientTestFormFieldsConfig {
 }
 /**
  * Assembles the form fields for the OAuth test client form.
+ *
+ * @param config - Configuration providing available redirect URIs and scopes for the test form.
+ * @returns Array of FormlyFieldConfig for the test client form.
  */
 declare function oidcEntryClientTestFormFields(config: OidcEntryClientTestFormFieldsConfig): FormlyFieldConfig[];
+/**
+ * Creates a read-only text field displaying the OAuth client ID.
+ *
+ * @returns A FormlyFieldConfig for the client ID display.
+ */
 declare function oidcClientTestClientIdField(): FormlyFieldConfig;
+/**
+ * Creates a selection field for choosing one of the client's registered redirect URIs for testing.
+ *
+ * @param redirectUris - The registered redirect URIs to display as options.
+ * @returns A FormlyFieldConfig for the redirect URI selector.
+ */
 declare function oidcClientTestRedirectUriField(redirectUris: OidcRedirectUri[]): FormlyFieldConfig;
+/**
+ * Creates a pickable chip field for selecting scopes to request during the test flow.
+ *
+ * @param availableScopes - The available scopes to display as selectable options.
+ * @returns A FormlyFieldConfig for the scopes selector.
+ */
 declare function oidcClientTestScopesField(availableScopes: OidcScopeDetails[]): FormlyFieldConfig;
 
 type DbxFirebaseOidcModelClientFormValue = CreateOidcClientParams;
@@ -339,7 +395,9 @@ declare class DbxFirebaseOidcEntryClientListViewItemComponent extends AbstractDb
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<DbxFirebaseOidcEntryClientListViewItemComponent, "ng-component", never, {}, {}, never, never, true, never>;
 }
 
-/** Document store for a single {@link OidcEntry}. */
+/**
+ * Document store for a single {@link OidcEntry}.
+ */
 declare class OidcEntryDocumentStore extends AbstractDbxFirebaseDocumentStore<OidcEntry, OidcEntryDocument> {
     readonly oidcModelFunctions: OidcModelFunctions;
     private readonly _latestClientSecret$;
@@ -384,9 +442,13 @@ declare class DbxFirebaseOidcEntryClientCreateComponent {
 declare class DbxFirebaseOidcEntryClientTestComponent {
     private readonly oidcEntryDocumentStore;
     private readonly oidcConfigService;
-    /** Scopes the user can pick from. Overrides the service default when provided. */
+    /**
+     * Scopes the user can pick from. Overrides the service default when provided.
+     */
     readonly availableScopes: _angular_core.InputSignal<Maybe<OidcScopeDetails[]>>;
-    /** Path to the authorization endpoint. Overrides the service default when provided. */
+    /**
+     * Path to the authorization endpoint. Overrides the service default when provided.
+     */
     readonly oidcAuthorizationEndpointApiPath: _angular_core.InputSignal<Maybe<string>>;
     readonly resolvedAvailableScopes: _angular_core.Signal<OidcScopeDetails[]>;
     readonly resolvedAuthorizationEndpointPath: _angular_core.Signal<string>;
@@ -398,7 +460,9 @@ declare class DbxFirebaseOidcEntryClientTestComponent {
     readonly codeChallenge: _angular_core.WritableSignal<string>;
     readonly state: _angular_core.WritableSignal<string>;
     readonly nonce: _angular_core.WritableSignal<string>;
-    /** The current form value, updated by the form via dbxFormValueChange. */
+    /**
+     * The current form value, updated by the form via dbxFormValueChange.
+     */
     readonly formValue: _angular_core.WritableSignal<Maybe<DbxFirebaseOidcModelClientTestFormValue>>;
     readonly authorizationUrlSignal: _angular_core.Signal<string | undefined>;
     constructor();
@@ -440,21 +504,27 @@ declare class DbxFirebaseOidcEntryClientViewComponent {
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<DbxFirebaseOidcEntryClientViewComponent, "dbx-firebase-oidc-entry-client-view", never, {}, {}, never, never, true, never>;
 }
 
-/** Collection store for querying {@link OidcEntry} documents. */
+/**
+ * Collection store for querying {@link OidcEntry} documents.
+ */
 declare class OidcEntryCollectionStore extends AbstractDbxFirebaseCollectionStore<OidcEntry, OidcEntryDocument> {
     constructor();
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<OidcEntryCollectionStore, never>;
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<OidcEntryCollectionStore>;
 }
 
-/** Directive providing a {@link OidcEntryCollectionStore} for querying {@link OidcEntry} documents. */
+/**
+ * Directive providing a {@link OidcEntryCollectionStore} for querying {@link OidcEntry} documents.
+ */
 declare class OidcEntryCollectionStoreDirective extends DbxFirebaseCollectionStoreDirective<OidcEntry, OidcEntryDocument, OidcEntryCollectionStore> {
     constructor();
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<OidcEntryCollectionStoreDirective, never>;
     static ɵdir: _angular_core.ɵɵDirectiveDeclaration<OidcEntryCollectionStoreDirective, "[dbxOidcEntryCollection]", never, {}, {}, never, never, true, never>;
 }
 
-/** Directive providing a {@link OidcEntryDocumentStore} for accessing a single {@link OidcEntry} document. */
+/**
+ * Directive providing a {@link OidcEntryDocumentStore} for accessing a single {@link OidcEntry} document.
+ */
 declare class OidcEntryDocumentStoreDirective extends DbxFirebaseDocumentStoreDirective<OidcEntry, OidcEntryDocument, OidcEntryDocumentStore> {
     constructor();
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<OidcEntryDocumentStoreDirective, never>;
@@ -490,11 +560,17 @@ declare const DEFAULT_OIDC_TOKEN_ENDPOINT_AUTH_METHODS: OidcTokenEndpointAuthMet
  * Apps provide a concrete implementation via `provideDbxFirebaseOidc()`.
  */
 declare abstract class DbxFirebaseOidcConfig {
-    /** Available scopes for the OIDC provider. Used in scope picker fields. */
+    /**
+     * Available scopes for the OIDC provider. Used in scope picker fields.
+     */
     abstract readonly availableScopes: OidcScopeDetails[];
-    /** Path to the authorization endpoint. Defaults to '/oidc/auth'. */
+    /**
+     * Path to the authorization endpoint. Defaults to '/oidc/auth'.
+     */
     readonly oidcAuthorizationEndpointApiPath?: Maybe<string>;
-    /** Base path for interaction endpoints. Defaults to '/interaction'. */
+    /**
+     * Base path for interaction endpoints. Defaults to '/interaction'.
+     */
     readonly oidcInteractionEndpointApiPath?: Maybe<string>;
     /**
      * Supported token endpoint authentication methods.
@@ -541,6 +617,9 @@ declare class DbxFirebaseOidcConfigService {
 
 /**
  * Provider factory for the {@link OidcModelFirestoreCollections}.
+ *
+ * @param appCollection - The application's Firestore collection that must implement {@link OidcModelFirestoreCollections}.
+ * @returns The validated OidcModelFirestoreCollections instance.
  */
 declare function provideOidcModelFirestoreCollections(appCollection: OidcModelFirestoreCollections): OidcModelFirestoreCollections;
 /**
@@ -572,6 +651,9 @@ interface ProvideDbxFirebaseOidcConfig {
  * When `oauthInteractionRoute` is configured in {@link DbxFirebaseOidcConfig}, an app initializer
  * is registered that adds that route to the {@link DbxAppAuthRouterService} ignored routes set,
  * preventing auth effects from redirecting away during the OIDC interaction flow.
+ *
+ * @param config - Configuration specifying the app collection class, OIDC settings, and provider options.
+ * @returns EnvironmentProviders for the OIDC module.
  */
 declare function provideDbxFirebaseOidc(config: ProvideDbxFirebaseOidcConfig): EnvironmentProviders;
 
@@ -590,6 +672,8 @@ declare class DbxFirebaseOidcInteractionService {
     private readonly _oidcConfig;
     /**
      * Base URL for the interaction API, derived from the OIDC config service.
+     *
+     * @returns The base URL string for the OIDC interaction endpoint.
      */
     get baseUrl(): string;
     /**
@@ -597,6 +681,7 @@ declare class DbxFirebaseOidcInteractionService {
      *
      * Automatically attaches the current user's Firebase ID token.
      *
+     * @param uid - The OIDC interaction UID identifying the current login interaction.
      * @returns Observable that emits the redirect URL from the server response.
      */
     submitLogin(uid: OidcInteractionUid): Observable<OAuthInteractionLoginResponse>;
@@ -605,6 +690,8 @@ declare class DbxFirebaseOidcInteractionService {
      *
      * Automatically attaches the current user's Firebase ID token.
      *
+     * @param uid - The OIDC interaction UID identifying the current consent interaction.
+     * @param approved - Whether the user approved or denied the consent request.
      * @returns Observable that emits the redirect URL from the server response.
      */
     submitConsent(uid: OidcInteractionUid, approved: boolean): Observable<OAuthInteractionConsentResponse>;