@empathyco/x-components 4.1.0-alpha.24 → 4.1.0-alpha.25

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.1.0-alpha.25](https://github.com/empathyco/x/compare/@empathyco/x-components@4.1.0-alpha.24...@empathyco/x-components@4.1.0-alpha.25) (2024-02-23)
+
+
+### Code Refactoring
+
+* **components:** migrate location-provider component to vue 2.7 (#1421) ([98377e8](https://github.com/empathyco/x/commit/98377e8fb4e3a65dce7aa8ddd144cd69f2ab1395))
+
+
+
 ## [4.1.0-alpha.24](https://github.com/empathyco/x/compare/@empathyco/x-components@4.1.0-alpha.23...@empathyco/x-components@4.1.0-alpha.24) (2024-02-21)
 
 

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

@@ -2,20 +2,22 @@
 
 [Home](./index.md) > [@empathyco/x-components](./x-components.md) > [LocationProvider](./x-components.locationprovider.md)
 
-## LocationProvider class
+## LocationProvider variable
 
 Location Provider component. This component injects the location with value passed as prop.
 
 **Signature:**
 
 ```typescript
-export default class LocationProvider extends NoElement 
+_default: import("vue").DefineComponent<{
+    location: {
+        type: PropType<FeatureLocation>;
+        required: true;
+    };
+}, () => import("vue").VNode, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
+    location: {
+        type: PropType<FeatureLocation>;
+        required: true;
+    };
+}>>, {}>
 ```
-**Extends:** NoElement
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [location](./x-components.locationprovider.location.md) | <code>protected</code> | [FeatureLocation](./x-components.featurelocation.md) | The [FeatureLocation](./x-components.featurelocation.md) to provide. |
-

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

@@ -67,7 +67,6 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [IdentifierResults](./x-components.identifierresults.md) | Paints the list of identifier results stored in the state. Each identifier result should be represented by a [IdentifierResult](./x-components.identifierresult.md) component besides any other component. |
 |  [ItemsList](./x-components.itemslist.md) | It renders a list of [ListItem](./x-components.listitem.md) providing a slot for each <code>slotName</code> which depends on the <code>modelName</code>of the item. |
 |  [ItemsListInjectionMixin](./x-components.itemslistinjectionmixin.md) | Mixin to facilitate providing and injecting a list of list items. Injected list is available at <code>injectedListItems</code>, and the provided list should be stored in <code>items</code>. |
-|  [LocationProvider](./x-components.locationprovider.md) | Location Provider component. This component injects the location with value passed as prop. |
 |  [MainScroll](./x-components.mainscroll.md) | <p>Extends the scroll making it able to sync the first visible element, and allowing the children position to be restored.</p><p>Each child element that wants to have this support must be wrapped in a [MainScrollItem](./x-components.mainscrollitem.md) component.</p> |
 |  [MainScrollItem](./x-components.mainscrollitem.md) | Wrapper for elements contained in the [MainScroll](./x-components.mainscroll.md) that should store/restore its position. |
 |  [MultiColumnMaxWidthLayout](./x-components.multicolumnmaxwidthlayout.md) | Component for use as Layout to be filled with the rest of the Components. |
@@ -538,6 +537,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [LightBulbOn](./x-components.lightbulbon.md) |  |
 |  [loadHistoryQueriesFromBrowserStorage](./x-components.loadhistoryqueriesfrombrowserstorage.md) | Default implementation for the [HistoryQueriesActions.loadHistoryQueriesFromBrowserStorage()](./x-components.historyqueriesactions.loadhistoryqueriesfrombrowserstorage.md) action. |
 |  [loadHistoryQueriesFromBrowserStorageWire](./x-components.loadhistoryqueriesfrombrowserstoragewire.md) | Loads the history queries from the browser storage, saving them to the [HistoryQueriesState.historyQueries](./x-components.historyqueriesstate.historyqueries.md)<!-- -->. |
+|  [LocationProvider](./x-components.locationprovider.md) | Location Provider component. This component injects the location with value passed as prop. |
 |  [MainModal](./x-components.mainmodal.md) | A specialised version of a modal component, made to contain a full search application. |
 |  [MenuIcon](./x-components.menuicon.md) |  |
 |  [MinusIcon](./x-components.minusicon.md) |  |

package/docs/API-reference/components/common/x-components.location-provider.md

@@ -14,12 +14,6 @@ Location Provider component. This component injects the location with value pass
 | --------------------- | ------------------------------- | ---------------------------- | ------------- |
 | <code>location</code> | The FeatureLocation to provide. | <code>FeatureLocation</code> | <code></code> |
 
-## Slots
-
-| Name                 | Description | Bindings<br />(name - type - description) |
-| -------------------- | ----------- | ----------------------------------------- |
-| <code>default</code> |             | None                                      |
-
 ## Events
 
 This component doesn't emit events. However, events emitted by child components, will include the

package/js/components/location-provider.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"location-provider.vue.js","sources":["../../../src/components/location-provider.vue"],"sourcesContent":["<script lang=\"ts\">\n  import { Prop, Provide, Component } from 'vue-property-decorator';\n  import { NoElement } from '../components/no-element';\n  import { FeatureLocation } from '../types';\n\n  /**\n   * Location Provider component.\n   * This component injects the location with value passed as prop.\n   *\n   * @public\n   */\n  @Component\n  export default class LocationProvider extends NoElement {\n    /**\n     * The {@link FeatureLocation} to provide.\n     *\n     * @public\n     */\n    @Prop({ required: true })\n    @Provide()\n    protected location!: FeatureLocation;\n  }\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nThis component doesn't emit events. However, events emitted by child components, will include the\n`location` prop value in its metadata.\n\n## See it in action\n\nIn this example, the `LocationProvider` component receives the `location` prop with the\n`predictive_layer` value. This value will then be combined with the `NextQueries` feature name,\n`next_query` to create a `QueryOrigin` string, which is used for tracking the performance of the\ndifferent tools that generate the query.\n\n```vue\n<template>\n  <LocationProvider location=\"predictive_layer\">\n    <NextQueries />\n  </LocationProvider>\n</template>\n<script>\n  import { LocationProvider } from '@empathyco/x-components';\n  import { NextQueries } from '@empathyco/x-components/next-queries';\n  export default {\n    name: 'LocationProviderDemo',\n    components: {\n      LocationProvider,\n      NextQueries\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;AAEA,MAAc,cAAA,GAAA,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"location-provider.vue.js","sources":["../../../src/components/location-provider.vue"],"sourcesContent":["<script lang=\"ts\">\n  import { defineComponent, PropType, provide, toRef } from 'vue';\n  import { FeatureLocation } from '../types';\n  import { useNoElementRender } from '../composables/index';\n\n  /**\n   * Location Provider component.\n   * This component injects the location with value passed as prop.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'LocationProvider',\n    props: {\n      /**\n       * The {@link FeatureLocation} to provide.\n       *\n       * @public\n       */\n      location: {\n        type: String as PropType<FeatureLocation>,\n        required: true\n      }\n    },\n    setup(props, { slots }) {\n      const featureLocation = toRef(props, 'location');\n      provide('location', featureLocation);\n\n      return () => useNoElementRender(slots);\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nThis component doesn't emit events. However, events emitted by child components, will include the\n`location` prop value in its metadata.\n\n## See it in action\n\nIn this example, the `LocationProvider` component receives the `location` prop with the\n`predictive_layer` value. This value will then be combined with the `NextQueries` feature name,\n`next_query` to create a `QueryOrigin` string, which is used for tracking the performance of the\ndifferent tools that generate the query.\n\n```vue\n<template>\n  <LocationProvider location=\"predictive_layer\">\n    <NextQueries />\n  </LocationProvider>\n</template>\n<script>\n  import { LocationProvider } from '@empathyco/x-components';\n  import { NextQueries } from '@empathyco/x-components/next-queries';\n  export default {\n    name: 'LocationProviderDemo',\n    components: {\n      LocationProvider,\n      NextQueries\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;AAEA,MAAc,cAAA,GAAA,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/js/components/location-provider.vue2.js

@@ -1,6 +1,15 @@
-import { __decorate } from 'tslib';
-import { Prop, Provide, Component } from 'vue-property-decorator';
-import { NoElement } from './no-element.js';
+import { defineComponent, toRef, provide } from 'vue';
+import '../composables/create-use-device.composable.js';
+import { useNoElementRender } from '../composables/use-no-element-render.js';
+import '../plugins/x-plugin.js';
+import '@vueuse/core';
+import '@vue/devtools-api';
+import '../plugins/devtools/timeline.devtools.js';
+import '@empathyco/x-utils';
+import 'rxjs/operators';
+import 'rxjs';
+import '../plugins/devtools/colors.utils.js';
+import '../plugins/x-bus.js';
 
 /**
  * Location Provider component.
@@ -8,16 +17,25 @@ import { NoElement } from './no-element.js';
  *
  * @public
  */
-let LocationProvider = class LocationProvider extends NoElement {
-};
-__decorate([
-    Prop({ required: true }),
-    Provide()
-], LocationProvider.prototype, "location", void 0);
-LocationProvider = __decorate([
-    Component
-], LocationProvider);
-var script = LocationProvider;
+var script = defineComponent({
+    name: 'LocationProvider',
+    props: {
+        /**
+         * The {@link FeatureLocation} to provide.
+         *
+         * @public
+         */
+        location: {
+            type: String,
+            required: true
+        }
+    },
+    setup(props, { slots }) {
+        const featureLocation = toRef(props, 'location');
+        provide('location', featureLocation);
+        return () => useNoElementRender(slots);
+    }
+});
 
 export { script as default };
 //# sourceMappingURL=location-provider.vue2.js.map

package/js/components/location-provider.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"location-provider.vue2.js","sources":["../../../src/components/location-provider.vue?rollup-plugin-vue=script.ts"],"sourcesContent":["\n  import { Prop, Provide, Component } from 'vue-property-decorator';\n  import { NoElement } from '../components/no-element';\n  import { FeatureLocation } from '../types';\n\n  /**\n   * Location Provider component.\n   * This component injects the location with value passed as prop.\n   *\n   * @public\n   */\n  @Component\n  export default class LocationProvider extends NoElement {\n    /**\n     * The {@link FeatureLocation} to provide.\n     *\n     * @public\n     */\n    @Prop({ required: true })\n    @Provide()\n    protected location!: FeatureLocation;\n  }\n"],"names":[],"mappings":";;;;AAKE;;;;;AAKG;AAEY,IAAM,gBAAgB,GAAtB,MAAM,gBAAiB,SAAQ,SAAS,CAAA;CAStD,CAAA;AADC,UAAA,CAAA;AAFC,IAAA,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;AACxB,IAAA,OAAO,EAAE;AAC2B,CAAA,EAAA,gBAAA,CAAA,SAAA,EAAA,UAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AARlB,gBAAgB,GAAA,UAAA,CAAA;IADpC,SAAS;AACW,CAAA,EAAA,gBAAgB,CASpC,CAAA;aAToB,gBAAgB;;;;"}
+{"version":3,"file":"location-provider.vue2.js","sources":["../../../src/components/location-provider.vue?rollup-plugin-vue=script.ts"],"sourcesContent":["\n  import { defineComponent, PropType, provide, toRef } from 'vue';\n  import { FeatureLocation } from '../types';\n  import { useNoElementRender } from '../composables/index';\n\n  /**\n   * Location Provider component.\n   * This component injects the location with value passed as prop.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'LocationProvider',\n    props: {\n      /**\n       * The {@link FeatureLocation} to provide.\n       *\n       * @public\n       */\n      location: {\n        type: String as PropType<FeatureLocation>,\n        required: true\n      }\n    },\n    setup(props, { slots }) {\n      const featureLocation = toRef(props, 'location');\n      provide('location', featureLocation);\n\n      return () => useNoElementRender(slots);\n    }\n  });\n"],"names":[],"mappings":";;;;;;;;;;;;;AAKE;;;;;AAKG;AACH,aAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,kBAAkB;AACxB,IAAA,KAAK,EAAE;AACL;;;;AAIG;AACH,QAAA,QAAQ,EAAE;AACR,YAAA,IAAI,EAAE,MAAmC;AACzC,YAAA,QAAQ,EAAE,IAAI;AACf,SAAA;AACF,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAA;QACpB,MAAM,eAAe,GAAG,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AACjD,QAAA,OAAO,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AAErC,QAAA,OAAO,MAAM,kBAAkB,CAAC,KAAK,CAAC,CAAC;KACxC;AACF,CAAA,CAAC;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-components",
-  "version": "4.1.0-alpha.24",
+  "version": "4.1.0-alpha.25",
   "description": "Empathy X Components",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -143,5 +143,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "fe464ee1365a9778151e551a5984353a1fcb23ec"
+  "gitHead": "2aab60ec704c772f6c3e7b63ef9d12532ad85b5b"
 }

package/report/x-components.api.json

@@ -30569,67 +30569,117 @@
           }
         },
         {
-          "kind": "Class",
-          "canonicalReference": "@empathyco/x-components!LocationProvider:class",
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!LocationProvider:var",
           "docComment": "/**\n * Location Provider component. This component injects the location with value passed as prop.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export default class LocationProvider extends "
+              "text": "_default: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"vue\")."
             },
             {
               "kind": "Reference",
-              "text": "NoElement",
-              "canonicalReference": "@empathyco/x-components!NoElement"
+              "text": "DefineComponent",
+              "canonicalReference": "vue!DefineComponent:type"
             },
             {
               "kind": "Content",
-              "text": " "
+              "text": "<{\n    location: {\n        type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropType",
+              "canonicalReference": "vue!PropType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "FeatureLocation",
+              "canonicalReference": "@empathyco/x-components!FeatureLocation:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">;\n        required: true;\n    };\n}, () => import(\"vue\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VNode",
+              "canonicalReference": "vue!VNode:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", {}, {}, {}, import(\"vue/types/v3-component-options\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ComponentOptionsMixin",
+              "canonicalReference": "vue!ComponentOptionsMixin:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", import(\"vue/types/v3-component-options\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ComponentOptionsMixin",
+              "canonicalReference": "vue!ComponentOptionsMixin:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", {}, string, "
+            },
+            {
+              "kind": "Reference",
+              "text": "Readonly",
+              "canonicalReference": "!Readonly:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<import(\"vue\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ExtractPropTypes",
+              "canonicalReference": "vue!ExtractPropTypes:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<{\n    location: {\n        type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropType",
+              "canonicalReference": "vue!PropType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "FeatureLocation",
+              "canonicalReference": "@empathyco/x-components!FeatureLocation:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">;\n        required: true;\n    };\n}>>, {}>"
             }
           ],
           "fileUrlPath": "dist/types/components/location-provider.vue.d.ts",
