@rickcedwhat/playwright-smart-table 3.1.0 → 3.2.0

package/dist/typeContext.js

@@ -10,15 +10,21 @@ exports.TYPE_CONTEXT = `
 export type Selector = string | ((root: Locator | Page) => Locator);
 
 export type SmartRow = Locator & {
+  getRequestIndex(): number | undefined; // Helper to get the row index if known
+  rowIndex?: number;
   getCell(column: string): Locator;
   toJSON(): Promise<Record<string, string>>;
   /**
    * Fills the row with data. Automatically detects input types (text input, select, checkbox, etc.).
    */
+  fill: (data: Record<string, any>, options?: FillOptions) => Promise<void>;
+  /**
+   * Alias for fill() to avoid conflict with Locator.fill() 
+   */
   smartFill: (data: Record<string, any>, options?: FillOptions) => Promise<void>;
 };
 
-export type StrategyContext = TableContext;
+export type StrategyContext = TableContext & { rowLocator?: Locator; rowIndex?: number };
 
 /**
  * Defines the contract for a sorting strategy.
@@ -63,45 +69,81 @@ export interface PromptOptions {
   includeTypes?: boolean;
 }
 
+export type FillStrategy = (options: {
+  row: SmartRow;
+  columnName: string;
+  value: any;
+  index: number;
+  page: Page;
+  rootLocator: Locator;
+  table: TableResult; // The parent table instance
+  fillOptions?: FillOptions;
+}) => Promise<void>;
+
+export type { HeaderStrategy } from './strategies/headers';
+export type { ColumnStrategy } from './strategies/columns';
+
+/**
+ * Configuration options for useTable.
+ */
 export interface TableConfig {
-  rowSelector?: Selector;
-  headerSelector?: Selector;
-  cellSelector?: Selector;
+  /** Selector for the table headers */
+  headerSelector?: string;
+  /** Selector for the table rows */
+  rowSelector?: string;
+  /** Selector for the cells within a row */
+  cellSelector?: string;
+  /** Strategy for filling forms within the table */
+  fillStrategy?: FillStrategy;
+  /** Strategy for discovering headers */
+  headerStrategy?: HeaderStrategy;
+  /** Strategy for navigating to columns */
+  columnStrategy?: ColumnStrategy;
+  /** Number of pages to scan for verification */
+  maxPages?: number;
+
+  /** Pagination Strategy */
   pagination?: PaginationStrategy;
+  /** Sorting Strategy */
   sorting?: SortingStrategy;
-  maxPages?: number;
-  /**
+  /** 
    * Hook to rename columns dynamically.
-   * * @param args.text - The default innerText of the header.
-   * @param args.index - The column index.
-   * @param args.locator - The specific header cell locator.
    */
   headerTransformer?: (args: { text: string, index: number, locator: Locator }) => string | Promise<string>;
+  /** Automatically scroll to table on init */
   autoScroll?: boolean;
-  /**
-   * Enable debug mode to log internal state to console.
-   */
+  /** Enable debug logs */
   debug?: boolean;
-  /**
-   * Strategy to reset the table to the initial page.
-   * Called when table.reset() is invoked.
-   */
+  /** Reset hook */
   onReset?: (context: TableContext) => Promise<void>;
+  /**
+   * Custom resolver for finding a cell. 
+   * Overrides cellSelector logic if provided.
+   * Useful for virtualized tables where nth() index doesn't match DOM index.
+  */
+  cellResolver?: (args: { row: Locator, columnName: string, columnIndex: number, rowIndex?: number }) => Locator;
 }
 
-/**
- * Represents the final, resolved table configuration after default values have been applied.
- * All optional properties from TableConfig are now required, except for \`sorting\`.
- */
-export type FinalTableConfig = Required<Omit<TableConfig, 'sorting'>> & {
-  sorting?: SortingStrategy;
-};
+export interface FinalTableConfig extends TableConfig {
+  headerSelector: string;
+  rowSelector: string;
+  cellSelector: string;
+  fillStrategy: FillStrategy;
+  headerStrategy: HeaderStrategy;
+  columnStrategy: ColumnStrategy;
+  maxPages: number;
+  pagination: PaginationStrategy;
+  autoScroll: boolean;
+  debug: boolean;
+  headerTransformer: (args: { text: string, index: number, locator: Locator }) => string | Promise<string>;
+  onReset: (context: TableContext) => Promise<void>;
+  cellResolver?: (args: { row: Locator, columnName: string, columnIndex: number, rowIndex?: number }) => Locator;
+}
 
 export interface FillOptions {
   /**
    * Custom input mappers for specific columns.
    * Maps column names to functions that return the input locator for that cell.
-   * Columns not specified here will use auto-detection.
    */
   inputMappers?: Record<string, (cell: Locator) => Locator>;
 }
@@ -120,20 +162,35 @@ export interface TableResult {
    * Finds a row on the current page only. Returns immediately (sync).
    * Throws error if table is not initialized.
    */
-  getByRow: (
-    filters: Record<string, string | RegExp | number>, 
-    options?: { exact?: boolean }
-  ) => SmartRow;
+  getByRow: {
+    (index: number): SmartRow;
+    (
+      filters: Record<string, string | RegExp | number>,
+      options?: { exact?: boolean }
+    ): SmartRow;
+  };
 
   /**
    * Searches for a row across all available data using the configured strategy (pagination, scroll, etc.).
    * Auto-initializes if needed.
    */
   searchForRow: (
-    filters: Record<string, string | RegExp | number>, 
+    filters: Record<string, string | RegExp | number>,
     options?: { exact?: boolean, maxPages?: number }
   ) => Promise<SmartRow>;
 
+  /**
+   * Manually scrolls to a column using the configured ColumnStrategy.
+   */
+  scrollToColumn: (columnName: string) => Promise<void>;
+
+  getAllCurrentRows: <T extends { asJSON?: boolean }>(
+    options?: { filter?: Record<string, any>, exact?: boolean } & T
+  ) => Promise<T['asJSON'] extends true ? Record<string, string>[] : SmartRow[]>;
+
+  /**
+   * @deprecated Use getAllCurrentRows instead. This method will be removed in a future major version.
+   */
   getAllRows: <T extends { asJSON?: boolean }>(
     options?: { filter?: Record<string, any>, exact?: boolean } & T
   ) => Promise<T['asJSON'] extends true ? Record<string, string>[] : SmartRow[]>;
@@ -197,5 +254,5 @@ export interface TableResult {
 /**
  * Restricted table result that excludes methods that shouldn't be called during iteration.
  */
-export type RestrictedTableResult = Omit<TableResult, 'searchForRow' | 'iterateThroughTable' | 'reset'>;
+export type RestrictedTableResult = Omit<TableResult, 'searchForRow' | 'iterateThroughTable' | 'reset' | 'getAllRows'>;
 `;

