@xyd-js/framework 0.1.0-xyd.11 → 0.1.0-xyd.115

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 xyd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

package/dist/Sidebar-CdavG0uc.d.ts

@@ -0,0 +1,23 @@
+import { Metadata } from '@xyd-js/core';
+
+interface FwSidebarGroupProps {
+    group: string;
+    groupIndex: number;
+    items: FwSidebarItemProps[];
+    icon?: string;
+}
+interface FwSidebarItemProps {
+    title: string;
+    href: string;
+    uniqIndex: number;
+    icon?: string;
+    sidebarTitle?: string;
+    items?: FwSidebarItemProps[];
+    active?: boolean;
+    readonly level?: number;
+    readonly groupIndex?: number;
+    readonly itemIndex?: number;
+    readonly pageMeta?: Metadata;
+}
+
+export type { FwSidebarGroupProps as F };

package/dist/hydration.d.ts

@@ -0,0 +1,17 @@
+import { Settings, MetadataMap, Metadata } from '@xyd-js/core';
+import { IBreadcrumb, INavLinks } from '@xyd-js/ui';
+import { F as FwSidebarGroupProps } from './Sidebar-CdavG0uc.js';
+
+declare function mapSettingsToProps(settings: Settings, pagePathMapping: {
+    [key: string]: string;
+}, slug: string, frontmatters?: MetadataMap): Promise<{
+    groups: FwSidebarGroupProps[];
+    breadcrumbs: IBreadcrumb[];
+    navlinks?: INavLinks;
+    hiddenPages?: {
+        [key: string]: boolean;
+    };
+    metadata?: Metadata | null;
+}>;
+
+export { mapSettingsToProps };

package/dist/hydration.js

