@deliverart/sdk-js-order 2.12.0 → 2.13.0

package/README.md

@@ -15,7 +15,7 @@ pnpm add @deliverart/sdk-js-order @deliverart/sdk-js-core
 ### Core Types
 
 ```typescript
-type OrderType = 'delivery' | 'take_away' | 'kitchen'
+type OrderType = 'delivery' | 'collection' | 'kitchen'
 type OrderStatus = 'pending' | 'confirmed' | 'rejected'
 type OrderPreparationStatus = 'to_prepare' | 'in_preparation' | 'done'
 type OrderSource = 'application' | 'ecommerce' | 'partner'
@@ -27,10 +27,12 @@ type OrderPlanningMode = 'PLANNED' | 'FORCED'
 - `Order`
 - `OrderDetails`
 - `DeliveryOrder`
-- `TakeAwayOrder`
+- `CollectionOrder`
+- `TakeAwayOrder` (deprecated alias)
 - `KitchenOrder`
 - `DeliveryOrderDetails`
-- `TakeAwayOrderDetails`
+- `CollectionOrderDetails`
+- `TakeAwayOrderDetails` (deprecated alias)
 - `KitchenOrderDetails`
 - `WritableOrder`
 - `WritableUpdateOrder`
@@ -51,7 +53,7 @@ type OrderPlanningMode = 'PLANNED' | 'FORCED'
 `Order` and `OrderDetails` are discriminated by `type`.
 
 - `delivery` orders expose delivery-specific fields like `address`, `requestedDeliveryTime`, `finalDeliveryTime`, `deliveryStartedAt`, `deliveredAt`
-- `take_away` orders expose collection-specific fields like `requestedCollectionTime`, `finalCollectionTime`, `collectedAt`
+- `collection` orders expose collection-specific fields like `requestedCollectionTime`, `finalCollectionTime`, `collectedAt`
 - `kitchen` orders exclude both delivery and collection scheduling fields
 - all order read models also expose scheduling metadata such as `scheduledWindowStart`, `scheduledWindowEnd`, `schedulingVersion` and `planningMode`
 - delivery read models additionally expose `estimatedRouteDurationSeconds`, `estimatedRouteDistanceMeters` and `stopSequence`
@@ -59,11 +61,12 @@ type OrderPlanningMode = 'PLANNED' | 'FORCED'
 `CreateOrderInput` and `CalculateOrderFeesInput` are also discriminated by `type`.
 
 - `delivery` accepts fields such as `address`, `customerAddress`, `locationData`, `referenceBundle`, `deliveryTime`
-- `take_away` accepts `collectionTime`
+- `collection` accepts `collectionTime`
+- the legacy alias `take_away` is still accepted on write for backward compatibility
 - `kitchen` does not accept delivery or collection scheduling fields
 - all writable order inputs also accept `forceScheduling?: boolean` for internal operator-only retries that bypass slot/capacity validation
 
-`UpdateOrderInput` keeps common editable fields and enforces mutually exclusive delivery / take-away scheduling fields.
+`UpdateOrderInput` keeps common editable fields and enforces mutually exclusive delivery / collection scheduling fields.
 
 ## Order Requests
 
@@ -126,7 +129,7 @@ import { CalculateOrderFees } from '@deliverart/sdk-js-order'
 
 const fees = await sdk.call(
   new CalculateOrderFees({
-    type: 'take_away',
+    type: 'collection',
     source: 'application',
     pointOfSale: '/point_of_sales/123e4567-e89b-12d3-a456-426614174000',
     collectionTime: '2026-03-22T20:00:00+01:00',
@@ -155,7 +158,7 @@ import { GetOrders } from '@deliverart/sdk-js-order'
 const orders = await sdk.call(
   new GetOrders({
     query: {
-      type: ['delivery', 'take_away'],
+      type: ['delivery', 'collection'],
       status: ['pending', 'confirmed'],
       preparationStatus: 'to_prepare',
       'order[createdAt]': 'desc',

package/dist/index.cjs

@@ -62,6 +62,8 @@ __export(index_exports, {
   bundlesQuerySchema: () => bundlesQuerySchema,
   calculateOrderFeesInputSchema: () => calculateOrderFeesInputSchema,
   calculateOrderFeesResponseSchema: () => calculateOrderFeesResponseSchema,
+  collectionOrderDetailsSchema: () => collectionOrderDetailsSchema,
+  collectionOrderSchema: () => collectionOrderSchema,
   confirmOrderInputSchema: () => confirmOrderInputSchema,
   confirmOrderResponseSchema: () => confirmOrderResponseSchema,
   createBundleInputSchema: () => createBundleInputSchema,
@@ -170,6 +172,7 @@ __export(index_exports, {
   updateOrderInputSchema: () => updateOrderInputSchema,
   updateOrderResponseSchema: () => updateOrderResponseSchema,
   writableBundleSchema: () => writableBundleSchema,
+  writableCollectionOrderSchema: () => writableCollectionOrderSchema,
   writableDeliveryOrderSchema: () => writableDeliveryOrderSchema,
   writableKitchenOrderSchema: () => writableKitchenOrderSchema,
   writableOrderMenuItemModifierSchema: () => writableOrderMenuItemModifierSchema,
@@ -14108,6 +14111,12 @@ var orderBaseSchema = external_exports.object({
   createdAt: import_sdk_js_global_types3.datetimeSchema,
   updatedAt: import_sdk_js_global_types3.datetimeSchema
 });
+var normalizeCollectionOrderType = (value) => {
+  if (value !== null && typeof value === "object" && "type" in value && value.type === "take_away") {
+    return { ...value, type: "collection" };
+  }
+  return value;
+};
 var deliveryOrderFieldsSchema = external_exports.object({
   type: external_exports.literal("delivery"),
   address: orderAddressSchema.nullable(),
@@ -14120,8 +14129,8 @@ var deliveryOrderFieldsSchema = external_exports.object({
   finalCollectionTime: external_exports.null(),
   collectedAt: external_exports.null()
 });
-var takeAwayOrderFieldsSchema = external_exports.object({
-  type: external_exports.literal("take_away"),
+var collectionOrderFieldsSchema = external_exports.object({
+  type: external_exports.literal("collection"),
   address: external_exports.null(),
   location: external_exports.null(),
   requestedDeliveryTime: external_exports.null(),
@@ -14145,13 +14154,13 @@ var kitchenOrderFieldsSchema = external_exports.object({
   collectedAt: external_exports.null()
 });
 var deliveryOrderSchema = orderBaseSchema.extend(deliveryOrderFieldsSchema.shape);
-var takeAwayOrderSchema = orderBaseSchema.extend(takeAwayOrderFieldsSchema.shape);
+var collectionOrderSchema = orderBaseSchema.extend(collectionOrderFieldsSchema.shape);
+var takeAwayOrderSchema = collectionOrderSchema;
 var kitchenOrderSchema = orderBaseSchema.extend(kitchenOrderFieldsSchema.shape);
-var orderSchema = external_exports.discriminatedUnion("type", [
-  deliveryOrderSchema,
-  takeAwayOrderSchema,
-  kitchenOrderSchema
-]);
+var orderSchema = external_exports.preprocess(
+  normalizeCollectionOrderType,
+  external_exports.discriminatedUnion("type", [deliveryOrderSchema, collectionOrderSchema, kitchenOrderSchema])
+);
 var orderDetailsCommonSchema = external_exports.object({
   pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
   customer: import_sdk_js_customer.customerNullableIriSchema,
@@ -14162,13 +14171,17 @@ var orderDetailsCommonSchema = external_exports.object({
   modifiers: external_exports.array(orderMenuItemModifierSchema).min(0)
 });
 var deliveryOrderDetailsSchema = deliveryOrderSchema.extend(orderDetailsCommonSchema.shape);
-var takeAwayOrderDetailsSchema = takeAwayOrderSchema.extend(orderDetailsCommonSchema.shape);
+var collectionOrderDetailsSchema = collectionOrderSchema.extend(orderDetailsCommonSchema.shape);
+var takeAwayOrderDetailsSchema = collectionOrderDetailsSchema;
 var kitchenOrderDetailsSchema = kitchenOrderSchema.extend(orderDetailsCommonSchema.shape);
-var orderDetailsSchema = external_exports.discriminatedUnion("type", [
-  deliveryOrderDetailsSchema,
-  takeAwayOrderDetailsSchema,
-  kitchenOrderDetailsSchema
-]);
+var orderDetailsSchema = external_exports.preprocess(
+  normalizeCollectionOrderType,
+  external_exports.discriminatedUnion("type", [
+    deliveryOrderDetailsSchema,
+    collectionOrderDetailsSchema,
+    kitchenOrderDetailsSchema
+  ])
+);
 var writableOrderMenuItemSchema = external_exports.lazy(
   () => external_exports.object({
     menuItem: import_sdk_js_menu.menuItemIriSchema,
@@ -14216,6 +14229,16 @@ var writableDeliveryOrderSchema = writableOrderBaseSchema.extend({
   deliveryTime: import_sdk_js_global_types3.datetimeSchema.nullable().optional(),
   collectionTime: external_exports.never().optional()
 });
+var writableCollectionOrderSchema = writableOrderBaseSchema.extend({
+  type: external_exports.literal("collection"),
+  collectionTime: import_sdk_js_global_types3.datetimeSchema.nullable().optional(),
+  address: external_exports.never().optional(),
+  customerAddress: external_exports.never().optional(),
+  locationData: external_exports.never().optional(),
+  referenceBundle: external_exports.never().optional(),
+  resolveLocationFromAddress: external_exports.never().optional(),
+  deliveryTime: external_exports.never().optional()
+});
 var writableTakeAwayOrderSchema = writableOrderBaseSchema.extend({
   type: external_exports.literal("take_away"),
   collectionTime: import_sdk_js_global_types3.datetimeSchema.nullable().optional(),
@@ -14238,6 +14261,7 @@ var writableKitchenOrderSchema = writableOrderBaseSchema.extend({
 });
 var writableOrderSchema = external_exports.discriminatedUnion("type", [
   writableDeliveryOrderSchema,
+  writableCollectionOrderSchema,
   writableTakeAwayOrderSchema,
   writableKitchenOrderSchema
 ]);
@@ -15206,6 +15230,8 @@ var UpdateOrder = class extends import_sdk_js_core26.AbstractApiRequest {
   bundlesQuerySchema,
   calculateOrderFeesInputSchema,
   calculateOrderFeesResponseSchema,
+  collectionOrderDetailsSchema,
+  collectionOrderSchema,
   confirmOrderInputSchema,
   confirmOrderResponseSchema,
   createBundleInputSchema,
@@ -15314,6 +15340,7 @@ var UpdateOrder = class extends import_sdk_js_core26.AbstractApiRequest {
   updateOrderInputSchema,
   updateOrderResponseSchema,
   writableBundleSchema,
+  writableCollectionOrderSchema,
   writableDeliveryOrderSchema,
   writableKitchenOrderSchema,
   writableOrderMenuItemModifierSchema,