@or-sdk/idw 3.1.1 → 4.0.0

package/dist/types/migration-handler.d.ts

@@ -1,20 +0,0 @@
-import { Accounts } from '@or-sdk/accounts';
-import { Graphs } from '@or-sdk/graph';
-import { Users } from '@or-sdk/users';
-import { Settings } from '@or-sdk/settings';
-import { Flows } from '@or-sdk/flows';
-export default class MigrationHandler {
-    private graphApi;
-    private users;
-    private accounts;
-    private settings;
-    private accountId;
-    private flows;
-    private migrations;
-    constructor(graphApi: Graphs, users: Users, accounts: Accounts, settings: Settings, accountId: string | undefined, flows: Flows);
-    applyMigrations(): Promise<void>;
-    saveVersion(currentLatestVersion: number): Promise<void>;
-    deleteMigrationVersion(): Promise<void>;
-    findAccountsMigrationVersion(): Promise<any>;
-}
-//# sourceMappingURL=migration-handler.d.ts.map

package/dist/types/migration-handler.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"migration-handler.d.ts","sourceRoot":"","sources":["../../src/migration-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAA6B,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAIvE,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAItC,MAAM,CAAC,OAAO,OAAO,gBAAgB;IAIjC,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,KAAK;IARf,OAAO,CAAC,UAAU,CAA6B;gBAGrC,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,MAAM,GAAG,SAAS,EAC7B,KAAK,EAAE,KAAK;IAkBhB,eAAe;IAwBf,WAAW,CAAC,oBAAoB,EAAE,MAAM;IAaxC,sBAAsB;IAOtB,4BAA4B;CAWnC"}

package/dist/types/migrations/Migration__1.d.ts

@@ -1,6 +0,0 @@
-import { MigrationBase } from '../migration-base';
-export default class Migration__1 extends MigrationBase {
-    up(): Promise<void>;
-    checkOrSetupIDWInfo(): Promise<void>;
-}
-//# sourceMappingURL=Migration__1.d.ts.map

package/dist/types/migrations/Migration__1.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Migration__1.d.ts","sourceRoot":"","sources":["../../../src/migrations/Migration__1.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AASlD,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,aAAa;IAC/C,EAAE;IAIF,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;CAkB3C"}

package/dist/types/migrations/Migration__2.d.ts

@@ -1,7 +0,0 @@
-import { MigrationBase } from '../migration-base';
-export default class Migration__2 extends MigrationBase {
-    up(): Promise<void>;
-    private createChannels;
-    private checkIfChannelsExist;
-}
-//# sourceMappingURL=Migration__2.d.ts.map

package/dist/types/migrations/Migration__2.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Migration__2.d.ts","sourceRoot":"","sources":["../../../src/migrations/Migration__2.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAyClD,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,aAAa;IAC/C,EAAE;YAOM,cAAc;YAUd,oBAAoB;CAQnC"}

package/dist/types/migrations/Migration__3.d.ts

@@ -1,5 +0,0 @@
-import { MigrationBase } from '../migration-base';
-export default class Migration__3 extends MigrationBase {
-    up(): Promise<void>;
-}
-//# sourceMappingURL=Migration__3.d.ts.map

package/dist/types/migrations/Migration__3.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Migration__3.d.ts","sourceRoot":"","sources":["../../../src/migrations/Migration__3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAIlD,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,aAAa;IAC/C,EAAE;CAuCT"}

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

@@ -1,4 +0,0 @@
-export { default as Migration__1 } from './Migration__1';
-export { default as Migration__2 } from './Migration__2';
-export { default as Migration__3 } from './Migration__3';
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/migrations/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC"}

package/src/idw.ts