package/dist/types.d.ts

@@ -1,14 +1,23 @@
 import type { Locator, Page } from '@playwright/test';
 export type Selector = string | ((root: Locator | Page) => Locator);
 export type SmartRow = Locator & {
+    getRequestIndex(): number | undefined;
+    rowIndex?: number;
     getCell(column: string): Locator;
     toJSON(): Promise<Record<string, string>>;
     /**
      * Fills the row with data. Automatically detects input types (text input, select, checkbox, etc.).
      */
+    fill: (data: Record<string, any>, options?: FillOptions) => Promise<void>;
+    /**
+     * Alias for fill() to avoid conflict with Locator.fill()
+     */
     smartFill: (data: Record<string, any>, options?: FillOptions) => Promise<void>;
 };
-export type StrategyContext = TableContext;
+export type StrategyContext = TableContext & {
+    rowLocator?: Locator;
+    rowIndex?: number;
+};
 /**
  * Defines the contract for a sorting strategy.
  */
@@ -46,47 +55,96 @@ export interface PromptOptions {
     output?: 'console' | 'error';
     includeTypes?: boolean;
 }
+export type FillStrategy = (options: {
+    row: SmartRow;
+    columnName: string;
+    value: any;
+    index: number;
+    page: Page;
+    rootLocator: Locator;
+    table: TableResult;
+    fillOptions?: FillOptions;
+}) => Promise<void>;
+export type { HeaderStrategy } from './strategies/headers';
+export type { ColumnStrategy } from './strategies/columns';
+import { HeaderStrategy } from './strategies/headers';
+import { ColumnStrategy } from './strategies/columns';
+/**
+ * Configuration options for useTable.
+ */
 export interface TableConfig {
-    rowSelector?: Selector;
-    headerSelector?: Selector;
-    cellSelector?: Selector;
+    /** Selector for the table headers */
+    headerSelector?: string;
+    /** Selector for the table rows */
+    rowSelector?: string;
+    /** Selector for the cells within a row */
+    cellSelector?: string;
+    /** Strategy for filling forms within the table */
+    fillStrategy?: FillStrategy;
+    /** Strategy for discovering headers */
+    headerStrategy?: HeaderStrategy;
+    /** Strategy for navigating to columns */
+    columnStrategy?: ColumnStrategy;
+    /** Number of pages to scan for verification */
+    maxPages?: number;
+    /** Pagination Strategy */
     pagination?: PaginationStrategy;
+    /** Sorting Strategy */
     sorting?: SortingStrategy;
-    maxPages?: number;
     /**
      * Hook to rename columns dynamically.
-     * * @param args.text - The default innerText of the header.
-     * @param args.index - The column index.
-     * @param args.locator - The specific header cell locator.
      */
     headerTransformer?: (args: {
         text: string;
         index: number;
         locator: Locator;
     }) => string | Promise<string>;
+    /** Automatically scroll to table on init */
     autoScroll?: boolean;
-    /**
-     * Enable debug mode to log internal state to console.
-     */
+    /** Enable debug logs */
     debug?: boolean;
-    /**
-     * Strategy to reset the table to the initial page.
-     * Called when table.reset() is invoked.
-     */
+    /** Reset hook */
     onReset?: (context: TableContext) => Promise<void>;
+    /**
+     * Custom resolver for finding a cell.
+     * Overrides cellSelector logic if provided.
+     * Useful for virtualized tables where nth() index doesn't match DOM index.
+    */
+    cellResolver?: (args: {
+        row: Locator;
+        columnName: string;
+        columnIndex: number;
+        rowIndex?: number;
+    }) => Locator;
+}
+export interface FinalTableConfig extends TableConfig {
+    headerSelector: string;
+    rowSelector: string;
+    cellSelector: string;
+    fillStrategy: FillStrategy;
+    headerStrategy: HeaderStrategy;
+    columnStrategy: ColumnStrategy;
+    maxPages: number;
+    pagination: PaginationStrategy;
+    autoScroll: boolean;
+    debug: boolean;
+    headerTransformer: (args: {
+        text: string;
+        index: number;
+        locator: Locator;
+    }) => string | Promise<string>;
+    onReset: (context: TableContext) => Promise<void>;
+    cellResolver?: (args: {
+        row: Locator;
+        columnName: string;
+        columnIndex: number;
+        rowIndex?: number;
+    }) => Locator;
 }
