@designcrowd/library.brand-page 5.19.1-id-based-items-2 → 5.19.2

package/src/metadata-builder/builders/item-id-utils.test.ts

@@ -1,184 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import {
-  END_ITEM_ANCHOR,
-  ensureBrandPageItemIds,
-  ensureItemIds,
-  generateItemId,
-  removeItemsByIds,
-  repositionItemByAnchor,
-} from './item-id-utils';
-import type { BrandPageModel } from '../../brand-page/models';
-
-type Item = { id?: string; label: string };
-
-const UUID_RE =
-  /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
-
-const items = (...labels: string[]): Item[] =>
-  labels.map((label) => ({ id: label, label }));
-
-const labels = (list: Item[]): string[] => list.map((i) => i.label);
-
-describe('generateItemId', () => {
-  it('returns unique uuid-shaped ids', () => {
-    const a = generateItemId();
-    const b = generateItemId();
-
-    expect(a).not.toBe(b);
-    expect(a).toMatch(
-      /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i,
-    );
-  });
-});
-
-describe('ensureItemIds', () => {
-  it('backfills only the items missing an id, preserving existing ones', () => {
-    const list: Item[] = [
-      { id: 'keep', label: 'a' },
-      { label: 'b' },
-      { id: '', label: 'c' },
-    ];
-
-    ensureItemIds(list);
-
-    expect(list[0].id).toBe('keep');
-    expect(list[1].id).toBeTruthy();
-    expect(list[2].id).toBeTruthy();
-    expect(new Set(list.map((i) => i.id)).size).toBe(3);
-  });
-
-  it('is a no-op for undefined', () => {
-    expect(() => ensureItemIds(undefined)).not.toThrow();
-  });
-});
-
-describe('removeItemsByIds', () => {
-  it('removes by id regardless of order (no index shifting)', () => {
-    const result = removeItemsByIds(items('a', 'b', 'c', 'd'), ['c', 'a']);
-
-    expect(labels(result)).toEqual(['b', 'd']);
-  });
-
-  it('returns the list unchanged when no ids given', () => {
-    const list = items('a', 'b');
-
-    expect(removeItemsByIds(list, undefined)).toBe(list);
-    expect(removeItemsByIds(list, [])).toBe(list);
-  });
-
-  it('returns [] for undefined items', () => {
-    expect(removeItemsByIds(undefined, ['x'])).toEqual([]);
-  });
-});
-
-describe('repositionItemByAnchor', () => {
-  it('appends a new item when no anchor is given', () => {
-    const list = items('a', 'b');
-
-    repositionItemByAnchor(list, { id: 'new', label: 'new' }, undefined);
-
-    expect(labels(list)).toEqual(['a', 'b', 'new']);
-  });
-
-  it('leaves an existing item in place when no anchor is given', () => {
-    const list = items('a', 'b', 'c');
-
-    repositionItemByAnchor(list, list[1], undefined);
-
-    expect(labels(list)).toEqual(['a', 'b', 'c']);
-  });
-
-  it('inserts a new item before the anchor id', () => {
-    const list = items('a', 'b', 'c');
-
-    repositionItemByAnchor(list, { id: 'new', label: 'new' }, 'b');
-
-    expect(labels(list)).toEqual(['a', 'new', 'b', 'c']);
-  });
-
-  it('moves an existing item before the anchor id', () => {
-    const list = items('a', 'b', 'c', 'd');
-
-    // move 'd' before 'b'
-    repositionItemByAnchor(list, list[3], 'b');
-
-    expect(labels(list)).toEqual(['a', 'd', 'b', 'c']);
-  });
-
-  it('moves an existing item to the end with the __end__ sentinel', () => {
-    const list = items('a', 'b', 'c');
-
-    repositionItemByAnchor(list, list[0], END_ITEM_ANCHOR);
-
-    expect(labels(list)).toEqual(['b', 'c', 'a']);
-  });
-
-  it('falls through to the end when the anchor id is not found', () => {
-    const list = items('a', 'b');
-
-    repositionItemByAnchor(list, { id: 'new', label: 'new' }, 'missing');
-
-    expect(labels(list)).toEqual(['a', 'b', 'new']);
-  });
-});
-
-describe('ensureBrandPageItemIds', () => {
-  const makeModel = (): BrandPageModel =>
-    ({
-      pages: [
-        {
-          contents: [
-            {
-              type: 'image-gallery',
-              images: [{ imageUrl: 'a' }, { imageUrl: 'b' }],
-            },
-            {
-              type: 'testimonial-section',
-              items: [{ id: 'keep-me', name: 'X' }, { name: 'Y' }],
-            },
-            { type: 'text', textItems: [{ text: 'hi' }] },
-            { type: 'social-links', links: [{ url: 'u' }] },
-            { type: 'divider-section' }, // no item arrays — must not throw
-          ],
-        },
-      ],
-      pageFooterDesktop: { socialLinks: [{ url: 'f' }] },
-      pageFooterMobile: { socialLinks: [{ url: 'm' }] },
-    }) as unknown as BrandPageModel;
-
-  it('stamps a uuid id onto every id-less nested item across sections + footer', () => {
-    const model = makeModel();
-
-    ensureBrandPageItemIds(model);
-
-    const c = model.pages[0].contents as any[];
-
-    expect(c[0].images[0].id).toMatch(UUID_RE);
-    expect(c[0].images[1].id).toMatch(UUID_RE);
-    expect(c[1].items[1].id).toMatch(UUID_RE);
-    expect(c[2].textItems[0].id).toMatch(UUID_RE);
-    expect(c[3].links[0].id).toMatch(UUID_RE);
-    expect((model.pageFooterDesktop as any).socialLinks[0].id).toMatch(UUID_RE);
-    expect((model.pageFooterMobile as any).socialLinks[0].id).toMatch(UUID_RE);
-  });
-
-  it('preserves existing ids (idempotent)', () => {
-    const model = makeModel();
-
-    ensureBrandPageItemIds(model);
-    const first = (model.pages[0].contents as any[])[1].items[0].id;
-
-    ensureBrandPageItemIds(model);
-    const second = (model.pages[0].contents as any[])[1].items[0].id;
-
-    expect(first).toBe('keep-me');
-    expect(second).toBe('keep-me');
-  });
-
-  it('does not throw on an empty / partial model', () => {
-    expect(() => ensureBrandPageItemIds({} as BrandPageModel)).not.toThrow();
-    expect(() =>
-      ensureBrandPageItemIds({ pages: [] } as unknown as BrandPageModel),
-    ).not.toThrow();
-  });
-});

