devextreme-react 23.2.1-alpha-23255-1813 → 23.2.3

package/cjs/core/template-manager.js

@@ -0,0 +1,182 @@
+/*!
+ * devextreme-react
+ * Version: 23.2.3
+ * Build date: Tue Nov 28 2023
+ *
+ * Copyright (c) 2012 - 2023 Developer Express Inc. ALL RIGHTS RESERVED
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file in the root of the project for details.
+ *
+ * https://github.com/DevExpress/devextreme-react
+ */
+
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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;
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TemplateManager = void 0;
+var React = __importStar(require("react"));
+var events = __importStar(require("devextreme/events"));
+var react_1 = require("react");
+var template_wrapper_1 = require("./template-wrapper");
+var helpers_1 = require("./helpers");
+var component_base_1 = require("./component-base");
+var config_1 = require("./config");
+function normalizeProps(props) {
+    if (config_1.getOption('useLegacyTemplateEngine')) {
+        var model = props.data;
+        if (model && Object.prototype.hasOwnProperty.call(model, 'key')) {
+            model.dxkey = model.key;
+        }
+        return model;
+    }
+    return props;
+}
+var TemplateManager = function (_a) {
+    var init = _a.init;
+    var _b = __read(react_1.useState(new helpers_1.TemplateInstantiationModels()), 2), instantiationModels = _b[0], setInstantiationModels = _b[1];
+    var _c = __read(react_1.useState(), 2), updateContext = _c[0], setUpdateContext = _c[1];
+    var widgetId = react_1.useRef('');
+    var templateFactories = react_1.useRef({});
+    var subscribeOnRemoval = react_1.useCallback(function (container, onRemoved) {
+        if (container.nodeType === Node.ELEMENT_NODE) {
+            events.on(container, component_base_1.DX_REMOVE_EVENT, onRemoved);
+        }
+    }, []);
+    var unsubscribeOnRemoval = react_1.useCallback(function (container, onRemoved) {
+        if (container.nodeType === Node.ELEMENT_NODE) {
+            events.off(container, component_base_1.DX_REMOVE_EVENT, onRemoved);
+        }
+    }, []);
+    var createMapKey = react_1.useCallback(function (key1, key2) { return ({ key1: key1, key2: key2 }); }, []);
+    var getRandomId = react_1.useCallback(function () { return "" + helpers_1.generateID() + helpers_1.generateID() + helpers_1.generateID(); }, []);
+    var getRenderFunc = react_1.useCallback(function (templateKey) { return function (_a) {
+        var data = _a.model, index = _a.index, container = _a.container, onRendered = _a.onRendered;
+        var key = createMapKey(data, container);
+        var onRemoved = function () {
+            setInstantiationModels(function (currentInstantiationModels) {
+                var template = currentInstantiationModels.get(key);
+                if (template) {
+                    currentInstantiationModels.delete(key);
+                    return currentInstantiationModels.shallowCopy();
+                }
+                return currentInstantiationModels;
+            });
+        };
+        var hostWidgetId = widgetId.current;
+        setInstantiationModels(function (currentInstantiationModels) {
+            currentInstantiationModels.set(key, {
+                templateKey: templateKey,
+                index: index,
+                componentKey: getRandomId(),
+                onRendered: function () {
+                    unsubscribeOnRemoval(container, onRemoved);
+                    if (hostWidgetId === widgetId.current) {
+                        onRendered === null || onRendered === void 0 ? void 0 : onRendered();
+                    }
+                },
+                onRemoved: onRemoved,
+            });
+            return currentInstantiationModels.shallowCopy();
+        });
+        return container;
+    }; }, [unsubscribeOnRemoval, createMapKey]);
+    react_1.useMemo(function () {
+        function getTemplateFunction(template) {
+            switch (template.type) {
+                case 'children': return function () { return template.content; };
+                case 'render': return function (props) {
+                    normalizeProps(props);
+                    return template.content(props.data, props.index);
+                };
+                case 'component': return function (props) {
+                    props = normalizeProps(props);
+                    return React.createElement.bind(null, template.content)(props);
+                };
+                default: return function () { return React.createElement(React.Fragment); };
+            }
+        }
+        function createDXTemplates(templateOptions) {
+            var factories = Object.entries(templateOptions)
+                .reduce(function (res, _a) {
+                var _b;
+                var _c = __read(_a, 2), key = _c[0], template = _c[1];
+                return (__assign(__assign({}, res), (_b = {}, _b[key] = getTemplateFunction(template), _b)));
+            }, {});
+            templateFactories.current = factories;
+            var dxTemplates = Object.keys(factories)
+                .reduce(function (templates, templateKey) {
+                templates[templateKey] = { render: getRenderFunc(templateKey) };
+                return templates;
+            }, {});
+            return dxTemplates;
+        }
+        function clearInstantiationModels() {
+            widgetId.current = getRandomId();
+            setInstantiationModels(new helpers_1.TemplateInstantiationModels());
+        }
+        function updateTemplates(onUpdated) {
+            setUpdateContext({ onUpdated: onUpdated });
+        }
+        init({ createDXTemplates: createDXTemplates, clearInstantiationModels: clearInstantiationModels, updateTemplates: updateTemplates });
+    }, [init, getRenderFunc]);
+    react_1.useEffect(function () {
+        if (updateContext) {
+            updateContext.onUpdated();
+        }
+    }, [updateContext]);
+    if (instantiationModels.empty) {
+        return null;
+    }
+    return (React.createElement(React.Fragment, null, Array.from(instantiationModels).map(function (_a) {
+        var _b = __read(_a, 2), _c = _b[0], data = _c.key1, container = _c.key2, _d = _b[1], index = _d.index, templateKey = _d.templateKey, componentKey = _d.componentKey, onRendered = _d.onRendered, onRemoved = _d.onRemoved;
+        subscribeOnRemoval(container, onRemoved);
+        return React.createElement(template_wrapper_1.TemplateWrapper, { key: componentKey, templateFactory: templateFactories.current[templateKey], data: data, index: index, container: container, onRemoved: onRemoved, onRendered: onRendered });
+    })));
+};
+exports.TemplateManager = TemplateManager;

