@player-ui/player 0.4.0-next.5 → 0.4.0-next.7

package/dist/index.cjs.js

@@ -1916,6 +1916,9 @@ function parse(schema) {
       if (type.isArray) {
         nestedPath.push("[]");
       }
+      if (type.isRecord) {
+        nestedPath.push("{}");
+      }
       if (type.type && schema[type.type]) {
         parseQueue.push({
           path: nestedPath,
@@ -1964,8 +1967,20 @@ class SchemaController {
     if (cached) {
       return cached;
     }
-    const normalized = binding.asArray().map((p) => typeof p === "number" ? "[]" : p).join(".");
-    this.bindingSchemaNormalizedCache.set(binding, normalized);
+    let bindingArray = binding.asArray();
+    let normalized = bindingArray.map((p) => typeof p === "number" ? "[]" : p).join(".");
+    if (normalized) {
+      this.bindingSchemaNormalizedCache.set(binding, normalized);
+      bindingArray = normalized.split(".");
+    }
+    bindingArray.forEach((item) => {
+      const recordBinding = bindingArray.map((p) => p === item ? "{}" : p).join(".");
+      if (this.schema.get(recordBinding)) {
+        this.bindingSchemaNormalizedCache.set(binding, recordBinding);
+        bindingArray = recordBinding.split(".");
+        normalized = recordBinding;
+      }
+    });
     return normalized;
   }
   getType(binding) {
@@ -2052,6 +2067,9 @@ function findNextExp(str) {
   };
 }
 function resolveExpressionsInString(val, { evaluate }) {
+  if (!evaluate) {
+    return val;
+  }
   const expMatch = /@\[.*?\]@/;
   let newVal = val;
   let match = newVal.match(expMatch);
@@ -2071,7 +2089,7 @@ function resolveExpressionsInString(val, { evaluate }) {
 function resolveDataRefsInString(val, options) {
   const { model } = options;
   let workingString = resolveExpressionsInString(val, options);
-  if (typeof workingString !== "string" || workingString.indexOf(DOUBLE_OPEN_CURLY) === -1) {
+  if (!model || typeof workingString !== "string" || workingString.indexOf(DOUBLE_OPEN_CURLY) === -1) {
     return workingString;
   }
   while (workingString.indexOf(DOUBLE_OPEN_CURLY) !== -1) {
@@ -2100,9 +2118,9 @@ function traverseObject(val, options) {
       const keys = Object.keys(val);
       let newVal = val;
       if (keys.length > 0) {
-        for (const key of keys) {
+        keys.forEach((key) => {
           newVal = timm.setIn(newVal, [key], traverseObject(val[key], options));
-        }
+        });
       }
       return newVal;
     }
@@ -2154,7 +2172,7 @@ class ValidationMiddleware {
       } else if (validations instanceof Set) {
         validations.forEach((validation) => {
           invalidBindings.push(validation.binding);
-          if (!validation.isStrong) {
+          if (!validation.isStrong && validation.binding.asString() === binding.asString()) {
             nextTransaction.push([validation.binding, value]);
           }
         });
@@ -4242,7 +4260,6 @@ class DataController {
       }
     });
     this.hooks.onSet.call(normalizedTransaction);
-    this.hooks.onSet.call(normalizedTransaction);
     if (setUpdates.length > 0) {
       this.hooks.onUpdate.call(setUpdates, options);
     }
@@ -4401,6 +4418,39 @@ class FlowExpPlugin {
   }
 }
 
+const createFormatFunction = (schema) => {
+  const handler = (ctx, value, formatName) => {
+    var _a, _b;
+    return (_b = (_a = schema.getFormatterForType({ type: formatName })) == null ? void 0 : _a.format(value)) != null ? _b : value;
+  };
+  return handler;
+};
+class DefaultExpPlugin {
+  constructor() {
+    this.name = "flow-exp-plugin";
+  }
+  apply(player) {
+    let formatFunction;
+    player.hooks.schema.tap(this.name, (schemaController) => {
+      formatFunction = createFormatFunction(schemaController);
+    });
+    player.hooks.expressionEvaluator.tap(this.name, (expEvaluator) => {
+      if (formatFunction) {
+        expEvaluator.addExpressionFunction("format", formatFunction);
+      }
+      expEvaluator.addExpressionFunction("log", (ctx, ...args) => {
+        player.logger.info(...args);
+      });
+      expEvaluator.addExpressionFunction("debug", (ctx, ...args) => {
+        player.logger.debug(...args);
+      });
+      expEvaluator.addExpressionFunction("eval", (ctx, ...args) => {
+        return ctx.evaluate(...args);
+      });
+    });
+  }
+}
+
 const NOT_STARTED_STATE = {
   ref: Symbol("not-started"),
   status: "not-started"
@@ -4445,8 +4495,8 @@ var __async = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const PLAYER_VERSION = "0.4.0-next.5";
-const COMMIT = "a7957331b94ce0a7d50709a0d636a406b033300f";
+const PLAYER_VERSION = "0.4.0-next.7";
+const COMMIT = "d187c654ea192038fcd5eb00f88d7244bb2cafff";
 const _Player = class {
   constructor(config) {
     this.logger = new TapableLogger();
@@ -4467,14 +4517,15 @@ const _Player = class {
       resolveFlowContent: new tapableTs.SyncWaterfallHook()
     };
     var _a;
-    const initialPlugins = [];
-    const flowExpPlugin = new FlowExpPlugin();
-    initialPlugins.push(flowExpPlugin);
     if (config == null ? void 0 : config.logger) {
       this.logger.addHandler(config.logger);
     }
     this.config = config || {};
-    this.config.plugins = [...this.config.plugins || [], ...initialPlugins];
+    this.config.plugins = [
+      new DefaultExpPlugin(),
+      ...this.config.plugins || [],
+      new FlowExpPlugin()
+    ];
     (_a = this.config.plugins) == null ? void 0 : _a.forEach((plugin) => {
       plugin.apply(this);
     });
@@ -4658,11 +4709,6 @@ const _Player = class {
       this.hooks.view.call(view);
     });
     this.hooks.viewController.call(viewController);
-    const formatFunction = (ctx, value, formatName) => {
-      var _a, _b;
-      return (_b = (_a = schema.getFormatterForType({ type: formatName })) == null ? void 0 : _a.format(value)) != null ? _b : value;
-    };
-    expressionEvaluator.addExpressionFunction("format", formatFunction);
     return {
       start: () => {
         flowController.start().then((endState) => {

package/dist/index.d.ts

@@ -1504,7 +1504,7 @@ declare class ValidatorRegistry {
 }
 
 /** Expand the authored schema into a set of paths -> DataTypes */
-declare function parse(schema: Schema.Schema): Map<string, Schema.DataType>;
+declare function parse(schema: Schema.Schema): Map<string, Schema.DataTypes>;
 /**
  * The Schema is the central hub for all data invariants, and metaData associated with the data-model itself
  * Outside of the types defined in the JSON payload, it doesn't manage or keep any state.
@@ -1513,18 +1513,18 @@ declare function parse(schema: Schema.Schema): Map<string, Schema.DataType>;
 declare class SchemaController implements ValidationProvider {
     private formatters;
     private types;
-    readonly schema: Map<string, Schema.DataType>;
+    readonly schema: Map<string, Schema.DataTypes>;
     private bindingSchemaNormalizedCache;
     readonly hooks: {
-        resolveTypeForBinding: SyncWaterfallHook<[Schema.DataType<unknown> | undefined, BindingInstance], Record<string, any>>;
+        resolveTypeForBinding: SyncWaterfallHook<[Schema.DataTypes | undefined, BindingInstance], Record<string, any>>;
     };
     constructor(schema?: Schema.Schema);
     addFormatters(fns: Array<FormatType<any, any, FormatOptions>>): void;
     addDataTypes(types: Array<Schema.DataType<any>>): void;
     getValidationsForBinding(binding: BindingInstance): Array<ValidationObject> | undefined;
     private normalizeBinding;
-    getType(binding: BindingInstance): Schema.DataType | undefined;
-    getApparentType(binding: BindingInstance): Schema.DataType | undefined;
+    getType(binding: BindingInstance): Schema.DataTypes | undefined;
+    getApparentType(binding: BindingInstance): Schema.DataTypes | undefined;
     getTypeDefinition(dataType: string): Schema.DataType<any> | undefined;
     getFormatterForType(formatReference: Formatting.Reference): FormatDefinition<unknown, unknown> | undefined;
     /**
@@ -1535,10 +1535,16 @@ declare class SchemaController implements ValidationProvider {
 }
 
 interface Options {
-    /** The model to use when resolving refs */
-    model: DataModelWithParser;
-    /** A function to evaluate an expression */
-    evaluate: (exp: Expression) => any;
+    /**
+     * The model to use when resolving refs
+     * Passing `false` will skip trying to resolve any direct model refs ({{foo}})
+     */
+    model: false | DataModelWithParser;
+    /**
+     * A function to evaluate an expression
+     * Passing `false` will skip trying to evaluate any expressions (@[ foo() ]@)
+     */
+    evaluate: false | ((exp: Expression) => any);
 }
 /** Search the given string for the coordinates of the next expression to resolve */
 declare function findNextExp(str: string): {
@@ -1565,6 +1571,8 @@ interface PlayerPlugin {
      */
     apply: (player: Player) => void;
 }
+interface ExtendedPlayerPlugin<Assets = void, Views = void, Expressions = void, DataTypes = void> {
+}
 interface PlayerConfigOptions {
     /** A set of plugins to load  */
     plugins?: PlayerPlugin[];
@@ -1651,4 +1659,4 @@ declare class FlowExpPlugin implements PlayerPlugin {
     apply(player: Player): void;
 }
 
-export { AnyAssetType, ApplicabilityPlugin, ArrayExpressionNode, AssetTransformCorePlugin, AssignmentNode, BaseFlowState, BaseNode, BatchSetTransaction, BeforeTransformFunction, BinaryNode, BinaryOperator, BinaryOperatorAdvanced, BinaryOperatorBasic, BindingFactory, BindingInstance, BindingLike, BindingParser, BindingParserOptions, BindingTracker, Builder, CallExpressionNode, CompletedState, CompoundNode, ConditionalExpressionNode, ConsoleLogger, ConstantsController, ConstantsProvider, ControllerState, DataController, DataModelImpl, DataModelMiddleware, DataModelOptions, DataModelWithParser, DataPipeline, DependencyMiddleware, DependencyModel, DependencySets, DependencyTracker, DirectionalNode, EMPTY_NODE, ErrorState, ErrorValidationResponse, ExpNodeOpaqueIdentifier, ExpressionContext, ExpressionEvaluator, ExpressionEvaluatorFunction, ExpressionEvaluatorOptions, ExpressionHandler, ExpressionLiteralType, ExpressionNode, ExpressionNodeType, ExpressionType, FlowController, FlowExpPlugin, FlowInstance, FormatDefinition, FormatFunction, FormatHandler, FormatOptions, FormatType, Getter, HookOptions, IdentifierNode, InProgressState, LiteralNode, LocalModel, LocalStateStore, LogFn, Logger, LoggerProvider, LogicalNode, MemberExpressionNode, MiddlewareChecker, ModelRefNode, ModificationNode, NOOPDataModel, NOOP_MODEL, NOT_STARTED_STATE, NamedState, Node, NodeLocation, NodePosition, NodeType, NoopLogger, NotStartedState, ObjectNode, OperatorProcessingOptions, Options, ParseObjectOptions, Parser, PipelinedDataModel, Player, PlayerConfigOptions, PlayerFlowExecutionData, PlayerFlowState, PlayerFlowStatus, PlayerInfo, PlayerPlugin, ProxyLogger, ROOT_BINDING, RawBinding, RawBindingSegment, RawSetTransaction, RawSetType, Resolve, Resolver, SIMPLE_BINDING_REGEX, SchemaController, Severity, StatefulValidationObject, Store, StringResolverPlugin, StrongOrWeakBinding, SwitchPlugin, TapableLogger, TemplatePlugin, ThisNode, TransformFunction, TransformFunctions, TransformRegistry, TransitionFunction, TransitionOptions, UnaryNode, UnaryOperator, Updates, ValidationBindingTrackerViewPlugin, ValidationController, ValidationMiddleware, ValidationObject, ValidationProvider, ValidationResponse, ValidatorContext, ValidatorFunction, ValidatorRegistry, ViewController, ViewControllerOptions, ViewInstance, ViewPlugin, WarningValidationResponse, caresAboutDataChanges, constructModelForPipeline, findClosestNodeAtPosition, findInArray, findNextExp, getBindingSegments, isBinding, isExpressionNode, maybeConvertToNum, parse, parseExpression, resolveDataRefs, resolveDataRefsInString, resolveExpressionsInString, severities, toModel, toNodeResolveOptions, withParser, withoutContext };
+export { AnyAssetType, ApplicabilityPlugin, ArrayExpressionNode, AssetTransformCorePlugin, AssignmentNode, BaseFlowState, BaseNode, BatchSetTransaction, BeforeTransformFunction, BinaryNode, BinaryOperator, BinaryOperatorAdvanced, BinaryOperatorBasic, BindingFactory, BindingInstance, BindingLike, BindingParser, BindingParserOptions, BindingTracker, Builder, CallExpressionNode, CompletedState, CompoundNode, ConditionalExpressionNode, ConsoleLogger, ConstantsController, ConstantsProvider, ControllerState, DataController, DataModelImpl, DataModelMiddleware, DataModelOptions, DataModelWithParser, DataPipeline, DependencyMiddleware, DependencyModel, DependencySets, DependencyTracker, DirectionalNode, EMPTY_NODE, ErrorState, ErrorValidationResponse, ExpNodeOpaqueIdentifier, ExpressionContext, ExpressionEvaluator, ExpressionEvaluatorFunction, ExpressionEvaluatorOptions, ExpressionHandler, ExpressionLiteralType, ExpressionNode, ExpressionNodeType, ExpressionType, ExtendedPlayerPlugin, FlowController, FlowExpPlugin, FlowInstance, FormatDefinition, FormatFunction, FormatHandler, FormatOptions, FormatType, Getter, HookOptions, IdentifierNode, InProgressState, LiteralNode, LocalModel, LocalStateStore, LogFn, Logger, LoggerProvider, LogicalNode, MemberExpressionNode, MiddlewareChecker, ModelRefNode, ModificationNode, NOOPDataModel, NOOP_MODEL, NOT_STARTED_STATE, NamedState, Node, NodeLocation, NodePosition, NodeType, NoopLogger, NotStartedState, ObjectNode, OperatorProcessingOptions, Options, ParseObjectOptions, Parser, PipelinedDataModel, Player, PlayerConfigOptions, PlayerFlowExecutionData, PlayerFlowState, PlayerFlowStatus, PlayerInfo, PlayerPlugin, ProxyLogger, ROOT_BINDING, RawBinding, RawBindingSegment, RawSetTransaction, RawSetType, Resolve, Resolver, SIMPLE_BINDING_REGEX, SchemaController, Severity, StatefulValidationObject, Store, StringResolverPlugin, StrongOrWeakBinding, SwitchPlugin, TapableLogger, TemplatePlugin, ThisNode, TransformFunction, TransformFunctions, TransformRegistry, TransitionFunction, TransitionOptions, UnaryNode, UnaryOperator, Updates, ValidationBindingTrackerViewPlugin, ValidationController, ValidationMiddleware, ValidationObject, ValidationProvider, ValidationResponse, ValidatorContext, ValidatorFunction, ValidatorRegistry, ViewController, ViewControllerOptions, ViewInstance, ViewPlugin, WarningValidationResponse, caresAboutDataChanges, constructModelForPipeline, findClosestNodeAtPosition, findInArray, findNextExp, getBindingSegments, isBinding, isExpressionNode, maybeConvertToNum, parse, parseExpression, resolveDataRefs, resolveDataRefsInString, resolveExpressionsInString, severities, toModel, toNodeResolveOptions, withParser, withoutContext };

package/dist/index.esm.js

@@ -1903,6 +1903,9 @@ function parse(schema) {
       if (type.isArray) {
         nestedPath.push("[]");
       }
+      if (type.isRecord) {
+        nestedPath.push("{}");
+      }
       if (type.type && schema[type.type]) {
         parseQueue.push({
           path: nestedPath,
@@ -1951,8 +1954,20 @@ class SchemaController {
     if (cached) {
       return cached;
     }
-    const normalized = binding.asArray().map((p) => typeof p === "number" ? "[]" : p).join(".");
-    this.bindingSchemaNormalizedCache.set(binding, normalized);
+    let bindingArray = binding.asArray();
+    let normalized = bindingArray.map((p) => typeof p === "number" ? "[]" : p).join(".");
+    if (normalized) {
+      this.bindingSchemaNormalizedCache.set(binding, normalized);
+      bindingArray = normalized.split(".");
+    }
+    bindingArray.forEach((item) => {
+      const recordBinding = bindingArray.map((p) => p === item ? "{}" : p).join(".");
+      if (this.schema.get(recordBinding)) {
+        this.bindingSchemaNormalizedCache.set(binding, recordBinding);
+        bindingArray = recordBinding.split(".");
+        normalized = recordBinding;
+      }
+    });
     return normalized;
   }
   getType(binding) {
@@ -2039,6 +2054,9 @@ function findNextExp(str) {
   };
 }
 function resolveExpressionsInString(val, { evaluate }) {
+  if (!evaluate) {
+    return val;
+  }
   const expMatch = /@\[.*?\]@/;
   let newVal = val;
   let match = newVal.match(expMatch);
@@ -2058,7 +2076,7 @@ function resolveExpressionsInString(val, { evaluate }) {
 function resolveDataRefsInString(val, options) {
   const { model } = options;
   let workingString = resolveExpressionsInString(val, options);
-  if (typeof workingString !== "string" || workingString.indexOf(DOUBLE_OPEN_CURLY) === -1) {
+  if (!model || typeof workingString !== "string" || workingString.indexOf(DOUBLE_OPEN_CURLY) === -1) {
     return workingString;
   }
   while (workingString.indexOf(DOUBLE_OPEN_CURLY) !== -1) {
@@ -2087,9 +2105,9 @@ function traverseObject(val, options) {
       const keys = Object.keys(val);
       let newVal = val;
       if (keys.length > 0) {
-        for (const key of keys) {
+        keys.forEach((key) => {
           newVal = setIn(newVal, [key], traverseObject(val[key], options));
-        }
+        });
       }
       return newVal;
     }
@@ -2141,7 +2159,7 @@ class ValidationMiddleware {
       } else if (validations instanceof Set) {
         validations.forEach((validation) => {
           invalidBindings.push(validation.binding);
-          if (!validation.isStrong) {
+          if (!validation.isStrong && validation.binding.asString() === binding.asString()) {
             nextTransaction.push([validation.binding, value]);
           }
         });
@@ -4229,7 +4247,6 @@ class DataController {
       }
     });
     this.hooks.onSet.call(normalizedTransaction);
-    this.hooks.onSet.call(normalizedTransaction);
     if (setUpdates.length > 0) {
       this.hooks.onUpdate.call(setUpdates, options);
     }
@@ -4388,6 +4405,39 @@ class FlowExpPlugin {
   }
 }
 
+const createFormatFunction = (schema) => {
+  const handler = (ctx, value, formatName) => {
+    var _a, _b;
+    return (_b = (_a = schema.getFormatterForType({ type: formatName })) == null ? void 0 : _a.format(value)) != null ? _b : value;
+  };
+  return handler;
+};
+class DefaultExpPlugin {
+  constructor() {
+    this.name = "flow-exp-plugin";
+  }
+  apply(player) {
+    let formatFunction;
+    player.hooks.schema.tap(this.name, (schemaController) => {
+      formatFunction = createFormatFunction(schemaController);
+    });
+    player.hooks.expressionEvaluator.tap(this.name, (expEvaluator) => {
+      if (formatFunction) {
+        expEvaluator.addExpressionFunction("format", formatFunction);
+      }
+      expEvaluator.addExpressionFunction("log", (ctx, ...args) => {
+        player.logger.info(...args);
+      });
+      expEvaluator.addExpressionFunction("debug", (ctx, ...args) => {
+        player.logger.debug(...args);
+      });
+      expEvaluator.addExpressionFunction("eval", (ctx, ...args) => {
+        return ctx.evaluate(...args);
+      });
+    });
+  }
+}
+
 const NOT_STARTED_STATE = {
   ref: Symbol("not-started"),
   status: "not-started"
@@ -4432,8 +4482,8 @@ var __async = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const PLAYER_VERSION = "0.4.0-next.5";
-const COMMIT = "a7957331b94ce0a7d50709a0d636a406b033300f";
+const PLAYER_VERSION = "0.4.0-next.7";
+const COMMIT = "d187c654ea192038fcd5eb00f88d7244bb2cafff";
 const _Player = class {
   constructor(config) {
     this.logger = new TapableLogger();
@@ -4454,14 +4504,15 @@ const _Player = class {
       resolveFlowContent: new SyncWaterfallHook()
     };
     var _a;
-    const initialPlugins = [];
-    const flowExpPlugin = new FlowExpPlugin();
-    initialPlugins.push(flowExpPlugin);
     if (config == null ? void 0 : config.logger) {
       this.logger.addHandler(config.logger);
     }
     this.config = config || {};
-    this.config.plugins = [...this.config.plugins || [], ...initialPlugins];
+    this.config.plugins = [
+      new DefaultExpPlugin(),
+      ...this.config.plugins || [],
+      new FlowExpPlugin()
+    ];
     (_a = this.config.plugins) == null ? void 0 : _a.forEach((plugin) => {
       plugin.apply(this);
     });
@@ -4645,11 +4696,6 @@ const _Player = class {
       this.hooks.view.call(view);
     });
     this.hooks.viewController.call(viewController);
-    const formatFunction = (ctx, value, formatName) => {
-      var _a, _b;
-      return (_b = (_a = schema.getFormatterForType({ type: formatName })) == null ? void 0 : _a.format(value)) != null ? _b : value;
-    };
-    expressionEvaluator.addExpressionFunction("format", formatFunction);
     return {
       start: () => {
         flowController.start().then((endState) => {