@flowerforce/flower-core 3.0.1-beta.7 → 3.1.0

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 3.1.0 (2024-06-06)
+
+
+### 🚀 Features
+
+- add restart action in core ([800da33](https://github.com/flowerforce/flower/commit/800da33))
+
+- add devtool to demo - remove duplicated export type ([88117d6](https://github.com/flowerforce/flower/commit/88117d6))
+
+- allow custom functions when defining rules and navigation between nodes ([b35f5da](https://github.com/flowerforce/flower/commit/b35f5da))
+
+
+### 🩹 Fixes
+
+- fix circular dependency on rules matchers ([0bcb02f](https://github.com/flowerforce/flower/commit/0bcb02f))
+
+- align packages ([210a284](https://github.com/flowerforce/flower/commit/210a284))
+
 ## 3.0.0 (2024-05-20)
 
 This was a version bump only for flower-core to align it with other projects, there were no code changes.

package/dist/index.cjs.js

@@ -18,6 +18,7 @@ var mapKeys = require('lodash/mapKeys');
 var mapValues = require('lodash/mapValues');
 var _trimStart = require('lodash/trimStart');
 var _intersection = require('lodash/intersection');
+var flat = require('flat');
 
 const Emitter = new tinyEmitter.TinyEmitter();
 
@@ -190,6 +191,7 @@ const rulesMatcherUtils = {
   },
   getKeys: (rules, options) => {
     if (!rules) return null;
+    if (typeof rules == 'function') return [];
     if (!rulesMatcherUtils.forceArray(rules).every(r => rulesMatcherUtils.isObject(r))) return null;
     const keys = {};
     const conditions = Array.isArray(rules) ? {
@@ -219,6 +221,9 @@ const operators = {
 
 const rulesMatcher = (rules, formValue = {}, apply = true, options) => {
   if (!rules) return [apply];
+  if (typeof rules === 'function') {
+    return [rules(formValue) === apply];
+  }
   const conditions = Array.isArray(rules) ? {
     $and: rules
   } : rules;
@@ -347,6 +352,9 @@ const CoreUtils = {
     if (typeof rule.rules === 'string') {
       return false;
     }
+    if (typeof rule.rules === 'function') {
+      return rule.rules(value);
+    }
     if (rule.rules === null) {
       return true;
     }
@@ -750,164 +758,6 @@ const FlowerCoreReducers = {
   }
 };
 
-function isBuffer (obj) {
-  return obj &&
-    obj.constructor &&
-    (typeof obj.constructor.isBuffer === 'function') &&
-    obj.constructor.isBuffer(obj)
-}
-
-function keyIdentity (key) {
-  return key
-}
-
-function flatten (target, opts) {
-  opts = opts || {};
-
-  const delimiter = opts.delimiter || '.';
-  const maxDepth = opts.maxDepth;
-  const transformKey = opts.transformKey || keyIdentity;
-  const output = {};
-
-  function step (object, prev, currentDepth) {
-    currentDepth = currentDepth || 1;
-    Object.keys(object).forEach(function (key) {
-      const value = object[key];
-      const isarray = opts.safe && Array.isArray(value);
-      const type = Object.prototype.toString.call(value);
-      const isbuffer = isBuffer(value);
-      const isobject = (
-        type === '[object Object]' ||
-        type === '[object Array]'
-      );
-
-      const newKey = prev
-        ? prev + delimiter + transformKey(key)
-        : transformKey(key);
-
-      if (!isarray && !isbuffer && isobject && Object.keys(value).length &&
-        (!opts.maxDepth || currentDepth < maxDepth)) {
-        return step(value, newKey, currentDepth + 1)
-      }
-
-      output[newKey] = value;
-    });
-  }
-
-  step(target);
-
-  return output
-}
-
-function unflatten (target, opts) {
-  opts = opts || {};
-
-  const delimiter = opts.delimiter || '.';
-  const overwrite = opts.overwrite || false;
-  const transformKey = opts.transformKey || keyIdentity;
-  const result = {};
-
-  const isbuffer = isBuffer(target);
-  if (isbuffer || Object.prototype.toString.call(target) !== '[object Object]') {
-    return target
-  }
-
-  // safely ensure that the key is
-  // an integer.
-  function getkey (key) {
-    const parsedKey = Number(key);
-
-    return (
-      isNaN(parsedKey) ||
-      key.indexOf('.') !== -1 ||
-      opts.object
-    )
-      ? key
-      : parsedKey
-  }
-
-  function addKeys (keyPrefix, recipient, target) {
-    return Object.keys(target).reduce(function (result, key) {
-      result[keyPrefix + delimiter + key] = target[key];
-
-      return result
-    }, recipient)
-  }
-
-  function isEmpty (val) {
-    const type = Object.prototype.toString.call(val);
-    const isArray = type === '[object Array]';
-    const isObject = type === '[object Object]';
-
-    if (!val) {
-      return true
-    } else if (isArray) {
-      return !val.length
-    } else if (isObject) {
-      return !Object.keys(val).length
-    }
-  }
-
-  target = Object.keys(target).reduce(function (result, key) {
-    const type = Object.prototype.toString.call(target[key]);
-    const isObject = (type === '[object Object]' || type === '[object Array]');
-    if (!isObject || isEmpty(target[key])) {
-      result[key] = target[key];
-      return result
-    } else {
-      return addKeys(
-        key,
-        result,
-        flatten(target[key], opts)
-      )
-    }
-  }, {});
-
-  Object.keys(target).forEach(function (key) {
-    const split = key.split(delimiter).map(transformKey);
-    let key1 = getkey(split.shift());
-    let key2 = getkey(split[0]);
-    let recipient = result;
-
-    while (key2 !== undefined) {
-      if (key1 === '__proto__') {
-        return
-      }
-
-      const type = Object.prototype.toString.call(recipient[key1]);
-      const isobject = (
-        type === '[object Object]' ||
-        type === '[object Array]'
-      );
-
-      // do not write over falsey, non-undefined values if overwrite is false
-      if (!overwrite && !isobject && typeof recipient[key1] !== 'undefined') {
-        return
-      }
-
-      if ((overwrite && !isobject) || (!overwrite && recipient[key1] == null)) {
-        recipient[key1] = (
-          typeof key2 === 'number' &&
-          !opts.object
-            ? []
-            : {}
-        );
-      }
-
-      recipient = recipient[key1];
-      if (split.length > 0) {
-        key1 = getkey(split.shift());
-        key2 = getkey(split[0]);
-      }
-    }
-
-    // unflatten again for 'messy objects'
-    recipient[key1] = unflatten(target[key], opts);
-  });
-
-  return result
-}
-
 const FlowerCoreStateSelectors = {
   selectGlobal: state => state && state.flower,
   selectFlower: name => state => _get(state, [name]),
@@ -966,6 +816,9 @@ const FlowerCoreStateSelectors = {
       $self: _get(newState, [flowName, ...id.split('.')])
     } : {});
     if (!rules) return false;
+    if (typeof rules === 'function') {
+      return !rules(state);
+    }
     if (!keys) return false;
     const res = keys.reduce((acc, inc) => {
       const k = inc;
@@ -974,7 +827,7 @@ const FlowerCoreStateSelectors = {
       });
     }, {});
     const [disabled] = MatchRules.rulesMatcher(rules, {
-      ...unflatten(res)
+      ...flat.unflatten(res)
     }, false, {
       prefix: flowName
     });

package/dist/index.esm.js

@@ -16,6 +16,7 @@ import mapKeys from 'lodash/mapKeys';
 import mapValues from 'lodash/mapValues';
 import _trimStart from 'lodash/trimStart';
 import _intersection from 'lodash/intersection';
+import { unflatten } from 'flat';
 
 const Emitter = new TinyEmitter();
 
@@ -188,6 +189,7 @@ const rulesMatcherUtils = {
   },
   getKeys: (rules, options) => {
     if (!rules) return null;
+    if (typeof rules == 'function') return [];
     if (!rulesMatcherUtils.forceArray(rules).every(r => rulesMatcherUtils.isObject(r))) return null;
     const keys = {};
     const conditions = Array.isArray(rules) ? {
@@ -217,6 +219,9 @@ const operators = {
 
 const rulesMatcher = (rules, formValue = {}, apply = true, options) => {
   if (!rules) return [apply];
+  if (typeof rules === 'function') {
+    return [rules(formValue) === apply];
+  }
   const conditions = Array.isArray(rules) ? {
     $and: rules
   } : rules;
@@ -345,6 +350,9 @@ const CoreUtils = {
     if (typeof rule.rules === 'string') {
       return false;
     }
+    if (typeof rule.rules === 'function') {
+      return rule.rules(value);
+    }
     if (rule.rules === null) {
       return true;
     }
@@ -748,164 +756,6 @@ const FlowerCoreReducers = {
   }
 };
 
-function isBuffer (obj) {
-  return obj &&
-    obj.constructor &&
-    (typeof obj.constructor.isBuffer === 'function') &&
-    obj.constructor.isBuffer(obj)
-}
-
-function keyIdentity (key) {
-  return key
-}
-
-function flatten (target, opts) {
-  opts = opts || {};
-
-  const delimiter = opts.delimiter || '.';
-  const maxDepth = opts.maxDepth;
-  const transformKey = opts.transformKey || keyIdentity;
-  const output = {};
-
-  function step (object, prev, currentDepth) {
-    currentDepth = currentDepth || 1;
-    Object.keys(object).forEach(function (key) {
-      const value = object[key];
-      const isarray = opts.safe && Array.isArray(value);
-      const type = Object.prototype.toString.call(value);
-      const isbuffer = isBuffer(value);
-      const isobject = (
-        type === '[object Object]' ||
-        type === '[object Array]'
-      );
-
-      const newKey = prev
-        ? prev + delimiter + transformKey(key)
-        : transformKey(key);
-
-      if (!isarray && !isbuffer && isobject && Object.keys(value).length &&
-        (!opts.maxDepth || currentDepth < maxDepth)) {
-        return step(value, newKey, currentDepth + 1)
-      }
-
-      output[newKey] = value;
-    });
-  }
-
-  step(target);
-
-  return output
-}
-
-function unflatten (target, opts) {
-  opts = opts || {};
-
-  const delimiter = opts.delimiter || '.';
-  const overwrite = opts.overwrite || false;
-  const transformKey = opts.transformKey || keyIdentity;
-  const result = {};
-
-  const isbuffer = isBuffer(target);
-  if (isbuffer || Object.prototype.toString.call(target) !== '[object Object]') {
-    return target
-  }
-
-  // safely ensure that the key is
-  // an integer.
-  function getkey (key) {
-    const parsedKey = Number(key);
-
-    return (
-      isNaN(parsedKey) ||
-      key.indexOf('.') !== -1 ||
-      opts.object
-    )
-      ? key
-      : parsedKey
-  }
-
-  function addKeys (keyPrefix, recipient, target) {
-    return Object.keys(target).reduce(function (result, key) {
-      result[keyPrefix + delimiter + key] = target[key];
-
-      return result
-    }, recipient)
-  }
-
-  function isEmpty (val) {
-    const type = Object.prototype.toString.call(val);
-    const isArray = type === '[object Array]';
-    const isObject = type === '[object Object]';
-
-    if (!val) {
-      return true
-    } else if (isArray) {
-      return !val.length
-    } else if (isObject) {
-      return !Object.keys(val).length
-    }
-  }
-
-  target = Object.keys(target).reduce(function (result, key) {
-    const type = Object.prototype.toString.call(target[key]);
-    const isObject = (type === '[object Object]' || type === '[object Array]');
-    if (!isObject || isEmpty(target[key])) {
-      result[key] = target[key];
-      return result
-    } else {
-      return addKeys(
-        key,
-        result,
-        flatten(target[key], opts)
-      )
-    }
-  }, {});
-
-  Object.keys(target).forEach(function (key) {
-    const split = key.split(delimiter).map(transformKey);
-    let key1 = getkey(split.shift());
-    let key2 = getkey(split[0]);
-    let recipient = result;
-
-    while (key2 !== undefined) {
-      if (key1 === '__proto__') {
-        return
-      }
-
-      const type = Object.prototype.toString.call(recipient[key1]);
-      const isobject = (
-        type === '[object Object]' ||
-        type === '[object Array]'
-      );
-
-      // do not write over falsey, non-undefined values if overwrite is false
-      if (!overwrite && !isobject && typeof recipient[key1] !== 'undefined') {
-        return
-      }
-
-      if ((overwrite && !isobject) || (!overwrite && recipient[key1] == null)) {
-        recipient[key1] = (
-          typeof key2 === 'number' &&
-          !opts.object
-            ? []
-            : {}
-        );
-      }
-
-      recipient = recipient[key1];
-      if (split.length > 0) {
-        key1 = getkey(split.shift());
-        key2 = getkey(split[0]);
-      }
-    }
-
-    // unflatten again for 'messy objects'
-    recipient[key1] = unflatten(target[key], opts);
-  });
-
-  return result
-}
-
 const FlowerCoreStateSelectors = {
   selectGlobal: state => state && state.flower,
   selectFlower: name => state => _get(state, [name]),
@@ -964,6 +814,9 @@ const FlowerCoreStateSelectors = {
       $self: _get(newState, [flowName, ...id.split('.')])
     } : {});
     if (!rules) return false;
+    if (typeof rules === 'function') {
+      return !rules(state);
+    }
     if (!keys) return false;
     const res = keys.reduce((acc, inc) => {
       const k = inc;

package/dist/src/RulesMatcher.d.ts

@@ -1,4 +1,5 @@
+import { FunctionRule } from './interfaces';
 export declare const MatchRules: {
-    rulesMatcher: (rules?: Record<string, any> | Record<string, any>[], formValue?: Record<string, any>, apply?: boolean, options?: Record<string, any>) => boolean[];
+    rulesMatcher: (rules?: Record<string, any> | Record<string, any>[] | FunctionRule, formValue?: Record<string, any>, apply?: boolean, options?: Record<string, any>) => boolean[];
     utils: import("./rules-matcher/interface").RulesMatcherUtils;
 };

package/dist/src/interfaces/CoreInterface.d.ts

@@ -67,6 +67,7 @@ type RulesWithName = {
         rules: RulesObject<any>;
     };
 };
+export type FunctionRule = (data: Record<string, any>) => boolean;
 export type RulesObject<T> = RulesValuesType<T> | {
     [K in keyof typeof RulesModes]: Array<RulesOperatorsInArray<RulesValuesType<T>>> | Array<RulesObject<RulesValuesType<T>>>;
 } | Array<Exclude<RulesOperatorsInArray<RulesValuesType<T>>, undefined>>;
@@ -78,7 +79,7 @@ export type GetPath = (idValue?: string) => {
 export type AllEqual = (...args: Array<number | string | boolean>[]) => boolean;
 export type FindValidRule<T = Rules<RulesObject<any>>> = (nextRules: {
     rules: {
-        rules: T;
+        rules: T | FunctionRule;
     };
 }, value: Record<string, any>, prefix?: {
     prefix: string;

package/dist/src/interfaces/SelectorsInterface.d.ts

@@ -1,5 +1,5 @@
 import { RulesObject } from './CoreInterface';
-import { Flower, Form, Node } from './Store';
+import { Flower, Form, INode } from './Store';
 export interface ISelectors {
     selectGlobal<T extends Record<string, any>>(state: {
         flower: {
@@ -18,7 +18,7 @@ export interface ISelectors {
     makeSelectCurrentNodeId<T extends Record<string, any>>(flower: Flower<T>, startNodeId: Flower<T>['startId']): string;
     makeSelectPrevNodeRetain<T extends Record<string, any>>(nodes: Flower<T>['nodes'], history: Flower<T>['history'], current: Flower<T>['current']): boolean | string | undefined;
     makeSelectCurrentNodeDisabled<T extends Record<string, any>>(nodes: {
-        [x: string]: Partial<Node>;
+        [x: string]: Partial<INode>;
     }, current: Flower<T>['current']): boolean;
     makeSelectNodeErrors<T extends Record<string, any>>(form: Form<T> | undefined): {
         touched: boolean;

package/dist/src/interfaces/Store.d.ts

@@ -27,7 +27,7 @@ export interface Flower<T extends Record<string, any>> {
     current: string;
     history: string[];
     nodes: {
-        [x: string]: Node;
+        [x: string]: INode;
     };
     nextRules: {
         [x: string]: RulesByNodeId<T>[];
@@ -37,7 +37,7 @@ export interface Flower<T extends Record<string, any>> {
         [x: string]: Form<T>;
     };
 }
-export interface Node {
+export interface INode {
     nodeId: string;
     nodeType: string;
     retain?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowerforce/flower-core",
-  "version": "3.0.1-beta.7",
+  "version": "3.1.0",
   "description": "Core functions for flowerJS",
   "repository": {
     "type": "git",
@@ -25,12 +25,14 @@
     "lodash": ">=4"
   },
   "devDependencies": {
+    "@types/flat": "^5.0.5",
     "@types/lodash": "^4.17.1",
     "jest": "^29.7.0",
     "ts-jest": "^29.1.2",
     "typescript": "^5.4.5"
   },
   "dependencies": {
+    "flat": "5.0.2",
     "tiny-emitter": "^2.1.0"
   },
   "exports": {