run mgmt flow (#554)

* run mgmt flow

* run mgmt flow

* cr fixes

* readme

Author: asafshen

README.md

@@ -1103,14 +1103,30 @@ updatedRes.data.screens.forEach((screen) => {
   // do something
 });
 
+// Run a management Flow
+// Note: Flow must be a management flow, not an interactive flow
+const runRes = await descopeClient.management.flow.run('management-flow-id');
+console.log('flow result', runRes.data); // The result data will contain the flow's output, which is configured in the 'End' step of the flow
+
+// Run a management Flow with input
+// Note: Flow must be a management flow, not an interactive flow
+const runWithInputRes = await descopeClient.management.flow.run('management-flow-id', {
+  input: {
+    key1: 'value1',
+  },
+});
+console.log('flow with input result', runWithInputRes.data); // The result data will contain the flow's output, which is configured in the 'End' step of the flow
+```
+
 // Export the current theme of the project
 const res = descopeClient.management.theme.export();
 console.log(res.data.theme);
 
 // Import the given theme to the project
 const updatedRes = descopeClient.management.theme.import(theme);
 console.log(updatedRes.data.theme);
-```
+
+````
 
 ### Manage JWTs
 
@@ -1121,7 +1137,7 @@ const updatedJWTRes = await descopeClient.management.jwt.update('original-jwt',
   customKey1: 'custom-value1',
   customKey2: 'custom-value2',
 });
-```
+````
 
 Generate a JWT for a user, simulating a sign in request.
 

examples/es6/README.md

@@ -32,7 +32,7 @@ npm run generateCerts
 ```
 # .env
 DESCOPE_PROJECT_ID=<Descope project ID>
