@xyo-network/sdk-js 4.3.0 → 5.0.0

package/docs/variables/withNodeModule.md

@@ -1,27 +0,0 @@
-[@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

@@ -1,27 +0,0 @@
-[@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

@@ -1,27 +0,0 @@
-[@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

@@ -1,27 +0,0 @@
-[@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

@@ -1,27 +0,0 @@
-[@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/eslint.config.mjs

@@ -1,33 +0,0 @@
-import {
-  typescriptConfig,
-  unicornConfig,
-  workspacesConfig,
-  rulesConfig,
-  sonarConfig,
-  importConfig,
-} from '@xylabs/eslint-config-flat'
-
-export default [
-  {
-    ignores: ['dist',
-      '**/packages/*/dist',
-      'build',
-      '**/packages/*/build',, '.yarn',
-      'node_modules',
-      '**/packages/*/node_modules',
-      'docs',
-      '.dependency-cruiser.mjs'],
-  },
-  unicornConfig,
-  workspacesConfig,
-  rulesConfig,
-  typescriptConfig,
-  importConfig,
-  sonarConfig,
-  {
-    rules: {
-      'sonarjs/prefer-single-boolean-return': ['off'],
-      'import-x/no-unresolved': ['off'],
-    },
-  },
-]

package/knip.config.ts

@@ -1,68 +0,0 @@
-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*']
-const ignore = ['packages/**']
-const typescript = {
-  config: [
-    'tsconfig.json',
-  ],
-}
-
-const config: KnipConfig = {
-  entry,
-  ignore,
-  project,
-  typescript,
-  ignoreDependencies: ['@xylabs/ts-scripts-yarn3', 'tslib'],
-  workspaces: {
-    '.': {
-      entry,
-      project,
-      ignoreDependencies: [
-        '@typescript-eslint/eslint-plugin',
-        '@typescript-eslint/parser',
-        'eslint',
-        'eslint-import-resolver-typescript',
-      ],
-    },
-    'packages/*': {
-      entry,
-      ignore,
-      project,
-      typescript,
-    },
-    'packages/*/packages/*': {
-      entry,
-      ignore,
-      project,
-      typescript,
-    },
-    'packages/*/packages/packages/*': {
-      entry,
-      ignore,
-      project,
-      typescript,
-    },
-    'packages/*/packages/*/packages/*': {
-      entry,
-      ignore,
-      project,
-      typescript,
-    },
-    'packages/*/packages/*/packages/*/packages/*': {
-      entry,
-      ignore,
-      project,
-      typescript,
-    },
-    'packages/*/packages/*/packages/*/packages/*/packages/*': {
-      entry,
-      ignore,
-      project,
-      typescript,
-    },
-  },
-}
-
-export default config

package/scripts/README.template.md

@@ -1,23 +0,0 @@
-# {{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/clear-scrollback-buffer.sh

@@ -1,3 +0,0 @@
-#!/usr/bin/env bash
-clear
-printf '\e[3J'

package/scripts/generate-typedoc.mjs

@@ -1,168 +0,0 @@
-import { execSync } from 'node:child_process'
-import {
-  existsSync, mkdirSync, readFileSync, readdirSync,
-} from 'node:fs'
-import { rm, writeFile } from 'node:fs/promises'
-import path from 'node:path'
-import { fileURLToPath } from 'node:url'
-
-/**
- * Generates inline TypeDoc markdown documentation
- * @param {string} packageLocation - The package location path
- * @param {string} sourceGlob - The glob pattern for source files
- * @returns {Promise<string>} A markdown string containing Reference
- */
-export async function generateTypeDoc(packageLocation, entryPoints) {
-  const __dirname = path.dirname(fileURLToPath(import.meta.url))
-  const tempDir = path.join(__dirname, '.temp-typedoc')
-
-  console.log(`Generating TypeDoc for package at: ${packageLocation}`)
-  for (const ep of entryPoints) {
-    console.log(`  - Entry point: ${path.resolve(packageLocation, ep)}`)
-  }
-
-  try {
-    // Create temp directory if it doesn't exist
-    if (!existsSync(tempDir)) {
-      mkdirSync(tempDir, { recursive: true })
-    }
-
-    // Create a minimal TypeDoc config for markdown generation
-    const typedocConfig = {
-      entryPoints: entryPoints.map(ep => path.resolve(packageLocation, ep)),
-      entryPointStrategy: 'expand',
-      out: tempDir,
-      plugin: ['typedoc-plugin-markdown'],
-      readme: 'none',
-      theme: 'markdown',
-      useCodeBlocks: true,
-      hidePageTitle: true,
-      githubPages: false,
-      hideGenerator: true,
-      hideBreadcrumbs: true,
-      disableSources: true,
-      skipErrorChecking: true,
-      excludeExternals: true,
-      excludeInternal: true,
-      excludePrivate: true,
-      sort: ['source-order'],
-    }
-
-    // Create temporary typedoc.json file
-    const typedocJsonPath = path.join(tempDir, 'typedoc.json')
-    await writeFile(typedocJsonPath, JSON.stringify(typedocConfig, null, 2))
-
-    // Run TypeDoc with the config
-    try {
-      console.log(`Generating docs for: ${packageLocation}`)
-      execSync(`npx typedoc --options ${typedocJsonPath}`, {
-        cwd: process.cwd(),
-        stdio: ['ignore', 'pipe', 'pipe'],
-      })
-    } catch (error) {
-      console.error(`TypeDoc error: ${error.stderr ? error.stderr.toString() : error.message}`)
-      return '## Reference\n\nReference generation failed.'
-    }
-
-    // Combine all markdown files into a single document
-    return consolidateMarkdown(tempDir)
-  } catch (error) {
-    console.warn(`⚠️ Error generating TypeDoc for ${packageLocation}:`, error.message)
-    return '## Reference\n\nReference generation failed.'
-  } finally {
-    // Clean up the temp directory
-    try {
-      await rm(tempDir, { recursive: true, force: true })
-    } catch (error) {
-      console.warn('⚠️ Failed to clean up temp directory:', error.message)
-    }
-  }
-}
-
-/**
- * Consolidates all markdown files in the TypeDoc output directory into a single markdown string
- * @param {string} tempDir - The temporary directory containing TypeDoc output
- * @returns {string} - Consolidated markdown content
- */
-function consolidateMarkdown(tempDir) {
-  // Start with the main README content
-  let consolidated = '## Reference\n\n'
-
-  // Read main README.md first (if it exists)
-  const mainReadmePath = path.join(tempDir, 'README.md')
-  if (existsSync(mainReadmePath)) {
-    const mainContent = readFileSync(mainReadmePath, 'utf8')
-      .replace(/^---(.|\n)*?---\n/, '') // Remove front matter
-      .replace(/^# .+\n/, '') // Remove top-level header
-      .replaceAll(/\]\((.+?)\.md\)/g, '](#$1)') // Fix internal links to use anchors
-
-    consolidated += mainContent + '\n\n'
-  }
-
-  // Function to process a directory recursively
-  function processDirectory(dir, level = 0) {
-    const indent = '  '.repeat(level)
-    let content = ''
-
-    try {
-      const items = readdirSync(dir, { withFileTypes: true })
-
-      // Process files first
-      for (const item of items) {
-        const itemPath = path.join(dir, item.name)
-
-        // Skip directories for now (process them later)
-        if (item.isDirectory()) continue
-
-        // Skip README.md (already processed) and files that aren't markdown
-        if (item.name === 'README.md' || !item.name.endsWith('.md')) continue
-
-        // Read file content
-        const fileContent = readFileSync(itemPath, 'utf8')
-          .replace(/^---(.|\n)*?---\n/, '') // Remove front matter
-
-        // Get the module name from filename (without extension)
-        const moduleName = item.name.replace('.md', '')
-
-        // Create a header with anchor
-        content += `\n\n${indent}### <a id="${moduleName}"></a>${moduleName}\n\n`
-
-        // Add file content with fixed links
-        content += fileContent
-          .replace(/^# .+\n/, '') // Remove top-level header
-          .replaceAll(/\]\((.+?)\.md\)/g, '](#$1)') // Fix internal links to use anchors
-      }
-
-      // Process subdirectories
-      for (const item of items) {
-        if (item.isDirectory()) {
-          const subDirPath = path.join(dir, item.name)
-          // Skip spec directories
-          if (item.name === 'spec' || item.name.includes('.spec')) continue
-
-          // Create a header for the directory
-          content += `\n\n${indent}### ${item.name}\n`
-
-          // Process the subdirectory
-          content += processDirectory(subDirPath, level + 1)
-        }
-      }
-    } catch (error) {
-      console.warn(`⚠️ Error processing directory ${dir}:`, error.message)
-    }
-
-    return content
-  }
-
-  // Process all files in the tempDir
-  consolidated += processDirectory(tempDir)
-
-  // Clean up the markdown (fix duplicate headers, etc.)
-  consolidated = consolidated
-    .replaceAll(/\n\n\n+/g, '\n\n') // Remove excess newlines
-    .replaceAll(/^#### /gm, '### ') // Adjust heading levels
-    .replaceAll(/^##### /gm, '#### ') // Adjust heading levels
-    .replaceAll(/^###### /gm, '##### ') // Adjust heading levels
-
-  return consolidated
-}

package/scripts/mongo/README.md

@@ -1,33 +0,0 @@
-# MongoDB Scripts
-
-The following scripts exist to initialize the local MongoDB instance
-appropriately. From [their docs](https://hub.docker.com/_/mongo):
-
-> When a container is started for the first time it will execute files with
-> extensions `.sh` and `.js` that are found in `/docker-entrypoint-initdb.d`.
-> Files will be executed in alphabetical order. `.js` files will be executed by
-> mongo using the database specified by the `MONGO_INITDB_DATABASE` variable,
-> if it is present, or test otherwise. You may also switch databases within the
-> `.js` script.
-
-It doesn't look like they support:
-
--   `await`
--   `console`
-
-so be sure to code your scripts accordingly.
-
-## Debugging
-
-For debugging with `mongosh` you can connect with something similar to the
-following:
-
-```shell
-mongosh --authenticationDatabase admin mongodb://root:example@localhost:27017/archivist
-```
-
-From the mongo shell, to seed the DB with test data you can run:
-
-```shell
-load('./scripts/mongo/test/seed.js')
-```

package/scripts/mongo/docker-entrypoint-initdb.d/00-create-key.sh

@@ -1,5 +0,0 @@
-#!/bin/bash -eux
-
-cd /tmp
-openssl rand -base64 756 > mongodb.key
-chmod 400 mongodb.key

package/scripts/mongo/opt/mongo/joinReplicaSet.js

@@ -1,13 +0,0 @@
-const config = {
-  _id: 'dbrs',
-  members: [
-    {
-      _id: 0,
-      host: '127.0.0.1:27017',
-      priority: 1,
-    },
-  ],
-  version: 1,
-}
-rs.initiate(config, { force: true })
-rs.status()

package/scripts/readme-gen.mjs

@@ -1,50 +0,0 @@
-#!/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 { generateTypeDoc } from './generate-typedoc.mjs'
-// import { getPackageEntryPoints } from './get-package-entrypoints.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 tryLoadReadmeBody(location) {
-  const readmeBodyPath = path.join(location, 'README_BODY.md')
-  try {
-    return await readFile(readmeBodyPath, 'utf8')
-  } catch {
-    return ''
-  }
-}
-
-async function main() {
-  const template = await readFile(templatePath, 'utf8')
-  const pkgs = yarnWorkspaces()
-
-  for (const { location } of pkgs) {
-    try {
-      const pkgJsonPath = path.join(location, 'package.json')
-      const readmeBodyPath = path.join(location, 'README_BODY.md')
-      const pkg = JSON.parse(await readFile(pkgJsonPath, 'utf8'))
-      const body = await tryLoadReadmeBody(readmeBodyPath)
-      const typedoc = await generateTypeDoc(location, ['src/index*.ts'])
-      const readmeContent = fillTemplate(template, {
-        ...pkg, body, typedoc,
-      })
-      await writeFile(path.join(location, 'README.md'), readmeContent)
-      console.log(`✅ Created README.md for ${pkg.name}`)
-    } catch (err) {
-      console.warn(`⚠️ Skipped ${location}:`, err.message)
-    }
-  }
-}
-
-main().catch(console.error)

package/scripts/run-cycle.mjs

@@ -1,71 +0,0 @@
-#!/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/vitest.config.ts

@@ -1,19 +0,0 @@
-import dotenv from 'dotenv'
-import { defineConfig } from 'vitest/config'
-
-dotenv.config()
-
-export default defineConfig({
-  test: {
-    globals: true,
-    environment: 'node',
-    coverage: {
-      provider: 'v8', // Use V8 native coverage provider
-      reporter: ['text', 'html', 'lcov'], // Output formats
-      // reportsDirectory: './coverage', // Directory for coverage output
-      // include: ['**/src/**/*.ts'], // Include files to track
-      // exclude: ['node_modules', '**/src/*.spec.*'], // Exclude unnecessary files
-    },
-    watch: false,
-  },
-})

package/vitest.workspace.ts

@@ -1,5 +0,0 @@
-import { defineWorkspace } from 'vitest/config'
-
-export default defineWorkspace([
-  './vitest.config.ts',
-])

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: {},
-    neutral: { src: true },
-    node: {},
-  },
-}
-
-export default config