@feedmepos/mf-order-setting 0.0.84 → 0.0.85

package/src/modules/order-setting/kiosk/interface.ts

@@ -1,127 +1,138 @@
-import { FdoEPaymentMethod, F_ORDER_PAYMENT_TYPE } from "@entity";
-import { FdoOfflinePaymentMethod } from '@feedmepos/core/entity';
-
-export interface MfKioskSubmitOrderInstruction {
-    payAtCounter: string | null,
-    paid: string | null,
-}
-
-export type KioskSubmitOrderInstructionForm = MfKioskSubmitOrderInstruction;
-
-export interface MfDisplayStandSetting {
-    enabled: boolean,
-    standSlotRange: {
-        min: number,
-        max: number,
-    },
-    prefix: string | null,
-    padDigit: number,
-    enablePaxDialog: boolean,
-    submitOrderInstruction: MfKioskSubmitOrderInstruction,
-}
-
-export interface DisplayStandSettingForm {
-    enabled: boolean,
-    standSlotRange: {
-        min: number | null,
-        max: number | null
-    },
-    prefix: string | null,
-    padDigit: number | null,
-    enablePaxDialog: boolean,
-    submitOrderInstruction: KioskSubmitOrderInstructionForm,
-}
-
-export interface MfKioskPickAtCounterSetting {
-    enabled: boolean,
-    enablePaxDialog: boolean,
-    submitOrderInstruction: MfKioskSubmitOrderInstruction,
-}
-
-export interface PickAtCounterSettingForm {
-    enabled: boolean,
-    enablePaxDialog: boolean,
-    submitOrderInstruction: KioskSubmitOrderInstructionForm,
-}
-
-export interface MfKioskSequenceNumberSetting {
-    prefix: string,
-    current: number,
-}
-
-export interface MfKioskDineInSetting {
-    enabled: boolean,
-    sequenceNumber: MfKioskSequenceNumberSetting,
-    displayStand: MfDisplayStandSetting,
-    pickUp: MfKioskPickAtCounterSetting,
-}
-
-export interface MfKioskTakeawaySetting {
-    enabled: boolean,
-    submitOrderInstruction: MfKioskSubmitOrderInstruction,
-}
-
-export interface MfKioskPaymentSetting {
-    paymentTypes: MfKioskPaymentTypes,
-    offlinePaymentTypes: FdoOfflinePaymentMethod[],
-    ePaymentTypes: FdoEPaymentMethod
-}
-
-export type MfKioskPaymentTypes = F_ORDER_PAYMENT_TYPE[];
-
-export type KioskTakeawaySettingForm = MfKioskTakeawaySetting;
-
-export type KioskPaymentTypesForm = MfKioskPaymentTypes;
-
-export type KioskPaymentSettingForm = MfKioskPaymentSetting;
-
-export interface MfKioskOrderSetting {
-    dineIn: MfKioskDineInSetting,
-    takeaway: MfKioskTakeawaySetting,
-    paymentSetting: MfKioskPaymentSetting,
-    menuItem: MfKioskOrderSettingMenuItemForm,
-    coverImageLandscape: string | null,
-    coverImagePortrait: string | null,
-    otaChannel?: string | null,
-    // null = merchant never chose; the backend then keeps inheriting
-    // dineInSettings. Must stay nullable end-to-end or saving any unrelated
-    // kiosk field would persist `false` and silently kill inheritance.
-    autoCloseBill: boolean | null,
-    printReceiptAfterClose: boolean | null,
-    // Locales the kiosk may offer the customer. null or [] = no restriction,
-    // i.e. the kiosk shows every language it ships. Anything else is the exact
-    // allowed set.
-    languages: string[] | null,
-}
-
-export interface MfKioskOrderSettingMenuItemForm {
-    showAllOnly: boolean,
-}
-
-export interface MfKioskOrderSettingForm {
-    dineIn: KioskDineInSettingForm,
-    takeaway: KioskTakeawaySettingForm,
-    paymentSetting: KioskPaymentSettingForm,
-    menuItem: KioskMenuItemSettingForm,
-    coverImageLandscape: string | null,
-    coverImagePortrait: string | null,
-    otaChannel?: string | null,
-    // null = merchant never chose; the backend then keeps inheriting
-    // dineInSettings. Must stay nullable end-to-end or saving any unrelated
-    // kiosk field would persist `false` and silently kill inheritance.
-    autoCloseBill: boolean | null,
-    printReceiptAfterClose: boolean | null,
-    // Locales the kiosk may offer the customer. null or [] = no restriction,
-    // i.e. the kiosk shows every language it ships. Anything else is the exact
-    // allowed set.
-    languages: string[] | null,
-}
-
-export type KioskPickAtCounterSettingForm = MfKioskPickAtCounterSetting;
-export type KioskMenuItemSettingForm = MfKioskOrderSettingMenuItemForm;
-export interface KioskDineInSettingForm {
-    enabled: boolean,
-    sequenceNumber: MfKioskSequenceNumberSetting,
-    displayStand: DisplayStandSettingForm,
-    pickUp: KioskPickAtCounterSettingForm,
-}
+import { FdoEPaymentMethod, F_ORDER_PAYMENT_TYPE, type OrderKioskSettings } from "@entity";
+import { FdoOfflinePaymentMethod } from '@feedmepos/core/entity';
+
+export interface MfKioskSubmitOrderInstruction {
+    payAtCounter: string | null,
+    paid: string | null,
+}
+
+export type KioskSubmitOrderInstructionForm = MfKioskSubmitOrderInstruction;
+
+export interface MfDisplayStandSetting {
+    enabled: boolean,
+    standSlotRange: {
+        min: number,
+        max: number,
+    },
+    prefix: string | null,
+    padDigit: number,
+    enablePaxDialog: boolean,
+    submitOrderInstruction: MfKioskSubmitOrderInstruction,
+}
+
+export interface DisplayStandSettingForm {
+    enabled: boolean,
+    standSlotRange: {
+        min: number | null,
+        max: number | null
+    },
+    prefix: string | null,
+    padDigit: number | null,
+    enablePaxDialog: boolean,
+    submitOrderInstruction: KioskSubmitOrderInstructionForm,
+}
+
+export interface MfKioskPickAtCounterSetting {
+    enabled: boolean,
+    enablePaxDialog: boolean,
+    submitOrderInstruction: MfKioskSubmitOrderInstruction,
+}
+
+export interface PickAtCounterSettingForm {
+    enabled: boolean,
+    enablePaxDialog: boolean,
+    submitOrderInstruction: KioskSubmitOrderInstructionForm,
+}
+
+export interface MfKioskSequenceNumberSetting {
+    prefix: string,
+    current: number,
+}
+
+export interface MfKioskDineInSetting {
+    enabled: boolean,
+    sequenceNumber: MfKioskSequenceNumberSetting,
+    displayStand: MfDisplayStandSetting,
+    pickUp: MfKioskPickAtCounterSetting,
+}
+
+export interface MfKioskTakeawaySetting {
+    enabled: boolean,
+    submitOrderInstruction: MfKioskSubmitOrderInstruction,
+}
+
+export interface MfKioskPaymentSetting {
+    paymentTypes: MfKioskPaymentTypes,
+    offlinePaymentTypes: FdoOfflinePaymentMethod[],
+    ePaymentTypes: FdoEPaymentMethod
+}
+
+export type MfKioskPaymentTypes = F_ORDER_PAYMENT_TYPE[];
+
+export type KioskTakeawaySettingForm = MfKioskTakeawaySetting;
+
+export type KioskPaymentTypesForm = MfKioskPaymentTypes;
+
+export type KioskPaymentSettingForm = MfKioskPaymentSetting;
+
+export interface MfKioskOrderSetting {
+    dineIn: MfKioskDineInSetting,
+    takeaway: MfKioskTakeawaySetting,
+    paymentSetting: MfKioskPaymentSetting,
+    menuItem: MfKioskOrderSettingMenuItemForm,
+    coverImageLandscape: string | null,
+    coverImagePortrait: string | null,
+    // Multi-image landing background. Edited by the cover-image section of
+    // KioskSettingView; it must also stay listed here because the backend
+    // $sets kioskSettings as a whole subdocument, so any field the mapper does
+    // not rebuild is deleted on the next save of an unrelated kiosk field.
+    coverCarousel?: OrderKioskSettings['coverCarousel'],
+    otaChannel?: string | null,
+    // null = merchant never chose; the backend then keeps inheriting
+    // dineInSettings. Must stay nullable end-to-end or saving any unrelated
+    // kiosk field would persist `false` and silently kill inheritance.
+    autoSendKitchen: boolean | null,
+    autoCloseBill: boolean | null,
+    printReceiptAfterClose: boolean | null,
+    // Locales the kiosk may offer the customer. null or [] = no restriction,
+    // i.e. the kiosk shows every language it ships. Anything else is the exact
+    // allowed set.
+    languages: string[] | null,
+}
+
+export interface MfKioskOrderSettingMenuItemForm {
+    showAllOnly: boolean,
+}
+
+export interface MfKioskOrderSettingForm {
+    dineIn: KioskDineInSettingForm,
+    takeaway: KioskTakeawaySettingForm,
+    paymentSetting: KioskPaymentSettingForm,
+    menuItem: KioskMenuItemSettingForm,
+    coverImageLandscape: string | null,
+    coverImagePortrait: string | null,
+    // Multi-image landing background, edited together with the two single
+    // fields above — the form shows ONE list per orientation and
+    // modules/order-setting/kiosk/coverCarousel.ts maps it onto both fields.
+    coverCarousel?: OrderKioskSettings['coverCarousel'],
+    otaChannel?: string | null,
+    // null = merchant never chose; the backend then keeps inheriting
+    // dineInSettings. Must stay nullable end-to-end or saving any unrelated
+    // kiosk field would persist `false` and silently kill inheritance.
+    autoSendKitchen: boolean | null,
+    autoCloseBill: boolean | null,
+    printReceiptAfterClose: boolean | null,
+    // Locales the kiosk may offer the customer. null or [] = no restriction,
+    // i.e. the kiosk shows every language it ships. Anything else is the exact
+    // allowed set.
+    languages: string[] | null,
+}
+
+export type KioskPickAtCounterSettingForm = MfKioskPickAtCounterSetting;
+export type KioskMenuItemSettingForm = MfKioskOrderSettingMenuItemForm;
+export interface KioskDineInSettingForm {
+    enabled: boolean,
+    sequenceNumber: MfKioskSequenceNumberSetting,
+    displayStand: DisplayStandSettingForm,
+    pickUp: KioskPickAtCounterSettingForm,
+}

