nuxt-ui-tools 1.27.1 → 1.27.2

package/dist/module.json

@@ -5,7 +5,7 @@
   "configKey": "nuxtUiTools",
   "docs": "https://ui.nuxt.com/docs/getting-started/installation/nuxt",
   "name": "nuxt-ui-tools",
-  "version": "1.27.1",
+  "version": "1.27.2",
   "builder": {
     "@nuxt/module-builder": "1.0.3",
     "unbuild": "unknown"

package/dist/runtime/table/builders/index.js

@@ -61,6 +61,41 @@ export function createTableFilterBuilder() {
         kind: "text",
         ...options
       };
+    },
+    query: createTableQueryFilterBuilder()
+  };
+}
+function createTableQueryFilterBuilder() {
+  return {
+    boolean(key, options) {
+      return {
+        key,
+        kind: "boolean",
+        ...options,
+        behavior: { ...options.behavior, applyTo: "query" }
+      };
+    },
+    date(key, options) {
+      return { key, kind: "date", ...options, behavior: { ...options.behavior, applyTo: "query" } };
+    },
+    number(key, options) {
+      return {
+        key,
+        kind: "number",
+        ...options,
+        behavior: { ...options.behavior, applyTo: "query" }
+      };
+    },
+    option(key, options) {
+      return {
+        key,
+        kind: "option",
+        ...options,
+        behavior: { ...options.behavior, applyTo: "query" }
+      };
+    },
+    text(key, options) {
+      return { key, kind: "text", ...options, behavior: { ...options.behavior, applyTo: "query" } };
     }
   };
 }

package/dist/runtime/table/types/filters.d.ts

@@ -708,33 +708,37 @@ export type TableOptionFilterOptions<TRow extends GenericObject = GenericObject,
 export type TableBooleanFilterOptions<TRow extends GenericObject = GenericObject, TContext extends GenericObject = GenericObject, TKey extends string = TableKnownFieldPath<TRow>> = Omit<TableBooleanFilterDefinition<TRow, TContext, TKey>, 'key' | 'kind'>;
 export type TableNumberFilterOptions<TRow extends GenericObject = GenericObject, TContext extends GenericObject = GenericObject, TKey extends string = TableKnownFieldPath<TRow>> = Omit<TableNumberFilterDefinition<TRow, TContext, TKey>, 'key' | 'kind'>;
 export type TableDateFilterOptions<TRow extends GenericObject = GenericObject, TContext extends GenericObject = GenericObject, TKey extends string = TableKnownFieldPath<TRow>> = Omit<TableDateFilterDefinition<TRow, TContext, TKey>, 'key' | 'kind'>;
