@mikevar/data-grid 0.0.1

package/dist/index.cjs

@@ -0,0 +1,293 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  COL_DIRECTION_SEPARATOR: () => COL_DIRECTION_SEPARATOR,
+  COL_OPERATOR_SEPARATOR: () => COL_OPERATOR_SEPARATOR,
+  DEFAULT_CURSOR: () => DEFAULT_CURSOR,
+  DEFAULT_CURSOR_KEY: () => DEFAULT_CURSOR_KEY,
+  DEFAULT_FILTER_MODE: () => DEFAULT_FILTER_MODE,
+  DEFAULT_FILTER_MODE_KEY: () => DEFAULT_FILTER_MODE_KEY,
+  DEFAULT_LIMIT: () => DEFAULT_LIMIT,
+  DEFAULT_LIMIT_KEY: () => DEFAULT_LIMIT_KEY,
+  DEFAULT_ORDERS_KEY: () => DEFAULT_ORDERS_KEY,
+  DEFAULT_PAGE: () => DEFAULT_PAGE,
+  DEFAULT_PAGE_KEY: () => DEFAULT_PAGE_KEY,
+  DEFAULT_PAGINATION_MODE: () => DEFAULT_PAGINATION_MODE,
+  DEFAULT_PAGINATION_MODE_KEY: () => DEFAULT_PAGINATION_MODE_KEY,
+  DEFAULT_SEARCH: () => DEFAULT_SEARCH,
+  DEFAULT_SEARCH_KEY: () => DEFAULT_SEARCH_KEY,
+  FILTER_OPERATORS: () => FILTER_OPERATORS,
+  isFilterMode: () => isFilterMode,
+  isFilterOperator: () => isFilterOperator,
+  isOrderDirection: () => isOrderDirection,
+  isPaginationMode: () => isPaginationMode,
+  mergeDefaultAndCustomQueryKeys: () => mergeDefaultAndCustomQueryKeys,
+  mergeDefaultQueryValues: () => mergeDefaultQueryValues,
+  normalizeParsedQueryObject: () => normalizeParsedQueryObject,
+  parseAndNormalize: () => parseAndNormalize,
+  parseAndNormalizeQueryObject: () => parseAndNormalizeQueryObject,
+  parseQueryObject: () => parseQueryObject,
+  toPositiveInt: () => toPositiveInt
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/consts.ts
+var COL_DIRECTION_SEPARATOR = ":";
+var COL_OPERATOR_SEPARATOR = "__";
+var DEFAULT_FILTER_MODE_KEY = "filterMode";
+var DEFAULT_SEARCH_KEY = "search";
+var DEFAULT_PAGINATION_MODE_KEY = "paginationMode";
+var DEFAULT_PAGE_KEY = "page";
+var DEFAULT_LIMIT_KEY = "limit";
+var DEFAULT_CURSOR_KEY = "cursor";
+var DEFAULT_ORDERS_KEY = "orders";
+var DEFAULT_PAGINATION_MODE = "offset";
+var DEFAULT_PAGE = 1;
+var DEFAULT_LIMIT = 10;
+var DEFAULT_CURSOR = "";
+var DEFAULT_FILTER_MODE = "search";
+var DEFAULT_SEARCH = "";
+var FILTER_OPERATORS = [
+  "eq",
+  "gt",
+  "gte",
+  "lt",
+  "lte",
+  "between",
+  "iLike",
+  "isNull",
+  "inArray"
+];
+
+// src/utils.ts
+function mergeDefaultAndCustomQueryKeys(customQueryKeys) {
+  const DEFAULT_QUERY_KEYS = {
+    filterMode: DEFAULT_FILTER_MODE_KEY,
+    search: DEFAULT_SEARCH_KEY,
+    paginationMode: DEFAULT_PAGINATION_MODE_KEY,
+    page: DEFAULT_PAGE_KEY,
+    limit: DEFAULT_LIMIT_KEY,
+    cursor: DEFAULT_CURSOR_KEY,
+    orders: DEFAULT_ORDERS_KEY
+  };
+  return {
+    filterMode: customQueryKeys?.filterMode ?? DEFAULT_QUERY_KEYS.filterMode,
+    search: customQueryKeys?.search ?? DEFAULT_QUERY_KEYS.search,
+    paginationMode: customQueryKeys?.paginationMode ?? DEFAULT_QUERY_KEYS.paginationMode,
+    page: customQueryKeys?.page ?? DEFAULT_QUERY_KEYS.page,
+    limit: customQueryKeys?.limit ?? DEFAULT_QUERY_KEYS.limit,
+    cursor: customQueryKeys?.cursor ?? DEFAULT_QUERY_KEYS.cursor,
+    orders: customQueryKeys?.orders ?? DEFAULT_QUERY_KEYS.orders
+  };
+}
+function mergeDefaultQueryValues(defaultQueryValues) {
+  if (defaultQueryValues === void 0) {
+    return {
+      pagination: {
+        mode: DEFAULT_PAGINATION_MODE,
+        page: DEFAULT_PAGE,
+        limit: DEFAULT_LIMIT,
+        cursor: DEFAULT_CURSOR
+      },
+      sorting: {
+        orders: []
+      },
+      filtering: {
+        mode: DEFAULT_FILTER_MODE,
+        search: DEFAULT_SEARCH,
+        filters: []
+      }
+    };
+  }
+  return {
+    pagination: {
+      mode: defaultQueryValues.paginationMode ?? DEFAULT_PAGINATION_MODE,
+      page: defaultQueryValues.page ?? DEFAULT_PAGE,
+      limit: defaultQueryValues.limit ?? DEFAULT_LIMIT,
+      cursor: defaultQueryValues.cursor ?? DEFAULT_CURSOR
+    },
+    sorting: {
+      orders: defaultQueryValues.orders ?? []
+    },
+    filtering: {
+      mode: defaultQueryValues.filterMode ?? DEFAULT_FILTER_MODE,
+      search: defaultQueryValues.search ?? DEFAULT_SEARCH,
+      filters: defaultQueryValues.filters ?? []
+    }
+  };
+}
+
+// src/helpers.ts
+function isPaginationMode(v) {
+  return v === "offset" || v === "cursor";
+}
+function isOrderDirection(v) {
+  return v === "asc" || v === "desc";
+}
+function isFilterMode(v) {
+  return v === "search" || v === "filter";
+}
+function toPositiveInt(value, fallback) {
+  const n = Number(value);
+  return Number.isFinite(n) && n > 0 ? n : fallback;
+}
+function isFilterOperator(v) {
+  return FILTER_OPERATORS.includes(v);
+}
+
+// src/parse-query-object.ts
+function parseQueryObject({
+  query,
+  queryKeys
+}) {
+  const keys = mergeDefaultAndCustomQueryKeys(queryKeys);
+  const reserved = new Set(Object.values(keys));
+  const filters = {};
+  for (const [key, value] of Object.entries(query)) {
+    if (!reserved.has(key)) {
+      filters[key] = value;
+    }
+  }
+  return {
+    pagination: {
+      mode: query[keys.paginationMode],
+      page: query[keys.page],
+      limit: query[keys.limit],
+      cursor: query[keys.cursor]
+    },
+    sorting: {
+      orders: query[keys.orders]
+    },
+    filtering: {
+      mode: query[keys.filterMode],
+      search: query[keys.search],
+      filters
+    }
+  };
+}
+
+// src/normalize-parsed-query-object.ts
+function normalizeParsedQueryObject({
+  parsedQuery,
+  defaultQueryValues
+}) {
+  const defaultValues = mergeDefaultQueryValues(defaultQueryValues);
+  const paginationMode = isPaginationMode(parsedQuery.pagination.mode) ? parsedQuery.pagination.mode : defaultValues.pagination.mode;
+  const page = toPositiveInt(
+    parsedQuery.pagination.page,
+    defaultValues.pagination.page
+  );
+  const limit = toPositiveInt(
+    parsedQuery.pagination.limit,
+    defaultValues.pagination.limit
+  );
+  const cursor = parsedQuery.pagination.cursor ?? defaultValues.pagination.cursor;
+  const pagination = paginationMode === "offset" ? {
+    mode: "offset",
+    page,
+    limit
+  } : {
+    mode: "cursor",
+    cursor,
+    limit
+  };
+  const explodedOrders = parsedQuery.sorting.orders?.split(",") || [];
+  const orders = explodedOrders.map((order) => {
+    const [column, direction] = order.split(COL_DIRECTION_SEPARATOR).map((s) => s.trim());
+    if (!column) return null;
+    return {
+      column,
+      direction: isOrderDirection(direction) ? direction : "asc"
+    };
+  }).filter((item) => item !== null);
+  const filters = Object.entries(parsedQuery.filtering.filters).map(([colOperator, value]) => {
+    const [col, operator] = colOperator.split(COL_OPERATOR_SEPARATOR);
+    if (!col || !isFilterOperator(operator)) return null;
+    const column = col.trim();
+    const valueTrimmed = value.trim();
+    return {
+      column,
+      operator,
+      value: valueTrimmed
+    };
+  }).filter((item) => item !== null);
+  return {
+    pagination,
+    sorting: {
+      orders
+    },
+    filtering: {
+      mode: isFilterMode(parsedQuery.filtering.mode) ? parsedQuery.filtering.mode : defaultValues.filtering.mode,
+      search: parsedQuery.filtering.search ?? defaultValues.filtering.search,
+      filters
+    }
+  };
+}
+
+// src/parse-and-normalize-query-object.ts
+function parseAndNormalizeQueryObject(options) {
+  const parsed = parseQueryObject({
+    query: options.query,
+    queryKeys: options.queryKeys
+  });
+  const normalized = normalizeParsedQueryObject({
+    parsedQuery: parsed,
+    defaultQueryValues: options.defaultQueryValues
+  });
+  return {
+    parsed,
+    normalized
+  };
+}
+function parseAndNormalize(options) {
+  return parseAndNormalizeQueryObject(options);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  COL_DIRECTION_SEPARATOR,
+  COL_OPERATOR_SEPARATOR,
+  DEFAULT_CURSOR,
+  DEFAULT_CURSOR_KEY,
+  DEFAULT_FILTER_MODE,
+  DEFAULT_FILTER_MODE_KEY,
+  DEFAULT_LIMIT,
+  DEFAULT_LIMIT_KEY,
+  DEFAULT_ORDERS_KEY,
+  DEFAULT_PAGE,
+  DEFAULT_PAGE_KEY,
+  DEFAULT_PAGINATION_MODE,
+  DEFAULT_PAGINATION_MODE_KEY,
+  DEFAULT_SEARCH,
+  DEFAULT_SEARCH_KEY,
+  FILTER_OPERATORS,
+  isFilterMode,
+  isFilterOperator,
+  isOrderDirection,
+  isPaginationMode,
+  mergeDefaultAndCustomQueryKeys,
+  mergeDefaultQueryValues,
+  normalizeParsedQueryObject,
+  parseAndNormalize,
+  parseAndNormalizeQueryObject,
+  parseQueryObject,
+  toPositiveInt
+});

