@cleanweb/oore 2.0.0-alpha.34 → 2.0.0-alpha.35

package/build/_cjs/helpers/index.js

@@ -1,34 +0,0 @@
-"use strict";
-/**
- * <!-- @ mergeModuleWith API -->
- * @module Helpers
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.noOp = void 0;
-__exportStar(require("./mount-state.js"), exports);
-__exportStar(require("./rerender.js"), exports);
-__exportStar(require("./use-component/index.js"), exports);
-__exportStar(require("./object-gate.js"), exports);
-__exportStar(require("./debounce/index.js"), exports);
-__exportStar(require("./debounce/react-state.js"), exports);
-__exportStar(require("./type-guards.js"), exports);
-/**
- * An empty function.
- * It returns (void) without performing any operations.
- */
-const noOp = () => { };
-exports.noOp = noOp;

package/build/_cjs/helpers/mount-state.d.ts

@@ -1,5 +0,0 @@
-/**
- * Returns a value that is false before the component has been mounted,
- * then true during all subsequent rerenders.
- */
-export declare const useMountState: () => () => boolean;

package/build/_cjs/helpers/mount-state.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useMountState = void 0;
-const react_1 = require("react");
-/**
- * Returns a value that is false before the component has been mounted,
- * then true during all subsequent rerenders.
- */
-const useMountState = () => {
-    /**
-     * This must not be a state value. It should not be the cause of a rerender.
-     * It merely provides information about the render count,
-     * without influencing that count itself.
-     * So `mounted` should never be created with `useState`.
-     */
-    const mounted = (0, react_1.useRef)(false);
-    (0, react_1.useEffect)(() => {
-        mounted.current = true;
-        return () => {
-            mounted.current = false;
-        };
-    }, []);
-    return () => mounted.current;
-};
-exports.useMountState = useMountState;

package/build/_cjs/helpers/object-gate.d.ts

@@ -1,74 +0,0 @@
-type TRecord = Record<keyof any, any>;
-declare namespace _ObjectGate {
-    /** Configure property access for a proxy object. */
-    interface IGateConfig<TSource extends TRecord> {
-        /**
-         * The keys to be exposed for read access through the proxy.
-         * Defaults to [`Reflect.ownKeys(source)`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Reflect/ownKeys) —
-         * so if omitted, all ["_own properties_"](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Enumerability_and_ownership_of_properties)
-         * present on the source at
-         * instantiation time will be exposed for read access through the proxy.
-         */
-        getters?: Readonly<Array<keyof TSource>>;
-        /**
-         * Keys that should definitely be omitted from read access,
-         * even if they are present in {@link getters}.
-         * @default [] - Empty array.
-         */
-        gettersExclude?: Readonly<Array<keyof TSource>>;
-        /**
-         * The keys to be exposed for write access through the proxy.
-         * This defaults to an empty array, so if omitted, none of the gated
-         * properties will be writeable.
-         * @default [] - Empty array.
-         */
-        setters?: Readonly<Array<keyof TSource> | true>;
-        /**
-         * Keys that should definitely be omitted from write access,
-         * even if they are present in {@link setters}.
-         * @default [] - Empty array.
-         */
-        settersExclude?: Readonly<Array<keyof TSource>>;
-    }
-    type Params<TSource extends TRecord> = [
-        /**
-         * The target object, where the actual values are stored.
-         * Keys on the created gate object will use JavaScript getters to return
-         * the real-time value of the same key from this source object.
-         */
-        source: TSource,
-        /** @see {@link IGateConfig} */
-        config?: Readonly<IGateConfig<TSource>>
-    ];
-    class Gate<TSource extends TRecord> {
-        constructor(...params: Params<TSource>);
-    }
-    interface IConstructor {
-        new <TOutput extends Partial<TSource>, TSource extends TRecord>(...params: _ObjectGate.Params<TSource>): TOutput;
-    }
-}
-/**
- * Creates a new object that acts as a real-time proxy
- * for the {@link _ObjectGate.Params | `source`} object.
- * This lets you prevent access to some properties, effectively making them private,
- * while selectively exposing access to only the properties you specify
- * in the {@link _ObjectGate.IGateConfig.getters | `getters`} config option.
- *
- * The exposed properties are read-only by default,
- * exposing only a [getter](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/get#description)
- * with no corresponding [setter](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/set#description).
- *
- * The {@link _ObjectGate.Params | `config`} argument also lets you selectively allow
- * write access to specific properties through the
- * {@link _ObjectGate.IGateConfig.setters | `setters`} config option.
- *
- * Unlike [`structuredClone`](https://developer.mozilla.org/docs/Web/API/Window/structuredClone)
- * this doesn't return a _copy_ of the `source` object.
- *
- * Instead, it returns a _**Real-time proxy**_. This means that a value is read
- * from the source object each time a property is accessed through the proxy.
- * So accessing a property through the gate object is guaranteed to always return
- * the latest value.
- */
-export declare const ObjectGate: _ObjectGate.IConstructor;
-export {};

