@vaadin/vaadin-template-renderer 22.0.0-alpha4 → 22.0.0-alpha8

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2017 Vaadin Ltd.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/package.json

@@ -1,37 +1,33 @@
 {
   "name": "@vaadin/vaadin-template-renderer",
-  "version": "22.0.0-alpha4",
+  "version": "22.0.0-alpha8",
+  "publishConfig": {
+    "access": "public"
+  },
   "description": "vaadin-template-renderer",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vaadin/web-components.git",
+    "directory": "packages/vaadin-template-renderer"
+  },
+  "author": "Vaadin Ltd",
+  "homepage": "https://vaadin.com/components",
+  "bugs": {
+    "url": "https://github.com/vaadin/web-components/issues"
+  },
   "main": "vaadin-template-renderer.js",
   "module": "vaadin-template-renderer.js",
-  "repository": "vaadin/vaadin-template-renderer",
+  "files": [
+    "vaadin-*.js"
+  ],
   "keywords": [
     "Vaadin",
     "polymer",
     "template"
   ],
-  "author": "Vaadin Ltd",
-  "license": "Apache-2.0",
-  "bugs": {
-    "url": "https://github.com/vaadin/web-components/issues"
-  },
-  "homepage": "https://vaadin.com/components",
-  "files": [
-    "vaadin-*.js",
-    "src"
-  ],
   "dependencies": {
-    "@polymer/polymer": "^3.0.0"
-  },
-  "devDependencies": {
-    "@esm-bundle/chai": "^4.3.4",
-    "@vaadin/checkbox": "^22.0.0-alpha4",
-    "@vaadin/testing-helpers": "^0.2.1",
-    "@vaadin/vaadin-grid": "^22.0.0-alpha4",
-    "@vaadin/vaadin-grid-pro": "^22.0.0-alpha4"
-  },
-  "publishConfig": {
-    "access": "public"
+    "@vaadin/polymer-legacy-adapter": "22.0.0-alpha8"
   },
-  "gitHead": "86c025abd605d5a4a3c0ae36eb07c34704cee1f2"
+  "gitHead": "c24468526298ee26ad7f7280b59f6c8789e1f75f"
 }

package/vaadin-template-renderer.js

@@ -1 +1 @@
-export * from './src/vaadin-template-renderer.js';
+import '@vaadin/polymer-legacy-adapter/template-renderer.js';

package/src/vaadin-template-renderer-grid-templatizer.js

@@ -1,111 +0,0 @@
-import { Templatizer } from './vaadin-template-renderer-templatizer.js';
-
-export class GridTemplatizer extends Templatizer {
-  /**
-   * @override
-   */
-  static get is() {
-    return 'vaadin-template-renderer-grid-templatizer';
-  }
-
-  /**
-   * Updates the grid items once an item's nested property is changed.
-   *
-   * Note: The templatizer doesn't support 2-way binding for items provided by custom data provider.
-   * Note: The templatizer doesn't support 2-way binding for the whole item:
-   * <div>{{item}}</div> - not allowed.
-   * <div>{{item.title}}</div> - allowed.
-   *
-   * @protected
-   */
-  _onItemPropertyChanged(instance, path, value) {
-    // Supports 2-way binding only for nested `item` properties.
-    if (path === 'item') {
-      return;
-    }
-
-    // Supports 2-way binding only for items provided by the array data provider.
-    if (!Array.isArray(this.__grid.items)) {
-      return;
-    }
-
-    const index = this.__grid.items.indexOf(instance.item);
-
-    path = path.replace(/^item\./, '');
-    path = `items.${index}.${path}`;
-
-    this.__grid.notifyPath(path, value);
-  }
-
-  /**
-   * Expands or collapses the item once the `expanded` property is changed.
-   * The listener handles only user-fired changes.
-   *
-   * @protected
-   */
-  _onExpandedPropertyChanged(instance, _path, value) {
-    // Skip if the value is changed by the templatizer.
-    if (instance.__properties.expanded === value) {
-      return;
-    }
-
-    if (value) {
-      this.__grid.expandItem(instance.item);
-    } else {
-      this.__grid.collapseItem(instance.item);
-    }
-  }
-
-  /**
-   * Selects or deselects the item once the `selected` property is changed.
-   * The listener handles only user-fired changes.
-   *
-   * @protected
-   */
-  _onSelectedPropertyChanged(instance, _path, value) {
-    // Skip if the value is changed by the templatizer.
-    if (instance.__properties.selected === value) {
-      return;
-    }
-
-    if (value) {
-      this.__grid.selectItem(instance.item);
-    } else {
-      this.__grid.deselectItem(instance.item);
-    }
-  }
-
-  /**
-   * Opens or closes the details for the item once the `detailsOpened` property is changed.
-   * The listener handles only user-fired changes.
-   *
-   * @protected
-   */
-  _onDetailsOpenedPropertyChanged(instance, _path, value) {
-    // Skip if the value is changed by the templatizer.
-    if (instance.__properties.detailsOpened === value) {
-      return;
-    }
-
-    if (value) {
-      this.__grid.openItemDetails(instance.item);
-    } else {
-      this.__grid.closeItemDetails(instance.item);
-    }
-  }
-
-  /**
-   * Returns a reference to the grid which the templatizer is connected to.
-   *
-   * @private
-   */
-  get __grid() {
-    if (this.__component.__gridElement) {
-      return this.__component;
-    }
-
-    return this.__component._grid;
-  }
-}
-
-customElements.define(GridTemplatizer.is, GridTemplatizer);

