ids-enterprise-typings 16.4.0 → 16.5.0

package/index.d.ts

@@ -54,6 +54,7 @@
 /// <reference path='lib/menu-button/soho-menu-button.d.ts' />
 /// <reference path='lib/message/soho-message.d.ts' />
 /// <reference path='lib/modal-dialog/soho-modal-dialog.d.ts' />
+/// <reference path='lib/module-nav/index.d.ts' />
 /// <reference path='lib/monthview/soho-monthview.d.ts' />
 /// <reference path='lib/notification/soho-notification.d.ts' />
 /// <reference path='lib/notification-badge/soho-notification-badge.d.ts' />

package/lib/accordion/soho-accordion.d.ts

@@ -8,10 +8,56 @@
 
 type SohoAccordionExpanderType = 'classic' | 'plus-minus' | 'chevron';
 
+type SohoAccordionDefaultFocusBehaviorCallback = () => void;
+
+type SohoAccordionHeaderGroup = any; // JQuery<HTMLElement>
+
+type SohoAccordionHeaderExpanderButtonGroup = any; // JQuery<HTMLElement>
+
+type SohoAccordionHeaderAnchorGroup = any; // JQuery<HTMLElement>
+
+type SohoAccordionHeaderAnyGroup = SohoAccordionHeaderGroup | SohoAccordionHeaderExpanderButtonGroup | SohoAccordionHeaderAnchorGroup;
+
+type SohoAccordionNavDirection = 0 | -1 | 1;
+
+/**
+ * Soho Accordion data representation types
+ * These can be used to work with the results of `.toData()`
+ */
+
+type SohoAccordionData = Array<SohoAccordionSectionData> | Array<SohoAccordionHeaderData>;
+
+type SohoAccordionSectionData = {
+  index: string,
+  type: 'section',
+  children?: Array<SohoAccordionHeaderData | SohoAccordionContentData>,
+};
+
+type SohoAccordionContentData = {
+  index: string,
+  type: 'content',
+  content?: string,
+  contentText?: string
+};
+
+type SohoAccordionHeaderData = {
+  index: string,
+  type: 'header',
+  text?: string,
+  icon?: string,
+  children?: Array<SohoAccordionHeaderData | SohoAccordionContentData>
+};
+
 /**
-* Soho Accordion Control Options
-*/
+ * Soho Accordion Control Options
+ */
 interface SohoAccordionOptions {
+  /**
+   * Provides a mechanism for controlling the behavior of accordion header focus.
+   * By default, the built-in behavior is used (ability to focus headers/expanders independently).
+   */
+  accordionFocusCallback?: (header: JQuery<HTMLElement>, defaultFocusBehaviorCallback?: SohoAccordionDefaultFocusBehaviorCallback) => void;
+
   /**
    * If set to true, allows only one pane of the Accordion to be open at a time.
    * If an Accordion pane is open, and that pane contains sub-headers,
@@ -68,22 +114,26 @@ interface SohoAccordionOptions {
 }
 
 /**
- * This interface represents the public API exposed by the
- * busy indicator.
+ * This interface represents the public API exposed by the Soho Accordion
  */
 interface SohoAccordionStatic {
   /** Access to the control's options block. */
   settings: SohoAccordionOptions;
 
+  /** Calls the `source` method passed via settings */
+  callSource(anchor: SohoAccordionHeaderAnchorGroup, animationCallback: () => void): void;
+
   /** Collapses all panels. */
   collapseAll(): void;
 
   /** Expands all panels. */
   expandAll(): void;
 
-  expand(header: any | string): void;
+  /** Expands one or a group of panels */
+  expand(header: SohoAccordionHeaderGroup | string): void;
 
-  collapse(header: any | string): void;
+  /** Collapses one or a group of panels */
+  collapse(header: SohoAccordionHeaderGroup | string): void;
 
   /** Disables the accordion from reacting to events. */
   disable(): void;
@@ -92,18 +142,69 @@ interface SohoAccordionStatic {
   enable(): void;
 
   /** Checks if a particular header is disabled, or if the entire accordion is disabled. */
-  isDisabled(jQuery: any): boolean;
+  isDisabled(header: SohoAccordionHeaderGroup): boolean;
 
   /** Checks if an Accordion Section is currently expanded. */
-  isExpanded(jQuery: any): boolean;
+  isExpanded(header: SohoAccordionHeaderGroup): boolean;
 
   /** Toggles the exanded state of the selected header. */
-  toggle(jQuery: any): void;
+  toggle(header: SohoAccordionHeaderGroup): boolean;
+
+  /**
+   * Gets the current contents of this accordion and creates a JSON-like representation of the structure.
+   * For full JSON compatibility, don't use the `addElementReference` flag.
+   **/
+  toData(flatten?: boolean, addElementReference?: boolean): SohoAccordionData;
+
+  /** Makes an accordion header appear with a "selected" state */
+  select(element?: SohoAccordionHeaderAnyGroup): void;
+
+  /** Makes an accordion header appear with a "deselected" state */
+  deselect(element?: SohoAccordionHeaderAnyGroup): void;
+
+  /** Makes all accordion headers deselected */
+  deselectAll(): void;
+
+  /** Gets a reference to currently-selected accordion headers */
+  getSelected(): SohoAccordionHeaderGroup;
+
+  /** Determines if an Accordion Header is disabled */
+  isDisabled(header: SohoAccordionHeaderGroup): boolean;
+
+  /** "Visually" filters accordion headers (elements are not added/removed but temporarily hidden by CSS if filtered out) */
+  filter(headers?: SohoAccordionHeaderGroup): void;
+
+  /** Resets a previously-applied filter */
+  unfilter(headers?: SohoAccordionHeaderGroup): void;
+
+  /** Determines if an Accordion Header is currently visually filtered out */
+  isFiltered(header: SohoAccordionHeaderGroup): boolean;
+
+  /** Determines if animation is currently happening on accordion panes (controls some behavior internally) */
+  isAnimating: boolean;
+
+  /** Programmatically navigates to the next-available accordion header (down) */
+  nextHeader(element: SohoAccordionHeaderAnyGroup, noDescend?: boolean): void;
+
+  /** Programmatically navigates to the previous-available accordion header (up) */
+  prevHeader(element: SohoAccordionHeaderAnyGroup, noDescend?: boolean): void;
+
+  /** Programmatically navigates to the next-available accordion header (down) */
+  ascend(element: SohoAccordionHeaderGroup, direction?: SohoAccordionNavDirection): void;
+
+  /** Programmatically navigates to the previous-available accordion header (up) */
+  descend(element: SohoAccordionHeaderGroup, direction?: SohoAccordionNavDirection): void;
+
+  /** Programmatically focuses the correct element within an accordion header (based on previously-focused elements) */
+  focusOriginalType(header: SohoAccordionHeaderGroup): void;
 
   /** Updates the accordion with any new settings. */
-  updated(headers?: JQuery[], settings?: SohoAccordionOptions): void;
+  updated(headers?: SohoAccordionHeaderGroup, settings?: SohoAccordionOptions): void;
+
+  /** Performs a teardown of the jQuery component API (does not remove the component instance) */
+  teardown(): void;
 
-  /** Destroys the control on completion. */
+  /** Destroys the control on completion. (Tears down and removes the component instance) */
   destroy(): void;
 }
 

package/lib/application-menu/soho-application-menu.d.ts

@@ -1,3 +1,6 @@
+/// <reference path='../accordion/soho-accordion.d.ts' />
+/// <reference path='../searchfield/soho-searchfield.d.ts' />
+
 /**
  * Soho Application Menu.
  *
@@ -63,6 +66,15 @@ interface SohoApplicationMenuStatic {
   /** Control settings. */
   settings: SohoApplicationMenuOptions;
 
+  /** Accordion element */
+  accordionEl: HTMLElement;
+
+  /** Searchfield element, if present */
+  searchEl?: HTMLElement | null;
+
+  /** Searchfield API, if present */
+  searchAPI?: SohoSearchFieldStatic;
+
   /**
    * Opens the application menu.
    *

package/lib/button/soho-button.d.ts

@@ -107,7 +107,7 @@ declare class SohoButtonStatic {
   toggle(): void;
 
   /** Update the component with new settings. */
-  updated(settings: SohoButtonOptions): void;
+  updated(settings?: SohoButtonOptions): void;
 }
 
 /**

package/lib/datagrid/soho-datagrid.d.ts

@@ -963,6 +963,9 @@ interface SohoDataGridColumn {
   /** Sets the name of the icon to show in the header */
   headerIcon?: string;
 
+  /** Sets the name of the icon to show in the header */
+  headerIconTooltip?: string;
+
   /** Adds an extra class to the header for formatting */
   headerCssClass?: string;
 

package/lib/datepicker/soho-datepicker.d.ts

@@ -229,6 +229,28 @@ interface SohoDatePickerMonthRenderedEvent extends JQuery.TriggeredEvent {
   year: number;
 }
 
+/**
+ * Interface to set custom data validation for the datepicker.
+ */
+interface SohoDatePickerValidator {
+  validator: {
+    /** Validator ID */
+    id: string;
+
+    /** Function to perform the validation */
+    check(value: any, field: any, grid: any): boolean
+
+    /** Message type */
+    type: string;
+
+    /** Message text */
+    message: string;
+  };
+
+  /** The event types that will trigger the validation */
+  validatorEvents: string;
+}
+
 /**
  * JQuery Integration
  */

package/lib/dropdown/soho-dropdown.d.ts

@@ -27,6 +27,16 @@ interface SohoDropDownOptions {
    */
   cssClass?: string;
 
+  /**
+   * Controls the style of the icon representing the Dropdown's "open/close" functionality.
+   */
+  dropdownIcon?: string;
+
+  /**
+   * If true, adds an extra wrapping element in the Dropdown List (in some situations used for styling/scrolling behavior changes)
+   */
+  extraListWrapper?: boolean;
+
   /**
    * Search mode to use between 'contains',  'keyword',  'wordStartsWith', 'phraseStartsWith false will not allow client side filter
    */
@@ -123,6 +133,11 @@ interface SohoDropDownOptions {
    */
   width?: number;
 
+  /**
+   * CSS selector representing an element that the Dropdown component can use to define the list's width
+   */
+  widthTarget?: string;
+
   /**
    * Show the select all text/option.
    */
@@ -217,7 +232,9 @@ interface SohoDropDownStatic {
    */
   disable(): void;
 
-  /** Enable the control. */
+  /**
+   * Enable the control.
+   */
   enable(): void;
 
   /**

package/lib/module-nav/index.d.ts

@@ -0,0 +1,4 @@
+/// <reference path='soho-module-nav-common.d.ts' />
+/// <reference path='soho-module-nav-settings.d.ts' />
+/// <reference path='soho-module-nav-switcher.d.ts' />
+/// <reference path='soho-module-nav.d.ts' />

package/lib/module-nav/soho-module-nav-common.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Soho Module Nav Common
+ *
+ * This file provides common types used by all Module Nav wrapper components
+ */
+
+/**
+ * Controls the visible state of the Module Nav component.
+ * In some cases this also has affects on child components and event handling
+ */
+type SohoModuleNavDisplayMode = false | 'collapsed' | 'expanded';
+

package/lib/module-nav/soho-module-nav-settings.d.ts

@@ -0,0 +1,53 @@
+/// <reference path='./soho-module-nav-common.d.ts' />
+/// <reference path='../accordion/soho-accordion.d.ts' />
+/// <reference path='../popupmenu/soho-popupmenu.d.ts' />
+
+/** Defines options present in the Soho Module Nav Settings */
+interface SohoModuleNavSettingsOptions {
+  displayMode?: SohoModuleNavDisplayMode;
+}
+
+/** Public API for Soho Module Nav Settings JS component */
+interface SohoModuleNavSettingsStatic {
+  /** Module Nav Switcher's current settings */
+  settings: SohoModuleNavSettingsOptions;
+
+  /** Reference to jQuery-wrapped HTML Element representing the Soho Accordion */
+  accordionEl?: HTMLElement;
+
+  /** Reference to a Soho Accordion API, if one is available */
+  accordionAPI?: SohoAccordionStatic;
+
+  /** References to specific sections/elements */
+  containerEl?: HTMLElement;
+
+  /** Reference to the element representing the settings button's menu */
+  menuEl?: HTMLElement;
+
+  /** Reference to the settings menu's Soho Popupmenu API, if one is available*/
+  menuAPI?: SohoPopupMenuStatic;
+
+  /** Initializes the jQuery component */
+  init(): void;
+
+  /** Changes the Module Nav Switcher's Display Mode */
+  setDisplayMode(val?: SohoModuleNavDisplayMode): void;
+
+  /** Re-renders jQuery child component APIs */
+  renderChildComponents(): void;
+
+  /** Tear down the markup for the control */
+  teardown(): void;
+
+  /** Updates the Module Nav Settings with any new settings */
+  updated(newSettings?: SohoModuleNavSettingsOptions): void;
+
+  /** Destroys the control on completion. */
+  destroy(): void;
+}
+
+/** jQuery interface for Module Nav Settings */
+interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
+  modulenavsettings(options?: SohoModuleNavSettingsOptions): JQuery;
+  on(events: 'updated', handler: JQuery.EventHandlerBase<any, SohoModuleNavSettingsOptions>): this;
+}

package/lib/module-nav/soho-module-nav-switcher.d.ts

@@ -0,0 +1,85 @@
+/// <reference path='./soho-module-nav-common.d.ts' />
+/// <reference path='../accordion/soho-accordion.d.ts' />
+/// <reference path='../button/soho-button.d.ts' />
+/// <reference path='../dropdown/soho-dropdown.d.ts' />
+
+
+/** Defines a Module Nav Switcher Role Record
+ * (Takes the same arguments as items present in the Soho Dropdown JSON notation)
+ */
+type SohoModuleNavSwitcherRoleRecord = Record<string, unknown>;
+
+type SohoModuleNavSwitcherIconSetting = string | ((api: SohoModuleNavSwitcherStatic) => string) | undefined;
+
+/** Defines options present in the Soho Module Nav Switcher */
+interface SohoModuleNavSwitcherOptions {
+  displayMode?: SohoModuleNavDisplayMode;
+  generate?: boolean;
+  icon?: SohoModuleNavSwitcherIconSetting;
+  moduleButtonText?: string;
+  roleDropdownLabel?: string;
+  roles?: Array<SohoModuleNavSwitcherRoleRecord>;
+}
+
+/** Public API for Soho Module Nav Switcher JS component */
+interface SohoModuleNavSwitcherStatic {
+  /** Module Nav Switcher's current settings */
+  settings: SohoModuleNavSwitcherOptions;
+
+  /** Reference to jQuery-wrapped HTML Element representing the Soho Accordion */
+  accordionEl?: HTMLElement;
+
+  /** Reference to a Soho Accordion API, if one is available */
+  accordionAPI?: SohoAccordionStatic;
+
+  /** Reference to container element */
+  containerEl?: HTMLElement;
+
+  /** Reference to the Module Button's Container Element */
+  moduleButtonContainerEl?: HTMLElement;
+
+  /** Reference to the Module Button element */
+  moduleButtonEl?: HTMLElement;
+
+  /** Reference to the Module Button's Soho Button API, if one is available */
+  moduleButtonAPI?: SohoButtonStatic;
+
+  /** Reference to the Role Dropdown's container element */
+  roleDropdownContainerEl?: HTMLElement;
+
+  /** Reference to the Role Dropdown's element */
+  roleDropdownEl?: HTMLElement;
+
+  /** Reference to the Module Button's Soho Button API, if one is available */
+  roleDropdownAPI?: SohoDropDownStatic;
+
+  /** Initializes the jQuery component */
+  init(): void;
+
+  /** Changes the Module Nav Switcher's Display Mode */
+  setDisplayMode(val?: SohoModuleNavDisplayMode): void;
+
+  /** Sets visible */
+  setRoles(val?: SohoModuleNavSwitcherRoleRecord[], doUpdate?: boolean): void;
+
+  /** Re-renders jQuery child component APIs */
+  renderChildComponents(): void;
+
+  /** Changes the focus of the Module Button */
+  toggleModuleButtonFocus(doFocus?: boolean): void;
+
+  /** Tear down the markup for the control */
+  teardown(): void;
+
+  /** Updates the Module Nav Switcher with any new settings */
+  updated(newSettings?: SohoModuleNavSwitcherOptions): void;
+
+  /** Destroys the control on completion. */
+  destroy(): void;
+}
+
+/** jQuery interface for Module Nav Switcher */
+interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
+  modulenavswitcher(options?: SohoModuleNavSwitcherOptions): JQuery;
+  on(events: 'updated', handler: JQuery.EventHandlerBase<any, SohoModuleNavSwitcherOptions>): this;
+}

package/lib/module-nav/soho-module-nav.d.ts

@@ -0,0 +1,78 @@
+/// <reference path='./soho-module-nav-common.d.ts' />
+/// <reference path='../accordion/soho-accordion.d.ts' />
+
+/** Defines options present in the Soho Module Nav */
+interface SohoModuleNavOptions {
+  accordionSettings?: SohoAccordionOptions;
+  displayMode?: SohoModuleNavDisplayMode;
+  filterable?: boolean;
+  initChildren?: boolean;
+  pinSections?: boolean;
+  showDetailView?: boolean;
+}
+
+/** Public API for Soho Module Nav JS component */
+interface SohoModuleNavStatic {
+  /** Module Nav's current settings */
+  settings: SohoModuleNavOptions;
+
+  /** Reference to element representing accordion, if one is available */
+  accordionEl?: HTMLElement;
+
+  /** Reference to a Soho Accordion API, if one is available */
+  accordionAPI?: SohoAccordionStatic;
+
+  /** Reference to element representing searchfield, if one is available */
+  searchEl?: HTMLElement;
+
+  /** Reference to a Soho SearchField API, if one is available */
+  searchAPI?: SohoSearchFieldStatic;
+
+  /** Reference to element representing settings button, if one is available */
+  settingsEl?: HTMLElement;
+
+  /** Reference to a Soho Module Nav Settings API, if one is available */
+  settingAPI?: SohoModuleNavSettingsStatic;
+
+  /** Reference to a Soho Module Nav Switcher container element, if one is available */
+  switcherEl?: HTMLElement;
+
+  /** Reference to a Soho Module Nav Settings API, if one is available */
+  switcherAPI?: SohoModuleNavSwitcherStatic;
+
+  /** Misc. references to specific sections/elements */
+  containerEl?: HTMLElement;
+  detailViewEl?: HTMLElement;
+  itemMenuEl?: HTMLElement;
+  footerEl?: HTMLElement;
+
+  /** Initializes the jQuery component */
+  init(): void;
+
+  /** Changes the Module Nav's Display Mode */
+  setDisplayMode(val?: SohoModuleNavDisplayMode): void;
+
+  /** Enables (true)/Disables (false) optional pinning of header/footer Module Nav regions */
+  setPinSections(val?: boolean): void;
+
+  /** Updates accordion section scroll state based on size changes */
+  setScrollable(): void;
+
+  /** Enables (true)/Disables (false) visibility of detail view pane used for sub modules */
+  setShowDetailView(val: boolean): void;
+
+  /** Tear down the markup for the control */
+  teardown(): void;
+
+  /** Updates the Module Nav with any new settings */
+  updated(newSettings?: SohoModuleNavOptions): void;
+
+  /** Destroys the control on completion. */
+  destroy(): void;
+}
+
+/** jQuery interface for Module Nav */
+interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
+  modulenav(options?: SohoModuleNavOptions): JQuery;
+  on(events: 'updated', handler: JQuery.EventHandlerBase<any, SohoModuleNavOptions>): this;
+}

package/lib/pie/soho-pie.d.ts

@@ -46,6 +46,9 @@ interface SohoPieOptions {
   /** Where to locate the legend. This can be bottom or right at the moment. */
   legendPlacement?: 'bottom' | 'right' | string;
 
+  /** Force Legend popup below regardless of the quantity of labels. */
+  forceLegendPopup?: boolean,
+
   /** A setting that controls the legend values and format. */
   legend?: SohoPieLegendOptions;
 

package/lib/popupmenu/soho-popupmenu.d.ts

@@ -57,6 +57,9 @@ interface SohoPopupMenuOptions {
 
   /** Add extra attributes like id's to the component **/
   attributes?: Array<Object> | Object;
+
+  /** Appends an optional css class to `.popupmenu-wrapper/popupmenu` elements  */
+  cssClass?: string | null;
 }
 
 /**
@@ -75,6 +78,9 @@ interface SohoPopupMenuStatic {
   /** Configuration options. */
   settings?: SohoPopupMenuOptions;
 
+  /** Gets the Popupmenu's ID string (can be used to query the DOM for the menu element) */
+  idString: string | undefined;
+
   /** Returns the selected html element. */
   getSelected(): any;
 

package/lib/tooltip/soho-tooltip.d.ts

@@ -53,7 +53,7 @@ interface SohoTooltipEvent extends JQuery.TriggeredEvent {
 interface SohoTooltipStatic {
   settings: SohoTooltipOptions;
   destroy(): void;
-  hide(): void;
+  hide(force?: boolean): void;
   show(): void;
   updated(): void;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ids-enterprise-typings",
   "slug": "ids-enterprise-typings",
-  "version": "16.4.0",
+  "version": "16.5.0",
   "declaration": true,
   "types": "index.d.ts",
   "dependencies": {