@searchcraft/vue-sdk 0.11.1 → 0.12.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Searchcraft, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -22,91 +22,97 @@ $ npm install @searchcraft/vue-sdk
 
 The Vue SDK provides the following prebuilt components for use in your application:
 
-```jsx
-
-<SearchInputForm />
-<SearchPopoverForm />
-<FilterPanel />
-<ResultsInfo />
-<BaseSearchResults />
-
+```vue
+<SearchcraftInputForm />
+<SearchcraftPopoverForm />
+<SearchcraftPopoverButton />
+<SearchcraftFilterPanel />
+<SearchcraftResultsInfo />
+<SearchcraftSearchResults />
+<SearchcraftPagination />
+<SearchcraftSearchResultsPerPage />
+<SearchcraftSummaryBox />
+<SearchcraftTheme />
 ```
 
 These components can be added to your Vue app and customized with configurations as needed.
 
-Example Setup
+### Themes & Styles
+
+**Note** To apply Searchcraft's built-in CSS theme to the components, which is highly recommended, please make sure that the `<SearchcraftTheme>` component is placed somewhere in your Vue template. This component adds the necessary styles for the Searchcraft components. Without this component, the searchcraft theme will _not_ be applied, and the components will render without styles.
 
 #### Example Setup
 
 As early as possible in the app lifecycle, initialize the Searchcraft object:
-```jsx
-import { Searchcraft } from '@searchcraft/react-sdk';
 
+```js
+import { Searchcraft } from '@searchcraft/vue-sdk';
+
+// Index Search Configuration
 const searchcraft = new Searchcraft({
-  index: ['your_index_from_vektron'],
+  indexName: 'your_index_from_vektron',
   readKey: 'your_read_key_from_vektron',
   endpointURL: 'your_searchcraft_endpoint_url',
   searchDebounceDelay: 50, // Optional debounce delay in milliseconds
 })
 
+// Alternatively, you can create a Federation Search Configuration which searches across multiple indices
+const federatedSearchcraft = new Searchcraft({
+  federationName: 'your_federation_name',
+  readKey: 'your_read_key_from_vektron',
+  endpointURL: 'your_searchcraft_endpoint_url',
+  searchDebounceDelay: 50, // Optional debounce delay in milliseconds
+})
 ```
 
 Add components to your application:
 
-```jsx
-
+```vue
 <template>
-  <SearchInputForm />
-  <FilterPanel :items="filterPanelItems" />
-  <BaseSearchResults />
+  <div>
+    <SearchcraftTheme />
+    <SearchcraftInputForm />
+    <SearchcraftFilterPanel :items="filterPanelItems" />
+    <SearchcraftResultsInfo />
+    <SearchcraftSearchResults />
+    <SearchcraftPagination />
+  </div>
 </template>
 
-<script>
+<script setup>
 import {
-  SearchcraftProvider,
-  SearchInputForm,
-  FilterPanel,
-  BaseSearchResults,
+  SearchcraftTheme,
+  SearchcraftInputForm,
+  SearchcraftFilterPanel,
+  SearchcraftResultsInfo,
+  SearchcraftSearchResults,
+  SearchcraftPagination,
 } from '@searchcraft/vue-sdk';
 
