@merkaly/api 0.3.4 → 0.3.6

package/dist/order/sale/transaction/transaction.enum.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SaleTransactionStatusEnum = void 0;
-var SaleTransactionStatusEnum;
+export var SaleTransactionStatusEnum;
 (function (SaleTransactionStatusEnum) {
     SaleTransactionStatusEnum["PENDING"] = "PENDING";
     SaleTransactionStatusEnum["ACCEPTED"] = "ACCEPTED";
@@ -9,5 +6,4 @@ var SaleTransactionStatusEnum;
     SaleTransactionStatusEnum["ON_HOLD"] = "ON_HOLD";
     SaleTransactionStatusEnum["COMPLETED"] = "COMPLETED";
     SaleTransactionStatusEnum["CANCELLED"] = "CANCELLED";
-})(SaleTransactionStatusEnum || (exports.SaleTransactionStatusEnum = SaleTransactionStatusEnum = {}));
-//# sourceMappingURL=transaction.enum.js.map
+})(SaleTransactionStatusEnum || (SaleTransactionStatusEnum = {}));

package/dist/order/sale/transaction/transaction.validator.d.ts

@@ -1,21 +1,22 @@
-import { CreateShippingValidator } from '../../../logistic/shipment';
 import { SaleTransactionEntity } from './';
 import { SaleTransactionStatusEnum } from './';
+import { CreateShippingValidator } from '../shipping';
 import { AbstractValidator, ReadValidator, SearchValidator } from '../../..';
