Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 | 1x 1x 1x 1x 1x 29x 36x 36x 1x 35x 35x 35x 17x 45x 18x 10x 30x 8x 1x 27x 4x 3x 4x 3x 3x 16x 1x 86x 43x 43x 41x 4x 1x 41x 41x 1x 3x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 2x 4x 2x 1x 1x 2x 1x 1x 1x 1x 1x 1x 2x 4x 2x 1x 1x 2x 1x 1x 30x 15x 15x 1x 1x 1x | import type {
CreateParams,
CreateResult,
DataProvider,
DeleteManyParams,
DeleteManyResult,
DeleteParams,
DeleteResult,
GetListParams,
GetListResult,
GetManyParams,
GetManyReferenceParams,
GetManyReferenceResult,
GetManyResult,
GetOneParams,
GetOneResult,
Identifier,
RaRecord,
UpdateManyParams,
UpdateManyResult,
UpdateParams,
UpdateResult
} from "ra-core";
import {
fetchUtils
} from "ra-core";
/**
* Maps react-admin queries to a TreeQL powered REST API
*
* @see https://treeql.org
*
* @example
*
* getList => GET http://my.api.url/records/posts?order=title,ASC&page=1,25
* getOne => GET http://my.api.url/records/posts/123
* getMany => GET http://my.api.url/records/posts?123,456,789
* getManyReference => GET http://my.api.url/records/posts?filter=author_id,eq,345
* update => PUT http://my.api.url/records/posts/123
* updateMany => PUT http://my.api.url/records/posts/123,456,789
* create => POST http://my.api.url/records/posts/123
* delete => DELETE http://my.api.url/records/posts/123
* deleteMany => DELETE http://my.api.url/records/posts/123,456,789
*
* @example
*
* import * as React from "react";
* import { Admin, Resource } from 'react-admin';
* import treeqlProvider from 'ra-data-treeql';
*
* import { PostList } from './posts';
*
* const App = () => (
* <Admin dataProvider={treeqlProvider('http://my.api.url/')}>
* <Resource name="posts" list={PostList} />
* </Admin>
* );
*
* export default App;
*/
/** see https://github.com/mevdschee/php-crud-api#filters */
const filterOperators = [
"cs", // contain string (string contains value)
"sw", // start with (string starts with value)
"ew", // end with (string end with value)
"eq", // equal (string or number matches exactly)
"lt", // lower than (number is lower than value)
"le", // lower or equal (number is lower than or equal to value)
"ge", // greater or equal (number is higher than or equal to value)
"gt", // greater than (number is higher than value)
"bt", // between (number is between two comma separated values)
"in", // in (number or string is in comma separated list of values)
"is", // is null (field contains "NULL" value)
] as const;
/** see https://marmelab.com/react-admin/FilteringTutorial.html#filter-operators */
const searchOperator = "q" as const; // default search operator of react-admin
const APISearchParam = "search" as const; // default search param of TreeQL
const APIFilterParam = "filter" as const; // filter param of TreeQL
type FilterOperator = typeof filterOperators[number];
const isValidFilterOperator = (value: any): value is FilterOperator => filterOperators.includes(value);
const formatFilter = (filter: Record<string, any>): [string, string][] => Object.entries(filter).map(([key, value]) => {
if (key === searchOperator) {
return [APISearchParam, value];
}
let operator: FilterOperator = "eq";
const suffix = key.slice(-2);
if (key.slice(-3, -2) === "_" && isValidFilterOperator(suffix)) {
operator = suffix;
return [APIFilterParam, [key.slice(0, -3), operator, formatFilterArguments(operator, value)].filter(v => !!v).join(",")];
}
if (key.slice(-4, -2) === "_n" && isValidFilterOperator(suffix)) {
// negated operators
operator = suffix;
return [APIFilterParam, [key.slice(0, -4), "n" + operator, formatFilterArguments(operator, value)].filter(v => !!v).join(",")];
}
return [APIFilterParam, `${key},eq,${value}`];
});
const formatFilterArguments = (operator: FilterOperator, value: any): string | null => {
switch (operator) {
case "bt":
if (!Array.isArray(value)) { throw new TypeError("Array expected as filter value for filter type \"between\" (bt)") }
return `${value[0]},${value[1]}`;
case "in":
if (!Array.isArray(value)) { throw new TypeError("Array expected as filter value for filter type \"in\"") }
return value.join(",");
case "is":
return null; // is null filter doesn't require any arguments
default:
return value;
}
};
interface IParams {
order?: string;
page?: string;
filter?: Record<string, any>;
meta?: Record<string, any>;
id?: Identifier;
ids?: Identifier[];
[key: string]: any;
}
export const formatParams = (params: IParams): string => {
const { filter, meta, ...rest } = params;
const urlParams = new URLSearchParams(rest);
filter && formatFilter(filter).forEach(([key, value]) => urlParams.append(key, value));
Object.entries(meta ?? {})
.filter(([key]) => !["order", "page", "filter"].includes(key))
.forEach(([key, value]) => urlParams.append(key, value));
const urlParamsString = urlParams.toString();
return !urlParamsString ? "" : "?" + decodeURIComponent(urlParamsString);
};
export class TreeQLDataProvider<ResourceType extends string = string> implements DataProvider<ResourceType> {
private apiUrl: string;
public constructor(_apiUrl: ResourceType, private httpClient = fetchUtils.fetchJson) {
this.apiUrl = _apiUrl.endsWith("/") ? _apiUrl.slice(0, -1) : _apiUrl;
}
public async getList<RecordType extends RaRecord = any>(resource: ResourceType, params: GetListParams): Promise<GetListResult<RecordType>> {
const { sort, pagination, filter, meta } = params;
const { page, perPage } = pagination;
const { field, order } = sort;
const url = this.getURL(resource, {
order: `${field},${order}`,
page: `${page},${perPage}`,
filter,
meta
});
const { json: { records, results } } = await this.httpClient(url);
return ({
data: records,
total: results,
});
}
public async getOne<RecordType extends RaRecord = any>(resource: ResourceType, params: GetOneParams<RecordType>): Promise<GetOneResult<RecordType>> {
const { id, meta } = params;
const { json } = await this.httpClient(this.getURL(resource, { id, meta }));
return ({ data: json });
}
public async getMany<RecordType extends RaRecord = any>(resource: ResourceType, params: GetManyParams): Promise<GetManyResult<RecordType>> {
const { ids, meta } = params;
const { json } = await this.httpClient(this.getURL(resource, { ids, meta }));
return ({ data: Array.isArray(json) ? json : [json] });
}
public async getManyReference<RecordType extends RaRecord = any>(resource: ResourceType, params: GetManyReferenceParams): Promise<GetManyReferenceResult<RecordType>> {
const { id, target, sort, pagination, filter, meta } = params;
const { page, perPage } = pagination;
const { field, order } = sort;
const url = this.getURL(resource, {
order: `${field},${order}`,
page: `${page},${perPage}`,
filter: {
...filter,
[target]: id
},
meta
});
const { json: { records, results } } = await this.httpClient(url);
return ({
data: records,
total: results,
});
}
public async update<RecordType extends RaRecord = any>(resource: ResourceType, params: UpdateParams<RecordType>): Promise<UpdateResult<RecordType>> {
const { id, data, previousData, meta } = params
await this.httpClient(this.getURL(resource, { id, meta }), {
method: 'PUT',
body: JSON.stringify(data),
});
return {
data: {
//@ts-ignore
id,
...previousData,
...data,
}
};
}
public async updateMany<RecordType extends RaRecord = any>(resource: ResourceType, params: UpdateManyParams<RecordType>): Promise<UpdateManyResult<RecordType>> {
const { ids, data, meta } = params;
await this.httpClient(this.getURL(resource, { ids, meta }), {
method: 'PUT',
body: JSON.stringify(data),
});
// TODO: there's no previous data for updateMany... do we need to return complete records?
return { data: ids };
}
public async create<RecordType extends RaRecord = any>(resource: ResourceType, params: CreateParams<RecordType>): Promise<CreateResult<RecordType>> {
const { data, meta } = params;
const { json } = await this.httpClient(this.getURL(resource, { meta }), {
method: 'POST',
body: JSON.stringify(data),
});
return ({
data: { ...data, id: json } as RecordType,
});
}
public async delete<RecordType extends RaRecord = any>(resource: ResourceType, params: DeleteParams<RecordType>): Promise<DeleteResult<RecordType>> {
const { id, previousData, meta } = params
await this.httpClient(this.getURL(resource, { id, meta }), {
method: 'DELETE',
});
return ({
data: {
id,
...previousData
} as RecordType
});
}
public async deleteMany<RecordType extends RaRecord = any>(resource: ResourceType, params: DeleteManyParams<RecordType>): Promise<DeleteManyResult<RecordType>> {
const { ids, meta } = params;
await this.httpClient(this.getURL(resource, { ids, meta }), {
method: 'DELETE',
});
return ({ data: ids });
}
protected getURL(resource: string, params: IParams) {
const { id, ids, ...rest } = params;
const record = id ? `/${id}` : ids ? `/${ids.join(",")}` : "";
return `${this.apiUrl}/records/${resource}${record}${formatParams(rest)}`;
}
}
const getDataProvider = (apiUrl: string, httpClient?: typeof fetchUtils.fetchJson) => new TreeQLDataProvider(apiUrl, httpClient);
export default getDataProvider;
|