wapi-client 0.10.2 → 0.10.6

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { WapiConnectionOptions, WapiHttpConnectionOptions, WsClient, HttpClient } from './api';
+import { WapiConnectionOptions, WapiHttpConnectionOptions, WsClient, HttpClient, ConnectionConfig } from './api';
 import { ClientHooks, ISocketId } from './api/base-client';
 import { AggregateQueryBuilder, UpdateQueryBuilder, ReverseQueryBuilder, QueryBuilder } from './lib/query-builder';
 import { StreamPromise } from './lib/stream-promise';
@@ -59,9 +59,10 @@ import { UpdateTransferGroupsFnFields, UpdateTransferGroupsFnMetadataFields, Upd
 import { UpdateTransfersFnInput, UpdateTransfersFnOutput, UpdateTransfersFnOptions, UpdateTransfersFnUpdateFields } from './fns/update-transfers/update-transfers.enums';
 import { UpdateTransfersFnFields, UpdateTransfersFnMetadataFields, UpdateTransfersFnStringFields, UpdateTransfersFnResultFields } from './fns/update-transfers/update-transfers';
 import { UpdateWalletFnInput, UpdateWalletFnOutput, UpdateWalletFnOptions } from './fns/update-wallet/update-wallet.enums';
-export interface ClientConfig {
+export interface ClientConfig extends ConnectionConfig {
     token?: number | string;
     hooks?: ClientHooks;
+    sendingTimeout?: number;
 }
 export declare class Client {
     /**
@@ -112,13 +113,14 @@ export declare class Client {
      */
     setHook(hookName: keyof ClientHooks, value: (input?: unknown) => boolean | void): this;
     /**
-     * Overwrite client configuration (default token, hooks)
+     * Overwrite client configuration (default token, default timeout, hooks)
      *
      *
      * ```javascript
      *
      * wapiClient.configure({
      *  token: 'EURO',
+     *  timeout: 45000,
      *  hooks: {
      *    disconnect: () => {}
      *  },
@@ -136,7 +138,7 @@ export declare class Client {
      *
      * ```
      */
-    getConfig(key: 'token'): number | string | undefined;
+    getConfig(key: keyof Omit<ClientConfig, 'hooks'>): number | string | undefined;
     /**
      *
      * Aggregate Transfers using either a simple filter or queryBuilder
@@ -805,6 +807,49 @@ export declare class Client {
     /**
      *
      *
+     * ```javascript
+     *
+     * // setup
+     * await wapiClient.createDeposit(
+     *   {
+     *     wallet: 'newWallet',
+     *     amount: 10,
+     *     status: 'pending',
+     *     identifier: 'depositUSD',
+     *     token: 'USD',
+     *   },
+     *   {
+     *     create_wallet_if_not_exists: true,
+     *   },
+     * );
+     * await wapiClient.updateTransfer({
+     *   transfer: 'depositUSD',
+     *   status: 'finished',
+     * });
+     *
+     * const result = await wapiClient.exportBalanceHistory(
+     *   {
+     *     wallet: 'newWallet',
+     *     token: 'USD',
+     *   },
+     *   {
+     *     limit: 0,
+     *     select: [
+     *       'transfer_identifier',
+     *       'pending_amount',
+     *       'finished_amount',
+     *       'pending_amount_from',
+     *       'pending_amount_to',
+     *       'amount',
+     *     ],
+     *     offset: 0,
+     *     order: 'desc',
+     *     tracking_id: 'mylogId',
+     *     // transaction_id: Transaction.identifier, // created transaction identifier
+     *   },
+     * );
+     *
+     * ```
      *
      * @param {ExportBalanceHistoryFnInput} input
      * @param {ExportBalanceHistoryFnOptions} [options]
@@ -1582,8 +1627,11 @@ export declare class Client {
      * ```javascript
      *
      * const result = await wapiClient.listExports(
-     *   {},
      *   {
+     *     type: 'transfers',
+     *   },
+     *   {
+     *     order_by: 'created_at desc',
      *     tracking_id: 'myLogId',
      *   },
      * );

package/dist/client.js

@@ -1,6 +1,4 @@
 var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
 var __getOwnPropSymbols = Object.getOwnPropertySymbols;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __propIsEnum = Object.prototype.propertyIsEnumerable;
@@ -16,7 +14,6 @@ var __spreadValues = (a, b) => {
     }
   return a;
 };
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
 var __async = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -43,14 +40,14 @@ import {
   createHttpClient,
   createWsClient
 } from "./api";
-import { ValidationError } from "./lib/errors";
+import { ConfigError, ValidationError } from "./lib/errors";
 import { ClientFunctions } from "./fns";
 import {
   isImportDataFnOptions,
   isImportDataFnInput
 } from "./fns/import-data/import-data.guards";
 var _a;
-var CLIENT_VERSION = (_a = '0.10.2') != null ? _a : "";
+var CLIENT_VERSION = (_a = '0.10.6') != null ? _a : "";
 var Client = class {
   /**
    * @internal
@@ -60,16 +57,13 @@ var Client = class {
     this.api = _apiClient;
     this.$connect = _apiClient.$connect;
     if (initialConf) {
-      if (initialConf.token) {
-        this.config = __spreadProps(__spreadValues({}, this.config), {
-          token: initialConf.token
-        });
-      }
-      if (initialConf.hooks) {
-        for (const [hookName, value] of Object.entries(initialConf.hooks)) {
-          this.setHook(hookName, value);
-        }
-      }
+      this.configure(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues({}, initialConf.token && { token: initialConf.token }), initialConf.sendingTimeout && {
+        sendingTimeout: initialConf.sendingTimeout
+      }), initialConf.connectingTimeout && {
+        connectingTimeout: initialConf.connectingTimeout
+      }), initialConf.reconnectingTimeout && {
+        reconnectingTimeout: initialConf.reconnectingTimeout
+      }), initialConf.hooks && { hooks: initialConf.hooks }));
     }
   }
   /**
@@ -119,13 +113,14 @@ var Client = class {
     return this;
   }
   /**
-   * Overwrite client configuration (default token, hooks)
+   * Overwrite client configuration (default token, default timeout, hooks)
    *
    *
    * ```javascript
    *
    * wapiClient.configure({
    *  token: 'EURO',
+   *  timeout: 45000,
    *  hooks: {
    *    disconnect: () => {}
    *  },
@@ -135,7 +130,33 @@ var Client = class {
    * @param {ClientConfig} newConf
    */
   configure(newConf) {
+    if (newConf.token && typeof newConf.token !== "string" && typeof newConf.token !== "number") {
+      throw new ConfigError("CONFIG_INVALID", {
+        field: "token",
+        error: `Must be a string|number, '${newConf.token}' provided`
+      });
+    }
+    ["sendingTimeout", "connectingTimeout", "reconnectingTimeout"].forEach(
+      (t) => {
+        if (newConf[t] && typeof newConf[t] !== "number") {
+          throw new ConfigError("CONFIG_INVALID", {
+            field: t,
+            error: `Must be a number, '${newConf[t]}' provided`
+          });
+        }
+      }
+    );
+    const hooks = newConf.hooks;
+    delete newConf.hooks;
     this.config = __spreadValues(__spreadValues({}, this.config), newConf);
+    if (this.config.sendingTimeout) {
+      this.api.sendingTimeout = this.config.sendingTimeout;
+    }
+    if (hooks) {
+      for (const [hookName, value] of Object.entries(hooks)) {
+        this.setHook(hookName, value);
+      }
+    }
     return this;
   }
   /**
@@ -762,6 +783,49 @@ var Client = class {
   /**
    *
    *
+   * ```javascript
+   *
+   * // setup
+   * await wapiClient.createDeposit(
+   *   {
+   *     wallet: 'newWallet',
+   *     amount: 10,
+   *     status: 'pending',
+   *     identifier: 'depositUSD',
+   *     token: 'USD',
+   *   },
+   *   {
+   *     create_wallet_if_not_exists: true,
+   *   },
+   * );
+   * await wapiClient.updateTransfer({
+   *   transfer: 'depositUSD',
+   *   status: 'finished',
+   * });
+   *
+   * const result = await wapiClient.exportBalanceHistory(
+   *   {
+   *     wallet: 'newWallet',
+   *     token: 'USD',
+   *   },
+   *   {
+   *     limit: 0,
+   *     select: [
+   *       'transfer_identifier',
+   *       'pending_amount',
+   *       'finished_amount',
+   *       'pending_amount_from',
+   *       'pending_amount_to',
+   *       'amount',
+   *     ],
+   *     offset: 0,
+   *     order: 'desc',
+   *     tracking_id: 'mylogId',
+   *     // transaction_id: Transaction.identifier, // created transaction identifier
+   *   },
+   * );
+   *
+   * ```
    *
    * @param {ExportBalanceHistoryFnInput} input
    * @param {ExportBalanceHistoryFnOptions} [options]
@@ -1283,8 +1347,11 @@ var Client = class {
    * ```javascript
    *
    * const result = await wapiClient.listExports(
-   *   {},
    *   {
+   *     type: 'transfers',
+   *   },
+   *   {
+   *     order_by: 'created_at desc',
    *     tracking_id: 'myLogId',
    *   },
    * );
@@ -1725,11 +1792,17 @@ var Client = class {
   // CLIENTFNDEFS
 };
 function createClientWithWS(opts, config) {
-  const wsClient = createWsClient(opts);
+  const wsClient = createWsClient(opts, {
+    connectingTimeout: config == null ? void 0 : config.connectingTimeout,
+    reconnectingTimeout: config == null ? void 0 : config.reconnectingTimeout
+  });
   return new Client(wsClient, config);
 }
 function createClientWithHttp(opts, config) {
-  const httpClient = createHttpClient(opts);
+  const httpClient = createHttpClient(opts, {
+    connectingTimeout: config == null ? void 0 : config.connectingTimeout,
+    reconnectingTimeout: config == null ? void 0 : config.reconnectingTimeout
+  });
   return new Client(httpClient, config);
 }
 export {

package/dist/fns/list-exports/list-exports.browser.cjs

@@ -36,15 +36,12 @@ function listExports(options, input, fnOptions) {
   if (error) {
     throw error;
   }
-  const date = (() => {
-    if (typeof inputCopy.date === "string") {
-      return inputCopy.date;
-    }
-    return void 0;
-  })();
+  const date = (0, import_utils.convertToString)(inputCopy == null ? void 0 : inputCopy.date);
+  fnOptions = (0, import_utils.checkFnOptionsOrderBy)(fnOptions);
   return client.api.listExportMany({
     export: {
-      date
+      date,
+      type: inputCopy.type
     },
     options: fnOptions
   });

package/dist/fns/list-exports/list-exports.browser.js

@@ -1,5 +1,9 @@
 // src/fns/list-exports/list-exports.ts
-import { validateClientFnInput } from "../../lib/utils.browser.js";
+import {
+  checkFnOptionsOrderBy,
+  convertToString,
+  validateClientFnInput
+} from "../../lib/utils.browser.js";
 import { getValidator, SchemaNames } from "../../lib/validator.browser.js";
 var validate = getValidator(SchemaNames.ListExportsFnInput);
 function listExports(options, input, fnOptions) {
@@ -12,15 +16,12 @@ function listExports(options, input, fnOptions) {
   if (error) {
     throw error;
   }
-  const date = (() => {
-    if (typeof inputCopy.date === "string") {
-      return inputCopy.date;
-    }
-    return void 0;
-  })();
+  const date = convertToString(inputCopy == null ? void 0 : inputCopy.date);
+  fnOptions = checkFnOptionsOrderBy(fnOptions);
   return client.api.listExportMany({
     export: {
-      date
+      date,
+      type: inputCopy.type
     },
     options: fnOptions
   });

package/dist/fns/list-exports/list-exports.cjs

@@ -36,15 +36,12 @@ function listExports(options, input, fnOptions) {
   if (error) {
     throw error;
   }
-  const date = (() => {
-    if (typeof inputCopy.date === "string") {
-      return inputCopy.date;
-    }
-    return void 0;
-  })();
+  const date = (0, import_utils.convertToString)(inputCopy == null ? void 0 : inputCopy.date);
+  fnOptions = (0, import_utils.checkFnOptionsOrderBy)(fnOptions);
   return client.api.listExportMany({
     export: {
-      date
+      date,
+      type: inputCopy.type
     },
     options: fnOptions
   });

package/dist/fns/list-exports/list-exports.enums.d.ts

@@ -1,8 +1,9 @@
-import { ListExportManyTxOutput } from '../../txs/list-export-many/list-export-many.enums';
+import { ExportType } from '../../txs/get-export/get-export.enums';
+import { ITxLimitingOptions, ITxGeneralOptions } from '../../txs/tx-consts.enums';
+import { ListExportManyOrderingOptions, ListExportManyTxOutput } from '../../txs/list-export-many/list-export-many.enums';
+import { IFnFindOptionsExtra } from '../fn-consts.enums';
 export type ListExportsFnInputStringFields = 'date';
-export interface ListExportsFnOptions {
-    [k: string]: unknown;
-}
+export type ListExportsFnOptions = ITxLimitingOptions & ITxGeneralOptions & ListExportManyOrderingOptions & IFnFindOptionsExtra;
 /**
  * Input for listExports
  *
@@ -13,6 +14,10 @@ export interface ListExportsFnInput {
      * Date of the export
      */
     date?: string;
+    /**
+     * Type of the export
+     */
+    type?: ExportType;
     options?: ListExportsFnOptions;
 }
 /**

package/dist/fns/list-exports/list-exports.js

@@ -1,5 +1,9 @@
 // src/fns/list-exports/list-exports.ts
-import { validateClientFnInput } from "../../lib/utils";
+import {
+  checkFnOptionsOrderBy,
+  convertToString,
+  validateClientFnInput
+} from "../../lib/utils";
 import { getValidator, SchemaNames } from "../../lib/validator";
 var validate = getValidator(SchemaNames.ListExportsFnInput);
 function listExports(options, input, fnOptions) {
@@ -12,15 +16,12 @@ function listExports(options, input, fnOptions) {
   if (error) {
     throw error;
   }
-  const date = (() => {
-    if (typeof inputCopy.date === "string") {
-      return inputCopy.date;
-    }
-    return void 0;
-  })();
+  const date = convertToString(inputCopy == null ? void 0 : inputCopy.date);
+  fnOptions = checkFnOptionsOrderBy(fnOptions);
   return client.api.listExportMany({
     export: {
-      date
+      date,
+      type: inputCopy.type
     },
     options: fnOptions
   });

package/dist/fns/list-exports/list-exports.schema.input.json

@@ -5,9 +5,14 @@
   "description": "Input for listExports",
   "type": "object",
   "properties": {
+    "type": {
+      "description": "Type of the export",
+      "$ref": "/txs/get-export/get-export.schema.output.json#/definitions/export_type"
+    },
     "date": {
       "description": "Date of the export",
-      "type": ["string"]
+      "type": "string",
+      "format": "date"
     },
     "options": {
       "$ref": "#/definitions/list_exports_fn_options"
@@ -15,7 +20,20 @@
   },
   "definitions": {
     "list_exports_fn_options": {
-      "$ref": "/txs/list-export-many/list-export-many.schema.input.json#/definitions/list_export_many_tx_options"
+      "allOf": [
+        {
+          "$ref": "/txs/tx-consts.schema.json#/definitions/i_tx_limiting_options"
+        },
+        {
+          "$ref": "/txs/tx-consts.schema.json#/definitions/i_tx_general_options"
+        },
+        {
+          "$ref": "/txs/list-export-many/list-export-many.schema.input.json#/definitions/list_export_many_ordering_options"
+        },
+        {
+          "$ref": "/fns/fn-consts.schema.json#/definitions/i_fn_find_options_extra"
+        }
+      ]
     }
   },
   "additionalProperties": false

package/dist/fns/update-transfer/update-transfer.browser.cjs

@@ -40,7 +40,8 @@ function updateTransfer(options, input, fnOptions) {
     transfer: (0, import_utils.getIdentifierFilter)(inputCopy.transfer),
     update: {
       status: inputCopy.status,
-      metadata: inputCopy.metadata
+      metadata: inputCopy.metadata,
+      extend_metadata: inputCopy.extend_metadata
     },
     options: inputCopy.options
   });

package/dist/fns/update-transfer/update-transfer.browser.js

@@ -16,7 +16,8 @@ function updateTransfer(options, input, fnOptions) {
     transfer: getIdentifierFilter(inputCopy.transfer),
     update: {
       status: inputCopy.status,
-      metadata: inputCopy.metadata
+      metadata: inputCopy.metadata,
+      extend_metadata: inputCopy.extend_metadata
     },
     options: inputCopy.options
   });

package/dist/fns/update-transfer/update-transfer.cjs

@@ -40,7 +40,8 @@ function updateTransfer(options, input, fnOptions) {
     transfer: (0, import_utils.getIdentifierFilter)(inputCopy.transfer),
     update: {
       status: inputCopy.status,
-      metadata: inputCopy.metadata
+      metadata: inputCopy.metadata,
+      extend_metadata: inputCopy.extend_metadata
     },
     options: inputCopy.options
   });

package/dist/fns/update-transfer/update-transfer.enums.d.ts

@@ -21,6 +21,12 @@ export interface UpdateTransferFnInput {
     metadata?: {
         [k: string]: unknown;
     } | null;
+    /**
+     * Key/value object describing this transfer
+     */
+    extend_metadata?: {
+        [k: string]: unknown;
+    } | null;
     options?: UpdateTransferFnOptions;
 }
 /**

package/dist/fns/update-transfer/update-transfer.js

@@ -16,7 +16,8 @@ function updateTransfer(options, input, fnOptions) {
     transfer: getIdentifierFilter(inputCopy.transfer),
     update: {
       status: inputCopy.status,
-      metadata: inputCopy.metadata
+      metadata: inputCopy.metadata,
+      extend_metadata: inputCopy.extend_metadata
     },
     options: inputCopy.options
   });

package/dist/fns/update-transfer/update-transfer.schema.input.json

@@ -16,6 +16,9 @@
     "metadata": {
       "$ref": "/db/transfer/transfer.schema.json#/properties/metadata"
     },
+    "extend_metadata": {
+      "$ref": "/db/transfer/transfer.schema.json#/properties/metadata"
+    },
     "options": {
       "$ref": "#/definitions/update_transfer_fn_options"
     }

package/dist/index.browser.cjs

@@ -59,7 +59,10 @@ var WapiClientType = /* @__PURE__ */ ((WapiClientType2) => {
   return WapiClientType2;
 })(WapiClientType || {});
 function create(options) {
+  var _a;
   const config = options.config;
+  delete options.config;
+  (_a = options.client) != null ? _a : options.client = "ws" /* ws */;
   const { inputCopy, error } = validate(options);
   if (error) {
     throw error;

package/dist/index.browser.js

@@ -34,7 +34,10 @@ var WapiClientType = /* @__PURE__ */ ((WapiClientType2) => {
   return WapiClientType2;
 })(WapiClientType || {});
 function create(options) {
+  var _a;
   const config = options.config;
+  delete options.config;
+  (_a = options.client) != null ? _a : options.client = "ws" /* ws */;
   const { inputCopy, error } = validate(options);
   if (error) {
     throw error;

package/dist/index.cjs

@@ -59,7 +59,10 @@ var WapiClientType = /* @__PURE__ */ ((WapiClientType2) => {
   return WapiClientType2;
 })(WapiClientType || {});
 function create(options) {
+  var _a;
   const config = options.config;
+  delete options.config;
+  (_a = options.client) != null ? _a : options.client = "ws" /* ws */;
   const { inputCopy, error } = validate(options);
   if (error) {
     throw error;

package/dist/index.d.ts

@@ -10,7 +10,7 @@ export declare enum WapiClientType {
     https = "https"
 }
 export interface WapiClientWsOptions {
-    client: WapiClientType.ws;
+    client?: WapiClientType.ws;
     connection: WapiConnectionOptions;
     config?: ClientConfig;
 }
@@ -35,32 +35,50 @@ export type WapiClientOptions = WapiClientWsOptions | WapiClientHttpOptions;
  *   },
  *   config: {
  *     hooks: {
+ *       // will fire after initial connection has been made
  *       connected() {
  *         console.log('connected');
  *       },
+ *       // will fire if the connection drops
  *       disconnected() {
  *         console.log('disconnected');
  *       },
+ *       // will fire before attempting to reconnect
+ *       // if this function returns false it will not reconnect
  *       reconnect() {
  *         console.log('reconnect attempt');
  *         // return false; from this hook to prevent reconnecting
  *       },
+ *       // will fire if there is a problem with reconnecting
  *       reconnectError(err) {
  *         console.error(err);
- *         // this hook will fire if websocket disconnects and fails to reconnect
  *       }
+ *       // will fire before each message is sent to server
+ *       // if this message returns false then the message is not sent
  *       preflight(msg) => {
  *         console.log('sending msg', msg);
- *         return true; // allow
  *       },
+ *       // will fire when a message is received from the server
  *       message(msg) => {
  *         console.log('got msg', msg);
  *       },
  *     },
- *     token: 'EUR', // default token
+ *     // default token to be used in methods that require a token
+ *     // allows you to skip specifying the token each time if you only care about one token
+ *     token: 'EUR',
+ *     // how long to wait on initial connection before throwing an error
+ *     // default is to wait underlying network layer timeout
+ *     connectingTimeout: 60000;
+ *     // how long to wait on reconnect attempts before erroring
+ *     // default is to wait underlying network layer timeout
+ *     reconnectingTimeout: 60000;
+ *     // how long to wait for server ACK response on sending a command
+ *     // NB! erroring on this timeout does not mean the command is not executed
+ *     // as the command might have gotten through, but return ACK did not
+ *     sendingTimeout: 60000;
  *   }
  * });
- *
+ * // this direct wait for connect is not required
  * await client.$connect;
  *
  * ```

package/dist/index.js

@@ -34,7 +34,10 @@ var WapiClientType = /* @__PURE__ */ ((WapiClientType2) => {
   return WapiClientType2;
 })(WapiClientType || {});
 function create(options) {
+  var _a;
   const config = options.config;
+  delete options.config;
+  (_a = options.client) != null ? _a : options.client = "ws" /* ws */;
   const { inputCopy, error } = validate(options);
   if (error) {
     throw error;