@svadmin/airtable 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +20 -0
- package/src/data-provider.ts +136 -0
- package/src/index.ts +1 -0
package/package.json
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@svadmin/airtable",
|
|
3
|
+
"version": "0.3.0",
|
|
4
|
+
"description": "Airtable DataProvider for svadmin",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"sideEffects": false,
|
|
7
|
+
"files": ["src/**/*"],
|
|
8
|
+
"main": "src/index.ts",
|
|
9
|
+
"types": "src/index.ts",
|
|
10
|
+
"exports": {
|
|
11
|
+
".": {
|
|
12
|
+
"types": "./src/index.ts",
|
|
13
|
+
"default": "./src/index.ts"
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
"peerDependencies": {
|
|
17
|
+
"@svadmin/core": "^0.3.0"
|
|
18
|
+
},
|
|
19
|
+
"license": "MIT"
|
|
20
|
+
}
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
import type {
|
|
2
|
+
DataProvider, GetListParams, GetListResult, GetOneParams, GetOneResult,
|
|
3
|
+
CreateParams, CreateResult, UpdateParams, UpdateResult, DeleteParams, DeleteResult,
|
|
4
|
+
GetManyParams, GetManyResult, CustomParams, CustomResult, Sort, Filter
|
|
5
|
+
} from '@svadmin/core';
|
|
6
|
+
|
|
7
|
+
function generateFilterByFormula(filters?: Filter[]): string | undefined {
|
|
8
|
+
if (!filters || filters.length === 0) return undefined;
|
|
9
|
+
|
|
10
|
+
const formulas = filters.map(f => {
|
|
11
|
+
if (!('field' in f)) return ''; // Skip logical filters for simplicity in this basic provider
|
|
12
|
+
|
|
13
|
+
// Airtable formula syntax
|
|
14
|
+
switch (f.operator) {
|
|
15
|
+
case 'eq': return `{${f.field}} = '${f.value}'`;
|
|
16
|
+
case 'ne': return `{${f.field}} != '${f.value}'`;
|
|
17
|
+
case 'lt': return `{${f.field}} < ${Number(f.value)}`;
|
|
18
|
+
case 'gt': return `{${f.field}} > ${Number(f.value)}`;
|
|
19
|
+
case 'lte': return `{${f.field}} <= ${Number(f.value)}`;
|
|
20
|
+
case 'gte': return `{${f.field}} >= ${Number(f.value)}`;
|
|
21
|
+
case 'contains': return `FIND('${f.value}', {${f.field}})`;
|
|
22
|
+
case 'null': return `{${f.field}} = BLANK()`;
|
|
23
|
+
default: return `{${f.field}} = '${f.value}'`;
|
|
24
|
+
}
|
|
25
|
+
}).filter(Boolean);
|
|
26
|
+
|
|
27
|
+
if (formulas.length === 0) return undefined;
|
|
28
|
+
if (formulas.length === 1) return formulas[0];
|
|
29
|
+
return `AND(${formulas.join(', ')})`;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
export function createAirtableDataProvider(apiKey: string, baseId: string): DataProvider {
|
|
33
|
+
const apiUrl = `https://api.airtable.com/v0/${baseId}`;
|
|
34
|
+
|
|
35
|
+
const headers = {
|
|
36
|
+
'Authorization': `Bearer ${apiKey}`,
|
|
37
|
+
'Content-Type': 'application/json',
|
|
38
|
+
};
|
|
39
|
+
|
|
40
|
+
return {
|
|
41
|
+
getApiUrl: () => apiUrl,
|
|
42
|
+
|
|
43
|
+
async getList<T>({ resource, pagination, sorters, filters }: GetListParams): Promise<GetListResult<T>> {
|
|
44
|
+
const url = new URL(`${apiUrl}/${resource}`);
|
|
45
|
+
|
|
46
|
+
const { pageSize = 100 } = pagination ?? {};
|
|
47
|
+
if (pageSize) url.searchParams.append('maxRecords', String(pageSize));
|
|
48
|
+
|
|
49
|
+
const formula = generateFilterByFormula(filters);
|
|
50
|
+
if (formula) url.searchParams.append('filterByFormula', formula);
|
|
51
|
+
|
|
52
|
+
if (sorters && sorters.length > 0) {
|
|
53
|
+
sorters.forEach((sort: Sort, index: number) => {
|
|
54
|
+
url.searchParams.append(`sort[${index}][field]`, sort.field);
|
|
55
|
+
url.searchParams.append(`sort[${index}][direction]`, sort.order);
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
const response = await fetch(url.toString(), { headers });
|
|
60
|
+
if (!response.ok) throw new Error(`HTTP error: ${response.status}`);
|
|
61
|
+
const data = await response.json();
|
|
62
|
+
|
|
63
|
+
// Airtable doesn't return total count easily without offset matching, we can only return current length or a large number
|
|
64
|
+
return {
|
|
65
|
+
data: data.records.map((r: any) => ({ ...r.fields, id: r.id })) as T[],
|
|
66
|
+
total: data.records.length,
|
|
67
|
+
};
|
|
68
|
+
},
|
|
69
|
+
|
|
70
|
+
async getOne<T>({ resource, id }: GetOneParams): Promise<GetOneResult<T>> {
|
|
71
|
+
const response = await fetch(`${apiUrl}/${resource}/${id}`, { headers });
|
|
72
|
+
if (!response.ok) throw new Error(`HTTP error: ${response.status}`);
|
|
73
|
+
const data = await response.json();
|
|
74
|
+
return { data: { ...data.fields, id: data.id } as T };
|
|
75
|
+
},
|
|
76
|
+
|
|
77
|
+
async create<T>({ resource, variables }: CreateParams): Promise<CreateResult<T>> {
|
|
78
|
+
const response = await fetch(`${apiUrl}/${resource}`, {
|
|
79
|
+
method: 'POST',
|
|
80
|
+
headers,
|
|
81
|
+
body: JSON.stringify({ records: [{ fields: variables }] }),
|
|
82
|
+
});
|
|
83
|
+
if (!response.ok) throw new Error(`HTTP error: ${response.status}`);
|
|
84
|
+
const data = await response.json();
|
|
85
|
+
return { data: { ...data.records[0].fields, id: data.records[0].id } as T };
|
|
86
|
+
},
|
|
87
|
+
|
|
88
|
+
async update<T>({ resource, id, variables }: UpdateParams): Promise<UpdateResult<T>> {
|
|
89
|
+
const response = await fetch(`${apiUrl}/${resource}`, {
|
|
90
|
+
method: 'PATCH',
|
|
91
|
+
headers,
|
|
92
|
+
body: JSON.stringify({ records: [{ id, fields: variables }] }),
|
|
93
|
+
});
|
|
94
|
+
if (!response.ok) throw new Error(`HTTP error: ${response.status}`);
|
|
95
|
+
const data = await response.json();
|
|
96
|
+
return { data: { ...data.records[0].fields, id: data.records[0].id } as T };
|
|
97
|
+
},
|
|
98
|
+
|
|
99
|
+
async deleteOne<T>({ resource, id }: DeleteParams): Promise<DeleteResult<T>> {
|
|
100
|
+
const response = await fetch(`${apiUrl}/${resource}/${id}`, { method: 'DELETE', headers });
|
|
101
|
+
if (!response.ok) throw new Error(`HTTP error: ${response.status}`);
|
|
102
|
+
const data = await response.json();
|
|
103
|
+
return { data: { id: data.id } as T };
|
|
104
|
+
},
|
|
105
|
+
|
|
106
|
+
async getMany<T>({ resource, ids }: GetManyParams): Promise<GetManyResult<T>> {
|
|
107
|
+
const url = new URL(`${apiUrl}/${resource}`);
|
|
108
|
+
const formula = `OR(${ids.map((id: string | number) => `RECORD_ID()='${id}'`).join(',')})`;
|
|
109
|
+
url.searchParams.append('filterByFormula', formula);
|
|
110
|
+
|
|
111
|
+
const response = await fetch(url.toString(), { headers });
|
|
112
|
+
if (!response.ok) throw new Error(`HTTP error: ${response.status}`);
|
|
113
|
+
const data = await response.json();
|
|
114
|
+
return { data: data.records.map((r: any) => ({ ...r.fields, id: r.id })) as T[] };
|
|
115
|
+
},
|
|
116
|
+
|
|
117
|
+
async custom<T>({ url, method, payload, headers: customHeaders, query }: CustomParams): Promise<CustomResult<T>> {
|
|
118
|
+
let requestUrl = url;
|
|
119
|
+
if (query) {
|
|
120
|
+
const params = new URLSearchParams();
|
|
121
|
+
Object.entries(query).forEach(([k, v]) => params.append(k, String(v)));
|
|
122
|
+
requestUrl = `${url}?${params.toString()}`;
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
const response = await fetch(requestUrl, {
|
|
126
|
+
method: method.toUpperCase(),
|
|
127
|
+
headers: { ...headers, ...customHeaders },
|
|
128
|
+
body: payload ? JSON.stringify(payload) : undefined,
|
|
129
|
+
});
|
|
130
|
+
|
|
131
|
+
if (!response.ok) throw new Error(`Custom request failed: ${response.status}`);
|
|
132
|
+
const data = await response.json();
|
|
133
|
+
return { data: data as T };
|
|
134
|
+
},
|
|
135
|
+
};
|
|
136
|
+
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { createAirtableDataProvider } from './data-provider';
|