@player-ui/check-path-plugin 0.3.1-next.0 → 0.3.1

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { PlayerPlugin, Player } from '@player-ui/player';
+import { PlayerPlugin, Player, Node } from '@player-ui/player';
 import { Asset } from '@player-ui/types';
 
 declare type QueryFunction = (asset: Asset) => boolean;
@@ -10,6 +10,7 @@ declare type Query = QueryFunction | string | object;
 declare class CheckPathPlugin implements PlayerPlugin {
     name: string;
     private viewInfo?;
+    readonly symbol: symbol;
     apply(player: Player): void;
     /**
      * Starts at the asset with the given id, and walks backwards _up_ the tree until it finds a match for the parent
@@ -46,11 +47,16 @@ declare class CheckPathPlugin implements PlayerPlugin {
     hasChildContext(id: string, query: Query | Array<Query>): boolean;
     /** Get the asset represented by id */
     getAsset(id: string): Asset | undefined;
+    /**
+     * Gets the value for an asset from an asset node
+     */
+    getAssetFromAssetNode(assetNode: Node.Asset | Node.View): Asset | undefined;
     /**
      * Get the path of the asset in the view upto
      * the asset that matches the query or to the view if no query is provided
      */
     getPath(id: string, query?: Query | Array<Query>): Array<string | number> | undefined;
+    private getResolvedValue;
 }
 
 export { CheckPathPlugin, Query, QueryFunction };

package/dist/index.esm.js

@@ -2,6 +2,8 @@ import { NodeType } from '@player-ui/player';
 import { createObjectMatcher } from '@player-ui/partial-match-registry';
 import dlv from 'dlv';
 
