@or-sdk/cards 0.25.1 → 0.25.2-beta.540.0

package/src/Cards.ts

@@ -1,60 +1,27 @@
-import { List } from '@or-sdk/base';
-import { DataHub, GraphqlResponse, GraphqlResponseCheckExecution, GraphqlResponseDelete, OperationNames } from '@or-sdk/data-hub';
-import { CardsConfig, Card } from './types';
-import {
-  ENTITY_NAME,
-  QUERY_LIST,
-  QUERY_GET,
-  QUERY_CREATE,
-  QUERY_UPDATE,
-  QUERY_DELETE,
-  QUERY_LIST_CROSSACCOUNT,
-  QUERY_GET_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 { CardsConfig, Card, ListCardsParams, PaginationOptions } from './types';
 import { Tags, Taggable, filterTagIds, addTagsIds, removeTagIds } from '@or-sdk/tags';
 
-/**
- * OneReach Cards service client
- * ## Installation:
- * ```
- * $ npm i @or-sdk/cards
- * ```
- */
 export class Cards implements Taggable<Card> {
-  private readonly dataHub: DataHub;
+  private readonly dataHubSvc: DataHubSvc;
   private readonly tags: Tags;
 
-  /**
-   * ```typescript
-   * import { Cards } from '@or-sdk/cards'
-   * const cards = new Cards({token: 'my-account-token-string', discoveryUrl: 'http://example.cards/endpoint'});
-   * ```
-   */
   constructor(params: CardsConfig) {
-    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(),
-    ]);
   }
 
   /**
@@ -63,27 +30,18 @@ export class Cards implements Taggable<Card> {
    * const cardList = await cards.listCards();
    * ```
    */
