@final-commerce/command-frame 0.15.0-staging.1 → 0.15.0-staging.2

package/dist/CommonTypes.d.ts

@@ -1,5 +1,5 @@
 export * from './common-types';
-import type { Tax, Tip, Address, MetadataItem, OrderAssignedUser, OrderInCart, OrderCustomStatus, PosDataItem, CartFeeTaxEntry, CartFeeItem, CartDiscountItem, OrderNote, NonRevenueItem, DiscountDetail, FeeDetail, DiscountLineItem, FeeLineItem, LineItem, TipPayment, RefundedTipPayment, PaymentMethod, Discount, CustomFee, Summary, CustomSale, RefundedCustomSale, RefundItem, RefundedLineItem, ActiveStation, ActiveSession, ActiveOutlet, ActiveUser, ActiveUserRole, ActiveOrder, ActiveCart, ActivePark, ActiveCompany, ActiveCustomSales, ActiveProduct, ActiveCustomer, FullProduct, ProductVariant, Inventory, ResolvedModifier, ResolvedModifierChoice, ModifierSelectionType, ModifierSelection, ModifierChoiceSelection, CartLineModifier, ProdModifierBreakdown, OrderLineItemModifier, CustomerNote, Attribute, AttributeOption, Category, Transaction, ActiveSplitPayment, BookingAvailability, BookingSlot, BookingSlotResource, BookingResource, Booking, CartReservation, OrderReservation, CartAddress, CartShipping, Composite, CompositePart, CompositeItem, CompositeChoice, CompositeItemUnavailable, CompositePick, CartLineComponent, OrderLineItemComponent } from '@final-commerce/common/pos-types';
+import type { Tax, Tip, Address, MetadataItem, OrderAssignedUser, OrderInCart, OrderCustomStatus, PosDataItem, CartFeeTaxEntry, CartFeeItem, CartDiscountItem, OrderNote, NonRevenueItem, DiscountDetail, FeeDetail, DiscountLineItem, FeeLineItem, LineItem, TipPayment, RefundedTipPayment, PaymentMethod, Discount, CustomFee, Summary, CustomSale, RefundedCustomSale, RefundItem, RefundedLineItem, ActiveStation, ActiveSession, ActiveOutlet, ActiveUser, ActiveUserRole, ActiveOrder, ActiveCart, ActivePark, ActiveCompany, ActiveCustomSales, ActiveProduct, ActiveCustomer, FullProduct, ProductVariant, Inventory, ResolvedModifier, ResolvedModifierChoice, ModifierSelectionType, ModifierSelection, ModifierChoiceSelection, CartLineModifier, ProdModifierBreakdown, OrderLineItemModifier, CustomerNote, Attribute, AttributeOption, Category, Transaction, ActiveSplitPayment, BookingAvailability, BookingSlot, BookingSlotResource, BookingResource, Booking, BookingRentalEnd, CartReservation, OrderReservation, CartAddress, CartShipping, Composite, CompositePart, CompositeItem, CompositeChoice, CompositeItemUnavailable, CompositePick, CartLineComponent, OrderLineItemComponent } from '@final-commerce/common/pos-types';
 export { CurrencyCode, ProductType as CFProductType, UserTypes as CFUserTypes } from '@final-commerce/common';
 /** Open record used as a base for active entities. */
 export type CFActiveEntity = Record<string, unknown>;
@@ -59,6 +59,7 @@ export type CFBookingSlot = BookingSlot;
 export type CFBookingSlotResource = BookingSlotResource;
 export type CFBookingResource = BookingResource;
 export type CFBooking = Booking;
+export type CFBookingRentalEnd = BookingRentalEnd;
 /** A service sitting in the cart, and the same sale once it is on an order. A flow that draws a
  *  cart or a receipt needs both by name — reaching into the package's dist for them is not an
  *  interface. */

package/dist/actions/get-booking-rental-ends/action.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get booking rental ends action
+ * Calls the getBookingRentalEnds action on the parent window
+ */
+import type { GetBookingRentalEnds } from './types';
+export declare const getBookingRentalEnds: GetBookingRentalEnds;

package/dist/actions/get-booking-rental-ends/action.js

@@ -0,0 +1,8 @@
+/**
+ * Get booking rental ends action
+ * Calls the getBookingRentalEnds action on the parent window
+ */
+import { commandFrameClient } from '../../client';
+export const getBookingRentalEnds = async (params) => {
+    return await commandFrameClient.call('getBookingRentalEnds', params);
+};

package/dist/actions/get-booking-rental-ends/mock.d.ts

@@ -0,0 +1,2 @@
+import { GetBookingRentalEnds } from './types';
+export declare const mockGetBookingRentalEnds: GetBookingRentalEnds;

