@cobrastyle/adapter-magento2 1.0.1

package/dist/store-config.d.ts

@@ -0,0 +1,42 @@
+export interface MagentoStoreConfig {
+    rootCategoryId: number;
+    rootCategoryUid: string;
+    storeCode: string;
+    storeName: string;
+    baseCurrencyCode: string;
+    defaultDisplayCurrencyCode: string;
+    locale: string;
+    timezone: string;
+    /** Suffix Magento appends to category URLs (e.g. ".html"; "" when disabled). */
+    categoryUrlSuffix: string;
+    /** Suffix Magento appends to product URLs (e.g. ".html"; "" when disabled). */
+    productUrlSuffix: string;
+    /** Magento "Add Store Code to URLs" (web/url/use_store). */
+    useStoreInUrl: boolean;
+    /**
+     * Identifier of the CMS page configured as the store home page
+     * (web/default/cms_home_page). Undefined when not set.
+     */
+    homePageIdentifier?: string;
+    /**
+     * Identifier of the CMS page configured as the 404 / no-route page
+     * (web/default/cms_no_route). Undefined when not set.
+     */
+    notFoundPageIdentifier?: string;
+    /** Default SEO title (design/head/default_title). */
+    defaultTitle?: string;
+    /** Default SEO meta description (design/head/default_description). */
+    defaultDescription?: string;
+    /** Default SEO meta keywords (design/head/default_keywords). */
+    defaultKeywords?: string;
+    /** Prefix prepended to page titles (design/head/title_prefix). */
+    titlePrefix?: string;
+    /** Suffix appended to page titles (design/head/title_suffix). */
+    titleSuffix?: string;
+    /** Separator between title parts (catalog/seo/title_separator). */
+    titleSeparator?: string;
+}
+/** Store config for the current request's store code, cached per code. */
+export declare function getStoreConfig(): Promise<MagentoStoreConfig>;
+/** Clear the per-store config cache (tests / after config changes). */
+export declare function clearStoreConfigCache(): void;

package/dist/store-config.js

@@ -0,0 +1,59 @@
+import { graphqlFetch } from "./client";
+import { getConfig } from "./config";
+import * as queries from "./queries";
+const cache = new Map();
+const inflight = new Map();
+function currentStoreCode() {
+    const config = getConfig();
+    let resolved;
+    try {
+        resolved = config.storeResolver?.();
+    }
+    catch {
+        resolved = undefined;
+    }
+    return resolved || config.storeCode || "default";
+}
+/** Store config for the current request's store code, cached per code. */
+export async function getStoreConfig() {
+    const code = currentStoreCode();
+    const cached = cache.get(code);
+    if (cached)
+        return cached;
+    const existing = inflight.get(code);
+    if (existing)
+        return existing;
+    const promise = (async () => {
+        const data = await graphqlFetch(queries.GET_STORE_CONFIG, undefined, { storeCode: code });
+        const mapped = {
+            rootCategoryId: data.storeConfig.root_category_id,
+            rootCategoryUid: data.storeConfig.root_category_uid,
+            storeCode: data.storeConfig.store_code,
+            storeName: data.storeConfig.store_name,
+            baseCurrencyCode: data.storeConfig.base_currency_code,
+            defaultDisplayCurrencyCode: data.storeConfig.default_display_currency_code,
+            locale: data.storeConfig.locale,
+            timezone: data.storeConfig.timezone,
+            categoryUrlSuffix: data.storeConfig.category_url_suffix ?? "",
+            productUrlSuffix: data.storeConfig.product_url_suffix ?? "",
+            useStoreInUrl: data.storeConfig.use_store_in_url === true,
+            homePageIdentifier: data.storeConfig.cms_home_page || undefined,
+            notFoundPageIdentifier: data.storeConfig.cms_no_route || undefined,
+            defaultTitle: data.storeConfig.default_title || undefined,
+            defaultDescription: data.storeConfig.default_description || undefined,
+            defaultKeywords: data.storeConfig.default_keywords || undefined,
+            titlePrefix: data.storeConfig.title_prefix || undefined,
+            titleSuffix: data.storeConfig.title_suffix || undefined,
+            titleSeparator: data.storeConfig.title_separator || undefined,
+        };
+        cache.set(code, mapped);
+        return mapped;
+    })().finally(() => inflight.delete(code));
+    inflight.set(code, promise);
+    return promise;
+}
+/** Clear the per-store config cache (tests / after config changes). */
+export function clearStoreConfigCache() {
+    cache.clear();
+    inflight.clear();
+}

package/dist/stores.d.ts

@@ -0,0 +1,10 @@
+import type { StoreView } from "@cobrastyle/shared-types";
+/** Map a raw Magento `availableStores` entry to a StoreView. */
+export declare function mapStoreView(raw: any): StoreView;
+/**
+ * All store views, fetched once and cached for the process lifetime (the store
+ * list is static config). Returns [] on failure without caching the failure.
+ */
+export declare function getStores(): Promise<StoreView[]>;
+/** Clear the store registry cache (tests / after config changes). */
+export declare function clearStoresCache(): void;

package/dist/stores.js

