johannesschobel / fractal-typescript

fractal-typescript

master	development

An adaptation of the famous php fractal-framework for typescript.

Testing

$ npm run test

Installation

• Download source code of fractal-typescript from github
• Build source code running tsccommand
• Open project in which you want to use fractal-typescript
• Install local version of fractal-typescript using npm i {path to project}
• Start using fractal-typescript as classical import

Usage

• Fractal-typescript can be used similar to its php equivalent
• Fractal-typescript provides three serializer:
  • ArraySerializer
  • DataArraySerializer
  • JsonApiSerializer
• Custom transformers can also be used (see advanced example below)

Simple example

import {Collection, Manager, Scope} from "fractal-typescript";

const fractal = new Manager();

const books: Array<Book> = [
    {
        "id": "1",
        "title": "Hogfather",
        "yr": 1998,
        "author_name": "Philip K Dick",
        "author_email": "[e-mail]",
    },
    {
        "id": "2",
        "title": "Game Of Kill Everyone",
        "yr": 2014,
        "author_name": "George R. R. Satan",
        "author_email": "[e-mail]",
    }
];


const resource = new Collection(books, function() {
    return {
        "id": this.id,
        "title": this.title,
        "year": this.yr,
        "author": {
            "name": this.author_name,
            "email": this.author_email
        },
        "links": {
            "rel": "self",
            "uri": "/books/" + this.id
        }
    };
});

const result: TransformationResult<BookTransformed> = fractal.createData(resource).toObject();
const string = fractal.createData(resource).toString();

Advanced example

This example shows an advanced usage of fractal-typescript using custom transformer classes serialized with the JsonApiSerializer.

index.ts

import {Item, JsonApiSerializer, Manager, Scope} from "fractal-typescript";

const manager = new Manager();

const baseUrl = 'http://example.com';
const jsonApiSerializer = new JsonApiSerializer(baseUrl);
manager.setSerializer(jsonApiSerializer);

const data = {
_author: {
  id: 1,
  name: 'Dave'
}
id: 1,
title: 'Foo',
year: 1991
};

const resource = new Item(data, null, new JsonApiBookTransformer(), 'books');
const scope = new Scope(manager, resource);
const result = scope.toObject();

JsonApiBookTransformer

import {TransformerAbstract} from "fractal-typescript/dist/TransformerAbstract";
import {JsonApiAuthorTransformer} from "./JsonApiAuthorTransformer";
import {JsonApiBook} from "./JsonApiBook";

export class JsonApiBookTransformer extends TransformerAbstract {

    protected tempAuthor = {};
    protected tempCoAuthor = {};
    protected availableIncludes = [
        'author',
        'co-author',
        'author-with-meta'
    ];

    public transform(book: JsonApiBook) {
        this.tempAuthor = book._author;
        delete book._author;
        this.tempCoAuthor = book._co_author;
        delete book._co_author;
        return book;
    }

    public includeAuthor(book: JsonApiBook) {
        if (book._author !== undefined) {
            return;
        }

        if (book._author === null) {
            return this.null();
        }

        return this.item(this.tempAuthor, new JsonApiAuthorTransformer(), 'people');
    }

    public includeAuthorWithMeta(book: JsonApiBook) {
        if (book._author !== undefined) {
            return;
        }

        if (book._author === null) {
            return this.null();
        }
        const resource = this.item(this.tempAuthor, new JsonApiAuthorTransformer(), 'people');
        resource.setMeta({foo: 'bar'});
        return resource;
    }

    public includeCoAuthor(book: JsonApiBook) {
        if (book._co_author !== undefined) {
            return;
        }

        if (book._co_author === null) {
            return this.null();
        }

        return this.item(this.tempCoAuthor, new JsonApiAuthorTransformer(), 'people');
    }
}

JsonApiAuthorTransformer

import {JsonApiBookTransformer} from './JsonApiBookTransformer';
import {TransformerAbstract} from "fractal-typescript/dist/TransformerAbstract";

export class JsonApiAuthorTransformer extends TransformerAbstract {

    protected tempPublished = {};
    protected availableIncludes = [
        'published'
    ];

    public transform(author: {}) {
        this.tempPublished = author._published;
        delete author._published;
        return author;
    }

    public includePublished(author: {}) {
        return this.collection(this.tempPublished, null, new JsonApiBookTransformer(), 'books');
    }

}

Links

• Fractal Source Code
• Fractal Documentation

Maintainers

• Daniel Kempf
• Paul Romahn