@soulcraft/brainy 0.19.0 → 0.21.0

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 (93) hide show
  1. package/README.md +8 -3
  2. package/dist/augmentations/conduitAugmentations.js +1158 -0
  3. package/dist/augmentations/conduitAugmentations.js.map +1 -0
  4. package/dist/augmentations/memoryAugmentations.js +255 -0
  5. package/dist/augmentations/memoryAugmentations.js.map +1 -0
  6. package/dist/augmentations/serverSearchAugmentations.js +531 -0
  7. package/dist/augmentations/serverSearchAugmentations.js.map +1 -0
  8. package/dist/brainy.js +508 -42
  9. package/dist/brainy.min.js +750 -750
  10. package/dist/brainyData.d.ts +58 -4
  11. package/dist/coreTypes.d.ts +54 -0
  12. package/dist/examples/basicUsage.js +128 -0
  13. package/dist/examples/basicUsage.js.map +1 -0
  14. package/dist/hnsw/hnswIndex.js +550 -0
  15. package/dist/hnsw/hnswIndex.js.map +1 -0
  16. package/dist/hnsw/hnswIndexOptimized.js +441 -0
  17. package/dist/hnsw/hnswIndexOptimized.js.map +1 -0
  18. package/dist/mcp/brainyMCPAdapter.js +142 -0
  19. package/dist/mcp/brainyMCPAdapter.js.map +1 -0
  20. package/dist/mcp/brainyMCPService.js +248 -0
  21. package/dist/mcp/brainyMCPService.js.map +1 -0
  22. package/dist/mcp/index.js +17 -0
  23. package/dist/mcp/index.js.map +1 -0
  24. package/dist/mcp/mcpAugmentationToolset.js +180 -0
  25. package/dist/mcp/mcpAugmentationToolset.js.map +1 -0
  26. package/dist/storage/adapters/baseStorageAdapter.d.ts +82 -0
  27. package/dist/storage/adapters/baseStorageAdapter.d.ts.map +1 -0
  28. package/dist/storage/adapters/baseStorageAdapter.js +233 -0
  29. package/dist/storage/adapters/baseStorageAdapter.js.map +1 -0
  30. package/dist/storage/adapters/fileSystemStorage.d.ts +11 -1
  31. package/dist/storage/adapters/fileSystemStorage.d.ts.map +1 -1
  32. package/dist/storage/adapters/fileSystemStorage.js +568 -0
  33. package/dist/storage/adapters/fileSystemStorage.js.map +1 -0
  34. package/dist/storage/adapters/memoryStorage.d.ts +12 -1
  35. package/dist/storage/adapters/memoryStorage.d.ts.map +1 -1
  36. package/dist/storage/adapters/memoryStorage.js +300 -0
  37. package/dist/storage/adapters/memoryStorage.js.map +1 -0
  38. package/dist/storage/adapters/opfsStorage.d.ts +28 -1
  39. package/dist/storage/adapters/opfsStorage.d.ts.map +1 -1
  40. package/dist/storage/adapters/opfsStorage.js +778 -0
  41. package/dist/storage/adapters/opfsStorage.js.map +1 -0
  42. package/dist/storage/adapters/s3CompatibleStorage.d.ts +47 -1
  43. package/dist/storage/adapters/s3CompatibleStorage.d.ts.map +1 -1
  44. package/dist/storage/adapters/s3CompatibleStorage.js +1021 -0
  45. package/dist/storage/adapters/s3CompatibleStorage.js.map +1 -0
  46. package/dist/storage/baseStorage.d.ts +16 -2
  47. package/dist/storage/baseStorage.d.ts.map +1 -1
  48. package/dist/storage/baseStorage.js +126 -0
  49. package/dist/storage/baseStorage.js.map +1 -0
  50. package/dist/storage/fileSystemStorage.d.ts +15 -2
  51. package/dist/storage/fileSystemStorage.d.ts.map +1 -1
  52. package/dist/storage/opfsStorage.d.ts +66 -3
  53. package/dist/storage/opfsStorage.d.ts.map +1 -1
  54. package/dist/storage/s3CompatibleStorage.d.ts +14 -2
  55. package/dist/storage/s3CompatibleStorage.d.ts.map +1 -1
  56. package/dist/storage/storageFactory.js +183 -0
  57. package/dist/storage/storageFactory.js.map +1 -0
  58. package/dist/types/augmentations.js +16 -0
  59. package/dist/types/augmentations.js.map +1 -0
  60. package/dist/types/brainyDataInterface.js +8 -0
  61. package/dist/types/brainyDataInterface.js.map +1 -0
  62. package/dist/types/fileSystemTypes.js +8 -0
  63. package/dist/types/fileSystemTypes.js.map +1 -0
  64. package/dist/types/graphTypes.js +36 -0
  65. package/dist/types/graphTypes.js.map +1 -0
  66. package/dist/types/mcpTypes.js +22 -0
  67. package/dist/types/mcpTypes.js.map +1 -0
  68. package/dist/types/pipelineTypes.js +7 -0
  69. package/dist/types/pipelineTypes.js.map +1 -0
  70. package/dist/types/tensorflowTypes.js +6 -0
  71. package/dist/types/tensorflowTypes.js.map +1 -0
  72. package/dist/unified.js +1554 -550
  73. package/dist/unified.min.js +747 -747
  74. package/dist/utils/distance.js +239 -0
  75. package/dist/utils/distance.js.map +1 -0
  76. package/dist/utils/embedding.js +622 -0
  77. package/dist/utils/embedding.js.map +1 -0
  78. package/dist/utils/environment.js +75 -0
  79. package/dist/utils/environment.js.map +1 -0
  80. package/dist/utils/index.js +5 -0
  81. package/dist/utils/index.js.map +1 -0
  82. package/dist/utils/statistics.d.ts +11 -1
  83. package/dist/utils/statistics.d.ts.map +1 -1
  84. package/dist/utils/statistics.js +25 -0
  85. package/dist/utils/statistics.js.map +1 -0
  86. package/dist/utils/tensorflowUtils.js +25 -0
  87. package/dist/utils/tensorflowUtils.js.map +1 -0
  88. package/dist/utils/textEncoding.js +281 -0
  89. package/dist/utils/textEncoding.js.map +1 -0
  90. package/dist/utils/workerUtils.js +458 -0
  91. package/dist/utils/workerUtils.js.map +1 -0
  92. package/package.json +4 -3
  93. package/README.demo.md +0 -65