-import { SaleOrderItemValidator } from '../item';
-import { CreatePaymentValidator } from '../payment';
-export declare class SearchOrdersValidator extends SearchValidator<SaleTransactionEntity> {
+import { SaleItemValidator } from '../item';
+import { SalePaymentValidator } from '../payment';
+export declare class SearchSaleTransactionValidator extends SearchValidator<SaleTransactionEntity> {
 }
-export declare class ReadOrderValidator extends ReadValidator<SaleTransactionEntity> {
+export declare class ReadSaleTransactionValidator extends ReadValidator<SaleTransactionEntity> {
 }
-export declare class CreateOrderValidator extends AbstractValidator {
-    items: SaleOrderItemValidator[];
+export declare class CreateSaleTransactionValidator extends AbstractValidator {
+    items: SaleItemValidator[];
     notes: string;
     shipping: CreateShippingValidator;
-    payment: CreatePaymentValidator;
+    payment: SalePaymentValidator;
     user: string;
-    company: string;
+    customer?: string;
 }
-export declare class UpdateOrderValidator extends CreateOrderValidator {
+export declare class UpdateSaleTransactionValidator extends AbstractValidator {
     status?: SaleTransactionStatusEnum;
+    notes?: string;
 }

package/dist/settings/organization/index.d.ts

@@ -0,0 +1,3 @@
+export * from './organization.entity';
+export * from './organization.enum';
+export * from './organization.validator';

package/dist/settings/organization/index.js

@@ -0,0 +1 @@
+export * from './organization.enum.js';

package/dist/settings/organization/organization.entity.d.ts

@@ -0,0 +1,5 @@
+import { AbstractEntity } from '../..';
+export declare class SettingsOrganizationEntity<V = unknown> extends AbstractEntity {
+    _id: string;
+    value: V;
+}

package/dist/settings/organization/organization.enum.d.ts

@@ -0,0 +1,13 @@
+export declare enum SettingsOrganizationEnum {
+    APP_WORKSPACE = "app.workspace",
+    APP_CONTACT = "app.contact",
+    APP_REGIONAL = "app.regional",
+    APP_ADDRESS = "app.address",
+    ORDER_SALE_SEQUENCE = "order.sale.sequence",
+    ORDER_SALE_PAYMENT_SEQUENCE = "order.sale.payment.sequence",
+    ORDER_SALE_SHIPPING_SEQUENCE = "order.sale.shipping.sequence",
+    ORDER_PURCHASE_SEQUENCE = "order.purchase.sequence",
+    INVENTORY_STOCK_TRANSFER_SEQUENCE = "inventory.stock.transfer.sequence",
+    FINANCE_REFUND_SEQUENCE = "finance.refund.sequence",
+    FINANCE_INVOICE_SEQUENCE = "finance.invoice.sequence"
+}

package/dist/settings/organization/organization.enum.js

@@ -0,0 +1,14 @@
+export var SettingsOrganizationEnum;
+(function (SettingsOrganizationEnum) {
+    SettingsOrganizationEnum["APP_WORKSPACE"] = "app.workspace";
+    SettingsOrganizationEnum["APP_CONTACT"] = "app.contact";
+    SettingsOrganizationEnum["APP_REGIONAL"] = "app.regional";
+    SettingsOrganizationEnum["APP_ADDRESS"] = "app.address";
+    SettingsOrganizationEnum["ORDER_SALE_SEQUENCE"] = "order.sale.sequence";
+    SettingsOrganizationEnum["ORDER_SALE_PAYMENT_SEQUENCE"] = "order.sale.payment.sequence";
+    SettingsOrganizationEnum["ORDER_SALE_SHIPPING_SEQUENCE"] = "order.sale.shipping.sequence";
+    SettingsOrganizationEnum["ORDER_PURCHASE_SEQUENCE"] = "order.purchase.sequence";
+    SettingsOrganizationEnum["INVENTORY_STOCK_TRANSFER_SEQUENCE"] = "inventory.stock.transfer.sequence";
+    SettingsOrganizationEnum["FINANCE_REFUND_SEQUENCE"] = "finance.refund.sequence";
+    SettingsOrganizationEnum["FINANCE_INVOICE_SEQUENCE"] = "finance.invoice.sequence";
+})(SettingsOrganizationEnum || (SettingsOrganizationEnum = {}));

package/dist/settings/organization/organization.validator.d.ts

@@ -0,0 +1,13 @@
+import { AbstractValidator, ReadValidator, SearchValidator } from '../..';
+import type { SettingsOrganizationEntity } from './';
+export declare class SearchSettingValidator extends SearchValidator<SettingsOrganizationEntity> {
+}
+export declare class ReadSettingValidator extends ReadValidator<SettingsOrganizationEntity> {
+}
+export declare class CreateSettingValidator extends AbstractValidator {
+    readonly key: string;
+    readonly value: string;
+}
+export declare class UpdateSettingValidator extends AbstractValidator {
+    readonly value?: string;
+}

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@merkaly/api",
-  "version": "0.3.4",
+  "version": "0.3.6",
+  "type": "module",
   "description": "Shared TypeScript interfaces and enums for Merkaly API",
   "exports": {
     "./inventory/catalog/product": {
@@ -23,6 +24,10 @@
       "types": "./dist/inventory/catalog/collection/index.d.ts",
       "default": "./dist/inventory/catalog/collection/index.js"
     },
+    "./inventory/catalog/variant": {
+      "types": "./dist/inventory/catalog/variant/index.d.ts",
+      "default": "./dist/inventory/catalog/variant/index.js"
+    },
     "./inventory/configuration/measurement": {
       "types": "./dist/inventory/configuration/measurement/index.d.ts",
       "default": "./dist/inventory/configuration/measurement/index.js"
@@ -43,10 +48,6 @@
       "types": "./dist/inventory/stock/transfer/index.d.ts",
       "default": "./dist/inventory/stock/transfer/index.js"
     },
-    "./inventory/stock/backorder": {
-      "types": "./dist/inventory/stock/backorder/index.d.ts",
-      "default": "./dist/inventory/stock/backorder/index.js"
-    },
     "./order/sale/transaction": {
       "types": "./dist/order/sale/transaction/index.d.ts",
       "default": "./dist/order/sale/transaction/index.js"
@@ -71,21 +72,29 @@
       "types": "./dist/order/purchase/item/index.d.ts",
       "default": "./dist/order/purchase/item/index.js"
     },
-    "./billing/payment": {
-      "types": "./dist/billing/payment/index.d.ts",
-      "default": "./dist/billing/payment/index.js"
+    "./order/sale/shipping": {
+      "types": "./dist/order/sale/shipping/index.d.ts",
+      "default": "./dist/order/sale/shipping/index.js"
+    },
+    "./finance/payment": {
+      "types": "./dist/finance/payment/index.d.ts",
+      "default": "./dist/finance/payment/index.js"
+    },
+    "./finance/invoice": {
+      "types": "./dist/finance/invoice/index.d.ts",
+      "default": "./dist/finance/invoice/index.js"
     },
-    "./billing/status": {
-      "types": "./dist/billing/status/index.d.ts",
-      "default": "./dist/billing/status/index.js"
+    "./finance/refund": {
+      "types": "./dist/finance/refund/index.d.ts",
+      "default": "./dist/finance/refund/index.js"
     },
-    "./logistic/shipment": {
-      "types": "./dist/logistic/shipment/index.d.ts",
-      "default": "./dist/logistic/shipment/index.js"
+    "./finance/tax": {
+      "types": "./dist/finance/tax/index.d.ts",
+      "default": "./dist/finance/tax/index.js"
     },
-    "./logistic/carrier": {
-      "types": "./dist/logistic/carrier/index.d.ts",
-      "default": "./dist/logistic/carrier/index.js"
+    "./finance/subscription": {
+      "types": "./dist/finance/subscription/index.d.ts",
+      "default": "./dist/finance/subscription/index.js"
     },
     "./account/user": {
       "types": "./dist/account/user/index.d.ts",

package/dist/billing/payment/index.d.ts

@@ -1,2 +0,0 @@
-export * from './transaction.entity';
-export * from './payment.enum';

package/dist/billing/payment/index.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var payment_enum_1 = require("./payment.enum");
-Object.keys(payment_enum_1).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  Object.defineProperty(exports, key, { enumerable: true, get: function () { return payment_enum_1[key]; } });
-});

package/dist/billing/payment/payment.enum.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BillingPaymentTypeEnum = exports.BillingPaymentStatusEnum = void 0;
-var BillingPaymentStatusEnum;
-(function (BillingPaymentStatusEnum) {
-    BillingPaymentStatusEnum["OPEN"] = "OPEN";
-    BillingPaymentStatusEnum["PENDING"] = "PENDING";
-    BillingPaymentStatusEnum["FAILED"] = "FAILED";
-    BillingPaymentStatusEnum["DISPUTED"] = "DISPUTED";
-    BillingPaymentStatusEnum["PAID"] = "PAID";
-    BillingPaymentStatusEnum["REFUNDED"] = "REFUNDED";
-    BillingPaymentStatusEnum["CANCELLED"] = "CANCELLED";
-})(BillingPaymentStatusEnum || (exports.BillingPaymentStatusEnum = BillingPaymentStatusEnum = {}));
-var BillingPaymentTypeEnum;
-(function (BillingPaymentTypeEnum) {
-    BillingPaymentTypeEnum["CARD"] = "CARD";
-    BillingPaymentTypeEnum["TRANSFER"] = "TRANSFER";
-    BillingPaymentTypeEnum["CASH"] = "CASH";
-    BillingPaymentTypeEnum["CRYPTO"] = "CRYPTO";
-})(BillingPaymentTypeEnum || (exports.BillingPaymentTypeEnum = BillingPaymentTypeEnum = {}));
-//# sourceMappingURL=payment.enum.js.map

package/dist/billing/payment/transaction.entity.d.ts

@@ -1,15 +0,0 @@
-import { SaleTransactionEntity } from '../../order/sale/transaction';
-import { AbstractEntity } from '../..';
-import { BillingPaymentTypeEnum } from './';
-import { BillingPaymentStatusEntity } from '../status';
-import type { MongoEntity } from '../..';
-export declare class BillingPaymentEntity extends AbstractEntity {
-    order: MongoEntity<SaleTransactionEntity>;
-    statuses: BillingPaymentStatusEntity[];
-    total: number;
-    fee: number;
-    type: BillingPaymentTypeEnum;
-    sequence: number;
-    readonly number: string;
-    readonly currentStatus: BillingPaymentStatusEntity;
-}

package/dist/billing/status/index.d.ts

@@ -1 +0,0 @@
-export * from './status.entity';

package/dist/billing/status/index.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/billing/status/status.entity.d.ts

@@ -1,8 +0,0 @@
-import { AccountUserEntity } from '../../account/user';
-import { BillingPaymentStatusEnum } from '../payment';
-import type { MongoEntity } from '../..';
-export declare class BillingPaymentStatusEntity {
-    name: BillingPaymentStatusEnum;
-    date: Date;
-    user: MongoEntity<AccountUserEntity>;
-}

package/dist/inventory/configuration/label/label.entity.d.ts

@@ -1,7 +0,0 @@
-import { AbstractEntity } from '../../..';
-export declare class ConfigurationLabelEntity extends AbstractEntity {
-    name: string;
-    description: string;
-    color: string;
-    active: boolean;
-}

package/dist/inventory/configuration/label/label.validator.d.ts

@@ -1,14 +0,0 @@
-import { ConfigurationLabelEntity } from './';
-import { AbstractValidator, ReadValidator, SearchValidator } from '../../..';
-export declare class SearchLabelValidator extends SearchValidator<ConfigurationLabelEntity> {
-}
-export declare class ReadLabelValidator extends ReadValidator<ConfigurationLabelEntity> {
-}
-export declare class CreateLabelValidator extends AbstractValidator {
-    name: string;
-    description?: string;
-    color?: string;
-    active?: boolean;
-}
-export declare class UpdateLabelValidator extends CreateLabelValidator {
-}

package/dist/inventory/stock/backorder/backorder.entity.d.ts

@@ -1,33 +0,0 @@
-import { CatalogProductEntity } from '../../catalog/product';
-import { StockWarehouseEntity } from '../warehouse';
-import { SaleCustomerEntity } from '../../../order/sale/customer';
-import { SaleTransactionEntity } from '../../../order/sale/transaction';
-import { AbstractEntity, MongoEntity } from '../../..';
-export declare enum BackorderStatusEnum {
-    PENDING = "PENDING",
-    PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED",
-    FULFILLED = "FULFILLED",
-    CANCELLED = "CANCELLED"
-}
-export declare enum BackorderPriorityEnum {
-    LOW = "LOW",
-    NORMAL = "NORMAL",
-    HIGH = "HIGH",
-    URGENT = "URGENT"
-}
-export declare class StockBackorderEntity extends AbstractEntity {
-    product: MongoEntity<CatalogProductEntity>;
-    quantityOrdered: number;
-    quantityFulfilled: number;
-    customer?: MongoEntity<SaleCustomerEntity>;
-    saleOrder?: MongoEntity<SaleTransactionEntity>;
-    warehouse?: MongoEntity<StockWarehouseEntity>;
-    sequence: number;
-    status: BackorderStatusEnum;
-    priority: BackorderPriorityEnum;
-    notes?: string;
-    expectedRestockDate?: Date;
-    fulfilledDate?: Date;
-    readonly number: string;
-    readonly quantityPending: number;
-}

package/dist/inventory/stock/backorder/backorder.validator.d.ts

@@ -1,24 +0,0 @@
-import { BackorderPriorityEnum, BackorderStatusEnum, StockBackorderEntity } from './';
-import { AbstractValidator, ReadValidator, SearchValidator } from '../../..';
-export declare class SearchBackorderValidator extends SearchValidator<StockBackorderEntity> {
-}
-export declare class ReadBackorderValidator extends ReadValidator<StockBackorderEntity> {
-}
-export declare class CreateBackorderValidator extends AbstractValidator {
-    product: string;
-    quantityOrdered: number;
-    customer?: string;
-    saleOrder?: string;
-    warehouse?: string;
-    priority?: BackorderPriorityEnum;
-    notes?: string;
-    expectedRestockDate?: string;
-}
-export declare class UpdateBackorderValidator extends AbstractValidator {
-    status?: BackorderStatusEnum;
-    priority?: BackorderPriorityEnum;
-    quantityFulfilled?: number;
-    notes?: string;
-    expectedRestockDate?: string;
-    fulfilledDate?: string;
-}

package/dist/inventory/stock/backorder/index.d.ts

@@ -1,2 +0,0 @@
-export * from './backorder.entity';
-export * from './backorder.validator';

package/dist/inventory/stock/backorder/index.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/logistic/carrier/carrier.entity.d.ts

@@ -1,10 +0,0 @@
-import { AbstractEntity } from '../..';
-export declare class LogisticCarrierEntity extends AbstractEntity {
-    name: string;
-    description: string;
-    website: string;
-    trackingUrl: string;
-    phone: string;
-    email: string;
-    active: boolean;
-}

package/dist/logistic/carrier/carrier.validator.d.ts

@@ -1,17 +0,0 @@
-import { LogisticCarrierEntity } from './';
-import { AbstractValidator, ReadValidator, SearchValidator } from '../..';
-export declare class SearchCarrierValidator extends SearchValidator<LogisticCarrierEntity> {
-}
-export declare class ReadCarrierValidator extends ReadValidator<LogisticCarrierEntity> {
-}
-export declare class CreateCarrierValidator extends AbstractValidator {
-    name: string;
-    description?: string;
-    website?: string;
-    trackingUrl?: string;
-    phone?: string;
-    email?: string;
-    active?: boolean;
-}
-export declare class UpdateCarrierValidator extends CreateCarrierValidator {
-}

package/dist/logistic/carrier/index.d.ts

@@ -1,2 +0,0 @@
-export * from './carrier.entity';
-export * from './carrier.validator';

package/dist/logistic/carrier/index.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/logistic/shipment/index.d.ts

@@ -1,3 +0,0 @@
-export * from './shipment.entity';
-export * from './shipment.validator';
-export * from './shipment.enum';

package/dist/logistic/shipment/index.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var shipment_enum_1 = require("./shipment.enum");
-Object.keys(shipment_enum_1).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  Object.defineProperty(exports, key, { enumerable: true, get: function () { return shipment_enum_1[key]; } });
-});

package/dist/logistic/shipment/shipment.entity.d.ts

@@ -1,19 +0,0 @@
-import { SaleTransactionEntity } from '../../order/sale/transaction';
-import { AbstractEntity } from '../..';
-import { CreateEntityArgs } from '../..';
-import { AddressEntity } from '../..';
-import { LogisticShippingTypeEnum } from './';
-import { LogisticShippingStatusEntity } from '../..';
-import type { MongoEntity } from '../..';
-export declare class LogisticShippingEntity extends AbstractEntity {
-    order: MongoEntity<SaleTransactionEntity>;
-    statuses: LogisticShippingStatusEntity[];
-    destinationAddress: CreateEntityArgs<AddressEntity>;
-    originAddress: AddressEntity;
-    cost: number;
-    distance: number;
-    type: LogisticShippingTypeEnum;
-    sequence: number;
-    readonly number: string;
-    readonly currentStatus: LogisticShippingStatusEntity;
-}

package/dist/logistic/shipment/shipment.enum.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogisticShippingTypeEnum = exports.LogisticShippingStatusEnum = void 0;
-var LogisticShippingStatusEnum;
-(function (LogisticShippingStatusEnum) {
-    LogisticShippingStatusEnum["OPEN"] = "OPEN";
-    LogisticShippingStatusEnum["NOT_REQUIRED"] = "NOT_REQUIRED";
-    LogisticShippingStatusEnum["PROCESSING"] = "PROCESSING";
-    LogisticShippingStatusEnum["SHIPPED"] = "SHIPPED";
-    LogisticShippingStatusEnum["IN_TRANSIT"] = "IN_TRANSIT";
-    LogisticShippingStatusEnum["DELIVERED"] = "DELIVERED";
-    LogisticShippingStatusEnum["FAILED"] = "FAILED";
-    LogisticShippingStatusEnum["RETURNED"] = "RETURNED";
-    LogisticShippingStatusEnum["CANCELLED"] = "CANCELLED";
-})(LogisticShippingStatusEnum || (exports.LogisticShippingStatusEnum = LogisticShippingStatusEnum = {}));
-var LogisticShippingTypeEnum;
-(function (LogisticShippingTypeEnum) {
-    LogisticShippingTypeEnum["PICKUP"] = "PICKUP";
-    LogisticShippingTypeEnum["DELIVERY"] = "DELIVERY";
-    LogisticShippingTypeEnum["DROPOFF"] = "DROPOFF";
-})(LogisticShippingTypeEnum || (exports.LogisticShippingTypeEnum = LogisticShippingTypeEnum = {}));
-//# sourceMappingURL=shipment.enum.js.map