-export default {
-  components: {
-    SearchcraftProvider,
-    SearchInputForm,
-    FilterPanel,
-    BaseSearchResults,
+const filterPanelItems = [
+  {
+    type: 'mostRecentToggle',
+    label: 'Most Recent',
+    options: {
+      subLabel: 'Show the most recently published articles first.',
+    },
   },
-  data() {
-    return {
-      filterPanelItems: [
-        {
-          type: 'mostRecentToggle',
-          label: 'Most Recent',
-          options: {
-            subLabel: 'Show the most recently published articles first.',
-          },
-        },
-        {
-          type: 'exactMatchToggle',
-          label: 'Exact Match',
-          options: {
-            subLabel: 'Only show results that precisely match your search.',
-          },
-        },
-      ],
-    };
+  {
+    type: 'exactMatchToggle',
+    label: 'Exact Match',
+    options: {
+      subLabel: 'Only show results that precisely match your search.',
+    },
   },
-};
+];
 </script>
-
 ```
 
-Example Filter Configuration
+### Example Filter Configuration
 
 Below is an example of a filter panel configuration object. It specifies the filters to be displayed in the filter panel and maps them to the corresponding index fields.
 
-```jsx
-
+```js
 const today = new Date();
 const pastDate = new Date(today);
 pastDate.setFullYear(today.getFullYear() - 10);
@@ -128,7 +134,7 @@ export const filterPanelItems = [
   },
   {
     type: 'dateRange',
-    fieldName: 'date_published',
+    field: 'date_published',
     label: 'Filter by Year',
     options: {
       minDate: pastDate,
@@ -138,85 +144,85 @@ export const filterPanelItems = [
   },
   {
     type: 'facets',
-    fieldName: 'section',
+    field: 'section',
     label: 'Filter by Section',
+    options: {
+      subLabel: 'Filter by content section',
+      maxItems: 10,
+    },
   },
 ];
-
 ```
 
-Example Result Mappings
-
-Customize the appearance and behavior of search results by modifying the searchResultMappings configuration. Use field names from your index to map the content.
+### Search Result Templates
+
+The Vue SDK supports custom search result templates using template functions. You can customize the appearance and behavior of search results by providing a template function:
+
+```js
+import { html } from '@searchcraft/vue-sdk';
+
+export const customSearchResultTemplate = (data, index, { html }) => {
+  return html`
+    <a href="${data.canonical_link}" target="_blank" rel="noreferrer">
+      <div class="search-result-content">
+        <h3 class="search-result-content-subtitle">${data.section_name}</h3>
+        <h2 class="search-result-content-title">${data.headline}</h2>
+        <p class="search-result-content-body">${data.sub_headline}</p>
+        <footer class="search-result-content-footer">
+          <time>
+            ${new Intl.DateTimeFormat("en-US", {
+              day: "numeric",
+              month: "short",
+              year: "numeric",
+            }).format(new Date(data.date_published))}
+          </time>
+          •
+          <p>${data.author_name}</p>
+        </footer>
+      </div>
+      <div class="search-result-image">
+        <img src="${data.medium_image}" alt="${data.headline}" />
+      </div>
+    </a>
+  `;
+};
+```
 
-```jsx
+Then apply the template to your search results component:
 
-export const searchResultMappings = {
-  containerHref: {
-    fieldNames: [
-      {
-        fieldName: 'canonical_link',
-        dataType: 'text',
-      },
-    ],
-  },
-  footer: {
-    fieldNames: [
-      {
-        fieldName: 'date_published',
-        dataType: 'date',
-      },
-      {
-        fieldName: 'author_name',
-        dataType: 'text',
-      },
-    ],
-    delimiter: ' • ',
-  },
-  imageSource: {
-    fieldNames: [
-      {
-        fieldName: 'medium_image',
-        dataType: 'text',
-      },
-    ],
-  },
-  body: {
-    fieldNames: [{ fieldName: 'sub_headline', dataType: 'text' }],
-  },
-  title: {
-    fieldNames: [{ fieldName: 'section_name', dataType: 'text' }],
-  },
-  subtitle: {
-    fieldNames: [{ fieldName: 'headline', dataType: 'text' }],
-  },
-};
+```vue
+<template>
+  <SearchcraftSearchResults :template="customSearchResultTemplate" />
+</template>
 
+<script setup>
+import { SearchcraftSearchResults } from '@searchcraft/vue-sdk';
+import { customSearchResultTemplate } from './searchResultTemplate';
+</script>
 ```
 
-#### Event Handling
-You can subscribe to various events within Searchcraft:
+### Event Handling
 
-```jsx
-
-  const searchcraft = new Searchcraft({
-    index: ['your_index_from_vektron'],
-    readKey: 'your_read_key_from_vektron',
-    endpointURL: 'your_searchcraft_endpoint_url',
-  });
+You can subscribe to various events within Searchcraft:
 
-  const unsubscribeCallback = searchcraft.subscribe('query_submitted', (event) => {
-    // Do something in your application when a query has been submitted
-  });
+```js
+const searchcraft = new Searchcraft({
+  indexName: 'your_index_from_vektron',
+  readKey: 'your_read_key_from_vektron',
+  endpointURL: 'your_searchcraft_endpoint_url',
+});
 
+const unsubscribeCallback = searchcraft.subscribe('query_submitted', (event) => {
+  // Do something in your application when a query has been submitted
+});
 
-  const unsubscribeCallback = searchcraft.subscribe('ad_container_rendered', (event) => {
-    // Do something when a new ad container has been rendered
-  });
+const unsubscribeCallback2 = searchcraft.subscribe('ad_container_rendered', (event) => {
+  // Do something when a new ad container has been rendered
+});
 ```
 
-For a complete listing of event subscriptions, refer to the api reference.
+For a complete listing of event subscriptions, refer to the API reference.
 
-Additional Information
+## Additional Information
 
-For more advanced use cases and component-specific documentation, refer to the official [Searchcraft Vue SDK documentation](https://docs.searchcraft.io/).
+For more advanced use cases and component-specific documentation, refer to the official [Searchcraft Vue SDK documentation](https://docs.searchcraft.io/).

package/dist/index.d.ts

@@ -90,6 +90,7 @@ export interface MeasureRequestProperties {
 	searchcraft_organization_id?: string;
 	searchcraft_application_id?: string;
 	searchcraft_index_names: string[];
+	searchcraft_federation_name?: string;
 	search_term?: string;
 	number_of_documents?: number;
 	external_document_id?: string;
@@ -333,8 +334,16 @@ export interface SearchcraftConfig {
 	endpointURL: string;
 	/**
 	 * Name of the Searchcraft search index to search for results within. If you are using Searchcraft Cloud, this value can be found within the Vektron dashboard in the Code Snippets section when configuring a search index.
+	 *
+	 * Note: Either `indexName` or `federationName` must be provided, but not both.
+	 */
+	indexName?: string;
+	/**
+	 * Name of the Searchcraft federation to search across multiple indices. Federation search allows you to search across all indices defined in a federation with a single query.
+	 *
+	 * Note: Either `indexName` or `federationName` must be provided, but not both.
 	 */
-	indexName: string;
+	federationName?: string;
 	/**
 	 * The initial search query to call when Searchcraft is first initialized in your front-end application. This parameter can be used when you want to populate a page with an initial set of search results based on a query.
 	 *
@@ -601,6 +610,7 @@ declare class SearchClient {
 	constructor(parent: SearchcraftCore, config: SearchcraftConfig, userId: string);
 	/**
 	 * Getter for the base url used by the /search endpoint.
+	 * Supports both index and federation search endpoints.
 	 */
 	private get baseSearchUrl();
 	/**
@@ -640,7 +650,9 @@ export interface SearchcraftStateFunctions {
 	removeFacetPathsForIndexField: (fieldName: string) => void;
 	removeRangeValueForIndexField: (fieldName: string) => void;
 	resetSearchValues: () => void;
-	search: () => Promise<void>;
+	search: (options?: {
+		skipSummary?: boolean;
+	}) => Promise<void>;
 	setPopoverVisibility: (isVisible: boolean) => void;
 	setSearchResultsCount: (count: number) => void;
 	setSearchResultsPage: (page: number) => void;
@@ -671,6 +683,11 @@ export interface SearchcraftStateValues {
 	searchClientRequestProperties: SearchClientRequestProperties | string | undefined | null;
 	searchClientResponseItems: SearchClientResponseItem[];
 	cachedSearchClientResponseItems: SearchClientResponseItem[];
+	cachedSearchResponseFacetPrime: FacetPrime | undefined | null;
+	cachedSupplementalFacetPrime: FacetPrime | undefined | null;
+	cachedSearchResponseTimeTaken: number | undefined;
+	cachedSearchResultsCount: number | undefined;
+	cachedSearchClientRequestProperties: SearchClientRequestProperties | string | undefined | null;
 	searchResponseTimeTaken: number | undefined;
 	searchResponseFacetPrime: FacetPrime | undefined | null;
 	supplementalFacetPrime: FacetPrime | undefined | null;
@@ -684,6 +701,7 @@ export interface SearchcraftStateValues {
 	hasSummaryBox: boolean;
 	isSummaryLoading: boolean;
 	summaryClient?: SummaryClient;
+	isSummaryNotEnabled: boolean;
 }
 export interface SearchcraftState extends SearchcraftStateFunctions, SearchcraftStateValues {
 }
@@ -908,6 +926,10 @@ export namespace Components {
 		  * The id of the Searchcraft instance that this component should use.
 		 */
 		"searchcraftId"?: string;
+		/**
+		  * The value to display in the input field.
+		 */
+		"value"?: string;
 	}
 	/**
 	 * This web component serves as the input label for the searchcraft-input-form component.
@@ -1048,6 +1070,14 @@ export namespace Components {
 		  * The hotkey modifier that activates the popover. Used together with the `hotkey` prop.
 		 */
 		"hotkeyModifier"?: "ctrl" | "meta" | "alt" | "option";
+		/**
+		  * The placeholder's render behavior. 'hide-on-focus' - Hide the placeholder text immediately when the input form gains focus. 'hide-on-text-entered' - Only hide the placeholder when the input form has text entered into it.
+		 */
+		"placeholderBehavior"?: "hide-on-focus" | "hide-on-text-entered";
+		/**
+		  * The input element's placeholder value.
+		 */
+		"placeholderValue"?: string;
 		/**
 		  * Formats the content rendered for each result.
 		 */
@@ -2163,6 +2193,10 @@ declare namespace LocalJSX {
 		  * The id of the Searchcraft instance that this component should use.
 		 */
 		"searchcraftId"?: string;
+		/**
+		  * The value to display in the input field.
+		 */
+		"value"?: string;
 	}
 	/**
 	 * This web component serves as the input label for the searchcraft-input-form component.
@@ -2303,6 +2337,14 @@ declare namespace LocalJSX {
 		  * The hotkey modifier that activates the popover. Used together with the `hotkey` prop.
 		 */
 		"hotkeyModifier"?: "ctrl" | "meta" | "alt" | "option";
+		/**
+		  * The placeholder's render behavior. 'hide-on-focus' - Hide the placeholder text immediately when the input form gains focus. 'hide-on-text-entered' - Only hide the placeholder when the input form has text entered into it.
+		 */
+		"placeholderBehavior"?: "hide-on-focus" | "hide-on-text-entered";
+		/**
+		  * The input element's placeholder value.
+		 */
+		"placeholderValue"?: string;
 		/**
 		  * Formats the content rendered for each result.
 		 */