@@ -0,0 +1,269 @@
+// packages/hydration/mapSettingsToProps.ts
+import { pageFrontMatters } from "@xyd-js/content";
+async function mapSettingsToProps(settings, pagePathMapping, slug, frontmatters) {
+  let uniqIndex = 0;
+  const filteredNav = filterNavigation(settings, slug);
+  if (!frontmatters) {
+    frontmatters = await pageFrontMatters(filteredNav, pagePathMapping);
+  }
+  const slugFrontmatter = frontmatters[slug] || null;
+  const breadcrumbs = [];
+  let navlinks = void 0;
+  const hiddenPages = Object.keys(frontmatters).reduce((acc, page) => {
+    if (frontmatters[page].hidden) {
+      acc[page] = true;
+    }
+    return acc;
+  }, {});
+  function mapItems(page, currentNav, nav) {
+    var _a, _b;
+    if (!frontmatters) {
+      console.error("frontmatters not found");
+      return null;
+    }
+    if (typeof page !== "string" && !("virtual" in page)) {
+      const items = (_b = (_a = page.pages) == null ? void 0 : _a.map((p) => mapItems(p, page, nav))) == null ? void 0 : _b.filter(Boolean);
+      if (items == null ? void 0 : items.find((item) => normalizeHrefCheck(item.href, slug))) {
+        breadcrumbs.unshift({
+          title: page.group || "",
+          href: ""
+          // TODO:
+        });
+      }
+      return {
+        title: page.group,
+        href: "",
+        active: false,
+        uniqIndex: uniqIndex++,
+        icon: page.icon,
+        items
+      };
+    }
+    let pageName = "";
+    if (typeof page === "string") {
+      pageName = page;
+    } else {
+      pageName = page.page;
+    }
+    if (hiddenPages[pageName]) {
+      return null;
+    }
+    const matterTitle = frontmatters && frontmatters[pageName] && frontmatters[pageName].title;
+    let title = "";
+    if (typeof matterTitle === "string") {
+      title = matterTitle;
+    } else {
+      title = matterTitle;
+    }
+    if (!title) {
+      console.debug(`\u26A0\uFE0F Title not found for page "${pageName}"`);
+    }
+    const meta = frontmatters[pageName];
+    if (slugFrontmatter && slugFrontmatter === meta) {
+      const nlinks = mapNavToLinks(pageName, currentNav, nav, frontmatters, hiddenPages);
+      if (nlinks) {
+        navlinks = nlinks;
+      }
+      if (currentNav.group) {
+        breadcrumbs.push({
+          title: currentNav.group,
+          href: ""
+          // TODO:
+        });
+      }
+      breadcrumbs.push({
+        // @ts-ignore
+        title,
+        href: pageName
+      });
+    }
+    return {
+      title,
+      href: safePageLink(pageName),
+      active: false,
+      uniqIndex: uniqIndex++,
+      icon: (meta == null ? void 0 : meta.icon) || "",
+      sidebarTitle: (meta == null ? void 0 : meta.sidebarTitle) || "",
+      pageMeta: meta || null
+    };
+  }
+  const groups = filteredNav.map((nav) => {
+    var _a, _b, _c;
+    if ("route" in nav) {
+      if ((_a = nav.pages) == null ? void 0 : _a.length) {
+        const items2 = (((_b = nav.pages) == null ? void 0 : _b.map((p) => mapItems(p, nav, filteredNav))) || []).filter(Boolean);
+        return {
+          items: items2
+        };
+      }
+      return {
+        group: "",
+        items: [],
+        groupIndex: 0
+      };
+    }
+    const items = (((_c = nav.pages) == null ? void 0 : _c.map((p) => mapItems(p, nav, filteredNav))) || []).filter(Boolean);
+    return {
+      group: nav.group,
+      icon: nav == null ? void 0 : nav.icon,
+      items
+    };
+  }) || [];
+  return {
+    groups,
+    breadcrumbs,
+    navlinks,
+    hiddenPages,
+    metadata: slugFrontmatter
+  };
+}
+function filterNavigation(settings, slug) {
+  var _a, _b;
+  const sidebarItems = [];
+  let multiSidebarMatch = null;
+  let flatPagesOnly = false;
+  let foundRoute = false;
+  function findRoute(sidebar) {
+    var _a2;
+    if ("route" in sidebar) {
+      const sideMatch = normalizeHref(sidebar.route);
+      const normalizeSlug = normalizeHref(slug);
+      if (normalizeSlug.startsWith(sideMatch)) {
+        if (multiSidebarMatch) {
+          const findByMatchLvl = multiSidebarMatch.route.split("/").length;
+          const urlMatchLvl = sideMatch.split("/").length;
+          if (urlMatchLvl > findByMatchLvl) {
+            if (!foundRoute) {
+              foundRoute = true;
+              sidebarItems.length = 0;
+            }
+            multiSidebarMatch = sidebar;
+          }
+        } else {
+          if (!foundRoute) {
+            foundRoute = true;
+            sidebarItems.length = 0;
+          }
+          multiSidebarMatch = sidebar;
+        }
+      }
+      if ("pages" in sidebar && ((_a2 = sidebar.pages) == null ? void 0 : _a2.length)) {
+        for (const page of sidebar.pages) {
+          findRoute(page);
+        }
+      }
+    }
+    return;
+  }
+  (_a = settings == null ? void 0 : settings.navigation) == null ? void 0 : _a.sidebar.filter((sidebar) => {
+    if (flatPagesOnly) {
+      return;
+    }
+    if (typeof sidebar === "string") {
+      flatPagesOnly = true;
+      return;
+    }
+    if ("route" in sidebar) {
+      findRoute(sidebar);
+      return;
+    }
+    if (foundRoute) {
+      return;
+    }
+    sidebarItems.push(sidebar);
+  });
+  if (multiSidebarMatch != null) {
+    const side = multiSidebarMatch;
+    sidebarItems.push(...(side == null ? void 0 : side.pages) || []);
+  }
+  if (flatPagesOnly) {
+    sidebarItems.push({
+      pages: (_b = settings == null ? void 0 : settings.navigation) == null ? void 0 : _b.sidebar
+    });
+  }
+  return sidebarItems;
+}
+function normalizeHrefCheck(first, second) {
+  if (first.startsWith("/")) {
+    first = first.slice(1);
+  }
+  if (second.startsWith("/")) {
+    second = second.slice(1);
+  }
+  return first === second;
+}
+function normalizeHref(href) {
+  if (href.startsWith("/")) {
+    return href;
+  }
+  return `/${href}`;
+}
+function safePageLink(page) {
+  return (page == null ? void 0 : page.startsWith("/")) ? page : `/${page}`;
+}
+function mapNavToLinks(page, currentNav, nav, frontmatters, hiddenPages) {
+  var _a, _b;
+  if (!currentNav.group) {
+    console.debug("current nav need group to calculate navlinks");
+    return;
+  }
+  const allPages = [];
+  nav.forEach((group, groupIndex) => {
+    if (group.pages) {
+      group.pages.forEach((pageItem, pageIndex) => {
+        let pageName = "";
+        if (typeof pageItem === "string") {
+          pageName = pageItem;
+        } else if ("virtual" in pageItem) {
+          pageName = pageItem.page;
+        } else if ("pages" in pageItem) {
+          return;
+        } else if ("page" in pageItem && typeof pageItem === "object") {
+          pageName = pageItem.page;
+        }
+        if (pageName && !hiddenPages[pageName]) {
+          allPages.push({
+            page: pageName,
+            group: group.group || "",
+            groupIndex,
+            pageIndex
+          });
+        }
+      });
+    }
+  });
+  const currentPageIndex = allPages.findIndex((p) => p.page === page);
+  if (currentPageIndex === -1) {
+    return void 0;
+  }
+  const prevPage = allPages[currentPageIndex - 1];
+  const nextPage = allPages[currentPageIndex + 1];
+  let prevLink;
+  let nextLink;
+  if (prevPage) {
+    const prevTitle = ((_a = frontmatters[prevPage.page]) == null ? void 0 : _a.title) || prevPage.page;
+    if (typeof prevTitle === "string") {
+      prevLink = {
+        title: prevTitle,
+        href: safePageLink(prevPage.page)
+      };
+    }
+  }
+  if (nextPage) {
+    const nextTitle = ((_b = frontmatters[nextPage.page]) == null ? void 0 : _b.title) || nextPage.page;
+    if (typeof nextTitle === "string") {
+      nextLink = {
+        title: nextTitle,
+        href: safePageLink(nextPage.page)
+      };
+    }
+  }
+  return {
+    prev: prevLink || void 0,
+    next: nextLink || void 0
+  };
+}
+export {
+  mapSettingsToProps
+};
+//# sourceMappingURL=hydration.js.map

