@or-sdk/deployer 1.5.6 → 1.6.0

package/dist/types/types/flow-logs.d.ts

@@ -0,0 +1,81 @@
+export type FetchFlowLogsParams = {
+    flowId: string;
+    limit?: number;
+    filter?: string;
+    start?: Date | number | 'now';
+    end?: Date | number | 'now';
+    skipOriginal?: boolean;
+};
+export type FetchFlowLogsChunkParams = FetchFlowLogsParams & {
+    next?: string;
+};
+export type FlowLogEventMessageString = {
+    parsed: string;
+    type: 'string';
+};
+export type ParsedReportingEventMessage = {
+    event: {
+        EventId: string;
+        Event: string;
+        EventCategory: string;
+        EventValue: Record<string, unknown>;
+        AccountId: string;
+        FlowId: string;
+        Timestamp: string;
+        Tags?: Array<unknown>;
+        SessionId?: string;
+        BeginningSessionId?: string;
+        Version?: number;
+        [key: string]: unknown;
+    };
+};
+export type RuntimeEventMessage = {
+    type: 'START' | 'END' | 'REPORT';
+    message: string;
+};
+export type SystemEventMessage = {
+    type: string;
+    sys: string;
+    thread: string;
+    data?: Record<string, unknown>;
+    step?: {
+        stepId: string;
+        [key: string]: unknown;
+    };
+    session?: {
+        id: string;
+        [key: string]: unknown;
+    };
+};
+export type LogEventMessage = {
+    type: string;
+    msg: string;
+    thread: string;
+    data?: Record<string, unknown>;
+    step?: {
+        stepId: string;
+        [key: string]: unknown;
+    };
+    session?: {
+        id: string;
+        [key: string]: unknown;
+    };
+};
+export type FlowLogEventMessageJson = {
+    parsed: LogEventMessage | SystemEventMessage | ParsedReportingEventMessage | RuntimeEventMessage;
+    type: 'json';
+};
+export type FlowLogEventMessage = FlowLogEventMessageString | FlowLogEventMessageJson;
+export type FlowLogEvent = {
+    requestId: string;
+    message: FlowLogEventMessage;
+    timestamp: number;
+};
+export type FlowLogsResponse = {
+    events: FlowLogEvent[];
+    startTime: number;
+};
+export type FlowLogsChunkResponse = FlowLogsResponse & {
+    nextToken?: string;
+};
+//# sourceMappingURL=flow-logs.d.ts.map

package/dist/types/types/flow-logs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow-logs.d.ts","sourceRoot":"","sources":["../../../src/types/flow-logs.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,GAAG;IAEhC,MAAM,EAAE,MAAM,CAAC;IAGf,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,MAAM,CAAC,EAAE,MAAM,CAAC;IAWhB,KAAK,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC;IAW9B,GAAG,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC;IAG5B,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,mBAAmB,GAAG;IAE3D,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,QAAQ,CAAC;CAChB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG;IACxC,KAAK,EAAE;QACL,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,aAAa,EAAE,MAAM,CAAC;QACtB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACpC,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QACtB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;CACjB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,IAAI,CAAC,EAAE;QACL,MAAM,EAAE,MAAM,CAAC;QACf,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,OAAO,CAAC,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,IAAI,CAAC,EAAE;QACL,MAAM,EAAE,MAAM,CAAC;QACf,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,OAAO,CAAC,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EACJ,eAAe,GACf,kBAAkB,GAClB,2BAA2B,GAC3B,mBAAmB,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;CACd,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,yBAAyB,GAAG,uBAAuB,CAAC;AAEtF,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,mBAAmB,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAE7B,MAAM,EAAE,YAAY,EAAE,CAAC;IAGvB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,gBAAgB,GAAG;IAErD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/dist/types/types/index.d.ts

