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

feat: export parse order by helper

Author: psteinroe

.changeset/grumpy-rice-chew.md

@@ -0,0 +1,5 @@
+---
+"@supabase-cache-helpers/postgrest-core": patch
+---
+
+feat: extrat and export parse order by helper

packages/postgrest-core/src/index.ts

@@ -13,6 +13,7 @@ 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/parse-order-by';
 export * from './lib/find-filters';
 
 export * from './cursor-pagination-fetcher';

packages/postgrest-core/src/lib/parse-order-by.ts

@@ -0,0 +1,23 @@
+import { OrderDefinition } from './query-types';
+
+export const parseOrderBy = (searchParams: URLSearchParams) => {
+  const orderBy: OrderDefinition[] = [];
+  searchParams.forEach((value, key) => {
+    const split = key.split('.');
+    if (split[split.length === 2 ? 1 : 0] === 'order') {
+      // separated by ,
+      const orderByDefs = value.split(',');
+      orderByDefs.forEach((def) => {
+        const [column, ascending, nullsFirst] = def.split('.');
+        orderBy.push({
+          ascending: ascending === 'asc',
+          column,
+          nullsFirst: nullsFirst === 'nullsfirst',
+          foreignTable: split.length === 2 ? split[0] : undefined,
+        });
+      });
+    }
+  });
+
+  return orderBy;
+};

packages/postgrest-core/src/postgrest-parser.ts

@@ -3,6 +3,7 @@ import type { PostgrestBuilder } from '@supabase/postgrest-js';
 import { encodeObject } from './lib/encode-object';
 import { getTableFromUrl } from './lib/get-table-from-url';
 import { isObject } from './lib/is-object';
+import { parseOrderBy } from './lib/parse-order-by';
 import type { OrderDefinition } from './lib/query-types';
 import { sortSearchParams } from './lib/sort-search-param';
 import {
@@ -69,22 +70,7 @@ export class PostgrestParser<Result> extends PostgrestQueryParser {
     const offset = this._url.searchParams.get('offset');
     this.offset = offset ? Number(offset) : undefined;
 
-    this._url.searchParams.forEach((value, key) => {
-      const split = key.split('.');
-      if (split[split.length === 2 ? 1 : 0] === 'order') {
-        // separated by ,
-        const orderByDefs = value.split(',');
-        orderByDefs.forEach((def) => {
-          const [column, ascending, nullsFirst] = def.split('.');
-          this.orderBy.push({
-            ascending: ascending === 'asc',
-            column,
-            nullsFirst: nullsFirst === 'nullsfirst',
-            foreignTable: split.length === 2 ? split[0] : undefined,
-          });
-        });
-      }
-    });
+    this.orderBy = parseOrderBy(this._url.searchParams);
     this.orderByKey = this.orderBy
       .map(
         ({ column, ascending, nullsFirst, foreignTable }) =>

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

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