Add AccessKeyLoginOptions (including customClaims) for ExchangeAccess…

…Key API (#338)

* Add AccessKeyLoginOptions (including customClaims) for ExchangeAccessKey API

* fix tests

lib/index.test.ts

@@ -263,21 +263,21 @@ describe('sdk', () => {
     it('should fail when the server call throws', async () => {
       const spyExchange = jest.spyOn(sdk.accessKey, 'exchange').mockRejectedValueOnce('error');
       await expect(sdk.exchangeAccessKey('key')).rejects.toThrow('could not exchange access key');
-      expect(spyExchange).toHaveBeenCalledWith('key');
+      expect(spyExchange).toHaveBeenCalledWith('key', undefined);
     });
     it('should fail when getting an unexpected response from the server', async () => {
       const spyExchange = jest
         .spyOn(sdk.accessKey, 'exchange')
         .mockResolvedValueOnce({ data: {} } as SdkResponse<ExchangeAccessKeyResponse>);
       await expect(sdk.exchangeAccessKey('key')).rejects.toThrow('could not exchange access key');
-      expect(spyExchange).toHaveBeenCalledWith('key');
+      expect(spyExchange).toHaveBeenCalledWith('key', undefined);
     });
     it('should fail when the session token the server returns is invalid', async () => {
       const spyExchange = jest.spyOn(sdk.accessKey, 'exchange').mockResolvedValueOnce({
         data: { sessionJwt: expiredToken },
       } as SdkResponse<ExchangeAccessKeyResponse>);
       await expect(sdk.exchangeAccessKey('key')).rejects.toThrow('could not exchange access key');
-      expect(spyExchange).toHaveBeenCalledWith('key');
+      expect(spyExchange).toHaveBeenCalledWith('key', undefined);
     });
     it('should return the same session token it got from the server', async () => {
       const spyExchange = jest.spyOn(sdk.accessKey, 'exchange').mockResolvedValueOnce({
@@ -287,8 +287,9 @@ describe('sdk', () => {
         jwt: validToken,
         token: { exp: 1981398111, iss: 'project-id' },
       };
-      await expect(sdk.exchangeAccessKey('key')).resolves.toMatchObject(expected);
-      expect(spyExchange).toHaveBeenCalledWith('key');
+      const loginOptions = { customClaims: { k1: 'v1' } };
+      await expect(sdk.exchangeAccessKey('key', loginOptions)).resolves.toMatchObject(expected);
+      expect(spyExchange).toHaveBeenCalledWith('key', loginOptions);
     });
   });
 

lib/index.ts

@@ -1,4 +1,9 @@
-import createSdk, { ExchangeAccessKeyResponse, SdkResponse, wrapWith } from '@descope/core-js-sdk';
+import createSdk, {
+  ExchangeAccessKeyResponse,
+  AccessKeyLoginOptions,
+  SdkResponse,
+  wrapWith,
+} from '@descope/core-js-sdk';
 import { JWK, JWTHeaderParameters, KeyLike, errors, importJWK, jwtVerify } from 'jose';
 import {
   permissionsClaimName,
@@ -184,14 +189,18 @@ const nodeSdk = ({ managementKey, publicKey, ...config }: NodeSdkArgs) => {
     /**
      * Exchange API key (access key) for a session key
      * @param accessKey access key to exchange for a session JWT
+     * @param loginOptions Optional advanced controls over login parameters
      * @returns AuthenticationInfo with session JWT data
      */
-    async exchangeAccessKey(accessKey: string): Promise<AuthenticationInfo> {
+    async exchangeAccessKey(
+      accessKey: string,
+      loginOptions?: AccessKeyLoginOptions,
+    ): Promise<AuthenticationInfo> {
       if (!accessKey) throw Error('access key must not be empty');
 
       let resp: SdkResponse<ExchangeAccessKeyResponse>;
       try {
-        resp = await sdk.accessKey.exchange(accessKey);
+        resp = await sdk.accessKey.exchange(accessKey, loginOptions);
       } catch (error) {
         logger?.error('failed to exchange access key', error);
         throw Error(`could not exchange access key - Failed to exchange. Error: ${error}`);

package.json

@@ -100,7 +100,7 @@
     "typescript": "^4.6.4"
   },
   "dependencies": {
-    "@descope/core-js-sdk": "2.9.0",
+    "@descope/core-js-sdk": "2.11.0",
     "cross-fetch": "^4.0.0",
     "jose": "4.15.4",
     "tslib": "^1.14.1"