@reactionary/core 0.10.54 → 0.10.55

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reactionary/core",
-  "version": "0.10.54",
+  "version": "0.10.55",
   "type": "module",
   "main": "./index.js",
   "types": "./src/index.d.ts",

package/schemas/models/shipping-method.model.js

@@ -8,6 +8,13 @@ const ShippingProtocolDataSchema = z.looseObject({
   key: z.string().meta({ description: 'The protocol-specific key, e.g. "timeSlotId".' }),
   value: z.union([z.string(), z.record(z.string(), z.json())]).meta({ description: "The protocol-specific value: either a plain string, or a JSON-serializable object for richer structures." })
 });
+const SHIPPING_PROTOCOL_DATA_KEYS = {
+  /**
+   * The identifier (Store.identifier.key) of the brand's own store an
+   * in-store pickup (BOPIS) shipping method is fulfilled from.
+   */
+  pickupStore: "pickup_store"
+};
 const PickupPointSchema = z.looseObject({
   identifier: z.object({
     key: z.string()
@@ -29,7 +36,7 @@ const ShippingMethodSchema = z.looseObject({
   deliveryTime: z.string(),
   carrier: z.string().optional(),
   fulfillmentType: ShippingFulfillmentTypeSchema.optional().meta({ description: `How this shipping method fulfills the order: "delivery" for shipment to an address (including third-party carrier service points selected via the shipping instruction's pickupPoint), "pickup" for collection at one of the brand's own stores (BOPIS). When absent, "delivery" can be assumed.` }),
-  protocolData: z.array(ShippingProtocolDataSchema).optional().meta({ description: "Additional provider-populated, protocol-specific data for this shipping method, e.g. available pickup time slots." })
+  protocolData: z.array(ShippingProtocolDataSchema).optional().meta({ description: `Additional provider-populated, protocol-specific data for this shipping method, e.g. available pickup time slots. Conventional keys (see SHIPPING_PROTOCOL_DATA_KEYS) include "pickup_store": the identifier of the brand's own store a pickup method is fulfilled from.` })
 });
 const ShippingInstructionSchema = BaseModelSchema.extend({
   shippingMethod: ShippingMethodIdentifierSchema,
@@ -41,6 +48,7 @@ const ShippingInstructionSchema = BaseModelSchema.extend({
 });
 export {
   PickupPointSchema,
+  SHIPPING_PROTOCOL_DATA_KEYS,
   ShippingFulfillmentTypeSchema,
   ShippingInstructionSchema,
   ShippingMethodSchema,

package/src/schemas/models/shipping-method.model.d.ts

@@ -19,6 +19,18 @@ export declare const ShippingProtocolDataSchema: z.ZodObject<{
     key: z.ZodString;
     value: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodJSONSchema>]>;
 }, z.core.$loose>;
+/**
+ * Conventional, cross-provider keys for shipping protocol data entries.
+ * Providers emit these keys when the concept applies, so clients can consume
+ * them without provider-specific knowledge.
+ */
+export declare const SHIPPING_PROTOCOL_DATA_KEYS: {
+    /**
+     * The identifier (Store.identifier.key) of the brand's own store an
+     * in-store pickup (BOPIS) shipping method is fulfilled from.
+     */
+    readonly pickupStore: "pickup_store";
+};
 export declare const PickupPointSchema: z.ZodObject<{
     identifier: z.ZodObject<{
         key: z.ZodString;