@or-sdk/flows 2.7.2-beta.4026.0 → 2.7.2

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.7.2](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/flows@2.7.1...@or-sdk/flows@2.7.2) (2026-03-02)
+
+
+### Bug Fixes
+
+* **flows:** saving big flow ([0a4e5f3](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/commit/0a4e5f3064589c1b24d3978f4953252fe77110d2))
+
+
+
 ## [2.7.1](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/flows@2.7.0...@or-sdk/flows@2.7.1) (2026-02-25)
 
 **Note:** Version bump only for package @or-sdk/flows

package/dist/types/Flows.d.ts

@@ -4,26 +4,330 @@ export declare class Flows implements Taggable<Flow> {
     private readonly dataHubSvc;
     private readonly tags;
     private readonly files;
+    /** Service-Discovery API allows to fetch URLs for required services automatically on bootstrap */
     constructor(params: FlowsConfigWithDiscovery);
+    /** Providing URLs for APIs explicitly allows to reduce initial delay by avoiding extra calls to discovery service */
     constructor(params: FlowsConfigWithExplicitUrls);
+    /**
+     * List flows
+     *
+     * @example
+     * ```typescript
+     * const flowsList = await flows.listFlows();
+     * ```
+     */
     listFlows(params?: ListFlowsParams, paginationOptions?: PaginationOptions): Promise<List<Flow>>;
+    /**
+     * Fetch flow by id
+     *
+     * Supports cross-account logic (with super-admin token).
+     *
+     * @example
+     * ```typescript
+     * const flow = await flows.getFlow('<flow-id>');
+     * ```
+     */
     getFlow(id: string, params?: GetFlowParams): Promise<Flow>;
+    /**
+     * Save flow
+     *
+     * If source contains existing id - existing flow will be updated.
+     *
+     * Supports cross-account logic (with super-admin token).
+     *
+     * @example
+     * ```typescript
+     * const savedFlow = await flows.saveFlow(flowSource);
+     * ```
+     */
     saveFlow(source: Flow, options?: SaveFlowOptions): Promise<Flow>;
-    deleteFlow(flowId: string | Flow, temporarily?: boolean): Promise<void>;
+    /**
+     * Delete flow
+     *
+     * Supports cross-account logic (with super-admin token).
+     *
+     * @example Delete flow by id
+     * ```typescript
+     * await flows.deleteFlow('<flow-id>');
+     * ```
+  
+     * @example Delete flow by flow source
+     * ```typescript
+     * await flows.deleteFlow(flowSource);
+     * ```
+    */
+    deleteFlow(
+    /** Either id of the flow to delete, or flow object of the flow to delete */
+    flowId: string | Flow, 
+    /** If `true` flow would be deleted in trash.Default `true` */
+    temporarily?: boolean): Promise<void>;
+    /**
+     * Recover flow
+     *
+     * Supports cross-account logic (with super-admin token)
+     *
+     * @example
+     * ```typescript
+     * await flows.recoverFlow('<flow-id>');
+     * ```
+     */
     recoverFlow(flowId: string): Promise<void>;
-    activateFlow(flowSource: Flow, interactiveDebug?: boolean, progressCallback?: (progress: PollingResultPending) => void, pollingOptions?: PollingOptions): Promise<PollingResultActivateSuccess>;
-    deactivateFlow(flowSource: Flow, progressCallback?: (progress: PollingResultPending) => void, pollingOptions?: PollingOptions): Promise<PollingResultDeactivateSuccess>;
+    /**
+     * 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)
+     *
+     * The method is a convenience proxy of the same method from
+     * [@or-sdk/deployer](https://www.npmjs.com/package/@or-sdk/deployer).
+     *
+     * @example
+     * ```typescript
+     * const triggerList = await flows.activateFlow(flowSource, false, fnShowProgress);
+     * ```
+     */
+    activateFlow(
+    /** Flow data object. SDK uses `id` and `data.deploy.role` properties from it. */
+    flowSource: Flow, 
+    /** Flag to turn the debug mode on/off. `false` by default. */
+    interactiveDebug?: boolean, 
+    /** Callback function to call with interim activation progress results. */
+    progressCallback?: (progress: PollingResultPending) => void, 
+    /** Activation polling options */
+    pollingOptions?: PollingOptions): Promise<PollingResultActivateSuccess>;
+    /**
+     * 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)
+     *
+     * The method is a convenience proxy of the same method from
+     * [@or-sdk/deployer](https://www.npmjs.com/package/@or-sdk/deployer).
+     *
+     * @example
+     * ```typescript
+     * const deactivatedFlowList = await flows.deactivateFlow(flowSource, fnShowProgress);
+     * ```
+     */
+    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, 
+    /** Deactivation polling options */
+    pollingOptions?: PollingOptions): Promise<PollingResultDeactivateSuccess>;
+    /**
+     * 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).
+     *
+     * The method is a convenience proxy of the same method from
+     * [@or-sdk/deployer](https://www.npmjs.com/package/@or-sdk/deployer).
+     *
+     * @example Fetch latest chunk of logs for the flow:
+     * ```typescript
+     * const flows = new Flows({token: '<token>', discoveryUrl: '<discovery-api-url>'});
+     * const logs = await flows.fetchFlowLogsChunk({flowId: '<flow-id>'});
+     * ```
+     *
+     * @example Fetch two chunks of flow logs
+     * ```typescript
+     * const flows = new Flows({token: '<token>', discoveryUrl: '<discovery-api-url>'});
+     * const chunk1 = await flows.fetchFlowLogsChunk({flowId: '<flow-id>'});
+     * const chunk2 = await flows.fetchFlowLogsChunk({
+     *   flowId: '<flow-id>',
+     *   next: chunk1.nextToken,
+     * });
+     * ```
+     *
+     * @example Fetch chunk of logs starting from 1 hour ago till now:
+     * ```typescript
+     * const flows = new Flows({token: '<token>', discoveryUrl: '<discovery-api-url>'});
+     * const logs = await flows.fetchFlowLogsChunk({
+     *   flowId: '<flow-id>',
+     *   start: Date.now() - 60 * 60 * 1000, // 60 minutes ago
+     * });
+     * ```
+     */
     fetchFlowLogsChunk(params: FetchFlowLogsChunkParams): Promise<FlowLogsChunkResponse>;
