add third party app patch

add third party app get secret
add third party app rotate secret

Author: Bars92

README.md

@@ -1227,11 +1227,20 @@ const { id, cleartext: secret } =
 // Update a third party application.
 // Update will override all fields as is. Use carefully.
 await descopeClient.management.thirdPartyApplication.updateApplication({
+  id: 'my-app-id',
   name: 'my updated app',
   loginPageUrl: 'http://dummy.com/login',
   approvedCallbackUrls: ['dummy.com', 'myawesomedomain.com'],
 });
 
+// Patch a third party application.
+// patch will not override all fields, but update only what given.
+await descopeClient.management.thirdPartyApplication.patchApplication({
+  id: 'my-app-id',
+  name: 'my updated app name',
+  description: 'my new description',
+});
+
 // third party application deletion cannot be undone. Use carefully.
 await descopeClient.management.thirdPartyApplication.deleteApplication('my-app-id');
 
@@ -1244,6 +1253,16 @@ appsRes.data.forEach((app) => {
   // do something
 });
 
+// Get a third party application secret by application id.
+const { cleartext } = await descopeClient.management.thirdPartyApplication.getApplicationSecret(
+  'my-app-id',
+);
+
+// Rotate a third party application secret by application id.
+const { cleartext } = await descopeClient.management.thirdPartyApplication.rotateApplicationSecret(
+  'my-app-id',
+);
+
 // Search in all consents. search consents by the given app id and offset to the third page.
 const consentsRes = await descopeClient.management.thirdPartyApplication.searchConsents({
   appId: 'my-app',

lib/management/paths.ts

@@ -79,9 +79,12 @@ export default {
   thirdPartyApplication: {
     create: '/v1/mgmt/thirdparty/app/create',
     update: '/v1/mgmt/thirdparty/app/update',
+    patch: '/v1/mgmt/thirdparty/app/patch',
     delete: '/v1/mgmt/thirdparty/app/delete',
     load: '/v1/mgmt/thirdparty/app/load',
     loadAll: '/v1/mgmt/thirdparty/apps/load',
+    secret: '/v1/mgmt/thirdparty/app/secret',
+    rotate: '/v1/mgmt/thirdparty/app/rotate',
   },
   thirdPartyApplicationConsents: {
     delete: '/v1/mgmt/thirdparty/consents/delete',

lib/management/thirdpartyapplication.test.ts

@@ -5,6 +5,7 @@ import {
   CreateThirdPartyApplicationResponse,
   ThirdPartyApplication,
   ThirdPartyApplicationConsent,
+  ThirdPartyApplicationSecretResponse,
 } from './types';
 import { mockCoreSdk, mockHttpClient } from './testutils';
 
@@ -165,6 +166,47 @@ describe('Management ThirdPartyApplication', () => {
     });
   });
 
+  describe('patchThirdPartyApplication', () => {
+    it('should send the correct request and receive correct response', async () => {
+      const httpResponse = {
+        ok: true,
+        json: () => {},
+        clone: () => ({
+          json: () => Promise.resolve({}),
+        }),
+        status: 200,
+      };
+      mockHttpClient.post.mockResolvedValue(httpResponse);
+
+      const resp = await management.thirdPartyApplication.patchApplication({
+        id: 'app1',
+        logo: 'logo',
+        description: 'desc',
+        loginPageUrl: 'http://dummy.com',
+        permissionsScopes: [],
+      });
+
+      expect(mockHttpClient.post).toHaveBeenCalledWith(
+        apiPaths.thirdPartyApplication.patch,
+        {
+          id: 'app1',
+          permissionsScopes: [],
+          logo: 'logo',
+          description: 'desc',
+          loginPageUrl: 'http://dummy.com',
+        },
+        { token: 'key' },
+      );
+
+      expect(resp).toEqual({
+        code: 200,
+        data: {},
+        ok: true,
+        response: httpResponse,
+      });
+    });
+  });
+
   describe('deleteThirdPartyApplication', () => {
     it('should send the correct request and receive correct response', async () => {
       const httpResponse = {
@@ -223,6 +265,70 @@ describe('Management ThirdPartyApplication', () => {
     });
   });
 
+  describe('getThirdPartyApplicationSecret', () => {
+    it('should send the correct request and receive correct response', async () => {
+      const httpResponse = {
+        ok: true,
+        json: () => {
+          '1';
+        },
+        clone: () => ({
+          json: () => Promise.resolve({ cleartext: '1' }),
+        }),
+        status: 200,
+      };
+      mockHttpClient.get.mockResolvedValue(httpResponse);
+
+      const resp: SdkResponse<ThirdPartyApplicationSecretResponse> =
+        await management.thirdPartyApplication.getApplicationSecret(
+          mockThirdPartyApplications[0].id,
+        );
+
+      expect(mockHttpClient.get).toHaveBeenCalledWith(apiPaths.thirdPartyApplication.secret, {
+        queryParams: { id: mockThirdPartyApplications[0].id },
+        token: 'key',
+      });
+
+      expect(resp).toEqual({
+        code: 200,
+        data: { cleartext: '1' },
+        ok: true,
+        response: httpResponse,
+      });
+    });
+  });
+
+  describe('rotateThirdPartyApplication', () => {
+    it('should send the correct request and receive correct response', async () => {
+      const httpResponse = {
+        ok: true,
+        json: () => {
+          '1';
+        },
+        clone: () => ({
+          json: () => Promise.resolve({ cleartext: '1' }),
+        }),
+        status: 200,
+      };
+      mockHttpClient.post.mockResolvedValue(httpResponse);
+
+      const resp = await management.thirdPartyApplication.rotateApplicationSecret('app1');
+
+      expect(mockHttpClient.post).toHaveBeenCalledWith(
+        apiPaths.thirdPartyApplication.rotate,
+        { id: 'app1' },
+        { token: 'key' },
+      );
+
+      expect(resp).toEqual({
+        code: 200,
+        data: { cleartext: '1' },
+        ok: true,
+        response: httpResponse,
+      });
+    });
+  });
+
   describe('loadAllThirdPartyApplication', () => {
     it('should send the correct request and receive correct response', async () => {
       const httpResponse = {

lib/management/thirdpartyapplication.ts

@@ -8,6 +8,7 @@ import {
   ThirdPartyApplicationConsentSearchOptions,
   CreateThirdPartyApplicationResponse,
   ThirdPartyApplicationOptions,
+  ThirdPartyApplicationSecretResponse,
 } from './types';
 
 type MultipleThirdPartyApplicationResponse = {
@@ -41,6 +42,16 @@ const withThirdPartyApplication = (sdk: CoreSdk, managementKey?: string) => ({
         { token: managementKey },
       ),
     ),
+  patchApplication: (
+    options: Partial<ThirdPartyApplicationOptions> & { id: string },
+  ): Promise<SdkResponse<never>> =>
+    transformResponse(
+      sdk.httpClient.post(
+        apiPaths.thirdPartyApplication.patch,
+        { ...options },
+        { token: managementKey },
+      ),
+    ),
   deleteApplication: (id: string): Promise<SdkResponse<never>> =>
     transformResponse(
       sdk.httpClient.post(apiPaths.thirdPartyApplication.delete, { id }, { token: managementKey }),
@@ -60,6 +71,18 @@ const withThirdPartyApplication = (sdk: CoreSdk, managementKey?: string) => ({
       }),
       (data) => data.apps,
     ),
+  getApplicationSecret: (id: string): Promise<SdkResponse<ThirdPartyApplicationSecretResponse>> =>
+    transformResponse<ThirdPartyApplicationSecretResponse, ThirdPartyApplicationSecretResponse>(
+      sdk.httpClient.get(apiPaths.thirdPartyApplication.secret, {
+        queryParams: { id },
+        token: managementKey,
+      }),
+      (data) => data,
+    ),
+  rotateApplicationSecret: (id: string): Promise<SdkResponse<never>> =>
+    transformResponse(
+      sdk.httpClient.post(apiPaths.thirdPartyApplication.rotate, { id }, { token: managementKey }),
+    ),
   searchConsents: (
     options?: ThirdPartyApplicationConsentSearchOptions,
   ): Promise<SdkResponse<ThirdPartyApplicationConsent[]>> =>

lib/management/types.ts

@@ -819,11 +819,14 @@ export type ThirdPartyApplication = ThirdPartyApplicationOptions & {
   clientId: string;
 };
 
-export type CreateThirdPartyApplicationResponse = {
-  id: string;
+export type ThirdPartyApplicationSecretResponse = {
   cleartext: string;
 };
 
+export type CreateThirdPartyApplicationResponse = {
+  id: string;
+} & ThirdPartyApplicationSecretResponse;
+
 /**
  * Represents a third party application consent for a single application
  * for a specific user within the project.