@wishknish/knishio-client-js 0.5.2 → 0.6.1

package/src/query/Query.js

@@ -45,28 +45,30 @@ Please visit https://github.com/WishKnish/KnishIO-Client-JS for information.
 
 License: https://github.com/WishKnish/KnishIO-Client-JS/blob/master/LICENSE
 */
-import CodeException from '../exception/CodeException';
-import Response from '../response/Response';
+import CodeException from '../exception/CodeException'
+import Response from '../response/Response'
 
 export default class Query {
   /**
-   *
-   * @param {ApolloClient} apolloClient
+   * @param {UrqlClientWrapper} graphQLClient
+   * @param {KnishIOClient} knishIOClient
    */
-  constructor ( apolloClient ) {
-    this.client = apolloClient;
-    this.$__variables = null;
-    this.$__query = null;
+  constructor (graphQLClient, knishIOClient) {
+    this.client = graphQLClient
+    this.knishIOClient = knishIOClient
+    this.$__variables = null
+    this.$__query = null
+    this.$__response = null
+    this.$__request = null
   }
 
-
   /**
    * Return a response object
    * Used at KnishIOClient::createMolecule => sets the source wallet from the remainder one stored in response object
    * @return {Response}
    */
   response () {
-    return this.$__response;
+    return this.$__response
   }
 
   /**
@@ -75,8 +77,8 @@ export default class Query {
    * @param response
    * @return {Promise<Response>}
    */
-  async createResponseRaw ( response ) {
-    return this.createResponse( response );
+  async createResponseRaw (response) {
+    return this.createResponse(response)
   }
 
   /**
@@ -85,11 +87,11 @@ export default class Query {
    * @param {object} json
    * @return {Response}
    */
-  createResponse ( json ) {
-    return new Response( {
+  createResponse (json) {
+    return new Response({
       query: this,
       json
-    } );
+    })
   }
 
   /**
@@ -98,43 +100,62 @@ export default class Query {
    * @param {{}} variables
    * @returns {{variables: (Object|null), query: null}}
    */
-  createQuery ( { variables = null } ) {
-    this.$__variables = this.compiledVariables( variables );
+  createQuery ({ variables = null }) {
+    this.$__variables = this.compiledVariables(variables)
 
     // Uri is a required parameter
-    let uri = this.uri();
+    const uri = this.uri()
 
-    if ( !uri ) {
-      throw new CodeException( 'Query::createQuery() - Node URI was not initialized for this client instance!' );
+    if (!uri) {
+      throw new CodeException('Query::createQuery() - Node URI was not initialized for this client instance!')
     }
 
-    if ( this.$__query === null ) {
-      throw new CodeException( 'Query::createQuery() - GraphQL subscription was not initialized!' );
+    if (this.$__query === null) {
+      throw new CodeException('Query::createQuery() - GraphQL subscription was not initialized!')
     }
 
     return {
       query: this.$__query,
       variables: this.variables()
-    };
+    }
   }
 
   /**
    * Sends the Query to a Knish.IO node and returns the Response
    *
    * @param {object} variables
+   * @param {object} context
    * @return {Promise<Response>}
    */
-  async execute ( { variables = null } ) {
-
-    this.$__request = this.createQuery( {
-      variables
-    } );
-
-    let response = await this.client.query( this.$__request );
+  async execute ({ variables = null, context = {} }) {
+    this.$__request = this.createQuery({ variables })
 
-    this.$__response = await this.createResponseRaw( response );
+    const mergedContext = {
+      ...context,
+      ...this.createQueryContext()
+    }
 
-    return this.$__response;
+    try {
+      const response = await this.client.query({
+        ...this.$__request,
+        context: mergedContext
+      })
+
+      this.$__response = await this.createResponseRaw(response)
+
+      return this.$__response
+    } catch (error) {
+      if (error.name === 'AbortError') {
+        this.knishIOClient.log('warn', 'Query was cancelled')
+        // You might want to create a custom response for cancelled queries
+        return new Response({
+          query: this,
+          json: { data: null, errors: [{ message: 'Query was cancelled' }] }
+        })
+      } else {
+        throw error
+      }
+    }
   }
 
   /**
@@ -143,8 +164,8 @@ export default class Query {
    * @param {object} variables
    * @return {object}
    */
-  compiledVariables ( variables = null ) {
-    return variables || {};
+  compiledVariables (variables = null) {
+    return variables || {}
   }
 
   /**
@@ -153,7 +174,7 @@ export default class Query {
    * @return {string}
    */
   uri () {
-    return this.client.getUri();
+    return this.client.getUri()
   }
 
   /**
@@ -162,6 +183,11 @@ export default class Query {
    * @return {object|null}
    */
   variables () {
-    return this.$__variables;
+    return this.$__variables
+  }
+
+  createQueryContext () {
+    // Override this method in subclasses if needed
+    return {}
   }
 }

package/src/query/QueryActiveSession.js

@@ -45,21 +45,20 @@ Please visit https://github.com/WishKnish/KnishIO-Client-JS for information.
 
 License: https://github.com/WishKnish/KnishIO-Client-JS/blob/master/LICENSE
 */
-import Query from './Query';
-import ResponseQueryActiveSession from '../response/ResponseQueryActiveSession';
-import { gql } from '@apollo/client/core';
+import Query from './Query'
+import ResponseQueryActiveSession from '../response/ResponseQueryActiveSession'
+import { gql } from '@urql/core'
 
 /**
  * Query for retrieving a list of active User Sessions
  */
 export default class QueryActiveSession extends Query {
   /**
-   * Class constructor
-   *
-   * @param httpClient
+   * @param {UrqlClientWrapper} graphQLClient
+   * @param {KnishIOClient} knishIOClient
    */
-  constructor ( httpClient ) {
-    super( httpClient );
+  constructor (graphQLClient, knishIOClient) {
+    super(graphQLClient, knishIOClient)
 
     this.$__query = gql`query ActiveUserQuery ($bundleHash:String, $metaType: String, $metaId: String) {
       ActiveUser (bundleHash: $bundleHash, metaType: $metaType, metaId: $metaId) {
@@ -70,18 +69,17 @@ export default class QueryActiveSession extends Query {
         createdAt,
         updatedAt
       }
-    }`;
+    }`
   }
 
   /**
    * @param {object} json
    * @return {ResponseQueryActiveSession}
    */
-  createResponse ( json ) {
-    return new ResponseQueryActiveSession( {
+  createResponse (json) {
+    return new ResponseQueryActiveSession({
       query: this,
       json
-    } );
+    })
   }
-
 }

package/src/query/QueryAtom.js

@@ -45,21 +45,20 @@ Please visit https://github.com/WishKnish/KnishIO-Client-JS for information.
 
 License: https://github.com/WishKnish/KnishIO-Client-JS/blob/master/LICENSE
 */
-import Query from './Query';
-import { gql } from '@apollo/client/core';
-import ResponseAtom from '../response/ResponseAtom';
+import Query from './Query'
+import ResponseAtom from '../response/ResponseAtom'
+import { gql } from '@urql/core'
 
 /**
  * Query for getting the balance of a given wallet or token slug
  */
 export default class QueryAtom extends Query {
   /**
-   * Class constructor
-   *
-   * @param apolloClient
+   * @param {UrqlClientWrapper} graphQLClient
+   * @param {KnishIOClient} knishIOClient
    */
-  constructor ( apolloClient ) {
-    super( apolloClient );
+  constructor (graphQLClient, knishIOClient) {
+    super(graphQLClient, knishIOClient)
 
     this.$__query = gql`query(
       $molecularHashes: [String!],
@@ -117,20 +116,7 @@ export default class QueryAtom extends Query {
           total
         }
       }
-    }`;
-  }
-
-  /**
-   * Returns a Response object
-   *
-   * @param {object} json
-   * @return {ResponseAtom}
-   */
-  createResponse ( json ) {
-    return new ResponseAtom( {
-      query: this,
-      json
-    } );
+    }`
   }
 
   /**
@@ -165,7 +151,7 @@ export default class QueryAtom extends Query {
    * @param {object} queryArgs
    * @return {object}
    */
-  static createVariables ( {
+  static createVariables ({
     molecularHashes,
     molecularHash,
     bundleHashes,
@@ -193,83 +179,96 @@ export default class QueryAtom extends Query {
     filter,
     latest,
     queryArgs
-  } ) {
-    if ( molecularHash ) {
-      molecularHashes = molecularHashes || [];
-      molecularHashes.push( molecularHash );
+  }) {
+    if (molecularHash) {
+      molecularHashes = molecularHashes || []
+      molecularHashes.push(molecularHash)
     }
 
-    if ( bundleHash ) {
-      bundleHashes = bundleHashes || [];
-      bundleHashes.push( bundleHash );
+    if (bundleHash) {
+      bundleHashes = bundleHashes || []
+      bundleHashes.push(bundleHash)
     }
 
-    if ( position ) {
-      positions = positions || [];
-      positions.push( position );
+    if (position) {
+      positions = positions || []
+      positions.push(position)
     }
 
-    if ( walletAddress ) {
-      walletAddresses = walletAddresses || [];
-      walletAddresses.push( walletAddress );
+    if (walletAddress) {
+      walletAddresses = walletAddresses || []
+      walletAddresses.push(walletAddress)
     }
 
-    if ( isotope ) {
-      isotopes = isotopes || [];
-      isotopes.push( isotope );
+    if (isotope) {
+      isotopes = isotopes || []
+      isotopes.push(isotope)
     }
 
-    if ( tokenSlug ) {
-      tokenSlugs = tokenSlugs || [];
-      tokenSlugs.push( tokenSlug );
+    if (tokenSlug) {
+      tokenSlugs = tokenSlugs || []
+      tokenSlugs.push(tokenSlug)
     }
 
-    if ( cellSlug ) {
-      cellSlugs = cellSlugs || [];
-      cellSlugs.push( cellSlug );
+    if (cellSlug) {
+      cellSlugs = cellSlugs || []
+      cellSlugs.push(cellSlug)
     }
 
-    if ( batchId ) {
-      batchIds = batchIds || [];
-      batchIds.push( batchId );
+    if (batchId) {
+      batchIds = batchIds || []
+      batchIds.push(batchId)
     }
 
-    if ( value ) {
-      values = values || [];
-      values.push( value );
+    if (value) {
+      values = values || []
+      values.push(value)
     }
 
-    if ( metaType ) {
-      metaTypes = metaTypes || [];
-      metaTypes.push( metaType );
+    if (metaType) {
+      metaTypes = metaTypes || []
+      metaTypes.push(metaType)
     }
 
-    if ( metaId ) {
-      metaIds = metaIds || [];
-      metaIds.push( metaId );
+    if (metaId) {
+      metaIds = metaIds || []
+      metaIds.push(metaId)
     }
 
-    if ( index ) {
-      indexes = indexes || [];
-      indexes.push( index );
+    if (index) {
+      indexes = indexes || []
+      indexes.push(index)
     }
 
     return {
-      molecularHashes: molecularHashes,
-      bundleHashes: bundleHashes,
-      positions: positions,
-      walletAddresses: walletAddresses,
-      isotopes: isotopes,
-      tokenSlugs: tokenSlugs,
-      cellSlugs: cellSlugs,
-      batchIds: batchIds,
-      values: values,
-      metaTypes: metaTypes,
-      metaIds: metaIds,
-      indexes: indexes,
-      filter: filter,
-      latest: latest,
-      queryArgs: queryArgs
-    };
+      molecularHashes,
+      bundleHashes,
+      positions,
+      walletAddresses,
+      isotopes,
+      tokenSlugs,
+      cellSlugs,
+      batchIds,
+      values,
+      metaTypes,
+      metaIds,
+      indexes,
+      filter,
+      latest,
+      queryArgs
+    }
+  }
+
+  /**
+   * Returns a Response object
+   *
+   * @param {object} json
+   * @return {ResponseAtom}
+   */
+  createResponse (json) {
+    return new ResponseAtom({
+      query: this,
+      json
+    })
   }
 }

package/src/query/QueryBalance.js

@@ -45,21 +45,20 @@ Please visit https://github.com/WishKnish/KnishIO-Client-JS for information.
 
 License: https://github.com/WishKnish/KnishIO-Client-JS/blob/master/LICENSE
 */
-import Query from './Query';
-import { gql } from '@apollo/client/core';
-import ResponseBalance from '../response/ResponseBalance';
+import Query from './Query'
+import ResponseBalance from '../response/ResponseBalance'
+import { gql } from '@urql/core'
 
 /**
  * Query for getting the balance of a given wallet or token slug
  */
 export default class QueryBalance extends Query {
   /**
-   * Class constructor
-   *
-   * @param apolloClient
+   * @param {UrqlClientWrapper} graphQLClient
+   * @param {KnishIOClient} knishIOClient
    */
-  constructor ( apolloClient ) {
-    super( apolloClient );
+  constructor (graphQLClient, knishIOClient) {
+    super(graphQLClient, knishIOClient)
 
     this.$__query = gql`query( $address: String, $bundleHash: String, $type: String, $token: String, $position: String ) {
       Balance( address: $address, bundleHash: $bundleHash, type: $type, token: $token, position: $position ) {
@@ -83,17 +82,17 @@ export default class QueryBalance extends Query {
           amount
         }
       }
-    }`;
+    }`
   }
 
   /**
    * @param {object} json
    * @return {ResponseBalance}
    */
-  createResponse ( json ) {
-    return new ResponseBalance( {
+  createResponse (json) {
+    return new ResponseBalance({
       query: this,
       json
-    } );
+    })
   }
 }

package/src/query/QueryBatch.js

@@ -45,17 +45,21 @@ Please visit https://github.com/WishKnish/KnishIO-Client-JS for information.
 
 License: https://github.com/WishKnish/KnishIO-Client-JS/blob/master/LICENSE
 */
-import Query from './Query';
-import Response from '../response/Response';
-import { gql } from '@apollo/client/core';
-
+import Query from './Query'
+import Response from '../response/Response'
+import { gql } from '@urql/core'
 
 /**
  * Query for retrieving Meta Asset information
  */
 export default class QueryBatch extends Query {
-  constructor ( apolloClient ) {
-    super( apolloClient );
+  /**
+   * @param {UrqlClientWrapper} graphQLClient
+   * @param {KnishIOClient} knishIOClient
+   */
+  constructor (graphQLClient, knishIOClient) {
+    super(graphQLClient, knishIOClient)
+
     this.$__query = gql`query( $batchId: String ) {
       Batch( batchId: $batchId ) {
         ${ QueryBatch.getFields() },
@@ -63,7 +67,7 @@ export default class QueryBatch extends Query {
           ${ QueryBatch.getFields() }
         }
       }
-    }`;
+    }`
   }
 
   static getFields () {
@@ -116,7 +120,7 @@ export default class QueryBatch extends Query {
               throughMetas {
                   key,
                   value
-              }`;
+              }`
   }
 
   /**
@@ -125,13 +129,12 @@ export default class QueryBatch extends Query {
    * @param {object} json
    * @return {Response}
    */
-  createResponse ( json ) {
-    let responseObject = new Response( {
+  createResponse (json) {
+    const responseObject = new Response({
       query: this,
       json
-    } );
-    responseObject.dataKey = 'data.Batch';
-    return responseObject;
+    })
+    responseObject.dataKey = 'data.Batch'
+    return responseObject
   }
-
 }

package/src/query/QueryBatchHistory.js

@@ -45,23 +45,27 @@ Please visit https://github.com/WishKnish/KnishIO-Client-JS for information.
 
 License: https://github.com/WishKnish/KnishIO-Client-JS/blob/master/LICENSE
 */
-import Query from './Query';
-import QueryBatch from './QueryBatch';
-import Response from '../response/Response';
-import { gql } from '@apollo/client/core';
+import Query from './Query'
+import QueryBatch from './QueryBatch'
+import Response from '../response/Response'
+import { gql } from '@urql/core'
 
 /**
  * Query for retrieving Meta Asset information
  */
 export default class QueryBatchHistory extends Query {
+  /**
+   * @param {UrqlClientWrapper} graphQLClient
+   * @param {KnishIOClient} knishIOClient
+   */
+  constructor (graphQLClient, knishIOClient) {
+    super(graphQLClient, knishIOClient)
 
-  constructor ( apolloClient ) {
-    super( apolloClient );
     this.$__query = gql`query( $batchId: String ) {
       BatchHistory( batchId: $batchId ) {
         ${ QueryBatch.getFields() }
       }
-    }`;
+    }`
   }
 
   /**
@@ -70,13 +74,12 @@ export default class QueryBatchHistory extends Query {
    * @param {object} json
    * @return {Response}
    */
-  createResponse ( json ) {
-    let responseObject = new Response( {
+  createResponse (json) {
+    const responseObject = new Response({
       query: this,
       json
-    } );
-    responseObject.dataKey = 'data.BatchHistory';
-    return responseObject;
+    })
+    responseObject.dataKey = 'data.BatchHistory'
+    return responseObject
   }
-
 }

package/src/query/QueryContinuId.js

@@ -45,17 +45,21 @@ Please visit https://github.com/WishKnish/KnishIO-Client-JS for information.
 
 License: https://github.com/WishKnish/KnishIO-Client-JS/blob/master/LICENSE
 */
-import Query from './Query';
-import ResponseContinuId from '../response/ResponseContinuId';
-import { gql } from '@apollo/client/core';
+import Query from './Query'
+import ResponseContinuId from '../response/ResponseContinuId'
+import { gql } from '@urql/core'
 
 /**
  * Queries the node for the next wallet to sign with for ContinuID
  */
 export default class QueryContinuId extends Query {
+  /**
+   * @param {UrqlClientWrapper} graphQLClient
+   * @param {KnishIOClient} knishIOClient
+   */
+  constructor (graphQLClient, knishIOClient) {
+    super(graphQLClient, knishIOClient)
 
-  constructor ( apolloClient ) {
-    super( apolloClient );
     this.$__query = gql`query ($bundle: String!) {
       ContinuId(bundle: $bundle) {
         address,
@@ -68,7 +72,7 @@ export default class QueryContinuId extends Query {
         amount,
         createdAt
       }
-    }`;
+    }`
   }
 
   /**
@@ -77,11 +81,10 @@ export default class QueryContinuId extends Query {
    * @param {object} json
    * @return {ResponseContinuId}
    */
-  createResponse ( json ) {
-    return new ResponseContinuId( {
+  createResponse (json) {
+    return new ResponseContinuId({
       query: this,
       json
-    } );
+    })
   }
-
 }