@firebase/app-check 0.4.2-pr5646.6d9dd3616 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @firebase/app-check
 
+## 0.5.0
+
+### Minor Changes
+
+- [`61604979c`](https://github.com/firebase/firebase-js-sdk/commit/61604979cb35647610ea385a6ba0ca67cb03f5d1) [#5595](https://github.com/firebase/firebase-js-sdk/pull/5595) - Add ReCAPTCHA Enterprise as an attestation option for App Check.
+
+### Patch Changes
+
+- [`2322b6023`](https://github.com/firebase/firebase-js-sdk/commit/2322b6023c628cd9f4f4172767c17d215dd91684) [#5693](https://github.com/firebase/firebase-js-sdk/pull/5693) - Add exports field to all packages
+
+- Updated dependencies [[`2322b6023`](https://github.com/firebase/firebase-js-sdk/commit/2322b6023c628cd9f4f4172767c17d215dd91684)]:
+  - @firebase/component@0.5.8
+  - @firebase/logger@0.3.1
+  - @firebase/util@1.4.1
+
 ## 0.4.2
 
 ### Patch Changes

package/dist/app-check-public.d.ts

@@ -30,9 +30,9 @@ export declare interface AppCheck {
  */
 export declare interface AppCheckOptions {
     /**
-     * reCAPTCHA provider or custom provider.
+     * A reCAPTCHA V3 provider, reCAPTCHA Enterprise provider, or custom provider.
      */
-    provider: CustomProvider | ReCaptchaV3Provider;
+    provider: CustomProvider | ReCaptchaV3Provider | ReCaptchaEnterpriseProvider;
     /**
      * If set to true, enables automatic background refresh of App Check token.
      */
@@ -159,6 +159,26 @@ export declare function onTokenChanged(appCheckInstance: AppCheck, observer: Par
 export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
 export { PartialObserver }
 
+/**
+ * App Check provider that can obtain a reCAPTCHA Enterprise token and exchange it
+ * for an App Check token.
+ *
+ * @public
+ */
+export declare class ReCaptchaEnterpriseProvider implements AppCheckProvider {
+    private _siteKey;
+    private _app?;
+    private _platformLoggerProvider?;
+    /**
+     * Create a ReCaptchaEnterpriseProvider instance.
+     * @param siteKey - reCAPTCHA Enterprise score-based site key.
+     */
+    constructor(_siteKey: string);
+    /* Excluded from this release type: getToken */
+    /* Excluded from this release type: initialize */
+    /* Excluded from this release type: isEqual */
+}
+
 /**
  * App Check provider that can obtain a reCAPTCHA V3 token and exchange it
  * for an App Check token.

package/dist/app-check.d.ts

@@ -36,9 +36,9 @@ export declare type _AppCheckInternalComponentName = 'app-check-internal';
  */
 export declare interface AppCheckOptions {
     /**
-     * reCAPTCHA provider or custom provider.
+     * A reCAPTCHA V3 provider, reCAPTCHA Enterprise provider, or custom provider.
      */
-    provider: CustomProvider | ReCaptchaV3Provider;
+    provider: CustomProvider | ReCaptchaV3Provider | ReCaptchaEnterpriseProvider;
     /**
      * If set to true, enables automatic background refresh of App Check token.
      */
@@ -181,6 +181,36 @@ export declare function onTokenChanged(appCheckInstance: AppCheck, observer: Par
 export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
 export { PartialObserver }
 
+/**
+ * App Check provider that can obtain a reCAPTCHA Enterprise token and exchange it
+ * for an App Check token.
+ *
+ * @public
+ */
+export declare class ReCaptchaEnterpriseProvider implements AppCheckProvider {
+    private _siteKey;
+    private _app?;
+    private _platformLoggerProvider?;
+    /**
+     * Create a ReCaptchaEnterpriseProvider instance.
+     * @param siteKey - reCAPTCHA Enterprise score-based site key.
+     */
+    constructor(_siteKey: string);
+    /**
+     * Returns an App Check token.
+     * @internal
+     */
+    getToken(): Promise<AppCheckTokenInternal>;
+    /**
+     * @internal
+     */
+    initialize(app: FirebaseApp): void;
+    /**
+     * @internal
+     */
+    isEqual(otherProvider: unknown): boolean;
+}
+
 /**
  * App Check provider that can obtain a reCAPTCHA V3 token and exchange it
  * for an App Check token.

package/dist/esm/index.esm.js

@@ -57,6 +57,7 @@ function getDebugState() {
  */
 var BASE_ENDPOINT = 'https://content-firebaseappcheck.googleapis.com/v1beta';
 var EXCHANGE_RECAPTCHA_TOKEN_METHOD = 'exchangeRecaptchaToken';
+var EXCHANGE_RECAPTCHA_ENTERPRISE_TOKEN_METHOD = 'exchangeRecaptchaEnterpriseToken';
 var EXCHANGE_DEBUG_TOKEN_METHOD = 'exchangeDebugToken';
 var TOKEN_REFRESH_TIME = {
     /**
@@ -256,7 +257,12 @@ var ERROR_FACTORY = new ErrorFactory('appCheck', 'AppCheck', ERRORS);
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-function getRecaptcha() {
+function getRecaptcha(isEnterprise) {
+    var _a;
+    if (isEnterprise === void 0) { isEnterprise = false; }
+    if (isEnterprise) {
+        return (_a = self.grecaptcha) === null || _a === void 0 ? void 0 : _a.enterprise;
+    }
     return self.grecaptcha;
 }
 function ensureActivated(app) {
@@ -363,13 +369,21 @@ function exchangeToken(_a, platformLoggerProvider) {
         });
     });
 }
-function getExchangeRecaptchaTokenRequest(app, reCAPTCHAToken) {
+function getExchangeRecaptchaV3TokenRequest(app, reCAPTCHAToken) {
     var _a = app.options, projectId = _a.projectId, appId = _a.appId, apiKey = _a.apiKey;
     return {
         url: BASE_ENDPOINT + "/projects/" + projectId + "/apps/" + appId + ":" + EXCHANGE_RECAPTCHA_TOKEN_METHOD + "?key=" + apiKey,
         body: {
-            // eslint-disable-next-line
-            recaptcha_token: reCAPTCHAToken
+            'recaptcha_token': reCAPTCHAToken
+        }
+    };
+}
+function getExchangeRecaptchaEnterpriseTokenRequest(app, reCAPTCHAToken) {
+    var _a = app.options, projectId = _a.projectId, appId = _a.appId, apiKey = _a.apiKey;
+    return {
+        url: BASE_ENDPOINT + "/projects/" + projectId + "/apps/" + appId + ":" + EXCHANGE_RECAPTCHA_ENTERPRISE_TOKEN_METHOD + "?key=" + apiKey,
+        body: {
+            'recaptcha_enterprise_token': reCAPTCHAToken
         }
     };
 }
@@ -996,7 +1010,7 @@ function internalFactory(appCheck) {
 }
 
 var name = "@firebase/app-check";
-var version = "0.4.2-pr5646.6d9dd3616";
+var version = "0.5.0";
 
 /**
  * @license
@@ -1015,38 +1029,72 @@ var version = "0.4.2-pr5646.6d9dd3616";
  * limitations under the License.
  */
 var RECAPTCHA_URL = 'https://www.google.com/recaptcha/api.js';
-function initialize(app, siteKey) {
+var RECAPTCHA_ENTERPRISE_URL = 'https://www.google.com/recaptcha/enterprise.js';
+function initializeV3(app, siteKey) {
     var state = getState(app);
     var initialized = new Deferred();
     setState(app, __assign(__assign({}, state), { reCAPTCHAState: { initialized: initialized } }));
-    var divId = "fire_app_check_" + app.name;
-    var invisibleDiv = document.createElement('div');
-    invisibleDiv.id = divId;
-    invisibleDiv.style.display = 'none';
-    document.body.appendChild(invisibleDiv);
-    var grecaptcha = getRecaptcha();
+    var divId = makeDiv(app);
+    var grecaptcha = getRecaptcha(false);
     if (!grecaptcha) {
-        loadReCAPTCHAScript(function () {
-            var grecaptcha = getRecaptcha();
+        loadReCAPTCHAV3Script(function () {
+            var grecaptcha = getRecaptcha(false);
             if (!grecaptcha) {
                 // it shouldn't happen.
                 throw new Error('no recaptcha');
             }
-            grecaptcha.ready(function () {
-                // Invisible widgets allow us to set a different siteKey for each widget, so we use them to support multiple apps
-                renderInvisibleWidget(app, siteKey, grecaptcha, divId);
-                initialized.resolve(grecaptcha);
-            });
+            queueWidgetRender(app, siteKey, grecaptcha, divId, initialized);
         });
     }
     else {
-        grecaptcha.ready(function () {
-            renderInvisibleWidget(app, siteKey, grecaptcha, divId);
-            initialized.resolve(grecaptcha);
+        queueWidgetRender(app, siteKey, grecaptcha, divId, initialized);
+    }
+    return initialized.promise;
+}
+function initializeEnterprise(app, siteKey) {
+    var state = getState(app);
+    var initialized = new Deferred();
+    setState(app, __assign(__assign({}, state), { reCAPTCHAState: { initialized: initialized } }));
+    var divId = makeDiv(app);
+    var grecaptcha = getRecaptcha(true);
+    if (!grecaptcha) {
+        loadReCAPTCHAEnterpriseScript(function () {
+            var grecaptcha = getRecaptcha(true);
+            if (!grecaptcha) {
+                // it shouldn't happen.
+                throw new Error('no recaptcha');
+            }
+            queueWidgetRender(app, siteKey, grecaptcha, divId, initialized);
         });
     }
+    else {
+        queueWidgetRender(app, siteKey, grecaptcha, divId, initialized);
+    }
     return initialized.promise;
 }
+/**
+ * Add listener to render the widget and resolve the promise when
+ * the grecaptcha.ready() event fires.
+ */
+function queueWidgetRender(app, siteKey, grecaptcha, container, initialized) {
+    grecaptcha.ready(function () {
+        // Invisible widgets allow us to set a different siteKey for each widget,
+        // so we use them to support multiple apps
+        renderInvisibleWidget(app, siteKey, grecaptcha, container);
+        initialized.resolve(grecaptcha);
+    });
+}
+/**
+ * Add invisible div to page.
+ */
+function makeDiv(app) {
+    var divId = "fire_app_check_" + app.name;
+    var invisibleDiv = document.createElement('div');
+    invisibleDiv.id = divId;
+    invisibleDiv.style.display = 'none';
+    document.body.appendChild(invisibleDiv);
+    return divId;
+}
 function getToken$1(app) {
     return __awaiter(this, void 0, void 0, function () {
         var reCAPTCHAState, recaptcha;
@@ -1087,9 +1135,15 @@ function renderInvisibleWidget(app, siteKey, grecaptcha, container) {
     setState(app, __assign(__assign({}, state), { reCAPTCHAState: __assign(__assign({}, state.reCAPTCHAState), { // state.reCAPTCHAState is set in the initialize()
             widgetId: widgetId }) }));
 }
-function loadReCAPTCHAScript(onload) {
+function loadReCAPTCHAV3Script(onload) {
     var script = document.createElement('script');
-    script.src = "" + RECAPTCHA_URL;
+    script.src = RECAPTCHA_URL;
+    script.onload = onload;
+    document.head.appendChild(script);
+}
+function loadReCAPTCHAEnterpriseScript(onload) {
+    var script = document.createElement('script');
+    script.src = RECAPTCHA_ENTERPRISE_URL;
     script.onload = onload;
     document.head.appendChild(script);
 }
@@ -1133,22 +1187,13 @@ var ReCaptchaV3Provider = /** @class */ (function () {
             var attestedClaimsToken;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0:
-                        if (!this._app || !this._platformLoggerProvider) {
-                            // This should only occur if user has not called initializeAppCheck().
-                            // We don't have an appName to provide if so.
-                            // This should already be caught in the top level `getToken()` function.
-                            throw ERROR_FACTORY.create("use-before-activation" /* USE_BEFORE_ACTIVATION */, {
-                                appName: ''
-                            });
-                        }
-                        return [4 /*yield*/, getToken$1(this._app).catch(function (_e) {
-                                // reCaptcha.execute() throws null which is not very descriptive.
-                                throw ERROR_FACTORY.create("recaptcha-error" /* RECAPTCHA_ERROR */);
-                            })];
+                    case 0: return [4 /*yield*/, getToken$1(this._app).catch(function (_e) {
+                            // reCaptcha.execute() throws null which is not very descriptive.
+                            throw ERROR_FACTORY.create("recaptcha-error" /* RECAPTCHA_ERROR */);
+                        })];
                     case 1:
                         attestedClaimsToken = _a.sent();
-                        return [2 /*return*/, exchangeToken(getExchangeRecaptchaTokenRequest(this._app, attestedClaimsToken), this._platformLoggerProvider)];
+                        return [2 /*return*/, exchangeToken(getExchangeRecaptchaV3TokenRequest(this._app, attestedClaimsToken), this._platformLoggerProvider)];
                 }
             });
         });
@@ -1159,7 +1204,7 @@ var ReCaptchaV3Provider = /** @class */ (function () {
     ReCaptchaV3Provider.prototype.initialize = function (app) {
         this._app = app;
         this._platformLoggerProvider = _getProvider(app, 'platform-logger');
-        initialize(app, this._siteKey).catch(function () {
+        initializeV3(app, this._siteKey).catch(function () {
             /* we don't care about the initialization result */
         });
     };
@@ -1176,6 +1221,63 @@ var ReCaptchaV3Provider = /** @class */ (function () {
     };
     return ReCaptchaV3Provider;
 }());
+/**
+ * App Check provider that can obtain a reCAPTCHA Enterprise token and exchange it
+ * for an App Check token.
+ *
+ * @public
+ */
+var ReCaptchaEnterpriseProvider = /** @class */ (function () {
+    /**
+     * Create a ReCaptchaEnterpriseProvider instance.
+     * @param siteKey - reCAPTCHA Enterprise score-based site key.
+     */
+    function ReCaptchaEnterpriseProvider(_siteKey) {
+        this._siteKey = _siteKey;
+    }
+    /**
+     * Returns an App Check token.
+     * @internal
+     */
+    ReCaptchaEnterpriseProvider.prototype.getToken = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var attestedClaimsToken;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, getToken$1(this._app).catch(function (_e) {
+                            // reCaptcha.execute() throws null which is not very descriptive.
+                            throw ERROR_FACTORY.create("recaptcha-error" /* RECAPTCHA_ERROR */);
+                        })];
+                    case 1:
+                        attestedClaimsToken = _a.sent();
+                        return [2 /*return*/, exchangeToken(getExchangeRecaptchaEnterpriseTokenRequest(this._app, attestedClaimsToken), this._platformLoggerProvider)];
+                }
+            });
+        });
+    };
+    /**
+     * @internal
+     */
+    ReCaptchaEnterpriseProvider.prototype.initialize = function (app) {
+        this._app = app;
+        this._platformLoggerProvider = _getProvider(app, 'platform-logger');
+        initializeEnterprise(app, this._siteKey).catch(function () {
+            /* we don't care about the initialization result */
+        });
+    };
+    /**
+     * @internal
+     */
+    ReCaptchaEnterpriseProvider.prototype.isEqual = function (otherProvider) {
+        if (otherProvider instanceof ReCaptchaEnterpriseProvider) {
+            return this._siteKey === otherProvider._siteKey;
+        }
+        else {
+            return false;
+        }
+    };
+    return ReCaptchaEnterpriseProvider;
+}());
 /**
  * Custom provider class.
  * @public
@@ -1192,16 +1294,7 @@ var CustomProvider = /** @class */ (function () {
             var customToken, issuedAtTimeSeconds, issuedAtTimeMillis;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0:
-                        if (!this._app) {
-                            // This should only occur if user has not called initializeAppCheck().
-                            // We don't have an appName to provide if so.
-                            // This should already be caught in the top level `getToken()` function.
-                            throw ERROR_FACTORY.create("use-before-activation" /* USE_BEFORE_ACTIVATION */, {
-                                appName: ''
-                            });
-                        }
-                        return [4 /*yield*/, this._customProviderOptions.getToken()];
+                    case 0: return [4 /*yield*/, this._customProviderOptions.getToken()];
                     case 1:
                         customToken = _a.sent();
                         issuedAtTimeSeconds = issuedAtTime(customToken.token);
@@ -1436,5 +1529,5 @@ function registerAppCheck() {
 }
 registerAppCheck();
 
-export { CustomProvider, ReCaptchaV3Provider, getToken, initializeAppCheck, onTokenChanged, setTokenAutoRefreshEnabled };
+export { CustomProvider, ReCaptchaEnterpriseProvider, ReCaptchaV3Provider, getToken, initializeAppCheck, onTokenChanged, setTokenAutoRefreshEnabled };
 //# sourceMappingURL=index.esm.js.map