package/build/_cjs/helpers/object-gate.js

@@ -1,67 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectGate = void 0;
-var _ObjectGate;
-(function (_ObjectGate) {
-    class Gate {
-        constructor(...params) {
-            var _a, _b, _c, _d;
-            const [source, config] = params;
-            const getters = (_a = config === null || config === void 0 ? void 0 : config.getters) !== null && _a !== void 0 ? _a : Reflect.ownKeys(source);
-            const gettersExclude = (_b = config === null || config === void 0 ? void 0 : config.gettersExclude) !== null && _b !== void 0 ? _b : [];
-            const setters = (config === null || config === void 0 ? void 0 : config.setters) === true
-                ? getters
-                : ((_c = config === null || config === void 0 ? void 0 : config.setters) !== null && _c !== void 0 ? _c : []);
-            const settersExclude = (_d = config === null || config === void 0 ? void 0 : config.settersExclude) !== null && _d !== void 0 ? _d : [];
-            getters.forEach((_key) => {
-                const key = _key;
-                if (gettersExclude.includes(key))
-                    return;
-                Object.defineProperty(this, key, {
-                    enumerable: true,
-                    configurable: true,
-                    get() {
-                        return source[key];
-                    },
-                });
-            });
-            setters.forEach((_key) => {
-                const key = _key;
-                if (settersExclude.includes(key))
-                    return;
-                Object.defineProperty(this, key, {
-                    enumerable: true,
-                    set(value) {
-                        source[key] = value;
-                    },
-                });
-            });
-        }
-    }
-    _ObjectGate.Gate = Gate;
-    ;
-})(_ObjectGate || (_ObjectGate = {}));
-/**
- * Creates a new object that acts as a real-time proxy
- * for the {@link _ObjectGate.Params | `source`} object.
- * This lets you prevent access to some properties, effectively making them private,
- * while selectively exposing access to only the properties you specify
- * in the {@link _ObjectGate.IGateConfig.getters | `getters`} config option.
- *
- * The exposed properties are read-only by default,
- * exposing only a [getter](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/get#description)
- * with no corresponding [setter](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/set#description).
- *
- * The {@link _ObjectGate.Params | `config`} argument also lets you selectively allow
- * write access to specific properties through the
- * {@link _ObjectGate.IGateConfig.setters | `setters`} config option.
- *
- * Unlike [`structuredClone`](https://developer.mozilla.org/docs/Web/API/Window/structuredClone)
- * this doesn't return a _copy_ of the `source` object.
- *
- * Instead, it returns a _**Real-time proxy**_. This means that a value is read
- * from the source object each time a property is accessed through the proxy.
- * So accessing a property through the gate object is guaranteed to always return
- * the latest value.
- */
-exports.ObjectGate = _ObjectGate.Gate;

package/build/_cjs/helpers/rerender.d.ts

@@ -1,24 +0,0 @@
-interface ICountRef {
-    current: number;
-}
-interface IRefresherReturn {
-    /** The last render count just before the rerender was triggered. */
-    previousCount: number;
-    /** A {@link useRef | RefObject} whose `current` property always has the latest render count. */
-    latestCountRef: ICountRef;
-}
-interface IRefresher {
-    (): Promise<IRefresherReturn>;
-}
-interface IUseRender {
-    (): IRefresher & {
-        /** The number of times this instance of the component has been (re)rendered. */
-        currentCount: number;
-    };
-}
-/**
- * Returns a function that can be called to manually trigger
- * a rerender of your component.
- */
-export declare const useRerender: IUseRender;
-export {};

package/build/_cjs/helpers/rerender.js