package/dist/index.d.cts

@@ -0,0 +1,162 @@
+declare const COL_DIRECTION_SEPARATOR = ":";
+declare const COL_OPERATOR_SEPARATOR = "__";
+declare const DEFAULT_FILTER_MODE_KEY = "filterMode";
+declare const DEFAULT_SEARCH_KEY = "search";
+declare const DEFAULT_PAGINATION_MODE_KEY = "paginationMode";
+declare const DEFAULT_PAGE_KEY = "page";
+declare const DEFAULT_LIMIT_KEY = "limit";
+declare const DEFAULT_CURSOR_KEY = "cursor";
+declare const DEFAULT_ORDERS_KEY = "orders";
+declare const DEFAULT_PAGINATION_MODE: PaginationMode;
+declare const DEFAULT_PAGE = 1;
+declare const DEFAULT_LIMIT = 10;
+declare const DEFAULT_CURSOR = "";
+declare const DEFAULT_FILTER_MODE: FilterMode;
+declare const DEFAULT_SEARCH = "";
+declare const FILTER_OPERATORS: readonly ["eq", "gt", "gte", "lt", "lte", "between", "iLike", "isNull", "inArray"];
+
+type QueryKeysOptions = {
+    filterMode?: string;
+    search?: string;
+    paginationMode?: string;
+    page?: string;
+    limit?: string;
+    cursor?: string;
+    orders?: string;
+};
+type DefaultQueryValuesOptions = {
+    filterMode?: FilterMode;
+    search?: string;
+    paginationMode?: PaginationMode;
+    page?: number;
+    limit?: number;
+    cursor?: string;
+    orders?: OrderObject[];
+    filters?: FilterObject[];
+};
+type ParsedQueryObject = {
+    pagination: {
+        mode?: string;
+        page?: string;
+        limit?: string;
+        cursor?: string;
+    };
+    sorting: {
+        orders?: string;
+    };
+    filtering: {
+        mode?: string;
+        search?: string;
+        filters: Record<string, string>;
+    };
+};
+type PaginationMode = "offset" | "cursor";
+type OffsetPaginationObject = {
+    mode: "offset";
+    page: number;
+    limit: number;
+};
+type CursorPaginationObject = {
+    mode: "cursor";
+    cursor: string;
+    limit: number;
+};
+type OrderDirection = "asc" | "desc";
+type OrderObject = {
+    column: string;
+    direction: OrderDirection;
+};
+type FilterMode = "search" | "filter";
+type FilterOperator = (typeof FILTER_OPERATORS)[number];
+type FilterObject = {
+    column: string;
+    operator: FilterOperator;
+    value: string;
+};
+type NormalizedQueryObject = {
+    pagination: OffsetPaginationObject | CursorPaginationObject;
+    sorting: {
+        orders: OrderObject[];
+    };
+    filtering: {
+        mode: FilterMode;
+        search: string;
+        filters: FilterObject[];
+    };
+};
+type FieldSchemaColumn = any | unknown;
+type FieldSchemaObjectType = "string" | "number" | "boolean" | "date";
+type FieldSchemaObject = {
+    column: FieldSchemaColumn;
+    type: FieldSchemaObjectType;
+    sortable?: boolean;
+    searchable?: boolean;
+    filterable?: boolean;
+};
+type FieldSchema = Record<string, FieldSchemaObject>;
+type QueryPlanObject = {
+    where?: any;
+    orderBy?: any;
+    limit: number;
+    offset?: number;
+};
+
+declare function mergeDefaultAndCustomQueryKeys(customQueryKeys: QueryKeysOptions | undefined): {
+    filterMode: string;
+    search: string;
+    paginationMode: string;
+    page: string;
+    limit: string;
+    cursor: string;
+    orders: string;
+};
+declare function mergeDefaultQueryValues(defaultQueryValues?: DefaultQueryValuesOptions): {
+    pagination: {
+        mode: PaginationMode;
+        page: number;
+        limit: number;
+        cursor: string;
+    };
+    sorting: {
+        orders: OrderObject[];
+    };
+    filtering: {
+        mode: FilterMode;
+        search: string;
+        filters: FilterObject[];
+    };
+};
+
+declare function isPaginationMode(v: unknown): v is PaginationMode;
+declare function isOrderDirection(v: unknown): v is OrderDirection;
+declare function isFilterMode(v: unknown): v is FilterMode;
+declare function toPositiveInt(value: string | undefined, fallback: number): number;
+declare function isFilterOperator(v: unknown): v is FilterOperator;
+
+interface ParseQueryObjectParams {
+    query: Record<string, string>;
+    queryKeys?: QueryKeysOptions | undefined;
+}
+declare function parseQueryObject({ query, queryKeys, }: ParseQueryObjectParams): ParsedQueryObject;
+
+interface NormalizeParsedQueryObjectParams {
+    parsedQuery: ParsedQueryObject;
+    defaultQueryValues?: DefaultQueryValuesOptions | undefined;
+}
+declare function normalizeParsedQueryObject({ parsedQuery, defaultQueryValues, }: NormalizeParsedQueryObjectParams): NormalizedQueryObject;
+
+interface ParseAndNormalizeQueryObjectOptions {
+    query: Record<string, string>;
+    queryKeys?: QueryKeysOptions | undefined;
+    defaultQueryValues?: DefaultQueryValuesOptions | undefined;
+}
+declare function parseAndNormalizeQueryObject(options: ParseAndNormalizeQueryObjectOptions): {
+    parsed: ParsedQueryObject;
+    normalized: NormalizedQueryObject;
+};
+declare function parseAndNormalize(options: ParseAndNormalizeQueryObjectOptions): {
+    parsed: ParsedQueryObject;
+    normalized: NormalizedQueryObject;
+};
+
+export { COL_DIRECTION_SEPARATOR, COL_OPERATOR_SEPARATOR, type CursorPaginationObject, DEFAULT_CURSOR, DEFAULT_CURSOR_KEY, DEFAULT_FILTER_MODE, DEFAULT_FILTER_MODE_KEY, DEFAULT_LIMIT, DEFAULT_LIMIT_KEY, DEFAULT_ORDERS_KEY, DEFAULT_PAGE, DEFAULT_PAGE_KEY, DEFAULT_PAGINATION_MODE, DEFAULT_PAGINATION_MODE_KEY, DEFAULT_SEARCH, DEFAULT_SEARCH_KEY, type DefaultQueryValuesOptions, FILTER_OPERATORS, type FieldSchema, type FieldSchemaColumn, type FieldSchemaObject, type FieldSchemaObjectType, type FilterMode, type FilterObject, type FilterOperator, type NormalizedQueryObject, type OffsetPaginationObject, type OrderDirection, type OrderObject, type PaginationMode, type ParsedQueryObject, type QueryKeysOptions, type QueryPlanObject, isFilterMode, isFilterOperator, isOrderDirection, isPaginationMode, mergeDefaultAndCustomQueryKeys, mergeDefaultQueryValues, normalizeParsedQueryObject, parseAndNormalize, parseAndNormalizeQueryObject, parseQueryObject, toPositiveInt };

