@getlupa/client 0.4.3-1

package/.browserslistrc

@@ -0,0 +1,3 @@
+> 1%
+last 2 versions
+not dead

package/.eslintrc.js

@@ -0,0 +1,37 @@
+module.exports = {
+  root: true,
+  env: {
+    node: true,
+  },
+  extends: [
+    "plugin:vue/essential",
+    "eslint:recommended",
+    "@vue/typescript/recommended",
+    "@vue/prettier",
+    "@vue/prettier/@typescript-eslint",
+  ],
+  parserOptions: {
+    ecmaVersion: 2020,
+  },
+  rules: {
+    "no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
+    "no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off",
+    "prettier/prettier": [
+      "error",
+      {
+        endOfLine: "auto",
+      },
+    ],
+  },
+  overrides: [
+    {
+      files: [
+        "**/__tests__/*.{j,t}s?(x)",
+        "**/tests/unit/**/*.spec.{j,t}s?(x)",
+      ],
+      env: {
+        jest: true,
+      },
+    },
+  ],
+};

package/.github/workflows/build-test.yml

@@ -0,0 +1,23 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Lupa-Test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: c-hive/gha-yarn-cache@v2
+      - run: yarn install
+      - run: yarn build
+      - run: yarn validate:es5
+      - run: yarn test:unit
+      - run: yarn test:e2e

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,24 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: NPM Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: yarn install
+      - run: yarn build
+      - run: yarn publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/README.md

@@ -0,0 +1,71 @@
+# search-plugin
+
+## Getting started for development
+
+Copy example configuration files files to enable live reloading of configuration during development
+
+- `src/constants/development/searchBoxDev.example.const.ts`
+
+- `src/constants/development/searchResultsDev.example.const.ts`
+
+To
+
+- `src/constants/development/searchBoxDev.const.ts`
+
+- `src/constants/development/searchResultsDev.const.ts`.
+
+If files are copied, development build will not work.
+
+## Project setup
+
+```
+yarn install
+```
+
+### Compiles and hot-reloads for development
+
+```
+yarn serve
+```
+
+### Bundles the plugin
+
+```
+yarn build
+```
+
+### Lints and fixes files
+
+```
+yarn lint
+```
+
+### Runs tests
+
+```
+yarn build
+yarn test:unit
+yarn test:e2e
+```
+
+### Interactive Test with Cypress
+
+```
+yarn build
+
+yarn cypress open
+```
+
+### Customize configuration
+
+See [Configuration Reference](https://cli.vuejs.org/config/).
+
+## Documentation
+
+If you are integrating standalone version of the plugin (as a cdn link):
+
+- See [Getting Started - Standalone](/docs/getting-started-standalone.md) for more information about plugin integration.
+
+For integration as an npm package:
+
+- See [Getting Started - npm](/docs/getting-started-npm.md) for more information about plugin integration.

package/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: ["@vue/cli-plugin-babel/preset"],
+};

package/cypress.json

@@ -0,0 +1 @@
+{}

package/dist/cjs/SearchBoxEntry.vue.d.ts

@@ -0,0 +1,6 @@
+import { SearchBoxOptions } from "@/types/search-box/SearchBoxOptions";
+import Vue from "vue";
+export default class SearchBoxEntry extends Vue {
+    searchBoxOptions: SearchBoxOptions;
+    get fullSearchBoxOptions(): SearchBoxOptions;
+}

package/dist/cjs/SearchResultsEntry.vue.d.ts

@@ -0,0 +1,6 @@
+import Vue from "vue";
+import { SearchResultsOptions } from "./types/search-results/SearchResultsOptions";
+export default class SearchResultsEntry extends Vue {
+    searchResultsOptions: SearchResultsOptions;
+    get fullSearchResultsOptions(): SearchResultsOptions;
+}

package/dist/cjs/components/common/Spinner.vue.d.ts

@@ -0,0 +1,3 @@
+import Vue from "vue";
+export default class Spinner extends Vue {
+}

package/dist/cjs/components/search-box/SearchBox.vue.d.ts