package/dist/hydration.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../packages/hydration/mapSettingsToProps.ts"],"sourcesContent":["// server-only\n\nimport { Sidebar, MetadataMap, Settings, SidebarRoute, Metadata, PageURL } from \"@xyd-js/core\";\nimport { pageFrontMatters } from \"@xyd-js/content\";\nimport { IBreadcrumb, INavLinks } from \"@xyd-js/ui\";\n\nimport { FwSidebarGroupProps } from \"../react\";\n\n// TODO: framework vs content responsibility\n\n// mapSettingsToProps maps @xyd-js/core settings into xyd props\nexport async function mapSettingsToProps(\n    settings: Settings,\n    pagePathMapping: { [key: string]: string },\n    slug: string,\n    frontmatters?: MetadataMap\n): Promise<{\n    groups: FwSidebarGroupProps[],\n    breadcrumbs: IBreadcrumb[]\n    navlinks?: INavLinks\n    hiddenPages?: { [key: string]: boolean }\n    metadata?: Metadata | null\n}> {\n    let uniqIndex = 0\n    const filteredNav = filterNavigation(settings, slug)\n    if (!frontmatters) {\n        frontmatters = await pageFrontMatters(filteredNav, pagePathMapping) as MetadataMap\n    }\n\n    const slugFrontmatter = frontmatters[slug] || null\n    const breadcrumbs: IBreadcrumb[] = []\n    let navlinks: INavLinks | undefined = undefined\n\n    const hiddenPages = Object.keys(frontmatters).reduce((acc, page) => {\n        if (frontmatters[page].hidden) {\n            acc[page] = true\n        }\n\n        return acc\n    }, {})\n\n    function mapItems(\n        page: PageURL,\n        currentNav: Sidebar,\n        nav: Sidebar[]\n    ) {\n        if (!frontmatters) {\n            console.error(\"frontmatters not found\")\n            return null\n        }\n\n        if (typeof page !== \"string\" && !(\"virtual\" in page)) {\n            const items = page.pages\n                ?.map((p) => mapItems(p, page, nav))\n                ?.filter(Boolean)\n\n            if (items?.find(item => normalizeHrefCheck(item.href, slug))) {\n                breadcrumbs.unshift({\n                    title: page.group || \"\",\n                    href: \"\", // TODO:\n                })\n            }\n\n            return {\n                title: page.group,\n                href: \"\",\n                active: false,\n                uniqIndex: uniqIndex++,\n                icon: page.icon,\n                items,\n            }\n        }\n        let pageName = \"\"\n        if (typeof page === \"string\") {\n            pageName = page\n        } else {\n            pageName = page.page\n        }\n\n        if (hiddenPages[pageName]) {\n            return null\n        }\n\n        const matterTitle = frontmatters && frontmatters[pageName] && frontmatters[pageName].title\n\n        let title = \"\"\n\n        if (typeof matterTitle === \"string\") {\n            title = matterTitle\n        } else {\n            // @ts-ignore\n            title = matterTitle\n        }\n\n        if (!title) {\n            console.debug(`⚠️ Title not found for page \"${pageName}\"`)\n        }\n\n        const meta = frontmatters[pageName]\n\n        // TODO: better data structures - for example flat array of filtered nav\n        if (slugFrontmatter && (slugFrontmatter === meta)) {\n            const nlinks = mapNavToLinks(pageName, currentNav, nav, frontmatters, hiddenPages)\n\n            if (nlinks) {\n                navlinks = nlinks\n            }\n\n            if (currentNav.group) {\n                breadcrumbs.push({\n                    title: currentNav.group,\n                    href: \"\", // TODO:\n                })\n            }\n            breadcrumbs.push({\n                // @ts-ignore\n                title,\n                href: pageName,\n            })\n        }\n\n        return {\n            title,\n            href: safePageLink(pageName),\n            active: false,\n            uniqIndex: uniqIndex++,\n            icon: meta?.icon || \"\",\n            sidebarTitle: meta?.sidebarTitle || \"\",\n            pageMeta: meta || null,\n        }\n    }\n\n    const groups = filteredNav\n        .map((nav) => {\n            // TODO: finish\n            if (\"route\" in nav) {\n                if (nav.pages?.length) {\n                    const items = (nav.pages?.map((p) => mapItems(p, nav, filteredNav)) || [])\n                        .filter(Boolean)\n\n                    return {\n                        items\n                    } as FwSidebarGroupProps\n                }\n\n                return {\n                    group: \"\",\n                    items: [],\n                    groupIndex: 0,\n                } as FwSidebarGroupProps\n            }\n\n            const items = (nav.pages?.map((p) => mapItems(p, nav, filteredNav)) || [])\n                .filter(Boolean)\n\n            return {\n                group: nav.group,\n                icon: nav?.icon,\n                items\n            } as FwSidebarGroupProps\n        }) || []\n\n    return {\n        groups,\n        breadcrumbs,\n        navlinks,\n        hiddenPages,\n        metadata: slugFrontmatter\n    }\n}\n\nfunction filterNavigation(settings: Settings, slug: string): Sidebar[] {\n    const sidebarItems: Sidebar[] = []\n\n    let multiSidebarMatch: SidebarRoute | null = null\n\n    let flatPagesOnly = false\n\n    let foundRoute = false\n\n    function findRoute(sidebar: Sidebar | SidebarRoute) {\n        if (\"route\" in sidebar) {\n            const sideMatch = normalizeHref(sidebar.route)\n            const normalizeSlug = normalizeHref(slug)\n\n            // TODO: startWith is not enough e.g `/docs/apps/buildISSUE` if `/docs/apps/build`\n            if (normalizeSlug.startsWith(sideMatch)) {\n                if (multiSidebarMatch) {\n                    const findByMatchLvl = multiSidebarMatch.route.split(\"/\").length\n                    const urlMatchLvl = sideMatch.split(\"/\").length\n\n                    if (urlMatchLvl > findByMatchLvl) {\n                        if (!foundRoute) {\n                            foundRoute = true\n                            sidebarItems.length = 0\n                        }\n                        \n                        multiSidebarMatch = sidebar\n                    }\n                } else {\n                    if (!foundRoute) {\n                        foundRoute = true\n                        sidebarItems.length = 0\n                    }\n                  \n                    multiSidebarMatch = sidebar\n                }\n            }\n\n            if (\"pages\" in sidebar && sidebar.pages?.length) {\n                for (const page of sidebar.pages) {\n                    findRoute(page)\n                }\n            }\n        }\n\n        return\n    }\n\n    settings?.navigation?.sidebar.filter(sidebar => {\n        if (flatPagesOnly) {\n            return\n        }\n        if (typeof sidebar === \"string\") {\n            flatPagesOnly = true\n            return\n        }\n\n        if (\"route\" in sidebar) {\n            findRoute(sidebar)\n\n            return\n        }\n\n        if (foundRoute) {\n            return\n        }\n\n        sidebarItems.push(sidebar)\n    })\n\n    if (multiSidebarMatch != null) {\n        const side = multiSidebarMatch as SidebarRoute\n        sidebarItems.push(...(side?.pages || []))\n    }\n\n    if (flatPagesOnly) {\n        sidebarItems.push({\n            pages: settings?.navigation?.sidebar as string[]\n        })\n    }\n\n    return sidebarItems\n}\n\n// TODO: rename this because it's no longer 'navigation' because it returns breadcrumbs, sidebar and nextlinks props\n// TODO: breadcrumbs and frontmatters as content plugins?\n// TODO: idea - calculate breadcrumbs and navlinks near server-side component?\n\nfunction normalizeHrefCheck(first: string, second: string) {\n    if (first.startsWith(\"/\")) {\n        first = first.slice(1)\n    }\n\n    if (second.startsWith(\"/\")) {\n        second = second.slice(1)\n    }\n\n    return first === second\n}\n\nfunction normalizeHref(href: string) {\n    if (href.startsWith(\"/\")) {\n        return href\n    }\n\n    return `/${href}`\n}\n\nfunction safePageLink(page: string): string {\n    return page?.startsWith(\"/\") ? page : `/${page}`\n}\n\n// TODO: support next-prev for different 'groups' levels\nfunction mapNavToLinks(\n    page: string,\n    currentNav: Sidebar,\n    nav: Sidebar[],\n    frontmatters: MetadataMap,\n    hiddenPages: { [key: string]: boolean }\n): INavLinks | undefined {\n    if (!currentNav.group) {\n        console.debug(\"current nav need group to calculate navlinks\")\n        return\n    }\n\n    // Flatten all pages from all groups to find the sequence\n    const allPages: Array<{ page: string, group: string, groupIndex: number, pageIndex: number }> = []\n\n    nav.forEach((group, groupIndex) => {\n        if (group.pages) {\n            group.pages.forEach((pageItem, pageIndex) => {\n                let pageName = \"\"\n                if (typeof pageItem === \"string\") {\n                    pageName = pageItem\n                } else if (\"virtual\" in pageItem) {\n                    pageName = pageItem.page\n                } else if (\"pages\" in pageItem) {\n                    // This is a nested Sidebar, skip for now as it's not supported\n                    return\n                } else if (\"page\" in pageItem && typeof pageItem === \"object\") {\n                    // This is a VirtualPage object with page property\n                    pageName = (pageItem as { page: string }).page\n                }\n\n                if (pageName && !hiddenPages[pageName]) {\n                    allPages.push({\n                        page: pageName,\n                        group: group.group || \"\",\n                        groupIndex,\n                        pageIndex\n                    })\n                }\n            })\n        }\n    })\n\n    // Find current page in the flattened list\n    const currentPageIndex = allPages.findIndex(p => p.page === page)\n\n    if (currentPageIndex === -1) {\n        return undefined\n    }\n\n    // Get previous and next pages\n    const prevPage = allPages[currentPageIndex - 1]\n    const nextPage = allPages[currentPageIndex + 1]\n\n    let prevLink\n    let nextLink\n\n    if (prevPage) {\n        const prevTitle = frontmatters[prevPage.page]?.title || prevPage.page\n        if (typeof prevTitle === \"string\") {\n            prevLink = {\n                title: prevTitle,\n                href: safePageLink(prevPage.page),\n            }\n        }\n    }\n\n    if (nextPage) {\n        const nextTitle = frontmatters[nextPage.page]?.title || nextPage.page\n        if (typeof nextTitle === \"string\") {\n            nextLink = {\n                title: nextTitle,\n                href: safePageLink(nextPage.page),\n            }\n        }\n    }\n\n    return {\n        prev: prevLink || undefined,\n        next: nextLink || undefined,\n    }\n}\n"],"mappings":";AAGA,SAAS,wBAAwB;AAQjC,eAAsB,mBAClB,UACA,iBACA,MACA,cAOD;AACC,MAAI,YAAY;AAChB,QAAM,cAAc,iBAAiB,UAAU,IAAI;AACnD,MAAI,CAAC,cAAc;AACf,mBAAe,MAAM,iBAAiB,aAAa,eAAe;AAAA,EACtE;AAEA,QAAM,kBAAkB,aAAa,IAAI,KAAK;AAC9C,QAAM,cAA6B,CAAC;AACpC,MAAI,WAAkC;AAEtC,QAAM,cAAc,OAAO,KAAK,YAAY,EAAE,OAAO,CAAC,KAAK,SAAS;AAChE,QAAI,aAAa,IAAI,EAAE,QAAQ;AAC3B,UAAI,IAAI,IAAI;AAAA,IAChB;AAEA,WAAO;AAAA,EACX,GAAG,CAAC,CAAC;AAEL,WAAS,SACL,MACA,YACA,KACF;AA7CN;AA8CQ,QAAI,CAAC,cAAc;AACf,cAAQ,MAAM,wBAAwB;AACtC,aAAO;AAAA,IACX;AAEA,QAAI,OAAO,SAAS,YAAY,EAAE,aAAa,OAAO;AAClD,YAAM,SAAQ,gBAAK,UAAL,mBACR,IAAI,CAAC,MAAM,SAAS,GAAG,MAAM,GAAG,OADxB,mBAER,OAAO;AAEb,UAAI,+BAAO,KAAK,UAAQ,mBAAmB,KAAK,MAAM,IAAI,IAAI;AAC1D,oBAAY,QAAQ;AAAA,UAChB,OAAO,KAAK,SAAS;AAAA,UACrB,MAAM;AAAA;AAAA,QACV,CAAC;AAAA,MACL;AAEA,aAAO;AAAA,QACH,OAAO,KAAK;AAAA,QACZ,MAAM;AAAA,QACN,QAAQ;AAAA,QACR,WAAW;AAAA,QACX,MAAM,KAAK;AAAA,QACX;AAAA,MACJ;AAAA,IACJ;AACA,QAAI,WAAW;AACf,QAAI,OAAO,SAAS,UAAU;AAC1B,iBAAW;AAAA,IACf,OAAO;AACH,iBAAW,KAAK;AAAA,IACpB;AAEA,QAAI,YAAY,QAAQ,GAAG;AACvB,aAAO;AAAA,IACX;AAEA,UAAM,cAAc,gBAAgB,aAAa,QAAQ,KAAK,aAAa,QAAQ,EAAE;AAErF,QAAI,QAAQ;AAEZ,QAAI,OAAO,gBAAgB,UAAU;AACjC,cAAQ;AAAA,IACZ,OAAO;AAEH,cAAQ;AAAA,IACZ;AAEA,QAAI,CAAC,OAAO;AACR,cAAQ,MAAM,0CAAgC,QAAQ,GAAG;AAAA,IAC7D;AAEA,UAAM,OAAO,aAAa,QAAQ;AAGlC,QAAI,mBAAoB,oBAAoB,MAAO;AAC/C,YAAM,SAAS,cAAc,UAAU,YAAY,KAAK,cAAc,WAAW;AAEjF,UAAI,QAAQ;AACR,mBAAW;AAAA,MACf;AAEA,UAAI,WAAW,OAAO;AAClB,oBAAY,KAAK;AAAA,UACb,OAAO,WAAW;AAAA,UAClB,MAAM;AAAA;AAAA,QACV,CAAC;AAAA,MACL;AACA,kBAAY,KAAK;AAAA;AAAA,QAEb;AAAA,QACA,MAAM;AAAA,MACV,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,MACH;AAAA,MACA,MAAM,aAAa,QAAQ;AAAA,MAC3B,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,OAAM,6BAAM,SAAQ;AAAA,MACpB,eAAc,6BAAM,iBAAgB;AAAA,MACpC,UAAU,QAAQ;AAAA,IACtB;AAAA,EACJ;AAEA,QAAM,SAAS,YACV,IAAI,CAAC,QAAQ;AArItB;AAuIY,QAAI,WAAW,KAAK;AAChB,WAAI,SAAI,UAAJ,mBAAW,QAAQ;AACnB,cAAMA,YAAS,SAAI,UAAJ,mBAAW,IAAI,CAAC,MAAM,SAAS,GAAG,KAAK,WAAW,OAAM,CAAC,GACnE,OAAO,OAAO;AAEnB,eAAO;AAAA,UACH,OAAAA;AAAA,QACJ;AAAA,MACJ;AAEA,aAAO;AAAA,QACH,OAAO;AAAA,QACP,OAAO,CAAC;AAAA,QACR,YAAY;AAAA,MAChB;AAAA,IACJ;AAEA,UAAM,WAAS,SAAI,UAAJ,mBAAW,IAAI,CAAC,MAAM,SAAS,GAAG,KAAK,WAAW,OAAM,CAAC,GACnE,OAAO,OAAO;AAEnB,WAAO;AAAA,MACH,OAAO,IAAI;AAAA,MACX,MAAM,2BAAK;AAAA,MACX;AAAA,IACJ;AAAA,EACJ,CAAC,KAAK,CAAC;AAEX,SAAO;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,UAAU;AAAA,EACd;AACJ;AAEA,SAAS,iBAAiB,UAAoB,MAAyB;AA3KvE;AA4KI,QAAM,eAA0B,CAAC;AAEjC,MAAI,oBAAyC;AAE7C,MAAI,gBAAgB;AAEpB,MAAI,aAAa;AAEjB,WAAS,UAAU,SAAiC;AApLxD,QAAAC;AAqLQ,QAAI,WAAW,SAAS;AACpB,YAAM,YAAY,cAAc,QAAQ,KAAK;AAC7C,YAAM,gBAAgB,cAAc,IAAI;AAGxC,UAAI,cAAc,WAAW,SAAS,GAAG;AACrC,YAAI,mBAAmB;AACnB,gBAAM,iBAAiB,kBAAkB,MAAM,MAAM,GAAG,EAAE;AAC1D,gBAAM,cAAc,UAAU,MAAM,GAAG,EAAE;AAEzC,cAAI,cAAc,gBAAgB;AAC9B,gBAAI,CAAC,YAAY;AACb,2BAAa;AACb,2BAAa,SAAS;AAAA,YAC1B;AAEA,gCAAoB;AAAA,UACxB;AAAA,QACJ,OAAO;AACH,cAAI,CAAC,YAAY;AACb,yBAAa;AACb,yBAAa,SAAS;AAAA,UAC1B;AAEA,8BAAoB;AAAA,QACxB;AAAA,MACJ;AAEA,UAAI,WAAW,aAAWA,MAAA,QAAQ,UAAR,gBAAAA,IAAe,SAAQ;AAC7C,mBAAW,QAAQ,QAAQ,OAAO;AAC9B,oBAAU,IAAI;AAAA,QAClB;AAAA,MACJ;AAAA,IACJ;AAEA;AAAA,EACJ;AAEA,6CAAU,eAAV,mBAAsB,QAAQ,OAAO,aAAW;AAC5C,QAAI,eAAe;AACf;AAAA,IACJ;AACA,QAAI,OAAO,YAAY,UAAU;AAC7B,sBAAgB;AAChB;AAAA,IACJ;AAEA,QAAI,WAAW,SAAS;AACpB,gBAAU,OAAO;AAEjB;AAAA,IACJ;AAEA,QAAI,YAAY;AACZ;AAAA,IACJ;AAEA,iBAAa,KAAK,OAAO;AAAA,EAC7B;AAEA,MAAI,qBAAqB,MAAM;AAC3B,UAAM,OAAO;AACb,iBAAa,KAAK,IAAI,6BAAM,UAAS,CAAC,CAAE;AAAA,EAC5C;AAEA,MAAI,eAAe;AACf,iBAAa,KAAK;AAAA,MACd,QAAO,0CAAU,eAAV,mBAAsB;AAAA,IACjC,CAAC;AAAA,EACL;AAEA,SAAO;AACX;AAMA,SAAS,mBAAmB,OAAe,QAAgB;AACvD,MAAI,MAAM,WAAW,GAAG,GAAG;AACvB,YAAQ,MAAM,MAAM,CAAC;AAAA,EACzB;AAEA,MAAI,OAAO,WAAW,GAAG,GAAG;AACxB,aAAS,OAAO,MAAM,CAAC;AAAA,EAC3B;AAEA,SAAO,UAAU;AACrB;AAEA,SAAS,cAAc,MAAc;AACjC,MAAI,KAAK,WAAW,GAAG,GAAG;AACtB,WAAO;AAAA,EACX;AAEA,SAAO,IAAI,IAAI;AACnB;AAEA,SAAS,aAAa,MAAsB;AACxC,UAAO,6BAAM,WAAW,QAAO,OAAO,IAAI,IAAI;AAClD;AAGA,SAAS,cACL,MACA,YACA,KACA,cACA,aACqB;AAlSzB;AAmSI,MAAI,CAAC,WAAW,OAAO;AACnB,YAAQ,MAAM,8CAA8C;AAC5D;AAAA,EACJ;AAGA,QAAM,WAA0F,CAAC;AAEjG,MAAI,QAAQ,CAAC,OAAO,eAAe;AAC/B,QAAI,MAAM,OAAO;AACb,YAAM,MAAM,QAAQ,CAAC,UAAU,cAAc;AACzC,YAAI,WAAW;AACf,YAAI,OAAO,aAAa,UAAU;AAC9B,qBAAW;AAAA,QACf,WAAW,aAAa,UAAU;AAC9B,qBAAW,SAAS;AAAA,QACxB,WAAW,WAAW,UAAU;AAE5B;AAAA,QACJ,WAAW,UAAU,YAAY,OAAO,aAAa,UAAU;AAE3D,qBAAY,SAA8B;AAAA,QAC9C;AAEA,YAAI,YAAY,CAAC,YAAY,QAAQ,GAAG;AACpC,mBAAS,KAAK;AAAA,YACV,MAAM;AAAA,YACN,OAAO,MAAM,SAAS;AAAA,YACtB;AAAA,YACA;AAAA,UACJ,CAAC;AAAA,QACL;AAAA,MACJ,CAAC;AAAA,IACL;AAAA,EACJ,CAAC;AAGD,QAAM,mBAAmB,SAAS,UAAU,OAAK,EAAE,SAAS,IAAI;AAEhE,MAAI,qBAAqB,IAAI;AACzB,WAAO;AAAA,EACX;AAGA,QAAM,WAAW,SAAS,mBAAmB,CAAC;AAC9C,QAAM,WAAW,SAAS,mBAAmB,CAAC;AAE9C,MAAI;AACJ,MAAI;AAEJ,MAAI,UAAU;AACV,UAAM,cAAY,kBAAa,SAAS,IAAI,MAA1B,mBAA6B,UAAS,SAAS;AACjE,QAAI,OAAO,cAAc,UAAU;AAC/B,iBAAW;AAAA,QACP,OAAO;AAAA,QACP,MAAM,aAAa,SAAS,IAAI;AAAA,MACpC;AAAA,IACJ;AAAA,EACJ;AAEA,MAAI,UAAU;AACV,UAAM,cAAY,kBAAa,SAAS,IAAI,MAA1B,mBAA6B,UAAS,SAAS;AACjE,QAAI,OAAO,cAAc,UAAU;AAC/B,iBAAW;AAAA,QACP,OAAO;AAAA,QACP,MAAM,aAAa,SAAS,IAAI;AAAA,MACpC;AAAA,IACJ;AAAA,EACJ;AAEA,SAAO;AAAA,IACH,MAAM,YAAY;AAAA,IAClB,MAAM,YAAY;AAAA,EACtB;AACJ;","names":["items","_a"]}

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import React from 'react';
+
+declare enum SurfaceTarget {
+    NavRight = "nav.right",
+    SidebarTop = "sidebar.top",
+    PageFooterBottom = "page.footer.bottom",
+    SidebarItemLeft = "sidebar.item.left",
+    SidebarItemRight = "sidebar.item.right"
+}
+type SurfaceTargetType = SurfaceTarget | `${SurfaceTarget}`;
+interface SurfaceOptions {
+    append?: boolean;
+}
+interface ROSurface {
+    get(target: SurfaceTargetType): React.JSX.Element | React.JSX.Element[] | undefined;
+}
+declare class Surfaces implements ROSurface {
+    private registry;
+    define(target: SurfaceTargetType, component: React.JSX.Element | React.ComponentType<any>, // TODO: fix any
+    opts?: SurfaceOptions): void;
+    get(target: SurfaceTargetType): React.JSX.Element | React.JSX.Element[] | undefined;
+}
+
+export { type ROSurface, type SurfaceOptions, SurfaceTarget, type SurfaceTargetType, Surfaces };

