@tanstack/table-core 9.0.0-alpha.43 → 9.0.0-alpha.46

package/dist/core/table/coreTablesFeature.js.map

@@ -1 +1 @@
-{"version":3,"file":"coreTablesFeature.js","names":[],"sources":["../../../src/core/table/coreTablesFeature.ts"],"sourcesContent":["import { assignTableAPIs } from '../../utils'\nimport { table_reset, table_setOptions } from './coreTablesFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type { TableOptions_Table, Table_Table } from './coreTablesFeature.types'\n\nexport interface CoreTablesFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Table: Table_Table<TFeatures, TData>\n  // TableOptions: TableOptions_Table<TFeatures, TData>\n}\n\nexport function constructCoreTablesFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<CoreTablesFeatureConstructors<TFeatures, TData>> {\n  return {\n    constructTableAPIs: (table) => {\n      assignTableAPIs('coreTablesFeature', table, {\n        table_reset: {\n          fn: () => table_reset(table),\n        },\n        table_setOptions: {\n          fn: (updater) => table_setOptions(table, updater),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The Core Tables feature provides the core table functionality for handling state and options.\n */\nexport const coreTablesFeature = constructCoreTablesFeature()\n"],"mappings":";;;;AAcA,SAAgB,6BAGmD;AACjE,QAAO,EACL,qBAAqB,UAAU;AAC7B,kBAAgB,qBAAqB,OAAO;GAC1C,aAAa,EACX,UAAU,YAAY,MAAM,EAC7B;GACD,kBAAkB,EAChB,KAAK,YAAY,iBAAiB,OAAO,QAAQ,EAClD;GACF,CAAC;IAEL;;;;;AAMH,MAAa,oBAAoB,4BAA4B"}
+{"version":3,"file":"coreTablesFeature.js","names":[],"sources":["../../../src/core/table/coreTablesFeature.ts"],"sourcesContent":["import { assignTableAPIs } from '../../utils'\nimport { table_reset, table_setOptions } from './coreTablesFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type { TableOptions_Table, Table_Table } from './coreTablesFeature.types'\n\nexport interface CoreTablesFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Table: Table_Table<TFeatures, TData>\n  // TableOptions: TableOptions_Table<TFeatures, TData>\n}\n\n/**\n * Creates the stock core tables feature.\n *\n * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.\n */\nexport function constructCoreTablesFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<CoreTablesFeatureConstructors<TFeatures, TData>> {\n  return {\n    constructTableAPIs: (table) => {\n      assignTableAPIs('coreTablesFeature', table, {\n        table_reset: {\n          fn: () => table_reset(table),\n        },\n        table_setOptions: {\n          fn: (updater) => table_setOptions(table, updater),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The Core Tables feature provides the core table functionality for handling state and options.\n */\nexport const coreTablesFeature = constructCoreTablesFeature()\n"],"mappings":";;;;;;;;;AAmBA,SAAgB,6BAGmD;CACjE,OAAO,EACL,qBAAqB,UAAU;EAC7B,gBAAgB,qBAAqB,OAAO;GAC1C,aAAa,EACX,UAAU,YAAY,MAAM,EAC7B;GACD,kBAAkB,EAChB,KAAK,YAAY,iBAAiB,OAAO,QAAQ,EAClD;GACF,CAAC;IAEL;;;;;AAMH,MAAa,oBAAoB,4BAA4B"}

package/dist/core/table/coreTablesFeature.types.d.cts

@@ -54,9 +54,9 @@ interface TableOptions_Table<TFeatures extends TableFeatures, TData extends RowD
   /**
    * Optionally, provide your own external writable atoms for individual state slices.
    * When an atom is provided for a given slice, it takes precedence over `options.state[key]`
-   * and the internal base atom for that slice. Writes originating from the library are
-   * still routed through the internal base atom; consumers are responsible for
-   * mirroring changes back to their external atom via the corresponding `onXChange` callback.
+   * and the internal base atom for that slice. Feature state update APIs write through
+   * the corresponding atom updater, so external atoms are the preferred v9 ownership
+   * model for app-managed table state slices.
    */
   readonly atoms?: ExternalAtoms<TFeatures>;
   /**
@@ -68,8 +68,10 @@ interface TableOptions_Table<TFeatures extends TableFeatures, TData extends RowD
    */
   readonly data: ReadonlyArray<TData>;
   /**
-   * Use this option to optionally pass initial state to the table. This state will be used when resetting various table states either automatically by the table (eg. `options.autoResetPageIndex`) or via functions like `table.resetRowSelection()`. Most reset function allow you optionally pass a flag to reset to a blank/default state instead of the initial state.
-   * Table state will not be reset when this object changes, which also means that the initial state object does not need to be stable.
+   * Optionally provide starting values for registered table state slices.
+   * Feature reset APIs use this value by default, and many reset APIs accept
+   * `true` to reset to that feature's blank/default state instead. Changing this
+   * object later does not reset table state, so it does not need to be stable.
    */
   readonly initialState?: Partial<TableState<TFeatures>>;
   /**
@@ -81,7 +83,11 @@ interface TableOptions_Table<TFeatures extends TableFeatures, TData extends RowD
    */
   readonly meta?: TableMeta<TFeatures, TData>;
   /**
-   * Pass in individual self-managed state to the table.
+   * Optionally provide externally managed values for individual state slices.
+   *
+   * Pair each slice with its matching `on[State]Change` callback so table state
+   * updates can be persisted outside the table. External atoms take precedence
+   * over this option when both are provided for the same slice.
    */
   readonly state?: Partial<TableState<TFeatures>>;
 }
@@ -138,10 +144,9 @@ interface Table_CoreProperties<TFeatures extends TableFeatures, TData extends Ro
    */
   readonly options: TableOptions<TFeatures, TData>;
   /**
-   * Writable atom for table options. Only created when `createOptionsStore` is true
-   * on `coreReativityFeature` (e.g. Lit, Vue, Solid). React/Preact use `createOptionsStore: false`:
-   * options are held as plain data with a lightweight revision + subscribe source; there is
-   * no writable atom backing the full options object. Use {@link getTableOptionsStore} to subscribe.
+   * Writable atom for table options. Only created when `createOptionsStore` is
+   * true on the active core reactivity bindings. Adapters that opt out keep
+   * options as plain resolved data instead of backing them with an atom.
    */
   readonly optionsStore?: Atom<TableOptions<TFeatures, TData>> | undefined;
   /**
@@ -152,11 +157,16 @@ interface Table_CoreProperties<TFeatures extends TableFeatures, TData extends Ro
 }
 interface Table_Table<TFeatures extends TableFeatures, TData extends RowData> extends Table_CoreProperties<TFeatures, TData> {
   /**
-   * Call this function to reset the table state to the initial state.
+   * Resets the table's internal base atoms to `table.initialState`.
+   *
+   * Prefer feature-specific reset APIs, such as `resetPagination`, when a state
+   * slice may be owned by an external atom or needs that feature's blank/default
+   * reset behavior.
    */
   reset: () => void;
   /**
-   * This function can be used to update the table options.
+   * Updates the table options by applying a value or updater to the current
+   * resolved options and then merging them through `options.mergeOptions`.
    */
   setOptions: (newOptions: Updater<TableOptions<TFeatures, TData>>) => void;
 }

package/dist/core/table/coreTablesFeature.types.d.ts

