@webitel/ui-datalist 26.8.6 → 26.8.8

package/types/modules/table/createTableStore.store.d.ts

@@ -1,6 +1,7 @@
 import { type Ref } from 'vue';
+import type { FilterName } from '../filters';
 import type { Identifiable } from '../types/createDatalistStore.types';
-import type { LoadDataListOptions, PatchItemPropertyParams, useTableStoreConfig } from '../types/tableStore.types';
+import type { DatalistTableHeader, LoadDataListOptions, PatchItemPropertyParams, useTableStoreConfig } from '../types/tableStore.types';
 export declare const tableStoreBody: <Entity extends Identifiable>(namespace: string, config: useTableStoreConfig<Entity>) => {
     isStoreSetUp: Ref<boolean, boolean>;
     isNested: Ref<boolean, boolean>;
@@ -11,120 +12,87 @@ export declare const tableStoreBody: <Entity extends Identifiable>(namespace: st
     page: Ref<number, number>;
     size: Ref<number, number>;
     next: Ref<boolean, boolean>;
-    headers: Ref<{
-        value: string;
-        locale?: string | (string | number | Record<string, unknown>)[] | undefined;
-        text?: string | undefined;
-        width?: string | undefined;
-        field: string;
-        sort?: (import("@webitel/ui-sdk/src/components/wt-table/types/WtTable").WtTableSortOrder | boolean) | undefined;
-        show?: boolean | undefined;
-        reorderable?: boolean | undefined;
-        shouldBeInitialized?: boolean | undefined;
-        access?: (() => boolean | Ref<boolean>) | undefined;
-    }[], import("../..").DatalistTableHeader[] | {
-        value: string;
-        locale?: string | (string | number | Record<string, unknown>)[] | undefined;
-        text?: string | undefined;
-        width?: string | undefined;
-        field: string;
-        sort?: (import("@webitel/ui-sdk/src/components/wt-table/types/WtTable").WtTableSortOrder | boolean) | undefined;
-        show?: boolean | undefined;
-        reorderable?: boolean | undefined;
-        shouldBeInitialized?: boolean | undefined;
-        access?: (() => boolean | Ref<boolean>) | undefined;
-    }[]>;
-    shownHeaders: import("vue").ComputedRef<{
-        value: string;
-        locale?: string | (string | number | Record<string, unknown>)[] | undefined;
-        text?: string | undefined;
-        width?: string | undefined;
-        field: string;
-        sort?: (import("@webitel/ui-sdk/src/components/wt-table/types/WtTable").WtTableSortOrder | boolean) | undefined;
-        show?: boolean | undefined;
-        reorderable?: boolean | undefined;
-        shouldBeInitialized?: boolean | undefined;
-        access?: (() => boolean | Ref<boolean>) | undefined;
-    }[]>;
+    headers: import("vue").ComputedRef<DatalistTableHeader[]>;
+    shownHeaders: import("vue").ComputedRef<DatalistTableHeader[]>;
     fields: import("vue").ComputedRef<string[]>;
     sort: import("vue").ComputedRef<string | null>;
     columnWidths: import("vue").ComputedRef<Record<string, string>>;
     searchMode: Ref<string, string>;
     filtersManager: Ref<{
         filters: Map<string, {
-            name: import("../filters").FilterName;
+            name: FilterName;
             value: import("../filters").FilterValue;
             label?: import("../filters").FilterLabel | undefined;
             set: (data: import("../filters/classes/Filter").FilterData) => import("../filters").IFilter;
         }> & Omit<Map<string, import("../filters").IFilter>, keyof Map<any, any>>;
-        hasFilter: (name: import("../filters").FilterName) => boolean;
-        getFilter: (name: import("../filters").FilterName) => import("../filters").IFilter | undefined;
+        hasFilter: (name: FilterName) => boolean;
+        getFilter: (name: FilterName) => import("../filters").IFilter | undefined;
         addFilter: (params: import("../filters").FilterInitParams, payload?: object, config?: import("../filters").FilterInstanceConfig) => import("../filters").IFilter;
         updateFilter: ({ name, }: {
-            name: import("../filters").FilterName;
+            name: FilterName;
             value?: import("../filters").FilterValue;
             label?: import("../filters").FilterLabel;
         }) => import("../filters").IFilter;
         deleteFilter: ({ name }: {
-            name: import("../filters").FilterName;
+            name: FilterName;
         }) => import("../filters").IFilter | undefined;
         toString: (options?: {
-            include?: import("../filters").FilterName[];
-            exclude?: import("../filters").FilterName[];
+            include?: FilterName[];
+            exclude?: FilterName[];
         }) => string;
         fromString: (snapshotStr: string) => void;
         reset: ({ include, exclude, }?: {
-            include?: import("../filters").FilterName[];
-            exclude?: import("../filters").FilterName[];
+            include?: FilterName[];
+            exclude?: FilterName[];
         }) => void;
-        getAllKeys: () => import("../filters").FilterName[];
+        getAllKeys: () => FilterName[];
         getAllValues: ({ include, exclude, }?: {
-            include?: import("../filters").FilterName[];
-            exclude?: import("../filters").FilterName[];
+            include?: FilterName[];
+            exclude?: FilterName[];
         }) => {
-            [name: import("../filters").FilterName]: import("../filters").FilterValue;
+            [name: FilterName]: import("../filters").FilterValue;
         };
         getFiltersList: ({ include, exclude, }?: {
-            include?: import("../filters").FilterName[];
-            exclude?: import("../filters").FilterName[];
+            include?: FilterName[];
+            exclude?: FilterName[];
         }) => import("../filters").IFilter[];
     }, {
         filters: Map<string, {
-            name: import("../filters").FilterName;
+            name: FilterName;
             value: import("../filters").FilterValue;
             label?: import("../filters").FilterLabel | undefined;
             set: (data: import("../filters/classes/Filter").FilterData) => import("../filters").IFilter;
         }> & Omit<Map<string, import("../filters").IFilter>, keyof Map<any, any>>;
-        hasFilter: (name: import("../filters").FilterName) => boolean;
-        getFilter: (name: import("../filters").FilterName) => import("../filters").IFilter | undefined;
+        hasFilter: (name: FilterName) => boolean;
+        getFilter: (name: FilterName) => import("../filters").IFilter | undefined;
         addFilter: (params: import("../filters").FilterInitParams, payload?: object, config?: import("../filters").FilterInstanceConfig) => import("../filters").IFilter;
         updateFilter: ({ name, }: {
-            name: import("../filters").FilterName;
+            name: FilterName;
             value?: import("../filters").FilterValue;
             label?: import("../filters").FilterLabel;
         }) => import("../filters").IFilter;
         deleteFilter: ({ name }: {
-            name: import("../filters").FilterName;
+            name: FilterName;
         }) => import("../filters").IFilter | undefined;
         toString: (options?: {
-            include?: import("../filters").FilterName[];
-            exclude?: import("../filters").FilterName[];
+            include?: FilterName[];
+            exclude?: FilterName[];
         }) => string;
         fromString: (snapshotStr: string) => void;
         reset: ({ include, exclude, }?: {
-            include?: import("../filters").FilterName[];
-            exclude?: import("../filters").FilterName[];
+            include?: FilterName[];
+            exclude?: FilterName[];
         }) => void;
-        getAllKeys: () => import("../filters").FilterName[];
+        getAllKeys: () => FilterName[];
         getAllValues: ({ include, exclude, }?: {
-            include?: import("../filters").FilterName[];
-            exclude?: import("../filters").FilterName[];
+            include?: FilterName[];
+            exclude?: FilterName[];
         }) => {
-            [name: import("../filters").FilterName]: import("../filters").FilterValue;
+            [name: FilterName]: import("../filters").FilterValue;
         };
         getFiltersList: ({ include, exclude, }?: {
-            include?: import("../filters").FilterName[];
-            exclude?: import("../filters").FilterName[];
+            include?: FilterName[];
+            exclude?: FilterName[];
         }) => import("../filters").IFilter[];
     }>;
     isFiltersRestoring: Ref<boolean, boolean>;
@@ -143,7 +111,7 @@ export declare const tableStoreBody: <Entity extends Identifiable>(namespace: st
     updateSearchMode: (newSearch: string) => void;
     updatePage: (newPage: number) => void;
     updateSize: (newSize: number) => void;
-    updateSort: (column: import("../..").DatalistTableHeader, options?: {
+    updateSort: (column: DatalistTableHeader, options?: {
         order?: import("@webitel/ui-sdk/src/components/wt-table/types/WtTable").WtTableSortOrder;
     } | import("@webitel/ui-sdk/src/components/wt-table/types/WtTable").WtTableSortOrder) => void;
     columnResize: ({ columnName, columnWidth, }: {
@@ -151,16 +119,16 @@ export declare const tableStoreBody: <Entity extends Identifiable>(namespace: st
         columnWidth: string;
     }) => void;
     columnReorder: (orderedFields: string[]) => void;
-    updateShownHeaders: (value: import("../..").DatalistTableHeader[]) => void;
-    hasFilter: (name: import("../filters").FilterName) => boolean;
+    updateShownHeaders: (value: DatalistTableHeader[]) => void;
+    hasFilter: (name: FilterName) => boolean;
     addFilter: (params: import("../filters").FilterInitParams, payload?: object, config?: import("../filters").FilterInstanceConfig) => import("../filters").IFilter;
     updateFilter: ({ name, }: {
-        name: import("../filters").FilterName;
+        name: FilterName;
         value?: import("../filters").FilterValue;
         label?: import("../filters").FilterLabel;
     }) => import("../filters").IFilter;
     deleteFilter: ({ name }: {
-        name: import("../filters").FilterName;
+        name: FilterName;
     }) => import("../filters").IFilter | undefined;
 };
 export declare const createTableStore: <Entity extends Identifiable>(namespace: string, config: useTableStoreConfig<Entity>) => import("../types/createDatalistStore.types").PatchableStoreFactory<{
@@ -173,120 +141,87 @@ export declare const createTableStore: <Entity extends Identifiable>(namespace:
     page: Ref<number, number>;
     size: Ref<number, number>;
     next: Ref<boolean, boolean>;
-    headers: Ref<{
-        value: string;
-        locale?: string | (string | number | Record<string, unknown>)[] | undefined;
-        text?: string | undefined;
-        width?: string | undefined;
-        field: string;
-        sort?: (import("@webitel/ui-sdk/src/components/wt-table/types/WtTable").WtTableSortOrder | boolean) | undefined;
-        show?: boolean | undefined;
-        reorderable?: boolean | undefined;
-        shouldBeInitialized?: boolean | undefined;
-        access?: (() => boolean | Ref<boolean>) | undefined;
-    }[], import("../..").DatalistTableHeader[] | {
-        value: string;
-        locale?: string | (string | number | Record<string, unknown>)[] | undefined;
-        text?: string | undefined;
-        width?: string | undefined;
-        field: string;
-        sort?: (import("@webitel/ui-sdk/src/components/wt-table/types/WtTable").WtTableSortOrder | boolean) | undefined;
-        show?: boolean | undefined;
-        reorderable?: boolean | undefined;
-        shouldBeInitialized?: boolean | undefined;
-        access?: (() => boolean | Ref<boolean>) | undefined;
-    }[]>;
-    shownHeaders: import("vue").ComputedRef<{
-        value: string;
-        locale?: string | (string | number | Record<string, unknown>)[] | undefined;
-        text?: string | undefined;
-        width?: string | undefined;
-        field: string;
-        sort?: (import("@webitel/ui-sdk/src/components/wt-table/types/WtTable").WtTableSortOrder | boolean) | undefined;
-        show?: boolean | undefined;
-        reorderable?: boolean | undefined;
-        shouldBeInitialized?: boolean | undefined;
-        access?: (() => boolean | Ref<boolean>) | undefined;
-    }[]>;
+    headers: import("vue").ComputedRef<DatalistTableHeader[]>;
+    shownHeaders: import("vue").ComputedRef<DatalistTableHeader[]>;
     fields: import("vue").ComputedRef<string[]>;
     sort: import("vue").ComputedRef<string | null>;
     columnWidths: import("vue").ComputedRef<Record<string, string>>;
     searchMode: Ref<string, string>;
     filtersManager: Ref<{
         filters: Map<string, {
-            name: import("../filters").FilterName;
+            name: FilterName;
             value: import("../filters").FilterValue;
             label?: import("../filters").FilterLabel | undefined;
             set: (data: import("../filters/classes/Filter").FilterData) => import("../filters").IFilter;
         }> & Omit<Map<string, import("../filters").IFilter>, keyof Map<any, any>>;
-        hasFilter: (name: import("../filters").FilterName) => boolean;
-        getFilter: (name: import("../filters").FilterName) => import("../filters").IFilter | undefined;
+        hasFilter: (name: FilterName) => boolean;
+        getFilter: (name: FilterName) => import("../filters").IFilter | undefined;
         addFilter: (params: import("../filters").FilterInitParams, payload?: object, config?: import("../filters").FilterInstanceConfig) => import("../filters").IFilter;
         updateFilter: ({ name, }: {
-            name: import("../filters").FilterName;
+            name: FilterName;
             value?: import("../filters").FilterValue;
             label?: import("../filters").FilterLabel;
         }) => import("../filters").IFilter;
         deleteFilter: ({ name }: {
-            name: import("../filters").FilterName;
+            name: FilterName;
         }) => import("../filters").IFilter | undefined;
         toString: (options?: {
-            include?: import("../filters").FilterName[];
-            exclude?: import("../filters").FilterName[];
+            include?: FilterName[];
+            exclude?: FilterName[];
         }) => string;
         fromString: (snapshotStr: string) => void;
         reset: ({ include, exclude, }?: {
-            include?: import("../filters").FilterName[];
-            exclude?: import("../filters").FilterName[];
+            include?: FilterName[];
+            exclude?: FilterName[];
         }) => void;
-        getAllKeys: () => import("../filters").FilterName[];
+        getAllKeys: () => FilterName[];
         getAllValues: ({ include, exclude, }?: {
-            include?: import("../filters").FilterName[];
-            exclude?: import("../filters").FilterName[];
+            include?: FilterName[];
+            exclude?: FilterName[];
         }) => {
-            [name: import("../filters").FilterName]: import("../filters").FilterValue;
+            [name: FilterName]: import("../filters").FilterValue;
         };
         getFiltersList: ({ include, exclude, }?: {
-            include?: import("../filters").FilterName[];
-            exclude?: import("../filters").FilterName[];
+            include?: FilterName[];
+            exclude?: FilterName[];
         }) => import("../filters").IFilter[];
     }, {
         filters: Map<string, {
-            name: import("../filters").FilterName;
+            name: FilterName;
             value: import("../filters").FilterValue;
             label?: import("../filters").FilterLabel | undefined;
             set: (data: import("../filters/classes/Filter").FilterData) => import("../filters").IFilter;
         }> & Omit<Map<string, import("../filters").IFilter>, keyof Map<any, any>>;
-        hasFilter: (name: import("../filters").FilterName) => boolean;
-        getFilter: (name: import("../filters").FilterName) => import("../filters").IFilter | undefined;
+        hasFilter: (name: FilterName) => boolean;
+        getFilter: (name: FilterName) => import("../filters").IFilter | undefined;
         addFilter: (params: import("../filters").FilterInitParams, payload?: object, config?: import("../filters").FilterInstanceConfig) => import("../filters").IFilter;
         updateFilter: ({ name, }: {
-            name: import("../filters").FilterName;
+            name: FilterName;
             value?: import("../filters").FilterValue;
             label?: import("../filters").FilterLabel;
         }) => import("../filters").IFilter;
         deleteFilter: ({ name }: {
-            name: import("../filters").FilterName;
+            name: FilterName;
         }) => import("../filters").IFilter | undefined;
         toString: (options?: {
-            include?: import("../filters").FilterName[];
-            exclude?: import("../filters").FilterName[];
+            include?: FilterName[];
+            exclude?: FilterName[];
         }) => string;
         fromString: (snapshotStr: string) => void;
         reset: ({ include, exclude, }?: {
-            include?: import("../filters").FilterName[];
-            exclude?: import("../filters").FilterName[];
+            include?: FilterName[];
+            exclude?: FilterName[];
         }) => void;
-        getAllKeys: () => import("../filters").FilterName[];
+        getAllKeys: () => FilterName[];
         getAllValues: ({ include, exclude, }?: {
-            include?: import("../filters").FilterName[];
-            exclude?: import("../filters").FilterName[];
+            include?: FilterName[];
+            exclude?: FilterName[];
         }) => {
-            [name: import("../filters").FilterName]: import("../filters").FilterValue;
+            [name: FilterName]: import("../filters").FilterValue;
         };
         getFiltersList: ({ include, exclude, }?: {
-            include?: import("../filters").FilterName[];
-            exclude?: import("../filters").FilterName[];
+            include?: FilterName[];
+            exclude?: FilterName[];
         }) => import("../filters").IFilter[];
     }>;
     isFiltersRestoring: Ref<boolean, boolean>;
@@ -305,7 +240,7 @@ export declare const createTableStore: <Entity extends Identifiable>(namespace:
     updateSearchMode: (newSearch: string) => void;
     updatePage: (newPage: number) => void;
     updateSize: (newSize: number) => void;
-    updateSort: (column: import("../..").DatalistTableHeader, options?: {
+    updateSort: (column: DatalistTableHeader, options?: {
         order?: import("@webitel/ui-sdk/src/components/wt-table/types/WtTable").WtTableSortOrder;
     } | import("@webitel/ui-sdk/src/components/wt-table/types/WtTable").WtTableSortOrder) => void;
     columnResize: ({ columnName, columnWidth, }: {
@@ -313,15 +248,15 @@ export declare const createTableStore: <Entity extends Identifiable>(namespace:
         columnWidth: string;
     }) => void;
     columnReorder: (orderedFields: string[]) => void;
-    updateShownHeaders: (value: import("../..").DatalistTableHeader[]) => void;
-    hasFilter: (name: import("../filters").FilterName) => boolean;
+    updateShownHeaders: (value: DatalistTableHeader[]) => void;
+    hasFilter: (name: FilterName) => boolean;
     addFilter: (params: import("../filters").FilterInitParams, payload?: object, config?: import("../filters").FilterInstanceConfig) => import("../filters").IFilter;
     updateFilter: ({ name, }: {
-        name: import("../filters").FilterName;
+        name: FilterName;
         value?: import("../filters").FilterValue;
         label?: import("../filters").FilterLabel;
     }) => import("../filters").IFilter;
     deleteFilter: ({ name }: {
-        name: import("../filters").FilterName;
+        name: FilterName;
     }) => import("../filters").IFilter | undefined;
 }>;

package/types/modules/types/tableStore.types.d.ts

@@ -1,14 +1,24 @@
 import type { ApiModule } from '@webitel/ui-sdk/api/types/ApiModule';
 import type { WtTableHeader } from '@webitel/ui-sdk/components/wt-table/types/WtTable';
 import type { Ref } from 'vue';
-import type { IFiltersManager } from '../filters';
+import type { FilterName, IFiltersManager } from '../filters';
 import type { DatalistStoreProviderType } from './StoreProvider';
+/**
+ * Minimal shape of an already-resolved header filter. Deliberately not the full
+ * `AnyFilterConfig` (with its `Component` props): `createTableHeadersStore` keeps headers in a
+ * plain `ref<DatalistTableHeader[]>`, and `Component` props there send Vue's `UnwrapRef` into
+ * excessive type-instantiation depth (TS2589). `useColumnFilter`'s `isResolvedFilterConfig`
+ * narrows a value of this shape back to `AnyFilterConfig` for actual use.
+ */
+export type ResolvedHeaderFilter = {
+    name: FilterName;
+};
 /**
  * Table header shape used inside the datalist stores. In addition to the
  * base {@link WtTableHeader} shape, datalist stores key columns by `field`
  * and may flag dynamically-appended headers for lazy initialization.
  */
-export type DatalistTableHeader = WtTableHeader & {
+export type DatalistTableHeader = Omit<WtTableHeader, 'filter'> & {
     field: string;
     shouldBeInitialized?: boolean;
     /**
@@ -18,6 +28,14 @@ export type DatalistTableHeader = WtTableHeader & {
      * restorable from persisted state. Omitted means allowed.
      */
     access?: () => boolean | Ref<boolean>;
+    /**
+     * Name of the filter shown in the column header popover (`column-filter` slot),
+     * or an already-resolved config for it (build one with `createFilterConfig`). Passing a
+     * config here lets `headers.ts` map the header to its filter once, instead of
+     * `useColumnFilter` searching `filterOptions`/`filterableExtensionFields` for it on every
+     * column.
+     */
+    filter?: WtTableHeader['filter'] | ResolvedHeaderFilter;
 };
 export type TrackSelectedRowBy<T> = (row: T) => T;
 /**