package/cjs/core/template-wrapper.d.ts

@@ -1,7 +1,7 @@
 /*!
  * devextreme-react
- * Version: 23.2.1-alpha-23255-1813
- * Build date: Tue Sep 12 2023
+ * Version: 23.2.3
+ * Build date: Tue Nov 28 2023
  *
  * Copyright (c) 2012 - 2023 Developer Express Inc. ALL RIGHTS RESERVED
  *
@@ -12,30 +12,5 @@
  */
 
 import * as React from 'react';
-interface ITemplateWrapperProps {
-    content: any;
-    container: Element;
-    onRemoved: () => void;
-    onDidMount?: () => void;
-    key: string;
-}
-interface ITemplateWrapperState {
-    removalListenerRequired: boolean;
-}
-declare type TemplateWrapperRenderer = () => TemplateWrapper;
-declare class TemplateWrapper extends React.PureComponent<ITemplateWrapperProps, ITemplateWrapperState> {
-    private readonly _removalListenerRef;
-    private element;
-    private hiddenElement;
-    constructor(props: ITemplateWrapperProps);
-    componentDidMount(): void;
-    componentDidUpdate(): void;
-    componentWillUnmount(): void;
-    private get _listenerElement();
-    private getPreviousSiblingNode;
-    private _subscribeOnRemove;
-    private _subscribeOnElementRemoval;
-    private _onDxRemove;
-    render(): React.ReactNode;
-}
-export { ITemplateWrapperProps, TemplateWrapper, TemplateWrapperRenderer, };
+import { TemplateWrapperProps } from './types';
+export declare const TemplateWrapper: React.NamedExoticComponent<TemplateWrapperProps>;

package/cjs/core/template-wrapper.js

@@ -1,7 +1,7 @@
 /*!
  * devextreme-react
- * Version: 23.2.1-alpha-23255-1813
- * Build date: Tue Sep 12 2023
+ * Version: 23.2.3
+ * Build date: Tue Nov 28 2023
  *
  * Copyright (c) 2012 - 2023 Developer Express Inc. ALL RIGHTS RESERVED
  *
@@ -12,21 +12,6 @@
  */
 
 "use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