+const CheckPathPluginSymbol = Symbol.for("CheckPathPlugin");
+
 function createMatcher(match) {
   if (typeof match === "string" || typeof match === "number") {
     return createObjectMatcher({ type: match });
@@ -12,19 +14,19 @@ function createMatcher(match) {
   return createObjectMatcher(match);
 }
 function getParent(node, viewInfo) {
-  var _a;
   let working = node;
   while (working.parent && working.parent.type !== NodeType.Asset && working.parent.type !== NodeType.View) {
     working = working.parent;
   }
   const { parent } = working;
   if (parent && (parent.type === NodeType.Asset || parent.type === NodeType.View)) {
-    return (_a = viewInfo.resolver.getSourceNode(parent)) != null ? _a : parent;
+    return parent;
   }
 }
 class CheckPathPlugin {
   constructor() {
     this.name = "check-path";
+    this.symbol = CheckPathPluginSymbol;
   }
   apply(player) {
     player.hooks.viewController.tap(this.name, (viewController) => {
@@ -62,11 +64,10 @@ class CheckPathPlugin {
     if (!assetNode || !this.viewInfo) {
       return void 0;
     }
-    let potentialMatch = getParent(assetNode, this.viewInfo);
+    let potentialMatch = getParent(assetNode);
     if (query === void 0) {
       if (potentialMatch) {
-        const resolved = this.viewInfo.resolvedMap.get(potentialMatch);
-        return resolved == null ? void 0 : resolved.value;
+        return this.getAssetFromAssetNode(potentialMatch);
       }
       return;
     }
@@ -78,19 +79,19 @@ class CheckPathPlugin {
         throw new Error("Recursion depth exceeded. Check for cycles in the AST graph");
       }
       const matcher = createMatcher(parentQuery);
-      const resolved = this.viewInfo.resolvedMap.get(potentialMatch);
-      if (resolved && matcher(resolved.value)) {
+      const resolved = this.getAssetFromAssetNode(potentialMatch);
+      if (resolved && matcher(resolved)) {
         if (queryArray.length === 0) {
-          return resolved.value;
+          return resolved;
         }
         parentQuery = queryArray.shift();
       }
-      potentialMatch = getParent(potentialMatch, this.viewInfo);
+      potentialMatch = getParent(potentialMatch);
     }
     return void 0;
   }
   getParentProp(id) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c;
     const assetNode = (_a = this.viewInfo) == null ? void 0 : _a.assetIdMap.get(id);
     if (!assetNode || !this.viewInfo) {
       return;
@@ -98,15 +99,15 @@ class CheckPathPlugin {
     let working = assetNode;
     let parent;
     while (working) {
-      parent = (working == null ? void 0 : working.parent) && ((_b = this.viewInfo.resolvedMap.get(working.parent)) == null ? void 0 : _b.resolved);
+      parent = working == null ? void 0 : working.parent;
       if (parent && (parent.type === NodeType.Asset || parent.type === NodeType.View)) {
         break;
       }
       working = working == null ? void 0 : working.parent;
     }
     if (parent && "children" in parent) {
-      const childProp = (_c = parent.children) == null ? void 0 : _c.find((child) => child.value === working);
-      return (_d = childProp == null ? void 0 : childProp.path) == null ? void 0 : _d[0];
+      const childProp = (_b = parent.children) == null ? void 0 : _b.find((child) => child.value === working);
+      return (_c = childProp == null ? void 0 : childProp.path) == null ? void 0 : _c[0];
     }
     return void 0;
   }
@@ -122,28 +123,29 @@ class CheckPathPlugin {
     return Boolean(this.getParent(id, query));
   }
   findChildPath(node, query, includeSelfMatch = true) {
-    var _a, _b, _c, _d;
+    var _a, _b;
     if (query.length === 0) {
       return true;
     }
     const [first, ...rest] = query;
     const matcher = createMatcher(first);
-    if (node.type === NodeType.Asset || node.type === NodeType.View) {
-      const resolved = (_a = this.viewInfo) == null ? void 0 : _a.resolvedMap.get(node);
-      const includesSelf = (_b = includeSelfMatch && resolved && matcher(resolved.value)) != null ? _b : false;
+    if (node.type === NodeType.Asset || node.type === NodeType.View || node.type === NodeType.Applicability) {
+      const resolvedValue = this.getResolvedValue(node);
+      const includesSelf = (_a = includeSelfMatch && matcher(resolvedValue)) != null ? _a : false;
       const childQuery = includesSelf ? rest : query;
       if (childQuery.length === 0 && includesSelf) {
         return true;
       }
-      if (childQuery.length && (!node.children || node.children.length === 0)) {
+      const children = node.type === NodeType.Applicability ? node.value.children : node.children;
+      if (childQuery.length && (!children || children.length === 0)) {
         return false;
       }
-      if ((_c = node.children) == null ? void 0 : _c.some((childNode) => this.findChildPath(childNode.value, childQuery))) {
+      if (children == null ? void 0 : children.some((childNode) => this.findChildPath(childNode.value, childQuery))) {
         return true;
       }
     } else if (node.type === NodeType.MultiNode && node.values.some((childNode) => this.findChildPath(childNode, query))) {
       return true;
-    } else if ("children" in node && ((_d = node.children) == null ? void 0 : _d.some((childNode) => this.findChildPath(childNode.value, query)))) {
+    } else if ("children" in node && ((_b = node.children) == null ? void 0 : _b.some((childNode) => this.findChildPath(childNode.value, query)))) {
       return true;
     }
     return false;
@@ -158,14 +160,18 @@ class CheckPathPlugin {
     return this.findChildPath(assetNode, queryArray, false);
   }
   getAsset(id) {
-    var _a, _b, _c;
+    var _a;
     const assetNode = (_a = this.viewInfo) == null ? void 0 : _a.assetIdMap.get(id);
     if (!assetNode)
       return;
+    return this.getAssetFromAssetNode(assetNode);
+  }
+  getAssetFromAssetNode(assetNode) {
+    var _a, _b;
     const sourceNode = this.getSourceAssetNode(assetNode);
     if (!sourceNode)
       return;
-    return (_c = (_b = this.viewInfo) == null ? void 0 : _b.resolvedMap.get(sourceNode)) == null ? void 0 : _c.value;
+    return (_b = (_a = this.viewInfo) == null ? void 0 : _a.resolvedMap.get(sourceNode)) == null ? void 0 : _b.value;
   }
   getPath(id, query) {
     var _a, _b;
@@ -185,34 +191,35 @@ class CheckPathPlugin {
       return (_a2 = parent.children) == null ? void 0 : _a2.find((n) => n.value === working);
     };
     while (working !== void 0) {
-      const parent = (working == null ? void 0 : working.parent) && this.viewInfo.resolvedMap.get(working.parent);
-      const parentNode = parent == null ? void 0 : parent.resolved;
-      if (parentNode) {
-        if (parentNode.type === NodeType.MultiNode) {
-          const index = parentNode.values.indexOf(working);
+      const { parent } = working;
+      if (parent) {
+        if (parent.type === NodeType.MultiNode) {
+          const index = parent.values.indexOf(working);
           if (index !== -1) {
-            const actualIndex = index - parentNode.values.slice(0, index).reduce((undefCount, next) => {
-              var _a2, _b2;
-              return ((_b2 = (_a2 = this.viewInfo) == null ? void 0 : _a2.resolvedMap.get(next)) == null ? void 0 : _b2.value) === void 0 ? undefCount + 1 : undefCount;
-            }, 0);
+            const actualIndex = index - parent.values.slice(0, index).reduce((undefCount, next) => this.getResolvedValue(next) === void 0 ? undefCount + 1 : undefCount, 0);
             path = [actualIndex, ...path];
           }
-        } else if ("children" in parentNode) {
-          const childProp = findWorkingChild(parentNode);
+        } else if ("children" in parent) {
+          const childProp = findWorkingChild(parent);
           path = [...(_b = childProp == null ? void 0 : childProp.path) != null ? _b : [], ...path];
         }
-      }
-      if (parentQuery) {
-        const matcher = createMatcher(parentQuery);
-        if (matcher(parent == null ? void 0 : parent.value)) {
-          parentQuery = queryArray.shift();
-          if (!parentQuery)
-            return path;
+        if (parentQuery) {
+          const matcher = createMatcher(parentQuery);
+          if (matcher(this.getResolvedValue(parent))) {
+            parentQuery = queryArray.shift();
+            if (!parentQuery)
+              return path;
+          }
         }
       }
       working = working.parent;
     }
-    return queryArray.length === 0 ? path : void 0;
+    return parentQuery ? void 0 : path;
+  }
+  getResolvedValue(node) {
+    var _a, _b;
+    const sourceNode = this.getSourceAssetNode(node);
+    return (_b = (_a = this.viewInfo) == null ? void 0 : _a.resolvedMap.get(sourceNode != null ? sourceNode : node)) == null ? void 0 : _b.value;
   }
 }
 

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@player-ui/check-path-plugin",
-  "version": "0.3.1-next.0",
+  "version": "0.3.1",
   "private": false,
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },
   "peerDependencies": {
-    "@player-ui/player": "0.3.1-next.0"
+    "@player-ui/player": "0.3.1"
   },
   "dependencies": {
-    "@player-ui/partial-match-registry": "0.3.1-next.0",
+    "@player-ui/partial-match-registry": "0.3.1",
     "dlv": "^1.1.3",
-    "tapable-ts": "^0.1.0",
+    "tapable-ts": "^0.2.3",
     "@babel/runtime": "7.15.4"
   },
   "main": "dist/index.cjs.js",
@@ -55,6 +55,15 @@
     {
       "name": "Kelly Harrop",
       "url": "https://github.com/kharrop"
+    },
+    {
+      "name": "Alejandro Fimbres",
+      "url": "https://github.com/lexfm"
+    },
+    {
+      "name": "Rafael Campos",
+      "url": "https://github.com/rafbcampos"
     }
-  ]
+  ],
+  "bundle": "./dist/check-path-plugin.prod.js"
 }

package/src/index.ts

@@ -3,6 +3,7 @@ import type { Player, PlayerPlugin, Node, Resolver } from '@player-ui/player';
 import type { Asset } from '@player-ui/types';
 import { createObjectMatcher } from '@player-ui/partial-match-registry';
 import dlv from 'dlv';
+import { CheckPathPluginSymbol } from './symbols';
 
 export type QueryFunction = (asset: Asset) => boolean;
 export type Query = QueryFunction | string | object;
@@ -51,7 +52,7 @@ interface ViewInfo {
  */
 function getParent(
   node: Node.Node,
-  viewInfo: ViewInfo
+  viewInfo?: ViewInfo
 ): Node.ViewOrAsset | undefined {
   let working = node;
 
@@ -69,8 +70,7 @@ function getParent(
     parent &&
     (parent.type === NodeType.Asset || parent.type === NodeType.View)
   ) {
-    return (viewInfo.resolver.getSourceNode(parent) ??
-      parent) as Node.ViewOrAsset;
+    return parent;
   }
 }
 
@@ -81,6 +81,7 @@ function getParent(
 export class CheckPathPlugin implements PlayerPlugin {
   name = 'check-path';
   private viewInfo?: ViewInfo;
+  public readonly symbol = CheckPathPluginSymbol;
 
   apply(player: Player) {
     player.hooks.viewController.tap(this.name, (viewController) => {
@@ -135,14 +136,12 @@ export class CheckPathPlugin implements PlayerPlugin {
       return undefined;
     }
 
-    let potentialMatch = getParent(assetNode, this.viewInfo);
+    let potentialMatch = getParent(assetNode);
 
     // Handle the case of an empty query (just get the immediate parent)
     if (query === undefined) {
       if (potentialMatch) {
-        const resolved = this.viewInfo.resolvedMap.get(potentialMatch);
-
-        return resolved?.value;
+        return this.getAssetFromAssetNode(potentialMatch);
       }
 
       return;
@@ -162,18 +161,18 @@ export class CheckPathPlugin implements PlayerPlugin {
       }
 
       const matcher = createMatcher(parentQuery);
-      const resolved = this.viewInfo.resolvedMap.get(potentialMatch);
+      const resolved = this.getAssetFromAssetNode(potentialMatch);
 
-      if (resolved && matcher(resolved.value)) {
+      if (resolved && matcher(resolved)) {
         // This is the last match.
         if (queryArray.length === 0) {
-          return resolved.value;
+          return resolved;
         }
 
         parentQuery = queryArray.shift();
       }
 
-      potentialMatch = getParent(potentialMatch, this.viewInfo);
+      potentialMatch = getParent(potentialMatch);
     }
 
     return undefined;
@@ -196,9 +195,7 @@ export class CheckPathPlugin implements PlayerPlugin {
     let parent;
 
     while (working) {
-      parent =
-        working?.parent &&
-        this.viewInfo.resolvedMap.get(working.parent)?.resolved;
+      parent = working?.parent;
 
       if (
         parent &&
@@ -254,22 +251,30 @@ export class CheckPathPlugin implements PlayerPlugin {
     const [first, ...rest] = query;
     const matcher = createMatcher(first);
 
-    if (node.type === NodeType.Asset || node.type === NodeType.View) {
-      const resolved = this.viewInfo?.resolvedMap.get(node);
+    if (
+      node.type === NodeType.Asset ||
+      node.type === NodeType.View ||
+      node.type === NodeType.Applicability
+    ) {
+      const resolvedValue = this.getResolvedValue(node);
       const includesSelf =
-        (includeSelfMatch && resolved && matcher(resolved.value)) ?? false;
+        (includeSelfMatch && matcher(resolvedValue)) ?? false;
       const childQuery = includesSelf ? rest : query;
 
       if (childQuery.length === 0 && includesSelf) {
         return true;
       }
 
-      if (childQuery.length && (!node.children || node.children.length === 0)) {
+      const children =
+        node.type === NodeType.Applicability
+          ? (node.value as Node.ViewOrAsset).children
+          : node.children;
+      if (childQuery.length && (!children || children.length === 0)) {
         return false;
       }
 
       if (
-        node.children?.some((childNode) =>
+        children?.some((childNode) =>
           this.findChildPath(childNode.value, childQuery)
         )
       ) {
@@ -314,6 +319,15 @@ export class CheckPathPlugin implements PlayerPlugin {
     const assetNode = this.viewInfo?.assetIdMap.get(id);
     if (!assetNode) return;
 
+    return this.getAssetFromAssetNode(assetNode);
+  }
+
+  /**
+   * Gets the value for an asset from an asset node
+   */
+  public getAssetFromAssetNode(
+    assetNode: Node.Asset | Node.View
+  ): Asset | undefined {
     const sourceNode = this.getSourceAssetNode(assetNode);
     if (!sourceNode) return;
 
@@ -352,23 +366,20 @@ export class CheckPathPlugin implements PlayerPlugin {
     };
 
     while (working !== undefined) {
-      const parent =
-        working?.parent && this.viewInfo.resolvedMap.get(working.parent);
+      const { parent } = working;
 
-      const parentNode = parent?.resolved;
-
-      if (parentNode) {
-        if (parentNode.type === NodeType.MultiNode) {
-          const index = parentNode.values.indexOf(working);
+      if (parent) {
+        if (parent.type === NodeType.MultiNode) {
+          const index = parent.values.indexOf(working);
 
           if (index !== -1) {
             const actualIndex =
               index -
-              parentNode.values
+              parent.values
                 .slice(0, index)
                 .reduce(
                   (undefCount, next) =>
-                    this.viewInfo?.resolvedMap.get(next)?.value === undefined
+                    this.getResolvedValue(next) === undefined
                       ? undefCount + 1
                       : undefCount,
                   0
@@ -376,18 +387,17 @@ export class CheckPathPlugin implements PlayerPlugin {
 
             path = [actualIndex, ...path];
           }
-        } else if ('children' in parentNode) {
-          const childProp = findWorkingChild(parentNode);
+        } else if ('children' in parent) {
+          const childProp = findWorkingChild(parent);
           path = [...(childProp?.path ?? []), ...path];
         }
-      }
-
-      if (parentQuery) {
-        const matcher = createMatcher(parentQuery);
 
-        if (matcher(parent?.value)) {
-          parentQuery = queryArray.shift();
-          if (!parentQuery) return path;
+        if (parentQuery) {
+          const matcher = createMatcher(parentQuery);
+          if (matcher(this.getResolvedValue(parent))) {
+            parentQuery = queryArray.shift();
+            if (!parentQuery) return path;
+          }
         }
       }
 
@@ -396,6 +406,11 @@ export class CheckPathPlugin implements PlayerPlugin {
 
     /* if at the end all queries haven't been consumed, 
        it means we couldn't find a path till the matching query */
-    return queryArray.length === 0 ? path : undefined;
+    return parentQuery ? undefined : path;
+  }
+
+  private getResolvedValue(node: Node.Node) {
+    const sourceNode = this.getSourceAssetNode(node);
+    return this.viewInfo?.resolvedMap.get(sourceNode ?? node)?.value;
   }
 }

package/src/symbols.ts

@@ -0,0 +1 @@
+export const CheckPathPluginSymbol = Symbol.for('CheckPathPlugin');