@@ -1,291 +0,0 @@
-import { Settings } from '@or-sdk/settings';
-import { Base } from '@or-sdk/base';
-import { Graphs } from '@or-sdk/graph';
-import { Users } from '@or-sdk/users';
-import { Accounts } from '@or-sdk/accounts';
-import { GRAPH_NAME, SERVICE_KEY } from './constants';
-import { IDWConfig } from './types';
-import MigrationHandler from './migration-handler';
-import { Flow } from '@or-sdk/deployer';
-import { Flows } from '@or-sdk/flows';
-/**
- * OneReach IDW service client
- *  ## Installation:
- * ```
- * $ npm i @or-sdk/idw
- * ```
- */
-export class IDW extends Base {
-  private readonly graphApi: Graphs;
-  private readonly users: Users;
-  private readonly accounts: Accounts;
-  private readonly settings: Settings;
-  private readonly flows: Flows;
-  private accountId: string | undefined;
-  private migrationHandler: MigrationHandler;
-
-  /**
-   * ```typescript
-   * import { IDW } from '@or-sdk/idw'
-   * import config from '../config';
-   *
-   * const idw = new IDW({
-   *   graphUrl: config.GRAPHS_API_URL,
-   *   token: 'account-token-string'
-   * })
-   *  ```
-   */
-  constructor(params: IDWConfig) {
-    const {
-      accountId,
-      discoveryUrl,
-      graphUrl,
-      sdkApiUrl,
-      token,
-    } = params;
-
-    super({
-      accountId,
-      discoveryUrl,
-      serviceKey: SERVICE_KEY,
-      token,
-    });
-
-    this.graphApi = new Graphs({
-      accountId,
-      discoveryUrl,
-      graphUrl,
-      token,
-    });
-    this.users = new Users({
-      accountId,
-      token,
-      discoveryUrl,
-      sdkUrl: sdkApiUrl,
-    });
-    this.accounts = new Accounts({
-      token,
-      discoveryUrl,
-      sdkUrl: sdkApiUrl,
-    });
-    this.settings = new Settings({
-      token,
-      sdkUrl: sdkApiUrl,
-    });
-    this.flows = new Flows({
-      token,
-      discoveryUrl,
-    });
-
-    this.accountId = accountId;
-
-    this.migrationHandler = new MigrationHandler(
-      this.graphApi,
-      this.users,
-      this.accounts,
-      this.settings,
-      this.accountId,
-      this.flows
-    );
-  }
-
-  async runMigrations() {
-    await this.migrationHandler.applyMigrations();
-  }
-
-  async checkOrCreateDb() {
-    try {
-      await this.graphApi.getGraphInfo(GRAPH_NAME);
-    } catch (e) {
-      this.createDb();
-      // TODO: This function removes account setting storing the migration version
-      // to apply all migrations after creating db.
-      // Will be moved to the backend.
-      this.migrationHandler.deleteMigrationVersion();
-    }
-  }
-
-  private async createDb() {
-    await this.graphApi.createGraph({ name: GRAPH_NAME });
-  }
-
-  async createOrUpdateFlow(flow: Flow) {
-    const id = flow.id;
-    if (id === undefined) {
-      throw new Error('Only flows with id can be added to the IDW graph');
-    }
-
-    if (flow.isDeleted) {
-      return await this.deleteFlow(id);
-    }
-
-    const { username, userId } = await this.users.getCurrentUser();
-
-    await this.graphQuery(`
-      MERGE (flow:FLOW { id: $id })
-      ON MATCH
-        SET flow.createdAt = $createdAt,
-            flow.createdBy = $userId,
-            flow.description = $description,
-            flow.groupId = $groupId,
-            flow.name = $name,
-            flow.updatedAt = $updatedAt,
-            flow.updatedBy = $username,
-            flow.steps = $steps
-      ON CREATE
-        SET flow.createdAt = $createdAt,
-            flow.createdBy = $userId,
-            flow.description = $description,
-            flow.groupId = $groupId,
-            flow.isActive = false,
-            flow.name = $name,
-            flow.updatedAt = $updatedAt,
-            flow.updatedBy = $username,
-            flow.steps = $steps
-      RETURN flow
-    `, {
-      createdAt: flow.dateCreated,
-      description: flow.data.description,
-      groupId: flow.botId,
-      id,
-      name: flow.data.label,
-      updatedAt: flow.dateModified,
-      username,
-      userId,
-      steps: flow.data.trees?.main?.steps?.length ?? 0,
-    });
-
-    await this.graphQuery(`
-      MATCH (flow:FLOW { id: $id })
-      OPTIONAL MATCH (flow)-[channelRelations:IMPLEMENTS { isActive: false }]->(:CHANNEL)
-      OPTIONAL MATCH (flow)-[skillRelations:IMPLEMENTS { isActive: false }]->(:SKILL)
-      DELETE channelRelations, skillRelations
-    `, { id });
-
-    const channel = flow.data.meta.idw?.channel;
-    const skills: string[] | undefined = flow.data.meta.idw?.skills;
-
-    if (channel !== undefined && channel.length !== 0) {
-      await this.graphQuery(`
-        MATCH (flow:FLOW { id: $id }),
-              (channel:CHANNEL { id: $channel })
-        MERGE (flow)-[relationship:IMPLEMENTS]->(channel)
-        ON CREATE
-          SET relationship.isActive = false
-      `, {
-        channel,
-        id,
-      });
-    }
-
-    if (skills?.length) {
-      const preparedIds = skills.map(id => `'${id}'`);
-      await this.graphQuery(`
-        MATCH (flow:FLOW { id: $id }), (skill:SKILL)
-        WHERE skill.id in [${preparedIds}]
-        MERGE (flow)-[relationship:IMPLEMENTS]->(skill)
-        ON CREATE
-          SET relationship.isActive = false
-      `, {
-        id,
-      });
-    }
-  }
-
-  async deleteFlow(id: string) {
-    await this.graphQuery(`
-      MATCH (flow:FLOW { id: $id })
-      DETACH DELETE flow
-    `, { id });
-  }
-
-  async deleteFlows(ids: string[]) {
-    if (ids.length) {
-      await this.graphQuery(`
-      MATCH (flow:FLOW)
-      where flow.id in [${ids.map(id => `'${id}'`)}]
-      DETACH DELETE flow
-    `);
-    }
-  }
-
-  async activateFlow(flow: Flow) {
-    const id = flow.id;
-    if (id === undefined) {
-      throw new Error('Only flows with id can be added to the IDW graph');
-    }
-
-    await this.graphQuery(`
-      MATCH (flow:FLOW { id: $id })
-      OPTIONAL MATCH (flow)-[channelRelations:IMPLEMENTS]->(:CHANNEL)
-      OPTIONAL MATCH (flow)-[skillRelations:IMPLEMENTS]->(:SKILL)
-      DELETE channelRelations, skillRelations
-      SET flow.activatedAt = $activatedAt,
-          flow.isActive = true
-    `, {
-      activatedAt: Date.now(),
-      id,
-    });
-
-    const channel = flow.data.meta.idw?.channel;
-    const skills: string[] | undefined = flow.data.meta.idw?.skills;
-
-    if (channel !== undefined && channel.length !== 0) {
-      await this.graphQuery(`
-        MATCH (flow:FLOW { id: $id }),
-              (channel:CHANNEL { id: $channel })
-        MERGE (flow)-[relationship:IMPLEMENTS]->(channel)
-        SET relationship.isActive = true
-      `, {
-        channel,
-        id,
-      });
-    }
-
-    if (skills?.length) {
-      const preparedIds = skills.map(id => `'${id}'`);
-      await this.graphQuery(`
-        MATCH (flow:FLOW { id: $id }), (skill:SKILL)
-        WHERE skill.id in [${preparedIds}]
-        MERGE (flow)-[relationship:IMPLEMENTS]->(skill)
-        SET relationship.isActive = true
-      `, {
-        id,
-      });
-    }
-  }
-
-  async deactivateFlow(id: string) {
-    await this.graphQuery(`
-      MATCH (flow:FLOW { id: $id })
-      OPTIONAL MATCH (flow)-[channelRelations:IMPLEMENTS]->(:CHANNEL)
-      OPTIONAL MATCH (flow)-[skillRelations:IMPLEMENTS]->(:SKILL)
-      SET flow.isActive = false,
-          channelRelations.isActive = false,
-          skillRelations.isActive = false
-      REMOVE flow.activatedAt
-      RETURN flow
-    `, { id });
-  }
-
-  private async graphQuery(query: string, params?: Record<string, null | number | string | boolean>) {
-    //create graph if not exists
-    try {
-      await this.checkOrCreateDb();
-    } catch (e) {
-      console.warn(e);
-      // TODO: handle errors 🤔
-    }
-
-    try {
-      return await this.graphApi.query({
-        graph: GRAPH_NAME,
-        params,
-        query,
-      });
-    } catch (e) {
-      console.warn(e);
-      // TODO: handle errors 🤔
-    }
-  }
-}

