AGENTS.md

1# @second-brain/types — Agent Instructions
2 
3Shared TypeScript type definitions for the entire monorepo. No runtime code — types only.
4 
5## Key Files
6 
7| File | Contents |
8|------|----------|
9| `src/entity.ts` | `Entity` type, `ENTITY_TYPES` array (15 types), `EntityType` union |
10| `src/relation.ts` | `Relation` type, `RELATION_TYPES` array (20 types), `RelationType` union |
11| `src/search.ts` | `SearchResult`, `SearchOptions`, `FusedSearchOptions` |
12| `src/temporal.ts` | `BitemporalRecord`, `TemporalQuery`, `HistoryEntry` |
13| `src/sync.ts` | `SyncState`, `SyncMessage`, `SyncConfig` |
14| `src/namespace.ts` | `Namespace` type, validation helpers |
15| `src/author.ts` | `Author` type for attribution |
16| `src/branch-context.ts` | `BranchContext` for git-aware operations |
17| `src/index.ts` | Re-exports everything |
18 
19## Adding a New Entity Type
20 
211. Add to `ENTITY_TYPES` array in `src/entity.ts`
222. The `EntityType` union auto-derives from the array
233. Downstream: update FTS triggers in `packages/core` if needed
24 
25## Adding a New Relation Type
26 
271. Add to `RELATION_TYPES` array in `src/relation.ts`
282. The `RelationType` union auto-derives from the array
29 
30## Conventions
31 
32- All types use `as const` arrays with derived union types
33- Every entity/relation carries `namespace`, `eventTime`, `ingestTime`
34- Confidence is `0..1` float, decayed read-side only
35- Observations are `string[]` — atomic facts
36