@empathyco/x-components 3.0.0-alpha.355 → 3.0.0-alpha.356

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 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.356](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.355...@empathyco/x-components@3.0.0-alpha.356) (2023-04-20)
+
+### Features
+
+- export sticky modifier (#1151)
+  ([8bbd1ab](https://github.com/empathyco/x/commit/8bbd1ab6b0b595c94386bdc0f37d7061df072127))
+
+# Change Log
+
+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.355](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.354...@empathyco/x-components@3.0.0-alpha.355) (2023-04-19)
 
 ### ⚠ BREAKING CHANGES

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/full-theme.css

@@ -442,15 +442,15 @@
 .x-dropdown.x-dropdown--s {
   --x-size-width-dropdown-toggle-default: var(--x-size-width-dropdown-s);
 }
-:root {
-  --x-size-width-dropdown-s: 74px;
-}
 .x-dropdown.x-dropdown--xl {
   --x-size-width-dropdown-toggle-default: var(--x-size-width-dropdown-xl);
 }
 :root {
   --x-size-width-dropdown-xl: 282px;
 }
+:root {
+  --x-size-width-dropdown-s: 74px;
+}
 .x-facet--card.x-facet,
 .x-facet--card .x-facet {
   --x-size-border-radius-facet-default: var(--x-size-border-radius-facet-card);

package/facets/index.js

@@ -13,6 +13,7 @@ export { NumberRangeFilterEntity } from '../js/x-modules/facets/entities/number-
 export { RawFilterEntity } from '../js/x-modules/facets/entities/raw-filter.entity.js';
 export { SimpleFilterEntity } from '../js/x-modules/facets/entities/simple-filter.entity.js';
 export { SingleSelectModifier } from '../js/x-modules/facets/entities/single-select.modifier.js';
+export { StickyModifier } from '../js/x-modules/facets/entities/sticky.modifier.js';
 export { BaseFilterEntityModifier } from '../js/x-modules/facets/entities/types.js';
 export { default as Facets } from '../js/x-modules/facets/components/facets/facets.vue.js';
 export { default as FacetsProvider } from '../js/x-modules/facets/components/facets/facets-provider.vue.js';

package/js/index.js

@@ -218,6 +218,7 @@ export { NumberRangeFilterEntity } from './x-modules/facets/entities/number-rang
 export { RawFilterEntity } from './x-modules/facets/entities/raw-filter.entity.js';
 export { SimpleFilterEntity } from './x-modules/facets/entities/simple-filter.entity.js';
 export { SingleSelectModifier } from './x-modules/facets/entities/single-select.modifier.js';
+export { StickyModifier } from './x-modules/facets/entities/sticky.modifier.js';
 export { BaseFilterEntityModifier } from './x-modules/facets/entities/types.js';
 export { default as Facets } from './x-modules/facets/components/facets/facets.vue.js';
 export { default as FacetsProvider } from './x-modules/facets/components/facets/facets-provider.vue.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/facets/entities/sticky.modifier.js

@@ -0,0 +1,35 @@
+import { BaseFilterEntityModifier } from './types.js';
+
+/**
+ * Allows to persist a filter between different queries.
+ *
+ * @remarks when using this modifier along with others, make sure this is the first one defined.
+ *
+ * @internal
+ */
+class StickyModifier extends BaseFilterEntityModifier {
+    /**
+     * Deselects the passed filter unless the metadata has the `keepSticky` flag enabled.
+     *
+     * @param filter - The filter to deselect.
+     * @param metadata - Additional information to prevent a filter from being deselected.
+     */
+    deselect(filter, metadata) {
+        if (!metadata?.keepSticky) {
+            super.deselect(filter, metadata);
+            this.store.commit('x/facets/removeStickyFilter', filter);
+        }
+    }
+    /**
+     * Selects the passed filter and stores it as sticky.
+     *
+     * @param filter - The filter to select.
+     */
+    select(filter) {
+        super.select(filter);
+        this.store.commit('x/facets/setStickyFilter', filter);
+    }
+}
+
+export { StickyModifier };
+//# sourceMappingURL=sticky.modifier.js.map

package/js/x-modules/facets/entities/sticky.modifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sticky.modifier.js","sources":["../../../../../src/x-modules/facets/entities/sticky.modifier.ts"],"sourcesContent":["import { Filter } from '@empathyco/x-types';\nimport { BaseFilterEntityModifier } from './types';\n\n/**\n * A dictionary with information about whether to keep or remove sticky filters.\n */\ninterface Metadata {\n  keepSticky: boolean;\n}\n\n/**\n * Allows to persist a filter between different queries.\n *\n * @remarks when using this modifier along with others, make sure this is the first one defined.\n *\n * @internal\n */\nexport class StickyModifier extends BaseFilterEntityModifier<Metadata> {\n  /**\n   * Deselects the passed filter unless the metadata has the `keepSticky` flag enabled.\n   *\n   * @param filter - The filter to deselect.\n   * @param metadata - Additional information to prevent a filter from being deselected.\n   */\n  deselect(filter: Filter, metadata?: Metadata): void {\n    if (!metadata?.keepSticky) {\n      super.deselect(filter, metadata);\n      this.store.commit('x/facets/removeStickyFilter', filter);\n    }\n  }\n\n  /**\n   * Selects the passed filter and stores it as sticky.\n   *\n   * @param filter - The filter to select.\n   */\n  select(filter: Filter): void {\n    super.select(filter);\n    this.store.commit('x/facets/setStickyFilter', filter);\n  }\n}\n"],"names":[],"mappings":";;AAUA;;;;;;AAMG;AACG,MAAO,cAAe,SAAQ,wBAAkC,CAAA;AACpE;;;;;AAKG;IACH,QAAQ,CAAC,MAAc,EAAE,QAAmB,EAAA;AAC1C,QAAA,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE;AACzB,YAAA,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YACjC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;AAC1D,SAAA;KACF;AAED;;;;AAIG;AACH,IAAA,MAAM,CAAC,MAAc,EAAA;AACnB,QAAA,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;KACvD;AACF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-components",
-  "version": "3.0.0-alpha.355",
+  "version": "3.0.0-alpha.356",
   "description": "Empathy X Components",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -143,5 +143,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "f6070d1560eab789551f39594b1c28c20656057d"
+  "gitHead": "fb160f8c2ad830991779a6731b4b6c632238293e"
 }

package/report/x-components.api.md

@@ -4986,6 +4986,14 @@ export interface StatusState {
     status: RequestStatus;
 }
 
+// Warning: (ae-forgotten-export) The symbol "Metadata" needs to be exported by the entry point index.d.ts
+//
+// @internal
+export class StickyModifier extends BaseFilterEntityModifier<Metadata> {
+    deselect(filter: Filter, metadata?: Metadata): void;
+    select(filter: Filter): void;
+}
+
 // @public
 export const storageKey: HistoryQueriesXStoreModule['getters']['storageKey'];
 

package/types/x-modules/facets/entities/index.d.ts

@@ -5,5 +5,6 @@ export * from './number-range-filter.entity';
 export * from './raw-filter.entity';
 export * from './simple-filter.entity';
 export * from './single-select.modifier';
+export * from './sticky.modifier';
 export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/types/x-modules/facets/entities/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/facets/entities/index.ts"],"names":[],"mappings":"AAAA,cAAc,uCAAuC,CAAC;AACtD,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/facets/entities/index.ts"],"names":[],"mappings":"AAAA,cAAc,uCAAuC,CAAC;AACtD,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,SAAS,CAAC"}