@asteby/storefront 0.7.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +30 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +34 -3
- package/dist/index.d.ts +34 -3
- package/dist/index.js +27 -1
- package/dist/index.js.map +1 -1
- package/dist/mock.cjs +5 -1
- package/dist/mock.cjs.map +1 -1
- package/dist/mock.d.cts +8 -1
- package/dist/mock.d.ts +8 -1
- package/dist/mock.js +5 -1
- package/dist/mock.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { GeoPoint } from './geo.cjs';
|
|
2
2
|
export { OpenStatus, OpeningHours } from './geo.cjs';
|
|
3
|
-
import { am as ProductSort, aB as Shop, ak as ProductConnection, ah as Product, x as Connection, w as Collection, S as LocationListParams, P as Location, Y as NearestLocation, aF as StockLevel, at as RestockSubscriptionInput, au as RestockSubscriptionResult, l as CartLineInput, C as Cart, o as CartLineUpdateInput, f as CartBuyerInput, a as AddressInput, H as DeliveryOptions, a9 as PaymentMethods, F as DeliveryInput, as as RecommendationPlacement, r as CartRecommendations, t as CheckoutInput, v as CheckoutResult, ar as PromotionsList, a6 as PaymentConfig, ae as PaymentSubmitInput, a2 as PaymentAttemptResult, z as CustomerIdentifier, D as CustomerSessionInput, B as CustomerSession, y as Customer, Z as Order, aw as ReturnRequestInput, av as ReturnRequest, N as InvoiceRequest, O as InvoiceResult, A as Address, aI as Theme, $ as Page, U as Menu, b as Article, aH as StorefrontErrorCode, M as InsufficientStockLine, W as Money, d as AvailabilityStatus, n as CartLineProblem, c as Availability, an as ProductVariant, E as DeclineCode, af as PaymentVoucher, aa as PaymentNextStep, p as CartPromotions, ap as PromotionReward } from './types-CSMuPSQA.cjs';
|
|
4
|
-
export { e as CartBuyer, g as CartCost, h as CartDelivery, i as CartDiscountCode, j as CartDiscountLine, k as CartLine, m as CartLineMerchandise, q as CartRecommendation, s as CheckoutInfo, u as CheckoutPayment,
|
|
3
|
+
import { am as ProductSort, aB as Shop, ak as ProductConnection, ah as Product, x as Connection, w as Collection, S as LocationListParams, P as Location, Y as NearestLocation, aF as StockLevel, at as RestockSubscriptionInput, au as RestockSubscriptionResult, l as CartLineInput, C as Cart, o as CartLineUpdateInput, f as CartBuyerInput, a as AddressInput, H as DeliveryOptions, a9 as PaymentMethods, F as DeliveryInput, as as RecommendationPlacement, r as CartRecommendations, t as CheckoutInput, v as CheckoutResult, ar as PromotionsList, a6 as PaymentConfig, ae as PaymentSubmitInput, a2 as PaymentAttemptResult, z as CustomerIdentifier, D as CustomerSessionInput, B as CustomerSession, y as Customer, Z as Order, aw as ReturnRequestInput, av as ReturnRequest, N as InvoiceRequest, O as InvoiceResult, A as Address, aI as Theme, $ as Page, U as Menu, b as Article, aH as StorefrontErrorCode, M as InsufficientStockLine, W as Money, d as AvailabilityStatus, n as CartLineProblem, c as Availability, an as ProductVariant, E as DeclineCode, af as PaymentVoucher, aa as PaymentNextStep, p as CartPromotions, ap as PromotionReward, G as DeliveryMethod, aJ as UnavailableRateProvider } from './types-CSMuPSQA.cjs';
|
|
4
|
+
export { e as CartBuyer, g as CartCost, h as CartDelivery, i as CartDiscountCode, j as CartDiscountLine, k as CartLine, m as CartLineMerchandise, q as CartRecommendation, s as CheckoutInfo, u as CheckoutPayment, I as Facet, J as FacetValue, K as Image, L as InsufficientStockDetails, Q as LocationContacts, R as LocationKind, T as LocationPickup, V as MenuItem, X as MoneyRange, _ as OrderLine, a0 as PageInfo, a1 as PaymentAction, a3 as PaymentAttemptStatus, a4 as PaymentClient, a5 as PaymentClientCsp, a7 as PaymentFlow, a8 as PaymentMethod, ab as PaymentOption, ac as PaymentOptionKey, ad as PaymentPoint, ag as PickupOption, ai as ProductAttributeValue, aj as ProductCategory, al as ProductOption, ao as PromotionAnnouncement, aq as PromotionTier, ax as SEO, ay as Section, az as SelectedOption, aA as ShippingRate, aC as ShopBranch, aD as ShopContact, aE as ShopPolicies, aG as StorefrontErrorBody } from './types-CSMuPSQA.cjs';
|
|
5
5
|
|
|
6
6
|
type QueryValue = string | number | boolean | null | undefined;
|
|
7
7
|
type QueryParams = Record<string, QueryValue | QueryValue[]>;
|
|
@@ -646,4 +646,35 @@ declare function hreflangLinks(markets: MarketInfo[], path: string, defaultMarke
|
|
|
646
646
|
href: string;
|
|
647
647
|
}[];
|
|
648
648
|
|
|
649
|
-
|
|
649
|
+
/** Kind of a delivery radio: `ship` (address only, quote later), `rate` (a quoted rate) or `pickup` (a branch). */
|
|
650
|
+
type DeliveryChoiceKind = 'ship' | 'rate' | 'pickup';
|
|
651
|
+
type DeliveryChoice = {
|
|
652
|
+
kind: DeliveryChoiceKind;
|
|
653
|
+
/** Everything after the first `:` — a rate id may contain more colons (`rate:skydropx:<id>`). */
|
|
654
|
+
id: string;
|
|
655
|
+
method: DeliveryMethod;
|
|
656
|
+
/** `ship:` — only the address is saved; the rate is picked on the next pass. */
|
|
657
|
+
addressOnly: boolean;
|
|
658
|
+
};
|
|
659
|
+
/**
|
|
660
|
+
* Parses the value of the single delivery radio group: `ship:`, `rate:<id>` or `pickup:<branch>`.
|
|
661
|
+
* Splits on the FIRST colon only, so ids like `skydropx:<id>` survive intact (`split(':', 2)` would
|
|
662
|
+
* silently drop everything after the second colon). Anything unknown is treated as `rate`.
|
|
663
|
+
*/
|
|
664
|
+
declare function parseDelivery(value: string | null | undefined): DeliveryChoice;
|
|
665
|
+
/** The `setDelivery` payload for a choice; `null` when it only saves the address (`ship:`). */
|
|
666
|
+
declare function deliveryInput(choice: DeliveryChoice): DeliveryInput | null;
|
|
667
|
+
/** Reason code a rate provider reports when the cart has items without weight. */
|
|
668
|
+
declare const MISSING_WEIGHT = "missing_weight";
|
|
669
|
+
type DeliveryNotices = {
|
|
670
|
+
/** Providers that could not quote because some item has no weight. */
|
|
671
|
+
missingWeight: UnavailableRateProvider[];
|
|
672
|
+
/** Providers that failed for any other reason (timeouts, errors). */
|
|
673
|
+
unavailable: UnavailableRateProvider[];
|
|
674
|
+
/** `true` when the shopper should be told something is off with the quote. */
|
|
675
|
+
hasNotices: boolean;
|
|
676
|
+
};
|
|
677
|
+
/** Splits `delivery.unavailable` into the `missing_weight` notice and the generic one. */
|
|
678
|
+
declare function deliveryNotices(delivery: Pick<DeliveryOptions, 'unavailable' | 'partial'> | null | undefined): DeliveryNotices;
|
|
679
|
+
|
|
680
|
+
export { Address, AddressInput, Article, type ArticleListParams, Availability, type AvailabilityLocale, type AvailabilityMessageKey, type AvailabilityMessages, AvailabilityStatus, type AvailabilityTone, type AvailabilityView, type AvailabilityViewOptions, CLIENT_IP_HEADER, COUNTRY_HEADERS, Cart, CartBuyerInput, CartLineInput, CartLineProblem, type CartLineProblemView, CartLineUpdateInput, CartPromotions, CartRecommendations, CheckoutInput, CheckoutResult, Collection, type CollectionListParams, Connection, Customer, CustomerIdentifier, CustomerSession, CustomerSessionInput, DeclineCode, type DeliveryChoice, type DeliveryChoiceKind, DeliveryInput, DeliveryMethod, type DeliveryNotices, DeliveryOptions, type DiscountBarState, type DiscountBarView, type FetchLike, type FormatMoneyOptions, GeoPoint, InsufficientStockLine, InvoiceRequest, InvoiceResult, Location, LocationListParams, MISSING_WEIGHT, type MarketInfo, type MarketSuggestion, Menu, Money, NOTE_MAX_LENGTH, NearestLocation, Order, Page, type PaginationParams, PaymentAttemptResult, PaymentConfig, type PaymentErrorKind, type PaymentErrorView, type PaymentLocale, type PaymentMessageKey, type PaymentMessages, PaymentMethods, PaymentNextStep, type PaymentOutcome, type PaymentOutcomeKind, PaymentSubmitInput, PaymentVoucher, type PreviewOptions, Product, ProductConnection, type ProductListParams, ProductSort, ProductVariant, type PromoProgressView, type PromotionLocale, type PromotionMessageKey, type PromotionMessages, PromotionReward, PromotionsList, type QueryParams, type QueryValue, RecommendationPlacement, type RequestOptions, type ResolveAvailabilityOptions, RestockSubscriptionInput, RestockSubscriptionResult, ReturnRequest, ReturnRequestInput, type ShippingBarState, type ShippingBarView, Shop, StockLevel, type StorefrontClient, type StorefrontClientOptions, StorefrontError, StorefrontErrorCode, type StorefrontErrorInit, type StorefrontRequestContext, type StorefrontResponseContext, Theme, UnavailableRateProvider, type WriteOptions, appendParams, availabilityLocale, availabilityMessages, availabilityView, cartLineProblemView, clampPercent, createStorefrontClient, declineMessage, declineMessageKey, deliveryInput, deliveryNotices, formatAvailabilityMessage, formatMoney, formatVoucherExpiry, generateIdempotencyKey, hreflangLinks, isStorefrontError, isTokenPublishable, negotiateLocale, normalizeClientIp, normalizeNote, parseDelivery, parseMoney, parseProductFilters, paymentErrorView, paymentIdempotencyKey, paymentMessages, paymentOutcome, preferredLanguages, productAvailability, productListQuery, promoProgressView, promotionMessages, resolveAvailability, rewardLabel, safeHttpsUrl, schemaAvailability, storefrontDomainHeader, suggestMarket, toMoney, visitorCountry };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { GeoPoint } from './geo.js';
|
|
2
2
|
export { OpenStatus, OpeningHours } from './geo.js';
|
|
3
|
-
import { am as ProductSort, aB as Shop, ak as ProductConnection, ah as Product, x as Connection, w as Collection, S as LocationListParams, P as Location, Y as NearestLocation, aF as StockLevel, at as RestockSubscriptionInput, au as RestockSubscriptionResult, l as CartLineInput, C as Cart, o as CartLineUpdateInput, f as CartBuyerInput, a as AddressInput, H as DeliveryOptions, a9 as PaymentMethods, F as DeliveryInput, as as RecommendationPlacement, r as CartRecommendations, t as CheckoutInput, v as CheckoutResult, ar as PromotionsList, a6 as PaymentConfig, ae as PaymentSubmitInput, a2 as PaymentAttemptResult, z as CustomerIdentifier, D as CustomerSessionInput, B as CustomerSession, y as Customer, Z as Order, aw as ReturnRequestInput, av as ReturnRequest, N as InvoiceRequest, O as InvoiceResult, A as Address, aI as Theme, $ as Page, U as Menu, b as Article, aH as StorefrontErrorCode, M as InsufficientStockLine, W as Money, d as AvailabilityStatus, n as CartLineProblem, c as Availability, an as ProductVariant, E as DeclineCode, af as PaymentVoucher, aa as PaymentNextStep, p as CartPromotions, ap as PromotionReward } from './types-iGGZ9EiC.js';
|
|
4
|
-
export { e as CartBuyer, g as CartCost, h as CartDelivery, i as CartDiscountCode, j as CartDiscountLine, k as CartLine, m as CartLineMerchandise, q as CartRecommendation, s as CheckoutInfo, u as CheckoutPayment,
|
|
3
|
+
import { am as ProductSort, aB as Shop, ak as ProductConnection, ah as Product, x as Connection, w as Collection, S as LocationListParams, P as Location, Y as NearestLocation, aF as StockLevel, at as RestockSubscriptionInput, au as RestockSubscriptionResult, l as CartLineInput, C as Cart, o as CartLineUpdateInput, f as CartBuyerInput, a as AddressInput, H as DeliveryOptions, a9 as PaymentMethods, F as DeliveryInput, as as RecommendationPlacement, r as CartRecommendations, t as CheckoutInput, v as CheckoutResult, ar as PromotionsList, a6 as PaymentConfig, ae as PaymentSubmitInput, a2 as PaymentAttemptResult, z as CustomerIdentifier, D as CustomerSessionInput, B as CustomerSession, y as Customer, Z as Order, aw as ReturnRequestInput, av as ReturnRequest, N as InvoiceRequest, O as InvoiceResult, A as Address, aI as Theme, $ as Page, U as Menu, b as Article, aH as StorefrontErrorCode, M as InsufficientStockLine, W as Money, d as AvailabilityStatus, n as CartLineProblem, c as Availability, an as ProductVariant, E as DeclineCode, af as PaymentVoucher, aa as PaymentNextStep, p as CartPromotions, ap as PromotionReward, G as DeliveryMethod, aJ as UnavailableRateProvider } from './types-iGGZ9EiC.js';
|
|
4
|
+
export { e as CartBuyer, g as CartCost, h as CartDelivery, i as CartDiscountCode, j as CartDiscountLine, k as CartLine, m as CartLineMerchandise, q as CartRecommendation, s as CheckoutInfo, u as CheckoutPayment, I as Facet, J as FacetValue, K as Image, L as InsufficientStockDetails, Q as LocationContacts, R as LocationKind, T as LocationPickup, V as MenuItem, X as MoneyRange, _ as OrderLine, a0 as PageInfo, a1 as PaymentAction, a3 as PaymentAttemptStatus, a4 as PaymentClient, a5 as PaymentClientCsp, a7 as PaymentFlow, a8 as PaymentMethod, ab as PaymentOption, ac as PaymentOptionKey, ad as PaymentPoint, ag as PickupOption, ai as ProductAttributeValue, aj as ProductCategory, al as ProductOption, ao as PromotionAnnouncement, aq as PromotionTier, ax as SEO, ay as Section, az as SelectedOption, aA as ShippingRate, aC as ShopBranch, aD as ShopContact, aE as ShopPolicies, aG as StorefrontErrorBody } from './types-iGGZ9EiC.js';
|
|
5
5
|
|
|
6
6
|
type QueryValue = string | number | boolean | null | undefined;
|
|
7
7
|
type QueryParams = Record<string, QueryValue | QueryValue[]>;
|
|
@@ -646,4 +646,35 @@ declare function hreflangLinks(markets: MarketInfo[], path: string, defaultMarke
|
|
|
646
646
|
href: string;
|
|
647
647
|
}[];
|
|
648
648
|
|
|
649
|
-
|
|
649
|
+
/** Kind of a delivery radio: `ship` (address only, quote later), `rate` (a quoted rate) or `pickup` (a branch). */
|
|
650
|
+
type DeliveryChoiceKind = 'ship' | 'rate' | 'pickup';
|
|
651
|
+
type DeliveryChoice = {
|
|
652
|
+
kind: DeliveryChoiceKind;
|
|
653
|
+
/** Everything after the first `:` — a rate id may contain more colons (`rate:skydropx:<id>`). */
|
|
654
|
+
id: string;
|
|
655
|
+
method: DeliveryMethod;
|
|
656
|
+
/** `ship:` — only the address is saved; the rate is picked on the next pass. */
|
|
657
|
+
addressOnly: boolean;
|
|
658
|
+
};
|
|
659
|
+
/**
|
|
660
|
+
* Parses the value of the single delivery radio group: `ship:`, `rate:<id>` or `pickup:<branch>`.
|
|
661
|
+
* Splits on the FIRST colon only, so ids like `skydropx:<id>` survive intact (`split(':', 2)` would
|
|
662
|
+
* silently drop everything after the second colon). Anything unknown is treated as `rate`.
|
|
663
|
+
*/
|
|
664
|
+
declare function parseDelivery(value: string | null | undefined): DeliveryChoice;
|
|
665
|
+
/** The `setDelivery` payload for a choice; `null` when it only saves the address (`ship:`). */
|
|
666
|
+
declare function deliveryInput(choice: DeliveryChoice): DeliveryInput | null;
|
|
667
|
+
/** Reason code a rate provider reports when the cart has items without weight. */
|
|
668
|
+
declare const MISSING_WEIGHT = "missing_weight";
|
|
669
|
+
type DeliveryNotices = {
|
|
670
|
+
/** Providers that could not quote because some item has no weight. */
|
|
671
|
+
missingWeight: UnavailableRateProvider[];
|
|
672
|
+
/** Providers that failed for any other reason (timeouts, errors). */
|
|
673
|
+
unavailable: UnavailableRateProvider[];
|
|
674
|
+
/** `true` when the shopper should be told something is off with the quote. */
|
|
675
|
+
hasNotices: boolean;
|
|
676
|
+
};
|
|
677
|
+
/** Splits `delivery.unavailable` into the `missing_weight` notice and the generic one. */
|
|
678
|
+
declare function deliveryNotices(delivery: Pick<DeliveryOptions, 'unavailable' | 'partial'> | null | undefined): DeliveryNotices;
|
|
679
|
+
|
|
680
|
+
export { Address, AddressInput, Article, type ArticleListParams, Availability, type AvailabilityLocale, type AvailabilityMessageKey, type AvailabilityMessages, AvailabilityStatus, type AvailabilityTone, type AvailabilityView, type AvailabilityViewOptions, CLIENT_IP_HEADER, COUNTRY_HEADERS, Cart, CartBuyerInput, CartLineInput, CartLineProblem, type CartLineProblemView, CartLineUpdateInput, CartPromotions, CartRecommendations, CheckoutInput, CheckoutResult, Collection, type CollectionListParams, Connection, Customer, CustomerIdentifier, CustomerSession, CustomerSessionInput, DeclineCode, type DeliveryChoice, type DeliveryChoiceKind, DeliveryInput, DeliveryMethod, type DeliveryNotices, DeliveryOptions, type DiscountBarState, type DiscountBarView, type FetchLike, type FormatMoneyOptions, GeoPoint, InsufficientStockLine, InvoiceRequest, InvoiceResult, Location, LocationListParams, MISSING_WEIGHT, type MarketInfo, type MarketSuggestion, Menu, Money, NOTE_MAX_LENGTH, NearestLocation, Order, Page, type PaginationParams, PaymentAttemptResult, PaymentConfig, type PaymentErrorKind, type PaymentErrorView, type PaymentLocale, type PaymentMessageKey, type PaymentMessages, PaymentMethods, PaymentNextStep, type PaymentOutcome, type PaymentOutcomeKind, PaymentSubmitInput, PaymentVoucher, type PreviewOptions, Product, ProductConnection, type ProductListParams, ProductSort, ProductVariant, type PromoProgressView, type PromotionLocale, type PromotionMessageKey, type PromotionMessages, PromotionReward, PromotionsList, type QueryParams, type QueryValue, RecommendationPlacement, type RequestOptions, type ResolveAvailabilityOptions, RestockSubscriptionInput, RestockSubscriptionResult, ReturnRequest, ReturnRequestInput, type ShippingBarState, type ShippingBarView, Shop, StockLevel, type StorefrontClient, type StorefrontClientOptions, StorefrontError, StorefrontErrorCode, type StorefrontErrorInit, type StorefrontRequestContext, type StorefrontResponseContext, Theme, UnavailableRateProvider, type WriteOptions, appendParams, availabilityLocale, availabilityMessages, availabilityView, cartLineProblemView, clampPercent, createStorefrontClient, declineMessage, declineMessageKey, deliveryInput, deliveryNotices, formatAvailabilityMessage, formatMoney, formatVoucherExpiry, generateIdempotencyKey, hreflangLinks, isStorefrontError, isTokenPublishable, negotiateLocale, normalizeClientIp, normalizeNote, parseDelivery, parseMoney, parseProductFilters, paymentErrorView, paymentIdempotencyKey, paymentMessages, paymentOutcome, preferredLanguages, productAvailability, productListQuery, promoProgressView, promotionMessages, resolveAvailability, rewardLabel, safeHttpsUrl, schemaAvailability, storefrontDomainHeader, suggestMarket, toMoney, visitorCountry };
|
package/dist/index.js
CHANGED
|
@@ -891,6 +891,32 @@ function hreflangLinks(markets, path, defaultMarket, protocol = "https") {
|
|
|
891
891
|
return links;
|
|
892
892
|
}
|
|
893
893
|
|
|
894
|
-
|
|
894
|
+
// src/delivery.ts
|
|
895
|
+
function parseDelivery(value) {
|
|
896
|
+
const raw = (value ?? "").trim();
|
|
897
|
+
const i = raw.indexOf(":");
|
|
898
|
+
const head = i === -1 ? raw : raw.slice(0, i);
|
|
899
|
+
const id = i === -1 ? "" : raw.slice(i + 1);
|
|
900
|
+
const kind = head === "pickup" ? "pickup" : head === "ship" ? "ship" : "rate";
|
|
901
|
+
return { kind, id, method: kind === "pickup" ? "pickup" : "shipping", addressOnly: kind === "ship" };
|
|
902
|
+
}
|
|
903
|
+
function deliveryInput(choice) {
|
|
904
|
+
if (choice.addressOnly) return null;
|
|
905
|
+
if (choice.kind === "pickup") return { method: "pickup", branch_id: choice.id };
|
|
906
|
+
return { method: "shipping", rate_id: choice.id || void 0 };
|
|
907
|
+
}
|
|
908
|
+
var MISSING_WEIGHT = "missing_weight";
|
|
909
|
+
function deliveryNotices(delivery) {
|
|
910
|
+
const all = delivery?.unavailable ?? [];
|
|
911
|
+
const missingWeight = all.filter((u) => u.code === MISSING_WEIGHT);
|
|
912
|
+
const unavailable = all.filter((u) => u.code !== MISSING_WEIGHT);
|
|
913
|
+
return {
|
|
914
|
+
missingWeight,
|
|
915
|
+
unavailable,
|
|
916
|
+
hasNotices: missingWeight.length > 0 || unavailable.length > 0 || delivery?.partial === true
|
|
917
|
+
};
|
|
918
|
+
}
|
|
919
|
+
|
|
920
|
+
export { CLIENT_IP_HEADER, COUNTRY_HEADERS, MISSING_WEIGHT, NOTE_MAX_LENGTH, StorefrontError, appendParams, clampPercent, createStorefrontClient, declineMessage, declineMessageKey, deliveryInput, deliveryNotices, formatMoney, formatVoucherExpiry, generateIdempotencyKey, hreflangLinks, isStorefrontError, isTokenPublishable, negotiateLocale, normalizeClientIp, normalizeNote, parseDelivery, parseMoney, parseProductFilters, paymentErrorView, paymentIdempotencyKey, paymentMessages, paymentOutcome, preferredLanguages, productListQuery, promoProgressView, promotionMessages, rewardLabel, safeHttpsUrl, storefrontDomainHeader, suggestMarket, toMoney, visitorCountry };
|
|
895
921
|
//# sourceMappingURL=index.js.map
|
|
896
922
|
//# sourceMappingURL=index.js.map
|