@empathyco/x-components 6.0.0-alpha.25 → 6.0.0-alpha.26

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

@@ -88,7 +88,6 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [useOnDisplay({ element, callback, triggerOnce })](./x-components.useondisplay.md) | Composable that triggers a callback whenever the provided element appears in the viewport. It can trigger the first time only or every time the element appears in the viewport. |
 |  [useScroll(props, { emit }, scrollEl)](./x-components.usescroll.md) | Composable to share Scroll logic. |
 |  [useState(module, paths)](./x-components.usestate.md) | Function which returns the requested state's properties as a dictionary. |
-|  [useStore()](./x-components.usestore.md) | Function which returns the <code>$store</code> object from the current component instance. |
 |  [useXBus()](./x-components.usexbus.md) | Composable which injects the current location, returns the <code>on</code> and <code>emit</code> functions using the bus and applying component metadata. Also unsubscribe from events when components is unmounted. |
 |  [wireCommit(mutation, payloadFactory)](./x-components.wirecommit.md) | Creates a wire that commits a mutation to the store. This wire receives a function. This function is used to get the actual payload value passed to mutation. This wire can be used in every event, as it does not have a payload type associated. |
 |  [wireCommit(mutation, staticPayload)](./x-components.wirecommit_1.md) | Creates a wire that commits a mutation to the store. This wire can receive any value as payload. This wire can be used in every event, as it does not have a payload type associated. |

package/js/composables/use-alias-api.js

@@ -7,7 +7,7 @@ import '../plugins/devtools/colors.utils.js';
 import '../plugins/x-bus.js';
 import '../plugins/x-plugin.js';
 import { getGetterPath } from '../plugins/x-plugin.utils.js';
-import { useStore } from './use-store.js';
+import { useStore } from 'vuex';
 
 /**
  * Creates an object containing the alias part of {@link XComponentAPI}.

package/js/composables/use-getter.js

@@ -8,7 +8,7 @@ import '../plugins/devtools/colors.utils.js';
 import '../plugins/x-bus.js';
 import '../plugins/x-plugin.js';
 import { getGetterPath } from '../plugins/x-plugin.utils.js';
-import { useStore } from './use-store.js';
+import { useStore } from 'vuex';
 
 /**
  * Function which returns the requested getters as a dictionary of getters.

package/js/composables/use-state.js

@@ -1,5 +1,5 @@
 import { computed } from 'vue';
-import { useStore } from './use-store.js';
+import { useStore } from 'vuex';
 
 /**
  * Function which returns the requested state's properties as a dictionary.

package/js/index.js

@@ -148,7 +148,7 @@ export { useDebounce } from './composables/use-debounce.js';
 export { useGetter } from './composables/use-getter.js';
 export { useEmitDisplayEvent, useOnDisplay } from './composables/use-on-display.js';
 export { useState } from './composables/use-state.js';
-export { useStore } from './composables/use-store.js';
+export { useStore } from 'vuex';
 export { useXBus } from './composables/use-x-bus.js';
 export { infiniteScroll } from './directives/infinite-scroll.js';
 export { setupDevtools } from './plugins/devtools/devtools.plugin.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-components",
-  "version": "6.0.0-alpha.25",
+  "version": "6.0.0-alpha.26",
   "description": "Empathy X Components",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -138,5 +138,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "68a9cd09f37965b33ca0c35380e7a3335f845a5f"
+  "gitHead": "a4087d2e2ebed52afcd1f3d96b00a0f7c36f054e"
 }

package/report/x-components.api.json

@@ -79336,39 +79336,6 @@
           ],
           "name": "useState"
         },
-        {
-          "kind": "Function",
-          "canonicalReference": "@empathyco/x-components!useStore:function(1)",
-          "docComment": "/**\n * Function which returns the `$store` object from the current component instance.\n *\n * @returns The `$store` object from the current component instance.\n *\n * @public\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function useStore(): "
-            },
-            {
-              "kind": "Reference",
-              "text": "Store",
-              "canonicalReference": "vuex!Store:class"
-            },
-            {
-              "kind": "Content",
-              "text": "<any>"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "fileUrlPath": "src/composables/use-store.ts",
-          "returnTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 3
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [],
-          "name": "useStore"
-        },
         {
           "kind": "Function",
           "canonicalReference": "@empathyco/x-components!useXBus:function(1)",

package/report/x-components.api.md

@@ -115,6 +115,7 @@ import { default as TrendingIcon } from './trending.vue';
 import { default as TrendingTinyIcon } from './trending-tiny.vue';
 import { default as UserFilledIcon } from './user-filled.vue';
 import { default as UserIcon } from './user.vue';
+import { useStore } from 'vuex';
 import { VNode } from 'vue';
 import Vue from 'vue';
 import { WatchOptions } from 'vue';
@@ -8456,8 +8457,7 @@ export function useScroll(props: {
 // @public
 export function useState<Module extends XModuleName, Path extends keyof ExtractState<Module> & string>(module: Module, paths: Path[]): Dictionary<ComputedRef>;
 
-// @public
-export function useStore(): Store<any>;
+export { useStore }
 
 // @public
 export function useXBus(): {

package/types/composables/use-store.d.ts

@@ -1,10 +1,10 @@
-import { Store } from 'vuex';
 /**
  * Function which returns the `$store` object from the current component instance.
  *
  * @returns The `$store` object from the current component instance.
+ * @deprecated Use `useStore` from `vuex` instead.
  *
  * @public
  */
-export declare function useStore(): Store<any>;
+export { useStore } from 'vuex';
 //# sourceMappingURL=use-store.d.ts.map

package/types/composables/use-store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-store.d.ts","sourceRoot":"","sources":["../../../src/composables/use-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,KAAK,EAAE,MAAM,MAAM,CAAC;AACvD;;;;;;GAMG;AACH,wBAAgB,QAAQ,IAAI,KAAK,CAAC,GAAG,CAAC,CAErC"}
+{"version":3,"file":"use-store.d.ts","sourceRoot":"","sources":["../../../src/composables/use-store.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC"}

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

@@ -1,19 +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; [useStore](./x-components.usestore.md)
-
-## useStore() function
-
-Function which returns the `$store` object from the current component instance.
-
-**Signature:**
-
-```typescript
-export declare function useStore(): Store<any>;
-```
-**Returns:**
-
-Store&lt;any&gt;
-
-The `$store` object from the current component instance.
-

package/js/composables/use-store.js

@@ -1,15 +0,0 @@
-import { useStore as useStore$1 } from 'vuex';
-
-/**
- * Function which returns the `$store` object from the current component instance.
- *
- * @returns The `$store` object from the current component instance.
- *
- * @public
- */
-function useStore() {
-    return useStore$1();
-}
-
-export { useStore };
-//# sourceMappingURL=use-store.js.map

package/js/composables/use-store.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"use-store.js","sources":["../../../src/composables/use-store.ts"],"sourcesContent":["import { useStore as useStoreVuex, Store } from 'vuex';\n/**\n * Function which returns the `$store` object from the current component instance.\n *\n * @returns The `$store` object from the current component instance.\n *\n * @public\n */\nexport function useStore(): Store<any> {\n  return useStoreVuex();\n}\n"],"names":["useStoreVuex"],"mappings":";;AACA;;;;;;AAMG;SACa,QAAQ,GAAA;IACtB,OAAOA,UAAY,EAAE,CAAC;AACxB;;;;"}