@searchcraft/javascript-sdk 0.5.3 → 0.6.0

package/dist/searchcraft-javascript-sdk/p-efab9f3c.entry.js

@@ -0,0 +1,2 @@
+import{r as s,c as e,h as c,F as r}from"./p-e0be53df.js";import{c as a}from"./p-5cdc6210.js";const n=":root{--sc-input-border-radius:8px;--sc-input-search-icon-size:20px;--sc-input-clear-icon-size:20px;--sc-input-padding-left:44px;--sc-input-padding-right:44px;--sc-image-border-radius:8px;--sc-popover-form-border-radius:8px;--sc-popover-list-view-height:400px;--sc-popover-list-item-image-size:60px;--sc-popover-list-item-padding-horizontal:8px;--sc-popover-list-item-padding-vertical:8px;--sc-popover-modal-max-width:570px}:root{--sc-surface-disabled:#D9D9D9;--sc-surface-neutral-primary:#FFFFFF;--sc-surface-neutral-secondary:#F3F3F3;--sc-surface-neutral-light:#FFFFFF;--sc-surface-neutral-primary-hover:#FAFAFA;--sc-surface-neutral-primary-active:#F7F7F7;--sc-surface-neutral-secondary-hover:#EDEDED;--sc-surface-neutral-secondary-active:#E6E6E6;--sc-surface-brand-primary:#000000;--sc-surface-brand-secondary:#E6E6E6;--sc-surface-brand-primary-hover:#2E2E2E;--sc-surface-brand-primary-active:#292929;--sc-surface-brand-secondary-hover:#EBEBEB;--sc-surface-brand-secondary-active:#E0E0E0;--sc-surface-success-primary:#008000;--sc-surface-success-secondary:#CCFFCC;--sc-surface-success-primary-hover:#009900;--sc-surface-success-primary-active:#006600;--sc-surface-success-secondary-hover:#E6FFE6;--sc-surface-success-secondary-active:#E6FFE6;--sc-surface-caution-primary:#CC6600;--sc-surface-caution-secondary:#FFD9B3;--sc-surface-caution-primary-hover:#E57300;--sc-surface-caution-primary-active:#B25A00;--sc-surface-caution-secondary-hover:#FFE5CC;--sc-surface-caution-secondary-active:#FFCC99;--sc-surface-danger-primary:#CC0000;--sc-surface-danger-secondary:#FFCCCC;--sc-surface-danger-primary-hover:#E50000;--sc-surface-danger-primary-active:#B30000;--sc-surface-danger-secondary-hover:#FFE7E7;--sc-surface-danger-secondary-active:#FFB3B3;--sc-content-brand:#000000;--sc-content-success:#008000;--sc-content-caution:#994D00;--sc-content-danger:#990000;--sc-content-disabled:#737373;--sc-content-neutral-primary:#292929;--sc-content-neutral-secondary:#404040;--sc-content-brand-on-primary:#FFFFFF;--sc-content-success-on-primary:#FFFFFF;--sc-content-caution-on-primary:#FFFFFF;--sc-content-danger-on-primary:#FFFFFF;--sc-content-disabled-on-disabled:#737373;--sc-border-neutral:rgba(0,0,0, 0.1);--sc-border-brand:#000000;--sc-border-success:#008000;--sc-border-caution:#CC6600;--sc-border-danger:#CC0000;--sc-border-disabled:#737373}:root{--sc-font-family:sans-serif;--sc-heading-1-font-size:32px;--sc-heading-1-line-height:36px;--sc-heading-1-font-weight:700;--sc-heading-2-font-size:29px;--sc-heading-2-line-height:32px;--sc-heading-2-font-weight:700;--sc-heading-3-font-size:26px;--sc-heading-3-line-height:28px;--sc-heading-3-font-weight:700;--sc-heading-4-font-size:23px;--sc-heading-4-line-height:24px;--sc-heading-4-font-weight:700;--sc-heading-5-font-size:20px;--sc-heading-5-line-height:24px;--sc-heading-5-font-weight:700;--sc-heading-6-font-size:10px;--sc-heading-6-line-height:12px;--sc-heading-6-font-weight:700;--sc-body-bold-font-size:16px;--sc-body-bold-line-height:20px;--sc-body-bold-font-weight:700;--sc-body-font-size:16px;--sc-body-line-height:20px;--sc-body-font-weight:400;--sc-body-small-bold-font-size:12px;--sc-body-small-bold-line-height:16px;--sc-body-small-bold-font-weight:700;--sc-body-small-font-size:12px;--sc-body-small-line-height:16px;--sc-body-small-font-weight:400}:root{--sc-breakpoint-sm:576px;--sc-breakpoint-md:768px;--sc-breakpoint-lg:992px}.searchcraft-button{font-family:var(--sc-font-family);-webkit-font-smoothing:antialiased;font-size:var(--sc-body-bold-font-size);font-weight:var(--sc-body-bold-font-weight);line-height:var(--sc-body-bold-line-height);border-radius:8px;display:flex;padding:12px 20px;position:relative;background-color:var(--sc-surface-brand-primary);border:1px solid var(--sc-border-primary);color:var(--sc-content-brand-on-primary)}.searchcraft-button:hover{cursor:pointer;background-color:var(--sc-surface-brand-primary-hover)}.searchcraft-button:focus{outline:2px solid var(--sc-surface-brand-primary)}.buttonLabel{position:relative}";const i=n;const t=class{constructor(c){s(this,c);this.buttonClick=e(this,"buttonClick",7);this.handleClick=()=>{this.buttonClick.emit()};this.iconElement=undefined;this.iconOnly=false;this.iconPosition="left";this.label="Search";this.isRequesting=false}render(){return c(r,{key:"52b95f09f5da9f281b250285623e150c5d952dce"},this.iconOnly?c("button",{class:a("searchcraft-button"),onClick:this.handleClick,type:"submit"},this.isRequesting?c("searchcraft-spinner-dark",null):this.iconElement):c("button",{class:a("searchcraft-button"),onClick:this.handleClick,type:"submit"},this.iconPosition==="left"&&this.iconElement,c("span",{class:a("buttonLabel","searchcraft-button-label")},this.label)))}};t.style=i;const o=":root{--sc-input-border-radius:8px;--sc-input-search-icon-size:20px;--sc-input-clear-icon-size:20px;--sc-input-padding-left:44px;--sc-input-padding-right:44px;--sc-image-border-radius:8px;--sc-popover-form-border-radius:8px;--sc-popover-list-view-height:400px;--sc-popover-list-item-image-size:60px;--sc-popover-list-item-padding-horizontal:8px;--sc-popover-list-item-padding-vertical:8px;--sc-popover-modal-max-width:570px}:root{--sc-surface-disabled:#D9D9D9;--sc-surface-neutral-primary:#FFFFFF;--sc-surface-neutral-secondary:#F3F3F3;--sc-surface-neutral-light:#FFFFFF;--sc-surface-neutral-primary-hover:#FAFAFA;--sc-surface-neutral-primary-active:#F7F7F7;--sc-surface-neutral-secondary-hover:#EDEDED;--sc-surface-neutral-secondary-active:#E6E6E6;--sc-surface-brand-primary:#000000;--sc-surface-brand-secondary:#E6E6E6;--sc-surface-brand-primary-hover:#2E2E2E;--sc-surface-brand-primary-active:#292929;--sc-surface-brand-secondary-hover:#EBEBEB;--sc-surface-brand-secondary-active:#E0E0E0;--sc-surface-success-primary:#008000;--sc-surface-success-secondary:#CCFFCC;--sc-surface-success-primary-hover:#009900;--sc-surface-success-primary-active:#006600;--sc-surface-success-secondary-hover:#E6FFE6;--sc-surface-success-secondary-active:#E6FFE6;--sc-surface-caution-primary:#CC6600;--sc-surface-caution-secondary:#FFD9B3;--sc-surface-caution-primary-hover:#E57300;--sc-surface-caution-primary-active:#B25A00;--sc-surface-caution-secondary-hover:#FFE5CC;--sc-surface-caution-secondary-active:#FFCC99;--sc-surface-danger-primary:#CC0000;--sc-surface-danger-secondary:#FFCCCC;--sc-surface-danger-primary-hover:#E50000;--sc-surface-danger-primary-active:#B30000;--sc-surface-danger-secondary-hover:#FFE7E7;--sc-surface-danger-secondary-active:#FFB3B3;--sc-content-brand:#000000;--sc-content-success:#008000;--sc-content-caution:#994D00;--sc-content-danger:#990000;--sc-content-disabled:#737373;--sc-content-neutral-primary:#292929;--sc-content-neutral-secondary:#404040;--sc-content-brand-on-primary:#FFFFFF;--sc-content-success-on-primary:#FFFFFF;--sc-content-caution-on-primary:#FFFFFF;--sc-content-danger-on-primary:#FFFFFF;--sc-content-disabled-on-disabled:#737373;--sc-border-neutral:rgba(0,0,0, 0.1);--sc-border-brand:#000000;--sc-border-success:#008000;--sc-border-caution:#CC6600;--sc-border-danger:#CC0000;--sc-border-disabled:#737373}:root{--sc-font-family:sans-serif;--sc-heading-1-font-size:32px;--sc-heading-1-line-height:36px;--sc-heading-1-font-weight:700;--sc-heading-2-font-size:29px;--sc-heading-2-line-height:32px;--sc-heading-2-font-weight:700;--sc-heading-3-font-size:26px;--sc-heading-3-line-height:28px;--sc-heading-3-font-weight:700;--sc-heading-4-font-size:23px;--sc-heading-4-line-height:24px;--sc-heading-4-font-weight:700;--sc-heading-5-font-size:20px;--sc-heading-5-line-height:24px;--sc-heading-5-font-weight:700;--sc-heading-6-font-size:10px;--sc-heading-6-line-height:12px;--sc-heading-6-font-weight:700;--sc-body-bold-font-size:16px;--sc-body-bold-line-height:20px;--sc-body-bold-font-weight:700;--sc-body-font-size:16px;--sc-body-line-height:20px;--sc-body-font-weight:400;--sc-body-small-bold-font-size:12px;--sc-body-small-bold-line-height:16px;--sc-body-small-bold-font-weight:700;--sc-body-small-font-size:12px;--sc-body-small-line-height:16px;--sc-body-small-font-weight:400}:root{--sc-breakpoint-sm:576px;--sc-breakpoint-md:768px;--sc-breakpoint-lg:992px}.searchcraft-error-message{font-family:var(--sc-font-family);-webkit-font-smoothing:antialiased;font-size:var(--sc-body-small-font-size);font-weight:var(--sc-body-small-font-weight);line-height:var(--sc-body-small-line-height);color:var(--sc-content-danger);margin:0}";const d=o;const p=class{constructor(e){s(this,e);this.errorMessage=undefined}render(){return c("p",{key:"5bdc428adf6f239d66a9b0f946ee6e582de41e86",class:"searchcraft-error-message"},this.errorMessage||"Search term is required.")}};p.style=d;const h=":root{--sc-input-border-radius:8px;--sc-input-search-icon-size:20px;--sc-input-clear-icon-size:20px;--sc-input-padding-left:44px;--sc-input-padding-right:44px;--sc-image-border-radius:8px;--sc-popover-form-border-radius:8px;--sc-popover-list-view-height:400px;--sc-popover-list-item-image-size:60px;--sc-popover-list-item-padding-horizontal:8px;--sc-popover-list-item-padding-vertical:8px;--sc-popover-modal-max-width:570px}:root{--sc-surface-disabled:#D9D9D9;--sc-surface-neutral-primary:#FFFFFF;--sc-surface-neutral-secondary:#F3F3F3;--sc-surface-neutral-light:#FFFFFF;--sc-surface-neutral-primary-hover:#FAFAFA;--sc-surface-neutral-primary-active:#F7F7F7;--sc-surface-neutral-secondary-hover:#EDEDED;--sc-surface-neutral-secondary-active:#E6E6E6;--sc-surface-brand-primary:#000000;--sc-surface-brand-secondary:#E6E6E6;--sc-surface-brand-primary-hover:#2E2E2E;--sc-surface-brand-primary-active:#292929;--sc-surface-brand-secondary-hover:#EBEBEB;--sc-surface-brand-secondary-active:#E0E0E0;--sc-surface-success-primary:#008000;--sc-surface-success-secondary:#CCFFCC;--sc-surface-success-primary-hover:#009900;--sc-surface-success-primary-active:#006600;--sc-surface-success-secondary-hover:#E6FFE6;--sc-surface-success-secondary-active:#E6FFE6;--sc-surface-caution-primary:#CC6600;--sc-surface-caution-secondary:#FFD9B3;--sc-surface-caution-primary-hover:#E57300;--sc-surface-caution-primary-active:#B25A00;--sc-surface-caution-secondary-hover:#FFE5CC;--sc-surface-caution-secondary-active:#FFCC99;--sc-surface-danger-primary:#CC0000;--sc-surface-danger-secondary:#FFCCCC;--sc-surface-danger-primary-hover:#E50000;--sc-surface-danger-primary-active:#B30000;--sc-surface-danger-secondary-hover:#FFE7E7;--sc-surface-danger-secondary-active:#FFB3B3;--sc-content-brand:#000000;--sc-content-success:#008000;--sc-content-caution:#994D00;--sc-content-danger:#990000;--sc-content-disabled:#737373;--sc-content-neutral-primary:#292929;--sc-content-neutral-secondary:#404040;--sc-content-brand-on-primary:#FFFFFF;--sc-content-success-on-primary:#FFFFFF;--sc-content-caution-on-primary:#FFFFFF;--sc-content-danger-on-primary:#FFFFFF;--sc-content-disabled-on-disabled:#737373;--sc-border-neutral:rgba(0,0,0, 0.1);--sc-border-brand:#000000;--sc-border-success:#008000;--sc-border-caution:#CC6600;--sc-border-danger:#CC0000;--sc-border-disabled:#737373}:root{--sc-font-family:sans-serif;--sc-heading-1-font-size:32px;--sc-heading-1-line-height:36px;--sc-heading-1-font-weight:700;--sc-heading-2-font-size:29px;--sc-heading-2-line-height:32px;--sc-heading-2-font-weight:700;--sc-heading-3-font-size:26px;--sc-heading-3-line-height:28px;--sc-heading-3-font-weight:700;--sc-heading-4-font-size:23px;--sc-heading-4-line-height:24px;--sc-heading-4-font-weight:700;--sc-heading-5-font-size:20px;--sc-heading-5-line-height:24px;--sc-heading-5-font-weight:700;--sc-heading-6-font-size:10px;--sc-heading-6-line-height:12px;--sc-heading-6-font-weight:700;--sc-body-bold-font-size:16px;--sc-body-bold-line-height:20px;--sc-body-bold-font-weight:700;--sc-body-font-size:16px;--sc-body-line-height:20px;--sc-body-font-weight:400;--sc-body-small-bold-font-size:12px;--sc-body-small-bold-line-height:16px;--sc-body-small-bold-font-weight:700;--sc-body-small-font-size:12px;--sc-body-small-line-height:16px;--sc-body-small-font-weight:400}:root{--sc-breakpoint-sm:576px;--sc-breakpoint-md:768px;--sc-breakpoint-lg:992px}.searchcraft-input-label{font-family:var(--sc-font-family);-webkit-font-smoothing:antialiased;font-size:var(--sc-body-small-bold-font-size);font-weight:var(--sc-body-small-bold-font-weight);line-height:var(--sc-body-small-bold-line-height);color:var(--sc-content-neutral-primary);margin-top:4px;margin-bottom:4px}";const u=h;const l=class{constructor(e){s(this,e);this.inputLabelClassName="";this.label=undefined}render(){return c("label",{key:"4f913c1d9027ff781725a01e71e241cb5767eadb",class:a("searchcraft-input-label",this.inputLabelClassName),htmlFor:"searchcraft-input-id"},this.label)}};l.style=u;export{t as searchcraft_button,p as searchcraft_error_message,l as searchcraft_input_label};
+//# sourceMappingURL=p-efab9f3c.entry.js.map