package/README.md CHANGED
@@ -3,7 +3,7 @@
3
3
  <br/><br/>
4
4
 
5
5
  [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
6
- [![Node.js](https://img.shields.io/badge/node-%3E%3D24.4.0-brightgreen.svg)](https://nodejs.org/)
6
+ [![Node.js](https://img.shields.io/badge/node-%3E%3D24.4.1-brightgreen.svg)](https://nodejs.org/)
7
7
  [![TypeScript](https://img.shields.io/badge/TypeScript-5.4.5-blue.svg)](https://www.typescriptlang.org/)
8
8
  [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
9
9
 
@@ -69,15 +69,19 @@ configuration.
69
69
  Brainy offers specialized packages for different use cases:
70
70
 
71
71
  #### CLI Package
72
+
72
73
  ```bash
73
74
  npm install -g @soulcraft/brainy-cli
74
75
  ```
76
+
75
77
  Command-line interface for data management, bulk operations, and database administration.
76
78
 
77
79
  #### Web Service Package
80
+
78
81
  ```bash
79
82
  npm install @soulcraft/brainy-web-service
80
83
  ```
84
+
81
85
  REST API web service wrapper that provides HTTP endpoints for search operations and database queries.
82
86
 
83
87
  ## 🏁 Quick Start
@@ -493,7 +497,7 @@ const restoreResult = await db.restore(backupData, {clearExisting: true})
493
497
  Brainy provides a way to get statistics about the current state of the database:
494
498
 
495
499
  ```typescript
496
- import { BrainyData, getStatistics } from '@soulcraft/brainy'
500
+ import {BrainyData, getStatistics} from '@soulcraft/brainy'
497
501
 
498
502
  // Create and initialize the database
499
503
  const db = new BrainyData()
@@ -509,6 +513,7 @@ const instanceStats = await db.getStatistics()
509
513
  ```
510
514
 
511
515
  The statistics include:
516
+
512
517
  - `nounCount`: Number of nouns (entities) in the database
513
518
  - `verbCount`: Number of verbs (relationships) in the database
514
519
  - `metadataCount`: Number of metadata entries
@@ -1107,7 +1112,7 @@ The repository includes a comprehensive demo that showcases Brainy's main featur
1107
1112
  - **[Try the live demo](https://soulcraft-research.github.io/brainy/demo/index.html)** - Check out the
1108
1113
  interactive demo on
1109
1114
  GitHub Pages
1110
- - Or run it locally with `npm run demo` (see [demo instructions](README.demo.md) for details)
1115
+ - Or run it locally with `npm run demo` (see [demo instructions](demo.md) for details)
1111
1116
  - To deploy your own version to GitHub Pages, use the GitHub Actions workflow in
1112
1117
  `.github/workflows/deploy-demo.yml`,
1113
1118
  which automatically deploys when pushing to the main branch or can be manually triggered