npm NuGet v1.0.0 MIT

@metaengine/graphql-angular

GraphQL SDL → Angular services and models with typed queries, mutations & subscriptions, inject() DI, interceptors, and HTTP-status error handling. Idiomatic Angular 19+ over GraphQL-on-HTTP.

GraphQL SDLMetaEngine IRTypeScript · Angular
Install

Pick your registry

The same generator, published to every ecosystem we support. Install however your project expects.

npmPrimary@metaengine/graphql-angular
$npm install @metaengine/graphql-angular
v1.0.0
NuGetMetaEngine.TypeScript.GraphQL.Angular
$dotnet add package MetaEngine.TypeScript.GraphQL.Angular
v1.0.0
Usage

Drive it from the CLI or programmatically

npm ships a zero-config CLI. NuGet ships the same generator as a C# fluent API — same options, same output.

npm · npx · CI-friendly

After install, point the CLI at your schema. It writes the generated tree to your chosen output directory.

Basic syntax
terminal
npx @metaengine/graphql-angular <input> <output> [options]

Generates Angular TypeScript services and models from GraphQL schemas — typed queries, mutations & subscriptions over Angular HttpClient.

Quick examples
Generate from a schema file
npx @metaengine/graphql-angular schema.graphql ./src/app/api
With Angular best practices
npx @metaengine/graphql-angular schema.graphql ./src/app/api \
  --inject-function \
  --provided-in root \
  --documentation
With error handling, retries and a scalar mapping
npx @metaengine/graphql-angular schema.graphql ./src/app/api \
  --error-handling \
  --retries 3 \
  --custom-scalar DateTime=string
CLI options
Option
Description
--fragments
Emit reusable named fragments for object-type selections
--one-of-inputs
Generate idiomatic @oneOf input types (tagged-union inputs)
--custom-scalar <Scalar=target>
Map a GraphQL custom scalar to a TS type. Repeatable. Targets: string · number · boolean · Date (e.g. DateTime=string)
--provided-in <scope>
Angular injection scope (root, any, platform)
--base-url-token <name>
Injection token name for base URL [default: BASE_URL]
--inject-function
Use inject() instead of constructor injection (Angular 14+)
--interceptors
Generate Angular interceptors so cross-cutting concerns (auth, headers) live in interceptors
--error-handling
Smart error handling based on HTTP status semantics
--retries <max-attempts>
Enable retries with exponential backoff (status 429, 503)
--documentation
Generate JSDoc comments from SDL descriptions
--date-transformation
Convert Date-typed scalar fields (e.g. DateTime) in responses to JavaScript Date objects
--options-threshold <n>
Parameter count to use options object [default: 4]
--types-barrel
Emit an index.ts barrel per folder plus a root index.ts re-exporting everything
--clean
Clean output directory (remove files not in generation)
--verbose
Enable verbose logging
--help, -h
Show help message
Options reference

Every knob, documented

Every option is available on the C# fluent API as a method, and most are also exposed as CLI flags. Cross-cutting auth, headers, retries and timeouts apply across frameworks.

Angular Options

5
  • WithBaseUrlToken(string)Injection token name for base URL (default: "BASE_URL")
  • WithInjectFunction()Use inject() instead of constructor DI (Angular 14+)
  • WithProvidedIn(string)Injection scope ("root", "platform", "any")
  • WithInterceptors()Generate interceptor infrastructure (ApiMiddleware type + provideApiInterceptors factory) so auth / headers live in interceptors
  • WithResponseDateTransformation()Convert Date-typed scalar fields (e.g. DateTime) in responses to Date objects

Auth · Headers · Resilience

12
  • WithErrorHandling()Smart error handling based on HTTP status semantics (404 / 403 → null · 400 / 422 / 409 → error body · 401 / 5xx → throw). GraphQL operations travel over HTTP POST.
  • WithErrorHandling(errors => errors...)Per-status routing: ReturnNullFor(404, 403) · ReturnErrorFor(400, 422) · ThrowFor(401, 500)
  • WithBearerAuth()Bearer token from env var (default API_TOKEN) — adds Authorization header
  • WithBearerAuth(string)Bearer token from a specific env var name
  • WithBearerAuth(string, string)Bearer token with custom header name
  • WithBasicAuth(string, string)HTTP Basic auth from username + password env vars
  • WithCustomHeader(string, string)Static header from env var. Repeatable (e.g. X-Tenant-ID ← TENANT_ID)
  • WithTimeout(double)Request timeout in seconds for all operations
  • WithTimeout(double?, double?, double?, double?)Granular timeout: connect · read · write · pool
  • WithRetries()Retries with exponential backoff (default status 429, 503)
  • WithRetries(int)Retries with custom max attempts
  • WithRetries(int, double, double, int[])Retries with full custom settings including status codes

GraphQL Options

8
  • WithDocumentation()Generate JSDoc comments from SDL type & field descriptions
  • WithFragments()Emit reusable named fragments for object-type selections (...TypeFields spreads)
  • WithOneOfInputs()Generate idiomatic @oneOf input types (tagged-union inputs where exactly one field is set)
  • WithCustomScalar(string, Type)Map a GraphQL custom scalar to a TS type (e.g. DateTime → Date). Unmapped scalars default to string
  • WithSubscriptionUrl(string)Override the WebSocket subscription path appended to baseUrl (default: "/graphql")
  • WithTypeFilter(Func)Filter extracted GraphQL types before registration — only types returning true are generated
  • WithMethodNames(Func)Custom method naming rule
  • WithOptionsObjectThreshold(int)Parameter count for options object (default: 4)

TypeScript Output

1
  • WithTypesBarrel()Emit an index.ts barrel per folder plus a root index.ts re-exporting everything

Naming Transformations

3
  • Types(Func)Transform type names
  • Paths(Func)Transform output paths
  • FileNames(Func)Transform file names

File Management

5
  • CleanDestination()Clean output directory before generation
  • AlwaysOverwrite()Always overwrite existing files
  • OnlyWhenModelChanged()Update only when model changes
  • OnlyWhenNew()Write only new files, preserve existing
  • CleanDirectories(...)Clean specific subdirectories

Diagnostics

1
  • EnableVerboseLogging()Enable detailed logging
Features

Why this package is different

Deterministic output
Same spec + same options produce byte-identical files. Safe to commit, safe to diff in review, safe to cache in CI.
Tree-shakeable
One file per tag (or per operation) means bundlers drop unused code at build time. No runtime dispatch table.
Zero runtime
Validation and clients opt in. The default emit is pure types with no dependency surface beyond your HTTP lib.
Flexible naming
Case conventions configurable per role — types, properties, operations, enums. Idiomatic in the target by default.
Type resolution
Discriminated unions for oneOf, proper nullability, bigint when the spec mandates it, refs flattened only when safe.
Semver-honest
Spec diff drives the version bump. Additive changes = minor, removed ops = major. Never a surprise in your lockfile.