@xyd-js/framework 0.1.0-xyd.6 → 0.1.0-xyd.73

package/dist/index.js

@@ -1,18 +1,37 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+// 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 = {};
   }
-  return to;
+  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
 };
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var src_exports = {};
-module.exports = __toCommonJS(src_exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type * from \"./types\";"],"mappings":";;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"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

@@ -1,32 +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 } from '@xyd-js/core';
-import { ITOC, IBreadcrumb, INavLinks } from '@xyd-js/ui';
-import { F as FwSidebarGroupProps } from './sidebar-Dwf54qYp.js';
+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 {
-    onePathBehaviour?: boolean;
-    clientSideRouting?: boolean;
 }
 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[];
-    toc?: ITOC[];
+    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 Framework(props: FrameworkProps): React.JSX.Element;
+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.SubHeader | null;
+declare function useMatchedSubNav(): _xyd_js_core.Segment | null;
 
-export { Framework, type FrameworkProps, FwBreadcrumbs, FwNav, FwNavLinks, FwSidebarGroupProps, FwSidebarGroups, type FwSidebarGroupsProps, FwSubNav, FwToc, useMatchedSubNav };
+export { Framework, FrameworkPage, type FrameworkProps, FwBreadcrumbs, FwCopyPage, FwLink, FwLogo, FwNav, FwNavLinks, FwSidebarGroupProps, FwSidebarGroups, type FwSidebarGroupsProps, FwSubNav, FwToc, Surface, SurfaceContext, useComponents, useContentComponent, useMatchedSubNav, useMetadata, useSettings };