+    /**
+     * 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).
+     *
+     * The method is a convenience proxy of the same method from
+     * [@or-sdk/deployer](https://www.npmjs.com/package/@or-sdk/deployer).
+     *
+     * @example Fetch latest logs for the flow:
+     * ```typescript
+     * const flows = new Flows({token: '<token>', discoveryUrl: '<discovery-api-url>'});
+     * const logs = await flows.fetchAllFlowLogs({flowId: '<flow-id>'});
+     * ```
+     *
+     * @example Fetch all logs starting from 1 hour ago till now:
+     * ```typescript
+     * const flows = new Flows({token: '<token>', discoveryUrl: '<discovery-api-url>'});
+     * const logs = await flows.fetchAllFlowLogs({
+     *   flowId: '<flow-id>',
+     *   start: Date.now() - 60 * 60 * 1000, // 60 minutes ago
+     * });
+     * ```
+     */
     fetchAllFlowLogs(params: FetchFlowLogsParams): Promise<FlowLogsResponse>;
+    /**
+     * List data outs
+     *
+     * Supports cross-account logic (with super-admin token)
+     */
     listDataOuts(paginationOptions?: PaginationOptions, params?: ListDataOutsParams): Promise<List<DataOut>>;
+    /**
+     * Add tags to flow
+     *
+     * Supports cross-account logic (with super-admin token)
+     *
+     * @example
+     * ```typescript
+     * const flow = await flows.addTags(flowSource, ['tag-name']);
+     * ```
+     */
     addTags(source: Flow, tagNames: string[]): Promise<Flow>;
+    /**
+     * Remove tags from flow
+     *
+     * Supports cross-account logic (with super-admin token)
+     *
+     * @example
+     * ```typescript
+     * const flow = await flows.removeTags(flowSource, ['tag-name']);
+     * ```
+     */
     removeTags(source: Flow, tagNames: string[]): Promise<Flow>;
