@deenruv/inpost 1.0.0

package/src/models/parcel.ts

@@ -0,0 +1,75 @@
+export type Parcel = {
+  id?: number;
+  identify_number?: string;
+} & (
+  | {
+      template: 'small';
+      is_non_standard?: false;
+      dimensions?: {
+        length: 380;
+        width: 640;
+        height: 80;
+        unit: 'mm';
+      };
+      weight?: {
+        amount: 25;
+        unit: 'kg';
+      };
+    }
+  | {
+      template: 'medium';
+      is_non_standard?: false;
+      dimensions?: {
+        length: 380;
+        width: 640;
+        height: 190;
+        unit: 'mm';
+      };
+      weight?: {
+        amount: 25;
+        unit: 'kg';
+      };
+    }
+  | {
+      template: 'large';
+      is_non_standard?: false;
+      dimensions?: {
+        length: 380;
+        width: 640;
+        height: 410;
+        unit: 'mm';
+      };
+      weight?: {
+        amount: 25;
+        unit: 'kg';
+      };
+    }
+  | {
+      template: 'xlarge';
+      is_non_standard?: false;
+      dimensions?: {
+        length: 500;
+        width: 800;
+        height: 500;
+        unit: 'mm';
+      };
+      weight?: {
+        amount: 25;
+        unit: 'kg';
+      };
+    }
+  | {
+      is_non_standard?: boolean;
+      template?: null;
+      dimensions: {
+        length: number;
+        width: number;
+        height: number;
+        unit: string;
+      };
+      weight: {
+        amount: number;
+        unit: string;
+      };
+    }
+);

package/src/models/person.ts

@@ -0,0 +1,11 @@
+import { Address } from './address.js';
+
+export interface Person {
+  id?: number;
+  email?: string;
+  phone?: string;
+  first_name?: string;
+  last_name?: string;
+  company_name?: string;
+  address?: Address;
+}

package/src/models/service.ts

@@ -0,0 +1,15 @@
+export type Service =
+  | 'inpost_locker_allegro'
+  | 'inpost_locker_pass_thru'
+  | 'inpost_locker_standard'
+  | 'inpost_letter_allegro'
+  | 'inpost_courier_palette'
+  | 'inpost_courier_allegro'
+  | 'inpost_courier_standard'
+  | 'inpost_courier_express_1000'
+  | 'inpost_courier_express_1200'
+  | 'inpost_courier_express_1700'
+  | 'inpost_courier_c2c'
+  | 'inpost_locker_standard_smart'
+  | 'inpost_locker_allegro_smart'
+  | 'inpost_locker_economy';

package/src/models/shipment.ts

@@ -0,0 +1,39 @@
+import { Person } from "./person.js";
+import { Parcel } from "./parcel.js";
+import { Money } from "./money.js";
+import { Service } from "./service.js";
+import { Offer } from "./offer.js";
+import { Transaction } from "./transaction.js";
+
+export interface Shipment {
+  id?: number;
+  receiver: Person;
+  sender?: Person;
+  parcels: Parcel[];
+  custom_attributes?: {
+    sending_method?:
+      | "parcel_locker"
+      | "dispatch_order"
+      | "branch"
+      | "pop"
+      | "any_point"
+      | "courier_pok";
+    target_point?: string;
+    dropoff_point?: string;
+    dispatch_order_id?: string;
+  };
+  cod?: Money;
+  insurance?: Money;
+  reference?: string;
+  is_return?: boolean;
+  service: Service;
+  additional_services?: ("sms" | "email" | "saturday")[];
+  external_customer_id?: string;
+  only_choice_of_offer?: boolean;
+  mpk?: string;
+  comments?: string;
+  status?: "created" | "offer_selected";
+  offers?: Offer[];
+  selected_offer?: Offer;
+  transactions?: Transaction[];
+}

package/src/models/transaction.ts