-  public async listCards(): Promise<List<Card>> {
-    const variables = {
-      entity: ENTITY_NAME,
+  public async listCards(params: ListCardsParams = {}, paginationOptions: PaginationOptions = {}): Promise<List<Card>> {
+    const result = await this.dataHubSvc.makeRequest<Card[]>({
+      method: 'GET',
+      route: 'cards',
       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<Card>('POST', '/graphql', data);
+    return makeList<Card>(result);
   }
 
   /**
@@ -93,31 +51,13 @@ export class Cards implements Taggable<Card> {
    * ```
    */
   public async getCard(id: string): Promise<Card> {
-    const variables = {
-      entity: ENTITY_NAME,
+    return this.dataHubSvc.makeRequest<Card>({
+      method: 'GET',
+      route: `cards/${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<Card>>({
-      method: 'POST',
-      route: '/graphql',
-      data,
     });
-
-    return result.data[operationName] as Card;
   }
 
   /**
@@ -129,7 +69,7 @@ export class Cards implements Taggable<Card> {
    * ```
    */
   public async saveCard(source: Card): Promise<Card> {
-    return source.id ? this.updateCard(source) : this.createCard(source);
+    return (source.id && source.id !== 'new') ? this.updateCard(source) : this.createCard(source);
   }
 
   /**
@@ -139,29 +79,21 @@ export class Cards implements Taggable<Card> {
    * ```
    */
   public async createCard(source: Card): Promise<Card> {
-    const variables = {
-      entity: ENTITY_NAME,
+    const result = await this.dataHubSvc.makeRequest<{ id: string; }>({
+      method: 'POST',
+      route: 'cards/new',
       data: {
-        body: source,
+        card: {
+          ...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<Card>>({
-      method: 'POST',
-      route: '/graphql',
-      data,
     });
 
-    return result.data[operationName] as Card;
+    return setDiff<Card>(source, result);
   }
 
   /**
@@ -171,30 +103,18 @@ export class Cards implements Taggable<Card> {
    * ```
    */
   public async updateCard(source: Card): Promise<Card> {
-    const variables = {
-      entity: ENTITY_NAME,
+    const result = await this.dataHubSvc.makeRequest<{ id: string; }>({
+      method: 'POST',
+      route: `cards/${source.id}`,
       data: {
-        id: source.id,
-        body: source,
+        card: 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<Card>>({
-      method: 'POST',
-      route: '/graphql',
-      data,
     });
 
-    return result.data[operationName] as Card;
+    return setDiff<Card>(source, result);
   }
 
   /**
@@ -203,34 +123,52 @@ export class Cards implements Taggable<Card> {
    * await cards.deleteCard('card-id');
    * ```
    */
-  public async deleteCard(cardId: string): Promise<GraphqlResponseCheckExecution> {
-    if (this.dataHub.isCrossAccount) {
-      throw Error('Cross-account deleting is not implemented.');
-    }
-
-    const variables = {
-      entity: ENTITY_NAME,
+  public async deleteCard(cardId: string, temporarily = true): Promise<void> {
+    return this.dataHubSvc.makeRequest<void>({
+      method: 'DELETE',
+      route: `cards/${cardId}`,
       data: {
-        id: cardId,
-        subscribe: true,
+        temporarily,
       },
-    };
-
-    const operationName = this.dataHub.getOperationName(OperationNames.DELETE_TEMPORARILY);
-
-    const data = {
-      operationName,
-      query: QUERY_DELETE,
-      variables,
-    };
+      params: {
+        ... this.dataHubSvc.isCrossAccount ? { accountId: this.dataHubSvc.currentAccountId } : {},
+      },
+    });
+  }
 
-    const result = await this.dataHub.makeRequest<GraphqlResponse<void>>({
-      method: 'POST',
-      route: '/graphql',
-      data,
+  /**
+   * Recover card
+   * ```typescript
+   * await cards.recoverCard('card-id');
+   * ```
+   */
+  public async recoverCard(cardId: string): Promise<void> {
+    return this.dataHubSvc.makeRequest<void>({
+      method: 'PATCH',
+      route: `cards/${cardId}`,
+      params: {
+        ... this.dataHubSvc.isCrossAccount ? { accountId: this.dataHubSvc.currentAccountId } : {},
+      },
     });
+  }
 
-    return this.dataHub.subscribe((result.data[operationName] as GraphqlResponseDelete).requestId);
+  /**
+   * Clone card
+   * ```typescript
+   * const result = await cards.cloneCard('card-id');
+   * ```
+   */
+  public async cloneCard(cardId: string, keepTemplateDetails = true): Promise<Card> {
+    return this.dataHubSvc.makeRequest<Card>({
+      method: 'PUT',
+      route: `cards/${cardId}`,
+      data: {
+        keepTemplateDetails,
+      },
+      params: {
+        ... this.dataHubSvc.isCrossAccount ? { accountId: this.dataHubSvc.currentAccountId } : {},
+      },
+    });
   }
 
   /**
@@ -282,4 +220,5 @@ export class Cards implements Taggable<Card> {
       },
     });
   }
+
 }

package/src/constants.ts

@@ -1,376 +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 Card {
-        id
-        schemaVersion
-        dateCreated
-        dateModified
-        data {
-          data
-          form {
-            code
-            data
-            style
-            template
-          }
-          presentation {
-            code
-            data
-            style
-            template
-          }
-          tagIds
-        }
-        reference {
-          id
-          type
-        }
-        template {
-          category
-          description
-          help
-          icon
-          iconUrl
-          implicitly
-          label
-          publishedBy
-          tags
-          type
-          version
-        }
-      }
-    }
-    last
-  }
-}
-`;
-
-export const QUERY_LIST_CROSSACCOUNT = `query listCrossAccount($entity: EntityType!, $params: ListInput!, $accountId: String!) {
-  listCrossAccount(entity: $entity, params: $params, accountId: $accountId) {
-    records {
-      ... on Card {
-        id
-        schemaVersion
-        dateCreated
-        dateModified
-        data {
-          data
-          form {
-            code
-            data
-            style
-            template
-          }
-          presentation {
-            code
-            data
-            style
-            template
-          }
-          tagIds
-        }
-        reference {
-          id
-          type
-        }
-        template {
-          category
-          description
-          help
-          icon
-          iconUrl
-          implicitly
-          label
-          publishedBy
-          tags
-          type
-          version
-        }
-      }
-    }
-    last
-  }
-}
-`;
-
-export const QUERY_GET = `query get($entity: EntityType!, $params: GetInput!) {
-  get(entity: $entity, params: $params) {
-    ... on Card {
-      id
-      schemaVersion
-      dateCreated
-      dateModified
-      data {
-        data
-        form {
-          code
-          data
-          style
-          template
-        }
-        presentation {
-          code
-          data
-          style
-          template
-        }
-        tagIds
-      }
-      reference {
-        id
-        type
-      }
-      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 Card {
-      id
-      schemaVersion
-      dateCreated
-      dateModified
-      data {
-        data
-        form {
-          code
-          data
-          style
-          template
-        }
-        presentation {
-          code
-          data
-          style
-          template
-        }
-        tagIds
-      }
-      reference {
-        id
-        type
-      }
-      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 Card {
-      id
-      schemaVersion
-      dateCreated
-      dateModified
-      data {
-        data
-        form {
-          code
-          data
-          style
-          template
-        }
-        presentation {
-          code
-          data
-          style
-          template
-        }
-        tagIds
-      }
-      reference {
-        id
-        type
-      }
-      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 Card {
-      id
-      schemaVersion
-      dateCreated
-      dateModified
-      data {
-        data
-        form {
-          code
-          data
-          style
-          template
-        }
-        presentation {
-          code
-          data
-          style
-          template
-        }
-        tagIds
-      }
-      reference {
-        id
-        type
-      }
-      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 Card {
-      id
-      schemaVersion
-      dateCreated
-      dateModified
-      data {
-        data
-        form {
-          code
-          data
-          style
-          template
-        }
-        presentation {
-          code
-          data
-          style
-          template
-        }
-        tagIds
-      }
-      reference {
-        id
-        type
-      }
-      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 Card {
-      id
-      schemaVersion
-      dateCreated
-      dateModified
-      data {
-        data
-        form {
-          code
-          data
-          style
-          template
-        }
-        presentation {
-          code
-          data
-          style
-          template
-        }
-        tagIds
-      }
-      reference {
-        id
-        type
-      }
-      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 = 'CARD';
+export { DATA_HUB_SVC_SERVICE_KEY } from '@or-sdk/data-hub-svc';

package/src/types.ts

@@ -17,9 +17,9 @@ export type CardsConfig = {
   accountId?: string;
 
   /**
-   * Url of OneReach DataHub api
+   * Url of OneReach DataHubSvc api
    */
-  dataHubUrl?: string;
+  dataHubSvcUrl?: string;
 };
 
 export type Card = {
@@ -58,3 +58,17 @@ export type Card = {
   reference?: string | null;
   template?: string | null;
 };
+
+export type ListCardsParams = {
+  query?: {
+    [key: string]: unknown;
+  };
+  projection?: string[];
+  group?: string[];
+  sandbox?: boolean;
+};
+
+export type PaginationOptions = {
+  limit?: number;
+  offset?: number;
+};