@taruvi/refine-providers 1.3.4-beta.0 → 1.3.4-beta.2

package/dist/index.d.cts

@@ -186,6 +186,8 @@ interface TaruviMeta extends MetaQuery {
     idColumnName?: string;
     /** Fields to select/return. */
     select?: string | string[];
+    /** Full-text search (`?search=`) when the table has `search_vector`. */
+    search?: string;
     /** Override the table name for API calls (when resource name differs from table name). */
     tableName?: string;
     /** Override the bucket name for storage API calls (when resource name differs from bucket name). */
@@ -242,6 +244,38 @@ type ConvertRefineFiltersOptions = {
      */
     logicalEncoding?: "bracket" | "flatten";
 };
+/** One leaf filter ready for flat `field__op=value` query encoding. */
+type FlatFilterLeaf = {
+    field: string;
+    operator: string;
+    value: unknown;
+};
+/** Root logical filter for JSON `filters` query param (not wrapped in an array). */
+type LogicalCrudFilter = {
+    operator: "and" | "or";
+    value: CrudFilter[];
+};
+/**
+ * Taruvi list filter payload: leaf array → flat query params; logical object → JSON tree.
+ */
+type TaruviListFilters = FlatFilterLeaf[] | LogicalCrudFilter;
+/** True when `filters` is a non-logical array of field leaves (may be empty). */
+declare function isFlatFilterList(filters: unknown): filters is FlatFilterLeaf[];
+/** True when `filters` is a single logical object (and / or), not an array. */
+declare function isLogicalCrudFilter(filters: unknown): filters is LogicalCrudFilter;
+/**
+ * Normalize Refine `CrudFilter[]` or Taruvi payloads for `applyFilters`.
+ * Legacy: all field leaves → flat array; single root logical → logical object.
+ */
+declare function normalizeTaruviListFilters(filters: unknown): TaruviListFilters | undefined;
+/**
+ * Collect field filters that can be sent as top-level query params (implicit AND).
+ *
+ * Returns `null` when the list contains `or` or other shapes that require the JSON
+ * `filters` tree. FK-traversal fields (`department_id.name`, etc.) must use flat
+ * params on the current platform — nesting them under JSON `and` breaks traversal.
+ */
+declare function collectFlatLeaves(filters?: CrudFilter[]): FlatFilterLeaf[] | null;
 /** Backend operator token for CrudFilters bracket payloads (suffix or `eq`). */
 declare function refineOperatorToBackendKey(operator: string): string;
 /** String value for a leaf filter (flat or bracket). */
@@ -253,10 +287,15 @@ declare function encodeCrudFilterBracket(filter: CrudFilter, path: string, out:
  * (root array of `{ operator: "and"|"or", value: [...] }` nodes).
  *
  * Leaf `operator` values are **Taruvi / platform** tokens after `refineOperatorToBackendKey`.
- * String contains variants are normalized to backend-safe case-sensitive LIKE tokens so the
- * frontend does not depend on comparator-specific support in the backend SQLAlchemy build.
+ * Leaf `operator` values use Taruvi / platform tokens from `refineOperatorToBackendKey`.
  */
 declare function convertRefineFiltersToBackendTree(filters?: CrudFilter[]): BackendFilterTreeRoot | null;
+/**
+ * Converts one logical CrudFilter object into the backend JSON `filters` tree root.
+ */
+declare function convertLogicalFilterToBackendTree(filter: LogicalCrudFilter): BackendFilterTreeRoot | null;
+/** Encode leaf filters as flat `field__op` query param keys. */
+declare function encodeFlatFilterListToParams(leaves: FlatFilterLeaf[]): Record<string, string>;
 /**
  * Converts Refine CrudFilter[] to Taruvi query parameters.
  * Logical `and` / `or` use CrudFilters bracket notation unless `logicalEncoding: 'flatten'`.
@@ -296,4 +335,4 @@ declare function buildQueryString(params?: Record<string, unknown>): string;
  */
 declare function handleError(error: unknown): never;
 
-export { type AllowedAction, type AnalyticsMeta, type AppCustomMeta, type ConvertRefineFiltersOptions, type FunctionMeta, type LoginParams, type LogoutParams, REFINE_OPERATOR_MAP, type RegisterParams, type StorageDownloadResponse, type StorageUploadVariables, type TaruviListResponse, type TaruviMeta, _cachedUser, accessControlProvider, analyticsDataProvider, appDataProvider, applyRefineQueryParamsToDatabase, authProvider, buildQueryString, buildRefineQueryParams, convertRefineFilters, convertRefineFiltersToBackendTree, convertRefinePagination, convertRefineSorters, dataProvider, encodeCrudFilterBracket, formatRefineLeafValue, functionsDataProvider, handleError, refineOperatorToBackendKey, storageDataProvider, userDataProvider };
+export { type AllowedAction, type AnalyticsMeta, type AppCustomMeta, type ConvertRefineFiltersOptions, type FlatFilterLeaf, type FunctionMeta, type LogicalCrudFilter, type LoginParams, type LogoutParams, REFINE_OPERATOR_MAP, type RegisterParams, type StorageDownloadResponse, type StorageUploadVariables, type TaruviListFilters, type TaruviListResponse, type TaruviMeta, _cachedUser, accessControlProvider, analyticsDataProvider, appDataProvider, applyRefineQueryParamsToDatabase, authProvider, buildQueryString, buildRefineQueryParams, collectFlatLeaves, convertLogicalFilterToBackendTree, convertRefineFilters, convertRefineFiltersToBackendTree, convertRefinePagination, convertRefineSorters, dataProvider, encodeCrudFilterBracket, encodeFlatFilterListToParams, formatRefineLeafValue, functionsDataProvider, handleError, isFlatFilterList, isLogicalCrudFilter, normalizeTaruviListFilters, refineOperatorToBackendKey, storageDataProvider, userDataProvider };

package/dist/index.d.ts

@@ -186,6 +186,8 @@ interface TaruviMeta extends MetaQuery {
     idColumnName?: string;
     /** Fields to select/return. */
     select?: string | string[];
+    /** Full-text search (`?search=`) when the table has `search_vector`. */
+    search?: string;
     /** Override the table name for API calls (when resource name differs from table name). */
     tableName?: string;
     /** Override the bucket name for storage API calls (when resource name differs from bucket name). */
@@ -242,6 +244,38 @@ type ConvertRefineFiltersOptions = {
      */
     logicalEncoding?: "bracket" | "flatten";
 };
+/** One leaf filter ready for flat `field__op=value` query encoding. */
+type FlatFilterLeaf = {
+    field: string;
+    operator: string;
+    value: unknown;
+};
+/** Root logical filter for JSON `filters` query param (not wrapped in an array). */
+type LogicalCrudFilter = {
+    operator: "and" | "or";
+    value: CrudFilter[];
+};
+/**
+ * Taruvi list filter payload: leaf array → flat query params; logical object → JSON tree.
+ */
+type TaruviListFilters = FlatFilterLeaf[] | LogicalCrudFilter;
+/** True when `filters` is a non-logical array of field leaves (may be empty). */
+declare function isFlatFilterList(filters: unknown): filters is FlatFilterLeaf[];
+/** True when `filters` is a single logical object (and / or), not an array. */
+declare function isLogicalCrudFilter(filters: unknown): filters is LogicalCrudFilter;
+/**
+ * Normalize Refine `CrudFilter[]` or Taruvi payloads for `applyFilters`.
+ * Legacy: all field leaves → flat array; single root logical → logical object.
+ */
+declare function normalizeTaruviListFilters(filters: unknown): TaruviListFilters | undefined;
+/**
+ * Collect field filters that can be sent as top-level query params (implicit AND).
+ *
+ * Returns `null` when the list contains `or` or other shapes that require the JSON
+ * `filters` tree. FK-traversal fields (`department_id.name`, etc.) must use flat
+ * params on the current platform — nesting them under JSON `and` breaks traversal.
+ */
+declare function collectFlatLeaves(filters?: CrudFilter[]): FlatFilterLeaf[] | null;
 /** Backend operator token for CrudFilters bracket payloads (suffix or `eq`). */
 declare function refineOperatorToBackendKey(operator: string): string;
 /** String value for a leaf filter (flat or bracket). */
@@ -253,10 +287,15 @@ declare function encodeCrudFilterBracket(filter: CrudFilter, path: string, out:
  * (root array of `{ operator: "and"|"or", value: [...] }` nodes).
  *
  * Leaf `operator` values are **Taruvi / platform** tokens after `refineOperatorToBackendKey`.
- * String contains variants are normalized to backend-safe case-sensitive LIKE tokens so the
- * frontend does not depend on comparator-specific support in the backend SQLAlchemy build.
+ * Leaf `operator` values use Taruvi / platform tokens from `refineOperatorToBackendKey`.
  */
 declare function convertRefineFiltersToBackendTree(filters?: CrudFilter[]): BackendFilterTreeRoot | null;
+/**
+ * Converts one logical CrudFilter object into the backend JSON `filters` tree root.
+ */
+declare function convertLogicalFilterToBackendTree(filter: LogicalCrudFilter): BackendFilterTreeRoot | null;
+/** Encode leaf filters as flat `field__op` query param keys. */
+declare function encodeFlatFilterListToParams(leaves: FlatFilterLeaf[]): Record<string, string>;
 /**
  * Converts Refine CrudFilter[] to Taruvi query parameters.
  * Logical `and` / `or` use CrudFilters bracket notation unless `logicalEncoding: 'flatten'`.
@@ -296,4 +335,4 @@ declare function buildQueryString(params?: Record<string, unknown>): string;
  */
 declare function handleError(error: unknown): never;
 
-export { type AllowedAction, type AnalyticsMeta, type AppCustomMeta, type ConvertRefineFiltersOptions, type FunctionMeta, type LoginParams, type LogoutParams, REFINE_OPERATOR_MAP, type RegisterParams, type StorageDownloadResponse, type StorageUploadVariables, type TaruviListResponse, type TaruviMeta, _cachedUser, accessControlProvider, analyticsDataProvider, appDataProvider, applyRefineQueryParamsToDatabase, authProvider, buildQueryString, buildRefineQueryParams, convertRefineFilters, convertRefineFiltersToBackendTree, convertRefinePagination, convertRefineSorters, dataProvider, encodeCrudFilterBracket, formatRefineLeafValue, functionsDataProvider, handleError, refineOperatorToBackendKey, storageDataProvider, userDataProvider };
+export { type AllowedAction, type AnalyticsMeta, type AppCustomMeta, type ConvertRefineFiltersOptions, type FlatFilterLeaf, type FunctionMeta, type LogicalCrudFilter, type LoginParams, type LogoutParams, REFINE_OPERATOR_MAP, type RegisterParams, type StorageDownloadResponse, type StorageUploadVariables, type TaruviListFilters, type TaruviListResponse, type TaruviMeta, _cachedUser, accessControlProvider, analyticsDataProvider, appDataProvider, applyRefineQueryParamsToDatabase, authProvider, buildQueryString, buildRefineQueryParams, collectFlatLeaves, convertLogicalFilterToBackendTree, convertRefineFilters, convertRefineFiltersToBackendTree, convertRefinePagination, convertRefineSorters, dataProvider, encodeCrudFilterBracket, encodeFlatFilterListToParams, formatRefineLeafValue, functionsDataProvider, handleError, isFlatFilterList, isLogicalCrudFilter, normalizeTaruviListFilters, refineOperatorToBackendKey, storageDataProvider, userDataProvider };

package/dist/index.js

@@ -5,7 +5,7 @@ import DataLoader from 'dataloader';
 
 // package.json
 var package_default = {
-  version: "1.3.4-beta.0"};
+  version: "1.3.4-beta.2"};
 
 // src/utils.ts
 var REFINE_OPERATOR_MAP = {
@@ -18,23 +18,26 @@ var REFINE_OPERATOR_MAP = {
   gt: "gt",
   lte: "lte",
   gte: "gte",
-  // String operators mapped to backend-safe case-sensitive LIKE variants.
-  contains: "containss",
-  ncontains: "ncontainss",
+  // String matching — Taruvi wire suffix matches platform filter_translator.
+  contains: "contains",
+  ncontains: "ncontains",
   containss: "containss",
   ncontainss: "ncontainss",
-  // String operators mapped to backend-safe case-sensitive prefix/suffix LIKE.
-  startswith: "startswiths",
-  nstartswith: "nstartswiths",
-  endswith: "endswiths",
-  nendswith: "nendswiths",
+  startswith: "startswith",
+  nstartswith: "nstartswith",
+  endswith: "endswith",
+  nendswith: "nendswith",
   startswiths: "startswiths",
   nstartswiths: "nstartswiths",
   endswiths: "endswiths",
   nendswiths: "nendswiths",
-  // Aliases mapped to backend-safe case-sensitive LIKE variants.
-  icontains: "containss",
-  nicontains: "ncontainss",
+  // Refine aliases → platform insensitive tokens
+  icontains: "contains",
+  nicontains: "ncontains",
+  istartswith: "startswith",
+  nistartswith: "nstartswith",
+  iendswith: "endswith",
+  niendswith: "nendswith",
   // Array / membership
   in: "in",
   nin: "nin",
@@ -95,6 +98,66 @@ function isLogicalFilter(filter) {
 function isFieldFilter(filter) {
   return typeof filter === "object" && filter !== null && "field" in filter && "operator" in filter && typeof filter.field === "string" && typeof filter.operator === "string";
 }
+function isFlatFilterList(filters) {
+  if (!Array.isArray(filters)) return false;
+  return filters.every((f) => {
+    if (!isFieldFilter(f)) return false;
+    const leaf = f;
+    if (leaf.value === void 0 || leaf.value === null && leaf.operator !== "null") {
+      return false;
+    }
+    if (REFINE_OPERATOR_MAP[leaf.operator] === void 0) {
+      return false;
+    }
+    return true;
+  });
+}
+function isLogicalCrudFilter(filters) {
+  return typeof filters === "object" && filters !== null && !Array.isArray(filters) && isLogicalFilter(filters);
+}
+function normalizeTaruviListFilters(filters) {
+  if (filters === void 0 || filters === null) return void 0;
+  if (isLogicalCrudFilter(filters)) return filters;
+  if (isFlatFilterList(filters)) return filters;
+  if (!Array.isArray(filters) || filters.length === 0) return void 0;
+  if (filters.length === 1 && isLogicalFilter(filters[0])) {
+    return filters[0];
+  }
+  if (filters.every(isFieldFilter)) {
+    return filters;
+  }
+  return void 0;
+}
+function collectFlatLeaves(filters) {
+  if (!filters?.length) return [];
+  const leaves = [];
+  const walk = (group) => {
+    for (const filter of group) {
+      if (isLogicalFilter(filter)) {
+        if (filter.operator === "or") return false;
+        if (!walk(filter.value)) return false;
+        continue;
+      }
+      if (!isFieldFilter(filter)) return false;
+      const leaf = filter;
+      if (leaf.value === void 0 || leaf.value === null && leaf.operator !== "null") {
+        continue;
+      }
+      if (REFINE_OPERATOR_MAP[leaf.operator] === void 0) {
+        console.warn(`Unknown Refine operator: ${leaf.operator}`);
+        return false;
+      }
+      leaves.push({
+        field: leaf.field,
+        operator: leaf.operator,
+        value: leaf.value
+      });
+    }
+    return true;
+  };
+  if (!walk(filters)) return null;
+  return leaves;
+}
 function refineOperatorToBackendKey(operator) {
   const suffix = REFINE_OPERATOR_MAP[operator];
   if (suffix === void 0) return operator;
@@ -188,6 +251,18 @@ function convertRefineFiltersToBackendTree(filters) {
   }
   return [{ operator: "and", value: nodes }];
 }
+function convertLogicalFilterToBackendTree(filter) {
+  const node = crudFilterToBackendNodeOrNull(filter);
+  if (!node || !isLogicalBackendNode(node)) return null;
+  return [node];
+}
+function encodeFlatFilterListToParams(leaves) {
+  const params = {};
+  for (const leaf of leaves) {
+    encodeLeafFlat(leaf.field, leaf.operator, leaf.value, params);
+  }
+  return params;
+}
 function convertRefineFiltersFlattened(filters) {
   if (!filters || filters.length === 0) return {};
   const params = {};
@@ -330,11 +405,38 @@ function applyAggregations(query, meta) {
   }
   return result;
 }
+function applyFlatFilterList(query, leaves) {
+  let result = query;
+  for (const { field, operator, value } of leaves) {
+    const backendOp = refineOperatorToBackendKey(operator);
+    const formatted = formatRefineLeafValue(operator, value);
+    result = result.filters(
+      field,
+      backendOp,
+      formatted
+    );
+  }
+  return result;
+}
 function applyFilters(query, filters) {
-  if (!filters || filters.length === 0) return query;
-  const tree = convertRefineFiltersToBackendTree(filters);
-  if (!tree) return query;
-  return query.filters(tree);
+  const normalized = normalizeTaruviListFilters(filters);
+  if (normalized === void 0) {
+    if (Array.isArray(filters) && filters.length > 0) {
+      const tree = convertRefineFiltersToBackendTree(filters);
+      if (tree) return query.filters(tree);
+    }
+    return query;
+  }
+  if (isFlatFilterList(normalized)) {
+    if (normalized.length === 0) return query;
+    return applyFlatFilterList(query, normalized);
+  }
+  if (isLogicalCrudFilter(normalized)) {
+    const tree = convertLogicalFilterToBackendTree(normalized);
+    if (!tree) return query;
+    return query.filters(tree);
+  }
+  return query;
 }
 function applySorters(query, sorters) {
   const ordering = convertRefineSorters(sorters);
@@ -356,6 +458,16 @@ function applyAllowedActions(query, meta) {
   if (!meta?.allowedActions?.length) return query;
   return query.allowedActions(meta.allowedActions);
 }
+function applySearchAndFields(query, meta) {
+  if (!meta) return query;
+  let result = query;
+  const search = meta.search?.trim();
+  if (search) result = result.search(search);
+  const select = meta.select;
+  const fields = typeof select === "string" ? select.trim() : Array.isArray(select) ? select.map(String).join(",") : "";
+  if (fields) result = result.fields(fields);
+  return result;
+}
 function isGraphQuery(meta) {
   return !!(meta?.format || meta?.graph_types || meta?.include || meta?.depth);
 }
@@ -393,6 +505,7 @@ function dataProvider(client) {
       query = applyPagination(query, pagination);
       query = applyPopulate(query, taruviMeta);
       query = applyAggregations(query, taruviMeta);
+      query = applySearchAndFields(query, taruviMeta);
       query = applyAllowedActions(query, taruviMeta);
       const response = await query.execute();
       return { data: response.data, total: response.total };
@@ -1235,6 +1348,6 @@ function accessControlProvider(client, options) {
   };
 }
 
-export { REFINE_OPERATOR_MAP, _cachedUser, accessControlProvider, analyticsDataProvider, appDataProvider, applyRefineQueryParamsToDatabase, authProvider, buildQueryString, buildRefineQueryParams, convertRefineFilters, convertRefineFiltersToBackendTree, convertRefinePagination, convertRefineSorters, dataProvider, encodeCrudFilterBracket, formatRefineLeafValue, functionsDataProvider, handleError, refineOperatorToBackendKey, storageDataProvider, userDataProvider };
+export { REFINE_OPERATOR_MAP, _cachedUser, accessControlProvider, analyticsDataProvider, appDataProvider, applyRefineQueryParamsToDatabase, authProvider, buildQueryString, buildRefineQueryParams, collectFlatLeaves, convertLogicalFilterToBackendTree, convertRefineFilters, convertRefineFiltersToBackendTree, convertRefinePagination, convertRefineSorters, dataProvider, encodeCrudFilterBracket, encodeFlatFilterListToParams, formatRefineLeafValue, functionsDataProvider, handleError, isFlatFilterList, isLogicalCrudFilter, normalizeTaruviListFilters, refineOperatorToBackendKey, storageDataProvider, userDataProvider };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map