xmlui 0.9.30 → 0.9.32

package/dist/lib/xmlui.d.ts

@@ -12,6 +12,7 @@ import { RefAttributes } from 'react';
 import { RefObject } from 'react';
 import { Renderable } from 'react-hot-toast';
 import { Root } from 'react-dom/client';
+import { SetupWorker } from 'msw/browser';
 import { To } from 'react-router-dom';
 import { Toast } from 'react-hot-toast';
 import { ToastOptions } from 'react-hot-toast';
@@ -64,6 +65,13 @@ export declare type ApiInterceptorDefinition = {
     auth?: AuthDefinition;
 };
 
+export declare function ApiInterceptorProvider({ interceptor, children, apiWorker, useHashBasedRouting, }: {
+    interceptor?: ApiInterceptorDefinition;
+    children: ReactNode;
+    apiWorker?: SetupWorker;
+    useHashBasedRouting?: boolean;
+}): JSX_2.Element;
+
 /**
  * This interface defines the properties and services of an app context that the application components can use when
  * implementing their behavior.
@@ -812,6 +820,13 @@ declare interface DestructureBase extends ExpressionBase {
     oDestr?: ObjectDestructure[];
 }
 
+declare enum DiagnosticCategory {
+    Warning = 0,
+    Error = 1,
+    Suggestion = 2,
+    Message = 3
+}
+
 declare type DO_WHILE_STATEMENT = typeof T_DO_WHILE_STATEMENT;
 
 declare interface DoWhileStatement extends ScripNodeBase {
@@ -851,6 +866,34 @@ declare type EntrypointCompilation = CompilationUnit & {
     definition: ComponentDef;
 };
 
+declare enum ErrCodes {
+    onlyOneElem = "U002",
+    expTagOpen = "U003",
+    expTagIdent = "U004",
+    expCloseStart = "U005",
+    expEndOrClose = "U006",
+    tagNameMismatch = "U007",
+    expEnd = "U008",
+    expAttrIdent = "U009",
+    expEq = "U010",
+    expAttrValue = "U011",
+    duplAttr = "U012",
+    uppercaseAttr = "U013",
+    invalidChar = "W001",
+    untermStr = "W002",
+    untermComment = "W007",
+    untermCData = "W008",
+    untermScript = "W009"
+}
+
+declare interface Error_2 {
+    readonly category: DiagnosticCategory;
+    readonly code: ErrCodes;
+    readonly message: string;
+    readonly pos: number;
+    readonly end: number;
+}
+
 /**
  * This React component serves as an error boundary; it catches any errors within
  * the nested components
@@ -886,6 +929,16 @@ export declare class ErrorBoundary extends default_2.Component<Props, State> {
     render(): string | number | boolean | Iterable<default_2.ReactNode> | JSX_2.Element;
 }
 
+declare interface ErrorWithLineColInfo extends Error_2 {
+    line: number;
+    col: number;
+}
+
+/** returns a component definition containing the errors.
+ * It is a component and a compound component definition at the same time,
+ * so that it can be used to render the errors for a compound component as well*/
+export declare function errReportComponent(errors: ErrorWithLineColInfo[], fileName: number | string, compoundCompName: string | undefined): any;
+
 declare type Expression = UnaryExpression | BinaryExpression | SequenceExpression | ConditionalExpression | FunctionInvocationExpression | MemberAccessExpression | CalculatedMemberAccessExpression | Identifier | TemplateLiteralExpression | Literal | ArrayLiteral | ObjectLiteral | SpreadExpression | AssignmentExpression | NoArgExpression | ArrowExpression | PrefixOpExpression | PostfixOpExpression | ReactiveVarDeclaration | VarDeclaration | Destructure | ObjectDestructure | ArrayDestructure | SwitchCase;
 
 declare type EXPRESSION_STATEMENT = typeof T_EXPRESSION_STATEMENT;