@@ -54,9 +54,9 @@ interface TableOptions_Table<TFeatures extends TableFeatures, TData extends RowD
   /**
    * Optionally, provide your own external writable atoms for individual state slices.
    * When an atom is provided for a given slice, it takes precedence over `options.state[key]`
-   * and the internal base atom for that slice. Writes originating from the library are
-   * still routed through the internal base atom; consumers are responsible for
-   * mirroring changes back to their external atom via the corresponding `onXChange` callback.
+   * and the internal base atom for that slice. Feature state update APIs write through
+   * the corresponding atom updater, so external atoms are the preferred v9 ownership
+   * model for app-managed table state slices.
    */
   readonly atoms?: ExternalAtoms<TFeatures>;
   /**
@@ -68,8 +68,10 @@ interface TableOptions_Table<TFeatures extends TableFeatures, TData extends RowD
    */
   readonly data: ReadonlyArray<TData>;
   /**
-   * Use this option to optionally pass initial state to the table. This state will be used when resetting various table states either automatically by the table (eg. `options.autoResetPageIndex`) or via functions like `table.resetRowSelection()`. Most reset function allow you optionally pass a flag to reset to a blank/default state instead of the initial state.
-   * Table state will not be reset when this object changes, which also means that the initial state object does not need to be stable.
+   * Optionally provide starting values for registered table state slices.
+   * Feature reset APIs use this value by default, and many reset APIs accept
+   * `true` to reset to that feature's blank/default state instead. Changing this
+   * object later does not reset table state, so it does not need to be stable.
    */
   readonly initialState?: Partial<TableState<TFeatures>>;
   /**
@@ -81,7 +83,11 @@ interface TableOptions_Table<TFeatures extends TableFeatures, TData extends RowD
    */
   readonly meta?: TableMeta<TFeatures, TData>;
   /**
-   * Pass in individual self-managed state to the table.
+   * Optionally provide externally managed values for individual state slices.
+   *
+   * Pair each slice with its matching `on[State]Change` callback so table state
+   * updates can be persisted outside the table. External atoms take precedence
+   * over this option when both are provided for the same slice.
    */
   readonly state?: Partial<TableState<TFeatures>>;
 }
@@ -138,10 +144,9 @@ interface Table_CoreProperties<TFeatures extends TableFeatures, TData extends Ro
    */
   readonly options: TableOptions<TFeatures, TData>;
   /**
-   * Writable atom for table options. Only created when `createOptionsStore` is true
-   * on `coreReativityFeature` (e.g. Lit, Vue, Solid). React/Preact use `createOptionsStore: false`:
-   * options are held as plain data with a lightweight revision + subscribe source; there is
-   * no writable atom backing the full options object. Use {@link getTableOptionsStore} to subscribe.
+   * Writable atom for table options. Only created when `createOptionsStore` is
+   * true on the active core reactivity bindings. Adapters that opt out keep
+   * options as plain resolved data instead of backing them with an atom.
    */
   readonly optionsStore?: Atom<TableOptions<TFeatures, TData>> | undefined;
   /**
@@ -152,11 +157,16 @@ interface Table_CoreProperties<TFeatures extends TableFeatures, TData extends Ro
 }
 interface Table_Table<TFeatures extends TableFeatures, TData extends RowData> extends Table_CoreProperties<TFeatures, TData> {
   /**
-   * Call this function to reset the table state to the initial state.
+   * Resets the table's internal base atoms to `table.initialState`.
+   *
+   * Prefer feature-specific reset APIs, such as `resetPagination`, when a state
+   * slice may be owned by an external atom or needs that feature's blank/default
+   * reset behavior.
    */
   reset: () => void;
   /**
-   * This function can be used to update the table options.
+   * Updates the table options by applying a value or updater to the current
+   * resolved options and then merging them through `options.mergeOptions`.
    */
   setOptions: (newOptions: Updater<TableOptions<TFeatures, TData>>) => void;
 }

package/dist/core/table/coreTablesFeature.utils.cjs

@@ -1,6 +1,17 @@
 const require_utils = require('../../utils.cjs');
 
 //#region src/core/table/coreTablesFeature.utils.ts
+/**
+* Synchronizes externally controlled state slices into the table's base atoms.
+*
+* This keeps legacy `options.state` values reflected in the atom graph so
+* derived atoms, stores, and table APIs read a consistent snapshot.
+*
+* @example
+* ```ts
+* const value = table_syncExternalStateToBaseAtoms(table)
+* ```
+*/
 function table_syncExternalStateToBaseAtoms(table) {
 	const state = table.options.state;
 	if (!state) return;
@@ -13,12 +24,34 @@ function table_syncExternalStateToBaseAtoms(table) {
 		}
 	});
 }
+/**
+* Resets all internal table base atoms to `table.initialState`.
+*
+* This resets internally owned state slices in a single reactivity batch. Use
+* feature-specific reset APIs when a slice may be externally owned.
+*
+* @example
+* ```ts
+* table_reset(table)
+* ```
+*/
 function table_reset(table) {
 	const snap = require_utils.cloneState(table.initialState);
 	table._reactivity.batch(() => {
 		for (const key of Object.keys(snap)) table.baseAtoms[key].set(snap[key]);
 	});
 }
