@nascentdigital/funnel-ui 4.4.18

package/dist/client/forms/interactive/RadioGroupField.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RadioGroupField = RadioGroupField;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const RadioField_1 = require("./RadioField");
+// component
+function RadioGroupField({ id, value, onChange, options, disabled, error }) {
+    // render
+    return Object.entries(options).map(([optionKey, option]) => (0, jsx_runtime_1.jsxs)("div", { className: "nd-RadioField-layout", children: [(0, jsx_runtime_1.jsx)(RadioField_1.RadioField, { id: `${id}-${optionKey}`, groupId: id, checked: value === optionKey, onChange: () => onChange === null || onChange === void 0 ? void 0 : onChange(optionKey), disabled: disabled, error: error }), (0, jsx_runtime_1.jsx)("label", { className: "nd-Field-label", htmlFor: `${id}-${optionKey}`, children: option.name })] }, optionKey));
+}

package/dist/client/forms/interactive/SelectField.d.ts

@@ -0,0 +1,17 @@
+import { Callback, Schema } from '@nascentdigital/funnel-core';
+export declare function SelectField({ className, id, name, value, options, hint, disabled, error, onChange, onFocus, onBlur, }: SelectField.Props): import("react/jsx-runtime").JSX.Element;
+export declare namespace SelectField {
+    type Props = {
+        className?: string;
+        id: string;
+        name?: string;
+        value: string;
+        options: Schema.EnumField.Options;
+        hint?: string;
+        disabled?: boolean;
+        error?: boolean;
+        onChange?: Callback<string>;
+        onFocus?: Callback.Void;
+        onBlur?: Callback.Void;
+    };
+}

package/dist/client/forms/interactive/SelectField.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SelectField = SelectField;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const classnames_1 = __importDefault(require("classnames"));
+// component
+function SelectField({ className, id, name, value, options, hint, disabled, error, onChange, onFocus, onBlur, }) {
+    return ((0, jsx_runtime_1.jsxs)("select", { id: id, name: name, className: (0, classnames_1.default)(className, 'nd-Field nd-EnumField nd-DropdownField', {
+            'nd-Field-error': error,
+            'nd-Field-disabled': disabled
+        }), value: value, onChange: e => onChange === null || onChange === void 0 ? void 0 : onChange(e.target.value), onFocus: onFocus, onBlur: onBlur, disabled: disabled, "aria-label": name, required: true, children: [hint &&
+                (0, jsx_runtime_1.jsx)("option", { value: "", disabled: true, hidden: true, children: hint }), Object.entries(options).map(([optionKey, option]) => (0, jsx_runtime_1.jsx)("option", { value: optionKey, children: option.name }, optionKey))] }));
+}

package/dist/client/forms/interactive/index.d.ts

@@ -0,0 +1,4 @@
+export * from './CheckboxField';
+export * from './RadioField';
+export * from './RadioGroupField';
+export * from './SelectField';

package/dist/client/forms/interactive/index.js

@@ -0,0 +1,20 @@
+"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("./CheckboxField"), exports);
+__exportStar(require("./RadioField"), exports);
+__exportStar(require("./RadioGroupField"), exports);
+__exportStar(require("./SelectField"), exports);

package/dist/client/forms/useForm.d.ts

@@ -0,0 +1,2 @@
+import type { FormModel } from '@nascentdigital/funnel-core';
+export declare function useForm(form: FormModel): void;

package/dist/client/forms/useForm.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useForm = useForm;
+const react_1 = require("react");
+const hooks_1 = require("../hooks");
+// hook
+function useForm(form) {
+    // bind
+    const touch = (0, hooks_1.useTouch)();
+    // listen to form changes
+    (0, react_1.useEffect)(() => {
+        // subscribe to changes
+        const subscription = form.events$.subscribe(touch);
+        // unsubscribe on unmount
+        return () => subscription.unsubscribe();
+    }, [form, touch]);
+}

package/dist/client/forms/useTempFields.d.ts

@@ -0,0 +1,7 @@
+import { Schema, TranslateSchema } from '@nascentdigital/funnel-core';
+export declare function useTempFields<TFields extends Record<string, Schema.Optional.Maybe<Schema.Field.Type>>>(schemasRaw: TFields, dependencies?: any[]): TranslateSchema.Fields<TFields>;
+export declare namespace useTempFields {
+    type Args = {
+        schemas: Record<string, Schema.Field.Type>;
+    };
+}

