@sitecore-feaas/clientside 0.1.56 → 0.2.1

package/types/components/FEAASBase.d.ts

@@ -1,299 +0,0 @@
-import type { ReactElement, ReactNode } from 'react';
-import type ReactDOMClient from 'react-dom/client';
-import type ReactDOM from 'react-dom';
-import type React from 'react';
-import { ControlledPromise } from '../utils/promise.js';
-export type OptionalExcept<T, K extends keyof T> = Pick<T, K> & Partial<Omit<T, K>>;
-declare var WebComponent: {
-    new (): HTMLElement;
-    prototype: HTMLElement;
-};
-export interface ReactPayload {
-    React: typeof React;
-    ReactDOM: typeof ReactDOM;
-    ReactDOMClient: typeof ReactDOMClient;
-}
-/**
- * FEAASBase is a superclass for FEAAS components with optional react support.
- *
- * Initialization lifecycle:
- *
- * - `set(props)`
- * - `scheduleRender()` - any attribute change causes render to schedule to next frame
- * - `whenRendered.restart()` - rendering promise is reset and will resolve after render
- * - `advance()` - called on next frame
- * - `if (isReadyToLoad()) => boolean` - check if component has all necessary properties to load
- * - `load() => payload` => component is loaded
- * - `onLoad?(payload)` => invoke loaded callback
- * - `advance()` => going further in state machine
- * - `flush()` => flushes all react changes if needed
- * - `update()` => component-specific method (or react) to render changes to dom
- * - `render(payload, props)` => render means react
- * - `whenRendered.resolve()` - rendering promise is resolved after rendering
- * - `whenLoaded.resolved()` - resolved after loading and rendering
- */
-export declare class FEAASBase<Props = any, Payload = any> extends WebComponent {
-    static observedAttributes: string[];
-    defaultProps: Partial<Props>;
-    /** Return attributes as parsed values */
-    getProps(context?: HTMLElement): any;
-    /** Properties parsed in current tick */
-    props: Props;
-    overrides: Props;
-    /** Timer until next tick */
-    nextRender: number;
-    /** Is/was component in the dom? */
-    connected: boolean;
-    refs: Record<string, FEAASBase>;
-    descendants: FEAASBase[];
-    /** Result of lazy loading */
-    payload: Payload;
-    whenLoaded: ControlledPromise<Payload>;
-    constructor();
-    /** Attaches shadow root if getShadowRootOptions any settings, or uses element itself */
-    getRoot(): FEAASBase | HTMLElement | ShadowRoot;
-    /** Attribute changes trigger props parsing and schedules re-rendering */
-    attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
-    /** Components parses its attributes when connected, and schedules rendeirng */
-    connectedCallback(): void;
-    disconnectedCallback(): void;
-    /**
-     * Web components are initialized depth-first, making child elements render before its parents. This could here
-     * attempts to avoid this and inverts the initialization logic, so that children are initialized in the context of its
-     * already-initialized parents.
-     *
-     * FEAAS components dispatch `feaasMount` event that allows components to store references to each other. In addition
-     * it allows external scripts to listen for initialization of FEAAS components
-     */
-    mount(): void;
-    log(...args: any): void;
-    /** Nothing special happens on unmount, except setting a flag */
-    unmount(): void;
-    getParent(onlyFeaas?: boolean): HTMLElement;
-    getElements(root?: HTMLElement | ShadowRoot, onlyFeaas?: boolean): HTMLElement[];
-    /** Catch-all event handler that dispatches events to callback */
-    handleEvent(event: Event): void;
-    /** Act on children element being removed */
-    unnestedCallback(target: FEAASBase): void;
-    /** Act on children element being added */
-    nestedCallback(target: FEAASBase): boolean | void;
-    getComponentName(): string;
-    /**
-     * Check if lazy component is ready to be loaded. For example a component may stay unloaded unless certain attributes
-     * are set
-     */
-    isReadyToLoad(): boolean;
-    /** Generic error handler */
-    onError(error: Error, where?: string, handled?: boolean): boolean;
-    shouldUpdateOnLoad(): boolean;
-    onLoad: (payload: Payload) => void;
-    /** Load lazy component & render */
-    advance(): Promise<void>;
-    flush(): void;
-    /** Invoke preloading logic that needs to finish before component can render */
-    load(): Promise<any>;
-    /**
-     * Component-specific logic that updates the DOM. Default render implementation assume react rendering, in that case
-     * the component needs to provide React & ReactDOM references in its payload. Web component redefine its render to not
-     * use react at all
-     */
-    update(): any;
-    invokeReactRendering(): ReactNode;
-    reactWrapper: React.FunctionComponent;
-    reactErrorBoundary: new (...args: any) => React.Component<{
-        children: any;
-        slot: string;
-    }, {
-        error: Error;
-    }>;
-    reactRoot: ReactDOMClient.Root;
-    getReactErrorBoundary(target?: FEAASBase, displayName?: string): (new (...args: any) => React.Component<{
-        children: any;
-        slot: string;
-    }, {
-        error: Error;
-    }, any>) | {
-        new (props: {
-            children: any;
-            slot: string;
-        } | Readonly<{
-            children: any;
-            slot: string;
-        }>): {
-            state: {
-                error: Error;
-            };
-            componentDidCatch(error: Error, errorInfo: any): void;
-            render(): any;
-            context: unknown;
-            setState<K extends "error">(state: {
-                error: Error;
-            } | ((prevState: Readonly<{
-                error: Error;
-            }>, props: Readonly<{
-                children: any;
-                slot: string;
-            }>) => {
-                error: Error;
-            } | Pick<{
-                error: Error;
-            }, K>) | Pick<{
-                error: Error;
-            }, K>, callback?: () => void): void;
-            forceUpdate(callback?: () => void): void;
-            readonly props: Readonly<{
-                children: any;
-                slot: string;
-            }>;
-            refs: {
-                [key: string]: React.ReactInstance;
-            };
-            componentDidMount?(): void;
-            shouldComponentUpdate?(nextProps: Readonly<{
-                children: any;
-                slot: string;
-            }>, nextState: Readonly<{
-                error: Error;
-            }>, nextContext: any): boolean;
-            componentWillUnmount?(): void;
-            getSnapshotBeforeUpdate?(prevProps: Readonly<{
-                children: any;
-                slot: string;
-            }>, prevState: Readonly<{
-                error: Error;
-            }>): any;
-            componentDidUpdate?(prevProps: Readonly<{
-                children: any;
-                slot: string;
-            }>, prevState: Readonly<{
-                error: Error;
-            }>, snapshot?: any): void;
-            componentWillMount?(): void;
-            UNSAFE_componentWillMount?(): void;
-            componentWillReceiveProps?(nextProps: Readonly<{
-                children: any;
-                slot: string;
-            }>, nextContext: any): void;
-            UNSAFE_componentWillReceiveProps?(nextProps: Readonly<{
-                children: any;
-                slot: string;
-            }>, nextContext: any): void;
-            componentWillUpdate?(nextProps: Readonly<{
-                children: any;
-                slot: string;
-            }>, nextState: Readonly<{
-                error: Error;
-            }>, nextContext: any): void;
-            UNSAFE_componentWillUpdate?(nextProps: Readonly<{
-                children: any;
-                slot: string;
-            }>, nextState: Readonly<{
-                error: Error;
-            }>, nextContext: any): void;
-        };
-        new (props: {
-            children: any;
-            slot: string;
-        }, context: any): {
-            state: {
-                error: Error;
-            };
-            componentDidCatch(error: Error, errorInfo: any): void;
-            render(): any;
-            context: unknown;
-            setState<K extends "error">(state: {
-                error: Error;
-            } | ((prevState: Readonly<{
-                error: Error;
-            }>, props: Readonly<{
-                children: any;
-                slot: string;
-            }>) => {
-                error: Error;
-            } | Pick<{
-                error: Error;
-            }, K>) | Pick<{
-                error: Error;
-            }, K>, callback?: () => void): void;
-            forceUpdate(callback?: () => void): void;
-            readonly props: Readonly<{
-                children: any;
-                slot: string;
-            }>;
-            refs: {
-                [key: string]: React.ReactInstance;
-            };
-            componentDidMount?(): void;
-            shouldComponentUpdate?(nextProps: Readonly<{
-                children: any;
-                slot: string;
-            }>, nextState: Readonly<{
-                error: Error;
-            }>, nextContext: any): boolean;
-            componentWillUnmount?(): void;
-            getSnapshotBeforeUpdate?(prevProps: Readonly<{
-                children: any;
-                slot: string;
-            }>, prevState: Readonly<{
-                error: Error;
-            }>): any;
-            componentDidUpdate?(prevProps: Readonly<{
-                children: any;
-                slot: string;
-            }>, prevState: Readonly<{
-                error: Error;
-            }>, snapshot?: any): void;
-            componentWillMount?(): void;
-            UNSAFE_componentWillMount?(): void;
-            componentWillReceiveProps?(nextProps: Readonly<{
-                children: any;
-                slot: string;
-            }>, nextContext: any): void;
-            UNSAFE_componentWillReceiveProps?(nextProps: Readonly<{
-                children: any;
-                slot: string;
-            }>, nextContext: any): void;
-            componentWillUpdate?(nextProps: Readonly<{
-                children: any;
-                slot: string;
-            }>, nextState: Readonly<{
-                error: Error;
-            }>, nextContext: any): void;
-            UNSAFE_componentWillUpdate?(nextProps: Readonly<{
-                children: any;
-                slot: string;
-            }>, nextState: Readonly<{
-                error: Error;
-            }>, nextContext: any): void;
-        };
-        getDerivedStateFromError(error: Error): {
-            error: Error;
-        };
-        contextType?: React.Context<any>;
-    };
-    getReactElement(target?: FEAASBase, props?: any): JSX.Element;
-    getReactWrapper(target?: FEAASBase, displayName?: string): React.FunctionComponent<{}>;
-    uid: string;
-    getUID(): string;
-    forceUpdateReact: (node?: ReactNode) => void;
-    /**
-     * Render method that is pretty much the same as React Functional component, but with extra second argument for
-     * payload (usually result of import, it is expected to have React in scope).
-     */
-    render?(props: React.PropsWithChildren<Props>, payload: Payload): ReactNode | ReactElement;
-    useShadowRoot: boolean;
-    getShadowRoot(): ShadowRoot;
-    getReactRootElement(): HTMLElement | ShadowRoot;
-    /** Set props and return values on new next tick */
-    set(overrides?: Partial<Props>): this;
-    import(path: string): Promise<Payload>;
-    /** Schedule rendering on next tick, to batch multiple attribute changes */
-    initialized: boolean;
-    whenRendered: ControlledPromise<this>;
-    scheduleRender(): void;
-    formatURL(src: string, hostname: string): string;
-    getContextAttribute(name: string, element?: this): string;
-    static register(tagName: string, win?: Window): void;
-}
-export { FEAASBase as Base };
-//# sourceMappingURL=FEAASBase.d.ts.map