-/**
- * Keys a filter may use. A row field path filters rows; any other key names a query parameter of
- * the source and requires `behavior.applyTo: 'query'`.
- */
-export type TableFilterKey<TRow extends GenericObject = GenericObject> = TableKnownFieldPath<TRow> | (string & {});
-/** What a filter key adds to its options: nothing for a row field, `applyTo: 'query'` otherwise. */
-export type TableFilterKeyScope<TRow extends GenericObject, TKey extends string> = TKey extends TableKnownFieldPath<TRow> ? unknown : {
+/** What marks a filter as a scope of the source query rather than of the rows. */
+export type TableQueryFilterScope = {
     behavior: {
         applyTo: 'query';
     };
 };
+/**
+ * Builds filters that scope the source query (`behavior.applyTo: 'query'`). Their key names a query
+ * parameter, so it does not have to be a row field.
+ */
+export interface TableQueryFilterBuilder<TRow extends GenericObject = GenericObject, TContext extends GenericObject = GenericObject> {
+    text<TKey extends string>(key: TKey, options: TableTextFilterOptions<TRow, TContext, TKey>): TableTextFilterDefinition<TRow, TContext, TKey> & TableQueryFilterScope;
+    option<TKey extends string, TValue extends TableFilterPrimitiveValue, TPresentation extends TableOptionFilterPresentation = TableOptionFilterPresentation>(key: TKey, options: TableOptionFilterOptions<TRow, TContext, TKey, TValue, TPresentation>): TableOptionFilterDefinition<TRow, TContext, TKey, TValue, TPresentation> & TableQueryFilterScope;
+    boolean<TKey extends string>(key: TKey, options: TableBooleanFilterOptions<TRow, TContext, TKey>): TableBooleanFilterDefinition<TRow, TContext, TKey> & TableQueryFilterScope;
+    number<TKey extends string>(key: TKey, options: TableNumberFilterOptions<TRow, TContext, TKey>): TableNumberFilterDefinition<TRow, TContext, TKey> & TableQueryFilterScope;
+    date<TKey extends string>(key: TKey, options: TableDateFilterOptions<TRow, TContext, TKey>): TableDateFilterDefinition<TRow, TContext, TKey> & TableQueryFilterScope;
+}
 export interface TableFilterBuilder<TRow extends GenericObject = GenericObject, TContext extends GenericObject = GenericObject> {
-    text<TKey extends TableFilterKey<TRow>>(key: TKey, options: TableTextFilterOptions<TRow, TContext, TKey> & TableFilterKeyScope<TRow, TKey>): TableTextFilterDefinition<TRow, TContext, TKey> & TableFilterKeyScope<TRow, TKey>;
-    option<TKey extends TableFilterKey<TRow>, TValue extends TableFilterPrimitiveValue, TPresentation extends TableOptionFilterPresentation = TableOptionFilterPresentation>(key: TKey, options: TableOptionFilterOptions<TRow, TContext, TKey, TValue, TPresentation> & TableFilterKeyScope<TRow, TKey>): TableOptionFilterDefinition<TRow, TContext, TKey, TValue, TPresentation> & TableFilterKeyScope<TRow, TKey>;
-    boolean<TKey extends TableFilterKey<TRow>>(key: TKey, options: TableBooleanFilterOptions<TRow, TContext, TKey> & TableFilterKeyScope<TRow, TKey>): TableBooleanFilterDefinition<TRow, TContext, TKey> & TableFilterKeyScope<TRow, TKey>;
-    number<TKey extends TableFilterKey<TRow>>(key: TKey, options: TableNumberFilterOptions<TRow, TContext, TKey> & TableFilterKeyScope<TRow, TKey>): TableNumberFilterDefinition<TRow, TContext, TKey> & TableFilterKeyScope<TRow, TKey>;
-    date<TKey extends TableFilterKey<TRow>>(key: TKey, options: TableDateFilterOptions<TRow, TContext, TKey> & TableFilterKeyScope<TRow, TKey>): TableDateFilterDefinition<TRow, TContext, TKey> & TableFilterKeyScope<TRow, TKey>;
+    text<TKey extends TableKnownFieldPath<TRow>>(key: TKey, options: TableTextFilterOptions<TRow, TContext, TKey>): TableTextFilterDefinition<TRow, TContext, TKey>;
+    option<TKey extends TableKnownFieldPath<TRow>, TValue extends TableFilterPrimitiveValue, TPresentation extends TableOptionFilterPresentation = TableOptionFilterPresentation>(key: TKey, options: TableOptionFilterOptions<TRow, TContext, TKey, TValue, TPresentation>): TableOptionFilterDefinition<TRow, TContext, TKey, TValue, TPresentation>;
+    boolean<TKey extends TableKnownFieldPath<TRow>>(key: TKey, options: TableBooleanFilterOptions<TRow, TContext, TKey>): TableBooleanFilterDefinition<TRow, TContext, TKey>;
+    number<TKey extends TableKnownFieldPath<TRow>>(key: TKey, options: TableNumberFilterOptions<TRow, TContext, TKey>): TableNumberFilterDefinition<TRow, TContext, TKey>;
+    date<TKey extends TableKnownFieldPath<TRow>>(key: TKey, options: TableDateFilterOptions<TRow, TContext, TKey>): TableDateFilterDefinition<TRow, TContext, TKey>;
+    /** Filters that scope the source query instead of the rows. See `TableQueryFilterBuilder`. */
+    query: TableQueryFilterBuilder<TRow, TContext>;
 }
 /**
- * One filter of a table: a row filter keyed by a row field, or a query filter
- * (`behavior.applyTo: 'query'`) keyed by any query parameter.
+ * One filter of a table: a row filter keyed by a row field, or a query filter built with
+ * `filter.query` and keyed by any query parameter.
  */
-export type TableUiFilterCollectionItem<TRow extends GenericObject = GenericObject, TContext extends GenericObject = GenericObject, TKey extends string = TableKnownFieldPath<TRow>> = TableUiFilterDefinition<TRow, TContext, TKey> | (TableUiFilterDefinition<TRow, TContext, string> & {
-    behavior: {
-        applyTo: 'query';
-    };
-});
+export type TableUiFilterCollectionItem<TRow extends GenericObject = GenericObject, TContext extends GenericObject = GenericObject, TKey extends string = TableKnownFieldPath<TRow>> = TableUiFilterDefinition<TRow, TContext, TKey> | (TableUiFilterDefinition<TRow, TContext, string> & TableQueryFilterScope);
 export type TableUiFilterCollection<TRow extends GenericObject = GenericObject, TContext extends GenericObject = GenericObject, TKey extends string = TableKnownFieldPath<TRow>> = TableUiFilterCollectionItem<TRow, TContext, TKey>[] | ((filter: TableFilterBuilder<TRow, TContext>) => TableUiFilterCollectionItem<TRow, TContext, TKey>[]);
 export interface TableFiltersSchema<TRow extends GenericObject = GenericObject, TContext extends GenericObject = GenericObject, TKey extends string = TableKnownFieldPath<TRow>> {
     search?: TableSearchFilter<TRow>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-ui-tools",
-  "version": "1.27.1",
+  "version": "1.27.2",
   "description": "Nuxt module and runtime toolkit for UI-heavy Nuxt applications",
   "homepage": "https://github.com/ChronicStone/nuxt-ui-tools#readme",
   "bugs": "https://github.com/ChronicStone/nuxt-ui-tools/issues",