@degenerate/generic 0.0.10 → 0.0.13

package/dist/errors/index.d.ts

@@ -1,6 +1,7 @@
 export * from './base-error';
 export * from './generic/generic-errors';
 export * from './request/request-errors';
+export * from './safe/safe-rules-errors';
 export * from './scheduler/scheduler-errors';
 export * from './share-data/share-data-errors';
 //# sourceMappingURL=index.d.ts.map

package/dist/errors/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/errors/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/errors/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC"}

package/dist/errors/index.js

@@ -17,5 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./base-error"), exports);
 __exportStar(require("./generic/generic-errors"), exports);
 __exportStar(require("./request/request-errors"), exports);
+__exportStar(require("./safe/safe-rules-errors"), exports);
 __exportStar(require("./scheduler/scheduler-errors"), exports);
 __exportStar(require("./share-data/share-data-errors"), exports);

package/dist/errors/safe/safe-rules-errors.d.ts

@@ -0,0 +1,30 @@
+import { ConditionType } from '../../models';
+import { BaseError } from '../base-error';
+/**
+ * This error is thrown when a evaluation condition data value is not valid
+ */
+export declare class SafeRuleEvaluationConditionDataValueError extends BaseError {
+    /**
+     *  This error is thrown when a evaluation condition data value is not valid
+     */
+    constructor(dataValue: unknown, conditionValue: unknown, conditionType: ConditionType);
+}
+/**
+ * This error is thrown when a evaluation condition value is not valid
+ */
+export declare class SafeRuleEvaluationConditionValueError extends BaseError {
+    /**
+     *  This error is thrown when a evaluation condition value is not valid
+     */
+    constructor(dataValue: unknown, conditionValue: unknown, conditionType: ConditionType);
+}
+/**
+ * This error is thrown when a speical condition pattern is not valid
+ */
+export declare class SafeRuleEvaluationSpecialConditionPatternError extends BaseError {
+    /**
+     * This error is thrown when a speical condition pattern is not valid
+     */
+    constructor(dataValue: unknown, conditionValue: unknown);
+}
+//# sourceMappingURL=safe-rules-errors.d.ts.map

package/dist/errors/safe/safe-rules-errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"safe-rules-errors.d.ts","sourceRoot":"","sources":["../../../src/errors/safe/safe-rules-errors.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;GAEG;AACH,qBAAa,yCAA0C,SAAQ,SAAS;IACpE;;OAEG;gBACS,SAAS,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa;CAGxF;AAED;;GAEG;AACH,qBAAa,qCAAsC,SAAQ,SAAS;IAChE;;OAEG;gBACS,SAAS,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa;CAGxF;AAED;;GAEG;AACH,qBAAa,8CAA+C,SAAQ,SAAS;IACzE;;OAEG;gBACS,SAAS,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO;CAG1D"}

package/dist/errors/safe/safe-rules-errors.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SafeRuleEvaluationSpecialConditionPatternError = exports.SafeRuleEvaluationConditionValueError = exports.SafeRuleEvaluationConditionDataValueError = void 0;
+const base_error_1 = require("../base-error");
+/**
+ * This error is thrown when a evaluation condition data value is not valid
+ */
+class SafeRuleEvaluationConditionDataValueError extends base_error_1.BaseError {
+    /**
+     *  This error is thrown when a evaluation condition data value is not valid
+     */
+    constructor(dataValue, conditionValue, conditionType) {
+        super(`Share Rule condition evaluation for type ${conditionType} failed to execute. dataValue: ${dataValue} is incorrect for conditionValue: ${conditionValue}`);
+    }
+}
+exports.SafeRuleEvaluationConditionDataValueError = SafeRuleEvaluationConditionDataValueError;
+/**
+ * This error is thrown when a evaluation condition value is not valid
+ */
+class SafeRuleEvaluationConditionValueError extends base_error_1.BaseError {
+    /**
+     *  This error is thrown when a evaluation condition value is not valid
+     */
+    constructor(dataValue, conditionValue, conditionType) {
+        super(`Share Rule condition evaluation for type ${conditionType} failed to execute. conditionValue: ${conditionValue} is incorrect for dataValue: ${dataValue}`);
+    }
+}
+exports.SafeRuleEvaluationConditionValueError = SafeRuleEvaluationConditionValueError;
+/**
+ * This error is thrown when a speical condition pattern is not valid
+ */
+class SafeRuleEvaluationSpecialConditionPatternError extends base_error_1.BaseError {
+    /**
+     * This error is thrown when a speical condition pattern is not valid
+     */
+    constructor(dataValue, conditionValue) {
+        super(`Share Rule special condition pattern evaluation failed to execute. dataValue ${dataValue} and conditionValue: ${conditionValue}`);
+    }
+}
+exports.SafeRuleEvaluationSpecialConditionPatternError = SafeRuleEvaluationSpecialConditionPatternError;