@@ -0,0 +1,7 @@
+export type Transaction = {
+  id: number;
+  status: string;
+  offer_id: number;
+  created_at: string;
+  updated_at: string;
+};

package/src/validators/address.ts

@@ -0,0 +1,19 @@
+import { Address } from "../models/index.js";
+import { isCountryCode } from "./is_country_code.js";
+import { isNumber } from "./number.js";
+import { isObject } from "./object.js";
+import { isOptional } from "./optional.js";
+import { isString } from "./string.js";
+
+const validateAddress = (v: Address) =>
+  isNumber(v.id) &&
+  isOptional(isString)((v as { building_number: string }).building_number) &&
+  isOptional(isString)((v as { street: string }).street) &&
+  isOptional(isString)(v.city) &&
+  isOptional(isString)((v as { line1: string }).line1) &&
+  isOptional(isString)((v as { line2: string }).line2) &&
+  isString(v.post_code) &&
+  isCountryCode(v.country_code);
+
+export const isAddress = (v: unknown): v is Address =>
+  isObject(v) && validateAddress(v as Address);

package/src/validators/array.ts

@@ -0,0 +1,4 @@
+export const isArray =
+  <T>(fn: (v: unknown) => v is T) =>
+  (v: unknown): v is T[] =>
+    Array.isArray(v) && v.filter(fn).length === v.length;

package/src/validators/carrier.ts

@@ -0,0 +1,13 @@
+import { Carrier } from '../models/index.js';
+
+const mustBeCarrier = (v: Carrier): true => {
+  switch (v) {
+    case 'inpost_locker':
+    case 'inpost_letter':
+    case 'inpost_courier':
+      return true;
+  }
+};
+
+export const isCarrier = (v: unknown): v is Carrier =>
+  !!mustBeCarrier(v as Carrier);

package/src/validators/is_country_code.ts

@@ -0,0 +1,11 @@
+import { CountryCode } from '../models/index.js';
+// Small trick that will cause compile time error if any enum is missing
+const mustBeCountryCode = (v: CountryCode) => {
+  switch (v) {
+    case CountryCode.pl:
+    case CountryCode.en:
+      return true;
+  }
+};
+export const isCountryCode = (v: unknown): v is CountryCode =>
+  !!mustBeCountryCode(v as CountryCode);

package/src/validators/is_currency_code.ts

@@ -0,0 +1,10 @@
+import { CurrencyCode } from '../models/index.js';
+// Small trick that will cause compile time error if any enum is missing
+const mustBeCurrencyCode = (v: CurrencyCode) => {
+  switch (v) {
+    case CurrencyCode.PLN:
+      return true;
+  }
+};
+export const isCurrencyCode = (v: unknown): v is CurrencyCode =>
+  !!mustBeCurrencyCode(v as CurrencyCode);

package/src/validators/is_money.ts

@@ -0,0 +1,8 @@
+import { Money } from '../models/index.js';
+import { isObject } from './object.js';
+import { isCurrencyCode } from './is_currency_code.js';
+
+const mustBeMoney = (v: Money) =>
+  typeof v.amount === 'number' && isCurrencyCode(v.currency);
+export const isMoney = (v: unknown): v is Money =>
+  isObject(v) && mustBeMoney(v as Money);

package/src/validators/is_parcel.ts

@@ -0,0 +1,11 @@
+import { Parcel } from '../models/index.js';
+import { isObject } from './object.js';
+import { isOptional } from './optional.js';
+
+const mustBeParcel = (v: Parcel): v is Parcel =>
+  isOptional(
+    (v: unknown): v is Parcel['template'] =>
+      v === 'small' || v === 'medium' || v === 'large' || v === 'xlarge',
+  )(v.template);
+export const isParcel = (v: unknown): v is Parcel =>
+  isObject(v) && mustBeParcel(v as Parcel);

package/src/validators/is_shipment.ts