@@ -0,0 +1,60 @@
+import { FetchedData, HighlightedDocInfo, InputSuggestion, InputSuggestionFacet, SelectedData, TrackableEventData } from "@/types/search-box/Common";
+import { SearchBoxInputOptions, SearchBoxOptions, SearchBoxPanelOptions } from "@/types/search-box/SearchBoxOptions";
+import { QueryParams } from "@/types/search-results/QueryParams";
+import { Document } from "@getlupa/client-sdk/Types";
+import Vue from "vue";
+export default class SearchBox extends Vue {
+    options: SearchBoxOptions;
+    inputValue: string;
+    suggestedValue: InputSuggestion;
+    opened: boolean;
+    highlightedDocument?: {
+        doc?: Document;
+        link?: string;
+    };
+    addHistory: ({ item }: {
+        item: string;
+    }) => string[];
+    saveOptions: ({ options, }: {
+        options: SearchBoxOptions;
+    }) => void;
+    get searchValue(): string;
+    get inputOptions(): SearchBoxInputOptions;
+    get panelOptions(): SearchBoxPanelOptions;
+    get searchTriggers(): string[];
+    trackClick: ({ queryKey, data, }: {
+        queryKey: string;
+        data: TrackableEventData;
+    }) => void;
+    setSearchResultsLink: (searchResultsLink: string) => {
+        searchResultsLink: string;
+    };
+    setSearchBoxOptions: ({ options, }: {
+        options: SearchBoxOptions;
+    }) => void;
+    mounted(): void;
+    beforeDestroy(): void;
+    handleMouseClick(e: MouseEvent): void;
+    handleKeyDown(e: KeyboardEvent): void;
+    handleInput(value: string): void;
+    handleItemsFetch(data: FetchedData): void;
+    handleItemSelect(data: SelectedData): void;
+    selectSuggestion(inputSuggestion: InputSuggestion, shouldSearch?: boolean): void;
+    handleNavigateDocument({ link }: {
+        doc?: Document;
+        link?: string;
+    }): void;
+    handleCurrentValueSearch(): void;
+    goToResults: ({ searchText, facet, }: {
+        searchText: string;
+        facet?: InputSuggestionFacet;
+    }) => {
+        params: QueryParams;
+    };
+    handleSearch({ query }?: {
+        query: string;
+    }): void;
+    trackDocumentClick(doc: HighlightedDocInfo): void;
+    trackSuggestionClick(suggestion?: string): void;
+    resetValues(): void;
+}

package/dist/cjs/components/search-box/SearchBoxInput.vue.d.ts

@@ -0,0 +1,21 @@
+import { InputSuggestion } from "@/types/search-box/Common";
+import { SearchBoxInputOptions } from "@/types/search-box/SearchBoxOptions";
+import Vue from "vue";
+export default class SearchBoxInput extends Vue {
+    options: SearchBoxInputOptions;
+    suggestedValue: InputSuggestion;
+    labels: import("@/types/search-box/SearchBoxOptions").SearchBoxOptionLabels;
+    input: string;
+    saveInputValue: ({ input, }: {
+        input: string;
+    }) => void;
+    query: string;
+    get inputValue(): string;
+    set inputValue(value: string);
+    get showHint(): boolean;
+    get inputAttributes(): Record<string, string>;
+    onSuggestedValueChange(): void;
+    handleQueryChange(): void;
+    handleInput(evt?: InputEvent): void;
+    handleFocus(): void;
+}

package/dist/cjs/components/search-box/SearchBoxMainPanel.vue.d.ts

@@ -0,0 +1,33 @@
+import { SearchBoxPanelOptions } from "@/types/search-box/SearchBoxOptions";
+import { SearchBoxPanel, SearchBoxPanelType } from "@/types/search-box/SearchBoxPanel";
+import Vue from "vue";
+import { SdkOptions } from "@/types/General";
+import { DisplaySuggestion } from "@/types/search-box/Common";
+export default class SearchBoxMainPanel extends Vue {
+    options: SearchBoxPanelOptions;
+    inputValue: string;
+    focused: boolean;
+    history: string[];
+    labels: import("@/types/search-box/SearchBoxOptions").SearchBoxOptionLabels;
+    panels: SearchBoxPanel[];
+    sdkOptions: SdkOptions;
+    get displayResults(): boolean;
+    get displayHistory(): boolean;
+    suggestionResults: Record<string, DisplaySuggestion[]>;
+    getInput(panel: SearchBoxPanel): string;
+    highlightChange: ({ action, }: {
+        action: "up" | "down" | "clear";
+    }) => void;
+    mounted(): void;
+    beforeDestroy(): void;
+    handleNavigation(e: KeyboardEvent): void;
+    handleGoToResults({ query }?: {
+        query: string;
+    }): void;
+    remove({ item }: {
+        item: string;
+    }): void;
+    removeAll(): void;
+    getComponent(type: SearchBoxPanelType): string;
+    appHeight(): void;
+}

