@reactionary/core 0.10.53 → 0.10.54

package/package.json

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

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

@@ -1,8 +1,13 @@
 import * as z from "zod";
-import { ShippingMethodIdentifierSchema } from "./identifiers.model.js";
+import { ShippingMethodIdentifierSchema, StoreIdentifierSchema } from "./identifiers.model.js";
 import { MonetaryAmountSchema } from "./price.model.js";
 import { BaseModelSchema, ImageSchema } from "./base.model.js";
 import { AddressSchema } from "./profile.model.js";
+const ShippingFulfillmentTypeSchema = z.enum(["delivery", "pickup"]);
+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 PickupPointSchema = z.looseObject({
   identifier: z.object({
     key: z.string()
@@ -22,16 +27,22 @@ const ShippingMethodSchema = z.looseObject({
   logo: ImageSchema.optional(),
   price: MonetaryAmountSchema,
   deliveryTime: z.string(),
-  carrier: z.string().optional()
+  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." })
 });
 const ShippingInstructionSchema = BaseModelSchema.extend({
   shippingMethod: ShippingMethodIdentifierSchema,
-  pickupPoint: z.string().meta({ description: "An optional pickup point for the shipping method. This could be a physical store, a locker, or similar. If not set, it means home delivery to the shipping address." }),
+  pickupPoint: z.string().meta({ description: "An optional third-party carrier service point for the shipping method (e.g. a GLS or PostNord parcel shop, or a locker). Reserved for the carrier-service-point case; for pickup at one of the brand's own stores (BOPIS), use the store field instead. If neither is set, it means home delivery to the shipping address." }),
   instructions: z.string().meta({ description: "Optional instructions for the shipping. This could be delivery instructions, or similar." }),
-  consentForUnattendedDelivery: z.boolean().meta({ description: "Indicates if the customer has given consent for unattended delivery, if applicable." })
+  consentForUnattendedDelivery: z.boolean().meta({ description: "Indicates if the customer has given consent for unattended delivery, if applicable." }),
+  store: StoreIdentifierSchema.optional().meta({ description: "An optional reference to one of the brand's own stores where the order will be picked up (BOPIS). Distinct from pickupPoint, which is reserved for third-party carrier service points." }),
+  protocolData: z.array(ShippingProtocolDataSchema).optional().meta({ description: "Additional client-set, protocol-specific data for the shipping instruction, e.g. a selected pickup time slot." })
 });
 export {
   PickupPointSchema,
+  ShippingFulfillmentTypeSchema,
   ShippingInstructionSchema,
-  ShippingMethodSchema
+  ShippingMethodSchema,
+  ShippingProtocolDataSchema
 };

package/schemas/models/store.model.js

@@ -1,14 +1,19 @@
 import * as z from "zod";
-import { BaseModelSchema } from "./base.model.js";
+import { BaseModelSchema, createPaginatedResponseSchema } from "./base.model.js";
 import {
   FulfillmentCenterIdentifierSchema,
   StoreIdentifierSchema
 } from "./identifiers.model.js";
+import { AddressSchema } from "./profile.model.js";
 const StoreSchema = BaseModelSchema.extend({
   identifier: StoreIdentifierSchema,
   name: z.string(),
-  fulfillmentCenter: FulfillmentCenterIdentifierSchema
+  fulfillmentCenter: FulfillmentCenterIdentifierSchema,
+  address: AddressSchema.optional().meta({ description: "The physical address of the store, if known. Useful for showing the store on a map, and as the shipping address for in-store pickup (BOPIS)." }),
+  openingHours: z.string().optional().meta({ description: 'The opening hours of the store, if known. This could be a string like "Mon-Fri 9am-5pm".' })
 });
+const StorePaginatedResultSchema = createPaginatedResponseSchema(StoreSchema);
 export {
+  StorePaginatedResultSchema,
   StoreSchema
 };

package/schemas/queries/store.query.js

@@ -1,11 +1,21 @@
 import * as z from "zod";
 import { BaseQuerySchema } from "./base.query.js";
+import { StoreIdentifierSchema } from "../models/identifiers.model.js";
+import { PaginationOptionsSchema } from "../models/base.model.js";
 const StoreQueryByProximitySchema = BaseQuerySchema.extend({
   longitude: z.number(),
   latitude: z.number(),
   distance: z.number(),
   limit: z.number()
 });
+const StoreQueryByIdSchema = BaseQuerySchema.extend({
+  identifier: StoreIdentifierSchema
+});
+const StoreQueryForListSchema = BaseQuerySchema.extend({
+  paginationOptions: PaginationOptionsSchema
+});
 export {
-  StoreQueryByProximitySchema
+  StoreQueryByIdSchema,
+  StoreQueryByProximitySchema,
+  StoreQueryForListSchema
 };

package/src/capabilities/store.capability.d.ts

@@ -1,8 +1,23 @@
-import type { Store } from '../schemas/models/store.model.js';
-import type { StoreQueryByProximity } from '../schemas/queries/index.js';
+import type { NotFoundError } from '../schemas/errors/not-found.error.js';
+import type { Store, StorePaginatedResult } from '../schemas/models/store.model.js';
+import type { StoreQueryById, StoreQueryByProximity, StoreQueryForList } from '../schemas/queries/index.js';
 import type { Result } from '../schemas/result.js';
 import { BaseCapability } from './base.capability.js';
-export declare abstract class StoreCapability<TStore extends Store = Store> extends BaseCapability {
+export declare abstract class StoreCapability<TStore extends Store = Store, TStorePaginatedResult extends StorePaginatedResult = StorePaginatedResult> extends BaseCapability {
     abstract queryByProximity(payload: StoreQueryByProximity): Promise<Result<Array<TStore>>>;
+    /**
+     * Lists the brand's own stores, paged.
+     *
+     * Usecase: You are rendering a store picker for in-store pickup (BOPIS), or a store locator page,
+     * and geo coordinates are not available.
+     */
+    abstract list(payload: StoreQueryForList): Promise<Result<TStorePaginatedResult>>;
+    /**
+     * Gets a single store by its identifier.
+     *
+     * Usecase: You have a store reference on a shipping instruction (in-store pickup / BOPIS) and
+     * need to show the store's name, address and opening hours.
+     */
+    abstract getById(payload: StoreQueryById): Promise<Result<TStore, NotFoundError>>;
     protected getResourceName(): string;
 }

package/src/schemas/models/checkout.model.d.ts

@@ -2684,6 +2684,13 @@ export declare const CheckoutSchema: z.ZodObject<{
         pickupPoint: z.ZodString;
         instructions: z.ZodString;
         consentForUnattendedDelivery: z.ZodBoolean;
+        store: z.ZodOptional<z.ZodObject<{
+            key: z.ZodString;
+        }, z.core.$loose>>;
+        protocolData: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            value: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodJSONSchema>]>;
+        }, z.core.$loose>>>;
     }, z.core.$loose>>;
     paymentInstructions: z.ZodDefault<z.ZodArray<z.ZodObject<{
         identifier: z.ZodObject<{

package/src/schemas/models/order.model.d.ts

@@ -2879,6 +2879,14 @@ export declare const OrderSchema: z.ZodObject<{
         }, z.core.$loose>;
         deliveryTime: z.ZodString;
         carrier: z.ZodOptional<z.ZodString>;
+        fulfillmentType: z.ZodOptional<z.ZodEnum<{
+            delivery: "delivery";
+            pickup: "pickup";
+        }>>;
+        protocolData: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            value: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodJSONSchema>]>;
+        }, z.core.$loose>>>;
     }, z.core.$loose>>;
     orderStatus: z.ZodEnum<{
         AwaitingPayment: "AwaitingPayment";

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

@@ -1,5 +1,24 @@
 import * as z from "zod";
 import type { InferType } from '../../zod-utils.js';
+/**
+ * How a shipping method fulfills the order:
+ * - 'delivery': the order is shipped to an address (home delivery, or delivery to a third-party
+ *   carrier service point selected via the shipping instruction's pickupPoint field).
+ * - 'pickup': the order is picked up at one of the brand's own stores (BOPIS - buy online, pickup in store).
+ */
+export declare const ShippingFulfillmentTypeSchema: z.ZodEnum<{
+    delivery: "delivery";
+    pickup: "pickup";
+}>;
+/**
+ * A single protocol-specific key/value pair exchanged with the shipping provider.
+ * The value is either a plain string or a JSON-serializable object, so richer
+ * structures (e.g. a selected time slot) round-trip cleanly.
+ */
+export declare const ShippingProtocolDataSchema: z.ZodObject<{
+    key: z.ZodString;
+    value: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodJSONSchema>]>;
+}, z.core.$loose>;
 export declare const PickupPointSchema: z.ZodObject<{
     identifier: z.ZodObject<{
         key: z.ZodString;
@@ -224,6 +243,14 @@ export declare const ShippingMethodSchema: z.ZodObject<{
     }, z.core.$loose>;
     deliveryTime: z.ZodString;
     carrier: z.ZodOptional<z.ZodString>;
+    fulfillmentType: z.ZodOptional<z.ZodEnum<{
+        delivery: "delivery";
+        pickup: "pickup";
+    }>>;
+    protocolData: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        value: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodJSONSchema>]>;
+    }, z.core.$loose>>>;
 }, z.core.$loose>;
 export declare const ShippingInstructionSchema: z.ZodObject<{
     shippingMethod: z.ZodObject<{
@@ -232,7 +259,16 @@ export declare const ShippingInstructionSchema: z.ZodObject<{
     pickupPoint: z.ZodString;
     instructions: z.ZodString;
     consentForUnattendedDelivery: z.ZodBoolean;
+    store: z.ZodOptional<z.ZodObject<{
+        key: z.ZodString;
+    }, z.core.$loose>>;
+    protocolData: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        value: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodJSONSchema>]>;
+    }, z.core.$loose>>>;
 }, z.core.$loose>;
 export type ShippingMethod = InferType<typeof ShippingMethodSchema>;
 export type PickupPoint = InferType<typeof PickupPointSchema>;
 export type ShippingInstruction = InferType<typeof ShippingInstructionSchema>;
+export type ShippingFulfillmentType = InferType<typeof ShippingFulfillmentTypeSchema>;
+export type ShippingProtocolData = InferType<typeof ShippingProtocolDataSchema>;

package/src/schemas/models/store.model.d.ts

@@ -8,5 +8,49 @@ export declare const StoreSchema: z.ZodObject<{
     fulfillmentCenter: z.ZodObject<{
         key: z.ZodString;
     }, z.core.$loose>;
+    address: z.ZodOptional<z.ZodObject<{
+        identifier: z.ZodDefault<z.ZodObject<{
+            nickName: z.ZodString;
+        }, z.core.$loose>>;
+        firstName: z.ZodString;
+        lastName: z.ZodString;
+        streetAddress: z.ZodString;
+        streetNumber: z.ZodString;
+        city: z.ZodString;
+        region: z.ZodString;
+        postalCode: z.ZodString;
+        countryCode: z.ZodString;
+    }, z.core.$loose>>;
+    openingHours: z.ZodOptional<z.ZodString>;
 }, z.core.$loose>;
+export declare const StorePaginatedResultSchema: z.ZodObject<{
+    pageNumber: z.ZodNumber;
+    pageSize: z.ZodNumber;
+    totalCount: z.ZodNumber;
+    totalPages: z.ZodNumber;
+    items: z.ZodArray<z.ZodObject<{
+        identifier: z.ZodObject<{
+            key: z.ZodString;
+        }, z.core.$loose>;
+        name: z.ZodString;
+        fulfillmentCenter: z.ZodObject<{
+            key: z.ZodString;
+        }, z.core.$loose>;
+        address: z.ZodOptional<z.ZodObject<{
+            identifier: z.ZodDefault<z.ZodObject<{
+                nickName: z.ZodString;
+            }, z.core.$loose>>;
+            firstName: z.ZodString;
+            lastName: z.ZodString;
+            streetAddress: z.ZodString;
+            streetNumber: z.ZodString;
+            city: z.ZodString;
+            region: z.ZodString;
+            postalCode: z.ZodString;
+            countryCode: z.ZodString;
+        }, z.core.$loose>>;
+        openingHours: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>;
+}, z.core.$strip>;
 export type Store = InferType<typeof StoreSchema>;
+export type StorePaginatedResult = InferType<typeof StorePaginatedResultSchema>;

package/src/schemas/mutations/analytics/index.d.ts

@@ -2253,6 +2253,14 @@ export declare const AnalyticsMutationSchema: z.ZodDiscriminatedUnion<[z.ZodObje
             }, z.core.$loose>;
             deliveryTime: z.ZodString;
             carrier: z.ZodOptional<z.ZodString>;
+            fulfillmentType: z.ZodOptional<z.ZodEnum<{
+                delivery: "delivery";
+                pickup: "pickup";
+            }>>;
+            protocolData: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                key: z.ZodString;
+                value: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodJSONSchema>]>;
+            }, z.core.$loose>>>;
         }, z.core.$loose>>;
         orderStatus: z.ZodEnum<{
             AwaitingPayment: "AwaitingPayment";

package/src/schemas/mutations/analytics/purchase.mutation.d.ts

@@ -2126,6 +2126,14 @@ export declare const AnalyticsMutationPurchaseEventSchema: z.ZodObject<{
             }, z.core.$loose>;
             deliveryTime: z.ZodString;
             carrier: z.ZodOptional<z.ZodString>;
+            fulfillmentType: z.ZodOptional<z.ZodEnum<{
+                delivery: "delivery";
+                pickup: "pickup";
+            }>>;
+            protocolData: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                key: z.ZodString;
+                value: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodJSONSchema>]>;
+            }, z.core.$loose>>>;
         }, z.core.$loose>>;
         orderStatus: z.ZodEnum<{
             AwaitingPayment: "AwaitingPayment";

package/src/schemas/mutations/checkout.mutation.d.ts

@@ -2333,6 +2333,13 @@ export declare const CheckoutMutationSetShippingInstructionSchema: z.ZodObject<{
         pickupPoint: z.ZodString;
         instructions: z.ZodString;
         consentForUnattendedDelivery: z.ZodBoolean;
+        store: z.ZodOptional<z.ZodObject<{
+            key: z.ZodString;
+        }, z.core.$loose>>;
+        protocolData: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            value: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodJSONSchema>]>;
+        }, z.core.$loose>>>;
     }, z.core.$loose>;
     checkout: z.ZodObject<{
         key: z.ZodString;

package/src/schemas/queries/store.query.d.ts

@@ -6,4 +6,17 @@ export declare const StoreQueryByProximitySchema: z.ZodObject<{
     distance: z.ZodNumber;
     limit: z.ZodNumber;
 }, z.core.$loose>;
+export declare const StoreQueryByIdSchema: z.ZodObject<{
+    identifier: z.ZodObject<{
+        key: z.ZodString;
+    }, z.core.$loose>;
+}, z.core.$loose>;
+export declare const StoreQueryForListSchema: z.ZodObject<{
+    paginationOptions: z.ZodObject<{
+        pageNumber: z.ZodDefault<z.ZodNumber>;
+        pageSize: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$loose>;
+}, z.core.$loose>;
 export type StoreQueryByProximity = InferType<typeof StoreQueryByProximitySchema>;
+export type StoreQueryById = InferType<typeof StoreQueryByIdSchema>;
+export type StoreQueryForList = InferType<typeof StoreQueryForListSchema>;