How to use

Installing

Usage example

import{ApiPropertyRef}from'@z-brain/api-entity-ref';import{Account}from'../types';exportabstractclassAccountBaseDtoimplementsOmit<Account,'id'>{  @ApiPropertyRef()publicemail!:string;  @ApiPropertyRef()publicfirstName?:string;}

import{ApiEntityRef,ApiPropertyRef}from'@z-brain/api-entity-ref';import{EEntityValidationGroup}from'@lib/common/enums';import{Account}from'../types';import{AccountBaseDto}from'./account-base.dto';@ApiEntityRef(Account,{groups:[EEntityValidationGroup.Create]})exportclassAccountCreateDtoextendsAccountBaseDto{  @ApiPropertyRef()publiclastName?:string;}

import{Allow,IsNotEmpty}from'class-validator';import{ApiEntityRef}from'@z-brain/api-entity-ref';import{IDInt}from'@lib/common/types';import{EEntityValidationGroup}from'@lib/common/enums';import{Account}from'../types';import{AccountBaseDto}from'./account-base.dto';@ApiEntityRef(Account,{groups:[EEntityValidationGroup.Update]})exportclassAccountUpdateDtoextendsAccountBaseDtoimplementsOmit<Account,'fullName'>{  @Allow()  @IsNotEmpty()publicid!:IDInt;}

import{ApiProperty,ApiPropertyOptional,ApiResponseProperty}from'@nestjs/swagger';import{IsEmail,IsOptional,IsString,Length}from'class-validator';lmport{Type}from'class-transformer';import{IDInt}from'@lib/common/types';import{DEFAULT_EMAIL_MAX_LEN,DEFAULT_EMAIL_MIN_LEN,DEFAULT_NAME_MAX_LEN,DEFAULT_NAME_MIN_LEN,}from'@lib/common/db.constants';import{IsUnique}from'@lib/common/validators';import{EEntityValidationGroup}from'@lib/common/enums';classFirstLast{  @ApiPropertyOptional({example:'Ivan',maxLength:DEFAULT_NAME_MAX_LEN,minLength:DEFAULT_NAME_MIN_LEN,})  @IsOptional({always:true})  @IsString({always:true})  @Length(DEFAULT_NAME_MIN_LEN,DEFAULT_NAME_MAX_LEN,{always:true})  @Column({length:DEFAULT_NAME_MAX_LEN,nullable:true})publicfirst!:string;  @ApiPropertyOptional({example:'Trump',maxLength:DEFAULT_NAME_MAX_LEN,minLength:DEFAULT_NAME_MIN_LEN,})  @IsOptional({always:true})  @IsString({always:true})  @Length(DEFAULT_NAME_MIN_LEN,DEFAULT_NAME_MAX_LEN,{always:true})  @Column({length:DEFAULT_NAME_MAX_LEN,nullable:true})publiclast!:string;}@Entity()exportclassAccount{publicstaticreadonlyNAMELESS_FULL_NAME:string='Nameless User';  @ApiResponseProperty({example:1234})  @PrimaryGeneratedColumn('increment',{unsigned:true})publicid!:IDInt;  @ApiProperty({example:'ivan@gmail.com',maxLength:DEFAULT_NAME_MAX_LEN,minLength:DEFAULT_NAME_MIN_LEN,uniqueItems:true,})  @Column({length:DEFAULT_EMAIL_MAX_LEN,unique:true})  @IsOptional({groups:[EEntityValidationGroup.Update]})  @IsEmail(undefined,{always:true})  @IsUnique(Account,undefined,{always:true})  @Length(DEFAULT_EMAIL_MIN_LEN,DEFAULT_EMAIL_MAX_LEN,{always:true})publicemail!:string;  @Column(()=>Name)  @Type(()=>Name)publicname:FirstLast;  @ApiResponseProperty({example:'Ivan Trump',})publicgetfullName():string{returnthis.name.first&&this.name.last           ?`${this.name.first}${this.name.last}`           :this.name.first||this.name.last||(this.constructorastypeofAccount).NAMELESS_FULL_NAME;}}

Development notes

Quick Start

cd /code/z-braingit clone git@github.com:z-brain/api-entity-ref.gitcd api-entity-refyarn install

How to use NodeJS version from the.nvmrc

How to make a build

How to run lint

How to run tests

How to build and publish NPM package

npm run pre-push \&& npm version patch -m'Update package version version to %s' \&& npm run gen-public-package.json \&& cp README.md dist/ \&& npm publish dist --access public \&& git push --no-verify&& git push --tags --no-verify

How to build package to local installation

Author