feat: support embedded or filter (#160)

Author: bmartel

src/lib/PostgrestFilterBuilder.ts

@@ -47,9 +47,11 @@ export default class PostgrestFilterBuilder<T> extends PostgrestTransformBuilder
    * Finds all rows satisfying at least one of the filters.
    *
    * @param filters  The filters to use, separated by commas.
+   * @param foreignTable  The foreign table to use (if `column` is a foreign column).
    */
-  or(filters: string): this {
-    this.url.searchParams.append('or', `(${filters})`)
+  or(filters: string, { foreignTable }: { foreignTable?: string } = {}): this {
+    const key = typeof foreignTable === 'undefined' ? 'or' : `${foreignTable}.or`
+    this.url.searchParams.append(key, `(${filters})`)
     return this
   }
 

test/__snapshots__/index.test.ts.snap

@@ -790,6 +790,140 @@ Object {
 }
 `;
 
+exports[`embedded filters embedded or 1`] = `
+Object {
+  "body": Array [
+    Object {
+      "messages": Array [
+        Object {
+          "channel_id": 1,
+          "data": null,
+          "id": 1,
+          "message": "Hello World 👋",
+          "username": "supabot",
+        },
+        Object {
+          "channel_id": 2,
+          "data": null,
+          "id": 2,
+          "message": "Perfection is attained, not when there is nothing more to add, but when there is nothing left to take away.",
+          "username": "supabot",
+        },
+      ],
+    },
+    Object {
+      "messages": Array [],
+    },
+    Object {
+      "messages": Array [],
+    },
+    Object {
+      "messages": Array [],
+    },
+  ],
+  "count": null,
+  "data": Array [
+    Object {
+      "messages": Array [
+        Object {
+          "channel_id": 1,
+          "data": null,
+          "id": 1,
+          "message": "Hello World 👋",
+          "username": "supabot",
+        },
+        Object {
+          "channel_id": 2,
+          "data": null,
+          "id": 2,
+          "message": "Perfection is attained, not when there is nothing more to add, but when there is nothing left to take away.",
+          "username": "supabot",
+        },
+      ],
+    },
+    Object {
+      "messages": Array [],
+    },
+    Object {
+      "messages": Array [],
+    },
+    Object {
+      "messages": Array [],
+    },
+  ],
+  "error": null,
+  "status": 200,
+  "statusText": "OK",
+}
+`;
+
+exports[`embedded filters embedded or with and 1`] = `
+Object {
+  "body": Array [
+    Object {
+      "messages": Array [
+        Object {
+          "channel_id": 1,
+          "data": null,
+          "id": 1,
+          "message": "Hello World 👋",
+          "username": "supabot",
+        },
+        Object {
+          "channel_id": 2,
+          "data": null,
+          "id": 2,
+          "message": "Perfection is attained, not when there is nothing more to add, but when there is nothing left to take away.",
+          "username": "supabot",
+        },
+      ],
+    },
+    Object {
+      "messages": Array [],
+    },
+    Object {
+      "messages": Array [],
+    },
+    Object {
+      "messages": Array [],
+    },
+  ],
+  "count": null,
+  "data": Array [
+    Object {
+      "messages": Array [
+        Object {
+          "channel_id": 1,
+          "data": null,
+          "id": 1,
+          "message": "Hello World 👋",
+          "username": "supabot",
+        },
+        Object {
+          "channel_id": 2,
+          "data": null,
+          "id": 2,
+          "message": "Perfection is attained, not when there is nothing more to add, but when there is nothing left to take away.",
+          "username": "supabot",
+        },
+      ],
+    },
+    Object {
+      "messages": Array [],
+    },
+    Object {
+      "messages": Array [],
+    },
+    Object {
+      "messages": Array [],
+    },
+  ],
+  "error": null,
+  "status": 200,
+  "statusText": "OK",
+}
+`;
+
 exports[`embedded select 1`] = `
 Object {
   "body": Array [

test/resource-embedding.ts

@@ -13,6 +13,20 @@ describe('embedded filters', () => {
     const res = await postgrest.from('users').select('messages(*)').eq('messages.channel_id', 1)
     expect(res).toMatchSnapshot()
   })
+  test('embedded or', async () => {
+    const res = await postgrest
+      .from('users')
+      .select('messages(*)')
+      .or('channel_id.eq.2,message.eq.Hello World 👋', { foreignTable: 'messages' })
+    expect(res).toMatchSnapshot()
+  })
+  test('embedded or with and', async () => {
+    const res = await postgrest
+      .from('users')
+      .select('messages(*)')
+      .or('channel_id.eq.2,and(message.eq.Hello World 👋,username.eq.supabot)', { foreignTable: 'messages' })
+    expect(res).toMatchSnapshot()
+  })
 })
 
 describe('embedded transforms', () => {