-
Notifications
You must be signed in to change notification settings - Fork 4
feat(identity): implement ADR-0068 unified user-context contract (D1–D4) #2312
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
49cf6a0
feat(identity): implement ADR-0068 unified user-context contract (D1–D4)
zhuangjianguo dab2b06
docs(spec): use canonical roles[] form in app visibility-predicate ex…
zhuangjianguo 6e9acf3
chore(spec): regenerate api-surface snapshot for ADR-0068 exports
zhuangjianguo 54c9286
fix(formula): harden D4 role-exists regex against ReDoS
zhuangjianguo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| --- | ||
| title: Eval User | ||
| description: Eval User protocol schemas | ||
| --- | ||
|
|
||
| {/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs go in content/docs/guides/. */} | ||
|
|
||
| EvalUser — the one user-context contract (ADR-0068 D1). | ||
|
|
||
| The signed-in user exposed to every predicate surface (server formula, server | ||
|
|
||
| RLS, client UI gates) under the canonical variable name `current_user` | ||
|
|
||
| (aliases `user`, `ctx.user`) with an **identical shape**. A predicate such as | ||
|
|
||
| `current_user.roles.exists(r, r == 'org_admin')` (or | ||
|
|
||
| `'org_admin' in current_user.roles`) therefore evaluates identically wherever | ||
|
|
||
| it is written. | ||
|
|
||
| `roles: string[]` is the **only canonical** role field. Singular `role` is NOT | ||
|
|
||
| part of this contract — its legacy "overwritten to 'admin' on promotion" | ||
|
|
||
| behavior is the footgun this eliminates. | ||
|
|
||
| @see docs/adr/0068-unified-user-context-and-built-in-identity-roles.md | ||
|
|
||
| <Callout type="info"> | ||
| **Source:** `packages/spec/src/identity/eval-user.zod.ts` | ||
| </Callout> | ||
|
|
||
| ## TypeScript Usage | ||
|
|
||
| ```typescript | ||
| import { EvalUser } from '@objectstack/spec/identity'; | ||
| import type { EvalUser } from '@objectstack/spec/identity'; | ||
|
|
||
| // Validate data | ||
| const result = EvalUser.parse(data); | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## EvalUser | ||
|
|
||
| ### Properties | ||
|
|
||
| | Property | Type | Required | Description | | ||
| | :--- | :--- | :--- | :--- | | ||
| | **id** | `string` | ✅ | User ID | | ||
| | **name** | `string` | optional | Display name | | ||
| | **email** | `string` | optional | Email address | | ||
| | **roles** | `string[]` | ✅ | Canonical role names assigned to the user (scope-resolved) | | ||
| | **isPlatformAdmin** | `boolean` | optional | DERIVED alias of 'platform_admin' in roles. Deprecated. | | ||
| | **organizationId** | `string \| null` | optional | Active organization ID (null = platform/unscoped) | | ||
|
|
||
|
|
||
| --- | ||
|
|
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| { | ||
| "title": "Identity Protocol", | ||
| "pages": [ | ||
| "eval-user", | ||
| "identity", | ||
| "organization", | ||
| "role", | ||
|
|
||
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
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
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
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.