@@ -0,0 +1,5 @@
+import { Shipment } from '../models/index.js';
+import { isObject } from './object.js';
+
+// TODO: finish validation of shipment
+export const isShipment = (v: unknown): v is Shipment => isObject(v);

package/src/validators/number.ts

@@ -0,0 +1 @@
+export const isNumber = (v: unknown): v is number => typeof v === 'number';

package/src/validators/object.ts

@@ -0,0 +1,2 @@
+export const isObject = (v: unknown): v is object =>
+  !!v && typeof v === 'object';

package/src/validators/optional.ts

@@ -0,0 +1,4 @@
+export const isOptional =
+  <T>(fn: (v: unknown) => v is T) =>
+  (v: unknown): v is T | undefined | null =>
+    v === undefined || v === null || fn(v);

package/src/validators/organization.ts

@@ -0,0 +1,29 @@
+import { isNumber } from './number.js';
+import { isObject } from './object.js';
+import { isOptional } from './optional.js';
+import { isArray } from './array.js';
+import { isString } from './string.js';
+import { isCarrier } from './carrier.js';
+import { isService } from './services.js';
+import { isPerson } from './person.js';
+import { isAddress } from './address.js';
+import { Organization } from '../models/index.js';
+
+const validateOrganization = (v: Organization) =>
+  isNumber(v.id) &&
+  isAddress(v.address) &&
+  isOptional(isString)(v.bank_account_number) &&
+  isArray(isCarrier)(v.carriers) &&
+  isOptional(isPerson)(v.contact_person) &&
+  isString(v.created_at) &&
+  isString(v.href) &&
+  isNumber(v.id) &&
+  isOptional(isAddress)(v.invoice_address) &&
+  isString(v.name) &&
+  isNumber(v.owner_id) &&
+  isArray(isService)(v.services) &&
+  isString(v.tax_id) &&
+  isString(v.updated_at);
+
+export const isOrganization = (v: unknown): v is Organization =>
+  isObject(v) && validateOrganization(v as Organization);

package/src/validators/person.ts

@@ -0,0 +1,18 @@
+import { Person } from '../models/index.js';
+import { isAddress } from './address.js';
+import { isNumber } from './number.js';
+import { isObject } from './object.js';
+import { isOptional } from './optional.js';
+import { isString } from './string.js';
+
+const validatePerson = (v: Person) =>
+  isOptional(isNumber)(v.id) &&
+  isOptional(isString)(v.email) &&
+  isOptional(isString)(v.first_name) &&
+  isOptional(isString)(v.last_name) &&
+  isOptional(isString)(v.phone) &&
+  isOptional(isString)(v.company_name) &&
+  isOptional(isAddress)(v.address);
+
+export const isPerson = (v: unknown): v is Person =>
+  isObject(v) && validatePerson(v as Person);

package/src/validators/services.ts

@@ -0,0 +1,24 @@
+import { Service } from '../models/index.js';
+
+const mustBeService = (v: Service): true => {
+  switch (v) {
+    case 'inpost_locker_allegro':
+    case 'inpost_locker_pass_thru':
+    case 'inpost_locker_standard':
+    case 'inpost_locker_economy':
+    case 'inpost_letter_allegro':
+    case 'inpost_courier_palette':
+    case 'inpost_courier_allegro':
+    case 'inpost_courier_standard':
+    case 'inpost_courier_express_1000':
+    case 'inpost_courier_express_1200':
+    case 'inpost_courier_express_1700':
+    case 'inpost_courier_c2c':
+    case 'inpost_locker_standard_smart':
+    case 'inpost_locker_allegro_smart':
+      return true;
+  }
+};
+
+export const isService = (v: unknown): v is Service =>
+  !!mustBeService(v as Service);

package/src/validators/string.ts

@@ -0,0 +1 @@
+export const isString = (v: unknown): v is string => typeof v === 'string';

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true,
+    "module": "nodenext",
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.cts", "src/**/*.mts", "src/**/*.ts"]
+}