@xyo-network/plugins 2.80.0 → 2.80.4

package/README.md

@@ -1,6 +1,6 @@
 [![logo][]](https://xyo.network)
 
-# sdk-xyo-client-js
+# plugins
 
 [![main-build][]][main-build-link]
 [![npm-badge][]][npm-link]
@@ -14,7 +14,7 @@
 > We continue to maintain this software in the interest of developer education.
 
 ## Table of Contents
--   [Title](#sdk-xyo-client-js)
+-   [Title](#plugins)
 -   [Table of Contents](#table-of-contents)
 -   [Description](#description)
 -   [Install](#install)
@@ -24,7 +24,7 @@
 
 ## Description
 
-> Primary SDK for using the XYO Protocol 2.0 from TypeScript/JavaScript.
+> Plugins (Witnesses, Diviners, etc...) to be used with the XYO Platform
 > Designed to work in both browser based and Node JS based solutions.
 
 ## Use the sdk in another project
@@ -32,13 +32,13 @@
 Using npm:
 
 ```sh
-npm i --save @xyo-network/sdk-xyo-client-js
+npm i --save @xyo-network/plugins
 ```
 
 Using yarn:
 
 ```sh
-yarn add @xyo-network/sdk-xyo-client-js
+yarn add @xyo-network/plugins
 ```
 
 ## Building the sdk locally
@@ -66,7 +66,7 @@ yarn xy compile
 
 ## License
 
-> See the [LICENSE](https://raw.githubusercontent.com/XYOracleNetwork/sdk-xyo-client-js/main/LICENSE)
+> See the [LICENSE](https://raw.githubusercontent.com/XYOracleNetwork/plugins/main/LICENSE)
 > file for license details
 
 ## Credits
@@ -75,20 +75,20 @@ yarn xy compile
 
 [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
 
-[main-build]: https://github.com/XYOracleNetwork/sdk-xyo-client-js/actions/workflows/build.yml/badge.svg
-[main-build-link]: https://github.com/XYOracleNetwork/sdk-xyo-client-js/actions/workflows/build.yml
+[main-build]: https://github.com/XYOracleNetwork/plugins/actions/workflows/build.yml/badge.svg
+[main-build-link]: https://github.com/XYOracleNetwork/plugins/actions/workflows/build.yml
 
-[npm-badge]: https://img.shields.io/npm/v/@xyo-network/sdk-xyo-client-js.svg
-[npm-link]: https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/plugins.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/plugins
 
 [codacy-badge]: https://app.codacy.com/project/badge/Grade/ba1f344ae34e4bfe999331cf4e27b9f5
-[codacy-link]: https://www.codacy.com/gh/XYOracleNetwork/sdk-xyo-client-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=XYOracleNetwork/sdk-xyo-client-js&utm_campaign=Badge_Grade
+[codacy-link]: https://www.codacy.com/gh/XYOracleNetwork/plugins/dashboard?utm_source=github.com&utm_medium=referral&utm_content=XYOracleNetwork/plugins&utm_campaign=Badge_Grade
 
 [codeclimate-badge]: https://api.codeclimate.com/v1/badges/0e76349c9541f3866948/maintainability
-[codeclimate-link]: https://codeclimate.com/github/XYOracleNetwork/sdk-xyo-client-js/maintainability
+[codeclimate-link]: https://codeclimate.com/github/XYOracleNetwork/plugins/maintainability
 
-[snyk-badge]: https://snyk.io/test/github/XYOracleNetwork/sdk-xyo-client-js/badge.svg?targetFile=package.json
-[snyk-link]: https://snyk.io/test/github/XYOracleNetwork/sdk-xyo-client-js?targetFile=package.json
+[snyk-badge]: https://snyk.io/test/github/XYOracleNetwork/plugins/badge.svg?targetFile=package.json
+[snyk-link]: https://snyk.io/test/github/XYOracleNetwork/plugins?targetFile=package.json
 
-[license-badge]: https://img.shields.io/github/license/XYOracleNetwork/sdk-xyo-client-js
-[license-link]: https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/main/LICENSE
+[license-badge]: https://img.shields.io/github/license/XYOracleNetwork/plugins
+[license-link]: https://github.com/XYOracleNetwork/plugins/blob/main/LICENSE

package/jest.config.ts

@@ -2,12 +2,14 @@ const generateJestConfig = ({ esModules }: { esModules: string[] }) => {
   const esModulesList = Array.isArray(esModules) ? esModules.join('|') : esModules
   return {
     coveragePathIgnorePatterns: ['<rootDir>/(.*)/dist'],
+    globalSetup: './jestSetup/globalSetup.ts',
+    globalTeardown: './jestSetup/globalTeardown.ts',
     moduleNameMapper: {
       '^(\\.{1,2}/.*)\\.js$': '$1',
     },
     preset: 'ts-jest/presets/default-esm',
     setupFiles: ['dotenv/config'],
-    setupFilesAfterEnv: ['jest-sorted', 'jest-extended/all'],
+    setupFilesAfterEnv: ['jest-sorted', 'jest-extended/all', './jestSetup/setupFiles.ts'],
     testRegex: '(/__tests__/.*|(\\.|/)((!perf\\.)test|spec))\\.tsx?$',
     testTimeout: 200000,
     transform: {
@@ -23,7 +25,7 @@ const generateJestConfig = ({ esModules }: { esModules: string[] }) => {
   }
 }
 
-const config = generateJestConfig({ esModules: ['is-ip', 'ip-regex', 'lodash-es', 'uuid', 'lodash-es'] })
+const config = generateJestConfig({ esModules: ['is-ip', 'ip-regex', 'lodash-es', 'uuid', 'lodash-es', 'quick-lru'] })
 
 // eslint-disable-next-line import/no-default-export
 export default config

package/jestSetup/globalSetup.ts

@@ -0,0 +1,16 @@
+/* eslint-disable no-var */
+import { config } from 'dotenv'
+config()
+import { Config } from 'jest'
+import { SuperTest, Test } from 'supertest'
+
+// Augment global scope with shared variables (must be var)
+declare global {
+  var req: SuperTest<Test>
+}
+
+/**
+ * Jest global setup method runs before any tests are run
+ * https://jestjs.io/docs/configuration#globalsetup-string
+ */
+module.exports = async (_globalConfig: Config, _projectConfig: Config) => {}

package/jestSetup/globalTeardown.ts

@@ -0,0 +1,9 @@
+import { config } from 'dotenv'
+config()
+import { Config } from 'jest'
+
+/**
+ * Jest global teardown method runs after all tests are run
+ * https://jestjs.io/docs/configuration#globalteardown-string
+ */
+module.exports = async (_globalConfig: Config, _projectConfig: Config) => {}

package/jestSetup/setupFiles.ts

@@ -0,0 +1,10 @@
+import { ForgetPromise } from '@xylabs/forget'
+
+beforeAll(() => {
+  // Can be async, before each test file
+})
+
+afterAll(async () => {
+  // Can be async, after each test file
+  await ForgetPromise.awaitInactive()
+})

package/package.json

@@ -7,14 +7,14 @@
   },
   "bugs": {
     "email": "support@xyo.network",
-    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+    "url": "https://github.com/XYOracleNetwork/plugins/issues"
   },
   "workspaces": [
     "packages/**/*"
   ],
   "dependencies": {
-    "@xyo-network/payload-plugins": "~2.80.0",
-    "@xyo-network/payloadset-plugins": "~2.80.0"
+    "@xyo-network/payload-plugins": "~2.80.4",
+    "@xyo-network/payloadset-plugins": "~2.80.4"
   },
   "devDependencies": {
     "@babel/core": "^7.23.3",
@@ -24,10 +24,11 @@
     "@types/supertest": "^2.0.16",
     "@typescript-eslint/eslint-plugin": "^6.11.0",
     "@typescript-eslint/parser": "^6.11.0",
-    "@xylabs/eslint-config": "^3.1.21",
-    "@xylabs/ts-scripts-yarn3": "^3.1.21",
-    "@xylabs/tsconfig": "^3.1.21",
-    "@xylabs/tsconfig-dom-jest": "^3.1.21",
+    "@xylabs/eslint-config": "^3.2.2",
+    "@xylabs/forget": "^2.13.9",
+    "@xylabs/ts-scripts-yarn3": "^3.2.2",
+    "@xylabs/tsconfig": "^3.2.2",
+    "@xylabs/tsconfig-dom-jest": "^3.2.2",
     "babel-jest": "^29.7.0",
     "dotenv": "^16.3.1",
     "eslint": "^8.53.0",
@@ -48,7 +49,12 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.2.2"
   },
-  "description": "Primary SDK for using XYO Protocol 2.0",
+  "resolutions": {
+    "axios": "^1",
+    "bn.js": "^5",
+    "quick-lru": "^5"
+  },
+  "description": "Typescript/Javascript Plugins for XYO Platform",
   "exports": {
     ".": {
       "browser": {
@@ -97,8 +103,8 @@
     "build-typedoc-site": "xy gen-docs @xyo-network/plugins"
   },
   "sideEffects": false,
-  "version": "2.80.0",
-  "packageManager": "yarn@3.6.3",
+  "version": "2.80.4",
+  "packageManager": "yarn@4.0.2",
   "volta": {
     "node": "18.17.1",
     "yarn": "1.22.19"