@firebase/app-check 0.6.5 → 0.7.0-canary.5a2ceb07b

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @firebase/app-check
 
+## 0.7.0
+
+### Minor Changes
+
+- [`195e82ebb`](https://github.com/firebase/firebase-js-sdk/commit/195e82ebba29d501892cf9269ecee74eec9df220) [#7169](https://github.com/firebase/firebase-js-sdk/pull/7169) - Add new limited use token method to App Check
+
 ## 0.6.5
 
 ### Patch Changes

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

@@ -102,6 +102,23 @@ export declare interface CustomProviderOptions {
     getToken: () => Promise<AppCheckToken>;
 }
 
+/**
+ * Requests a Firebase App Check token. This method should be used
+ * only if you need to authorize requests to a non-Firebase backend.
+ *
+ * Returns limited-use tokens that are intended for use with your
+ * non-Firebase backend endpoints that are protected with
+ * <a href="https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection">
+ * Replay Protection</a>. This method
+ * does not affect the token generation behavior of the
+ * #getAppCheckToken() method.
+ *
+ * @param appCheckInstance - The App Check service instance.
+ * @returns The limited use token.
+ * @public
+ */
+export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
+
 /**
  * Get the current App Check token. Attaches to the most recent
  * in-flight request if one is present. Returns null if no token

package/dist/app-check.d.ts

@@ -124,6 +124,23 @@ export declare interface CustomProviderOptions {
     getToken: () => Promise<AppCheckToken>;
 }
 
+/**
+ * Requests a Firebase App Check token. This method should be used
+ * only if you need to authorize requests to a non-Firebase backend.
+ *
+ * Returns limited-use tokens that are intended for use with your
+ * non-Firebase backend endpoints that are protected with
+ * <a href="https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection">
+ * Replay Protection</a>. This method
+ * does not affect the token generation behavior of the
+ * #getAppCheckToken() method.
+ *
+ * @param appCheckInstance - The App Check service instance.
+ * @returns The limited use token.
+ * @public
+ */
+export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
+
 /**
  * Get the current App Check token. Attaches to the most recent
  * in-flight request if one is present. Returns null if no token

package/dist/esm/index.esm.js

@@ -915,6 +915,35 @@ function getToken$2(appCheck, forceRefresh) {
         });
     });
 }
+/**
+ * Internal API for limited use tokens. Skips all FAC state and simply calls
+ * the underlying provider.
+ */
+function getLimitedUseToken$1(appCheck) {
+    return __awaiter(this, void 0, void 0, function () {
+        var app, provider, debugToken, token, token;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    app = appCheck.app;
+                    ensureActivated(app);
+                    provider = getStateReference(app).provider;
+                    if (!isDebugMode()) return [3 /*break*/, 3];
+                    return [4 /*yield*/, getDebugToken()];
+                case 1:
+                    debugToken = _a.sent();
+                    return [4 /*yield*/, exchangeToken(getExchangeDebugTokenRequest(app, debugToken), appCheck.heartbeatServiceProvider)];
+                case 2:
+                    token = (_a.sent()).token;
+                    return [2 /*return*/, { token: token }];
+                case 3: return [4 /*yield*/, provider.getToken()];
+                case 4:
+                    token = (_a.sent()).token;
+                    return [2 /*return*/, { token: token }];
+            }
+        });
+    });
+}
 function addTokenListener(appCheck, type, listener, onError) {
     var app = appCheck.app;
     var state = getStateReference(app);
@@ -1120,7 +1149,7 @@ function internalFactory(appCheck) {
 }
 
 var name = "@firebase/app-check";
-var version = "0.6.5";
+var version = "0.7.0-canary.5a2ceb07b";
 
 /**
  * @license
@@ -1717,6 +1746,24 @@ function getToken(appCheckInstance, forceRefresh) {
         });
     });
 }
+/**
+ * Requests a Firebase App Check token. This method should be used
+ * only if you need to authorize requests to a non-Firebase backend.
+ *
+ * Returns limited-use tokens that are intended for use with your
+ * non-Firebase backend endpoints that are protected with
+ * <a href="https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection">
+ * Replay Protection</a>. This method
+ * does not affect the token generation behavior of the
+ * #getAppCheckToken() method.
+ *
+ * @param appCheckInstance - The App Check service instance.
+ * @returns The limited use token.
+ * @public
+ */
+function getLimitedUseToken(appCheckInstance) {
+    return getLimitedUseToken$1(appCheckInstance);
+}
 /**
  * Wraps `addTokenListener`/`removeTokenListener` methods in an `Observer`
  * pattern for public use.
@@ -1780,5 +1827,5 @@ function registerAppCheck() {
 }
 registerAppCheck();
 
-export { CustomProvider, ReCaptchaEnterpriseProvider, ReCaptchaV3Provider, getToken, initializeAppCheck, onTokenChanged, setTokenAutoRefreshEnabled };
+export { CustomProvider, ReCaptchaEnterpriseProvider, ReCaptchaV3Provider, getLimitedUseToken, getToken, initializeAppCheck, onTokenChanged, setTokenAutoRefreshEnabled };
 //# sourceMappingURL=index.esm.js.map