@dereekb/dbx-firebase 13.4.0 → 13.4.2

package/fesm2022/dereekb-dbx-firebase-oidc.mjs

@@ -269,9 +269,13 @@ const DEFAULT_OIDC_TOKEN_ENDPOINT_AUTH_METHODS = ['client_secret_post', 'client_
  * Apps provide a concrete implementation via `provideDbxFirebaseOidc()`.
  */
 class DbxFirebaseOidcConfig {
-    /** Path to the authorization endpoint. Defaults to '/oidc/auth'. */
+    /**
+     * Path to the authorization endpoint. Defaults to '/oidc/auth'.
+     */
     oidcAuthorizationEndpointApiPath;
-    /** Base path for interaction endpoints. Defaults to '/interaction'. */
+    /**
+     * Base path for interaction endpoints. Defaults to '/interaction'.
+     */
     oidcInteractionEndpointApiPath;
     /**
      * Supported token endpoint authentication methods.
@@ -347,7 +351,7 @@ class DbxFirebaseOAuthConsentScopeDefaultViewComponent extends AbstractDbxFireba
         return [
             ...knownScopes.map((name) => {
                 const details = availableScopes.find((s) => s.value === name);
-                return { name, description: details.description ?? '' };
+                return { name, description: details?.description ?? '' };
             }),
             ...unknownScopes.map((name) => ({ name, description: 'unknown' }))
         ];
@@ -394,6 +398,8 @@ class DbxFirebaseOidcInteractionService {
     _oidcConfig = inject(DbxFirebaseOidcConfigService);
     /**
      * Base URL for the interaction API, derived from the OIDC config service.
+     *
+     * @returns The base URL string for the OIDC interaction endpoint.
      */
     get baseUrl() {
         return this._oidcConfig.oidcInteractionEndpointApiPath;
@@ -403,6 +409,7 @@ 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) {
@@ -413,6 +420,8 @@ 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, approved) {
@@ -632,6 +641,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
  * 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.
  */
 function oidcEntryClientFormFields(config) {
     const fields = [];
@@ -641,6 +653,12 @@ function oidcEntryClientFormFields(config) {
     fields.push(...oidcEntryClientUpdateFormFields());
     return fields;
 }
+/**
+ * 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.
+ */
 function oidcClientTokenEndpointAuthMethodField(config) {
     const allowedAuthMethods = config?.tokenEndpointAuthMethods;
     const options = allowedAuthMethods?.length ? ALL_OIDC_TOKEN_ENDPOINT_AUTH_METHOD_OPTIONS.filter((o) => allowedAuthMethods.includes(o.value)) : ALL_OIDC_TOKEN_ENDPOINT_AUTH_METHOD_OPTIONS;
@@ -656,10 +674,17 @@ function oidcClientTokenEndpointAuthMethodField(config) {
  * 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.
  */
 function oidcEntryClientUpdateFormFields() {
     return [oidcClientNameField(), oidcClientRedirectUrisField(), oidcClientJwksUriField(), oidcClientLogoUriField(), oidcClientHomepageUriField()];
 }
+/**
+ * Creates a text field for the OAuth client display name.
+ *
+ * @returns A FormlyFieldConfig for the client name input.
+ */
 function oidcClientNameField() {
     return textField({
         key: 'client_name',
@@ -669,6 +694,11 @@ function oidcClientNameField() {
         maxLength: 200
     });
 }
+/**
+ * Creates a searchable chip field for entering redirect URIs.
+ *
+ * @returns A FormlyFieldConfig for the redirect URIs input.
+ */
 function oidcClientRedirectUrisField() {
     return searchableStringChipField({
         key: 'redirect_uris',
@@ -681,6 +711,11 @@ function oidcClientRedirectUrisField() {
         displayForValue: (values) => of(values.map((v) => ({ ...v, label: v.value })))
     });
 }
+/**
+ * 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.
+ */
 function oidcClientJwksUriField() {
     return textField({
         key: 'jwks_uri',
@@ -692,6 +727,11 @@ function oidcClientJwksUriField() {
         }
     });
 }
+/**
+ * Creates a text field for the optional client logo URL.
+ *
+ * @returns A FormlyFieldConfig for the logo URI input.
+ */
 function oidcClientLogoUriField() {
     return textField({
         key: 'logo_uri',
@@ -700,6 +740,11 @@ function oidcClientLogoUriField() {
         required: false
     });
 }
+/**
+ * Creates a text field for the optional client homepage URL.
+ *
+ * @returns A FormlyFieldConfig for the homepage URL input.
+ */
 function oidcClientHomepageUriField() {
     return textField({
         key: 'client_uri',
@@ -710,10 +755,18 @@ function oidcClientHomepageUriField() {
 }
 /**
  * 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.
  */
 function oidcEntryClientTestFormFields(config) {
     return [oidcClientTestClientIdField(), oidcClientTestRedirectUriField(config.redirectUris), oidcClientTestScopesField(config.availableScopes)];
 }
+/**
+ * Creates a read-only text field displaying the OAuth client ID.
+ *
+ * @returns A FormlyFieldConfig for the client ID display.
+ */
 function oidcClientTestClientIdField() {
     return textField({
         key: 'client_id',
@@ -721,6 +774,12 @@ function oidcClientTestClientIdField() {
         readonly: true
     });
 }
+/**
+ * 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.
+ */
 function oidcClientTestRedirectUriField(redirectUris) {
     const options = redirectUris.map((uri) => ({ label: uri, value: uri }));
     return valueSelectionField({
@@ -731,6 +790,12 @@ function oidcClientTestRedirectUriField(redirectUris) {
         options
     });
 }
+/**
+ * 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.
+ */
 function oidcClientTestScopesField(availableScopes) {
     return pickableItemChipField({
         key: 'scopes',
@@ -835,11 +900,11 @@ class DbxFirebaseOidcEntryClientListViewItemClientComponent {
     entry = input.required(...(ngDevMode ? [{ debugName: "entry" }] : []));
     get name() {
         const payload = this.entry().payload;
-        return payload?.['client_name'] || 'OAuth Client';
+        return payload?.client_name || 'OAuth Client';
     }
     get clientId() {
         const payload = this.entry().payload;
-        return payload?.['client_id'] || '';
+        return payload?.client_id || '';
     }
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.0", ngImport: i0, type: DbxFirebaseOidcEntryClientListViewItemClientComponent, deps: [], target: i0.ɵɵFactoryTarget.Component });
     static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "17.1.0", version: "21.2.0", type: DbxFirebaseOidcEntryClientListViewItemClientComponent, isStandalone: true, selector: "dbx-firebase-oidc-client-list-view-item-client", inputs: { entry: { classPropertyName: "entry", publicName: "entry", isSignal: true, isRequired: true, transformFunction: null } }, ngImport: i0, template: `
@@ -915,7 +980,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }] });
 
-/** Document store for a single {@link OidcEntry}. */
+/**
+ * Document store for a single {@link OidcEntry}.
+ */
 class OidcEntryDocumentStore extends AbstractDbxFirebaseDocumentStore {
     oidcModelFunctions = inject(OidcModelFunctions);
     _latestClientSecret$ = completeOnDestroy(new BehaviorSubject(undefined));
@@ -1033,9 +1100,13 @@ function base64UrlEncode(bytes) {
 class DbxFirebaseOidcEntryClientTestComponent {
     oidcEntryDocumentStore = inject(OidcEntryDocumentStore);
     oidcConfigService = inject(DbxFirebaseOidcConfigService);
-    /** Scopes the user can pick from. Overrides the service default when provided. */
+    /**
+     * Scopes the user can pick from. Overrides the service default when provided.
+     */
     availableScopes = input(undefined, ...(ngDevMode ? [{ debugName: "availableScopes" }] : []));
-    /** Path to the authorization endpoint. Overrides the service default when provided. */
+    /**
+     * Path to the authorization endpoint. Overrides the service default when provided.
+     */
     oidcAuthorizationEndpointApiPath = input(undefined, ...(ngDevMode ? [{ debugName: "oidcAuthorizationEndpointApiPath" }] : []));
     resolvedAvailableScopes = computed(() => this.availableScopes() ?? this.oidcConfigService.availableScopes, ...(ngDevMode ? [{ debugName: "resolvedAvailableScopes" }] : []));
     resolvedAuthorizationEndpointPath = computed(() => this.oidcAuthorizationEndpointApiPath() ?? this.oidcConfigService.oidcAuthorizationEndpointApiPath, ...(ngDevMode ? [{ debugName: "resolvedAuthorizationEndpointPath" }] : []));
@@ -1065,7 +1136,9 @@ class DbxFirebaseOidcEntryClientTestComponent {
     codeChallenge = signal('', ...(ngDevMode ? [{ debugName: "codeChallenge" }] : []));
     state = signal(generateRandomString(), ...(ngDevMode ? [{ debugName: "state" }] : []));
     nonce = signal(generateRandomString(), ...(ngDevMode ? [{ debugName: "nonce" }] : []));
-    /** The current form value, updated by the form via dbxFormValueChange. */
+    /**
+     * The current form value, updated by the form via dbxFormValueChange.
+     */
     formValue = signal(undefined, ...(ngDevMode ? [{ debugName: "formValue" }] : []));
     authorizationUrlSignal = computed(() => {
         const clientId = this.clientIdSignal();
@@ -1107,7 +1180,7 @@ class DbxFirebaseOidcEntryClientTestComponent {
         this._updateCodeChallenge();
     }
     _updateCodeChallenge() {
-        generatePkceCodeChallenge(this.codeVerifier()).then((challenge) => {
+        void generatePkceCodeChallenge(this.codeVerifier()).then((challenge) => {
             this.codeChallenge.set(challenge);
         });
     }
@@ -1286,7 +1359,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }] });
 
-/** Collection store for querying {@link OidcEntry} documents. */
+/**
+ * Collection store for querying {@link OidcEntry} documents.
+ */
 class OidcEntryCollectionStore extends AbstractDbxFirebaseCollectionStore {
     constructor() {
         super({ firestoreCollection: inject(OidcModelFirestoreCollections).oidcEntryCollection });
@@ -1298,7 +1373,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
             type: Injectable
         }], ctorParameters: () => [] });
 
-/** Directive providing a {@link OidcEntryCollectionStore} for querying {@link OidcEntry} documents. */
+/**
+ * Directive providing a {@link OidcEntryCollectionStore} for querying {@link OidcEntry} documents.
+ */
 class OidcEntryCollectionStoreDirective extends DbxFirebaseCollectionStoreDirective {
     constructor() {
         super(inject(OidcEntryCollectionStore));
@@ -1315,7 +1392,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                 }]
         }], ctorParameters: () => [] });
 
-/** Directive providing a {@link OidcEntryDocumentStore} for accessing a single {@link OidcEntry} document. */
+/**
+ * Directive providing a {@link OidcEntryDocumentStore} for accessing a single {@link OidcEntry} document.
+ */
 class OidcEntryDocumentStoreDirective extends DbxFirebaseDocumentStoreDirective {
     constructor() {
         super(inject(OidcEntryDocumentStore));
@@ -1334,6 +1413,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
 
 /**
  * Provider factory for the {@link OidcModelFirestoreCollections}.
+ *
+ * @param appCollection - The application's Firestore collection that must implement {@link OidcModelFirestoreCollections}.
+ * @returns The validated OidcModelFirestoreCollections instance.
  */
 function provideOidcModelFirestoreCollections(appCollection) {
     if (!appCollection.oidcEntryCollection) {
@@ -1347,6 +1429,9 @@ function provideOidcModelFirestoreCollections(appCollection) {
  * 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.
  */
 function provideDbxFirebaseOidc(config) {
     const providers = [{ provide: DbxFirebaseOidcConfig, useValue: config.oidcConfig }, DbxFirebaseOidcConfigService];