@asstio-dev/storefront 0.28.0 → 0.31.1

package/dist/seo/sitemap.d.ts

@@ -0,0 +1,44 @@
+import type { Client } from "openapi-fetch";
+import type { StorefrontPaths } from "../index.js";
+export type SitemapType = "product" | "collection" | "brand";
+export type SitemapUrl = {
+    url: string;
+    lastModified?: string;
+    alternates: {
+        hreflang: string;
+        href: string;
+    }[];
+};
+/** `complete: false` = the API was unavailable part-way (transport failure, a 5xx, `INDEX_UNAVAILABLE`,
+ * `SITE_REGISTRY_WARMING`); `entries` is what was read before that. `complete: true` means "walked to exhaustion
+ * without an error" — a cursor walk is an eventually consistent crawl, not a snapshot. */
+export type SitemapResult = {
+    entries: SitemapUrl[];
+    complete: boolean;
+};
+/** Next.js `MetadataRoute.Sitemap` entry, structurally typed (no `next` dependency, like `toNextMetadata`). */
+export type NextSitemapEntry = {
+    url: string;
+    lastModified?: string;
+    alternates?: {
+        languages: Record<string, string>;
+    };
+};
+export interface SitemapOptions {
+    /** The market the client was created with (the same `X-Market`). Required: `/v1/site` answers the site's default market,
+     * not the request's, and a wrong market here would pair one market's URLs with another's hreflang. */
+    market: string;
+    /** Default: all three. */
+    types?: SitemapType[];
+    /** Items per request, 1–1000 (default 1000). */
+    pageSize?: number;
+}
+/**
+ * Every sitemap URL of one market: `GET /v1/site` once, then for each type a cursor walk of `GET /v1/sitemap` from
+ * `cursor=start` along `nextCursor`. hreflang tags are real BCP 47 tags (`sv-SE`, never the market code `se`), with a
+ * self-reference, and `x-default` only when the site's default market has the page. An epoch `updatedAt` (collections)
+ * is left out rather than printed as 1970.
+ */
+export declare function sitemapEntries(client: Client<StorefrontPaths>, opts: SitemapOptions): Promise<SitemapResult>;
+/** Next.js `app/sitemap.ts` shape: `alternates` → `{ languages: { [hreflang]: href } }`, `x-default` included. */
+export declare function toNextSitemap(r: SitemapResult): NextSitemapEntry[];

package/dist/seo/sitemap.js

