@player-ui/computed-properties-plugin 0.0.1-next.1

package/dist/index.cjs.js

@@ -0,0 +1,54 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+class ComputedPropertiesPlugin {
+  constructor() {
+    this.name = "ComputedProperties";
+  }
+  apply(player) {
+    let schemaController;
+    let expressionEvaluator;
+    const getExpressionType = (binding) => {
+      const dataType = schemaController == null ? void 0 : schemaController.getType(binding);
+      if ((dataType == null ? void 0 : dataType.type) === "Expression") {
+        return dataType;
+      }
+    };
+    const computedPropertyMiddleware = {
+      name: this.name,
+      get(binding, options, next) {
+        const expType = getExpressionType(binding);
+        if (expType) {
+          const { exp } = expType;
+          const result = exp && (expressionEvaluator == null ? void 0 : expressionEvaluator.evaluate(exp, options == null ? void 0 : options.context));
+          return result != null ? result : expType.default;
+        }
+        return next == null ? void 0 : next.get(binding, options);
+      },
+      set(transaction, options, next) {
+        var _a;
+        for (const setOperation of transaction) {
+          if (getExpressionType(setOperation[0])) {
+            throw new Error(`Invalid 'set' operation on computed property: ${setOperation[0].asString()}`);
+          }
+        }
+        return (_a = next == null ? void 0 : next.set(transaction, options)) != null ? _a : [];
+      }
+    };
+    player.hooks.dataController.tap(this.name, (dataController) => {
+      dataController.hooks.resolveDataStages.tap(this.name, (dataPipeline) => {
+        return [...dataPipeline, computedPropertyMiddleware];
+      });
+    });
+    player.hooks.schema.tap(this.name, (schema) => {
+      schemaController = schema;
+    });
+    player.hooks.expressionEvaluator.tap(this.name, (evaluator) => {
+      expressionEvaluator = evaluator;
+    });
+  }
+}
+
+exports.ComputedPropertiesPlugin = ComputedPropertiesPlugin;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import { PlayerPlugin, Player } from '@player-ui/player';
+import { Schema, Expression } from '@player-ui/types';
+
+interface ExpressionDataType extends Schema.DataType<'Expression'> {
+    /** The expression to evaluate to compute the value of this node */
+    exp?: Expression;
+}
+/**
+ * A player plugin to manage beacon events.
+ * It automatically keeps track of the current user's view, and adds additional metaData to each beacon event.
+ */
+declare class ComputedPropertiesPlugin implements PlayerPlugin {
+    name: string;
+    apply(player: Player): void;
+}
+
+export { ComputedPropertiesPlugin, ExpressionDataType };

package/dist/index.esm.js

@@ -0,0 +1,50 @@
+class ComputedPropertiesPlugin {
+  constructor() {
+    this.name = "ComputedProperties";
+  }
+  apply(player) {
+    let schemaController;
+    let expressionEvaluator;
+    const getExpressionType = (binding) => {
+      const dataType = schemaController == null ? void 0 : schemaController.getType(binding);
+      if ((dataType == null ? void 0 : dataType.type) === "Expression") {
+        return dataType;
+      }
+    };
+    const computedPropertyMiddleware = {
+      name: this.name,
+      get(binding, options, next) {
+        const expType = getExpressionType(binding);
+        if (expType) {
+          const { exp } = expType;
+          const result = exp && (expressionEvaluator == null ? void 0 : expressionEvaluator.evaluate(exp, options == null ? void 0 : options.context));
+          return result != null ? result : expType.default;
+        }
+        return next == null ? void 0 : next.get(binding, options);
+      },
+      set(transaction, options, next) {
+        var _a;
+        for (const setOperation of transaction) {
+          if (getExpressionType(setOperation[0])) {
+            throw new Error(`Invalid 'set' operation on computed property: ${setOperation[0].asString()}`);
+          }
+        }
+        return (_a = next == null ? void 0 : next.set(transaction, options)) != null ? _a : [];
+      }
+    };
+    player.hooks.dataController.tap(this.name, (dataController) => {
+      dataController.hooks.resolveDataStages.tap(this.name, (dataPipeline) => {
+        return [...dataPipeline, computedPropertyMiddleware];
+      });
+    });
+    player.hooks.schema.tap(this.name, (schema) => {
+      schemaController = schema;
+    });
+    player.hooks.expressionEvaluator.tap(this.name, (evaluator) => {
+      expressionEvaluator = evaluator;
+    });
+  }
+}
+
+export { ComputedPropertiesPlugin };
+//# sourceMappingURL=index.esm.js.map

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@player-ui/computed-properties-plugin",
+  "version": "0.0.1-next.1",
+  "private": false,
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "peerDependencies": {
+    "@player-ui/binding-grammar": "0.0.1-next.1"
+  },
+  "dependencies": {
+    "tapable": "1.1.3",
+    "@types/tapable": "^1.0.5",
+    "@babel/runtime": "7.15.4"
+  },
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "typings": "dist/index.d.ts"
+}

