Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
protoc-gen-orm
command
Command protoc-gen-orm is a protoc plugin that reads proto descriptors annotated with google.api.* and orm.v1.* options, then generates database schema artifacts for the requested backend: gorm, sql, or prisma.
|
Command protoc-gen-orm is a protoc plugin that reads proto descriptors annotated with google.api.* and orm.v1.* options, then generates database schema artifacts for the requested backend: gorm, sql, or prisma. |
|
factory
|
|
|
config
Package config loads and validates orm.yaml — the factory's single source of truth.
|
Package config loads and validates orm.yaml — the factory's single source of truth. |
|
coreir
Package coreir is the factory's shared intermediate model.
|
Package coreir is the factory's shared intermediate model. |
|
source/graphql
Package graphql is the factory Source that reads a GraphQL server: it introspects a live endpoint (or reads a cached GraphQL SDL schema, .graphql), then builds the GraphQL IR under the configured dialect.
|
Package graphql is the factory Source that reads a GraphQL server: it introspects a live endpoint (or reads a cached GraphQL SDL schema, .graphql), then builds the GraphQL IR under the configured dialect. |
|
source/proto
Package proto is the factory Source that reads proto descriptors.
|
Package proto is the factory Source that reads proto descriptors. |
|
source/proto/backend
Package backend is orm's schema.Backend: the bridge between protokit's generic IR builder and orm's own annotation package.
|
Package backend is orm's schema.Backend: the bridge between protokit's generic IR builder and orm's own annotation package. |
|
target/database
Package database adapts protokit's proto-bound schema.Target (gorm, sql, prisma) to the factory's source-agnostic factory.Target.
|
Package database adapts protokit's proto-bound schema.Target (gorm, sql, prisma) to the factory's source-agnostic factory.Target. |
|
target/gorm
Package gorm generates production-ready Go structs with GORM struct tags.
|
Package gorm generates production-ready Go structs with GORM struct tags. |
|
target/graphql
Package graphql is the "graphql" factory Target: it renders a typed GraphQL client from the Model's GraphQL facet.
|
Package graphql is the "graphql" factory Target: it renders a typed GraphQL client from the Model's GraphQL facet. |
|
target/graphql/golang
Package golang renders a Go client from the IR using an interface/handler architecture grouped by domain.
|
Package golang renders a Go client from the IR using an interface/handler architecture grouped by domain. |
|
target/graphql/golang/selection
Package selection renders Go model struct bodies from IR objects.
|
Package selection renders Go model struct bodies from IR objects. |
|
target/graphql/golang/typemap
Package typemap maps GraphQL types to Go types for the generated client.
|
Package typemap maps GraphQL types to Go types for the generated client. |
|
target/prisma
Package prisma generates a multi-file Prisma schema tree from the orm IR, replicating the hand-written layout this repository uses:
|
Package prisma generates a multi-file Prisma schema tree from the orm IR, replicating the hand-written layout this repository uses: |
|
target/repository
Package repository generates provider-agnostic, proto-facing repository layers from the same proto-derived schema the database targets render: one CRUD interface per resource (speaking proto messages and AIP conventions — resource names, page tokens, field masks, etags) plus adapters composing the generated gorm output (models, stores, converters, filterx) and, when a client module is configured, the generated GraphQL client.
|
Package repository generates provider-agnostic, proto-facing repository layers from the same proto-derived schema the database targets render: one CRUD interface per resource (speaking proto messages and AIP conventions — resource names, page tokens, field masks, etags) plus adapters composing the generated gorm output (models, stores, converters, filterx) and, when a client module is configured, the generated GraphQL client. |
|
target/sql
Package sql generates PostgreSQL DDL from the orm IR.
|
Package sql generates PostgreSQL DDL from the orm IR. |
|
target/types
Package types is orm's projection of the neutral schema.FieldType onto the canonical PostgreSQL type the gorm/sql/prisma targets render from.
|
Package types is orm's projection of the neutral schema.FieldType onto the canonical PostgreSQL type the gorm/sql/prisma targets render from. |
|
wire
Package wire is the factory's composition root: it assembles the registered sources and targets into one Registry.
|
Package wire is the factory's composition root: it assembles the registered sources and targets into one Registry. |
|
pb
|
|
Click to show internal directories.
Click to hide internal directories.