Skip to content

Commit 57d9d9a

Browse files
committed
docs(spec): AuthSessionApi docblock prescribes the helper instead of describing every reader
State the helper as the way to read and what a hand-built input costs on a cookie-carrying request, rather than asserting that every reader already reads through it. Claude-Session: https://claude.ai/code/session_01DhTqaEHqPVSVnAkjG3jywn Co-authored-by: Claude <noreply@anthropic.com>
1 parent 769d9f4 commit 57d9d9a

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

‎packages/spec/src/contracts/auth-service.ts‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -184,11 +184,12 @@ export interface IAuthService {
184184
* `{ headers }` alone, renewal included.
185185
*
186186
* Their one source is `inProcessSessionReadInput(headers)` in
187-
* `@objectstack/types` (`packages/types/src/in-process-session-read.ts`); a
188-
* reader calls `api.getSession(inProcessSessionReadInput(headers))` and never
189-
* builds either form by hand. `query` is declared because readers send it
190-
* (#22258): `rest-server.ts` in `@objectstack/rest` (twice); in
191-
* `@objectstack/runtime`, `http-dispatcher.ts` (twice),
187+
* `@objectstack/types` (`packages/types/src/in-process-session-read.ts`):
188+
* read with `api.getSession(inProcessSessionReadInput(headers))`, not with a
189+
* hand-built input — a hand-built `{ headers }` on a cookie-carrying request
190+
* renews the session behind a cookie nobody re-issues. `query` is declared
191+
* because readers send it (#22258): `rest-server.ts` in `@objectstack/rest`
192+
* (twice); in `@objectstack/runtime`, `http-dispatcher.ts` (twice),
192193
* `security/resolve-session-principal.ts` and
193194
* `security/resolve-execution-context.ts`; `current-user-endpoints.ts` in
194195
* `@objectstack/plugin-hono-server`; and in `@objectstack/cloud-connection`,

0 commit comments

Comments
 (0)