@@ -1425,6 +1478,16 @@ declare interface SequenceExpression extends ExpressionBase {
 
 declare const sizeValues: string[];
 
+export declare const SolidThemeDefinition: ThemeDefinition;
+
+export declare const Spinner: ForwardRefExoticComponent<SpinnerProps & RefAttributes<HTMLDivElement>>;
+
+declare interface SpinnerProps {
+    delay?: number;
+    fullScreen?: boolean;
+    style?: CSSProperties;
+}
+
 export declare const Splitter: ({ initialPrimarySize, minPrimarySize, maxPrimarySize, orientation, children, style, swapped, floating, splitterTemplate, resize, }: SplitterProps) => JSX_2.Element;
 
 declare type SplitterProps = {
@@ -1672,6 +1735,24 @@ declare interface TemplateLiteralExpression extends ExpressionBase {
     segments: (Literal | Expression)[];
 }
 
+declare const Text_2: default_2.ForwardRefExoticComponent<Omit<TextProps, "ref"> & default_2.RefAttributes<unknown>>;
+export { Text_2 as Text }
+
+declare type TextProps = {
+    uid?: string;
+    children?: default_2.ReactNode;
+    variant?: TextVariant;
+    maxLines?: number;
+    preserveLinebreaks?: boolean;
+    ellipses?: boolean;
+    style?: CSSProperties;
+    [variantSpecificProps: string]: any;
+};
+
+declare type TextVariant = (typeof TextVariantKeys)[number];
+
+declare const TextVariantKeys: readonly ["abbr", "cite", "code", "codefence", "deleted", "inserted", "keyboard", "marked", "sample", "sub", "sup", "var", "strong", "em", "mono", "title", "subtitle", "small", "caption", "placeholder", "paragraph", "subheading", "tableheading", "secondary"];
+
 /**
  * This type represents a theme definition object. Theme files can use this object's JSON-serialized
  * format to define an app theme; an app can have multiple theme files.
@@ -1759,7 +1840,7 @@ declare type ThemeScope = {
 /**
  * This type describes one the available theme tones.
  */
-declare type ThemeTone = (typeof ThemeToneKeys)[number];
+export declare type ThemeTone = (typeof ThemeToneKeys)[number];
 
 /**
  * Each theme can have a light or a dark tone.
@@ -1927,6 +2008,8 @@ declare type UnaryOpSymbols = "+" | "-" | "~" | "!" | "typeof" | "delete";
  */
 declare type UpdateStateFn = (componentState: any, options?: any) => void;
 
+export declare function useApiWorkerContext(): SetupWorker;
+
 export declare function useColors(...colorNames: (string | ColorDef)[]): Record<string, string>;
 
 export declare function useDevTools(): {
@@ -2031,6 +2114,143 @@ declare interface WhileStatement extends ScripNodeBase {
     body: Statement;
 }
 
+declare interface XmlUiAttribute extends XmlUiNodeBase {
+    type: "XmlUiAttribute";
+    name: string;
+    namespace?: string;
+    value?: string;
+    preserveQuotes?: boolean;
+    preserveSpaces?: boolean;
+}
+
+declare interface XmlUiComment extends XmlUiNodeBase {
+    type: "XmlUiComment";
+    text?: string;
+}
+
+declare interface XmlUiElement extends XmlUiNodeBase {
+    type: "XmlUiElement";
+    name: string;
+    namespace?: string;
+    attributes?: XmlUiAttribute[];
+    text?: string;
+    preserveSpaces?: boolean;
+    childNodes?: XmlUiNode[];
+}
+
+declare type XmlUiFragment = XmlUiNode | XmlUiNode[];
+
+/**
+ * Helper class for XMLUI serialization and parsing
+ */
+export declare class XmlUiHelper {
+    /**
+     * Serialize the specified XML fragment into a string
+     * @param xml XML fragment to serialize
+     * @param options Formatting options to use
+     */
+    serialize(xml: XmlUiFragment, options?: XmluiSerializationOptions): string;
+    /**
+     * Transform the specified component definition into an XMLUI node
+     * @param def Component definitions
+     * @param options Transformation options
+     */
+    transformComponentDefinition(def: ComponentDef | CompoundComponentDef, options?: XmlUiTransformOptions): XmlUiFragment;
+    /**
+     * Transform the specified object into an XMLUI nodes
+     * @param def Object definition
+     * @param options Transformation options
+     */
+    transformObject(def: Record<string, any>, options?: XmlUiTransformOptions): XmlUiNode[] | null;
+    /**
+     * Transforms the specified simple component definition into an XMLUI node
+     * @param def Component definition
+     * @param options Transformation options
+     */
+    private transformSimpleComponentDefinition;
+    /**
+     * Transforms the specified simple component definition into an Xml node
+     * @param def Compound component definition
+     * @param options Transformation options
+     */
+    private transformCompoundComponentDefinition;
+    /**
+     * Transforms a value into an XMLUI element
+     * @param nodeName Name of the value node
+     * @param name Optional (property) name
+     * @param value Value to transform
+     * @param options Transformation options
+     */
+    private transformValue;
+    /**
+     * Transforms the specified simple component definition into an Xml node
+     * @param name Element name
+     * @param value Value to transform
+     * @param options Transformation options
+     */
+    private transformObjectValue;
+    /**
+     * Add a property to the specified XMLUI element
+     * @param element XML element
+     * @param name Element name
+     * @param value Element value
+     * @param options Transformation options
+     */
+    private addProperty;
+    private addComponentElement;
+    /**
+     * Adds a list to the specified XML element
+     * @param element XML element
+     * @param name Name of the list (child in `element`)
+     * @param prefix Prefix to use for the list
+     * @param list List with items
+     * @param options Transformation options
+     */
+    private addList;
+    /**
+     * Adds a component list to the specified element
+     * @param element XML element
+     * @param name Name to use for the wrapper element
+     * @param list List with component items
+     * @private
+     */
+    private addComponentList;
+}
+
+export declare function xmlUiMarkupToComponent(source: string, fileId?: string | number): {
+    component: null | ComponentDef | CompoundComponentDef;
+    errors: ErrorWithLineColInfo[];
+    erroneousCompoundComponentName?: string;
+};
+
+export declare type XmlUiNode = XmlUiComment | XmlUiAttribute | XmlUiElement;
+
+declare interface XmlUiNodeBase {
+    type: XmlUiNode["type"];
+}
+
+declare type XmluiSerializationOptions = {
+    prettify?: boolean;
+    indents?: number;
+    lineLength?: number;
+    useQuotes?: boolean;
+    useSpaceBeforeClose?: boolean;
+    breakClosingTag?: boolean;
+};
+
+export declare const XmlUiThemeDefinition: ThemeDefinition;
+
+/**
+ * Options to use with markup transformation from memory format to XMLUI structure
+ */
+declare type XmlUiTransformOptions = {
+    preserveLineBreaks?: boolean;
+    preserveSpecialChars?: boolean;
+    removeQuotes?: boolean;
+    extractProps?: boolean;
+    preferTextToValue?: boolean;
+};
+
 export { }
 
 
@@ -2053,636 +2273,3 @@ declare global {
         TEST_ENV: StandaloneAppDescription | undefined;
     }
 }
-
-
-declare namespace m {
-    function from(e: any, t: any, n: any, r: any, s: any, o: any): any;
-}
-
-
-declare namespace ae {
-    let Continue: number;
-    let SwitchingProtocols: number;
-    let Processing: number;
-    let EarlyHints: number;
-    let Ok: number;
-    let Created: number;
-    let Accepted: number;
-    let NonAuthoritativeInformation: number;
-    let NoContent: number;
-    let ResetContent: number;
-    let PartialContent: number;
-    let MultiStatus: number;
-    let AlreadyReported: number;
-    let ImUsed: number;
-    let MultipleChoices: number;
-    let MovedPermanently: number;
-    let Found: number;
-    let SeeOther: number;
-    let NotModified: number;
-    let UseProxy: number;
-    let Unused: number;
-    let TemporaryRedirect: number;
-    let PermanentRedirect: number;
-    let BadRequest: number;
-    let Unauthorized: number;
-    let PaymentRequired: number;
-    let Forbidden: number;
-    let NotFound: number;
-    let MethodNotAllowed: number;
-    let NotAcceptable: number;
-    let ProxyAuthenticationRequired: number;
-    let RequestTimeout: number;
-    let Conflict: number;
-    let Gone: number;
-    let LengthRequired: number;
-    let PreconditionFailed: number;
-    let PayloadTooLarge: number;
-    let UriTooLong: number;
-    let UnsupportedMediaType: number;
-    let RangeNotSatisfiable: number;
-    let ExpectationFailed: number;
-    let ImATeapot: number;
-    let MisdirectedRequest: number;
-    let UnprocessableEntity: number;
-    let Locked: number;
-    let FailedDependency: number;
-    let TooEarly: number;
-    let UpgradeRequired: number;
-    let PreconditionRequired: number;
-    let TooManyRequests: number;
-    let RequestHeaderFieldsTooLarge: number;
-    let UnavailableForLegalReasons: number;
-    let InternalServerError: number;
-    let NotImplemented: number;
-    let BadGateway: number;
-    let ServiceUnavailable: number;
-    let GatewayTimeout: number;
-    let HttpVersionNotSupported: number;
-    let VariantAlsoNegotiates: number;
-    let InsufficientStorage: number;
-    let LoopDetected: number;
-    let NotExtended: number;
-    let NetworkAuthenticationRequired: number;
-}
-
-
-declare namespace a {
-    namespace root {
-        let patterns: ({
-            include: string;
-            begin?: undefined;
-            beginCaptures?: undefined;
-            end?: undefined;
-            endCaptures?: undefined;
-            contentName?: undefined;
-        } | {
-            begin: string;
-            beginCaptures: {
-                1: {
-                    name: string;
-                };
-                2: {
-                    name: string;
-                };
-                3: {
-                    name: string;
-                };
-            };
-            end: string;
-            endCaptures: {
-                0: {
-                    name: string;
-                };
-            };
-            contentName: string;
-            include?: undefined;
-        })[];
-    }
-    namespace methodTag {
-        export let begin: string;
-        export let beginCaptures: {
-            1: {
-                name: string;
-            };
-            2: {
-                name: string;
-            };
-            3: {
-                name: string;
-            };
-        };
-        export let endCaptures: {
-            0: {
-                name: string;
-            };
-        };
-        export let applyEndPatternLast: string;
-        let patterns_1: ({
-            include: string;
-            begin?: undefined;
-            beginCaptures?: undefined;
-            endCaptures?: undefined;
-            contentName?: undefined;
-            patterns?: undefined;
-            end?: undefined;
-        } | {
-            begin: string;
-            beginCaptures: {
-                0: {
-                    name: string;
-                };
-            };
-            endCaptures: {
-                1: {
-                    name: string;
-                };
-                2: {
-                    name: string;
-                };
-                3: {
-                    name: string;
-                };
-            };
-            contentName: string;
-            patterns: {
-                include: string;
-            }[];
-            end: string;
-            include?: undefined;
-        })[];
-        export { patterns_1 as patterns };
-        export let end: string;
-    }
-    namespace eventTag {
-        let begin_1: string;
-        export { begin_1 as begin };
-        let beginCaptures_1: {
-            1: {
-                name: string;
-            };
-            2: {
-                name: string;
-            };
-            3: {
-                name: string;
-            };
-        };
-        export { beginCaptures_1 as beginCaptures };
-        let endCaptures_1: {
-            0: {
-                name: string;
-            };
-        };
-        export { endCaptures_1 as endCaptures };
-        let applyEndPatternLast_1: string;
-        export { applyEndPatternLast_1 as applyEndPatternLast };
-        let patterns_2: ({
-            include: string;
-            begin?: undefined;
-            beginCaptures?: undefined;
-            endCaptures?: undefined;
-            patterns?: undefined;
-            end?: undefined;
-        } | {
-            begin: string;
-            beginCaptures: {
-                0: {
-                    name: string;
-                };
-            };
-            endCaptures: {
-                1: {
-                    name: string;
-                };
-                2: {
-                    name: string;
-                };
-                3: {
-                    name: string;
-                };
-            };
-            patterns: {
-                include: string;
-            }[];
-            end: string;
-            include?: undefined;
-        })[];
-        export { patterns_2 as patterns };
-        let end_1: string;
-        export { end_1 as end };
-    }
-    namespace fieldTag {
-        let begin_2: string;
-        export { begin_2 as begin };
-        let beginCaptures_2: {
-            1: {
-                name: string;
-            };
-            2: {
-                name: string;
-            };
-            3: {
-                name: string;
-            };
-        };
-        export { beginCaptures_2 as beginCaptures };
-        let endCaptures_2: {
-            0: {
-                name: string;
-            };
-        };
-        export { endCaptures_2 as endCaptures };
-        let applyEndPatternLast_2: string;
-        export { applyEndPatternLast_2 as applyEndPatternLast };
-        let patterns_3: ({
-            include: string;
-            begin?: undefined;
-            beginCaptures?: undefined;
-            endCaptures?: undefined;
-            patterns?: undefined;
-            end?: undefined;
-        } | {
-            begin: string;
-            beginCaptures: {
-                0: {
-                    name: string;
-                };
-            };
-            endCaptures: {
-                1: {
-                    name: string;
-                };
-                2: {
-                    name: string;
-                };
-                3: {
-                    name: string;
-                };
-            };
-            patterns: {
-                include: string;
-            }[];
-            end: string;
-            include?: undefined;
-        })[];
-        export { patterns_3 as patterns };
-        let end_2: string;
-        export { end_2 as end };
-    }
-    namespace itemTag {
-        let begin_3: string;
-        export { begin_3 as begin };
-        let beginCaptures_3: {
-            1: {
-                name: string;
-            };
-            2: {
-                name: string;
-            };
-            3: {
-                name: string;
-            };
-        };
-        export { beginCaptures_3 as beginCaptures };
-        let endCaptures_3: {
-            0: {
-                name: string;
-            };
-        };
-        export { endCaptures_3 as endCaptures };
-        let applyEndPatternLast_3: string;
-        export { applyEndPatternLast_3 as applyEndPatternLast };
-        let patterns_4: ({
-            include: string;
-            begin?: undefined;
-            beginCaptures?: undefined;
-            endCaptures?: undefined;
-            patterns?: undefined;
-            end?: undefined;
-        } | {
-            begin: string;
-            beginCaptures: {
-                0: {
-                    name: string;
-                };
-            };
-            endCaptures: {
-                1: {
-                    name: string;
-                };
-                2: {
-                    name: string;
-                };
-                3: {
-                    name: string;
-                };
-            };
-            patterns: {
-                include: string;
-            }[];
-            end: string;
-            include?: undefined;
-        })[];
-        export { patterns_4 as patterns };
-        let end_3: string;
-        export { end_3 as end };
-    }
-    namespace bindingExpr {
-        export let contentName: string;
-        let begin_4: string;
-        export { begin_4 as begin };
-        let end_4: string;
-        export { end_4 as end };
-        let beginCaptures_4: {
-            0: {
-                name: string;
-            };
-        };
-        export { beginCaptures_4 as beginCaptures };
-        let endCaptures_4: {
-            0: {
-                name: string;
-            };
-        };
-        export { endCaptures_4 as endCaptures };
-        let patterns_5: {
-            include: string;
-        }[];
-        export { patterns_5 as patterns };
-    }
-    namespace helperTag {
-        let patterns_6: {
-            include: string;
-        }[];
-        export { patterns_6 as patterns };
-    }
-    namespace valueAttributeScriptInside {
-        let patterns_7: ({
-            captures: {
-                1: {
-                    name: string;
-                };
-                2: {
-                    name: string;
-                };
-            };
-            match: string;
-            include?: undefined;
-        } | {
-            include: string;
-            captures?: undefined;
-            match?: undefined;
-        })[];
-        export { patterns_7 as patterns };
-    }
-    namespace scriptTag {
-        let begin_5: string;
-        export { begin_5 as begin };
-        let end_5: string;
-        export { end_5 as end };
-        let contentName_1: string;
-        export { contentName_1 as contentName };
-        let beginCaptures_5: {
-            1: {
-                name: string;
-            };
-            2: {
-                name: string;
-            };
-            3: {
-                name: string;
-            };
-            4: {
-                name: string;
-            };
-        };
-        export { beginCaptures_5 as beginCaptures };
-        let endCaptures_5: {
-            1: {
-                name: string;
-            };
-            2: {
-                name: string;
-            };
-            3: {
-                name: string;
-            };
-            4: {
-                name: string;
-            };
-        };
-        export { endCaptures_5 as endCaptures };
-        let patterns_8: {
-            include: string;
-        }[];
-        export { patterns_8 as patterns };
-    }
-    namespace textWithBindingExpr {
-        let patterns_9: {
-            include: string;
-        }[];
-        export { patterns_9 as patterns };
-    }
-    namespace propOrVarTag {
-        let begin_6: string;
-        export { begin_6 as begin };
-        let beginCaptures_6: {
-            1: {
-                name: string;
-            };
-            2: {
-                name: string;
-            };
-            3: {
-                name: string;
-            };
-        };
-        export { beginCaptures_6 as beginCaptures };
-        let end_6: string;
-        export { end_6 as end };
-        let endCaptures_6: {
-            1: {
-                name: string;
-            };
-        };
-        export { endCaptures_6 as endCaptures };
-        let patterns_10: {
-            include: string;
-        }[];
-        export { patterns_10 as patterns };
-    }
-    namespace componentTag {
-        let begin_7: string;
-        export { begin_7 as begin };
-        let beginCaptures_7: {
-            1: {
-                name: string;
-            };
-            2: {
-                name: string;
-            };
-            3: {
-                name: string;
-            };
-        };
-        export { beginCaptures_7 as beginCaptures };
-        let end_7: string;
-        export { end_7 as end };
-        let endCaptures_7: {
-            1: {
-                name: string;
-            };
-        };
-        export { endCaptures_7 as endCaptures };
-        let patterns_11: {
-            include: string;
-        }[];
-        export { patterns_11 as patterns };
-    }
-    namespace quotedStringJsInside {
-        let begin_8: string;
-        export { begin_8 as begin };
-        let beginCaptures_8: {
-            0: {
-                name: string;
-            };
-        };
-        export { beginCaptures_8 as beginCaptures };
-        let end_8: string;
-        export { end_8 as end };
-        let endCaptures_8: {
-            0: {
-                name: string;
-            };
-        };
-        export { endCaptures_8 as endCaptures };
-        let contentName_2: string;
-        export { contentName_2 as contentName };
-        let patterns_12: {
-            include: string;
-        }[];
-        export { patterns_12 as patterns };
-    }
-    namespace entity {
-        let captures: {
-            1: {
-                name: string;
-            };
-            2: {
-                name: string;
-            };
-            3: {
-                name: string;
-            };
-        };
-        let match: string;
-    }
-    namespace eventHandler {
-        let patterns_13: ({
-            captures: {
-                1: {
-                    name: string;
-                };
-                2: {
-                    name: string;
-                };
-            };
-            match: string;
-            include?: undefined;
-        } | {
-            include: string;
-            captures?: undefined;
-            match?: undefined;
-        })[];
-        export { patterns_13 as patterns };
-    }
-    namespace attribute {
-        let patterns_14: ({
-            begin: string;
-            end: string;
-            beginCaptures: {
-                1: {
-                    name: string;
-                };
-                2: {
-                    name: string;
-                };
-                3: {
-                    name: string;
-                };
-                4: {
-                    name: string;
-                };
-            };
-            endCaptures: {
-                0: {
-                    name: string;
-                };
-            };
-            contentName: string;
-            patterns: {
-                include: string;
-            }[];
-            match?: undefined;
-            captures?: undefined;
-            name?: undefined;
-        } | {
-            match: string;
-            captures: {
-                1: {
-                    name: string;
-                };
-                2: {
-                    name: string;
-                };
-                3: {
-                    name: string;
-                };
-                4: {
-                    name: string;
-                };
-            };
-            begin?: undefined;
-            end?: undefined;
-            beginCaptures?: undefined;
-            endCaptures?: undefined;
-            contentName?: undefined;
-            patterns?: undefined;
-            name?: undefined;
-        } | {
-            match: string;
-            name: string;
-            captures: {
-                1: {
-                    name: string;
-                };
-                2: {
-                    name: string;
-                };
-                "3"?: undefined;
-                "4"?: undefined;
-            };
-            begin?: undefined;
-            end?: undefined;
-            beginCaptures?: undefined;
-            endCaptures?: undefined;
-            contentName?: undefined;
-            patterns?: undefined;
-        })[];
-        export { patterns_14 as patterns };
-    }
-    namespace comments {
-        let patterns_15: {
-            begin: string;
-            captures: {
-                0: {
-                    name: string;
-                };
-            };
-            end: string;
-            name: string;
-        }[];
-        export { patterns_15 as patterns };
-    }
-}