@shipengine/react-api 1.12.3 → 1.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/hooks/carriers/index.d.ts +0 -1
- package/hooks/funding-sources/use-get-funding-source-transactions.d.ts +4 -2
- package/index.js +19 -24
- package/index.mjs +20 -24
- package/package.json +1 -1
- package/providers/shipengine.d.ts +1 -4
- package/utilities/error.d.ts +6 -1
- package/hooks/carriers/use-get-wallet-history.d.ts +0 -10
|
@@ -6,7 +6,6 @@ export * from "./use-get-countries-by-carrier";
|
|
|
6
6
|
export * from "./use-get-currencies-by-carrier";
|
|
7
7
|
export * from "./use-get-package-rating-group-by-carrier";
|
|
8
8
|
export * from "./use-get-services-by-carrier";
|
|
9
|
-
export * from "./use-get-wallet-history";
|
|
10
9
|
export * from "./use-list-carriers";
|
|
11
10
|
export * from "./use-update-auto-funding";
|
|
12
11
|
export * from "./use-get-zones-by-carrier";
|
|
@@ -1,5 +1,7 @@
|
|
|
1
|
-
import { PageableQuery } from "@shipengine/js-api";
|
|
1
|
+
import { PageableQuery, SortableQuery } from "@shipengine/js-api";
|
|
2
2
|
/**
|
|
3
3
|
* @category ShipEngine API Hooks
|
|
4
4
|
*/
|
|
5
|
-
export declare const useGetFundingSourceTransactions: (fundingSourceId: string, params?:
|
|
5
|
+
export declare const useGetFundingSourceTransactions: (fundingSourceId: string, params?: {
|
|
6
|
+
category?: string;
|
|
7
|
+
} & PageableQuery & SortableQuery<"amount" | "category">) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").FundingSourceTransactionsResponse, unknown>;
|
package/index.js
CHANGED
|
@@ -8,21 +8,29 @@ const react = require('react');
|
|
|
8
8
|
const jsApi = require('@shipengine/js-api');
|
|
9
9
|
|
|
10
10
|
const ShipEngineContext = react.createContext(void 0);
|
|
11
|
-
const ShipEngine = ({
|
|
11
|
+
const ShipEngine = ({
|
|
12
|
+
baseURL,
|
|
13
|
+
children,
|
|
14
|
+
headers,
|
|
15
|
+
getToken,
|
|
16
|
+
onApiError
|
|
17
|
+
}) => {
|
|
12
18
|
const [client, setClient] = react.useState(() => {
|
|
13
19
|
const token = getToken();
|
|
14
20
|
if (typeof token === "string")
|
|
15
21
|
return new jsApi.ShipEngineAPI(token, {
|
|
16
22
|
baseURL,
|
|
17
23
|
getToken,
|
|
18
|
-
headers: headers != null ? headers : {}
|
|
24
|
+
headers: headers != null ? headers : {},
|
|
25
|
+
onApiError
|
|
19
26
|
});
|
|
20
27
|
token.then(
|
|
21
28
|
(t) => setClient(
|
|
22
29
|
new jsApi.ShipEngineAPI(t, {
|
|
23
30
|
baseURL,
|
|
24
31
|
getToken,
|
|
25
|
-
headers: headers != null ? headers : {}
|
|
32
|
+
headers: headers != null ? headers : {},
|
|
33
|
+
onApiError
|
|
26
34
|
})
|
|
27
35
|
)
|
|
28
36
|
);
|
|
@@ -58,7 +66,13 @@ const delay = (ms) => new Promise((resolve) => {
|
|
|
58
66
|
setTimeout(() => resolve(true), ms);
|
|
59
67
|
});
|
|
60
68
|
|
|
61
|
-
|
|
69
|
+
var dist = {};
|
|
70
|
+
|
|
71
|
+
Object.defineProperty(dist, "__esModule", { value: true });
|
|
72
|
+
var _default = dist.default = (function () {
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
const onError = (_errors) => _default();
|
|
62
76
|
|
|
63
77
|
var o={trace:10,debug:20,info:30,warn:40,error:50,fatal:60},l={};function a(e){return "string"==typeof e?o[e.toLowerCase()]:e}function c(e,r){return c=Object.setPrototypeOf||function(e,r){return e.__proto__=r,e},c(e,r)}function u(){if("undefined"==typeof Reflect||!Reflect.construct)return !1;if(Reflect.construct.sham)return !1;if("function"==typeof Proxy)return !0;try{return Boolean.prototype.valueOf.call(Reflect.construct(Boolean,[],function(){})),!0}catch(e){return !1}}function f(e,r,t){return f=u()?Reflect.construct:function(e,r,t){var s=[null];s.push.apply(s,r);var i=new(Function.bind.apply(e,s));return t&&c(i,t.prototype),i},f.apply(null,arguments)}function h(e){if(null==e)return e;if(Array.isArray(e))return e.slice();if("object"==typeof e){var r={};return Object.keys(e).forEach(function(t){r[t]=e[t];}),r}return e}function v(e){return void 0===e?"undefined":null===e?"null":Array.isArray(e)?"[ "+e.map(function(e){return v(e)}).join(", ")+" ]":"object"==typeof e?JSON.stringify(e):"function"==typeof e?"[Function: "+e.name+"]":"boolean"==typeof e||"number"==typeof e?e:"'"+e.toString()+"'"}function p(e){if("string"!=typeof e){for(var r=new Array(arguments.length),t=0;t<arguments.length;t++)r[t]=v(arguments[t]);return r.join(" ")}for(var s=/%[sdj%]/g,i=1,n=arguments,o=n.length,l=String(e).replace(s,function(e){if("%%"===e)return "%";if(i>=o)return e;switch(e){case"%s":return String(n[i++]);case"%d":return Number(n[i++]);case"%j":try{return JSON.stringify(n[i++])}catch(e){return "[Circular]"}default:return e}}),a=n[i];i<o;a=n[++i])l+=null===a||"object"!=typeof a?" "+a:" "+v(a);return l}function m(e,r){var t=e.split("\n");t[0]&&t[0].indexOf("call-stack-error")>=0&&t.shift();var s=t[r],i=null;if(s){var n=/^\s*(at|.*@)\s*(.+)?$/.exec(s);i=Array.isArray(n)&&n[2]?n[2]:s;}return i}Object.keys(o).forEach(function(e){l[o[e]]=e;});var y={};function d(e,r){if(r){if(y[r])return;y[r]=!0;}console.error(e+"\n");}function g(e){return y[e]}function w(){var e=[];return function(r,t){return t&&"object"==typeof t?-1!==e.indexOf(t)?"[Circular]":(e.push(t),t):t}}var b=/*#__PURE__*/function(){function e(){}return e.prototype.write=function(e){e.level<30?console.log(e):e.level<40?console.info(e):e.level<50?console.warn(e):console.error(e),e.err&&e.err.stack&&console.error(e.err.stack),e.obj&&console.log(e.obj);},e}(),j=/*#__PURE__*/function(){function e(r,t,s){var i,n,o,l,a=this;if(!(this instanceof e))return new e(r,t);if(void 0!==t&&(i=r,r=t,!(i instanceof e)))throw new TypeError("invalid Logger creation: do not pass a second arg");if(!r)throw new TypeError("options (object) is required");if(i){if(r.name)throw new TypeError("invalid options.name: child cannot set logger name")}else if(!r.name)throw new TypeError("options.name (string) is required");if(r.stream&&r.streams)throw new TypeError('cannot mix "streams" and "stream" options');if(r.streams&&!Array.isArray(r.streams))throw new TypeError("invalid options.streams: must be an array");if(r.serializers&&("object"!=typeof r.serializers||Array.isArray(r.serializers)))throw new TypeError("invalid options.serializers: must be an object");if(i&&s){this._level=i._level,this.streams=i.streams,this.serializers=i.serializers,this.src=i.src,n=this.fields={};var c=Object.keys(i.fields);for(l=0;l<c.length;l++)n[o=c[l]]=i.fields[o];var u=Object.keys(r);for(l=0;l<u.length;l++)n[o=u[l]]=r[o];}else {if(i){for(this._level=i._level,this.streams=[],l=0;l<i.streams.length;l++){var f=h(i.streams[l]);this.streams.push(f);}this.serializers=h(i.serializers),this.src=i.src,this.fields=h(i.fields),r.level&&this.level(r.level);}else this._level=Number.POSITIVE_INFINITY,this.streams=[],this.serializers=null,this.src=!1,this.fields={};r.stream?this.addStream({type:"stream",stream:r.stream,level:r.level}):r.streams?r.streams.forEach(function(e){a.addStream(e,r.level);}):i&&r.level?this.level(r.level):i||this.addStream({type:"raw",stream:new b,level:r.level}),r.serializers&&this.addSerializers(r.serializers),r.src&&(this.src=!0),delete(n=h(r)).stream,delete n.level,delete n.streams,delete n.serializers,delete n.src,this.serializers&&this._applySerializers(n),Object.keys(n).forEach(function(e){a.fields[e]=n[e];});}}var r=e.prototype;return r.addStream=function(e,r){void 0===r&&(r=30),(e=h(e)).type="raw",e.level=a(e.level||r),e.level<this._level&&(this._level=e.level),this.streams.push(e),delete this.haveNonRawStreams;},r.addSerializers=function(e){var r=this;this.serializers||(this.serializers={}),Object.keys(e).forEach(function(t){var s=e[t];if("function"!=typeof s)throw new TypeError(p('invalid serializer for "%s" field: must be a function',t));r.serializers[t]=s;});},r.child=function(e,r){return new this.constructor(this,e||{},r)},r.level=function(e){if(void 0===e)return this._level;for(var r=a(e),t=this.streams.length,s=0;s<t;s++)this.streams[s].level=r;this._level=r;},r.levels=function(e,r){if(void 0===e)return this.streams.map(function(e){return e.level});var t;if("number"==typeof e){if(void 0===(t=this.streams[e]))throw new Error("invalid stream index: "+e)}else {for(var s=this.streams.length,i=0;i<s;i++){var n=this.streams[i];if(n.name===e){t=n;break}}if(!t)throw new Error(p('no stream with name "%s"',e))}if(void 0===r)return t.level;var o=a(r);t.level=o,o<this._level&&(this._level=o);},r._applySerializers=function(e,r){var t=this;Object.keys(this.serializers).forEach(function(s){if(!(void 0===e[s]||r&&r[s]))try{e[s]=t.serializers[s](e[s]);}catch(r){d(p('bunyan: ERROR: Exception thrown from the "%s" Bunyan serializer. This should never happen. This is a bugin that serializer function.\n%s',s,r.stack||r)),e[s]=p('(Error in Bunyan log "%s" serializer broke field. See stderr for details.)',s);}});},r._emit=function(e,r){var t,s;if(void 0===this.haveNonRawStreams)for(this.haveNonRawStreams=!1,t=0;t<this.streams.length;t++)if(!this.streams[t].raw){this.haveNonRawStreams=!0;break}if(r||this.haveNonRawStreams)try{s=JSON.stringify(e,w())+"\n";}catch(r){var i=r.stack.split(/\n/g,2).join("\n");d('bunyan: ERROR: Exception in `JSON.stringify(rec)`. You can install the "safe-json-stringify" module to have Bunyan fallback to safer stringification. Record:\n'+function(e,r){return r||(r=" "),r+e.split(/\r?\n/g).join("\n"+r)}(p("%s\n%s",e,r.stack)),i),s=p("(Exception in JSON.stringify(rec): %j. See stderr for details.)\n",r.message);}if(r)return s;var n=e.level;for(t=0;t<this.streams.length;t++){var o=this.streams[t];o.level<=n&&o.stream.write(e);}return s},e}();function z(e){return function(){var r=this;function t(t){var n;t[0]instanceof Error?(s={err:r.serializers&&r.serializers.err?r.serializers.err(t[0]):k.err(t[0])},n={err:!0},i=1===t.length?[s.err.message]:Array.prototype.slice.call(t,1)):"object"!=typeof t[0]&&null!==t[0]||Array.isArray(t[0])?(s=null,i=Array.prototype.slice.call(t)):(s=t[0],i=1===t.length&&s.err&&s.err instanceof Error?[s.err.message]:Array.prototype.slice.call(t,1));var o=h(r.fields);o.level=e;var a=s?h(s):null;if(a&&(r.serializers&&r._applySerializers(a,n),Object.keys(a).forEach(function(e){o[e]=a[e];})),o.levelName=l[e],o.msg=i.length?p.apply(r,i):"",o.time||(o.time=new Date),r.src&&!o.src)try{throw new Error("call-stack-error")}catch(e){var c=e.stack?m(e.stack,2):"";c||g("src")||d("Unable to determine src line info","src"),o.src=c||"";}return o.v=1,o}var s=null,i=arguments,n=null;if(0===arguments.length)return this._level<=e;this._level>e||(n=t(i),this._emit(n));}}function S(e){var r=e.stack||e.toString();if(e.cause&&"function"==typeof e.cause){var t=e.cause();t&&(r+="\nCaused by: "+S(t));}return r}j.prototype.trace=z(10),j.prototype.debug=z(20),j.prototype.info=z(30),j.prototype.warn=z(40),j.prototype.error=z(50),j.prototype.fatal=z(60);var k={err:function(e){return e&&e.stack?{message:e.message,name:e.name,stack:S(e),code:e.code,signal:e.signal}:e}};function E(){return f(j,[].slice.call(arguments))}var A={levels:{trace:"color: DeepPink",debug:"color: GoldenRod",info:"color: DarkTurquoise",warn:"color: Purple",error:"color: Crimson",fatal:"color: Black"},def:"color: DimGray",msg:"color: SteelBlue",src:"color: DimGray; font-style: italic; font-size: 0.9em"},R=/*#__PURE__*/function(){function e(e){var r=void 0===e?{}:e,t=r.logByLevel,s=r.css,i=void 0===s?A:s;this.logByLevel=void 0!==t&&t,this.css=i;}return e.prototype.write=function(e){var r,t,s=this.css.def,i=this.css.msg,n=this.css.src,o=e.childName?e.name+"/"+e.childName:e.name,a=l[e.level],c=(Array(6-a.length).join(" ")+a).toUpperCase();this.logByLevel?(10===e.level?a="debug":60===e.level&&(a="error"),t="function"==typeof console[a]?console[a]:console.log):t=console.log,r=e.level<20?this.css.levels.trace:e.level<30?this.css.levels.debug:e.level<40?this.css.levels.info:e.level<50?this.css.levels.warn:e.level<60?this.css.levels.error:this.css.levels.fatal;var u=function(e,r){return Array(r+1-(e+"").length).join("0")+e},f=[];f.push("[%s:%s:%s:%s] %c%s%c: %s: %c%s "+(e.src?"%c%s":"")),f.push(u(e.time.getHours(),2)),f.push(u(e.time.getMinutes(),2)),f.push(u(e.time.getSeconds(),2)),f.push(u(e.time.getMilliseconds(),4)),f.push(r),f.push(c),f.push(s),f.push(o),f.push(i),f.push(e.msg),e.src&&(f.push(n),f.push(e.src)),e.obj&&(f.push("\n"),f.push(e.obj)),e.err&&e.err.stack&&(f.push("\n"),f.push(e.err.stack)),t.apply(console,f);},e.getDefaultCss=function(){return A},e}();
|
|
64
78
|
|
|
@@ -490,24 +504,6 @@ const useGetServicesByCarrier = (carrierId) => {
|
|
|
490
504
|
});
|
|
491
505
|
};
|
|
492
506
|
|
|
493
|
-
const useGetWalletHistory = ({
|
|
494
|
-
enabled,
|
|
495
|
-
page,
|
|
496
|
-
range
|
|
497
|
-
}) => {
|
|
498
|
-
const { client } = useShipEngine();
|
|
499
|
-
const [startDate, endDate] = range;
|
|
500
|
-
return reactQuery.useQuery({
|
|
501
|
-
enabled,
|
|
502
|
-
keepPreviousData: true,
|
|
503
|
-
// See https://react-query-v3.tanstack.com/guides/paginated-queries#better-paginated-queries-with-keeppreviousdata
|
|
504
|
-
onError,
|
|
505
|
-
queryFn: () => client.carriers.getWalletHistory(startDate, endDate, page),
|
|
506
|
-
queryKey: ["useGetWalletHistory", startDate, endDate, page],
|
|
507
|
-
select: (result) => result.data
|
|
508
|
-
});
|
|
509
|
-
};
|
|
510
|
-
|
|
511
507
|
const useListCarriers = () => {
|
|
512
508
|
const { client } = useShipEngine();
|
|
513
509
|
return reactQuery.useQuery({
|
|
@@ -750,8 +746,8 @@ const useGetFundingSourceMetadata = () => {
|
|
|
750
746
|
const useGetFundingSourceTransactions = (fundingSourceId, params) => {
|
|
751
747
|
const { client } = useShipEngine();
|
|
752
748
|
return reactQuery.useQuery({
|
|
749
|
+
enabled: !!fundingSourceId,
|
|
753
750
|
keepPreviousData: true,
|
|
754
|
-
onError,
|
|
755
751
|
queryFn: () => client.fundingSources.transactions(fundingSourceId, params),
|
|
756
752
|
queryKey: ["useGetFundingSourceTransactions", fundingSourceId, params],
|
|
757
753
|
select: (result) => result.data
|
|
@@ -1868,7 +1864,6 @@ exports.useGetShipmentRates = useGetShipmentRates;
|
|
|
1868
1864
|
exports.useGetShippingRuleById = useGetShippingRuleById;
|
|
1869
1865
|
exports.useGetShippingRuleConditionsOptions = useGetShippingRuleConditionsOptions;
|
|
1870
1866
|
exports.useGetThemeById = useGetThemeById;
|
|
1871
|
-
exports.useGetWalletHistory = useGetWalletHistory;
|
|
1872
1867
|
exports.useGetZonesByCarrier = useGetZonesByCarrier;
|
|
1873
1868
|
exports.useListCarriers = useListCarriers;
|
|
1874
1869
|
exports.useListCustomPackageTypes = useListCustomPackageTypes;
|
package/index.mjs
CHANGED
|
@@ -5,21 +5,29 @@ import { ShipEngineAPI, SE } from '@shipengine/js-api';
|
|
|
5
5
|
export * from '@shipengine/js-api';
|
|
6
6
|
|
|
7
7
|
const ShipEngineContext = createContext(void 0);
|
|
8
|
-
const ShipEngine = ({
|
|
8
|
+
const ShipEngine = ({
|
|
9
|
+
baseURL,
|
|
10
|
+
children,
|
|
11
|
+
headers,
|
|
12
|
+
getToken,
|
|
13
|
+
onApiError
|
|
14
|
+
}) => {
|
|
9
15
|
const [client, setClient] = useState(() => {
|
|
10
16
|
const token = getToken();
|
|
11
17
|
if (typeof token === "string")
|
|
12
18
|
return new ShipEngineAPI(token, {
|
|
13
19
|
baseURL,
|
|
14
20
|
getToken,
|
|
15
|
-
headers: headers != null ? headers : {}
|
|
21
|
+
headers: headers != null ? headers : {},
|
|
22
|
+
onApiError
|
|
16
23
|
});
|
|
17
24
|
token.then(
|
|
18
25
|
(t) => setClient(
|
|
19
26
|
new ShipEngineAPI(t, {
|
|
20
27
|
baseURL,
|
|
21
28
|
getToken,
|
|
22
|
-
headers: headers != null ? headers : {}
|
|
29
|
+
headers: headers != null ? headers : {},
|
|
30
|
+
onApiError
|
|
23
31
|
})
|
|
24
32
|
)
|
|
25
33
|
);
|
|
@@ -55,7 +63,13 @@ const delay = (ms) => new Promise((resolve) => {
|
|
|
55
63
|
setTimeout(() => resolve(true), ms);
|
|
56
64
|
});
|
|
57
65
|
|
|
58
|
-
|
|
66
|
+
var dist = {};
|
|
67
|
+
|
|
68
|
+
Object.defineProperty(dist, "__esModule", { value: true });
|
|
69
|
+
var _default = dist.default = (function () {
|
|
70
|
+
});
|
|
71
|
+
|
|
72
|
+
const onError = (_errors) => _default();
|
|
59
73
|
|
|
60
74
|
var o={trace:10,debug:20,info:30,warn:40,error:50,fatal:60},l={};function a(e){return "string"==typeof e?o[e.toLowerCase()]:e}function c(e,r){return c=Object.setPrototypeOf||function(e,r){return e.__proto__=r,e},c(e,r)}function u(){if("undefined"==typeof Reflect||!Reflect.construct)return !1;if(Reflect.construct.sham)return !1;if("function"==typeof Proxy)return !0;try{return Boolean.prototype.valueOf.call(Reflect.construct(Boolean,[],function(){})),!0}catch(e){return !1}}function f(e,r,t){return f=u()?Reflect.construct:function(e,r,t){var s=[null];s.push.apply(s,r);var i=new(Function.bind.apply(e,s));return t&&c(i,t.prototype),i},f.apply(null,arguments)}function h(e){if(null==e)return e;if(Array.isArray(e))return e.slice();if("object"==typeof e){var r={};return Object.keys(e).forEach(function(t){r[t]=e[t];}),r}return e}function v(e){return void 0===e?"undefined":null===e?"null":Array.isArray(e)?"[ "+e.map(function(e){return v(e)}).join(", ")+" ]":"object"==typeof e?JSON.stringify(e):"function"==typeof e?"[Function: "+e.name+"]":"boolean"==typeof e||"number"==typeof e?e:"'"+e.toString()+"'"}function p(e){if("string"!=typeof e){for(var r=new Array(arguments.length),t=0;t<arguments.length;t++)r[t]=v(arguments[t]);return r.join(" ")}for(var s=/%[sdj%]/g,i=1,n=arguments,o=n.length,l=String(e).replace(s,function(e){if("%%"===e)return "%";if(i>=o)return e;switch(e){case"%s":return String(n[i++]);case"%d":return Number(n[i++]);case"%j":try{return JSON.stringify(n[i++])}catch(e){return "[Circular]"}default:return e}}),a=n[i];i<o;a=n[++i])l+=null===a||"object"!=typeof a?" "+a:" "+v(a);return l}function m(e,r){var t=e.split("\n");t[0]&&t[0].indexOf("call-stack-error")>=0&&t.shift();var s=t[r],i=null;if(s){var n=/^\s*(at|.*@)\s*(.+)?$/.exec(s);i=Array.isArray(n)&&n[2]?n[2]:s;}return i}Object.keys(o).forEach(function(e){l[o[e]]=e;});var y={};function d(e,r){if(r){if(y[r])return;y[r]=!0;}console.error(e+"\n");}function g(e){return y[e]}function w(){var e=[];return function(r,t){return t&&"object"==typeof t?-1!==e.indexOf(t)?"[Circular]":(e.push(t),t):t}}var b=/*#__PURE__*/function(){function e(){}return e.prototype.write=function(e){e.level<30?console.log(e):e.level<40?console.info(e):e.level<50?console.warn(e):console.error(e),e.err&&e.err.stack&&console.error(e.err.stack),e.obj&&console.log(e.obj);},e}(),j=/*#__PURE__*/function(){function e(r,t,s){var i,n,o,l,a=this;if(!(this instanceof e))return new e(r,t);if(void 0!==t&&(i=r,r=t,!(i instanceof e)))throw new TypeError("invalid Logger creation: do not pass a second arg");if(!r)throw new TypeError("options (object) is required");if(i){if(r.name)throw new TypeError("invalid options.name: child cannot set logger name")}else if(!r.name)throw new TypeError("options.name (string) is required");if(r.stream&&r.streams)throw new TypeError('cannot mix "streams" and "stream" options');if(r.streams&&!Array.isArray(r.streams))throw new TypeError("invalid options.streams: must be an array");if(r.serializers&&("object"!=typeof r.serializers||Array.isArray(r.serializers)))throw new TypeError("invalid options.serializers: must be an object");if(i&&s){this._level=i._level,this.streams=i.streams,this.serializers=i.serializers,this.src=i.src,n=this.fields={};var c=Object.keys(i.fields);for(l=0;l<c.length;l++)n[o=c[l]]=i.fields[o];var u=Object.keys(r);for(l=0;l<u.length;l++)n[o=u[l]]=r[o];}else {if(i){for(this._level=i._level,this.streams=[],l=0;l<i.streams.length;l++){var f=h(i.streams[l]);this.streams.push(f);}this.serializers=h(i.serializers),this.src=i.src,this.fields=h(i.fields),r.level&&this.level(r.level);}else this._level=Number.POSITIVE_INFINITY,this.streams=[],this.serializers=null,this.src=!1,this.fields={};r.stream?this.addStream({type:"stream",stream:r.stream,level:r.level}):r.streams?r.streams.forEach(function(e){a.addStream(e,r.level);}):i&&r.level?this.level(r.level):i||this.addStream({type:"raw",stream:new b,level:r.level}),r.serializers&&this.addSerializers(r.serializers),r.src&&(this.src=!0),delete(n=h(r)).stream,delete n.level,delete n.streams,delete n.serializers,delete n.src,this.serializers&&this._applySerializers(n),Object.keys(n).forEach(function(e){a.fields[e]=n[e];});}}var r=e.prototype;return r.addStream=function(e,r){void 0===r&&(r=30),(e=h(e)).type="raw",e.level=a(e.level||r),e.level<this._level&&(this._level=e.level),this.streams.push(e),delete this.haveNonRawStreams;},r.addSerializers=function(e){var r=this;this.serializers||(this.serializers={}),Object.keys(e).forEach(function(t){var s=e[t];if("function"!=typeof s)throw new TypeError(p('invalid serializer for "%s" field: must be a function',t));r.serializers[t]=s;});},r.child=function(e,r){return new this.constructor(this,e||{},r)},r.level=function(e){if(void 0===e)return this._level;for(var r=a(e),t=this.streams.length,s=0;s<t;s++)this.streams[s].level=r;this._level=r;},r.levels=function(e,r){if(void 0===e)return this.streams.map(function(e){return e.level});var t;if("number"==typeof e){if(void 0===(t=this.streams[e]))throw new Error("invalid stream index: "+e)}else {for(var s=this.streams.length,i=0;i<s;i++){var n=this.streams[i];if(n.name===e){t=n;break}}if(!t)throw new Error(p('no stream with name "%s"',e))}if(void 0===r)return t.level;var o=a(r);t.level=o,o<this._level&&(this._level=o);},r._applySerializers=function(e,r){var t=this;Object.keys(this.serializers).forEach(function(s){if(!(void 0===e[s]||r&&r[s]))try{e[s]=t.serializers[s](e[s]);}catch(r){d(p('bunyan: ERROR: Exception thrown from the "%s" Bunyan serializer. This should never happen. This is a bugin that serializer function.\n%s',s,r.stack||r)),e[s]=p('(Error in Bunyan log "%s" serializer broke field. See stderr for details.)',s);}});},r._emit=function(e,r){var t,s;if(void 0===this.haveNonRawStreams)for(this.haveNonRawStreams=!1,t=0;t<this.streams.length;t++)if(!this.streams[t].raw){this.haveNonRawStreams=!0;break}if(r||this.haveNonRawStreams)try{s=JSON.stringify(e,w())+"\n";}catch(r){var i=r.stack.split(/\n/g,2).join("\n");d('bunyan: ERROR: Exception in `JSON.stringify(rec)`. You can install the "safe-json-stringify" module to have Bunyan fallback to safer stringification. Record:\n'+function(e,r){return r||(r=" "),r+e.split(/\r?\n/g).join("\n"+r)}(p("%s\n%s",e,r.stack)),i),s=p("(Exception in JSON.stringify(rec): %j. See stderr for details.)\n",r.message);}if(r)return s;var n=e.level;for(t=0;t<this.streams.length;t++){var o=this.streams[t];o.level<=n&&o.stream.write(e);}return s},e}();function z(e){return function(){var r=this;function t(t){var n;t[0]instanceof Error?(s={err:r.serializers&&r.serializers.err?r.serializers.err(t[0]):k.err(t[0])},n={err:!0},i=1===t.length?[s.err.message]:Array.prototype.slice.call(t,1)):"object"!=typeof t[0]&&null!==t[0]||Array.isArray(t[0])?(s=null,i=Array.prototype.slice.call(t)):(s=t[0],i=1===t.length&&s.err&&s.err instanceof Error?[s.err.message]:Array.prototype.slice.call(t,1));var o=h(r.fields);o.level=e;var a=s?h(s):null;if(a&&(r.serializers&&r._applySerializers(a,n),Object.keys(a).forEach(function(e){o[e]=a[e];})),o.levelName=l[e],o.msg=i.length?p.apply(r,i):"",o.time||(o.time=new Date),r.src&&!o.src)try{throw new Error("call-stack-error")}catch(e){var c=e.stack?m(e.stack,2):"";c||g("src")||d("Unable to determine src line info","src"),o.src=c||"";}return o.v=1,o}var s=null,i=arguments,n=null;if(0===arguments.length)return this._level<=e;this._level>e||(n=t(i),this._emit(n));}}function S(e){var r=e.stack||e.toString();if(e.cause&&"function"==typeof e.cause){var t=e.cause();t&&(r+="\nCaused by: "+S(t));}return r}j.prototype.trace=z(10),j.prototype.debug=z(20),j.prototype.info=z(30),j.prototype.warn=z(40),j.prototype.error=z(50),j.prototype.fatal=z(60);var k={err:function(e){return e&&e.stack?{message:e.message,name:e.name,stack:S(e),code:e.code,signal:e.signal}:e}};function E(){return f(j,[].slice.call(arguments))}var A={levels:{trace:"color: DeepPink",debug:"color: GoldenRod",info:"color: DarkTurquoise",warn:"color: Purple",error:"color: Crimson",fatal:"color: Black"},def:"color: DimGray",msg:"color: SteelBlue",src:"color: DimGray; font-style: italic; font-size: 0.9em"},R=/*#__PURE__*/function(){function e(e){var r=void 0===e?{}:e,t=r.logByLevel,s=r.css,i=void 0===s?A:s;this.logByLevel=void 0!==t&&t,this.css=i;}return e.prototype.write=function(e){var r,t,s=this.css.def,i=this.css.msg,n=this.css.src,o=e.childName?e.name+"/"+e.childName:e.name,a=l[e.level],c=(Array(6-a.length).join(" ")+a).toUpperCase();this.logByLevel?(10===e.level?a="debug":60===e.level&&(a="error"),t="function"==typeof console[a]?console[a]:console.log):t=console.log,r=e.level<20?this.css.levels.trace:e.level<30?this.css.levels.debug:e.level<40?this.css.levels.info:e.level<50?this.css.levels.warn:e.level<60?this.css.levels.error:this.css.levels.fatal;var u=function(e,r){return Array(r+1-(e+"").length).join("0")+e},f=[];f.push("[%s:%s:%s:%s] %c%s%c: %s: %c%s "+(e.src?"%c%s":"")),f.push(u(e.time.getHours(),2)),f.push(u(e.time.getMinutes(),2)),f.push(u(e.time.getSeconds(),2)),f.push(u(e.time.getMilliseconds(),4)),f.push(r),f.push(c),f.push(s),f.push(o),f.push(i),f.push(e.msg),e.src&&(f.push(n),f.push(e.src)),e.obj&&(f.push("\n"),f.push(e.obj)),e.err&&e.err.stack&&(f.push("\n"),f.push(e.err.stack)),t.apply(console,f);},e.getDefaultCss=function(){return A},e}();
|
|
61
75
|
|
|
@@ -487,24 +501,6 @@ const useGetServicesByCarrier = (carrierId) => {
|
|
|
487
501
|
});
|
|
488
502
|
};
|
|
489
503
|
|
|
490
|
-
const useGetWalletHistory = ({
|
|
491
|
-
enabled,
|
|
492
|
-
page,
|
|
493
|
-
range
|
|
494
|
-
}) => {
|
|
495
|
-
const { client } = useShipEngine();
|
|
496
|
-
const [startDate, endDate] = range;
|
|
497
|
-
return useQuery({
|
|
498
|
-
enabled,
|
|
499
|
-
keepPreviousData: true,
|
|
500
|
-
// See https://react-query-v3.tanstack.com/guides/paginated-queries#better-paginated-queries-with-keeppreviousdata
|
|
501
|
-
onError,
|
|
502
|
-
queryFn: () => client.carriers.getWalletHistory(startDate, endDate, page),
|
|
503
|
-
queryKey: ["useGetWalletHistory", startDate, endDate, page],
|
|
504
|
-
select: (result) => result.data
|
|
505
|
-
});
|
|
506
|
-
};
|
|
507
|
-
|
|
508
504
|
const useListCarriers = () => {
|
|
509
505
|
const { client } = useShipEngine();
|
|
510
506
|
return useQuery({
|
|
@@ -747,8 +743,8 @@ const useGetFundingSourceMetadata = () => {
|
|
|
747
743
|
const useGetFundingSourceTransactions = (fundingSourceId, params) => {
|
|
748
744
|
const { client } = useShipEngine();
|
|
749
745
|
return useQuery({
|
|
746
|
+
enabled: !!fundingSourceId,
|
|
750
747
|
keepPreviousData: true,
|
|
751
|
-
onError,
|
|
752
748
|
queryFn: () => client.fundingSources.transactions(fundingSourceId, params),
|
|
753
749
|
queryKey: ["useGetFundingSourceTransactions", fundingSourceId, params],
|
|
754
750
|
select: (result) => result.data
|
|
@@ -1819,4 +1815,4 @@ const useUpdateAccountBillingPlan = () => {
|
|
|
1819
1815
|
});
|
|
1820
1816
|
};
|
|
1821
1817
|
|
|
1822
|
-
export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateAccountImage, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateShippingRule, useCreateWarehouse, useDeleteAccountImage, useDeleteRateCard, useDeleteShippingRule, useDeleteWarehouse, useDownloadRateCard, useEditShippingRule, useFundingSourcesAddFunds, useGetAccountBillingPlan, useGetAccountImages, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetFundingSourceMetadata, useGetFundingSourceTransactions, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetShippingRuleById, useGetShippingRuleConditionsOptions, useGetThemeById,
|
|
1818
|
+
export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateAccountImage, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateShippingRule, useCreateWarehouse, useDeleteAccountImage, useDeleteRateCard, useDeleteShippingRule, useDeleteWarehouse, useDownloadRateCard, useEditShippingRule, useFundingSourcesAddFunds, useGetAccountBillingPlan, useGetAccountImages, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetFundingSourceMetadata, useGetFundingSourceTransactions, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetShippingRuleById, useGetShippingRuleConditionsOptions, useGetThemeById, useGetZonesByCarrier, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListShippingRules, useListWarehouses, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountBillingPlan, useUpdateAccountImage, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUploadRateCard, useValidateAddresses, useVoidLabel };
|
package/package.json
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { AxiosRequestHeaders } from "axios";
|
|
2
1
|
import { ShipEngineAPI, ShipEngineAPIConfig } from "@shipengine/js-api";
|
|
3
2
|
export interface ShipEngineContextValue {
|
|
4
3
|
client: ShipEngineAPI;
|
|
@@ -6,8 +5,6 @@ export interface ShipEngineContextValue {
|
|
|
6
5
|
export declare const ShipEngineContext: import("react").Context<ShipEngineContextValue | undefined>;
|
|
7
6
|
export type ShipEngineProps = {
|
|
8
7
|
children: React.ReactNode;
|
|
9
|
-
getToken: () => Promise<string> | string;
|
|
10
|
-
headers?: AxiosRequestHeaders;
|
|
11
8
|
} & ShipEngineAPIConfig;
|
|
12
|
-
export declare const ShipEngine: ({ baseURL, children, headers, getToken }: ShipEngineProps) => JSX.Element;
|
|
9
|
+
export declare const ShipEngine: ({ baseURL, children, headers, getToken, onApiError, }: ShipEngineProps) => JSX.Element;
|
|
13
10
|
export declare const useShipEngine: () => ShipEngineContextValue;
|
package/utilities/error.d.ts
CHANGED
|
@@ -1,2 +1,7 @@
|
|
|
1
1
|
import { SE } from "@shipengine/js-api";
|
|
2
|
-
|
|
2
|
+
/**
|
|
3
|
+
* This callback is used in all hooks to infer the error type CodedError[].
|
|
4
|
+
* This way when using from an app a hook, for example useGetAccountImages(), the returned `error` object
|
|
5
|
+
* or the `onError` callback will have the type CodedError[] instead of unknown.
|
|
6
|
+
*/
|
|
7
|
+
export declare const onError: (_errors: SE.CodedError[]) => any;
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @category ShipEngine API Hooks
|
|
3
|
-
*
|
|
4
|
-
* @see https://react-query-v3.tanstack.com/guides/paginated-queries
|
|
5
|
-
*/
|
|
6
|
-
export declare const useGetWalletHistory: ({ enabled, page, range, }: {
|
|
7
|
-
enabled: boolean;
|
|
8
|
-
page: number;
|
|
9
|
-
range: [Date, Date];
|
|
10
|
-
}) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").WalletTransactionHistory, import("@shipengine/js-api").CodedError[]>;
|