package/dist/cjs/components/search-box/SearchBoxMoreResults.vue.d.ts

@@ -0,0 +1,11 @@
+import { SearchBoxOptionLabels, SearchBoxOptions } from "@/types/search-box/SearchBoxOptions";
+import { SearchQueryResult } from "@getlupa/client-sdk/Types";
+import Vue from "vue";
+export default class SearchBoxMoreResults extends Vue {
+    labels: SearchBoxOptionLabels;
+    showTotalCount: boolean;
+    docResults: Record<string, SearchQueryResult>;
+    options: SearchBoxOptions;
+    get totalCount(): string;
+    handleClick(): void;
+}

package/dist/cjs/components/search-box/__tests__/SearchBox.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/components/search-box/__tests__/SearchBoxInput.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/components/search-box/__tests__/SearchBoxMainPanel.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/components/search-box/history/SearchBoxHistoryItem.vue.d.ts

@@ -0,0 +1,7 @@
+import Vue from "vue";
+export default class SearchBoxHistoryItem extends Vue {
+    item: string;
+    highlighted: boolean;
+    remove(): void;
+    click(): void;
+}

package/dist/cjs/components/search-box/history/SearchBoxHistoryPanel.vue.d.ts

@@ -0,0 +1,23 @@
+import Vue from "vue";
+import { SearchBoxHistory } from "@/types/search-box/SearchBoxHistory";
+export default class SearchBoxHistoryPanel extends Vue {
+    options: SearchBoxHistory;
+    highlightedIndex: number;
+    history: string[];
+    removeItem: ({ item, }: {
+        item: string;
+    }) => string[];
+    clear: () => string[];
+    get highlightIndex(): number;
+    get hasHistory(): boolean;
+    mounted(): void;
+    beforeDestroy(): void;
+    remove({ item }: {
+        item: string;
+    }): void;
+    removeAll(): void;
+    goToResults({ query }: {
+        query: string;
+    }): void;
+    handleKeyDown(e: KeyboardEvent): void;
+}

package/dist/cjs/components/search-box/history/__tests__/SearchBoxHistoryPanel.vue.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/components/search-box/products/SearchBoxProduct.vue.d.ts

@@ -0,0 +1,25 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { DocumentSearchBoxPanel } from "@/types/search-box/SearchBoxPanel";
+import { SearchBoxOptionLabels } from "@/types/search-box/SearchBoxOptions";
+import { DocumentElement } from "@/types/DocumentElement";
+import { TrackableEventData } from "@/types/search-box/Common";
+export default class SearchBoxProduct extends Vue {
+    item: Document;
+    inputValue: string;
+    panelOptions: DocumentSearchBoxPanel;
+    labels?: SearchBoxOptionLabels;
+    highlighted?: boolean;
+    trackClick: ({ queryKey, data, }: {
+        queryKey: string;
+        data: TrackableEventData;
+    }) => void;
+    addHistory: ({ item }: {
+        item: string;
+    }) => string[];
+    get link(): string;
+    get imageElements(): DocumentElement[];
+    get detailElements(): DocumentElement[];
+    get id(): string;
+    handleClick(): void;
+}

package/dist/cjs/components/search-box/products/SearchBoxProducts.vue.d.ts

@@ -0,0 +1,15 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { DocumentSearchBoxPanel } from "@/types/search-box/SearchBoxPanel";
+import { SearchBoxOptionLabels } from "@/types/search-box/SearchBoxOptions";
+export default class SearchBoxProducts extends Vue {
+    items: Document[];
+    inputValue: string;
+    panelOptions: DocumentSearchBoxPanel;
+    labels: SearchBoxOptionLabels;
+    highlightedItem?: {
+        queryKey: string;
+        index: number;
+    };
+    get highlightedIndex(): number;
+}