package/dist/searchcraft-javascript-sdk/p-efab9f3c.entry.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["searchcraftButtonModuleCss","SearchcraftButtonStyle0","SearchcraftButton","this","handleClick","buttonClick","emit","render","h","Fragment","key","iconOnly","class","classNames","onClick","type","isRequesting","iconPosition","iconElement","label","searchcraftErrorMessageModuleCss","SearchcraftErrorMessageStyle0","SearchcraftErrorMessage","errorMessage","searchcraftInputLabelModuleCss","SearchcraftInputLabelStyle0","SearchcraftInputLabel","inputLabelClassName","htmlFor"],"sources":["src/components/searchcraft-button/searchcraft-button.module.scss?tag=searchcraft-button","src/components/searchcraft-button/searchcraft-button.tsx","src/components/searchcraft-error-message/searchcraft-error-message.module.scss?tag=searchcraft-error-message","src/components/searchcraft-error-message/searchcraft-error-message.tsx","src/components/searchcraft-input-label/searchcraft-input-label.module.scss?tag=searchcraft-input-label","src/components/searchcraft-input-label/searchcraft-input-label.tsx"],"sourcesContent":[".searchcraft-button {\n  @include body-bold;\n\n  border-radius: 8px;\n  display: flex;\n  padding: 12px 20px;\n  position: relative;\n\n  background-color: var(--sc-surface-brand-primary);\n  border: 1px solid var(--sc-border-primary);\n  color: var(--sc-content-brand-on-primary);\n\n  &:hover {\n    cursor: pointer;\n    background-color: var(--sc-surface-brand-primary-hover);\n  }\n\n  &:focus {\n    outline: 2px solid var(--sc-surface-brand-primary);\n  }\n}\n\n.buttonLabel {\n  position: relative;\n}","import {\n  Component,\n  Event,\n  type EventEmitter,\n  Prop,\n  h,\n  State,\n  Fragment,\n} from '@stencil/core';\nimport classNames from 'classnames';\n\n/**\n * This web component represents a button to be consumed within the `search-input-form` component.\n * It provides a clear, interactive way for users to submit search queries or trigger actions in a search interface.\n * It is consumed within the `searchcraft-input-form` component.\n */\n@Component({\n  tag: 'searchcraft-button',\n  styleUrl: 'searchcraft-button.module.scss',\n  shadow: false,\n})\nexport class SearchcraftButton {\n  /**\n   * The icon element.\n   */\n  @Prop() iconElement?: Element;\n  /**\n   * Should the button only display an icon.\n   */\n  @Prop() iconOnly = false;\n  /**\n   * The position of the icon.\n   */\n  @Prop() iconPosition = 'left';\n  /**\n   * The label for the button.\n   */\n  @Prop() label = 'Search';\n\n  /**\n   * When the button is clicked.\n   */\n  @Event() buttonClick!: EventEmitter<void>;\n\n  @State() isRequesting = false;\n\n  private handleClick = () => {\n    this.buttonClick.emit();\n  };\n\n  render() {\n    return (\n      <Fragment>\n        {this.iconOnly ? (\n          <button\n            class={classNames('searchcraft-button')}\n            onClick={this.handleClick}\n            type='submit'\n          >\n            {this.isRequesting ? (\n              <searchcraft-spinner-dark />\n            ) : (\n              this.iconElement\n            )}\n          </button>\n        ) : (\n          <button\n            class={classNames('searchcraft-button')}\n            onClick={this.handleClick}\n            type='submit'\n          >\n            {this.iconPosition === 'left' && this.iconElement}\n            <span class={classNames('buttonLabel', 'searchcraft-button-label')}>\n              {this.label}\n            </span>\n          </button>\n        )}\n      </Fragment>\n    );\n  }\n}\n",".searchcraft-error-message {\n  @include body-small();\n  color: var(--sc-content-danger);\n  margin: 0;\n}\n","import { Component, Prop, h } from '@stencil/core';\n\n/**\n * This web component is designed to display a user-friendly error message when a search query fails, providing clear feedback to users and enhancing their experience when an issue arises during the search process.\n *\n * ## Usage\n * ```html\n * <!-- index.html -->\n * <searchcraft-error-message error-message=\"No search results found for query\" />\n * ```\n */\n@Component({\n  tag: 'searchcraft-error-message',\n  styleUrl: 'searchcraft-error-message.module.scss',\n  shadow: false,\n})\nexport class SearchcraftErrorMessage {\n  /**\n   * The error message.\n   */\n  @Prop() errorMessage?: string;\n\n  render() {\n    return (\n      <p class='searchcraft-error-message'>\n        {this.errorMessage || 'Search term is required.'}\n      </p>\n    );\n  }\n}\n",".searchcraft-input-label {\n  @include body-small-bold();\n  color: var(--sc-content-neutral-primary);\n  margin-top: 4px;\n  margin-bottom: 4px;\n}\n","import { Component, Prop, h } from '@stencil/core';\nimport classNames from 'classnames';\n\n/**\n * This web component serves as the input label for the searchcraft-input-form component.\n *\n * ## Usage\n * ```html\n * <!-- index.html -->\n * <searchcraft-input-label label=\"Search\" />\n * ```\n */\n@Component({\n  tag: 'searchcraft-input-label',\n  styleUrl: 'searchcraft-input-label.module.scss',\n  shadow: false,\n})\nexport class SearchcraftInputLabel {\n  /**\n   * The classname applied to the label element.\n   */\n  @Prop() inputLabelClassName? = '';\n  @Prop() label: string;\n\n  render() {\n    return (\n      <label\n        class={classNames('searchcraft-input-label', this.inputLabelClassName)}\n        htmlFor='searchcraft-input-id'\n      >\n        {this.label}\n      </label>\n    );\n  }\n}\n"],"mappings":"6FAAA,MAAMA,EAA6B,66HACnC,MAAAC,EAAeD,E,MCoBFE,EAAiB,M,kEAyBpBC,KAAAC,YAAc,KACpBD,KAAKE,YAAYC,MAAM,E,yCAlBN,M,kBAII,O,WAIP,S,kBAOQ,K,CAMxB,MAAAC,GACE,OACEC,EAACC,EAAQ,CAAAC,IAAA,4CACNP,KAAKQ,SACJH,EAAA,UACEI,MAAOC,EAAW,sBAClBC,QAASX,KAAKC,YACdW,KAAK,UAEJZ,KAAKa,aACJR,EAAA,iCAEAL,KAAgB,aAIpBK,EAAA,UACEI,MAAOC,EAAW,sBAClBC,QAASX,KAAKC,YACdW,KAAK,UAEJZ,KAAKc,eAAiB,QAAUd,KAAKe,YACtCV,EAAA,QAAMI,MAAOC,EAAW,cAAe,6BACpCV,KAAKgB,Q,aCzEpB,MAAMC,EAAmC,6kHACzC,MAAAC,EAAeD,E,MCeFE,EAAuB,M,qDAMlC,MAAAf,GACE,OACEC,EAAA,KAAAE,IAAA,2CAAGE,MAAM,6BACNT,KAAKoB,cAAgB,2B,aCzB9B,MAAMC,EAAiC,2nHACvC,MAAAC,EAAeD,E,MCgBFE,EAAqB,M,kDAID,G,qBAG/B,MAAAnB,GACE,OACEC,EAAA,SAAAE,IAAA,2CACEE,MAAOC,EAAW,0BAA2BV,KAAKwB,qBAClDC,QAAQ,wBAEPzB,KAAKgB,M","ignoreList":[]}

