Options
All
  • Public
  • Public/Protected
  • All
Menu

@devoinc/app-developer-kit

Index

Namespaces

Classes

Interfaces

Type Aliases

Type Aliases

CompactFieldResponse

CompactFieldResponse: { index: number; type: string }

Field of a compact query response.

Type declaration

  • index: number
  • type: string

CompactQueryResponse

CompactQueryResponse: { fields: {} }

Compact query response.

Type declaration

Dates

Dates: { from: Date | number; to: Date | number }

From/to date object See this for reference: https://github.com/DevoInc/js-helper/blob/6ba3a8ec27a5ce4449a5a957b161ca81718c1b06/lib/config.js#L66

param dateFrom

start date. If it's a number value, it should be in epoc ms.

param dateTo

end date. If it's a number value, it should be in epoc ms.

Type declaration

  • from: Date | number
  • to: Date | number

DevoAppConfig

DevoAppConfig: { standaloneDependencies?: WebCoreRuntimeDeps; timeout?: number; onAppUnmount?: any }

Configuration for a Devo App initialization.

Type declaration

  • Optional standaloneDependencies?: WebCoreRuntimeDeps

    Standalone dependencies.

    remarks

    This field is used to override the default WebCoreRuntimeDeps from Devo web core in a standalone mode.

  • Optional timeout?: number

    Default timeout for web core communication requests.

  • onAppUnmount?:function
    • onAppUnmount(): void

NotiPopAction

NotiPopAction: { element: string | HTMLElement; onClick: any }

NotiPop action model

Type declaration

NotiPopPosition

NotiPopPosition: "top-left" | "top-center" | "top-right" | "bottom-left" | "bottom-center" | "bottom-right"

Different positions that notifications could have in the screen.

NotiPopRequest

NotiPopRequest: { actions?: NotiPopAction[]; iconClass?: string; iconCloseClass?: string; position?: NotiPopPosition; size?: NotiPopSize; subtitle?: string; text: string; timer?: number; title?: string; type?: NotiPopType }

Request to create a notification on the screen.

Type declaration

  • Optional actions?: NotiPopAction[]

    Actions that a notification can have. These will appear as different actionable buttons.

    optional
  • Optional iconClass?: string

    NotiPop main icon class

    optional
    default

    'lticon-information_about'

  • Optional iconCloseClass?: string

    NotiPop close icon class

    optional
    default

    'lticon-exit_close'

  • Optional position?: NotiPopPosition

    NotiPop position

    optional
    default

    'top-right'

  • Optional size?: NotiPopSize

    NotiPop size

    optional
    default

    'md'

  • Optional subtitle?: string

    NotiPop subtitle

    optional
  • text: string

    NotiPop content text

    required
  • Optional timer?: number

    NotiPop timeout in milliseconds

    optional
    default

    auto

  • Optional title?: string

    NotiPop title

    optional
  • Optional type?: NotiPopType

    NotiPop type

    optional
    default

    'success'

NotiPopSize

NotiPopSize: "lg" | "md" | "sm"

Different sizes that notifications could have in the screen.

NotiPopType

NotiPopType: "default" | "info" | "success" | "error" | "help" | "warning"

Different types of notifications.

Query

Query: { dates: Dates; queryString: string }

Devo query.

Type declaration

  • dates: Dates

    Date range

  • queryString: string

    Query string

QueryClientResponse

QueryClientResponse: { data: QueryClientResponseData[]; metadata: QueryClientResponseMetadata }

Query client response type

Type declaration

QueryClientResponseData

QueryClientResponseData: {}

Query response result as a diccionary of QueryResponseDataType

Type declaration

QueryClientResponseDataType

QueryClientResponseDataType: number | string | boolean

query result types as number or strings;

QueryClientResponseMetadata

QueryClientResponseMetadata: { fields: {} }

Query response metadata.

Type declaration

QueryClientResponseMetadataType

QueryClientResponseMetadataType: { index: number; type: string }

Field type of a query response metadata type.

Type declaration

  • index: number
  • type: string

QueryClientResponseProgress

QueryClientResponseProgress: number[]

Query client response progress type

StreamDates

StreamDates: { from: Date | number; to?: Date | number }

From/to types for stream queries

param dateFrom

start date. If it's a number value, it should be in epoc ms. If undefined it will be replaced with new Date()

param dateTo

end date. If it's a number value, it should be in epoc ms. If undefined, the stream will be left opened

Type declaration

  • from: Date | number
  • Optional to?: Date | number

StreamQuery

StreamQuery: { dates: StreamDates; queryString: string }

Devo query type for streaming

Type declaration

  • dates: StreamDates

    Date range

  • queryString: string

    Query string

UserApplication

UserApplication: { id: number; name: string; nameI18n: string; path: string; type: string }

Current user application.

Type declaration

  • Readonly id: number
  • Readonly name: string
  • Readonly nameI18n: string
  • Readonly path: string
  • Readonly type: string

UserCredentials

UserCredentials: { activeboardsURI: string; alertsURI: string; apiKey: string; apiSecret: string; enigmaURI: string; investigationsURI: string; jwtSessionCredentials: { apiKey: string; jwtUserId: string }; marketplaceBundle: string; marketplaceURI: string; serrea: string; standAloneToken: string }

Current user credentials.

Type declaration

  • Readonly activeboardsURI: string
  • Readonly alertsURI: string
  • Readonly apiKey: string
  • Readonly apiSecret: string
  • Readonly enigmaURI: string
  • Readonly investigationsURI: string
  • Readonly jwtSessionCredentials: { apiKey: string; jwtUserId: string }
    • Readonly apiKey: string
    • Readonly jwtUserId: string
  • Readonly marketplaceBundle: string
  • Readonly marketplaceURI: string
  • Readonly serrea: string

    Serrea url

  • Readonly standAloneToken: string

    Tapu token

UserInfo

UserInfo: { applications: UserApplication[]; credentials: UserCredentials; domain: string; email: string; locale: string; name: string; roles: UserRole[]; timezone: string; vault: UserVault }

Current user information.

Type declaration

  • Readonly applications: UserApplication[]

    Current user apps

  • Readonly credentials: UserCredentials

    credentials

  • Readonly domain: string

    domain

  • Readonly email: string

    User email

  • Readonly locale: string

    user locale (language)

  • Readonly name: string

    User name

  • Readonly roles: UserRole[]

    User roles

  • Readonly timezone: string

    timezone

  • Readonly vault: UserVault

    vault

UserRole

UserRole: { id: number; name: string; type: string }

Current user role.

Type declaration

  • Readonly id: number
  • Readonly name: string
  • Readonly type: string

UserVault

UserVault: { id: number; label: string; name: string; share: number }

Current user vault.

Type declaration

  • Readonly id: number
  • Readonly label: string
  • Readonly name: string
  • Readonly share: number

WebCoreRuntimeDeps

WebCoreRuntimeDeps: { NotiPop?: any; userInfo: UserInfo; goToQuery: any }

Devo web core dependencies.

remarks

This type is based on the current WebCore dependency implementation. if you want to override these dependencies for a standalone mode, use the DevoAppProvider's init method with a custom object based on this type.

Type declaration

  • Optional Readonly NotiPop?: any

    NotiPop class

    remarks

    This field contain a class that is used to create a notipop alert on the screen. If you want to use a different implementation for a standalon mode, simply declare a class and pass it here. A NotiPopRequest will be passed to the constructor.

    Use this as example of how to fake notipop in standalon mode:

    class StandaloneNotipop {
     constructor(request: NotiPopRequest) {
         ...
     }
    }

    const standaloneDependencies: WebCoreRuntimeDeps = {
     NotiPop: StandaloneNotipop,
     ...
    }

    DevoAppProvider.init({
     standaloneDependencies,
    });
  • Readonly userInfo: UserInfo

    User info

  • goToQuery:function
    • goToQuery(query: string, dates: Dates): void

Generated using TypeDoc