package/dist/cjs/components/search-box/products/SearchBoxProductsWrapper.vue.d.ts

@@ -0,0 +1,26 @@
+import { SdkOptions } from "@/types/General";
+import { SearchBoxOptionLabels } from "@/types/search-box/SearchBoxOptions";
+import { DocumentSearchBoxPanel } from "@/types/search-box/SearchBoxPanel";
+import { Options, PublicQuery, SearchQueryResult } from "@getlupa/client-sdk/Types";
+import Vue from "vue";
+export default class SearchBoxProductsWrapper extends Vue {
+    panel: DocumentSearchBoxPanel;
+    options: SdkOptions;
+    inputValue: string;
+    labels: SearchBoxOptionLabels;
+    debounce?: number;
+    docResults: Record<string, SearchQueryResult>;
+    get searchResult(): SearchQueryResult;
+    queryDocuments: ({ queryKey, publicQuery, options, }: {
+        queryKey: string;
+        publicQuery: PublicQuery;
+        options?: Options;
+    }) => Promise<{
+        queryKey: string;
+        result?: SearchQueryResult;
+    }>;
+    created(): void;
+    onInputChange(): void;
+    getItemsDebounced: () => unknown;
+    getItems(): void;
+}

package/dist/cjs/components/search-box/products/__tests__/SearchBoxProduct.vue.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/components/search-box/products/elements/SearchBoxProductCustom.vue.d.ts

@@ -0,0 +1,10 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { CustomDocumentElement } from "@/types/DocumentElement";
+export default class SearchBoxProductCustom extends Vue {
+    item: Document;
+    options: CustomDocumentElement;
+    get text(): string;
+    get className(): string;
+    get isHtml(): boolean;
+}

package/dist/cjs/components/search-box/products/elements/SearchBoxProductDescription.vue.d.ts

@@ -0,0 +1,9 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { DescriptionDocumentElement } from "@/types/DocumentElement";
+export default class SearchBoxProductDescription extends Vue {
+    item: Document;
+    options: DescriptionDocumentElement;
+    get description(): unknown;
+    get isHtml(): boolean;
+}

package/dist/cjs/components/search-box/products/elements/SearchBoxProductElement.vue.d.ts

@@ -0,0 +1,11 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { DocumentElement } from "@/types/DocumentElement";
+import { SearchBoxOptionLabels } from "@/types/search-box/SearchBoxOptions";
+export default class SearchBoxProductElement extends Vue {
+    item: Document;
+    element: DocumentElement;
+    labels?: SearchBoxOptionLabels;
+    get elementComponent(): string;
+    get displayElement(): boolean;
+}

package/dist/cjs/components/search-box/products/elements/SearchBoxProductImage.vue.d.ts

@@ -0,0 +1,14 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { ImageDocumentElement } from "@/types/DocumentElement";
+export default class SearchBoxProductImage extends Vue {
+    item: Document;
+    options: ImageDocumentElement;
+    get hasFullImageUrl(): boolean;
+    get rootImageUrl(): string | undefined;
+    get image(): string;
+    get imageUrl(): string;
+    get hasImage(): boolean;
+    get placeholder(): string;
+    replaceWithPlaceholder(e: Event): void;
+}

package/dist/cjs/components/search-box/products/elements/SearchBoxProductPrice.vue.d.ts

@@ -0,0 +1,10 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { RegularPriceDocumentElement } from "@/types/DocumentElement";
+import { SearchBoxOptionLabels } from "@/types/search-box/SearchBoxOptions";
+export default class SearchBoxProductPrice extends Vue {
+    item: Document;
+    options: RegularPriceDocumentElement;
+    labels?: SearchBoxOptionLabels;
+    get price(): string;
+}

package/dist/cjs/components/search-box/products/elements/SearchBoxProductRegularPrice.vue.d.ts

@@ -0,0 +1,10 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { RegularPriceDocumentElement } from "@/types/DocumentElement";
+import { SearchBoxOptionLabels } from "@/types/search-box/SearchBoxOptions";
+export default class SearchBoxProductRegularPrice extends Vue {
+    item: Document;
+    options: RegularPriceDocumentElement;
+    labels: SearchBoxOptionLabels;
+    get price(): string;
+}

package/dist/cjs/components/search-box/products/elements/SearchBoxProductTitle.vue.d.ts

