Compare commits
2 commits
main
...
feat/warm-
| Author | SHA1 | Date | |
|---|---|---|---|
| ec57174760 | |||
| 16832671fb |
9 changed files with 307 additions and 161 deletions
|
|
@ -2,15 +2,6 @@
|
||||||
|
|
||||||
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
||||||
|
|
||||||
### [8.10.0](https://github.com/soulcraftlabs/brainy/compare/v8.9.0...v8.10.0) (2026-07-23)
|
|
||||||
|
|
||||||
- docs: adoption storefront — contributing guide, security policy, README support + cor section (9a99a7b)
|
|
||||||
- fix(release): push the public mirror explicitly and verify the tag lands at the right commit before publishing (6ba94c8)
|
|
||||||
- docs: project guide version line points at npm instead of a hardcoded stale number (3a1efc9)
|
|
||||||
- feat: vector provider identity is a required name field (hnsw-js), rendered [vector-index:<name>] (3be4ba9)
|
|
||||||
- feat: warm contract (warm/warmOnOpen/provider warm hook), configurable transact budget floor, backend-neutral vector index op names (55b867c)
|
|
||||||
|
|
||||||
|
|
||||||
### [8.9.0](https://github.com/soulcraftlabs/brainy/compare/v8.8.2...v8.9.0) (2026-07-19)
|
### [8.9.0](https://github.com/soulcraftlabs/brainy/compare/v8.8.2...v8.9.0) (2026-07-19)
|
||||||
|
|
||||||
- docs: measured performance envelopes v1 (per-op p50/p95 at 1k and 10k, pure-JS floor) (5cabd78)
|
- docs: measured performance envelopes v1 (per-op p50/p95 at 1k and 10k, pure-JS floor) (5cabd78)
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@ Handoff file: `/home/dpsifr/.strategy/PLATFORM-HANDOFF.md`
|
||||||
|
|
||||||
**Brainy's current open actions:** None. MIT open-source — no platform-specific actions.
|
**Brainy's current open actions:** None. MIT open-source — no platform-specific actions.
|
||||||
|
|
||||||
**Current version:** run `npm view @soulcraft/brainy version` (never trust a hardcoded number here — this line went stale for months); consumer-facing changes tracked in `RELEASES.md`
|
**Current version:** `@soulcraft/brainy@7.31.5` (latest published; 8.0.0 release candidate on `feat/8.0-u64-ids`)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
318
CONTRIBUTING.md
318
CONTRIBUTING.md
|
|
@ -1,66 +1,298 @@
|
||||||
# Contributing to Brainy
|
# Contributing to Brainy
|
||||||
|
|
||||||
Brainy is MIT-licensed and genuinely open to outside contributions. This page
|
Thank you for your interest in contributing to Brainy! This document provides guidelines and instructions for contributing to the project.
|
||||||
is the honest, current path — please don't rely on older instructions you
|
|
||||||
may find elsewhere in the repo's history.
|
|
||||||
|
|
||||||
## Where the project lives
|
## Code of Conduct
|
||||||
|
|
||||||
The source of truth is a self-hosted forge: **source.soulcraft.com/soulcraft/brainy**.
|
By participating in this project, you agree to abide by our Code of Conduct:
|
||||||
It's anonymously readable and cloneable — no account needed to browse, clone,
|
- Be respectful and inclusive
|
||||||
or build.
|
- Welcome newcomers and help them get started
|
||||||
|
- Focus on constructive criticism
|
||||||
|
- Respect differing viewpoints and experiences
|
||||||
|
|
||||||
## How to contribute
|
## How to Contribute
|
||||||
|
|
||||||
**Found a bug, or have an idea?** Email **brainy@soulcraft.com**. No account,
|
### Reporting Issues
|
||||||
no ceremony — you'll get a receipt, and it goes to a human.
|
|
||||||
|
|
||||||
**Want to send a patch?** Two ways, both first-class:
|
Before creating an issue, please check existing issues to avoid duplicates.
|
||||||
|
|
||||||
- **Email a patch.** Run `git format-patch` against your change and email the
|
When creating an issue, include:
|
||||||
output to **brainy@soulcraft.com**. This is a genuinely supported path, not
|
- Clear, descriptive title
|
||||||
a fallback — plenty of good contributions arrive this way.
|
- Detailed description of the problem
|
||||||
- **Open a pull request on the forge.** Request an account at
|
- Steps to reproduce
|
||||||
**source.soulcraft.com** (registration is request-with-approval, so allow
|
- Expected vs actual behavior
|
||||||
a little lag), clone, push a branch, and open a PR there. Maintainers
|
- System information (OS, Node version, Brainy version)
|
||||||
review and land it.
|
- Code examples if applicable
|
||||||
|
|
||||||
Either way, for anything beyond a small fix, opening an issue first (email is
|
### Suggesting Features
|
||||||
fine) to talk through the approach saves everyone rework.
|
|
||||||
|
|
||||||
## Development setup
|
Feature requests are welcome! Please provide:
|
||||||
|
- Clear use case
|
||||||
|
- Proposed API/interface
|
||||||
|
- Examples of how it would work
|
||||||
|
- Any potential challenges or considerations
|
||||||
|
|
||||||
|
### Pull Requests
|
||||||
|
|
||||||
|
#### Before Starting
|
||||||
|
|
||||||
|
1. Check existing issues and PRs
|
||||||
|
2. Open an issue to discuss significant changes
|
||||||
|
3. Fork the repository
|
||||||
|
4. Create a feature branch from `main`
|
||||||
|
|
||||||
|
#### Development Setup
|
||||||
|
|
||||||
|
**Quick Setup (Recommended):**
|
||||||
```bash
|
```bash
|
||||||
git clone https://source.soulcraft.com/soulcraft/brainy.git
|
# Clone your fork
|
||||||
|
git clone https://github.com/your-username/brainy.git
|
||||||
cd brainy
|
cd brainy
|
||||||
|
|
||||||
|
# Run setup script (installs all dependencies including Rust)
|
||||||
|
./scripts/setup-dev.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
**Manual Setup:**
|
||||||
|
```bash
|
||||||
|
# Clone your fork
|
||||||
|
git clone https://github.com/your-username/brainy.git
|
||||||
|
cd brainy
|
||||||
|
|
||||||
|
# Install system dependencies (Ubuntu/Debian)
|
||||||
|
sudo apt-get install -y build-essential pkg-config libssl-dev
|
||||||
|
|
||||||
|
# Install Rust (for WASM embedding engine)
|
||||||
|
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||||
|
source ~/.cargo/env
|
||||||
|
rustup target add wasm32-unknown-unknown
|
||||||
|
cargo install wasm-pack
|
||||||
|
|
||||||
|
# Install Node.js dependencies
|
||||||
npm install
|
npm install
|
||||||
|
|
||||||
|
# Build Candle WASM embedding engine
|
||||||
|
npm run build:candle
|
||||||
|
|
||||||
|
# Build TypeScript
|
||||||
npm run build
|
npm run build
|
||||||
|
|
||||||
|
# Run tests
|
||||||
npm test
|
npm test
|
||||||
```
|
```
|
||||||
|
|
||||||
Tests run on [Vitest](https://vitest.dev/). `npm test` runs the unit suite;
|
#### Making Changes
|
||||||
see `package.json` for `test:integration`, `test:coverage`, and friends.
|
|
||||||
|
|
||||||
## Standards
|
1. **Follow the code style**
|
||||||
|
- TypeScript for all source code
|
||||||
|
- Clear variable and function names
|
||||||
|
- Comments for complex logic
|
||||||
|
- JSDoc for public APIs
|
||||||
|
|
||||||
- **Strict TypeScript.** No `any` escape hatches to dodge the type checker.
|
2. **Write tests**
|
||||||
- **Tests exercise real behavior.** No mocking away the thing you're supposed
|
- Add tests for new features
|
||||||
to be testing.
|
- Update tests for changes
|
||||||
- **No stubs, no TODO-code.** If something can't be finished, say so and
|
- Ensure all tests pass
|
||||||
leave it out — don't merge a placeholder.
|
|
||||||
- **JSDoc on every exported function, class, and type.**
|
|
||||||
- **[Conventional Commits](https://www.conventionalcommits.org/).** `feat:`,
|
|
||||||
`fix:`, `docs:`, `perf:`, `refactor:`, `test:`, `chore:`. Never
|
|
||||||
`BREAKING CHANGE` in a commit message — major version bumps are a separate,
|
|
||||||
deliberate decision.
|
|
||||||
- **Performance claims are measured or labeled projected.** If a PR or its
|
|
||||||
description states a number, cite the benchmark that produced it (see
|
|
||||||
[docs/performance-envelopes.md](docs/performance-envelopes.md) for the
|
|
||||||
pattern). Don't state an estimate as if it were measured.
|
|
||||||
|
|
||||||
## License
|
3. **Update documentation**
|
||||||
|
- Update README if needed
|
||||||
|
- Add/update API documentation
|
||||||
|
- Include examples
|
||||||
|
|
||||||
Brainy is [MIT licensed](LICENSE). Contributions are accepted under the same
|
#### Commit Guidelines
|
||||||
license — there's no CLA to sign.
|
|
||||||
|
|
||||||
Thank you for considering a contribution.
|
Follow conventional commits format:
|
||||||
|
|
||||||
|
```
|
||||||
|
type(scope): description
|
||||||
|
|
||||||
|
[optional body]
|
||||||
|
|
||||||
|
[optional footer]
|
||||||
|
```
|
||||||
|
|
||||||
|
Types:
|
||||||
|
- `feat`: New feature
|
||||||
|
- `fix`: Bug fix
|
||||||
|
- `docs`: Documentation changes
|
||||||
|
- `style`: Code style changes
|
||||||
|
- `refactor`: Code refactoring
|
||||||
|
- `perf`: Performance improvements
|
||||||
|
- `test`: Test changes
|
||||||
|
- `chore`: Build/tooling changes
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
```bash
|
||||||
|
feat(triple): add graph traversal depth limit
|
||||||
|
fix(storage): handle concurrent write conflicts
|
||||||
|
docs(api): update search method documentation
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Submitting PR
|
||||||
|
|
||||||
|
1. Push to your fork
|
||||||
|
2. Create PR against `main` branch
|
||||||
|
3. Fill out PR template
|
||||||
|
4. Ensure CI checks pass
|
||||||
|
5. Wait for review
|
||||||
|
|
||||||
|
### Testing
|
||||||
|
|
||||||
|
#### Running Tests
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run all tests
|
||||||
|
npm test
|
||||||
|
|
||||||
|
# Run specific test file
|
||||||
|
npm test tests/core.test.ts
|
||||||
|
|
||||||
|
# Run with coverage
|
||||||
|
npm run test:coverage
|
||||||
|
|
||||||
|
# Watch mode
|
||||||
|
npm run test:watch
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Writing Tests
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { describe, it, expect } from 'vitest'
|
||||||
|
import { Brainy } from '../src'
|
||||||
|
|
||||||
|
describe('Feature Name', () => {
|
||||||
|
it('should do something specific', async () => {
|
||||||
|
const brain = new Brainy()
|
||||||
|
await brain.init()
|
||||||
|
|
||||||
|
// Test implementation
|
||||||
|
const result = await brain.search("test")
|
||||||
|
|
||||||
|
expect(result).toBeDefined()
|
||||||
|
expect(result.length).toBeGreaterThan(0)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## Architecture Guidelines
|
||||||
|
|
||||||
|
### Adding New Features
|
||||||
|
|
||||||
|
1. **Check existing functionality**
|
||||||
|
- Review `ARCHITECTURE.md`
|
||||||
|
- Check if similar features exist
|
||||||
|
- Consider if it should be an augmentation
|
||||||
|
|
||||||
|
2. **Design considerations**
|
||||||
|
- Maintain backward compatibility
|
||||||
|
- Consider performance impact
|
||||||
|
- Think about all storage adapters
|
||||||
|
- Plan for extensibility
|
||||||
|
|
||||||
|
3. **Implementation checklist**
|
||||||
|
- [ ] Core functionality
|
||||||
|
- [ ] Tests (unit and integration)
|
||||||
|
- [ ] Documentation
|
||||||
|
- [ ] TypeScript types
|
||||||
|
- [ ] Examples
|
||||||
|
- [ ] Performance benchmarks (if applicable)
|
||||||
|
|
||||||
|
### Creating Augmentations
|
||||||
|
|
||||||
|
Augmentations extend Brainy's functionality:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { BrainyAugmentation } from '../types'
|
||||||
|
|
||||||
|
export class MyAugmentation extends BrainyAugmentation {
|
||||||
|
name = 'MyAugmentation'
|
||||||
|
|
||||||
|
async onInit(brain: Brainy): Promise<void> {
|
||||||
|
// Initialize augmentation
|
||||||
|
}
|
||||||
|
|
||||||
|
async onAdd(item: any, brain: Brainy): Promise<any> {
|
||||||
|
// Process before adding
|
||||||
|
return item
|
||||||
|
}
|
||||||
|
|
||||||
|
async onSearch(query: any, results: any[], brain: Brainy): Promise<any[]> {
|
||||||
|
// Process search results
|
||||||
|
return results
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Performance Considerations
|
||||||
|
|
||||||
|
- Use batch operations where possible
|
||||||
|
- Implement caching strategically
|
||||||
|
- Consider memory usage
|
||||||
|
- Profile performance impacts
|
||||||
|
- Add benchmarks for critical paths
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
### API Documentation
|
||||||
|
|
||||||
|
Use JSDoc for all public APIs:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
/**
|
||||||
|
* Searches for similar items using vector similarity
|
||||||
|
* @param query - Search query (text or vector)
|
||||||
|
* @param options - Search options
|
||||||
|
* @returns Array of search results with scores
|
||||||
|
* @example
|
||||||
|
* ```typescript
|
||||||
|
* const results = await brain.search("machine learning", { limit: 10 })
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
async search(query: string | Vector, options?: SearchOptions): Promise<SearchResult[]> {
|
||||||
|
// Implementation
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Examples
|
||||||
|
|
||||||
|
Add examples for new features:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// examples/feature-name.ts
|
||||||
|
import { Brainy } from 'brainy'
|
||||||
|
|
||||||
|
async function exampleUsage() {
|
||||||
|
const brain = new Brainy()
|
||||||
|
await brain.init()
|
||||||
|
|
||||||
|
// Show feature usage
|
||||||
|
// Include comments explaining what's happening
|
||||||
|
// Handle errors appropriately
|
||||||
|
}
|
||||||
|
|
||||||
|
exampleUsage().catch(console.error)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Release Process
|
||||||
|
|
||||||
|
1. **Version bump**: Follow semantic versioning
|
||||||
|
2. **Update CHANGELOG**: Document all changes
|
||||||
|
3. **Run tests**: Ensure all tests pass
|
||||||
|
4. **Build**: Generate distribution files
|
||||||
|
5. **Tag**: Create git tag for version
|
||||||
|
6. **Publish**: Release to npm
|
||||||
|
|
||||||
|
## Getting Help
|
||||||
|
|
||||||
|
- **Discord**: Join our community
|
||||||
|
- **Issues**: Ask questions on GitHub
|
||||||
|
- **Discussions**: Share ideas and get feedback
|
||||||
|
|
||||||
|
## Recognition
|
||||||
|
|
||||||
|
Contributors will be recognized in:
|
||||||
|
- CHANGELOG.md for their contributions
|
||||||
|
- README.md contributors section
|
||||||
|
- GitHub contributors page
|
||||||
|
|
||||||
|
Thank you for contributing to Brainy! 🧠
|
||||||
26
README.md
26
README.md
|
|
@ -13,7 +13,7 @@
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://www.npmjs.com/package/@soulcraft/brainy"><img src="https://img.shields.io/npm/v/@soulcraft/brainy.svg" alt="npm version"></a>
|
<a href="https://www.npmjs.com/package/@soulcraft/brainy"><img src="https://img.shields.io/npm/v/@soulcraft/brainy.svg" alt="npm version"></a>
|
||||||
<a href="https://www.npmjs.com/package/@soulcraft/brainy"><img src="https://img.shields.io/npm/dm/@soulcraft/brainy.svg" alt="npm downloads"></a>
|
<a href="https://www.npmjs.com/package/@soulcraft/brainy"><img src="https://img.shields.io/npm/dm/@soulcraft/brainy.svg" alt="npm downloads"></a>
|
||||||
<a href="https://source.soulcraft.com/soulcraft/brainy/actions"><img src="https://source.soulcraft.com/soulcraft/brainy/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI"></a>
|
<a href="https://github.com/soulcraftlabs/brainy/actions/workflows/ci.yml"><img src="https://github.com/soulcraftlabs/brainy/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
|
||||||
<a href="https://soulcraft.com/docs"><img src="https://img.shields.io/badge/docs-soulcraft.com-blue.svg" alt="Documentation"></a>
|
<a href="https://soulcraft.com/docs"><img src="https://img.shields.io/badge/docs-soulcraft.com-blue.svg" alt="Documentation"></a>
|
||||||
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT License"></a>
|
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT License"></a>
|
||||||
<a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg" alt="TypeScript"></a>
|
<a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg" alt="TypeScript"></a>
|
||||||
|
|
@ -23,9 +23,8 @@
|
||||||
<a href="#quick-start">Quick start</a> ·
|
<a href="#quick-start">Quick start</a> ·
|
||||||
<a href="#one-query-three-engines">One query</a> ·
|
<a href="#one-query-three-engines">One query</a> ·
|
||||||
<a href="#feature-tour">Features</a> ·
|
<a href="#feature-tour">Features</a> ·
|
||||||
<a href="#when-you-outgrow-brainy">Scale with Cor</a> ·
|
<a href="#from-laptop-to-hundreds-of-millions">Scale with Cor</a> ·
|
||||||
<a href="#documentation">Docs</a> ·
|
<a href="#documentation">Docs</a>
|
||||||
<a href="#support--community">Support</a>
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
@ -173,11 +172,9 @@ await brain.vfs.search('React components with hooks') // semantic file
|
||||||
|
|
||||||
**[Multi-process model](docs/concepts/multi-process.md)** · **[Inspection guide](docs/guides/inspection.md)**
|
**[Multi-process model](docs/concepts/multi-process.md)** · **[Inspection guide](docs/guides/inspection.md)**
|
||||||
|
|
||||||
## When you outgrow Brainy
|
## From laptop to hundreds of millions
|
||||||
|
|
||||||
Brainy's pure-TypeScript engines carry real workloads a long way on their own — see the measured, per-operation numbers (not marketing figures) in **[docs/performance-envelopes.md](docs/performance-envelopes.md)** for what to expect, unaccelerated, on plain filesystem storage.
|
Brainy's TypeScript engines take you a long way. When you outgrow them, add the native engine — **the API doesn't change**:
|
||||||
|
|
||||||
When a deployment needs native-scale vector/graph performance — memory-mapped indexes that don't need your dataset in RAM, billion-scale ambitions — add the native engine. **The API doesn't change:**
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install @soulcraft/cor
|
npm install @soulcraft/cor
|
||||||
|
|
@ -190,14 +187,13 @@ await brain.init() // @soulcraft/cor detected — same code, native engines un
|
||||||
|
|
||||||
Installing the package is the opt-in: if `@soulcraft/cor` is present, it loads and announces itself in the init log; if it's present but broken, `init()` **throws** — an installed accelerator never silently vanishes behind the JS engines. Opt out with `plugins: []`, or pin exactly what loads with `plugins: ['@soulcraft/cor']`. [`@soulcraft/cor`](https://www.npmjs.com/package/@soulcraft/cor) (Brainy 8.x ↔ Cor 3.x, version-matched) registers Rust implementations behind every provider seam: SIMD distance kernels, memory-mapped storage, a disk-native vector index that doesn't need your dataset in RAM, durable LSM field/graph indexes that serve cold opens instantly, and native aggregation. Recall@10 measured **0.99 / 0.96 / 0.96 at 1M / 10M / 100M vectors** in Cor's release gate.
|
Installing the package is the opt-in: if `@soulcraft/cor` is present, it loads and announces itself in the init log; if it's present but broken, `init()` **throws** — an installed accelerator never silently vanishes behind the JS engines. Opt out with `plugins: []`, or pin exactly what loads with `plugins: ['@soulcraft/cor']`. [`@soulcraft/cor`](https://www.npmjs.com/package/@soulcraft/cor) (Brainy 8.x ↔ Cor 3.x, version-matched) registers Rust implementations behind every provider seam: SIMD distance kernels, memory-mapped storage, a disk-native vector index that doesn't need your dataset in RAM, durable LSM field/graph indexes that serve cold opens instantly, and native aggregation. Recall@10 measured **0.99 / 0.96 / 0.96 at 1M / 10M / 100M vectors** in Cor's release gate.
|
||||||
|
|
||||||
Open core, commercial accelerator: Brainy is MIT and complete on its own — Cor is more headroom for when you need it, not capability held back to sell you later. Licensing and support: **cor@soulcraft.com**.
|
Open core, commercial accelerator: Brainy is MIT and complete on its own; Cor is licensed and funds both.
|
||||||
|
|
||||||
## Performance
|
## Performance
|
||||||
|
|
||||||
- Per-operation p50/p95 at 1k and 10k entities, pure-JS floor, measured and re-run every release that touches a measured path: **[docs/performance-envelopes.md](docs/performance-envelopes.md)**.
|
|
||||||
- JS distance kernels: **~6× faster cosine, ~1.4× euclidean** than 7.x (measured: [`tests/benchmarks/distance-microbench.mjs`](tests/benchmarks/distance-microbench.mjs), 384-dim, median of 41).
|
- JS distance kernels: **~6× faster cosine, ~1.4× euclidean** than 7.x (measured: [`tests/benchmarks/distance-microbench.mjs`](tests/benchmarks/distance-microbench.mjs), 384-dim, median of 41).
|
||||||
- Whole-graph reads are single **O(N + E)** cursor walks — a consumer-measured 19k-edge export dropped from ~27 s of per-node calls to one scan.
|
- Whole-graph reads are single **O(N + E)** cursor walks — a consumer-measured 19k-edge export dropped from ~27 s of per-node calls to one scan.
|
||||||
- Capacity planning and architecture: **[docs/PERFORMANCE.md](docs/PERFORMANCE.md)** · **[docs/SCALING.md](docs/SCALING.md)**
|
- Full numbers and capacity planning: **[docs/PERFORMANCE.md](docs/PERFORMANCE.md)** · **[docs/SCALING.md](docs/SCALING.md)**
|
||||||
|
|
||||||
## Use cases
|
## Use cases
|
||||||
|
|
||||||
|
|
@ -216,10 +212,6 @@ Open core, commercial accelerator: Brainy is MIT and complete on its own — Cor
|
||||||
|
|
||||||
**Bun ≥ 1.1** (recommended) or **Node.js ≥ 22**. Brainy 8.x is server-only; the 7.x line remains on npm for browser use.
|
**Bun ≥ 1.1** (recommended) or **Node.js ≥ 22**. Brainy 8.x is server-only; the 7.x line remains on npm for browser use.
|
||||||
|
|
||||||
## Support & community
|
## Contributing & license
|
||||||
|
|
||||||
- **Bugs and ideas** → **brainy@soulcraft.com** — no account needed, you'll get a receipt.
|
Contributions welcome — see **[CONTRIBUTING.md](CONTRIBUTING.md)**. MIT © Brainy Contributors.
|
||||||
- **Security reports** → **security@soulcraft.com** — see **[SECURITY.md](SECURITY.md)**.
|
|
||||||
- **Contributing** → see **[CONTRIBUTING.md](CONTRIBUTING.md)**.
|
|
||||||
|
|
||||||
MIT © Brainy Contributors.
|
|
||||||
|
|
|
||||||
36
SECURITY.md
36
SECURITY.md
|
|
@ -1,36 +0,0 @@
|
||||||
# Security Policy
|
|
||||||
|
|
||||||
## Reporting a vulnerability
|
|
||||||
|
|
||||||
Email **security@soulcraft.com**. That's the one door for security reports
|
|
||||||
across the company, and it works the same way for Brainy: every report is
|
|
||||||
read by a human, you'll get a private receipt, and we'll work with you on
|
|
||||||
coordinated disclosure — please don't open a public issue for anything
|
|
||||||
that isn't already public.
|
|
||||||
|
|
||||||
Include what you'd want if you were on the other end: affected version,
|
|
||||||
how to reproduce, and what you think the impact is. If you have a patch or
|
|
||||||
a suggested fix, send it along — it's welcome but not required.
|
|
||||||
|
|
||||||
There is no bounty program today. We're saying that plainly so you know
|
|
||||||
what to expect going in.
|
|
||||||
|
|
||||||
## Response time
|
|
||||||
|
|
||||||
We respond as fast as truth allows. That means: no fixed SLA, no promise of
|
|
||||||
a reply within a specific number of hours — but a real report from a real
|
|
||||||
person gets read promptly and taken seriously. If you haven't heard anything
|
|
||||||
in a reasonable stretch, a follow-up email is completely fine.
|
|
||||||
|
|
||||||
## Supported versions
|
|
||||||
|
|
||||||
The latest `8.x` minor release line receives security fixes. If you're
|
|
||||||
running an older major version, please upgrade before reporting — we can't
|
|
||||||
commit to backporting fixes to unsupported lines.
|
|
||||||
|
|
||||||
## Scope
|
|
||||||
|
|
||||||
This policy covers the `@soulcraft/brainy` package itself — the code in
|
|
||||||
this repository. If you're evaluating a deployment that also uses
|
|
||||||
`@soulcraft/cor`, report issues in that package the same way, to the same
|
|
||||||
address; we'll route internally.
|
|
||||||
4
package-lock.json
generated
4
package-lock.json
generated
|
|
@ -1,12 +1,12 @@
|
||||||
{
|
{
|
||||||
"name": "@soulcraft/brainy",
|
"name": "@soulcraft/brainy",
|
||||||
"version": "8.10.0",
|
"version": "8.9.0",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "@soulcraft/brainy",
|
"name": "@soulcraft/brainy",
|
||||||
"version": "8.10.0",
|
"version": "8.9.0",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@msgpack/msgpack": "^3.1.2",
|
"@msgpack/msgpack": "^3.1.2",
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "@soulcraft/brainy",
|
"name": "@soulcraft/brainy",
|
||||||
"version": "8.10.0",
|
"version": "8.9.0",
|
||||||
"description": "Universal Knowledge Protocol™ - World's first Triple Intelligence database unifying vector, graph, and document search in one API. Stage 3 CANONICAL: 42 nouns × 127 verbs covering 96-97% of all human knowledge.",
|
"description": "Universal Knowledge Protocol™ - World's first Triple Intelligence database unifying vector, graph, and document search in one API. Stage 3 CANONICAL: 42 nouns × 127 verbs covering 96-97% of all human knowledge.",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"module": "dist/index.js",
|
"module": "dist/index.js",
|
||||||
|
|
@ -128,13 +128,13 @@
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"access": "public"
|
"access": "public"
|
||||||
},
|
},
|
||||||
"homepage": "https://source.soulcraft.com/soulcraft/brainy",
|
"homepage": "https://github.com/soulcraftlabs/brainy",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://source.soulcraft.com/soulcraft/brainy/issues"
|
"url": "https://github.com/soulcraftlabs/brainy/issues"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://source.soulcraft.com/soulcraft/brainy.git"
|
"url": "git+https://github.com/soulcraftlabs/brainy.git"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"dist/**/*.js",
|
"dist/**/*.js",
|
||||||
|
|
|
||||||
|
|
@ -142,7 +142,7 @@ else
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Create new changelog entry
|
# Create new changelog entry
|
||||||
CHANGELOG_ENTRY="### [${NEW_VERSION}](https://source.soulcraft.com/soulcraft/brainy/compare/v${CURRENT_VERSION}...v${NEW_VERSION}) ($(date +%Y-%m-%d))
|
CHANGELOG_ENTRY="### [${NEW_VERSION}](https://github.com/soulcraftlabs/brainy/compare/v${CURRENT_VERSION}...v${NEW_VERSION}) ($(date +%Y-%m-%d))
|
||||||
|
|
||||||
${COMMITS}
|
${COMMITS}
|
||||||
"
|
"
|
||||||
|
|
@ -175,59 +175,26 @@ echo -e "${BLUE}7️⃣ Creating git tag v${NEW_VERSION}...${NC}"
|
||||||
git tag -a "v${NEW_VERSION}" -m "Release v${NEW_VERSION}"
|
git tag -a "v${NEW_VERSION}" -m "Release v${NEW_VERSION}"
|
||||||
echo -e "${GREEN}✅ Tag created${NC}\n"
|
echo -e "${GREEN}✅ Tag created${NC}\n"
|
||||||
|
|
||||||
# Step 9: Push to origin — the forge is the one home (ruled 2026-07-23; the
|
# Step 9: Push to GitHub
|
||||||
# old public GitHub repo is archived history, no longer part of any release).
|
echo -e "${BLUE}8️⃣ Pushing to GitHub...${NC}"
|
||||||
echo -e "${BLUE}8️⃣ Pushing to origin...${NC}"
|
|
||||||
git push --follow-tags origin "$CURRENT_BRANCH"
|
git push --follow-tags origin "$CURRENT_BRANCH"
|
||||||
echo -e "${GREEN}✅ Pushed to origin${NC}\n"
|
echo -e "${GREEN}✅ Pushed to GitHub${NC}\n"
|
||||||
|
|
||||||
# Step 10: Publish — forge FIRST (home), npmjs second (the world's storefront).
|
# Step 10: Publish to npm
|
||||||
# The fleet-wide ~/.npmrc maps the @soulcraft scope to the forge registry, and
|
echo -e "${BLUE}9️⃣ Publishing to npm (dist-tag: ${NPM_TAG})...${NC}"
|
||||||
# a scope mapping BEATS `--registry` on the command line — so each publish
|
npm publish --tag "$NPM_TAG"
|
||||||
# names its registry via the scope override explicitly. Nothing implicit.
|
|
||||||
FORGE_NPM_REG="https://source.soulcraft.com/api/packages/soulcraft/npm/"
|
|
||||||
FORGE_NPM_TOKEN_FILE="$HOME/.config/soulcraft/npm-publish-brainy.token"
|
|
||||||
echo -e "${BLUE}9️⃣ Publishing to the forge registry (home)...${NC}"
|
|
||||||
if [ -f "$FORGE_NPM_TOKEN_FILE" ]; then
|
|
||||||
TMPRC="$(mktemp)"
|
|
||||||
chmod 600 "$TMPRC"
|
|
||||||
{
|
|
||||||
echo "@soulcraft:registry=${FORGE_NPM_REG}"
|
|
||||||
echo "//source.soulcraft.com/api/packages/soulcraft/npm/:_authToken=$(cat "$FORGE_NPM_TOKEN_FILE")"
|
|
||||||
} > "$TMPRC"
|
|
||||||
if npm publish --tag "$NPM_TAG" --userconfig "$TMPRC"; then
|
|
||||||
echo -e "${GREEN}✅ Published to the forge${NC}\n"
|
|
||||||
else
|
|
||||||
rm -f "$TMPRC"
|
|
||||||
echo -e "${RED}❌ Forge publish FAILED — aborting before npmjs so the pair never diverges. Fix and re-run.${NC}"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
rm -f "$TMPRC"
|
|
||||||
else
|
|
||||||
echo -e "${RED}❌ Forge publish token missing (${FORGE_NPM_TOKEN_FILE}) — aborting. The forge is home; publish it first or restage the token.${NC}"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo -e "${BLUE}9️⃣½ Publishing to npmjs (storefront, dist-tag: ${NPM_TAG})...${NC}"
|
|
||||||
npm publish --tag "$NPM_TAG" "--@soulcraft:registry=https://registry.npmjs.org/"
|
|
||||||
# Brainy is the only PUBLIC @soulcraft package — verify visibility after every publish.
|
# Brainy is the only PUBLIC @soulcraft package — verify visibility after every publish.
|
||||||
npm access get status @soulcraft/brainy "--@soulcraft:registry=https://registry.npmjs.org/" || true
|
npm access get status @soulcraft/brainy || true
|
||||||
echo -e "${GREEN}✅ Published to npmjs${NC}\n"
|
echo -e "${GREEN}✅ Published to npm${NC}\n"
|
||||||
|
|
||||||
# Step 11: Release object on the forge (presentational — the tag, CHANGELOG,
|
# Step 11: Create GitHub release
|
||||||
# and RELEASES.md are the record; this just gives the forge UI a release page).
|
echo -e "${BLUE}🔟 Creating GitHub release...${NC}"
|
||||||
echo -e "${BLUE}🔟 Creating forge release...${NC}"
|
if [ "$PRERELEASE" = true ]; then
|
||||||
if [ -n "${FORGEJO_RELEASE_TOKEN:-}" ]; then
|
gh release create "v${NEW_VERSION}" --generate-notes --prerelease
|
||||||
if curl -sf -X POST "https://source.soulcraft.com/api/v1/repos/soulcraft/brainy/releases" \
|
|
||||||
-H "Authorization: token ${FORGEJO_RELEASE_TOKEN}" -H "Content-Type: application/json" \
|
|
||||||
-d "{\"tag_name\":\"v${NEW_VERSION}\",\"name\":\"v${NEW_VERSION}\",\"prerelease\":${PRERELEASE}}" >/dev/null; then
|
|
||||||
echo -e "${GREEN}✅ Forge release created${NC}\n"
|
|
||||||
else
|
|
||||||
echo -e "${RED}⚠️ Forge release API call failed — tag + CHANGELOG remain the record; create the release page via the forge UI if wanted${NC}\n"
|
|
||||||
fi
|
|
||||||
else
|
else
|
||||||
echo -e "${RED}⚠️ FORGEJO_RELEASE_TOKEN unset — no release page created; tag + CHANGELOG remain the record${NC}\n"
|
gh release create "v${NEW_VERSION}" --generate-notes
|
||||||
fi
|
fi
|
||||||
|
echo -e "${GREEN}✅ GitHub release created${NC}\n"
|
||||||
|
|
||||||
# Step 12: Push public docs to the soulcraft.com docs ingest door
|
# Step 12: Push public docs to the soulcraft.com docs ingest door
|
||||||
# (VENUE-DOCS-RELEASE-PUSH). Skips with a loud warning when
|
# (VENUE-DOCS-RELEASE-PUSH). Skips with a loud warning when
|
||||||
|
|
@ -246,4 +213,4 @@ echo -e "${GREEN}🎉 Release ${NEW_VERSION} complete!${NC}"
|
||||||
echo -e "${GREEN}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"
|
echo -e "${GREEN}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"
|
||||||
echo ""
|
echo ""
|
||||||
echo -e "📦 npm: ${BLUE}https://www.npmjs.com/package/@soulcraft/brainy/v/${NEW_VERSION}${NC}"
|
echo -e "📦 npm: ${BLUE}https://www.npmjs.com/package/@soulcraft/brainy/v/${NEW_VERSION}${NC}"
|
||||||
echo -e "🏠 Forge: ${BLUE}https://source.soulcraft.com/soulcraft/brainy/releases/tag/v${NEW_VERSION}${NC}"
|
echo -e "🐙 GitHub: ${BLUE}https://github.com/soulcraftlabs/brainy/releases/tag/v${NEW_VERSION}${NC}"
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue