@degenerate/rules 0.0.1

package/dist/rules/src/evaluation/evaluate-rule-conditions.d.ts

@@ -0,0 +1,10 @@
+import { ICondition, ITargetObject } from '../../../generic/src';
+/**
+ * This evaluates the conditions for the rule.
+ *
+ * @param targetObject the full object to check
+ * @param condition the condition to check
+ */
+declare const evaluateRuleConditions: (targetObject: ITargetObject, condition: ICondition) => boolean;
+export { evaluateRuleConditions };
+//# sourceMappingURL=evaluate-rule-conditions.d.ts.map

package/dist/rules/src/evaluation/evaluate-rule-conditions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"evaluate-rule-conditions.d.ts","sourceRoot":"","sources":["../../../../src/evaluation/evaluate-rule-conditions.ts"],"names":[],"mappings":"AAAA,OAAO,EAUH,UAAU,EACV,aAAa,EAChB,MAAM,sBAAsB,CAAC;AAW9B;;;;;GAKG;AACH,QAAA,MAAM,sBAAsB,iBAAkB,aAAa,aAAa,UAAU,KAAG,OAkCpF,CAAC;AAGF,OAAO,EAAE,sBAAsB,EAAE,CAAC"}

package/dist/rules/src/evaluation/evaluate-rule-conditions.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.evaluateRuleConditions = void 0;
+const src_1 = require("../../../generic/src");
+const boolean_conditions_1 = require("./conditions/boolean-conditions");
+const contains_conditions_1 = require("./conditions/contains-conditions");
+const empty_conditions_1 = require("./conditions/empty-conditions");
+const equality_conditions_1 = require("./conditions/equality-conditions");
+const null_conditions_1 = require("./conditions/null-conditions");
+const range_conditions_1 = require("./conditions/range-conditions");
+const special_conditions_1 = require("./conditions/special-conditions");
+const starts_end_with_conditions_1 = require("./conditions/starts-end-with-conditions");
+const typeof_rule_conditions_1 = require("./conditions/typeof-rule-conditions");
+/**
+ * This evaluates the conditions for the rule.
+ *
+ * @param targetObject the full object to check
+ * @param condition the condition to check
+ */
+const evaluateRuleConditions = (targetObject, condition) => {
+    const splitProperties = condition.targettedProperty.split('.');
+    const targetValue = getNestedProperty(targetObject, splitProperties);
+    switch (condition.conditionType) {
+        case src_1.ConditionTypeTypeOf.IS_TYPEOF:
+        case src_1.ConditionTypeTypeOf.IS_NOT_TYPEOF:
+            return (0, typeof_rule_conditions_1.isValidTypeOfValue)(targetValue, condition.conditionValue, condition.conditionType);
+        case src_1.ConditionTypeEquality.EQUAL:
+        case src_1.ConditionTypeEquality.NOT_EQUAL:
+            return (0, equality_conditions_1.isValidEqualityValue)(targetValue, condition.conditionValue, condition.conditionType);
+        case src_1.ConditionTypeRange.GREATER_THAN:
+        case src_1.ConditionTypeRange.LESS_THAN:
+        case src_1.ConditionTypeRange.GREATER_THAN_OR_EQUAL:
+        case src_1.ConditionTypeRange.LESS_THAN_OR_EQUAL:
+            return (0, range_conditions_1.isValidRangeValue)(targetValue, condition.conditionValue, condition.conditionType);
+        case src_1.ConditionTypeContains.CONTAINS:
+        case src_1.ConditionTypeContains.NOT_CONTAINS:
+            return (0, contains_conditions_1.isValidContainsValue)(targetValue, condition.conditionValue, condition.conditionType);
+        case src_1.ConditionTypeStartsEndsWith.STARTS_WITH:
+        case src_1.ConditionTypeStartsEndsWith.ENDS_WITH:
+            return (0, starts_end_with_conditions_1.isValidStartEndWithValue)(targetValue, condition.conditionValue, condition.conditionType);
+        case src_1.ConditionTypeNull.IS_NULL:
+        case src_1.ConditionTypeNull.IS_NOT_NULL:
+            return (0, null_conditions_1.isValidNullValue)(targetValue, condition.conditionType);
+        case src_1.ConditionTypeBoolean.IS_TRUE:
+        case src_1.ConditionTypeBoolean.IS_FALSE:
+            return (0, boolean_conditions_1.isValidBooleanValue)(targetValue, condition.conditionType);
+        case src_1.ConditionTypeEmpty.IS_EMPTY:
+        case src_1.ConditionTypeEmpty.IS_NOT_EMPTY:
+            return (0, empty_conditions_1.isValidEmptyValue)(targetValue, condition.conditionType);
+        case src_1.ConditionTypeSpecial.PATTERN:
+            return (0, special_conditions_1.isValidSpecialValue)(targetObject, condition.conditionValue, condition.conditionType);
+    }
+    // return false;
+};
+exports.evaluateRuleConditions = evaluateRuleConditions;
+/**
+ * Accesses a nested property in an object dynamically.
+ *
+ * @param obj The object to access.
+ * @param path The path to the property as an array of strings.
+ * @returns The value of the nested property, or undefined if the property does not exist.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const getNestedProperty = (obj, path) => {
+    return path.reduce((acc, key) => (acc && acc[key] !== undefined) ? acc[key] : undefined, obj);
+};

package/dist/rules/src/evaluation/evaluate-rule.d.ts

@@ -0,0 +1,13 @@
+import { IShareRuleApplied, IShareData, IShareRuleEvalutionResult } from '../../../generic/src';
+/**
+ * This function evaluates a rule and returns the Id of the rule and whether it is valid.
+ *
+ * @param rule the rule to evaluate
+ * @param shareDataCurrent the current share data
+ * @param shareDataProposed the proposed share data
+ * @param logInfo whether to log the information (optional) default is false
+ * @returns
+ */
+declare const evaluateRule: (rule: IShareRuleApplied, shareDataCurrent: IShareData, shareDataProposed: IShareData, logInfo?: boolean) => IShareRuleEvalutionResult;
+export { evaluateRule };
+//# sourceMappingURL=evaluate-rule.d.ts.map

