@xyo-network/sdk-js 3.12.2 → 3.12.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +4 -0
  2. package/eslint.config.mjs +1 -1
  3. package/package.json +16 -13
  4. package/typedoc.config.mjs +14 -0
  5. package/typedoc.json +0 -14
package/README.md CHANGED
@@ -18,6 +18,7 @@
18
18
  - [Table of Contents](#table-of-contents)
19
19
  - [Description](#description)
20
20
  - [Install](#install)
21
+ - [Packages](#packages)
21
22
  - [Maintainers](#maintainers)
22
23
  - [License](#license)
23
24
  - [Credits](#credits)
@@ -41,6 +42,9 @@ Using yarn:
41
42
  yarn add @xyo-network/sdk-xyo-client-js
42
43
  ```
43
44
 
45
+ ## Packages
46
+ List of packages and documentation can be found [here](./packages.md).
47
+
44
48
  ## Building the sdk locally
45
49
 
46
50
  First clone the repo to your local computer. Once you have done that, from
package/eslint.config.mjs CHANGED
@@ -8,7 +8,7 @@ import {
8
8
  } from '@xylabs/eslint-config-flat'
9
9
 
10
10
  export default [
11
- { ignores: ['dist', '**/packages/*/dist', '.yarn', 'node_modules', '**/packages/*/node_modules'] },
11
+ { ignores: ['dist', '**/packages/*/dist', '.yarn', 'node_modules', '**/packages/*/node_modules', 'docs'] },
12
12
  unicornConfig,
13
13
  workspacesConfig,
14
14
  rulesConfig,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/sdk-js",
3
- "version": "3.12.2",
3
+ "version": "3.12.4",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -42,6 +42,8 @@
42
42
  "free-3033": "kill -9 $(lsof -t -i :3033)",
43
43
  "free-8080": "kill -9 $(lsof -t -i :8080)",
44
44
  "free-mongo": "kill -9 $(lsof -t -i :55391) && kill -9 $(lsof -t -i :55393)",
45
+ "package-build": "yarn package-clean && rimraf docs && yarn package-build-only && typedoc && xy statics",
46
+ "package-clean": "rimraf dist",
45
47
  "test": "vitest --watch false"
46
48
  },
47
49
  "resolutions": {
@@ -52,12 +54,12 @@
52
54
  "quick-lru": "^4"
53
55
  },
54
56
  "dependencies": {
55
- "@xyo-network/core-payload-plugins": "^3.12.2",
56
- "@xyo-network/manifest": "^3.12.2",
57
- "@xyo-network/modules": "^3.12.2",
58
- "@xyo-network/protocol": "^3.12.2",
59
- "@xyo-network/sdk-utils": "^3.12.2",
60
- "@xyo-network/shared": "^3.12.2"
57
+ "@xyo-network/core-payload-plugins": "^3.12.4",
58
+ "@xyo-network/manifest": "^3.12.4",
59
+ "@xyo-network/modules": "^3.12.4",
60
+ "@xyo-network/protocol": "^3.12.4",
61
+ "@xyo-network/sdk-utils": "^3.12.4",
62
+ "@xyo-network/shared": "^3.12.4"
61
63
  },
62
64
  "devDependencies": {
63
65
  "@firebase/app": "^0.11.4",
@@ -68,25 +70,25 @@
68
70
  "@typescript-eslint/parser": "^8.29.1",
69
71
  "@vitest/coverage-v8": "^3.1.1",
70
72
  "@xylabs/eslint-config-flat": "^6.2.1",
71
- "@xylabs/forget": "^4.8.1",
73
+ "@xylabs/forget": "^4.8.4",
72
74
  "@xylabs/ts-scripts-yarn3": "^6.2.1",
73
75
  "@xylabs/tsconfig": "^6.2.1",
74
- "@xylabs/vitest-extended": "^4.8.1",
75
- "dotenv": "^16.4.7",
76
+ "@xylabs/vitest-extended": "^4.8.4",
77
+ "dotenv": "^16.5.0",
76
78
  "eslint": "^9.24.0",
77
79
  "eslint-import-resolver-typescript": "^4.3.2",
78
80
  "jsdom": "^26.0.0",
79
- "knip": "^5.49.0",
81
+ "knip": "^5.50.2",
80
82
  "reflect-metadata": "^0.2.2",
81
83
  "rimraf": "^6.0.1",
82
84
  "supertest": "^7.1.0",
83
85
  "tslib": "^2.8.1",
84
86
  "typedoc": "^0.28.2",
85
- "typedoc-material-theme": "^1.3.0",
87
+ "typedoc-plugin-markdown": "^4.6.2",
86
88
  "typescript": "^5.8.3",
87
89
  "vitest": "^3.1.1"
88
90
  },
89
- "packageManager": "yarn@4.9.0",
91
+ "packageManager": "yarn@4.9.1",
90
92
  "volta": {
91
93
  "node": "22.3.0",
92
94
  "yarn": "1.22.22"
@@ -94,5 +96,6 @@
94
96
  "publishConfig": {
95
97
  "access": "public"
96
98
  },
99
+ "readme": "README.md",
97
100
  "resolutions_comment": "We set the above resolutions to make sure we pull in the latest versions of these packages even if some sub packages request earlier versions"
98
101
  }
package/typedoc.config.mjs ADDED
@@ -0,0 +1,14 @@
1
+ const config = {
2
+ entryPointStrategy: 'packages',
3
+ entryPoints: ['.', 'packages/**'],
4
+ out: 'docs',
5
+ plugin: ['typedoc-plugin-markdown'],
6
+ exclude: ['**/docs/**', '**/spec/**', '**/*.spec.*', '**/*.d.ts'],
7
+ excludeExternals: true,
8
+ excludePrivate: true,
9
+ excludeProtected: true,
10
+ includeVersion: true,
11
+ packageOptions: { entryPoints: ['src/index*.ts*'] },
12
+ }
13
+
14
+ export default config
package/typedoc.json DELETED
@@ -1,14 +0,0 @@
1
- {
2
- "$schema": "https://typedoc.org/schema.json",
3
- "entryPointStrategy": "packages",
4
- "entryPoints": [
5
- "./**/packages/*",
6
- "."
7
- ],
8
- "exclude": ["**/*.d.ts"],
9
- "includeVersion": true,
10
- "name": "XYO Platform SDK",
11
- "plugin": ["typedoc-material-theme"],
12
- "themeColor": "#cb9820",
13
- "tsconfig": "./tsconfig.typedoc.json"
14
- }