package/dist/searchcraft-javascript-sdk/searchcraft-javascript-sdk.esm.js

@@ -1,2 +1,2 @@
-import{p as e,b as t}from"./p-d7d0b88c.js";export{s as setNonce}from"./p-d7d0b88c.js";import{g as a}from"./p-e1255160.js";var r=()=>{const t=import.meta.url;const a={};if(t!==""){a.resourcesUrl=new URL(".",t).href}return e(a)};r().then((async e=>{await a();return t([["p-a810aeae",[[0,"searchcraft-filter-panel",{items:[16],unsubscribe:[32],lastQuery:[32]}]]],["p-32068485",[[0,"searchcraft-input-form",{config:[16],autoSearch:[4,"auto-search"],buttonPlacement:[1,"button-placement"],buttonLabel:[1,"button-label"],inputLabel:[1,"input-label"],customStyles:[1,"custom-styles"],placeholderValue:[1,"placeholder-value"],searchTerm:[1,"search-term"],debounceDelay:[2,"debounce-delay"],inputValue:[32],error:[32],isSearchcraftInitialized:[32]},null,{config:["onConfigChange"]}]]],["p-4d3682a8",[[4,"searchcraft-base-search-results",{adInterval:[2,"ad-interval"],customStylesForResults:[1,"custom-styles-for-results"],searchResultMappings:[16],placeAdAtEnd:[4,"place-ad-at-end"],placeAdAtStart:[4,"place-ad-at-start"],resultImagePlacement:[1,"result-image-placement"],buttonLabel:[1,"button-label"],buttonTarget:[1,"button-target"],buttonRel:[1,"button-rel"],containerTarget:[1,"container-target"],containerRel:[1,"container-rel"],hasSearched:[32],query:[32],searchResults:[32]}]]],["p-61cf9d6c",[[0,"searchcraft-popover-form",{config:[16],type:[1],popoverResultMappings:[16]}]]],["p-a7a7b4e0",[[0,"searchcraft-popover-result"]]],["p-d57eba31",[[0,"searchcraft-results-info",{isRequesting:[32],resultsCount:[32],responseTime:[32],query:[32]}]]],["p-93b92b65",[[0,"searchcraft-base-search-result",{titleContent:[1,"title-content"],subtitleContent:[1,"subtitle-content"],bodyContent:[1,"body-content"],footerContent:[1,"footer-content"],buttonLabel:[1,"button-label"],buttonHref:[1,"button-href"],buttonTarget:[1,"button-target"],buttonRel:[1,"button-rel"],containerHref:[1,"container-href"],containerTarget:[1,"container-target"],containerRel:[1,"container-rel"],imageSrc:[1,"image-src"],imageAlt:[1,"image-alt"],imagePlacement:[1,"image-placement"],customStyles:[1,"custom-styles"],documentPosition:[2,"document-position"]}]]],["p-adadf38a",[[0,"searchcraft-popover-list-view",{popoverResultMappings:[16]}]]],["p-04300412",[[0,"searchcraft-button",{iconElement:[16],iconOnly:[4,"icon-only"],iconPosition:[1,"icon-position"],label:[1],isRequesting:[32]}],[0,"searchcraft-input-label",{inputLabelClassName:[1,"input-label-class-name"],label:[1]}]]],["p-09c7fbef",[[0,"searchcraft-error-message",{errorMessage:[1,"error-message"]}]]],["p-aa155194",[[0,"searchcraft-facet-list",{fieldName:[1,"field-name"],baseFacetRoot:[32],facetRoot:[32],selectedPaths:[32],lastTimeTaken:[32],hasNewSearchTerm:[32],lastQuery:[32],lastSearchMode:[32],lastSortType:[32],unsubscribe:[32]}],[0,"searchcraft-slider",{max:[2],min:[2],granularity:[2],dataType:[1,"data-type"],endValue:[32],startValue:[32],lastFocusedHandle:[32]}],[0,"searchcraft-toggle-button",{label:[1],subLabel:[1,"sub-label"],isActive:[32],unsubscribe:[32],lastQuery:[32]}]]]],e)}));
+import{p as e,b as t}from"./p-e0be53df.js";export{s as setNonce}from"./p-e0be53df.js";import{g as a}from"./p-e1255160.js";var r=()=>{const t=import.meta.url;const a={};if(t!==""){a.resourcesUrl=new URL(".",t).href}return e(a)};r().then((async e=>{await a();return t([["p-c27a3673",[[0,"searchcraft-filter-panel",{items:[16],unsubscribe:[32],lastQuery:[32]}]]],["p-cd852b84",[[4,"searchcraft-base-search-results",{adInterval:[2,"ad-interval"],customStylesForResults:[1,"custom-styles-for-results"],searchResultMappings:[16],placeAdAtEnd:[4,"place-ad-at-end"],placeAdAtStart:[4,"place-ad-at-start"],resultImagePlacement:[1,"result-image-placement"],buttonLabel:[1,"button-label"],buttonTarget:[1,"button-target"],buttonRel:[1,"button-rel"],containerTarget:[1,"container-target"],containerRel:[1,"container-rel"],hasSearched:[32],query:[32],searchResults:[32]}]]],["p-b8bd53ce",[[4,"searchcraft-popover-button"]]],["p-e042deb9",[[0,"searchcraft-results-info",{isRequesting:[32],resultsCount:[32],responseTime:[32],query:[32]}]]],["p-8e539d62",[[0,"searchcraft-base-search-result",{titleContent:[1,"title-content"],subtitleContent:[1,"subtitle-content"],bodyContent:[1,"body-content"],footerContent:[1,"footer-content"],buttonLabel:[1,"button-label"],buttonHref:[1,"button-href"],buttonTarget:[1,"button-target"],buttonRel:[1,"button-rel"],containerHref:[1,"container-href"],containerTarget:[1,"container-target"],containerRel:[1,"container-rel"],imageSrc:[1,"image-src"],imageAlt:[1,"image-alt"],imagePlacement:[1,"image-placement"],customStyles:[1,"custom-styles"],documentPosition:[2,"document-position"]}]]],["p-98640a6a",[[0,"searchcraft-popover-list-item",{titleContent:[1,"title-content"],subtitleContent:[1,"subtitle-content"],imageSrc:[1,"image-src"],imageAlt:[1,"image-alt"],href:[1],documentPosition:[2,"document-position"]}]]],["p-efab9f3c",[[0,"searchcraft-button",{iconElement:[16],iconOnly:[4,"icon-only"],iconPosition:[1,"icon-position"],label:[1],isRequesting:[32]}],[0,"searchcraft-input-label",{inputLabelClassName:[1,"input-label-class-name"],label:[1]}],[0,"searchcraft-error-message",{errorMessage:[1,"error-message"]}]]],["p-4580e8a4",[[0,"searchcraft-input-form",{config:[16],autoSearch:[4,"auto-search"],buttonPlacement:[1,"button-placement"],buttonLabel:[1,"button-label"],inputLabel:[1,"input-label"],customStyles:[1,"custom-styles"],placeholderValue:[1,"placeholder-value"],searchTerm:[1,"search-term"],inputValue:[32],error:[32],isSearchcraftInitialized:[32]},null,{config:["onConfigChange"]}],[0,"searchcraft-popover-list-view",{popoverResultMappings:[16],documents:[16]}]]],["p-7049b93d",[[0,"searchcraft-popover-form",{config:[16],type:[1],popoverResultMappings:[16],hotkey:[1],hotkeyModifier:[1,"hotkey-modifier"],isPopoverVisibleInState:[32],unsubscribe:[32],searchResults:[32],searchTerm:[32],isFocused:[32],breakpointSm:[32],breakpointMd:[32],breakpointLg:[32],modalElement:[32]}]]],["p-9d0f5c89",[[0,"searchcraft-facet-list",{fieldName:[1,"field-name"],baseFacetRoot:[32],facetRoot:[32],selectedPaths:[32],lastTimeTaken:[32],hasNewSearchTerm:[32],lastQuery:[32],lastSearchMode:[32],lastSortType:[32],unsubscribe:[32]}],[0,"searchcraft-slider",{max:[2],min:[2],granularity:[2],dataType:[1,"data-type"],endValue:[32],startValue:[32],lastFocusedHandle:[32]}],[0,"searchcraft-toggle-button",{label:[1],subLabel:[1,"sub-label"],isActive:[32],unsubscribe:[32],lastQuery:[32]}]]]],e)}));
 //# sourceMappingURL=searchcraft-javascript-sdk.esm.js.map