-    downloadTemplate(flowTemplateId: string, botId: string, shouldUpdateSteps?: boolean): Promise<DownloadTemplateResult>;
+    /**
+     * Download flow template into Space (Bot)
+     *
+     * Supports cross-account logic (with super-admin token)
+     *
+     * @example
+     * ```typescript
+     * const result = await flows.downloadTemplate('<flow-template-id>', '<bot-id>');
+     * ```
+     */
+    downloadTemplate(
+    /** Id of the flow template to download */
+    flowTemplateId: string, 
+    /** Space id (bot id) */
+    botId: string, 
+    /** If `true` update step templates to latest versions after download. Default `false`. */
+    shouldUpdateSteps?: boolean): Promise<DownloadTemplateResult>;
+    /**
+     * List unused step templates from flow source
+     *
+     * @example
+     * ```typescript
+     * const result = Flows.getUnusedStepTemplates(source);
+     * ```
+     */
     static listUnusedStepTemplates(source: Flow): StepTemplateRaw[];
-    static deleteUnusedStepTemplates(source: Flow, stepTemplates?: StepTemplateToDelete[]): Flow;
+    /**
+     * Delete unused step templates from flow source
+     *
+     * Can delete specific templates passed as 2nd argument otherwise deletes all unused templates.
+     *
+     * @example
+     * ```typescript
+     * const result = Flows.deleteUnusedStepTemplates(source, unusedTemplatesArr);
+     * ```
+     */
+    static deleteUnusedStepTemplates(
+    /** Flow source to delete unused step templates from */
+    source: Flow, 
+    /** List of specific unused step templates to delete. If not set will delete all unused step templates. */
+    stepTemplates?: StepTemplateToDelete[]): Flow;
+    /**
+     * List account or library flows that have or don't have specific step templates.
+     *
+     * Response would not include deleted flows.
+     *
+     * @example search for flows in current account which do not have the step template
+     * ```typescript
+     * const result = await flows.listFlowsByStepTemplate({
+     *   query: { id: '<step-template-id>' },
+     *   includesStep: false,
+     * });
+     * ```
+     *
+     * @example List flow labels in the library that have step templates
+     * with labels that start with 'Wait' and were not published by OneReach
+     * ```typescript
+     * const result = await client.listFlowsByStepTemplate({
+     *   query: {
+     *     label: { startsWith: 'Wait' },
+     *     publishedBy: { notILike: '%onereach%' },
+     *   },
+     *   projection: ['id', 'data.label'],
+     *   sandbox: true,
+     * });
+     * ```
+     */
     listFlowsByStepTemplate(params: ListFlowsByStepTemplateParams): Promise<List<Flow>>;
+    /**
+     * Only for SUPER_ADMIN token.
+     *
+     * List flows that use specific step template. Runs globally across all accounts.
+     *
+     * Response might include deleted flows, check `isDeleted` field.
+     *
+     * @example Search what flows use specific step templates:
+     * ```typescript
+     * const result = await flows.listFlowsByStepTemplateGlobal({
+     *   query: {
+     *     id: ['<step-template-id-1>', '<step-template-id-2>']
+     *   }
+     * });
+     * ```
+     *
+     * @example Search for flows that have step with versions '0.6.*' and return only flow ids and labels
+     * ```typescript
+     *   const result = await client.listFlowsByStepTemplateGlobal({
+     *     query: {
+     *       id: '<step-template-id>',
+     *       version: { like: '0.6.%' },
+     *     },
+     *     projection: ['id', 'accountId', 'botId', 'data.label'],
+     *   });
+     * ```
+     */
     listFlowsByStepTemplateGlobal(params: ListFlowsByStepTemplateGlobalParams): Promise<List<Flow>>;
+    /**
+     * Only for SUPER_ADMIN token.
+     *
+     * List step templates in the flow (in any account)
+     *
+     * @example List step templates in the flow by flow id and return only specific fields
+     * ```typescript
+     * const result = await flows.listStepTemplateByFlowGlobal({
+     *   id: '<flow-id>',
+     *   projection: ['label','version','id','isSandbox','isExternal']
+     * });
+     * ```
+     */
     listStepTemplateByFlowGlobal(params: ListStepTemplateParams): Promise<List<StepTemplateRaw>>;
+    /**
+     * List categories for library flows
+     *
+     * @example
+     * ```typescript
+     * const categories = await flows.listFlowCategories();
+     * ```
+     */
     listFlowCategories(): Promise<FlowCategoriesResponse>;
     private get crossAccountDataHubParams();
 }

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

