@akinon/next 1.126.18 → 1.126.19

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @akinon/next
 
+## 1.126.19
+
+### Patch Changes
+
+- df46ca2: ZERO-5207: Add getCollectionWidgetData to the v1 server data layer, as on main
+
+  `getCollectionWidgetData` reads a collection widget (`/product_collection_widgets/<slug>/`) through the core's cache, under `widget_collection:<slug>`, the way `getWidgetData` reads a widget. `@akinon/pz-theme` already looks the function up on `@akinon/next/data/server` and uses it when it is there; on a core without it, pz-theme calls the endpoint itself, without the cache. Like `getWidgetSchemaData` on this line, it skips main's preview-copy lookup, because the theme editor writes no preview copies of collection widgets.
+
 ## 1.126.18
 
 ### Patch Changes

package/__tests__/collection-widget-data.test.ts

@@ -0,0 +1,126 @@
+jest.mock('server-only', () => ({}), { virtual: true });
+
+const appFetch = jest.fn();
+
+jest.mock('../utils/app-fetch', () => ({
+  __esModule: true,
+  default: (...args: unknown[]) => appFetch(...args)
+}));
+
+jest.mock('../utils/server-variables', () => ({
+  ServerVariables: { locale: 'tr', currency: 'try' }
+}));
+
+import * as serverData from '../data/server';
+import { getCollectionWidgetData, getWidgetData } from '../data/server/widget';
+import { Cache, CacheKey } from '../lib/cache';
+
+const SLUG = 'home-product-slider';
+
+const COLLECTION_WIDGET = {
+  pk: 7,
+  name: SLUG,
+  attributes: {},
+  products: [{ pk: 1, name: 'Shirt', absolute_url: '/shirt/' }]
+};
+
+describe('getCollectionWidgetData', () => {
+  let wrap: jest.SpyInstance;
+
+  beforeEach(() => {
+    appFetch.mockReset().mockResolvedValue(COLLECTION_WIDGET);
+    wrap = jest
+      .spyOn(Cache, 'wrap')
+      .mockImplementation(async (_key, _locale, handler) => handler());
+  });
+
+  afterEach(() => {
+    wrap.mockRestore();
+  });
+
+  // @akinon/pz-theme reads it off this module object and calls the endpoint
+  // itself, uncached, when it is missing.
+  it('is exported from the server data layer', () => {
+    expect(
+      (serverData as unknown as Record<string, unknown>).getCollectionWidgetData
+    ).toBe(getCollectionWidgetData);
+  });
+
+  it('reads the collection widget endpoint for the request locale and currency', async () => {
+    await expect(getCollectionWidgetData({ slug: SLUG })).resolves.toEqual(
+      COLLECTION_WIDGET
+    );
+
+    expect(appFetch).toHaveBeenCalledTimes(1);
+    expect(appFetch).toHaveBeenCalledWith({
+      url: `/product_collection_widgets/${SLUG}/`,
+      locale: 'tr',
+      currency: 'try',
+      init: {}
+    });
+  });
+
+  it('caches compressed, under its own key, per locale', async () => {
+    await getCollectionWidgetData({ slug: SLUG });
+
+    expect(wrap).toHaveBeenCalledWith(
+      `widget_collection:${SLUG}`,
+      'tr',
+      expect.any(Function),
+      { compressed: true }
+    );
+  });
+
+  it('never shares a cache entry with a regular widget of the same slug', () => {
+    expect(CacheKey.Widget(`collection:${SLUG}`)).not.toBe(
+      CacheKey.Widget(SLUG)
+    );
+  });
+
+  it('honours an explicit locale, currency and cache options', async () => {
+    await getCollectionWidgetData({
+      slug: SLUG,
+      locale: 'en',
+      currency: 'usd',
+      cacheOptions: { expire: 30 }
+    });
+
+    expect(wrap).toHaveBeenCalledWith(
+      `widget_collection:${SLUG}`,
+      'en',
+      expect.any(Function),
+      { compressed: true, expire: 30 }
+    );
+    expect(appFetch).toHaveBeenCalledWith({
+      url: `/product_collection_widgets/${SLUG}/`,
+      locale: 'en',
+      currency: 'usd',
+      init: {}
+    });
+  });
+
+  it('serves a cached answer without calling the api', async () => {
+    wrap.mockResolvedValue(COLLECTION_WIDGET);
+
+    await expect(getCollectionWidgetData({ slug: SLUG })).resolves.toEqual(
+      COLLECTION_WIDGET
+    );
+    expect(appFetch).not.toHaveBeenCalled();
+  });
+
+  it('answers null for an empty slug without calling the api', async () => {
+    await expect(getCollectionWidgetData({ slug: '' })).resolves.toBeNull();
+    expect(appFetch).not.toHaveBeenCalled();
+  });
+
+  it('is cached the way the widget answer is', async () => {
+    await getWidgetData({ slug: SLUG });
+    await getCollectionWidgetData({ slug: SLUG });
+
+    const [widgetOptions, collectionOptions] = wrap.mock.calls.map(
+      (call) => call[3]
+    );
+
+    expect(widgetOptions).toEqual(collectionOptions);
+  });
+});

package/data/server/widget.ts

@@ -265,6 +265,55 @@ export const getWidgetData = async <T>({
   );
 };
 
+const getCollectionWidgetDataHandler =
+  (
+    slug: string,
+    locale: string,
+    currency: string,
+    next?: { revalidate: number }
+  ) =>
+  async () => {
+    if (!slug) {
+      return null;
+    }
+
+    return await appFetch({
+      url: widgets.getCollectionWidget(slug),
+      locale,
+      currency,
+      init: next ? { next } : {}
+    });
+  };
+
+/**
+ * A collection-backed widget (`product_collection_widgets`): what a theme
+ * section bound to a product collection renders, with the collection's live
+ * rows. Cached like the widget answer. Like getWidgetSchemaData on this line,
+ * it skips main's preview-copy lookup: the theme editor writes no preview
+ * copies of collection widgets (see ZERO-5149).
+ */
+export const getCollectionWidgetData = async <T>({
+  slug,
+  locale = ServerVariables.locale,
+  currency = ServerVariables.currency,
+  cacheOptions
+}: {
+  slug: string;
+  locale?: string;
+  currency?: string;
+  cacheOptions?: CacheOptions;
+}): Promise<WidgetResultType<T>> => {
+  return Cache.wrap(
+    CacheKey.Widget(`collection:${slug}`),
+    locale,
+    getCollectionWidgetDataHandler(slug, locale, currency),
+    {
+      compressed: true,
+      ...cacheOptions
+    }
+  );
+};
+
 const getWidgetSchemaDataHandler =
   (
     widgetSlug: string,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@akinon/next",
   "description": "Core package for Project Zero Next",
-  "version": "1.126.18",
+  "version": "1.126.19",
   "private": false,
   "license": "MIT",
   "bin": {
@@ -35,7 +35,7 @@
     "set-cookie-parser": "2.6.0"
   },
   "devDependencies": {
-    "@akinon/eslint-plugin-projectzero": "1.126.18",
+    "@akinon/eslint-plugin-projectzero": "1.126.19",
     "@babel/core": "7.26.10",
     "@babel/preset-env": "7.26.9",
     "@babel/preset-typescript": "7.27.0",