@xyo-network/sdk-js 3.12.4 → 3.13.0

package/README.md

@@ -33,13 +33,13 @@
 Using npm:
 
 ```sh
-npm i --save @xyo-network/sdk-xyo-client-js
+npm i --save @xyo-network/sdk-js
 ```
 
 Using yarn:
 
 ```sh
-yarn add @xyo-network/sdk-xyo-client-js
+yarn add @xyo-network/sdk-js
 ```
 
 ## Packages
@@ -82,8 +82,8 @@ yarn xy compile
 [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
 
-[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/sdk-js.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/sdk-js
 
 [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

package/eslint.config.mjs

@@ -8,7 +8,7 @@ import {
 } from '@xylabs/eslint-config-flat'
 
 export default [
-  { ignores: ['dist', '**/packages/*/dist', '.yarn', 'node_modules', '**/packages/*/node_modules', 'docs'] },
+  { ignores: ['dist', '**/packages/*/dist', '.yarn', 'node_modules', '**/packages/*/node_modules', 'docs', '.dependency-cruiser.mjs'] },
   unicornConfig,
   workspacesConfig,
   rulesConfig,

package/knip.config.ts

@@ -1,22 +1,43 @@
 import type { KnipConfig } from 'knip'
 
+const entry = ['src/index.ts*', 'src/index-*.ts*', '*.ts', '*.mjs', 'scripts/**/*.*', 'bin/*', 'src/**/*.stories.ts*', 'src/**/*.spec.ts']
+const project = ['src/**/*.ts*', '*.ts*']
+
 const config: KnipConfig = {
-  entry: ['src/index.ts', 'src/index-*.ts'],
-  project: ['src/**/*.ts'],
-  ignore: ['xy.config.ts'],
-  ignoreDependencies: [
-    '@xylabs/ts-scripts-yarn3',
+  entry: [
+    'src/index.ts*',
+    'src/index-*.ts*',
+    '*.ts',
+    '*.mjs',
+    'scripts/**/*.*',
+    'bin/*',
+    'src/**/*.stories.ts*',
+    'src/**/*.spec.ts',
   ],
+  project: ['src/**/*.ts*', '*.ts*'],
+  ignoreDependencies: ['@xylabs/ts-scripts-yarn3', 'tslib'],
   workspaces: {
     '.': {
+      entry: [...entry, 'src/**/*.ts', './storybook/**/*.ts', 'vite.config.ts'],
+      project,
       ignoreDependencies: [
-        'eslint',
         '@typescript-eslint/eslint-plugin',
-        'eslint-import-resolver-typescript',
-        'reflect-metadata',
         '@typescript-eslint/parser',
+        'eslint',
+        'eslint-import-resolver-typescript',
       ],
     },
+    'packages/*': { entry, project },
+    'packages/*/packages/*': { entry, project },
+    'packages/*/packages/packages/*': { entry, project },
+    'packages/*/packages/*/packages/*': { entry, project },
+    'packages/*/packages/*/packages/*/packages/*': { entry, project },
+  },
+  typescript: {
+    config: [
+      'tsconfig.json',
+      'packages/**/*/tsconfig.json',
+    ],
   },
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/sdk-js",
-  "version": "3.12.4",
+  "version": "3.13.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -38,6 +38,7 @@
     "build-typedoc-site": "typedoc",
     "compile": "./scripts/clear-scrollback-buffer.sh && yarn xy compile",
     "coverage": "vitest --coverage --watch false",
+    "cycle": "node ./scripts/run-cycle.mjs",
     "deploy": "xy deploy",
     "free-3033": "kill -9 $(lsof -t -i :3033)",
     "free-8080": "kill -9 $(lsof -t -i :8080)",
@@ -54,39 +55,40 @@
     "quick-lru": "^4"
   },
   "dependencies": {
-    "@xyo-network/core-payload-plugins": "^3.12.4",
-    "@xyo-network/manifest": "^3.12.4",
-    "@xyo-network/modules": "^3.12.4",
-    "@xyo-network/protocol": "^3.12.4",
-    "@xyo-network/sdk-utils": "^3.12.4",
-    "@xyo-network/shared": "^3.12.4"
+    "@xyo-network/core-payload-plugins": "^3.13.0",
+    "@xyo-network/manifest": "^3.13.0",
+    "@xyo-network/modules": "^3.13.0",
+    "@xyo-network/protocol": "^3.13.0",
+    "@xyo-network/sdk-utils": "^3.13.0",
+    "@xyo-network/shared": "^3.13.0"
   },
   "devDependencies": {
     "@firebase/app": "^0.11.4",
     "@firebase/app-compat": "^0.2.53",
     "@stylistic/eslint-plugin": "^4.2.0",
     "@types/supertest": "^6.0.3",
-    "@typescript-eslint/eslint-plugin": "^8.29.1",
-    "@typescript-eslint/parser": "^8.29.1",
-    "@vitest/coverage-v8": "^3.1.1",
-    "@xylabs/eslint-config-flat": "^6.2.1",
-    "@xylabs/forget": "^4.8.4",
-    "@xylabs/ts-scripts-yarn3": "^6.2.1",
-    "@xylabs/tsconfig": "^6.2.1",
-    "@xylabs/vitest-extended": "^4.8.4",
+    "@typescript-eslint/eslint-plugin": "^8.31.0",
+    "@typescript-eslint/parser": "^8.31.0",
+    "@vitest/coverage-v8": "^3.1.2",
+    "@xylabs/eslint-config-flat": "^6.3.4",
+    "@xylabs/forget": "^4.8.7",
+    "@xylabs/ts-scripts-yarn3": "^6.3.4",
+    "@xylabs/tsconfig": "^6.3.4",
+    "@xylabs/vitest-extended": "^4.8.7",
+    "dependency-cruiser": "^16.10.1",
     "dotenv": "^16.5.0",
-    "eslint": "^9.24.0",
-    "eslint-import-resolver-typescript": "^4.3.2",
-    "jsdom": "^26.0.0",
-    "knip": "^5.50.2",
+    "eslint": "^9.25.1",
+    "eslint-import-resolver-typescript": "^4.3.4",
+    "jsdom": "^26.1.0",
+    "knip": "^5.50.5",
     "reflect-metadata": "^0.2.2",
     "rimraf": "^6.0.1",
     "supertest": "^7.1.0",
     "tslib": "^2.8.1",
-    "typedoc": "^0.28.2",
+    "typedoc": "^0.28.3",
     "typedoc-plugin-markdown": "^4.6.2",
     "typescript": "^5.8.3",
-    "vitest": "^3.1.1"
+    "vitest": "^3.1.2"
   },
   "packageManager": "yarn@4.9.1",
   "volta": {

package/scripts/run-cycle.mjs

@@ -0,0 +1,71 @@
+#!/usr/bin/env node
+
+import { cruise } from 'dependency-cruiser'
+import { spawnSync } from 'node:child_process'
+
+export const yarnWorkspaces = () => {
+  const result = spawnSync('yarn', ['workspaces', 'list', '--json', '--recursive'], { encoding: 'utf8', shell: true })
+  if (result.error) {
+    throw result.error
+  }
+  return (
+    result.stdout
+      .toString()
+      // NOTE: This probably doesn't work on Windows
+      // TODO: Replace /r/n with /n first
+      .split('\n')
+      .slice(0, -1)
+      .map((item) => {
+        return JSON.parse(item)
+      })
+  )
+}
+
+export const cycleAll = async () => {
+  const pkgName = process.env.npm_package_name
+
+  const cruiseOptions = {
+    ruleSet: {
+      forbidden: [
+        {
+          name: 'no-circular',
+          severity: 'error',
+          comment: 'This dependency creates a circular reference',
+          from: {},
+          to: { circular: true },
+        },
+      ],
+    },
+    exclude: 'node_modules|packages/.*/packages',
+    validate: true,
+    doNotFollow: { path: 'node_modules|packages/.*/packages' },
+    tsPreCompilationDeps: false,
+    combinedDependencies: true,
+    outputType: 'err',
+  }
+
+  const packages = yarnWorkspaces()
+  const targets = packages.map(({ location }) => `${location}/src/**`)
+
+  console.log('Checking for circular dependencies in packages...')
+
+  const result = await cruise(targets, cruiseOptions)
+  if (result.output) {
+    console.log(result.output)
+  }
+
+  if (result.exitCode === 0) {
+    console.log(`${pkgName} ✅ No dependency violations`)
+  } else {
+    console.error(`${pkgName} ❌ Dependency violations found`)
+  }
+  return result.exitCode
+}
+
+cycleAll().then(() => {
+  console.log('Exiting with code 0')
+  process.exit(0)
+}).catch((error) => {
+  console.error('Error while checking for circular dependencies:', error)
+  process.exit(1)
+})

package/typedoc.config.mjs

@@ -1,14 +0,0 @@
-const config = {
-  entryPointStrategy: 'packages',
-  entryPoints: ['.', 'packages/**'],
-  out: 'docs',
-  plugin: ['typedoc-plugin-markdown'],
-  exclude: ['**/docs/**', '**/spec/**', '**/*.spec.*', '**/*.d.ts'],
-  excludeExternals: true,
-  excludePrivate: true,
-  excludeProtected: true,
-  includeVersion: true,
-  packageOptions: { entryPoints: ['src/index*.ts*'] },
-}
-
-export default config