-DESCOPE_API_BASE_URL=<Descope API base URL> # optional, Descope will use the default URL if not provided
+DESCOPE_BASE_URL=<Descope API base URL> # optional, Descope will use the default URL if not provided
 PORT=8082 # optional, default is 443
 ```
 

examples/es6/src/index.ts

@@ -22,7 +22,7 @@ const options = {
 const clientAuth = {
   auth: DescopeClient({
     projectId: process.env.DESCOPE_PROJECT_ID || '',
-    baseUrl: process.env.DESCOPE_API_BASE_URL,
+    baseUrl: process.env.DESCOPE_BASE_URL,
     logger: console,
   }),
 };

examples/managementCli/src/index.ts

@@ -24,7 +24,7 @@ function handleSdkRes(res: SdkResponse<any>, responseFile?: string) {
 
 const DESCOPE_PROJECT_ID = process.env.DESCOPE_PROJECT_ID as string;
 const DESCOPE_MANAGEMENT_KEY = process.env.DESCOPE_MANAGEMENT_KEY as string;
-const DESCOPE_API_BASE_URL = (process.env.DESCOPE_API_BASE_URL as string) || undefined;
+const DESCOPE_BASE_URL = (process.env.DESCOPE_BASE_URL as string) || undefined;
 
 if (!DESCOPE_PROJECT_ID || !DESCOPE_MANAGEMENT_KEY) {
   console.error('Missing DESCOPE_PROJECT_ID or DESCOPE_MANAGEMENT_KEY environment variables');
@@ -33,7 +33,7 @@ if (!DESCOPE_PROJECT_ID || !DESCOPE_MANAGEMENT_KEY) {
 
 const sdk = DescopeClient({
   projectId: DESCOPE_PROJECT_ID,
-  baseUrl: DESCOPE_API_BASE_URL,
+  baseUrl: DESCOPE_BASE_URL,
   managementKey: DESCOPE_MANAGEMENT_KEY,
   logger: console,
 });
@@ -951,6 +951,34 @@ program
     handleSdkRes(await sdk.management.flow.import(flowId, flow, screens));
   });
 
+// flow-run
+program
+  .command('flow-run')
+  .description('Run a flow')
+  .argument('<flow-id>', 'Flow ID')
+  .option('-i, --input <input>', 'Input object as JSON string')
+  .action(async (flowId, options) => {
+    let input = {};
+
+    if (options.input) {
+      try {
+        input = JSON.parse(options.input);
+      } catch (error) {
+        console.error(
+          'Invalid JSON input:',
+          error instanceof Error ? error.message : String(error),
+        );
+        return;
+      }
+    }
+
+    handleSdkRes(
+      await sdk.management.flow.run(flowId, {
+        input,
+      }),
+    );
+  });
+
 // *** Theme commands ***
 
 // export-theme

lib/management/flow.test.ts

@@ -43,6 +43,10 @@ const mockFlowResponse: FlowResponse = {
   screens: [mockScreen],
 };
 
+const mockRunFlowResponse = {
+  output: { result: 'success' },
+};
+
 const mockTheme: Theme = {
   id: 'mockTheme',
   cssTemplate: {},
@@ -173,6 +177,65 @@ describe('Management flow', () => {
       });
     });
   });
+
+  describe('run', () => {
+    it('should send the correct request and receive correct response', async () => {
+      const httpResponse = {
+        ok: true,
+        json: () => mockRunFlowResponse,
+        clone: () => ({
+          json: () => Promise.resolve(mockRunFlowResponse),
+        }),
+        status: 200,
+      };
+      mockHttpClient.post.mockResolvedValue(httpResponse);
+
+      const id = 'flow-id';
+      const resp = await management.flow.run(id);
+
+      expect(mockHttpClient.post).toHaveBeenCalledWith(
+        apiPaths.flow.run,
+        { flowId: id, options: undefined },
+        { token: 'key' },
+      );
+
+      expect(resp).toEqual({
+        code: 200,
+        ok: true,
+        response: httpResponse,
+        data: mockRunFlowResponse.output,
+      });
+    });
+
+    it('should send the correct request with options and receive correct response', async () => {
+      const httpResponse = {
+        ok: true,
+        json: () => mockRunFlowResponse,
+        clone: () => ({
+          json: () => Promise.resolve(mockRunFlowResponse),
+        }),
+        status: 200,
+      };
+      mockHttpClient.post.mockResolvedValue(httpResponse);
+
+      const id = 'flow-id';
+      const options = { input: { userId: '123' }, preview: true };
+      const resp = await management.flow.run(id, options);
+
+      expect(mockHttpClient.post).toHaveBeenCalledWith(
+        apiPaths.flow.run,
+        { flowId: id, options },
+        { token: 'key' },
+      );
+
+      expect(resp).toEqual({
+        code: 200,
+        ok: true,
+        response: httpResponse,
+        data: mockRunFlowResponse.output,
+      });
+    });
+  });
 });
 
 describe('Management theme', () => {

lib/management/flow.ts

@@ -1,7 +1,14 @@
 import { SdkResponse, transformResponse } from '@descope/core-js-sdk';
 import { CoreSdk } from '../types';
 import apiPaths from './paths';
-import { FlowResponse, FlowsResponse, Screen, Flow } from './types';
+import {
+  FlowResponse,
+  FlowsResponse,
+  Screen,
+  Flow,
+  ManagementFlowOptions,
+  RunManagementFlowResponse,
+} from './types';
 
 const WithFlow = (sdk: CoreSdk, managementKey?: string) => ({
   list: (): Promise<SdkResponse<FlowsResponse>> =>
@@ -22,6 +29,14 @@ const WithFlow = (sdk: CoreSdk, managementKey?: string) => ({
         { token: managementKey },
       ),
     ),
+  run: (
+    flowId: string,
+    options?: ManagementFlowOptions,
+  ): Promise<SdkResponse<RunManagementFlowResponse['output']>> =>
+    transformResponse(
+      sdk.httpClient.post(apiPaths.flow.run, { flowId, options }, { token: managementKey }),
+      (data) => (data as RunManagementFlowResponse)?.output,
+    ),
 });
 
 export default WithFlow;

lib/management/paths.ts

@@ -148,6 +148,7 @@ export default {
     delete: '/v1/mgmt/flow/delete',
     export: '/v1/mgmt/flow/export',
     import: '/v1/mgmt/flow/import',
+    run: '/v1/mgmt/flow/run',
   },
   theme: {
     export: '/v1/mgmt/theme/export',

lib/management/types.ts

@@ -320,6 +320,10 @@ export type FlowResponse = {
   screens: Screen[];
 };
 
+export type RunManagementFlowResponse = {
+  output: Record<string, any>;
+};
+
 export type Theme = {
   id: string;
   cssTemplate?: any;
@@ -1001,3 +1005,8 @@ export type FetchLatestOutboundAppTenantTokenRequest = {
   tenantId: string;
   options?: FetchOutboundAppTokenOptions;
 };
+
+export type ManagementFlowOptions = {
+  input?: Record<string, any>;
+  preview?: boolean;
+};