package/dist/index.d.ts

@@ -0,0 +1,162 @@
+declare const COL_DIRECTION_SEPARATOR = ":";
+declare const COL_OPERATOR_SEPARATOR = "__";
+declare const DEFAULT_FILTER_MODE_KEY = "filterMode";
+declare const DEFAULT_SEARCH_KEY = "search";
+declare const DEFAULT_PAGINATION_MODE_KEY = "paginationMode";
+declare const DEFAULT_PAGE_KEY = "page";
+declare const DEFAULT_LIMIT_KEY = "limit";
+declare const DEFAULT_CURSOR_KEY = "cursor";
+declare const DEFAULT_ORDERS_KEY = "orders";
+declare const DEFAULT_PAGINATION_MODE: PaginationMode;
+declare const DEFAULT_PAGE = 1;
+declare const DEFAULT_LIMIT = 10;
+declare const DEFAULT_CURSOR = "";
+declare const DEFAULT_FILTER_MODE: FilterMode;
+declare const DEFAULT_SEARCH = "";
+declare const FILTER_OPERATORS: readonly ["eq", "gt", "gte", "lt", "lte", "between", "iLike", "isNull", "inArray"];
+
+type QueryKeysOptions = {
+    filterMode?: string;
+    search?: string;
+    paginationMode?: string;
+    page?: string;
+    limit?: string;
+    cursor?: string;
+    orders?: string;
+};
+type DefaultQueryValuesOptions = {
+    filterMode?: FilterMode;
+    search?: string;
+    paginationMode?: PaginationMode;
+    page?: number;
+    limit?: number;
+    cursor?: string;
+    orders?: OrderObject[];
+    filters?: FilterObject[];
+};
+type ParsedQueryObject = {
+    pagination: {
+        mode?: string;
+        page?: string;
+        limit?: string;
+        cursor?: string;
+    };
+    sorting: {
+        orders?: string;
+    };
+    filtering: {
+        mode?: string;
+        search?: string;
+        filters: Record<string, string>;
+    };
+};
+type PaginationMode = "offset" | "cursor";
+type OffsetPaginationObject = {
+    mode: "offset";
+    page: number;
+    limit: number;
+};
+type CursorPaginationObject = {
+    mode: "cursor";
+    cursor: string;
+    limit: number;
+};
+type OrderDirection = "asc" | "desc";
+type OrderObject = {
+    column: string;
+    direction: OrderDirection;
+};
+type FilterMode = "search" | "filter";
+type FilterOperator = (typeof FILTER_OPERATORS)[number];
+type FilterObject = {
+    column: string;
+    operator: FilterOperator;
+    value: string;
+};
+type NormalizedQueryObject = {
+    pagination: OffsetPaginationObject | CursorPaginationObject;
+    sorting: {
+        orders: OrderObject[];
+    };
+    filtering: {
+        mode: FilterMode;
+        search: string;
+        filters: FilterObject[];
+    };
+};
+type FieldSchemaColumn = any | unknown;
+type FieldSchemaObjectType = "string" | "number" | "boolean" | "date";
+type FieldSchemaObject = {
+    column: FieldSchemaColumn;
+    type: FieldSchemaObjectType;
+    sortable?: boolean;
+    searchable?: boolean;
+    filterable?: boolean;
+};
+type FieldSchema = Record<string, FieldSchemaObject>;
+type QueryPlanObject = {
+    where?: any;
+    orderBy?: any;
+    limit: number;
+    offset?: number;
+};
+
+declare function mergeDefaultAndCustomQueryKeys(customQueryKeys: QueryKeysOptions | undefined): {
+    filterMode: string;
+    search: string;
+    paginationMode: string;
+    page: string;
+    limit: string;
+    cursor: string;
+    orders: string;
+};
+declare function mergeDefaultQueryValues(defaultQueryValues?: DefaultQueryValuesOptions): {
+    pagination: {
+        mode: PaginationMode;
+        page: number;
+        limit: number;
+        cursor: string;
+    };
+    sorting: {
+        orders: OrderObject[];
+    };
+    filtering: {
+        mode: FilterMode;
+        search: string;
+        filters: FilterObject[];
+    };
+};
+
+declare function isPaginationMode(v: unknown): v is PaginationMode;
+declare function isOrderDirection(v: unknown): v is OrderDirection;
+declare function isFilterMode(v: unknown): v is FilterMode;
+declare function toPositiveInt(value: string | undefined, fallback: number): number;
+declare function isFilterOperator(v: unknown): v is FilterOperator;
+
+interface ParseQueryObjectParams {
+    query: Record<string, string>;
+    queryKeys?: QueryKeysOptions | undefined;
+}
+declare function parseQueryObject({ query, queryKeys, }: ParseQueryObjectParams): ParsedQueryObject;
+
+interface NormalizeParsedQueryObjectParams {
+    parsedQuery: ParsedQueryObject;
+    defaultQueryValues?: DefaultQueryValuesOptions | undefined;
+}
+declare function normalizeParsedQueryObject({ parsedQuery, defaultQueryValues, }: NormalizeParsedQueryObjectParams): NormalizedQueryObject;
+
+interface ParseAndNormalizeQueryObjectOptions {
+    query: Record<string, string>;
+    queryKeys?: QueryKeysOptions | undefined;
+    defaultQueryValues?: DefaultQueryValuesOptions | undefined;
+}
+declare function parseAndNormalizeQueryObject(options: ParseAndNormalizeQueryObjectOptions): {
+    parsed: ParsedQueryObject;
+    normalized: NormalizedQueryObject;
+};
+declare function parseAndNormalize(options: ParseAndNormalizeQueryObjectOptions): {
+    parsed: ParsedQueryObject;
+    normalized: NormalizedQueryObject;
+};
+
+export { COL_DIRECTION_SEPARATOR, COL_OPERATOR_SEPARATOR, type CursorPaginationObject, DEFAULT_CURSOR, DEFAULT_CURSOR_KEY, DEFAULT_FILTER_MODE, DEFAULT_FILTER_MODE_KEY, DEFAULT_LIMIT, DEFAULT_LIMIT_KEY, DEFAULT_ORDERS_KEY, DEFAULT_PAGE, DEFAULT_PAGE_KEY, DEFAULT_PAGINATION_MODE, DEFAULT_PAGINATION_MODE_KEY, DEFAULT_SEARCH, DEFAULT_SEARCH_KEY, type DefaultQueryValuesOptions, FILTER_OPERATORS, type FieldSchema, type FieldSchemaColumn, type FieldSchemaObject, type FieldSchemaObjectType, type FilterMode, type FilterObject, type FilterOperator, type NormalizedQueryObject, type OffsetPaginationObject, type OrderDirection, type OrderObject, type PaginationMode, type ParsedQueryObject, type QueryKeysOptions, type QueryPlanObject, isFilterMode, isFilterOperator, isOrderDirection, isPaginationMode, mergeDefaultAndCustomQueryKeys, mergeDefaultQueryValues, normalizeParsedQueryObject, parseAndNormalize, parseAndNormalizeQueryObject, parseQueryObject, toPositiveInt };