package/dist/client/forms/useTempFields.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useTempFields = useTempFields;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const react_1 = require("react");
+const hooks_1 = require("../hooks");
+// hook
+function useTempFields(schemasRaw, dependencies = []) {
+    // bind hooks + fields (track a ref so we don't constantly rebind fields unless deps change)
+    const schemasRef = (0, react_1.useRef)(schemasRaw);
+    const dependenciesRef = (0, react_1.useRef)(dependencies);
+    const previousDependencies = dependenciesRef.current;
+    // update schemas if dependencies have changed
+    if (!funnel_core_1.Value.equals(dependencies, previousDependencies)) {
+        // update schemas
+        schemasRef.current = schemasRaw;
+        // update dependencies
+        dependenciesRef.current = dependencies;
+    }
+    const schemas = schemasRef.current;
+    const fields = (0, react_1.useMemo)(() => {
+        // create temp bus
+        const eventBus = new funnel_core_1.EventBus();
+        // map fields into editor variants
+        return Object.entries(schemas).reduce((fields, [key, schema]) => {
+            // create field if there's a definition
+            if (schema) {
+                const id = key;
+                fields[id] = funnel_core_1.FieldSerializer.deserializeField({
+                    id,
+                    eventBus,
+                    schema: schema.unwrap(),
+                    content: undefined,
+                    snapshot: undefined
+                });
+            }
+            // keep reducing
+            return fields;
+        }, {});
+    }, [schemas]);
+    // listen to fields events (force a re-render of child)
+    const touch = (0, hooks_1.useTouch)();
+    (0, react_1.useEffect)(() => {
+        // subscribe to changes
+        const subscriptions = Object.values(fields).map(fieldRaw => {
+            const field = fieldRaw;
+            return field.events$.subscribe(() => touch());
+        });
+        // unsubscribe on unmount
+        return () => subscriptions.forEach(subscription => subscription.unsubscribe());
+    }, [touch, fields]);
+    // return fields
+    return fields;
+}

package/dist/client/hooks/assets/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useImageProxy';
+export * from './useVideoProxy';

package/dist/client/hooks/assets/index.js

@@ -0,0 +1,18 @@
+"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("./useImageProxy"), exports);
+__exportStar(require("./useVideoProxy"), exports);

package/dist/client/hooks/assets/useImageProxy.d.ts

@@ -0,0 +1,2 @@
+import { ElementImageProxy } from '@nascentdigital/funnel-core';
+export declare function useImageProxy(target: HTMLImageElement | string | null | undefined): ElementImageProxy | undefined;

package/dist/client/hooks/assets/useImageProxy.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useImageProxy = useImageProxy;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const react_1 = require("react");
+const useTouch_1 = require("../useTouch");
+// hook
+function useImageProxy(target) {
+    // bind state
+    const [proxy, setProxy] = (0, react_1.useState)();
+    const touch = (0, useTouch_1.useTouch)();
+    // bind video proxy
+    (0, react_1.useEffect)(() => {
+        var _a;
+        // resolve image (or skip if there's none)
+        const image = target
+            ? target instanceof HTMLImageElement
+                ? target
+                : (_a = document.querySelector(target)) !== null && _a !== void 0 ? _a : undefined
+            : undefined;
+        if (!image) {
+            // clear proxy
+            setProxy(undefined);
+            // stop
+            return;
+        }
+        // or create proxy
+        const proxy = new funnel_core_1.ElementImageProxy(image);
+        // subscribe to events
+        const proxySubscription = proxy.state$.subscribe(() => touch());
+        // set proxy
+        setProxy(proxy);
+        // free resources on unmount
+        return () => {
+            // clear subscription
+            proxySubscription.unsubscribe();
+            // dispose proxy
+            proxy.dispose();
+        };
+    }, [touch, target]);
+    // return proxy
+    return proxy;
+}

package/dist/client/hooks/assets/useVideoProxy.d.ts

@@ -0,0 +1,2 @@
+import { ElementVideoProxy } from '@nascentdigital/funnel-core';
+export declare function useVideoProxy(target: HTMLVideoElement | string | null | undefined): ElementVideoProxy | undefined;