+          "isReadonly": true,
           "releaseTag": "Public",
-          "isAbstract": false,
           "name": "LocationProvider",
-          "preserveMemberOrder": false,
-          "members": [
-            {
-              "kind": "Property",
-              "canonicalReference": "@empathyco/x-components!LocationProvider#location:member",
-              "docComment": "/**\n * The {@link FeatureLocation} to provide.\n *\n * @public\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "protected location: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "FeatureLocation",
-                  "canonicalReference": "@empathyco/x-components!FeatureLocation:type"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "location",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isStatic": false,
-              "isProtected": true,
-              "isAbstract": false
-            }
-          ],
-          "extendsTokenRange": {
+          "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 2
-          },
-          "implementsTokenRanges": []
+            "endIndex": 22
+          }
         },
         {
           "kind": "Variable",

package/report/x-components.api.md

@@ -2986,12 +2986,18 @@ export const loadHistoryQueriesFromBrowserStorageWire: AnyWire;
 // @internal
 export const localStorageService: StorageService;
 
-// Warning: (ae-incompatible-release-tags) The symbol "LocationProvider" is marked as @public, but its signature references "NoElement" which is marked as @internal
-//
 // @public
-export class LocationProvider extends NoElement {
-    protected location: FeatureLocation;
-}
+export const LocationProvider: DefineComponent<    {
+location: {
+type: PropType<FeatureLocation>;
+required: true;
+};
+}, () => VNode, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {
+location: {
+type: PropType<FeatureLocation>;
+required: true;
+};
+}>>, {}>;
 
 // @internal
 export type Machine<SomeStatus extends string, SomeEvent extends string> = {

package/types/components/location-provider.vue.d.ts

@@ -1,4 +1,4 @@
-import { NoElement } from '../components/no-element';
+import { PropType } from 'vue';
 import { FeatureLocation } from '../types';
 /**
  * Location Provider component.
@@ -6,12 +6,26 @@ import { FeatureLocation } from '../types';
  *
  * @public
  */
-export default class LocationProvider extends NoElement {
+declare const _default: import("vue").DefineComponent<{
     /**
      * The {@link FeatureLocation} to provide.
      *
      * @public
      */
-    protected location: FeatureLocation;
-}
+    location: {
+        type: PropType<FeatureLocation>;
+        required: true;
+    };
+}, () => import("vue").VNode, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The {@link FeatureLocation} to provide.
+     *
+     * @public
+     */
+    location: {
+        type: PropType<FeatureLocation>;
+        required: true;
+    };
+}>>, {}>;
+export default _default;
 //# sourceMappingURL=location-provider.vue?rollup-plugin-vue=script.d.ts.map

package/types/components/location-provider.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"location-provider.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../src/components/location-provider.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAEE,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C;;;;;GAKG;AAEH,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,SAAS;IACrD;;;;OAIG;IAGH,SAAS,CAAC,QAAQ,EAAG,eAAe,CAAC;CACtC"}
+{"version":3,"file":"location-provider.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../src/components/location-provider.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AACE,OAAO,EAAmB,QAAQ,EAAkB,MAAM,KAAK,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAG3C;;;;;GAKG;;IAIC;;;;OAIG;;;;;;IAJH;;;;OAIG;;;;;;AAPP,wBAmBG"}

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

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [LocationProvider](./x-components.locationprovider.md) &gt; [location](./x-components.locationprovider.location.md)
-
-## LocationProvider.location property
-
-The [FeatureLocation](./x-components.featurelocation.md) to provide.
-
-**Signature:**
-
-```typescript
-protected location: FeatureLocation;
-```