@intelact/gnosa 0.1.0 → 0.1.1

package/lib/order/order.model.js

@@ -0,0 +1,427 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Order = exports.OrderItem = exports.Address = exports.Cart = exports.CartItem = exports.ShippingCountry = void 0;
+const class_transformer_1 = require("class-transformer");
+const order_enum_1 = require("./order.enum");
+/**
+ * A country Gnosa ships to, with its flat shipping rate in each currency, whatever the quantity.
+ */
+class ShippingCountry {
+    /**
+     * ISO 3166-1 alpha-2 code (`DE`).
+     */
+    code;
+    /**
+     * The country's name in the app language.
+     */
+    name;
+    rateEur;
+    rateMkd;
+    /**
+     * Whether the shipping address needs a state or province.
+     */
+    requiresState;
+    constructor(props) {
+        Object.assign(this, props);
+    }
+}
+exports.ShippingCountry = ShippingCountry;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], ShippingCountry.prototype, "code", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], ShippingCountry.prototype, "name", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], ShippingCountry.prototype, "rateEur", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], ShippingCountry.prototype, "rateMkd", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Boolean)
+], ShippingCountry.prototype, "requiresState", void 0);
+/**
+ * One publication of a priced cart, at its current price in the cart currency.
+ */
+class CartItem {
+    type;
+    slug;
+    /**
+     * In the app language; `null` for a publication that no longer exists.
+     */
+    title;
+    coverUrl;
+    /**
+     * The current VAT-inclusive unit price; `null` when the publication can't be ordered.
+     */
+    unitPrice;
+    quantity;
+    /**
+     * `unitPrice` × `quantity`; 0 when the publication can't be ordered.
+     */
+    lineTotal;
+    /**
+     * Whether the physical publication can still be ordered.
+     */
+    isAvailable;
+    /**
+     * Whether the current price differs from the one the cart showed.
+     */
+    isPriceChanged;
+    constructor(props) {
+        Object.assign(this, props);
+    }
+}
+exports.CartItem = CartItem;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], CartItem.prototype, "type", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], CartItem.prototype, "slug", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], CartItem.prototype, "title", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], CartItem.prototype, "coverUrl", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], CartItem.prototype, "unitPrice", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], CartItem.prototype, "quantity", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], CartItem.prototype, "lineTotal", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Boolean)
+], CartItem.prototype, "isAvailable", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Boolean)
+], CartItem.prototype, "isPriceChanged", void 0);
+/**
+ * The website's cart, priced: the items at their current prices, and, once a delivery country is
+ * chosen, the shipping and the total. Every amount is in `currency` and includes VAT.
+ */
+class Cart {
+    currency;
+    items;
+    /**
+     * Sum of the line totals of the available items.
+     */
+    subtotal;
+    /**
+     * The delivery country's code, when one was given.
+     */
+    country;
+    /**
+     * The country's flat rate; `null` until a country is given.
+     */
+    shippingCost;
+    /**
+     * `subtotal` + `shippingCost`.
+     */
+    total;
+    /**
+     * The VAT rate included in every price, as a percentage.
+     */
+    vatRate;
+    /**
+     * The VAT included in `total`.
+     */
+    vatAmount;
+    /**
+     * Whether the cart can be checked out as it is: no unavailable item and no changed price.
+     */
+    isValid;
+    constructor(props) {
+        Object.assign(this, props);
+    }
+}
+exports.Cart = Cart;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Cart.prototype, "currency", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_transformer_1.Type)(() => CartItem),
+    __metadata("design:type", Array)
+], Cart.prototype, "items", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], Cart.prototype, "subtotal", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Cart.prototype, "country", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], Cart.prototype, "shippingCost", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], Cart.prototype, "total", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], Cart.prototype, "vatRate", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], Cart.prototype, "vatAmount", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Boolean)
+], Cart.prototype, "isValid", void 0);
+/**
+ * A postal address of an order.
+ */
+class Address {
+    line1;
+    line2;
+    postcode;
+    city;
+    state;
+    /**
+     * ISO 3166-1 alpha-2 code (`DE`).
+     */
+    country;
+    /**
+     * The country's name in the app language.
+     */
+    countryName;
+    constructor(props) {
+        Object.assign(this, props);
+    }
+}
+exports.Address = Address;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Address.prototype, "line1", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Address.prototype, "line2", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Address.prototype, "postcode", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Address.prototype, "city", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Address.prototype, "state", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Address.prototype, "country", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Address.prototype, "countryName", void 0);
+/**
+ * One publication line of an order, as it was at checkout.
+ */
+class OrderItem {
+    type;
+    title;
+    unitPrice;
+    quantity;
+    lineTotal;
+    constructor(props) {
+        Object.assign(this, props);
+    }
+}
+exports.OrderItem = OrderItem;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], OrderItem.prototype, "type", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], OrderItem.prototype, "title", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], OrderItem.prototype, "unitPrice", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], OrderItem.prototype, "quantity", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], OrderItem.prototype, "lineTotal", void 0);
+/**
+ * A customer's order, a snapshot of the checkout. Every amount is in `currency` and includes VAT. The
+ * list carries the fields of a row; the detail adds the contact details, addresses, items, amounts
+ * and the workflow times.
+ */
+class Order {
+    /**
+     * The order reference (`GN-00042`), which identifies the order and is the E-Banking payment
+     * reference.
+     */
+    reference;
+    /**
+     * When the order was placed, in UTC.
+     */
+    createdOn;
+    status;
+    currency;
+    firstName;
+    lastName;
+    email;
+    total;
+    /**
+     * Whether an Orders List page has already displayed the order; until then it shows a New badge.
+     */
+    isSeen;
+    phone;
+    shippingAddress;
+    billingAddress;
+    items;
+    subtotal;
+    shippingCost;
+    /**
+     * The VAT rate at checkout, as a percentage.
+     */
+    vatRate;
+    /**
+     * The VAT included in `total`.
+     */
+    vatAmount;
+    /**
+     * When the payment was confirmed, in UTC.
+     */
+    paidOn;
+    /**
+     * When the order was marked as shipped, in UTC.
+     */
+    shippedOn;
+    trackingUrl;
+    constructor(props) {
+        Object.assign(this, props);
+    }
+}
+exports.Order = Order;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Order.prototype, "reference", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_transformer_1.Type)(() => Date),
+    __metadata("design:type", Date)
+], Order.prototype, "createdOn", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Order.prototype, "status", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Order.prototype, "currency", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Order.prototype, "firstName", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Order.prototype, "lastName", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Order.prototype, "email", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], Order.prototype, "total", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Boolean)
+], Order.prototype, "isSeen", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Order.prototype, "phone", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_transformer_1.Type)(() => Address),
+    __metadata("design:type", Address)
+], Order.prototype, "shippingAddress", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_transformer_1.Type)(() => Address),
+    __metadata("design:type", Address)
+], Order.prototype, "billingAddress", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_transformer_1.Type)(() => OrderItem),
+    __metadata("design:type", Array)
+], Order.prototype, "items", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], Order.prototype, "subtotal", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], Order.prototype, "shippingCost", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], Order.prototype, "vatRate", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], Order.prototype, "vatAmount", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_transformer_1.Type)(() => Date),
+    __metadata("design:type", Date)
+], Order.prototype, "paidOn", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_transformer_1.Type)(() => Date),
+    __metadata("design:type", Date)
+], Order.prototype, "shippedOn", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], Order.prototype, "trackingUrl", void 0);
+//# sourceMappingURL=order.model.js.map

package/lib/order/order.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order.model.js","sourceRoot":"","sources":["../../src/order/order.model.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAAiD;AAEjD,6CAAoE;AAEpE;;GAEG;AACH,MAAa,eAAe;IAC3B;;OAEG;IAEH,IAAI,CAAS;IAEb;;OAEG;IAEH,IAAI,CAAS;IAGb,OAAO,CAAS;IAGhB,OAAO,CAAS;IAEhB;;OAEG;IAEH,aAAa,CAAU;IAEvB,YAAY,KAAgC;QAC3C,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;CACD;AA5BD,0CA4BC;AAvBA;IADC,IAAA,0BAAM,GAAE;;6CACI;AAMb;IADC,IAAA,0BAAM,GAAE;;6CACI;AAGb;IADC,IAAA,0BAAM,GAAE;;gDACO;AAGhB;IADC,IAAA,0BAAM,GAAE;;gDACO;AAMhB;IADC,IAAA,0BAAM,GAAE;;sDACc;AAOxB;;GAEG;AACH,MAAa,QAAQ;IAEpB,IAAI,CAAgB;IAGpB,IAAI,CAAS;IAEb;;OAEG;IAEH,KAAK,CAAS;IAGd,QAAQ,CAAS;IAEjB;;OAEG;IAEH,SAAS,CAAS;IAGlB,QAAQ,CAAS;IAEjB;;OAEG;IAEH,SAAS,CAAS;IAElB;;OAEG;IAEH,WAAW,CAAU;IAErB;;OAEG;IAEH,cAAc,CAAU;IAExB,YAAY,KAAyB;QACpC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;CACD;AA9CD,4BA8CC;AA5CA;IADC,IAAA,0BAAM,GAAE;;sCACW;AAGpB;IADC,IAAA,0BAAM,GAAE;;sCACI;AAMb;IADC,IAAA,0BAAM,GAAE;;uCACK;AAGd;IADC,IAAA,0BAAM,GAAE;;0CACQ;AAMjB;IADC,IAAA,0BAAM,GAAE;;2CACS;AAGlB;IADC,IAAA,0BAAM,GAAE;;0CACQ;AAMjB;IADC,IAAA,0BAAM,GAAE;;2CACS;AAMlB;IADC,IAAA,0BAAM,GAAE;;6CACY;AAMrB;IADC,IAAA,0BAAM,GAAE;;gDACe;AAOzB;;;GAGG;AACH,MAAa,IAAI;IAEhB,QAAQ,CAAW;IAInB,KAAK,CAAa;IAElB;;OAEG;IAEH,QAAQ,CAAS;IAEjB;;OAEG;IAEH,OAAO,CAAS;IAEhB;;OAEG;IAEH,YAAY,CAAS;IAErB;;OAEG;IAEH,KAAK,CAAS;IAEd;;OAEG;IAEH,OAAO,CAAS;IAEhB;;OAEG;IAEH,SAAS,CAAS;IAElB;;OAEG;IAEH,OAAO,CAAU;IAEjB,YAAY,KAAqB;QAChC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;CACD;AArDD,oBAqDC;AAnDA;IADC,IAAA,0BAAM,GAAE;;sCACU;AAInB;IAFC,IAAA,0BAAM,GAAE;IACR,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,QAAQ,CAAC;;mCACH;AAMlB;IADC,IAAA,0BAAM,GAAE;;sCACQ;AAMjB;IADC,IAAA,0BAAM,GAAE;;qCACO;AAMhB;IADC,IAAA,0BAAM,GAAE;;0CACY;AAMrB;IADC,IAAA,0BAAM,GAAE;;mCACK;AAMd;IADC,IAAA,0BAAM,GAAE;;qCACO;AAMhB;IADC,IAAA,0BAAM,GAAE;;uCACS;AAMlB;IADC,IAAA,0BAAM,GAAE;;qCACQ;AAOlB;;GAEG;AACH,MAAa,OAAO;IAEnB,KAAK,CAAS;IAGd,KAAK,CAAS;IAGd,QAAQ,CAAS;IAGjB,IAAI,CAAS;IAGb,KAAK,CAAS;IAEd;;OAEG;IAEH,OAAO,CAAS;IAEhB;;OAEG;IAEH,WAAW,CAAS;IAEpB,YAAY,KAAwB;QACnC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;CACD;AA/BD,0BA+BC;AA7BA;IADC,IAAA,0BAAM,GAAE;;sCACK;AAGd;IADC,IAAA,0BAAM,GAAE;;sCACK;AAGd;IADC,IAAA,0BAAM,GAAE;;yCACQ;AAGjB;IADC,IAAA,0BAAM,GAAE;;qCACI;AAGb;IADC,IAAA,0BAAM,GAAE;;sCACK;AAMd;IADC,IAAA,0BAAM,GAAE;;wCACO;AAMhB;IADC,IAAA,0BAAM,GAAE;;4CACW;AAOrB;;GAEG;AACH,MAAa,SAAS;IAErB,IAAI,CAAgB;IAGpB,KAAK,CAAS;IAGd,SAAS,CAAS;IAGlB,QAAQ,CAAS;IAGjB,SAAS,CAAS;IAElB,YAAY,KAA0B;QACrC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;CACD;AAnBD,8BAmBC;AAjBA;IADC,IAAA,0BAAM,GAAE;;uCACW;AAGpB;IADC,IAAA,0BAAM,GAAE;;wCACK;AAGd;IADC,IAAA,0BAAM,GAAE;;4CACS;AAGlB;IADC,IAAA,0BAAM,GAAE;;2CACQ;AAGjB;IADC,IAAA,0BAAM,GAAE;;4CACS;AAOnB;;;;GAIG;AACH,MAAa,KAAK;IACjB;;;OAGG;IAEH,SAAS,CAAS;IAElB;;OAEG;IAGH,SAAS,CAAO;IAGhB,MAAM,CAAc;IAGpB,QAAQ,CAAW;IAGnB,SAAS,CAAS;IAGlB,QAAQ,CAAS;IAGjB,KAAK,CAAS;IAGd,KAAK,CAAS;IAEd;;OAEG;IAEH,MAAM,CAAU;IAGhB,KAAK,CAAU;IAIf,eAAe,CAAW;IAI1B,cAAc,CAAW;IAIzB,KAAK,CAAe;IAGpB,QAAQ,CAAU;IAGlB,YAAY,CAAU;IAEtB;;OAEG;IAEH,OAAO,CAAU;IAEjB;;OAEG;IAEH,SAAS,CAAU;IAEnB;;OAEG;IAGH,MAAM,CAAQ;IAEd;;OAEG;IAGH,SAAS,CAAQ;IAGjB,WAAW,CAAU;IAErB,YAAY,KAAsB;QACjC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;CACD;AA5FD,sBA4FC;AAtFA;IADC,IAAA,0BAAM,GAAE;;wCACS;AAOlB;IAFC,IAAA,0BAAM,GAAE;IACR,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC;8BACN,IAAI;wCAAC;AAGhB;IADC,IAAA,0BAAM,GAAE;;qCACW;AAGpB;IADC,IAAA,0BAAM,GAAE;;uCACU;AAGnB;IADC,IAAA,0BAAM,GAAE;;wCACS;AAGlB;IADC,IAAA,0BAAM,GAAE;;uCACQ;AAGjB;IADC,IAAA,0BAAM,GAAE;;oCACK;AAGd;IADC,IAAA,0BAAM,GAAE;;oCACK;AAMd;IADC,IAAA,0BAAM,GAAE;;qCACO;AAGhB;IADC,IAAA,0BAAM,GAAE;;oCACM;AAIf;IAFC,IAAA,0BAAM,GAAE;IACR,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC;8BACF,OAAO;8CAAC;AAI1B;IAFC,IAAA,0BAAM,GAAE;IACR,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC;8BACH,OAAO;6CAAC;AAIzB;IAFC,IAAA,0BAAM,GAAE;IACR,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,SAAS,CAAC;;oCACF;AAGpB;IADC,IAAA,0BAAM,GAAE;;uCACS;AAGlB;IADC,IAAA,0BAAM,GAAE;;2CACa;AAMtB;IADC,IAAA,0BAAM,GAAE;;sCACQ;AAMjB;IADC,IAAA,0BAAM,GAAE;;wCACU;AAOnB;IAFC,IAAA,0BAAM,GAAE;IACR,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC;8BACR,IAAI;qCAAC;AAOd;IAFC,IAAA,0BAAM,GAAE;IACR,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC;8BACL,IAAI;wCAAC;AAGjB;IADC,IAAA,0BAAM,GAAE;;0CACY"}