package/dist/client/hooks/assets/useVideoProxy.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useVideoProxy = useVideoProxy;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const react_1 = require("react");
+const useTouch_1 = require("../useTouch");
+// hook
+function useVideoProxy(target) {
+    // bind state
+    const [proxy, setProxy] = (0, react_1.useState)();
+    const touch = (0, useTouch_1.useTouch)();
+    // bind video proxy
+    (0, react_1.useEffect)(() => {
+        var _a;
+        // resolve video (or skip if there's none)
+        const video = target
+            ? target instanceof HTMLVideoElement
+                ? target
+                : (_a = document.querySelector(target)) !== null && _a !== void 0 ? _a : undefined
+            : undefined;
+        if (!video) {
+            // clear proxy
+            setProxy(undefined);
+            // stop
+            return;
+        }
+        // or create proxy
+        const proxy = new funnel_core_1.ElementVideoProxy(video);
+        // subscribe to events
+        const proxySubscription = proxy.state$.subscribe(() => touch());
+        // set proxy
+        setProxy(proxy);
+        // free resources on unmount
+        return () => {
+            // clear subscription
+            proxySubscription.unsubscribe();
+            // dispose proxy
+            proxy.dispose();
+        };
+    }, [touch, target]);
+    // return proxy
+    return proxy;
+}

package/dist/client/hooks/breakpoint/BreakpointContainer.d.ts

@@ -0,0 +1,9 @@
+import { Breakpoints } from '@nascentdigital/funnel-core';
+import { ReactNode } from 'react';
+export declare function BreakpointContainer({ breakpoints, children }: BreakpointContainer.Props): import("react/jsx-runtime").JSX.Element;
+export declare namespace BreakpointContainer {
+    type Props = {
+        breakpoints?: Readonly<Breakpoints>;
+        children?: ReactNode;
+    };
+}

package/dist/client/hooks/breakpoint/BreakpointContainer.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BreakpointContainer = BreakpointContainer;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const react_1 = require("react");
+const BreakpointContext_1 = require("./BreakpointContext");
+// container
+function BreakpointContainer({ breakpoints = funnel_core_1.Breakpoints.defaults, children }) {
+    // bind state + observer
+    const [context, setContext] = (0, react_1.useState)({
+        breakpoints
+    });
+    // update context when breakpoint changes
+    (0, react_1.useEffect)(() => {
+        // bind to observer updates
+        const observer = new funnel_core_1.BreakpointObserver(breakpoints);
+        const subscription = observer.current$.subscribe(current => {
+            // create context
+            const context = {
+                breakpoints,
+                current,
+                states: funnel_core_1.Breakpoint.values.reduce((states, breakpoint) => {
+                    states[breakpoint] = funnel_core_1.Breakpoint.compare(breakpoint, current) <= 0;
+                    return states;
+                }, {})
+            };
+            // and set it
+            setContext(context);
+        });
+        // dispose on unmount
+        return () => {
+            subscription.unsubscribe();
+            observer.dispose();
+        };
+    }, [breakpoints]);
+    // return breakpoints
+    return ((0, jsx_runtime_1.jsx)(BreakpointContext_1.BreakpointContext.Provider, { value: context, children: children }));
+}

package/dist/client/hooks/breakpoint/BreakpointContext.d.ts

@@ -0,0 +1,7 @@
+import { Breakpoint, Breakpoints, BreakpointStates } from '@nascentdigital/funnel-core';
+export type IBreakpointContext = {
+    breakpoints: Breakpoints;
+    current?: Breakpoint;
+    states?: BreakpointStates;
+};
+export declare const BreakpointContext: import("react").Context<IBreakpointContext>;

package/dist/client/hooks/breakpoint/BreakpointContext.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BreakpointContext = void 0;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const react_1 = require("react");
+// context
+exports.BreakpointContext = (0, react_1.createContext)({
+    breakpoints: funnel_core_1.Breakpoints.defaults
+});

package/dist/client/hooks/breakpoint/index.d.ts

@@ -0,0 +1,3 @@
+export * from './BreakpointContext';
+export * from './BreakpointContainer';
+export * from './useCurrentBreakpoint';

package/dist/client/hooks/breakpoint/index.js

@@ -0,0 +1,19 @@
+"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("./BreakpointContext"), exports);
+__exportStar(require("./BreakpointContainer"), exports);
+__exportStar(require("./useCurrentBreakpoint"), exports);

