@artaio/node-api - npm Package Compare versions

Comparing version 0.30.1 to 0.31.0

dist/lib/ArtaClient.d.ts

@@ -1,3 +0,3 @@
-import { HttpClient } from './net/HttpClient';
-import { RestClient } from './net/RestClient';
+import type { HttpClient } from './net/HttpClient';
+import type { RestClient } from './net/RestClient';
 export type ArtaID = number | string;
@@ -16,7 +16,7 @@ interface ArtaClientConfig {
     private makeArtaAuthHeader;
-    get(path: string, auth?: string): Promise<any>;
-    post(path: string, payload: any, auth?: string): Promise<any>;
-    patch(path: string, payload: any, auth?: string): Promise<any>;
+    get<T>(path: string, auth?: string): Promise<T>;
+    post<U, T>(path: string, payload: U, auth?: string): Promise<T>;
+    patch<U, T>(path: string, payload: U, auth?: string): Promise<T>;
     delete(path: string, auth?: string): Promise<void>;
 }
 export {};

dist/lib/ArtaClient.js

@@ -56,2 +56,5 @@ "use strict";
                         authValue = this.makeArtaAuthHeader(this.config.apiKey);
+                        if (params.headers == null) {
+                            params.headers = {};
+                        }
                         if (params.headers.Authorization == null) {
@@ -87,2 +90,5 @@ params.headers.Authorization = authValue;
         if (auth) {
+            if (reqParams.headers == null) {
+                reqParams.headers = {};
+            }
             reqParams.headers.Authorization = this.makeArtaAuthHeader(auth);
@@ -89,0 +95,0 @@ }

dist/lib/endpoint/hostedSessions.d.ts

@@ -5,3 +5,3 @@ import { ArtaID } from '../ArtaClient';
 import { AdditionalService, ArtaLocation, ArtaObject, Insurance, PaymentProcessType, QuoteType, QuoteRequestStatus } from '../MetadataTypes';
-import { DatedInterface, Nullable, NullableString } from '../utils';
+import { type DatedInterface, type Nullable, type NullableString } from '../utils';
 import { HostedSessionsSearch } from '../search';
@@ -8,0 +8,0 @@ export interface HostedSession extends DatedInterface {

dist/lib/endpoint/invoicePayments.d.ts

@@ -16,2 +16,6 @@ import { ArtaID } from '../ArtaClient';
 }
+export interface UnparsedInvoicePayment extends Omit<InvoicePayment, 'paid_on' | 'amount'> {
+    paid_on: string;
+    amount: string;
+}
 export declare class InvoicePaymentsEndpoint {
@@ -18,0 +22,0 @@ private readonly artaClient;

dist/lib/endpoint/invoicePayments.js

 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvoicePaymentsEndpoint = void 0;
+var utils_1 = require("../utils");
 var endpoint_1 = require("./endpoint");
@@ -20,5 +32,3 @@ var InvoicePaymentsEndpoint = /** @class */ (function () {
     InvoicePaymentsEndpoint.prototype.enrichFields = function (resource) {
-        resource.amount = Number(resource.amount);
-        resource.paid_on = new Date(resource.paid_on);
-        return resource;
+        return __assign(__assign({}, resource), { amount: Number(resource.amount), paid_on: (0, utils_1.createDateAsUTC)(resource.paid_on) });
     };
@@ -25,0 +35,0 @@ return InvoicePaymentsEndpoint;

dist/lib/endpoint/logs.d.ts

@@ -21,2 +21,6 @@ import { ArtaID } from '../ArtaClient';
 }
+export interface UnparsedLog extends Omit<Log, 'start_at' | 'end_at'> {
+    start_at: string;
+    end_at: string;
+}
 export declare class LogsEndpoint {
@@ -23,0 +27,0 @@ private readonly artaClient;

dist/lib/endpoint/logs.js

 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -21,5 +32,3 @@ exports.LogsEndpoint = void 0;
     LogsEndpoint.prototype.enrichFields = function (resource) {
-        resource.start_at = (0, utils_1.createDateAsUTC)(resource.start_at);
-        resource.end_at = (0, utils_1.createDateAsUTC)(resource.end_at);
-        return resource;
+        return __assign(__assign({}, resource), { start_at: (0, utils_1.createDateAsUTC)(resource.start_at), end_at: (0, utils_1.createDateAsUTC)(resource.end_at) });
     };
@@ -26,0 +35,0 @@ return LogsEndpoint;

dist/lib/endpoint/payments.d.ts

@@ -13,2 +13,6 @@ import { ArtaID } from '../ArtaClient';
 }
+export interface UnparsedPayment extends Omit<Payment, 'paid_on' | 'amount'> {
+    paid_on: string;
+    amount: string;
+}
 export declare class PaymentsEndpoint {
@@ -15,0 +19,0 @@ private readonly artaClient;

dist/lib/endpoint/payments.js

 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PaymentsEndpoint = void 0;
+var utils_1 = require("../utils");
 var endpoint_1 = require("./endpoint");
@@ -20,5 +32,3 @@ var PaymentsEndpoint = /** @class */ (function () {
     PaymentsEndpoint.prototype.enrichFields = function (resource) {
-        resource.amount = Number(resource.amount);
-        resource.paid_on = new Date(resource.paid_on);
-        return resource;
+        return __assign(__assign({}, resource), { amount: Number(resource.amount), paid_on: (0, utils_1.createDateAsUTC)(resource.paid_on) });
     };
@@ -25,0 +35,0 @@ return PaymentsEndpoint;

dist/lib/endpoint/shipments.js

@@ -18,6 +18,6 @@ "use strict";
         if (r.schedule) {
-            r.schedule.delivery_end = new Date(r.schedule.delivery_end);
-            r.schedule.delivery_start = new Date(r.schedule.delivery_start);
-            r.schedule.pickup_end = new Date(r.schedule.pickup_end);
-            r.schedule.pickup_start = new Date(r.schedule.pickup_start);
+            r.schedule.delivery_end = (0, utils_1.createDateAsUTC)(r.schedule.delivery_end);
+            r.schedule.delivery_start = (0, utils_1.createDateAsUTC)(r.schedule.delivery_start);
+            r.schedule.pickup_end = (0, utils_1.createDateAsUTC)(r.schedule.pickup_end);
+            r.schedule.pickup_start = (0, utils_1.createDateAsUTC)(r.schedule.pickup_start);
         }
@@ -24,0 +24,0 @@ if (r.packages) {

dist/lib/endpoint/trackings.js

 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
@@ -48,3 +59,3 @@ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
         return __awaiter(this, void 0, void 0, function () {
-            var tracking;
+            var unparsedTracking, parsedEvents;
             return __generator(this, function (_a) {
@@ -54,7 +65,5 @@ switch (_a.label) {
                     case 1:
-                        tracking = _a.sent();
-                        tracking.events.forEach(function (e) {
-                            e.date = (0, utils_1.createDateAsUTC)(e.date);
-                        });
-                        return [2 /*return*/, tracking];
+                        unparsedTracking = _a.sent();
+                        parsedEvents = unparsedTracking.events.map(function (event) { return (__assign(__assign({}, event), { date: (0, utils_1.createDateAsUTC)(event.date) })); });
+                        return [2 /*return*/, __assign(__assign({}, unparsedTracking), { events: parsedEvents })];
                 }
@@ -61,0 +70,0 @@ });

dist/lib/net/HttpClient.d.ts

 export type HttpMethod = 'get' | 'post' | 'patch' | 'put' | 'delete';
+export interface HttpClientHeaders {
+    [key: string]: string | string[] | undefined;
+}
 export interface HttpClientResponse {
     statusCode?: number;
-    headers?: any;
+    headers?: HttpClientHeaders;
     body: () => Promise<string>;
-    json: () => Promise<any>;
+    json: <T>() => Promise<T>;
 }
@@ -13,3 +16,3 @@ export interface HttpRequestParameters {
     method: HttpMethod;
-    headers: any;
+    headers: HttpClientHeaders;
     requestData: string;
@@ -16,0 +19,0 @@ timeout: number;

dist/lib/net/NodeHttpClient.d.ts

@@ -13,3 +13,3 @@ /// <reference types="node" />
     body(): Promise<string>;
-    json(): Promise<any>;
+    json<T>(): Promise<T>;
 }
@@ -16,0 +16,0 @@ export declare class NodeHttpClient implements HttpClient {

dist/lib/net/RestClient.d.ts

 export interface RestClient {
-    get(path: string, auth?: string): Promise<any>;
-    post(path: string, payload: any, auth?: string): Promise<any>;
-    patch(path: string, payload: any, auth?: string): Promise<any>;
+    get<T>(path: string, auth?: string): Promise<T>;
+    post<U, T>(path: string, payload: U, auth?: string): Promise<T>;
+    patch<U, T>(path: string, payload: U, auth?: string): Promise<T>;
     delete(path: string, auth?: string): Promise<void>;
 }

dist/lib/utils.d.ts

 export interface DatedInterface {
     updated_at?: Date;
-    created_at: Date;
+    created_at?: Date;
 }
+export interface UnparsedDatedInterface {
+    updated_at?: string;
+    created_at?: string;
+}
+export type NotDateParsed<T> = Omit<T, 'updated_at' | 'created_at'> & UnparsedDatedInterface;
 export declare function createDateAsUTC(dateStr: string): Date;
-export declare function convertDatesToUtc(artaResponse: any): any;
+export declare function convertDatesToUtc<T extends DatedInterface>(artaResponse: NotDateParsed<T>): T;
 export type Nullable<T> = T | null;
 export type NullableString = Nullable<string>;
 export declare const parseService: (s: any) => void;

dist/lib/utils.js

 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -11,7 +22,7 @@ exports.parseService = exports.convertDatesToUtc = exports.createDateAsUTC = void 0;
 function convertDatesToUtc(artaResponse) {
-    if (artaResponse.updated_at) {
-        artaResponse.updated_at = createDateAsUTC(artaResponse.updated_at);
-    }
-    artaResponse.created_at = createDateAsUTC(artaResponse.created_at);
-    return artaResponse;
+    return __assign(__assign({}, artaResponse), { created_at: artaResponse.created_at
+            ? createDateAsUTC(artaResponse.created_at)
+            : undefined, updated_at: artaResponse.updated_at
+            ? createDateAsUTC(artaResponse.updated_at)
+            : undefined });
 }
@@ -18,0 +29,0 @@ exports.convertDatesToUtc = convertDatesToUtc;

dist/package.json

 {
     "name": "@artaio/node-api",
-    "version": "0.30.1",
+    "version": "0.31.0",
     "description": "The Arta Node library provides a seamless integration to Arta API for applications running on Node.js using both Typescript or Javascript.",
@@ -34,21 +34,21 @@ "scripts": {
     "devDependencies": {
-        "@commitlint/cli": "^17.6.3",
-        "@commitlint/config-conventional": "^17.6.3",
-        "@types/jest": "^29.5.1",
+        "@commitlint/cli": "^18.2.0",
+        "@commitlint/config-conventional": "^18.1.0",
+        "@types/jest": "^29.5.7",
         "@types/nock": "^11.1.0",
-        "@types/node": "^20.2.1",
-        "@typescript-eslint/eslint-plugin": "^5.59.6",
-        "@typescript-eslint/parser": "^5.59.6",
-        "eslint": "^8.40.0",
-        "eslint-config-prettier": "^8.8.0",
-        "eslint-plugin-import": "^2.27.5",
-        "eslint-plugin-n": "^16.0.0",
+        "@types/node": "^20.8.10",
+        "@typescript-eslint/eslint-plugin": "^6.9.1",
+        "@typescript-eslint/parser": "^6.9.1",
+        "eslint": "^8.52.0",
+        "eslint-config-prettier": "^9.0.0",
+        "eslint-plugin-import": "^2.29.0",
+        "eslint-plugin-n": "^16.2.0",
         "eslint-plugin-promise": "^6.1.1",
         "husky": "^8.0.3",
-        "jest": "^29.5.0",
-        "nock": "^13.3.1",
+        "jest": "^29.7.0",
+        "nock": "^13.3.8",
         "pinst": "^3.0.0",
-        "prettier": "2.8.8",
-        "ts-jest": "^29.1.0",
-        "typescript": "^5.0.4"
+        "prettier": "3.0.3",
+        "ts-jest": "^29.1.1",
+        "typescript": "^5.2.2"
     },
@@ -58,3 +58,6 @@ "bugs": {
     },
+    "engines": {
+        "node": ">=14.x"
+    },
     "license": "MIT"
 }

package.json

 {
   "name": "@artaio/node-api",
-  "version": "0.30.1",
+  "version": "0.31.0",
   "description": "The Arta Node library provides a seamless integration to Arta API for applications running on Node.js using both Typescript or Javascript.",
@@ -34,21 +34,21 @@ "scripts": {
   "devDependencies": {
-    "@commitlint/cli": "^17.6.3",
-    "@commitlint/config-conventional": "^17.6.3",
-    "@types/jest": "^29.5.1",
+    "@commitlint/cli": "^18.2.0",
+    "@commitlint/config-conventional": "^18.1.0",
+    "@types/jest": "^29.5.7",
     "@types/nock": "^11.1.0",
-    "@types/node": "^20.2.1",
-    "@typescript-eslint/eslint-plugin": "^5.59.6",
-    "@typescript-eslint/parser": "^5.59.6",
-    "eslint": "^8.40.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-n": "^16.0.0",
+    "@types/node": "^20.8.10",
+    "@typescript-eslint/eslint-plugin": "^6.9.1",
+    "@typescript-eslint/parser": "^6.9.1",
+    "eslint": "^8.52.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-n": "^16.2.0",
     "eslint-plugin-promise": "^6.1.1",
     "husky": "^8.0.3",
-    "jest": "^29.5.0",
-    "nock": "^13.3.1",
+    "jest": "^29.7.0",
+    "nock": "^13.3.8",
     "pinst": "^3.0.0",
-    "prettier": "2.8.8",
-    "ts-jest": "^29.1.0",
-    "typescript": "^5.0.4"
+    "prettier": "3.0.3",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.2.2"
   },
@@ -58,3 +58,6 @@ "bugs": {
   },
+  "engines": {
+    "node": ">=14.x"
+  },
   "license": "MIT"
 }

No alert changes

Improved metrics

Total package byte prevSize

137387

increased by2.48%

Lines of code

2727

increased by2.83%

No dependency changes