package/dist/actions/get-booking-rental-ends/mock.js

@@ -0,0 +1,6 @@
+import { MOCK_ONLY_SINGLE_SLOTS } from '../hold-booking/mock';
+// The mock shop has no date-range rules, so no stay can start in it — the same refusal `holdBooking` gives a stay.
+export const mockGetBookingRentalEnds = async (params) => {
+    console.log('[Mock] getBookingRentalEnds called', params);
+    return { success: false, reason: MOCK_ONLY_SINGLE_SLOTS, timestamp: new Date().toISOString() };
+};

package/dist/actions/get-booking-rental-ends/types.d.ts

@@ -0,0 +1,31 @@
+import { CFBookingRentalEnd } from '../../CommonTypes';
+export interface GetBookingRentalEndsParams {
+    /** The bookable product. Date-range rules only (hours, nights, days, weeks, months). */
+    productId: string;
+    /** The chosen check-in: the `startAt` of a slot `getBookingAvailability` offered, ISO 8601. */
+    startAt: string;
+    /**
+     * Last shop day an end may fall on, `YYYY-MM-DD` (the format of `getBookingAvailability`'s `fromDay`). Ends past it are
+     * not computed. Leave one page more than you show — a check-in on the last day, a whole week or month — and never a day
+     * before the chosen check-out; ask again with a later day when the cashier pages or steps past it. The shortest allowed
+     * stay comes even when it ends past it — alone — so a `minStay` longer than what you show still books.
+     */
+    untilDay: string;
+    /** The resource that must serve the whole stay. Omit for "any free one", picked per end exactly as the hold picks it. */
+    resourceId?: string;
+    /** Places the booking takes, as you will pass to `addBookingToCart`. Default 1. */
+    qty?: number;
+}
+export interface GetBookingRentalEndsResponse {
+    /** False when no stay can start here — a taken first night, a `minStay` the free nights do not reach, a non-range rule. */
+    success: boolean;
+    /** Why, in the host's own words. Absent on success. */
+    reason?: string;
+    /**
+     * Every end the stay may have now, ascending, never empty on success. Enable only these as check-out; highlight the
+     * chosen one's `coveredSlots`; send its `endAt` to `addBookingToCart`.
+     */
+    ends?: CFBookingRentalEnd[];
+    timestamp: string;
+}
+export type GetBookingRentalEnds = (params: GetBookingRentalEndsParams) => Promise<GetBookingRentalEndsResponse>;

package/dist/actions/get-booking-rental-ends/types.js

@@ -0,0 +1 @@
+export {};

package/dist/actions/hold-booking/mock.d.ts

@@ -1,2 +1,3 @@
 import { HoldBooking } from './types';
+export declare const MOCK_ONLY_SINGLE_SLOTS = "[Mock] the mock shop sells single 30-minute slots \u2014 pass the slot's endAt";
 export declare const mockHoldBooking: HoldBooking;

package/dist/actions/hold-booking/mock.js

@@ -3,7 +3,7 @@ import { ReservationStatus, pickFreeResource } from '@final-commerce/common';
 const BUFFER_MINUTES = 5;
 const HOLD_MINUTES = 10;
 const TAKEN = 'That window has just been taken — pick another slot.';