-/**
- * Represents the final, resolved table configuration after default values have been applied.
- * All optional properties from TableConfig are now required, except for `sorting`.
- */
-export type FinalTableConfig = Required<Omit<TableConfig, 'sorting'>> & {
-    sorting?: SortingStrategy;
-};
 export interface FillOptions {
     /**
      * Custom input mappers for specific columns.
      * Maps column names to functions that return the input locator for that cell.
-     * Columns not specified here will use auto-detection.
      */
     inputMappers?: Record<string, (cell: Locator) => Locator>;
 }
@@ -104,9 +162,12 @@ export interface TableResult {
      * Finds a row on the current page only. Returns immediately (sync).
      * Throws error if table is not initialized.
      */
-    getByRow: (filters: Record<string, string | RegExp | number>, options?: {
-        exact?: boolean;
-    }) => SmartRow;
+    getByRow: {
+        (index: number): SmartRow;
+        (filters: Record<string, string | RegExp | number>, options?: {
+            exact?: boolean;
+        }): SmartRow;
+    };
     /**
      * Searches for a row across all available data using the configured strategy (pagination, scroll, etc.).
      * Auto-initializes if needed.
@@ -115,6 +176,19 @@ export interface TableResult {
         exact?: boolean;
         maxPages?: number;
     }) => Promise<SmartRow>;
+    /**
+     * Manually scrolls to a column using the configured ColumnStrategy.
+     */
+    scrollToColumn: (columnName: string) => Promise<void>;
+    getAllCurrentRows: <T extends {
+        asJSON?: boolean;
+    }>(options?: {
+        filter?: Record<string, any>;
+        exact?: boolean;
+    } & T) => Promise<T['asJSON'] extends true ? Record<string, string>[] : SmartRow[]>;
+    /**
+     * @deprecated Use getAllCurrentRows instead. This method will be removed in a future major version.
+     */
     getAllRows: <T extends {
         asJSON?: boolean;
     }>(options?: {
@@ -188,4 +262,4 @@ export interface TableResult {
 /**
  * Restricted table result that excludes methods that shouldn't be called during iteration.
  */
-export type RestrictedTableResult = Omit<TableResult, 'searchForRow' | 'iterateThroughTable' | 'reset'>;
+export type RestrictedTableResult = Omit<TableResult, 'searchForRow' | 'iterateThroughTable' | 'reset' | 'getAllRows'>;

package/dist/useTable.d.ts

@@ -1,25 +1,23 @@
 import type { Locator } from '@playwright/test';
 import { TableConfig, Selector, TableResult, PaginationStrategy } from './types';
+import { FillStrategies } from './strategies/fill';
+import { HeaderStrategies } from './strategies/headers';
+import { ColumnStrategies } from './strategies/columns';
 /**
- * A collection of pre-built pagination strategies.
+ * Main hook to interact with a table.
  */
+export declare const useTable: (rootLocator: Locator, configOptions?: TableConfig) => TableResult;
 export declare const PaginationStrategies: {
     clickNext: (nextButtonSelector: Selector, timeout?: number) => PaginationStrategy;
     clickLoadMore: (buttonSelector: Selector, timeout?: number) => PaginationStrategy;
     infiniteScroll: (timeout?: number) => PaginationStrategy;
 };
-/**
- * @deprecated Use `PaginationStrategies` instead. This alias will be removed in a future major version.
- */
 export declare const TableStrategies: {
     clickNext: (nextButtonSelector: Selector, timeout?: number) => PaginationStrategy;
     clickLoadMore: (buttonSelector: Selector, timeout?: number) => PaginationStrategy;
     infiniteScroll: (timeout?: number) => PaginationStrategy;
 };
-/**
- * A collection of pre-built sorting strategies.
- */
 export declare const SortingStrategies: {
     AriaSort: () => import("./types").SortingStrategy;
 };
-export declare const useTable: (rootLocator: Locator, configOptions?: TableConfig) => TableResult;
+export { FillStrategies, HeaderStrategies, ColumnStrategies };