Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
122 lines (97 sloc) 3.43 KB

TypeScript SDK

Framework-agnostic TypeScript SDK containing CUBA data model
(entities and enums), rest services and queries as TypeScript classes.

It's possible to generate the following configurations of sdk depending on your needs (see usage instruction):

  • gen-cuba-front sdk:model - generates entities and enums
  • gen-cuba-front sdk:all - generates all toolkit - entities, enums, queries and services

SDK can be used for front-end clients and Node.js-based BFF (Backend for Frontend) development.


Persistent entities

Consider the Role entity class of CUBA Framework generated in TypeScript:


export class Role extends StandardEntity {
    static NAME = "sec$Role";
    name?: string | null;
    locName?: string | null;
    description?: string | null;
    type?: any | null;
    defaultRole?: boolean | null;
    permissions?: Permission[] | null;
  • you can easily access entity name by static NAME property: Role.NAME,
  • class contains all properties of domain model entity including from class hierarchy, reference fields have corresponding types as well so that you can work with them in a type-safe manner:
function changeRole(role: Role) {
  role.defaultRole = true;   // ok
  role.defaultRole = 'foo';  // compilation fails  

Non-persistent entities

CUBA Platform supports non-persistent entities in model. Entity class should be annotated with com.haulmont.chile.core.annotations.MetaClass, and extended from com.haulmont.cuba.core.entity.BaseUuidEntity. Class properties annotated with com.haulmont.chile.core.annotations.MetaProperty will be included in generated model.



import com.haulmont.chile.core.annotations.MetaClass;
import com.haulmont.chile.core.annotations.MetaProperty;
import com.haulmont.cuba.core.entity.BaseUuidEntity;

@MetaClass(name = "SampleUserInfo")
public class SampleUserInfo extends BaseUuidEntity {

    public String firstName;

    public String lastName;


export class SampleUserInfo {
    static NAME = "SampleUserInfo";
    firstName?: string | null;
    lastName?: string | null;


CUBA REST API module uses enum’s constant name in client-server communication. SDK contains generated string enums e.g.:

export enum CarType {
    SEDAN = "SEDAN",

In order to get enum id and localized caption, you can query full information about enums in runtime using loadEnums method of cuba-rest-js:

import {EnumInfo, initializeApp} from "@cuba-platform/rest";

const cubaREST = initializeApp();
    .then(((enums: EnumInfo[]) => {
        console.log('enums', enums)

Response example:

    "name": "",
    "values": [
        "name": "SEDAN",
        "id": "SEDAN",
        "caption": "Sedan"
        "name": "HATCHBACK",
        "id": "HATCHBACK",
        "caption": "Hatchback"
You can’t perform that action at this time.