-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathbase.ts
More file actions
380 lines (347 loc) · 11.2 KB
/
Copy pathbase.ts
File metadata and controls
380 lines (347 loc) · 11.2 KB
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
import type { FindFirst, FindMany, ID, Result, UID } from "@repo/strapi-types"
import { getEnvVar } from "@/lib/env-vars"
import { isDevelopment } from "@/lib/general-helpers"
import { PAGE_REVALIDATE_SECONDS } from "@/lib/revalidate"
import type {
APIResponse,
APIResponseCollection,
APIResponseWithBreadcrumbs,
AppLocalizedParams,
DynamicZonePopulateParams,
PageLocalization,
} from "@/types/api"
import type { AppError, CustomFetchOptions } from "@/types/general"
// Add endpoints here that are queried from the frontend.
// Mapping of Strapi content type UIDs to API endpoint paths.
export const API_ENDPOINTS: Partial<Record<UID.ContentType, string>> = {
"api::page.page": "/pages",
"api::blog-post.blog-post": "/blog-posts",
"api::post-tag.post-tag": "/post-tags",
"api::post-category.post-category": "/post-categories",
"api::blog.blog": "/blog",
"api::footer.footer": "/footer",
"api::header.header": "/header",
"api::cms.cms": "/cmses",
"api::cms-comparison.cms-comparison": "/cms-comparisons",
"api::case-study.case-study": "/case-studies",
"api::global.global": "/global",
"api::not-found.not-found": "/not-found",
"api::news-item.news-item": "/news-items",
} as const
/**
* Content types with Strapi i18n enabled (`pluginOptions.i18n.localized: true`
* in their schema). ONLY these accept a `locale` query param / `locale` field —
* sending `locale` to any other content type returns a 400 "Invalid key locale"
* and can break build-time static generation. Keep in sync with the Strapi
* schemas (`apps/strapi/src/api/<type>/content-types/<type>/schema.json`).
*/
const LOCALIZED_UIDS = new Set<UID.ContentType>([
"api::page.page",
"api::blog.blog",
"api::blog-category.blog-category",
"api::blog-tag.blog-tag",
"api::footer.footer",
"api::header.header",
"api::not-found.not-found",
"api::plan.plan",
])
/**
* For non-localized content types, drop `locale` from both the query params and
* any `locale` field selection, and flag the request so the client doesn't
* re-add the locale param. Localized types are returned untouched.
*/
function normalizeLocaleForUid<TParams>(
uid: UID.ContentType,
params: TParams | undefined,
options?: CustomFetchOptions
): { params: TParams | undefined; options: CustomFetchOptions | undefined } {
if (LOCALIZED_UIDS.has(uid) || params == null) {
return { params, options }
}
const next: Record<string, unknown> = {
...(params as Record<string, unknown>),
}
delete next.locale
if (Array.isArray(next.fields)) {
next.fields = next.fields.filter((field) => field !== "locale")
}
return {
params: next as TParams,
options: { ...options, doNotAddLocaleQueryParams: true },
}
}
export default abstract class BaseStrapiClient {
public async fetchAPI(
path: string,
params: AppLocalizedParams<Record<string, unknown>> = {},
requestInit?: RequestInit,
options?: CustomFetchOptions
) {
const { url, headers } = await this.prepareRequest(
path,
{
...params,
...(options?.doNotAddLocaleQueryParams
? {}
: { locale: params.locale }),
},
requestInit,
options
)
// Caller-provided cache config wins. When the caller passes `cache: "no-store"`
// (e.g. draft mode), Next.js treats `next.revalidate` as mutually exclusive,
// so only forward `next.tags` in that case.
const mergedHeaders = {
...requestInit?.headers,
...headers,
}
const fetchInit: RequestInit = requestInit?.cache
? {
...requestInit,
...(requestInit?.next?.tags
? { next: { tags: requestInit.next.tags } }
: {}),
headers: mergedHeaders,
}
: {
...requestInit,
next: {
tags: requestInit?.next?.tags,
// if revalidate is set to a number since 0 implies cache: 'no-store' and a positive value implies cache: 'force-cache'.
revalidate: isDevelopment()
? 0
: (requestInit?.next?.revalidate ?? PAGE_REVALIDATE_SECONDS),
},
headers: mergedHeaders,
}
const response = await fetch(url, fetchInit)
const { json, text } = await this.parseResponse(response)
if (text) {
const appError: AppError = {
name: "Invalid response format",
message: text,
status: response.status,
details: { url },
}
console.error("[BaseStrapiClient] Strapi API request error:", appError)
throw new Error(JSON.stringify(appError))
}
if (!response.ok) {
const { error } = json
const appError: AppError = {
name: error?.name,
message: error?.message,
details: {
url,
},
status: response.status ?? error?.status,
}
if (getEnvVar("DEBUG_STRAPI_CLIENT_API_CALLS")) {
console.error("[BaseStrapiClient] Strapi API request error:", appError)
}
throw new Error(JSON.stringify(appError))
}
return json
}
/**
* Fetches one document by ID or Single type (without ID)
*/
public async fetchOne<
TContentTypeUID extends UID.ContentType,
TParams extends AppLocalizedParams<FindFirst<TContentTypeUID>>,
>(
uid: TContentTypeUID,
documentId?: ID | undefined,
params?: TParams,
requestInit?: RequestInit,
options?: CustomFetchOptions
): Promise<
APIResponse<Result<TContentTypeUID, DynamicZonePopulateParams<TParams>>>
> {
const path = this.getStrapiApiPathByUId(uid)
const url = `${path}${documentId ? `/${documentId}` : ""}`
const localized = normalizeLocaleForUid(uid, params, options)
return this.fetchAPI(url, localized.params, requestInit, localized.options)
}
/**
* Fetches multiple documents
*/
public async fetchMany<
TContentTypeUID extends UID.ContentType,
TParams extends AppLocalizedParams<FindMany<TContentTypeUID>>,
>(
uid: TContentTypeUID,
params?: TParams,
requestInit?: RequestInit,
options?: CustomFetchOptions
): Promise<
APIResponseCollection<
Result<TContentTypeUID, DynamicZonePopulateParams<TParams>>
>
> {
const path = this.getStrapiApiPathByUId(uid)
const localized = normalizeLocaleForUid(uid, params, options)
return this.fetchAPI(path, localized.params, requestInit, localized.options)
}
/**
* Fetches all documents
*/
public async fetchAll<
TContentTypeUID extends UID.ContentType,
TParams extends AppLocalizedParams<FindMany<TContentTypeUID>>,
>(
uid: TContentTypeUID,
params?: TParams,
requestInit?: RequestInit,
options?: CustomFetchOptions
): Promise<APIResponseCollection<Result<TContentTypeUID, TParams>>> {
const path = this.getStrapiApiPathByUId(uid)
const localized = normalizeLocaleForUid(uid, params, options)
// Strapi can be configured in https://docs.strapi.io/dev-docs/configurations/api
const maxPageSize = 100
const firstPage: APIResponseCollection<Result<TContentTypeUID, TParams>> =
await this.fetchAPI(
path,
{ ...localized.params, pagination: { page: 1, pageSize: maxPageSize } },
requestInit,
localized.options
)
if (firstPage.meta.pagination.pageCount === 1) {
return firstPage
}
const otherPages = Array.from(
{ length: firstPage.meta.pagination.pageCount - 1 },
(_, i) =>
this.fetchAPI(
path,
{
...localized.params,
pagination: {
...firstPage.meta.pagination,
page: i + 2,
pageSize: maxPageSize,
},
},
requestInit,
localized.options
)
)
return Promise.all(otherPages).then((res) => ({
data: [firstPage.data, ...res.map((page) => page.data)].flat(),
meta: {
pagination: {
page: 1,
pageCount: 1,
pageSize: firstPage.meta.pagination.total,
total: firstPage.meta.pagination.total,
},
},
}))
}
/**
* Fetches a single entity by slug
*/
public async fetchOneBySlug<
TContentTypeUID extends UID.ContentType,
TParams extends AppLocalizedParams<FindMany<TContentTypeUID>>,
>(
uid: TContentTypeUID,
slug: string | null,
params?: TParams,
requestInit?: RequestInit,
options?: CustomFetchOptions
): Promise<
APIResponse<Result<TContentTypeUID, DynamicZonePopulateParams<TParams>>>
> {
const slugFilter = slug && slug.length > 0 ? { $eq: slug } : { $null: true }
const localized = normalizeLocaleForUid(uid, params, options)
const mergedParams = {
...localized.params,
sort: { publishedAt: "desc" },
filters: { ...localized.params?.filters, slug: slugFilter },
}
const path = this.getStrapiApiPathByUId(uid)
const response: APIResponseCollection<
Result<TContentTypeUID, DynamicZonePopulateParams<TParams>>
> = await this.fetchAPI(path, mergedParams, requestInit, localized.options)
// return last published entry
return {
data: response.data.pop() ?? null,
meta: {},
}
}
/**
* Fetches a single entity by full path
*/
public async fetchOneByFullPath<
TContentTypeUID extends UID.ContentType,
TParams extends AppLocalizedParams<FindMany<TContentTypeUID>>,
>(
uid: TContentTypeUID,
fullPath: string | null,
params?: TParams,
requestInit?: RequestInit,
options?: CustomFetchOptions
): Promise<
APIResponseWithBreadcrumbs<
Result<TContentTypeUID, DynamicZonePopulateParams<TParams>> &
PageLocalization
>
> {
const slugFilter =
fullPath && fullPath.length > 0 ? { $eq: fullPath } : { $null: true }
const localized = normalizeLocaleForUid(uid, params, options)
const mergedParams = {
...localized.params,
sort: { publishedAt: "desc" },
filters: { ...localized.params?.filters, fullPath: slugFilter },
pagination: {
page: 1,
pageSize: 1,
},
}
const path = this.getStrapiApiPathByUId(uid)
const response: APIResponseCollection<Result<TContentTypeUID, TParams>> =
await this.fetchAPI(path, mergedParams, requestInit, localized.options)
// return last published entry
return {
// @ts-expect-error localizations field is not in the response type
// @dominik-juriga
data: response.data.pop() ?? null,
meta: response.meta,
}
}
protected abstract prepareRequest(
path: string,
params: object,
requestInit?: RequestInit,
options?: CustomFetchOptions
): Promise<{ url: string; headers: Record<string, string> }>
/**
* Get Path of the API route by UID
* @param uid - UID of the Endpoint
* @returns API Endpoint path
*/
public getStrapiApiPathByUId(uid: keyof typeof API_ENDPOINTS): string {
const path = API_ENDPOINTS[uid]
if (path) {
return path
}
throw new Error(
`Endpoint for UID "${uid}" not found. Extend API_ENDPOINTS in lib/api/client.ts.`
)
}
private async parseResponse(response: Response) {
const contentType = response.headers.get("content-type")
if (contentType?.includes("application/json")) {
return {
contentType,
json: await response.json(),
}
}
return {
contentType,
text: await response.text(),
}
}
}