@or-sdk/views 0.27.0 → 1.0.1

package/src/Views.ts

@@ -1,75 +1,47 @@
-import { List } from '@or-sdk/base';
-import { DataHub, GraphqlResponse, GraphqlResponseCheckExecution, GraphqlResponseDelete, OperationNames } from '@or-sdk/data-hub';
-import { ViewsConfig, View } from './types';
-import {
-  ENTITY_NAME,
-  QUERY_LIST,
-  QUERY_GET,
-  QUERY_CREATE,
-  QUERY_UPDATE,
-  QUERY_DELETE,
-  QUERY_GET_CROSSACCOUNT,
-  QUERY_LIST_CROSSACCOUNT,
-  QUERY_CREATE_CROSSACCOUNT,
-  QUERY_UPDATE_CROSSACCOUNT,
-} from './constants';
+import { List, makeList } from '@or-sdk/base';
+import { DataHubSvc, setDiff } from '@or-sdk/data-hub-svc';
+import { ViewsConfig, View, ListViewParams, PaginationOptions } from './types';
 import { Tags, Taggable, filterTagIds, addTagsIds, removeTagIds } from '@or-sdk/tags';
 
 export class Views implements Taggable<View> {
-  private readonly dataHub: DataHub;
+  private readonly dataHubSvc: DataHubSvc;
   private readonly tags: Tags;
 
   constructor(params: ViewsConfig) {
-    const { token, discoveryUrl, accountId, dataHubUrl } = params;
+    const { token, discoveryUrl, accountId, dataHubSvcUrl } = params;
 
-    this.dataHub = new DataHub({
+    this.dataHubSvc = new DataHubSvc({
       token,
       discoveryUrl,
       accountId,
-      dataHubUrl,
+      dataHubSvcUrl,
     });
     this.tags = new Tags({
       token,
       discoveryUrl,
       accountId,
-      dataHubUrl,
+      dataHubSvcUrl,
     });
   }
 
-  async init() {
-    await Promise.all([
-      this.dataHub.init(),
-      this.tags.init(),
-    ]);
-  }
-
   /**
    * List views
    * ```typescript
    * const viewList = await views.listViews();
    * ```
    */
-  public async listViews(): Promise<List<View>> {
-    const variables = {
-      entity: ENTITY_NAME,
+  public async listViews(params: ListViewParams = {}, paginationOptions: PaginationOptions = {}): Promise<List<View>> {
+    const result = await this.dataHubSvc.makeRequest<View[]>({
+      method: 'GET',
+      route: 'views',
       params: {
-        queryParams: {},
-        includeDeleted: false,
-        includeExisting: true,
-        limit: 30,
+        ...params,
+        ...paginationOptions,
+        ... this.dataHubSvc.isCrossAccount ? { accountId: this.dataHubSvc.currentAccountId } : {},
       },
-      ... this.dataHub.isCrossAccount ? { accountId: this.dataHub.currentAccountId } : { sandbox: false },
-    };
-
-    const operationName = this.dataHub.getOperationName(OperationNames.LIST);
-
-    const data = {
-      operationName,
-      query: this.dataHub.isCrossAccount ? QUERY_LIST_CROSSACCOUNT : QUERY_LIST,
-      variables,
-    };
+    });
 
-    return this.dataHub.getFullList<View>('POST', '/graphql', data);
+    return makeList<View>(result);
   }
 
   /**
@@ -79,31 +51,13 @@ export class Views implements Taggable<View> {
    * ```
    */
   public async getView(id: string): Promise<View> {
-    const variables = {
-      entity: ENTITY_NAME,
+    return this.dataHubSvc.makeRequest<View>({
+      method: 'GET',
+      route: `views/${id}`,
       params: {
-        id,
-        includeDeleted: false,
-        includeExisting: true,
+        ... this.dataHubSvc.isCrossAccount ? { accountId: this.dataHubSvc.currentAccountId } : {},
       },
-      ... this.dataHub.isCrossAccount ? { accountId: this.dataHub.currentAccountId } : {},
-    };
-
-    const operationName = this.dataHub.getOperationName(OperationNames.GET);
-
-    const data = {
-      operationName,
-      query: this.dataHub.isCrossAccount ? QUERY_GET_CROSSACCOUNT : QUERY_GET,
-      variables,
-    };
-
-    const result = await this.dataHub.makeRequest<GraphqlResponse<View>>({
-      method: 'POST',
-      route: '/graphql',
-      data,
     });
-
-    return result.data[operationName] as View;
   }
 
   /**
@@ -115,7 +69,7 @@ export class Views implements Taggable<View> {
    * ```
    */
   public async saveView(source: View): Promise<View> {
-    return source.id ? this.updateView(source) : this.createView(source);
+    return (source.id && source.id !== 'new') ? this.updateView(source) : this.createView(source);
   }
 
   /**
@@ -125,29 +79,21 @@ export class Views implements Taggable<View> {
    * ```
    */
   public async createView(source: View): Promise<View> {
-    const variables = {
-      entity: ENTITY_NAME,
+    const result = await this.dataHubSvc.makeRequest<{ id: string; }>({
+      method: 'POST',
+      route: 'views/new',
       data: {
-        body: source,
+        view: {
+          ...source,
+          id: 'new', //TODO: remove later
+        },
+      },
+      params: {
+        ... this.dataHubSvc.isCrossAccount ? { accountId: this.dataHubSvc.currentAccountId } : {},
       },
-      ... this.dataHub.isCrossAccount ? { accountId: this.dataHub.currentAccountId } : {},
-    };
-
-    const operationName = this.dataHub.getOperationName(OperationNames.CREATE);
-
-    const data = {
-      operationName,
-      query: this.dataHub.isCrossAccount ? QUERY_CREATE_CROSSACCOUNT : QUERY_CREATE,
-      variables,
-    };
-
-    const result = await this.dataHub.makeRequest<GraphqlResponse<View>>({
-      method: 'POST',
-      route: '/graphql',
-      data,
     });
 
-    return result.data[operationName] as View;
+    return setDiff<View>(source, result);
   }
 
   /**
@@ -157,30 +103,18 @@ export class Views implements Taggable<View> {
    * ```
    */
   public async updateView(source: View): Promise<View> {
-    const variables = {
-      entity: ENTITY_NAME,
+    const result = await this.dataHubSvc.makeRequest<{ id: string; }>({
+      method: 'POST',
+      route: `views/${source.id}`,
       data: {
-        id: source.id,
-        body: source,
+        view: source,
+      },
+      params: {
+        ... this.dataHubSvc.isCrossAccount ? { accountId: this.dataHubSvc.currentAccountId } : {},
       },
-      ... this.dataHub.isCrossAccount ? { accountId: this.dataHub.currentAccountId } : {},
-    };
-
-    const operationName = this.dataHub.getOperationName(OperationNames.UPDATE);
-
-    const data = {
-      operationName,
-      query: this.dataHub.isCrossAccount ? QUERY_UPDATE_CROSSACCOUNT : QUERY_UPDATE,
-      variables,
-    };
-
-    const result = await this.dataHub.makeRequest<GraphqlResponse<View>>({
-      method: 'POST',
-      route: '/graphql',
-      data,
     });
 
-    return result.data[operationName] as View;
+    return setDiff<View>(source, result);
   }
 
   /**
@@ -189,34 +123,33 @@ export class Views implements Taggable<View> {
    * await views.deleteView('view-id');
    * ```
    */
-  public async deleteView(viewId: string): Promise<GraphqlResponseCheckExecution> {
-    if (this.dataHub.isCrossAccount) {
-      throw Error('Cross-account deleting is not implemented.');
-    }
-
-    const variables = {
-      entity: ENTITY_NAME,
+  public async deleteView(viewId: string, temporarily = true): Promise<void> {
+    return this.dataHubSvc.makeRequest<void>({
+      method: 'DELETE',
+      route: `views/${viewId}`,
       data: {
-        id: viewId,
-        subscribe: true,
+        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 view
+   * ```typescript
+   * await views.recoverView('view-id');
+   * ```
+   */
+  public async recoverView(viewId: string): Promise<void> {
+    return this.dataHubSvc.makeRequest<void>({
+      method: 'PATCH',
+      route: `views/${viewId}`,
+      params: {
+        ... this.dataHubSvc.isCrossAccount ? { accountId: this.dataHubSvc.currentAccountId } : {},
+      },
+    });
   }
 
   /**

package/src/constants.ts

@@ -1,341 +1 @@
-export { DATA_HUB_SERVICE_KEY } from '@or-sdk/data-hub';
-
-export const QUERY_LIST = `query list($entity: EntityType!, $params: ListInput!, $sandbox: Boolean) {
-  list(entity: $entity, params: $params, sandbox: $sandbox) {
-    records {
-      ... on View {
-        id
-        data {
-          data
-        }
-        cardIds
-        mirrorCardIds
-        linkId
-        linkType
-        template {
-          category
-          description
-          help
-          icon
-          iconUrl
-          implicitly
-          label
-          publishedBy
-          tags
-          type
-          version
-        }
-        reference
-      }
-    }
-    last
-  }
-}
-`;
-
-export const QUERY_LIST_CROSSACCOUNT = `query listCrossAccount($entity: EntityType!, $params: ListInput!, $accountId: String!) {
-  listCrossAccount(entity: $entity, params: $params, accountId: $accountId) {
-    records {
-      ... on View {
-        id
-        data {
-          data
-        }
-        cardIds
-        mirrorCardIds
-        linkId
-        linkType
-        template {
-          category
-          description
-          help
-          icon
-          iconUrl
-          implicitly
-          label
-          publishedBy
-          tags
-          type
-          version
-        }
-        reference
-      }
-    }
-    last
-  }
-}
-`;
-
-export const QUERY_GET = `query get($entity: EntityType!, $params: GetInput!) {
-  get(entity: $entity, params: $params) {
-    ... on View {
-      id
-      cardIds
-      linkId
-      mirrorCardIds
-      schemaVersion
-      dateCreated
-      dateModified
-      data {
-        data
-        form {
-          code
-          data
-          style
-          template
-        }
-        presentation {
-          code
-          data
-          style
-          template
-        }
-      }
-      linkType
-      reference
-      template {
-        category
-        description
-        help
-        icon
-        iconUrl
-        implicitly
-        label
-        publishedBy
-        tags
-        type
-        version
-      }
-    }
-  }
-}`;
-
-export const QUERY_GET_CROSSACCOUNT = `query getCrossAccount($entity: EntityType!, $params: GetInput!, $accountId: String!) {
-  getCrossAccount(entity: $entity, params: $params, accountId: $accountId) {
-    ... on View {
-      id
-      cardIds
-      linkId
-      mirrorCardIds
-      schemaVersion
-      dateCreated
-      dateModified
-      data {
-        data
-        form {
-          code
-          data
-          style
-          template
-        }
-        presentation {
-          code
-          data
-          style
-          template
-        }
-      }
-      linkType
-      reference
-      template {
-        category
-        description
-        help
-        icon
-        iconUrl
-        implicitly
-        label
-        publishedBy
-        tags
-        type
-        version
-      }
-    }
-  }
-}`;
-
-export const QUERY_CREATE = `mutation create($entity: EntityType!, $data: CreateInput!) {
-  create(entity: $entity, data: $data) {
-    ... on View {
-      id
-      cardIds
-      linkId
-      mirrorCardIds
-      schemaVersion
-      dateCreated
-      dateModified
-      data {
-        data
-        form {
-          code
-          data
-          style
-          template
-        }
-        presentation {
-          code
-          data
-          style
-          template
-        }
-      }
-      linkType
-      reference
-      template {
-        category
-        description
-        help
-        icon
-        iconUrl
-        implicitly
-        label
-        publishedBy
-        tags
-        type
-        version
-      }
-    }
-  }
-}`;
-
-export const QUERY_CREATE_CROSSACCOUNT = `mutation createCrossAccount($entity: EntityType!, $data: CreateInput!, $accountId: String!) {
-  createCrossAccount(entity: $entity, data: $data, accountId: $accountId) {
-    ... on View {
-      id
-      cardIds
-      linkId
-      mirrorCardIds
-      schemaVersion
-      dateCreated
-      dateModified
-      data {
-        data
-        form {
-          code
-          data
-          style
-          template
-        }
-        presentation {
-          code
-          data
-          style
-          template
-        }
-      }
-      linkType
-      reference
-      template {
-        category
-        description
-        help
-        icon
-        iconUrl
-        implicitly
-        label
-        publishedBy
-        tags
-        type
-        version
-      }
-    }
-  }
-}`;
-
-export const QUERY_UPDATE = `mutation update($entity: EntityType!, $data: UpdateInput!) {
-  update(entity: $entity, data: $data) {
-    ... on View {
-      id
-      cardIds
-      linkId
-      mirrorCardIds
-      schemaVersion
-      dateCreated
-      dateModified
-      data {
-        data
-        form {
-          code
-          data
-          style
-          template
-        }
-        presentation {
-          code
-          data
-          style
-          template
-        }
-      }
-      linkType
-      reference
-      template {
-        category
-        description
-        help
-        icon
-        iconUrl
-        implicitly
-        label
-        publishedBy
-        tags
-        type
-        version
-      }
-    }
-  }
-}`;
-
-export const QUERY_UPDATE_CROSSACCOUNT = `mutation updateCrossAccount($entity: EntityType!, $data: UpdateInput!, $accountId: String!) {
-  updateCrossAccount(entity: $entity, data: $data, accountId: $accountId) {
-    ... on View {
-      id
-      cardIds
-      linkId
-      mirrorCardIds
-      schemaVersion
-      dateCreated
-      dateModified
-      data {
-        data
-        form {
-          code
-          data
-          style
-          template
-        }
-        presentation {
-          code
-          data
-          style
-          template
-        }
-      }
-      linkType
-      reference
-      template {
-        category
-        description
-        help
-        icon
-        iconUrl
-        implicitly
-        label
-        publishedBy
-        tags
-        type
-        version
-      }
-    }
-  }
-}`;
-
-export const QUERY_DELETE = `mutation deleteTemporarily($entity: EntityType!, $data: DeleteInput!) {
-  deleteTemporarily(entity: $entity, data: $data) {
-    ... on AsyncRequest {
-      requestId
-    }
-  }
-}`;
-
-export const ENTITY_NAME = 'VIEW';
+export { DATA_HUB_SVC_SERVICE_KEY } from '@or-sdk/data-hub-svc';

package/src/types.ts

@@ -17,9 +17,9 @@ export type ViewsConfig = {
   accountId?: string;
 
   /**
-   * Url of OneReach DataHub api
+   * Url of OneReach DataHubSvc api
    */
-  dataHubUrl?: string;
+  dataHubSvcUrl?: string;
 };
 
 export type View = {
@@ -104,3 +104,17 @@ export type View = {
   template: null;
   deletedDate?: string;
 };
+
+export type ListViewParams = {
+  query?: {
+    [key: string]: unknown;
+  };
+  projection?: string[];
+  group?: string[];
+  sandbox?: boolean;
+};
+
+export type PaginationOptions = {
+  limit?: number;
+  offset?: number;
+};

package/dist/cjs/utils/addTagsIds.js

@@ -1,20 +0,0 @@
-"use strict";
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-function addTagIds(source, tagIds) {
-    if (!Array.isArray(source.data.data.filterByTagIds)) {
-        source.data.data.filterByTagIds = [];
-    }
-    source.data.data.filterByTagIds = __spreadArray(__spreadArray([], source.data.data.filterByTagIds, true), tagIds, true);
-    return source;
-}
-exports.default = addTagIds;
-//# sourceMappingURL=addTagsIds.js.map

package/dist/cjs/utils/addTagsIds.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"addTagsIds.js","sourceRoot":"","sources":["../../../src/utils/addTagsIds.ts"],"names":[],"mappings":";;;;;;;;;;;AAIA,SAAS,SAAS,CAAC,MAAY,EAAE,MAAgB;IAC/C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE;QACnD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;KACtC;IAED,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,mCAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,SAAK,MAAM,OAAC,CAAC;IAElF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,kBAAe,SAAS,CAAC"}

package/dist/cjs/utils/filterTagIds.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function filterTagIds(source, tagIdsToFilter) {
-    var newIds = [];
-    var existingIds = [];
-    if (!Array.isArray(source.data.data.filterByTagIds)) {
-        newIds = tagIdsToFilter;
-    }
-    else {
-        tagIdsToFilter.forEach(function (tagId) {
-            if (source.data.data.filterByTagIds.indexOf(tagId) !== -1) {
-                existingIds.push(tagId);
-            }
-            else {
-                newIds.push(tagId);
-            }
-        });
-    }
-    return {
-        newIds: newIds,
-        existingIds: existingIds,
-    };
-}
-exports.default = filterTagIds;
-//# sourceMappingURL=filterTagIds.js.map

package/dist/cjs/utils/filterTagIds.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"filterTagIds.js","sourceRoot":"","sources":["../../../src/utils/filterTagIds.ts"],"names":[],"mappings":";;AAIA,SAAS,YAAY,CAAC,MAAY,EAAE,cAAwB;IAC1D,IAAI,MAAM,GAAa,EAAE,CAAC;IAC1B,IAAM,WAAW,GAAa,EAAE,CAAC;IAEjC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE;QACnD,MAAM,GAAG,cAAc,CAAC;KACzB;SAAM;QACL,cAAc,CAAC,OAAO,CAAC,UAAA,KAAK;YAC1B,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAe,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE;gBAC1D,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACzB;iBAAM;gBACL,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACpB;QACH,CAAC,CAAC,CAAC;KACJ;IAED,OAAO;QACL,MAAM,QAAA;QACN,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAED,kBAAe,YAAY,CAAC"}

package/dist/cjs/utils/index.js

@@ -1,13 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeTagIds = exports.addTagsIds = exports.filterTagIds = void 0;
-var filterTagIds_1 = require("./filterTagIds");
-Object.defineProperty(exports, "filterTagIds", { enumerable: true, get: function () { return __importDefault(filterTagIds_1).default; } });
-var addTagsIds_1 = require("./addTagsIds");
-Object.defineProperty(exports, "addTagsIds", { enumerable: true, get: function () { return __importDefault(addTagsIds_1).default; } });
-var removeTagIds_1 = require("./removeTagIds");
-Object.defineProperty(exports, "removeTagIds", { enumerable: true, get: function () { return __importDefault(removeTagIds_1).default; } });
-//# sourceMappingURL=index.js.map