package/dist/index.js

@@ -0,0 +1,37 @@
+// src/surfaces.ts
+var SurfaceTarget = /* @__PURE__ */ ((SurfaceTarget2) => {
+  SurfaceTarget2["NavRight"] = "nav.right";
+  SurfaceTarget2["SidebarTop"] = "sidebar.top";
+  SurfaceTarget2["PageFooterBottom"] = "page.footer.bottom";
+  SurfaceTarget2["SidebarItemLeft"] = "sidebar.item.left";
+  SurfaceTarget2["SidebarItemRight"] = "sidebar.item.right";
+  return SurfaceTarget2;
+})(SurfaceTarget || {});
+var Surfaces = class {
+  constructor() {
+    this.registry = {};
+  }
+  define(target, component, opts) {
+    if (opts == null ? void 0 : opts.append) {
+      if (Array.isArray(this.registry[target])) {
+        this.registry[target].push(component);
+        return;
+      }
+      if (this.registry[target]) {
+        this.registry[target] = [this.registry[target], component];
+        return;
+      }
+      this.registry[target] = [component];
+      return;
+    }
+    this.registry[target] = component;
+  }
+  get(target) {
+    return this.registry[target];
+  }
+};
+export {
+  SurfaceTarget,
+  Surfaces
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/surfaces.ts"],"sourcesContent":["import React, { createContext } from 'react'\n\nexport enum SurfaceTarget {\n    NavRight = \"nav.right\",\n\n    SidebarTop = \"sidebar.top\",\n\n    PageFooterBottom = \"page.footer.bottom\",\n\n    SidebarItemLeft = \"sidebar.item.left\",\n    SidebarItemRight = \"sidebar.item.right\",\n}\n\n// Type that allows both enum and string values\nexport type SurfaceTargetType = SurfaceTarget | `${SurfaceTarget}`\n\nexport interface SurfaceOptions {\n    append?: boolean\n}\n\nexport interface ROSurface {\n    get(target: SurfaceTargetType): React.JSX.Element | React.JSX.Element[] | undefined\n}\n\n// TODO: framework vs theme ?\nexport class Surfaces implements ROSurface {\n    private registry: Partial<Record<SurfaceTargetType, React.JSX.Element | React.JSX.Element[]>> = {}\n\n    public define(\n        target: SurfaceTargetType,\n        component: React.JSX.Element | React.ComponentType<any>, // TODO: fix any\n        opts?: SurfaceOptions\n    ) {\n        if (opts?.append) {\n            if (Array.isArray(this.registry[target])) {\n                this.registry[target].push(component)\n                return\n            }\n\n            if (this.registry[target]) {\n                this.registry[target] = [this.registry[target], component]\n                return\n            }\n\n            this.registry[target] = [component]\n\n            return\n        }\n\n        this.registry[target] = component\n    }\n\n    public get(target: SurfaceTargetType): React.JSX.Element | React.JSX.Element[] | undefined {\n        return this.registry[target]\n    }\n}\n"],"mappings":";AAEO,IAAK,gBAAL,kBAAKA,mBAAL;AACH,EAAAA,eAAA,cAAW;AAEX,EAAAA,eAAA,gBAAa;AAEb,EAAAA,eAAA,sBAAmB;AAEnB,EAAAA,eAAA,qBAAkB;AAClB,EAAAA,eAAA,sBAAmB;AARX,SAAAA;AAAA,GAAA;AAuBL,IAAM,WAAN,MAAoC;AAAA,EAApC;AACH,SAAQ,WAAwF,CAAC;AAAA;AAAA,EAE1F,OACH,QACA,WACA,MACF;AACE,QAAI,6BAAM,QAAQ;AACd,UAAI,MAAM,QAAQ,KAAK,SAAS,MAAM,CAAC,GAAG;AACtC,aAAK,SAAS,MAAM,EAAE,KAAK,SAAS;AACpC;AAAA,MACJ;AAEA,UAAI,KAAK,SAAS,MAAM,GAAG;AACvB,aAAK,SAAS,MAAM,IAAI,CAAC,KAAK,SAAS,MAAM,GAAG,SAAS;AACzD;AAAA,MACJ;AAEA,WAAK,SAAS,MAAM,IAAI,CAAC,SAAS;AAElC;AAAA,IACJ;AAEA,SAAK,SAAS,MAAM,IAAI;AAAA,EAC5B;AAAA,EAEO,IAAI,QAAgF;AACvF,WAAO,KAAK,SAAS,MAAM;AAAA,EAC/B;AACJ;","names":["SurfaceTarget"]}

