mongez-http-resource

name	mongez-http-resource
description	@mongez/http `Resource` class — zero-boilerplate RESTful CRUD: `list`, `get`, `create`, `update`, `patch`, `delete`, `bulkDelete`, `publish`, `action`, `path`, `actionPath`, `useHttp`. Lazy `http` getter from `getCurrentHttp()`. Extend with a `route` string. Implements `ResourceService`.

Resource class

Zero-boilerplate RESTful CRUD helper. Extend and set route.

class Resource {
  route: string = ''
  defaultListParams: HttpParams = {}

  // All methods return CancellablePromise<HttpResult<T>>
  list<T>(params?: HttpParams, options?: RequestOptions): CancellablePromise<HttpResult<T>>
  get<T>(id: number | string, options?: RequestOptions): CancellablePromise<HttpResult<T>>
  create<T>(data: HttpData, options?: RequestOptions): CancellablePromise<HttpResult<T>>
  update<T>(id: number | string, data: HttpData, options?: RequestOptions): CancellablePromise<HttpResult<T>>
  // PATCH body goes via `options.data` (no separate data argument).
  patch<T>(id: number | string, options?: RequestOptions): CancellablePromise<HttpResult<T>>
  delete<T>(id: number | string, options?: RequestOptions): CancellablePromise<HttpResult<T>>
  bulkDelete<T>(data: HttpData, options?: RequestOptions): CancellablePromise<HttpResult<T>>
  publish<T>(id, published, publishKey?, options?): CancellablePromise<HttpResult<T>>

  // Non-CRUD action on a specific record — POST by default, override via `method`.
  action<T>(
    id: number | string,
    actionName: string,
    data?: HttpData,
    options?: RequestOptions,
    method?: HttpMethod,
  ): CancellablePromise<HttpResult<T>>

  path(suffix?: string | number): string         // concatRoute(route, suffix)
  actionPath(id: string | number, actionName: string): string
  useHttp(instance: Http): this                  // override Http instance for this resource
}

Usage

import { Resource } from '@mongez/http';
import type { User } from './types';

class UsersResource extends Resource {
  route = '/users';
}

export const usersResource = new UsersResource();

// List
const { data: users, error } = await usersResource.list<User[]>({ page: 1, limit: 20 });

// Get one
const { data: user } = await usersResource.get<User>(42);

// Create
const { data: newUser } = await usersResource.create<User>({ name: 'Alice', email: '[e-mail]' });

// Update (PUT)
const { data: updated } = await usersResource.update<User>(42, { name: 'Alice Updated' });

// Partial update (PATCH) — body is supplied via `options.data`
await usersResource.patch(42, { data: { avatar: 'url' } });

// Delete
await usersResource.delete(42);

// Bulk delete
await usersResource.bulkDelete({ ids: [1, 2, 3] });

// Publish / Unpublish
await usersResource.publish(42, true);
await usersResource.publish(42, false, 'active'); // custom key

// Non-CRUD actions on a specific record
await usersResource.action(42, 'activate');                       // POST   /users/42/activate
await usersResource.action(5, 'refund', { amount: 100 });         // POST   /orders/5/refund
await usersResource.action(1, 'publish', undefined, {}, 'PATCH'); // PATCH  /posts/1/publish

Http resolution

Resource.http is a lazy getter — it calls getCurrentHttp() on first access. Call setCurrentHttp(http) at app bootstrap; all Resources resolve it at request time.

To use a different Http instance for a single resource:

const adminHttp = new Http({ baseURL: 'https://admin.api.com', auth: adminToken });
export const adminUsers = new UsersResource().useHttp(adminHttp);

Nested resources

class PostCommentsResource extends Resource {
  constructor(postId: number) {
    super();
    this.route = `/posts/${postId}/comments`;
  }
}

const comments = new PostCommentsResource(5);
await comments.list();   // GET /posts/5/comments

Pagination helper subclass

class PaginatedResource<T> extends Resource {
  async page(n: number, perPage = 20) {
    return this.list<{ data: T[]; total: number }>({
      page: n,
      per_page: perPage,
    });
  }
}

class UsersResource extends PaginatedResource<User> {
  route = '/users';
}

const { data } = await new UsersResource().page(2, 50);  // GET /users?page=2&per_page=50