package/dist/rules/src/evaluation/evaluate-rule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"evaluate-rule.d.ts","sourceRoot":"","sources":["../../../../src/evaluation/evaluate-rule.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AAGhG;;;;;;;;GAQG;AACH,QAAA,MAAM,YAAY,SACR,iBAAiB,oBACL,UAAU,qBACT,UAAU,wBAE9B,yBAmCF,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/rules/src/evaluation/evaluate-rule.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.evaluateRule = void 0;
+const evaluate_rule_conditions_1 = require("./evaluate-rule-conditions");
+/**
+ * This function evaluates a rule and returns the Id of the rule and whether it is valid.
+ *
+ * @param rule the rule to evaluate
+ * @param shareDataCurrent the current share data
+ * @param shareDataProposed the proposed share data
+ * @param logInfo whether to log the information (optional) default is false
+ * @returns
+ */
+const evaluateRule = (rule, shareDataCurrent, shareDataProposed, logInfo = false) => {
+    const ruleEvaluationResult = {
+        ruleId: rule.ruleId,
+        currentConditionFailure: [],
+        currentResult: true,
+        proposedConditionFailure: [],
+        proposedResult: true,
+    };
+    // make sure that both before and after data conditions are present
+    if (rule.currentDataConditions.length === 0 || rule.proposedDataConditions.length === 0) {
+        ruleEvaluationResult.currentResult = (rule.currentDataConditions.length !== 0);
+        ruleEvaluationResult.proposedResult = (rule.proposedDataConditions.length !== 0);
+        return ruleEvaluationResult;
+    }
+    // check the current conditions
+    for (const condition of rule.currentDataConditions) {
+        const conditionEvaluationOutcome = (0, evaluate_rule_conditions_1.evaluateRuleConditions)(shareDataCurrent, condition);
+        if (!conditionEvaluationOutcome) {
+            ruleEvaluationResult.currentResult = false;
+            ruleEvaluationResult.currentConditionFailure.push(condition);
+            if (!logInfo)
+                break;
+        }
+    }
+    // check the proposed conditions
+    for (const condition of rule.proposedDataConditions) {
+        const conditionEvaluationOutcome = (0, evaluate_rule_conditions_1.evaluateRuleConditions)(shareDataProposed, condition);
+        if (!conditionEvaluationOutcome) {
+            ruleEvaluationResult.proposedResult = false;
+            ruleEvaluationResult.proposedConditionFailure.push(condition);
+            if (!logInfo)
+                break;
+        }
+    }
+    return ruleEvaluationResult;
+};
+exports.evaluateRule = evaluateRule;

package/dist/rules/src/evaluation/evaluate-rules.d.ts

@@ -0,0 +1,12 @@
+import { IShareRuleApplied, IShareData, IShareRulesEvaluationResult } from '../../../generic/src';
+/**
+ * This function evaluates all rules to check if at least one rule is valid.
+ * @param rootParam the root parameter that all the rules are providing a allow / deny for
+ * @param appliedRules the rules to check for validation
+ * @param shareDataCurrent the current share data
+ * @param shareDataProposed the proposed share data
+ * @param logInfo whether to log the information (optional) default is false
+ */
+declare const evaluateRules: (rootParam: string, appliedRules: IShareRuleApplied[], shareDataCurrent: IShareData, shareDataProposed: IShareData, logInfo?: boolean) => IShareRulesEvaluationResult;
+export { evaluateRules };
+//# sourceMappingURL=evaluate-rules.d.ts.map

package/dist/rules/src/evaluation/evaluate-rules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"evaluate-rules.d.ts","sourceRoot":"","sources":["../../../../src/evaluation/evaluate-rules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,2BAA2B,EAA6B,MAAM,sBAAsB,CAAC;AAG7H;;;;;;;GAOG;AACH,QAAA,MAAM,aAAa,cACJ,MAAM,gBACH,iBAAiB,EAAE,oBACf,UAAU,qBACT,UAAU,wBAE9B,2BA2BF,CAAC;AAEF,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/rules/src/evaluation/evaluate-rules.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.evaluateRules = void 0;
+const evaluate_rule_1 = require("./evaluate-rule");
+/**
+ * This function evaluates all rules to check if at least one rule is valid.
+ * @param rootParam the root parameter that all the rules are providing a allow / deny for
+ * @param appliedRules the rules to check for validation
+ * @param shareDataCurrent the current share data
+ * @param shareDataProposed the proposed share data
+ * @param logInfo whether to log the information (optional) default is false
+ */
+const evaluateRules = (rootParam, appliedRules, shareDataCurrent, shareDataProposed, logInfo = false) => {
+    // create the evaluation object.
+    const shareRulesEvaluationResults = {
+        rootParam,
+        shareRuleEvalutionResults: [],
+        passedRuleCheck: false,
+        passedRuleId: '',
+    };
+    // check each rule
+    for (const rule of appliedRules) {
+        // evaluate the rule
+        const ruleEvaluationResult = (0, evaluate_rule_1.evaluateRule)(rule, shareDataCurrent, shareDataProposed, logInfo);
+        // check if the rule passed
+        const passedRuleCheck = checkIfPassedRules(ruleEvaluationResult);
+        if (passedRuleCheck) {
+            shareRulesEvaluationResults.passedRuleCheck = true;
+            shareRulesEvaluationResults.passedRuleId = rule.ruleId;
+            if (!logInfo)
+                break;
+        }
+        else {
+            if (logInfo) {
+                shareRulesEvaluationResults.shareRuleEvalutionResults.push(ruleEvaluationResult);
+            }
+        }
+    }
+    return shareRulesEvaluationResults;
+};
+exports.evaluateRules = evaluateRules;
+/**
+ * This functions returns whether or not the rule passed for the evaluation.
+ *
+ * @param shareRulesEvaluationResults the evaluation results
+ * @returns
+ */
+const checkIfPassedRules = (shareRulesEvaluationResults) => {
+    return (shareRulesEvaluationResults.currentResult && shareRulesEvaluationResults.proposedResult);
+};

package/dist/rules/src/evaluation/get-data-changed-information.d.ts

@@ -0,0 +1,11 @@
+import { IShareData } from '../../../generic/src';
+/**
+ * This gets a list of the root properties that are different between the two share data objects.
+ *
+ * @param shareDataCurrent The current share data
+ * @param shareDataProposed the proposed share data
+ * @returns
+ */
+declare const getRootPropertyDifferences: (shareDataCurrent: IShareData, shareDataProposed: IShareData) => string[];
+export { getRootPropertyDifferences };
+//# sourceMappingURL=get-data-changed-information.d.ts.map

package/dist/rules/src/evaluation/get-data-changed-information.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-data-changed-information.d.ts","sourceRoot":"","sources":["../../../../src/evaluation/get-data-changed-information.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAGlD;;;;;;GAMG;AACH,QAAA,MAAM,0BAA0B,qBAAsB,UAAU,qBACzC,UAAU,KAAG,MAAM,EAsBzC,CAAC;AAEF,OAAO,EAAE,0BAA0B,EAAE,CAAC"}

package/dist/rules/src/evaluation/get-data-changed-information.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRootPropertyDifferences = void 0;
+const determine_if_data_has_changed_1 = require("./determine-if-data-has-changed");
+/**
+ * This gets a list of the root properties that are different between the two share data objects.
+ *
+ * @param shareDataCurrent The current share data
+ * @param shareDataProposed the proposed share data
+ * @returns
+ */
+const getRootPropertyDifferences = (shareDataCurrent, shareDataProposed) => {
+    // create an array of root properties to check
+    const currentRootProperties = Object.keys(shareDataCurrent);
+    const proposedRootProperties = Object.keys(shareDataProposed);
+    // check if the root properties are the same, if not return the differences
+    const differences = currentRootProperties.filter((x) => !proposedRootProperties.includes(x));
+    const differences2 = proposedRootProperties.filter((x) => !currentRootProperties.includes(x));
+    // combine the differences
+    const allDifferences = [...differences, ...differences2];
+    // get the items that are the same
+    const sameItems = currentRootProperties.filter((x) => proposedRootProperties.includes(x));
+    // loop each item and check if the data is the same or different between them
+    for (const item of sameItems) {
+        if ((0, determine_if_data_has_changed_1.determineIfDataHasChanged)(shareDataCurrent[item], shareDataProposed[item])) {
+            allDifferences.push(item);
+        }
+    }
+    return allDifferences;
+};
+exports.getRootPropertyDifferences = getRootPropertyDifferences;

package/dist/rules/src/evaluation/get-root-property-results.d.ts

@@ -0,0 +1,14 @@
+import { IShareRuleApplied, IShareData, IShareRulesEvaluationResult } from '../../../generic/src';
+/**
+ * This function gets the root property results.
+ *
+ * @param differentRootProperties the different root properties
+ * @param appliedRules the rules to check
+ * @param shareDataCurrent the current share data
+ * @param shareDataProposed the proposed share data
+ * @param logInfo the detailed log information (optional) default is false
+ * @returns
+ */
+declare const getRootPropertyResults: (differentRootProperties: string[], appliedRules: IShareRuleApplied[], shareDataCurrent: IShareData, shareDataProposed: IShareData, logInfo?: boolean) => IShareRulesEvaluationResult[];
+export { getRootPropertyResults };
+//# sourceMappingURL=get-root-property-results.d.ts.map

package/dist/rules/src/evaluation/get-root-property-results.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-root-property-results.d.ts","sourceRoot":"","sources":["../../../../src/evaluation/get-root-property-results.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,2BAA2B,EAAE,MAAM,sBAAsB,CAAC;AAGlG;;;;;;;;;GASG;AACH,QAAA,MAAM,sBAAsB,4BACC,MAAM,EAAE,gBACnB,iBAAiB,EAAE,oBACf,UAAU,qBACT,UAAU,wBAE9B,2BAA2B,EAa7B,CAAC;AAEF,OAAO,EAAE,sBAAsB,EAAE,CAAC"}

package/dist/rules/src/evaluation/get-root-property-results.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRootPropertyResults = void 0;
+const evaluate_rules_1 = require("./evaluate-rules");
+/**
+ * This function gets the root property results.
+ *
+ * @param differentRootProperties the different root properties
+ * @param appliedRules the rules to check
+ * @param shareDataCurrent the current share data
+ * @param shareDataProposed the proposed share data
+ * @param logInfo the detailed log information (optional) default is false
+ * @returns
+ */
+const getRootPropertyResults = (differentRootProperties, appliedRules, shareDataCurrent, shareDataProposed, logInfo = false) => {
+    const rulesResults = [];
+    // loop each root property and check their rules.
+    for (const rootProperty of differentRootProperties) {
+        // get the rules for the root property
+        const rulesForRootProperty = appliedRules.filter((x) => x.targettedProperty === rootProperty);
+        // evaluate the rules
+        const ruleEvaluationResult = (0, evaluate_rules_1.evaluateRules)(rootProperty, rulesForRootProperty, shareDataCurrent, shareDataProposed, logInfo);
+        rulesResults.push(ruleEvaluationResult);
+    }
+    return rulesResults;
+};
+exports.getRootPropertyResults = getRootPropertyResults;

package/dist/rules/src/evaluation/index.d.ts

@@ -0,0 +1,10 @@
+export * from './conditions/boolean-conditions';
+export * from './conditions/contains-conditions';
+export * from './conditions/empty-conditions';
+export * from './conditions/equality-conditions';
+export * from './conditions/null-conditions';
+export * from './conditions/range-conditions';
+export * from './conditions/special-conditions';
+export * from './conditions/starts-end-with-conditions';
+export * from './conditions/typeof-rule-conditions';
+//# sourceMappingURL=index.d.ts.map

package/dist/rules/src/evaluation/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/evaluation/index.ts"],"names":[],"mappings":"AAEA,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,yCAAyC,CAAC;AACxD,cAAc,qCAAqC,CAAC"}

package/dist/rules/src/evaluation/index.js

@@ -0,0 +1,27 @@
+"use strict";
+//#region Conditional Functions
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./conditions/boolean-conditions"), exports);
+__exportStar(require("./conditions/contains-conditions"), exports);
+__exportStar(require("./conditions/empty-conditions"), exports);
+__exportStar(require("./conditions/equality-conditions"), exports);
+__exportStar(require("./conditions/null-conditions"), exports);
+__exportStar(require("./conditions/range-conditions"), exports);
+__exportStar(require("./conditions/special-conditions"), exports);
+__exportStar(require("./conditions/starts-end-with-conditions"), exports);
+__exportStar(require("./conditions/typeof-rule-conditions"), exports);
+//#endregion Conditional Functions

package/dist/rules/src/evaluation/start-rule-evaluation.d.ts

@@ -0,0 +1,13 @@
+import { IShareFunction, IShareRuleApplied, IShareData, IRuleEvaluationResults } from '../../../generic/src';
+/**
+ * This function starts the rule evaluation for the share data.
+ *
+ * @param shareDataId the share data id
+ * @param appliedRules all rules in the share data
+ * @param shareDataCurrent the current share data
+ * @param shareDataProposed the proposed share data
+ * @param logInfo whether detailed information should be logged (optional) default is false
+ */
+declare const startRuleEvaluation: (shareDataId: string, shareDataFunction: IShareFunction<any, (...args: any[]) => any, any>, shareDataFunctions: IShareFunction<any, (...args: any[]) => any, any>[], appliedRules: IShareRuleApplied[], shareDataCurrent: IShareData, shareDataProposed: IShareData, logInfo?: boolean) => IRuleEvaluationResults;
+export { startRuleEvaluation };
+//# sourceMappingURL=start-rule-evaluation.d.ts.map

package/dist/rules/src/evaluation/start-rule-evaluation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"start-rule-evaluation.d.ts","sourceRoot":"","sources":["../../../../src/evaluation/start-rule-evaluation.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,cAAc,EACd,iBAAiB,EACjB,UAAU,EACV,sBAAsB,EAGzB,MAAM,sBAAsB,CAAC;AAO9B;;;;;;;;GAQG;AACH,QAAA,MAAM,mBAAmB,gBACR,MAAM,qBACA,cAAc,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAAE,GAAG,CAAC,sBAChD,cAAc,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAAE,GAAG,CAAC,EAAE,gBACzD,iBAAiB,EAAE,oBACf,UAAU,qBACT,UAAU,wBAE9B,sBA4BF,CAAC;AAEF,OAAO,EAAE,mBAAmB,EAAE,CAAC"}

package/dist/rules/src/evaluation/start-rule-evaluation.js

@@ -0,0 +1,42 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startRuleEvaluation = void 0;
+const src_1 = require("../../../generic/src");
+const check_function_integrity_1 = require("./check-function-integrity");
+const check_if_proposal_is_valid_1 = require("./check-if-proposal-is-valid");
+const determine_if_data_has_changed_1 = require("./determine-if-data-has-changed");
+const get_data_changed_information_1 = require("./get-data-changed-information");
+const get_root_property_results_1 = require("./get-root-property-results");
+/**
+ * This function starts the rule evaluation for the share data.
+ *
+ * @param shareDataId the share data id
+ * @param appliedRules all rules in the share data
+ * @param shareDataCurrent the current share data
+ * @param shareDataProposed the proposed share data
+ * @param logInfo whether detailed information should be logged (optional) default is false
+ */
+const startRuleEvaluation = (shareDataId, shareDataFunction, shareDataFunctions, appliedRules, shareDataCurrent, shareDataProposed, logInfo = false) => {
+    // create the return data
+    const rulesEvaluationsFull = {
+        shareDataId,
+        rulesResults: [],
+        isValidProposal: false,
+    };
+    // check data integrity
+    if (!(0, check_function_integrity_1.checkFunctionIntegrity)(shareDataFunction, shareDataFunctions)) {
+        throw new src_1.ShareDataIntegrityError(shareDataId);
+    }
+    // check if the data has changed.
+    if (!(0, determine_if_data_has_changed_1.determineIfDataHasChanged)(shareDataCurrent, shareDataProposed)) {
+        throw new src_1.ShareDataCurrentAndProposalDataMatchesError(shareDataId);
+    }
+    // get all root properties that are different
+    const differentRootProperties = (0, get_data_changed_information_1.getRootPropertyDifferences)(shareDataCurrent, shareDataProposed);
+    const totalRulesToBeValid = differentRootProperties.length;
+    rulesEvaluationsFull.rulesResults = (0, get_root_property_results_1.getRootPropertyResults)(differentRootProperties, appliedRules, shareDataCurrent, shareDataProposed, logInfo);
+    rulesEvaluationsFull.isValidProposal = (0, check_if_proposal_is_valid_1.checkIfProposalIsValid)(totalRulesToBeValid, rulesEvaluationsFull.rulesResults);
+    return rulesEvaluationsFull;
+};
+exports.startRuleEvaluation = startRuleEvaluation;

package/dist/rules/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './evaluation';
+//# sourceMappingURL=index.d.ts.map

package/dist/rules/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/dist/rules/src/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./evaluation"), exports);

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@degenerate/rules",
+  "description": "This contains the rules information needed for the ShareData Adaptive Framework Ecosystem (SAFE) network.",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "devDependencies": {
+    "@types/jest": "^29.5.13",
+    "@types/node": "^22.7.7",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.6.3"
+  },
+  "scripts": {
+    "build": "rm -rf dist/* && tsc -p tsconfig.pkg.json",
+    "compile": "rm -rf dist/* && tsc -p tsconfig.pkg.json",
+    "test": "jest --forceExit --detectOpenHandles --verbose --silent=false --env node --config tsconfig.pkg.json",
+    "test:coverage": "jest --forceExit --coverage --detectOpenHandles --verbose --silent=false --env node  --config tsconfig.pkg.json",
+    "test:clearCache": "jest --clearCache"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/syncrude/safe.git"
+  },
+  "keywords": [
+    "ShareData Adaptive Framework Ecosystem",
+    "SAFE",
+    "SAFE Rules",
+    "ShareData",
+    "ShareBlock"
+  ],
+  "bugs": {
+    "url": "https://github.com/syncrude/safe/issues"
+  },
+  "homepage": "https://github.com/syncrude/safe#readme",
+  "author": "Degenerate Inc.",
+  "license": "ISC"
+}