+/**
+* Merges new table options with the current resolved options.
+*
+* If `options.mergeOptions` is provided, it owns the merge behavior; otherwise
+* options are shallow-merged.
+*
+* @example
+* ```ts
+* const value = table_mergeOptions(table)
+* ```
+*/
 function table_mergeOptions(table, newOptions) {
 	if (table.options.mergeOptions) return table.options.mergeOptions(table.options, newOptions);
 	return {
@@ -26,6 +59,17 @@ function table_mergeOptions(table, newOptions) {
 		...newOptions
 	};
 }
+/**
+* Updates the table options object.
+*
+* The updater receives the current resolved options and the merged result is
+* immediately assigned to the table instance.
+*
+* @example
+* ```ts
+* table_setOptions(table, (old) => old)
+* ```
+*/
 function table_setOptions(table, updater) {
 	const mergedOptions = table_mergeOptions(table, require_utils.functionalUpdate(updater, table.options));
 	if (table.optionsStore) table.optionsStore.set(() => mergedOptions);

package/dist/core/table/coreTablesFeature.utils.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"coreTablesFeature.utils.cjs","names":["cloneState","functionalUpdate"],"sources":["../../../src/core/table/coreTablesFeature.utils.ts"],"sourcesContent":["import { cloneState, functionalUpdate } from '../../utils'\nimport type { RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { TableOptions } from '../../types/TableOptions'\n\nexport function table_syncExternalStateToBaseAtoms<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): void {\n  const state = table.options.state\n  if (!state) {\n    return\n  }\n\n  table._reactivity.batch(() => {\n    for (const key in state) {\n      const baseAtom = (table.baseAtoms as Record<string, any>)[key]\n      if (!baseAtom) {\n        continue\n      }\n\n      const externalState = state[key as keyof typeof state]\n      if (externalState !== baseAtom.get()) {\n        baseAtom.set(() => externalState)\n      }\n    }\n  })\n}\n\nexport function table_reset<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): void {\n  const snap = cloneState(table.initialState)\n  table._reactivity.batch(() => {\n    for (const key of Object.keys(snap) as Array<keyof typeof snap>) {\n      ;(table.baseAtoms as any)[key].set(snap[key] as any)\n    }\n  })\n}\n\nexport function table_mergeOptions<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  newOptions: TableOptions<TFeatures, TData>,\n) {\n  if (table.options.mergeOptions) {\n    return table.options.mergeOptions(table.options, newOptions)\n  }\n\n  return {\n    ...table.options,\n    ...newOptions,\n  }\n}\n\nexport function table_setOptions<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  updater: Updater<TableOptions<TFeatures, TData>>,\n): void {\n  const newOptions = functionalUpdate(updater, table.options)\n  const mergedOptions = table_mergeOptions(table, newOptions)\n  if (table.optionsStore) {\n    table.optionsStore.set(() => mergedOptions)\n  } else {\n    table.options = mergedOptions\n  }\n  table_syncExternalStateToBaseAtoms(table)\n}\n"],"mappings":";;;AAMA,SAAgB,mCAGd,OAA+C;CAC/C,MAAM,QAAQ,MAAM,QAAQ;AAC5B,KAAI,CAAC,MACH;AAGF,OAAM,YAAY,YAAY;AAC5B,OAAK,MAAM,OAAO,OAAO;GACvB,MAAM,WAAY,MAAM,UAAkC;AAC1D,OAAI,CAAC,SACH;GAGF,MAAM,gBAAgB,MAAM;AAC5B,OAAI,kBAAkB,SAAS,KAAK,CAClC,UAAS,UAAU,cAAc;;GAGrC;;AAGJ,SAAgB,YAGd,OAA+C;CAC/C,MAAM,OAAOA,yBAAW,MAAM,aAAa;AAC3C,OAAM,YAAY,YAAY;AAC5B,OAAK,MAAM,OAAO,OAAO,KAAK,KAAK,CAChC,CAAC,MAAM,UAAkB,KAAK,IAAI,KAAK,KAAY;GAEtD;;AAGJ,SAAgB,mBAId,OACA,YACA;AACA,KAAI,MAAM,QAAQ,aAChB,QAAO,MAAM,QAAQ,aAAa,MAAM,SAAS,WAAW;AAG9D,QAAO;EACL,GAAG,MAAM;EACT,GAAG;EACJ;;AAGH,SAAgB,iBAId,OACA,SACM;CAEN,MAAM,gBAAgB,mBAAmB,OADtBC,+BAAiB,SAAS,MAAM,QACO,CAAC;AAC3D,KAAI,MAAM,aACR,OAAM,aAAa,UAAU,cAAc;KAE3C,OAAM,UAAU;AAElB,oCAAmC,MAAM"}
+{"version":3,"file":"coreTablesFeature.utils.cjs","names":["cloneState","functionalUpdate"],"sources":["../../../src/core/table/coreTablesFeature.utils.ts"],"sourcesContent":["import { cloneState, functionalUpdate } from '../../utils'\nimport type { RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { TableOptions } from '../../types/TableOptions'\n\n/**\n * Synchronizes externally controlled state slices into the table's base atoms.\n *\n * This keeps legacy `options.state` values reflected in the atom graph so\n * derived atoms, stores, and table APIs read a consistent snapshot.\n *\n * @example\n * ```ts\n * const value = table_syncExternalStateToBaseAtoms(table)\n * ```\n */\nexport function table_syncExternalStateToBaseAtoms<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): void {\n  const state = table.options.state\n  if (!state) {\n    return\n  }\n\n  table._reactivity.batch(() => {\n    for (const key in state) {\n      const baseAtom = (table.baseAtoms as Record<string, any>)[key]\n      if (!baseAtom) {\n        continue\n      }\n\n      const externalState = state[key as keyof typeof state]\n      if (externalState !== baseAtom.get()) {\n        baseAtom.set(() => externalState)\n      }\n    }\n  })\n}\n\n/**\n * Resets all internal table base atoms to `table.initialState`.\n *\n * This resets internally owned state slices in a single reactivity batch. Use\n * feature-specific reset APIs when a slice may be externally owned.\n *\n * @example\n * ```ts\n * table_reset(table)\n * ```\n */\nexport function table_reset<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): void {\n  const snap = cloneState(table.initialState)\n  table._reactivity.batch(() => {\n    for (const key of Object.keys(snap) as Array<keyof typeof snap>) {\n      ;(table.baseAtoms as any)[key].set(snap[key] as any)\n    }\n  })\n}\n\n/**\n * Merges new table options with the current resolved options.\n *\n * If `options.mergeOptions` is provided, it owns the merge behavior; otherwise\n * options are shallow-merged.\n *\n * @example\n * ```ts\n * const value = table_mergeOptions(table)\n * ```\n */\nexport function table_mergeOptions<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  newOptions: TableOptions<TFeatures, TData>,\n) {\n  if (table.options.mergeOptions) {\n    return table.options.mergeOptions(table.options, newOptions)\n  }\n\n  return {\n    ...table.options,\n    ...newOptions,\n  }\n}\n\n/**\n * Updates the table options object.\n *\n * The updater receives the current resolved options and the merged result is\n * immediately assigned to the table instance.\n *\n * @example\n * ```ts\n * table_setOptions(table, (old) => old)\n * ```\n */\nexport function table_setOptions<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  updater: Updater<TableOptions<TFeatures, TData>>,\n): void {\n  const newOptions = functionalUpdate(updater, table.options)\n  const mergedOptions = table_mergeOptions(table, newOptions)\n  if (table.optionsStore) {\n    table.optionsStore.set(() => mergedOptions)\n  } else {\n    table.options = mergedOptions\n  }\n  table_syncExternalStateToBaseAtoms(table)\n}\n"],"mappings":";;;;;;;;;;;;;;AAiBA,SAAgB,mCAGd,OAA+C;CAC/C,MAAM,QAAQ,MAAM,QAAQ;CAC5B,IAAI,CAAC,OACH;CAGF,MAAM,YAAY,YAAY;EAC5B,KAAK,MAAM,OAAO,OAAO;GACvB,MAAM,WAAY,MAAM,UAAkC;GAC1D,IAAI,CAAC,UACH;GAGF,MAAM,gBAAgB,MAAM;GAC5B,IAAI,kBAAkB,SAAS,KAAK,EAClC,SAAS,UAAU,cAAc;;GAGrC;;;;;;;;;;;;;AAcJ,SAAgB,YAGd,OAA+C;CAC/C,MAAM,OAAOA,yBAAW,MAAM,aAAa;CAC3C,MAAM,YAAY,YAAY;EAC5B,KAAK,MAAM,OAAO,OAAO,KAAK,KAAK,EAChC,AAAC,MAAM,UAAkB,KAAK,IAAI,KAAK,KAAY;GAEtD;;;;;;;;;;;;;AAcJ,SAAgB,mBAId,OACA,YACA;CACA,IAAI,MAAM,QAAQ,cAChB,OAAO,MAAM,QAAQ,aAAa,MAAM,SAAS,WAAW;CAG9D,OAAO;EACL,GAAG,MAAM;EACT,GAAG;EACJ;;;;;;;;;;;;;AAcH,SAAgB,iBAId,OACA,SACM;CAEN,MAAM,gBAAgB,mBAAmB,OADtBC,+BAAiB,SAAS,MAAM,QACO,CAAC;CAC3D,IAAI,MAAM,cACR,MAAM,aAAa,UAAU,cAAc;MAE3C,MAAM,UAAU;CAElB,mCAAmC,MAAM"}

package/dist/core/table/coreTablesFeature.utils.d.cts

@@ -4,9 +4,53 @@ import { TableFeatures } from "../../types/TableFeatures.cjs";
 import { Table_Internal } from "../../types/Table.cjs";
 
 //#region src/core/table/coreTablesFeature.utils.d.ts
+/**
+ * Synchronizes externally controlled state slices into the table's base atoms.
+ *
+ * This keeps legacy `options.state` values reflected in the atom graph so
+ * derived atoms, stores, and table APIs read a consistent snapshot.
+ *
+ * @example
+ * ```ts
+ * const value = table_syncExternalStateToBaseAtoms(table)
+ * ```
+ */
 declare function table_syncExternalStateToBaseAtoms<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): void;
+/**
+ * Resets all internal table base atoms to `table.initialState`.
+ *
+ * This resets internally owned state slices in a single reactivity batch. Use
+ * feature-specific reset APIs when a slice may be externally owned.
+ *
+ * @example
+ * ```ts
+ * table_reset(table)
+ * ```
+ */
 declare function table_reset<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): void;
+/**
+ * Merges new table options with the current resolved options.
+ *
+ * If `options.mergeOptions` is provided, it owns the merge behavior; otherwise
+ * options are shallow-merged.
+ *
+ * @example
+ * ```ts
+ * const value = table_mergeOptions(table)
+ * ```
+ */
 declare function table_mergeOptions<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, newOptions: TableOptions<TFeatures, TData>): TableOptions<TFeatures, TData>;
+/**
+ * Updates the table options object.
+ *
+ * The updater receives the current resolved options and the merged result is
+ * immediately assigned to the table instance.
+ *
+ * @example
+ * ```ts
+ * table_setOptions(table, (old) => old)
+ * ```
+ */
 declare function table_setOptions<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<TableOptions<TFeatures, TData>>): void;
 //#endregion
 export { table_mergeOptions, table_reset, table_setOptions, table_syncExternalStateToBaseAtoms };

package/dist/core/table/coreTablesFeature.utils.d.ts

@@ -4,9 +4,53 @@ import { TableFeatures } from "../../types/TableFeatures.js";
 import { Table_Internal } from "../../types/Table.js";
 
 //#region src/core/table/coreTablesFeature.utils.d.ts