package/dist/client/hooks/breakpoint/useCurrentBreakpoint.d.ts

@@ -0,0 +1,2 @@
+import { Breakpoint } from '@nascentdigital/funnel-core';
+export declare function useCurrentBreakpoint(): Breakpoint | undefined;

package/dist/client/hooks/breakpoint/useCurrentBreakpoint.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useCurrentBreakpoint = useCurrentBreakpoint;
+const react_1 = require("react");
+const BreakpointContext_1 = require("./BreakpointContext");
+// hook
+function useCurrentBreakpoint() {
+    const { current } = (0, react_1.useContext)(BreakpointContext_1.BreakpointContext);
+    return current;
+}

package/dist/client/hooks/index.d.ts

@@ -0,0 +1,26 @@
+export * from './assets';
+export * from './ui-lock';
+export * from './breakpoint';
+export * from './useCounter';
+export * from './useCycle';
+export * from './useElementRect';
+export * from './useElementScrolled';
+export * from './useElementSelector';
+export * from './useFindElements';
+export * from './useElementSize';
+export * from './useInViewport';
+export * from './useIsDesktop';
+export * from './useKeyboardFocus';
+export * from './useLatestValue';
+export * from './useLock';
+export * from './useMixedResponsiveValue';
+export * from './usePathname';
+export * from './useRefElement';
+export * from './useRefresh';
+export * from './useResizeObserver';
+export * from './useResponsiveValue';
+export * from './useRouter';
+export * from './useSafeLayoutEffect';
+export * from './useTouch';
+export * from './useViewportSize';
+export * from './useWindowScrolled';

package/dist/client/hooks/index.js

@@ -0,0 +1,42 @@
+"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("./assets"), exports);
+__exportStar(require("./ui-lock"), exports);
+__exportStar(require("./breakpoint"), exports);
+__exportStar(require("./useCounter"), exports);
+__exportStar(require("./useCycle"), exports);
+__exportStar(require("./useElementRect"), exports);
+__exportStar(require("./useElementScrolled"), exports);
+__exportStar(require("./useElementSelector"), exports);
+__exportStar(require("./useFindElements"), exports);
+__exportStar(require("./useElementSize"), exports);
+__exportStar(require("./useInViewport"), exports);
+__exportStar(require("./useIsDesktop"), exports);
+__exportStar(require("./useKeyboardFocus"), exports);
+__exportStar(require("./useLatestValue"), exports);
+__exportStar(require("./useLock"), exports);
+__exportStar(require("./useMixedResponsiveValue"), exports);
+__exportStar(require("./usePathname"), exports);
+__exportStar(require("./useRefElement"), exports);
+__exportStar(require("./useRefresh"), exports);
+__exportStar(require("./useResizeObserver"), exports);
+__exportStar(require("./useResponsiveValue"), exports);
+__exportStar(require("./useRouter"), exports);
+__exportStar(require("./useSafeLayoutEffect"), exports);
+__exportStar(require("./useTouch"), exports);
+__exportStar(require("./useViewportSize"), exports);
+__exportStar(require("./useWindowScrolled"), exports);

package/dist/client/hooks/ui-lock/UILockContainer.d.ts

@@ -0,0 +1,5 @@
+import { PropsWithChildren } from 'react';
+export declare function UILockContainer({ children }: UILockContainer.Props): import("react/jsx-runtime").JSX.Element;
+export declare namespace UILockContainer {
+    type Props = PropsWithChildren;
+}

