README.md

simpli-web-sdk

Index

Enumerations

• Byte
• Currency
• FileFormat
• HttpStatus
• Lang

Classes

• $
• AdapOrderby
• AdapPagination
• AdapSearchfield
• AjvController
• AjvI18n
• AjvType
• Await
• AwaitController
• CnpjMaskPreset
• Collection
• CpfCnpjMaskPreset
• CpfMaskPreset
• DateMaskPreset
• DatetimeMaskPreset
• DefaultConfig
• EnumCollection
• InputCheckbox
• InputSelect
• InputText
• MaskPresetConfig
• MixinQueryRouter
• MixinUpload
• Modal
• ModalController
• Model
• PageCollection
• PhoneMaskPreset
• Render
• RenderAnchor
• RenderImage
• RenderSchema
• Request
• Resource
• ResourceCollection
• Response
• RgMaskPreset
• Schema
• SchemaBuilder
• Simpli
• SocketConnection
• Tip
• TipController
• ToastConfig
• UploadConfig
• ZipcodeMaskPreset

Interfaces

• $Prototype
• ComponentOptions
• DataBlueprint
• Dictionary
• DictionaryOfValidation
• FieldComponent
• FieldSet
• FileObject
• FilterOptions
• IResource
• IResourceCollection
• ISchema
• LocaleOptions
• MaskToken
• QueryRouter
• ResourceAction
• ResourceActionConfig
• SchemaResult
• SchemaSet
• SocketConfig
• SocketInstance
• SocketStatic
• ValidationArray
• ValidationNumber
• ValidationString

Type aliases

• ClassType
• EnumType
• FieldContent
• FieldController
• FieldData
• FieldValidation
• ID
• InputType
• NormalizedItem
• QueryFilter
• ResponseType
• TAG

Variables

• classToClass
• classToClassFromExist
• classToPlain
• classToPlainFromExist
• deserialize
• deserializeArray
• plainToClass
• plainToClassFromExist
• serialize

Functions

• HttpExclude
• HttpExpose
• RequestExclude
• RequestExpose
• ResponseExclude
• ResponseExpose
• ResponseSerialize
• abort
• addResource
• allWithPlaceholder
• appendResource
• bool
• buildResource
• clone
• cnpj
• copyToClipboard
• cpf
• cpfOrCnpj
• createCsvFile
• csvToData
• csvToNormalizedData
• date
• datetime
• error
• errorAndPush
• errorValidation
• getManyResource
• getResource
• historyBack
• info
• infoAndPush
• listObject
• normalizeData
• openUrl
• pad
• phone
• prependResource
• push
• pushByName
• removeDelimiters
• removeResource
• rg
• sleep
• success
• successAndPush
• time
• toString
• truncate
• uid
• warning
• warningAndPush
• zipcode

---

Type aliases

ClassType

Ƭ ClassType: object

Defined in interfaces/general.interface.ts:1

Type declaration

---

EnumType

Ƭ EnumType: Record<keyof E, number | string> & object

Defined in interfaces/general.interface.ts:7

---

FieldContent

Ƭ FieldContent: FieldComponent | FieldData

Defined in interfaces/schema.interface.ts:25

---

FieldController

Ƭ FieldController: function

Defined in interfaces/schema.interface.ts:23

Type declaration

▸(schema: SchemaResult<M>): FieldContent

Parameters:

Name	Type
schema	SchemaResult<M>

Returns: FieldContent

---

FieldData

Ƭ FieldData: string | number | null

Defined in interfaces/schema.interface.ts:27

---

FieldValidation

Ƭ FieldValidation: FieldValidation<V>

Defined in interfaces/schema.interface.ts:37

---

ID

Ƭ ID: number | string

Defined in interfaces/resource.interface.ts:3

---

InputType

Ƭ InputType: string | number | null

Defined in interfaces/general.interface.ts:9

---

NormalizedItem

Ƭ NormalizedItem: Record<keyof B, string> & object

Defined in interfaces/general.interface.ts:34

---

QueryFilter

Ƭ QueryFilter: Dictionary<any>

Defined in interfaces/general.interface.ts:15

---

ResponseType

Ƭ ResponseType: ClassType<T> | T

Defined in interfaces/general.interface.ts:5

---

TAG

Ƭ TAG: string

Defined in interfaces/resource.interface.ts:5

---

Variables

<Const> classToClass

● classToClass: classToClass = ClassTransformer.classToClass

Defined in helpers/transform.helper.ts:30

Converts class (constructor) object to new class (constructor) object. Also works with arrays.

---

<Const> classToClassFromExist

● classToClassFromExist: classToClassFromExist = ClassTransformer.classToClassFromExist

Defined in helpers/transform.helper.ts:37

Converts class (constructor) object to plain (literal) object. Uses given plain object as source object (it means fills given plain object with data from class object). Also works with arrays.

