@vita-mojo/types 0.0.2-rc.0

package/README.md

@@ -0,0 +1,11 @@
+# types
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test types` to execute the unit tests via [Jest](https://jestjs.io).
+
+## Running lint
+
+Run `nx lint types` to execute the lint via [ESLint](https://eslint.org/).

package/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@vita-mojo/types",
+  "version": "0.0.2-rc.0",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "dependencies": {},
+  "peerDependencies": {
+    "tslib": "2.4.1"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,7 @@
+export * as Order from './order';
+export { Permission } from './permission.interface';
+export { Profile } from './profile.interface';
+export { Role } from './role.interface';
+export { Tenant } from './tenant.interface';
+export { TokenDecrypted } from './token-decrypted.interface';
+export { User } from './user.interface';

package/src/index.js

@@ -0,0 +1,2 @@
+export * as Order from './order';
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/types/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC"}

package/src/order/accessory.d.ts

@@ -0,0 +1,6 @@
+export interface Accessory {
+    bundle: {
+        uuid: string;
+    };
+    name: string;
+}

package/src/order/accessory.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=accessory.js.map

package/src/order/accessory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessory.js","sourceRoot":"","sources":["../../../../../packages/types/src/order/accessory.ts"],"names":[],"mappings":""}

package/src/order/auth-user.d.ts

@@ -0,0 +1,15 @@
+export interface AuthUser {
+    uuid: string;
+    email: string;
+    tenantUUID: string;
+    storeUUID: string;
+    allowedStores: string[];
+    role: AuthUserRole;
+    roles?: AuthUserRole[];
+}
+export interface AuthUserRole {
+    uuid: string;
+    slug: string;
+    displayName: string;
+    description: string;
+}

package/src/order/auth-user.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=auth-user.js.map

package/src/order/auth-user.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-user.js","sourceRoot":"","sources":["../../../../../packages/types/src/order/auth-user.ts"],"names":[],"mappings":""}

package/src/order/brand.d.ts

@@ -0,0 +1,4 @@
+export interface Brand {
+    name: string;
+    uuid: string;
+}

package/src/order/brand.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=brand.js.map

package/src/order/brand.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"brand.js","sourceRoot":"","sources":["../../../../../packages/types/src/order/brand.ts"],"names":[],"mappings":""}

package/src/order/bundle.d.ts

@@ -0,0 +1,85 @@
+import { ItemType } from './item-type';
+import { Promotion } from './promotion';
+export interface AppStraightToPickup {
+    kiosk: boolean;
+    online: boolean;
+    pos: boolean;
+}
+export interface KitchenStation {
+    uuid: string;
+    extTenantUUID: string;
+    name: string;
+}
+export interface DefaultItemCustomization {
+    type: string;
+    uuid: string;
+    current: number | number[];
+}
+export interface DefaultItem {
+    itemUUID: string;
+    name: string;
+    customizations: DefaultItemCustomization[];
+}
+export interface Deal {
+    uuid: string;
+    dealCategoryUUID: string;
+    name: string;
+    basketUUID: string;
+    promotion: Promotion;
+}
+export interface Bundle {
+    uuid: string;
+    menuUUID: string;
+    isReorder: boolean;
+    basketUUID: string;
+    hasModifiers: string;
+    extMediaUUID: string;
+    name: string;
+    kitchenTicketName: string;
+    slug: string;
+    description: string;
+    dealCategoryOrder: number;
+    isGrouped: boolean;
+    isPrintable: boolean;
+    isAccessory: boolean;
+    straightToPickup: boolean;
+    appStraightToPickup: AppStraightToPickup;
+    type: number;
+    itemTypes: ItemType[];
+    price: number;
+    priceEatIn: number;
+    hasEatInPrice: boolean;
+    /**
+     * total price for bundle, calculated on frontend
+     * @example:
+     *  price 3
+     *  discount 0.5
+     *  finalPrice 2.5
+     * */
+    finalPrice: number;
+    subtotalAmountIncludingTax: number;
+    /**
+     * is Amount of bundle with discount and with applied VAT
+     */
+    totalAmount: number;
+    subtotalAmount: number;
+    vatAmount: number;
+    discount: number;
+    taxExempt: number;
+    vatRateEatIn: number;
+    vatRateTakeaway: number;
+    rootCategory: object;
+    category: object;
+    note: string;
+    defaultItems: DefaultItem[];
+    promotion: Promotion;
+    meta: object;
+    baseTotalAmount: number;
+    baseVatAmount: number;
+    deal: Deal;
+    kitchenStation: KitchenStation;
+    status?: string;
+    allergens: string[];
+    isRecommendation: boolean;
+    parentID?: string;
+}

package/src/order/bundle.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=bundle.js.map

package/src/order/bundle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bundle.js","sourceRoot":"","sources":["../../../../../packages/types/src/order/bundle.ts"],"names":[],"mappings":""}

package/src/order/device.d.ts

@@ -0,0 +1,7 @@
+export interface Device {
+    deviceType: string;
+    appVersion: string;
+    productVersion: string;
+    platform: string;
+    deviceOS: string;
+}

package/src/order/device.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=device.js.map

package/src/order/device.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device.js","sourceRoot":"","sources":["../../../../../packages/types/src/order/device.ts"],"names":[],"mappings":""}

package/src/order/index.d.ts

@@ -0,0 +1,6 @@
+export * as Bundle from './bundle';
+export * as Item from './item';
+export { ItemType } from './item-type';
+export { Order } from './order';
+export * as Payment from './payment';
+export * as User from './user';

package/src/order/index.js

@@ -0,0 +1,5 @@
+export * as Bundle from './bundle';
+export * as Item from './item';
+export * as Payment from './payment';
+export * as User from './user';
+//# sourceMappingURL=index.js.map

package/src/order/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/types/src/order/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAG/B,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC"}

package/src/order/item-type.d.ts

@@ -0,0 +1,11 @@
+import { Item } from './item';
+export interface ItemType {
+    uuid: string;
+    isDefault: boolean;
+    minRestriction: number;
+    maxRestriction: number;
+    name: string;
+    ticketGroup: string;
+    type: string;
+    items: Item[];
+}

package/src/order/item-type.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=item-type.js.map

package/src/order/item-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"item-type.js","sourceRoot":"","sources":["../../../../../packages/types/src/order/item-type.ts"],"names":[],"mappings":""}

package/src/order/item.d.ts

@@ -0,0 +1,78 @@
+import { Promotion } from './promotion';
+export interface AppStraightToPickup {
+    kiosk: boolean;
+    online: boolean;
+    pos: boolean;
+}
+export interface Unit {
+    slug: string;
+    name: any;
+    value: any;
+}
+export interface Variation {
+    name: string;
+    unit: Unit;
+    price: number;
+    priceEatIn: number;
+    hasEatInPrice: boolean;
+    step: number;
+    type: string;
+    uuid: string;
+    parentUUID: string;
+    value: any;
+    printText: string;
+    standalonePrice: string;
+    unitsNumber: number;
+}
+export interface Customization {
+    uuid: string;
+    current: number | number[];
+    text: string;
+    type: string;
+    variations: Variation[];
+    meta: any;
+}
+export interface KitchenZone {
+    uuid: string;
+    name: string;
+    slug: string;
+    sortOrderOnPrint: number;
+    capacity: number;
+}
+export interface Item {
+    name: string;
+    uuid: string;
+    kitchenTicketName: string;
+    kitchenZone: KitchenZone;
+    itemUUID: string;
+    straightToPickup: boolean;
+    price: number;
+    priceEatIn: number;
+    hasEatInPrice: boolean;
+    appStraightToPickup: AppStraightToPickup;
+    /**
+     * total price for item, calculated on frontend
+     * @example:
+     *  price 3
+     *  discount 0.5
+     *  finalPrice 2.5
+     * */
+    finalPrice: number;
+    /**
+     * is Amount of item with discount and with applied VAT
+     */
+    totalAmount: number;
+    subtotalAmount: number;
+    customizations: Customization[];
+    vatAmount: number;
+    discount: number;
+    taxExempt: number;
+    vatRateEatIn: number;
+    vatRateTakeaway: number;
+    promotion: Promotion;
+    type: string;
+    dealPriceOverrideDiff?: {
+        priceEatIn: number;
+        price: number;
+    };
+}

package/src/order/item.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=item.js.map

package/src/order/item.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"item.js","sourceRoot":"","sources":["../../../../../packages/types/src/order/item.ts"],"names":[],"mappings":""}

package/src/order/order-store-settings.d.ts

@@ -0,0 +1,4 @@
+export interface OrderStoreSettings {
+    isStraightToProductionFlowEnabled: boolean;
+    isPaidOrdersStraightToProduction: boolean;
+}

package/src/order/order-store-settings.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=order-store-settings.js.map

package/src/order/order-store-settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order-store-settings.js","sourceRoot":"","sources":["../../../../../packages/types/src/order/order-store-settings.ts"],"names":[],"mappings":""}

package/src/order/order.d.ts

@@ -0,0 +1,49 @@
+import { Accessory } from './accessory';
+import { AuthUser } from './auth-user';
+import { Brand } from './brand';
+import { Bundle } from './bundle';
+import { Device } from './device';
+import { OrderStoreSettings } from './order-store-settings';
+import { Payment } from './payment';
+import { Promotion } from './promotion';
+import { Timeslot } from './timeslot';
+import { User } from './user';
+export interface Order {
+    uuid: string;
+    timezone: string;
+    requestedFrom: string;
+    pickupTime?: number;
+    user: User;
+    serialNumber: string;
+    isAsap: boolean;
+    sortOrder: number;
+    createdAt: number | string;
+    updatedAt: number | string;
+    bundles: Bundle[];
+    status: string;
+    statusChanged?: {
+        [status: string]: number;
+    };
+    table?: string | number;
+    extTenantUUID: string;
+    extStoreUUID?: string;
+    storeUUID: string;
+    extUserUUID?: string;
+    timeSlot?: Timeslot;
+    payment: Payment;
+    isPaidOrderStraightToProduction?: boolean;
+    storeSettings?: OrderStoreSettings;
+    takeaway?: boolean;
+    transitionAlias?: string;
+    basketUUIDs?: string[];
+    source?: string;
+    isOpat: boolean;
+    isDelivery: boolean;
+    canceledBy?: AuthUser;
+    accessories?: Accessory[];
+    bundlesBatchEvents?: string[];
+    promotions?: Promotion;
+    note?: string;
+    brand?: Brand;
+    device: Device;
+}

package/src/order/order.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=order.js.map

package/src/order/order.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order.js","sourceRoot":"","sources":["../../../../../packages/types/src/order/order.ts"],"names":[],"mappings":""}

package/src/order/payment.d.ts

@@ -0,0 +1,33 @@
+export interface Payment {
+    totalAmount: number;
+    subtotalAmount: number;
+    vatAmount?: number;
+    price: number;
+    discount?: number;
+    provider?: string;
+    currency?: string;
+    status?: string;
+    meta?: string;
+    name?: string;
+    type?: string;
+    refundSumUp?: number;
+    salesTaxRate?: number;
+    serviceCharge?: number;
+    serviceChargePercentage?: number;
+    deliveryFee: number;
+    transactions?: Transaction[];
+}
+export interface Transaction {
+    uuid: string;
+    status: string;
+    type: string;
+    amount: number;
+    provider: {
+        slug: string;
+        name: string;
+        type: string;
+    };
+    isGiftCard: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+}

package/src/order/payment.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=payment.js.map

package/src/order/payment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment.js","sourceRoot":"","sources":["../../../../../packages/types/src/order/payment.ts"],"names":[],"mappings":""}

package/src/order/promotion.d.ts

@@ -0,0 +1,25 @@
+export interface PromoCodeDto {
+    code: string;
+    phoneNumber?: string;
+    secureCode?: string;
+    bindAccount?: boolean;
+}
+export interface Promotion {
+    uuid: string;
+    type: string;
+    value: number;
+    name: string;
+    appliesTo: string;
+    promoCode: PromoCodeDto;
+    loyaltyPoints: number;
+    maxAmount: number;
+    minBasket: number;
+    providerPromotion: PromotionProviderDetails;
+    provider: string;
+    freeDelivery: boolean;
+}
+export interface PromotionProviderDetails {
+    type: string;
+    expirationDate: string;
+    count: number;
+}

package/src/order/promotion.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=promotion.js.map

package/src/order/promotion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promotion.js","sourceRoot":"","sources":["../../../../../packages/types/src/order/promotion.ts"],"names":[],"mappings":""}

package/src/order/timeslot.d.ts

@@ -0,0 +1,5 @@
+export interface Timeslot {
+    uuid: string;
+    slot: string;
+    windowLength?: number;
+}

package/src/order/timeslot.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=timeslot.js.map

package/src/order/timeslot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeslot.js","sourceRoot":"","sources":["../../../../../packages/types/src/order/timeslot.ts"],"names":[],"mappings":""}

package/src/order/user.d.ts

@@ -0,0 +1,20 @@
+export interface UserAddress {
+    address1: string;
+    address2: null;
+    county: null;
+    distance: number;
+    instructions: string;
+    phoneNumber: string;
+    postCode: string;
+    town: string;
+}
+export interface User {
+    extUserUUID: string;
+    email: string;
+    isGuest: boolean;
+    name: string;
+    originalName: string;
+    address?: UserAddress;
+    acteolMemberNumber?: number;
+    acteolCtcId?: number;
+}

package/src/order/user.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=user.js.map

package/src/order/user.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../../../../packages/types/src/order/user.ts"],"names":[],"mappings":""}

package/src/permission.interface.d.ts

@@ -0,0 +1,5 @@
+export interface Permission {
+    uuid: string;
+    name: string;
+    description: string;
+}

package/src/permission.interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=permission.interface.js.map

package/src/permission.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permission.interface.js","sourceRoot":"","sources":["../../../../packages/types/src/permission.interface.ts"],"names":[],"mappings":""}

package/src/profile.interface.d.ts

@@ -0,0 +1,3 @@
+export interface Profile {
+    firstName: string;
+}

package/src/profile.interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=profile.interface.js.map

package/src/profile.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"profile.interface.js","sourceRoot":"","sources":["../../../../packages/types/src/profile.interface.ts"],"names":[],"mappings":""}

package/src/role.interface.d.ts

@@ -0,0 +1,8 @@
+export interface Role {
+    uuid: string;
+    rank: number;
+    slug: string;
+    displayName: string;
+    description: string;
+    permissions: string[];
+}

package/src/role.interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=role.interface.js.map

package/src/role.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"role.interface.js","sourceRoot":"","sources":["../../../../packages/types/src/role.interface.ts"],"names":[],"mappings":""}

package/src/tenant.interface.d.ts

@@ -0,0 +1,6 @@
+export interface Tenant {
+    uuid: string;
+    name: string;
+    alias: string;
+    description: string;
+}

package/src/tenant.interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=tenant.interface.js.map

package/src/tenant.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenant.interface.js","sourceRoot":"","sources":["../../../../packages/types/src/tenant.interface.ts"],"names":[],"mappings":""}

package/src/token-decrypted.interface.d.ts

@@ -0,0 +1,24 @@
+import { Profile } from './profile.interface';
+import { Role } from './role.interface';
+export interface TokenDecrypted {
+    user: {
+        uuid: string;
+        tenantUUID: string;
+        storeUUID: string;
+        email: string;
+        active: boolean;
+        hasLinkedComoAccount: boolean;
+        forgottenToken: string;
+        createdAt: string;
+        updatedAt: string;
+        role: Role;
+        profile: Profile;
+        allowedStores?: string[];
+        integrations?: {
+            comoID: string;
+        };
+        locale: string;
+    };
+    iat: number;
+    exp: number;
+}

package/src/token-decrypted.interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=token-decrypted.interface.js.map

package/src/token-decrypted.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token-decrypted.interface.js","sourceRoot":"","sources":["../../../../packages/types/src/token-decrypted.interface.ts"],"names":[],"mappings":""}

package/src/user.interface.d.ts

@@ -0,0 +1,18 @@
+import { Profile } from './profile.interface';
+import { Role } from './role.interface';
+export interface User {
+    uuid: string;
+    tenantUUID: string;
+    storeUUID: string;
+    email: string;
+    active: boolean;
+    forgottenToken: string;
+    createdAt: string;
+    updatedAt: string;
+    role: Role;
+    profile: Profile;
+    allowedStores?: string[];
+    integrations?: {
+        comoID: string;
+    };
+}

package/src/user.interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=user.interface.js.map

package/src/user.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.interface.js","sourceRoot":"","sources":["../../../../packages/types/src/user.interface.ts"],"names":[],"mappings":""}