@empathyco/x-components 3.0.0-alpha.387 → 3.0.0-alpha.388

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.0.0-alpha.388](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.387...@empathyco/x-components@3.0.0-alpha.388) (2023-06-14)
+
+**Note:** Version bump only for package @empathyco/x-components
+
+
+
+
+
 ## [3.0.0-alpha.387](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.386...@empathyco/x-components@3.0.0-alpha.387) (2023-06-14)
 
 

package/core/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/design-system/deprecated-full-theme.css

@@ -3444,46 +3444,6 @@
   --x-size-line-height-small: var(--x-size-line-height-base-s);
   --x-string-text-decoration-small: none;
 }
-:root {
-  --x-font-family-base: "Montserrat", sans-serif;
-  --x-size-font-base-xs: 12px;
-  --x-size-font-base-s: 14px;
-  --x-size-font-base-m: 16px;
-  --x-size-font-base-l: 18px;
-  --x-size-font-base-xl: 32px;
-  --x-number-font-weight-base-light: 300;
-  --x-number-font-weight-base-regular: 400;
-  --x-number-font-weight-base-bold: 600;
-  --x-size-line-height-base-s: 16px;
-  --x-size-line-height-base-m: 24px;
-  --x-size-line-height-base-l: 32px;
-  --x-color-text-default: var(--x-color-base-neutral-10);
-  --x-font-family-text: var(--x-font-family-base);
-  --x-size-font-text: var(--x-size-font-base-s);
-  --x-number-font-weight-text: var(--x-number-font-weight-base-regular);
-  --x-size-line-height-text: var(--x-size-line-height-base-s);
-  --x-string-text-decoration-text: none;
-  --x-font-family-title1: var(--x-font-family-base);
-  --x-size-font-title1: var(--x-size-font-base-xl);
-  --x-number-font-weight-title1: var(--x-number-font-weight-base-regular);
-  --x-size-line-height-title1: var(--x-size-line-height-base-l);
-  --x-string-text-decoration-title1: none;
-  --x-font-family-title2: var(--x-font-family-base);
-  --x-size-font-title2: var(--x-size-font-base-l);
-  --x-number-font-weight-title2: var(--x-number-font-weight-base-regular);
-  --x-size-line-height-title2: var(--x-size-line-height-base-m);
-  --x-string-text-decoration-title2: none;
-  --x-font-family-title3: var(--x-font-family-base);
-  --x-size-font-title3: var(--x-size-font-base-m);
-  --x-number-font-weight-title3: var(--x-number-font-weight-base-regular);
-  --x-size-line-height-title3: var(--x-size-line-height-base-m);
-  --x-string-text-decoration-title3: none;
-  --x-font-family-small: var(--x-font-family-base);
-  --x-size-font-small: var(--x-size-font-base-xs);
-  --x-number-font-weight-small: var(--x-number-font-weight-base-regular);
-  --x-size-line-height-small: var(--x-size-line-height-base-s);
-  --x-string-text-decoration-small: none;
-}
 
 .x,
 .x-text {
@@ -3561,6 +3521,46 @@
 .x-text--bold.x-small {
   --x-number-font-weight-small: var(--x-number-font-weight-base-bold);
 }
+:root {
+  --x-font-family-base: "Montserrat", sans-serif;
+  --x-size-font-base-xs: 12px;
+  --x-size-font-base-s: 14px;
+  --x-size-font-base-m: 16px;
+  --x-size-font-base-l: 18px;
+  --x-size-font-base-xl: 32px;
+  --x-number-font-weight-base-light: 300;
+  --x-number-font-weight-base-regular: 400;
+  --x-number-font-weight-base-bold: 600;
+  --x-size-line-height-base-s: 16px;
+  --x-size-line-height-base-m: 24px;
+  --x-size-line-height-base-l: 32px;
+  --x-color-text-default: var(--x-color-base-neutral-10);
+  --x-font-family-text: var(--x-font-family-base);
+  --x-size-font-text: var(--x-size-font-base-s);
+  --x-number-font-weight-text: var(--x-number-font-weight-base-regular);
+  --x-size-line-height-text: var(--x-size-line-height-base-s);
+  --x-string-text-decoration-text: none;
+  --x-font-family-title1: var(--x-font-family-base);
+  --x-size-font-title1: var(--x-size-font-base-xl);
+  --x-number-font-weight-title1: var(--x-number-font-weight-base-regular);
+  --x-size-line-height-title1: var(--x-size-line-height-base-l);
+  --x-string-text-decoration-title1: none;
+  --x-font-family-title2: var(--x-font-family-base);
+  --x-size-font-title2: var(--x-size-font-base-l);
+  --x-number-font-weight-title2: var(--x-number-font-weight-base-regular);
+  --x-size-line-height-title2: var(--x-size-line-height-base-m);
+  --x-string-text-decoration-title2: none;
+  --x-font-family-title3: var(--x-font-family-base);
+  --x-size-font-title3: var(--x-size-font-base-m);
+  --x-number-font-weight-title3: var(--x-number-font-weight-base-regular);
+  --x-size-line-height-title3: var(--x-size-line-height-base-m);
+  --x-string-text-decoration-title3: none;
+  --x-font-family-small: var(--x-font-family-base);
+  --x-size-font-small: var(--x-size-font-base-xs);
+  --x-number-font-weight-small: var(--x-number-font-weight-base-regular);
+  --x-size-line-height-small: var(--x-size-line-height-base-s);
+  --x-string-text-decoration-small: none;
+}
 :root {
   --x-color-text-accent: var(--x-color-base-accent);
 }

package/docs/API-reference/api/x-components.md

@@ -650,6 +650,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [TrendingTinyIcon](./x-components.trendingtinyicon.md) |  |
 |  [updateHistoryQueriesWithSearchResponse](./x-components.updatehistoryquerieswithsearchresponse.md) | Updates the history queries with the relevant info included in a search response. |
 |  [urlXModule](./x-components.urlxmodule.md) | URL [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the <code>url</code> entry point. |
+|  [useQueriesPreview](./x-components.usequeriespreview.md) | Composable helpers for the QueriesPreview module. |
 |  [UserFilledIcon](./x-components.userfilledicon.md) |  |
 |  [UserIcon](./x-components.usericon.md) |  |
 |  [xPlugin](./x-components.xplugin.md) | Vue plugin that modifies each component instance, extending them with the [X Component API](./x-components.xcomponentapi.md)<!-- -->. |

package/docs/API-reference/api/x-components.usequeriespreview.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [useQueriesPreview](./x-components.usequeriespreview.md)
+
+## useQueriesPreview variable
+
+Composable helpers for the QueriesPreview module.
+
+**Signature:**
+
+```typescript
+useQueriesPreview: () => UseQueriesPreview
+```

package/js/index.js

@@ -297,6 +297,7 @@ export { popularSearchesWiring, setPopularSearchesExtraParams, setSearchedQuerie
 export { popularSearchesXModule } from './x-modules/popular-searches/x-module.js';
 export { default as QueryPreview } from './x-modules/queries-preview/components/query-preview.vue.js';
 export { default as QueryPreviewList } from './x-modules/queries-preview/components/query-preview-list.vue.js';
+export { useQueriesPreview } from './x-modules/queries-preview/composables/use-queries-preview.composable.js';
 export { fetchQueryPreview } from './x-modules/queries-preview/store/actions/fetch-query-preview.action.js';
 export { fetchAndSaveQueryPreview } from './x-modules/queries-preview/store/actions/fetch-and-save-query-preview.action.js';
 export { queriesPreviewEmitters } from './x-modules/queries-preview/store/emitters.js';

package/js/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/js/x-modules/queries-preview/composables/use-queries-preview.composable.js

@@ -0,0 +1,42 @@
+import { computed } from 'vue';
+import { XPlugin } from '../../../plugins/x-plugin.js';
+
+/**
+ * Composable helpers for the QueriesPreview module.
+ *
+ * @returns Composable with helpers.
+ *
+ * @public
+ */
+const useQueriesPreview = () => {
+    const store = XPlugin.store;
+    const loadedQueriesPreview = computed(() => store.getters['x/queriesPreview/loadedQueriesPreview']);
+    const loadedQueries = computed(() => {
+        return Object.keys(loadedQueriesPreview.value);
+    });
+    /**
+     * Checks if the query passed has results in the queries preview.
+     *
+     * @param query - The query to check.
+     * @returns True if the query has results.
+     */
+    const isQueryLoadedInPreview = (query) => {
+        return loadedQueries.value.includes(query);
+    };
+    /**
+     * Checks if any of the queries passed have results in the queries previews.
+     *
+     * @param queries - The queries to check.
+     * @returns True if some query has results.
+     */
+    const isAnyQueryLoadedInPreview = (queries) => {
+        return queries.some(isQueryLoadedInPreview);
+    };
+    return {
+        isAnyQueryLoadedInPreview,
+        isQueryLoadedInPreview
+    };
+};
+
+export { useQueriesPreview };
+//# sourceMappingURL=use-queries-preview.composable.js.map

package/js/x-modules/queries-preview/composables/use-queries-preview.composable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-queries-preview.composable.js","sources":["../../../../../src/x-modules/queries-preview/composables/use-queries-preview.composable.ts"],"sourcesContent":["import { computed } from 'vue';\nimport { QueriesPreviewGetters } from '../store';\nimport { XPlugin } from '../../../plugins/x-plugin';\n\n/**\n * Composable helpers for the QueriesPreview module.\n */\ninterface UseQueriesPreview {\n  /**\n   * Checks if any of the queries passed have results in the queries previews.\n   *\n   * @param queries - The queries to check.\n   * @returns True if some query has results.\n   */\n  isAnyQueryLoadedInPreview: (queries: string[]) => boolean;\n  /**\n   * Checks if the query passed has results in the queries preview.\n   *\n   * @param query - The query to check.\n   * @returns True if the query has results.\n   */\n  isQueryLoadedInPreview: (query: string) => boolean;\n}\n\n/**\n * Composable helpers for the QueriesPreview module.\n *\n * @returns Composable with helpers.\n *\n * @public\n */\nexport const useQueriesPreview = (): UseQueriesPreview => {\n  const store = XPlugin.store;\n  const loadedQueriesPreview = computed<QueriesPreviewGetters['loadedQueriesPreview']>(\n    () => store.getters['x/queriesPreview/loadedQueriesPreview']\n  );\n  const loadedQueries = computed(() => {\n    return Object.keys(loadedQueriesPreview.value);\n  });\n\n  /**\n   * Checks if the query passed has results in the queries preview.\n   *\n   * @param query - The query to check.\n   * @returns True if the query has results.\n   */\n  const isQueryLoadedInPreview: UseQueriesPreview['isQueryLoadedInPreview'] = (\n    query: string\n  ): boolean => {\n    return loadedQueries.value.includes(query);\n  };\n\n  /**\n   * Checks if any of the queries passed have results in the queries previews.\n   *\n   * @param queries - The queries to check.\n   * @returns True if some query has results.\n   */\n  const isAnyQueryLoadedInPreview: UseQueriesPreview['isAnyQueryLoadedInPreview'] = (\n    queries: string[]\n  ): boolean => {\n    return queries.some(isQueryLoadedInPreview);\n  };\n\n  return {\n    isAnyQueryLoadedInPreview,\n    isQueryLoadedInPreview\n  };\n};\n"],"names":[],"mappings":";;;AAwBA;;;;;;AAMG;AACI,MAAM,iBAAiB,GAAG,MAAwB;AACvD,IAAA,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;AAC5B,IAAA,MAAM,oBAAoB,GAAG,QAAQ,CACnC,MAAM,KAAK,CAAC,OAAO,CAAC,uCAAuC,CAAC,CAC7D,CAAC;AACF,IAAA,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAK;QAClC,OAAO,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;AACjD,KAAC,CAAC,CAAC;AAEH;;;;;AAKG;AACH,IAAA,MAAM,sBAAsB,GAAgD,CAC1E,KAAa,KACF;QACX,OAAO,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC7C,KAAC,CAAC;AAEF;;;;;AAKG;AACH,IAAA,MAAM,yBAAyB,GAAmD,CAChF,OAAiB,KACN;AACX,QAAA,OAAO,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;AAC9C,KAAC,CAAC;IAEF,OAAO;QACL,yBAAyB;QACzB,sBAAsB;KACvB,CAAC;AACJ;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-components",
-  "version": "3.0.0-alpha.387",
+  "version": "3.0.0-alpha.388",
   "description": "Empathy X Components",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -143,5 +143,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "4496791f07bdaeaf56f14334719623ba374baddb"
+  "gitHead": "677d0fc9da4da921c540218b475bd6a54e64b1a3"
 }

package/queries-preview/index.js

@@ -1,5 +1,6 @@
 export { default as QueryPreview } from '../js/x-modules/queries-preview/components/query-preview.vue.js';
 export { default as QueryPreviewList } from '../js/x-modules/queries-preview/components/query-preview-list.vue.js';
+export { useQueriesPreview } from '../js/x-modules/queries-preview/composables/use-queries-preview.composable.js';
 export { fetchQueryPreview } from '../js/x-modules/queries-preview/store/actions/fetch-query-preview.action.js';
 export { fetchAndSaveQueryPreview } from '../js/x-modules/queries-preview/store/actions/fetch-and-save-query-preview.action.js';
 export { queriesPreviewEmitters } from '../js/x-modules/queries-preview/store/emitters.js';

package/report/x-components.api.json

@@ -60789,6 +60789,34 @@
             "endIndex": 14
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!useQueriesPreview:var",
+          "docComment": "/**\n * Composable helpers for the QueriesPreview module.\n *\n * @returns Composable with helpers.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "useQueriesPreview: "
+            },
+            {
+              "kind": "Content",
+              "text": "() => "
+            },
+            {
+              "kind": "Reference",
+              "text": "UseQueriesPreview",
+              "canonicalReference": "@empathyco/x-components!~UseQueriesPreview:interface"
+            }
+          ],
+          "fileUrlPath": "src/x-modules/queries-preview/composables/use-queries-preview.composable.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "useQueriesPreview",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@empathyco/x-components!UserFilledIcon:var",