package/src/migration-base.ts

@@ -1,35 +0,0 @@
-import { Accounts } from '@or-sdk/accounts';
-import { Graphs } from '@or-sdk/graph';
-import { Settings } from '@or-sdk/settings';
-import { Users } from '@or-sdk/users';
-import { Flows } from '@or-sdk/flows';
-
-export interface MigrationsParams {
-  graphApi: Graphs;
-  users: Users;
-  accounts: Accounts;
-  settings: Settings;
-  accountId: string | undefined;
-}
-
-export abstract class MigrationBase {
-  constructor(
-    protected graphApi: Graphs,
-    protected users: Users,
-    protected accounts: Accounts,
-    protected settings: Settings,
-    protected accountId: string | undefined,
-    protected flows: Flows
-  ) {
-  }
-
-  abstract up(): Promise<void>;
-
-  protected async resolveAccountId(): Promise<string> {
-    return this.accountId ?? (async () => {
-      const { accountId } = await this.users.getCurrentUser();
-      this.accountId = accountId;
-      return accountId;
-    })();
-  }
-}

package/src/migration-handler.ts

@@ -1,94 +0,0 @@
-import { Accounts } from '@or-sdk/accounts';
-import { Graphs } from '@or-sdk/graph';
-import { Users } from '@or-sdk/users';
-import { AccountRouteDeletePayload, Settings } from '@or-sdk/settings';
-import { MigrationBase } from './migration-base';
-import { SERVICE_KEY, VERSION_PROP } from './constants';
-import * as migrations from './migrations';
-import { Flows } from '@or-sdk/flows';
-
-const PREFIX = 'Migration__';
-
-export default class MigrationHandler {
-  private migrations: Map<string, MigrationBase>;
-
-  constructor(
-    private graphApi: Graphs,
-    private users: Users,
-    private accounts: Accounts,
-    private settings: Settings,
-    private accountId: string | undefined,
-    private flows: Flows
-  ) {
-
-    this.migrations = new Map(
-      Object.values(migrations)
-        .map(ctor => [
-          ctor.name, new ctor(
-            this.graphApi,
-            this.users,
-            this.accounts,
-            this.settings,
-            this.accountId,
-            this.flows
-          ),
-        ])
-    );
-  }
-
-  async applyMigrations() {
-    const accountsLatestVersion = (await this.findAccountsMigrationVersion()) ?? 0;
-
-    const migrationVersions = Array.from(this.migrations.keys()).map(migrationName => {
-      const [, version] = migrationName.split(PREFIX);
-      return Number(version);
-    }).sort();
-
-    for (let i = 0;i < migrationVersions.length;i++) {
-      if (migrationVersions[i] > accountsLatestVersion) {
-        const migration = this.migrations.get(PREFIX + migrationVersions[i]);
-        if (migration) {
-          try {
-            await migration.up();
-            await this.saveVersion(migrationVersions[i]);
-
-          } catch (e) {
-            throw new Error(`Migration ${migration.constructor.name} is not applied`);
-          }
-        }
-      }
-    }
-  }
-
-  async saveVersion(currentLatestVersion: number) {
-    try {
-      const params = {
-        key: `${SERVICE_KEY}.${VERSION_PROP}`,
-        value: currentLatestVersion,
-      };
-      await this.settings.setAccountSettings(params);
-    } catch (e) {
-      // eslint-disable-next-line no-console
-      throw new Error(`Error while saving migration "${PREFIX + currentLatestVersion}"`);
-    }
-  }
-
-  async deleteMigrationVersion() {
-    const params = {
-      key: `${SERVICE_KEY}.${VERSION_PROP}`,
-    } as AccountRouteDeletePayload;
-    await this.settings.deleteAccountSettings(params);
-  }
-
-  async findAccountsMigrationVersion() {
-    try {
-      const params = {
-        key: `${SERVICE_KEY}.${VERSION_PROP}`,
-      };
-      return await this.settings.getAccountSettings(params);
-    } catch (e) {
-      // eslint-disable-next-line no-console
-      throw new Error('Error while getting account settings');
-    }
-  }
-}

