@or-sdk/views 0.26.0 → 0.27.0

package/src/Views.ts

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

package/src/constants.ts

@@ -1 +1,341 @@
-export { DATA_HUB_SVC_SERVICE_KEY } from '@or-sdk/data-hub-svc';
+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';

package/src/types.ts

@@ -17,9 +17,9 @@ export type ViewsConfig = {
   accountId?: string;
 
   /**
-   * Url of OneReach DataHubSvc api
+   * Url of OneReach DataHub api
    */
-  dataHubSvcUrl?: string;
+  dataHubUrl?: string;
 };
 
 export type View = {
@@ -104,17 +104,3 @@ 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/src/utils/addTagsIds.ts

@@ -0,0 +1,15 @@
+import {
+  View,
+} from '../types';
+
+function addTagIds(source: View, tagIds: string[]): View {
+  if (!Array.isArray(source.data.data.filterByTagIds)) {
+    source.data.data.filterByTagIds = [];
+  }
+
+  source.data.data.filterByTagIds = [...source.data.data.filterByTagIds, ...tagIds];
+
+  return source;
+}
+
+export default addTagIds;

package/src/utils/filterTagIds.ts

@@ -0,0 +1,27 @@
+import {
+  View,
+} from '../types';
+
+function filterTagIds(source: View, tagIdsToFilter: string[]): { newIds: string[]; existingIds: string[]; } {
+  let newIds: string[] = [];
+  const existingIds: string[] = [];
+
+  if (!Array.isArray(source.data.data.filterByTagIds)) {
+    newIds = tagIdsToFilter;
+  } else {
+    tagIdsToFilter.forEach(tagId => {
+      if (source.data.data.filterByTagIds!.indexOf(tagId) !== -1) {
+        existingIds.push(tagId);
+      } else {
+        newIds.push(tagId);
+      }
+    });
+  }
+
+  return {
+    newIds,
+    existingIds,
+  };
+}
+
+export default filterTagIds;

package/src/utils/index.ts

@@ -0,0 +1,6 @@
+/**
+ * @internal
+ */
+export { default as filterTagIds } from './filterTagIds';
+export { default as addTagsIds } from './addTagsIds';
+export { default as removeTagIds } from './removeTagIds';

package/src/utils/removeTagIds.ts

@@ -0,0 +1,15 @@
+import {
+  View,
+} from '../types';
+
+function removeTagIds(source: View, tagIds: string[]): View {
+  if (!Array.isArray(source.data.data.filterByTagIds)) {
+    source.data.data.filterByTagIds = [];
+  }
+
+  source.data.data.filterByTagIds = source.data.data.filterByTagIds.filter((id: string) => tagIds.indexOf(id) === -1);
+
+  return source;
+}
+
+export default removeTagIds;