@@ -1,42 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useRerender = void 0;
-const react_1 = require("react");
-const mount_state_1 = require("../helpers/mount-state.js");
-;
-/**
- * Returns a function that can be called to manually trigger
- * a rerender of your component.
- */
-const useRerender = () => {
-    const isMounted = (0, mount_state_1.useMountState)();
-    const renderCount = (0, react_1.useRef)(0);
-    const [, forceRerender] = (0, react_1.useState)(renderCount.current);
-    renderCount.current++;
-    const rerender = (0, react_1.useCallback)(() => {
-        let resolve;
-        const promise = new Promise((_r) => resolve = _r);
-        const execute = () => {
-            forceRerender(renderCount.current);
-            resolve({
-                previousCount: renderCount.current,
-                latestCountRef: renderCount,
-            });
-        };
-        if (isMounted())
-            execute();
-        else {
-            setTimeout(() => {
-                if (isMounted())
-                    execute();
-                else
-                    console.log('Cannot rerender an unmounted component.');
-            }, 1000);
-        }
-        return promise;
-    }, [forceRerender, renderCount]);
-    const refresher = () => rerender();
-    refresher.currentCount = renderCount.current;
-    return refresher;
-};
-exports.useRerender = useRerender;

package/build/_cjs/helpers/type-guards.d.ts

@@ -1 +0,0 @@
-export declare const canIndex: <T extends object>(key: keyof any, targetObject: T) => key is keyof T;

package/build/_cjs/helpers/type-guards.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.canIndex = void 0;
-const canIndex = (key, targetObject) => {
-    const test = typeof key === 'number' ? `${key}` : key;
-    return Reflect.ownKeys(targetObject).includes(test);
-};
-exports.canIndex = canIndex;

package/build/_cjs/helpers/use-component/index.d.ts

@@ -1,6 +0,0 @@
-import type { ClassComponentHookWrapper } from './types.js';
-/**
- * A component you can use to consume React hooks
- * in a {@link Component | React.Component} class.
- */
-export declare const Use: ClassComponentHookWrapper;

package/build/_cjs/helpers/use-component/index.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Use = void 0;
-const react_1 = require("react");
-/**
- * A component you can use to consume React hooks
- * in a {@link Component | React.Component} class.
- */
-const Use = (params) => {
-    const { hook: useGenericHook, argumentsList, onUpdate } = params;
-    const output = useGenericHook(...argumentsList);
-    (0, react_1.useEffect)(() => {
-        onUpdate(output);
-    }, [output]);
-    return null;
-};
-exports.Use = Use;

package/build/_cjs/helpers/use-component/types.d.ts

@@ -1,22 +0,0 @@
-interface HookWrapperProps<THookFunction extends AnyFunction> {
-    /**
-     * The React hook you which to consume.
-     * Render a separate instance of the `<Use />` component for each hook.
-     * You can also create a custom hook that combines multiple hooks,
-     * then use that wrapper hook with a single `<Use />` instance.
-     */
-    hook: THookFunction;
-    /**
-     * An array containing the list of arguments
-     * to be passed to your hook, in the right order.
-     */
-    argumentsList: Parameters<THookFunction>;
-    /**
-     * A callback that will be called with whatever value your hook returns.
-     * Use this to update your component's state with the value.
-     * This will allow your component to rerender whenever the hook returns a new value.
-     */
-    onUpdate: (output: ReturnType<THookFunction>) => void;
-}
-export type ClassComponentHookWrapper = <Hook extends AnyFunction>(props: HookWrapperProps<Hook>) => null;
-export {};

package/build/_cjs/helpers/use-component/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/_cjs/index.d.ts

@@ -1,3 +0,0 @@
-export * from './classy/index.js';
-export * from './base/index.js';
-export * from './helpers/index.js';

package/build/_cjs/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./classy/index.js"), exports);
-__exportStar(require("./base/index.js"), exports);
-__exportStar(require("./helpers/index.js"), exports);

package/build/_cjs/slots/hook.d.ts

@@ -1,20 +0,0 @@
-import type { ReactElement, ReactNode, ReactPortal } from 'react';
-import type { IUseSlots, PotentialSlotComponent } from './types.js';
-export declare const isElementChild: (child: ReactNode) => child is ReactElement<any, any>;
-interface IGetSlotName {
-    (TargetComponent: PotentialSlotComponent, child?: ReactElement): string | undefined;
-}
-export declare const getComponentSlotName: IGetSlotName;
-export declare const isPortalChild: (child: ReactNode) => child is ReactPortal;
-/**
- * Groups `children` prop into predefined slots.
- *
- * @returns A {@link TUseSlotsResult} array,
- * which includes a `slotNodes` object that maps the keys from
- * the predefined {@link Caller.slots} object to the corresponding
- * React node(s) that were rendered for that slot.
- *
- * @see {@link SlotComponent} for more on how to use the returned slot nodes.
- */
-export declare const useSlots: IUseSlots;
-export type { SlottedComponent, TSlotsRecord, SlotComponent, PotentialSlotComponent, } from './types.js';

package/build/_cjs/slots/hook.js

