packages/util/brand/README.md

# dsh-brand

The `Branded<B>` nominal-typing primitive — a tiny, **type-only** package (no runtime code, no harness-package dependency) shared by every package that owns a cross-boundary id.

## What `Branded` is

A brand makes structurally-identical strings non-interchangeable at the type level: an `AgentId` cannot be passed where a `CallId` is expected, even though both are plain `string`s at runtime.

```ts
import type { Branded } from '@deepseek-ai/dsh-brand'

export type SessionId = Branded<'SessionId'>

/** Brand a string as a SessionId (a plain cast — zero runtime cost). */
export function SessionId(id: string): SessionId {
  return id as SessionId
}
```

Construction goes through the per-id factory in the owning package. Comparison, logging, JSON serialization, and the wire format behave as for an ordinary string; the brand is erased at compile time.

## Policy: brand ids that cross package boundaries

A package brands the ids it owns — `CallId` in `dsh-llm`, `SessionId` in `dsh-session`, `AgentId` in `dsh-agent`, and `TaskId` in `dsh-tasks`. Brand cross-package ids that could plausibly be confused; not every string needs one.

This package owns only the primitive. Keeping it dependency-free lets `dsh-tasks`, for example, brand `TaskId` without importing an unrelated capability package merely to reach `Branded`.
feat(types): brand bash ids + stop brand erosion; extract Branded to dsh-brand 2026-06-21 07:17:25 +08:00			`# dsh-brand`

			The `Branded<B>` nominal-typing primitive — a tiny, type-only package (no runtime code, no harness-package dependency) shared by every package that owns a cross-boundary id.

			## What `Branded` is

			A brand makes structurally-identical strings non-interchangeable at the type level: an `AgentId` cannot be passed where a `CallId` is expected, even though both are plain `string`s at runtime.

			```ts
			`import type { Branded } from '@deepseek-ai/dsh-brand'`

			`export type SessionId = Branded<'SessionId'>`

			`/** Brand a string as a SessionId (a plain cast — zero runtime cost). */`
			`export function SessionId(id: string): SessionId {`
			`return id as SessionId`
			`}`
			```

docs(tasks): condense background task prose 2026-07-15 21:08:58 +08:00			`Construction goes through the per-id factory in the owning package. Comparison, logging, JSON serialization, and the wire format behave as for an ordinary string; the brand is erased at compile time.`
feat(types): brand bash ids + stop brand erosion; extract Branded to dsh-brand 2026-06-21 07:17:25 +08:00
			`## Policy: brand ids that cross package boundaries`

docs(tasks): condense background task prose 2026-07-15 21:08:58 +08:00			A package brands the ids it owns — `CallId` in `dsh-llm`, `SessionId` in `dsh-session`, `AgentId` in `dsh-agent`, and `TaskId` in `dsh-tasks`. Brand cross-package ids that could plausibly be confused; not every string needs one.
feat(types): brand bash ids + stop brand erosion; extract Branded to dsh-brand 2026-06-21 07:17:25 +08:00
docs(tasks): condense background task prose 2026-07-15 21:08:58 +08:00			This package owns only the primitive. Keeping it dependency-free lets `dsh-tasks`, for example, brand `TaskId` without importing an unrelated capability package merely to reach `Branded`.