package/src/vaadin-template-renderer-templatizer.js

@@ -1,134 +0,0 @@
-import { PolymerElement } from '@polymer/polymer';
-import { templatize } from '@polymer/polymer/lib/utils/templatize';
-
-export class Templatizer extends PolymerElement {
-  static create(component, template) {
-    const templatizer = new this();
-    templatizer.__template = template;
-    templatizer.__component = component;
-    return templatizer;
-  }
-
-  static get is() {
-    return 'vaadin-template-renderer-templatizer';
-  }
-
-  constructor() {
-    super();
-
-    this.__template = null;
-    this.__component = null;
-    this.__TemplateClass = null;
-    this.__templateInstances = new Set();
-  }
-
-  /**
-   * If the template instance was created by this templatizer's instance and is still attached to DOM,
-   * it only re-renders the instance with the new properties.
-   * Otherwise, it disposes of the old template instance (if it exists),
-   * creates a new template instance with the given properties and renders the instance's root to the element.
-   */
-  render(element, properties = {}) {
-    let instance = element.__templateInstance;
-
-    if (this.__hasTemplateInstance(instance) && this.__isTemplateInstanceAttachedToDOM(instance)) {
-      this.__updateProperties(instance, properties);
-      return;
-    }
-
-    if (this.__hasTemplateInstance(instance)) {
-      this.__disposeOfTemplateInstance(instance);
-    }
-
-    instance = this.__createTemplateInstance(properties);
-    element.__templateInstance = instance;
-    element.innerHTML = '';
-    element.appendChild(instance.root);
-  }
-
-  /** @private */
-  __updateProperties(instance, properties) {
-    // The Polymer uses `===` to check whether a property is changed and should be re-rendered.
-    // This means, object properties won't be re-rendered when mutated inside.
-    // This workaround forces the `item` property to re-render even
-    // the new item is stricly equal to the old item.
-    if (instance.item === properties.item) {
-      instance._setPendingProperty('item');
-    }
-
-    instance.__properties = properties;
-    instance.setProperties(properties);
-  }
-
-  /** @private */
-  __createTemplateInstance(properties) {
-    this.__createTemplateClass(properties);
-
-    const instance = new this.__TemplateClass(properties);
-    instance.__properties = properties;
-
-    this.__templateInstances.add(instance);
-
-    return instance;
-  }
-
-  /** @private */
-  __disposeOfTemplateInstance(instance) {
-    this.__templateInstances.delete(instance);
-  }
-
-  /** @private */
-  __hasTemplateInstance(instance) {
-    return this.__templateInstances.has(instance);
-  }
-
-  /** @private */
-  __isTemplateInstanceAttachedToDOM(instance) {
-    // The edge-case case when the template is empty
-    if (instance.children.length === 0) {
-      return false;
-    }
-
-    return !!instance.children[0].parentElement;
-  }
-
-  /** @private */
-  __createTemplateClass(properties) {
-    if (this.__TemplateClass) return;
-
-    const instanceProps = Object.keys(properties).reduce((accum, key) => {
-      return { ...accum, [key]: true };
-    }, {});
-
-    this.__TemplateClass = templatize(this.__template, this, {
-      // This property prevents the template instance properties
-      // from passing into the `forwardHostProp` callback
-      instanceProps,
-
-      // When changing a property of the data host component, this callback forwards
-      // the changed property to the template instances so that cause their re-rendering.
-      forwardHostProp(prop, value) {
-        this.__templateInstances.forEach((instance) => {
-          instance.forwardHostProp(prop, value);
-        });
-      },
-
-      notifyInstanceProp(instance, path, value) {
-        let rootProperty;
-
-        // Extracts the root property name from the path
-        rootProperty = path.split('.')[0];
-        // Capitalizes the property name
-        rootProperty = rootProperty[0].toUpperCase() + rootProperty.slice(1);
-
-        const callback = `_on${rootProperty}PropertyChanged`;
-
-        if (this[callback]) {
-          this[callback](instance, path, value);
-        }
-      }
-    });
-  }
-}
-
-customElements.define(Templatizer.is, Templatizer);