-const MOCK_ONLY_SINGLE_SLOTS = "[Mock] the mock shop sells single 30-minute slots — pass the slot's endAt";
+export const MOCK_ONLY_SINGLE_SLOTS = "[Mock] the mock shop sells single 30-minute slots — pass the slot's endAt";
 let held = 0;
 const refused = (reason) => ({
     success: false,

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export declare const command: {
     readonly getProducts: import(".").GetProducts;
     readonly getBookingResources: import(".").GetBookingResources;
     readonly getBookingAvailability: import(".").GetBookingAvailability;
+    readonly getBookingRentalEnds: import(".").GetBookingRentalEnds;
     readonly getBookings: import(".").GetBookings;
     readonly holdBooking: import(".").HoldBooking;
     readonly addBookingToCart: import(".").AddBookingToCart;
@@ -155,6 +156,7 @@ export type { GenerateAPIKey, GenerateAPIKeyParams, GenerateAPIKeyResponse } fro
 export type { GetProducts, GetProductsParams, GetProductsResponse } from './actions/get-products/types';
 export type { GetBookingResources, GetBookingResourcesParams, GetBookingResourcesResponse, } from './actions/get-booking-resources/types';
 export type { GetBookingAvailability, GetBookingAvailabilityParams, GetBookingAvailabilityResponse, } from './actions/get-booking-availability/types';
+export type { GetBookingRentalEnds, GetBookingRentalEndsParams, GetBookingRentalEndsResponse, } from './actions/get-booking-rental-ends/types';
 export type { GetBookings, GetBookingsParams, GetBookingsResponse } from './actions/get-bookings/types';
 export type { HoldBooking, HoldBookingParams, HoldBookingResponse } from './actions/hold-booking/types';
 export type { AddBookingToCart, AddBookingToCartParams, AddBookingToCartResponse, } from './actions/add-booking-to-cart/types';

package/dist/index.js

@@ -3,6 +3,7 @@ import { exampleFunction } from './actions/example-function/action';
 import { getProducts } from './actions/get-products/action';
 import { getBookingResources } from './actions/get-booking-resources/action';
 import { getBookingAvailability } from './actions/get-booking-availability/action';
+import { getBookingRentalEnds } from './actions/get-booking-rental-ends/action';
 import { getBookings } from './actions/get-bookings/action';
 import { holdBooking } from './actions/hold-booking/action';
 import { addBookingToCart } from './actions/add-booking-to-cart/action';
@@ -173,6 +174,7 @@ export const command = {
     getProducts,
     getBookingResources,
     getBookingAvailability,
+    getBookingRentalEnds,
     getBookings,
     holdBooking,
     addBookingToCart,

package/dist/projects/render/mocks.js

@@ -64,6 +64,7 @@ import { mockGetOrders } from '../../actions/get-orders/mock';
 import { mockGetProducts } from '../../actions/get-products/mock';
 import { mockGetBookingResources } from '../../actions/get-booking-resources/mock';
 import { mockGetBookingAvailability } from '../../actions/get-booking-availability/mock';
+import { mockGetBookingRentalEnds } from '../../actions/get-booking-rental-ends/mock';
 import { mockGetBookings } from '../../actions/get-bookings/mock';
 import { mockHoldBooking } from '../../actions/hold-booking/mock';
 import { mockAddBookingToCart } from '../../actions/add-booking-to-cart/mock';
@@ -195,6 +196,7 @@ export const RENDER_MOCKS = {
     getProducts: mockGetProducts,
     getBookingResources: mockGetBookingResources,
     getBookingAvailability: mockGetBookingAvailability,
+    getBookingRentalEnds: mockGetBookingRentalEnds,
     getBookings: mockGetBookings,
     holdBooking: mockHoldBooking,
     addBookingToCart: mockAddBookingToCart,

package/dist/projects/render/types.d.ts

@@ -1,9 +1,10 @@
-import type { ExampleFunction, GetProducts, AddCustomSale, EditCustomSale, GetCustomers, AssignCustomer, AddCustomer, EditCustomer, GetCategories, GetOrders, GetRefunds, GetTaxTables, GetCustomStockActions, AddProductDiscount, AddProductToCart, RemoveProductFromCart, UpdateCartItemQuantity, AddCartDiscount, GetContext, GetFinalContext, AddProductNote, AddProductFee, GetProductModifierSelections, GetCompositePrice, GetCompositeAvailability, SetProductModifierSelections, SetActiveProductFee, SetActiveProductDiscount, GetActiveProduct, SetActiveProduct, AdjustInventory, SetVariantUnavailable, AddOrderNote, AddCartFee, ClearCart, ParkOrder, ResumeParkedOrder, ResumeOrder, SetOrderMetadata, AssignOrderUser, ReleaseFromCart, SetOrderType, SetScheduledFor, SetOrderStatus, GetOrderStatuses, DeleteParkedOrder, VoidOrder, InitiateRefund, CashPayment, RecordExternalPayment, GetCashRoundingAmount, GetCashChange, GetOrdersSummary, TapToPayPayment, TerminalPayment, ExtensionPayment, RedeemPayment, AddNonRevenueItem, AddCustomerNote, RemoveCustomerNote, RemoveCustomerFromCart, GoToStationHome, OpenCashDrawer, ShowNotification, ShowConfirmation, AuthenticateUser, PartialPayment, SwitchUser, SetRefundStockAction, SelectAllRefundItems, ResetRefundDetails, CalculateRefundTotal, GetRemainingRefundableQuantities, ProcessPartialRefund, RedeemRefund, GetRefundPlan, CheckPermission, GetCurrentCart, Print, SetActiveOrder, GetCustomTables, GetCustomTableData, UpsertCustomTableData, DeleteCustomTableData, GetCustomExtensions, GetCurrentCompanyCustomExtensions, GetCustomExtensionCustomTables, GetCustomTableFields, GetSecretsKeys, GetSecretVal, SetSecretVal, GetUsers, GetRoles, RemoveCartDiscount, GetActiveOrder, GetActiveCustomer, SetActiveCustomer, GetActiveOutlet, GetActiveStation, GetActiveSession, GetActiveUser, SetActiveUser, SetActiveRefund, RemoveProductDiscount, RemoveProductFee, RemoveProductNote, RemoveCartFee, RemoveOrderNote, RemoveCustomSale, RemoveNonRevenueItem, CanTransition, GetAvailableTransitions, ApplyTransition, IntegrationPayment, GetSmartGridLayout, SaveSmartGridLayout, SendEmail, SendSms, GetBookingResources, GetBookingAvailability, GetBookings, HoldBooking, AddBookingToCart, RemoveBookingFromCart, CancelBooking, CreatePaymentLink, ChargeMoto, StartCheckout, AttachCheckoutContact, GetAddressOptions, SetOrderAddress, GetShippingOptions, SelectShippingOption, GetOutlets, SetOutlet, ResumeCheckout, GetCheckoutStatus, GetMotoConfig, GetTimeClockStatus } from '../../index';
+import type { ExampleFunction, GetProducts, AddCustomSale, EditCustomSale, GetCustomers, AssignCustomer, AddCustomer, EditCustomer, GetCategories, GetOrders, GetRefunds, GetTaxTables, GetCustomStockActions, AddProductDiscount, AddProductToCart, RemoveProductFromCart, UpdateCartItemQuantity, AddCartDiscount, GetContext, GetFinalContext, AddProductNote, AddProductFee, GetProductModifierSelections, GetCompositePrice, GetCompositeAvailability, SetProductModifierSelections, SetActiveProductFee, SetActiveProductDiscount, GetActiveProduct, SetActiveProduct, AdjustInventory, SetVariantUnavailable, AddOrderNote, AddCartFee, ClearCart, ParkOrder, ResumeParkedOrder, ResumeOrder, SetOrderMetadata, AssignOrderUser, ReleaseFromCart, SetOrderType, SetScheduledFor, SetOrderStatus, GetOrderStatuses, DeleteParkedOrder, VoidOrder, InitiateRefund, CashPayment, RecordExternalPayment, GetCashRoundingAmount, GetCashChange, GetOrdersSummary, TapToPayPayment, TerminalPayment, ExtensionPayment, RedeemPayment, AddNonRevenueItem, AddCustomerNote, RemoveCustomerNote, RemoveCustomerFromCart, GoToStationHome, OpenCashDrawer, ShowNotification, ShowConfirmation, AuthenticateUser, PartialPayment, SwitchUser, SetRefundStockAction, SelectAllRefundItems, ResetRefundDetails, CalculateRefundTotal, GetRemainingRefundableQuantities, ProcessPartialRefund, RedeemRefund, GetRefundPlan, CheckPermission, GetCurrentCart, Print, SetActiveOrder, GetCustomTables, GetCustomTableData, UpsertCustomTableData, DeleteCustomTableData, GetCustomExtensions, GetCurrentCompanyCustomExtensions, GetCustomExtensionCustomTables, GetCustomTableFields, GetSecretsKeys, GetSecretVal, SetSecretVal, GetUsers, GetRoles, RemoveCartDiscount, GetActiveOrder, GetActiveCustomer, SetActiveCustomer, GetActiveOutlet, GetActiveStation, GetActiveSession, GetActiveUser, SetActiveUser, SetActiveRefund, RemoveProductDiscount, RemoveProductFee, RemoveProductNote, RemoveCartFee, RemoveOrderNote, RemoveCustomSale, RemoveNonRevenueItem, CanTransition, GetAvailableTransitions, ApplyTransition, IntegrationPayment, GetSmartGridLayout, SaveSmartGridLayout, SendEmail, SendSms, GetBookingResources, GetBookingAvailability, GetBookingRentalEnds, GetBookings, HoldBooking, AddBookingToCart, RemoveBookingFromCart, CancelBooking, CreatePaymentLink, ChargeMoto, StartCheckout, AttachCheckoutContact, GetAddressOptions, SetOrderAddress, GetShippingOptions, SelectShippingOption, GetOutlets, SetOutlet, ResumeCheckout, GetCheckoutStatus, GetMotoConfig, GetTimeClockStatus } from '../../index';
 export interface RenderProviderActions {
     exampleFunction: ExampleFunction;
     getProducts: GetProducts;
     getBookingResources: GetBookingResources;
     getBookingAvailability: GetBookingAvailability;
+    getBookingRentalEnds: GetBookingRentalEnds;
     getBookings: GetBookings;
     holdBooking: HoldBooking;
     addBookingToCart: AddBookingToCart;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@final-commerce/command-frame",
-  "version": "0.15.0-staging.1",
+  "version": "0.15.0-staging.2",
   "description": "Commands Frame library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -57,7 +57,7 @@
     "ignoreBranchesMissingTickets": true
   },
   "dependencies": {
-    "@final-commerce/common": "2.12.0-staging.1"
+    "@final-commerce/common": "2.12.0-staging.2"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.0.0",