0.1.3 β€’ Published 5 months ago

grng v0.1.3

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

smile

GRNG - in active development. Not ready for production.

Overview

grng - Pronounced like "grunge". This is a lightweight, Angular-native GraphQL client designed to seamlessly integrate with Angular 19’s resource API. It provides a minimalistic and efficient way to manage GraphQL queries, mutations, and subscriptions using Angular’s reactivity model. The goal is to reduce boilerplate, enhance developer experience, and ensure optimal performance with Signals and RxJS.

Contacts

Telegram

Features

πŸš€ Angular 19 resource Integration

  • Native support for resource(), leveraging Signals for reactivity.
  • Declarative API that simplifies GraphQL operations.

πŸ”₯ Minimal Boilerplate, Maximum Power

  • Short and intuitive function names: queryResource, mutateResource, query$, and mutate$.
  • No unnecessary decorators or complex configurations.

πŸ”„ Dual API: Signals & RxJS

  • Signal-based API: Uses resource() for automatic reactivity.
  • RxJS-based API: Returns Observable for flexibility in streaming data.

πŸ“¦ Built-in Caching and State Management

  • Optional caching mechanism with auto-invalidation.
  • Fine-grained control over fetch policies (network-only, cache-first, etc.).

πŸ”‘ First-class TypeScript Support

  • Strongly typed queries and mutations.
  • Seamless integration with GraphQL Codegen.

πŸ“‘ WebSocket Support for Subscriptions (Planned Feature)

  • subResource and sub$ for GraphQL subscriptions.
  • Real-time updates with WebSockets.

🌍 SSR and Angular Universal Friendly

  • Optimized for server-side rendering with Angular Universal.
  • Automatic state hydration on the client.

πŸ— Flexible Transport Layer

  • Works with fetch(), HttpClient, or custom transport strategies.
  • Easy authentication handling via interceptors or headers.

Installation

npm install grng

Usage

Query with resource

import { queryResource } from 'grng';
import { signal, Injectable } from '@angular/core';

@Injectable({ providedIn: 'root' })
export class UserService {
  getUser = queryResource<{ user: User }>(gql`
    query GetUser($id: ID!) {
      user(id: $id) {
        id
        name
      }
    }
  `, { id: signal('123') });
}

Mutation with resource

import { mutateResource } from 'grng';

@Injectable({ providedIn: 'root' })
export class UserService {
  updateUser = mutateResource<{ updateUser: User }>(gql`
    mutation UpdateUser($id: ID!, $input: UserInput!) {
      updateUser(id: $id, input: $input) {
        id
        name
      }
    }
  `);
}

RxJS API

Query with Observable

import { query$ } from 'grng';

@Injectable({ providedIn: 'root' })
export class UserService {
  getUser$ = query$<{ user: User }>(gql`
    query GetUser($id: ID!) {
      user(id: $id) {
        id
        name
      }
    }
  `, { id: '123' });
}

Mutation with Observable

import { mutate$ } from 'grng';

@Injectable({ providedIn: 'root' })
export class UserService {
  updateUser$ = mutate$<{ updateUser: User }>(gql`
    mutation UpdateUser($id: ID!, $input: UserInput!) {
      updateUser(id: $id, input: $input) {
        id
        name
      }
    }
  `);
}

Contributing

We welcome contributions! Feel free to open issues and submit pull requests.

License

MIT License

0.1.3

5 months ago

0.1.2

5 months ago

0.1.1

5 months ago

0.1.0

5 months ago