@asteby/storefront 0.2.0 → 0.4.0

package/dist/{types-CTXB8Dnl.d.cts → types-BmC-RDo8.d.ts}

@@ -1,9 +1,12 @@
+import { OpeningHours } from './geo.js';
+
 /**
  * Storefront API v1 contract types.
  *
  * Field names match the wire format exactly (snake_case). Money amounts are
  * decimal strings ("1899.00") so no precision is lost in transit.
  */
+
 type Money = {
     amount: string;
     currency_code: string;
@@ -125,6 +128,53 @@ type ShopBranch = {
     lat: number | null;
     lng: number | null;
     hours: string | null;
+    /**
+     * Structured hours. Optional: only present once the Storefront API ships
+     * `locations.v1`; today's API returns `hours` (free text) only.
+     */
+    opening_hours?: OpeningHours;
+    /** IANA time zone of the branch (e.g. `America/Mexico_City`). Comes with `locations.v1`. */
+    timezone?: string;
+    /** Human-readable hours, authoritative for display. Comes with `locations.v1`. */
+    opening_hours_text?: string;
+    /** Postal code of the branch. Comes with `locations.v1`. */
+    postal_code?: string | null;
+    /** What kind of place it is. Comes with `locations.v1`. */
+    kind?: LocationKind;
+    /** What can be done there (free-form keys such as `pickup`, `returns`, `repairs`). Comes with `locations.v1`. */
+    services?: string[];
+    /** Contact channels of the branch. Comes with `locations.v1`. */
+    contacts?: LocationContacts;
+    /** Pickup ("recoge en sucursal") terms. Comes with `locations.v1`. */
+    pickup?: LocationPickup;
+};
+type LocationKind = 'store' | 'warehouse' | 'pickup_point' | 'office' | (string & {});
+type LocationContacts = {
+    phone: string | null;
+    email: string | null;
+    whatsapp: string | null;
+};
+/** `fee` is `null` when pickup is free. `prep_days`: days until the order is ready (0 = same day). */
+type LocationPickup = {
+    enabled: boolean;
+    fee: Money | null;
+    prep_days: number;
+};
+/**
+ * A branch as served by `/storefront/locations` (`locations.v1`): a `ShopBranch`
+ * whose structured fields are always present. `distance_km` is set only when
+ * the answer is ordered by distance (`nearest`, or `list` with `postal_code`).
+ */
+type Location = ShopBranch & Required<Pick<ShopBranch, 'kind' | 'services' | 'contacts' | 'pickup' | 'postal_code'>> & {
+    distance_km?: number | null;
+};
+/** Answer of `locations.nearest`: always ordered by distance, closest first. */
+type NearestLocation = Location & {
+    distance_km: number;
+};
+type LocationListParams = {
+    /** Orders the branches by distance to the centroid of this postal code. */
+    postal_code?: string;
 };
 type ShopPolicies = {
     free_shipping_min: Money | null;
@@ -462,4 +512,4 @@ type StorefrontErrorBody = {
     };
 };
 
-export type { SelectedOption as $, Address as A, MenuItem as B, Cart as C, DeliveryInput as D, Money as E, Facet as F, MoneyRange as G, OrderLine as H, Image as I, PageInfo as J, PaymentMethod as K, PaymentMethods as L, Menu as M, PickupOption as N, Order as O, Page as P, Product as Q, ProductAttributeValue as R, ProductCategory as S, ProductConnection as T, ProductOption as U, ProductSort as V, ProductVariant as W, ReturnRequest as X, ReturnRequestInput as Y, SEO as Z, Section as _, AddressInput as a, ShippingRate as a0, Shop as a1, ShopBranch as a2, ShopContact as a3, ShopPolicies as a4, StockLevel as a5, StorefrontErrorBody as a6, StorefrontErrorCode as a7, Theme as a8, UnavailableRateProvider as a9, Article as b, CartBuyer as c, CartBuyerInput as d, CartCost as e, CartDelivery as f, CartDiscountCode as g, CartLine as h, CartLineInput as i, CartLineMerchandise as j, CartLineUpdateInput as k, CheckoutInfo as l, CheckoutInput as m, CheckoutPayment as n, CheckoutResult as o, Collection as p, Connection as q, Customer as r, CustomerIdentifier as s, CustomerSession as t, CustomerSessionInput as u, DeliveryMethod as v, DeliveryOptions as w, FacetValue as x, InvoiceRequest as y, InvoiceResult as z };
+export type { ProductSort as $, Address as A, LocationContacts as B, Cart as C, DeliveryInput as D, LocationKind as E, Facet as F, LocationListParams as G, LocationPickup as H, Image as I, MenuItem as J, Money as K, Location as L, Menu as M, MoneyRange as N, NearestLocation as O, Order as P, OrderLine as Q, Page as R, PageInfo as S, PaymentMethod as T, PaymentMethods as U, PickupOption as V, Product as W, ProductAttributeValue as X, ProductCategory as Y, ProductConnection as Z, ProductOption as _, AddressInput as a, ProductVariant as a0, ReturnRequest as a1, ReturnRequestInput as a2, SEO as a3, Section as a4, SelectedOption as a5, ShippingRate as a6, Shop as a7, ShopBranch as a8, ShopContact as a9, ShopPolicies as aa, StockLevel as ab, StorefrontErrorBody as ac, StorefrontErrorCode as ad, Theme as ae, UnavailableRateProvider as af, Article as b, CartBuyer as c, CartBuyerInput as d, CartCost as e, CartDelivery as f, CartDiscountCode as g, CartLine as h, CartLineInput as i, CartLineMerchandise as j, CartLineUpdateInput as k, CheckoutInfo as l, CheckoutInput as m, CheckoutPayment as n, CheckoutResult as o, Collection as p, Connection as q, Customer as r, CustomerIdentifier as s, CustomerSession as t, CustomerSessionInput as u, DeliveryMethod as v, DeliveryOptions as w, FacetValue as x, InvoiceRequest as y, InvoiceResult as z };

package/dist/{types-CTXB8Dnl.d.ts → types-D300wdPF.d.cts}

@@ -1,9 +1,12 @@
+import { OpeningHours } from './geo.cjs';
+
 /**
  * Storefront API v1 contract types.
  *
  * Field names match the wire format exactly (snake_case). Money amounts are
  * decimal strings ("1899.00") so no precision is lost in transit.
  */
+
 type Money = {
     amount: string;
     currency_code: string;
@@ -125,6 +128,53 @@ type ShopBranch = {
     lat: number | null;
     lng: number | null;
     hours: string | null;
+    /**
+     * Structured hours. Optional: only present once the Storefront API ships
+     * `locations.v1`; today's API returns `hours` (free text) only.
+     */
+    opening_hours?: OpeningHours;
+    /** IANA time zone of the branch (e.g. `America/Mexico_City`). Comes with `locations.v1`. */
+    timezone?: string;
+    /** Human-readable hours, authoritative for display. Comes with `locations.v1`. */
+    opening_hours_text?: string;
+    /** Postal code of the branch. Comes with `locations.v1`. */
+    postal_code?: string | null;
+    /** What kind of place it is. Comes with `locations.v1`. */
+    kind?: LocationKind;
+    /** What can be done there (free-form keys such as `pickup`, `returns`, `repairs`). Comes with `locations.v1`. */
+    services?: string[];
+    /** Contact channels of the branch. Comes with `locations.v1`. */
+    contacts?: LocationContacts;
+    /** Pickup ("recoge en sucursal") terms. Comes with `locations.v1`. */
+    pickup?: LocationPickup;
+};
+type LocationKind = 'store' | 'warehouse' | 'pickup_point' | 'office' | (string & {});
+type LocationContacts = {
+    phone: string | null;
+    email: string | null;
+    whatsapp: string | null;
+};
+/** `fee` is `null` when pickup is free. `prep_days`: days until the order is ready (0 = same day). */
+type LocationPickup = {
+    enabled: boolean;
+    fee: Money | null;
+    prep_days: number;
+};
+/**
+ * A branch as served by `/storefront/locations` (`locations.v1`): a `ShopBranch`
+ * whose structured fields are always present. `distance_km` is set only when
+ * the answer is ordered by distance (`nearest`, or `list` with `postal_code`).
+ */
+type Location = ShopBranch & Required<Pick<ShopBranch, 'kind' | 'services' | 'contacts' | 'pickup' | 'postal_code'>> & {
+    distance_km?: number | null;
+};
+/** Answer of `locations.nearest`: always ordered by distance, closest first. */
+type NearestLocation = Location & {
+    distance_km: number;
+};
+type LocationListParams = {
+    /** Orders the branches by distance to the centroid of this postal code. */
+    postal_code?: string;
 };
 type ShopPolicies = {
     free_shipping_min: Money | null;
@@ -462,4 +512,4 @@ type StorefrontErrorBody = {
     };
 };
 
-export type { SelectedOption as $, Address as A, MenuItem as B, Cart as C, DeliveryInput as D, Money as E, Facet as F, MoneyRange as G, OrderLine as H, Image as I, PageInfo as J, PaymentMethod as K, PaymentMethods as L, Menu as M, PickupOption as N, Order as O, Page as P, Product as Q, ProductAttributeValue as R, ProductCategory as S, ProductConnection as T, ProductOption as U, ProductSort as V, ProductVariant as W, ReturnRequest as X, ReturnRequestInput as Y, SEO as Z, Section as _, AddressInput as a, ShippingRate as a0, Shop as a1, ShopBranch as a2, ShopContact as a3, ShopPolicies as a4, StockLevel as a5, StorefrontErrorBody as a6, StorefrontErrorCode as a7, Theme as a8, UnavailableRateProvider as a9, Article as b, CartBuyer as c, CartBuyerInput as d, CartCost as e, CartDelivery as f, CartDiscountCode as g, CartLine as h, CartLineInput as i, CartLineMerchandise as j, CartLineUpdateInput as k, CheckoutInfo as l, CheckoutInput as m, CheckoutPayment as n, CheckoutResult as o, Collection as p, Connection as q, Customer as r, CustomerIdentifier as s, CustomerSession as t, CustomerSessionInput as u, DeliveryMethod as v, DeliveryOptions as w, FacetValue as x, InvoiceRequest as y, InvoiceResult as z };
+export type { ProductSort as $, Address as A, LocationContacts as B, Cart as C, DeliveryInput as D, LocationKind as E, Facet as F, LocationListParams as G, LocationPickup as H, Image as I, MenuItem as J, Money as K, Location as L, Menu as M, MoneyRange as N, NearestLocation as O, Order as P, OrderLine as Q, Page as R, PageInfo as S, PaymentMethod as T, PaymentMethods as U, PickupOption as V, Product as W, ProductAttributeValue as X, ProductCategory as Y, ProductConnection as Z, ProductOption as _, AddressInput as a, ProductVariant as a0, ReturnRequest as a1, ReturnRequestInput as a2, SEO as a3, Section as a4, SelectedOption as a5, ShippingRate as a6, Shop as a7, ShopBranch as a8, ShopContact as a9, ShopPolicies as aa, StockLevel as ab, StorefrontErrorBody as ac, StorefrontErrorCode as ad, Theme as ae, UnavailableRateProvider as af, Article as b, CartBuyer as c, CartBuyerInput as d, CartCost as e, CartDelivery as f, CartDiscountCode as g, CartLine as h, CartLineInput as i, CartLineMerchandise as j, CartLineUpdateInput as k, CheckoutInfo as l, CheckoutInput as m, CheckoutPayment as n, CheckoutResult as o, Collection as p, Connection as q, Customer as r, CustomerIdentifier as s, CustomerSession as t, CustomerSessionInput as u, DeliveryMethod as v, DeliveryOptions as w, FacetValue as x, InvoiceRequest as y, InvoiceResult as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asteby/storefront",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Typed client for the Storefront API v1 (catalog, cart, checkout, customer, content) using only global fetch — Node 20+, edge runtimes and browsers — plus an in-memory mock of the whole contract.",
   "license": "Apache-2.0",
   "repository": {
@@ -37,6 +37,16 @@
         "default": "./dist/mock.cjs"
       }
     },
+    "./geo": {
+      "import": {
+        "types": "./dist/geo.d.ts",
+        "default": "./dist/geo.js"
+      },
+      "require": {
+        "types": "./dist/geo.d.cts",
+        "default": "./dist/geo.cjs"
+      }
+    },
     "./package.json": "./package.json"
   },
   "sideEffects": false,