package/dist/searchcraft-javascript-sdk/searchcraft-javascript-sdk.esm.js.map

@@ -1 +1 @@
-{"version":3,"names":["patchBrowser","importMeta","url","opts","resourcesUrl","URL","href","promiseResolve","then","async","options","globalScripts","bootstrapLazy","items","unsubscribe","lastQuery","config","autoSearch","buttonPlacement","buttonLabel","inputLabel","customStyles","placeholderValue","searchTerm","debounceDelay","inputValue","error","isSearchcraftInitialized","adInterval","customStylesForResults","searchResultMappings","placeAdAtEnd","placeAdAtStart","resultImagePlacement","buttonTarget","buttonRel","containerTarget","containerRel","hasSearched","query","searchResults","type","popoverResultMappings","isRequesting","resultsCount","responseTime","titleContent","subtitleContent","bodyContent","footerContent","buttonHref","containerHref","imageSrc","imageAlt","imagePlacement","documentPosition","iconElement","iconOnly","iconPosition","label","inputLabelClassName","errorMessage","fieldName","baseFacetRoot","facetRoot","selectedPaths","lastTimeTaken","hasNewSearchTerm","lastSearchMode","lastSortType","max","min","granularity","dataType","endValue","startValue","lastFocusedHandle","subLabel","isActive"],"sources":["../../node_modules/@stencil/core/internal/client/patch-browser.js","@lazy-browser-entrypoint?app-data=conditional"],"sourcesContent":["/*\n Stencil Client Patch Browser v4.22.3 | MIT Licensed | https://stenciljs.com\n */\n\n// src/client/client-patch-browser.ts\nimport { BUILD, NAMESPACE } from \"@stencil/core/internal/app-data\";\nimport { consoleDevInfo, doc, H, promiseResolve } from \"@stencil/core\";\nvar patchBrowser = () => {\n  if (BUILD.isDev && !BUILD.isTesting) {\n    consoleDevInfo(\"Running in development mode.\");\n  }\n  if (BUILD.cloneNodeFix) {\n    patchCloneNodeFix(H.prototype);\n  }\n  const scriptElm = BUILD.scriptDataOpts ? Array.from(doc.querySelectorAll(\"script\")).find(\n    (s) => new RegExp(`/${NAMESPACE}(\\\\.esm)?\\\\.js($|\\\\?|#)`).test(s.src) || s.getAttribute(\"data-stencil-namespace\") === NAMESPACE\n  ) : null;\n  const importMeta = import.meta.url;\n  const opts = BUILD.scriptDataOpts ? (scriptElm || {})[\"data-opts\"] || {} : {};\n  if (importMeta !== \"\") {\n    opts.resourcesUrl = new URL(\".\", importMeta).href;\n  }\n  return promiseResolve(opts);\n};\nvar patchCloneNodeFix = (HTMLElementPrototype) => {\n  const nativeCloneNodeFn = HTMLElementPrototype.cloneNode;\n  HTMLElementPrototype.cloneNode = function(deep) {\n    if (this.nodeName === \"TEMPLATE\") {\n      return nativeCloneNodeFn.call(this, deep);\n    }\n    const clonedNode = nativeCloneNodeFn.call(this, false);\n    const srcChildNodes = this.childNodes;\n    if (deep) {\n      for (let i = 0; i < srcChildNodes.length; i++) {\n        if (srcChildNodes[i].nodeType !== 2) {\n          clonedNode.appendChild(srcChildNodes[i].cloneNode(true));\n        }\n      }\n    }\n    return clonedNode;\n  };\n};\nexport {\n  patchBrowser\n};\n","export { setNonce } from '@stencil/core';\nimport { bootstrapLazy } from '@stencil/core';\nimport { patchBrowser } from '@stencil/core/internal/client/patch-browser';\nimport { globalScripts } from '@stencil/core/internal/app-globals';\npatchBrowser().then(async (options) => {\n  await globalScripts();\n  return bootstrapLazy([/*!__STENCIL_LAZY_DATA__*/], options);\n});\n"],"mappings":"0HAOA,IAAIA,EAAe,KAUjB,MAAMC,cAAyBC,IAC/B,MAAMC,EAAqE,GAC3E,GAAIF,IAAe,GAAI,CACrBE,EAAKC,aAAe,IAAIC,IAAI,IAAKJ,GAAYK,IACjD,CACE,OAAOC,EAAeJ,EAAK,EClB7BH,IAAeQ,MAAKC,MAAOC,UACnBC,IACN,OAAOC,EAAc,8CAAuC,CAAAC,MAAA,KAAAC,YAAA,KAAAC,UAAA,qDAAAC,OAAA,KAAAC,WAAA,kBAAAC,gBAAA,uBAAAC,YAAA,mBAAAC,WAAA,kBAAAC,aAAA,oBAAAC,iBAAA,wBAAAC,WAAA,kBAAAC,cAAA,qBAAAC,WAAA,KAAAC,MAAA,KAAAC,yBAAA,YAAAX,OAAA,4EAAAY,WAAA,kBAAAC,uBAAA,gCAAAC,qBAAA,KAAAC,aAAA,sBAAAC,eAAA,wBAAAC,qBAAA,6BAAAd,YAAA,mBAAAe,aAAA,oBAAAC,UAAA,iBAAAC,gBAAA,uBAAAC,aAAA,oBAAAC,YAAA,KAAAC,MAAA,KAAAC,cAAA,uDAAAxB,OAAA,KAAAyB,KAAA,IAAAC,sBAAA,yGAAAC,aAAA,KAAAC,aAAA,KAAAC,aAAA,KAAAN,MAAA,6DAAAO,aAAA,oBAAAC,gBAAA,uBAAAC,YAAA,mBAAAC,cAAA,qBAAA9B,YAAA,mBAAA+B,WAAA,kBAAAhB,aAAA,oBAAAC,UAAA,iBAAAgB,cAAA,qBAAAf,gBAAA,uBAAAC,aAAA,oBAAAe,SAAA,gBAAAC,SAAA,gBAAAC,eAAA,sBAAAjC,aAAA,oBAAAkC,iBAAA,+EAAAb,sBAAA,iDAAAc,YAAA,KAAAC,SAAA,gBAAAC,aAAA,oBAAAC,MAAA,IAAAhB,aAAA,qCAAAiB,oBAAA,6BAAAD,MAAA,uDAAAE,aAAA,oEAAAC,UAAA,iBAAAC,cAAA,KAAAC,UAAA,KAAAC,cAAA,KAAAC,cAAA,KAAAC,iBAAA,KAAApD,UAAA,KAAAqD,eAAA,KAAAC,aAAA,KAAAvD,YAAA,gCAAAwD,IAAA,IAAAC,IAAA,IAAAC,YAAA,IAAAC,SAAA,gBAAAC,SAAA,KAAAC,WAAA,KAAAC,kBAAA,uCAAAjB,MAAA,IAAAkB,SAAA,gBAAAC,SAAA,KAAAhE,YAAA,KAAAC,UAAA,UAAAL,EAAA","ignoreList":[]}
+{"version":3,"names":["patchBrowser","importMeta","url","opts","resourcesUrl","URL","href","promiseResolve","then","async","options","globalScripts","bootstrapLazy","items","unsubscribe","lastQuery","adInterval","customStylesForResults","searchResultMappings","placeAdAtEnd","placeAdAtStart","resultImagePlacement","buttonLabel","buttonTarget","buttonRel","containerTarget","containerRel","hasSearched","query","searchResults","isRequesting","resultsCount","responseTime","titleContent","subtitleContent","bodyContent","footerContent","buttonHref","containerHref","imageSrc","imageAlt","imagePlacement","customStyles","documentPosition","iconElement","iconOnly","iconPosition","label","inputLabelClassName","errorMessage","config","autoSearch","buttonPlacement","inputLabel","placeholderValue","searchTerm","inputValue","error","isSearchcraftInitialized","popoverResultMappings","documents","type","hotkey","hotkeyModifier","isPopoverVisibleInState","isFocused","breakpointSm","breakpointMd","breakpointLg","modalElement","fieldName","baseFacetRoot","facetRoot","selectedPaths","lastTimeTaken","hasNewSearchTerm","lastSearchMode","lastSortType","max","min","granularity","dataType","endValue","startValue","lastFocusedHandle","subLabel","isActive"],"sources":["../../node_modules/@stencil/core/internal/client/patch-browser.js","@lazy-browser-entrypoint?app-data=conditional"],"sourcesContent":["/*\n Stencil Client Patch Browser v4.22.3 | MIT Licensed | https://stenciljs.com\n */\n\n// src/client/client-patch-browser.ts\nimport { BUILD, NAMESPACE } from \"@stencil/core/internal/app-data\";\nimport { consoleDevInfo, doc, H, promiseResolve } from \"@stencil/core\";\nvar patchBrowser = () => {\n  if (BUILD.isDev && !BUILD.isTesting) {\n    consoleDevInfo(\"Running in development mode.\");\n  }\n  if (BUILD.cloneNodeFix) {\n    patchCloneNodeFix(H.prototype);\n  }\n  const scriptElm = BUILD.scriptDataOpts ? Array.from(doc.querySelectorAll(\"script\")).find(\n    (s) => new RegExp(`/${NAMESPACE}(\\\\.esm)?\\\\.js($|\\\\?|#)`).test(s.src) || s.getAttribute(\"data-stencil-namespace\") === NAMESPACE\n  ) : null;\n  const importMeta = import.meta.url;\n  const opts = BUILD.scriptDataOpts ? (scriptElm || {})[\"data-opts\"] || {} : {};\n  if (importMeta !== \"\") {\n    opts.resourcesUrl = new URL(\".\", importMeta).href;\n  }\n  return promiseResolve(opts);\n};\nvar patchCloneNodeFix = (HTMLElementPrototype) => {\n  const nativeCloneNodeFn = HTMLElementPrototype.cloneNode;\n  HTMLElementPrototype.cloneNode = function(deep) {\n    if (this.nodeName === \"TEMPLATE\") {\n      return nativeCloneNodeFn.call(this, deep);\n    }\n    const clonedNode = nativeCloneNodeFn.call(this, false);\n    const srcChildNodes = this.childNodes;\n    if (deep) {\n      for (let i = 0; i < srcChildNodes.length; i++) {\n        if (srcChildNodes[i].nodeType !== 2) {\n          clonedNode.appendChild(srcChildNodes[i].cloneNode(true));\n        }\n      }\n    }\n    return clonedNode;\n  };\n};\nexport {\n  patchBrowser\n};\n","export { setNonce } from '@stencil/core';\nimport { bootstrapLazy } from '@stencil/core';\nimport { patchBrowser } from '@stencil/core/internal/client/patch-browser';\nimport { globalScripts } from '@stencil/core/internal/app-globals';\npatchBrowser().then(async (options) => {\n  await globalScripts();\n  return bootstrapLazy([/*!__STENCIL_LAZY_DATA__*/], options);\n});\n"],"mappings":"0HAOA,IAAIA,EAAe,KAUjB,MAAMC,cAAyBC,IAC/B,MAAMC,EAAqE,GAC3E,GAAIF,IAAe,GAAI,CACrBE,EAAKC,aAAe,IAAIC,IAAI,IAAKJ,GAAYK,IACjD,CACE,OAAOC,EAAeJ,EAAK,EClB7BH,IAAeQ,MAAKC,MAAOC,UACnBC,IACN,OAAOC,EAAc,8CAAuC,CAAAC,MAAA,KAAAC,YAAA,KAAAC,UAAA,8DAAAC,WAAA,kBAAAC,uBAAA,gCAAAC,qBAAA,KAAAC,aAAA,sBAAAC,eAAA,wBAAAC,qBAAA,6BAAAC,YAAA,mBAAAC,aAAA,oBAAAC,UAAA,iBAAAC,gBAAA,uBAAAC,aAAA,oBAAAC,YAAA,KAAAC,MAAA,KAAAC,cAAA,yGAAAC,aAAA,KAAAC,aAAA,KAAAC,aAAA,KAAAJ,MAAA,6DAAAK,aAAA,oBAAAC,gBAAA,uBAAAC,YAAA,mBAAAC,cAAA,qBAAAd,YAAA,mBAAAe,WAAA,kBAAAd,aAAA,oBAAAC,UAAA,iBAAAc,cAAA,qBAAAb,gBAAA,uBAAAC,aAAA,oBAAAa,SAAA,gBAAAC,SAAA,gBAAAC,eAAA,sBAAAC,aAAA,oBAAAC,iBAAA,+EAAAV,aAAA,oBAAAC,gBAAA,uBAAAK,SAAA,gBAAAC,SAAA,gBAAAlC,KAAA,IAAAqC,iBAAA,oEAAAC,YAAA,KAAAC,SAAA,gBAAAC,aAAA,oBAAAC,MAAA,IAAAjB,aAAA,qCAAAkB,oBAAA,6BAAAD,MAAA,sCAAAE,aAAA,oEAAAC,OAAA,KAAAC,WAAA,kBAAAC,gBAAA,uBAAA9B,YAAA,mBAAA+B,WAAA,kBAAAX,aAAA,oBAAAY,iBAAA,wBAAAC,WAAA,kBAAAC,WAAA,KAAAC,MAAA,KAAAC,yBAAA,YAAAR,OAAA,yDAAAS,sBAAA,KAAAC,UAAA,uDAAAV,OAAA,KAAAW,KAAA,IAAAF,sBAAA,KAAAG,OAAA,IAAAC,eAAA,sBAAAC,wBAAA,KAAAlD,YAAA,KAAAe,cAAA,KAAA0B,WAAA,KAAAU,UAAA,KAAAC,aAAA,KAAAC,aAAA,KAAAC,aAAA,KAAAC,aAAA,qDAAAC,UAAA,iBAAAC,cAAA,KAAAC,UAAA,KAAAC,cAAA,KAAAC,cAAA,KAAAC,iBAAA,KAAA5D,UAAA,KAAA6D,eAAA,KAAAC,aAAA,KAAA/D,YAAA,gCAAAgE,IAAA,IAAAC,IAAA,IAAAC,YAAA,IAAAC,SAAA,gBAAAC,SAAA,KAAAC,WAAA,KAAAC,kBAAA,uCAAArC,MAAA,IAAAsC,SAAA,gBAAAC,SAAA,KAAAxE,YAAA,KAAAC,UAAA,UAAAL,EAAA","ignoreList":[]}

