@xylabs/sdk-js 4.13.15 → 4.13.16

package/README.md

@@ -1,7 +1,7 @@
-[![logo][]](https://xylabs.com)
-
 # @xylabs/sdk-js
 
+[![logo][]](https://xylabs.com)
+
 [![main-build][]][main-build-link]
 [![npm-badge][]][npm-link]
 [![npm-downloads-badge][]][npm-link]
@@ -12,53 +12,15 @@
 [![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-## Table of Contents
-
--   [Description](#description)
--   [Install](#install)
--   [Scripts](#scripts)
--   [Maintainers](#maintainers)
--   [License](#license)
--   [Credits](#credits)
-
-## Description
-
-SDK for base code for Typescript and Javascript Libraries. Common utility &
-helper code that is used throughout XYLabs/XYO Network TypeScript projects.
-
-Features:
+Version: 4.13.15
 
--   Mono-repo that publishes individual packages to npm
--   Fully written in TypeScript
--   Polyfills to ensure common operation across Node.js/Browser environments
+Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
-## Install
+## Documentation
 
-Using npm:
+Coming Soon!
 
-```sh
-npm i --save @xylabs/sdk-js
-```
-
-Using yarn:
-
-```sh
-yarn add @xylabs/sdk-js
-```
-
-## Scripts
-
-Using npm:
-
-```sh
-npm xy --help
-```
-
-Using yarn:
-
-```sh
-yarn xy --help
-```
+Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 
 ## Maintainers
 
@@ -69,13 +31,14 @@ yarn xy --help
 
 ## License
 
-See the [LICENSE](LICENSE) file for license details
+> See the [LICENSE](LICENSE) file for license details
 
 ## Credits
 
-[Made with 🔥 and ❄️ by XY Labs](https://xylabs.com)
+[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
 
 [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
+
 [main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
 [main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/sdk-js.svg
@@ -94,4 +57,4 @@ See the [LICENSE](LICENSE) file for license details
 [jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/sdk-js
 
 [socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/sdk-js
-[socket-link]: https://socket.dev/npm/package/@xylabs/sdk-js
+[socket-link]: https://socket.dev/npm/package/@xylabs/sdk-js

package/dist/browser/index.d.ts

@@ -19,3 +19,4 @@ export * from '@xylabs/retry';
 export * from '@xylabs/set';
 export * from '@xylabs/static-implements';
 export * from '@xylabs/timer';
+//# sourceMappingURL=index.d.ts.map

package/dist/neutral/index.d.ts

@@ -19,3 +19,4 @@ export * from '@xylabs/retry';
 export * from '@xylabs/set';
 export * from '@xylabs/static-implements';
 export * from '@xylabs/timer';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.ts

@@ -19,3 +19,4 @@ export * from '@xylabs/retry';
 export * from '@xylabs/set';
 export * from '@xylabs/static-implements';
 export * from '@xylabs/timer';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/sdk-js",
-  "version": "4.13.15",
+  "version": "4.13.16",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "xylabs",
@@ -39,6 +39,7 @@
   ],
   "scripts": {
     "build-typedoc-site": "xy gen-docs @xylabs/sdk-js",
+    "readme:gen": "node scripts/readme-gen.mjs",
     "test": "vitest run"
   },
   "resolutions": {
@@ -46,37 +47,37 @@
     "uuid": "^11"
   },
   "dependencies": {
-    "@xylabs/api": "^4.13.15",
-    "@xylabs/array": "^4.13.15",
-    "@xylabs/assert": "^4.13.15",
-    "@xylabs/axios": "^4.13.15",
-    "@xylabs/decimal-precision": "^4.13.15",
-    "@xylabs/delay": "^4.13.15",
-    "@xylabs/error": "^4.13.15",
-    "@xylabs/eth-address": "^4.13.15",
-    "@xylabs/exists": "^4.13.15",
-    "@xylabs/forget": "^4.13.15",
-    "@xylabs/function-name": "^4.13.15",
-    "@xylabs/hex": "^4.13.15",
-    "@xylabs/log": "^4.13.15",
-    "@xylabs/logger": "^4.13.15",
-    "@xylabs/object": "^4.13.15",
-    "@xylabs/profile": "^4.13.15",
-    "@xylabs/promise": "^4.13.15",
-    "@xylabs/retry": "^4.13.15",
-    "@xylabs/set": "^4.13.15",
-    "@xylabs/static-implements": "^4.13.15",
-    "@xylabs/timer": "^4.13.15"
+    "@xylabs/api": "^4.13.16",
+    "@xylabs/array": "^4.13.16",
+    "@xylabs/assert": "^4.13.16",
+    "@xylabs/axios": "^4.13.16",
+    "@xylabs/decimal-precision": "^4.13.16",
+    "@xylabs/delay": "^4.13.16",
+    "@xylabs/error": "^4.13.16",
+    "@xylabs/eth-address": "^4.13.16",
+    "@xylabs/exists": "^4.13.16",
+    "@xylabs/forget": "^4.13.16",
+    "@xylabs/function-name": "^4.13.16",
+    "@xylabs/hex": "^4.13.16",
+    "@xylabs/log": "^4.13.16",
+    "@xylabs/logger": "^4.13.16",
+    "@xylabs/object": "^4.13.16",
+    "@xylabs/profile": "^4.13.16",
+    "@xylabs/promise": "^4.13.16",
+    "@xylabs/retry": "^4.13.16",
+    "@xylabs/set": "^4.13.16",
+    "@xylabs/static-implements": "^4.13.16",
+    "@xylabs/timer": "^4.13.16"
   },
   "devDependencies": {
-    "@types/node": "^24.0.13",
-    "@typescript-eslint/eslint-plugin": "^8.36.0",
-    "@typescript-eslint/parser": "^8.36.0",
-    "@typescript-eslint/types": "^8.36.0",
-    "@xylabs/eslint-config-flat": "^7.0.0-rc.20",
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
-    "@xylabs/tsconfig": "^7.0.0-rc.20",
-    "@xylabs/tsconfig-dom": "^7.0.0-rc.20",
+    "@types/node": "^24.0.14",
+    "@typescript-eslint/eslint-plugin": "^8.37.0",
+    "@typescript-eslint/parser": "^8.37.0",
+    "@typescript-eslint/types": "^8.37.0",
+    "@xylabs/eslint-config-flat": "^7.0.0-rc.27",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig": "^7.0.0-rc.27",
+    "@xylabs/tsconfig-dom": "^7.0.0-rc.27",
     "dotenv": "^17.2.0",
     "eslint": "^9.31.0",
     "eslint-import-resolver-typescript": "^4.4.4",

package/scripts/README.template.md

@@ -0,0 +1,60 @@
+# {{name}}
+
+[![logo][]](https://xylabs.com)
+
+[![main-build][]][main-build-link]
+[![npm-badge][]][npm-link]
+[![npm-downloads-badge][]][npm-link]
+[![jsdelivr-badge][]][jsdelivr-link]
+[![npm-license-badge][]](LICENSE)
+[![codacy-badge][]][codacy-link]
+[![codeclimate-badge][]][codeclimate-link]
+[![snyk-badge][]][snyk-link]
+[![socket-badge][]][socket-link]
+
+Version: {{version}}
+
+{{description}}
+
+## Documentation
+
+Coming Soon!
+
+Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
+
+## Maintainers
+
+-   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
+-   [Matt Jones](https://github.com/jonesmac)
+-   [Joel Carter](https://github.com/JoelBCarter)
+-   [Jordan Trouw](https://github.com/jordantrouw)
+
+## License
+
+> See the [LICENSE](LICENSE) file for license details
+
+## Credits
+
+[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
+
+[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
+
+[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
+[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
+[npm-badge]: https://img.shields.io/npm/v/{{name}}.svg
+[npm-link]: https://www.npmjs.com/package/{{name}}
+[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
+[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
+[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
+[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
+[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
+[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
+
+[npm-downloads-badge]: https://img.shields.io/npm/dw/{{name}}
+[npm-license-badge]: https://img.shields.io/npm/l/{{name}}
+
+[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/{{name}}/badge
+[jsdelivr-link]: https://www.jsdelivr.com/package/npm/{{name}}
+
+[socket-badge]: https://socket.dev/api/badge/npm/package/{{name}}
+[socket-link]: https://socket.dev/npm/package/{{name}}

package/scripts/readme-gen.mjs

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+
+// generate-readmes.mjs
+import { readFile, writeFile } from 'node:fs/promises'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { yarnWorkspaces } from '@xylabs/ts-scripts-yarn3'
+// import { generateDocsForPackage } from './generate-docs-for-package.mjs'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const templatePath = path.join(__dirname, 'README.template.md')
+
+function fillTemplate(template, data) {
+  const additionalData = { ...data, safeName: data.name.replaceAll('/', '__').replaceAll('@', '') }
+  return template.replaceAll(/{{(.*?)}}/g, (_, key) => additionalData[key.trim()] ?? '')
+}
+
+async function main() {
+  const template = await readFile(templatePath, 'utf8')
+  const pkgs = yarnWorkspaces()
+
+  for (const { location } of pkgs) {
+    const pkgJsonPath = path.join(location, 'package.json')
+    try {
+      const pkg = JSON.parse(await readFile(pkgJsonPath, 'utf8'))
+      const readmeContent = fillTemplate(template, pkg)
+      await writeFile(path.join(location, 'README.md'), readmeContent)
+      // generateDocsForPackage(pkg.name, location)
+      console.log(`✅ Created README.md for ${pkg.name}`)
+    } catch (err) {
+      console.warn(`⚠️ Skipped ${location}:`, err.message)
+    }
+  }
+}
+
+main().catch(console.error)

package/build/browser/index.d.ts

@@ -1,22 +0,0 @@
-export * from '@xylabs/api';
-export * from '@xylabs/array';
-export * from '@xylabs/assert';
-export * from '@xylabs/axios';
-export * from '@xylabs/decimal-precision';
-export * from '@xylabs/delay';
-export * from '@xylabs/error';
-export * from '@xylabs/eth-address';
-export * from '@xylabs/exists';
-export * from '@xylabs/forget';
-export * from '@xylabs/function-name';
-export * from '@xylabs/hex';
-export * from '@xylabs/log';
-export * from '@xylabs/logger';
-export * from '@xylabs/object';
-export * from '@xylabs/profile';
-export * from '@xylabs/promise';
-export * from '@xylabs/retry';
-export * from '@xylabs/set';
-export * from '@xylabs/static-implements';
-export * from '@xylabs/timer';
-//# sourceMappingURL=index.d.ts.map

package/build/neutral/index.d.ts

@@ -1,22 +0,0 @@
-export * from '@xylabs/api';
-export * from '@xylabs/array';
-export * from '@xylabs/assert';
-export * from '@xylabs/axios';
-export * from '@xylabs/decimal-precision';
-export * from '@xylabs/delay';
-export * from '@xylabs/error';
-export * from '@xylabs/eth-address';
-export * from '@xylabs/exists';
-export * from '@xylabs/forget';
-export * from '@xylabs/function-name';
-export * from '@xylabs/hex';
-export * from '@xylabs/log';
-export * from '@xylabs/logger';
-export * from '@xylabs/object';
-export * from '@xylabs/profile';
-export * from '@xylabs/promise';
-export * from '@xylabs/retry';
-export * from '@xylabs/set';
-export * from '@xylabs/static-implements';
-export * from '@xylabs/timer';
-//# sourceMappingURL=index.d.ts.map

package/build/node/index.d.ts

@@ -1,22 +0,0 @@
-export * from '@xylabs/api';
-export * from '@xylabs/array';
-export * from '@xylabs/assert';
-export * from '@xylabs/axios';
-export * from '@xylabs/decimal-precision';
-export * from '@xylabs/delay';
-export * from '@xylabs/error';
-export * from '@xylabs/eth-address';
-export * from '@xylabs/exists';
-export * from '@xylabs/forget';
-export * from '@xylabs/function-name';
-export * from '@xylabs/hex';
-export * from '@xylabs/log';
-export * from '@xylabs/logger';
-export * from '@xylabs/object';
-export * from '@xylabs/profile';
-export * from '@xylabs/promise';
-export * from '@xylabs/retry';
-export * from '@xylabs/set';
-export * from '@xylabs/static-implements';
-export * from '@xylabs/timer';
-//# sourceMappingURL=index.d.ts.map