diff --git a/CHANGELOG.md b/CHANGELOG.md index ebc4054..b91388e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [v3.3.1] +- Added a `NodeError` type. https://github.com/anvilco/node-anvil/issues/476 +- Updated various dependencies + ## [v3.3.0] - Add support for `arrayBuffer` response type. - Use `arrayBuffer` type underneath `buffer` response type to stop triggering `buffer` deprecation warning. https://github.com/anvilco/node-anvil/pull/442 diff --git a/package.json b/package.json index 320c232..f54ff85 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@anvilco/anvil", - "version": "3.3.0", + "version": "3.3.1", "description": "Anvil API Client", "author": "Anvil Foundry Inc.", "homepage": "https://github.com/anvilco/node-anvil#readme", diff --git a/src/index.js b/src/index.js index c57e8f1..aa969f8 100644 --- a/src/index.js +++ b/src/index.js @@ -37,7 +37,7 @@ let fetch * @type {Object} * @property {number} statusCode * @property {GraphQLResponseData} [data] - * @property {Array} [errors] + * @property {Array} [errors] */ /** @typedef {{ @@ -49,10 +49,18 @@ let fetch * @type {Object} * @property {number} statusCode * @property {Buffer|Stream|Object} [data] - * @property {Array} [errors] + * @property {Array} [errors] * @property {any} [response] node-fetch Response */ +/** @typedef {{ + name: string; + message: string; + stack: string; + code: string; + cause?: any; +}} NodeError */ + /** @typedef {{ message: string, status?: number, @@ -396,7 +404,7 @@ class Anvil { /** * @param {Object} data * @param {Object} data.variables - * @returns {Promise<{url?: string, errors?: Array, statusCode: number}>} + * @returns {Promise<{url?: string, errors?: Array, statusCode: number}>} */ async generateEtchSignUrl ({ variables }) { const { statusCode, data, errors } = await this.requestGraphQL( diff --git a/types/src/index.d.ts b/types/src/index.d.ts index 9064ff7..e365199 100644 --- a/types/src/index.d.ts +++ b/types/src/index.d.ts @@ -10,7 +10,7 @@ export type AnvilOptions = { export type GraphQLResponse = { statusCode: number; data?: GraphQLResponseData; - errors?: Array; + errors?: Array; }; export type GraphQLResponseData = { data: { @@ -20,12 +20,19 @@ export type GraphQLResponseData = { export type RESTResponse = { statusCode: number; data?: Buffer | Stream | any; - errors?: Array; + errors?: Array; /** * node-fetch Response */ response?: any; }; +export type NodeError = { + name: string; + message: string; + stack: string; + code: string; + cause?: any; +}; export type ResponseError = { [key: string]: any; message: string; @@ -140,13 +147,13 @@ declare class Anvil { /** * @param {Object} data * @param {Object} data.variables - * @returns {Promise<{url?: string, errors?: Array, statusCode: number}>} + * @returns {Promise<{url?: string, errors?: Array, statusCode: number}>} */ generateEtchSignUrl({ variables }: { variables: any; }): Promise<{ url?: string; - errors?: Array; + errors?: Array; statusCode: number; }>; /** diff --git a/types/src/index.d.ts.map b/types/src/index.d.ts.map index 0608dfc..211f54d 100644 --- a/types/src/index.d.ts.map +++ b/types/src/index.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;aA0Bc,MAAM;kBACN,MAAM;cACN,MAAM;gBACN,MAAM;mBACN,MAAM;qBACN,MAAM;;;gBAMN,MAAM;WACN,mBAAmB;aACnB,MAAM,aAAa,CAAC;;;;;;;;gBAUpB,MAAM;WACN,MAAM,GAAC,MAAM,MAAO;aACpB,MAAM,aAAa,CAAC;;;;eACpB,GAAG;;;;aAIN,MAAM;aACN,MAAM;WACR,MAAM;aACJ,MAAM,kBAAkB,CAAC;;;;aAKzB,MAAM;eACJ,MAAM;;uBAIL;IACZ,IAAI,EAAE,MAAM,CAAA;CACb;AAyDD;IA+EE;;;;;;;;;;;;OAYG;IACH,iDATY,MAAM,GAAC,MAAM,GAAC,QAAQ,GAAC,IAAI,GAAC,IAAI,iEAMhC,iBAAiB,CA6C5B;IA/HD;;OAEG;IACH,qBAFW,YAAY,SA+BtB;IA1BC;;;;;;;MAKC;IAKD,mBAEoE;IAGpE,mCAAsC;IAEtC,kCAAqC;IAGrC,sCAEE;IADA,iDAAyC;IAO7C;;;;;OAKG;IACH,wBA8BC;IAHC,iBAAyB;IACzB,wBAAiC;IACjC,qBAAyB;IA4D3B;;;;;;;OAOG;IACH;QALwB,SAAS;QACR,aAAa,GAA3B,MAAM;QACQ,QAAQ,GAAtB,MAAM;QACJ,QAAQ,eAAe,CAAC,CAUpC;IAED;;;;OAIG;IACH,oCAJW,MAAM,wBAEJ,QAAQ,YAAY,CAAC,CAejC;IAED;;;;;OAKG;IACH,uBALW,MAAM,sCAGJ,QAAQ,YAAY,CAAC,CA2BjC;IAED;;;;;;OAMG;IACH;QALwB,SAAS;QACR,aAAa,GAA3B,MAAM;QACQ,QAAQ,GAAtB,MAAM;QACJ,QAAQ,eAAe,CAAC,CAUpC;IAED;;;;OAIG;IACH,gDAFa,QAAQ,YAAY,CAAC,CAsBjC;IAED;;;;;OAKG;IACH;QAJwB,SAAS;QACR,aAAa,GAA3B,MAAM;QACJ,QAAQ,eAAe,CAAC,CAUpC;IAED;;;;OAIG;IACH;QAHwB,SAAS;;cACL,MAAM;iBAAW,MAAM,aAAa,CAAC;oBAAc,MAAM;OAgBpF;IAED;;;;;OAKG;IACH;QAJwB,SAAS;QACR,QAAQ,GAAtB,MAAM;QACJ,QAAQ,eAAe,CAAC,CAUpC;IAED;;;;;;OAMG;IACH;QALwB,KAAK,EAAlB,MAAM;QACQ,SAAS;6BAErB,QAAQ,eAAe,CAAC,CAuIpC;IAED;;;;;OAKG;IACH,iBALW,MAAM,2CAGJ,QAAQ,YAAY,CAAC,CAmBjC;IAYD,8BAOC;IAED;;;;;OAKG;IACH,kBAMC;IAED;;;;;OAKG;IACH,qBAwFC;IAED;;;;OAIG;IACH,aAEC;IAED;;;;;;;OAOG;IACH,oBAqBC;IAED;;;;OAIG;IACH,2BAYC;IAED;;;;OAIG;IACH,kBA0BC;CACF;;;;;;uBAjzBsB,QAAQ;4BAGH,SAAS;8BAEP,qBAAqB;AA2GnD,iCAAyB;AAGzB,2CAAmC"} \ No newline at end of file +{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;aA0Bc,MAAM;kBACN,MAAM;cACN,MAAM;gBACN,MAAM;mBACN,MAAM;qBACN,MAAM;;;gBAMN,MAAM;WACN,mBAAmB;aACnB,MAAM,aAAa,GAAG,SAAS,CAAC;;;;;;;;gBAUhC,MAAM;WACN,MAAM,GAAC,MAAM,MAAO;aACpB,MAAM,aAAa,GAAG,SAAS,CAAC;;;;eAChC,GAAG;;wBAGH;IACZ,MAAM,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,GAAG,CAAC;CACb;;;aAGU,MAAM;aACN,MAAM;WACR,MAAM;aACJ,MAAM,kBAAkB,CAAC;;;;aAKzB,MAAM;eACJ,MAAM;;uBAIL;IACZ,IAAI,EAAE,MAAM,CAAA;CACb;AAyDD;IA+EE;;;;;;;;;;;;OAYG;IACH,iDATY,MAAM,GAAC,MAAM,GAAC,QAAQ,GAAC,IAAI,GAAC,IAAI,iEAMhC,iBAAiB,CA6C5B;IA/HD;;OAEG;IACH,qBAFW,YAAY,SA+BtB;IA1BC;;;;;;;MAKC;IAKD,mBAEoE;IAGpE,mCAAsC;IAEtC,kCAAqC;IAGrC,sCAEE;IADA,iDAAyC;IAO7C;;;;;OAKG;IACH,wBA8BC;IAHC,iBAAyB;IACzB,wBAAiC;IACjC,qBAAyB;IA4D3B;;;;;;;OAOG;IACH;QALwB,SAAS;QACR,aAAa,GAA3B,MAAM;QACQ,QAAQ,GAAtB,MAAM;QACJ,QAAQ,eAAe,CAAC,CAUpC;IAED;;;;OAIG;IACH,oCAJW,MAAM,wBAEJ,QAAQ,YAAY,CAAC,CAejC;IAED;;;;;OAKG;IACH,uBALW,MAAM,sCAGJ,QAAQ,YAAY,CAAC,CA2BjC;IAED;;;;;;OAMG;IACH;QALwB,SAAS;QACR,aAAa,GAA3B,MAAM;QACQ,QAAQ,GAAtB,MAAM;QACJ,QAAQ,eAAe,CAAC,CAUpC;IAED;;;;OAIG;IACH,gDAFa,QAAQ,YAAY,CAAC,CAsBjC;IAED;;;;;OAKG;IACH;QAJwB,SAAS;QACR,aAAa,GAA3B,MAAM;QACJ,QAAQ,eAAe,CAAC,CAUpC;IAED;;;;OAIG;IACH;QAHwB,SAAS;;cACL,MAAM;iBAAW,MAAM,aAAa,GAAG,SAAS,CAAC;oBAAc,MAAM;OAgBhG;IAED;;;;;OAKG;IACH;QAJwB,SAAS;QACR,QAAQ,GAAtB,MAAM;QACJ,QAAQ,eAAe,CAAC,CAUpC;IAED;;;;;;OAMG;IACH;QALwB,KAAK,EAAlB,MAAM;QACQ,SAAS;6BAErB,QAAQ,eAAe,CAAC,CAuIpC;IAED;;;;;OAKG;IACH,iBALW,MAAM,2CAGJ,QAAQ,YAAY,CAAC,CAmBjC;IAYD,8BAOC;IAED;;;;;OAKG;IACH,kBAMC;IAED;;;;;OAKG;IACH,qBAwFC;IAED;;;;OAIG;IACH,aAEC;IAED;;;;;;;OAOG;IACH,oBAqBC;IAED;;;;OAIG;IACH,2BAYC;IAED;;;;OAIG;IACH,kBA0BC;CACF;;;;;;uBAzzBsB,QAAQ;4BAGH,SAAS;8BAEP,qBAAqB;AAmHnD,iCAAyB;AAGzB,2CAAmC"} \ No newline at end of file