@jinntec/fore 1.0.0-3 → 1.0.0

package/index.js

@@ -35,8 +35,11 @@ import './src/actions/fx-toggle.js';
 import './src/actions/fx-dispatch.js';
 import './src/actions/fx-update.js';
 import './src/actions/fx-refresh.js';
+import './src/actions/fx-replace.js';
+import './src/actions/fx-return.js';
 import './src/actions/fx-confirm.js';
 import './src/actions/fx-show.js';
 import './src/actions/fx-hide.js';
 
 import './src/functions/fx-function.js';
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jinntec/fore",
-  "version": "1.0.0-3",
+  "version": "1.0.0",
   "description": "Fore - Forms for the Web",
   "module": "./index.js",
   "publishConfig": {
@@ -24,56 +24,52 @@
     "resources/toastify.css",
     "src/**/*",
     "dist/fore.js",
-    "dist/fore-all.js"
+    "dist/fore.js.map",
+    "dist/fore-dev.js",
+    "dist/fore-dev.js.map",
+    "!.DS_Store"
   ],
   "dependencies": {
-    "@jinntec/jinn-toast": "^1.0.2",
-    "@polymer/iron-component-page": "^4.0.1",
-    "@polymer/iron-demo-helpers": "^3.1.0",
-    "@polymer/paper-button": "^3.0.1",
-    "@polymer/paper-checkbox": "^3.1.0",
-    "@polymer/paper-dialog": "^3.0.1",
-    "@polymer/paper-dialog-scrollable": "^3.0.1",
-    "@polymer/paper-input": "^3.2.1",
-    "fontoxpath": "^3.20.4",
-    "web-component-analyzer": "^1.1.6"
+    "@jinntec/jinn-toast": "^1.0.4",
+    "fontoxpath": "^3.26.0"
   },
   "devDependencies": {
-    "@babel/plugin-proposal-class-properties": "^7.13.0",
-    "@open-wc/building-rollup": "^0.21.1",
-    "@open-wc/eslint-config": "^2.0.0",
+    "@babel/plugin-proposal-class-properties": "^7.17.12",
+    "@open-wc/building-rollup": "^2.0.1",
+    "@open-wc/eslint-config": "^7.0.0",
     "@open-wc/prettier-config": "^0.1.10",
-    "@open-wc/semantic-dom-diff": "^0.19.4",
-    "@open-wc/testing": "^2.0.0",
+    "@open-wc/semantic-dom-diff": "^0.19.6",
+    "@open-wc/testing": "^3.1.5",
     "@open-wc/testing-karma": "^4.0.9",
-    "@open-wc/testing-karma-bs": "^1.0.0",
-    "@rollup/plugin-commonjs": "^11.1.0",
-    "@rollup/plugin-node-resolve": "^6.1.0",
+    "@open-wc/testing-karma-bs": "^1.3.94",
+    "@rollup/plugin-commonjs": "^22.0.0",
+    "@rollup/plugin-node-resolve": "^13.3.0",
     "@rollup/plugin-strip": "^2.1.0",
     "@skypack/package-check": "^0.2.2",
-    "@webcomponents/webcomponentsjs": "^2.0.0",
-    "deepmerge": "^3.3.0",
-    "es-dev-server": "^1.57.8",
-    "eslint": "^6.1.0",
-    "husky": "^1.0.0",
-    "jsdoc": "^3.6.7",
-    "lint-staged": "^8.0.0",
-    "lit-html": "^1.1.2",
-    "mocha": "^7.0.1",
-    "np": "^7.5.0",
-    "rimraf": "^2.7.1",
-    "rollup": "^1.32.1",
+    "@webcomponents/webcomponentsjs": "^2.6.0",
+    "deepmerge": "^4.2.2",
+    "es-dev-server": "^2.1.0",
+    "eslint": "^8.16.0",
+    "husky": "^8.0.1",
+    "jsdoc": "^3.6.10",
+    "lint-staged": "^12.4.3",
+    "lit-html": "^2.2.5",
+    "mocha": "^10.0.0",
+    "np": "^7.6.1",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.75.4",
     "rollup-plugin-babel": "^4.4.0",
     "rollup-plugin-minify-html-literals": "^1.2.6",
-    "typescript": "^3.7.5",
+    "typescript": "^4.7.2",
+    "web-component-analyzer": "^1.1.6",
     "xmlserializer": "^0.6.1"
   },
   "scripts": {
     "test": "karma start",
-    "lint:eslint": "eslint --ext .js,.html . --ignore-path .gitignore",
-    "format:eslint": "eslint --ext .js,.html . --fix --ignore-path .gitignore",
-    "lint:prettier": "prettier \"**/*.js\" --check --ignore-path .gitignore",
-    "format:prettier": "prettier \"**/*.js\" --write --ignore-path .gitignore",
+    "lint:eslint": "eslint --ext .js,.html . --ignore-path .eslintignore",
+    "format:eslint": "eslint --ext .js,.html . --fix --ignore-path .eslintignore",
+    "lint:prettier": "prettier \"**/*.js\" --check --ignore-path .eslintignore",
+    "format:prettier": "prettier \"**/*.js\" --write --ignore-path .eslintignore",
     "docs": "wca src -f json --outFile fore-elements.json",
     "lint": "npm run lint:eslint && npm run lint:prettier",
     "lint:types": "tsc",
@@ -84,7 +80,7 @@
     "test:bs": "karma start karma.bs.config.js --coverage",
     "start:build": "cd dist && es-dev-server --open",
     "build": "rimraf dist && rollup -c rollup.config.js",
-    "start": "es-dev-server --app-index index.html --node-resolve --watch --open"
+    "start": "es-dev-server --app-index doc/index.html --node-resolve --watch --open"
   },
   "keywords": [
     "Fore",

package/resources/fore.css

@@ -2,10 +2,13 @@
 @import 'vars.css';
 
 html{
-    --inspector-bg:var(--paper-grey-500);
+    --inspector-bg:var(--paper-grey-300);
     --inspector-pre-bg:var(--paper-grey-100);
     --inspector-color:var(--paper-grey-800);
     --inspector-instance-height:200px;
+    --inspector-handle-bg: var(--paper-blue-500);
+    --inspector-handle-width: 30px;
+
 }
 [unresolved]{
     display: none;
@@ -14,6 +17,19 @@ html{
     pointer-events: none;
     cursor: default;
 }
+input[readonly]{
+    background: lightgrey;
+}
+
+/* fx-fore{ */
+/*     opacity: 0; */
+/* } */
+/* fx-fore.fx-ready{ */
+/*     opacity: 1; */
+/* } */
+fx-group, fx-switch, fx-repeat, fx-dialog{
+    display: block;
+}
 fx-trigger a[disabled] {
     color:lightgrey;
 }
@@ -35,7 +51,7 @@ fx-model, fx-model *, fx-model ::slotted(fx-instance), fx-instance{
 
 fx-control, fx-trigger{
     white-space: nowrap;
-    position: relative;
+    /* position: relative; */
 }
 .fx-checkbox{
     white-space: nowrap;
@@ -59,56 +75,25 @@ fx-repeatitem{
 }
 
 /* fx-inspector styles */
-fx-inspector{
-    position:fixed;
-    left:0;
-    right:0;
-    bottom:0;
-    width: 100%;
-    background: var(--inspector-bg);
-    color: white;
-    max-height: 33%;
-    overflow: scroll;
-    border-top:3px solid black;
-    opacity: 0.9;
-}
-fx-inspector::before{
-    content:'Instance Inspector';
-    font-style:italic;
-    position:absolute;
-    top:0;
-    right: 0.3rem;
-    z-index: 10;
-    font-size: 0.8rem;
-}
-fx-inspector details{
-    padding: 1rem;
-}
-fx-inspector pre{
-    background: var(--inspector-pre-bg);
-    border-radius: 0.5rem;
-    padding: 0.3rem;
-    max-height: var(--inspector-instance-height);
-    /*overflow: scroll;*/
-}
-fx-inspector details{
-    overflow: auto;
-    margin:0;
-}
-fx-inspector summary{
-    padding: 0;
-}
+
+/* ### FX-DIALOG STYLES ### */
+/* ### FX-DIALOG STYLES ### */
+/* ### FX-DIALOG STYLES ### */
 fx-dialog{
     display: none;
+    opacity: 0;
+    transition: opacity 1s linear;
 }
 fx-dialog.show{
     display: block;
     min-height: 200px;
     border-radius: 0.5rem;
-    /*opacity: 0.3;*/
+    opacity: 1;
     background:rgba(0,0,0,0.5);
     z-index: 10;
+    transition: opacity 2s linear;
 }
+
 fx-dialog.show .dialog-content{
     padding: 1rem;
     width:fit-content;
@@ -186,11 +171,11 @@ fx-dialog .action{
     animation: none;
     opacity: 1;
 }
-@keyframes fadein {
-    0% {
-        opacity:0;
-    }
-    100% {
-        opacity:1;
-    }
-}
+/* @keyframes fadein { */
+/*     0% { */
+/*         opacity:0; */
+/*     } */
+/*     100% { */
+/*         opacity:1; */
+/*     } */
+/* } */

package/src/DependencyNotifyingDomFacade.js

@@ -45,21 +45,14 @@ export class DependencyNotifyingDomFacade {
    * @param  bucket - The bucket that matches the attribute that will be used.
    */
   // eslint-disable-next-line class-methods-use-this
-/*
   getChildNodes(node, bucket) {
     const matchingNodes = Array.from(node.childNodes).filter(
       childNode => !bucket || getBucketsForNode(childNode).includes(bucket),
     );
-    return matchingNodes;
-  }
-*/
-
-  getChildNodes(node, bucket) {
-    const matchingNodes = Array.from(node.childNodes).filter(
-        childNode => !bucket || getBucketsForNode(childNode).includes(bucket));
     matchingNodes.forEach(matchingNode => this._onNodeTouched(matchingNode));
     return matchingNodes;
   }
+
   /**
    * Get the data of this node.
    *
@@ -83,11 +76,11 @@ export class DependencyNotifyingDomFacade {
    * @param  bucket - The bucket that matches the attribute that will be used.
    */
   getFirstChild(node, bucket) {
-    const matchingNode = Array.from(this.getChildNodes()).filter(
-      childNode => !bucket || getBucketsForNode(childNode).includes(bucket),
-    )[0];
-    if (matchingNode) {
-      return matchingNode;
+    for (const child of node.childNodes) {
+      if (!bucket || getBucketsForNode(child).includes(bucket)) {
+        this._onNodeTouched(child);
+        return child;
+      }
     }
     return null;
   }
@@ -120,12 +113,13 @@ export class DependencyNotifyingDomFacade {
    */
   // eslint-disable-next-line class-methods-use-this
   getNextSibling(node, bucket) {
-    for (let { nextSibling } = node; nextSibling; nextSibling = nextSibling.nextSibling) {
-      if (!getBucketsForNode(nextSibling).includes(bucket)) {
+    for (let sibling = node.nextSibling; sibling; sibling = sibling.nextSibling) {
+      if (!getBucketsForNode(sibling).includes(bucket)) {
         // eslint-disable-next-line no-continue
         continue;
       }
-      return nextSibling;
+      this._onNodeTouched(sibling);
+      return sibling;
     }
     return null;
   }

package/src/ForeElementMixin.js

@@ -1,5 +1,6 @@
 import { XPathUtil } from './xpath-util.js';
 import { FxModel } from './fx-model.js';
+import { Fore } from './fore.js';
 import {
   evaluateXPath,
   evaluateXPathToFirstNode,
@@ -7,6 +8,11 @@ import {
 } from './xpath-evaluation.js';
 import getInScopeContext from './getInScopeContext.js';
 
+/**
+ * Mixin containing all general functions that are shared by all Fore element classes.
+ * @param superclass
+ * @returns {{readonly properties: {ref: {type: StringConstructor}, context: {type: ObjectConstructor}, nodeset: {type: ObjectConstructor}, model: {type: ObjectConstructor}, inScopeVariables: {type: MapConstructor}, modelItem: {type: ObjectConstructor}}, new(): ForeElementMixin, context: null, model: null, modelItem: {}, ref: *|string, inScopeVariables: null, nodeset: *, prototype: ForeElementMixin}}
+ */
 export const foreElementMixin = superclass =>
   class ForeElementMixin extends superclass {
     static get properties() {
@@ -94,10 +100,21 @@ export const foreElementMixin = superclass =>
      */
     evalInContext() {
       // const inscopeContext = this.getInScopeContext();
-      const inscopeContext = getInScopeContext(this.getAttributeNode('ref') || this, this.ref);
+      let inscopeContext;
+      if (this.hasAttribute('context')) {
+        inscopeContext = getInScopeContext(this.getAttributeNode('context') || this, this.context);
+      }
+      if (this.hasAttribute('ref')) {
+        inscopeContext = getInScopeContext(this.getAttributeNode('ref') || this, this.ref);
+      }
       if (!inscopeContext) {
-        console.warn('no in scopeContext for ', this);
-        return;
+        // ### always fall back to default context with there's neither a 'context' or 'ref' present
+        inscopeContext = this.getModel()
+          .getDefaultInstance()
+          .getDefaultContext();
+        // console.warn('no in scopeContext for ', this);
+        // console.warn('using default context ', this);
+        // return;
       }
       if (this.ref === '') {
         this.nodeset = inscopeContext;
@@ -120,7 +137,7 @@ export const foreElementMixin = superclass =>
         if (nodeType) {
           this.nodeset = evaluateXPathToFirstNode(this.ref, inscopeContext, this);
         } else {
-          this.nodeset = evaluateXPath(this.ref, inscopeContext, this);
+          [this.nodeset] = evaluateXPath(this.ref, inscopeContext, this);
         }
       }
       // console.log('UiElement evaluated to nodeset: ', this.nodeset);
@@ -139,7 +156,7 @@ export const foreElementMixin = superclass =>
         return this.getAttribute('ref');
       }
       // try to get closest parent bind
-      const parent = this.parentNode.closest('[ref]');
+      const parent = Fore.getClosest('[ref]', this.parentNode);
       if (!parent) {
         return 'instance()'; // the default instance
       }
@@ -178,10 +195,10 @@ export const foreElementMixin = superclass =>
         this.modelItem = mi;
       }
 
-      const repeated = this.closest('fx-repeatitem');
+      const repeated = Fore.getClosest('fx-repeatitem', this);
       let existed;
       if (repeated) {
-        const { index } = this.closest('fx-repeatitem');
+        const { index } = repeated;
         if (Array.isArray(this.nodeset)) {
           existed = this.getModel().getModelItem(this.nodeset[index - 1]);
         } else {
@@ -211,7 +228,7 @@ export const foreElementMixin = superclass =>
           return evaluateXPathToString(valAttr, inscopeContext, this.getOwnerForm());
         } catch (error) {
           console.error(error);
-          this.dispatch('error', { message: error });
+          Fore.dispatch(this, 'error', { message: error });
         }
       }
       if (this.textContent) {
@@ -227,14 +244,4 @@ export const foreElementMixin = superclass =>
     setInScopeVariables(inScopeVariables) {
       this.inScopeVariables = inScopeVariables;
     }
-
-    dispatch(eventName, detail) {
-      const event = new CustomEvent(eventName, {
-        composed: true,
-        bubbles: true,
-        detail,
-      });
-      // console.log('firing', event);
-      this.dispatchEvent(event);
-    }
   };

package/src/actions/abstract-action.js

@@ -1,5 +1,7 @@
 import { foreElementMixin } from '../ForeElementMixin.js';
-import { evaluateXPathToBoolean } from '../xpath-evaluation.js';
+import { evaluateXPathToBoolean, resolveId } from '../xpath-evaluation.js';
+import getInScopeContext from '../getInScopeContext.js';
+import { Fore } from '../fore.js';
 
 async function wait(howLong) {
   return new Promise(resolve => setTimeout(() => resolve(), howLong));
@@ -86,7 +88,7 @@ export class AbstractAction extends foreElementMixin(HTMLElement) {
       } else if (this.target === '#document') {
         document.addEventListener(this.event, e => this.execute(e));
       } else {
-        this.targetElement = document.getElementById(this.target);
+        this.targetElement = resolveId(this.target, this);
         this.targetElement.addEventListener(this.event, e => this.execute(e));
       }
     } else {
@@ -112,9 +114,12 @@ export class AbstractAction extends foreElementMixin(HTMLElement) {
    * @param e
    */
   async execute(e) {
-    console.log('executing', this);
+    // console.log('executing', this);
+    // console.log('executing e', e);
+    // console.log('executing e phase', e.eventPhase);
     if (e && e.detail) {
       this.detail = e.detail;
+      // console.log('#### detail', e.detail);
     }
     this.needsUpdate = false;
 
@@ -124,7 +129,7 @@ export class AbstractAction extends foreElementMixin(HTMLElement) {
     }
 
     // First check if 'if' condition is true - otherwise exist right away
-    if (this.ifExpr && !evaluateXPathToBoolean(this.ifExpr, this.nodeset, this)) {
+    if (this.ifExpr && !evaluateXPathToBoolean(this.ifExpr, getInScopeContext(this), this)) {
       return;
     }
 
@@ -139,7 +144,7 @@ export class AbstractAction extends foreElementMixin(HTMLElement) {
           return;
         }
 
-        if (!evaluateXPathToBoolean(this.whileExpr, this.nodeset, this)) {
+        if (!evaluateXPathToBoolean(this.whileExpr, getInScopeContext(this), this)) {
           // Done with iterating
           return;
         }
@@ -198,13 +203,16 @@ export class AbstractAction extends foreElementMixin(HTMLElement) {
   }
 
   /**
+   * dispathes action-performed event
+   *
+   * @event action-performed - whenever an action has been run
    */
   dispatchActionPerformed() {
     console.log('action-performed ', this);
-    this.dispatchEvent(
-      new CustomEvent('action-performed', { composed: true, bubbles: true, detail: {} }),
-    );
+    Fore.dispatch(this, 'action-performed', {});
   }
 }
 
-window.customElements.define('abstract-action', AbstractAction);
+if (!customElements.get('abstract-action')) {
+  window.customElements.define('abstract-action', AbstractAction);
+}

package/src/actions/fx-action.js

@@ -47,13 +47,15 @@ export class FxAction extends AbstractAction {
         }
         const action = actionOrVar;
         action.detail = this.detail;
-        // action.perform();
-        action.execute();
+        action.perform();
+        // action.execute();
       });
       this.dispatchActionPerformed();
-      // this.needsUpdate = false;
+      this.needsUpdate = true;
     }
   }
 }
 
-window.customElements.define('fx-action', FxAction);
+if (!customElements.get('fx-action')) {
+  window.customElements.define('fx-action', FxAction);
+}

package/src/actions/fx-append.js

@@ -1,5 +1,6 @@
 import { AbstractAction } from './abstract-action.js';
 import { Fore } from '../fore.js';
+import { resolveId } from '../xpath-evaluation.js';
 
 /**
  * `fx-append` appends an entry to a repeat.
@@ -77,7 +78,7 @@ class FxAppend extends AbstractAction {
     super.actionPerformed();
     // const repeat = document.getElementById(this.repeat);
     // repeat.setIndex(repeat.nodeset.length);
-    this.dispatch();
+    this._dispatch();
   }
 
   /**
@@ -117,22 +118,10 @@ class FxAppend extends AbstractAction {
    *
    * The target repeat is a child of the same repeat-item as the append action.
    */
-  dispatch() {
-    let targetRepeat;
-    if (Fore.isRepeated(this)) {
-      console.log('append repeated ', this.repeatContext);
-      targetRepeat = Fore.getRepeatTarget(this, this.repeat);
-    } else {
-      targetRepeat = document.getElementById(this.repeat);
-    }
+  _dispatch() {
+    const targetRepeat = resolveId(this.repeat, this);
     console.log('dispatching index change ', targetRepeat.nodeset.length);
-    targetRepeat.dispatchEvent(
-      new CustomEvent('index-changed', {
-        composed: true,
-        bubbles: true,
-        detail: { index: targetRepeat.nodeset.length },
-      }),
-    );
+    Fore.dispatch(targetRepeat, 'index-changed', { index: targetRepeat.nodeset.length });
   }
 
   /**
@@ -213,4 +202,6 @@ class FxAppend extends AbstractAction {
   */
 }
 
-window.customElements.define('fx-append', FxAppend);
+if (!customElements.get('fx-append')) {
+  window.customElements.define('fx-append', FxAppend);
+}

package/src/actions/fx-confirm.js

@@ -19,4 +19,6 @@ export class FxConfirm extends FxAction {
   }
 }
 
-window.customElements.define('fx-confirm', FxConfirm);
+if (!customElements.get('fx-confirm')) {
+  window.customElements.define('fx-confirm', FxConfirm);
+}

package/src/actions/fx-delete.js

@@ -1,4 +1,5 @@
 import { AbstractAction } from './abstract-action.js';
+import { Fore } from '../fore.js';
 
 /**
  * `fx-delete`
@@ -29,13 +30,13 @@ class FxDelete extends AbstractAction {
     // ### if there's no repeat the delete action is inside of a repeat template
     if (this.repeatId === '') {
       // find the index to delete
-      const rItem = this.parentNode.closest('fx-repeatitem');
+      const rItem = Fore.getClosest('fx-repeatitem', this.parentNode);
       const idx = Array.from(rItem.parentNode.children).indexOf(rItem) + 1;
       // console.log('>>> idx to delete ', idx);
 
       // ### get the model now as it'll be hard once we've deleted ourselves ;)
       this.model = this.getModel();
-      const repeat = this.parentNode.closest('fx-repeat');
+      const repeat = Fore.getClosest('fx-repeat', this.parentNode);
 
       // ### update the nodeset
       let nodeToDelete;
@@ -77,4 +78,6 @@ class FxDelete extends AbstractAction {
   }
 }
 
-window.customElements.define('fx-delete', FxDelete);
+if (!customElements.get('fx-delete')) {
+  window.customElements.define('fx-delete', FxDelete);
+}

package/src/actions/fx-dispatch.js

@@ -1,6 +1,5 @@
 import { AbstractAction } from './abstract-action.js';
 import { evaluateXPath, resolveId } from '../xpath-evaluation.js';
-import { XPathUtil } from '../xpath-util.js';
 
 /**
  * `fx-dispatch`
@@ -68,7 +67,8 @@ export class FxDispatch extends AbstractAction {
         if (value) {
           throw new Error('if "expr" is given there must not be a "value" attribute');
         }
-        const result = evaluateXPath(expr, this.getInScopeContext(), this.getOwnerForm());
+        const [result] = evaluateXPath(expr, this.getInScopeContext(), this.getOwnerForm());
+
         let serialized = null;
         if (result.nodeName) {
           const serializer = new XMLSerializer();
@@ -90,11 +90,10 @@ export class FxDispatch extends AbstractAction {
 
     // ### when targetid is given dispatch to that if present (throw an error if not) - otherwise dispatch to document
     if (this.targetid) {
-      // const target = document.getElementById(this.targetid);
-      let target;
-      if (XPathUtil.isRepeated(this)) {
-        target = resolveId(this.targetid, this.parentNode, null);
-      } else {
+      let target = resolveId(this.targetid, this.parentNode, null);
+      if (!target) {
+        // TODO: essentially, we want to highly prefer the closest target. in the same subcontrol.
+        // However, it may be that our target is elsewhere. Do a global search for that case
         target = document.getElementById(this.targetid);
       }
       console.log('target', target);
@@ -120,4 +119,6 @@ export class FxDispatch extends AbstractAction {
   }
 }
 
-window.customElements.define('fx-dispatch', FxDispatch);
+if (!customElements.get('fx-dispatch')) {
+  window.customElements.define('fx-dispatch', FxDispatch);
+}

package/src/actions/fx-hide.js

@@ -1,4 +1,6 @@
-import { FxAction } from './fx-action.js';
+import { Fore } from '../fore.js';
+import { AbstractAction } from './abstract-action.js';
+import { resolveId } from '../xpath-evaluation.js';
 
 /**
  * `fx-hide`
@@ -7,17 +9,19 @@ import { FxAction } from './fx-action.js';
  * @customElement
  * @demo demo/project.html
  */
-export class FxHide extends FxAction {
+export class FxHide extends AbstractAction {
   connectedCallback() {
     this.dialog = this.getAttribute('dialog');
-    if(!this.dialog){
-      this.dispatch('error',{message:'dialog does not exist'})
+    if (!this.dialog) {
+      Fore.dispatch(this, 'error', { message: 'dialog does not exist' });
     }
   }
 
   perform() {
-    document.getElementById(this.dialog).hide();
+    resolveId(this.dialog, this).hide();
   }
 }
 
-window.customElements.define('fx-hide', FxHide);
+if (!customElements.get('fx-hide')) {
+  window.customElements.define('fx-hide', FxHide);
+}