package/dist/types/components/searchcraft-base-search-result/searchcraft-base-search-result.d.ts

@@ -1,19 +1,72 @@
+/**
+ * This web component is designed to display detailed information for a single search result.
+ * Once a query is submitted, the component formats and presents the result.
+ * It is consumed within the `searchcraft-base-search-results` component.
+ */
 export declare class SearchcraftBaseSearchResult {
+    /**
+     * The title content.
+     */
     titleContent: string | undefined;
+    /**
+     * The subtitle content.
+     */
     subtitleContent: string | undefined;
+    /**
+     * The body content.
+     */
     bodyContent: string | undefined;
+    /**
+     * The footer content.
+     */
     footerContent: string | undefined;
+    /**
+     * The label for the button rendered when containerHref is not present.
+     */
     buttonLabel: string | undefined;
+    /**
+     * The link for the button rendered when containerHref is not present.
+     */
     buttonHref: string | undefined;
+    /**
+     * Where to open the link for the button rendered when containerHref is not present.
+     */
     buttonTarget: '_blank' | '_self' | '_top' | '_parent';
+    /**
+     * The relationship between the current document and the link for the button rendered when containerHref is not present.
+     */
     buttonRel: 'noreferrer' | 'noopener' | 'nofollow' | undefined;
+    /**
+     * The link for the containing element.
+     */
     containerHref: string | undefined;
+    /**
+     * Where to open the link for the containing element.
+     */
     containerTarget: '_blank' | '_self' | '_top' | '_parent';
+    /**
+     * The relationship between the current document and the link for the containing element.
+     */
     containerRel: 'noreferrer' | 'noopener' | 'nofollow' | undefined;
+    /**
+     * The image source.
+     */
     imageSrc: string | undefined;
+    /**
+     * The image alternative text.
+     */
     imageAlt: string | undefined;
+    /**
+     * The placement of the image.
+     */
     imagePlacement: 'left' | 'right';
+    /**
+     * A custom styles object.
+     */
     customStyles: string | undefined;
+    /**
+     * The position in the document. Used with the "document_clicked" measure event.
+     */
     documentPosition: number;
     private searchcraftStore;
     private recordMeasureEvent;

package/dist/types/components/searchcraft-base-search-results/searchcraft-base-search-results.d.ts

@@ -1,18 +1,86 @@
 import { type EventEmitter } from '../../stencil-public-runtime';
 import type { SearchcraftResponse } from '@searchcraft/core';
 import type { SearchResultMappings } from "../../types/index";
+/**
+ * This web component is responsible for displaying the results of a search query.
+ * Once a query is submitted, the component formats and presents an ordered list of the results.
+ *
+ * ## Usage
+ * ```html
+ * <!-- index.html -->
+ * <searchcraft-base-search-results
+ *   ad-interval="4"
+ *   place-ad-at-start="false"
+ *   result-image-placement="right"
+ * />
+ * ```
+ *
+ * ```js
+ * // index.js
+ * const baseSearchResults = document.querySelector('searchcraft-base-search-results');
+ *
+ * baseSearchResults.searchResultMappings = containerHref: {
+ *   fieldNames: [
+ *    {
+ *      fieldName: 'canonical_link',
+ *      dataType: 'text',
+ *    },
+ *  ],
+ * };
+ *
+ * baseSearchResults.addEventListener('noResults', () => {
+ *   console.log('No search results found');
+ * });
+ * ```
+ */
 export declare class SearchcraftBaseSearchResults {
+    /**
+     * How often ads are injected.
+     */
     adInterval: number;
+    /**
+     * A custom styles object.
+     */
     customStylesForResults: string | Record<string, Record<string, string>> | undefined;
+    /**
+     * Formats the content rendered for each result.
+     */
     searchResultMappings: SearchResultMappings | undefined;
+    /**
+     * Should an ad be placed at the end of the results.
+     */
     placeAdAtEnd: boolean;
+    /**
+     * Should an ad be placed at the start of the results.
+     */
     placeAdAtStart: boolean;
+    /**
+     * The placement of the image for each result.
+     */
     resultImagePlacement: 'left' | 'right';
+    /**
+     * The label for the button rendered when containerHref is not present for each result.
+     */
     buttonLabel: string | undefined;
+    /**
+     * Where to open the link for the button rendered when containerHref is not present for each result.
+     */
     buttonTarget: '_blank' | '_self' | '_top' | '_parent';
+    /**
+     * The relationship between the current document and the link for the button rendered when containerHref is not present for each result.
+     */
     buttonRel: 'noreferrer' | 'noopener' | 'nofollow' | undefined;
+    /**
+     * Where to open the link for the containing element for each result.
+     */
     containerTarget: '_blank' | '_self' | '_top' | '_parent';
+    /**
+     * The relationship between the current document and the link for the containing element for each result.
+     */
     containerRel: 'noreferrer' | 'noopener' | 'nofollow' | undefined;
+    /**
+     * When no results are returned.
+     */
     noResults: EventEmitter<void>;
     hasSearched: boolean;
     query: string;

package/dist/types/components/searchcraft-button/searchcraft-button.d.ts

@@ -1,9 +1,29 @@
 import { type EventEmitter } from '../../stencil-public-runtime';
+/**
+ * This web component represents a button to be consumed within the `search-input-form` component.
+ * It provides a clear, interactive way for users to submit search queries or trigger actions in a search interface.
+ * It is consumed within the `searchcraft-input-form` component.
+ */
 export declare class SearchcraftButton {
+    /**
+     * The icon element.
+     */
     iconElement?: Element;
+    /**
+     * Should the button only display an icon.
+     */
     iconOnly: boolean;
+    /**
+     * The position of the icon.
+     */
     iconPosition: string;
+    /**
+     * The label for the button.
+     */
     label: string;
+    /**
+     * When the button is clicked.
+     */
     buttonClick: EventEmitter<void>;
     isRequesting: boolean;
     private handleClick;

package/dist/types/components/searchcraft-error-message/searchcraft-error-message.d.ts

@@ -1,4 +1,16 @@
+/**
+ * This web component is designed to display a user-friendly error message when a search query fails, providing clear feedback to users and enhancing their experience when an issue arises during the search process.
+ *
+ * ## Usage
+ * ```html
+ * <!-- index.html -->
+ * <searchcraft-error-message error-message="No search results found for query" />
+ * ```
+ */
 export declare class SearchcraftErrorMessage {
+    /**
+     * The error message.
+     */
     errorMessage?: string;
     render(): any;
 }

package/dist/types/components/searchcraft-facet-list/searchcraft-facet-list.d.ts

@@ -1,8 +1,33 @@
 import { type EventEmitter } from '../../stencil-public-runtime';
 import type { FacetChild, FacetRoot } from '@searchcraft/core';
 import { type SearchcraftState } from "../../provider/store";
+/**
+ * This web component is designed to display facets in a search interface, allowing users to refine their search results by applying filters based on various attributes.
+ * It is consumed within the `searchcraft-filter-panel`.
+ *
+ * ## Usage
+ * ```html
+ * <!-- index.html -->
+ * <searchcraft-facet-list field-name="title" />
+ * ```
+ *
+ * ```js
+ * // index.js
+ * const facetList = document.querySelector('searchcraft-facet-list');
+ *
+ * facetList.addEventListener('facetSelectionUpdated', () => {
+ *   console.log('Facet selection updated');
+ * });
+ * ```
+ */
 export declare class SearchcraftFacetList {
+    /**
+     * The name of the field where facets are applied.
+     */
     fieldName: string;
+    /**
+     * When the facets are updated.
+     */
     facetSelectionUpdated: EventEmitter<{
         paths: string[];
     }>;

package/dist/types/components/searchcraft-filter-panel/searchcraft-filter-panel.d.ts

@@ -1,5 +1,17 @@
 import type { FilterItem } from '../../types/searchcraft-filter-panel.types';
+/**
+ * This web component represents a series of filters that allows users to refine and control their search queries by applying various filter criteria.
+ *
+ * ## Usage
+ * ```html
+ * <!-- index.html -->
+ * <searchcraft-filter-panel />
+ * ```
+ */
 export declare class SearchcraftFilterPanel {
+    /**
+     * The items to filter.
+     */
     items: FilterItem[];
     unsubscribe: (() => void) | undefined;
     lastQuery: string | undefined;

package/dist/types/components/searchcraft-input-form/searchcraft-input-form.d.ts

@@ -4,6 +4,31 @@ export interface ScInputCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLSearchcraftInputFormElement;
 }
+/**
+ * This web component provides a user-friendly interface for querying an indexed dataset, enabling users to easily search large collections of data.
+ * It abstracts the complexities of index-based searching, making it accessible to users of all technical levels.
+ *
+ * ## Usage
+ * ```html
+ * <!-- index.html -->
+ * <searchcraft-input-form placeholder-value="Search here" />
+ * ```
+ *
+ * ```js
+ * // index.js
+ * const searchInputForm = document.querySelector('searchcraft-input-form');
+ *
+ * seardchInputForm.config = {
+ *   index: [],
+ *   readKey: '',
+ *   endpointUrl: '',
+ * };
+ *
+ * searchForm.addEventListener('querySubmit', (event) => {
+ *   console.log('Query submitted', event.detail);
+ * });
+ * ```
+ */
 export declare class SearchcraftInput {
     /**
      * The Searchcraft config object.
@@ -38,33 +63,32 @@ export declare class SearchcraftInput {
      */
     searchTerm: string;
     /**
-     * The duration to debounce the input's `inputChange` event.
-     */
-    debounceDelay: number;
-    /**
-     * Event emitted when the input element has been cleared.
+     * When the input is cleared.
      */
     inputCleared: EventEmitter<void>;
     /**
-     * Event emitted when a query returns with no results received.
+     * When no results are returned.
      */
     noResultsReceived: EventEmitter<void>;
     /**
-     * Event emitted when a new search request has been submitted.
-     */
-    querySubmit: EventEmitter<string>;
-    /**
-     * Event emitted when the input has gained focus.
+     * When the input becomes focused.
      */
     inputFocus: EventEmitter<void>;
     /**
-     * Event emitted when the input has lost focus.
+     * When the input becomes unfocused.
      */
     inputBlur: EventEmitter<void>;
+    /**
+     * Event emitted when input initializes.
+     */
+    inputInit: EventEmitter<void>;
+    /**
+     * Event emitted when a query has been submitted.
+     */
+    querySubmit: EventEmitter<string>;
     inputValue: string;
     error: boolean;
     isSearchcraftInitialized: boolean;
-    private debounceTimeout;
     private searchStore;
     init(): void;
     componentDidLoad(): void;

package/dist/types/components/searchcraft-input-label/searchcraft-input-label.d.ts

@@ -1,5 +1,17 @@
+/**
+ * This web component serves as the input label for the searchcraft-input-form component.
+ *
+ * ## Usage
+ * ```html
+ * <!-- index.html -->
+ * <searchcraft-input-label label="Search" />
+ * ```
+ */
 export declare class SearchcraftInputLabel {
+    /**
+     * The classname applied to the label element.
+     */
     inputLabelClassName?: string;
-    label?: string;
+    label: string;
     render(): any;
 }

package/dist/types/components/searchcraft-popover-button/searchcraft-popover-button.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Renders a button which, when clicked, turns on popover visibility.
+ */
+export declare class SearchcraftPopoverButton {
+    handleOnClick(): void;
+    render(): any;
+}

package/dist/types/components/searchcraft-popover-form/searchcraft-popover-form.d.ts

@@ -1,8 +1,104 @@
-import type { SearchcraftConfig } from '@searchcraft/core';
+import type { SearchcraftConfig, SearchcraftResponse } from '@searchcraft/core';
 import type { PopoverResultMappings } from "../../types/index";
+/**
+ * This web component is designed to display search results in a popover container that dynamically appears when the user interacts with a search input field.
+ *
+ * ## Usage
+ * ```html
+ * <!-- index.html -->
+ * <searchcraft-popover-form type="fullscreen" />
+ * ```
+ *
+ * ```js
+ * // index.js
+ * const popoverForm = document.querySelector('searchcraft-popover-form');
+ *
+ * popoverForm.config = {
+ *   index: [index_name_from_vektron],
+ *   readKey: 'read_key_from_vektron',
+ *   endpointUrl: 'enpoint_url_from_vektron',
+ * };
+ *
+ * popoverForm.popoverResultMappings = {
+ *  containerHref: {
+ *   fieldNames: [
+ *    {
+ *      fieldName: 'canonical_link',
+ *      dataType: 'text',
+ *    },
+ *  ],
+ *  };
+ * ```
+ */
 export declare class SearchcraftPopoverForm {
+    /**
+     * The Searchcraft config object.
+     */
     config: SearchcraftConfig | undefined;
+    /**
+     * The type of popover form to render.
+     *
+     * - `inline` - Renders inline with the rest of the content on the page. The search results pop over the page content.
+     * - `fullscreen` - Renders in fullscreen view. Used together with the `searchcraft-popover-button` component.
+     * - `modal` - Renders in a modal view. Used together with the `searchcraft-popover-button` component.
+     */
     type: 'inline' | 'fullscreen' | 'modal';
+    /**
+     * Formats the content rendered for each result.
+     */
     popoverResultMappings: PopoverResultMappings | undefined;
+    /**
+     * The hotkey that activates the popover.
+     */
+    hotkey: string;
+    /**
+     * The hotkey modifier that activates the popover. Used together with the `hotkey` prop.
+     */
+    hotkeyModifier: 'ctrl' | 'meta' | 'alt' | 'option';
+    isPopoverVisibleInState: boolean;
+    unsubscribe: (() => void) | undefined;
+    searchResults: SearchcraftResponse | undefined;
+    searchTerm: string | undefined;
+    isFocused: boolean;
+    breakpointSm: number;
+    breakpointMd: number;
+    breakpointLg: number;
+    modalElement: any;
+    hostElement: HTMLElement;
+    componentDidLoad(): void;
+    disconnectedCallback(): void;
+    handleDocumentClick: (event: MouseEvent) => void;
+    /**
+     * Handles when popover visibility is changed in state
+     */
+    handlePopoverVisibilityChange(isVisible: boolean): void;
+    /**
+     * Actions to perform when various keys are pressed within the popover form.
+     */
+    handleDocumentKeyDown: (event: KeyboardEvent) => void;
+    handleInputInit: () => void;
+    /**
+     * When popover is `inline` and the viewport is at the smallest breakpoint,
+     * focusing on the input will open a modal version of the popover form.
+     */
+    handleInputFocus(): void;
+    handleModalBackdropClick(_event: MouseEvent): void;
+    /**
+     * When a hotkey is pressed, tests if the modifiers also match.
+     * If modifiers match, toggles visibility of the popover modal.
+     */
+    handleHotkeyPressed(event: KeyboardEvent): void;
+    handleCancelButtonClick(): void;
+    /**
+     * Moves focus to the next/previous list item in the list view. If you are at the top
+     * of the list view, it moves focus back to the input.
+     *
+     * @param direction
+     */
+    focusOnNextListItem(direction: 'ArrowDown' | 'ArrowUp'): void;
+    get hasResultsToShow(): boolean;
+    renderInlinePopover(documents: Record<string, unknown>[]): any;
+    renderModalPopover(documents: Record<string, unknown>[]): any;
+    renderFullscreenPopover(documents: Record<string, unknown>[]): any;
     render(): any;
 }

package/dist/types/components/searchcraft-popover-list-item/searchcraft-popover-list-item.d.ts

@@ -0,0 +1,22 @@
+/**
+ * A single list item rendered in a searchcraft-popover-list-view.
+ */
+export declare class SearchcraftPopoverListItem {
+    /** The result title */
+    titleContent: string | undefined;
+    /** The result subtitle */
+    subtitleContent: string | undefined;
+    /** The source of the image. If not included, no item will be rendered. */
+    imageSrc: string | undefined;
+    /** The image alt tag. */
+    imageAlt: string | undefined;
+    /** The link href */
+    href: string | undefined;
+    /** The document position relative to the search results (For Measure) */
+    documentPosition: number;
+    componentDidLoad(): void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    handleButtonClick(): void;
+    render(): any;
+}

package/dist/types/components/searchcraft-popover-list-view/searchcraft-popover-list-view.d.ts

@@ -1,8 +1,24 @@
 import type { PopoverResultMappings } from "../../types/index";
+/**
+ * This web component is designed to display a list of results within a popover interface.
+ * It is consumed within the `searchcraft-popover-form` component.
+ *
+ * ## Usage
+ * ```html
+ * <!-- index.html -->
+ * <searchcraft-popover-list-view />
+ * ```
+ */
 export declare class SearchcraftPopoverListView {
+    /**
+     * The mappings that define how the data in the documents are mapped to the
+     * list-view-item elements.
+     */
     popoverResultMappings: PopoverResultMappings | undefined;
-    componentDidLoad(): void;
-    connectedCallback(): void;
-    disconnectedCallback(): void;
+    /**
+     * The documents to render in the list view.
+     */
+    documents: Record<string, unknown>[] | undefined;
+    renderDocument(document: Record<string, unknown>, index: number): any;
     render(): any;
 }

package/dist/types/components/searchcraft-results-info/searchcraft-results-info.d.ts

@@ -1,3 +1,13 @@
+/**
+ * This web component is designed to display the number of results returned from a search query.
+ * It provides users with real-time feedback on the scale of the results, such as the total number of items found.
+ *
+ * ## Usage
+ * ```html
+ * <!-- index.html -->
+ * <searchcraft-results-info />
+ * ```
+ */
 export declare class SearchcraftResultsInfo {
     isRequesting: boolean;
     resultsCount: number;