Rename

Author: sam-gc

packages/app-check/src/api.test.ts

@@ -22,7 +22,7 @@ import {
   initializeAppCheck,
   getToken,
   onTokenChanged,
-  getScopedToken
+  getLimitedUseToken
 } from './api';
 import {
   FAKE_SITE_KEY,
@@ -285,29 +285,29 @@ describe('api', () => {
       );
     });
   });
-  describe('getScopedToken()', () => {
-    it('getScopedToken() calls the internal getScopedToken() function', async () => {
+  describe('getLimitedUseToken()', () => {
+    it('getLimitedUseToken() calls the internal getLimitedUseToken() function', async () => {
       const app = getFakeApp({ automaticDataCollectionEnabled: true });
       const appCheck = getFakeAppCheck(app);
-      const internalGetScopedToken = stub(
+      const internalgetLimitedUseToken = stub(
         internalApi,
-        'getScopedToken'
+        'getLimitedUseToken'
       ).resolves({
         token: 'a-token-string'
       });
-      await getScopedToken(appCheck);
-      expect(internalGetScopedToken).to.be.calledWith(appCheck);
+      await getLimitedUseToken(appCheck);
+      expect(internalgetLimitedUseToken).to.be.calledWith(appCheck);
     });
-    it('getScopedToken() throws errors returned with token', async () => {
+    it('getLimitedUseToken() throws errors returned with token', async () => {
       const app = getFakeApp({ automaticDataCollectionEnabled: true });
       const appCheck = getFakeAppCheck(app);
-      // If getScopedToken() errors, it returns a dummy token with an error field
+      // If getLimitedUseToken() errors, it returns a dummy token with an error field
       // instead of throwing.
-      stub(internalApi, 'getScopedToken').resolves({
+      stub(internalApi, 'getLimitedUseToken').resolves({
         token: 'a-dummy-token',
         error: Error('there was an error')
       });
-      await expect(getScopedToken(appCheck)).to.be.rejectedWith(
+      await expect(getLimitedUseToken(appCheck)).to.be.rejectedWith(
         'there was an error'
       );
     });

packages/app-check/src/api.ts

@@ -35,7 +35,7 @@ import { AppCheckService } from './factory';
 import { AppCheckProvider, ListenerType } from './types';
 import {
   getToken as getTokenInternal,
-  getScopedToken as getScopedTokenInternal,
+  getLimitedUseToken as getLimitedUseTokenInternal,
   addTokenListener,
   removeTokenListener,
   isValid,
@@ -211,19 +211,23 @@ export async function getToken(
 }
 
 /**
- * Requests a Firebase App Check token. This method should be used ONLY if you
- * need to authorize requests to a non-Firebase backend. Tokens from this
- * method are intended for use with the Admin SDKs when `consume` is set to
- * true. Tokens from this method do not interact with FirebaseAppCheck’s token
- * cache.
+ * 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=[--URL to public docs--]>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 async function getScopedToken(
+export async function getLimitedUseToken(
   appCheckInstance: AppCheck
 ): Promise<AppCheckTokenResult> {
-  const result = await getScopedTokenInternal(
+  const result = await getLimitedUseTokenInternal(
     appCheckInstance as AppCheckService
   );
   if (result.error) {

packages/app-check/src/internal-api.test.ts

@@ -33,7 +33,7 @@ import {
   removeTokenListener,
   formatDummyToken,
   defaultTokenErrorData,
-  getScopedToken
+  getLimitedUseToken
 } from './internal-api';
 import * as reCAPTCHA from './recaptcha';
 import * as client from './client';
@@ -638,15 +638,15 @@ describe('internal api', () => {
     });
   });
 
-  describe('getScopedToken()', () => {
+  describe('getLimitedUseToken()', () => {
     it('uses customTokenProvider to get an AppCheck token', async () => {
       const customTokenProvider = getFakeCustomTokenProvider();
       const customProviderSpy = spy(customTokenProvider, 'getToken');
 
       const appCheck = initializeAppCheck(app, {
         provider: customTokenProvider
       });
-      const token = await getScopedToken(appCheck as AppCheckService);
+      const token = await getLimitedUseToken(appCheck as AppCheckService);
 
       expect(customProviderSpy).to.be.called;
       expect(token).to.deep.equal({
@@ -661,7 +661,7 @@ describe('internal api', () => {
       const appCheck = initializeAppCheck(app, {
         provider: customTokenProvider
       });
-      await getScopedToken(appCheck as AppCheckService);
+      await getLimitedUseToken(appCheck as AppCheckService);
 
       expect(getStateReference(app).token).to.be.undefined;
       expect(getStateReference(app).isTokenAutoRefreshEnabled).to.be.false;
@@ -680,7 +680,7 @@ describe('internal api', () => {
         'exchangeToken'
       ).returns(Promise.resolve(fakeRecaptchaAppCheckToken));
 
-      const token = await getScopedToken(appCheck as AppCheckService);
+      const token = await getLimitedUseToken(appCheck as AppCheckService);
 
       expect(reCAPTCHASpy).to.be.called;
 
@@ -703,7 +703,7 @@ describe('internal api', () => {
         'exchangeToken'
       ).returns(Promise.resolve(fakeRecaptchaAppCheckToken));
 
-      const token = await getScopedToken(appCheck as AppCheckService);
+      const token = await getLimitedUseToken(appCheck as AppCheckService);
 
       expect(reCAPTCHASpy).to.be.called;
 
@@ -726,7 +726,7 @@ describe('internal api', () => {
       const error = new Error('oops, something went wrong');
       stub(client, 'exchangeToken').returns(Promise.reject(error));
 
-      const token = await getScopedToken(appCheck as AppCheckService);
+      const token = await getLimitedUseToken(appCheck as AppCheckService);
 
       expect(reCAPTCHASpy).to.be.called;
       expect(token).to.deep.equal({
@@ -752,7 +752,7 @@ describe('internal api', () => {
         provider: new ReCaptchaV3Provider(FAKE_SITE_KEY)
       });
 
-      const token = await getScopedToken(appCheck as AppCheckService);
+      const token = await getLimitedUseToken(appCheck as AppCheckService);
       expect(exchangeTokenStub.args[0][0].body['debug_token']).to.equal(
         'my-debug-token'
       );
@@ -773,7 +773,7 @@ describe('internal api', () => {
         )
       );
 
-      const token = await getScopedToken(appCheck as AppCheckService);
+      const token = await getLimitedUseToken(appCheck as AppCheckService);
 
       // ReCaptchaV3Provider's _throttleData is private so checking
       // the resulting error message to be sure it has roughly the
@@ -799,7 +799,7 @@ describe('internal api', () => {
         )
       );
 
-      const token = await getScopedToken(appCheck as AppCheckService);
+      const token = await getLimitedUseToken(appCheck as AppCheckService);
 
       // ReCaptchaV3Provider's _throttleData is private so checking
       // the resulting error message to be sure it has roughly the

packages/app-check/src/internal-api.ts

@@ -210,7 +210,7 @@ export async function getToken(
  * The result will contain an error field if there is any error.
  * In case there is an error, the token field in the result will be populated with a dummy value
  */
-export async function getScopedToken(
+export async function getLimitedUseToken(
   appCheck: AppCheckService
 ): Promise<AppCheckTokenResult> {
   const app = appCheck.app;