@@ -0,0 +1,9 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { TitleDocumentElement } from "@/types/DocumentElement";
+export default class SearchBoxProductTitle extends Vue {
+    item: Document;
+    options: TitleDocumentElement;
+    get title(): unknown;
+    get isHtml(): boolean;
+}

package/dist/cjs/components/search-box/products/elements/__tests__/SearchBoxProductCustom.vue.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/components/search-box/products/elements/__tests__/SearchBoxProductElement.vue.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/components/search-box/products/elements/__tests__/SearchBoxProductImage.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/components/search-box/products/elements/__tests__/SearchBoxProductPrice.vue.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/components/search-box/products/elements/__tests__/SearchBoxProductTitle.vue.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/components/search-box/products/elements/custom/SearchBoxProductCustomHtml.vue.d.ts

@@ -0,0 +1,9 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { CustomHtmlElement } from "@/types/DocumentElement";
+export default class SearchBoxProductCustomHtml extends Vue {
+    item: Document;
+    options: CustomHtmlElement;
+    get text(): string;
+    get className(): string;
+}

package/dist/cjs/components/search-box/suggestions/SearchBoxSuggestion.vue.d.ts

@@ -0,0 +1,10 @@
+import { DisplaySuggestion } from "@/types/search-box/Common";
+import { SearchBoxOptionLabels } from "@/types/search-box/SearchBoxOptions";
+import Vue from "vue";
+export default class SearchBoxSuggestion extends Vue {
+    suggestion: DisplaySuggestion;
+    highlight: boolean[];
+    labels: SearchBoxOptionLabels;
+    get title(): string;
+    handleSelect(): void;
+}

package/dist/cjs/components/search-box/suggestions/SearchBoxSuggestions.vue.d.ts

@@ -0,0 +1,22 @@
+import { DisplaySuggestion, InputSuggestionFacet } from "@/types/search-box/Common";
+import { SearchBoxOptionLabels } from "@/types/search-box/SearchBoxOptions";
+import { Suggestion } from "@getlupa/client-sdk/Types";
+import Vue from "vue";
+export default class SearchBoxSuggestions extends Vue {
+    items: DisplaySuggestion[];
+    highlight: boolean[];
+    queryKey: string;
+    labels: SearchBoxOptionLabels;
+    highlightedItem?: {
+        queryKey: string;
+        index: number;
+    };
+    get highlightedIndex(): number;
+    handleSelect({ suggestion, override, facet, }: {
+        suggestion: Suggestion;
+        override: boolean;
+        facet?: InputSuggestionFacet;
+    }): void;
+    handleHighlight(): void;
+    getSuggestionKey(suggestion: DisplaySuggestion): string;
+}

package/dist/cjs/components/search-box/suggestions/SearchBoxSuggestionsWrapper.vue.d.ts

@@ -0,0 +1,28 @@
+import { DisplaySuggestion } from "@/types/search-box/Common";
+import { SdkOptions } from "@/types/General";
+import { SuggestionSearchBoxPanel } from "@/types/search-box/SearchBoxPanel";
+import Vue from "vue";
+import { Options, PublicQuery, SuggestionQueryResult } from "@getlupa/client-sdk/Types";
+import { SearchBoxOptionLabels } from "@/types/search-box/SearchBoxOptions";
+export default class SearchBoxSuggestionsWrapper extends Vue {
+    items: DisplaySuggestion[];
+    panel: SuggestionSearchBoxPanel;
+    options: SdkOptions;
+    inputValue: string;
+    debounce?: number;
+    labels: SearchBoxOptionLabels;
+    suggestionResults: Record<string, DisplaySuggestion[]>;
+    get searchResult(): DisplaySuggestion[];
+    querySuggestions: ({ queryKey, publicQuery, options, }: {
+        queryKey: string;
+        publicQuery: PublicQuery;
+        options?: Options;
+    }) => Promise<{
+        queryKey: string;
+        suggestions?: SuggestionQueryResult;
+    }>;
+    created(): void;
+    onInputChange(): void;
+    getSuggestionsDebounced: () => unknown;
+    getSuggestions(): void;
+}

package/dist/cjs/components/search-box/suggestions/__tests__/Suggestions.spec.d.ts

@@ -0,0 +1 @@
+export {};