package/dist/index.js

@@ -0,0 +1,240 @@
+// src/consts.ts
+var COL_DIRECTION_SEPARATOR = ":";
+var COL_OPERATOR_SEPARATOR = "__";
+var DEFAULT_FILTER_MODE_KEY = "filterMode";
+var DEFAULT_SEARCH_KEY = "search";
+var DEFAULT_PAGINATION_MODE_KEY = "paginationMode";
+var DEFAULT_PAGE_KEY = "page";
+var DEFAULT_LIMIT_KEY = "limit";
+var DEFAULT_CURSOR_KEY = "cursor";
+var DEFAULT_ORDERS_KEY = "orders";
+var DEFAULT_PAGINATION_MODE = "offset";
+var DEFAULT_PAGE = 1;
+var DEFAULT_LIMIT = 10;
+var DEFAULT_CURSOR = "";
+var DEFAULT_FILTER_MODE = "search";
+var DEFAULT_SEARCH = "";
+var FILTER_OPERATORS = [
+  "eq",
+  "gt",
+  "gte",
+  "lt",
+  "lte",
+  "between",
+  "iLike",
+  "isNull",
+  "inArray"
+];
+
+// src/utils.ts
+function mergeDefaultAndCustomQueryKeys(customQueryKeys) {
+  const DEFAULT_QUERY_KEYS = {
+    filterMode: DEFAULT_FILTER_MODE_KEY,
+    search: DEFAULT_SEARCH_KEY,
+    paginationMode: DEFAULT_PAGINATION_MODE_KEY,
+    page: DEFAULT_PAGE_KEY,
+    limit: DEFAULT_LIMIT_KEY,
+    cursor: DEFAULT_CURSOR_KEY,
+    orders: DEFAULT_ORDERS_KEY
+  };
+  return {
+    filterMode: customQueryKeys?.filterMode ?? DEFAULT_QUERY_KEYS.filterMode,
+    search: customQueryKeys?.search ?? DEFAULT_QUERY_KEYS.search,
+    paginationMode: customQueryKeys?.paginationMode ?? DEFAULT_QUERY_KEYS.paginationMode,
+    page: customQueryKeys?.page ?? DEFAULT_QUERY_KEYS.page,
+    limit: customQueryKeys?.limit ?? DEFAULT_QUERY_KEYS.limit,
+    cursor: customQueryKeys?.cursor ?? DEFAULT_QUERY_KEYS.cursor,
+    orders: customQueryKeys?.orders ?? DEFAULT_QUERY_KEYS.orders
+  };
+}
+function mergeDefaultQueryValues(defaultQueryValues) {
+  if (defaultQueryValues === void 0) {
+    return {
+      pagination: {
+        mode: DEFAULT_PAGINATION_MODE,
+        page: DEFAULT_PAGE,
+        limit: DEFAULT_LIMIT,
+        cursor: DEFAULT_CURSOR
+      },
+      sorting: {
+        orders: []
+      },
+      filtering: {
+        mode: DEFAULT_FILTER_MODE,
+        search: DEFAULT_SEARCH,
+        filters: []
+      }
+    };
+  }
+  return {
+    pagination: {
+      mode: defaultQueryValues.paginationMode ?? DEFAULT_PAGINATION_MODE,
+      page: defaultQueryValues.page ?? DEFAULT_PAGE,
+      limit: defaultQueryValues.limit ?? DEFAULT_LIMIT,
+      cursor: defaultQueryValues.cursor ?? DEFAULT_CURSOR
+    },
+    sorting: {
+      orders: defaultQueryValues.orders ?? []
+    },
+    filtering: {
+      mode: defaultQueryValues.filterMode ?? DEFAULT_FILTER_MODE,
+      search: defaultQueryValues.search ?? DEFAULT_SEARCH,
+      filters: defaultQueryValues.filters ?? []
+    }
+  };
+}
+
+// src/helpers.ts
+function isPaginationMode(v) {
+  return v === "offset" || v === "cursor";
+}
+function isOrderDirection(v) {
+  return v === "asc" || v === "desc";
+}
+function isFilterMode(v) {
+  return v === "search" || v === "filter";
+}
+function toPositiveInt(value, fallback) {
+  const n = Number(value);
+  return Number.isFinite(n) && n > 0 ? n : fallback;
+}
+function isFilterOperator(v) {
+  return FILTER_OPERATORS.includes(v);
+}
+
+// src/parse-query-object.ts
+function parseQueryObject({
+  query,
+  queryKeys
+}) {
+  const keys = mergeDefaultAndCustomQueryKeys(queryKeys);
+  const reserved = new Set(Object.values(keys));
+  const filters = {};
+  for (const [key, value] of Object.entries(query)) {
+    if (!reserved.has(key)) {
+      filters[key] = value;
+    }
+  }
+  return {
+    pagination: {
+      mode: query[keys.paginationMode],
+      page: query[keys.page],
+      limit: query[keys.limit],
+      cursor: query[keys.cursor]
+    },
+    sorting: {
+      orders: query[keys.orders]
+    },
+    filtering: {
+      mode: query[keys.filterMode],
+      search: query[keys.search],
+      filters
+    }
+  };
+}
+
+// src/normalize-parsed-query-object.ts
+function normalizeParsedQueryObject({
+  parsedQuery,
+  defaultQueryValues
+}) {
+  const defaultValues = mergeDefaultQueryValues(defaultQueryValues);
+  const paginationMode = isPaginationMode(parsedQuery.pagination.mode) ? parsedQuery.pagination.mode : defaultValues.pagination.mode;
+  const page = toPositiveInt(
+    parsedQuery.pagination.page,
+    defaultValues.pagination.page
+  );
+  const limit = toPositiveInt(
+    parsedQuery.pagination.limit,
+    defaultValues.pagination.limit
+  );
+  const cursor = parsedQuery.pagination.cursor ?? defaultValues.pagination.cursor;
+  const pagination = paginationMode === "offset" ? {
+    mode: "offset",
+    page,
+    limit
+  } : {
+    mode: "cursor",
+    cursor,
+    limit
+  };
+  const explodedOrders = parsedQuery.sorting.orders?.split(",") || [];
+  const orders = explodedOrders.map((order) => {
+    const [column, direction] = order.split(COL_DIRECTION_SEPARATOR).map((s) => s.trim());
+    if (!column) return null;
+    return {
+      column,
+      direction: isOrderDirection(direction) ? direction : "asc"
+    };
+  }).filter((item) => item !== null);
+  const filters = Object.entries(parsedQuery.filtering.filters).map(([colOperator, value]) => {
+    const [col, operator] = colOperator.split(COL_OPERATOR_SEPARATOR);
+    if (!col || !isFilterOperator(operator)) return null;
+    const column = col.trim();
+    const valueTrimmed = value.trim();
+    return {
+      column,
+      operator,
+      value: valueTrimmed
+    };
+  }).filter((item) => item !== null);
+  return {
+    pagination,
+    sorting: {
+      orders
+    },
+    filtering: {
+      mode: isFilterMode(parsedQuery.filtering.mode) ? parsedQuery.filtering.mode : defaultValues.filtering.mode,
+      search: parsedQuery.filtering.search ?? defaultValues.filtering.search,
+      filters
+    }
+  };
+}
+
+// src/parse-and-normalize-query-object.ts
+function parseAndNormalizeQueryObject(options) {
+  const parsed = parseQueryObject({
+    query: options.query,
+    queryKeys: options.queryKeys
+  });
+  const normalized = normalizeParsedQueryObject({
+    parsedQuery: parsed,
+    defaultQueryValues: options.defaultQueryValues
+  });
+  return {
+    parsed,
+    normalized
+  };
+}
+function parseAndNormalize(options) {
+  return parseAndNormalizeQueryObject(options);
+}
+export {
+  COL_DIRECTION_SEPARATOR,
+  COL_OPERATOR_SEPARATOR,
+  DEFAULT_CURSOR,
+  DEFAULT_CURSOR_KEY,
+  DEFAULT_FILTER_MODE,
+  DEFAULT_FILTER_MODE_KEY,
+  DEFAULT_LIMIT,
+  DEFAULT_LIMIT_KEY,
+  DEFAULT_ORDERS_KEY,
+  DEFAULT_PAGE,
+  DEFAULT_PAGE_KEY,
+  DEFAULT_PAGINATION_MODE,
+  DEFAULT_PAGINATION_MODE_KEY,
+  DEFAULT_SEARCH,
+  DEFAULT_SEARCH_KEY,
+  FILTER_OPERATORS,
+  isFilterMode,
+  isFilterOperator,
+  isOrderDirection,
+  isPaginationMode,
+  mergeDefaultAndCustomQueryKeys,
+  mergeDefaultQueryValues,
+  normalizeParsedQueryObject,
+  parseAndNormalize,
+  parseAndNormalizeQueryObject,
+  parseQueryObject,
+  toPositiveInt
+};

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@mikevar/data-grid",
+  "version": "0.0.1",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "dist/index.cjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "tsup": "^8.5.0",
+    "vitest": "^3.2.4"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mikevar/ts-mikevar-library.git"
+  },
+  "scripts": {
+    "test": "vitest src",
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "dev": "tsup src/index.ts --format esm,cjs --dts --watch"
+  }
+}