@cobrastyle/adapter-magento2 1.1.1 → 1.3.0

package/dist/adapter.js

@@ -232,6 +232,16 @@ export const magento2Adapter = {
                 return mapCartWithUrls(data.cart);
             }
             catch (error) {
+                // An ownership refusal means the id is unusable for this session (e.g. a
+                // guest cart id left in the cookie after login). Reporting it as `null`
+                // would render an empty cart while the quote still exists and leave the bad
+                // id in place, so let it propagate; callers can drop the id and start over.
+                if (error instanceof Error &&
+                    error.message.toLowerCase().includes('cannot perform operations on cart')) {
+                    throw error;
+                }
+                // Anything else (missing cart, transport failure) stays soft: the cart is
+                // simply unavailable and the page must still render.
                 return null;
             }
         },

package/dist/client.js

@@ -254,10 +254,15 @@ export async function graphqlFetch(query, variables, options = {}) {
                     }
                 }
                 logger.error(operationName, new Error(`HTTP ${response.status}: ${text}`), duration);
+                // Carry the backend's reason, not just the status: callers need it to tell
+                // an expired cart from an ownership problem, and without it a failure can
+                // only be diagnosed by reproducing the request by hand.
+                const reason = extractErrorReason(text);
+                const detail = reason ? `: ${reason}` : '';
                 if (response.status === 401) {
-                    throw new GraphQLAuthError(`GraphQL request failed: 401 ${response.statusText} [${requestId}]`);
+                    throw new GraphQLAuthError(`GraphQL request failed: 401 ${response.statusText}${detail} [${requestId}]`.replace(/ +/g, ' '));
                 }
-                throw new Error(`GraphQL request failed: ${response.status} ${response.statusText} [${requestId}]`);
+                throw new Error(`GraphQL request failed: ${response.status} ${response.statusText}${detail} [${requestId}]`.replace(/ +/g, ' '));
             }
             const text = await response.text();
             // Check if response is HTML (likely an error page)
@@ -324,6 +329,26 @@ export async function graphqlFetch(query, variables, options = {}) {
         ? lastError
         : new Error(`GraphQL request failed after ${maxAttempts} attempts for ${operationName} [${requestId}]`);
 }
