@xylabs/sdk-js 4.13.14 → 4.13.16

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 (11) hide show
  1. package/README.md +11 -48
  2. package/dist/browser/index.d.ts +1 -0
  3. package/dist/browser/index.d.ts.map +1 -0
  4. package/dist/neutral/index.d.ts +1 -0
  5. package/dist/neutral/index.d.ts.map +1 -0
  6. package/dist/node/index.d.ts +1 -0
  7. package/dist/node/index.d.ts.map +1 -0
  8. package/eslint.config.mjs +1 -1
  9. package/package.json +31 -30
  10. package/scripts/README.template.md +60 -0
  11. package/scripts/readme-gen.mjs +36 -0
package/README.md CHANGED
@@ -1,7 +1,7 @@
1
- [![logo][]](https://xylabs.com)
2
-
3
1
  # @xylabs/sdk-js
4
2
 
3
+ [![logo][]](https://xylabs.com)
4
+
5
5
  [![main-build][]][main-build-link]
6
6
  [![npm-badge][]][npm-link]
7
7
  [![npm-downloads-badge][]][npm-link]
@@ -12,53 +12,15 @@
12
12
  [![snyk-badge][]][snyk-link]
13
13
  [![socket-badge][]][socket-link]
14
14
 
15
- ## Table of Contents
16
-
17
- - [Description](#description)
18
- - [Install](#install)
19
- - [Scripts](#scripts)
20
- - [Maintainers](#maintainers)
21
- - [License](#license)
22
- - [Credits](#credits)
23
-
24
- ## Description
25
-
26
- SDK for base code for Typescript and Javascript Libraries. Common utility &
27
- helper code that is used throughout XYLabs/XYO Network TypeScript projects.
28
-
29
- Features:
15
+ Version: 4.13.15
30
16
 
31
- - Mono-repo that publishes individual packages to npm
32
- - Fully written in TypeScript
33
- - Polyfills to ensure common operation across Node.js/Browser environments
17
+ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
34
18
 
35
- ## Install
19
+ ## Documentation
36
20
 
37
- Using npm:
21
+ Coming Soon!
38
22
 
39
- ```sh
40
- npm i --save @xylabs/sdk-js
41
- ```
42
-
43
- Using yarn:
44
-
45
- ```sh
46
- yarn add @xylabs/sdk-js
47
- ```
48
-
49
- ## Scripts
50
-
51
- Using npm:
52
-
53
- ```sh
54
- npm xy --help
55
- ```
56
-
57
- Using yarn:
58
-
59
- ```sh
60
- yarn xy --help
61
- ```
23
+ Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
62
24
 
63
25
  ## Maintainers
64
26
 
@@ -69,13 +31,14 @@ yarn xy --help
69
31
 
70
32
  ## License
71
33
 
72
- See the [LICENSE](LICENSE) file for license details
34
+ > See the [LICENSE](LICENSE) file for license details
73
35
 
74
36
  ## Credits
75
37
 
76
- [Made with 🔥 and ❄️ by XY Labs](https://xylabs.com)
38
+ [Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
77
39
 
78
40
  [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
41
+
79
42
  [main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
80
43
  [main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
81
44
  [npm-badge]: https://img.shields.io/npm/v/@xylabs/sdk-js.svg
@@ -94,4 +57,4 @@ See the [LICENSE](LICENSE) file for license details
94
57
  [jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/sdk-js
95
58
 
96
59
  [socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/sdk-js
97
- [socket-link]: https://socket.dev/npm/package/@xylabs/sdk-js
60
+ [socket-link]: https://socket.dev/npm/package/@xylabs/sdk-js
package/dist/browser/index.d.ts CHANGED
@@ -19,3 +19,4 @@ export * from '@xylabs/retry';
19
19
  export * from '@xylabs/set';
20
20
  export * from '@xylabs/static-implements';
21
21
  export * from '@xylabs/timer';
22
+ //# sourceMappingURL=index.d.ts.map
package/dist/browser/index.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA;AAC7B,cAAc,2BAA2B,CAAA;AACzC,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAC7B,cAAc,qBAAqB,CAAA;AACnC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,uBAAuB,CAAA;AACrC,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,2BAA2B,CAAA;AACzC,cAAc,eAAe,CAAA"}
package/dist/neutral/index.d.ts CHANGED
@@ -19,3 +19,4 @@ export * from '@xylabs/retry';
19
19
  export * from '@xylabs/set';
20
20
  export * from '@xylabs/static-implements';
21
21
  export * from '@xylabs/timer';
22
+ //# sourceMappingURL=index.d.ts.map
package/dist/neutral/index.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA;AAC7B,cAAc,2BAA2B,CAAA;AACzC,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAC7B,cAAc,qBAAqB,CAAA;AACnC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,uBAAuB,CAAA;AACrC,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,2BAA2B,CAAA;AACzC,cAAc,eAAe,CAAA"}
package/dist/node/index.d.ts CHANGED
@@ -19,3 +19,4 @@ export * from '@xylabs/retry';
19
19
  export * from '@xylabs/set';
20
20
  export * from '@xylabs/static-implements';
21
21
  export * from '@xylabs/timer';
22
+ //# sourceMappingURL=index.d.ts.map
package/dist/node/index.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA;AAC7B,cAAc,2BAA2B,CAAA;AACzC,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAC7B,cAAc,qBAAqB,CAAA;AACnC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,uBAAuB,CAAA;AACrC,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,2BAA2B,CAAA;AACzC,cAAc,eAAe,CAAA"}
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: ['.yarn', 'dist', 'docs', 'eslint.config.mjs', '**/dist', '**/docs', 'packages/threads', 'packages/threads-test'] },
11
+ { ignores: ['.yarn', 'dist', 'build', 'docs', 'eslint.config.mjs', '**/dist', '**/build', '**/docs', 'packages/threads', 'packages/threads-test'] },
12
12
  unicornConfig,
13
13
  workspacesConfig,
14
14
  rulesConfig,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/sdk-js",
3
- "version": "4.13.14",
3
+ "version": "4.13.16",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "xylabs",
@@ -39,6 +39,7 @@
39
39
  ],
40
40
  "scripts": {
41
41
  "build-typedoc-site": "xy gen-docs @xylabs/sdk-js",
42
+ "readme:gen": "node scripts/readme-gen.mjs",
42
43
  "test": "vitest run"
43
44
  },
44
45
  "resolutions": {
@@ -46,37 +47,37 @@
46
47
  "uuid": "^11"
47
48
  },
48
49
  "dependencies": {
49
- "@xylabs/api": "^4.13.14",
50
- "@xylabs/array": "^4.13.14",
51
- "@xylabs/assert": "^4.13.14",
52
- "@xylabs/axios": "^4.13.14",
53
- "@xylabs/decimal-precision": "^4.13.14",
54
- "@xylabs/delay": "^4.13.14",
55
- "@xylabs/error": "^4.13.14",
56
- "@xylabs/eth-address": "^4.13.14",
57
- "@xylabs/exists": "^4.13.14",
58
- "@xylabs/forget": "^4.13.14",
59
- "@xylabs/function-name": "^4.13.14",
60
- "@xylabs/hex": "^4.13.14",
61
- "@xylabs/log": "^4.13.14",
62
- "@xylabs/logger": "^4.13.14",
63
- "@xylabs/object": "^4.13.14",
64
- "@xylabs/profile": "^4.13.14",
65
- "@xylabs/promise": "^4.13.14",
66
- "@xylabs/retry": "^4.13.14",
67
- "@xylabs/set": "^4.13.14",
68
- "@xylabs/static-implements": "^4.13.14",
69
- "@xylabs/timer": "^4.13.14"
50
+ "@xylabs/api": "^4.13.16",
51
+ "@xylabs/array": "^4.13.16",
52
+ "@xylabs/assert": "^4.13.16",
53
+ "@xylabs/axios": "^4.13.16",
54
+ "@xylabs/decimal-precision": "^4.13.16",
55
+ "@xylabs/delay": "^4.13.16",
56
+ "@xylabs/error": "^4.13.16",
57
+ "@xylabs/eth-address": "^4.13.16",
58
+ "@xylabs/exists": "^4.13.16",
59
+ "@xylabs/forget": "^4.13.16",
60
+ "@xylabs/function-name": "^4.13.16",
61
+ "@xylabs/hex": "^4.13.16",
62
+ "@xylabs/log": "^4.13.16",
63
+ "@xylabs/logger": "^4.13.16",
64
+ "@xylabs/object": "^4.13.16",
65
+ "@xylabs/profile": "^4.13.16",
66
+ "@xylabs/promise": "^4.13.16",
67
+ "@xylabs/retry": "^4.13.16",
68
+ "@xylabs/set": "^4.13.16",
69
+ "@xylabs/static-implements": "^4.13.16",
70
+ "@xylabs/timer": "^4.13.16"
70
71
  },
71
72
  "devDependencies": {
72
- "@types/node": "^24.0.13",
73
- "@typescript-eslint/eslint-plugin": "^8.36.0",
74
- "@typescript-eslint/parser": "^8.36.0",
75
- "@typescript-eslint/types": "^8.36.0",
76
- "@xylabs/eslint-config-flat": "^7.0.0-rc.12",
77
- "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.12",
78
- "@xylabs/tsconfig": "^7.0.0-rc.12",
79
- "@xylabs/tsconfig-dom": "^7.0.0-rc.12",
73
+ "@types/node": "^24.0.14",
74
+ "@typescript-eslint/eslint-plugin": "^8.37.0",
75
+ "@typescript-eslint/parser": "^8.37.0",
76
+ "@typescript-eslint/types": "^8.37.0",
77
+ "@xylabs/eslint-config-flat": "^7.0.0-rc.27",
78
+ "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
79
+ "@xylabs/tsconfig": "^7.0.0-rc.27",
80
+ "@xylabs/tsconfig-dom": "^7.0.0-rc.27",
80
81
  "dotenv": "^17.2.0",
81
82
  "eslint": "^9.31.0",
82
83
  "eslint-import-resolver-typescript": "^4.4.4",
package/scripts/README.template.md ADDED
@@ -0,0 +1,60 @@
1
+ # {{name}}
2
+
3
+ [![logo][]](https://xylabs.com)
4
+
5
+ [![main-build][]][main-build-link]
6
+ [![npm-badge][]][npm-link]
7
+ [![npm-downloads-badge][]][npm-link]
8
+ [![jsdelivr-badge][]][jsdelivr-link]
9
+ [![npm-license-badge][]](LICENSE)
10
+ [![codacy-badge][]][codacy-link]
11
+ [![codeclimate-badge][]][codeclimate-link]
12
+ [![snyk-badge][]][snyk-link]
13
+ [![socket-badge][]][socket-link]
14
+
15
+ Version: {{version}}
16
+
17
+ {{description}}
18
+
19
+ ## Documentation
20
+
21
+ Coming Soon!
22
+
23
+ Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
24
+
25
+ ## Maintainers
26
+
27
+ - [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
28
+ - [Matt Jones](https://github.com/jonesmac)
29
+ - [Joel Carter](https://github.com/JoelBCarter)
30
+ - [Jordan Trouw](https://github.com/jordantrouw)
31
+
32
+ ## License
33
+
34
+ > See the [LICENSE](LICENSE) file for license details
35
+
36
+ ## Credits
37
+
38
+ [Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
39
+
40
+ [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
41
+
42
+ [main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
43
+ [main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
44
+ [npm-badge]: https://img.shields.io/npm/v/{{name}}.svg
45
+ [npm-link]: https://www.npmjs.com/package/{{name}}
46
+ [codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
47
+ [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
48
+ [codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
49
+ [codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
50
+ [snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
51
+ [snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
52
+
53
+ [npm-downloads-badge]: https://img.shields.io/npm/dw/{{name}}
54
+ [npm-license-badge]: https://img.shields.io/npm/l/{{name}}
55
+
56
+ [jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/{{name}}/badge
57
+ [jsdelivr-link]: https://www.jsdelivr.com/package/npm/{{name}}
58
+
59
+ [socket-badge]: https://socket.dev/api/badge/npm/package/{{name}}
60
+ [socket-link]: https://socket.dev/npm/package/{{name}}
package/scripts/readme-gen.mjs ADDED
@@ -0,0 +1,36 @@
1
+ #!/usr/bin/env node
2
+
3
+ // generate-readmes.mjs
4
+ import { readFile, writeFile } from 'node:fs/promises'
5
+ import path from 'node:path'
6
+ import { fileURLToPath } from 'node:url'
7
+ import { yarnWorkspaces } from '@xylabs/ts-scripts-yarn3'
8
+ // import { generateDocsForPackage } from './generate-docs-for-package.mjs'
9
+
10
+ const __dirname = path.dirname(fileURLToPath(import.meta.url))
11
+ const templatePath = path.join(__dirname, 'README.template.md')
12
+
13
+ function fillTemplate(template, data) {
14
+ const additionalData = { ...data, safeName: data.name.replaceAll('/', '__').replaceAll('@', '') }
15
+ return template.replaceAll(/{{(.*?)}}/g, (_, key) => additionalData[key.trim()] ?? '')
16
+ }
17
+
18
+ async function main() {
19
+ const template = await readFile(templatePath, 'utf8')
20
+ const pkgs = yarnWorkspaces()
21
+
22
+ for (const { location } of pkgs) {
23
+ const pkgJsonPath = path.join(location, 'package.json')
24
+ try {
25
+ const pkg = JSON.parse(await readFile(pkgJsonPath, 'utf8'))
26
+ const readmeContent = fillTemplate(template, pkg)
27
+ await writeFile(path.join(location, 'README.md'), readmeContent)
28
+ // generateDocsForPackage(pkg.name, location)
29
+ console.log(`✅ Created README.md for ${pkg.name}`)
30
+ } catch (err) {
31
+ console.warn(`⚠️ Skipped ${location}:`, err.message)
32
+ }
33
+ }
34
+ }
35
+
36
+ main().catch(console.error)