@@ -0,0 +1,46 @@
+import { graphqlFetch } from "./client";
+import * as queries from "./queries";
+/** Map a raw Magento `availableStores` entry to a StoreView. */
+export function mapStoreView(raw) {
+    return {
+        code: raw.store_code,
+        name: raw.store_name ?? raw.store_code,
+        locale: raw.locale,
+        currencyCode: raw.default_display_currency_code,
+        baseCurrencyCode: raw.base_currency_code,
+        baseUrl: raw.base_url,
+        isDefault: raw.is_default_store === true,
+    };
+}
+let cachedStores = null;
+let storesPromise = null;
+/**
+ * All store views, fetched once and cached for the process lifetime (the store
+ * list is static config). Returns [] on failure without caching the failure.
+ */
+export async function getStores() {
+    if (cachedStores)
+        return cachedStores;
+    if (storesPromise)
+        return storesPromise;
+    storesPromise = (async () => {
+        try {
+            const data = await graphqlFetch(queries.GET_AVAILABLE_STORES);
+            cachedStores = (data.availableStores ?? []).map(mapStoreView);
+            return cachedStores;
+        }
+        catch (error) {
+            console.warn("Failed to fetch store views:", error);
+            return [];
+        }
+        finally {
+            storesPromise = null;
+        }
+    })();
+    return storesPromise;
+}
+/** Clear the store registry cache (tests / after config changes). */
+export function clearStoresCache() {
+    cachedStores = null;
+    storesPromise = null;
+}

package/dist/urls.d.ts

@@ -0,0 +1,32 @@
+/**
+ * URL helpers for the Magento adapter.
+ *
+ * Magento categories/products are addressed by a URL suffix (commonly ".html",
+ * configured per store via `storeConfig.category_url_suffix` /
+ * `product_url_suffix`). Magento's `route()` resolver only matches paths that
+ * include this suffix, so generated links must carry it and it must be present
+ * when resolving.
+ *
+ * We also deliberately build category paths from the `url_key` hierarchy rather
+ * than the entity's `url_path` field: `url_path` can be stale in Magento (e.g.
+ * a category named "22lr Ammunition" with url_key "22lr-ammunition" may report
+ * url_path "ammunition/lerduvor"), whereas the `url_key` chain always matches
+ * the store's canonical URL.
+ */
+/** Join path segments with "/", dropping empty/null/undefined ones. */
+export declare function joinSegments(segments: Array<string | null | undefined>): string;
+/**
+ * Append `suffix` to `path` unless the path is empty or already ends with it.
+ * An empty suffix (store with clean URLs) is a no-op.
+ */
+export declare function applySuffix(path: string, suffix: string): string;
+/**
+ * Remove a trailing `suffix` from `path` if present. Empty suffix is a no-op.
+ * Only the trailing occurrence is removed (internal matches are preserved).
+ */
+export declare function stripSuffix(path: string, suffix: string): string;
+/**
+ * Build a category's canonical relative URL from its ancestor url_key chain,
+ * its own url_key, and the store's category URL suffix.
+ */
+export declare function buildCategoryUrl(ancestorUrlKeys: Array<string | null | undefined>, urlKey: string | null | undefined, suffix: string): string;

package/dist/urls.js

@@ -0,0 +1,44 @@
+/**
+ * URL helpers for the Magento adapter.
+ *
+ * Magento categories/products are addressed by a URL suffix (commonly ".html",
+ * configured per store via `storeConfig.category_url_suffix` /
+ * `product_url_suffix`). Magento's `route()` resolver only matches paths that
+ * include this suffix, so generated links must carry it and it must be present
+ * when resolving.
+ *
+ * We also deliberately build category paths from the `url_key` hierarchy rather
+ * than the entity's `url_path` field: `url_path` can be stale in Magento (e.g.
+ * a category named "22lr Ammunition" with url_key "22lr-ammunition" may report
+ * url_path "ammunition/lerduvor"), whereas the `url_key` chain always matches
+ * the store's canonical URL.
+ */
+/** Join path segments with "/", dropping empty/null/undefined ones. */
+export function joinSegments(segments) {
+    return segments.filter((s) => Boolean(s && s.length)).join("/");
+}
+/**
+ * Append `suffix` to `path` unless the path is empty or already ends with it.
+ * An empty suffix (store with clean URLs) is a no-op.
+ */
+export function applySuffix(path, suffix) {
+    if (!path || !suffix)
+        return path;
+    return path.endsWith(suffix) ? path : `${path}${suffix}`;
+}
+/**
+ * Remove a trailing `suffix` from `path` if present. Empty suffix is a no-op.
+ * Only the trailing occurrence is removed (internal matches are preserved).
+ */
+export function stripSuffix(path, suffix) {
+    if (!path || !suffix)
+        return path;
+    return path.endsWith(suffix) ? path.slice(0, -suffix.length) : path;
+}
+/**
+ * Build a category's canonical relative URL from its ancestor url_key chain,
+ * its own url_key, and the store's category URL suffix.
+ */
+export function buildCategoryUrl(ancestorUrlKeys, urlKey, suffix) {
+    return applySuffix(joinSegments([...ancestorUrlKeys, urlKey]), suffix);
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@cobrastyle/adapter-magento2",
+  "version": "1.0.1",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@cobrastyle/shared-types": "1.0.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.3.0",
+    "@cobrastyle/adapter-conformance": "1.0.1"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eComero/cobrastyle-express-next.git",
+    "directory": "packages/adapters/magento2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "type-check": "tsc --noEmit"
+  }
+}