@azuro-org/toolkit 0.1.0

package/README.md

@@ -0,0 +1,116 @@
+# Toolkit Package
+
+This package provides helpers to develop an app using Azuro Protocol.
+
+
+## Installation
+
+```
+npm i --save @azuro-org/toolkit
+```
+
+
+## CLI
+
+All dictionaries stored in [public repository](https://github.com/Azuro-protocol/public-config/tree/main/dictionaries).
+For ease of use, the dictionaries have a version and file format.
+
+It's easy to download dictionary files with CLI. In your package.json add script:
+
+```json
+"scripts": {
+  "get-dicts": "dictionaries -o {OUTPUT_DIR} -v {VERSION} -t {FILES_TYPE}"
+}
+```
+
+- `VERSION` is the version of downloaded dictionaries. [Find the version you need here](https://github.com/Azuro-protocol/public-config/tree/main/dictionaries).
+- `OUTPUT_DIR` is the directory where to put downloaded files.
+- `FILES_TYPE` is the extension of downloaded files. Accepts `ts`, `js`, `maps`, `arrays`. `maps` and `arrays` are 
+json files with different output format.
+
+```bash
+dictionaries -o ./dist -v 2.0.0 -t ts # will download v2.0.0 typescript files to ./dist directory
+```
+
+
+## Helpers
+
+```js
+import { getMarketKey, getMarketName, getMarketDescription, assembleMarketName, assembleSelectionName } from '@azuro-org/dictionaries'
+```
+
+### Get market name and description
+
+```js
+import { getMarketKey } from '@azuro-org/dictionaries'
+import dictionaries from './path-to-downloaded-dictionaries'
+
+const outcomeId = 1
+const marketKey = getMarketKey(outcomeId, dictionaries)
+```
+
+`getMarketKey(outcomeId, dictionaries)` returns the string key `marketId-gamePeriodId-gameTypeId[-teamPlayerId]` 
+built from the dictionaries related to passed `outcomeId`.
+
+In the example above the result is `1-1-1`.
+
+There are two dictionary files `marketNames.js` and `marketDescriptions.js`. `marketKey` is used to receive market name 
+and description for specific outcome ID.
+
+```
+import dictionaries from './path-to-downloaded-dictionaries'
+
+dictionaries.marketNames['1-1-1'] // "Full Time Result" 
+dictionaries.marketDescriptions['1-1-1'] // "You predict the result..."
+```
+
+**!!! Note that there are no texts for each `outcomeId` !!!**
+
+`marketNames[marketKey]` and `marketDescriptions[marketKey]` may return `undefined`. For `marketName` generation there 
+is other helper `assembleMarketName`. It generates human readable market name based on outcome `marketId`, `gamePeriodId`, 
+`gameTypeId`, `teamPlayerId`.
+
+```
+import { getMarketKey, assembleMarketName } from '@azuro-org/dictionaries'
+import dictionaries from './path-to-downloaded-dictionaries'
+
+const outcomeId = 42
+const marketKey = getMarketKey(outcomeId, dictionaries)
+
+let marketName = dictionaries[marketKey] // undefined
+
+if (!marketName) {
+  marketName = assembleMarketName(outcomeId, dictionaries) // "Whole game - Winner of match Goal"
+}
+```
+
+There are additional 2 sugar helpers:
+
+```js
+import { getMarketName } from '@azuro-org/dictionaries'
+import dictionaries from './path-to-downloaded-dictionaries'
+
+getMarketName(1, dictionaries) // "Full Time Result"
+getMarketName(42, dictionaries) // "Whole game - Winner of match Goal"
+```
+
+```js
+import { getMarketDescription } from '@azuro-org/dictionaries'
+import dictionaries from './path-to-downloaded-dictionaries'
+
+getMarketDescription(1, dictionaries) // "You predict the result..."
+getMarketDescription(42, dictionaries) // undefined. Note that there is no `assemblyMarketDescription` helper.
+```
+
+### Get selection (outcome) name
+
+```js
+import { assembleSelectionName } from '@azuro-org/dictionaries'
+import dictionaries from './dist'
+
+const outcomeId = 1
+const selectionName = assembleSelectionName(outcomeId, dictionaries) // "Yes"
+
+const outcomeId = 4
+const selectionName = assembleSelectionName(outcomeId, dictionaries) // "Team 2 (4.5)"
+```

package/dist/aggregateOutcomesByMarkets.d.ts

@@ -0,0 +1,26 @@
+import { type Dictionaries } from '@azuro-org/dictionaries';
+type Outcome = {
+    conditionId: string;
+    outcomeId: string;
+    selectionName: string;
+    lpAddress: string;
+    coreAddress: string;
+};
+type Markets = {
+    marketName: string;
+    outcomes: Outcome[][];
+}[];
+type Props = {
+    lpAddress: string;
+    coreAddress: string;
+    conditions: {
+        [key: string]: any;
+        outcomes: {
+            [key: string]: any;
+            outcomeId: string;
+        }[];
+    }[];
+    dictionaries: Dictionaries;
+};
+export default function aggregateOutcomesByMarkets(props: Props): Markets;
+export {};

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { default as aggregateOutcomesByMarkets } from './aggregateOutcomesByMarkets';

package/dist/index.es.js

@@ -0,0 +1,78 @@
+import {getMarketKey,getMarketName,assembleSelectionName}from'@azuro-org/dictionaries';function aggregateOutcomesByMarkets(props) {
+    var lpAddress = props.lpAddress, coreAddress = props.coreAddress, conditions = props.conditions, dictionaries = props.dictionaries;
+    // group conditions by marketId
+    var outcomesByMarketKey = {};
+    var result = {};
+    conditions.forEach(function (_a) {
+        var conditionId = _a.conditionId, outcomes = _a.outcomes;
+        outcomes.forEach(function (_a) {
+            var outcomeId = _a.outcomeId;
+            var marketKey = getMarketKey(outcomeId, dictionaries);
+            var marketName = getMarketName(outcomeId, dictionaries);
+            var selectionName = assembleSelectionName(outcomeId, dictionaries);
+            var outcome = {
+                conditionId: conditionId,
+                outcomeId: outcomeId,
+                selectionName: selectionName,
+                lpAddress: lpAddress,
+                coreAddress: coreAddress,
+            };
+            // it's important to use "marketKey" because it's unique
+            // on other hand "marketId" can be same for different groups of conditions
+            // "marketKey" is a string template "marketId-gamePeriodId-gameTypeId[-teamPlayerId]"
+            if (!outcomesByMarketKey[marketKey]) {
+                outcomesByMarketKey[marketKey] = [];
+                result[marketKey] = {
+                    marketName: marketName,
+                    outcomes: [],
+                };
+            }
+            outcomesByMarketKey[marketKey].push(outcome);
+        });
+    });
+    // sort by outcomeId and group by conditionId
+    Object.keys(outcomesByMarketKey).forEach(function (marketKey) {
+        var marketId = +marketKey.split('-')[0];
+        // get outcomes related to the market
+        var outcomes = outcomesByMarketKey[marketKey];
+        // sort the conditions by selectionId (outcome)
+        outcomes.sort(function (a, b) {
+            var left = dictionaries.outcomes[a.outcomeId].selectionId;
+            var right = dictionaries.outcomes[b.outcomeId].selectionId;
+            return left - right;
+        });
+        // markets with different conditionIds and not require additional grouping or sorting
+        var marketsWithDifferentConditionIds = [1, 2];
+        if (marketsWithDifferentConditionIds.includes(marketId)) {
+            result[marketKey].outcomes = [outcomes];
+        }
+        // group by conditionId to allow draw outcomes by rows in UI, e.g.
+        //
+        // Team 1 - Total Goals:
+        // Over (1.5)   Under (1.5)
+        // Over (0.5)   Under (0.5)
+        else {
+            var outcomesByConditionId_1 = {};
+            outcomes.forEach(function (outcome) {
+                var key = outcome.conditionId;
+                if (!outcomesByConditionId_1[key]) {
+                    outcomesByConditionId_1[key] = [];
+                }
+                outcomesByConditionId_1[key].push(outcome);
+            });
+            var outcomesArr = Object.values(outcomesByConditionId_1);
+            result[marketKey].outcomes = outcomesArr.sort(function (a, b) {
+                var aSum = a.reduce(function (acc, _a) {
+                    var outcomeId = _a.outcomeId;
+                    return acc + +outcomeId;
+                }, 0);
+                var bSum = b.reduce(function (acc, _a) {
+                    var outcomeId = _a.outcomeId;
+                    return acc + +outcomeId;
+                }, 0);
+                return aSum - bSum;
+            });
+        }
+    });
+    return Object.values(result);
+}export{aggregateOutcomesByMarkets};

package/lib/aggregateOutcomesByMarkets.d.ts

@@ -0,0 +1,26 @@
+import { type Dictionaries } from '@azuro-org/dictionaries';
+type Outcome = {
+    conditionId: string;
+    outcomeId: string;
+    selectionName: string;
+    lpAddress: string;
+    coreAddress: string;
+};
+type Markets = {
+    marketName: string;
+    outcomes: Outcome[][];
+}[];
+type Props = {
+    lpAddress: string;
+    coreAddress: string;
+    conditions: {
+        [key: string]: any;
+        outcomes: {
+            [key: string]: any;
+            outcomeId: string;
+        }[];
+    }[];
+    dictionaries: Dictionaries;
+};
+export default function aggregateOutcomesByMarkets(props: Props): Markets;
+export {};

package/lib/index.d.ts

@@ -0,0 +1 @@
+export { default as aggregateOutcomesByMarkets } from './aggregateOutcomesByMarkets';

package/lib/index.js

@@ -0,0 +1,78 @@
+'use strict';Object.defineProperty(exports,'__esModule',{value:true});var dictionaries=require('@azuro-org/dictionaries');function aggregateOutcomesByMarkets(props) {
+    var lpAddress = props.lpAddress, coreAddress = props.coreAddress, conditions = props.conditions, dictionaries$1 = props.dictionaries;
+    // group conditions by marketId
+    var outcomesByMarketKey = {};
+    var result = {};
+    conditions.forEach(function (_a) {
+        var conditionId = _a.conditionId, outcomes = _a.outcomes;
+        outcomes.forEach(function (_a) {
+            var outcomeId = _a.outcomeId;
+            var marketKey = dictionaries.getMarketKey(outcomeId, dictionaries$1);
+            var marketName = dictionaries.getMarketName(outcomeId, dictionaries$1);
+            var selectionName = dictionaries.assembleSelectionName(outcomeId, dictionaries$1);
+            var outcome = {
+                conditionId: conditionId,
+                outcomeId: outcomeId,
+                selectionName: selectionName,
+                lpAddress: lpAddress,
+                coreAddress: coreAddress,
+            };
+            // it's important to use "marketKey" because it's unique
+            // on other hand "marketId" can be same for different groups of conditions
+            // "marketKey" is a string template "marketId-gamePeriodId-gameTypeId[-teamPlayerId]"
+            if (!outcomesByMarketKey[marketKey]) {
+                outcomesByMarketKey[marketKey] = [];
+                result[marketKey] = {
+                    marketName: marketName,
+                    outcomes: [],
+                };
+            }
+            outcomesByMarketKey[marketKey].push(outcome);
+        });
+    });
+    // sort by outcomeId and group by conditionId
+    Object.keys(outcomesByMarketKey).forEach(function (marketKey) {
+        var marketId = +marketKey.split('-')[0];
+        // get outcomes related to the market
+        var outcomes = outcomesByMarketKey[marketKey];
+        // sort the conditions by selectionId (outcome)
+        outcomes.sort(function (a, b) {
+            var left = dictionaries$1.outcomes[a.outcomeId].selectionId;
+            var right = dictionaries$1.outcomes[b.outcomeId].selectionId;
+            return left - right;
+        });
+        // markets with different conditionIds and not require additional grouping or sorting
+        var marketsWithDifferentConditionIds = [1, 2];
+        if (marketsWithDifferentConditionIds.includes(marketId)) {
+            result[marketKey].outcomes = [outcomes];
+        }
+        // group by conditionId to allow draw outcomes by rows in UI, e.g.
+        //
+        // Team 1 - Total Goals:
+        // Over (1.5)   Under (1.5)
+        // Over (0.5)   Under (0.5)
+        else {
+            var outcomesByConditionId_1 = {};
+            outcomes.forEach(function (outcome) {
+                var key = outcome.conditionId;
+                if (!outcomesByConditionId_1[key]) {
+                    outcomesByConditionId_1[key] = [];
+                }
+                outcomesByConditionId_1[key].push(outcome);
+            });
+            var outcomesArr = Object.values(outcomesByConditionId_1);
+            result[marketKey].outcomes = outcomesArr.sort(function (a, b) {
+                var aSum = a.reduce(function (acc, _a) {
+                    var outcomeId = _a.outcomeId;
+                    return acc + +outcomeId;
+                }, 0);
+                var bSum = b.reduce(function (acc, _a) {
+                    var outcomeId = _a.outcomeId;
+                    return acc + +outcomeId;
+                }, 0);
+                return aSum - bSum;
+            });
+        }
+    });
+    return Object.values(result);
+}exports.aggregateOutcomesByMarkets=aggregateOutcomesByMarkets;

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@azuro-org/toolkit",
+  "version": "0.1.0",
+  "description": "Set of helpers to work with Azuro protocol",
+  "module": "dist/index.es.js",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "dev": "rollup -cw",
+    "build": "rimraf ./dist && rimraf ./lib && rollup -c --compact",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "azuro",
+    "azuro-protocol",
+    "toolkit",
+    "helpers"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Azuro-protocol/toolkit.git"
+  },
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/Azuro-protocol/toolkit/issues"
+  },
+  "homepage": "https://github.com/Azuro-protocol/toolkit/packages/toolkit#readme",
+  "peerDependencies": {
+    "@azuro-org/dictionaries": "^1.0.5"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.17.0",
+    "@rollup/plugin-babel": "^6.0.3",
+    "@rollup/plugin-commonjs": "^23.0.3",
+    "@rollup/plugin-json": "^4.1.0",
+    "@types/node": "^17.0.21",
+    "builtin-modules": "^3.3.0",
+    "minimist": "^1.2.7",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.67.0",
+    "rollup-plugin-babel": "^4.4.0",
+    "rollup-plugin-typescript2": "^0.34.1",
+    "tslib": "^2.4.1",
+    "typescript": "^4.6.2"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "lib": [ "es2017", "es7", "es6", "dom" ],
+    "outDir": "lib",
+    "jsx": "react",
+    "strict": true,
+    "declaration": true,
+    "declarationDir": ".",
+    "esModuleInterop": true
+  },
+  "exclude": [
+    "node_modules",
+    "dist",
+    "lib"
+  ]
+}