package/src/index.ts

@@ -0,0 +1,81 @@
+import type { Player, PlayerPlugin } from '@player-ui/player';
+import type { ExpressionEvaluator } from '@player-ui/expressions';
+import type { Schema, Expression } from '@player-ui/types';
+import type { DataModelMiddleware, Updates } from '@player-ui/data';
+import type { SchemaController } from '@player-ui/schema';
+import type { BindingInstance } from '@player-ui/binding';
+
+export interface ExpressionDataType extends Schema.DataType<'Expression'> {
+  /** The expression to evaluate to compute the value of this node */
+  exp?: Expression;
+}
+
+/**
+ * A player plugin to manage beacon events.
+ * It automatically keeps track of the current user's view, and adds additional metaData to each beacon event.
+ */
+export class ComputedPropertiesPlugin implements PlayerPlugin {
+  name = 'ComputedProperties';
+
+  apply(player: Player) {
+    // Inject a middleware into the data-model to intercept any calls to an expression type in the schema
+    // Calls to `set` throw an error. Calls to `get` compute the value and return if or default
+
+    let schemaController: SchemaController | undefined;
+    let expressionEvaluator: ExpressionEvaluator | undefined;
+
+    /** Look up the data-type of the binding, and check for an Expression type */
+    const getExpressionType = (
+      binding: BindingInstance
+    ): ExpressionDataType | undefined => {
+      // Check to see if the data-type of the binding is an `Expression`
+      const dataType = schemaController?.getType(binding);
+
+      if (dataType?.type === 'Expression') {
+        return dataType as ExpressionDataType;
+      }
+    };
+
+    const computedPropertyMiddleware: DataModelMiddleware = {
+      name: this.name,
+      get(binding, options, next) {
+        const expType = getExpressionType(binding);
+
+        if (expType) {
+          const { exp } = expType;
+          const result =
+            exp && expressionEvaluator?.evaluate(exp, options?.context);
+
+          return result ?? expType.default;
+        }
+
+        return next?.get(binding, options);
+      },
+      set(transaction, options, next): Updates {
+        for (const setOperation of transaction) {
+          if (getExpressionType(setOperation[0])) {
+            throw new Error(
+              `Invalid 'set' operation on computed property: ${setOperation[0].asString()}`
+            );
+          }
+        }
+
+        return next?.set(transaction, options) ?? [];
+      },
+    };
+
+    player.hooks.dataController.tap(this.name, (dataController) => {
+      dataController.hooks.resolveDataStages.tap(this.name, (dataPipeline) => {
+        return [...dataPipeline, computedPropertyMiddleware];
+      });
+    });
+
+    player.hooks.schema.tap(this.name, (schema) => {
+      schemaController = schema;
+    });
+
+    player.hooks.expressionEvaluator.tap(this.name, (evaluator) => {
+      expressionEvaluator = evaluator;
+    });
+  }
+}