@@ -46,95 +31,106 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TemplateWrapper = void 0;
-var events = __importStar(require("devextreme/events"));
 var React = __importStar(require("react"));
-var ReactDOM = __importStar(require("react-dom"));
+var events = __importStar(require("devextreme/events"));
+var react_1 = require("react");
+var react_dom_1 = require("react-dom");
 var component_base_1 = require("./component-base");
-var removalListenerStyle = { display: 'none' };
-var TableNodeNames;
-(function (TableNodeNames) {
-    TableNodeNames["TABLE"] = "tbody";
-    TableNodeNames["TBODY"] = "tr";
-})(TableNodeNames || (TableNodeNames = {}));
-var TemplateWrapper = /** @class */ (function (_super) {
-    __extends(TemplateWrapper, _super);
-    function TemplateWrapper(props) {
-        var _this = _super.call(this, props) || this;
-        _this._removalListenerRef = React.createRef();
-        _this.state = { removalListenerRequired: false };
-        _this._onDxRemove = _this._onDxRemove.bind(_this);
-        _this.getPreviousSiblingNode = _this.getPreviousSiblingNode.bind(_this);
-        return _this;
+var helpers_1 = require("./helpers");
+var createHiddenNode = function (containerNodeName, ref, defaultElement) {
+    var style = { display: 'none' };
+    switch (containerNodeName) {
+        case 'TABLE':
+            return React.createElement("tbody", { style: style, ref: ref });
+        case 'TBODY':
+            return React.createElement("tr", { style: style, ref: ref });
+        default:
+            return React.createElement(defaultElement, { style: style, ref: ref });
     }
-    TemplateWrapper.prototype.componentDidMount = function () {
-        var _a, _b;
-        this._subscribeOnRemove();
-        (_b = (_a = this.props).onDidMount) === null || _b === void 0 ? void 0 : _b.call(_a);
-    };
-    TemplateWrapper.prototype.componentDidUpdate = function () {
-        this._subscribeOnRemove();
-    };
-    TemplateWrapper.prototype.componentWillUnmount = function () {
-        // Let React remove it itself
-        var node = this.element;
-        var hiddenNode = this.hiddenElement;
-        var container = this.props.container;
-        if (node) {
-            container.appendChild(node);
+};
+var TemplateWrapperComponent = function (_a) {
+    var templateFactory = _a.templateFactory, data = _a.data, index = _a.index, container = _a.container, onRemoved = _a.onRemoved, onRendered = _a.onRendered;
+    var _b = __read(react_1.useState(false), 2), removalListenerRequired = _b[0], setRemovalListenerRequired = _b[1];
+    var isRemovalLocked = react_1.useRef(false);
+    var removalLocker = react_1.useMemo(function () { return ({
+        lock: function () { isRemovalLocked.current = true; },
+        unlock: function () { isRemovalLocked.current = false; },
+    }); }, []);
+    var element = react_1.useRef();
+    var hiddenNodeElement = react_1.useRef();
+    var removalListenerElement = react_1.useRef();
+    var onTemplateRemoved = react_1.useCallback(function (_, args) {
+        if ((args === null || args === void 0 ? void 0 : args.isUnmounting) || isRemovalLocked.current) {
+            return;
         }
-        if (hiddenNode) {
-            container.appendChild(hiddenNode);
+        if (element.current) {
+            events.off(element.current, component_base_1.DX_REMOVE_EVENT, onTemplateRemoved);
         }
-        if (this._listenerElement) {
-            container.appendChild(this._listenerElement);
+        if (removalListenerElement.current) {
+            events.off(removalListenerElement.current, component_base_1.DX_REMOVE_EVENT, onTemplateRemoved);
         }
-    };
-    Object.defineProperty(TemplateWrapper.prototype, "_listenerElement", {
-        get: function () {
-            return this._removalListenerRef.current;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    TemplateWrapper.prototype.getPreviousSiblingNode = function (node) {
-        this.hiddenElement = node;
-        this.element = node === null || node === void 0 ? void 0 : node.previousSibling;
-    };
-    TemplateWrapper.prototype._subscribeOnRemove = function () {
-        var node = this.element;
-        var removalListenerRequired = this.state.removalListenerRequired;
-        if (node && node.nodeType === Node.ELEMENT_NODE) {
-            this._subscribeOnElementRemoval(node);
-            return;
+        onRemoved();
+    }, [onRemoved]);
+    react_1.useLayoutEffect(function () {
+        var el = element.current;
+        if (el && el.nodeType === Node.ELEMENT_NODE) {
+            events.off(el, component_base_1.DX_REMOVE_EVENT, onTemplateRemoved);
+            events.on(el, component_base_1.DX_REMOVE_EVENT, onTemplateRemoved);
         }
-        if (!removalListenerRequired) {
-            this.setState({ removalListenerRequired: true });
-            return;
+        else if (!removalListenerRequired) {
+            setRemovalListenerRequired(true);
         }
-        if (this._listenerElement) {
-            this._subscribeOnElementRemoval(this._listenerElement);
+        else if (removalListenerElement.current) {
+            events.off(removalListenerElement.current, component_base_1.DX_REMOVE_EVENT, onTemplateRemoved);
+            events.on(removalListenerElement.current, component_base_1.DX_REMOVE_EVENT, onTemplateRemoved);
         }
-    };
-    TemplateWrapper.prototype._subscribeOnElementRemoval = function (element) {
-        events.off(element, component_base_1.DX_REMOVE_EVENT, this._onDxRemove);
-        events.one(element, component_base_1.DX_REMOVE_EVENT, this._onDxRemove);
-    };
-    TemplateWrapper.prototype._onDxRemove = function () {
-        var onRemoved = this.props.onRemoved;
-        onRemoved();
-    };
-    TemplateWrapper.prototype.render = function () {
-        var removalListenerRequired = this.state.removalListenerRequired;
-        var _a = this.props, content = _a.content, container = _a.container;
-        var removalListener = removalListenerRequired
-            ? React.createElement('span', { style: removalListenerStyle, ref: this._removalListenerRef })
-            : undefined;
-        var nodeName = TableNodeNames[container.nodeName] || 'div';
-        // @ts-expect-error TS2322
-        return ReactDOM.createPortal(React.createElement(React.Fragment, null, content, content && React.createElement(nodeName, { style: { display: 'none' }, ref: this.getPreviousSiblingNode }), removalListener), container);
-    };
-    return TemplateWrapper;
-}(React.PureComponent));
-exports.TemplateWrapper = TemplateWrapper;
+        return function () {
+            if (element.current) {
+                container.appendChild(element.current);
+            }
+            if (hiddenNodeElement.current) {
+                container.appendChild(hiddenNodeElement.current);
+            }
+            if (removalListenerElement.current) {
+                container.appendChild(removalListenerElement.current);
+            }
+            if (el) {
+                events.off(el, component_base_1.DX_REMOVE_EVENT, onTemplateRemoved);
+            }
+        };
+    }, [onTemplateRemoved, removalListenerRequired, container]);
+    react_1.useEffect(function () {
+        onRendered();
+    }, [onRendered]);
+    var hiddenNode = createHiddenNode(container === null || container === void 0 ? void 0 : container.nodeName, function (node) {
+        hiddenNodeElement.current = node;
+        element.current = node === null || node === void 0 ? void 0 : node.previousSibling;
+    }, 'div');
+    var removalListener = removalListenerRequired
+        ? createHiddenNode(container === null || container === void 0 ? void 0 : container.nodeName, function (node) { removalListenerElement.current = node; }, 'span')
+        : undefined;
+    return react_dom_1.createPortal(React.createElement(React.Fragment, null,
+        React.createElement(helpers_1.RemovalLockerContext.Provider, { value: removalLocker },
+            templateFactory({ data: data, index: index, onRendered: onRendered }),
+            hiddenNode,
+            removalListener)), container);
+};
+exports.TemplateWrapper = react_1.memo(TemplateWrapperComponent);

package/cjs/core/template.d.ts

@@ -1,7 +1,7 @@
 /*!
  * devextreme-react
- * Version: 23.2.1-alpha-23255-1813
- * Build date: Tue Sep 12 2023
+ * Version: 23.2.3
+ * Build date: Tue Nov 28 2023
  *
  * Copyright (c) 2012 - 2023 Developer Express Inc. ALL RIGHTS RESERVED
  *

package/cjs/core/template.js

@@ -1,7 +1,7 @@
 /*!
  * devextreme-react
- * Version: 23.2.1-alpha-23255-1813
- * Build date: Tue Sep 12 2023
+ * Version: 23.2.3
+ * Build date: Tue Nov 28 2023
  *
  * Copyright (c) 2012 - 2023 Developer Express Inc. ALL RIGHTS RESERVED
  *

package/cjs/core/types.d.ts

@@ -0,0 +1,69 @@
+/*!
+ * devextreme-react
+ * Version: 23.2.3
+ * Build date: Tue Nov 28 2023
+ *
+ * Copyright (c) 2012 - 2023 Developer Express Inc. ALL RIGHTS RESERVED
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file in the root of the project for details.
+ *
+ * https://github.com/DevExpress/devextreme-react
+ */
+
+import { ReactNode } from 'react';
+import { ITemplate } from './configuration/config-node';
+interface DXTemplate {
+    render: RenderFunc;
+}
+declare type RenderFunc = (arg: RenderArgs) => HTMLElement;
+interface TemplateArgs {
+    data: any;
+    index?: number;
+    onRendered: () => void;
+}
+export interface RenderArgs {
+    model?: any;
+    container: any;
+    index?: any;
+    onRendered?: () => void;
+}
+export interface UpdateLocker {
+    lock: () => void;
+    unlock: () => void;
+}
+export declare type DXTemplateCollection = Record<string, DXTemplate>;
+export interface TemplateWrapperProps {
+    templateFactory: TemplateFunc;
+    data: any;
+    index: number;
+    container: HTMLElement;
+    onRendered: () => void;
+    onRemoved: () => void;
+}
+export declare type TemplateFunc = (arg: TemplateArgs) => JSX.Element | ReactNode;
+export declare type UpdateTemplateFunc = (onUpdated: () => void) => void;
+export interface InitArgument {
+    createDXTemplates: DXTemplateCreator;
+    clearInstantiationModels: () => void;
+    updateTemplates: UpdateTemplateFunc;
+}
+export interface TemplateManagerUpdateContext {
+    onUpdated: () => void;
+}
+export declare type DXTemplateCreator = (templateOptions: Record<string, ITemplate>) => DXTemplateCollection;
+export interface TemplateManagerProps {
+    init: (args: InitArgument) => void;
+}
+export interface TemplateInstantiationModel {
+    templateKey: string;
+    componentKey: string;
+    index: any;
+    onRendered: () => void;
+    onRemoved: () => void;
+}
+export declare type GetRenderFuncFn = (templateKey: string) => RenderFunc;
+export interface DXRemoveCustomArgs {
+    isUnmounting: boolean;
+}
+export {};

package/cjs/core/types.js

@@ -0,0 +1,15 @@
+/*!
+ * devextreme-react
+ * Version: 23.2.3
+ * Build date: Tue Nov 28 2023
+ *
+ * Copyright (c) 2012 - 2023 Developer Express Inc. ALL RIGHTS RESERVED
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file in the root of the project for details.
+ *
+ * https://github.com/DevExpress/devextreme-react
+ */
+
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/core/widget-config.d.ts

@@ -1,7 +1,7 @@
 /*!
  * devextreme-react
- * Version: 23.2.1-alpha-23255-1813
- * Build date: Tue Sep 12 2023
+ * Version: 23.2.3
+ * Build date: Tue Nov 28 2023
  *
  * Copyright (c) 2012 - 2023 Developer Express Inc. ALL RIGHTS RESERVED
  *

package/cjs/core/widget-config.js

@@ -1,7 +1,7 @@
 /*!
  * devextreme-react
- * Version: 23.2.1-alpha-23255-1813
- * Build date: Tue Sep 12 2023
+ * Version: 23.2.3
+ * Build date: Tue Nov 28 2023
  *
  * Copyright (c) 2012 - 2023 Developer Express Inc. ALL RIGHTS RESERVED
  *