package/src/metadata-builder/builders/item-id-utils.ts

@@ -1,117 +0,0 @@
-import { v4 as uuidv4 } from 'uuid';
-import type { BrandPageModel } from '../../brand-page/models';
-
-/**
- * Sentinel anchor meaning "the end of the list", mirroring the section-level
- * `move_before_content_id: "__end__"` convention used in base-section-builder.
- */
-export const END_ITEM_ANCHOR = '__end__';
-
-/** Generate a stable item id. Mirrors section-level `uuid.v4()` id generation. */
-export const generateItemId = (): string => uuidv4();
-
-/**
- * Walk an entire BrandPageModel and backfill a stable uuid `id` onto every
- * nested array item that lacks one (gallery images, images/shapes/testimonial
- * items, text items, social links, and footer social links).
- *
- * BP-5603: this must run BEFORE the model is minified for the AI, so the same
- * id the AI is shown (and copies into `item_id`) is the one the executor later
- * matches. The maker holds a single live model instance for both the minify
- * and the apply step, so mutating it here makes the ids round-trip; they then
- * persist on the next save. Idempotent — existing ids are preserved.
- */
-export const ensureBrandPageItemIds = (model: BrandPageModel): void => {
-  const ensureContentItemIds = (content: Record<string, unknown>): void => {
-    // Every array field that the minifier surfaces as a list of items.
-    for (const field of ['images', 'items', 'textItems', 'links'] as const) {
-      const arr = content[field];
-
-      if (Array.isArray(arr)) ensureItemIds(arr as { id?: string }[]);
-    }
-  };
-
-  for (const page of model.pages ?? []) {
-    for (const content of page.contents ?? []) {
-      ensureContentItemIds(content as unknown as Record<string, unknown>);
-    }
-  }
-
-  ensureItemIds(model.pageFooterDesktop?.socialLinks);
-  ensureItemIds(model.pageFooterMobile?.socialLinks);
-};
-
-/**
- * Backfill ids onto any items missing one. Per BP-5603 this runs in the
- * metadata builder when a section is processed, so the persisted metadata
- * returned to the client gains stable ids that subsequent AI tool calls can
- * reference. Mutates in place.
- */
-export const ensureItemIds = <T extends { id?: string }>(
-  items: T[] | undefined,
-): void => {
-  if (!items) return;
-
-  for (const item of items) {
-    if (!item.id) item.id = generateItemId();
-  }
-};
-
-/**
- * Remove items whose id appears in `ids`. Order-independent (no descending
- * index sort needed) — the whole point of the id-based migration. Items
- * without an id are never removed by id.
- */
-export const removeItemsByIds = <T extends { id?: string }>(
-  items: T[] | undefined,
-  ids: string[] | undefined,
-): T[] => {
-  if (!items?.length) return items ?? [];
-
-  if (!ids?.length) return items;
-
-  const toRemove = new Set(ids);
-
-  return items.filter((item) => !item.id || !toRemove.has(item.id));
-};
-
-/**
- * Position `item` within `items` relative to an anchor id — the item-level
- * mirror of base-section-builder's `moveContent`:
- *
- * - `moveBeforeItemId === undefined`  → leave an existing item where it is;
- *   append a new (not-yet-present) item to the end.
- * - `moveBeforeItemId === "__end__"`  → move/insert at the very end.
- * - anchor id found                   → insert immediately before it.
- * - anchor id not found               → fall through to the end (same
- *   forgiving behaviour as `moveContent`).
- *
- * Mutates `items` in place. `item` may be an existing element of `items`
- * (a move) or a brand-new object (an insert).
- */
-export const repositionItemByAnchor = <T extends { id?: string }>(
-  items: T[],
-  item: T,
-  moveBeforeItemId: string | undefined,
-): void => {
-  const currentIndex = items.indexOf(item);
-
-  if (moveBeforeItemId === undefined) {
-    if (currentIndex === -1) items.push(item);
-
-    return;
-  }
-
-  if (currentIndex !== -1) items.splice(currentIndex, 1);
-
-  const anchorIndex =
-    moveBeforeItemId === END_ITEM_ANCHOR
-      ? -1
-      : items.findIndex((i) => i.id === moveBeforeItemId);
-
-  if (anchorIndex !== -1) {
-    items.splice(anchorIndex, 0, item);
-  } else {
-    items.push(item);
-  }
-};