@wix/bex-core 1.444.0 → 1.445.0

package/dist/cjs/model/filter.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["../../../src/model/filter.ts"],"sourcesContent":["import { TypedEmitter } from '../util';\n\n/*\nchange - whenever we want to notify that the value was changed, for additional side effects, i.e BI events. For example, when initializing the value, we don't want to emit this event.\nrefresh - the collection should be refreshed as a result of this change\nscheduleRefresh - the collection should schedule a refresh as a result of this change\n */\ntype FilterEvent = 'change' | 'refresh' | 'scheduleRefresh' | 'beforeRefresh';\n\nexport interface ChangeValueOptions {\n  emitEvents?: FilterEvent[];\n  clearResult?: boolean;\n  actionType?: 'add' | 'remove';\n  clickedValueKey?: string;\n}\n\nexport type FilterItem<T> = T extends (infer V)[] ? V : T;\n\nexport interface FilterEventOptions {\n  clearResult?: boolean;\n  actionType?: 'add' | 'remove';\n  clickedValueKey?: string;\n}\n\ninterface FilterEventsSchema {\n  refresh: (opt: FilterEventOptions | undefined) => unknown;\n  beforeRefresh: (opt: FilterEventOptions | undefined) => unknown;\n  change: (opt?: FilterEventOptions) => unknown;\n  scheduleRefresh: (opt?: FilterEventOptions) => unknown;\n}\n\nexport type FilterEvents = TypedEmitter<FilterEventsSchema>;\n\nexport interface Filter<T> {\n  events: TypedEmitter<FilterEventsSchema>;\n  name: string;\n  persistent?: boolean;\n  readonly value: T;\n  readonly toArray: FilterItem<T>[];\n  readonly isEmpty: boolean;\n  readonly toQueryString: string;\n  readonly decode: (value: unknown) => T;\n  readonly encode: (value: T) => unknown;\n  readonly size: number;\n  readonly itemKey: (item: FilterItem<T>) => string;\n  readonly itemName: (item: FilterItem<T>) => string;\n  readonly matches: (item: FilterItem<T>, value: T) => boolean;\n  readonly entityName: (pluralization: number) => string;\n  readonly equals?: (item1: FilterItem<T>, item2: FilterItem<T>) => boolean;\n\n  applyFromQueryString(str: string): void;\n  setValue(value: T, options?: ChangeValueOptions): void;\n  changeValue(value: T, options?: ChangeValueOptions): void;\n  refresh(value: T, options?: ChangeValueOptions): void;\n  scheduleRefresh(value: T): void;\n  reset(options?: ChangeValueOptions): void;\n  remove(items: FilterItem<T>[], options?: ChangeValueOptions): void;\n  clone(...args: any[]): Filter<T>;\n  hasDiff(items: T): boolean;\n}\n\nexport interface FilterStateBaseParams<T> {\n  name?: string;\n  /**\n   * Marks the filter as a \"context\" or \"scope\" filter. This makes the filter not be visible in the sub-toolbar tag list, not saved in views, not counted as \"X filters applied\".\n   * @external\n   */\n  persistent?: boolean;\n  /**\n   * The value to initialize the filter with (Optional)\n   * @external\n   */\n  initialValue?: T;\n\n  /**\n   * A callback function that accepts an item and returns a unique ID of it. typically `item.id`.\n   * @external\n   */\n  itemKey: (item: FilterItem<T>) => string;\n  /**\n   * A callback function that accepts an item and returns the item name which is used in many messages through cairo\n   * @external\n   */\n  itemName: (item: FilterItem<T>) => string;\n  /**\n   * @deprecated No longer required. To customize filters panel accordion item label pass [accordionItemProps.label](/pages/cairo/?path=/story/components-filters--filterprops) prop to the filter component\n   */\n  entityName?: (pluralization: number) => string;\n\n  /**\n   * A function which accepts 2 items and returns true if they are equal\n   * @external\n   */\n  equals?: (item1: FilterItem<T>, item2: FilterItem<T>) => boolean;\n}\n\nexport type FiltersMap = { [key: string]: Filter<any> | undefined };\nexport type OptionalFiltersMap = { [key: string]: undefined };\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["../../../src/model/filter.ts"],"sourcesContent":["import { TypedEmitter } from '../util';\n\n/*\nchange - whenever we want to notify that the value was changed, for additional side effects, i.e BI events. For example, when initializing the value, we don't want to emit this event.\nrefresh - the collection should be refreshed as a result of this change\nscheduleRefresh - the collection should schedule a refresh as a result of this change\n */\ntype FilterEvent = 'change' | 'refresh' | 'scheduleRefresh' | 'beforeRefresh';\n\nexport interface ChangeValueOptions {\n  emitEvents?: FilterEvent[];\n  clearResult?: boolean;\n  actionType?: 'add' | 'remove';\n  clickedValueKey?: string;\n}\n\nexport type FilterItem<T> = T extends (infer V)[] ? V : T;\n\nexport interface FilterEventOptions {\n  clearResult?: boolean;\n  actionType?: 'add' | 'remove';\n  clickedValueKey?: string;\n}\n\ninterface FilterEventsSchema {\n  refresh: (opt: FilterEventOptions | undefined) => unknown;\n  beforeRefresh: (opt: FilterEventOptions | undefined) => unknown;\n  change: (opt?: FilterEventOptions) => unknown;\n  scheduleRefresh: (opt?: FilterEventOptions) => unknown;\n}\n\nexport type FilterEvents = TypedEmitter<FilterEventsSchema>;\n\nexport interface Filter<T> {\n  events: TypedEmitter<FilterEventsSchema>;\n  name: string;\n  persistent?: boolean;\n  readonly value: T;\n  readonly toArray: FilterItem<T>[];\n  readonly isEmpty: boolean;\n  readonly toQueryString: string;\n  readonly decode: (value: unknown) => T;\n  readonly encode: (value: T) => unknown;\n  readonly size: number;\n  readonly itemKey: (item: FilterItem<T>) => string;\n  readonly itemName: (item: FilterItem<T>) => string;\n  readonly matches: (item: FilterItem<T>, value: T) => boolean;\n  readonly entityName: (pluralization: number) => string;\n  readonly equals?: (item1: FilterItem<T>, item2: FilterItem<T>) => boolean;\n\n  applyFromQueryString(str: string): void;\n  setValue(value: T, options?: ChangeValueOptions): void;\n  changeValue(value: T, options?: ChangeValueOptions): void;\n  refresh(value: T, options?: ChangeValueOptions): void;\n  scheduleRefresh(value: T): void;\n  reset(options?: ChangeValueOptions): void;\n  remove(items: FilterItem<T>[], options?: ChangeValueOptions): void;\n  clone(...args: any[]): Filter<T>;\n  hasDiff(items: T): boolean;\n  _hideFromToolbar?: boolean;\n}\n\nexport interface FilterStateBaseParams<T> {\n  name?: string;\n  /**\n   * Marks the filter as a \"context\" or \"scope\" filter. This makes the filter not be visible in the sub-toolbar tag list, not saved in views, not counted as \"X filters applied\".\n   * @external\n   */\n  persistent?: boolean;\n  /**\n   * The value to initialize the filter with (Optional)\n   * @external\n   */\n  initialValue?: T;\n\n  /**\n   * A callback function that accepts an item and returns a unique ID of it. typically `item.id`.\n   * @external\n   */\n  itemKey: (item: FilterItem<T>) => string;\n  /**\n   * A callback function that accepts an item and returns the item name which is used in many messages through cairo\n   * @external\n   */\n  itemName: (item: FilterItem<T>) => string;\n  /**\n   * @deprecated No longer required. To customize filters panel accordion item label pass [accordionItemProps.label](/pages/cairo/?path=/story/components-filters--filterprops) prop to the filter component\n   */\n  entityName?: (pluralization: number) => string;\n\n  /**\n   * A function which accepts 2 items and returns true if they are equal\n   * @external\n   */\n  equals?: (item1: FilterItem<T>, item2: FilterItem<T>) => boolean;\n}\n\nexport type FiltersMap = { [key: string]: Filter<any> | undefined };\nexport type OptionalFiltersMap = { [key: string]: undefined };\n"],"mappings":"","ignoreList":[]}

package/dist/types/model/filter.d.ts

@@ -44,6 +44,7 @@ export interface Filter<T> {
     remove(items: FilterItem<T>[], options?: ChangeValueOptions): void;
     clone(...args: any[]): Filter<T>;
     hasDiff(items: T): boolean;
+    _hideFromToolbar?: boolean;
 }
 export interface FilterStateBaseParams<T> {
     name?: string;

package/dist/types/model/filter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"filter.d.ts","sourceRoot":"","sources":["../../../src/model/filter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAOvC,KAAK,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,iBAAiB,GAAG,eAAe,CAAC;AAE9E,MAAM,WAAW,kBAAkB;IACjC,UAAU,CAAC,EAAE,WAAW,EAAE,CAAC;IAC3B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;AAE1D,MAAM,WAAW,kBAAkB;IACjC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,UAAU,kBAAkB;IAC1B,OAAO,EAAE,CAAC,GAAG,EAAE,kBAAkB,GAAG,SAAS,KAAK,OAAO,CAAC;IAC1D,aAAa,EAAE,CAAC,GAAG,EAAE,kBAAkB,GAAG,SAAS,KAAK,OAAO,CAAC;IAChE,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC;IAC9C,eAAe,EAAE,CAAC,GAAG,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC;CACxD;AAED,MAAM,MAAM,YAAY,GAAG,YAAY,CAAC,kBAAkB,CAAC,CAAC;AAE5D,MAAM,WAAW,MAAM,CAAC,CAAC;IACvB,MAAM,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAAC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;IAClC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,CAAC,CAAC;IACvC,QAAQ,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC;IACvC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC;IAClD,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC;IACnD,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC;IAC7D,QAAQ,CAAC,UAAU,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,MAAM,CAAC;IACvD,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC;IAE1E,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACvD,WAAW,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAC1D,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACtD,eAAe,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IAChC,KAAK,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAC1C,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACnE,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACjC,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC;IAEjB;;;OAGG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC;IACzC;;;OAGG;IACH,QAAQ,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC;IAC1C;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,MAAM,CAAC;IAE/C;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC;CAClE;AAED,MAAM,MAAM,UAAU,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAA;CAAE,CAAC;AACpE,MAAM,MAAM,kBAAkB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC"}
+{"version":3,"file":"filter.d.ts","sourceRoot":"","sources":["../../../src/model/filter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAOvC,KAAK,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,iBAAiB,GAAG,eAAe,CAAC;AAE9E,MAAM,WAAW,kBAAkB;IACjC,UAAU,CAAC,EAAE,WAAW,EAAE,CAAC;IAC3B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;AAE1D,MAAM,WAAW,kBAAkB;IACjC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,UAAU,kBAAkB;IAC1B,OAAO,EAAE,CAAC,GAAG,EAAE,kBAAkB,GAAG,SAAS,KAAK,OAAO,CAAC;IAC1D,aAAa,EAAE,CAAC,GAAG,EAAE,kBAAkB,GAAG,SAAS,KAAK,OAAO,CAAC;IAChE,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC;IAC9C,eAAe,EAAE,CAAC,GAAG,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC;CACxD;AAED,MAAM,MAAM,YAAY,GAAG,YAAY,CAAC,kBAAkB,CAAC,CAAC;AAE5D,MAAM,WAAW,MAAM,CAAC,CAAC;IACvB,MAAM,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAAC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;IAClC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,CAAC,CAAC;IACvC,QAAQ,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC;IACvC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC;IAClD,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC;IACnD,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC;IAC7D,QAAQ,CAAC,UAAU,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,MAAM,CAAC;IACvD,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC;IAE1E,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACvD,WAAW,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAC1D,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACtD,eAAe,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IAChC,KAAK,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAC1C,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACnE,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACjC,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC;IAC3B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC;IAEjB;;;OAGG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC;IACzC;;;OAGG;IACH,QAAQ,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC;IAC1C;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,MAAM,CAAC;IAE/C;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC;CAClE;AAED,MAAM,MAAM,UAAU,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAA;CAAE,CAAC;AACpE,MAAM,MAAM,kBAAkB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/bex-core",
-  "version": "1.444.0",
+  "version": "1.445.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Kobi",
@@ -156,5 +156,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "577170c8519644eda3f81c909d9b6de14c056fa6a70dd83484daed36"
+  "falconPackageHash": "149720b6b6b429a2d7cd5b5697a95dbb12c7a91b015fef3c69137faa"
 }