@tylertech/forge-core 2.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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/README.md

@@ -0,0 +1,32 @@
+# Forge Core
+
+This library contains the core building blocks and utilities that are used when building Forge Web Components.
+
+This package is intended to be used directly with projects built using the Forge CLI, but there are many useful
+generic utilities that can be used directly within any web application.
+
+## Usage 
+
+```shell
+$ npm install @tylertech/forge-core
+```
+
+## Development
+
+Install dependencies:
+
+```shell
+$ npm install
+```
+
+Build npm package:
+
+```shell
+$ npm run build
+```
+
+Run tests:
+
+```shell
+$ npm test
+```

package/esm/a11y/a11y.js

@@ -0,0 +1,17 @@
+/**
+ * Hides an element from the user visually, while keeping it in the DOM.
+ * @param element The element to hide from view.
+ */
+export function hideElementVisually(element) {
+    element.style.border = '0';
+    element.style.clip = 'rect(0 0 0 0)';
+    element.style.height = '1px';
+    element.style.margin = '-1px';
+    element.style.overflow = 'hidden';
+    element.style.padding = '0';
+    element.style.position = 'absolute';
+    element.style.width = '1px';
+    element.style.outline = '0';
+    element.style.setProperty('-webkit-appearance', 'none');
+    element.style.setProperty('-moz-appearance', 'none');
+}

package/esm/a11y/index.js

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

package/esm/constants/date-constants.js

@@ -0,0 +1,52 @@
+const days = [
+    'Su',
+    'Mo',
+    'Tu',
+    'We',
+    'Th',
+    'Fr',
+    'Sa'
+];
+const daysLong = [
+    'Sunday',
+    'Monday',
+    'Tuesday',
+    'Wedensday',
+    'Thursday',
+    'Friday',
+    'Saturday'
+];
+const months = [
+    'Jan',
+    'Feb',
+    'Mar',
+    'Apr',
+    'May',
+    'Jun',
+    'Jul',
+    'Aug',
+    'Sep',
+    'Oct',
+    'Nov',
+    'Dec'
+];
+const monthsLong = [
+    'January',
+    'February',
+    'March',
+    'April',
+    'May',
+    'June',
+    'July',
+    'August',
+    'September',
+    'October',
+    'November',
+    'December'
+];
+export const DATE_CONSTANTS = {
+    days,
+    daysLong,
+    months,
+    monthsLong
+};

package/esm/constants/index.js

@@ -0,0 +1 @@
+export * from './date-constants';

package/esm/custom-elements/component-utils.js