+/**
+ * Synchronizes externally controlled state slices into the table's base atoms.
+ *
+ * This keeps legacy `options.state` values reflected in the atom graph so
+ * derived atoms, stores, and table APIs read a consistent snapshot.
+ *
+ * @example
+ * ```ts
+ * const value = table_syncExternalStateToBaseAtoms(table)
+ * ```
+ */
 declare function table_syncExternalStateToBaseAtoms<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): void;
+/**
+ * Resets all internal table base atoms to `table.initialState`.
+ *
+ * This resets internally owned state slices in a single reactivity batch. Use
+ * feature-specific reset APIs when a slice may be externally owned.
+ *
+ * @example
+ * ```ts
+ * table_reset(table)
+ * ```
+ */
 declare function table_reset<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): void;
+/**
+ * Merges new table options with the current resolved options.
+ *
+ * If `options.mergeOptions` is provided, it owns the merge behavior; otherwise
+ * options are shallow-merged.
+ *
+ * @example
+ * ```ts
+ * const value = table_mergeOptions(table)
+ * ```
+ */
 declare function table_mergeOptions<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, newOptions: TableOptions<TFeatures, TData>): TableOptions<TFeatures, TData>;
+/**
+ * Updates the table options object.
+ *
+ * The updater receives the current resolved options and the merged result is
+ * immediately assigned to the table instance.
+ *
+ * @example
+ * ```ts
+ * table_setOptions(table, (old) => old)
+ * ```
+ */
 declare function table_setOptions<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<TableOptions<TFeatures, TData>>): void;
 //#endregion
 export { table_mergeOptions, table_reset, table_setOptions, table_syncExternalStateToBaseAtoms };

package/dist/core/table/coreTablesFeature.utils.js

@@ -1,6 +1,17 @@
 import { cloneState, functionalUpdate } from "../../utils.js";
 
 //#region src/core/table/coreTablesFeature.utils.ts
+/**
+* Synchronizes externally controlled state slices into the table's base atoms.
+*
+* This keeps legacy `options.state` values reflected in the atom graph so
+* derived atoms, stores, and table APIs read a consistent snapshot.
+*
+* @example
+* ```ts
+* const value = table_syncExternalStateToBaseAtoms(table)
+* ```
+*/
 function table_syncExternalStateToBaseAtoms(table) {
 	const state = table.options.state;
 	if (!state) return;
@@ -13,12 +24,34 @@ function table_syncExternalStateToBaseAtoms(table) {
 		}
 	});
 }
+/**
+* Resets all internal table base atoms to `table.initialState`.
+*
+* This resets internally owned state slices in a single reactivity batch. Use
+* feature-specific reset APIs when a slice may be externally owned.
+*
+* @example
+* ```ts
+* table_reset(table)
+* ```
+*/
 function table_reset(table) {
 	const snap = cloneState(table.initialState);
 	table._reactivity.batch(() => {
 		for (const key of Object.keys(snap)) table.baseAtoms[key].set(snap[key]);
 	});
 }
