rc-transforms
A transformation layer that sits between orm and json responses
Inspired by Laravels Eloquent API Resources.
Installation
npm i rc-transformsor
pnpm add rc-transformsProgrammatic Usage
Create a resource file, PostResource.ts.
import { Resource } from "rc-transforms";
export class PostResource extends Resource {
topic: string;
toArray() {
return {
topic: this.topic
}
}
}Create a resource file, UserResource.ts.
import { Resource } from "rc-transforms";
import { PostResource } from "./PostResource"
export class UserResource extends Resource {
id: number;
fname: string;
created_at: string;
updated_at: string;
posts: Posts[];
lname: string;
toArray() {
return {
id: this.id,
fname: this.fname,
lname: this.lname,
posts: PostResource.collection(this.posts),
created_at: this.created_at,
updated_at: this.updated_at,
}
}
}Create some data and interface, maybe in data.ts
export interface Posts {
topic: string;
}
export interface User {
id: number;
fname: string;
lname: string;
created_at: string;
updated_at: string;
posts?: Posts[];
}
export const data: User[] = [{
id: 1,
fname: 'lalalan',
lname: 'nana',
created_at: '1990-02-01',
updated_at: '2000-02-01',
posts: [{
topic: 'im cool'
},
{
topic: 'so cool cool'
}
]
}, {
id: 2,
fname: 'bababan',
lname: 'nana',
created_at: '1990-02-01',
updated_at: '2000-02-01'
}]you can transform a single item:
const resource = new UserResource(data[0]);
console.log(resource);
/**
{
"id": 1,
"fname": "lalalan",
"lname": "nana",
"posts": [
{
"topic": "im cool"
},
{
"topic": "so cool cool"
}
],
"created_at": "1990-02-01",
"updated_at": "2000-02-01"
}
*/you can transform a all of them:
const collection = UserResource.collection(data);
console.log(collection);
/**
[
{
"id": 1,
"fname": "lalalan",
"lname": "nana",
"posts": [
{
"topic": "im cool"
},
{
"topic": "so cool cool"
}
],
"created_at": "1990-02-01",
"updated_at": "2000-02-01"
},
{
"id": 2,
"fname": "bababan",
"lname": "nana",
"posts": [
],
"created_at": "1990-02-01",
"updated_at": "2000-02-01"
}
]
*/Create a collection file, UserCollection.ts.
export class UserCollection {
constructor(data: object) {
return {
api: "v1",
meta: {
next: "---",
prev: "---"
},
data: data
}
}
}you can transform a collection wrapper:
const collection = UserResource.collection(new UserCollection(data));
console.log(collection);
/**
{
"api": "v1",
"meta": {
"next": "---",
"prev": "---"
},
"data": [
{
"id": 1,
"fname": "lalalan",
"lname": "nana",
"posts": [
{
"topic": "im cool"
},
{
"topic": "so cool cool"
}
],
"created_at": "1990-02-01",
"updated_at": "2000-02-01"
},
{
"id": 2,
"fname": "bababan",
"lname": "nana",
"posts": [
],
"created_at": "1990-02-01",
"updated_at": "2000-02-01"
}
]
}
*/you can transform a single item data key with collection wrapper:
const collection = UserResource.collection(new UserCollection([data[1]]));
console.log(collection);
/**
{
"api": "v1",
"meta": {
"next": "---",
"prev": "---"
},
"data": [
{
"id": 2,
"fname": "bababan",
"lname": "nana",
"posts": [
],
"created_at": "1990-02-01",
"updated_at": "2000-02-01"
}
]
}
*/