@@ -0,0 +1,4 @@
+export type * from './base';
+export type * from './flow-activation';
+export type * from './flow-logs';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,QAAQ,CAAC;AAC5B,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,aAAa,CAAC"}

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@or-sdk/deployer",
-  "version": "1.5.6",
+  "version": "1.6.0",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
   "scripts": {
-    "build": "pnpm clean && pnpm build:esm & pnpm build:cjs",
+    "build": "pnpm clean && concurrently 'pnpm:build:*(!watch)'",
     "build:cjs": "tsc --project tsconfig.json",
     "build:esm": "tsc --project tsconfig.esm.json",
     "build:types": "tsc --project tsconfig.types.json",
-    "build:watch": "concurrently -r --hide 1,2 \"pnpm build:watch:cjs\" \"pnpm build:watch:esm\" \"pnpm build:watch:types\"",
+    "build:watch": "concurrently 'pnpm:build:watch:*'",
     "build:watch:cjs": "tsc --project tsconfig.json -w",
     "build:watch:esm": "tsc --project tsconfig.esm.json -w",
     "build:watch:types": "tsc --project tsconfig.types.json -w",
@@ -18,8 +18,8 @@
     "dev": "pnpm build:watch:esm"
   },
   "dependencies": {
-    "@or-sdk/base": "^0.42.5",
-    "@or-sdk/step-templates": "^2.1.42"
+    "@or-sdk/base": "^0.43.0",
+    "@or-sdk/step-templates": "^2.2.0"
   },
   "devDependencies": {
     "concurrently": "9.0.1",
@@ -28,5 +28,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c6887f491665f09fe3588ef5384d0d3f2d42412d"
+  "gitHead": "ce62679c119c54ef41fd0d8f7084c563c3b21b24"
 }

package/src/Deployer.ts

@@ -1,18 +1,38 @@
 import { Base, timeout } from '@or-sdk/base';
 
 import { SERVICE_KEY } from './constants';
