Hapify

This document provides code examples to help you play with Hapify templates.

Prerequisites

Before reading this article, we recommend you to read the documentation about Hapify templates.

Creating a TypeScript class

Hapify (long)

<<# Import dependencies >>
<<for Dependencies not (hidden and internal) dep>>
import {<<dep pascal>>} from './<<dep pascal>>';
<<endfor>>

<<# Declare interfaces for enum fields >>
<<for Fields enum field>>
export type <<Model pascal>><<field pascal>>Enum =<<for field.enum e>> | '<<e snake>>'<<endfor>>;
<<endfor>>

<<if Model hasNotes>>
/** <<! Model>> */
<<endif>>
export class <<Model pascal>> {

    <<for Fields not primary field>>
        <<if field hasNotes>>
    /** <<! field>> */
        <<endif>>
        <<if field entity>>
    private <<field camel>>: number<<if field multiple>>[]<<endif>>;
        <<elseif field enum>>
    public <<field camel>>: <<Model pascal>><<field pascal>>Enum;
        <<elseif field datetime>>
    public <<field camel>>: Date;
        <<else>>
    public <<field camel>>: <<=field.type>>;
        <<endif>>
    <<endfor>>

    constructor(private <<PrimaryField camel>>: number) {}

    <<# Getter for primary field >>
    getId(): number {
        return this.<<PrimaryField camel>>
    }

    getLabel(): string {
        <<if Fields label>>
        return `<<=labels()>>`;
        <<else>>
        return this.getId().toString();
        <<endif>>
    }

    <<# Getter for each entity >>
    <<for Fields entity field>>

    get<<field pascal>>(): <<field.model pascal>><<if field multiple>>[]<<endif>> {
        <<if field multiple>>
        return this.<<field camel>>.map(id => new <<field.model pascal>>(id));
        <<else>>
        return new <<field.model pascal>>(this.<<field camel>>);
        <<endif>>
    }
    <<endfor>>

}

<<<
function labels() {
    return root.fields.label
        .map(label => "${this."+label.names.snake+"}")
        .join(' ');
}
>>>

Output 1

import {PlaceCategory} from './PlaceCategory';
import {Service} from './Service';
import {User} from './User';

/** Represent a restaurant */
export class Place {

    public name: string;
    public description: string;
    private categories: number[];
    public address1: string;
    public address2: string;
    /** Inferred from address fields */
    public latitude: number;
    /** Inferred from address fields */
    public longitude: number;
    public phone: string;
    public websiteUrl: string;
    private services: number[];
    public timetable: string;
    private owner: number;
    public disabled: boolean;

    constructor(private id: number) {}

    getId(): number {
        return this.id
    }

    getLabel(): string {
        return `${this.name}`;
    }

    getCategories(): PlaceCategory[] {
        return this.categories.map(id => new PlaceCategory(id));
    }

    getServices(): Service[] {
        return this.services.map(id => new Service(id));
    }

    getOwner(): User {
        return new User(this.owner);
    }
}

Output 2

export type UserRoleEnum = | 'admin' | 'user';

/** Represent a customer */
export class User {

    public name: string;
    public email: string;
    /** Hashed using BCrpyt */
    public password: string;
    public role: UserRoleEnum;
    /** Allow admins to disable this user */
    public banned: boolean;
    public lastConnectedAt: Date;

    constructor(private id: number) {}

    getId(): number {
        return this.id
    }

    getLabel(): string {
        return `${this.name}`;
    }

}