package/types/components/FEAASBase.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FEAASBase.d.ts","sourceRoot":"","sources":["../../src/components/FEAASBase.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAyB,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAC3E,OAAO,KAAK,cAAc,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,QAAQ,MAAM,WAAW,CAAA;AACrC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAC9B,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAEvD,MAAM,MAAM,cAAc,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAGnF,QAAA,IAAI,YAAY;;;CAOC,CAAA;AAEjB,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,OAAO,KAAK,CAAA;IACnB,QAAQ,EAAE,OAAO,QAAQ,CAAA;IACzB,cAAc,EAAE,OAAO,cAAc,CAAA;CACtC;AACD;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,SAAS,CAAC,KAAK,GAAG,GAAG,EAAE,OAAO,GAAG,GAAG,CAAE,SAAQ,YAAY;IACrE,MAAM,CAAC,kBAAkB,EAAE,MAAM,EAAE,CAAA;IAEnC,YAAY,iBAAuB;IAEnC,yCAAyC;IACzC,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,GAAG;IAIpC,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAA;IACZ,SAAS,EAAE,KAAK,CAAA;IAEhB,4BAA4B;IAC5B,UAAU,EAAE,MAAM,CAAA;IAElB,mCAAmC;IACnC,SAAS,UAAQ;IAEjB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAK;IACpC,WAAW,EAAE,SAAS,EAAE,CAAK;IAE7B,6BAA6B;IAC7B,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,6BAER;;IAQF,wFAAwF;IACxF,OAAO,IAAI,SAAS,GAAG,WAAW,GAAG,UAAU;IAI/C,yEAAyE;IACzE,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAIzE,+EAA+E;IAC/E,iBAAiB;IAGjB,oBAAoB;IAGpB;;;;;;;OAOG;IACH,KAAK;IAgBL,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG;IAIhB,gEAAgE;IAChE,OAAO;IAOP,SAAS,CAAC,SAAS,UAAO;IAU1B,WAAW,CAAC,IAAI,GAAE,WAAW,GAAG,UAA2B,EAAE,SAAS,UAAO,GAAG,WAAW,EAAE;IAa7F,iEAAiE;IACjE,WAAW,CAAC,KAAK,EAAE,KAAK;IAYxB,4CAA4C;IAC5C,gBAAgB,CAAC,MAAM,EAAE,SAAS;IAYlC,0CAA0C;IAC1C,cAAc,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,GAAG,IAAI;IAkBjD,gBAAgB;IAIhB;;;OAGG;IACH,aAAa;IAIb,4BAA4B;IAC5B,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,GAAE,MAAmB,EAAE,OAAO,UAAQ;IAcjE,kBAAkB;IAIlB,MAAM,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;IAElC,mCAAmC;IAC7B,OAAO;IA2Bb,KAAK;IASL,+EAA+E;IAC/E,IAAI;IAIJ;;;;OAIG;IACH,MAAM,IAAI,GAAG;IAqBb,oBAAoB,IAAI,SAAS;IAajC,YAAY,EAAE,KAAK,CAAC,iBAAiB,CAAA;IACrC,kBAAkB,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,KAAK,KAAK,CAAC,SAAS,CAAC;QAAE,QAAQ,EAAE,GAAG,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE;QAAE,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC,CAAA;IAC5G,SAAS,EAAE,cAAc,CAAC,IAAI,CAAA;IAE9B,qBAAqB,CAAC,MAAM,GAAE,SAAgB,EAAE,WAAW,SAAiB;;;;;;;sBAK5D,GAAG;kBAAQ,MAAM;;sBAAjB,GAAG;kBAAQ,MAAM;;;;;qCAWJ,KAAK,aAAa,GAAG;;;;uBAVrC,KAAK;;uBAAL,KAAK;;0BADF,GAAG;sBAAQ,MAAM;;uBACpB,KAAK;;uBAAL,KAAK;;uBAAL,KAAK;;;;0BADF,GAAG;sBAAQ,MAAM;;;;;;;0BAAjB,GAAG;sBAAQ,MAAM;;uBACpB,KAAK;;;;0BADF,GAAG;sBAAQ,MAAM;;uBACpB,KAAK;;;0BADF,GAAG;sBAAQ,MAAM;;uBACpB,KAAK;;;;;0BADF,GAAG;sBAAQ,MAAM;;;0BAAjB,GAAG;sBAAQ,MAAM;;;0BAAjB,GAAG;sBAAQ,MAAM;;uBACpB,KAAK;;;0BADF,GAAG;sBAAQ,MAAM;;uBACpB,KAAK;;;;sBADF,GAAG;kBAAQ,MAAM;;;;;qCAWJ,KAAK,aAAa,GAAG;;;;uBAVrC,KAAK;;uBAAL,KAAK;;0BADF,GAAG;sBAAQ,MAAM;;uBACpB,KAAK;;uBAAL,KAAK;;uBAAL,KAAK;;;;0BADF,GAAG;sBAAQ,MAAM;;;;;;;0BAAjB,GAAG;sBAAQ,MAAM;;uBACpB,KAAK;;;;0BADF,GAAG;sBAAQ,MAAM;;uBACpB,KAAK;;;0BADF,GAAG;sBAAQ,MAAM;;uBACpB,KAAK;;;;;0BADF,GAAG;sBAAQ,MAAM;;;0BAAjB,GAAG;sBAAQ,MAAM;;;0BAAjB,GAAG;sBAAQ,MAAM;;uBACpB,KAAK;;;0BADF,GAAG;sBAAQ,MAAM;;uBACpB,KAAK;;;wCAMyB,KAAK;;;;;IAuBhD,eAAe,CAAC,MAAM,GAAE,SAAgB,EAAE,KAAK,CAAC,EAAE,GAAG;IAWrD,eAAe,CAAC,MAAM,GAAE,SAAgB,EAAE,WAAW,SAAiB;IAuBtE,GAAG,EAAE,MAAM,CAAA;IACX,MAAM;IAGN,gBAAgB,EAAE,CAAC,IAAI,CAAC,EAAE,SAAS,KAAK,IAAI,CAAA;IAE5C;;;OAGG;IACH,MAAM,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,YAAY;IAE1F,aAAa,EAAE,OAAO,CAAA;IACtB,aAAa;IAMb,mBAAmB,IAAI,WAAW,GAAG,UAAU;IAI/C,mDAAmD;IACnD,GAAG,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC;IA2B9B,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAItC,2EAA2E;IAC3E,WAAW,EAAE,OAAO,CAAA;IACpB,YAAY,0BAGX;IACD,cAAc;IAWd,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAQvC,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,OAAO;IAWhD,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM;CAM9C;AAED,OAAO,EAAE,SAAS,IAAI,IAAI,EAAE,CAAA"}