@or-sdk/flows 0.28.0-beta.631.0 → 0.28.0

package/src/Flows.ts

@@ -1,31 +1,30 @@
 import { List, makeList } from '@or-sdk/base';
-import { DataHub, GraphqlResponseCheckExecution, GraphqlResponse, GraphqlResponseDelete, OperationNames } from '@or-sdk/data-hub';
+import { DataHubSvc, setDiff } from '@or-sdk/data-hub-svc';
 import { Deployer, Flow, PollingResultActivateSuccess, PollingResultDeactivateSuccess, StepTemplateRaw } from '@or-sdk/deployer';
-import { FlowsConfig, FlowListResponse, ListFlowsParams, StepTemplateToDelete } from './types';
-import { QUERY_DELETE, ENTITY_NAME } from './constants';
+import {
+  FlowsConfig,
+  ListFlowsParams,
+  StepTemplateToDelete,
+  PaginationOptions,
+  DownloadTemplateResult,
+  ListDataOutsParams, DataOut, GetFlowParams,
+} from './types';
 import { Tags, Taggable, filterTagIds, addTagsIds, removeTagIds } from '@or-sdk/tags';
 import { listUnusedStepTemplates, deleteUnusedStepTemplates } from './utils';
 
 export class Flows implements Taggable<Flow> {
-  private readonly dataHub: DataHub;
+  private readonly dataHubSvc: DataHubSvc;
   private readonly deployer: Deployer;
   private readonly tags: Tags;
 
-  /**
-   * ```typescript
-   * import { Flows } from '@or-sdk/flows'
-   * const flows = new Flows({token: 'my-account-token-string', baseUrl: 'http://example.flows/endpoint'});
-   * await flows.init();
-   * ```
-   */
   constructor(params: FlowsConfig) {
-    const { discoveryUrl, token, accountId, dataHubUrl, deployerUrl } = params;
+    const { discoveryUrl, token, accountId, dataHubSvcUrl, deployerUrl } = params;
 
-    this.dataHub = new DataHub({
+    this.dataHubSvc = new DataHubSvc({
       token,
       discoveryUrl,
       accountId,
-      dataHubUrl,
+      dataHubSvcUrl,
     });
     this.deployer = new Deployer({
       token,
@@ -37,72 +36,46 @@ export class Flows implements Taggable<Flow> {
       token,
       discoveryUrl,
       accountId,
-      dataHubUrl,
+      dataHubSvcUrl,
     });
   }
 
-  async init() {
-    await Promise.all([
-      this.dataHub.init(),
-      this.deployer.init(),
-      this.tags.init(),
-    ]);
-  }
-
   /**
-   * List identifiers
-   *
-   * If botId is passed - lists flows from the specified bot
+   * List flows
    * ```typescript
-   * const flowsList = await flows.listFlows('bot-id');
+   * const flowsList = await flows.listFlows();
    * ```
    */
-  public async listFlows(botId?: string, params?: ListFlowsParams): Promise<List<Flow>> {
-    const requestParams = {
-      // defaults
-      includeDeleted: false,
-      includeExisting: true,
-      projection: [
-        'id',
-        'version',
-        'botId',
-        'data.label',
-        'data.color',
-        'data.description',
-        'data.isHidden',
-        'tags',
-        'dateModified',
-      ],
+  public async listFlows(botId?: string, params: ListFlowsParams = {}, paginationOptions: PaginationOptions = {}): Promise<List<Flow>> {
+    let includeQuery = {};
+
+    if (params.includeDeleted === false || (params.includeDeleted === undefined && params.includeExisting !== false)) {
+      includeQuery = { isDeleted: false };
+    }
+    if (params.includeExisting === false) {
+      includeQuery = { isDeleted: true };
+    }
 
-      // overrides
+    const paramsToSend = {
       ...params,
+      query: {
+        ...params.query,
+        ...includeQuery,
+      },
+      ...paginationOptions,
+      ... this.dataHubSvc.isCrossAccount ? { accountId: this.dataHubSvc.currentAccountId } : {},
     };
 
-    const route = `/v2/${this.dataHub.currentAccountId ? this.dataHub.currentAccountId : 'current'}/flows`;
-
-    let result: FlowListResponse;
-    let flowList: Flow[] = [];
-    const query: { botId?: string; last?: string; } = { botId: botId ? botId : undefined };
-    const projection = JSON.stringify(requestParams.projection);
+    delete paramsToSend.includeDeleted;
+    delete paramsToSend.includeExisting;
 
-    do {
-      result = await this.dataHub.makeRequest({
-        method: 'GET',
-        route,
-        params: {
-          includeDeleted: requestParams.includeDeleted,
-          includeExisting: requestParams.includeExisting,
-          projection,
-          query: JSON.stringify(query),
-        },
-      });
-
-      flowList = [...flowList, ...result.items];
-      query.last = result.last;
-
-    } while (result.last);
+    const result = await this.dataHubSvc.makeRequest<Flow[]>({
+      method: 'GET',
+      route: 'flows',
+      params: paramsToSend,
+    });
 
-    return makeList<Flow>(flowList);
+    return makeList<Flow>(result);
   }
 
   /**
@@ -111,19 +84,14 @@ export class Flows implements Taggable<Flow> {
    * const flow = await flows.getFlow('flow-id');
    * ```
    */
-  public async getFlow(id: string): Promise<Flow> {
-    const route = `/v2/${this.dataHub.currentAccountId ? this.dataHub.currentAccountId : 'current'}/flow/${id}`;
-
-    const params = {
-      includeDeleted: false,
-      includeExisting: true,
-      sandbox: false,
-    };
-
-    return await this.dataHub.makeRequest<Flow>({
+  public async getFlow(id: string, params: GetFlowParams = {}): Promise<Flow> {
+    return this.dataHubSvc.makeRequest<Flow>({
       method: 'GET',
-      route,
-      params,
+      route: `flows/${id}`,
+      params: {
+        ...params,
+        ... this.dataHubSvc.isCrossAccount ? { accountId: this.dataHubSvc.currentAccountId } : {},
+      },
     });
   }
 
@@ -136,56 +104,59 @@ export class Flows implements Taggable<Flow> {
    * ```
    */
   public async saveFlow(source: Flow): Promise<Flow> {
-    const route = `/v2/${this.dataHub.currentAccountId ? this.dataHub.currentAccountId : 'current'}/flow/${source.id ? source.id : 'new'}`;
-
-    const data = {
-      flow: source,
-      previousVersion: source.id ? source.version : undefined,
-    };
-
-    return await this.dataHub.makeRequest<Flow>({
+    const result = await this.dataHubSvc.makeRequest<{ id: string; version: string; }>({
       method: 'POST',
-      route,
-      data,
+      route: `flows/${(source.id && source.id !== 'new') ? source.id : 'new'}`,
+      data: {
+        flow: (source.id && source.id !== 'new') ? source : {
+          ...source,
+          id: 'new', //TODO: remove later
+        },
+        previousVersion: (source.id && source.id !== 'new') ? source.version : undefined,
+      },
+      params: {
+        ... this.dataHubSvc.isCrossAccount ? { accountId: this.dataHubSvc.currentAccountId } : {},
+      },
     });
+
+    return setDiff<Flow>(source, result);
   }
 
   /**
    * Delete flow
    * ```typescript
-   * const result = await flows.deleteFlow(flowSource, flowAlias);
+   * await flows.deleteFlow('flow-id');
    * ```
    */
-  public async deleteFlow(source: Flow, flowAlias = 'dev'): Promise<GraphqlResponseCheckExecution> {
-    if (this.dataHub.isCrossAccount) {
-      throw Error('Cross-account deleting is not implemented.');
-    }
+  public async deleteFlow(flowId: string | Flow, temporarily = true): Promise<void> {
+    const flowSourceId = typeof flowId === 'string' ? flowId : flowId.id;
 
-    const variables = {
-      entity: ENTITY_NAME,
+    return this.dataHubSvc.makeRequest<void>({
+      method: 'DELETE',
+      route: `flows/${flowId}`,
       data: {
-        id: source.id,
-        flowAlias,
-        subscribe: true,
-        role: source.data.deploy.role,
+        temporarily,
+      },
+      params: {
+        ... this.dataHubSvc.isCrossAccount ? { accountId: this.dataHubSvc.currentAccountId } : {},
       },
-    };
-
-    const operationName = this.dataHub.getOperationName(OperationNames.DELETE_TEMPORARILY);
-
-    const data = {
-      operationName,
-      query: QUERY_DELETE,
-      variables,
-    };
-
-    const result = await this.dataHub.makeRequest<GraphqlResponse<void>>({
-      method: 'POST',
-      route: '/graphql',
-      data,
     });
+  }
 
-    return this.dataHub.subscribe((result.data[operationName] as GraphqlResponseDelete).requestId);
+  /**
+   * Recover flow
+   * ```typescript
+   * await flows.recoverFlow('flow-id');
+   * ```
+   */
+  public async recoverFlow(flowId: string): Promise<void> {
+    return this.dataHubSvc.makeRequest<void>({
+      method: 'PATCH',
+      route: `flows/${flowId}`,
+      params: {
+        ... this.dataHubSvc.isCrossAccount ? { accountId: this.dataHubSvc.currentAccountId } : {},
+      },
+    });
   }
 
   /**
@@ -208,6 +179,26 @@ export class Flows implements Taggable<Flow> {
     return this.deployer.deactivateFlow(source, flowAlias, deleteLambda);
   }
 
+  /**
+   * List data outs
+   * ```typescript
+   * const result = await flows.downloadTemplate('flow-template-id', 'bot-id');
+   * ```
+   */
+  public async listDataOuts(paginationOptions: PaginationOptions = {}, params: ListDataOutsParams = {}): Promise<List<DataOut>> {
+    const result = await this.dataHubSvc.makeRequest<DataOut[]>({
+      method: 'GET',
+      route: '/flows/data-outs',
+      params: {
+        ...params,
+        ...paginationOptions,
+        ... this.dataHubSvc.isCrossAccount ? { accountId: this.dataHubSvc.currentAccountId } : {},
+      },
+    });
+
+    return makeList<DataOut>(result);
+  }
+
   /**
    * Add tags
    * ```typescript
@@ -252,6 +243,26 @@ export class Flows implements Taggable<Flow> {
     });
   }
 
+  /**
+   * Download flow template to account
+   * ```typescript
+   * const result = await flows.downloadTemplate('flow-template-id', 'bot-id');
+   * ```
+   */
+  public async downloadTemplate(flowTemplateId: string, botId: string, shouldUpdateSteps = false): Promise<DownloadTemplateResult> {
+    return this.dataHubSvc.makeRequest<DownloadTemplateResult>({
+      method: 'PUT',
+      route: `flows/${botId}`,
+      data: {
+        flowId: flowTemplateId,
+        shouldUpdateSteps,
+      },
+      params: {
+        ... this.dataHubSvc.isCrossAccount ? { accountId: this.dataHubSvc.currentAccountId } : {},
+      },
+    });
+  }
+
   /**
    * List unused step templates from flow source
    * ```typescript

package/src/constants.ts

@@ -1,12 +1,2 @@
-export { DATA_HUB_SERVICE_KEY } from '@or-sdk/data-hub';
+export { DATA_HUB_SVC_SERVICE_KEY } from '@or-sdk/data-hub-svc';
 export { DEPLOYER_SERVICE_KEY } from '@or-sdk/deployer';
-
-export const QUERY_DELETE = `mutation deleteTemporarily($entity: EntityType!, $data: DeleteInput!) {
-  deleteTemporarily(entity: $entity, data: $data) {
-    ... on AsyncRequest {
-      requestId
-    }
-  }
-}`;
-
-export const ENTITY_NAME = 'FLOW';

package/src/index.ts

@@ -1,2 +1,4 @@
 export { Flows } from './Flows';
 export * from './types';
+export * from './constants';
+

package/src/types.ts

@@ -1,5 +1,4 @@
 import { Token } from '@or-sdk/base';
-import { Flow } from '@or-sdk/deployer';
 
 export type FlowsConfig = {
   /**
@@ -18,9 +17,9 @@ export type FlowsConfig = {
   accountId?: string;
 
   /**
-   * Url of OneReach DataHub api
+   * Url of OneReach DataHubSvc api
    */
-  dataHubUrl?: string;
+  dataHubSvcUrl?: string;
 
   /**
    * Url of OneReach Deployer api
@@ -28,19 +27,59 @@ export type FlowsConfig = {
   deployerUrl?: string;
 };
 
-export type FlowListResponse = {
-  count: number;
-  items: Flow[];
-  last?: string;
+export type ListFlowsParams = {
+  includeDeleted?: boolean;
+  includeExisting?: boolean;
+  query?: {
+    [key: string]: unknown;
+  };
+  projection?: string[];
+  group?: string[];
+  sandbox?: boolean;
 };
 
-export type ListFlowsParams = {
-  includeDeleted: boolean;
-  includeExisting: boolean;
-  projection: string[];
+export type ListDataOutsParams = {
+  query?: {
+    [key: string]: unknown;
+  };
+  projection?: string[];
+  group?: string[];
+  sandbox?: boolean;
+};
+
+export type PaginationOptions = {
+  limit?: number;
+  offset?: number;
+};
+
+export type GetFlowParams = {
+  query?: {
+    [key: string]: unknown;
+  };
+  projection?: string[];
+  sandbox?: boolean;
+};
+
+export type DataOut = {
+  flowId: string;
+  botId: string;
+  name: string;
+  type: string;
+  ttl: number;
+  meta: string;
+  outputExample: string;
+  stepLabel: string;
+  stepId: string;
 };
 
 export type StepTemplateToDelete = {
   id: string;
   [key: string]: unknown;
 };
+
+export type DownloadTemplateResult = {
+  id: string;
+  data: {
+    label: string;
+  };
+};

package/tsconfig.esm.json

@@ -4,7 +4,7 @@
     "outDir": "./dist/esm",
     "declarationDir": "./dist/types",
     "module": "ES6",
-    "target": "es2022",
+    "target": "es6",
     "rootDir": "./src",
     "declaration": true,
     "declarationMap": true