k1nq/TREK

mirror of https://github.com/mauriceboe/TREK.git synced 2026-10-23 07:26:30 +00:00

Files

T

Maurice 4570ace78c feat(journey): the shared book engine lays out, edits and designs whole books

Every element kind and Studio tool gets an op, the auto layout and its
templates move from the client to shared with a parity fixture, and a pure
design engine turns directives into a finished book with design findings.

2026-10-22 21:34:15 +00:00

scripts

fix(ci): typed card points, the managed take route, and the failing card tests and ratchets

2026-10-22 21:34:15 +00:00

src

feat(journey): the shared book engine lays out, edits and designs whole books

2026-10-22 21:34:15 +00:00

.prettierrc

build: prettier leaves side-effect imports where they are

2026-10-10 20:30:16 +02:00

CLAUDE.md

perf(shared): keep the DOMPurify sanitisers out of the root barrel

2026-10-20 08:22:40 +02:00

eslint.config.mjs

ci: server and shared lint stop rewriting files, and Prettier is checked per file

2026-10-10 20:15:54 +02:00

package.json

perf(shared): keep the DOMPurify sanitisers out of the root barrel

2026-10-20 08:22:40 +02:00

README.md

Release 3.1.0 (#1185 )

2026-06-16 22:22:45 +02:00

tsconfig.json

Release 3.1.0 (#1185 )

2026-06-16 22:22:45 +02:00

tsdown.config.ts

perf(shared): keep the DOMPurify sanitisers out of the root barrel

2026-10-20 08:22:40 +02:00

vitest.config.ts

v4.0.0 (#1719 )

2026-08-27 13:22:39 +02:00

README.md

@trek/shared

Single source of truth for TREK's API contracts, expressed as Zod schemas and consumed by both the server (request validation + inferred DTO types) and the client (typed requests/responses).

This package is part of the incremental NestJS + React 19 migration (see the "Brownfield Rewrite" board). It is intentionally dormant until modules start importing it — adding it changes nothing for users.

Rules

One folder per domain: src/<domain>/<domain>.schema.ts (+ .spec.ts).
Domain-agnostic building blocks live in src/common/.
A route is only considered migrated once its contract lives here.
Schemas are the source of truth; server DTOs and client types are inferred from them (z.infer<typeof schema>), never hand-duplicated.

Consumption (dev)

Both apps resolve @trek/shared to this package's TypeScript source:

Server (tsx): via paths in server/tsconfig.json.
Client (vite): via resolve.alias in client/vite.config.ts (+ paths for the type-checker).

Production packaging (Docker / workspace wiring) is introduced in card F2, when the server first depends on this package at runtime. Until then prod builds are untouched.

Not yet here

The canonical error envelope is finalised in card F5 (it must match TREK's current Express error responses byte-for-byte), so it is deliberately not invented in F1.