@myparcel-dev/sdk 4.1.0

package/lib/index.js

@@ -0,0 +1,622 @@
+var x = Object.defineProperty;
+var T = (s, t, r) => t in s ? x(s, t, { enumerable: !0, configurable: !0, writable: !0, value: r }) : s[t] = r;
+var e = (s, t, r) => (T(s, typeof t != "symbol" ? t + "" : t, r), r);
+import { isOfType as u } from "@myparcel/ts-utils";
+class h extends Error {
+  constructor(r) {
+    super(r);
+    e(this, "name", "user");
+    Object.setPrototypeOf(this, h.prototype), this.name = "UserException";
+  }
+}
+class y extends Error {
+  constructor(r) {
+    super(r.message);
+    e(this, "data");
+    Object.setPrototypeOf(this, y.prototype), this.name = "ApiException", this.data = r;
+  }
+}
+const _ = (s, t) => {
+  if (t) {
+    const r = Object.entries(t).map(([a, i]) => `${a}=${i}`);
+    r.length && (s += `?${r.join("&")}`);
+  }
+  return s;
+}, O = "https://api.myparcel.nl", C = ["POST", "PUT"];
+class A {
+  constructor(t) {
+    /**
+     * Base URL to make requests to.
+     *
+     * @protected
+     */
+    e(this, "baseUrl");
+    /**
+     * Headers to use with requests.
+     *
+     * @protected
+     */
+    e(this, "headers");
+    /**
+     * @protected
+     */
+    e(this, "parameters");
+    /**
+     * Additional client specific options.
+     *
+     * @protected
+     */
+    e(this, "options");
+    /**
+     * Array of headers that are required. Client will throw an error if any are missing.
+     *
+     * @private
+     */
+    e(this, "_requiredHeaders", []);
+    this.baseUrl = ((t == null ? void 0 : t.baseUrl) ?? O).replace(/\/+$/, ""), this.headers = (t == null ? void 0 : t.headers) ?? {}, this.parameters = (t == null ? void 0 : t.parameters) ?? {}, this.options = (t == null ? void 0 : t.options) ?? {};
+  }
+  get requiredHeaders() {
+    return this._requiredHeaders;
+  }
+  set requiredHeaders(t) {
+    this._requiredHeaders = t;
+  }
+  /**
+   * Prepare and execute the final request and handle the response.
+   */
+  async doRequest(t, r) {
+    const a = this.normalizeOptions(t, { ...r, ...this.options });
+    this.validateHeaders(t, a);
+    const i = await this.request(t, a);
+    if (u(i, "errors"))
+      throw new y(i);
+    return this.getResponseBody(t, i);
+  }
+  getResponseBody(t, r) {
+    if (!u(r, "data"))
+      return r;
+    const a = t.getResponseProperty();
+    if (!a)
+      return r.data;
+    const { page: i, size: n, results: p } = r.data;
+    return i === void 0 && n === void 0 && p === void 0 ? r.data[a] : {
+      [a]: r.data[a],
+      ...i !== void 0 && { page: i },
+      ...n !== void 0 && { size: n },
+      ...p !== void 0 && { results: p }
+    };
+  }
+  /**
+   * Gets default and custom headers.
+   *
+   * @protected
+   */
+  getHeaders() {
+    return {
+      Accept: "application/json",
+      ...this.headers
+    };
+  }
+  /**
+   * Uses the base url, endpoint and options to create the final request url.
+   *
+   * @protected
+   */
+  createUrl(t, r) {
+    let a = t.getPath();
+    if (a.length && !a.startsWith("/") && (a = `/${a}`), r != null && r.path && (a = this.substitutePath(a, r.path)), a.includes("/:"))
+      throw new h(`One or more path variables are missing in ${a}`);
+    return r != null && r.parameters && (a = _(a, r.parameters)), this.baseUrl + a;
+  }
+  /**
+   * Replace path variables in an url path. Deletes optional parameters if
+   * they're not passed.
+   *
+   * @protected
+   */
+  substitutePath(t, r) {
+    if (r && Object.entries(r).forEach(([a, i]) => {
+      t = t.replace(`:${a}`, String(i));
+    }), t.includes(":")) {
+      const a = t.match(/:\w+?\?/g);
+      a == null || a.forEach((i) => {
+        t = t.replace(`/${i}`, "");
+      });
+    }
+    return t;
+  }
+  /**
+   * Validates headers passed in options.
+   *
+   * @protected
+   */
+  validateHeaders(t, r) {
+    const a = Object.entries(r.headers).reduce(
+      (n, [p, c]) => ({
+        ...n,
+        [p.toLowerCase()]: c
+      }),
+      {}
+    ), i = this.requiredHeaders.filter((n) => !(n.toLowerCase() in a));
+    if (i.length)
+      throw new h(`Required headers are missing: ${i.join(", ")}`);
+  }
+  /**
+   * Executes transformations on options before request.
+   *
+   * @protected
+   */
+  normalizeOptions(t, r) {
+    const a = {
+      ...r,
+      parameters: {
+        ...this.parameters,
+        ...r.parameters,
+        ...t.getParameters()
+      },
+      headers: {
+        ...C.includes(t.method) ? { "Content-Type": "application/json" } : {},
+        ...this.getHeaders(),
+        ...r.headers,
+        ...t.getHeaders()
+      }
+    };
+    if (u(r, "body")) {
+      const i = t.getProperty();
+      if (r.body instanceof FormData)
+        return a.body = r.body, delete a.headers["Content-Type"], a;
+      i === void 0 ? a.body = {
+        data: r.body
+      } : a.body = {
+        data: { [i]: r.body }
+      };
+    }
+    return a;
+  }
+}
+const k = (s) => {
+  try {
+    return JSON.parse(s), !0;
+  } catch {
+    return !1;
+  }
+};
+class H extends A {
+  constructor(r) {
+    super(r);
+    e(this, "request", async (r, a) => {
+      var b, g;
+      const i = r.getTimeout() ?? a.timeout, n = new AbortController(), p = setTimeout(() => n.abort(), i), c = {
+        method: r.method,
+        headers: a.headers,
+        ...i && { signal: n.signal }
+      };
+      u(a, "body") && (a.body instanceof FormData ? c.body = a.body : c.body = JSON.stringify(a.body));
+      const d = await fetch(this.createUrl(r, a), c);
+      if (clearTimeout(p), d.body) {
+        if ((b = d.headers.get("Content-Disposition")) != null && b.includes("attachment"))
+          return d.blob();
+        const l = await d.text();
+        return (g = d.headers.get("Content-Type")) != null && g.includes("application/json") && k(l) ? JSON.parse(l) : l;
+      }
+    });
+  }
+}
+class S {
+  constructor(t) {
+    /**
+     * HTTP method.
+     */
+    e(this, "method", "GET");
+    /**
+     * The property in the request body and response body. If the response body
+     * property differs, set responseProperty alongside property.
+     * If the property is undefined, the endpoint will be called without a namespace.
+     */
+    e(this, "property");
+    /**
+     * Property used in the response. Falls back to `this.property` if it's not
+     * set.
+     */
+    e(this, "responseProperty");
+    /**
+     * Timeout in milliseconds.
+     * This is used to override the default timeout of the client.
+     */
+    e(this, "timeout");
+    /**
+     * Headers to include when calling this endpoint.
+     */
+    e(this, "headers");
+    /**
+     * Parameters to include in the endpoint url.
+     */
+    e(this, "parameters");
+    this.headers = (t == null ? void 0 : t.headers) ?? {}, this.parameters = (t == null ? void 0 : t.parameters) ?? {};
+  }
+  getHeaders() {
+    return this.headers;
+  }
+  getParameters() {
+    return this.parameters;
+  }
+  getPath() {
+    return this.path;
+  }
+  getProperty() {
+    return this.property;
+  }
+  getResponseProperty() {
+    return this.responseProperty ?? this.property;
+  }
+  getTimeout() {
+    return this.timeout;
+  }
+}
+class o extends S {
+}
+class m extends S {
+}
+function P(s, t) {
+  if (!t.length)
+    throw new h("At least one endpoint must be passed.");
+  return t.reduce(
+    (r, a) => ({
+      ...r,
+      [a.name]: async (i) => s.doRequest(a, i ?? {})
+    }),
+    {}
+  );
+}
+const G = (s, t) => (s.requiredHeaders = ["Authorization"], P(s, t)), v = (s, t) => P(s, t);
+class f extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "method", "DELETE");
+    e(this, "name", "deleteAccountMessage");
+    e(this, "path", "account_messages/:id");
+    e(this, "property", "messages");
+  }
+}
+class D extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getAccountMessages");
+    e(this, "path", "account_messages");
+    e(this, "property", "messages");
+  }
+}
+class j extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getAccount");
+    e(this, "path", "accounts/:id");
+    e(this, "property", "accounts");
+  }
+}
+class q extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getAccounts");
+    e(this, "path", "accounts");
+    e(this, "property", "accounts");
+  }
+}
+class U extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "method", "PUT");
+    e(this, "name", "putAccount");
+    e(this, "path", "accounts");
+    e(this, "property", "accounts");
+  }
+}
+class L extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getApiKeys");
+    e(this, "path", "keys");
+    e(this, "property", "api_keys");
+  }
+}
+class $ extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "method", "POST");
+    e(this, "name", "postApiKeys");
+    e(this, "path", "keys");
+    e(this, "property", "api_keys");
+  }
+}
+class M extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "method", "DELETE");
+    e(this, "name", "deleteCarrierOption");
+    e(this, "path", "accounts/:account_id/carrier_options/:contract_id");
+    e(this, "property", "carrier_options");
+  }
+}
+class R extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getCarrierOptions");
+    e(this, "path", "carrier_management/accounts/:account_id/carrier_options");
+    e(this, "property", "carrier_options");
+  }
+}
+class W extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "method", "POST");
+    e(this, "name", "postCarrierOptions");
+    e(this, "path", "accounts/:account_id/carrier_options");
+    e(this, "property", "carrier_options");
+    e(this, "responseProperty", "ids");
+  }
+}
+class N extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "putCarrierOptions");
+    e(this, "path", "carrier_management/accounts/:account_id/carrier_options");
+    e(this, "property", "carrier_options");
+    e(this, "method", "PUT");
+  }
+}
+class z extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getLocations");
+    e(this, "path", "locations");
+    e(this, "property", "locations");
+  }
+}
+class J extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getShipment");
+    e(this, "path", "shipments/:id");
+    e(this, "property", "shipments");
+  }
+}
+class K extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getShipments");
+    e(this, "path", "shipments");
+    e(this, "property", "shipments");
+  }
+}
+class B extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "method", "POST");
+    e(this, "name", "postShipments");
+    e(this, "path", "shipments");
+    e(this, "property", "shipments");
+    e(this, "responseProperty", "ids");
+  }
+  getHeaders() {
+    return {
+      ...super.getHeaders(),
+      "Content-Type": "application/vnd.shipment+json;charset=utf-8;version=1.1"
+    };
+  }
+}
+class F extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getShop");
+    e(this, "path", "shops/:id");
+    e(this, "property", "shops");
+  }
+}
+class I extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "method", "POST");
+    e(this, "name", "postShop");
+    e(this, "path", "shops/duplicate");
+    e(this, "property", "shops");
+    e(this, "responseProperty", "ids");
+  }
+}
+class Q extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "method", "PUT");
+    e(this, "name", "putShop");
+    e(this, "path", "shops");
+    e(this, "property", "shops");
+  }
+}
+class X extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "method", "POST");
+    e(this, "name", "postShopDuplicate");
+    e(this, "path", "shops/duplicate");
+    e(this, "property", "ids");
+  }
+}
+class Y extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getSubscriptionsCapabilities");
+    e(this, "path", "subscriptions/capabilities");
+    e(this, "property", "capabilities");
+  }
+}
+class Z extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "method", "DELETE");
+    e(this, "name", "deleteSubscription");
+    e(this, "path", "subscriptions/:id");
+    e(this, "property", "subscriptions");
+  }
+}
+class V extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getSubscriptions");
+    e(this, "path", "subscriptions");
+    e(this, "property", "subscriptions");
+  }
+}
+class ee extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "method", "PATCH");
+    e(this, "name", "patchSubscriptions");
+    e(this, "path", "subscriptions");
+    e(this, "property", "subscriptions");
+    e(this, "responseProperty", "ids");
+  }
+}
+class te extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "method", "POST");
+    e(this, "name", "postSubscriptions");
+    e(this, "path", "subscriptions");
+    e(this, "property", "subscriptions");
+    e(this, "responseProperty", "ids");
+  }
+}
+class se extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getSystemCountryCodes");
+    e(this, "path", "system_country_codes");
+    e(this, "property", "countries");
+  }
+}
+class re extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getSystemMessages");
+    e(this, "path", "system_messages");
+    e(this, "property", "messages");
+  }
+}
+class ae extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getTrackAndTrace");
+    e(this, "path", "tracktraces/:shipment_id");
+    e(this, "property", "tracktraces");
+  }
+}
+class oe extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "method", "DELETE");
+    e(this, "name", "deleteWebhookSubscriptions");
+    e(this, "path", "webhook_subscriptions/:ids");
+    e(this, "property", "webhook_subscriptions");
+  }
+}
+class ie extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getWebhookSubscriptions");
+    e(this, "path", "webhook_subscriptions");
+    e(this, "property", "webhook_subscriptions");
+  }
+}
+class ne extends o {
+  constructor() {
+    super(...arguments);
+    e(this, "method", "POST");
+    e(this, "name", "postWebhookSubscriptions");
+    e(this, "path", "webhook_subscriptions");
+    e(this, "property", "webhook_subscriptions");
+    e(this, "responseProperty", "ids");
+  }
+}
+class pe extends m {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getCarrier");
+    e(this, "path", "carriers/:carrier");
+    e(this, "property", "carriers");
+  }
+}
+class ce extends m {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getCarriers");
+    e(this, "path", "carriers");
+    e(this, "property", "carriers");
+  }
+}
+class de extends m {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getDeliveryOptions");
+    e(this, "path", "delivery_options");
+    e(this, "property", "deliveries");
+  }
+  getHeaders() {
+    return { ...super.getHeaders(), Accept: "application/json;version=2.0" };
+  }
+}
+class he extends m {
+  constructor() {
+    super(...arguments);
+    e(this, "name", "getPickupLocations");
+    e(this, "path", "pickup_locations");
+    e(this, "property", "pickup_locations");
+  }
+}
+export {
+  A as AbstractClient,
+  S as AbstractEndpoint,
+  o as AbstractPrivateEndpoint,
+  m as AbstractPublicEndpoint,
+  y as ApiException,
+  O as BASE_URL,
+  f as DeleteAccountMessage,
+  M as DeleteCarrierOptions,
+  Z as DeleteSubscription,
+  oe as DeleteWebhookSubscriptions,
+  H as FetchClient,
+  j as GetAccount,
+  D as GetAccountMessages,
+  q as GetAccounts,
+  L as GetApiKeys,
+  pe as GetCarrier,
+  R as GetCarrierOptions,
+  ce as GetCarriers,
+  de as GetDeliveryOptions,
+  z as GetLocations,
+  he as GetPickupLocations,
+  J as GetShipment,
+  K as GetShipments,
+  F as GetShop,
+  V as GetSubscriptions,
+  Y as GetSubscriptionsCapabilities,
+  se as GetSystemCountryCodes,
+  re as GetSystemMessages,
+  ae as GetTrackAndTrace,
+  ie as GetWebhookSubscriptions,
+  ee as PatchSubscriptions,
+  $ as PostApiKeys,
+  W as PostCarrierOptions,
+  B as PostShipments,
+  I as PostShop,
+  X as PostShopDuplicate,
+  te as PostSubscriptions,
+  ne as PostWebhookSubscriptions,
+  U as PutAccount,
+  N as PutCarrierOptions,
+  Q as PutShop,
+  h as UserException,
+  _ as addParameters,
+  P as createMyParcelSdk,
+  G as createPrivateSdk,
+  v as createPublicSdk,
+  k as isJson
+};