package/report/x-components.api.md

@@ -5792,6 +5792,11 @@ export type UseDeviceReturn<Device extends string = string> = {
     deviceName: Ref<string>;
 } & UseDeviceFlags<Device>;
 
+// Warning: (ae-forgotten-export) The symbol "UseQueriesPreview" needs to be exported by the entry point index.d.ts
+//
+// @public
+export const useQueriesPreview: () => UseQueriesPreview;
+
 // @public (undocumented)
 export const UserFilledIcon: {};
 

package/types/x-modules/queries-preview/composables/index.d.ts

@@ -0,0 +1,2 @@
+export * from './use-queries-preview.composable';
+//# sourceMappingURL=index.d.ts.map

package/types/x-modules/queries-preview/composables/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/queries-preview/composables/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAC"}

package/types/x-modules/queries-preview/composables/use-queries-preview.composable.d.ts

@@ -21,6 +21,8 @@ interface UseQueriesPreview {
  * Composable helpers for the QueriesPreview module.
  *
  * @returns Composable with helpers.
+ *
+ * @public
  */
 export declare const useQueriesPreview: () => UseQueriesPreview;
 export {};

package/types/x-modules/queries-preview/composables/use-queries-preview.composable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-queries-preview.composable.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/queries-preview/composables/use-queries-preview.composable.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,UAAU,iBAAiB;IACzB;;;;;OAKG;IACH,yBAAyB,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC;IAC1D;;;;;OAKG;IACH,sBAAsB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC;CACpD;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,QAAO,iBAqCpC,CAAC"}
+{"version":3,"file":"use-queries-preview.composable.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/queries-preview/composables/use-queries-preview.composable.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,UAAU,iBAAiB;IACzB;;;;;OAKG;IACH,yBAAyB,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC;IAC1D;;;;;OAKG;IACH,sBAAsB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC;CACpD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,QAAO,iBAqCpC,CAAC"}

package/types/x-modules/queries-preview/index.d.ts

@@ -1,4 +1,5 @@
 export * from './components';
+export * from './composables';
 export * from './config.types';
 export * from './events.types';
 export * from './store';

package/types/x-modules/queries-preview/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/x-modules/queries-preview/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/x-modules/queries-preview/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC"}