---

<Const> classToPlain

● classToPlain: classToPlain = ClassTransformer.classToPlain

Defined in helpers/transform.helper.ts:6

Converts class (constructor) object to plain (literal) object. Also works with arrays.

---

<Const> classToPlainFromExist

● classToPlainFromExist: classToPlainFromExist = ClassTransformer.classToPlainFromExist

Defined in helpers/transform.helper.ts:13

Converts class (constructor) object to plain (literal) object. Uses given plain object as source object (it means fills given plain object with data from class object). Also works with arrays.

---

<Const> deserialize

● deserialize: deserialize = ClassTransformer.deserialize

Defined in helpers/transform.helper.ts:47

Deserializes given JSON string to a object of the given class.

---

<Const> deserializeArray

● deserializeArray: deserializeArray = ClassTransformer.deserializeArray

Defined in helpers/transform.helper.ts:52

Deserializes given JSON string to an array of objects of the given class.

---

<Const> plainToClass

● plainToClass: plainToClass = ClassTransformer.plainToClass

Defined in helpers/transform.helper.ts:18

Converts plain (literal) object to class (constructor) object. Also works with arrays.

---

<Const> plainToClassFromExist

● plainToClassFromExist: plainToClassFromExist = ClassTransformer.plainToClassFromExist

Defined in helpers/transform.helper.ts:25

Converts plain (literal) object to class (constructor) object. Uses given object as source object (it means fills given object with data from plain object). Also works with arrays.

---

<Const> serialize

● serialize: serialize = ClassTransformer.serialize

Defined in helpers/transform.helper.ts:42

Serializes given object to a JSON string.

---

Functions

HttpExclude

▸ HttpExclude(): function

Defined in decorators/http.decorator.ts:27

Returns: function

---

HttpExpose

▸ HttpExpose(name?: undefined | string): function

Defined in decorators/http.decorator.ts:15

Parameters:

Name	Type
Optional name	undefined | string

Returns: function

---

RequestExclude

▸ RequestExclude(): function

Defined in decorators/http.decorator.ts:19

Returns: function

---

RequestExpose

▸ RequestExpose(name?: undefined | string): function

Defined in decorators/http.decorator.ts:11

Parameters:

Name	Type
Optional name	undefined | string

Returns: function

---

ResponseExclude

▸ ResponseExclude(): function

Defined in decorators/http.decorator.ts:23

Returns: function

---

ResponseExpose

▸ ResponseExpose(name?: undefined | string): function

Defined in decorators/http.decorator.ts:7

Parameters:

Name	Type
Optional name	undefined | string

Returns: function

---

ResponseSerialize

▸ ResponseSerialize(func: Function): function

Defined in decorators/http.decorator.ts:3

Parameters:

Name	Type
func	Function

Returns: function

---

abort

▸ abort(body: string, title?: undefined | string, useI18n?: boolean, config?: SnotifyToastConfig): void

Defined in helpers/toast.helper.ts:41

Parameters:

Name	Type	Default value
body	string	-
Optional title	undefined | string	-
Default value useI18n	boolean	true
Default value config	SnotifyToastConfig	{}

Returns: void

---

addResource

▸ addResource<R>(list: Array<R | IResource>, item: R | IResource, index?: undefined | number): void

Defined in helpers/resource.helper.ts:43

Type parameters:

R : Resource

Parameters:

Name	Type
list	Array<R | IResource>
item	R | IResource
Optional index	undefined | number

Returns: void

---

allWithPlaceholder

▸ allWithPlaceholder<R>(list: Array<R | IResource>, placeholder?: string | null): Array<R | IResource | null>

Defined in helpers/resource.helper.ts:5

Type parameters:

R : Resource

Parameters:

Name	Type	Default value
list	Array<R | IResource>	-
Default value placeholder	string | null	null

Returns: Array<R | IResource | null>

---

appendResource

▸ appendResource<R>(list: Array<R | IResource>, item: R | IResource): Array<R | IResource>

Defined in helpers/resource.helper.ts:35

Type parameters:

R : Resource

Parameters:

Name	Type
list	Array<R | IResource>
item	R | IResource

Returns: Array<R | IResource>

---

bool

▸ bool(val?: boolean | null): string

Defined in helpers/filter.helper.ts:8

Parameters:

Name	Type
Optional val	boolean | null

Returns: string

---

buildResource

▸ buildResource($id: ID, $tag: TAG): IResource

Defined in helpers/utils.helper.ts:21

Parameters:

Name	Type
$id	ID
$tag	TAG

Returns: IResource

---

clone

▸ clone<T>(fromEntity: T): T

Defined in helpers/utils.helper.ts:17

Type parameters:

T

Parameters:

Name	Type
fromEntity	T

Returns: T

---

cnpj

▸ cnpj(val?: string | number | null): string