package/lib/index.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/model/client/AbstractClient.d.ts

@@ -0,0 +1,78 @@
+import { type RequestHeader, type RequestHeaders } from '../../types/request.types';
+import { type WithRequired } from '../../types';
+import { type AbstractEndpoint } from '../endpoint/AbstractEndpoint';
+import { type ClientConfig, type ClientOptions, type ClientRequest, type EndpointPath, type EndpointResponse, type PaginatedEndpointResponse, type Options } from './AbstractClient.types';
+export declare const BASE_URL = "https://api.myparcel.nl";
+export declare abstract class AbstractClient {
+    /**
+     * Executes the request. Should return a promise containing the response json as object.
+     */
+    protected abstract request: ClientRequest;
+    /**
+     * Base URL to make requests to.
+     *
+     * @protected
+     */
+    protected baseUrl: string;
+    /**
+     * Headers to use with requests.
+     *
+     * @protected
+     */
+    protected headers: RequestHeaders;
+    /**
+     * @protected
+     */
+    protected parameters: Record<string, string>;
+    /**
+     * Additional client specific options.
+     *
+     * @protected
+     */
+    protected options: ClientOptions;
+    /**
+     * Array of headers that are required. Client will throw an error if any are missing.
+     *
+     * @private
+     */
+    private _requiredHeaders;
+    protected constructor(config?: ClientConfig);
+    get requiredHeaders(): (RequestHeader | string)[];
+    set requiredHeaders(value: (RequestHeader | string)[]);
+    /**
+     * Prepare and execute the final request and handle the response.
+     */
+    doRequest<E extends AbstractEndpoint>(endpoint: E, options: Options<E>): Promise<EndpointResponse<E>>;
+    getResponseBody<E extends AbstractEndpoint>(endpoint: E, response: EndpointResponse<E>): EndpointResponse<E> | PaginatedEndpointResponse<E>;
+    /**
+     * Gets default and custom headers.
+     *
+     * @protected
+     */
+    protected getHeaders(): RequestHeaders;
+    /**
+     * Uses the base url, endpoint and options to create the final request url.
+     *
+     * @protected
+     */
+    protected createUrl<E extends AbstractEndpoint>(endpoint: E, options: Options<E>): string;
+    /**
+     * Replace path variables in an url path. Deletes optional parameters if
+     * they're not passed.
+     *
+     * @protected
+     */
+    protected substitutePath<E extends AbstractEndpoint>(urlPath: string, pathVariables?: EndpointPath<E>): string;
+    /**
+     * Validates headers passed in options.
+     *
+     * @protected
+     */
+    protected validateHeaders<E extends AbstractEndpoint>(endpoint: E, options: WithRequired<Options<E>, 'headers'>): void;
+    /**
+     * Executes transformations on options before request.
+     *
+     * @protected
+     */
+    protected normalizeOptions<E extends AbstractEndpoint>(endpoint: E, options: Options<E>): WithRequired<Options<E>, 'headers'>;
+}

package/lib/model/client/AbstractClient.spec.d.ts

@@ -0,0 +1 @@
+export {};