@@ -1 +1 @@
-{"version":3,"file":"Flows.d.ts","sourceRoot":"","sources":["../../src/Flows.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,wBAAwB,EACxB,mBAAmB,EACnB,IAAI,EACJ,qBAAqB,EACrB,gBAAgB,EAChB,cAAc,EACd,4BAA4B,EAC5B,8BAA8B,EAC9B,oBAAoB,EACpB,eAAe,EACf,OAAO,EACP,sBAAsB,EACtB,sBAAsB,EACtB,aAAa,EACb,IAAI,EACJ,kBAAkB,EAClB,mCAAmC,EACnC,6BAA6B,EAC7B,eAAe,EACf,sBAAsB,EACtB,iBAAiB,EACjB,eAAe,EACf,oBAAoB,EACpB,QAAQ,EACR,wBAAwB,EACxB,2BAA2B,EAC5B,MAAM,eAAe,CAAC;AAGvB,qBAAa,KAAM,YAAW,QAAQ,CAAC,IAAI,CAAC;IAC1C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAO;IAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;gBAGlB,MAAM,EAAE,wBAAwB;gBAEhC,MAAM,EAAE,2BAA2B;IAyDlC,SAAS,CAAC,MAAM,GAAE,eAAoB,EAAE,iBAAiB,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IA0CvG,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,GAAE,aAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB9D,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IA+CpE,UAAU,CAErB,MAAM,EAAE,MAAM,GAAG,IAAI,EAGrB,WAAW,UAAO,GACjB,OAAO,CAAC,IAAI,CAAC;IAyBH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA0B1C,YAAY,CAEvB,UAAU,EAAE,IAAI,EAGhB,gBAAgB,UAAQ,EAGxB,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,oBAAoB,KAAK,IAAI,EAG3D,cAAc,CAAC,EAAE,cAAc,GAC9B,OAAO,CAAC,4BAA4B,CAAC;IAoB3B,cAAc,CAEzB,UAAU,EAAE,IAAI,EAGhB,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,oBAAoB,KAAK,IAAI,EAG3D,cAAc,CAAC,EAAE,cAAc,GAC9B,OAAO,CAAC,8BAA8B,CAAC;IAuC7B,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA6BpF,gBAAgB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IASxE,YAAY,CACvB,iBAAiB,GAAE,iBAAsB,EACzC,MAAM,GAAE,kBAAuB,GAC9B,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwBZ,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBxD,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA0B3D,gBAAgB,CAE3B,cAAc,EAAE,MAAM,EAGtB,KAAK,EAAE,MAAM,EAGb,iBAAiB,UAAQ,GACxB,OAAO,CAAC,sBAAsB,CAAC;WAsBpB,uBAAuB,CAAC,MAAM,EAAE,IAAI,GAAG,eAAe,EAAE;WAcxD,yBAAyB,CAErC,MAAM,EAAE,IAAI,EAGZ,aAAa,CAAC,EAAE,oBAAoB,EAAE,GACrC,IAAI;IA8BM,uBAAuB,CAAC,MAAM,EAAE,6BAA6B,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IA+CnF,6BAA6B,CACxC,MAAM,EAAE,mCAAmC,GAC1C,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAiCT,4BAA4B,CACvC,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAsBpB,kBAAkB,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAOlE,OAAO,KAAK,yBAAyB,GAIpC;CACF"}
+{"version":3,"file":"Flows.d.ts","sourceRoot":"","sources":["../../src/Flows.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,wBAAwB,EACxB,mBAAmB,EACnB,IAAI,EACJ,qBAAqB,EACrB,gBAAgB,EAChB,cAAc,EACd,4BAA4B,EAC5B,8BAA8B,EAC9B,oBAAoB,EACpB,eAAe,EACf,OAAO,EACP,sBAAsB,EACtB,sBAAsB,EACtB,aAAa,EACb,IAAI,EACJ,kBAAkB,EAClB,mCAAmC,EACnC,6BAA6B,EAC7B,eAAe,EACf,sBAAsB,EACtB,iBAAiB,EACjB,eAAe,EACf,oBAAoB,EACpB,QAAQ,EACR,wBAAwB,EACxB,2BAA2B,EAC5B,MAAM,eAAe,CAAC;AAGvB,qBAAa,KAAM,YAAW,QAAQ,CAAC,IAAI,CAAC;IAC1C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAO;IAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;IAE9B,kGAAkG;gBACtF,MAAM,EAAE,wBAAwB;IAC5C,qHAAqH;gBACzG,MAAM,EAAE,2BAA2B;IAiD/C;;;;;;;OAOG;IACU,SAAS,CAAC,MAAM,GAAE,eAAoB,EAAE,iBAAiB,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAgCpH;;;;;;;;;OASG;IACU,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,GAAE,aAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAW3E;;;;;;;;;;;OAWG;IACU,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgCjF;;;;;;;;;;;;;;MAcE;IACW,UAAU;IACrB,4EAA4E;IAC5E,MAAM,EAAE,MAAM,GAAG,IAAI;IAErB,8DAA8D;IAC9D,WAAW,UAAO,GACjB,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;;;;OASG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUvD;;;;;;;;;;;;;;;OAeG;IACU,YAAY;IACvB,iFAAiF;IACjF,UAAU,EAAE,IAAI;IAEhB,8DAA8D;IAC9D,gBAAgB,UAAQ;IAExB,0EAA0E;IAC1E,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,oBAAoB,KAAK,IAAI;IAE3D,iCAAiC;IACjC,cAAc,CAAC,EAAE,cAAc,GAC9B,OAAO,CAAC,4BAA4B,CAAC;IAIxC;;;;;;;;;;;;;;;OAeG;IACU,cAAc;IACzB,iFAAiF;IACjF,UAAU,EAAE,IAAI;IAEhB,mEAAmE;IACnE,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,oBAAoB,KAAK,IAAI;IAE3D,mCAAmC;IACnC,cAAc,CAAC,EAAE,cAAc,GAC9B,OAAO,CAAC,8BAA8B,CAAC;IAI1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACU,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAIjG;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,gBAAgB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIrF;;;;OAIG;IACU,YAAY,CACvB,iBAAiB,GAAE,iBAAsB,EACzC,MAAM,GAAE,kBAAuB,GAC9B,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAczB;;;;;;;;;OASG;IACU,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAcrE;;;;;;;;;OASG;IACU,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBxE;;;;;;;;;OASG;IACU,gBAAgB;IAC3B,0CAA0C;IAC1C,cAAc,EAAE,MAAM;IAEtB,wBAAwB;IACxB,KAAK,EAAE,MAAM;IAEb,0FAA0F;IAC1F,iBAAiB,UAAQ,GACxB,OAAO,CAAC,sBAAsB,CAAC;IAclC;;;;;;;OAOG;WACW,uBAAuB,CAAC,MAAM,EAAE,IAAI,GAAG,eAAe,EAAE;IAItE;;;;;;;;;OASG;WACW,yBAAyB;IACrC,uDAAuD;IACvD,MAAM,EAAE,IAAI;IAEZ,0GAA0G;IAC1G,aAAa,CAAC,EAAE,oBAAoB,EAAE,GACrC,IAAI;IAIP;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,uBAAuB,CAAC,MAAM,EAAE,6BAA6B,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAoBhG;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,6BAA6B,CACxC,MAAM,EAAE,mCAAmC,GAC1C,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAoBtB;;;;;;;;;;;;OAYG;IACU,4BAA4B,CACvC,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAcjC;;;;;;;OAOG;IACU,kBAAkB,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAOlE,OAAO,KAAK,yBAAyB,GAIpC;CACF"}

package/dist/types/types/base.d.ts

@@ -1,20 +1,63 @@
 import type { Token } from '@or-sdk/base';
 export type { Token };
 export type FlowsConfigBase = {
+    /**
+     * OneReach authentication token
+     */
     token: Token;
+    /**
+     * Account id for cross-account requests (super admin only)
+     */
     accountId?: string;
+    /**
+     * Allows to define custom feature for using with DataHubSvc API
+     */
     feature?: string;
 };
 export type FlowsConfigWithDiscovery = FlowsConfigBase & {
+    /**
+     * URL of OneReach service discovery API.
+     *
+     * Allows to fetch URLs of needed API's instead of defining them in the constructor.
+     */
     discoveryUrl: string;
+    /**
+     * URL of OneReach DataHubSvc API.
+     *
+     * Not needed if {@link FlowsConfig.discoveryUrl} is defined.
+     */
     dataHubSvcUrl?: never;
+    /**
+     * URL of OneReach Deployer API.
+     *
+     * Not needed if {@link FlowsConfig.discoveryUrl} is defined.
+     */
     deployerUrl?: never;
+    /**
+     * URL of OneReach Files API.
+     *
+     * Not needed if {@link FlowsConfig.discoveryUrl} is defined.
+     */
     filesApiUrl?: never;
 };
 export type FlowsConfigWithExplicitUrls = FlowsConfigBase & {
+    /**
+     * URL of OneReach DataHubSvc API.
+     */
     dataHubSvcUrl: string;
+    /**
+     * URL of OneReach Deployer API.
+     */
     deployerUrl: string;
+    /**
+     * URL of OneReach Files API.
+     */
     filesApiUrl: string;
+    /**
+     * URL of OneReach service discovery API.
+     *
+     * Not needed if API URLs are explicitly defined.
+     */
     discoveryUrl?: never;
 };
 export type FlowsConfig = FlowsConfigWithDiscovery | FlowsConfigWithExplicitUrls;

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

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/types/base.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAE1C,YAAY,EAAE,KAAK,EAAE,CAAC;AAEtB,MAAM,MAAM,eAAe,GAAG;IAI5B,KAAK,EAAE,KAAK,CAAC;IAKb,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG;IAMvD,YAAY,EAAE,MAAM,CAAC;IAOrB,aAAa,CAAC,EAAE,KAAK,CAAC;IAOtB,WAAW,CAAC,EAAE,KAAK,CAAC;IAOpB,WAAW,CAAC,EAAE,KAAK,CAAC;CACrB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,eAAe,GAAG;IAI1D,aAAa,EAAE,MAAM,CAAC;IAKtB,WAAW,EAAE,MAAM,CAAC;IAKpB,WAAW,EAAE,MAAM,CAAC;IAOpB,YAAY,CAAC,EAAE,KAAK,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,wBAAwB,GAAG,2BAA2B,CAAC"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/types/base.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAE1C,YAAY,EAAE,KAAK,EAAE,CAAC;AAEtB,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG;IACvD;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC;IAEtB;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC;IAEpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC;CACrB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,eAAe,GAAG;IAC1D;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,wBAAwB,GAAG,2BAA2B,CAAC"}

package/dist/types/types/flows.d.ts

@@ -1,6 +1,14 @@
 import { FlowEntity, ModelAttributes, ModelWhereAttributes } from './services/data-hub-svc';
 export type ListFlowsParams = {
+    /**
+     * Include deleted flows in result
+     * @default false
+     */
     includeDeleted?: boolean;
+    /**
+     * Include active (not deleted) flows in result
+     * @default true
+     */
     includeExisting?: boolean;
     query?: ModelWhereAttributes<FlowEntity>;
     includesStep?: boolean;

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

@@ -1 +1 @@
-{"version":3,"file":"flows.d.ts","sourceRoot":"","sources":["../../../src/types/flows.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAE5F,MAAM,MAAM,eAAe,GAAG;IAK5B,cAAc,CAAC,EAAE,OAAO,CAAC;IAMzB,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,KAAK,CAAC,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAEzC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,UAAU,CAAC,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IAEF,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IACzC,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,UAAU,CAAC,CAAC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,CAAC,EAAE;QACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE;QACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;KACd,EAAE,CAAA;CACJ,CAAC"}
+{"version":3,"file":"flows.d.ts","sourceRoot":"","sources":["../../../src/types/flows.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAE5F,MAAM,MAAM,eAAe,GAAG;IAC5B;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,KAAK,CAAC,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAEzC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,UAAU,CAAC,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IAEF,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IACzC,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,UAAU,CAAC,CAAC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,CAAC,EAAE;QACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE;QACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;KACd,EAAE,CAAA;CACJ,CAAC"}

package/dist/types/types/step-templates.d.ts

@@ -14,18 +14,39 @@ export type DownloadTemplateResult = {
     };
 };
 export type ListStepTemplateParams = {
+    /** Flow id */
     id: string;
+    /**
+     * If set step template records will have only fields from this list
+     * (e.g. `['id', 'label', 'outputExample.custom']` )
+     */
     projection?: ModelAttributes<StepTemplateEntity>;
 };
 export type ListFlowsByStepTemplateParams = {
+    /** Search criteria for step templates */
     query?: ModelWhereAttributes<StepTemplateEntity>;
+    /**
+     * If set flow records will have only fields from this list
+     * (e.g. `['id', 'data.label', 'data.deploy.role']` )
+     */
     projection?: ModelAttributes<FlowEntity>;
+    /**
+     * If `true` would return flows that have step template(s) found via query,
+     * otherwise flows that do not have them. Default `true`.
+     */
     includesStep?: boolean;
+    /** If `true` search for step templates in the library, otherwise in the current account. Default `false`. */
     sandbox?: boolean;
 };
 export type ListFlowsByStepTemplateGlobalParams = {
+    /** Search criteria for step templates */
     query: ModelWhereAttributes<Pick<StepTemplateEntity, 'id' | 'version'>>;
+    /**
+     * If set flow records will have only fields from this list
+     * (e.g. `['id', 'data.label', 'data.deploy.role']` )
+     */
     projection?: ModelAttributes<FlowEntity>;
+    /** If `true` would return flows that have stem template(s), otherwise flows that do not have them. Default `true`. */
     includesStep?: boolean;
 };
 //# sourceMappingURL=step-templates.d.ts.map

package/dist/types/types/step-templates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"step-templates.d.ts","sourceRoot":"","sources":["../../../src/types/step-templates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,kBAAkB,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAErH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IAEnC,EAAE,EAAE,MAAM,CAAC;IAMX,UAAU,CAAC,EAAE,eAAe,CAAC,kBAAkB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAE1C,KAAK,CAAC,EAAE,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;IAMjD,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IAMzC,YAAY,CAAC,EAAE,OAAO,CAAC;IAGvB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAEhD,KAAK,EAAE,oBAAoB,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC;IAMxE,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IAGzC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAA"}
+{"version":3,"file":"step-templates.d.ts","sourceRoot":"","sources":["../../../src/types/step-templates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,kBAAkB,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAErH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,cAAc;IACd,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC,kBAAkB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,yCAAyC;IACzC,KAAK,CAAC,EAAE,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;IAEjD;;;OAGG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IAEzC;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,6GAA6G;IAC7G,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAChD,yCAAyC;IACzC,KAAK,EAAE,oBAAoB,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC;IAExE;;;OAGG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IAEzC,sHAAsH;IACtH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAA"}

package/dist/types/utils/deleteUnusedStepTemplates.d.ts

@@ -1,5 +1,12 @@
 import type { Flow } from '@or-sdk/deployer';
 import type { StepTemplateToDelete } from '../types';
-declare function deleteUnusedStepTemplates(source: Flow, stepTemplates?: StepTemplateToDelete[]): Flow;
+/**
+ * Delete unused step templates from the flow source
+ */
+declare function deleteUnusedStepTemplates(
+/** Flow source to delete unused step templates from */
+source: Flow, 
+/** List of specific step templates to delete. If not set of empty array delete all unused step templates. */
+stepTemplates?: StepTemplateToDelete[]): Flow;
 export default deleteUnusedStepTemplates;
 //# sourceMappingURL=deleteUnusedStepTemplates.d.ts.map

package/dist/types/utils/deleteUnusedStepTemplates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deleteUnusedStepTemplates.d.ts","sourceRoot":"","sources":["../../../src/utils/deleteUnusedStepTemplates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAMrD,iBAAS,yBAAyB,CAEhC,MAAM,EAAE,IAAI,EAGZ,aAAa,CAAC,EAAE,oBAAoB,EAAE,GACrC,IAAI,CAkBN;AAED,eAAe,yBAAyB,CAAC"}
+{"version":3,"file":"deleteUnusedStepTemplates.d.ts","sourceRoot":"","sources":["../../../src/utils/deleteUnusedStepTemplates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAGrD;;GAEG;AACH,iBAAS,yBAAyB;AAChC,uDAAuD;AACvD,MAAM,EAAE,IAAI;AAEZ,6GAA6G;AAC7G,aAAa,CAAC,EAAE,oBAAoB,EAAE,GACrC,IAAI,CAkBN;AAED,eAAe,yBAAyB,CAAC"}

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

@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export { default as listUnusedStepTemplates } from './listUnusedStepTemplates';
 export { default as deleteUnusedStepTemplates } from './deleteUnusedStepTemplates';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,OAAO,IAAI,yBAAyB,EAAE,MAAM,6BAA6B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,OAAO,IAAI,yBAAyB,EAAE,MAAM,6BAA6B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@or-sdk/flows",
-  "version": "2.7.2-beta.4026.0",
+  "version": "2.7.2",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -30,5 +30,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "gitHead": "bf599a2fadd6dfc1c2ec1db86772288ef6fb4bc4"
 }