@@ -0,0 +1,262 @@
+import { replaceElement, isArray, removeAllChildren, walkUpUntil } from '../utils';
+/**
+ * Recursively defines a component as a custom elements and all of its dependencies.
+ * @param component The component to import.
+ */
+export function defineCustomElement(component) {
+    tryDefine(component._customElementName, component);
+    if (isArray(component._customElementDependencies)) {
+        defineCustomElements(component._customElementDependencies);
+    }
+}
+/**
+ * Defines the specified custom element components.
+ * @param {any[]} components The components to register.
+ */
+export function defineCustomElements(components) {
+    components.forEach(defineCustomElement);
+}
+/**
+ * Attempts to define the provided custom element name/constructor if not already defined.
+ * @param name The name of the custom element to define.
+ * @param ctor The custom element constructor.
+ */
+export function tryDefine(name, ctor, options) {
+    var _a;
+    if ((_a = window === null || window === void 0 ? void 0 : window.customElements) === null || _a === void 0 ? void 0 : _a.get(name)) {
+        return;
+    }
+    window.customElements.define(name, ctor, options);
+}
+/**
+ * Useful when capturing the value of a unupgraded component during the `connectedCallback` upon upgrade.
+ *
+ * More information here:
+ * https://developers.google.com/web/fundamentals/architecture/building-components/best-practices#lazy-properties
+ *
+ * @param property
+ */
+export function upgradeProperty(instance, property) {
+    if (instance.hasOwnProperty(property)) {
+        const value = instance[property];
+        delete instance[property];
+        instance[property] = value;
+    }
+}
+/**
+ * Traverses up the DOM tree starting from the provided component element to find the specified parent.
+ * @param {HTMLElement} component The starting HTMLElement.
+ * @param {string} parentTagName The parent tag name we are searching for.
+ */
+export function requireParent(component, parentTagName) {
+    let el = component;
+    while (el.parentNode) {
+        el = el.parentNode;
+        if (!el.tagName) {
+            break;
+        }
+        if (!el.tagName || el.tagName.toLowerCase() === parentTagName.toLowerCase()) {
+            return el;
+        }
+    }
+    return null;
+}
+/**
+ * Creates a template element from a string.
+ * @param template The template HTML string.
+ */
+export function parseTemplateString(template) {
+    const templateDocument = new DOMParser().parseFromString(template, 'text/html');
+    return templateDocument.querySelector('template');
+}
+/**
+ * Attaches a template to the given web component instance light DOM.
+ * @param {T} componentInstance A component instance.
+ * @param {string} template The template HTML string.
+ */
+export function attachLightTemplate(componentInstance, template) {
+    componentInstance.appendChild(parseTemplateString(template).content.cloneNode(true));
+}
+/**
+ * Attaches a shadow root to the given web component instance.
+ * @param {T} componentInstance A component instance.
+ * @param {string} elementName The name of the element the shadow root is to be attached to.
+ * @param {string} template The shadow root template HTML string.
+ * @param {string | string[]} styles The shadow root styles string to be encapsulated by this shadow root.
+ * @param {boolean} [delegatesFocus=false] Should the component delagate focus.
+ */
+export function attachShadowTemplate(componentInstance, template, styles, delegatesFocus = false) {
+    const templateElement = prepareShadowTemplate(template, styles);
+    componentInstance.attachShadow({ mode: 'open', delegatesFocus });
+    setShadowTemplate(componentInstance, templateElement);
+}
+/**
+ * Replaces the template of an existing shadow root with the provided template.
+ * @param {T} componentInstance A component instance.
+ * @param {string} elementName The name of the element the shadow root is to be attached to.
+ * @param {string} template The shadow root template HTML string.
+ * @param {string | string[]} styles The shadow root styles string to be encapsulated by this shadow root.
+ */
+export function replaceShadowTemplate(componentInstance, template, styles) {
+    if (!componentInstance.shadowRoot) {
+        throw new Error('This element does not contain a shadow root. Did you mean to call `attachShadowTemplate`?');
+    }
+    const templateElement = prepareShadowTemplate(template, styles);
+    if (componentInstance.shadowRoot.children.length) {
+        removeAllChildren(componentInstance.shadowRoot);
+    }
+    setShadowTemplate(componentInstance, templateElement);
+}
+/**
+ * Creates and prepares an HTML template element for rendering within a shadow root.
+ * @param {string} elementName The name of the element the shadow root is to be attached to.
+ * @param {string} template The shadow root template HTML string.
+ * @param {string | string[]} styles The shadow root styles string to be encapsulated by this shadow root.
+ */
+export function prepareShadowTemplate(template, styles) {
+    const templateElement = parseTemplateString(template);
+    if (styles) {
+        styles = styles instanceof Array ? styles : [styles];
+        const styleElement = document.createElement('style');
+        styleElement.type = 'text/css';
+        styleElement.textContent = styles.join(' ');
+        templateElement.content.appendChild(styleElement);
+    }
+    return templateElement;
+}
+/**
+ * Appends a template to the provided components shadow root.
+ * @param {T} componentInstance A component instance.
+ * @param {HTMLTemplateElement} templateElement A template element to be cloned.
+ */
+export function setShadowTemplate(componentInstance, templateElement) {
+    componentInstance.shadowRoot.appendChild(templateElement.content.cloneNode(true));
+}
+/**
+ * Copies style rules from the provided document stylesheets collection to the provided shadow root stylesheet.
+ * @param {Document} fromDocument The document to find the style sheets in.
+ * @param {ShadowRoot} shadowRoot The shadow root that contains the stylesheet to copy the rules to.
+ * @param {IStyleSheetDescriptor[]} styleSheetDescriptors A collection of style sheet predicates.
+ * @param {CSSStyleSheet} shadowStyleSheet The shadow root stylesheet to copy the style rules to.
+ */
+export function provideDocumentStyles(fromDocument, shadowRoot, documentStyleSheets, shadowStyleSheet) {
+    if (!shadowStyleSheet) {
+        return;
+    }
+    const documentSheets = [];
+    documentStyleSheets.forEach(sheet => {
+        const sheetName = typeof sheet === 'string' ? sheet : sheet.name;
+        const sheetFilter = sheet.selectorFilter;
+        const matchingStyleSheet = _findMatchingStyleSheet(fromDocument.styleSheets, sheetName);
+        if (!matchingStyleSheet) {
+            throw new Error(`Could not find stylesheet: ${sheetName}`);
+        }
+        let startIndex = shadowStyleSheet.cssRules.length;
+        for (const rule in matchingStyleSheet.cssRules) {
+            if (matchingStyleSheet.cssRules.hasOwnProperty(rule) && matchingStyleSheet.cssRules[rule].cssText && (!sheetFilter || new RegExp(sheetFilter).test(matchingStyleSheet.cssRules[rule].selectorText))) {
+                shadowStyleSheet.insertRule(matchingStyleSheet.cssRules[rule].cssText, startIndex++);
+            }
+        }
+    });
+}
+/**
+ * Finds a stylesheet by name in the provided stylesheet list.
+ * @param styleSheetList The stylesheet list to search.
+ * @param sheetName The stylesheet name to find.
+ * @returns {CSSStyleSheet | undefined}
+ */
+function _findMatchingStyleSheet(styleSheetList, sheetName) {
+    for (const prop in styleSheetList) {
+        if (styleSheetList.hasOwnProperty(prop) && styleSheetList[prop].href) {
+            if (new RegExp(sheetName).test(styleSheetList[prop].href)) {
+                return styleSheetList[prop];
+            }
+        }
+    }
+    return undefined;
+}
+/**
+ * Gets an HTML element using a query selector from the provided components` shadow root.
+ * @param {HTMLElement} componentInstance The component instance that contains a shadow root.
+ * @param {string} selector The selector to be passed to `querySelector`.
+ */
+export function getShadowElement(componentInstance, selector) {
+    return componentInstance.shadowRoot.querySelector(selector);
+}
+/**
+ * Gets an HTML element using a query selector from the provided components` light DOM.
+ * @param {HTMLElement} componentInstance The component instance.
+ * @param {string} selector The selector to be passed to `querySelector`.
+ */
+export function getLightElement(componentInstance, selector) {
+    return componentInstance.querySelector(selector);
+}
+/**
+ * Creates and dispatches a cross-browser `CustomEvent` with the provided type and data.
+ * @param {string} type
+ * @param {any} data
+ * @param {boolean=} bubble
+ */
+export function emitEvent(component, type, data, bubble = true, cancelable = false) {
+    let evt;
+    if (typeof CustomEvent === 'function') {
+        evt = new CustomEvent(type, {
+            detail: data,
+            bubbles: bubble,
+            cancelable
+        });
+    }
+    else {
+        evt = document.createEvent('CustomEvent');
+        evt.initCustomEvent(type, bubble, cancelable, data);
+    }
+    return component.dispatchEvent(evt);
+}
+/**
+ * Replaces the provided element with a placeholder comment and vice versa.
+ * Useful for hiding and showing elements while retaining their location in the DOM.
+ * @param {boolean} isVisible Whether the element is visible or not.
+ * @param {string} elementName The element tag name.
+ * @param {string} selector The selector used to find the element
+ * @param {Node} element The element
+ * @param {Comment} placeholder The existing placeholder
+ */
+export function toggleElementPlaceholder(component, isVisible, elementName, selector, element, placeholder) {
+    const exists = !!getShadowElement(component, selector);
+    if (!placeholder) {
+        placeholder = document.createComment(`(${elementName}) ${selector}`);
+    }
+    if (isVisible && !exists) {
+        replaceElement(element, placeholder);
+    }
+    else if (!isVisible && exists) {
+        replaceElement(placeholder, element);
+    }
+    return placeholder;
+}
+/**
+ * Walks up the tree starting a specific node and stops when it finds a shadow root.
+ * @param {Node} node The node to start searching from.
+ * @returns {ShadowRoot | null} The closest shadow root ancestor, or null if not inside a shadow root.
+ */
+export function getClosestShadowRoot(node) {
+    return walkUpUntil(node, current => current.toString() === '[object ShadowRoot]');
+}
+/**
+ * Finds the closest element up the tree from a starting element across shadow boundaries.
+ * @param selector The CSS selector for the element to find.
+ * @param startElement The element to start finding from.
+ */
+export function closestElement(selector, startElement) {
+    function __closestFrom(el) {
+        if (!el || el === document || el === window) {
+            return null;
+        }
+        if (el.assignedSlot) {
+            el = el.assignedSlot;
+        }
+        const found = el.closest(selector);
+        return found || __closestFrom(el.getRootNode().host);
+    }
+    return __closestFrom(startElement);
+}