@@ -0,0 +1,91 @@
+import { alternateSet } from "./shared.js";
+import { SeoError } from "./types.js";
+const ALL_TYPES = ["product", "collection", "brand"];
+const RETRYABLE = new Set(["INDEX_UNAVAILABLE", "SITE_REGISTRY_WARMING"]);
+/** The walk stops here, partial: the API is unavailable, not wrong. */
+const UNAVAILABLE = Symbol("unavailable");
+/**
+ * Every sitemap URL of one market: `GET /v1/site` once, then for each type a cursor walk of `GET /v1/sitemap` from
+ * `cursor=start` along `nextCursor`. hreflang tags are real BCP 47 tags (`sv-SE`, never the market code `se`), with a
+ * self-reference, and `x-default` only when the site's default market has the page. An epoch `updatedAt` (collections)
+ * is left out rather than printed as 1970.
+ */
+export async function sitemapEntries(client, opts) {
+    const entries = [];
+    const pageSize = opts.pageSize ?? 1000;
+    const site = await read(() => client.GET("/v1/site", {}));
+    if (site === UNAVAILABLE)
+        return { entries, complete: false };
+    // The API matches market codes case-insensitively; alternateSet does not, so the configured spelling is passed on.
+    const wanted = opts.market.toLowerCase();
+    const market = site.markets.find((m) => m.code.toLowerCase() === wanted)?.code;
+    if (market === undefined)
+        throw new SeoError(`market '${opts.market}' is not one of the site's markets (${site.markets.map((m) => m.code).join(", ")})`);
+    for (const type of opts.types ?? ALL_TYPES) {
+        let cursor = "start";
+        for (;;) {
+            const page = await read(() => client.GET("/v1/sitemap", { params: { query: { type, cursor, pageSize } } }));
+            if (page === UNAVAILABLE)
+                return { entries, complete: false };
+            // An API older than cursor paging ignores ?cursor= and answers one page without the field: that must never read as
+            // the end of the walk, or the sitemap would silently shrink to its first page.
+            if (!Object.hasOwn(page, "nextCursor"))
+                throw new Error("the Storefront API does not support sitemap cursors; deploy the API first");
+            for (const item of page.items)
+                entries.push(toSitemapUrl(site, market, item));
+            if (page.nextCursor === null)
+                break;
+            if (page.nextCursor === cursor)
+                throw new Error(`the Storefront API returned the same sitemap cursor twice (type=${type})`);
+            cursor = page.nextCursor;
+        }
+    }
+    return { entries, complete: true };
+}
+/** Next.js `app/sitemap.ts` shape: `alternates` → `{ languages: { [hreflang]: href } }`, `x-default` included. */
+export function toNextSitemap(r) {
+    return r.entries.map((e) => {
+        const out = { url: e.url };
+        if (e.lastModified !== undefined)
+            out.lastModified = e.lastModified;
+        if (e.alternates.length > 0)
+            out.alternates = { languages: Object.fromEntries(e.alternates.map((a) => [a.hreflang, a.href])) };
+        return out;
+    });
+}
+function toSitemapUrl(site, market, item) {
+    let alternates = [];
+    try {
+        alternates = alternateSet(site, market, item.url, item.alternateUrls).alternates;
+    }
+    catch (e) {
+        // Two markets mapping to one hreflang with different URLs is a site config fault: drop this entry's alternates, keep
+        // the URL. A config fault must not empty the sitemap.
+        if (!(e instanceof SeoError))
+            throw e;
+    }
+    const time = Date.parse(item.updatedAt);
+    return Number.isNaN(time) || time === 0 ? { url: item.url, alternates } : { url: item.url, lastModified: item.updatedAt, alternates };
+}
+/**
+ * One request. Decided on the status first: an empty-body 500 has no `error`, and an HTML 502 has a string one. A thrown
+ * request is a transport failure; the catch wraps the request only, never the mapping after it.
+ */
+async function read(request) {
+    let result;
+    try {
+        result = await request();
+    }
+    catch {
+        return UNAVAILABLE;
+    }
+    const { data, error, response } = result;
+    if (response.status >= 500)
+        return UNAVAILABLE;
+    const code = typeof error === "object" && error !== null && "code" in error && typeof error.code === "string" ? error.code : undefined;
+    if (code !== undefined && RETRYABLE.has(code))
+        return UNAVAILABLE;
+    if (!response.ok || data === undefined)
+        throw new Error(`Storefront API ${response.url} answered ${response.status}${code ? ` ${code}` : ""}`);
+    return data;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asstio-dev/storefront",
-  "version": "0.28.0",
+  "version": "0.31.1",
   "description": "Typed client for the Asstio Storefront API (generated from OpenAPI).",
   "repository": {
     "type": "git",
@@ -10,6 +10,25 @@
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./account": {
+      "types": "./dist/account/index.d.ts",
+      "default": "./dist/account/index.js"
+    },
+    "./account/browser": {
+      "types": "./dist/account/browser.d.ts",
+      "default": "./dist/account/browser.js"
+    },
+    "./account/next": {
+      "types": "./dist/account/next.d.ts",
+      "default": "./dist/account/next.js"
+    },
+    "./package.json": "./package.json"
+  },
   "files": [
     "dist",
     "src/schema.d.ts"
@@ -21,11 +40,20 @@
     "test": "vitest run",
     "test:browser": "playwright test -c browser/playwright.config.ts",
     "check": "npm run generate && npm run typecheck-examples && npm test && git diff --exit-code -- src/schema.d.ts && test -z \"$(git status --porcelain -- src/schema.d.ts)\"",
-    "smoke": "node --input-type=module -e \"import(\\\"./dist/index.js\\\").then(m => { for (const f of [\\\"createStorefrontClient\\\", \\\"filterQuery\\\", \\\"encodeFilterValues\\\", \\\"decodeFilterValues\\\", \\\"pictureSources\\\", \\\"mediaUrl\\\", \\\"formatImage\\\", \\\"styleToCss\\\", \\\"startCheckout\\\", \\\"syncCheckout\\\", \\\"completeCheckout\\\", \\\"getCheckoutStatus\\\", \\\"liveShippingFor\\\", \\\"getOrder\\\", \\\"awaitCompletion\\\", \\\"mountCheckout\\\", \\\"productJsonLd\\\", \\\"gtinJsonLd\\\", \\\"breadcrumbJsonLd\\\", \\\"productHead\\\", \\\"collectionHead\\\", \\\"brandHead\\\", \\\"toNextMetadata\\\", \\\"jsonLdScript\\\", \\\"SeoError\\\", \\\"productFacts\\\", \\\"toGa4Item\\\", \\\"toGa4Ecommerce\\\", \\\"longestCategory\\\", \\\"AnalyticsError\\\", \\\"trackSearchEvents\\\", \\\"variantUrl\\\", \\\"readVariantParam\\\", \\\"variantQueryForApi\\\", \\\"redirectTarget\\\"]) if (typeof m[f] !== \\\"function\\\") throw new Error(\\\"missing export \\\" + f) })\""
+    "smoke": "node --input-type=module -e \"import(\\\"./dist/index.js\\\").then(m => { for (const f of [\\\"createStorefrontClient\\\", \\\"filterQuery\\\", \\\"encodeFilterValues\\\", \\\"decodeFilterValues\\\", \\\"pictureSources\\\", \\\"mediaUrl\\\", \\\"formatImage\\\", \\\"styleToCss\\\", \\\"startCheckout\\\", \\\"syncCheckout\\\", \\\"completeCheckout\\\", \\\"getCheckoutStatus\\\", \\\"liveShippingFor\\\", \\\"getOrder\\\", \\\"awaitCompletion\\\", \\\"mountCheckout\\\", \\\"productJsonLd\\\", \\\"gtinJsonLd\\\", \\\"breadcrumbJsonLd\\\", \\\"productHead\\\", \\\"collectionHead\\\", \\\"brandHead\\\", \\\"toNextMetadata\\\", \\\"sitemapEntries\\\", \\\"toNextSitemap\\\", \\\"jsonLdScript\\\", \\\"SeoError\\\", \\\"productFacts\\\", \\\"toGa4Item\\\", \\\"toGa4Ecommerce\\\", \\\"longestCategory\\\", \\\"AnalyticsError\\\", \\\"trackSearchEvents\\\", \\\"variantUrl\\\", \\\"readVariantParam\\\", \\\"variantQueryForApi\\\", \\\"redirectTarget\\\"]) if (typeof m[f] !== \\\"function\\\") throw new Error(\\\"missing export \\\" + f) })\" && npm run smoke:account",
+    "smoke:account": "node --input-type=module -e \"const checks = { \\\"./dist/account/index.js\\\": [\\\"createShopperClient\\\", \\\"startSignIn\\\", \\\"verifySignIn\\\", \\\"signOut\\\", \\\"switchPrincipal\\\", \\\"getSession\\\", \\\"getMe\\\", \\\"getMyCompany\\\", \\\"linkChallengeId\\\", \\\"linkToken\\\", \\\"sessionCookie\\\", \\\"signInCookie\\\", \\\"cartCookie\\\", \\\"browserCartCookie\\\", \\\"copyBrowserCart\\\", \\\"CopyBrowserCartError\\\", \\\"cookieSecurity\\\", \\\"readSignInCookie\\\", \\\"serializeCookie\\\", \\\"shopperIpFrom\\\", \\\"assertSameOrigin\\\", \\\"safeReturnPath\\\", \\\"CrossOriginError\\\"], \\\"./dist/account/browser.js\\\": [\\\"readLinkFragment\\\"], \\\"./dist/account/next.js\\\": [\\\"startSignInAction\\\", \\\"verifySignInAction\\\", \\\"signOutAction\\\", \\\"switchPrincipalAction\\\", \\\"shopperClient\\\", \\\"copyBrowserCartAction\\\"] }; for (const [file, names] of Object.entries(checks)) { const m = await import(file); for (const f of names) if (typeof m[f] !== \\\"function\\\") throw new Error(\\\"missing export \\\" + f + \\\" in \\\" + file); }\""
   },
   "dependencies": {
     "openapi-fetch": "0.17.0"
   },
+  "peerDependencies": {
+    "next": ">=15"
+  },
+  "peerDependenciesMeta": {
+    "next": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@playwright/test": "1.63.0",
     "@types/react": "19.3.0",