package/src/vaadin-template-renderer.js

@@ -1,128 +0,0 @@
-import { FlattenedNodesObserver } from '@polymer/polymer/lib/utils/flattened-nodes-observer.js';
-
-import './vaadin-template-renderer-templatizer.js';
-import './vaadin-template-renderer-grid-templatizer.js';
-
-import { Templatizer } from './vaadin-template-renderer-templatizer.js';
-import { GridTemplatizer } from './vaadin-template-renderer-grid-templatizer.js';
-
-function createRenderer(component, template, TemplatizerClass = Templatizer) {
-  const templatizer = TemplatizerClass.create(component, template);
-
-  const renderer = (root, _owner, model) => {
-    templatizer.render(root, model);
-  };
-
-  template.__templatizer = templatizer;
-  renderer.__templatized = true;
-
-  return renderer;
-}
-
-function assignRenderer(component, rendererName, renderer) {
-  const oldRenderer = component[rendererName];
-
-  if (oldRenderer && !oldRenderer.__templatized) {
-    const tag = component.localName;
-
-    throw new Error(`Cannot use both a template and a renderer for <${tag} />.`);
-  }
-
-  component[rendererName] = renderer;
-}
-
-function showTemplateWarning(component) {
-  if (component.__suppressTemplateWarning) {
-    return;
-  }
-
-  if (component.hasAttribute('suppress-template-warning')) {
-    return;
-  }
-
-  console.warn(
-    `WARNING: <template> inside <${component.localName}> is deprecated. Use a renderer function instead (see https://vaad.in/template-renderer)`
-  );
-
-  component.__suppressTemplateWarning = true;
-}
-
-function processGridTemplate(grid, template) {
-  if (template.matches('.row-details')) {
-    const renderer = createRenderer(grid, template, GridTemplatizer);
-    assignRenderer(grid, 'rowDetailsRenderer', renderer);
-    return;
-  }
-}
-
-function processGridColumnTemplate(column, template) {
-  if (template.matches('.header')) {
-    const renderer = createRenderer(column, template);
-    assignRenderer(column, 'headerRenderer', renderer);
-    return;
-  }
-
-  if (template.matches('.footer')) {
-    const renderer = createRenderer(column, template);
-    assignRenderer(column, 'footerRenderer', renderer);
-    return;
-  }
-
-  if (template.matches('.editor')) {
-    const renderer = createRenderer(column, template, GridTemplatizer);
-    assignRenderer(column, 'editModeRenderer', renderer);
-    return;
-  }
-
-  const renderer = createRenderer(column, template, GridTemplatizer);
-  assignRenderer(column, 'renderer', renderer);
-}
-
-function processTemplate(component, template) {
-  showTemplateWarning(component);
-
-  if (component.__gridElement) {
-    processGridTemplate(component, template);
-    return;
-  }
-
-  if (component.__gridColumnElement) {
-    processGridColumnTemplate(component, template);
-    return;
-  }
-
-  const renderer = createRenderer(component, template);
-  assignRenderer(component, 'renderer', renderer);
-}
-
-function processTemplates(component) {
-  FlattenedNodesObserver.getFlattenedNodes(component)
-    .filter((child) => {
-      return child instanceof HTMLTemplateElement;
-    })
-    .forEach((template) => {
-      // Ignore templates which have been processed earlier
-      if (template.__templatizer) {
-        return;
-      }
-
-      processTemplate(component, template);
-    });
-}
-
-function observeTemplates(component) {
-  if (component.__templateObserver) return;
-
-  component.__templateObserver = new FlattenedNodesObserver(component, () => {
-    processTemplates(component);
-  });
-}
-
-/**
- * Public API
- */
-window.Vaadin = window.Vaadin || {};
-window.Vaadin.templateRendererCallback = (component) => {
-  processTemplates(component);
-  observeTemplates(component);
-};