A powerful tool designed to simplify data fetching in a model-driven way, using ORM techniques to streamline and ease the maintenance of API-dependent code.

Installation

First have your graphql server prepared then:

npm install @k1zang/models

or

yarn add @k1zang/models

Import and setup models

import BaseModel, { relation } from "@k1zang/models";

abstract class AbstractModel extends BaseModel {
  static apiUri = "http://loaclhost:8000/graphql";
}

class CartModel extends AbstractModel {
  public id?: number;
}

class UserModel extends AbstractModel {
  public name?: string = "";

  @relation.oneToOne(CartModel)
  public cart?: CartModel;
}

Not preferring typescript? then:

class UserModel {
  // ...
  cart;
  static relations = {
    cart: CartModel,
  };
}

Designed for professionals who require flexibility. Simply override the components you need to customize.

Usage

With Graphql The gql method returns the Apollo client api

const user = await UserModel.gql`query { user { cart { id } } }`.query();

Too complicated? use Abstracted api; Use methods provided by the Model class to interact with your models:

// Fetch all users
const users = await UserModel.all();

// Create a new user
const newUser = await UserModel.create({
  name: "John Doe",
});

Relations are automatically resolved

(await UserModel.first()).cart; // CartModel instance

Note: refer to the source code and comments for more detailed information about each method and how to use them.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT