Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

onemsdk

ONEmCommunications101ISC0.18.1

ONEm developer library for NodeJS

onem, developer, sdk, node

readme

Classes

ATagAttrs
ATag
BrTag
CardTagAttrs
CardTag
CardActionTagAttrs
CardActionTag
CardActionsTag
CardAvatarTagAttrs
CardAvatarTag
CardContentTagAttrs
CardContentTag
CardHeaderTagAttrs
CardHeaderTag
CardMediaTagAttrs
CardMediaTag
FooterTag
FormTagAttrs
FormTag
HeaderTag
ImgTagAttrs
ImgTag
InputTagAttrs
InputTag
LiTagAttrs
LiTag
LoginTagAttrs
LoginTag
LogoutTagAttrs
LogoutTag
PTag
SectionTagAttrs
SectionTag
SnackbarTagAttrs
SnackbarTag
Tag
TextareaTag
UlTag
VideoTagAttrs
VideoTag

Typedefs

ATag ⇐ Tag
BrTag ⇐ Tag
CardTag ⇐ Tag
CardActionTag ⇐ Tag
CardActionsTag ⇐ Tag
CardAvatarTag ⇐ Tag
CardContentTag ⇐ Tag
CardHeaderTag ⇐ Tag
CardMediaTag ⇐ Tag
FooterTag ⇐ Tag
FormTag ⇐ Tag
HeaderTag ⇐ Tag
ImgTag ⇐ Tag
InputTag ⇐ Tag
LabelTag ⇐ Tag
LiTag ⇐ Tag
LoginTag ⇐ Tag
LogoutTag ⇐ Tag
PTag ⇐ Tag
SectionTag ⇐ Tag
SnackbarTag ⇐ Tag
Tag
TextareaTag ⇐ Tag
UlTag ⇐ Tag
VideoTag ⇐ Tag

ATagAttrs

Kind: global class

new ATagAttrs(href, method)

Param Type Description
href string
method 'GET' | 'POST' default 'GET'

ATag

Kind: global class

new ATag(children, attrs)

Param Type
children Array.<string>
attrs ATagAttrs

ATag.getAttributes(node)

Kind: static method of ATag

Param Type
node HTMLAnchorElement

BrTag

Kind: global class

CardTagAttrs

Kind: global class

new CardTagAttrs([action], [method])

Param Type Default Description
[action] string | Optional path to call when the card is selected
[method] string ""GET"" Optional method associated with the action

CardTag

Kind: global class
Properties

Name Type
children Array.<(CardHeaderTag|CardMediaTag|CardContentTag|CardActionsTag)>

new CardTag(attrs)

Param Type
attrs CardTagAttrs

CardTag.getAttributes(node) ⇒ CardTagAttrs

Kind: static method of CardTag

Param Type
node HTMLElement

CardActionTagAttrs

Kind: global class

new CardActionTagAttrs(name, path, method)

Param Type Description
name string name of the card action button
path string path for the callback when the card action is selected
method string to use for the callback

CardActionTag

Kind: global class

new CardActionTag(children, attrs)

Param Type
children undefined
attrs CardActionTagAttrs

CardActionTag.getAttributes(node) ⇒ CardActionTagAttrs

Kind: static method of CardActionTag

Param Type
node HTMLElement

CardActionsTag

Kind: global class

new CardActionsTag(children)

Param Type
children Array.<CardActionTag>

CardAvatarTagAttrs

Kind: global class

new CardAvatarTagAttrs([src], [name])

Param Type Description
[src] string public url of the avatar png image
[name] string name of the avatar

CardAvatarTag

Kind: global class

new CardAvatarTag(children, attrs)

Param Type
children undefined
attrs CardAvatarTagAttrs

CardAvatarTag.getAttributes(node) ⇒ CardAvatarTagAttrs

Kind: static method of CardAvatarTag

Param Type
node HTMLElement

CardContentTagAttrs

Kind: global class

new CardContentTagAttrs([title], [subtitle], [content])

Param Type Description
[title] string title of the card
[subtitle] string subtitle of the card
[content] string text content to be displayed

CardContentTag

Kind: global class

new CardContentTag(children, attrs)

Param Type
children undefined
attrs CardContentTagAttrs

CardContentTag.getAttributes(node) ⇒ CardContentTagAttrs

Kind: static method of CardContentTag

Param Type
node HTMLElement

CardHeaderTagAttrs

Kind: global class

new CardHeaderTagAttrs(title, [subtitle])

Param Type Description
title string Title text
[subtitle] string Optional subtitle text

CardHeaderTag

Kind: global class
Properties

Name Type
[children] Array.<CardAvatarTag>

new CardHeaderTag(attrs)

Param Type
attrs CardHeaderTagAttrs

CardHeaderTag.getAttributes(node) ⇒ CardHeaderTagAttrs

Kind: static method of CardHeaderTag

Param Type
node HTMLElement

CardMediaTagAttrs

Kind: global class

new CardMediaTagAttrs([src], [avatarName])

Param Type Description
[src] string public url of the avatar png image
[avatarName] string name of the avatar

CardMediaTag

Kind: global class

new CardMediaTag(children, attrs)

Param Type
children undefined
attrs CardMediaTagAttrs

CardMediaTag.getAttributes(node) ⇒ CardMediaTagAttrs

Kind: static method of CardMediaTag

Param Type
node HTMLElement

FooterTag

Kind: global class

new FooterTag(children)

Instantiates a new FooterTag

Param Type
children Array.<string>

FormTagAttrs

Kind: global class

new FormTagAttrs(action, method, header, footer, completionStatusShow, completionStatusInHeader, skipConfirmation)

Instantiates a new FormTagAttrs

Param Type Description
action string the path where the form data is sent to after the user finishes the form
method string the method use to send the form data
header string | undefined the global form header which can be overwritten at the SectionTag level
footer string | undefined the global form footer which can be overwritten at the SectionTag level
completionStatusShow boolean | undefined whether to display the progress the user made in a form
completionStatusInHeader boolean | undefined whether to display that progress in header (if false it will be displayed in body)
skipConfirmation boolean | undefined whether the additional confirmation step at the end of the form will be skipped

FormTag

Kind: global class

new FormTag(children, attrs)

Instantiates a new FormTag. It is the equivalent of the HTML <form> tag and it is always the root (it cannot be placed inside of another tag). The FormTag is be used in all the situations where some data is expected from the user. The FormTag can have one SnackbarTag child followed by multiple SectionTag children and each SectionTag deals with one piece of data from the user.

Param Type
children Array.<SectionTag>
attrs FormTagAttrs

HeaderTag

Kind: global class

new HeaderTag(children)

Instantiates a new HeaderTag

Param Type
children Array.<string>

ImgTagAttrs

Kind: global class

new ImgTagAttrs([src], [alt])

Param Type
[src] string
[alt] string

ImgTag

Kind: global class

new ImgTag(children, attrs)

Param Type
children undefined
attrs InputTagAttrs

ImgTag.getAttributes(node) ⇒ ImgTagAttrs

Kind: static method of ImgTag

Param Type
node HTMLImgElement

InputTagAttrs

Kind: global class

new InputTagAttrs(type, [min], [minError], [minlength must be an integer], [minlengthError], [max], [maxError], [maxlength must be an integer], [maxlengthError], [step], [value], [pattern])

Param Type Description
type 'date' | 'datetime' | 'email' | 'hidden' | 'location' | 'number' | 'phone' | 'range' | 'tel' | 'text' | 'textarea' | 'url'
[min] number
[minError] string
[minlength must be an integer] number
[minlengthError] string
[max] number
[maxError] string
[maxlength must be an integer] number
[maxlengthError] string
[step] number
[value] string required if type="hidden"
[pattern] string

InputTag

Kind: global class

new InputTag(children, attrs)

Param Type
children undefined
attrs InputTagAttrs

InputTag.getAttributes(node) ⇒ InputTagAttrs

Kind: static method of InputTag

Param Type
node HTMLInputElement

LiTagAttrs

Kind: global class

new LiTagAttrs(value, textSearch)

Param Type
value string | undefined
textSearch string | undefined

LiTag

Kind: global class

new LiTag(children, attrs)

Param Type
children Array.<(ATag|string)>
attrs LiTagAttrs

LoginTagAttrs

Kind: global class