package/dist/react.d.ts

@@ -0,0 +1,72 @@
+import React from 'react';
+import { F as FwSidebarGroupProps } from './Sidebar-CdavG0uc.js';
+import { SurfaceTargetType, ROSurface, Surfaces } from './index.js';
+import * as _xyd_js_core from '@xyd-js/core';
+import { Settings, Metadata } from '@xyd-js/core';
+import { IBreadcrumb, ITOC, INavLinks } from '@xyd-js/ui';
+
+declare function FwNav({ kind }: {
+    kind?: "middle";
+}): React.JSX.Element;
+declare function FwSubNav(): React.JSX.Element | null;
+interface FwSidebarGroupsProps {
+}
+declare function FwSidebarGroups(props: FwSidebarGroupsProps): React.JSX.Element;
+declare function FwToc(): React.JSX.Element | null;
+declare function FwBreadcrumbs(): React.JSX.Element;
+declare function FwNavLinks(): React.JSX.Element | null;
+declare function FwLogo(): React.JSX.Element | null;
+declare function FwLink({ children, ...rest }: {
+    [x: string]: any;
+    children: any;
+}): React.JSX.Element;
+declare function FwCopyPage(): React.JSX.Element;
+
+interface SurfaceContext {
+    surfaces?: ROSurface;
+}
+declare const SurfaceContext: React.Context<SurfaceContext>;
+interface SurfaceProps {
+    target: SurfaceTargetType;
+    props?: any;
+}
+declare function Surface(props: SurfaceProps): React.JSX.Element | null;
+
+interface FrameworkProps {
+    children: React.ReactNode;
+    settings: Settings;
+    metadata: Metadata;
+    sidebarGroups: FwSidebarGroupProps[];
+    surfaces: Surfaces;
+    components?: {
+        [componentName: string]: React.ComponentType<any>;
+    };
+    BannerContent: React.ComponentType<any>;
+}
+declare function Framework(props: FrameworkProps): React.JSX.Element;
+interface FrameworkPageProps {
+    children: React.ReactNode;
+    ContentComponent?: (props: {
+        components: any;
+        children: React.ReactNode;
+    }) => React.JSX.Element;
+    metadata: Metadata;
+    breadcrumbs?: IBreadcrumb[];
+    rawPage?: string;
+    toc?: ITOC[];
+    navlinks?: INavLinks;
+}
+declare function FrameworkPage(props: FrameworkPageProps): React.JSX.Element;
+declare function useSettings(): Readonly<Settings>;
+declare function useMetadata(): Readonly<Metadata<void>>;
+declare function useComponents(): Readonly<{
+    [componentName: string]: React.ComponentType<any>;
+}> | undefined;
+declare function useContentComponent(): (props: {
+    components: any;
+    children: React.ReactNode;
+}) => React.JSX.Element;
+
+declare function useMatchedSubNav(): _xyd_js_core.Segment | null;
+
+export { Framework, FrameworkPage, type FrameworkProps, FwBreadcrumbs, FwCopyPage, FwLink, FwLogo, FwNav, FwNavLinks, FwSidebarGroupProps, FwSidebarGroups, type FwSidebarGroupsProps, FwSubNav, FwToc, Surface, SurfaceContext, useComponents, useContentComponent, useMatchedSubNav, useMetadata, useSettings };