@degenerate/sharedata 0.0.1

package/README.md

@@ -0,0 +1,3 @@
+# @Degenerate/<new-package-name> Package
+
+This package contains the functions for <new-package-name>.  The package <what-the-purpose-of-the-package-is> in the SAFE environment.

package/dist/index.d.ts

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

package/dist/index.d.ts.map

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

package/dist/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("./share-data/share-data"), exports);

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

@@ -0,0 +1,76 @@
+import { IShareData, IShareDataEvent, IShareFunction, IShareRuleApplied, IShareRuleEvalutionResult, IShareTransactionHistory } from '@degenerate/generic';
+/**
+ * This contains the interface for the share data object
+ */
+export declare class ShareData {
+    private _id;
+    private _version;
+    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 gets the version of the share data
+     */
+    get version(): number;
+    /**
+     * 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

@@ -0,0 +1 @@
+{"version":3,"file":"share-data.d.ts","sourceRoot":"","sources":["../../src/share-data/share-data.ts"],"names":[],"mappings":"AACA,OAAO,EACH,UAAU,EACV,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,yBAAyB,EACzB,wBAAwB,EAG3B,MAAM,qBAAqB,CAAC;AAE7B;;GAEG;AACH,qBAAa,SAAS;IAClB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,QAAQ,CAAS;IACzB,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;IAatB;;;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;;OAEG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED;;;OAGG;IACH,MAAM,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS;CAa/C"}

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

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShareData = void 0;
+const rules_1 = require("@degenerate/rules");
+const generic_1 = require("@degenerate/generic");
+/**
+ * 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._version = 1,
+            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 generic_1.ShareDataIsLockedError(this._id, generic_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 generic_1.ShareDataIsLockedError(this._id, generic_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 gets the version of the share data
+     */
+    get version() {
+        return this._version;
+    }
+    /**
+     * 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._events = [...this._events];
+        newShareData._data = { ...this._data };
+        newShareData._version = this._version;
+        return newShareData;
+    }
+}
+exports.ShareData = ShareData;

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@degenerate/sharedata",
+  "version": "0.0.1",
+  "description": "This contains the ShareData Adaptive Framework Ecosystem (SAFE) network core code",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "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"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.8.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.6.3"
+  },
+  "keywords": [
+    "ShareData Adaptive Framework Ecosystem",
+    "SAFE",
+    "SAFE ShareData",
+    "ShareData",
+    "ShareBlock"
+  ],
+  "author": "Degenerate Inc.",
+  "license": "ISC",
+  "dependencies": {
+    "@degenerate/generic": "^0.0.17",
+    "@degenerate/rules": "^0.0.9"
+  },
+  "bugs": {
+    "url": "https://github.com/syncrude/safe/issues"
+  },
+  "homepage": "https://github.com/syncrude/safe#readme",
+  "gitHead": "0e8f76c14364f6d23ab66cdb9547d4e486fad9a4",
+  "publishConfig": {
+    "access": "public"
+  }
+}