Better introspection of table relationships#19
Merged
Conversation
Add `schema` and `db` properties to FieldMeta for direct access to raw Zod schema and database metadata. Mark existing cooked properties as deprecated. New API (preferred): ```typescript fields.email.schema // ZodType - use Zod APIs for introspection fields.email.db // FieldDBMeta - raw db metadata fields.email.db.unique // boolean ``` Old API (deprecated, still works): ```typescript fields.email.unique // boolean fields.email.type // "email" fields.email.required // boolean ``` This is additive and non-breaking. Deprecated properties will be removed in a future major version when form logic moves to @b9g/forms. Related to #15 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
d27c902 to
0552e9e
Compare
Adds the ability to navigate both forward and reverse relations via a
unified `relations()` method.
- Forward relations come from `as` in `.db.references(Table, "as")`
- Reverse relations come from `reverseAs` in `.db.references(Table, "as", { reverseAs: "..." })`
Implementation:
- Add reverse relations registry using WeakMap for lazy resolution
- Register reverse relations when a reference defines `reverseAs`
- Merge `Relation` and `ReverseRelation` into single `Relation` interface
- Add `relations()` method that returns both forward and reverse
- Validate uniqueness of relation names (as + reverseAs) per target table
Usage:
```typescript
const Posts = table("posts", {
authorId: z.string().db.references(Users, "author", { reverseAs: "posts" }),
});
// Forward relation (many-to-one): Posts -> Users
Posts.relations().author.table // Users table
Posts.relations().author.fields().email // Users fields
// Reverse relation (one-to-many): Users -> Posts
Users.relations().posts.table // Posts table
Users.relations().posts.fields().title // Posts fields
```
Closes #18
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
0552e9e to
369d14b
Compare
- Update Field Metadata section with new preferred API (schema, db) - Remove deprecated FieldType from Types section - Add Relation type to exports documentation - Add chained relation navigation example - Fix "Why Zen?" heading to "Why ZenDB?" 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
relations()method to navigate both forward and reverse table relationsas, reverse fromreverseAsAPI
Relation interface
Test plan
reverseAsfields()navigates to related table fieldsreverseAsreverseAsnames for same targetreverseAscollides with forward relation nameCloses #18
🤖 Generated with Claude Code