weg-shared-layout 0.0.46 → 0.0.47

package/dist/collection/types/menus-data.js

@@ -0,0 +1 @@
+export {};

package/dist/collection/utils/menus.js

@@ -0,0 +1,39 @@
+import bootstrapDummy from "../assets/weg21-bootstrap.json";
+import menusDummy from "../assets/weg21-menus.json";
+export const DEFAULT_WEG21_API_BASE = 'https://warwickemploymentgroup.com/api/v1/weg21';
+export const WEG21_BOOTSTRAP_DUMMY = bootstrapDummy;
+export const WEG21_MENUS_DUMMY = menusDummy;
+export function menusToLayoutData(bootstrap, menus, options = {}) {
+    const headerMenu = options.headerMenu === 'int' ? menus.header.int : menus.header.ext;
+    const { credit, copyright, social_links } = bootstrap.footer;
+    return {
+        header: { menu: headerMenu },
+        footer: {
+            menu: menus.footer,
+            social: social_links,
+            credits: credit.trim() || undefined,
+            copyright: copyright.trim() || undefined,
+        },
+    };
+}
+/** Offline layout from package WEG21 dummy fixtures (`weg21-bootstrap.json` + `weg21-menus.json`). */
+export function dummyWeg21LayoutData(options = {}) {
+    return menusToLayoutData(WEG21_BOOTSTRAP_DUMMY, WEG21_MENUS_DUMMY, options);
+}
+export async function fetchWeg21Layout(options = {}) {
+    const apiBase = (options.apiBase ?? DEFAULT_WEG21_API_BASE).replace(/\/$/, '');
+    const fetchFn = options.fetch ?? globalThis.fetch;
+    const headers = { accept: 'application/json' };
+    if (options.apiKey)
+        headers['wcms-api-key'] = options.apiKey;
+    const [bootstrapRes, menusRes] = await Promise.all([
+        fetchFn(apiBase, { headers }),
+        fetchFn(`${apiBase}/menus`, { headers }),
+    ]);
+    if (!bootstrapRes.ok || !menusRes.ok) {
+        throw new Error(`WEG21 API error: bootstrap=${bootstrapRes.status} menus=${menusRes.status}`);
+    }
+    const bootstrap = (await bootstrapRes.json());
+    const menus = (await menusRes.json());
+    return menusToLayoutData(bootstrap, menus, options);
+}

package/dist/test-utils/layout-fixtures.js

@@ -0,0 +1,48 @@
+/** Minimal layout for component tests and local fallback. */
+export const SAMPLE_HEADER_LAYOUT = {
+    header: {
+        menu: [
+            {
+                label: 'Find a job',
+                items: [{ label: 'Graduates', href: '/search?category=graduates' }],
+            },
+            { label: 'Career advice', href: '/career-advice' },
+            { label: 'Sign in', href: '/account/login' },
+        ],
+    },
+};
+/** Header with three dropdown groups (desktop nav interaction tests). */
+export const MULTI_DROPDOWN_HEADER_LAYOUT = {
+    header: {
+        menu: [
+            {
+                label: 'Find a job',
+                items: [
+                    { label: 'Graduates', href: '/graduates' },
+                    { label: 'Senior roles', href: '/senior' },
+                ],
+            },
+            { label: 'Hire talent', items: [{ label: 'Executive search', href: '/executive' }] },
+            { label: 'HE solutions', items: [{ label: 'Franchise', href: '/franchise' }] },
+            { label: 'Sign in', href: '/account/login' },
+        ],
+    },
+};
+export const SAMPLE_FOOTER_LAYOUT = {
+    footer: {
+        social: [{ platform: 'LinkedIn', href: 'https://www.linkedin.com/company/example/' }],
+        menu: [
+            [
+                { label: 'Find a job', href: '/jobs' },
+                { label: 'About WEG', href: '/about' },
+            ],
+        ],
+        credits: 'Example credits text.',
+        copyright: 'Copyright © Example.',
+    },
+};
+/** Combined layout for accessibility tests. */
+export const FULL_LAYOUT_FIXTURE = {
+    header: MULTI_DROPDOWN_HEADER_LAYOUT.header,
+    footer: SAMPLE_FOOTER_LAYOUT.footer,
+};

package/dist/types/Users/rakin/Documents/WEG/repos/weg-shared-layout/.stencil/test-utils/layout-fixtures.d.ts

@@ -0,0 +1,8 @@
+import type { LayoutData } from '../src/types/layout-data';
+/** Minimal layout for component tests and local fallback. */
+export declare const SAMPLE_HEADER_LAYOUT: LayoutData;
+/** Header with three dropdown groups (desktop nav interaction tests). */
+export declare const MULTI_DROPDOWN_HEADER_LAYOUT: LayoutData;
+export declare const SAMPLE_FOOTER_LAYOUT: LayoutData;
+/** Combined layout for accessibility tests. */
+export declare const FULL_LAYOUT_FIXTURE: LayoutData;