+/**
+ * Pull a human-readable reason out of a non-2xx response body: the first GraphQL
+ * error message when the body is a GraphQL envelope, otherwise a trimmed excerpt
+ * of whatever the server sent (proxy errors, HTML pages, empty bodies).
+ */
+function extractErrorReason(body) {
+    const text = body?.trim();
+    if (!text)
+        return undefined;
+    try {
+        const parsed = JSON.parse(text);
+        const message = parsed.errors?.find((e) => e?.message)?.message;
+        if (message)
+            return message;
+    }
+    catch {
+        // Not JSON — fall through to the excerpt.
+    }
+    return text.slice(0, 200);
+}
 /** Sleep helper for retry backoff. */
 function delay(ms) {
     return ms > 0 ? new Promise((resolve) => setTimeout(resolve, ms)) : Promise.resolve();

package/dist/config.d.ts

@@ -42,6 +42,9 @@ export interface MagentoConfig extends AdapterConfig {
      */
     storeResolver?: () => string | undefined;
 }
+export declare const isConfigured: () => boolean;
+/** Warn once per process that the client is running on defaults only. */
+export declare function warnIfUnconfigured(context: string): void;
 export declare const getConfig: () => MagentoConfig;
 export declare const setConfig: (newConfig: Partial<MagentoConfig>) => void;
 export declare const createConfig: (overrides?: Partial<MagentoConfig>) => MagentoConfig;

package/dist/config.js

@@ -1,5 +1,8 @@
 let config = {
-    baseUrl: process.env.MAGENTO_URL || 'https://magento.example.com/graphql',
+    // Deliberately empty rather than a placeholder host: an unset MAGENTO_URL is a
+    // configuration error, and pointing it at a domain nobody owns turns that into
+    // confusing request failures instead.
+    baseUrl: process.env.MAGENTO_URL || '',
     storeCode: process.env.MAGENTO_STORE || 'default',
     skipSsl: process.env.SKIP_SSL === 'true',
     allowInsecure: process.env.ALLOW_INSECURE === 'true',
@@ -7,9 +10,32 @@ let config = {
     // If not set, will be fetched dynamically from storeConfig
     rootCategoryId: process.env.MAGENTO_ROOT_CATEGORY_ID ? parseInt(process.env.MAGENTO_ROOT_CATEGORY_ID, 10) : undefined,
 };
+/**
+ * Whether the consuming app has supplied its configuration yet.
+ *
+ * The env-derived defaults above make an *unconfigured* client look usable, but
+ * the injected callbacks — `customerTokenGetter`, `tokenRefresher`,
+ * `storeResolver` — have no defaults. Requests then go out unauthenticated and
+ * without per-request store resolution, which surfaces far downstream as an
+ * authorization error on customer-owned data. Consumers of the exported client
+ * (`graphqlFetch`, `withCustomerAuth`) need to be told.
+ */
+let configured = false;
+let warnedUnconfigured = false;
+export const isConfigured = () => configured;
+/** Warn once per process that the client is running on defaults only. */
+export function warnIfUnconfigured(context) {
+    if (configured || warnedUnconfigured)
+        return;
+    warnedUnconfigured = true;
+    console.warn(`[magento2] ${context} before setConfig() ran: requests will be sent unauthenticated ` +
+        'and without per-request store resolution. Call setConfig() (or load the adapter ' +
+        'through configureStorefront/getAdapter) before using the exported GraphQL client.');
+}
 export const getConfig = () => config;
 export const setConfig = (newConfig) => {
     config = { ...config, ...newConfig };
+    configured = true;
 };
 export const createConfig = (overrides = {}) => ({
     ...config,
@@ -20,6 +46,7 @@ export const createConfig = (overrides = {}) => ({
  * Merges with any extra options passed in.
  */
 export async function withCustomerAuth(extra = {}) {
+    warnIfUnconfigured('withCustomerAuth() was called');
     const token = await config.customerTokenGetter?.();
     if (token) {
         return { ...extra, customerToken: token };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { magento2Adapter, magento2Adapter as default } from './adapter';
-export { getConfig, setConfig, createConfig, withCustomerAuth } from './config';
+export { getConfig, setConfig, createConfig, withCustomerAuth, isConfigured } from './config';
 export type { MagentoConfig } from './config';
 export { graphqlFetch, GraphQLAuthError } from './client';
 export { logger, MagentoLogger } from './logger';

package/dist/index.js

@@ -1,5 +1,5 @@
 export { magento2Adapter, magento2Adapter as default } from './adapter';
-export { getConfig, setConfig, createConfig, withCustomerAuth } from './config';
+export { getConfig, setConfig, createConfig, withCustomerAuth, isConfigured } from './config';
 export { graphqlFetch, GraphQLAuthError } from './client';
 export { logger, MagentoLogger } from './logger';
 export * as queries from './queries';

package/dist/magento-types.d.ts

@@ -301,6 +301,11 @@ export interface MagentoCategory {
     breadcrumbs?: MagentoCategoryBreadcrumb[] | null;
     meta_title?: string;
     meta_description?: string;
+    /**
+     * PRODUCTS | PAGE | PRODUCTS_AND_PAGE. Magento's enum is a plain String in the
+     * GraphQL schema, so it is typed loosely here and narrowed by the mapper.
+     */
+    display_mode?: string | null;
 }
 export interface MagentoCmsPage {
     identifier: string;

package/dist/mappers.js

@@ -462,8 +462,15 @@ export const mapCategory = (cat, suffix = '', ancestorSegments) => {
         })),
         metaTitle: cat.meta_title,
         metaDescription: cat.meta_description,
+        displayMode: mapDisplayMode(cat.display_mode),
     };
 };
+/**
+ * Narrow Magento's `display_mode` to our union. Unknown or absent values map to
+ * undefined rather than a guessed default, so the storefront's own fallback
+ * (render products, the historic behaviour) stays in one place.
+ */
+const mapDisplayMode = (mode) => mode === 'PRODUCTS' || mode === 'PAGE' || mode === 'PRODUCTS_AND_PAGE' ? mode : undefined;
 // Magento exposes `include_in_menu` as a per-category flag (Boolean, or 0/1 in
 // older schemas). Categories may exist and be browsable while intentionally
 // hidden from navigation, so we must not render them in the menu. A missing

package/dist/queries.d.ts

@@ -1,9 +1,9 @@
 export declare const GET_PRODUCT_BY_URL_KEY = "\n  query GetProductByUrlKey($urlKey: String!) {\n    products(filter: { url_key: { eq: $urlKey } }) {\n      items {\n        __typename\n        id\n        sku\n        name\n        url_key\n        description { html }\n        short_description { html }\n        meta_title\n        meta_description\n        stock_status\n        price_range {\n          minimum_price {\n            regular_price { value currency }\n            final_price { value currency }\n            discount { amount_off percent_off }\n          }\n          maximum_price {\n            final_price { value currency }\n          }\n        }\n        price_tiers {\n          quantity\n          final_price { value currency }\n          discount { amount_off percent_off }\n        }\n        media_gallery {\n          url\n          label\n          position\n        }\n        categories {\n          id\n          name\n          url_key\n          breadcrumbs {\n            category_url_key\n            category_level\n          }\n        }\n        custom_attributesV2(filters: { is_visible_on_front: true }) {\n          items {\n            code\n            __typename\n            ... on AttributeValue {\n              value\n            }\n            ... on AttributeSelectedOptions {\n              selected_options {\n                label\n                value\n              }\n            }\n          }\n          errors {\n            message\n          }\n        }\n        ... on ConfigurableProduct {\n          configurable_options {\n            id\n            attribute_code\n            label\n            values {\n              uid\n              label\n              swatch_data {\n                __typename\n                value\n              }\n            }\n          }\n          variants {\n            product {\n              id\n              sku\n              name\n              stock_status\n              price_range {\n                minimum_price {\n                  regular_price { value currency }\n                  final_price { value currency }\n                }\n              }\n            }\n            attributes {\n              code\n              label\n              value_index\n            }\n          }\n        }\n        ... on GroupedProduct {\n          items {\n            qty\n            position\n            product {\n              ... on ProductInterface {\n                __typename\n                id\n                uid\n                sku\n                name\n                url_key\n                stock_status\n                price_range {\n                  minimum_price {\n                    regular_price { value currency }\n                    final_price { value currency }\n                    discount { amount_off percent_off }\n                  }\n                }\n                thumbnail { url label }\n              }\n            }\n          }\n        }\n        ... on BundleProduct {\n          dynamic_price\n          price_view\n          bundleItems: items {\n            uid\n            option_id\n            title\n            type\n            required\n            position\n            options {\n              uid\n              id\n              label\n              quantity\n              can_change_quantity\n              is_default\n              price\n              price_type\n              product {\n                sku\n                price_range { minimum_price { final_price { value currency } } }\n              }\n            }\n          }\n        }\n      }\n    }\n  }\n";
 export declare const GET_PRODUCT_BY_ID = "\n  query GetProductBySku($sku: String!) {\n    products(filter: { sku: { eq: $sku } }) {\n      items {\n        __typename\n        id\n        sku\n        name\n        url_key\n        description { html }\n        short_description { html }\n        meta_title\n        meta_description\n        stock_status\n        price_range {\n          minimum_price {\n            regular_price { value currency }\n            final_price { value currency }\n            discount { amount_off percent_off }\n          }\n          maximum_price {\n            final_price { value currency }\n          }\n        }\n        price_tiers {\n          quantity\n          final_price { value currency }\n          discount { amount_off percent_off }\n        }\n        media_gallery {\n          url\n          label\n          position\n        }\n        categories {\n          id\n          name\n          url_key\n          breadcrumbs {\n            category_url_key\n            category_level\n          }\n        }\n        custom_attributesV2(filters: { is_visible_on_front: true }) {\n          items {\n            code\n            __typename\n            ... on AttributeValue {\n              value\n            }\n            ... on AttributeSelectedOptions {\n              selected_options {\n                label\n                value\n              }\n            }\n          }\n          errors {\n            message\n          }\n        }\n        ... on ConfigurableProduct {\n          configurable_options {\n            id\n            attribute_code\n            label\n            values {\n              uid\n              label\n              swatch_data {\n                __typename\n                value\n              }\n            }\n          }\n          variants {\n            product {\n              id\n              sku\n              name\n              stock_status\n              price_range {\n                minimum_price {\n                  regular_price { value currency }\n                  final_price { value currency }\n                }\n              }\n            }\n            attributes {\n              code\n              label\n              value_index\n            }\n          }\n        }\n        ... on GroupedProduct {\n          items {\n            qty\n            position\n            product {\n              ... on ProductInterface {\n                __typename\n                id\n                uid\n                sku\n                name\n                url_key\n                stock_status\n                price_range {\n                  minimum_price {\n                    regular_price { value currency }\n                    final_price { value currency }\n                    discount { amount_off percent_off }\n                  }\n                }\n                thumbnail { url label }\n              }\n            }\n          }\n        }\n        ... on BundleProduct {\n          dynamic_price\n          price_view\n          bundleItems: items {\n            uid\n            option_id\n            title\n            type\n            required\n            position\n            options {\n              uid\n              id\n              label\n              quantity\n              can_change_quantity\n              is_default\n              price\n              price_type\n              product {\n                sku\n                price_range { minimum_price { final_price { value currency } } }\n              }\n            }\n          }\n        }\n      }\n    }\n  }\n";
 export declare const GET_PRODUCT_ATTRIBUTE_LABELS = "\n  query GetProductAttributeLabels {\n    attributesList(entityType: CATALOG_PRODUCT, filters: { is_visible_on_front: true }) {\n      items {\n        code\n        label\n      }\n      errors {\n        message\n      }\n    }\n  }\n";
-export declare const GET_CATEGORY_BY_URL_KEY = "\n  query GetCategoryByUrlKey($urlKey: String!) {\n    categoryList(filters: { url_path: { eq: $urlKey } }) {\n      id\n      uid\n      name\n      url_key\n      url_path\n      description\n      image\n      meta_title\n      meta_description\n      product_count\n      breadcrumbs {\n        category_id\n        category_uid\n        category_name\n        category_url_key\n        category_url_path\n        category_level\n      }\n      children {\n        id\n        uid\n        name\n        url_key\n        url_path\n        product_count\n      }\n    }\n  }\n";
-export declare const GET_CATEGORY_BY_URL_KEY_SINGLE = "\n  query GetCategoryByUrlKeySingle($urlKey: String!) {\n    categoryList(filters: { url_key: { eq: $urlKey } }) {\n      id\n      uid\n      name\n      url_key\n      url_path\n      description\n      image\n      meta_title\n      meta_description\n      product_count\n      breadcrumbs {\n        category_id\n        category_uid\n        category_name\n        category_url_key\n        category_url_path\n        category_level\n      }\n      children {\n        id\n        uid\n        name\n        url_key\n        url_path\n        product_count\n      }\n    }\n  }\n";
-export declare const GET_CATEGORY_BY_UID = "\n  query GetCategoryByUid($uid: String!) {\n    categoryList(filters: { category_uid: { eq: $uid } }) {\n      id\n      uid\n      name\n      url_key\n      url_path\n      description\n      image\n      meta_title\n      meta_description\n      product_count\n      breadcrumbs {\n        category_id\n        category_uid\n        category_name\n        category_url_key\n        category_url_path\n        category_level\n      }\n      children {\n        id\n        uid\n        name\n        url_key\n        url_path\n        product_count\n      }\n    }\n  }\n";
+export declare const GET_CATEGORY_BY_URL_KEY = "\n  query GetCategoryByUrlKey($urlKey: String!) {\n    categoryList(filters: { url_path: { eq: $urlKey } }) {\n      id\n      uid\n      name\n      url_key\n      url_path\n      description\n      image\n      meta_title\n      meta_description\n      product_count\n      display_mode\n      breadcrumbs {\n        category_id\n        category_uid\n        category_name\n        category_url_key\n        category_url_path\n        category_level\n      }\n      children {\n        id\n        uid\n        name\n        url_key\n        url_path\n        product_count\n      }\n    }\n  }\n";
+export declare const GET_CATEGORY_BY_URL_KEY_SINGLE = "\n  query GetCategoryByUrlKeySingle($urlKey: String!) {\n    categoryList(filters: { url_key: { eq: $urlKey } }) {\n      id\n      uid\n      name\n      url_key\n      url_path\n      description\n      image\n      meta_title\n      meta_description\n      product_count\n      display_mode\n      breadcrumbs {\n        category_id\n        category_uid\n        category_name\n        category_url_key\n        category_url_path\n        category_level\n      }\n      children {\n        id\n        uid\n        name\n        url_key\n        url_path\n        product_count\n      }\n    }\n  }\n";
+export declare const GET_CATEGORY_BY_UID = "\n  query GetCategoryByUid($uid: String!) {\n    categoryList(filters: { category_uid: { eq: $uid } }) {\n      id\n      uid\n      name\n      url_key\n      url_path\n      description\n      image\n      meta_title\n      meta_description\n      product_count\n      display_mode\n      breadcrumbs {\n        category_id\n        category_uid\n        category_name\n        category_url_key\n        category_url_path\n        category_level\n      }\n      children {\n        id\n        uid\n        name\n        url_key\n        url_path\n        product_count\n      }\n    }\n  }\n";
 export declare const GET_CATEGORY_SUGGESTIONS = "\n  query GetCategorySuggestions($name: String!) {\n    categoryList(filters: { name: { match: $name } }) {\n      uid\n      name\n      url_key\n      url_path\n    }\n  }\n";
 export declare const GET_CATEGORY_PRODUCTS = "\n  query GetCategoryProducts(\n    $pageSize: Int!\n    $currentPage: Int!\n    $filter: ProductAttributeFilterInput!\n    $sort: ProductAttributeSortInput\n  ) {\n    products(\n      filter: $filter\n      pageSize: $pageSize\n      currentPage: $currentPage\n      sort: $sort\n    ) {\n      total_count\n      page_info {\n        current_page\n        page_size\n        total_pages\n      }\n      items {\n        id\n        sku\n        name\n        url_key\n        stock_status\n        price_range {\n          minimum_price {\n            regular_price { value currency }\n            final_price { value currency }\n            discount { amount_off percent_off }\n          }\n        }\n        price_tiers {\n          quantity\n          final_price { value currency }\n          discount { amount_off percent_off }\n        }\n        thumbnail {\n          url\n          label\n        }\n      }\n      aggregations(filter: { category: { includeDirectChildrenOnly: false } }) {\n        attribute_code\n        label\n        options {\n          value\n          label\n          count\n        }\n      }\n      sort_fields {\n        default\n        options {\n          value\n          label\n        }\n      }\n    }\n  }\n";
 export declare const GET_STORE_CONFIG = "\n  query GetStoreConfig {\n    storeConfig {\n      root_category_uid\n      root_category_id\n      store_code\n      store_name\n      base_currency_code\n      default_display_currency_code\n      locale\n      timezone\n      category_url_suffix\n      product_url_suffix\n      use_store_in_url\n      cms_home_page\n      cms_no_route\n      default_title\n      default_description\n      default_keywords\n      title_prefix\n      title_suffix\n      title_separator\n    }\n  }\n";

package/dist/queries.js

@@ -330,6 +330,7 @@ export const GET_CATEGORY_BY_URL_KEY = `
       meta_title
       meta_description
       product_count
+      display_mode
       breadcrumbs {
         category_id
         category_uid
@@ -363,6 +364,7 @@ export const GET_CATEGORY_BY_URL_KEY_SINGLE = `
       meta_title
       meta_description
       product_count
+      display_mode
       breadcrumbs {
         category_id
         category_uid
@@ -397,6 +399,7 @@ export const GET_CATEGORY_BY_UID = `
       meta_title
       meta_description
       product_count
+      display_mode
       breadcrumbs {
         category_id
         category_uid

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobrastyle/adapter-magento2",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -13,12 +13,12 @@
     "dist"
   ],
   "dependencies": {
-    "@cobrastyle/shared-types": "1.1.0"
+    "@cobrastyle/shared-types": "1.2.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",
     "typescript": "^5.3.0",
-    "@cobrastyle/adapter-conformance": "1.0.2"
+    "@cobrastyle/adapter-conformance": "1.0.3"
   },
   "license": "MIT",
   "repository": {