@degenerate/generic 0.0.14 → 0.0.18

package/LICENCE.md

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) [2024] [Degenerateiinc.ca]
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,3 +1,3 @@
 # @Degenerate/generic Package
 
-This package contains generic functions and models for use in the SAFE ecosystem. The package is used to provide common functionality across the different services in the SAFE environment.
+This package contains generic functions and models for use in the SAFE ecosystem. The package is used to provide common functionality across the different services in the SAFE environment.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@degenerate/generic",
-  "version": "0.0.14",
+  "version": "0.0.18",
   "description": "This contains the generic information needed for the ShareData Adaptive Framework Ecosystem (SAFE) network",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -48,8 +48,8 @@
     "typescript-eslint": "^8.9.0"
   },
   "dependencies": {
-    "@degenerate/rules": "^0.0.5",
     "bip39": "^3.1.0",
     "elliptic": "^6.5.7"
-  }
+  },
+  "gitHead": "422633e36d3f60c773c8bf289285a78b5a75ef01"
 }

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

@@ -1,73 +0,0 @@
-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 +0,0 @@
-{"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,152 +0,0 @@
-"use strict";
-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;