@xyo-network/sdk-js 3.14.16 → 3.14.17

package/docs/variables/withNodeModule.md

@@ -0,0 +1,27 @@
+[@xyo-network/sdk-js](../README.md) / withNodeModule
+
+# Variable: withNodeModule()
+
+> `const` **withNodeModule**: \<`R`\>(`mod`, `closure`) => `R` \| `undefined`
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/typeChecks.d.ts:93
+
+## Type Parameters
+
+### R
+
+`R`
+
+## Parameters
+
+### mod
+
+`any`
+
+### closure
+
+(`mod`) => `R`
+
+## Returns
+
+`R` \| `undefined`

package/docs/variables/withSentinelInstance.md

@@ -0,0 +1,27 @@
+[@xyo-network/sdk-js](../README.md) / withSentinelInstance
+
+# Variable: withSentinelInstance()
+
+> `const` **withSentinelInstance**: \<`R`\>(`mod`, `closure`) => `R` \| `undefined`
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/typeChecks.d.ts:194
+
+## Type Parameters
+
+### R
+
+`R`
+
+## Parameters
+
+### mod
+
+`any`
+
+### closure
+
+(`mod`) => `R`
+
+## Returns
+
+`R` \| `undefined`

package/docs/variables/withSentinelModule.md

@@ -0,0 +1,27 @@
+[@xyo-network/sdk-js](../README.md) / withSentinelModule
+
+# Variable: withSentinelModule()
+
+> `const` **withSentinelModule**: \<`R`\>(`mod`, `closure`) => `R` \| `undefined`
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/typeChecks.d.ts:173
+
+## Type Parameters
+
+### R
+
+`R`
+
+## Parameters
+
+### mod
+
+`any`
+
+### closure
+
+(`mod`) => `R`
+
+## Returns
+
+`R` \| `undefined`

package/docs/variables/withWitnessInstance.md

@@ -0,0 +1,27 @@
+[@xyo-network/sdk-js](../README.md) / withWitnessInstance
+
+# Variable: withWitnessInstance()
+
+> `const` **withWitnessInstance**: \<`R`\>(`mod`, `closure`) => `R` \| `undefined`
+
+Defined in: packages/modules/packages/witness/packages/model/dist/types/typeChecks.d.ts:104
+
+## Type Parameters
+
+### R
+
+`R`
+
+## Parameters
+
+### mod
+
+`any`
+
+### closure
+
+(`mod`) => `R`
+
+## Returns
+
+`R` \| `undefined`

package/docs/variables/withWitnessModule.md

@@ -0,0 +1,27 @@
+[@xyo-network/sdk-js](../README.md) / withWitnessModule
+
+# Variable: withWitnessModule()
+
+> `const` **withWitnessModule**: \<`R`\>(`mod`, `closure`) => `R` \| `undefined`
+
+Defined in: packages/modules/packages/witness/packages/model/dist/types/typeChecks.d.ts:93
+
+## Type Parameters
+
+### R
+
+`R`
+
+## Parameters
+
+### mod
+
+`any`
+
+### closure
+
+(`mod`) => `R`
+
+## Returns
+
+`R` \| `undefined`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/sdk-js",
-  "version": "3.14.16",
+  "version": "3.14.17",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -45,44 +45,45 @@
     "free-mongo": "kill -9 $(lsof -t -i :55391) && kill -9 $(lsof -t -i :55393)",
     "package-build": "yarn package-clean && rimraf docs && yarn package-build-only && typedoc && xy statics",
     "package-clean": "rimraf dist",