package/esm/custom-elements/decorators/custom-element.js

@@ -0,0 +1,52 @@
+import { isFunction } from '../../utils';
+import { defineCustomElement } from '../component-utils';
+export const CUSTOM_ELEMENT_NAME_PROPERTY = '_customElementName';
+export const CUSTOM_ELEMENT_DEPENDENCIES_PROPERTY = '_customElementDependencies';
+/**
+ * This decorator is intended to be used on classes that extend `HTMLElement` to
+ * extend/modify the behavior of a custom element.
+ * @param {ICustomElementConfig} [config={}] The custom element configuration.
+ */
+export function CustomElement({ name, dependencies, define = true }) {
+    return (ctor) => {
+        patchConnectedCallback(ctor);
+        if (name) {
+            ctor[CUSTOM_ELEMENT_NAME_PROPERTY] = name;
+        }
+        if (dependencies && dependencies.length) {
+            ctor[CUSTOM_ELEMENT_DEPENDENCIES_PROPERTY] = dependencies;
+        }
+        if (window.__forgeFlags__autoDefine !== false && define) {
+            defineCustomElement(ctor);
+        }
+    };
+}
+function patchConnectedCallback(ctor) {
+    const originalConnectedCallback = ctor.prototype.connectedCallback;
+    ctor.prototype.connectedCallback = function () {
+        if (!this.isConnected) {
+            return;
+        }
+        if (!this._isInitialized) {
+            tryUpgradeOwnProperties(this);
+            if (isFunction(this.initializedCallback)) {
+                this.initializedCallback.apply(this);
+            }
+            this._isInitialized = true;
+        }
+        if (isFunction(originalConnectedCallback)) {
+            originalConnectedCallback.apply(this);
+        }
+    };
+}
+function tryUpgradeOwnProperties(instance) {
+    // We ignore our properties that start with an underscore as those are considered "internal"
+    // and are not auto-upgraded for us
+    const ownProperties = Object.getOwnPropertyNames(instance)
+        .filter(p => !p.startsWith('_'));
+    for (const property of ownProperties) {
+        const value = instance[property];
+        delete instance[property];
+        instance[property] = value;
+    }
+}