package/dist/share-data/share-data.d.ts

@@ -1 +1,73 @@
+import { IShareDataEvent } from '../models/events/share-event-models';
+import { IShareRuleApplied, IShareRuleEvalutionResult } from '../models/rules/share-rule-models';
+import { IShareFunction, IShareTransactionHistory, IShareData } from '../models/share-data/share-data';
+/**
+ * This contains the interface for the share data object
+ */
+export declare class ShareData {
+    private _id;
+    private _rules;
+    private _functions;
+    private _transactionHistory;
+    private _events;
+    private isLocked;
+    private _data;
+    /**
+     * This is the constructor for the share data object
+     * @param id the id of the share data
+     */
+    constructor(id: string);
+    /**
+     * This adds a rule to the share block.
+     * @param rule the rule to add to the share block
+     */
+    addRule(rule: IShareRuleApplied): void;
+    /**
+     * This gets the rules for the share block
+     */
+    get rules(): IShareRuleApplied[];
+    /**
+     * This gets the transaction history for the share block
+     */
+    addFunction(func: IShareFunction<any, (...args: any[]) => any, any>): void;
+    /**
+     * This gets the functions for the share block
+     */
+    get functions(): IShareFunction<any, (...args: any[]) => any, any>[];
+    /**
+     * This gets the events for the sharedata
+     */
+    get events(): IShareDataEvent[];
+    /**
+     * This adds an event to the share data
+     * @param event the event to add
+     */
+    addEvent(event: IShareDataEvent): void;
+    /**
+     * This adds a transaction to the share block
+     * @param rulesEvaluation the evaluation of the rules (result)
+     * @param transactionFunction the function that was run
+     */
+    addTransactionAlreadyValidated(proposedData: IShareData, rulesEvaluation: IShareRuleEvalutionResult, transactionFunction: IShareFunction<any, (...args: any[]) => any, any>): void;
+    /**
+     * This adds a transaction to the share block but the transaction has not yet been validated
+     *
+     * @param proposedData the proposed data
+     * @param transactionFunction the function that was attempted
+     */
+    addTransactionNotValidated(proposedData: IShareData, transactionFunction: IShareFunction<any, (...args: any[]) => any, any>): void;
+    /**
+     * This gets the transaction history for the share block
+     */
+    get transactionHistory(): IShareTransactionHistory[];
+    /**
+     * This returns the current state of data for the share block
+     */
+    get data(): IShareData;
+    /**
+     * This copies a share data object to a new transaction number
+     * @param transactionNumber the number of the transaction to run until.
+     */
+    copyTo(transactionNumber: number): ShareData;
+}
 //# sourceMappingURL=share-data.d.ts.map