package/src/migrations/Migration__1.ts

@@ -1,33 +0,0 @@
-import { MigrationBase } from '../migration-base';
-
-const idwSetupData = {
-  description: 'Add a fancy description to your IDW',
-  role: 'You can set your IDW\'s role/s just by chatting with the embedded RWC',
-  avatar: 'https://files.qa.api.onereach.ai/public/03db4abe-0477-47c0-ae4e-4c68f1047d59/IDW/IDWs-media-data/Img.png',
-};
-
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export default class Migration__1 extends MigrationBase {
-  async up() {
-    await this.checkOrSetupIDWInfo();
-  }
-
-  async checkOrSetupIDWInfo(): Promise<void> {
-    const accountId = await this.resolveAccountId();
-    const idwData = await this.accounts.getIdwData(accountId);
-    const hasIdwInfo = Boolean(idwData && idwData.name && idwData.role);
-
-    if (!hasIdwInfo) {
-      const { name, role, description, avatar } = idwData;
-      await this.accounts.updateIdwData(accountId, {
-        name,
-        // using || instead of ?? to replace empty strings
-        role: role?.trim() || idwSetupData.role,
-        description: description?.trim() || idwSetupData.description,
-        avatar: avatar?.trim() || idwSetupData.avatar,
-      });
-      //TODO it's necessary bc redis cache.
-      return new Promise(res => setTimeout(res, 60000));
-    }
-  }
-}

