xmlui 0.7.20 → 0.7.22

package/dist/xmlui.d.ts

@@ -45,22 +45,6 @@ declare interface ActionExecutionContext {
  */
 declare type ActionFunction = (executionContext: ActionExecutionContext, ...args: any[]) => any;
 
-/**
- * XMLUI keeps a registry of available actions to store information about out-of-the-box and custom
- * actions (contributions implemented in external packages or files). This type describes the
- * information the registry needs about the action to be able to render it.
- */
-declare interface ActionRendererDef {
-    /**
-     * The name of the action that will be used to reference it in XMLUI.
-     */
-    actionName: string;
-    /**
-     * The function that executes the action.
-     */
-    actionFn: ActionFunction;
-}
-
 declare type AlignmentOptions = (typeof alignmentOptionValues)[number];
 
 declare const alignmentOptionValues: readonly ["start", "center", "end"];
@@ -306,18 +290,18 @@ declare type AppContextObject = {
 };
 
 /**
- * This component runs the app in the context of the registered components
- * (including the core xmlui components and external ones passed to this
- * component.
+ * This component is responsible for running a pre-compiled xmlui app. It
+ * receives the internal representation of the app markup and code (coming
+ * from either code-behind files or inlined markup expressions) and executes
+ * the app accordingly.
  */
-export declare function AppRoot({ apiInterceptor, contributes, node, decorateComponentsWithTestId, debugEnabled, defaultTheme, defaultTone, resources, globalProps, standalone, trackContainerHeight, routerBaseName, previewMode, servedFromSingleFile, resourceMap, sources, componentManager, }: AppWrapperProps & {
-    componentManager?: StandaloneComponentManager;
+export declare function AppRoot({ apiInterceptor, contributes, node, decorateComponentsWithTestId, debugEnabled, defaultTheme, defaultTone, resources, globalProps, standalone, trackContainerHeight, routerBaseName, previewMode, resourceMap, sources, extensionManager, }: AppWrapperProps & {
+    extensionManager?: StandaloneExtensionManager;
 }): JSX_2.Element;
 
 declare type AppWrapperProps = {
     node: ComponentLike;
     previewMode?: boolean;
-    servedFromSingleFile?: boolean;
     routerBaseName?: string;
     contributes?: ContributesDefinition;
     globalProps?: GlobalProps;
@@ -459,7 +443,7 @@ export declare const Button: default_2.ForwardRefExoticComponent<{
     gap?: string | number;
     accessibilityProps?: any;
     autoFocus?: boolean;
-} & Pick<default_2.HTMLAttributes<HTMLButtonElement>, "className" | "aria-disabled" | "aria-label" | "aria-controls" | "aria-expanded" | "onClick" | "tabIndex" | "onFocus" | "onBlur" | "onMouseEnter" | "onMouseLeave"> & default_2.RefAttributes<HTMLButtonElement>>;
+} & Pick<default_2.HTMLAttributes<HTMLButtonElement>, "className" | "onClick" | "tabIndex" | "aria-controls" | "aria-disabled" | "aria-expanded" | "aria-label" | "onFocus" | "onBlur" | "onMouseEnter" | "onMouseLeave"> & default_2.RefAttributes<HTMLButtonElement>>;
 
 declare type ButtonThemeColor = (typeof buttonThemeValues)[number];
 
@@ -497,8 +481,9 @@ declare type ColorDef = {
 };
 
 /**
- * Components can provide an API that other components can invoke (using the host component ID). This
- * type defines the shape of a hash object that stores the API endpoints.
+ * Components can provide an API that other components can invoke (using
+ * the host component ID). This type defines the shape of a hash object that
+ * stores the API endpoints.
  */
 declare type ComponentApi = Record<string, ((...args: any[]) => any) | boolean>;
 
@@ -585,6 +570,8 @@ declare interface ComponentDefCore {
     debug?: Record<string, any>;
 }
 
+declare type ComponentExtension = ComponentRendererDef | CompoundComponentDef;
+
 /**
  * Sometimes, components and compound components can both be used
  */
@@ -598,7 +585,7 @@ export declare type ComponentLike = ComponentDef | CompoundComponentDef;
  * the metadata defined here in concert with the renderer object using the
  * same metadata type.
  */
-declare type ComponentMetadata<TProps extends Record<string, ComponentPropertyMetadata> = Record<string, any>, TEvents extends Record<string, ComponentPropertyMetadata> = Record<string, any>, TContextValues extends Record<string, ComponentPropertyMetadata> = Record<string, any>, TApis extends Record<string, ComponentPropertyMetadata> = Record<string, any>> = {
+export declare type ComponentMetadata<TProps extends Record<string, ComponentPropertyMetadata> = Record<string, any>, TEvents extends Record<string, ComponentPropertyMetadata> = Record<string, any>, TContextValues extends Record<string, ComponentPropertyMetadata> = Record<string, any>, TApis extends Record<string, ComponentPropertyMetadata> = Record<string, any>> = {
     status?: "stable" | "experimental" | "deprecated" | "in progress";
     description?: string;
     shortDescription?: string;
@@ -614,6 +601,7 @@ declare type ComponentMetadata<TProps extends Record<string, ComponentPropertyMe
     allowArbitraryProps?: boolean;
     specializedFrom?: string;
     docFolder?: string;
+    isHtmlTag?: boolean;
 };
 
 /**
@@ -655,8 +643,6 @@ declare type ComponentPropertyMetadata = {
     isInternal?: boolean;
 };
 
-declare type ComponentRegisteredCallbackFn = (component: ComponentRendererDef) => void;
-
 declare interface ComponentRendererContextBase<TMd extends ComponentMetadata = ComponentMetadata> {
     node: ComponentDef<TMd>;
     state: ContainerState;
@@ -764,10 +750,6 @@ declare type ContributesDefinition = {
      * Native xmlui components that come with the app.
      */
     components?: ComponentRendererDef[];
-    /**
-     * Action functions that come with the app.
-     */
-    actions?: ActionRendererDef[];
     /**
      * Application-specific compound components that come with the app.
      */
@@ -787,7 +769,7 @@ declare type ContributesDefinition = {
  */
 export declare function createComponentRenderer<TMd extends ComponentMetadata>(type: string, metadata: TMd, renderer: ComponentRendererFn<ComponentDef<TMd>>): ComponentRendererDef;
 
-export declare function createMetadata<TProps extends Record<string, ComponentPropertyMetadata>, TEvents extends Record<string, ComponentPropertyMetadata>, TContextVars extends Record<string, ComponentPropertyMetadata> = Record<string, any>, TApis extends Record<string, ComponentPropertyMetadata> = Record<string, any>>({ description, shortDescription, specializedFrom, status, props, events, contextVars, apis, nonVisual, opaque, themeVars, defaultThemeVars, toneSpecificThemeVars, allowArbitraryProps, docFolder, }: ComponentMetadata<TProps, TEvents, TContextVars, TApis>): ComponentMetadata<TProps, TEvents, TContextVars, TApis>;
+export declare function createMetadata<TProps extends Record<string, ComponentPropertyMetadata>, TEvents extends Record<string, ComponentPropertyMetadata>, TContextVars extends Record<string, ComponentPropertyMetadata> = Record<string, any>, TApis extends Record<string, ComponentPropertyMetadata> = Record<string, any>>({ description, shortDescription, specializedFrom, status, props, events, contextVars, apis, nonVisual, opaque, themeVars, defaultThemeVars, toneSpecificThemeVars, allowArbitraryProps, docFolder, isHtmlTag, }: ComponentMetadata<TProps, TEvents, TContextVars, TApis>): ComponentMetadata<TProps, TEvents, TContextVars, TApis>;
 
 export declare function d(description: string, availableValues?: readonly PropertyValueDescription[], valueType?: PropertyValueType, defaultValue?: any, isValid?: IsValidFunction<any>): ComponentPropertyMetadata;
 
@@ -838,7 +820,7 @@ declare interface EmptyStatement extends StatementBase {
 }
 
 /**
- * This component serves as an error boundary; it catches any errors within
+ * This React component serves as an error boundary; it catches any errors within
  * the nested components
  */
 export declare class ErrorBoundary extends default_2.Component<Props, State> {
@@ -847,6 +829,9 @@ export declare class ErrorBoundary extends default_2.Component<Props, State> {
      * This method implements the Error Boundaries for the React application.
      * It is invoked if errors occur during the rendering phase of any lifecycle
      * methods or children components.
+     *
+     * DO NOT DELETE this method! Though it is not referenced directly from the code,
+     * it is a required part of the React component lifecycle.
      */
     static getDerivedStateFromError(error: Error): State;
     /**
@@ -863,6 +848,9 @@ export declare class ErrorBoundary extends default_2.Component<Props, State> {
      * @param snapshot Optional snapshot (not used in this component)
      */
     componentDidUpdate(prevProps: Readonly<Props>, prevState: Readonly<State>, snapshot?: any): void;
+    /**
+     * Display an error message if an error occurred during rendering.
+     */
     render(): string | number | boolean | Iterable<default_2.ReactNode> | JSX_2.Element;
 }
 
@@ -880,6 +868,14 @@ declare interface ExpressionStatement extends StatementBase {
     expression: Expression;
 }
 
+declare interface Extension {
+    namespace?: string;
+    components?: ComponentExtension[];
+    themes?: ThemeDefinition[];
+}
+
+declare type ExtensionRegisteredCallbackFn = (extension: Extension) => void;
+
 /**
  * This type describes a font definition resource.
  */
@@ -1234,17 +1230,8 @@ declare type PropertyValueDescription = string | number | {
 
 declare type PropertyValueType = "boolean" | "string" | "number" | "any" | "ComponentDef";
 
-/**
- * This type represents the properties of the error boundary
- */
 declare interface Props {
-    /**
-     * Child nodes within the boundary
-     */
     children: ReactNode;
-    /**
-     * Whenever the value of this property changes, the boundary restores its "no error" state.
-     */
     node?: ComponentLike;
     location?: string;
 }
@@ -1410,7 +1397,7 @@ export declare const Stack: ForwardRefExoticComponent<Props_2 & RefAttributes<an
  * representation); ApiInterceptor can emulate some backend functionality
  * running in the browser.
  */
-export declare function StandaloneApp({ appDef, decorateComponentsWithTestId, debugEnabled, runtime, components: customComponents, componentManager, }: StandaloneAppProps): JSX_2.Element;
+export declare function StandaloneApp({ appDef, decorateComponentsWithTestId, debugEnabled, runtime, extensionManager, }: StandaloneAppProps): JSX_2.Element;
 
 export declare type StandaloneAppDescription = {
     name?: string;
@@ -1432,8 +1419,7 @@ declare type StandaloneAppProps = {
     decorateComponentsWithTestId?: boolean;
     debugEnabled?: boolean;
     runtime?: any;
-    components?: ComponentRendererDef[];
-    componentManager?: StandaloneComponentManager;
+    extensionManager?: StandaloneExtensionManager;
 };
 
 /**
@@ -1441,9 +1427,9 @@ declare type StandaloneAppProps = {
  * the xmlui component registry. The framework resolves the components used
  * in an application markup with this registry.
  */
-declare class StandaloneComponentManager {
-    subscriptions: Set<ComponentRegisteredCallbackFn>;
-    registeredComponents: Array<ComponentRendererDef>;
+declare class StandaloneExtensionManager {
+    subscriptions: Set<ExtensionRegisteredCallbackFn>;
+    registeredExtensions: Array<Extension>;
     constructor();
     /**
      * You can add a callback function invoked whenever a new component is added
@@ -1452,22 +1438,15 @@ declare class StandaloneComponentManager {
      * registry.
      * @param cb Function to call when a new component is registered
      */
-    subscribeToRegistrations(cb: ComponentRegisteredCallbackFn): void;
+    subscribeToRegistrations(cb: ExtensionRegisteredCallbackFn): void;
     /**
      * You can remove a function added by `subscribeToRegistrations`. After
      * calling this method, the particular callback function won't be invoked
      * for a new component registration.
      * @param cb Function to call when a new component is registered
      */
-    unSubscribeFromRegistrations(cb: ComponentRegisteredCallbackFn): void;
-    /**
-     * Use this function to add a new component to the registry. Adding a new
-     * component will invoke all callbacks that have already subscribed to the
-     * component registration.
-     * @param component The component to register. You can pass a single
-     * component or an array of components.
-     */
-    registerComponent(component: ComponentRendererDef | ComponentRendererDef[]): void;
+    unSubscribeFromRegistrations(cb: ExtensionRegisteredCallbackFn): void;
+    registerExtension(component: Extension | Extension[]): void;
 }
 
 export declare type StandaloneJsonConfig = {
@@ -1490,11 +1469,8 @@ export declare type StandaloneJsonConfig = {
  * @param components The related component's runtime representation
  * @returns The content's root element
  */
-export declare function startApp(runtime: any, components: ComponentRendererDef[] | undefined, componentManager: StandaloneComponentManager): Root;
+export declare function startApp(runtime: any, extensions?: Extension[] | Extension, extensionManager?: StandaloneExtensionManager): Root;
 
-/**
- * This type represents the current state of the error boundary
- */
 declare type State = {
     hasError: boolean;
     error: Error | null;

package/dist/xmlui.mjs

@@ -1,4 +1,4 @@
-import { A as e, B as t, E as r, I as o, h as p, f as n, S as c, c as d, b as u, e as S, i as l, p as A, s as C, t as m, j as B, u as f } from "./index-BYjaMGrD.mjs";
+import { A as e, B as t, E as r, I as o, h as p, f as n, S as c, c as d, b as u, e as S, i as l, p as A, s as C, t as m, j as B, u as f } from "./index-BLoqesEB.mjs";
 export {
   e as AppRoot,
   t as Button,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xmlui",
-  "version": "0.7.20",
+  "version": "0.7.22",
   "sideEffects": false,
   "scripts": {
     "start-test-bed": "cd src/testing/infrastructure && xmlui start",
@@ -26,7 +26,6 @@
     "@eslint-community/regexpp": "4.10.0",
     "@formkit/auto-animate": "0.7.0",
     "@headlessui/react": "1.7.16",
-    "@microsoft/tsdoc-config": "0.17.0",
     "@modyfi/vite-plugin-yaml": "1.1.0",
     "@monaco-editor/react": "4.4.6",
     "@nivo/bar": "0.87.0",
@@ -42,6 +41,7 @@
     "@radix-ui/react-popover": "^1.1.2",
     "@radix-ui/react-radio-group": "1.1.3",
     "@radix-ui/react-select": "^2.1.2",
+    "@radix-ui/react-slider": "^1.2.3",
     "@radix-ui/react-tabs": "1.1.0",
     "@radix-ui/react-visually-hidden": "1.0.3",
     "@remix-run/react": "2.9.1",
@@ -91,11 +91,13 @@
     "react-textarea-autosize": "8.5.3",
     "react-virtualized-auto-sizer": "1.0.24",
     "react-window": "1.8.10",
+    "recharts": "^2.15.1",
     "sass": "1.55.0",
     "scroll-into-view-if-needed": "^3.1.0",
     "shiki": "^1.14.1",
     "ts-node": "10.9.1",
     "use-context-selector": "1.4.1",
+    "virtua": "0.40.0",
     "vite-plugin-lib-inject-css": "1.3.0",
     "vite-plugin-svgr": "4.2.0",
     "yargs": "17.7.2"
@@ -130,7 +132,6 @@
     "rimraf": "6.0.1",
     "rollup-plugin-visualizer": "5.8.3",
     "serve": "14.2.0",
-    "typedoc": "^0.26.2",
     "typescript": "5.7.3",
     "vite": "5.4.9",
     "vite-plugin-dts": "4.5.0",