package/dist/client/hooks/ui-lock/UILockContainer.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UILockContainer = UILockContainer;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const rxjs_1 = require("rxjs");
+const UILockRef_1 = require("./UILockRef");
+const UILockContext_1 = require("./UILockContext");
+// container
+function UILockContainer({ children }) {
+    // bind state
+    const [context, setContext] = (0, react_1.useState)(() => ({
+        eventBus: new rxjs_1.Subject(),
+        refs: []
+    }));
+    const { eventBus } = context;
+    // update list of refs
+    (0, react_1.useEffect)(() => {
+        // subscribe to lock/unlock events
+        const subscription = eventBus.subscribe(event => {
+            // if a lock event
+            if (UILockRef_1.UILockRef.Event.Lock.guard(event)) {
+                // add it to the list of refs
+                setContext(context => ({
+                    eventBus,
+                    refs: [...context.refs, event.lock]
+                }));
+            }
+            // otherwise if an unlock event
+            else if (UILockRef_1.UILockRef.Event.Unlock.guard(event)) {
+                // remove it from the list of refs
+                setContext(context => ({
+                    eventBus,
+                    refs: removeRef(event.lockHolder, context.refs)
+                }));
+            }
+            // otherwise log a warning
+            else {
+                console.warn(`[UILockContainer]: Unable to handle event ${event}`);
+            }
+        });
+        // unsubscribe
+        return () => subscription.unsubscribe();
+    }, [eventBus]);
+    const removeRef = (lockHolder, refs) => {
+        // find the index for the given lock holder
+        const findIndex = refs.findIndex((lock) => lockHolder === lock.lockHolder);
+        const updatedRefs = [...refs];
+        // if there was a lock issued by the lock holder, remove it
+        if (findIndex >= 0) {
+            updatedRefs.splice(findIndex, 1);
+        }
+        // return the renewed list of refs
+        return updatedRefs;
+    };
+    return ((0, jsx_runtime_1.jsx)(UILockContext_1.UILockContext.Provider, { value: context, children: children }));
+}

package/dist/client/hooks/ui-lock/UILockContext.d.ts

@@ -0,0 +1,9 @@
+import { Subject } from 'rxjs';
+import { UILockRef } from './UILockRef';
+export declare const UILockContext: import("react").Context<UILockContext.Data>;
+export declare namespace UILockContext {
+    type Data = {
+        eventBus: Subject<UILockRef.Event>;
+        refs: Array<UILockRef>;
+    };
+}

package/dist/client/hooks/ui-lock/UILockContext.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UILockContext = void 0;
+const react_1 = require("react");
+// context
+exports.UILockContext = (0, react_1.createContext)({});

package/dist/client/hooks/ui-lock/UILockRef.d.ts

@@ -0,0 +1,36 @@
+export type UILockRef = {
+    lockHolder: HTMLElement;
+    config: UILockRef.Config;
+};
+export declare namespace UILockRef {
+    type Config = {
+        lockChildren: boolean;
+        delegationRule: Config.DelegationRule;
+    };
+    namespace Config {
+        type DelegationRule = 'none' | 'children' | 'all';
+    }
+    type Event = Event.Lock | Event.Unlock;
+    namespace Event {
+        export type Action = 'lock' | 'unlock';
+        interface Base {
+            action: Action;
+        }
+        export interface Lock extends Base {
+            action: 'lock';
+            lock: UILockRef;
+        }
+        export namespace Lock {
+            function guard(event: Event): event is Lock;
+        }
+        export interface Unlock extends Base {
+            action: 'unlock';
+            lockHolder: HTMLElement;
+        }
+        export namespace Unlock {
+            function guard(event: Event): event is Unlock;
+        }
+        export function create(event: Lock | Unlock): Event;
+        export {};
+    }
+}

package/dist/client/hooks/ui-lock/UILockRef.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UILockRef = void 0;
+// extension
+var UILockRef;
+(function (UILockRef) {
+    // extensions
+    let Event;
+    (function (Event) {
+        let Lock;
+        (function (Lock) {
+            // helpers
+            function guard(event) {
+                return event.action === 'lock';
+            }
+            Lock.guard = guard;
+        })(Lock = Event.Lock || (Event.Lock = {}));
+        let Unlock;
+        (function (Unlock) {
+            // helpers
+            function guard(event) {
+                return event.action === 'unlock';
+            }
+            Unlock.guard = guard;
+        })(Unlock = Event.Unlock || (Event.Unlock = {}));
+        // helpers
+        function create(event) {
+            return event;
+        }
+        Event.create = create;
+    })(Event = UILockRef.Event || (UILockRef.Event = {}));
+})(UILockRef || (exports.UILockRef = UILockRef = {}));

package/dist/client/hooks/ui-lock/index.d.ts

@@ -0,0 +1,3 @@
+export * from './UILockContainer';
+export * from './UILockContext';
+export * from './useUILock';

package/dist/client/hooks/ui-lock/index.js

@@ -0,0 +1,19 @@
+"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("./UILockContainer"), exports);
+__exportStar(require("./UILockContext"), exports);
+__exportStar(require("./useUILock"), exports);