Merge pull request #293 from psteinroe/feat/export-order-by

feat: export order by parser and add findFilters helper

.changeset/green-eyes-walk.md

@@ -0,0 +1,5 @@
+---
+"@supabase-cache-helpers/postgrest-core": patch
+---
+
+feat: export order by parser fn

.changeset/silver-beans-invent.md

@@ -0,0 +1,5 @@
+---
+"@supabase-cache-helpers/postgrest-core": minor
+---
+
+feat: add findFilters helper fn

packages/postgrest-core/__tests__/index.spec.ts

@@ -2,6 +2,6 @@ import * as Import from '../src';
 
 describe('index exports', () => {
   it('should export', () => {
-    expect(Object.keys(Import)).toHaveLength(30);
+    expect(Object.keys(Import)).toHaveLength(32);
   });
 });

packages/postgrest-core/__tests__/lib/find-filters.spec.ts

@@ -0,0 +1,129 @@
+import { SupabaseClient, createClient } from '@supabase/supabase-js';
+
+import { findFilters } from '../../src/lib/find-filters';
+import { PostgrestParser } from '../../src/postgrest-parser';
+
+describe('findFilters', () => {
+  let c: SupabaseClient;
+
+  beforeAll(() => {
+    c = createClient('https://localhost', '1234');
+  });
+
+  it('by path', () => {
+    expect(
+      findFilters(
+        new PostgrestParser(
+          c
+            .from('test')
+            .select('id', { head: true, count: 'exact' })
+            .eq('id', '123')
+            .contains('id', '456')
+        ).filters,
+        { path: 'id' }
+      )
+    ).toEqual([
+      {
+        alias: undefined,
+        negate: false,
+        operator: 'eq',
+        path: 'id',
+        value: 123,
+      },
+      {
+        alias: undefined,
+        negate: false,
+        operator: 'cs',
+        path: 'id',
+        value: 456,
+      },
+    ]);
+  });
+
+  it('by alias', () => {
+    expect(
+      findFilters(
+        new PostgrestParser(
+          c
+            .from('test')
+            .select('test:id', { head: true, count: 'exact' })
+            .eq('id', '123')
+            .contains('id', '456')
+        ).filters,
+        { alias: 'test' }
+      )
+    ).toEqual([
+      { alias: 'test', negate: false, operator: 'eq', path: 'id', value: 123 },
+      { alias: 'test', negate: false, operator: 'cs', path: 'id', value: 456 },
+    ]);
+  });
+
+  it('by operator', () => {
+    expect(
+      findFilters(
+        new PostgrestParser(
+          c
+            .from('test')
+            .select('id', { head: true, count: 'exact' })
+            .eq('id', '123')
+            .contains('id', '456')
+        ).filters,
+        { operator: 'eq' }
+      )
+    ).toEqual([
+      {
+        alias: undefined,
+        negate: false,
+        operator: 'eq',
+        path: 'id',
+        value: 123,
+      },
+    ]);
+  });
+
+  it('by negated operator', () => {
+    expect(
+      findFilters(
+        new PostgrestParser(
+          c
+            .from('test')
+            .select('id', { head: true, count: 'exact' })
+            .not('id', 'eq', '123')
+            .contains('id', '456')
+        ).filters,
+        { negate: true, operator: 'eq' }
+      )
+    ).toEqual([
+      {
+        alias: undefined,
+        negate: true,
+        operator: 'eq',
+        path: 'id',
+        value: 123,
+      },
+    ]);
+  });
+
+  it('by value', () => {
+    expect(
+      findFilters(
+        new PostgrestParser(
+          c
+            .from('test')
+            .select('id', { head: true, count: 'exact' })
+            .neq('id', '123')
+            .contains('id', '456')
+        ).filters,
+        { value: 123 }
+      )
+    ).toEqual([
+      {
+        alias: undefined,
+        negate: false,
+        operator: 'neq',
+        path: 'id',
+        value: 123,
+      },
+    ]);
+  });
+});

packages/postgrest-core/src/index.ts

@@ -11,6 +11,8 @@ export * from './lib/is-postgrest-builder';
 export * from './lib/get';
 export * from './lib/set-filter-value';
 export * from './lib/parse-value';
+export * from './lib/parse-order-by-key';
+export * from './lib/find-filters';
 
 export * from './cursor-pagination-fetcher';
 export * from './delete-fetcher';

packages/postgrest-core/src/lib/find-filters.ts

@@ -0,0 +1,35 @@
+import {
+  isAndFilter,
+  isOrFilter,
+  isFilterDefinition,
+  FilterDefinitions,
+  FilterDefinition,
+} from './query-types';
+
+// Helper to search for filters in a filter definition
+export const findFilters = (
+  f: FilterDefinitions,
+  by: Partial<FilterDefinition>
+) => {
+  const filters: FilterDefinition[] = [];
+  f.forEach((filter) => {
+    if (isAndFilter(filter)) {
+      filters.push(...findFilters(filter.and, by));
+    }
+    if (isOrFilter(filter)) {
+      filters.push(...findFilters(filter.or, by));
+    }
+    if (isFilterDefinition(filter)) {
+      if (
+        (typeof by.path === 'undefined' || filter.path === by.path) &&
+        (typeof by.alias === 'undefined' || filter.alias === by.alias) &&
+        (typeof by.value === 'undefined' || filter.value === by.value) &&
+        (typeof by.negate === 'undefined' || filter.negate === by.negate) &&
+        (typeof by.operator === 'undefined' || filter.operator === by.operator)
+      ) {
+        filters.push(filter);
+      }
+    }
+  });
+  return filters;
+};