@sequenceholdings/orm 0.1.2 → 0.1.3

package/README.md

@@ -1,11 +1,21 @@
 # @sequenceholdings/orm
 
-Sequence ORM — the OpCo data layer. Tables, links, row policies, and actions are defined in YAML per namespace; the platform compiles them into Postgres tables with forced row-level security in the OpCo's Lakebase, serves them through the Atlas Data API, and generates a typed client.
+Sequence ORM — the OpCo data layer. V2 namespaces define managed tables and
+read-only views in TypeScript, compile named GraphQL operations to persisted
+IR, and execute them through the governed Atlas Data API. Legacy v1 YAML
+namespaces remain supported during migration.
 
 Design source of truth: the "Sequence ORM: OpCo Data Layer" Notion page.
 
 This package is the pure core — no Atlas imports, no database access:
 
+- `authoring/` — TypeScript `defineTable` / `defineView` DSL. View queries use
+  Drizzle through `@sequenceholdings/orm/drizzle`; only normalized SQL and
+  dependencies enter canonical JSON.
+- `canonical/` — validated v2 table/view wire contract shared by CLI and Atlas.
+- `compiler-gql/`, `sdl/`, and `ir/` — read/write table operations plus
+  read-only keyed or keyless view queries compiled to persisted operation IR.
+
 - `schema/` — zod schemas for the YAML definition surface (tables, columns, links, indexes, policies, actions)
 - `migrations/` — the committed migration workspace (`orm diff`, offline `--check` verification, destructive-statement classification)
 - `predicate/` — the policy expression grammar (`claim('…')`, `capability('…')`, comparisons, `and`/`or`/`not`)