feat: add geojson transform

Also change the docker image to include postgis

Author: steve-chavez

packages/core/postgrest-js/src/lib/PostgrestTransformBuilder.ts

@@ -120,4 +120,12 @@ export default class PostgrestTransformBuilder<T> extends PostgrestBuilder<T> {
     this.headers['Accept'] = 'text/csv'
     return this as PromiseLike<PostgrestSingleResponse<string>>
   }
+
+  /**
+   * Set the response type to GeoJSON.
+   */
+  geojson(): PromiseLike<PostgrestSingleResponse<Record<string, unknown>>> {
+    this.headers['Accept'] = 'application/geo+json'
+    return this as PromiseLike<PostgrestSingleResponse<Record<string, unknown>>>
+  }
 }

packages/core/postgrest-js/test/db/00-schema.sql

@@ -13,7 +13,7 @@ CREATE TABLE public.users (
   status user_status DEFAULT 'ONLINE'::public.user_status,
   catchphrase tsvector DEFAULT null
 );
-ALTER TABLE public.users REPLICA IDENTITY FULL; -- Send "previous data" to supabase 
+ALTER TABLE public.users REPLICA IDENTITY FULL; -- Send "previous data" to supabase
 COMMENT ON COLUMN public.users.data IS 'For unstructured data and prototyping.';
 
 -- CHANNELS
@@ -47,10 +47,18 @@ RETURNS TABLE(username text, status user_status) AS $$
   SELECT username, status from users WHERE username=name_param;
 $$ LANGUAGE SQL IMMUTABLE;
 
-CREATE FUNCTION public.void_func() 
+CREATE FUNCTION public.void_func()
 RETURNS void AS $$
 $$ LANGUAGE SQL;
 
+create extension postgis;
+
+create table public.shops (
+  id        int primary key
+, address   text
+, shop_geom geometry(POINT, 4326)
+);
+
 -- SECOND SCHEMA USERS
 CREATE TYPE personal.user_status AS ENUM ('ONLINE', 'OFFLINE');
 CREATE TABLE personal.users(

packages/core/postgrest-js/test/db/01-dummy-data.sql

@@ -25,4 +25,8 @@ VALUES
     ('kiwicopple', 'OFFLINE', '[25,35)'::int4range),
     ('awailas', 'ONLINE', '[25,35)'::int4range),
     ('dragarcia', 'ONLINE', '[20,30)'::int4range),
-    ('leroyjenkins', 'ONLINE', '[20,40)'::int4range);
+    ('leroyjenkins', 'ONLINE', '[20,40)'::int4range);
+
+INSERT INTO shops(id, address, shop_geom)
+VALUES
+  (1, '1369 Cambridge St', 'SRID=4326;POINT(-71.10044 42.373695)');

packages/core/postgrest-js/test/db/docker-compose.yml

@@ -13,7 +13,7 @@ services:
     depends_on:
       - db
   db:
-    image: postgres:12
+    image: postgis/postgis:12-3.2
     ports:
       - '5432:5432'
     volumes:

packages/core/postgrest-js/test/transforms.ts

@@ -101,3 +101,32 @@ test('abort signal', async () => {
     }
   `)
 })
+
+test('geojson', async () => {
+  const res = await postgrest
+    .from('shops')
+    .select()
+    .geojson()
+    .then((res) => res.data)
+  expect(res).toMatchInlineSnapshot(`
+    Object {
+      "features": Array [
+        Object {
+          "geometry": Object {
+            "coordinates": Array [
+              -71.10044,
+              42.373695,
+            ],
+            "type": "Point",
+          },
+          "properties": Object {
+            "address": "1369 Cambridge St",
+            "id": 1,
+          },
+          "type": "Feature",
+        },
+      ],
+      "type": "FeatureCollection",
+    }
+  `)
+})