package/dist/share-data/share-data.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"share-data.d.ts","sourceRoot":"","sources":["../../src/share-data/share-data.ts"],"names":[],"mappings":""}
+{"version":3,"file":"share-data.d.ts","sourceRoot":"","sources":["../../src/share-data/share-data.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAC;AACjG,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAE,UAAU,EAAkB,MAAM,iCAAiC,CAAC;AAEvH;;GAEG;AACH,qBAAa,SAAS;IAClB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,MAAM,CAAsB;IACpC,OAAO,CAAC,UAAU,CAAsD;IACxE,OAAO,CAAC,mBAAmB,CAA6B;IACxD,OAAO,CAAC,OAAO,CAAoB;IACnC,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,KAAK,CAAa;IAE1B;;;OAGG;gBACS,EAAE,EAAE,MAAM;IAYtB;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI;IAOtC;;OAEG;IACH,IAAI,KAAK,IAAI,iBAAiB,EAAE,CAE/B;IAED;;OAEG;IACH,WAAW,CAAC,IAAI,EAAE,cAAc,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI;IAO1E;;OAEG;IACH,IAAI,SAAS,IAAI,cAAc,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAAE,GAAG,CAAC,EAAE,CAEnE;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,eAAe,EAAE,CAE9B;IAED;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI;IAItC;;;;OAIG;IACH,8BAA8B,CAC1B,YAAY,EAAE,UAAU,EACxB,eAAe,EAAE,yBAAyB,EAC1C,mBAAmB,EAAE,cAAc,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAAE,GAAG,CAAC,GACvE,IAAI;IAwBP;;;;;OAKG;IACH,0BAA0B,CACtB,YAAY,EAAE,UAAU,EACxB,mBAAmB,EAAE,cAAc,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAAE,GAAG,CAAC,GACvE,IAAI;IA0BP;;OAEG;IACH,IAAI,kBAAkB,IAAI,wBAAwB,EAAE,CAEnD;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,UAAU,CAErB;IAED;;;OAGG;IACH,MAAM,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS;CAW/C"}

package/dist/share-data/share-data.js

@@ -1,166 +1,152 @@
 "use strict";
-// import { startRuleEvaluation } from '../../../rules/src/evaluation/start-rule-evaluation';
-// import { ShareDataIsLockedError } from '../errors';
-// import { IShareDataEvent } from '../models/events/share-event-models';
-// import { IShareRuleApplied, IShareRuleEvalutionResult } from '../models/rules/share-rule-models';
-// import { IShareFunction, IShareTransactionHistory, IShareData, ShareDataTypes } from '../models/share-data/share-data';
-// /**
-//  * This contains the interface for the share data object
-//  */
-// export class ShareData {
-//     private _id: string; // the id of the share data
-//     private _rules: IShareRuleApplied[]; // the rules for the share data
-//     private _functions: IShareFunction<any, (...args: any[]) => any, any>[]; // the functions for the share data
-//     private _transactionHistory: IShareTransactionHistory[]; // The transaction history for the share data
-//     private _events: IShareDataEvent[]; // the events for the share data
-//     private isLocked: boolean; // the lock status of the share data
-//     private _data: IShareData; // the data for the share data
-//     /**
-//      * This is the constructor for the share data object
-//      * @param id the id of the share data
-//      */
-//     constructor(id: string) {
-//         this.isLocked = false;
-//         this._id = id;
-//         this._rules = [];
-//         this._functions = [];
-//         this._transactionHistory = [];
-//         this._events = [];
-//         this._data = {};
-//     }
-//     //#region Getters and Setters
-//     /**
-//      * This adds a rule to the share block.
-//      * @param rule the rule to add to the share block
-//      */
-//     addRule(rule: IShareRuleApplied): void {
-//         if (this.isLocked) {
-//             throw new ShareDataIsLockedError(this._id, ShareDataTypes.RULE);
-//         }
-//         this._rules.push(rule);
-//     }
-//     /**
-//      * This gets the rules for the share block
-//      */
-//     get rules(): IShareRuleApplied[] {
-//         return this._rules;
-//     }
-//     /**
-//      * This gets the transaction history for the share block
-//      */
-//     addFunction(func: IShareFunction<any, (...args: any[]) => any, any>): void {
-//         if (this.isLocked) {
-//             throw new ShareDataIsLockedError(this._id, ShareDataTypes.FUNCTION);
-//         }
-//         this._functions.push(func);
-//     }
-//     /**
-//      * This gets the functions for the share block
-//      */
-//     get functions(): IShareFunction<any, (...args: any[]) => any, any>[] {
-//         return this._functions;
-//     }
-//     /**
-//      * This gets the events for the sharedata
-//      */
-//     get events(): IShareDataEvent[] {
-//         return this._events;
-//     }
-//     /**
-//      * This adds an event to the share data
-//      * @param event the event to add
-//      */
-//     addEvent(event: IShareDataEvent): void {
-//         this._events.push(event);
-//     }
-//     /**
-//      * This adds a transaction to the share block
-//      * @param rulesEvaluation the evaluation of the rules (result)
-//      * @param transactionFunction the function that was run
-//      */
-//     addTransactionAlreadyValidated(
-//         proposedData: IShareData,
-//         rulesEvaluation: IShareRuleEvalutionResult,
-//         transactionFunction: IShareFunction<any, (...args: any[]) => any, any>,
-//     ): void {
-//         // make sure the function is known.
-//         if (!this._functions.includes(transactionFunction)) {
-//             throw new Error('The function is not known');
-//         }
-//         const transactionTime = Date.now(); // get the current time
-//         const transactionId = this._transactionHistory.length + 1; // get the transaction id
-//         const ruleOutcome = (rulesEvaluation.proposedResult && rulesEvaluation.currentResult);
-//         const transaction: IShareTransactionHistory = {
-//             ruleOutcome,
-//             ruleFailures: [],
-//             transactionFunction,
-//             transactionId: transactionId.toString(),
-//             transactionTime,
-//         };
-//         // the outcome of the rules is valid write the data to be the new current data.
-//         if (ruleOutcome) {
-//             this._data = proposedData;
-//         }
-//         this._transactionHistory.push(transaction);
-//     }
-//     /**
-//      * This adds a transaction to the share block but the transaction has not yet been validated
-//      *
-//      * @param proposedData the proposed data
-//      * @param transactionFunction the function that was attempted
-//      */
-//     addTransactionNotValidated(
-//         proposedData: IShareData,
-//         transactionFunction: IShareFunction<any, (...args: any[]) => any, any>,
-//     ): void {
-//         // make sure the function is known.
-//         if (!this._functions.includes(transactionFunction)) {
-//             // throw ShareDataFunctionBeingAppliedDoesNotExistOnShareDataError
-//             throw new Error('The function is not known');
-//         }
-//         // // evaluate the rules.
-//         // const rulesEvalOutcome = evaluateRules('transaction', this._data, proposedData, this._rules);
-//         const rulesOutcome = startRuleEvaluation(this._id, transactionFunction, this.functions, this._rules, this._data, proposedData);
-//         const transactionTime = Date.now(); // get the current time
-//         const transactionId = this._transactionHistory.length + 1; // get the transaction id
-//         const transaction: IShareTransactionHistory = {
-//             ruleOutcome: rulesOutcome.isValidProposal,
-//             ruleFailures: [],
-//             transactionFunction,
-//             transactionId: transactionId.toString(),
-//             transactionTime,
-//         };
-//         // update the data if the rules are valid
-//         if (rulesOutcome.isValidProposal) {
-//             this._data = proposedData;
-//         }
-//         // add the transaction to the history
-//         this._transactionHistory.push(transaction);
-//     }
-//     /**
-//      * This gets the transaction history for the share block
-//      */
-//     get transactionHistory(): IShareTransactionHistory[] {
-//         return this._transactionHistory;
-//     }
-//     /**
-//      * This returns the current state of data for the share block
-//      */
-//     get data(): IShareData {
-//         return this._data;
-//     }
-//     /**
-//      * This copies a share data object to a new transaction number
-//      * @param transactionNumber the number of the transaction to run until.
-//      */
-//     copyTo(transactionNumber: number): ShareData {
-//         // return share data with a new ID
-//         const newShareData = new ShareData(`${this._id}-${transactionNumber}`);
-//         newShareData._rules = [...this._rules];
-//         newShareData._functions = [...this._functions];
-//         newShareData._transactionHistory = [...this._transactionHistory];
-//         newShareData._data = { ...this._data };
-//         return newShareData;
-//     }
-//     //#endregion Getters and Setters
-// }
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShareData = void 0;
+const rules_1 = require("@degenerate/rules");
+const errors_1 = require("../errors");
+const share_data_1 = require("../models/share-data/share-data");
+/**
+ * This contains the interface for the share data object
+ */
+class ShareData {
+    /**
+     * This is the constructor for the share data object
+     * @param id the id of the share data
+     */
+    constructor(id) {
+        this.isLocked = false;
+        this._id = id;
+        this._rules = [];
+        this._functions = [];
+        this._transactionHistory = [];
+        this._events = [];
+        this._data = {};
+    }
+    //#region Getters and Setters
+    /**
+     * This adds a rule to the share block.
+     * @param rule the rule to add to the share block
+     */
+    addRule(rule) {
+        if (this.isLocked) {
+            throw new errors_1.ShareDataIsLockedError(this._id, share_data_1.ShareDataTypes.RULE);
+        }
+        this._rules.push(rule);
+    }
+    /**
+     * This gets the rules for the share block
+     */
+    get rules() {
+        return this._rules;
+    }
+    /**
+     * This gets the transaction history for the share block
+     */
+    addFunction(func) {
+        if (this.isLocked) {
+            throw new errors_1.ShareDataIsLockedError(this._id, share_data_1.ShareDataTypes.FUNCTION);
+        }
+        this._functions.push(func);
+    }
+    /**
+     * This gets the functions for the share block
+     */
+    get functions() {
+        return this._functions;
+    }
+    /**
+     * This gets the events for the sharedata
+     */
+    get events() {
+        return this._events;
+    }
+    /**
+     * This adds an event to the share data
+     * @param event the event to add
+     */
+    addEvent(event) {
+        this._events.push(event);
+    }
+    /**
+     * This adds a transaction to the share block
+     * @param rulesEvaluation the evaluation of the rules (result)
+     * @param transactionFunction the function that was run
+     */
+    addTransactionAlreadyValidated(proposedData, rulesEvaluation, transactionFunction) {
+        // make sure the function is known.
+        if (!this._functions.includes(transactionFunction)) {
+            throw new Error('The function is not known');
+        }
+        const transactionTime = Date.now(); // get the current time
+        const transactionId = this._transactionHistory.length + 1; // get the transaction id
+        const ruleOutcome = (rulesEvaluation.proposedResult && rulesEvaluation.currentResult);
+        const transaction = {
+            ruleOutcome,
+            ruleFailures: [],
+            transactionFunction,
+            transactionId: transactionId.toString(),
+            transactionTime,
+        };
+        // the outcome of the rules is valid write the data to be the new current data.
+        if (ruleOutcome) {
+            this._data = proposedData;
+        }
+        this._transactionHistory.push(transaction);
+    }
+    /**
+     * This adds a transaction to the share block but the transaction has not yet been validated
+     *
+     * @param proposedData the proposed data
+     * @param transactionFunction the function that was attempted
+     */
+    addTransactionNotValidated(proposedData, transactionFunction) {
+        // make sure the function is known.
+        if (!this._functions.includes(transactionFunction)) {
+            // throw ShareDataFunctionBeingAppliedDoesNotExistOnShareDataError
+            throw new Error('The function is not known');
+        }
+        // // evaluate the rules.
+        // const rulesEvalOutcome = evaluateRules('transaction', this._data, proposedData, this._rules);
+        const rulesOutcome = (0, rules_1.startRuleEvaluation)(this._id, transactionFunction, this.functions, this._rules, this._data, proposedData);
+        const transactionTime = Date.now(); // get the current time
+        const transactionId = this._transactionHistory.length + 1; // get the transaction id
+        const transaction = {
+            ruleOutcome: rulesOutcome.isValidProposal,
+            ruleFailures: [],
+            transactionFunction,
+            transactionId: transactionId.toString(),
+            transactionTime,
+        };
+        // update the data if the rules are valid
+        if (rulesOutcome.isValidProposal) {
+            this._data = proposedData;
+        }
+        // add the transaction to the history
+        this._transactionHistory.push(transaction);
+    }
+    /**
+     * This gets the transaction history for the share block
+     */
+    get transactionHistory() {
+        return this._transactionHistory;
+    }
+    /**
+     * This returns the current state of data for the share block
+     */
+    get data() {
+        return this._data;
+    }
+    /**
+     * This copies a share data object to a new transaction number
+     * @param transactionNumber the number of the transaction to run until.
+     */
+    copyTo(transactionNumber) {
+        // return share data with a new ID
+        const newShareData = new ShareData(`${this._id}-${transactionNumber}`);
+        newShareData._rules = [...this._rules];
+        newShareData._functions = [...this._functions];
+        newShareData._transactionHistory = [...this._transactionHistory];
+        newShareData._data = { ...this._data };
+        return newShareData;
+    }
+}
+exports.ShareData = ShareData;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@degenerate/generic",
-  "version": "0.0.10",
-  "description": "This contains the generic information needed for the Distributed Execution Infrastructure network.",
+  "version": "0.0.13",
+  "description": "This contains the generic information needed for the ShareData Adaptive Framework Ecosystem (SAFE) network",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -48,6 +48,7 @@
     "typescript-eslint": "^8.9.0"
   },
   "dependencies": {
+    "@degenerate/rules": "^0.0.5",
     "bip39": "^3.1.0",
     "elliptic": "^6.5.7"
   }