Defined in helpers/filter.helper.ts:48

Parameters:

Name	Type
Optional val	string | number | null

Returns: string

---

copyToClipboard

▸ copyToClipboard(text: string): void

Defined in helpers/utils.helper.ts:100

Parameters:

Name	Type
text	string

Returns: void

---

cpf

▸ cpf(val?: string | number | null): string

Defined in helpers/filter.helper.ts:44

Parameters:

Name	Type
Optional val	string | number | null

Returns: string

---

cpfOrCnpj

▸ cpfOrCnpj(val?: string | number | null): string

Defined in helpers/filter.helper.ts:52

Parameters:

Name	Type
Optional val	string | number | null

Returns: string

---

createCsvFile

▸ createCsvFile(filename: string, csvStr: string): void

Defined in helpers/utils.helper.ts:31

Parameters:

Name	Type
filename	string
csvStr	string

Returns: void

---

csvToData

▸ csvToData(urlOrFile: string | File): Promise<ParseResult>

Defined in helpers/utils.helper.ts:58

Parameters:

Name	Type
urlOrFile	string | File

Returns: Promise<ParseResult>

---

csvToNormalizedData

▸ csvToNormalizedData<T>(urlOrFile: string | File, blueprint: T): Promise<Array<NormalizedItem<T>>>

Defined in helpers/utils.helper.ts:50

Type parameters:

T : DataBlueprint

Parameters:

Name	Type
urlOrFile	string | File
blueprint	T

Returns: Promise<Array<NormalizedItem<T>>>

---

date

▸ date(date?: string | Date | Moment | null): string

Defined in helpers/filter.helper.ts:16

Parameters:

Name	Type
Optional date	string | Date | Moment | null

Returns: string

---

datetime

▸ datetime(date?: string | Date | Moment | null): string

Defined in helpers/filter.helper.ts:12

Parameters:

Name	Type
Optional date	string | Date | Moment | null

Returns: string

---

error

▸ error(body: string, title?: undefined | string, useI18n?: boolean, config?: SnotifyToastConfig): void

Defined in helpers/toast.helper.ts:21

Parameters:

Name	Type	Default value
body	string	-
Optional title	undefined | string	-
Default value useI18n	boolean	true
Default value config	SnotifyToastConfig	{}

Returns: void

---

errorAndPush

▸ errorAndPush(body: string, uri: string, title?: undefined | string, useI18n?: boolean, config?: SnotifyToastConfig): void

Defined in helpers/toast.helper.ts:30

Parameters:

Name	Type	Default value
body	string	-
uri	string	-
Optional title	undefined | string	-
Default value useI18n	boolean	true
Optional config	SnotifyToastConfig	-

Returns: void

---

errorValidation

▸ errorValidation(message: string): void

Defined in helpers/toast.helper.ts:26

Parameters:

Name	Type
message	string

Returns: void

---

getManyResource

▸ getManyResource<R>(list: Array<R | IResource>, ids: ID[]): Array<R | IResource>

Defined in helpers/resource.helper.ts:23

Type parameters:

R : Resource

Parameters:

Name	Type
list	Array<R | IResource>
ids	ID[]

Returns: Array<R | IResource>

---

getResource

▸ getResource<R>(list: Array<R | IResource>, id: ID | null): R | IResource | null

Defined in helpers/resource.helper.ts:19

Type parameters:

R : Resource

Parameters:

Name	Type
list	Array<R | IResource>
id	ID | null

Returns: R | IResource | null

---

historyBack

▸ historyBack(): void

Defined in helpers/router.helper.ts:24

Returns: void

---

info

▸ info(body: string, title?: undefined | string, useI18n?: boolean, config?: SnotifyToastConfig): void

Defined in helpers/toast.helper.ts:62

Parameters:

Name	Type	Default value
body	string	-
Optional title	undefined | string	-
Default value useI18n	boolean	true
Default value config	SnotifyToastConfig	{}

Returns: void

---

infoAndPush

▸ infoAndPush(body: string, uri: string, title?: undefined | string, useI18n?: boolean, config?: SnotifyToastConfig): void

Defined in helpers/toast.helper.ts:67

Parameters:

Name	Type	Default value
body	string	-
uri	string	-
Optional title	undefined | string	-
Default value useI18n	boolean	true
Optional config	SnotifyToastConfig	-

Returns: void

---

listObject

▸ listObject(obj: Dictionary<ID>, i18nPath?: undefined | string): IResource[]

Defined in helpers/utils.helper.ts:25

Parameters:

Name	Type
obj	Dictionary<ID>
Optional i18nPath	undefined | string

Returns: IResource[]

---

normalizeData

▸ normalizeData<T>(data: any[], blueprint: T): Array<NormalizedItem<T>>

Defined in helpers/utils.helper.ts:77

Type parameters:

T : DataBlueprint

