@raphiniert/ra-data-postgrest 2.0.0-alpha.0 → 2.0.0-alpha.3

package/src/index.ts

@@ -1,4 +1,16 @@
-import { fetchUtils, DataProvider } from 'ra-core';
+import {
+    fetchUtils,
+    DataProvider,
+    GetListParams,
+    GetOneParams,
+    GetManyParams,
+    GetManyReferenceParams,
+    UpdateParams,
+    UpdateManyParams,
+    CreateParams,
+    DeleteParams,
+    DeleteManyParams,
+} from 'ra-core';
 import {
     PrimaryKey,
     PostgRestOperator,
@@ -12,6 +24,8 @@ import {
     decodeId,
     isCompoundKey,
 } from './urlBuilder';
+import qs from 'qs';
+
 /**
  * Maps react-admin queries to a postgrest REST API
  *
@@ -34,13 +48,24 @@ import {
  * @example
  *
  * import * as React from 'react';
- * import { Admin, Resource } from 'react-admin';
- * import postgrestRestProvider from '@promitheus/ra-data-postgrest';
+ * import { Admin, Resource, fetchUtils } from 'react-admin';
+ * import postgrestRestProvider,
+ *      { IDataProviderConfig,
+ *        defaultPrimaryKeys,
+ *        defaultSchema } from '@raphiniert/ra-data-postgrest';
  *
  * import { PostList } from './posts';
  *
+ * const config: IDataProviderConfig = {
+ *     apiUrl: 'http://path.to.my.api/',
+ *     httpClient: fetchUtils.fetchJson,
+ *     defaultListOp: 'eq',
+ *     primaryKeys: defaultPrimaryKeys,
+ *     schema: defaultSchema
+ * }
+ *
  * const App = () => (
- *     <Admin dataProvider={postgrestRestProvider('http://path.to.my.api/')}>
+ *     <Admin dataProvider={postgrestRestProvider(config)}>
  *         <Resource name="posts" list={PostList} />
  *     </Admin>
  * );
@@ -48,40 +73,79 @@ import {
  * export default App;
  */
 
-const defaultPrimaryKeys = new Map<string, PrimaryKey>();
-
-export default (
-    apiUrl: string,
-    httpClient = fetchUtils.fetchJson,
-    defaultListOp: PostgRestOperator = 'eq',
-    primaryKeys: Map<string, PrimaryKey> = defaultPrimaryKeys
-): DataProvider => ({
-    getList: (resource, params) => {
-        const primaryKey = getPrimaryKey(resource, primaryKeys);
+export type MetaOption = string | undefined;
+
+export const defaultPrimaryKeys = new Map<string, PrimaryKey>();
+
+export const defaultSchema = () => '';
+
+export interface IDataProviderConfig {
+    apiUrl: string;
+    httpClient: (string, Options) => Promise<any>;
+    defaultListOp: PostgRestOperator;
+    primaryKeys: Map<string, PrimaryKey>;
+    schema: () => string;
+}
+
+const useCustomSchema = (
+    schema: () => string,
+    metaSchema: MetaOption,
+    method: string
+) => {
+    let funcHeaderSchema = schema;
+    if (metaSchema !== undefined) {
+        funcHeaderSchema = () => metaSchema;
+    }
+
+    if (funcHeaderSchema().length > 0) {
+        let schemaHeader = '';
+        if (['GET', 'HEAD'].includes(method)) {
+            schemaHeader = 'Accept-Profile';
+        } else if (['POST', 'PATCH', 'PUT', 'DELETE'].includes(method)) {
+            schemaHeader = 'Content-Profile';
+        } else return {};
+
+        return { [schemaHeader]: funcHeaderSchema() };
+    } else return {};
+};
+
+export default (config: IDataProviderConfig): DataProvider => ({
+    getList: (resource, params: Partial<GetListParams> = {}) => {
+        const primaryKey = getPrimaryKey(resource, config.primaryKeys);
 
         const { page, perPage } = params.pagination;
-        const { field, order } = params.sort;
-        const parsedFilter = parseFilters(params.filter, defaultListOp);
+        const { field, order } = params.sort || {};
+        const { filter, select } = parseFilters(params, config.defaultListOp);
+        const metaSchema = params.meta?.schema;
 
-        const query = {
-            order: getOrderBy(field, order, primaryKey),
+        let query = {
             offset: String((page - 1) * perPage),
             limit: String(perPage),
             // append filters
-            ...parsedFilter,
+            ...filter,
         };
 
+        if (field) {
+            query.order = getOrderBy(field, order, primaryKey);
+        }
+
+        if (select) {
+            query.select = select;
+        }
+
         // add header that Content-Range is in returned header
         const options = {
             headers: new Headers({
                 Accept: 'application/json',
                 Prefer: 'count=exact',
+                ...(params.meta?.headers || {}),
+                ...useCustomSchema(config.schema, metaSchema, 'GET'),
             }),
         };
 
-        const url = `${apiUrl}/${resource}?${new URLSearchParams(query)}`;
+        const url = `${config.apiUrl}/${resource}?${qs.stringify(query)}`;
 
-        return httpClient(url, options).then(({ headers, json }) => {
+        return config.httpClient(url, options).then(({ headers, json }) => {
             if (!headers.has('content-range')) {
                 throw new Error(
                     `The Content-Range header is missing in the HTTP Response. The postgREST data provider expects 
@@ -99,68 +163,92 @@ export default (
         });
     },
 
-    getOne: (resource, params) => {
-        const id = params.id;
-        const primaryKey = getPrimaryKey(resource, primaryKeys);
+    getOne: (resource, params: Partial<GetOneParams> = {}) => {
+        const { id, meta } = params;
+        const primaryKey = getPrimaryKey(resource, config.primaryKeys);
 
-        const query = getQuery(primaryKey, id, resource);
+        const query = getQuery(primaryKey, id, resource, meta);
 
-        const url = `${apiUrl}/${resource}?${query}`;
+        const url = `${config.apiUrl}/${resource}?${qs.stringify(query)}`;
+        const metaSchema = params.meta?.schema;
 
-        return httpClient(url, {
-            headers: new Headers({
-                accept: 'application/vnd.pgrst.object+json',
-            }),
-        }).then(({ json }) => ({
-            data: dataWithId(json, primaryKey),
-        }));
+        return config
+            .httpClient(url, {
+                headers: new Headers({
+                    accept: 'application/vnd.pgrst.object+json',
+                    ...(params.meta?.headers || {}),
+                    ...useCustomSchema(config.schema, metaSchema, 'GET'),
+                }),
+            })
+            .then(({ json }) => ({
+                data: dataWithId(json, primaryKey),
+            }));
     },
 
-    getMany: (resource, params) => {
+    getMany: (resource, params: Partial<GetManyParams> = {}) => {
         const ids = params.ids;
-        const primaryKey = getPrimaryKey(resource, primaryKeys);
+        const primaryKey = getPrimaryKey(resource, config.primaryKeys);
 
-        const query = getQuery(primaryKey, ids, resource);
+        const query = getQuery(primaryKey, ids, resource, params.meta);
 
-        const url = `${apiUrl}/${resource}?${query}`;
+        const url = `${config.apiUrl}/${resource}?${qs.stringify(query)}`;
+        const metaSchema = params.meta?.schema;
 
-        return httpClient(url).then(({ json }) => ({
-            data: json.map(data => dataWithId(data, primaryKey)),
-        }));
+        return config
+            .httpClient(url, {
+                headers: new Headers({
+                    ...useCustomSchema(config.schema, metaSchema, 'GET'),
+                }),
+            })
+            .then(({ json }) => ({
+                data: json.map(data => dataWithId(data, primaryKey)),
+            }));
     },
 
-    getManyReference: (resource, params) => {
+    getManyReference: (
+        resource,
+        params: Partial<GetManyReferenceParams> = {}
+    ) => {
         const { page, perPage } = params.pagination;
         const { field, order } = params.sort;
-        const parsedFilter = parseFilters(params.filter, defaultListOp);
-        const primaryKey = getPrimaryKey(resource, primaryKeys);
 
-        const query = params.target
+        const { filter, select } = parseFilters(params, config.defaultListOp);
+        const primaryKey = getPrimaryKey(resource, config.primaryKeys);
+
+        const metaSchema = params.meta?.schema;
+
+        let query = params.target
             ? {
                   [params.target]: `eq.${params.id}`,
                   order: getOrderBy(field, order, primaryKey),
                   offset: String((page - 1) * perPage),
                   limit: String(perPage),
-                  ...parsedFilter,
+                  ...filter,
               }
             : {
                   order: getOrderBy(field, order, primaryKey),
                   offset: String((page - 1) * perPage),
                   limit: String(perPage),
-                  ...parsedFilter,
+                  ...filter,
               };
 
+        if (select) {
+            query.select = select;
+        }
+
         // add header that Content-Range is in returned header
         const options = {
             headers: new Headers({
                 Accept: 'application/json',
                 Prefer: 'count=exact',
+                ...(params.meta?.headers || {}),
+                ...useCustomSchema(config.schema, metaSchema, 'GET'),
             }),
         };
 
-        const url = `${apiUrl}/${resource}?${new URLSearchParams(query)}`;
+        const url = `${config.apiUrl}/${resource}?${qs.stringify(query)}`;
 
-        return httpClient(url, options).then(({ headers, json }) => {
+        return config.httpClient(url, options).then(({ headers, json }) => {
             if (!headers.has('content-range')) {
                 throw new Error(
                     `The Content-Range header is missing in the HTTP Response. The postgREST data provider expects 
@@ -178,35 +266,40 @@ export default (
         });
     },
 
-    update: (resource, params) => {
-        const { id, data } = params;
-        const primaryKey = getPrimaryKey(resource, primaryKeys);
+    update: (resource, params: Partial<UpdateParams> = {}) => {
+        const { id, data, meta } = params;
+        const primaryKey = getPrimaryKey(resource, config.primaryKeys);
 
-        const query = getQuery(primaryKey, id, resource);
+        const query = getQuery(primaryKey, id, resource, meta);
 
         const primaryKeyData = getKeyData(primaryKey, data);
 
-        const url = `${apiUrl}/${resource}?${query}`;
+        const url = `${config.apiUrl}/${resource}?${qs.stringify(query)}`;
+        const metaSchema = params.meta?.schema;
 
         const body = JSON.stringify({
             ...data,
             ...primaryKeyData,
         });
 
-        return httpClient(url, {
-            method: 'PATCH',
-            headers: new Headers({
-                Accept: 'application/vnd.pgrst.object+json',
-                Prefer: 'return=representation',
-                'Content-Type': 'application/json',
-            }),
-            body,
-        }).then(({ json }) => ({ data: dataWithId(json, primaryKey) }));
+        return config
+            .httpClient(url, {
+                method: 'PATCH',
+                headers: new Headers({
+                    Accept: 'application/vnd.pgrst.object+json',
+                    Prefer: 'return=representation',
+                    'Content-Type': 'application/json',
+                    ...(params.meta?.headers || {}),
+                    ...useCustomSchema(config.schema, metaSchema, 'PATCH'),
+                }),
+                body,
+            })
+            .then(({ json }) => ({ data: dataWithId(json, primaryKey) }));
     },
 
-    updateMany: (resource, params) => {
+    updateMany: (resource, params: Partial<UpdateManyParams> = {}) => {
         const ids = params.ids;
-        const primaryKey = getPrimaryKey(resource, primaryKeys);
+        const primaryKey = getPrimaryKey(resource, config.primaryKeys);
 
         const body = JSON.stringify(
             params.ids.map(id => {
@@ -229,75 +322,94 @@ export default (
             })
         );
 
-        const url = `${apiUrl}/${resource}`;
-
-        return httpClient(url, {
-            method: 'PATCH',
-            headers: new Headers({
-                Prefer: 'return=representation',
-                'Content-Type': 'application/json',
-            }),
-            body,
-        }).then(({ json }) => ({
-            data: json.map(data => encodeId(data, primaryKey)),
-        }));
+        const url = `${config.apiUrl}/${resource}`;
+        const metaSchema = params.meta?.schema;
+
+        return config
+            .httpClient(url, {
+                method: 'PATCH',
+                headers: new Headers({
+                    Prefer: 'return=representation',
+                    'Content-Type': 'application/json',
+                    ...(params.meta?.headers || {}),
+                    ...useCustomSchema(config.schema, metaSchema, 'PATCH'),
+                }),
+                body,
+            })
+            .then(({ json }) => ({
+                data: json.map(data => encodeId(data, primaryKey)),
+            }));
     },
 
-    create: (resource, params) => {
-        const primaryKey = getPrimaryKey(resource, primaryKeys);
-
-        const url = `${apiUrl}/${resource}`;
-
-        return httpClient(url, {
-            method: 'POST',
-            headers: new Headers({
-                Accept: 'application/vnd.pgrst.object+json',
-                Prefer: 'return=representation',
-                'Content-Type': 'application/json',
-            }),
-            body: JSON.stringify(params.data),
-        }).then(({ json }) => ({
-            data: {
-                ...params.data,
-                id: encodeId(json, primaryKey),
-            },
-        }));
+    create: (resource, params: Partial<CreateParams> = {}) => {
+        const primaryKey = getPrimaryKey(resource, config.primaryKeys);
+        const url = `${config.apiUrl}/${resource}`;
+        const metaSchema = params.meta?.schema;
+
+        return config
+            .httpClient(url, {
+                method: 'POST',
+                headers: new Headers({
+                    Accept: 'application/vnd.pgrst.object+json',
+                    Prefer: 'return=representation',
+                    'Content-Type': 'application/json',
+                    ...(params.meta?.headers || {}),
+                    ...useCustomSchema(config.schema, metaSchema, 'POST'),
+                }),
+                body: JSON.stringify(params.data),
+            })
+            .then(({ json }) => ({
+                data: {
+                    ...json,
+                    id: encodeId(json, primaryKey),
+                },
+            }));
     },
 
-    delete: (resource, params) => {
-        const id = params.id;
-        const primaryKey = getPrimaryKey(resource, primaryKeys);
-
-        const query = getQuery(primaryKey, id, resource);
-
-        const url = `${apiUrl}/${resource}?${query}`;
-
-        return httpClient(url, {
-            method: 'DELETE',
-            headers: new Headers({
-                Accept: 'application/vnd.pgrst.object+json',
-                Prefer: 'return=representation',
-                'Content-Type': 'application/json',
-            }),
-        }).then(({ json }) => ({ data: dataWithId(json, primaryKey) }));
+    delete: (resource, params: Partial<DeleteParams> = {}) => {
+        const { id, meta } = params;
+        const primaryKey = getPrimaryKey(resource, config.primaryKeys);
+
+        const query = getQuery(primaryKey, id, resource, meta);
+
+        const url = `${config.apiUrl}/${resource}?${qs.stringify(query)}`;
+        const metaSchema = params.meta?.schema;
+
+        return config
+            .httpClient(url, {
+                method: 'DELETE',
+                headers: new Headers({
+                    Accept: 'application/vnd.pgrst.object+json',
+                    Prefer: 'return=representation',
+                    'Content-Type': 'application/json',
+                    ...(params.meta?.headers || {}),
+                    ...useCustomSchema(config.schema, metaSchema, 'DELETE'),
+                }),
+            })
+            .then(({ json }) => ({ data: dataWithId(json, primaryKey) }));
     },
 
-    deleteMany: (resource, params) => {
-        const ids = params.ids;
-        const primaryKey = getPrimaryKey(resource, primaryKeys);
+    deleteMany: (resource, params: Partial<DeleteManyParams> = {}) => {
+        const { ids, meta } = params;
+        const primaryKey = getPrimaryKey(resource, config.primaryKeys);
 
-        const query = getQuery(primaryKey, ids, resource);
+        const query = getQuery(primaryKey, ids, resource, meta);
 
-        const url = `${apiUrl}/${resource}?${query}`;
+        const url = `${config.apiUrl}/${resource}?${qs.stringify(query)}`;
+        const metaSchema = params.meta?.schema;
 
-        return httpClient(url, {
-            method: 'DELETE',
-            headers: new Headers({
-                Prefer: 'return=representation',
-                'Content-Type': 'application/json',
-            }),
-        }).then(({ json }) => ({
-            data: json.map(data => encodeId(data, primaryKey)),
-        }));
+        return config
+            .httpClient(url, {
+                method: 'DELETE',
+                headers: new Headers({
+                    Prefer: 'return=representation',
+                    'Content-Type': 'application/json',
+                    ...(params.meta?.headers || {}),
+                    ...useCustomSchema(config.schema, metaSchema, 'DELETE'),
+                }),
+            })
+            .then(({ json }) => ({
+                data: json.map(data => encodeId(data, primaryKey)),
+            }));
     },
 });