-import {
+import type {
   DeployerConfig,
-  Flow, PollingParams,
+  FetchFlowLogsChunkParams,
+  FetchFlowLogsParams,
+  Flow, FlowLogsChunkResponse, FlowLogsResponse, PollingOptions, PollingParams,
   PollingResult,
   PollingResultActivateSuccess,
   PollingResultDeactivateSuccess,
-  PollingResultError,
   PollingResultPending,
 } from './types';
 
 export class Deployer extends Base {
 
+  /**
+   * You need to pass URL either to discovery API or to deployer API
+   *
+   * @example Creating instance using discovery API
+   * ```typescript
+   * const deployer = new Deployer({
+   *   token: '<token>',
+   *   discoveryUrl: '<discovery-api-url>',
+   * })
+   * ```
+   *
+   * @example Creating instance using deployer API URL
+   * ```typescript
+   * const deployer = new Deployer({
+   *   token: '<token>',
+   *   deployerUrl: '<deployer-api-url>',
+   * })
+   * ```
+  */
   constructor(params: DeployerConfig) {
     const { token, discoveryUrl, accountId, deployerUrl } = params;
 
@@ -27,16 +47,18 @@ export class Deployer extends Base {
 
   /**
    * Remove role
+   *
+   * Does not support cross-account logic.
+   *
+   * @example
    * ```typescript
    * const result = await deployer.removeRole();
    * ```
    */
   public async removeRole(): Promise<void> {
-    const route = '/role';
-
     return this.callApi({
       method: 'DELETE',
-      route,
+      route: '/role',
       params: {
         accountId: this.currentAccountId,
       },
@@ -44,12 +66,19 @@ export class Deployer extends Base {
   }
 
   /**
-   * Activate flow without polling
+   * Activate flow without polling.
+   *
+   * Supports cross-account logic (with super-admin token).
+   *
+   * @example
    * ```typescript
    * const pollingParams = await deployer.activateFlow(flowSource, false);
    * ```
    */
-  public async activateFlowNoPoll({ id, data: { deploy: { role } } }: Flow, interactiveDebug = false): Promise<PollingParams> {
+  public async activateFlowNoPoll(
+    { id, data: { deploy: { role } } }: Flow,
+    interactiveDebug = false,
+  ): Promise<PollingParams> {
     if (!id) {
       throw new Error('Id is required');
     }
@@ -63,11 +92,9 @@ export class Deployer extends Base {
       role,
     };
 
-    const route = `${ this.isCrossAccount ? `/accounts/${this.currentAccountId}` : '' }/flows/deploy`;
-
-    const { requestId } = await this.callApi<{requestId: string;}>({
+    const { requestId } = await this.callApi<{ requestId: string; }>({
       method: 'POST',
-      route,
+      route: this.getPrefixedRoute('/flows/deploy'),
       data,
     });
 
@@ -79,21 +106,29 @@ export class Deployer extends Base {
 
   /**
    * Activates flow.
+   *
    * Starts activation and polls progress. `progressCallback` is called on every polling
    * while the activation is in 'pending' status.
+   *
+   * Supports cross-account logic (with super-admin token).
+   *
+   * @example
    * ```typescript
-   * const triggerList = await deployer.activateFlow(flowSource, false, fnShowProgress);
+   * const triggerList = await flows.activateFlow(flowSource, false, fnShowProgress);
    * ```
-   * @param flowSource Flow data object. SDK uses `id` and `data.deploy.role` properties from it.
-   * @param interactiveDebug Flag to turn the debug mode on/off. `false` by default.
-   * @param progressCallback Function to call with interim activation progress results.
-   * @returns Successful activation data object that contains active triggers for the flow.
    */
   public async activateFlow(
+    /** Flow data object. SDK uses `id` and `data.deploy.role` properties from it. */
     flowSource: Flow,
+
+    /** Flag to turn the debug mode on/off. Default `false`. */
     interactiveDebug = false,
+
+    /** Callback function to call with interim activation progress results. */
     progressCallback?: (progress: PollingResultPending) => void,
-    pollingOptions?: {maxAttempts: number; attemptDelay: number;}
+
+    /** Activation polling options */
+    pollingOptions?: PollingOptions,
   ): Promise<PollingResultActivateSuccess> {
     const pollingParams = await this.activateFlowNoPoll(flowSource, interactiveDebug);
 
@@ -106,6 +141,10 @@ export class Deployer extends Base {
 
   /**
    * Deactivate flow without polling
+   *
+   * Supports cross-account logic (with super-admin token).
+   *
+   * @example
    * ```typescript
    * const pollingParams = await deployer.deactivateFlow(flowSource);
    * ```
@@ -122,11 +161,9 @@ export class Deployer extends Base {
       role,
     };
 
-    const route = `${ this.isCrossAccount ? `/accounts/${this.currentAccountId}` : '' }/flows/deploy`;
-
-    const { requestId } = await this.callApi<{requestId: string;}>({
+    const { requestId } = await this.callApi<{ requestId: string; }>({
       method: 'DELETE',
-      route,
+      route: this.getPrefixedRoute('/flows/deploy'),
       data,
     });
 
@@ -138,19 +175,26 @@ export class Deployer extends Base {
 
   /**
    * Deactivates flow.
+   *
    * Starts deactivation and polls progress. `progressCallback` is called on every polling
    * while the deactivation is in 'pending' status.
+   *
+   * Supports cross-account logic (with super-admin token).
+   *
+   * @example
    * ```typescript
-   * const deactivatedFlowList = await deployer.deactivateFlow(flowSource, fnShowProgress);
+   * const deactivatedFlowList = await flows.deactivateFlow(flowSource, fnShowProgress);
    * ```
-   * @param flowSource Flow data object. SDK uses `id` and `data.deploy.role` properties from it.
-   * @param progressCallback Function to call with interim deactivation progress results.
-   * @returns Successful deactivation summary data.
    */
   public async deactivateFlow(
+    /** Flow data object. SDK uses `id` and `data.deploy.role` properties from it. */
     flowSource: Flow,
+
+    /** Function to call with interim deactivation progress results. */
     progressCallback?: (progress: PollingResultPending) => void,
-    pollingOptions?: {maxAttempts: number; attemptDelay: number;}
+
+    /** Deactivation polling options */
+    pollingOptions?: PollingOptions,
   ): Promise<PollingResultDeactivateSuccess> {
     const pollingParams = await this.deactivateFlowNoPoll(flowSource);
 
@@ -162,41 +206,44 @@ export class Deployer extends Base {
    * and success or error when finished. Performs up to 100 calls with 1 second interval.
    *
    * Optional progressCallback is calls for every call while in pending status.
+   *
+   * Supports cross-account logic (with super-admin token).
+   *
+   * @example
    * ```typescript
    * const result = await deployer.pollResult(pollingParams, progressCallback);
    * ```
-   * @param pollingParams Object with ids of the flow and the deployment process.
-   * @param progressCallback Callback function getting the interim status of the flow de/activation.
    */
   public async pollResult<T>(
+    /** Flow and activation/deactivation ids. */
     { flowId, requestId }: PollingParams,
+
+    /** Callback function getting the interim status of the flow activation/deactivation. */
     progressCallback?: (progress: PollingResultPending) => void,
-    options?: {maxAttempts: number; attemptDelay: number;}
+
+    /** Polling options */
+    options?: PollingOptions,
   ): Promise<T> {
     let counter = 0;
     const maxAttempts = options?.maxAttempts || 100;
     const attemptDelay = options?.attemptDelay || 3000;
 
-    const route = `${ this.isCrossAccount ? `/accounts/${this.currentAccountId}` : '' }/flows/check/${flowId}/${requestId}`;
-
     do {
-      counter++;
-      await timeout(attemptDelay);
+      if (counter) await timeout(attemptDelay);
+      counter += 1;
 
       const result = await this.callApi<PollingResult>({
         method: 'GET',
-        route,
+        route: this.getPrefixedRoute(`/flows/check/${flowId}/${requestId}`),
       });
 
-      if ((result as PollingResultPending).status === 'pending') {
+      if ('status' in result && result.status === 'pending') {
         if (typeof progressCallback === 'function') {
-          progressCallback(result as PollingResultPending);
+          progressCallback(result);
         }
+      } else if ('errorData' in result && result.errorData) {
+        throw result;
       } else {
-        if ((result as PollingResultError).errorData) {
-          throw result;
-        }
-
         return result as T;
       }
     } while (counter < maxAttempts);
@@ -206,9 +253,18 @@ export class Deployer extends Base {
 
   /**
    * Only for SUPER_ADMIN.
-   * The code includes the functionality to delete a user IAM role and disable all flows.
+   *
+   * Starts the process to delete an account IAM role and disable all account flows.
+   *
    * Additionally, it marks each deployment with a "suspended" flag to enable future resumption.
+   *
+   * @example
    * ```typescript
+   * const deployer = new Deployer({
+   *   token: '<super-admin-token>',
+   *   accountId: '<account-id-to-suspend>',
+   *   discoveryUrl: '<discovery-api-url>',
+   * });
    * await deployer.suspendAccount();
    * ```
    */
@@ -226,9 +282,17 @@ export class Deployer extends Base {
 
   /**
    * Only for SUPER_ADMIN.
-   * The code includes the functionality to activate all suspended flows.
+   *
+   * Restores suspended account and activates all suspended flows.
+   *
+   * @example
    * ```typescript
-   * await deployer.suspendAccount();
+   * const deployer = new Deployer({
+   *   token: '<super-admin-token>',
+   *   accountId: '<account-id-to-restore>',
+   *   discoveryUrl: '<discovery-api-url>',
+   * });
+   * await deployer.resumeAccount();
    * ```
    */
   public async resumeAccount(): Promise<void> {
@@ -242,4 +306,109 @@ export class Deployer extends Base {
       },
     });
   }
+
+  /**
+   * Fetch single chunk of flow logs
+   *
+   * To fetch all log events for given time interval see {@link fetchAllFlowLogs}.
+   *
+   * Does not support cross-account fetching (with `accountId` in Deployer constructor).
+   *
+   * @example Fetch latest chunk of logs for the flow:
+   * ```typescript
+   * const deployer = new Deployer({token: '<token>', discoveryUrl: '<discovery-api-url>'});
+   * const logs = await deployer.fetchFlowLogsChunk({flowId: '<flow-id>'});
+   * ```
+   *
+   * @example Fetch two chunks of flow logs
+   * ```typescript
+   * const deployer = new Deployer({token: '<token>', discoveryUrl: '<discovery-api-url>'});
+   * const chunk1 = await deployer.fetchFlowLogsChunk({flowId: '<flow-id>'});
+   * const chunk2 = await deployer.fetchFlowLogsChunk({
+   *   flowId: '<flow-id>',
+   *   next: chunk1.nextToken,
+   * });
+   * ```
+   *
+   * @example Fetch chunk of logs starting from 1 hour ago till now:
+   * ```typescript
+   * const deployer = new Deployer({token: '<token>', discoveryUrl: '<discovery-api-url>'});
+   * const logs = await deployer.fetchFlowLogsChunk({
+   *   flowId: '<flow-id>',
+   *   start: Date.now() - 60 * 60 * 1000, // 60 minutes ago
+   * });
+   * ```
+   */
+  public async fetchFlowLogsChunk(params: FetchFlowLogsChunkParams): Promise<FlowLogsChunkResponse> {
+    const {
+      flowId,
+      limit = 50,
+      skipOriginal = true,
+      start = 'now',
+      end = 'now',
+      ...options
+    } = params;
+
+    const result = await this.callApiV2<FlowLogsChunkResponse>({
+      method: 'GET',
+      route: `/flows/${flowId}/logs`,
+      params: {
+        ...options,
+        limit,
+        // due to API quirk it should be either `true` or `undefined` to properly pass it
+        skipOriginal: skipOriginal || undefined,
+        start: start instanceof Date ? start.valueOf() : start,
+        end: end instanceof Date ? end.valueOf() : end,
+      },
+    });
+
+    // delete param that will always be empty array
+    if ('searchedLogStreams' in result) delete result.searchedLogStreams;
+
+    return result;
+  }
+
+  /**
+   * Fetch all flow log events for a time interval
+   *
+   * To fetch only single chunk of log events see {@link fetchFlowLogsChunk}.
+   *
+   * Does not support cross-account fetching (with `accountId` in Deployer constructor).
+   *
+   * @example Fetch latest logs for the flow:
+   * ```typescript
+   * const deployer = new Deployer({token: '<token>', discoveryUrl: '<discovery-api-url>'});
+   * const logs = await deployer.fetchAllFlowLogs({flowId: '<flow-id>'});
+   * ```
+   *
+   * @example Fetch all logs starting from 1 hour ago till now:
+   * ```typescript
+   * const deployer = new Deployer({token: '<token>', discoveryUrl: '<discovery-api-url>'});
+   * const logs = await deployer.fetchAllFlowLogs({
+   *   flowId: '<flow-id>',
+   *   start: Date.now() - 60 * 60 * 1000, // 60 minutes ago
+   * });
+   * ```
+   */
+  public async fetchAllFlowLogs(params: FetchFlowLogsParams): Promise<FlowLogsResponse> {
+    let next: string | undefined;
+    let result: FlowLogsResponse | undefined;
+
+    do {
+      const chunk = await this.fetchFlowLogsChunk({
+        ...params,
+        next,
+      });
+      next = chunk.nextToken;
+
+      if (result == undefined) result = chunk;
+      else result.events = result.events.concat(chunk.events);
+    } while (next);
+
+    return result;
+  }
+
+  private getPrefixedRoute(route: string): string {
+    return `${this.isCrossAccount ? `/accounts/${this.currentAccountId}` : ''}${route}`;
+  }
 }

package/src/index.ts

@@ -1,3 +1,3 @@
 export { Deployer } from './Deployer';
-export * from './types';
 export * from './constants';
+export type * from './types/index';

package/src/types/base.ts

@@ -0,0 +1,42 @@
+import type { Token } from '@or-sdk/base';
+
+export type { Token };
+
+export type DeployerConfigBase = {
+  /**
+   * OneReach token or token factory function
+   */
+  token: Token;
+
+  /**
+   * Account id for cross-account requests (super admin only)
+   */
+  accountId?: string;
+};
+
+export type DeployerConfigWithDiscovery = DeployerConfigBase & {
+  /**
+   * URL of OneReach ServiceDiscovery API
+   *
+   * If this is set, do not provide {@link DeployerConfig.deployerUrl}.
+   */
+  discoveryUrl: string;
+
+  deployerUrl?: never;
+};
+
+export type DeployerConfigWithExplicitUrls = DeployerConfigBase & {
+  /**
+   * URL of OneReach Deployer API
+   *
+   * If this is set, do not provide {@link DeployerConfig.discoveryUrl}.
+   */
+  deployerUrl: string;
+
+  /**
+   * URL of OneReach ServiceDiscovery API
+   */
+  discoveryUrl?: never;
+};
+
+export type DeployerConfig = DeployerConfigWithDiscovery | DeployerConfigWithExplicitUrls;

package/src/{types.ts → types/flow-activation.ts}

@@ -1,30 +1,7 @@
-import { Token } from '@or-sdk/base';
-import { StepTemplateRaw } from '@or-sdk/step-templates';
+import type { StepTemplateRaw } from '@or-sdk/step-templates';
 
 export { StepTemplateRaw } from '@or-sdk/step-templates';
 
-export type DeployerConfig = {
-  /**
-   * token
-   */
-  token: Token;
-
-  /**
-   * Url of OneReach service discovery api
-   */
-  discoveryUrl?: string;
-
-  /**
-   * Account ID for cross-account requests (super admin only)
-   */
-  accountId?: string;
-
-  /**
-   * Url of OneReach Deployer api
-   */
-  deployerUrl?: string;
-};
-
 export type Step = {
   id: string;
   label?: string;
@@ -105,9 +82,7 @@ export type Trigger = {
       path?: string;
     };
   };
-  reporting: {
-    [key: string]: unknown;
-  }; //TODO: always empty?
+  reporting: Record<string, unknown>; //TODO: always empty?
   processed: boolean;
 };
 
@@ -122,7 +97,7 @@ export type PollingResultPending = {
      */
     message?: string;
     /**
-     * Percentage value of the flow de/activation completion.
+     * Percentage value of the flow activation/deactivation completion.
      */
     progress?: number;
   };
@@ -165,7 +140,7 @@ export type PollingResultError = {
 };
 
 export type PollingResult =
-  PollingResultPending
+  | PollingResultPending
   | PollingResultActivateSuccess
   | PollingResultDeactivateSuccess
   | PollingResultError;
@@ -174,3 +149,12 @@ export type PollingParams = {
   flowId: string;
   requestId: string;
 };
+
+/** Polling options */
+export type PollingOptions = {
+  /** Maximum number of poll requests to make. Default 100. */
+  maxAttempts?: number;
+
+  /** Delay in milliseconds between each poll request. Default 3000. */
+  attemptDelay?: number;
+}