ids-enterprise-typings 14.4.6 → 14.4.8-patch.1

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

@@ -0,0 +1,24 @@
+interface SohoArrangeOptions {
+  handle?: string; // The CSS class name of the handle element to connect.
+  itemsSelector?: string; // The CSS selector to match all the sortable elements.
+  connectWith?: boolean; // Optional CSS Selector to connect with when using two lists.
+  isVisualItems?: boolean; // Use only index of visual items to trigger.
+  placeholder?: string; // The html for the element that appears while dragging.
+  placeholderCssClass?: string; // The class to add to the ghost element that is being dragged.
+  useItemDimensions?: boolean; // If true, use item's dimensions to placeholder.
+}
+
+interface SohoArrangeStatic {
+  settings: SohoArrangeOptions;
+  updated: Function;
+  destroy: Function;
+}
+
+interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
+  arrange(options?: SohoArrangeOptions): JQuery;
+}
+
+interface SohoArrangeEvent {
+  event: JQuery.TriggeredEvent;
+  status?: any;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * Soho Field Options.
+ *
+ * This file contains the Typescript mappings for the public
+ * interface of the Soho jQuery Field Options control.
+ *
+ * Which has no options at this time.
+ */
+
+interface SohoFieldSetOptionStaticSettings {
+
+}
+
+interface SohoFieldSetOptionStatic {
+  /** Access to the control's options block. */
+  settings: SohoFieldSetOptionStaticSettings;
+
+  /** Destructor. */
+  destroy(): void;
+}
+
+interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
+  fieldoptions(options?: SohoFieldSetOptionStaticSettings): JQuery;
+}

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,95 @@
+/// <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 | false;
+
+/** Defines options present in the Soho Module Nav Switcher */
+interface SohoModuleNavSwitcherOptions {
+  displayMode?: SohoModuleNavDisplayMode;
+  generate?: boolean;
+  disabled?: boolean;
+  icon?: SohoModuleNavSwitcherIconSetting;
+  moduleButtonText?: string;
+  roleDropdownLabel?: string;
+  changeIconOnSelect?: boolean;
+  noSearch?: boolean;
+  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's Icon Element */
+  moduleButtonIconEl?: HTMLElement | SVGElement;
+
+  /** 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;
+
+  /** Selects a role in the dropdown based on its value,
+   * keeping all Module Nav Switcher elements synced */
+  selectRole(val: string): 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,100 @@
+/// <reference path='./soho-module-nav-common.d.ts' />
+/// <reference path='../accordion/soho-accordion.d.ts' />
+
+interface SohoModuleNavDisplayModeChangeEvent {
+  e: JQuery.TriggeredEvent,
+  val: SohoModuleNavDisplayMode
+}
+
+type SohoModuleNavBreakPoint =
+  'phone' |
+  'slim' |
+  'phablet' |
+  'phone-to-tablet' |
+  'wide-tablet' |
+  'tablet-to-desktop' |
+  'desktop-to-extralarge' | undefined;
+
+/** Defines options present in the Soho Module Nav */
+interface SohoModuleNavOptions {
+  accordionSettings?: SohoAccordionOptions;
+  displayMode?: SohoModuleNavDisplayMode;
+  filterable?: boolean;
+  disableSwitcher?: boolean;
+  initChildren?: boolean;
+  pinSections?: boolean;
+  showDetailView?: boolean;
+  mobileBehavior?: boolean;
+  breakpoint?: SohoModuleNavBreakPoint,
+  showOverlay?: boolean;
+  showModuleSwitcher?: boolean;
+  showGuestSection?: boolean;
+  showSearchBar?: boolean;
+  enableOutsideClick?: 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/timeline/soho-timeline.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Soho Timeline.
+ *
+ * This file contains the Typescript mappings for the public
+ * interface of the Soho jQuery Timeline control.
+ */
+
+/**
+ * Timeline Options
+ */
+interface SohoTimelineOptions {
+}
+
+/**
+ * Timeline Api.
+ */
+interface SohoTimelineStatic {
+  /** The settings option */
+  settings: SohoTimelineOptions;
+
+  /** Updates the timeline with any new settings */
+  updated(settings?: SohoTimelineOptions): void;
+
+  /** Destroys the control on completion. */
+  destroy(): void;
+}
+
+interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
+  timeline(options?: SohoTimelineOptions): JQuery;
+}

package/package.json

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