chore(backend): Remove secret in favor of token in m2m response (#6542)

Author: wobsoriano

.changeset/chatty-kings-raise.md

@@ -0,0 +1,21 @@
+---
+"@clerk/backend": minor
+---
+
+Remove `secret` in favor of `token` in m2m response.
+
+Before:
+
+```ts
+const result = await clerkClient.m2mTokens.create()
+
+console.log(result.secret)
+```
+
+After:
+
+```ts
+const result = await clerkClient.m2mTokens.create()
+
+console.log(result.token)
+```

packages/backend/src/api/__tests__/M2MTokenApi.test.ts

@@ -14,8 +14,6 @@ describe('M2MToken', () => {
     subject: 'mch_xxxxx',
     scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
     claims: { foo: 'bar' },
-    // Deprecated in favor of `token`
-    secret: m2mSecret,
     token: m2mSecret,
     revoked: false,
     revocation_reason: null,
@@ -47,7 +45,6 @@ describe('M2MToken', () => {
       });
 
       expect(response.id).toBe(m2mId);
-      expect(response.secret).toBe(m2mSecret);
       expect(response.token).toBe(m2mSecret);
       expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
       expect(response.claims).toEqual({ foo: 'bar' });
@@ -74,7 +71,7 @@ describe('M2MToken', () => {
       });
 
       expect(response.id).toBe(m2mId);
-      expect(response.secret).toBe(m2mSecret);
+      expect(response.token).toBe(m2mSecret);
       expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
       expect(response.claims).toEqual({ foo: 'bar' });
     });
@@ -152,7 +149,7 @@ describe('M2MToken', () => {
       });
 
       expect(response.revoked).toBe(true);
-      expect(response.secret).toBeUndefined();
+      expect(response.token).toBeUndefined();
       expect(response.revocationReason).toBe('revoked by test');
       expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
       expect(response.claims).toEqual({ foo: 'bar' });
@@ -180,7 +177,7 @@ describe('M2MToken', () => {
       });
 
       expect(response.revoked).toBe(true);
-      expect(response.secret).toBeUndefined();
+      expect(response.token).toBeUndefined();
       expect(response.revocationReason).toBe('revoked by test');
     });
 
@@ -231,7 +228,7 @@ describe('M2MToken', () => {
       });
 
       expect(response.id).toBe(m2mId);
-      expect(response.secret).toBe(m2mSecret);
+      expect(response.token).toBe(m2mSecret);
       expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
       expect(response.claims).toEqual({ foo: 'bar' });
     });
@@ -257,7 +254,7 @@ describe('M2MToken', () => {
       });
 
       expect(response.id).toBe(m2mId);
-      expect(response.secret).toBe(m2mSecret);
+      expect(response.token).toBe(m2mSecret);
       expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
       expect(response.claims).toEqual({ foo: 'bar' });
     });
@@ -308,7 +305,7 @@ describe('M2MToken', () => {
       });
 
       expect(response.id).toBe(m2mId);
-      expect(response.secret).toBe(m2mSecret);
+      expect(response.token).toBe(m2mSecret);
       expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
       expect(response.claims).toEqual({ foo: 'bar' });
     });
@@ -334,7 +331,7 @@ describe('M2MToken', () => {
       });
 
       expect(response.id).toBe(m2mId);
-      expect(response.secret).toBe(m2mSecret);
+      expect(response.token).toBe(m2mSecret);
       expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
       expect(response.claims).toEqual({ foo: 'bar' });
     });

packages/backend/src/api/resources/JSON.ts

@@ -734,10 +734,6 @@ export interface MachineSecretKeyJSON {
 
 export interface M2MTokenJSON extends ClerkResourceJSON {
   object: typeof ObjectType.M2MToken;
-  /**
-   * @deprecated Use {@link token} instead.
-   */
-  secret?: string;
   token?: string;
   subject: string;
   scopes: string[];

packages/backend/src/api/resources/M2MToken.ts

@@ -13,7 +13,6 @@ export class M2MToken {
     readonly createdAt: number,
     readonly updatedAt: number,
     readonly token?: string,
-    readonly secret?: string,
   ) {}
 
   static fromJSON(data: M2MTokenJSON): M2MToken {
@@ -29,7 +28,6 @@ export class M2MToken {
       data.created_at,
       data.updated_at,
       data.token,
-      data.secret,
     );
   }
 }