new LoginTagAttrs([onSuccess], [onFailure])

Param Type
[onSuccess] string
[onFailure] string

LoginTag

Kind: global class

new LoginTag(children, attrs)

Param Type
children undefined
attrs LoginTagAttrs

LoginTag.getAttributes(node) ⇒ LoginTagAttrs

Kind: static method of LoginTag

Param Type
node HTMLElement

LogoutTagAttrs

Kind: global class

new LogoutTagAttrs([onSuccess], [onFailure])

Param Type
[onSuccess] string
[onFailure] string

LogoutTag

Kind: global class

new LogoutTag(children, attrs)

Param Type
children undefined
attrs LogoutTagAttrs

LogoutTag.getAttributes(node) ⇒ LogoutTagAttrs

Kind: static method of LogoutTag

Param Type
node HTMLElement

PTag

Kind: global class

new PTag(children)

Param Type
children Array.<string>

SectionTagAttrs

Kind: global class

new SectionTagAttrs([props])

Instantiates a new SectionTagAttrs

Param Type Default Description
[props] object |
[props.name] string | this attribute is relevant only if the SectionTag is part of a FormTag
[props.header] string | text that will be included in header
[props.footer] string | text that will be included in footer
[props.autoSelect] boolean false
[props.multiSelect] boolean false
[props.numbered] boolean false
[props.chunkingFooter] string |
[props.confirmationLabel] string |
[props.method] string |
[props.required] boolean false
[props.default] string |
[props.statusExclude] boolean false
[props.statusPrepend] boolean false
[props.url] string |
[props.validateTypeError] string |
[props.validateTypeErrorFooter] string |
[props.validateUrl] string

SectionTag

Kind: global class

new SectionTag(children, attrs)

Instantiates a new SectionTag. A SectionTag may represent a step in a form, a menu or a block of text. A user will always receive the content of a SectionTag at a time.

Param Type
children Array.<(PTag|BrTag|UlTag|LabelTag|LoginTag|LogoutTag|HeaderTag|FooterTag|TextareaTag|InputTag|ImgTag|VideoTag|CardTag)>
attrs SectionTagAttrs

SnackbarTagAttrs

Kind: global class

new SnackbarTagAttrs([message], [severity])

Param Type
[message] string
[severity] string

SnackbarTag

Kind: global class

new SnackbarTag(children, attrs)

Param Type
children undefined
attrs SnackbarTagAttrs

SnackbarTag.getAttributes(node) ⇒ SnackbarTagAttrs

Kind: static method of SnackbarTag

Param Type
node HTMLElement

Tag

Kind: global class

new Tag(children, attrs)

Instantiates a Tag

Param Type
children Array.<Tag> | undefined
attrs Object | undefined

Tag.fromNode(node) ⇒ FormTag | CardTag | CardHeaderTag | CardAvatarTag | CardMediaTag | CardContentTag | CardActionsTag | CardActionTag | SectionTag | SnackbarTag | UlTag | LiTag | LoginTag | LogoutTag | ATag | PTag | BrTag | HeaderTag | FooterTag | InputTag | LabelTag | TextareaTag | ImgTag | VideoTag

Kind: static method of Tag

Param Type
node HTMLElement

Tag.getAttributes(node) ⇒ Object | undefined

Returns the attributes specific to a certain tag

Kind: static method of Tag

Param Type
node HTMLElement

TextareaTag

Kind: global class

new TextareaTag(children)

Param Type
children Array.<string>

UlTag

Kind: global class

new UlTag(children)

Param Type
children Array.<LiTag>

VideoTagAttrs

Kind: global class

new VideoTagAttrs([src], [alt])

Param Type
[src] string
[alt] string

VideoTag

Kind: global class

new VideoTag(children, attrs)

Param Type
children undefined
attrs InputTagAttrs

VideoTag.getAttributes(node) ⇒ VideoTagAttrs

Kind: static method of VideoTag

Param Type
node HTMLVideoElement

ATag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<string>
attrs ATagAttrs

new ATag(children, attrs)

Param Type
children Array.<string>
attrs ATagAttrs

ATag.getAttributes(node)

Kind: static method of ATag

Param Type
node HTMLAnchorElement

BrTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs undefined

CardTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<(CardHeaderTag|CardMediaTag|CardContentTag|CardActionsTag)>
attrs CardTagAttrs

new CardTag(attrs)

Param Type
attrs CardTagAttrs

CardTag.getAttributes(node) ⇒ CardTagAttrs

Kind: static method of CardTag

Param Type
node HTMLElement

CardActionTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs CardActionTagAttrs

new CardActionTag(children, attrs)

Param Type
children undefined
attrs CardActionTagAttrs

CardActionTag.getAttributes(node) ⇒ CardActionTagAttrs

Kind: static method of CardActionTag

Param Type
node HTMLElement

CardActionsTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<CardActionTag>
attrs undefined

new CardActionsTag(children)

Param Type
children Array.<CardActionTag>

CardAvatarTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs CardAvatarTagAttrs

new CardAvatarTag(children, attrs)

Param Type
children undefined
attrs CardAvatarTagAttrs

CardAvatarTag.getAttributes(node) ⇒ CardAvatarTagAttrs

Kind: static method of CardAvatarTag

Param Type
node HTMLElement

CardContentTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs CardContentTagAttrs

new CardContentTag(children, attrs)

Param Type
children undefined
attrs CardContentTagAttrs

CardContentTag.getAttributes(node) ⇒ CardContentTagAttrs

Kind: static method of CardContentTag

Param Type
node HTMLElement

CardHeaderTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
[children] Array.<CardAvatarTag>
attrs CardHeaderTagAttrs

new CardHeaderTag(attrs)

Param Type
attrs CardHeaderTagAttrs

CardHeaderTag.getAttributes(node) ⇒ CardHeaderTagAttrs

Kind: static method of CardHeaderTag

Param Type
node HTMLElement

CardMediaTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs CardMediaTagAttrs

new CardMediaTag(children, attrs)

Param Type
children undefined
attrs CardMediaTagAttrs

CardMediaTag.getAttributes(node) ⇒ CardMediaTagAttrs

Kind: static method of CardMediaTag

Param Type
node HTMLElement

FooterTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<string>
attrs undefined

new FooterTag(children)

Instantiates a new FooterTag

Param Type
children Array.<string>

FormTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<SectionTag>
attrs FormTagAttrs

new FormTag(children, attrs)

Instantiates a new FormTag. It is the equivalent of the HTML <form> tag and it is always the root (it cannot be placed inside of another tag). The FormTag is be used in all the situations where some data is expected from the user. The FormTag can have one SnackbarTag child followed by multiple SectionTag children and each SectionTag deals with one piece of data from the user.

Param Type
children Array.<SectionTag>
attrs FormTagAttrs

HeaderTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<string>
attrs undefined

new HeaderTag(children)

Instantiates a new HeaderTag

Param Type
children Array.<string>

ImgTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs InputTagAttrs

new ImgTag(children, attrs)

Param Type
children undefined
attrs InputTagAttrs

ImgTag.getAttributes(node) ⇒ ImgTagAttrs

Kind: static method of ImgTag

Param Type
node HTMLImgElement

InputTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs InputTagAttrs

new InputTag(children, attrs)

Param Type
children undefined
attrs InputTagAttrs

InputTag.getAttributes(node) ⇒ InputTagAttrs

Kind: static method of InputTag

Param Type
node HTMLInputElement

LabelTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<string>
attrs undefined

LiTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<(ATag|string)>
attrs LiTagAttrs

new LiTag(children, attrs)

Param Type
children Array.<(ATag|string)>
attrs LiTagAttrs

LoginTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs LoginTagAttrs

new LoginTag(children, attrs)

Param Type
children undefined
attrs LoginTagAttrs

LoginTag.getAttributes(node) ⇒ LoginTagAttrs

Kind: static method of LoginTag

Param Type
node HTMLElement

LogoutTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs LogoutTagAttrs

new LogoutTag(children, attrs)

Param Type
children undefined
attrs LogoutTagAttrs

LogoutTag.getAttributes(node) ⇒ LogoutTagAttrs

Kind: static method of LogoutTag

Param Type
node HTMLElement

PTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<string>
attrs undefined

new PTag(children)

Param Type
children Array.<string>

SectionTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<(HeaderTag|FooterTag|UlTag|PTag|BrTag|InputTag|TextareaTag|LabelTag|LoginTag|LogoutTag|ImgTag|VideoTag)>
attrs SectionTagAttrs

new SectionTag(children, attrs)

Instantiates a new SectionTag. A SectionTag may represent a step in a form, a menu or a block of text. A user will always receive the content of a SectionTag at a time.

Param Type
children Array.<(PTag|BrTag|UlTag|LabelTag|LoginTag|LogoutTag|HeaderTag|FooterTag|TextareaTag|InputTag|ImgTag|VideoTag|CardTag)>
attrs SectionTagAttrs

SnackbarTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs SnackbarTagAttrs

new SnackbarTag(children, attrs)

Param Type
children undefined
attrs SnackbarTagAttrs

SnackbarTag.getAttributes(node) ⇒ SnackbarTagAttrs

Kind: static method of SnackbarTag

Param Type
node HTMLElement

Tag

Kind: global typedef
Properties

Name Type
children Array.<Tag> | undefined
attrs Object | undefined
tagName string

new Tag(children, attrs)

Instantiates a Tag

Param Type
children Array.<Tag> | undefined
attrs Object | undefined

Tag.fromNode(node) ⇒ FormTag | CardTag | CardHeaderTag | CardAvatarTag | CardMediaTag | CardContentTag | CardActionsTag | CardActionTag | SectionTag | SnackbarTag | UlTag | LiTag | LoginTag | LogoutTag | ATag | PTag | BrTag | HeaderTag | FooterTag | InputTag | LabelTag | TextareaTag | ImgTag | VideoTag

Kind: static method of Tag

Param Type
node HTMLElement

Tag.getAttributes(node) ⇒ Object | undefined

Returns the attributes specific to a certain tag

Kind: static method of Tag

Param Type
node HTMLElement

TextareaTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<string>
attrs undefined

new TextareaTag(children)

Param Type
children Array.<string>

UlTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<LiTag>
attrs undefined

new UlTag(children)

Param Type
children Array.<LiTag>

VideoTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs InputTagAttrs

new VideoTag(children, attrs)

Param Type
children undefined
attrs InputTagAttrs

VideoTag.getAttributes(node) ⇒ VideoTagAttrs

Kind: static method of VideoTag

Param Type
node HTMLVideoElement

changelog

History

0.18.0

  • Added snackbar and various card constructors & tags

0.17.0

  • Support type float for step

0.16.0

  • Support for login/logout

0.15.0

  • Support for input type=range

0.14.0

  • Support for img and video tags in type=menu

0.13.0

  • Support for textarea tag

0.12.0

  • Support for phone and tel input types

0.11.0

  • Step:
    • Fixes for step attribute for input tag

0.6.0

  • HTML API:

    • Added a bunch of new attributes on <input>: min, min-error, minlength, minlength-error, max, max-error, maxlength, maxlength-error, step, value
    • Added a bunch of new attributes on <section>: chunking-footer, confirmation-label, method, required, status-exclude, status-prepend, url, validate-type-error, validate-type-error-footer, validate-url
    • Added new input types: number, hidden

  • NodeJS API

    • Removed FormItemMenu and FormItemContent. Use a single model instead - FormItem which achieves the functionality of both old models
    • A bunch of new properties were added on FormItem, taken from <input> and <section> tags (see changes in HTML API above).
    • Added textSearch property on MenuItemFormItem

0.5.0

  • HTML API:

    • Added text-search attribute on <li> tag in order to send more context to ONEm Platform to search in.

  • NodeJS API:

    • Added textSearch attribute on both MenuItem and FormItemMenuItem. This attribute has origin in <li> tag.

0.4.0

  • HTML API:

    • Added auto-select, multi-select and numbered flags on <section> tag. They take effect only if the <section> tag contains options
    • Boolean attributes are evaluated according to HTML5 (if present, a boolean attribute is true; if absent, it's false)

  • NodeJS API:

    • Added MenuMeta and FormItemMenuMeta objects to describe Menu objects and FormItemMenu objects respectively.
      • MenuMeta can contain autoSelect
      • FormItemMenuMeta can contain autoSelect, multiSelect and numbered
      • these attributes have origin in <section> tag