package/src/stores/order-setting/mapper.spec.ts

@@ -42,3 +42,29 @@ describe('kiosk languages round-trip', () => {
     ])
   })
 })
+
+describe('kiosk cover carousel round-trip', () => {
+  const carousel = { landscape: ['l1.jpg', 'l2.jpg'], portrait: ['p1.jpg'], intervalMs: 9000 }
+
+  it('reads a stored carousel back onto the form', () => {
+    expect(toKioskForm({ coverCarousel: carousel }).coverCarousel).toEqual(carousel)
+  })
+
+  it('reads an unset carousel as undefined', () => {
+    expect(toKioskForm({}).coverCarousel).toBeUndefined()
+  })
+
+  // The regression this guards: the write side rebuilds kioskSettings field by
+  // field and the backend $sets the whole subdocument, so a field the mapper
+  // forgets is DELETED the next time the merchant saves some unrelated kiosk
+  // setting. Same class of bug as the language/queue-segment guards above.
+  it('survives a save of an unrelated kiosk field', () => {
+    const form = { ...defaultKioskOrderSetting, coverCarousel: carousel, otaChannel: 'beta' }
+    expect(saved(form).coverCarousel).toEqual(carousel)
+  })
+
+  it('writes null through, so clearing the last extra image really removes it', () => {
+    const form = { ...defaultKioskOrderSetting, coverCarousel: null }
+    expect(saved(form).coverCarousel).toBeNull()
+  })
+})