@jaicome/contracts 0.0.73 → 0.0.76

package/dist/fulfillment-states.d.mts

@@ -1,8 +1,8 @@
-import { i as FulfillmentState$1 } from "./orders-yFOPRYZw.mjs";
+import { Y as orderFulfillmentTypes, i as FulfillmentState$1 } from "./orders-CHXvc7L7.mjs";
 
 //#region src/fulfillment-states.d.ts
-
 type FulfillmentState = FulfillmentState$1;
+type OrderFulfillmentType = (typeof orderFulfillmentTypes)[number];
 /**
  * All valid fulfillment states in order
  *
@@ -112,6 +112,44 @@ declare function getAllowedUserTransitions(from: FulfillmentState | null): Fulfi
  * ```
  */
 declare function isTerminalState(state: FulfillmentState): boolean;
+/**
+ * Human-readable labels for fulfillment states
+ * Used for translation keys and UI display
+ */
+declare const STATUS_LABELS: Readonly<Record<FulfillmentState, string>>;
+/**
+ * Gets available user transitions for a fulfillment, filtered by fulfillment type
+ * This is the recommended function for UI components to determine which state transitions to show
+ *
+ * Filtering rules:
+ * - REFUNDED is always excluded (handled via separate refund flow)
+ * - AWAITING_DELIVERY and ON_THE_WAY are excluded for non-delivery orders (PICKUP, DINEIN, CURBSIDE)
+ * - AWAITING_DELIVERY and ON_THE_WAY are included for DELIVERY and SHIPPING orders
+ *
+ * @param from - Current state (null treated as NEW)
+ * @param fulfillmentType - The fulfillment type (DELIVERY, PICKUP, SHIPPING, DINEIN, CURBSIDE)
+ * @returns Array of allowed next states appropriate for the fulfillment type
+ *
+ * @example
+ * ```ts
+ * // PICKUP order - no delivery states
+ * getAvailableUserTransitions("NEW", "PICKUP")
+ * // ["CONFIRMED", "READY", "COMPLETED", "CANCELLED"]
+ *
+ * // DELIVERY order - includes delivery states
+ * getAvailableUserTransitions("NEW", "DELIVERY")
+ * // ["AWAITING_DELIVERY", "CONFIRMED", "READY", "ON_THE_WAY", "COMPLETED", "CANCELLED"]
+ *
+ * // SHIPPING order - same as DELIVERY
+ * getAvailableUserTransitions("NEW", "SHIPPING")
+ * // ["AWAITING_DELIVERY", "CONFIRMED", "READY", "ON_THE_WAY", "COMPLETED", "CANCELLED"]
+ *
+ * // Terminal state - no transitions
+ * getAvailableUserTransitions("CANCELLED", "DELIVERY")
+ * // []
+ * ```
+ */
+declare function getAvailableUserTransitions(from: FulfillmentState | null, fulfillmentType?: OrderFulfillmentType | string | null): FulfillmentState[];
 /**
  * Namespace containing all fulfillment state machine operations
  * Provides a unified API for state machine functionality
@@ -121,9 +159,11 @@ declare const FulfillmentStateMachine: {
   readonly assertCanTransition: typeof assertCanTransition;
   readonly getAllowedTransitions: typeof getAllowedTransitions;
   readonly getAllowedUserTransitions: typeof getAllowedUserTransitions;
+  readonly getAvailableUserTransitions: typeof getAvailableUserTransitions;
   readonly isTerminalState: typeof isTerminalState;
   readonly values: readonly ["NEW", "AWAITING_DELIVERY", "CONFIRMED", "READY", "ON_THE_WAY", "COMPLETED", "CANCELLED", "FAILED", "REFUNDED"];
   readonly terminalStates: ReadonlySet<"NEW" | "AWAITING_DELIVERY" | "CONFIRMED" | "READY" | "ON_THE_WAY" | "COMPLETED" | "CANCELLED" | "FAILED" | "REFUNDED">;
+  readonly statusLabels: Readonly<Record<"NEW" | "AWAITING_DELIVERY" | "CONFIRMED" | "READY" | "ON_THE_WAY" | "COMPLETED" | "CANCELLED" | "FAILED" | "REFUNDED", string>>;
 };
 //#endregion
-export { Actor, FulfillmentState, FulfillmentStateMachine, FulfillmentStateValues, TerminalStates, assertCanTransition, canTransition, getAllowedTransitions, getAllowedUserTransitions, isTerminalState };
+export { Actor, FulfillmentState, FulfillmentStateMachine, FulfillmentStateValues, OrderFulfillmentType, STATUS_LABELS, TerminalStates, assertCanTransition, canTransition, getAllowedTransitions, getAllowedUserTransitions, getAvailableUserTransitions, isTerminalState };

package/dist/fulfillment-states.mjs

@@ -208,6 +208,69 @@ function isTerminalState(state) {
 	return TerminalStates.has(state);
 }
 /**
+* Fulfillment types that support delivery-specific states (AWAITING_DELIVERY, ON_THE_WAY)
+*/
+const DELIVERY_FULFILLMENT_TYPES = new Set(["DELIVERY", "SHIPPING"]);
+/**
+* States that are only applicable to delivery/shipping orders
+*/
+const DELIVERY_ONLY_STATES = new Set(["AWAITING_DELIVERY", "ON_THE_WAY"]);
+/**
+* Human-readable labels for fulfillment states
+* Used for translation keys and UI display
+*/
+const STATUS_LABELS = {
+	NEW: "New",
+	AWAITING_DELIVERY: "Awaiting Delivery",
+	CONFIRMED: "Confirmed",
+	READY: "Ready",
+	ON_THE_WAY: "On The Way",
+	COMPLETED: "Completed",
+	CANCELLED: "Cancelled",
+	FAILED: "Failed",
+	REFUNDED: "Refunded"
+};
+/**
+* Gets available user transitions for a fulfillment, filtered by fulfillment type
+* This is the recommended function for UI components to determine which state transitions to show
+*
+* Filtering rules:
+* - REFUNDED is always excluded (handled via separate refund flow)
+* - AWAITING_DELIVERY and ON_THE_WAY are excluded for non-delivery orders (PICKUP, DINEIN, CURBSIDE)
+* - AWAITING_DELIVERY and ON_THE_WAY are included for DELIVERY and SHIPPING orders
+*
+* @param from - Current state (null treated as NEW)
+* @param fulfillmentType - The fulfillment type (DELIVERY, PICKUP, SHIPPING, DINEIN, CURBSIDE)
+* @returns Array of allowed next states appropriate for the fulfillment type
+*
+* @example
+* ```ts
+* // PICKUP order - no delivery states
+* getAvailableUserTransitions("NEW", "PICKUP")
+* // ["CONFIRMED", "READY", "COMPLETED", "CANCELLED"]
+*
+* // DELIVERY order - includes delivery states
+* getAvailableUserTransitions("NEW", "DELIVERY")
+* // ["AWAITING_DELIVERY", "CONFIRMED", "READY", "ON_THE_WAY", "COMPLETED", "CANCELLED"]
+*
+* // SHIPPING order - same as DELIVERY
+* getAvailableUserTransitions("NEW", "SHIPPING")
+* // ["AWAITING_DELIVERY", "CONFIRMED", "READY", "ON_THE_WAY", "COMPLETED", "CANCELLED"]
+*
+* // Terminal state - no transitions
+* getAvailableUserTransitions("CANCELLED", "DELIVERY")
+* // []
+* ```
+*/
+function getAvailableUserTransitions(from, fulfillmentType) {
+	const isDelivery = DELIVERY_FULFILLMENT_TYPES.has(fulfillmentType ?? "");
+	return getAllowedUserTransitions(from).filter((state) => {
+		if (state === "REFUNDED") return false;
+		if (!isDelivery && DELIVERY_ONLY_STATES.has(state)) return false;
+		return true;
+	});
+}
+/**
 * Namespace containing all fulfillment state machine operations
 * Provides a unified API for state machine functionality
 */
@@ -216,10 +279,12 @@ const FulfillmentStateMachine = {
 	assertCanTransition,
 	getAllowedTransitions,
 	getAllowedUserTransitions,
+	getAvailableUserTransitions,
 	isTerminalState,
 	values: FulfillmentStateValues,
-	terminalStates: TerminalStates
+	terminalStates: TerminalStates,
+	statusLabels: STATUS_LABELS
 };
 
 //#endregion
-export { FulfillmentStateMachine, FulfillmentStateValues, TerminalStates, assertCanTransition, canTransition, getAllowedTransitions, getAllowedUserTransitions, isTerminalState };
+export { FulfillmentStateMachine, FulfillmentStateValues, STATUS_LABELS, TerminalStates, assertCanTransition, canTransition, getAllowedTransitions, getAllowedUserTransitions, getAvailableUserTransitions, isTerminalState };