@xylabs/sdk-js 2.3.6 → 2.3.7

package/README.md

@@ -12,12 +12,17 @@
 
 ## Table of Contents
 
-- [Description](#description)
-- [Install](#install)
-- [Scripts](#scripts)
-- [Maintainers](#maintainers)
-- [License](#license)
-- [Credits](#credits)
+- [@xylabs/sdk-js](#xylabssdk-js)
+  - [Table of Contents](#table-of-contents)
+  - [Description](#description)
+  - [Install](#install)
+  - [Common Scripts](#common-scripts)
+  - [Custom Scripts](#custom-scripts)
+    - [Start](#start)
+    - [Lint](#lint)
+  - [Maintainers](#maintainers)
+  - [License](#license)
+  - [Credits](#credits)
 
 ## Description
 
@@ -27,45 +32,41 @@ SDK for base code for Typescript and Javascript Libraries.
 
 Using npm:
 
-```
+```sh
 $ npm i --save @xylabs/sdk-js
 ```
 
 Using yarn:
 
-```
+```sh
 $ yarn add @xylabs/sdk-js
 ```
 
-## Scripts
+## Common Scripts
 
-### Build
-Builds the project as if it will be deployed
-```
-yarn build
-```
+See [ts-scripts](https://github.com/xylabs/ts-scripts/blob/main/README.md) for list of common scripts to build, etc...
+
+## Custom Scripts
 
 ### Start
-Starts the project in the browser for testing, with auto reload
-```
-yarn start
+
+Starts the project in the browser for testing, with auto reload using Storybook
+
+```sh
+$ yarn start
 ```
 
 ### Lint
-Runs the linter (eslint) for the project
-```
-yarn lint
-```
 
-### Dependencies
-Shows a dependency report for the project
-```
-yarn deps
+Upgraded lint for readme, etc...
+
+```sh
+$ yarn eslint .
 ```
 
 ## Maintainers
 
-- [Arie Trouw](https://github.com/arietrouw) (https://arietrouw.com)
+- [Arie Trouw](https://github.com/arietrouw) (<https://arietrouw.com>)
 
 ## License
 
@@ -76,25 +77,17 @@ See the [LICENSE](LICENSE) file for license details
 [Made with 🔥 and ❄️ by XY Labs](https://xylabs.com)
 
 [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
-
 [main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build-main.yml/badge.svg
 [main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build-main.yml
-
 [beta-build]: https://github.com/xylabs/sdk-js/actions/workflows/build-beta.yml/badge.svg
 [beta-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build-beta.yml
-
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/sdk-js.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/sdk-js
-
 [bch-badge]: https://bettercodehub.com/edge/badge/xylabs/sdk-js?branch=main
 [bch-link]: https://bettercodehub.com/results/xylabs/sdk-js
-
 [codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
-
-[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=xylabs/sdk-js&amp;utm_campaign=Badge_Grade
-
+[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
 [codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
 [codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
-
 [snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
 [snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json

package/dist/ApiEndpoint.d.ts

@@ -7,7 +7,7 @@ declare class ApiEndpoint<T> {
     private get url();
     private _value?;
     get value(): T | undefined;
-    get(): Promise<T>;
+    get(): Promise<T | NonNullable<T>>;
     fetch(): Promise<T>;
     insert(value: T): Promise<T>;
 }

package/dist/EthAddress.js

@@ -22,7 +22,7 @@ class EthAddress {
     }
     static fromString(value, base = 16) {
         if (value) {
-            const bn = new BigNumber(value.startsWith('0x') ? value.substr(2) : value, base);
+            const bn = new BigNumber(value.startsWith('0x') ? value.substring(2) : value, base);
             return new EthAddress(bn);
         }
     }

package/dist/EthAddress.js.map

@@ -1 +1 @@
-{"version":3,"file":"EthAddress.js","sourceRoot":"","sources":["../src/EthAddress.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,SAAS,MAAM,aAAa,CAAA;AACnC,OAAO,MAAM,MAAM,UAAU,CAAA;AAE7B,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,GAAqB,EAAE,EAAE,CAAC,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,MAAK,UAAU,CAAC,IAAI,CAAA;AAEpF,MAAM,UAAU;IAOd,YAAoB,OAAkB;QAN/B,SAAI,GAAG,UAAU,CAAC,IAAI,CAAA;QAO3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAEM,MAAM,CAAC,OAAoC;QAChD,IAAI,OAAO,EAAE;YACX,IAAI,SAAqB,CAAA;YACzB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;gBAC/B,SAAS,GAAG,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,CAAA;aACpE;iBAAM;gBACL,SAAS,GAAG,OAAO,CAAA;aACpB;YACD,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;SAC1C;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,KAAc,EAAE,IAAI,GAAG,EAAE;QACzC,IAAI,KAAK,EAAE;YACT,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;YAChF,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAA;SAC1B;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAa;QACxC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;SACpC;IACH,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAEM,QAAQ;QACb,OAAO,KAAK,IAAI,CAAC,KAAK,EAAE,EAAE,CAAA;IAC5B,CAAC;IAEM,iBAAiB;QACtB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,CAAA;IACtC,CAAC;IAEM,MAAM;QACX,OAAO,KAAK,IAAI,CAAC,KAAK,EAAE,EAAE,CAAA;IAC5B,CAAC;IAEM,KAAK;QACV,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;IAC9C,CAAC;IAEM,aAAa,CAAC,MAAM,GAAG,CAAC;QAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,EAAE,CAAA;QACxB,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;QAClC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QACxD,OAAO,KAAK,KAAK,MAAM,KAAK,EAAE,CAAA;IAChC,CAAC;;AAzDM,eAAI,GAAG,YAAY,CAAA;AA4D5B,eAAe,UAAU,CAAA"}
+{"version":3,"file":"EthAddress.js","sourceRoot":"","sources":["../src/EthAddress.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,SAAS,MAAM,aAAa,CAAA;AACnC,OAAO,MAAM,MAAM,UAAU,CAAA;AAE7B,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,GAAqB,EAAE,EAAE,CAAC,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,MAAK,UAAU,CAAC,IAAI,CAAA;AAEpF,MAAM,UAAU;IAOd,YAAoB,OAAkB;QAN/B,SAAI,GAAG,UAAU,CAAC,IAAI,CAAA;QAO3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAEM,MAAM,CAAC,OAAoC;QAChD,IAAI,OAAO,EAAE;YACX,IAAI,SAAqB,CAAA;YACzB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;gBAC/B,SAAS,GAAG,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,CAAA;aACpE;iBAAM;gBACL,SAAS,GAAG,OAAO,CAAA;aACpB;YACD,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;SAC1C;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,KAAc,EAAE,IAAI,GAAG,EAAE;QACzC,IAAI,KAAK,EAAE;YACT,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;YACnF,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAA;SAC1B;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAa;QACxC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;SACpC;IACH,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAEM,QAAQ;QACb,OAAO,KAAK,IAAI,CAAC,KAAK,EAAE,EAAE,CAAA;IAC5B,CAAC;IAEM,iBAAiB;QACtB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,CAAA;IACtC,CAAC;IAEM,MAAM;QACX,OAAO,KAAK,IAAI,CAAC,KAAK,EAAE,EAAE,CAAA;IAC5B,CAAC;IAEM,KAAK;QACV,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;IAC9C,CAAC;IAEM,aAAa,CAAC,MAAM,GAAG,CAAC;QAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,EAAE,CAAA;QACxB,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;QAClC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QACxD,OAAO,KAAK,KAAK,MAAM,KAAK,EAAE,CAAA;IAChC,CAAC;;AAzDM,eAAI,GAAG,YAAY,CAAA;AA4D5B,eAAe,UAAU,CAAA"}

package/jest.config.cjs

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+}

package/package.json

@@ -26,7 +26,7 @@
     "typescript",
     "esm"
   ],
-  "version": "2.3.6",
+  "version": "2.3.7",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -57,12 +57,19 @@
     "axios": "^0.24.0",
     "bn.js": "^5.2.0",
     "eslint": "^8",
+    "eslint-plugin-md": "^1.0.19",
     "jest": "^27.3.1",
+    "markdown-eslint-parser": "^1.2.1",
     "npm-package-json-lint": "^5.4.2",
     "npm-package-json-lint-config-default": "^3.0.0",
     "prettier": "^2.4.1",
+    "remark-cli": "^10.0.1",
+    "remark-lint": "^9.1.0",
+    "remark-preset-lint-markdown-style-guide": "^5.1.1",
+    "remark-preset-lint-recommended": "^6.1.1",
     "rollbar": "^2.24.0",
     "ts-jest": "^27.0.7",
+    "ts-node": "^10.4.0",
     "typescript": "^4"
   }
 }

package/src/EthAddress.spec.ts

@@ -5,6 +5,6 @@ describe('EthAddress', () => {
     const addressString = '7284b6A4233B8B05910F2CbF7dBf6715325F6fCb'.toLowerCase()
     const address = EthAddress.fromString(addressString, 16)
     expect(address?.toString()).toBe(`0x${addressString}`)
-    expect(address?.toShortString()).toBe('0x72...cb}')
+    expect(address?.toShortString()).toBe('0x72...cb')
   })
 })

package/src/EthAddress.ts

@@ -30,7 +30,7 @@ class EthAddress {
 
   static fromString(value?: string, base = 16) {
     if (value) {
-      const bn = new BigNumber(value.startsWith('0x') ? value.substr(2) : value, base)
+      const bn = new BigNumber(value.startsWith('0x') ? value.substring(2) : value, base)
       return new EthAddress(bn)
     }
   }