+/**
+* Merges new table options with the current resolved options.
+*
+* If `options.mergeOptions` is provided, it owns the merge behavior; otherwise
+* options are shallow-merged.
+*
+* @example
+* ```ts
+* const value = table_mergeOptions(table)
+* ```
+*/
 function table_mergeOptions(table, newOptions) {
 	if (table.options.mergeOptions) return table.options.mergeOptions(table.options, newOptions);
 	return {
@@ -26,6 +59,17 @@ function table_mergeOptions(table, newOptions) {
 		...newOptions
 	};
 }
+/**
+* Updates the table options object.
+*
+* The updater receives the current resolved options and the merged result is
+* immediately assigned to the table instance.
+*
+* @example
+* ```ts
+* table_setOptions(table, (old) => old)
+* ```
+*/
 function table_setOptions(table, updater) {
 	const mergedOptions = table_mergeOptions(table, functionalUpdate(updater, table.options));
 	if (table.optionsStore) table.optionsStore.set(() => mergedOptions);

package/dist/core/table/coreTablesFeature.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"coreTablesFeature.utils.js","names":[],"sources":["../../../src/core/table/coreTablesFeature.utils.ts"],"sourcesContent":["import { cloneState, functionalUpdate } from '../../utils'\nimport type { RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { TableOptions } from '../../types/TableOptions'\n\nexport function table_syncExternalStateToBaseAtoms<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): void {\n  const state = table.options.state\n  if (!state) {\n    return\n  }\n\n  table._reactivity.batch(() => {\n    for (const key in state) {\n      const baseAtom = (table.baseAtoms as Record<string, any>)[key]\n      if (!baseAtom) {\n        continue\n      }\n\n      const externalState = state[key as keyof typeof state]\n      if (externalState !== baseAtom.get()) {\n        baseAtom.set(() => externalState)\n      }\n    }\n  })\n}\n\nexport function table_reset<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): void {\n  const snap = cloneState(table.initialState)\n  table._reactivity.batch(() => {\n    for (const key of Object.keys(snap) as Array<keyof typeof snap>) {\n      ;(table.baseAtoms as any)[key].set(snap[key] as any)\n    }\n  })\n}\n\nexport function table_mergeOptions<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  newOptions: TableOptions<TFeatures, TData>,\n) {\n  if (table.options.mergeOptions) {\n    return table.options.mergeOptions(table.options, newOptions)\n  }\n\n  return {\n    ...table.options,\n    ...newOptions,\n  }\n}\n\nexport function table_setOptions<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  updater: Updater<TableOptions<TFeatures, TData>>,\n): void {\n  const newOptions = functionalUpdate(updater, table.options)\n  const mergedOptions = table_mergeOptions(table, newOptions)\n  if (table.optionsStore) {\n    table.optionsStore.set(() => mergedOptions)\n  } else {\n    table.options = mergedOptions\n  }\n  table_syncExternalStateToBaseAtoms(table)\n}\n"],"mappings":";;;AAMA,SAAgB,mCAGd,OAA+C;CAC/C,MAAM,QAAQ,MAAM,QAAQ;AAC5B,KAAI,CAAC,MACH;AAGF,OAAM,YAAY,YAAY;AAC5B,OAAK,MAAM,OAAO,OAAO;GACvB,MAAM,WAAY,MAAM,UAAkC;AAC1D,OAAI,CAAC,SACH;GAGF,MAAM,gBAAgB,MAAM;AAC5B,OAAI,kBAAkB,SAAS,KAAK,CAClC,UAAS,UAAU,cAAc;;GAGrC;;AAGJ,SAAgB,YAGd,OAA+C;CAC/C,MAAM,OAAO,WAAW,MAAM,aAAa;AAC3C,OAAM,YAAY,YAAY;AAC5B,OAAK,MAAM,OAAO,OAAO,KAAK,KAAK,CAChC,CAAC,MAAM,UAAkB,KAAK,IAAI,KAAK,KAAY;GAEtD;;AAGJ,SAAgB,mBAId,OACA,YACA;AACA,KAAI,MAAM,QAAQ,aAChB,QAAO,MAAM,QAAQ,aAAa,MAAM,SAAS,WAAW;AAG9D,QAAO;EACL,GAAG,MAAM;EACT,GAAG;EACJ;;AAGH,SAAgB,iBAId,OACA,SACM;CAEN,MAAM,gBAAgB,mBAAmB,OADtB,iBAAiB,SAAS,MAAM,QACO,CAAC;AAC3D,KAAI,MAAM,aACR,OAAM,aAAa,UAAU,cAAc;KAE3C,OAAM,UAAU;AAElB,oCAAmC,MAAM"}
+{"version":3,"file":"coreTablesFeature.utils.js","names":[],"sources":["../../../src/core/table/coreTablesFeature.utils.ts"],"sourcesContent":["import { cloneState, functionalUpdate } from '../../utils'\nimport type { RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { TableOptions } from '../../types/TableOptions'\n\n/**\n * Synchronizes externally controlled state slices into the table's base atoms.\n *\n * This keeps legacy `options.state` values reflected in the atom graph so\n * derived atoms, stores, and table APIs read a consistent snapshot.\n *\n * @example\n * ```ts\n * const value = table_syncExternalStateToBaseAtoms(table)\n * ```\n */\nexport function table_syncExternalStateToBaseAtoms<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): void {\n  const state = table.options.state\n  if (!state) {\n    return\n  }\n\n  table._reactivity.batch(() => {\n    for (const key in state) {\n      const baseAtom = (table.baseAtoms as Record<string, any>)[key]\n      if (!baseAtom) {\n        continue\n      }\n\n      const externalState = state[key as keyof typeof state]\n      if (externalState !== baseAtom.get()) {\n        baseAtom.set(() => externalState)\n      }\n    }\n  })\n}\n\n/**\n * Resets all internal table base atoms to `table.initialState`.\n *\n * This resets internally owned state slices in a single reactivity batch. Use\n * feature-specific reset APIs when a slice may be externally owned.\n *\n * @example\n * ```ts\n * table_reset(table)\n * ```\n */\nexport function table_reset<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): void {\n  const snap = cloneState(table.initialState)\n  table._reactivity.batch(() => {\n    for (const key of Object.keys(snap) as Array<keyof typeof snap>) {\n      ;(table.baseAtoms as any)[key].set(snap[key] as any)\n    }\n  })\n}\n\n/**\n * Merges new table options with the current resolved options.\n *\n * If `options.mergeOptions` is provided, it owns the merge behavior; otherwise\n * options are shallow-merged.\n *\n * @example\n * ```ts\n * const value = table_mergeOptions(table)\n * ```\n */\nexport function table_mergeOptions<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  newOptions: TableOptions<TFeatures, TData>,\n) {\n  if (table.options.mergeOptions) {\n    return table.options.mergeOptions(table.options, newOptions)\n  }\n\n  return {\n    ...table.options,\n    ...newOptions,\n  }\n}\n\n/**\n * Updates the table options object.\n *\n * The updater receives the current resolved options and the merged result is\n * immediately assigned to the table instance.\n *\n * @example\n * ```ts\n * table_setOptions(table, (old) => old)\n * ```\n */\nexport function table_setOptions<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  updater: Updater<TableOptions<TFeatures, TData>>,\n): void {\n  const newOptions = functionalUpdate(updater, table.options)\n  const mergedOptions = table_mergeOptions(table, newOptions)\n  if (table.optionsStore) {\n    table.optionsStore.set(() => mergedOptions)\n  } else {\n    table.options = mergedOptions\n  }\n  table_syncExternalStateToBaseAtoms(table)\n}\n"],"mappings":";;;;;;;;;;;;;;AAiBA,SAAgB,mCAGd,OAA+C;CAC/C,MAAM,QAAQ,MAAM,QAAQ;CAC5B,IAAI,CAAC,OACH;CAGF,MAAM,YAAY,YAAY;EAC5B,KAAK,MAAM,OAAO,OAAO;GACvB,MAAM,WAAY,MAAM,UAAkC;GAC1D,IAAI,CAAC,UACH;GAGF,MAAM,gBAAgB,MAAM;GAC5B,IAAI,kBAAkB,SAAS,KAAK,EAClC,SAAS,UAAU,cAAc;;GAGrC;;;;;;;;;;;;;AAcJ,SAAgB,YAGd,OAA+C;CAC/C,MAAM,OAAO,WAAW,MAAM,aAAa;CAC3C,MAAM,YAAY,YAAY;EAC5B,KAAK,MAAM,OAAO,OAAO,KAAK,KAAK,EAChC,AAAC,MAAM,UAAkB,KAAK,IAAI,KAAK,KAAY;GAEtD;;;;;;;;;;;;;AAcJ,SAAgB,mBAId,OACA,YACA;CACA,IAAI,MAAM,QAAQ,cAChB,OAAO,MAAM,QAAQ,aAAa,MAAM,SAAS,WAAW;CAG9D,OAAO;EACL,GAAG,MAAM;EACT,GAAG;EACJ;;;;;;;;;;;;;AAcH,SAAgB,iBAId,OACA,SACM;CAEN,MAAM,gBAAgB,mBAAmB,OADtB,iBAAiB,SAAS,MAAM,QACO,CAAC;CAC3D,IAAI,MAAM,cACR,MAAM,aAAa,UAAU,cAAc;MAE3C,MAAM,UAAU;CAElB,mCAAmC,MAAM"}

package/dist/features/column-faceting/columnFacetingFeature.cjs

@@ -2,6 +2,11 @@ const require_utils = require('../../utils.cjs');
 const require_columnFacetingFeature_utils = require('./columnFacetingFeature.utils.cjs');
 
 //#region src/features/column-faceting/columnFacetingFeature.ts
+/**
+* Creates the stock column faceting feature.
+*
+* The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+*/
 function constructColumnFacetingFeature() {
 	return {
 		assignColumnPrototype: (prototype, table) => {
@@ -55,7 +60,10 @@ function constructColumnFacetingFeature() {
 	};
 }
 /**
-* The Column Faceting feature adds column faceting APIs to the column objects.
+* The stock column faceting feature.
+*
+* Register this feature to add faceted row model, unique value, and min/max
+* helpers for column and global filter UIs.
 */
 const columnFacetingFeature = constructColumnFacetingFeature();
 

package/dist/features/column-faceting/columnFacetingFeature.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"columnFacetingFeature.cjs","names":["column_getFacetedRowModel","callMemoOrStaticFn","column_getFacetedMinMaxValues","column_getFacetedUniqueValues","table_getGlobalFacetedRowModel","table_getGlobalFacetedMinMaxValues","table_getGlobalFacetedUniqueValues"],"sources":["../../../src/features/column-faceting/columnFacetingFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  callMemoOrStaticFn,\n} from '../../utils'\nimport {\n  column_getFacetedMinMaxValues,\n  column_getFacetedRowModel,\n  column_getFacetedUniqueValues,\n  table_getGlobalFacetedMinMaxValues,\n  table_getGlobalFacetedRowModel,\n  table_getGlobalFacetedUniqueValues,\n} from './columnFacetingFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\nimport type { Column_Internal } from '../../types/Column'\n// import type {\n//   CachedRowModel_Faceted,\n//   Column_ColumnFaceting,\n//   CreateRowModel_Faceted,\n// } from './columnFacetingFeature.types'\n\nexport interface ColumnFacetingFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // CachedRowModel: CachedRowModel_Faceted<TFeatures, TData>\n  // Column: Column_ColumnFaceting<TFeatures, TData>\n  // CreateRowModels: CreateRowModel_Faceted<TFeatures, TData>\n}\n\nexport function constructColumnFacetingFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<ColumnFacetingFeatureConstructors<TFeatures, TData>> {\n  return {\n    assignColumnPrototype: (prototype, table) => {\n      assignPrototypeAPIs('columnFacetingFeature', prototype, table, {\n        column_getFacetedRowModel: {\n          memoDeps: () => [\n            table.getPreFilteredRowModel().rows,\n            table.atoms.columnFilters?.get(),\n            table.atoms.globalFilter?.get(),\n            table.getFilteredRowModel().rows,\n          ],\n          fn: (column) => column_getFacetedRowModel(column, column.table),\n        },\n        column_getFacetedMinMaxValues: {\n          memoDeps: (column: Column_Internal<TFeatures, TData>) => [\n            callMemoOrStaticFn(\n              column,\n              'getFacetedRowModel',\n              column_getFacetedRowModel,\n              column.table,\n            ).flatRows,\n          ],\n          fn: (column) => column_getFacetedMinMaxValues(column, column.table),\n        },\n        column_getFacetedUniqueValues: {\n          memoDeps: (column: Column_Internal<TFeatures, TData>) => [\n            callMemoOrStaticFn(\n              column,\n              'getFacetedRowModel',\n              column_getFacetedRowModel,\n              column.table,\n            ).flatRows,\n          ],\n          fn: (column) => column_getFacetedUniqueValues(column, column.table),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('columnFacetingFeature', table, {\n        table_getGlobalFacetedRowModel: {\n          memoDeps: () => [\n            table.getPreFilteredRowModel().rows,\n            table.atoms.columnFilters?.get(),\n            table.atoms.globalFilter?.get(),\n            table.getFilteredRowModel().rows,\n          ],\n          fn: () => table_getGlobalFacetedRowModel(table),\n        },\n        table_getGlobalFacetedMinMaxValues: {\n          memoDeps: () => [\n            callMemoOrStaticFn(\n              table,\n              'getGlobalFacetedRowModel',\n              table_getGlobalFacetedRowModel,\n            ).flatRows,\n          ],\n          fn: () => table_getGlobalFacetedMinMaxValues(table),\n        },\n        table_getGlobalFacetedUniqueValues: {\n          memoDeps: () => [\n            callMemoOrStaticFn(\n              table,\n              'getGlobalFacetedRowModel',\n              table_getGlobalFacetedRowModel,\n            ).flatRows,\n          ],\n          fn: () => table_getGlobalFacetedUniqueValues(table),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The Column Faceting feature adds column faceting APIs to the column objects.\n */\nexport const columnFacetingFeature = constructColumnFacetingFeature()\n"],"mappings":";;;;AA+BA,SAAgB,iCAGuD;AACrE,QAAO;EACL,wBAAwB,WAAW,UAAU;AAC3C,qCAAoB,yBAAyB,WAAW,OAAO;IAC7D,2BAA2B;KACzB,gBAAgB;;;OACd,MAAM,wBAAwB,CAAC;gCAC/B,MAAM,MAAM,6FAAe,KAAK;gCAChC,MAAM,MAAM,4FAAc,KAAK;OAC/B,MAAM,qBAAqB,CAAC;OAC7B;;KACD,KAAK,WAAWA,8DAA0B,QAAQ,OAAO,MAAM;KAChE;IACD,+BAA+B;KAC7B,WAAW,WAA8C,CACvDC,iCACE,QACA,sBACAD,+DACA,OAAO,MACR,CAAC,SACH;KACD,KAAK,WAAWE,kEAA8B,QAAQ,OAAO,MAAM;KACpE;IACD,+BAA+B;KAC7B,WAAW,WAA8C,CACvDD,iCACE,QACA,sBACAD,+DACA,OAAO,MACR,CAAC,SACH;KACD,KAAK,WAAWG,kEAA8B,QAAQ,OAAO,MAAM;KACpE;IACF,CAAC;;EAGJ,qBAAqB,UAAU;AAC7B,iCAAgB,yBAAyB,OAAO;IAC9C,gCAAgC;KAC9B,gBAAgB;;;OACd,MAAM,wBAAwB,CAAC;iCAC/B,MAAM,MAAM,+FAAe,KAAK;iCAChC,MAAM,MAAM,8FAAc,KAAK;OAC/B,MAAM,qBAAqB,CAAC;OAC7B;;KACD,UAAUC,mEAA+B,MAAM;KAChD;IACD,oCAAoC;KAClC,gBAAgB,CACdH,iCACE,OACA,4BACAG,mEACD,CAAC,SACH;KACD,UAAUC,uEAAmC,MAAM;KACpD;IACD,oCAAoC;KAClC,gBAAgB,CACdJ,iCACE,OACA,4BACAG,mEACD,CAAC,SACH;KACD,UAAUE,uEAAmC,MAAM;KACpD;IACF,CAAC;;EAEL;;;;;AAMH,MAAa,wBAAwB,gCAAgC"}
+{"version":3,"file":"columnFacetingFeature.cjs","names":["column_getFacetedRowModel","callMemoOrStaticFn","column_getFacetedMinMaxValues","column_getFacetedUniqueValues","table_getGlobalFacetedRowModel","table_getGlobalFacetedMinMaxValues","table_getGlobalFacetedUniqueValues"],"sources":["../../../src/features/column-faceting/columnFacetingFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  callMemoOrStaticFn,\n} from '../../utils'\nimport {\n  column_getFacetedMinMaxValues,\n  column_getFacetedRowModel,\n  column_getFacetedUniqueValues,\n  table_getGlobalFacetedMinMaxValues,\n  table_getGlobalFacetedRowModel,\n  table_getGlobalFacetedUniqueValues,\n} from './columnFacetingFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\nimport type { Column_Internal } from '../../types/Column'\n// import type {\n//   CachedRowModel_Faceted,\n//   Column_ColumnFaceting,\n//   CreateRowModel_Faceted,\n// } from './columnFacetingFeature.types'\n\nexport interface ColumnFacetingFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // CachedRowModel: CachedRowModel_Faceted<TFeatures, TData>\n  // Column: Column_ColumnFaceting<TFeatures, TData>\n  // CreateRowModels: CreateRowModel_Faceted<TFeatures, TData>\n}\n\n/**\n * Creates the stock column faceting feature.\n *\n * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.\n */\nexport function constructColumnFacetingFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<ColumnFacetingFeatureConstructors<TFeatures, TData>> {\n  return {\n    assignColumnPrototype: (prototype, table) => {\n      assignPrototypeAPIs('columnFacetingFeature', prototype, table, {\n        column_getFacetedRowModel: {\n          memoDeps: () => [\n            table.getPreFilteredRowModel().rows,\n            table.atoms.columnFilters?.get(),\n            table.atoms.globalFilter?.get(),\n            table.getFilteredRowModel().rows,\n          ],\n          fn: (column) => column_getFacetedRowModel(column, column.table),\n        },\n        column_getFacetedMinMaxValues: {\n          memoDeps: (column: Column_Internal<TFeatures, TData>) => [\n            callMemoOrStaticFn(\n              column,\n              'getFacetedRowModel',\n              column_getFacetedRowModel,\n              column.table,\n            ).flatRows,\n          ],\n          fn: (column) => column_getFacetedMinMaxValues(column, column.table),\n        },\n        column_getFacetedUniqueValues: {\n          memoDeps: (column: Column_Internal<TFeatures, TData>) => [\n            callMemoOrStaticFn(\n              column,\n              'getFacetedRowModel',\n              column_getFacetedRowModel,\n              column.table,\n            ).flatRows,\n          ],\n          fn: (column) => column_getFacetedUniqueValues(column, column.table),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('columnFacetingFeature', table, {\n        table_getGlobalFacetedRowModel: {\n          memoDeps: () => [\n            table.getPreFilteredRowModel().rows,\n            table.atoms.columnFilters?.get(),\n            table.atoms.globalFilter?.get(),\n            table.getFilteredRowModel().rows,\n          ],\n          fn: () => table_getGlobalFacetedRowModel(table),\n        },\n        table_getGlobalFacetedMinMaxValues: {\n          memoDeps: () => [\n            callMemoOrStaticFn(\n              table,\n              'getGlobalFacetedRowModel',\n              table_getGlobalFacetedRowModel,\n            ).flatRows,\n          ],\n          fn: () => table_getGlobalFacetedMinMaxValues(table),\n        },\n        table_getGlobalFacetedUniqueValues: {\n          memoDeps: () => [\n            callMemoOrStaticFn(\n              table,\n              'getGlobalFacetedRowModel',\n              table_getGlobalFacetedRowModel,\n            ).flatRows,\n          ],\n          fn: () => table_getGlobalFacetedUniqueValues(table),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The stock column faceting feature.\n *\n * Register this feature to add faceted row model, unique value, and min/max\n * helpers for column and global filter UIs.\n */\nexport const columnFacetingFeature = constructColumnFacetingFeature()\n"],"mappings":";;;;;;;;;AAoCA,SAAgB,iCAGuD;CACrE,OAAO;EACL,wBAAwB,WAAW,UAAU;GAC3C,kCAAoB,yBAAyB,WAAW,OAAO;IAC7D,2BAA2B;KACzB,gBAAgB;;;OACd,MAAM,wBAAwB,CAAC;gCAC/B,MAAM,MAAM,6FAAe,KAAK;gCAChC,MAAM,MAAM,4FAAc,KAAK;OAC/B,MAAM,qBAAqB,CAAC;OAC7B;;KACD,KAAK,WAAWA,8DAA0B,QAAQ,OAAO,MAAM;KAChE;IACD,+BAA+B;KAC7B,WAAW,WAA8C,CACvDC,iCACE,QACA,sBACAD,+DACA,OAAO,MACR,CAAC,SACH;KACD,KAAK,WAAWE,kEAA8B,QAAQ,OAAO,MAAM;KACpE;IACD,+BAA+B;KAC7B,WAAW,WAA8C,CACvDD,iCACE,QACA,sBACAD,+DACA,OAAO,MACR,CAAC,SACH;KACD,KAAK,WAAWG,kEAA8B,QAAQ,OAAO,MAAM;KACpE;IACF,CAAC;;EAGJ,qBAAqB,UAAU;GAC7B,8BAAgB,yBAAyB,OAAO;IAC9C,gCAAgC;KAC9B,gBAAgB;;;OACd,MAAM,wBAAwB,CAAC;iCAC/B,MAAM,MAAM,+FAAe,KAAK;iCAChC,MAAM,MAAM,8FAAc,KAAK;OAC/B,MAAM,qBAAqB,CAAC;OAC7B;;KACD,UAAUC,mEAA+B,MAAM;KAChD;IACD,oCAAoC;KAClC,gBAAgB,CACdH,iCACE,OACA,4BACAG,mEACD,CAAC,SACH;KACD,UAAUC,uEAAmC,MAAM;KACpD;IACD,oCAAoC;KAClC,gBAAgB,CACdJ,iCACE,OACA,4BACAG,mEACD,CAAC,SACH;KACD,UAAUE,uEAAmC,MAAM;KACpD;IACF,CAAC;;EAEL;;;;;;;;AASH,MAAa,wBAAwB,gCAAgC"}

package/dist/features/column-faceting/columnFacetingFeature.d.cts

@@ -3,9 +3,17 @@ import { TableFeature, TableFeatures } from "../../types/TableFeatures.cjs";
 
 //#region src/features/column-faceting/columnFacetingFeature.d.ts
 interface ColumnFacetingFeatureConstructors<TFeatures extends TableFeatures, TData extends RowData> {}
+/**
+ * Creates the stock column faceting feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 declare function constructColumnFacetingFeature<TFeatures extends TableFeatures, TData extends RowData>(): TableFeature<ColumnFacetingFeatureConstructors<TFeatures, TData>>;
 /**
- * The Column Faceting feature adds column faceting APIs to the column objects.
+ * The stock column faceting feature.
+ *
+ * Register this feature to add faceted row model, unique value, and min/max
+ * helpers for column and global filter UIs.
  */
 declare const columnFacetingFeature: TableFeature<ColumnFacetingFeatureConstructors<TableFeatures, RowData>>;
 //#endregion

package/dist/features/column-faceting/columnFacetingFeature.d.ts

@@ -3,9 +3,17 @@ import { TableFeature, TableFeatures } from "../../types/TableFeatures.js";
 
 //#region src/features/column-faceting/columnFacetingFeature.d.ts
 interface ColumnFacetingFeatureConstructors<TFeatures extends TableFeatures, TData extends RowData> {}
+/**
+ * Creates the stock column faceting feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 declare function constructColumnFacetingFeature<TFeatures extends TableFeatures, TData extends RowData>(): TableFeature<ColumnFacetingFeatureConstructors<TFeatures, TData>>;
 /**
- * The Column Faceting feature adds column faceting APIs to the column objects.
+ * The stock column faceting feature.
+ *
+ * Register this feature to add faceted row model, unique value, and min/max
+ * helpers for column and global filter UIs.
  */
 declare const columnFacetingFeature: TableFeature<ColumnFacetingFeatureConstructors<TableFeatures, RowData>>;
 //#endregion

package/dist/features/column-faceting/columnFacetingFeature.js

@@ -2,6 +2,11 @@ import { assignPrototypeAPIs, assignTableAPIs, callMemoOrStaticFn } from "../../
 import { column_getFacetedMinMaxValues, column_getFacetedRowModel, column_getFacetedUniqueValues, table_getGlobalFacetedMinMaxValues, table_getGlobalFacetedRowModel, table_getGlobalFacetedUniqueValues } from "./columnFacetingFeature.utils.js";
 
 //#region src/features/column-faceting/columnFacetingFeature.ts
+/**
+* Creates the stock column faceting feature.
+*
+* The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+*/
 function constructColumnFacetingFeature() {
 	return {
 		assignColumnPrototype: (prototype, table) => {
@@ -55,7 +60,10 @@ function constructColumnFacetingFeature() {
 	};
 }
 /**
-* The Column Faceting feature adds column faceting APIs to the column objects.
+* The stock column faceting feature.
+*
+* Register this feature to add faceted row model, unique value, and min/max
+* helpers for column and global filter UIs.
 */
 const columnFacetingFeature = constructColumnFacetingFeature();
 

package/dist/features/column-faceting/columnFacetingFeature.js.map

@@ -1 +1 @@
-{"version":3,"file":"columnFacetingFeature.js","names":[],"sources":["../../../src/features/column-faceting/columnFacetingFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  callMemoOrStaticFn,\n} from '../../utils'\nimport {\n  column_getFacetedMinMaxValues,\n  column_getFacetedRowModel,\n  column_getFacetedUniqueValues,\n  table_getGlobalFacetedMinMaxValues,\n  table_getGlobalFacetedRowModel,\n  table_getGlobalFacetedUniqueValues,\n} from './columnFacetingFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\nimport type { Column_Internal } from '../../types/Column'\n// import type {\n//   CachedRowModel_Faceted,\n//   Column_ColumnFaceting,\n//   CreateRowModel_Faceted,\n// } from './columnFacetingFeature.types'\n\nexport interface ColumnFacetingFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // CachedRowModel: CachedRowModel_Faceted<TFeatures, TData>\n  // Column: Column_ColumnFaceting<TFeatures, TData>\n  // CreateRowModels: CreateRowModel_Faceted<TFeatures, TData>\n}\n\nexport function constructColumnFacetingFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<ColumnFacetingFeatureConstructors<TFeatures, TData>> {\n  return {\n    assignColumnPrototype: (prototype, table) => {\n      assignPrototypeAPIs('columnFacetingFeature', prototype, table, {\n        column_getFacetedRowModel: {\n          memoDeps: () => [\n            table.getPreFilteredRowModel().rows,\n            table.atoms.columnFilters?.get(),\n            table.atoms.globalFilter?.get(),\n            table.getFilteredRowModel().rows,\n          ],\n          fn: (column) => column_getFacetedRowModel(column, column.table),\n        },\n        column_getFacetedMinMaxValues: {\n          memoDeps: (column: Column_Internal<TFeatures, TData>) => [\n            callMemoOrStaticFn(\n              column,\n              'getFacetedRowModel',\n              column_getFacetedRowModel,\n              column.table,\n            ).flatRows,\n          ],\n          fn: (column) => column_getFacetedMinMaxValues(column, column.table),\n        },\n        column_getFacetedUniqueValues: {\n          memoDeps: (column: Column_Internal<TFeatures, TData>) => [\n            callMemoOrStaticFn(\n              column,\n              'getFacetedRowModel',\n              column_getFacetedRowModel,\n              column.table,\n            ).flatRows,\n          ],\n          fn: (column) => column_getFacetedUniqueValues(column, column.table),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('columnFacetingFeature', table, {\n        table_getGlobalFacetedRowModel: {\n          memoDeps: () => [\n            table.getPreFilteredRowModel().rows,\n            table.atoms.columnFilters?.get(),\n            table.atoms.globalFilter?.get(),\n            table.getFilteredRowModel().rows,\n          ],\n          fn: () => table_getGlobalFacetedRowModel(table),\n        },\n        table_getGlobalFacetedMinMaxValues: {\n          memoDeps: () => [\n            callMemoOrStaticFn(\n              table,\n              'getGlobalFacetedRowModel',\n              table_getGlobalFacetedRowModel,\n            ).flatRows,\n          ],\n          fn: () => table_getGlobalFacetedMinMaxValues(table),\n        },\n        table_getGlobalFacetedUniqueValues: {\n          memoDeps: () => [\n            callMemoOrStaticFn(\n              table,\n              'getGlobalFacetedRowModel',\n              table_getGlobalFacetedRowModel,\n            ).flatRows,\n          ],\n          fn: () => table_getGlobalFacetedUniqueValues(table),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The Column Faceting feature adds column faceting APIs to the column objects.\n */\nexport const columnFacetingFeature = constructColumnFacetingFeature()\n"],"mappings":";;;;AA+BA,SAAgB,iCAGuD;AACrE,QAAO;EACL,wBAAwB,WAAW,UAAU;AAC3C,uBAAoB,yBAAyB,WAAW,OAAO;IAC7D,2BAA2B;KACzB,gBAAgB;;;OACd,MAAM,wBAAwB,CAAC;gCAC/B,MAAM,MAAM,6FAAe,KAAK;gCAChC,MAAM,MAAM,4FAAc,KAAK;OAC/B,MAAM,qBAAqB,CAAC;OAC7B;;KACD,KAAK,WAAW,0BAA0B,QAAQ,OAAO,MAAM;KAChE;IACD,+BAA+B;KAC7B,WAAW,WAA8C,CACvD,mBACE,QACA,sBACA,2BACA,OAAO,MACR,CAAC,SACH;KACD,KAAK,WAAW,8BAA8B,QAAQ,OAAO,MAAM;KACpE;IACD,+BAA+B;KAC7B,WAAW,WAA8C,CACvD,mBACE,QACA,sBACA,2BACA,OAAO,MACR,CAAC,SACH;KACD,KAAK,WAAW,8BAA8B,QAAQ,OAAO,MAAM;KACpE;IACF,CAAC;;EAGJ,qBAAqB,UAAU;AAC7B,mBAAgB,yBAAyB,OAAO;IAC9C,gCAAgC;KAC9B,gBAAgB;;;OACd,MAAM,wBAAwB,CAAC;iCAC/B,MAAM,MAAM,+FAAe,KAAK;iCAChC,MAAM,MAAM,8FAAc,KAAK;OAC/B,MAAM,qBAAqB,CAAC;OAC7B;;KACD,UAAU,+BAA+B,MAAM;KAChD;IACD,oCAAoC;KAClC,gBAAgB,CACd,mBACE,OACA,4BACA,+BACD,CAAC,SACH;KACD,UAAU,mCAAmC,MAAM;KACpD;IACD,oCAAoC;KAClC,gBAAgB,CACd,mBACE,OACA,4BACA,+BACD,CAAC,SACH;KACD,UAAU,mCAAmC,MAAM;KACpD;IACF,CAAC;;EAEL;;;;;AAMH,MAAa,wBAAwB,gCAAgC"}
+{"version":3,"file":"columnFacetingFeature.js","names":[],"sources":["../../../src/features/column-faceting/columnFacetingFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  callMemoOrStaticFn,\n} from '../../utils'\nimport {\n  column_getFacetedMinMaxValues,\n  column_getFacetedRowModel,\n  column_getFacetedUniqueValues,\n  table_getGlobalFacetedMinMaxValues,\n  table_getGlobalFacetedRowModel,\n  table_getGlobalFacetedUniqueValues,\n} from './columnFacetingFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\nimport type { Column_Internal } from '../../types/Column'\n// import type {\n//   CachedRowModel_Faceted,\n//   Column_ColumnFaceting,\n//   CreateRowModel_Faceted,\n// } from './columnFacetingFeature.types'\n\nexport interface ColumnFacetingFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // CachedRowModel: CachedRowModel_Faceted<TFeatures, TData>\n  // Column: Column_ColumnFaceting<TFeatures, TData>\n  // CreateRowModels: CreateRowModel_Faceted<TFeatures, TData>\n}\n\n/**\n * Creates the stock column faceting feature.\n *\n * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.\n */\nexport function constructColumnFacetingFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<ColumnFacetingFeatureConstructors<TFeatures, TData>> {\n  return {\n    assignColumnPrototype: (prototype, table) => {\n      assignPrototypeAPIs('columnFacetingFeature', prototype, table, {\n        column_getFacetedRowModel: {\n          memoDeps: () => [\n            table.getPreFilteredRowModel().rows,\n            table.atoms.columnFilters?.get(),\n            table.atoms.globalFilter?.get(),\n            table.getFilteredRowModel().rows,\n          ],\n          fn: (column) => column_getFacetedRowModel(column, column.table),\n        },\n        column_getFacetedMinMaxValues: {\n          memoDeps: (column: Column_Internal<TFeatures, TData>) => [\n            callMemoOrStaticFn(\n              column,\n              'getFacetedRowModel',\n              column_getFacetedRowModel,\n              column.table,\n            ).flatRows,\n          ],\n          fn: (column) => column_getFacetedMinMaxValues(column, column.table),\n        },\n        column_getFacetedUniqueValues: {\n          memoDeps: (column: Column_Internal<TFeatures, TData>) => [\n            callMemoOrStaticFn(\n              column,\n              'getFacetedRowModel',\n              column_getFacetedRowModel,\n              column.table,\n            ).flatRows,\n          ],\n          fn: (column) => column_getFacetedUniqueValues(column, column.table),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('columnFacetingFeature', table, {\n        table_getGlobalFacetedRowModel: {\n          memoDeps: () => [\n            table.getPreFilteredRowModel().rows,\n            table.atoms.columnFilters?.get(),\n            table.atoms.globalFilter?.get(),\n            table.getFilteredRowModel().rows,\n          ],\n          fn: () => table_getGlobalFacetedRowModel(table),\n        },\n        table_getGlobalFacetedMinMaxValues: {\n          memoDeps: () => [\n            callMemoOrStaticFn(\n              table,\n              'getGlobalFacetedRowModel',\n              table_getGlobalFacetedRowModel,\n            ).flatRows,\n          ],\n          fn: () => table_getGlobalFacetedMinMaxValues(table),\n        },\n        table_getGlobalFacetedUniqueValues: {\n          memoDeps: () => [\n            callMemoOrStaticFn(\n              table,\n              'getGlobalFacetedRowModel',\n              table_getGlobalFacetedRowModel,\n            ).flatRows,\n          ],\n          fn: () => table_getGlobalFacetedUniqueValues(table),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The stock column faceting feature.\n *\n * Register this feature to add faceted row model, unique value, and min/max\n * helpers for column and global filter UIs.\n */\nexport const columnFacetingFeature = constructColumnFacetingFeature()\n"],"mappings":";;;;;;;;;AAoCA,SAAgB,iCAGuD;CACrE,OAAO;EACL,wBAAwB,WAAW,UAAU;GAC3C,oBAAoB,yBAAyB,WAAW,OAAO;IAC7D,2BAA2B;KACzB,gBAAgB;;;OACd,MAAM,wBAAwB,CAAC;gCAC/B,MAAM,MAAM,6FAAe,KAAK;gCAChC,MAAM,MAAM,4FAAc,KAAK;OAC/B,MAAM,qBAAqB,CAAC;OAC7B;;KACD,KAAK,WAAW,0BAA0B,QAAQ,OAAO,MAAM;KAChE;IACD,+BAA+B;KAC7B,WAAW,WAA8C,CACvD,mBACE,QACA,sBACA,2BACA,OAAO,MACR,CAAC,SACH;KACD,KAAK,WAAW,8BAA8B,QAAQ,OAAO,MAAM;KACpE;IACD,+BAA+B;KAC7B,WAAW,WAA8C,CACvD,mBACE,QACA,sBACA,2BACA,OAAO,MACR,CAAC,SACH;KACD,KAAK,WAAW,8BAA8B,QAAQ,OAAO,MAAM;KACpE;IACF,CAAC;;EAGJ,qBAAqB,UAAU;GAC7B,gBAAgB,yBAAyB,OAAO;IAC9C,gCAAgC;KAC9B,gBAAgB;;;OACd,MAAM,wBAAwB,CAAC;iCAC/B,MAAM,MAAM,+FAAe,KAAK;iCAChC,MAAM,MAAM,8FAAc,KAAK;OAC/B,MAAM,qBAAqB,CAAC;OAC7B;;KACD,UAAU,+BAA+B,MAAM;KAChD;IACD,oCAAoC;KAClC,gBAAgB,CACd,mBACE,OACA,4BACA,+BACD,CAAC,SACH;KACD,UAAU,mCAAmC,MAAM;KACpD;IACD,oCAAoC;KAClC,gBAAgB,CACd,mBACE,OACA,4BACA,+BACD,CAAC,SACH;KACD,UAAU,mCAAmC,MAAM;KACpD;IACF,CAAC;;EAEL;;;;;;;;AASH,MAAa,wBAAwB,gCAAgC"}