Parameters:

Name	Type
data	any[]
blueprint	T

Returns: Array<NormalizedItem<T>>

---

openUrl

▸ openUrl(url: string, targetBlank?: undefined | false | true): null | Window

Defined in helpers/router.helper.ts:20

Parameters:

Name	Type
url	string
Optional targetBlank	undefined | false | true

Returns: null | Window

---

pad

▸ pad(val?: string | number | null, length?: undefined | number): string

Defined in helpers/filter.helper.ts:56

Parameters:

Name	Type
Optional val	string | number | null
Optional length	undefined | number

Returns: string

---

phone

▸ phone(val?: string | number | null): string

Defined in helpers/filter.helper.ts:32

Parameters:

Name	Type
Optional val	string | number | null

Returns: string

---

prependResource

▸ prependResource<R>(list: Array<R | IResource>, item: R | IResource): Array<R | IResource>

Defined in helpers/resource.helper.ts:27

Type parameters:

R : Resource

Parameters:

Name	Type
list	Array<R | IResource>
item	R | IResource

Returns: Array<R | IResource>

---

push

▸ push(uri: string): void

Defined in helpers/router.helper.ts:4

Parameters:

Name	Type
uri	string

Returns: void

---

pushByName

▸ pushByName(name: string, ...ids: ID[]): void

Defined in helpers/router.helper.ts:8

Parameters:

Name	Type
name	string
Rest ids	ID[]

Returns: void

---

removeDelimiters

▸ removeDelimiters(val?: string | number | null): string

Defined in helpers/filter.helper.ts:28

Parameters:

Name	Type
Optional val	string | number | null

Returns: string

---

removeResource

▸ removeResource<R>(list: Array<R | IResource>, id: ID): void

Defined in helpers/resource.helper.ts:51

Type parameters:

R : Resource

Parameters:

Name	Type
list	Array<R | IResource>
id	ID

Returns: void

---

rg

▸ rg(val?: string | number | null): string

Defined in helpers/filter.helper.ts:40

Parameters:

Name	Type
Optional val	string | number | null

Returns: string

---

sleep

▸ sleep(ms: number): Promise<Object>

Defined in helpers/utils.helper.ts:13

Parameters:

Name	Type
ms	number

Returns: Promise<Object>

---

success

▸ success(body: string, title?: undefined | string, useI18n?: boolean, config?: SnotifyToastConfig): void

Defined in helpers/toast.helper.ts:5

Parameters:

Name	Type	Default value
body	string	-
Optional title	undefined | string	-
Default value useI18n	boolean	true
Default value config	SnotifyToastConfig	{}

Returns: void

---

successAndPush

▸ successAndPush(body: string, uri: string, title?: undefined | string, useI18n?: boolean, config?: SnotifyToastConfig): void

Defined in helpers/toast.helper.ts:10

Parameters:

Name	Type	Default value
body	string	-
uri	string	-
Optional title	undefined | string	-
Default value useI18n	boolean	true
Optional config	SnotifyToastConfig	-

Returns: void

---

time

▸ time(date?: string | Date | Moment | null): string

Defined in helpers/filter.helper.ts:20

Parameters:

Name	Type
Optional date	string | Date | Moment | null

Returns: string

---

toString

▸ toString(val?: string | number | null): string

Defined in helpers/filter.helper.ts:4

Parameters:

Name	Type
Optional val	string | number | null

Returns: string

---

truncate

▸ truncate(val?: string | number | null, length?: undefined | number): string

Defined in helpers/filter.helper.ts:24

Parameters:

Name	Type
Optional val	string | number | null
Optional length	undefined | number

Returns: string

---

uid

▸ uid(prefix?: undefined | string, suffix?: undefined | string): string

Defined in helpers/utils.helper.ts:9

Parameters:

Name	Type
Optional prefix	undefined | string
Optional suffix	undefined | string

Returns: string

---

warning

▸ warning(body: string, title?: undefined | string, useI18n?: boolean, config?: SnotifyToastConfig): void

Defined in helpers/toast.helper.ts:46

Parameters:

Name	Type	Default value
body	string	-
Optional title	undefined | string	-
Default value useI18n	boolean	true
Default value config	SnotifyToastConfig	{}

Returns: void

---

warningAndPush

▸ warningAndPush(body: string, uri: string, title?: undefined | string, useI18n?: boolean, config?: SnotifyToastConfig): void

Defined in helpers/toast.helper.ts:51

Parameters:

Name	Type	Default value
body	string	-
uri	string	-
Optional title	undefined | string	-
Default value useI18n	boolean	true
Optional config	SnotifyToastConfig	-

Returns: void

---

zipcode

▸ zipcode(val?: string | number | null): string

Defined in helpers/filter.helper.ts:36

Parameters:

Name	Type
Optional val	string | number | null

Returns: string

---