@@ -1,147 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useSlots = exports.isPortalChild = exports.getComponentSlotName = exports.isElementChild = void 0;
-const errors_1 = require("../helpers/errors.js");
-const react_1 = __importStar(require("react"));
-const isElementChild = (child) => {
-    if (child && typeof child === 'object' && 'type' in child) {
-        return true;
-    }
-    return false;
-};
-exports.isElementChild = isElementChild;
-const getComponentSlotName = (TargetComponent, child) => {
-    if (child) {
-        const keyTypes = ['string', 'number', 'symbol'];
-        const slotName = child.props['data-slot-name'];
-        if (keyTypes.includes(typeof slotName)) {
-            return slotName;
-        }
-    }
-    if (typeof TargetComponent === 'string') {
-        return TargetComponent;
-    }
-    else if ('slotName' in TargetComponent) {
-        return TargetComponent.slotName;
-    }
-    else if ('displayName' in TargetComponent) {
-        return TargetComponent.displayName;
-    }
-    else if ('name' in TargetComponent) {
-        return TargetComponent.name;
-    }
-    return undefined;
-};
-exports.getComponentSlotName = getComponentSlotName;
-const isPortalChild = (child) => {
-    return (!!child
-        && typeof child === 'object'
-        && 'children' in child);
-};
-exports.isPortalChild = isPortalChild;
-/**
- * Groups `children` prop into predefined slots.
- *
- * @returns A {@link TUseSlotsResult} array,
- * which includes a `slotNodes` object that maps the keys from
- * the predefined {@link Caller.slots} object to the corresponding
- * React node(s) that were rendered for that slot.
- *
- * @see {@link SlotComponent} for more on how to use the returned slot nodes.
- */
-const useSlots = (children, Caller) => {
-    const slotsAliasLookup = (0, react_1.useMemo)(() => {
-        const entries = Object.entries(Caller.Slots);
-        const aliasLookup = {
-            byName: {},
-            byIdentity: new Map(),
-        };
-        entries.forEach(([alias, RegisteredSlotComponent]) => {
-            const slotName = (0, exports.getComponentSlotName)(RegisteredSlotComponent);
-            if (!slotName) {
-                aliasLookup.byIdentity.set(RegisteredSlotComponent, alias);
-                aliasLookup.byName[alias] = alias;
-            }
-            else
-                aliasLookup.byName[slotName] = alias;
-        });
-        return aliasLookup;
-    }, [Caller.Slots]);
-    // @todo Expose original source order of `children` with respect to slot aliases.
-    const result = (0, react_1.useMemo)(() => {
-        var _a;
-        const slotNodes = {};
-        const unmatchedChildren = [];
-        const invalidChildren = [];
-        const requiredSlotAliases = [
-            ...((_a = Caller.requiredSlotAliases) !== null && _a !== void 0 ? _a : [])
-        ];
-        react_1.default.Children.forEach(children, (_child) => {
-            const child = _child;
-            if (!child) {
-                invalidChildren.push(child);
-                return;
-            }
-            if (!react_1.default.isValidElement(child)) {
-                console.warn(`Invalid node found in JSX children while parsing slots. Got: "${child}".`);
-                invalidChildren.push(child);
-                return;
-            }
-            ;
-            // @todo Check for fragment
-            if (!(0, exports.isElementChild)(child)) {
-                unmatchedChildren.push(child);
-                return;
-            }
-            const slotAlias = (() => {
-                const slotName = (0, exports.getComponentSlotName)(child.type, child);
-                const alias = slotName
-                    ? slotsAliasLookup.byName[slotName]
-                    : slotsAliasLookup.byIdentity.get(child.type);
-                return alias !== null && alias !== void 0 ? alias : null;
-            })();
-            if (slotAlias) {
-                if (slotNodes[slotAlias]) {
-                    slotNodes[slotAlias].push(child);
-                }
-                else {
-                    slotNodes[slotAlias] = [child];
-                }
-            }
-            else
-                unmatchedChildren.push(child);
-        });
-        /** @todo Type keys as NonNullable if included in this array. */
-        requiredSlotAliases.forEach((slotAlias) => {
-            if (!slotNodes[slotAlias]) {
-                (0, errors_1.throwDevError)(`Missing required slot "${String(slotAlias)}".`);
-            }
-        });
-        return [slotNodes, unmatchedChildren, invalidChildren];
-    }, [children]);
-    return result;
-};
-exports.useSlots = useSlots;

package/build/_cjs/slots/index.d.ts

@@ -1 +0,0 @@
-export * from './hook.js';

package/build/_cjs/slots/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./hook.js"), exports);