+    "readme:gen": "node scripts/readme-gen.mjs",
     "test": "vitest --watch false"
   },
   "dependencies": {
-    "@xyo-network/manifest": "^3.14.16",
-    "@xyo-network/modules": "^3.14.16",
-    "@xyo-network/protocol": "^3.14.16"
+    "@xyo-network/manifest": "^3.14.17",
+    "@xyo-network/modules": "^3.14.17",
+    "@xyo-network/protocol": "^3.14.17"
   },
   "devDependencies": {
     "@firebase/app": "^0.11.5",
     "@firebase/app-compat": "^0.2.54",
     "@stylistic/eslint-plugin": "^4.2.0",
     "@types/supertest": "^6.0.3",
-    "@typescript-eslint/eslint-plugin": "^8.31.1",
-    "@typescript-eslint/parser": "^8.31.1",
-    "@vitest/coverage-v8": "^3.1.2",
-    "@xylabs/eslint-config-flat": "^6.4.6",
-    "@xylabs/forget": "^4.8.9",
-    "@xylabs/ts-scripts-yarn3": "^6.4.6",
-    "@xylabs/tsconfig": "^6.4.6",
-    "@xylabs/tsconfig-dom": "^6.4.6",
-    "@xylabs/vitest-extended": "^4.8.9",
-    "@xyo-network/sdk-utils": "^3.14.16",
+    "@typescript-eslint/eslint-plugin": "^8.32.0",
+    "@typescript-eslint/parser": "^8.32.0",
+    "@vitest/coverage-v8": "^3.1.3",
+    "@xylabs/eslint-config-flat": "^6.5.5",
+    "@xylabs/forget": "^4.9.3",
+    "@xylabs/ts-scripts-yarn3": "^6.5.5",
+    "@xylabs/tsconfig": "^6.5.5",
+    "@xylabs/tsconfig-dom": "^6.5.5",
+    "@xylabs/vitest-extended": "^4.9.3",
+    "@xyo-network/sdk-utils": "^3.14.17",
     "chalk": "^5.4.1",
     "dependency-cruiser": "^16.10.1",
     "dotenv": "^16.5.0",
-    "eslint": "^9.25.1",
+    "eslint": "^9.26.0",
     "eslint-import-resolver-typescript": "^4.3.4",
     "glob": "^11.0.2",
     "jsdom": "^26.1.0",
-    "knip": "^5.50.5",
+    "knip": "^5.54.1",
     "reflect-metadata": "^0.2.2",
     "rimraf": "^6.0.1",
     "supertest": "^7.1.0",
     "tslib": "^2.8.1",
-    "typedoc": "^0.28.3",
+    "typedoc": "^0.28.4",
     "typedoc-plugin-markdown": "^4.6.3",
     "typescript": "^5.8.3",
-    "vitest": "^3.1.2"
+    "vitest": "^3.1.3"
   },
   "packageManager": "yarn@4.9.1",
   "volta": {

package/scripts/README.template.md

@@ -0,0 +1,23 @@
+# {{name}}
+
+[![logo][]](https://xyo.network)
+
+Version: {{version}}
+
+{{description}}
+
+## Documentation
+
+[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/{{safeName}})
+
+Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
+
+## License
+
+> See the [LICENSE](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

package/scripts/generate-docs-for-package.mjs

@@ -0,0 +1,71 @@
+/* eslint-disable max-statements */
+import { execSync } from 'node:child_process'
+import fs, { rmSync } from 'node:fs'
+import path from 'node:path'
+
+export function generateDocsForPackage(pkgName, pkgDir) {
+  if (!pkgName) {
+    console.error('❌ Please provide a package name as an argument.')
+    return 1
+  }
+
+  const safePkgDir = pkgName.replaceAll('/', '__')
+  const packageRoot = path.join(process.cwd(), pkgDir)
+  const pkgJsonPath = path.join(packageRoot, 'package.json')
+
+  if (!fs.existsSync(pkgJsonPath)) {
+    console.error(`❌ Could not find package: ${pkgName}`)
+    return 1
+  }
+
+  const pkg = JSON.parse(fs.readFileSync(pkgJsonPath, 'utf8'))
+  const entryRelative = pkg.types || pkg.typings || pkg.main
+
+  if (!entryRelative) {
+    console.error(`❌ Package "${pkgName}" does not specify "types", "typings", or "main".`)
+    return 1
+  }
+
+  const entryAbsolute = path.join(packageRoot, entryRelative)
+  if (!fs.existsSync(entryAbsolute)) {
+    console.error(`❌ Entry point not found: ${entryAbsolute}`)
+    return 1
+  }
+
+  const originalTsconfigPath = path.join(packageRoot, 'tsconfig.json')
+  let compilerOptions = {
+    target: 'ES2020',
+    module: 'ESNext',
+    strict: true,
+    moduleResolution: 'Node',
+    skipLibCheck: true,
+  }
+
+  if (fs.existsSync(originalTsconfigPath)) {
+    const originalTsconfig = JSON.parse(fs.readFileSync(originalTsconfigPath, 'utf8'))
+    if (originalTsconfig.compilerOptions) {
+      compilerOptions = { ...compilerOptions, ...originalTsconfig.compilerOptions }
+    }
+  }
+
+  const tempTsconfigPath = path.join(packageRoot, `.typedoc-pkg-${safePkgDir}.tsconfig.json`)
+  fs.writeFileSync(tempTsconfigPath, JSON.stringify({
+    compilerOptions,
+    include: [entryAbsolute],
+  }, null, 2))
+
+  console.log(`📘 Generating docs for "${pkgName}" from ${entryRelative}...`)
+
+  try {
+    execSync(
+      `npx typedoc --entryPoints ${entryAbsolute} --tsconfig ${tempTsconfigPath} --out ${packageRoot}/docs --plugin typedoc-plugin-markdown --readme none --hidePageHeader --excludePrivate --excludeProtected`,
+      { stdio: 'inherit' },
+    )
+    rmSync(tempTsconfigPath, { force: true })
+    console.log(`✅ Docs generated for [${pkgName}]`)
+    return 0
+  } catch (err) {
+    console.error('❌ Failed to generate documentation:', err.message, err.stack)
+    return 1
+  }
+}

package/scripts/readme-gen.mjs

@@ -0,0 +1,37 @@
+#!/usr/bin/env node
+
+/* eslint-disable sonarjs/slow-regex */
+// 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)