@akinon/next 1.126.15 → 1.126.16

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @akinon/next
 
+## 1.126.16
+
+### Patch Changes
+
+- 032b418: ZERO-5194: add getWidgetSchemaData to the v1 server data layer, as on main
+
 ## 1.126.15
 
 ### Patch Changes

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

@@ -0,0 +1,121 @@
+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 { getWidgetData, getWidgetSchemaData } from '../data/server/widget';
+import { Cache, CacheKey } from '../lib/cache';
+
+const SLUG = 'section-hero';
+
+const SCHEMA = {
+  pk: 12,
+  name: SLUG,
+  schema: {
+    [SLUG]: { metadata: { blocks: [{ id: 'block-banner', type: 'image' }] } }
+  }
+};
+
+describe('getWidgetSchemaData', () => {
+  let wrap: jest.SpyInstance;
+
+  beforeEach(() => {
+    appFetch.mockReset().mockResolvedValue(SCHEMA);
+    wrap = jest
+      .spyOn(Cache, 'wrap')
+      .mockImplementation(async (_key, _locale, handler) => handler());
+  });
+
+  afterEach(() => {
+    wrap.mockRestore();
+  });
+
+  it('reads the schema endpoint for the request locale and currency', async () => {
+    await expect(getWidgetSchemaData({ widgetSlug: SLUG })).resolves.toEqual(
+      SCHEMA
+    );
+
+    expect(appFetch).toHaveBeenCalledTimes(1);
+    expect(appFetch).toHaveBeenCalledWith({
+      url: `/widgets/${SLUG}/schema/`,
+      locale: 'tr',
+      currency: 'try',
+      init: {}
+    });
+  });
+
+  it('caches under its own key, per locale', async () => {
+    await getWidgetSchemaData({ widgetSlug: SLUG });
+
+    expect(wrap).toHaveBeenCalledWith(
+      `widget_schema_${SLUG}`,
+      'tr',
+      expect.any(Function),
+      undefined
+    );
+  });
+
+  it('never shares a cache entry with the widget answer', () => {
+    expect(CacheKey.WidgetSchema(SLUG)).not.toBe(CacheKey.Widget(SLUG));
+  });
+
+  it('honours an explicit locale, currency and cache options', async () => {
+    const cacheOptions = { expire: 30 };
+
+    await getWidgetSchemaData({
+      widgetSlug: SLUG,
+      locale: 'en',
+      currency: 'usd',
+      cacheOptions
+    });
+
+    expect(wrap).toHaveBeenCalledWith(
+      `widget_schema_${SLUG}`,
+      'en',
+      expect.any(Function),
+      cacheOptions
+    );
+    expect(appFetch).toHaveBeenCalledWith({
+      url: `/widgets/${SLUG}/schema/`,
+      locale: 'en',
+      currency: 'usd',
+      init: {}
+    });
+  });
+
+  it('serves a cached schema without calling the api', async () => {
+    wrap.mockResolvedValue(SCHEMA);
+
+    await expect(getWidgetSchemaData({ widgetSlug: SLUG })).resolves.toEqual(
+      SCHEMA
+    );
+    expect(appFetch).not.toHaveBeenCalled();
+  });
+
+  it('answers null for an empty slug without calling the api', async () => {
+    await expect(getWidgetSchemaData({ widgetSlug: '' })).resolves.toBeNull();
+    expect(appFetch).not.toHaveBeenCalled();
+  });
+
+  it('lives exactly as long as the widget answer it is paired with', async () => {
+    await getWidgetData({ slug: SLUG });
+    await getWidgetSchemaData({ widgetSlug: SLUG });
+
+    const [dataOptions, schemaOptions] = wrap.mock.calls.map((call) => call[3]);
+
+    expect(wrap.mock.calls.map((call) => call[0])).toEqual([
+      `widget_${SLUG}`,
+      `widget_schema_${SLUG}`
+    ]);
+    expect(dataOptions?.expire).toBeUndefined();
+    expect(schemaOptions?.expire).toBeUndefined();
+  });
+});

package/data/server/widget.ts

@@ -1,6 +1,6 @@
 import { Cache, CacheKey } from '../../lib/cache';
 import 'server-only';
-import { CacheOptions, WidgetResultType } from '../../types';
+import { CacheOptions, WidgetResultType, WidgetSchemaType } from '../../types';
 import appFetch from '../../utils/app-fetch';
 import { widgets } from '../urls';
 import { ServerVariables } from '../../utils/server-variables';
@@ -264,3 +264,42 @@ export const getWidgetData = async <T>({
     }
   );
 };
+
+const getWidgetSchemaDataHandler =
+  (
+    widgetSlug: string,
+    locale: string,
+    currency: string,
+    next?: { revalidate: number }
+  ) =>
+  async () => {
+    if (!widgetSlug) {
+      return null;
+    }
+
+    return await appFetch({
+      url: widgets.getWidgetSchema(widgetSlug),
+      locale,
+      currency,
+      init: next ? { next } : {}
+    });
+  };
+
+export const getWidgetSchemaData = async <T>({
+  widgetSlug,
+  locale = ServerVariables.locale,
+  currency = ServerVariables.currency,
+  cacheOptions
+}: {
+  widgetSlug: string;
+  locale?: string;
+  currency?: string;
+  cacheOptions?: CacheOptions;
+}): Promise<WidgetSchemaType<T>> => {
+  return Cache.wrap(
+    CacheKey.WidgetSchema(widgetSlug),
+    locale,
+    getWidgetSchemaDataHandler(widgetSlug, locale, currency),
+    cacheOptions
+  );
+};

package/lib/cache.ts

@@ -108,6 +108,7 @@ export const CacheKey = {
   FlatPage: (pk: number) => `flat_page_${pk}`,
   LandingPage: (pk: number) => `landing_page_${pk}`,
   Widget: (slug: string) => `widget_${slug}`,
+  WidgetSchema: (widgetSlug: string) => `widget_schema_${widgetSlug}`,
   PrettyUrl: (pathname: string) => `pretty_url_${pathname}`,
   Menu: (depth: number, parent?: string) =>
     `menu_${depth}${parent ? `_${parent}` : ''}`,

package/package.json

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

package/types/commerce/widget.ts

@@ -26,3 +26,9 @@ export type WidgetResultType<T> = {
   slug?: string;
   template?: string;
 };
+
+export type WidgetSchemaType<T> = {
+  pk?: number;
+  name?: string;
+  schema?: T;
+};