@xyo-network/plugins 2.79.8 → 2.80.3

package/README.md

@@ -1,13 +1,94 @@
 [![logo][]](https://xyo.network)
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
+# plugins
+
+[![main-build][]][main-build-link]
+[![npm-badge][]][npm-link]
+[![codacy-badge][]][codacy-link]
+[![codeclimate-badge][]][codeclimate-link]
+[![snyk-badge][]][snyk-link]
+[![license-badge][]][license-link]
+
+> The XYO Foundation provides this source code in our efforts to
+> advance the understanding of the XYO Protocol and its possible uses.
+> We continue to maintain this software in the interest of developer education.
+
+## Table of Contents
+-   [Title](#plugins)
+-   [Table of Contents](#table-of-contents)
+-   [Description](#description)
+-   [Install](#install)
+-   [Maintainers](#maintainers)
+-   [License](#license)
+-   [Credits](#credits)
+
+## Description
+
+> 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
+
+Using npm:
+
+```sh
+npm i --save @xyo-network/plugins
+```
+
+Using yarn:
+
+```sh
+yarn add @xyo-network/plugins
+```
+
+## Building the sdk locally
+
+First clone the repo to your local computer.  Once you have done that, from
+inside the folder where it was cloned, these are some commands you can do.
+
+See list of XY scripts.
+
+```sh
+yarn xy help
+```
+
+Compile the mono repo
+
+```sh
+yarn xy compile
+```
+
+## Maintainers
+
+-   [Arie Trouw](https://github.com/arietrouw) [(arietrouw.com)](https://arietrouw.com)
+-   [Matt Jones](https://github.com/jonesmac)
+-   [Joel Carter](https://github.com/JoelBCarter)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+> See the [LICENSE](https://raw.githubusercontent.com/XYOracleNetwork/plugins/main/LICENSE)
+> file for license details
 
 ## Credits
 
 [Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+
+[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/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/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/plugins/maintainability
+
+[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/plugins
+[license-link]: https://github.com/XYOracleNetwork/plugins/blob/main/LICENSE

package/babel.config.json

@@ -0,0 +1,6 @@
+{
+    "presets": [
+        ["@babel/preset-env", { "modules": false, "targets": { "node": "current" } }],
+        "@babel/preset-typescript"
+    ]
+}

package/dist/node/index.cjs

@@ -0,0 +1,27 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+module.exports = __toCommonJS(src_exports);
+__reExport(src_exports, require("@xyo-network/payload-plugins"), module.exports);
+__reExport(src_exports, require("@xyo-network/payloadset-plugins"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("@xyo-network/payload-plugins"),
+  ...require("@xyo-network/payloadset-plugins")
+});
+//# sourceMappingURL=index.cjs.map

package/dist/node/{index.mjs.map → index.cjs.map}

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from '@xyo-network/payload-plugins'\nexport * from '@xyo-network/payloadset-plugins'\n"],"mappings":";AAAA,cAAc;AACd,cAAc;","names":[]}
+{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from '@xyo-network/payload-plugins'\nexport * from '@xyo-network/payloadset-plugins'\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA,wBAAc,yCAAd;AACA,wBAAc,4CADd;","names":[]}

package/dist/node/index.js

@@ -1,27 +1,4 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
 // src/index.ts
-var src_exports = {};
-module.exports = __toCommonJS(src_exports);
-__reExport(src_exports, require("@xyo-network/payload-plugins"), module.exports);
-__reExport(src_exports, require("@xyo-network/payloadset-plugins"), module.exports);
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ...require("@xyo-network/payload-plugins"),
-  ...require("@xyo-network/payloadset-plugins")
-});
+export * from "@xyo-network/payload-plugins";
+export * from "@xyo-network/payloadset-plugins";
 //# sourceMappingURL=index.js.map

package/dist/node/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from '@xyo-network/payload-plugins'\nexport * from '@xyo-network/payloadset-plugins'\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA,wBAAc,yCAAd;AACA,wBAAc,4CADd;","names":[]}
+{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from '@xyo-network/payload-plugins'\nexport * from '@xyo-network/payloadset-plugins'\n"],"mappings":";AAAA,cAAc;AACd,cAAc;","names":[]}

package/jest.config.ts

@@ -0,0 +1,31 @@
+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', './jestSetup/setupFiles.ts'],
+    testRegex: '(/__tests__/.*|(\\.|/)((!perf\\.)test|spec))\\.tsx?$',
+    testTimeout: 200000,
+    transform: {
+      [`(${esModulesList}).+\\.js$`]: 'babel-jest',
+      '^.+\\.tsx?$': [
+        'ts-jest',
+        {
+          tsconfig: 'tsconfig.test.json',
+        },
+      ],
+    },
+    transformIgnorePatterns: [`./node_modules/(?!${esModulesList})`],
+  }
+}
+
+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,19 +7,54 @@
   },
   "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.79.8",
-    "@xyo-network/payloadset-plugins": "~2.79.8"
+    "@xyo-network/payload-plugins": "~2.80.3",
+    "@xyo-network/payloadset-plugins": "~2.80.3"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^3.1.21",
-    "@xylabs/tsconfig": "^3.1.21",
+    "@babel/core": "^7.23.3",
+    "@babel/preset-env": "^7.23.3",
+    "@babel/preset-typescript": "^7.23.3",
+    "@types/jest": "^29.5.8",
+    "@types/supertest": "^2.0.16",
+    "@typescript-eslint/eslint-plugin": "^6.11.0",
+    "@typescript-eslint/parser": "^6.11.0",
+    "@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",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-deprecation": "^2.0.0",
+    "eslint-plugin-import": "^2.29.0",
+    "jest": "^29.7.0",
+    "jest-docblock": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "jest-extended": "^4.0.2",
+    "jest-runner": "^29.7.0",
+    "jest-runner-groups": "^2.2.0",
+    "jest-sorted": "^1.0.14",
+    "nodemon": "^3.0.1",
+    "reflect-metadata": "^0.1.13",
+    "supertest": "^6.3.3",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
     "typescript": "^5.2.2"
   },
-  "description": "Primary SDK for using XYO Protocol 2.0",
-  "docs": "dist/docs.json",
+  "resolutions": {
+    "axios": "^1",
+    "bn.js": "^5",
+    "quick-lru": "^5"
+  },
+  "description": "Typescript/Javascript Plugins for XYO Platform",
   "exports": {
     ".": {
       "browser": {
@@ -34,19 +69,20 @@
       },
       "node": {
         "require": {
-          "types": "./dist/node/index.d.ts",
-          "default": "./dist/node/index.js"
+          "types": "./dist/node/index.d.cts",
+          "default": "./dist/node/index.cjs"
         },
         "import": {
           "types": "./dist/node/index.d.mts",
-          "default": "./dist/node/index.mjs"
+          "default": "./dist/node/index.js"
         }
       }
     },
     "./package.json": "./package.json"
   },
-  "main": "dist/node/index.js",
-  "module": "dist/node/index.mjs",
+  "main": "dist/node/index.cjs",
+  "module": "dist/node/index.js",
+  "types": "dist/node/index.d.ts",
   "homepage": "https://xyo.network",
   "license": "LGPL-3.0-only",
   "publishConfig": {
@@ -54,9 +90,24 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+    "url": "https://github.com/XYOracleNetwork/plugins.git"
+  },
+  "scripts": {
+    "coverage": "yarn jest --coverage --forceExit",
+    "compile": "./scripts/clear-scrollback-buffer.sh && yarn xy compile",
+    "build": "xy build && xy statics",
+    "deploy": "xy deploy",
+    "lint-pkg": "npmPkgJsonLint .",
+    "test-esm": "node $(yarn jest --no-cache --forceExit)",
+    "test": "jest --no-cache --forceExit",
+    "build-typedoc-site": "xy gen-docs @xyo-network/plugins"
   },
   "sideEffects": false,
-  "types": "dist/node/index.d.ts",
-  "version": "2.79.8"
+  "version": "2.80.3",
+  "packageManager": "yarn@4.0.2",
+  "volta": {
+    "node": "18.17.1",
+    "yarn": "1.22.19"
+  },
+  "type": "module"
 }

package/scripts/clear-scrollback-buffer.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+clear
+printf '\e[3J'

package/typedoc.json

@@ -1,5 +1,10 @@
 {
   "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["./src/index.ts"],
+  "entryPointStrategy": "packages",
+  "entryPoints": [
+    "**/packages/*"
+  ],
+  "includeVersion": true,
+  "name": "XYO Plugins",
   "tsconfig": "./tsconfig.typedoc.json"
 }

package/dist/node/index.mjs

@@ -1,4 +0,0 @@
-// src/index.ts
-export * from "@xyo-network/payload-plugins";
-export * from "@xyo-network/payloadset-plugins";
-//# sourceMappingURL=index.mjs.map