@asteby/storefront 0.24.0 → 0.25.0

package/dist/index.js

@@ -36,6 +36,15 @@ function isTokenPublishable(token) {
 }
 
 // src/query.ts
+function accountListQuery(params) {
+  if (!params) return void 0;
+  const out = {};
+  for (const [key, value] of Object.entries(params)) {
+    if (value === void 0 || value === null || value === "") continue;
+    out[key] = value;
+  }
+  return out;
+}
 function appendParams(search, params) {
   if (!params) return search;
   for (const [key, raw] of Object.entries(params)) {
@@ -493,7 +502,50 @@ function createStorefrontClient(config) {
        * repeat after success is also fine. Afterwards the token is dead: drop it.
        */
       deleteAccount: (input, options) => write("DELETE", "/storefront/customer", input, options),
-      orders: (params, options) => get("/storefront/customer/orders", params, options),
+      /**
+       * The buyer's orders, newest first. Callable as before (`orders({ first })`) and, since contract 1.19, with
+       * `orders.list({ first, after, before, status, delivery_method, has_invoice, from, to, q })`: cursor paging
+       * (keyset, stable while new orders arrive), `page_info.start_cursor` / `has_previous_page` to go back, and
+       * `total_count` when it is cheap to know. An OPS older than 1.19 ignores the new parameters.
+       */
+      orders: Object.assign(
+        (params, options) => get("/storefront/customer/orders", params, options),
+        {
+          list: (params, options) => get("/storefront/customer/orders", accountListQuery(params), { ...options, cache: "no-store" })
+        }
+      ),
+      /**
+       * The buyer's invoices, one node per order that has them (`{ order, invoices }`), cursor-paged like `orders.list`.
+       * It replaces opening the detail of every order. An OPS older than 1.19 (no such route) is served from one page of
+       * orders and their details, so the account keeps working until the addon is updated.
+       */
+      invoices: {
+        list: async (params, options) => {
+          const page = await getOrNull("/storefront/customer/invoices", accountListQuery(params), { ...options, cache: "no-store" });
+          return page ?? legacyAccountList(client, params, options, (o) => o.invoice ? !["not_requested", "awaiting_payment", "window_closed"].includes(o.invoice.stage ?? "not_requested") : true, (o) => (o.invoices ?? []).length ? { order: orderRef(o), invoices: o.invoices ?? [] } : null);
+        }
+      },
+      /**
+       * The buyer's shipments, one node per delivered order with its service and parcels (`{ order, stage, service,
+       * shipments }`), cursor-paged like `orders.list`, without tracking events or map (those come with `order(id)`).
+       * An OPS older than 1.19 is served from one page of orders and their details.
+       */
+      shipments: {
+        list: async (params, options) => {
+          const page = await getOrNull("/storefront/customer/shipments", accountListQuery(params), { ...options, cache: "no-store" });
+          return page ?? legacyAccountList(
+            client,
+            params,
+            options,
+            (o) => o.delivery_method !== "pickup" && !["cancelled", "refunded", "pending_payment"].includes(o.status),
+            (o) => {
+              const service = o.shipping_service ?? null;
+              const shipments = o.shipments ?? [];
+              return service || shipments.length ? { order: orderRef(o), stage: o.progress?.stage ?? o.status, service, shipments } : null;
+            }
+          );
+        }
+      },
       /** `null` when the order does not exist or belongs to someone else. */
       order: (id, options) => getOrNull(`/storefront/customer/orders/${enc(id)}`, void 0, options),
       requestReturn: (orderId, input, options) => write("POST", `/storefront/customer/orders/${enc(orderId)}/returns`, input, options),
@@ -581,6 +633,20 @@ function createStorefrontClient(config) {
   };
   return client;
 }
+var orderRef = (o) => ({ id: o.id, number: o.number, created_at: o.created_at });
+async function legacyAccountList(client, params, options, keep, toNode) {
+  const page = await client.customer.orders.list({ ...params?.first ? { first: params.first } : {}, ...params?.after ? { after: params.after } : {}, ...params?.from ? { from: params.from } : {}, ...params?.to ? { to: params.to } : {}, ...params?.q ? { q: params.q } : {} }, options);
+  const details = await Promise.all(
+    page.nodes.filter(keep).map(
+      (o) => client.customer.order(o.id, options).catch((err) => {
+        if (err instanceof StorefrontError && err.status === 401) throw err;
+        return null;
+      })
+    )
+  );
+  const nodes = details.map((d) => d ? toNode(d) : null).filter((n) => n !== null);
+  return { nodes, page_info: { has_next_page: page.page_info.has_next_page, end_cursor: page.page_info.end_cursor } };
+}
 function storefrontDomainHeader(domain, market) {
   const host = domain.trim();
   const code = (market ?? "").trim().toLowerCase();
@@ -983,6 +1049,131 @@ function deliveryNotices(delivery) {
   };
 }
 
-export { CLIENT_IP_HEADER, COUNTRY_HEADERS, MISSING_WEIGHT, NOTE_MAX_LENGTH, PAYMENT_CHOICE_REFUSED_FIELD, appendParams, clampPercent, classifyPaymentError, createStorefrontClient, dataExportBytes, deliveryInput, deliveryNotices, diagnose, formatMoney, generateIdempotencyKey, groupInvoiceDocs, hreflangLinks, invoiceFileBytes, isAccountDeleteBlocked, isReauthRequired, isTokenPublishable, maskToken, negotiateLocale, normalizeClientIp, normalizeNote, opsSaysNotRetryable, parseDelivery, parseMoney, parseProductFilters, preferredLanguages, productListQuery, promoProgressView, promotionMessages, repairPath, rewardLabel, safeExportFilename, safeInvoiceFilename, storefrontDomainHeader, suggestMarket, toMoney, visitorCountry };
+// src/account-lists.ts
+var LIST_URL_ES = {
+  after: "despues",
+  before: "antes",
+  pos: "pos",
+  status: "estado",
+  delivery: "entrega",
+  invoice: "factura",
+  from: "desde",
+  to: "hasta",
+  q: "q",
+  deliveryValues: { shipping: "envio", pickup: "recoger" },
+  invoiceValues: { yes: "si", no: "no" }
+};
+var LIST_URL_EN = {
+  after: "after",
+  before: "before",
+  pos: "pos",
+  status: "status",
+  delivery: "delivery",
+  invoice: "invoice",
+  from: "from",
+  to: "to",
+  q: "q",
+  deliveryValues: { shipping: "shipping", pickup: "pickup" },
+  invoiceValues: { yes: "yes", no: "no" }
+};
+var CURSOR = /^[A-Za-z0-9_-]{1,300}$/;
+var DAY = /^\d{4}-\d{2}-\d{2}$/;
+var STATUS = /^[a-z_]{1,32}$/;
+var MAX_Q = 64;
+var MAX_POS = 1e6;
+var asParams = (search) => search instanceof URLSearchParams ? search : new URLSearchParams(typeof search === "string" ? search : "");
+var validDay = (v) => {
+  if (!v || !DAY.test(v)) return void 0;
+  const d = /* @__PURE__ */ new Date(`${v}T00:00:00Z`);
+  return Number.isNaN(d.getTime()) || d.toISOString().slice(0, 10) !== v ? void 0 : v;
+};
+function readListQuery(search, names = LIST_URL_ES) {
+  const p = asParams(search);
+  const out = {};
+  const after = p.get(names.after);
+  const before = p.get(names.before);
+  if (after && CURSOR.test(after)) out.after = after;
+  else if (before && CURSOR.test(before)) out.before = before;
+  const pos = Number(p.get(names.pos));
+  if (Number.isInteger(pos) && pos >= 1 && pos <= MAX_POS) out.pos = pos;
+  const status = p.get(names.status);
+  if (status && STATUS.test(status)) out.status = status;
+  const delivery = p.get(names.delivery);
+  if (delivery === names.deliveryValues.shipping) out.delivery = "shipping";
+  else if (delivery === names.deliveryValues.pickup) out.delivery = "pickup";
+  const invoice = p.get(names.invoice);
+  if (invoice === names.invoiceValues.yes) out.invoice = true;
+  else if (invoice === names.invoiceValues.no) out.invoice = false;
+  const from = validDay(p.get(names.from));
+  const to = validDay(p.get(names.to));
+  if (from) out.from = from;
+  if (to && (!from || to >= from)) out.to = to;
+  const q = (p.get(names.q) ?? "").trim().replace(/^#/, "").trim();
+  if (q && q.length <= MAX_Q) out.q = q;
+  return out;
+}
+function isFiltered(query) {
+  return !!(query.status || query.delivery || query.invoice !== void 0 || query.from || query.to || query.q);
+}
+function firstPageQuery(query) {
+  const { after: _a, before: _b, pos: _p, ...filters } = query;
+  return filters;
+}
+function listApiParams(query, first) {
+  const params = { first };
+  if (query.after) params.after = query.after;
+  else if (query.before) params.before = query.before;
+  if (query.status) params.status = query.status;
+  if (query.delivery) params.delivery_method = query.delivery;
+  if (query.invoice !== void 0) params.has_invoice = query.invoice;
+  if (query.from) params.from = query.from;
+  if (query.to) params.to = query.to;
+  if (query.q) params.q = query.q;
+  return params;
+}
+function listQueryString(query, names = LIST_URL_ES) {
+  const p = new URLSearchParams();
+  if (query.after) p.set(names.after, query.after);
+  else if (query.before) p.set(names.before, query.before);
+  if (query.pos && query.pos > 1) p.set(names.pos, String(query.pos));
+  if (query.status) p.set(names.status, query.status);
+  if (query.delivery) p.set(names.delivery, names.deliveryValues[query.delivery]);
+  if (query.invoice !== void 0) p.set(names.invoice, query.invoice ? names.invoiceValues.yes : names.invoiceValues.no);
+  if (query.from) p.set(names.from, query.from);
+  if (query.to) p.set(names.to, query.to);
+  if (query.q) p.set(names.q, query.q);
+  const s = p.toString();
+  return s ? `?${s}` : "";
+}
+var listHref = (path, query, names = LIST_URL_ES) => `${path}${listQueryString(query, names)}`;
+function pagePosition({ query, pageInfo, count }) {
+  if (count === 0) return void 0;
+  if (!query.after && !query.before) return 1;
+  if (pageInfo && pageInfo.has_previous_page === false) return 1;
+  return query.pos;
+}
+function nextPageQuery(state) {
+  const { query, pageInfo, count } = state;
+  if (!pageInfo?.has_next_page || !pageInfo.end_cursor) return null;
+  const here = pagePosition(state);
+  return { ...firstPageQuery(query), after: pageInfo.end_cursor, ...here ? { pos: here + count } : {} };
+}
+function previousPageQuery(state) {
+  const { query, pageInfo, first } = state;
+  if (!query.after && !query.before) return null;
+  if (pageInfo?.has_previous_page === false) return firstPageQuery(query);
+  const cursor = pageInfo?.start_cursor;
+  if (!cursor) return query.after || query.before ? firstPageQuery(query) : null;
+  const here = pagePosition(state);
+  if (here !== void 0 && here - first <= 1) return firstPageQuery(query);
+  return { ...firstPageQuery(query), before: cursor, ...here ? { pos: Math.max(1, here - first) } : {} };
+}
+function pageRange(state) {
+  const from = pagePosition(state);
+  if (!from || state.count === 0) return null;
+  return { from, to: from + state.count - 1, total: typeof state.total === "number" && state.total >= 0 ? state.total : null };
+}
+
+export { CLIENT_IP_HEADER, COUNTRY_HEADERS, LIST_URL_EN, LIST_URL_ES, MISSING_WEIGHT, NOTE_MAX_LENGTH, PAYMENT_CHOICE_REFUSED_FIELD, accountListQuery, appendParams, clampPercent, classifyPaymentError, createStorefrontClient, dataExportBytes, deliveryInput, deliveryNotices, diagnose, firstPageQuery, formatMoney, generateIdempotencyKey, groupInvoiceDocs, hreflangLinks, invoiceFileBytes, isAccountDeleteBlocked, isFiltered, isReauthRequired, isTokenPublishable, listApiParams, listHref, listQueryString, maskToken, negotiateLocale, nextPageQuery, normalizeClientIp, normalizeNote, opsSaysNotRetryable, pagePosition, pageRange, parseDelivery, parseMoney, parseProductFilters, preferredLanguages, previousPageQuery, productListQuery, promoProgressView, promotionMessages, readListQuery, repairPath, rewardLabel, safeExportFilename, safeInvoiceFilename, storefrontDomainHeader, suggestMarket, toMoney, visitorCountry };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map