package/src/migrations/Migration__2.ts

@@ -1,69 +0,0 @@
-import { GRAPH_NAME } from '../constants';
-import { MigrationBase } from '../migration-base';
-
-const startUpChannels = [
-  {
-    id: 'facebook-messenger',
-    name: 'Facebook Messenger',
-    icon: 'https://files.qa.api.onereach.ai/public/9c1b43df-0f7c-43fe-819f-be9df1f39759/channel-icons/messenger.png',
-  },
-  {
-    id: 'sms',
-    name: 'SMS',
-    icon: 'https://files.qa.api.onereach.ai/public/9c1b43df-0f7c-43fe-819f-be9df1f39759/channel-icons/sms.png',
-  },
-  {
-    id: 'telegram',
-    name: 'Telegram',
-    icon: 'https://files.qa.api.onereach.ai/public/9c1b43df-0f7c-43fe-819f-be9df1f39759/channel-icons/telegram.png',
-  },
-  {
-    id: 'twitter',
-    name: 'Twitter',
-    icon: 'https://files.qa.api.onereach.ai/public/9c1b43df-0f7c-43fe-819f-be9df1f39759/channel-icons/twitter.png',
-  },
-  {
-    id: 'viber',
-    name: 'Viber',
-    icon: 'https://files.qa.api.onereach.ai/public/9c1b43df-0f7c-43fe-819f-be9df1f39759/channel-icons/viber.png',
-  },
-  {
-    id: 'viber-business',
-    name: 'Viber Business',
-    icon: 'https://files.qa.api.onereach.ai/public/9c1b43df-0f7c-43fe-819f-be9df1f39759/channel-icons/viber.png',
-  },
-  {
-    id: 'whatsapp',
-    name: 'WhatsApp',
-    icon: 'https://files.qa.api.onereach.ai/public/9c1b43df-0f7c-43fe-819f-be9df1f39759/channel-icons/whatsapp.png',
-  },
-];
-
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export default class Migration__2 extends MigrationBase {
-  async up() {
-    const channelsExist = await this.checkIfChannelsExist();
-    if (!channelsExist) {
-      await this.createChannels();
-    }
-  }
-
-  private async createChannels() {
-    await this.graphApi.query({
-      graph: GRAPH_NAME,
-      query: `CREATE ${startUpChannels.map(({ id, name, icon }) => {
-        return `(:CHANNEL {id: '${id}', name: '${name}', icon: '${icon}'})`;
-      }).join(', ')}`,
-      params: {},
-    });
-  }
-
-  private async checkIfChannelsExist() {
-    const [data] = await this.graphApi.query<{ channels: any[]; }>({
-      graph: GRAPH_NAME,
-      query: 'MATCH (channels: CHANNEL) RETURN collect(DISTINCT channels) as channels',
-      params: {},
-    });
-    return data.channels.length > 0;
-  }
-}

package/src/migrations/Migration__3.ts

@@ -1,45 +0,0 @@
-import { MigrationBase } from '../migration-base';
-import { GRAPH_NAME } from '../constants';
-
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export default class Migration__3 extends MigrationBase {
-  async up() {
-    const flowsIds = await this.graphApi.query<{id: string;}>({
-      graph: GRAPH_NAME,
-      query: `match (flow: FLOW)
-              where flow.steps is NULL
-              return flow.id as id
-              `,
-      params: {},
-    });
-
-    if (flowsIds.length) {
-      const preparedIds = flowsIds.map(f => f.id);
-      const flows = await this.flows.listFlows({
-        query: {
-          id: preparedIds,
-        },
-        projection: ['data.trees.main.steps'],
-      });
-
-      const pairs = flows.items.map(flow => (
-        {
-          steps: flow.data.trees?.main.steps?.length ?? 0,
-          id: flow.id,
-        })
-      );
-
-      await this.graphApi.query({
-        graph: GRAPH_NAME,
-        query: `
-                unwind $list as pairs
-                MERGE (flow:FLOW { id: pairs.id })
-                SET flow.steps = pairs.steps
-              `,
-        params: {
-          list: pairs as any,
-        },
-      });
-    }
-  }
-}

package/src/migrations/index.ts

@@ -1,3 +0,0 @@
-export { default as Migration__1 } from './Migration__1';
-export { default as Migration__2 } from './Migration__2';
-export { default as Migration__3 } from './Migration__3';