package/dist/types/types/layout-data.d.ts

@@ -23,7 +23,8 @@ export type LayoutFooterData = {
 };
 /**
  * Layout payload accepted by `<weg-header>` and `<weg-footer>`.
- * @see src/assets/dummy-data.json
+ * @see src/assets/weg21-bootstrap.json and src/assets/weg21-menus.json (WEG21 API schema)
+ * @see src/utils/menus.ts (`menusToLayoutData`, `dummyWeg21LayoutData`)
  */
 export type LayoutData = {
     header?: Partial<LayoutHeaderData>;

package/dist/types/types/menus-data.d.ts

@@ -0,0 +1,37 @@
+/**
+ * WEG21 API types — mirrors wegcms-v2 `src/weg-shared-layout/menus-types.ts`.
+ * @see GET /api/v1/weg21
+ * @see GET /api/v1/weg21/menus
+ */
+export type LayoutPlatform = 'LinkedIn' | 'Instagram' | 'TikTok' | 'YouTube';
+export type LayoutSocialLink = {
+    platform: LayoutPlatform;
+    href: string;
+};
+export type MenuItemProps = {
+    label: string;
+    href?: string;
+    items?: MenuItemProps[];
+};
+export type HeaderMenuProps = {
+    ext: MenuItemProps[];
+    int: MenuItemProps[];
+};
+export type FooterMenuProps = MenuItemProps[][];
+/** `GET /api/v1/weg21/menus` response body. */
+export type MenusProps = {
+    header: HeaderMenuProps;
+    footer: FooterMenuProps;
+};
+export type Weg21FooterProps = {
+    social_links: LayoutSocialLink[];
+    credit: string;
+    copyright: string;
+};
+/** `GET /api/v1/weg21` response body. */
+export type Weg21BootstrapProps = {
+    logo: string;
+    favicon: string;
+    menus: string;
+    footer: Weg21FooterProps;
+};

package/dist/types/utils/menus.d.ts

@@ -0,0 +1,18 @@
+import type { LayoutData } from '../types/layout-data';
+import type { MenusProps, Weg21BootstrapProps } from '../types/menus-data';
+export declare const DEFAULT_WEG21_API_BASE = "https://warwickemploymentgroup.com/api/v1/weg21";
+export declare const WEG21_BOOTSTRAP_DUMMY: Weg21BootstrapProps;
+export declare const WEG21_MENUS_DUMMY: MenusProps;
+export type MenusToLayoutOptions = {
+    /** Which header nav slice maps to `header.menu`. Default: `ext` (public marketing nav). */
+    headerMenu?: 'ext' | 'int';
+};
+export declare function menusToLayoutData(bootstrap: Pick<Weg21BootstrapProps, 'footer'>, menus: MenusProps, options?: MenusToLayoutOptions): LayoutData;
+/** Offline layout from package WEG21 dummy fixtures (`weg21-bootstrap.json` + `weg21-menus.json`). */
+export declare function dummyWeg21LayoutData(options?: MenusToLayoutOptions): LayoutData;
+export type FetchWeg21LayoutOptions = MenusToLayoutOptions & {
+    apiBase?: string;
+    apiKey?: string;
+    fetch?: typeof fetch;
+};
+export declare function fetchWeg21Layout(options?: FetchWeg21LayoutOptions): Promise<LayoutData>;

package/docs/README.md

@@ -1,51 +1,54 @@
-# Documentation index
-
-Guides for integrating **`weg-shared-layout`** (`<weg-header>`, `<weg-footer>`) in host applications.
-
-Layout shape uses **`header.menu`** (unified nav) and **`footer.menu`** (columns). Reference JSON: [`src/assets/dummy-data.json`](../src/assets/dummy-data.json).
-
-**Nav active state:** pass **`current-path`** / **`currentPath`** on `<weg-header>` from your router (see framework guides below).
-
----
-
-## Choose a guide
-
-| Guide | Audience |
-| --- | --- |
-| **[../readme.md](../readme.md)** | Package overview, install, abbreviated layout shape |
-| **[angular.md](./angular.md)** | **Angular 16** — step-by-step integration |
-| **[../demo/angular16/README.md](../demo/angular16/README.md)** | Runnable Angular 16 demo (`npm run demo:angular16`) |
-| **[react.md](./react.md)** | React 19+ SPA (Vite, CRA, etc.) |
-| **[nextjs.md](./nextjs.md)** | Next.js 13+ App Router |
-| **[vanilla.md](./vanilla.md)** | Plain HTML / vanilla JS + bundler |
-| **[publishing.md](./publishing.md)** | Maintainers — npm publish, `prepack`, release checklist |
-
-Newer Angular (signals): [weg-angular-demo](https://github.com/jobsac/weg-angular-demo).
-
----
-
-## Package entry points
-
-Published subpaths (see [`package.json` `exports`](../package.json)):
-
-| Import | Purpose |
-| --- | --- |
-| `weg-shared-layout/loader` | **`defineCustomElements()`** — register all tags (recommended) |
-| `weg-shared-layout/dummy-data.json` | Sample layout JSON + `typeof` for app types |
-| `weg-shared-layout/layout-data` | Types only (`LayoutData`, etc.) — no Stencil runtime `.d.ts` |
-| `weg-shared-layout/weg-header` | Single-tag side-effect import (needs modern `moduleResolution`) |
-| `weg-shared-layout/weg-footer` | Single-tag side-effect import |
-
-TypeScript apps should set **`resolveJsonModule": true`** and **`moduleResolution": "bundler"`** (or `"node16"` / `"nodenext"`). See **[angular.md § Step 2](./angular.md#step-2--typescript-config)**.
-
----
-
-## Maintainer scripts
-
-From repo root:
-
-| Script | Action |
-| --- | --- |
-| `npm run build` | Stencil build → `dist/`, `loader/` |
-| `npm run demo:angular16` | Build library + `ng serve` in `demo/angular16` |
-| `npm run demo:angular16:build` | Build library + production build of demo |
+# Documentation index
+
+Guides for integrating **`weg-shared-layout`** (`<weg-header>`, `<weg-footer>`) in host applications.
+
+Layout data comes from the **WEG CMS WEG21 API** (`GET /api/v1/weg21` + `/menus`), mapped to `layout` via [`fetchWeg21Layout`](../src/utils/menus.ts). Schema reference: [`weg21-bootstrap.json`](../src/assets/weg21-bootstrap.json), [`weg21-menus.json`](../src/assets/weg21-menus.json).
+
+**Nav active state:** pass **`current-path`** / **`currentPath`** on `<weg-header>` from your router (see framework guides below).
+
+---
+
+## Choose a guide
+
+| Guide | Audience |
+| --- | --- |
+| **[../readme.md](../readme.md)** | Package overview, install, WEG21 API |
+| **[angular.md](./angular.md)** | **Angular 16** — step-by-step integration |
+| **[../demo/angular16/README.md](../demo/angular16/README.md)** | Runnable Angular 16 demo (`npm run demo:angular16`) |
+| **[react.md](./react.md)** | React 19+ SPA (Vite, CRA, etc.) |
+| **[nextjs.md](./nextjs.md)** | Next.js 13+ App Router |
+| **[vanilla.md](./vanilla.md)** | Plain HTML / vanilla JS + bundler |
+| **[publishing.md](./publishing.md)** | Maintainers — npm publish, `prepack`, release checklist |
+
+Newer Angular (signals): [weg-angular-demo](https://github.com/jobsac/weg-angular-demo).
+
+---
+
+## Package entry points
+
+Published subpaths (see [`package.json` `exports`](../package.json)):
+
+| Import | Purpose |
+| --- | --- |
+| `weg-shared-layout/loader` | **`defineCustomElements()`** — register all tags (recommended) |
+| `weg-shared-layout/menus` | **`fetchWeg21Layout`**, **`menusToLayoutData`** |
+| `weg-shared-layout/menus-data` | WEG21 API types (`MenusProps`, `Weg21BootstrapProps`, …) |
+| `weg-shared-layout/layout-data` | Types for `layout` prop (`LayoutData`, …) |
+| `weg-shared-layout/weg21-bootstrap.json` | `Weg21BootstrapProps` sample (`GET /api/v1/weg21`) |
+| `weg-shared-layout/weg21-menus.json` | `MenusProps` sample (`GET /api/v1/weg21/menus`) |
+| `weg-shared-layout/weg-header` | Single-tag side-effect import (needs modern `moduleResolution`) |
+| `weg-shared-layout/weg-footer` | Single-tag side-effect import |
+
+TypeScript apps should set **`resolveJsonModule": true`** and **`moduleResolution": "bundler"`** (or `"node16"` / `"nodenext"`). See **[angular.md § Step 2](./angular.md#step-2--typescript-config)**.
+
+---
+
+## Maintainer scripts
+
+From repo root:
+
+| Script | Action |
+| --- | --- |
+| `npm run build` | Stencil build → `dist/`, `loader/` |
+| `npm run demo:angular16` | Build library + `ng serve` in `demo/angular16` |
+| `npm run demo:angular16:build` | Build library + production build of demo |