@se-studio/contentful-rest-api 1.12.0 → 1.14.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/CHANGELOG.md +27 -0
- package/README.md +17 -0
- package/dist/api/article-type.d.ts.map +1 -1
- package/dist/api/article-type.js +6 -5
- package/dist/api/article-type.js.map +1 -1
- package/dist/api/banner.d.ts.map +1 -1
- package/dist/api/banner.js +5 -2
- package/dist/api/banner.js.map +1 -1
- package/dist/api/breadcrumb.d.ts.map +1 -1
- package/dist/api/breadcrumb.js +7 -21
- package/dist/api/breadcrumb.js.map +1 -1
- package/dist/api/helpers.d.ts +2 -0
- package/dist/api/helpers.d.ts.map +1 -1
- package/dist/api/helpers.js +13 -4
- package/dist/api/helpers.js.map +1 -1
- package/dist/api/index.d.ts +1 -1
- package/dist/api/index.d.ts.map +1 -1
- package/dist/api/index.js +1 -1
- package/dist/api/index.js.map +1 -1
- package/dist/api/links.d.ts.map +1 -1
- package/dist/api/links.js +87 -66
- package/dist/api/links.js.map +1 -1
- package/dist/api/navigation.d.ts +1 -0
- package/dist/api/navigation.d.ts.map +1 -1
- package/dist/api/navigation.js +1 -0
- package/dist/api/navigation.js.map +1 -1
- package/dist/api/page.d.ts.map +1 -1
- package/dist/api/page.js +1 -0
- package/dist/api/page.js.map +1 -1
- package/dist/api/person.d.ts.map +1 -1
- package/dist/api/person.js +6 -5
- package/dist/api/person.js.map +1 -1
- package/dist/api/redirects.d.ts.map +1 -1
- package/dist/api/redirects.js +5 -2
- package/dist/api/redirects.js.map +1 -1
- package/dist/api/tag-type.d.ts.map +1 -1
- package/dist/api/tag-type.js +6 -5
- package/dist/api/tag-type.js.map +1 -1
- package/dist/api/tag.d.ts.map +1 -1
- package/dist/api/tag.js +6 -5
- package/dist/api/tag.js.map +1 -1
- package/dist/api/types.d.ts +2 -0
- package/dist/api/types.d.ts.map +1 -1
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +12 -2
- package/dist/client.js.map +1 -1
- package/dist/converters/asset.d.ts.map +1 -1
- package/dist/converters/asset.js +14 -1
- package/dist/converters/asset.js.map +1 -1
- package/dist/converters/helpers.d.ts +1 -0
- package/dist/converters/helpers.d.ts.map +1 -1
- package/dist/converters/helpers.js +11 -8
- package/dist/converters/helpers.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/navigation/cacheOptions.d.ts +2 -0
- package/dist/navigation/cacheOptions.d.ts.map +1 -1
- package/dist/navigation/cacheOptions.js +7 -0
- package/dist/navigation/cacheOptions.js.map +1 -1
- package/dist/navigation/enrichModelNavigation.d.ts.map +1 -1
- package/dist/navigation/enrichModelNavigation.js +10 -4
- package/dist/navigation/enrichModelNavigation.js.map +1 -1
- package/dist/navigation/linkIndex.d.ts +1 -0
- package/dist/navigation/linkIndex.d.ts.map +1 -1
- package/dist/navigation/linkIndex.js +22 -78
- package/dist/navigation/linkIndex.js.map +1 -1
- package/dist/navigation/listingLinkBundle.d.ts +22 -0
- package/dist/navigation/listingLinkBundle.d.ts.map +1 -0
- package/dist/navigation/listingLinkBundle.js +88 -0
- package/dist/navigation/listingLinkBundle.js.map +1 -0
- package/dist/navigation/registry.d.ts +1 -0
- package/dist/navigation/registry.d.ts.map +1 -1
- package/dist/navigation/registry.js +23 -6
- package/dist/navigation/registry.js.map +1 -1
- package/dist/navigation/requestCache.d.ts +18 -0
- package/dist/navigation/requestCache.d.ts.map +1 -0
- package/dist/navigation/requestCache.js +66 -0
- package/dist/navigation/requestCache.js.map +1 -0
- package/dist/revalidation/entry-handlers.d.ts +39 -0
- package/dist/revalidation/entry-handlers.d.ts.map +1 -0
- package/dist/revalidation/entry-handlers.js +103 -0
- package/dist/revalidation/entry-handlers.js.map +1 -0
- package/dist/revalidation/handlers.d.ts +4 -37
- package/dist/revalidation/handlers.d.ts.map +1 -1
- package/dist/revalidation/handlers.js +2 -100
- package/dist/revalidation/handlers.js.map +1 -1
- package/dist/telemetry/deriveOperation.d.ts +8 -0
- package/dist/telemetry/deriveOperation.d.ts.map +1 -0
- package/dist/telemetry/deriveOperation.js +59 -0
- package/dist/telemetry/deriveOperation.js.map +1 -0
- package/dist/telemetry/queryContext.d.ts +7 -0
- package/dist/telemetry/queryContext.d.ts.map +1 -0
- package/dist/telemetry/queryContext.js +9 -0
- package/dist/telemetry/queryContext.js.map +1 -0
- package/dist/telemetry/queryLog.d.ts +17 -0
- package/dist/telemetry/queryLog.d.ts.map +1 -0
- package/dist/telemetry/queryLog.js +54 -0
- package/dist/telemetry/queryLog.js.map +1 -0
- package/docs/llms.md +24 -0
- package/package.json +4 -3
|
@@ -1,102 +1,7 @@
|
|
|
1
1
|
import { revalidateSingleTag, revalidateTags } from './server-utils.js';
|
|
2
|
-
import {
|
|
3
|
-
|
|
2
|
+
import { AssetTag, assetTag, GlobalTag } from './tags.js';
|
|
3
|
+
export { contentTypeHandlers, getPublishTagsForEntry } from './entry-handlers.js';
|
|
4
4
|
const defaultLocale = 'en-US';
|
|
5
|
-
// Content type handlers
|
|
6
|
-
const articleTypeHandler = {
|
|
7
|
-
extract: (data) => ({
|
|
8
|
-
slug: data.fields?.slug?.[defaultLocale],
|
|
9
|
-
}),
|
|
10
|
-
makeTags: (extracted) => [extracted.slug ? articleTypeIndexTag(extracted.slug) : undefined],
|
|
11
|
-
getGlobalTags: () => [ArticleTypeTag, ArticleTypeIndexTag],
|
|
12
|
-
};
|
|
13
|
-
const articleHandler = {
|
|
14
|
-
extract: (data) => ({
|
|
15
|
-
slug: data.fields?.slug?.[defaultLocale],
|
|
16
|
-
}),
|
|
17
|
-
makeTags: (extracted) => [extracted?.slug ? articleTag(extracted.slug) : undefined],
|
|
18
|
-
getGlobalTags: () => [ArticleTag],
|
|
19
|
-
rebuildSearch: true,
|
|
20
|
-
};
|
|
21
|
-
const pageVariantHandler = {
|
|
22
|
-
extract: (data) => {
|
|
23
|
-
const pageVariantSlug = data.fields?.slug?.[defaultLocale];
|
|
24
|
-
return pageVariantSlug;
|
|
25
|
-
},
|
|
26
|
-
makeTags: (extracted) => [extracted ? pageVariantTag(extracted) : undefined],
|
|
27
|
-
getGlobalTags: () => [PageVariantTag],
|
|
28
|
-
};
|
|
29
|
-
const templateHandler = {
|
|
30
|
-
extract: (data) => data.fields?.cmsLabel?.[defaultLocale],
|
|
31
|
-
makeTags: (extracted) => [extracted ? templateTag(extracted) : undefined],
|
|
32
|
-
getGlobalTags: () => [TemplateTag],
|
|
33
|
-
};
|
|
34
|
-
// Content type handlers registry
|
|
35
|
-
export const contentTypeHandlers = {
|
|
36
|
-
page: {
|
|
37
|
-
extract: (data) => data.fields?.slug?.[defaultLocale],
|
|
38
|
-
makeTags: (extracted) => [extracted ? pageTag(extracted) : undefined],
|
|
39
|
-
getGlobalTags: () => [PageTag],
|
|
40
|
-
},
|
|
41
|
-
pageVariant: pageVariantHandler,
|
|
42
|
-
// biome-ignore lint/suspicious/noExplicitAny: Any is ok for handlers with different types
|
|
43
|
-
article: articleHandler,
|
|
44
|
-
// biome-ignore lint/suspicious/noExplicitAny: Any is ok for handlers with different types
|
|
45
|
-
articleType: articleTypeHandler,
|
|
46
|
-
person: {
|
|
47
|
-
extract: (data) => data.fields?.slug?.[defaultLocale],
|
|
48
|
-
makeTags: (extracted) => [extracted ? personTag(extracted) : undefined],
|
|
49
|
-
getGlobalTags: () => [PersonTag],
|
|
50
|
-
},
|
|
51
|
-
tag: {
|
|
52
|
-
extract: (data) => data.fields?.slug?.[defaultLocale],
|
|
53
|
-
makeTags: (extracted) => [extracted ? tagTag(extracted) : undefined],
|
|
54
|
-
getGlobalTags: () => [TagTag],
|
|
55
|
-
},
|
|
56
|
-
tagType: {
|
|
57
|
-
extract: (data) => data.fields?.slug?.[defaultLocale],
|
|
58
|
-
makeTags: (extracted) => [extracted ? tagTypeTag(extracted) : undefined],
|
|
59
|
-
getGlobalTags: () => [TagTypeTag],
|
|
60
|
-
},
|
|
61
|
-
link: {
|
|
62
|
-
extract: () => undefined,
|
|
63
|
-
makeTags: () => undefined,
|
|
64
|
-
getGlobalTags: () => [LinkTag],
|
|
65
|
-
},
|
|
66
|
-
// biome-ignore lint/suspicious/noExplicitAny: Any is ok for handlers with different types
|
|
67
|
-
template: templateHandler,
|
|
68
|
-
customType: {
|
|
69
|
-
extract: () => undefined,
|
|
70
|
-
makeTags: () => undefined,
|
|
71
|
-
getGlobalTags: () => [CustomTypeTag],
|
|
72
|
-
},
|
|
73
|
-
navigation: {
|
|
74
|
-
extract: () => undefined,
|
|
75
|
-
makeTags: () => undefined,
|
|
76
|
-
getGlobalTags: () => [NavigationTag],
|
|
77
|
-
},
|
|
78
|
-
navigationItem: {
|
|
79
|
-
extract: () => undefined,
|
|
80
|
-
makeTags: () => undefined,
|
|
81
|
-
getGlobalTags: () => [NavigationItemTag],
|
|
82
|
-
},
|
|
83
|
-
banner: {
|
|
84
|
-
extract: () => undefined,
|
|
85
|
-
makeTags: () => undefined,
|
|
86
|
-
getGlobalTags: () => [BannerTag],
|
|
87
|
-
},
|
|
88
|
-
redirect: {
|
|
89
|
-
extract: () => undefined,
|
|
90
|
-
makeTags: () => undefined,
|
|
91
|
-
getGlobalTags: () => [RedirectTag],
|
|
92
|
-
},
|
|
93
|
-
location: {
|
|
94
|
-
extract: (data) => data.fields?.slug?.[defaultLocale],
|
|
95
|
-
makeTags: (extracted) => [extracted ? locationTag(extracted) : undefined],
|
|
96
|
-
getGlobalTags: () => [LocationTag],
|
|
97
|
-
},
|
|
98
|
-
};
|
|
99
|
-
// Asset revalidation handler
|
|
100
5
|
export async function revalidateAsset(content, message, preview = false) {
|
|
101
6
|
const id = content.sys.id;
|
|
102
7
|
const fileName = content.fields?.file?.[defaultLocale]?.fileName;
|
|
@@ -109,7 +14,6 @@ export async function revalidateAsset(content, message, preview = false) {
|
|
|
109
14
|
}
|
|
110
15
|
return true;
|
|
111
16
|
}
|
|
112
|
-
// Entry revalidation handler
|
|
113
17
|
export async function revalidateEntry(handler, content, contentType, preview = false) {
|
|
114
18
|
const extracted = await Promise.resolve(handler.extract(content));
|
|
115
19
|
const tags = handler.makeTags(extracted);
|
|
@@ -124,7 +28,6 @@ export async function revalidateEntry(handler, content, contentType, preview = f
|
|
|
124
28
|
}
|
|
125
29
|
return true;
|
|
126
30
|
}
|
|
127
|
-
// Revalidate deleted entry by content type (collection tags only)
|
|
128
31
|
export async function revalidateDeletedEntry(contentType, preview = false) {
|
|
129
32
|
const { getCacheTagsForProduction } = await import('./utils.js');
|
|
130
33
|
const tags = getCacheTagsForProduction(contentType);
|
|
@@ -136,7 +39,6 @@ export async function revalidateDeletedEntry(contentType, preview = false) {
|
|
|
136
39
|
}
|
|
137
40
|
return true;
|
|
138
41
|
}
|
|
139
|
-
// Revalidate deleted asset by ID
|
|
140
42
|
export async function revalidateDeletedAsset(assetId, preview = false) {
|
|
141
43
|
const tags = [assetTag(assetId), AssetTag];
|
|
142
44
|
if (preview) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"handlers.js","sourceRoot":"","sources":["../../src/revalidation/handlers.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"handlers.js","sourceRoot":"","sources":["../../src/revalidation/handlers.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAGvD,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAc/E,MAAM,aAAa,GAAG,OAAO,CAAC;AAE9B,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,OAAkB,EAClB,OAAe,EACf,UAAmB,KAAK;IAExB,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;IAC1B,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,aAAa,CAAC,EAAE,QAAQ,CAAC;IACjE,MAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,MAAM,CACrF,CAAC,GAAG,EAAiB,EAAE,CAAC,GAAG,KAAK,SAAS,CAC1C,CAAC;IAEF,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,mBAAmB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;SAAM,CAAC;QACN,MAAM,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,OAAiE,EACjE,OAAiB,EACjB,WAAmB,EACnB,UAAmB,KAAK;IAExB,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAClE,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IACzC,MAAM,SAAS,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC,GAAG,EAAiB,EAAE,CAAC,GAAG,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;IAChF,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAC3C,MAAM,gBAAgB,GAAG,CAAC,GAAG,SAAS,EAAE,GAAG,UAAU,CAAC,CAAC;IAEvD,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,mBAAmB,CAAC,SAAS,EAAE,WAAW,WAAW,iBAAiB,CAAC,CAAC;IAChF,CAAC;SAAM,CAAC;QACN,MAAM,cAAc,CAAC,gBAAgB,EAAE,WAAW,WAAW,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,WAAmB,EACnB,UAAmB,KAAK;IAExB,MAAM,EAAE,yBAAyB,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;IAC9D,MAAM,IAAI,GAAG,yBAAyB,CAAC,WAAW,CAAC,CAAC;IAEpD,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,mBAAmB,CAAC,SAAS,EAAE,UAAU,WAAW,iBAAiB,CAAC,CAAC;IAC/E,CAAC;SAAM,CAAC;QACN,MAAM,cAAc,CAAC,IAAI,EAAE,UAAU,WAAW,EAAE,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,OAAe,EACf,UAAmB,KAAK;IAExB,MAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;IAE3C,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,mBAAmB,CAAC,SAAS,EAAE,gBAAgB,OAAO,iBAAiB,CAAC,CAAC;IACjF,CAAC;SAAM,CAAC;QACN,MAAM,cAAc,CAAC,IAAI,EAAE,gBAAgB,OAAO,EAAE,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { CmsQueryContext } from './queryContext';
|
|
2
|
+
/** Human-readable operation label for a Contentful content type. */
|
|
3
|
+
export declare function operationLabel(contentType: string): string;
|
|
4
|
+
/** Link-list fetch label with optional pagination suffix. */
|
|
5
|
+
export declare function allLinksOperationLabel(contentType: string, page?: number): string;
|
|
6
|
+
/** Fallback operation + identifier derived from a Contentful REST URL. */
|
|
7
|
+
export declare function deriveOperationFromUrl(url: string): CmsQueryContext;
|
|
8
|
+
//# sourceMappingURL=deriveOperation.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deriveOperation.d.ts","sourceRoot":"","sources":["../../src/telemetry/deriveOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAmBtD,oEAAoE;AACpE,wBAAgB,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAE1D;AAED,6DAA6D;AAC7D,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAGjF;AAeD,0EAA0E;AAC1E,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAsBnE"}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
const OPERATION_VERBS = {
|
|
2
|
+
page: 'Reading page',
|
|
3
|
+
pageVariant: 'Reading page variant',
|
|
4
|
+
article: 'Reading article',
|
|
5
|
+
articleType: 'Reading article type',
|
|
6
|
+
tag: 'Reading tag',
|
|
7
|
+
tagType: 'Reading tag type',
|
|
8
|
+
person: 'Reading person',
|
|
9
|
+
customType: 'Reading custom type',
|
|
10
|
+
template: 'Reading template',
|
|
11
|
+
banner: 'Reading banner',
|
|
12
|
+
redirect: 'Reading redirect',
|
|
13
|
+
navigation: 'Reading navigation',
|
|
14
|
+
navigationItem: 'Reading navigation item',
|
|
15
|
+
link: 'Reading link',
|
|
16
|
+
};
|
|
17
|
+
/** Human-readable operation label for a Contentful content type. */
|
|
18
|
+
export function operationLabel(contentType) {
|
|
19
|
+
return OPERATION_VERBS[contentType] ?? `Reading ${contentType}`;
|
|
20
|
+
}
|
|
21
|
+
/** Link-list fetch label with optional pagination suffix. */
|
|
22
|
+
export function allLinksOperationLabel(contentType, page) {
|
|
23
|
+
const base = `Reading all ${contentType} links`;
|
|
24
|
+
return page !== undefined && page > 1 ? `${base} (page ${page})` : base;
|
|
25
|
+
}
|
|
26
|
+
function slugFromSearchParams(params) {
|
|
27
|
+
const direct = params.get('fields.slug');
|
|
28
|
+
if (direct)
|
|
29
|
+
return direct;
|
|
30
|
+
for (const [key, value] of params.entries()) {
|
|
31
|
+
if (key.startsWith('fields.') && key.endsWith('.slug') && value) {
|
|
32
|
+
return value;
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
return undefined;
|
|
36
|
+
}
|
|
37
|
+
/** Fallback operation + identifier derived from a Contentful REST URL. */
|
|
38
|
+
export function deriveOperationFromUrl(url) {
|
|
39
|
+
try {
|
|
40
|
+
const parsed = new URL(url);
|
|
41
|
+
const assetMatch = parsed.pathname.match(/\/assets\/([^/]+)$/);
|
|
42
|
+
if (assetMatch?.[1]) {
|
|
43
|
+
return { operation: 'Reading asset', identifier: assetMatch[1] };
|
|
44
|
+
}
|
|
45
|
+
const contentType = parsed.searchParams.get('content_type');
|
|
46
|
+
const identifier = slugFromSearchParams(parsed.searchParams);
|
|
47
|
+
if (contentType) {
|
|
48
|
+
return {
|
|
49
|
+
operation: operationLabel(contentType),
|
|
50
|
+
...(identifier ? { identifier } : {}),
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
return { operation: 'Reading Contentful' };
|
|
54
|
+
}
|
|
55
|
+
catch {
|
|
56
|
+
return { operation: 'Reading Contentful' };
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
//# sourceMappingURL=deriveOperation.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deriveOperation.js","sourceRoot":"","sources":["../../src/telemetry/deriveOperation.ts"],"names":[],"mappings":"AAEA,MAAM,eAAe,GAA2B;IAC9C,IAAI,EAAE,cAAc;IACpB,WAAW,EAAE,sBAAsB;IACnC,OAAO,EAAE,iBAAiB;IAC1B,WAAW,EAAE,sBAAsB;IACnC,GAAG,EAAE,aAAa;IAClB,OAAO,EAAE,kBAAkB;IAC3B,MAAM,EAAE,gBAAgB;IACxB,UAAU,EAAE,qBAAqB;IACjC,QAAQ,EAAE,kBAAkB;IAC5B,MAAM,EAAE,gBAAgB;IACxB,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,oBAAoB;IAChC,cAAc,EAAE,yBAAyB;IACzC,IAAI,EAAE,cAAc;CACrB,CAAC;AAEF,oEAAoE;AACpE,MAAM,UAAU,cAAc,CAAC,WAAmB;IAChD,OAAO,eAAe,CAAC,WAAW,CAAC,IAAI,WAAW,WAAW,EAAE,CAAC;AAClE,CAAC;AAED,6DAA6D;AAC7D,MAAM,UAAU,sBAAsB,CAAC,WAAmB,EAAE,IAAa;IACvE,MAAM,IAAI,GAAG,eAAe,WAAW,QAAQ,CAAC;IAChD,OAAO,IAAI,KAAK,SAAS,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,UAAU,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;AAC1E,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAuB;IACnD,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACzC,IAAI,MAAM;QAAE,OAAO,MAAM,CAAC;IAE1B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;QAC5C,IAAI,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC;YAChE,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,sBAAsB,CAAC,GAAW;IAChD,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5B,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAC/D,IAAI,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACpB,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC5D,MAAM,UAAU,GAAG,oBAAoB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAE7D,IAAI,WAAW,EAAE,CAAC;YAChB,OAAO;gBACL,SAAS,EAAE,cAAc,CAAC,WAAW,CAAC;gBACtC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACtC,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,CAAC;IAC7C,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export interface CmsQueryContext {
|
|
2
|
+
operation: string;
|
|
3
|
+
identifier?: string;
|
|
4
|
+
}
|
|
5
|
+
export declare function withCmsQueryContext<T>(context: CmsQueryContext, fn: () => T): T;
|
|
6
|
+
export declare function getCmsQueryContext(): CmsQueryContext | undefined;
|
|
7
|
+
//# sourceMappingURL=queryContext.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"queryContext.d.ts","sourceRoot":"","sources":["../../src/telemetry/queryContext.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAID,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,CAE/E;AAED,wBAAgB,kBAAkB,IAAI,eAAe,GAAG,SAAS,CAEhE"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { AsyncLocalStorage } from 'node:async_hooks';
|
|
2
|
+
const storage = new AsyncLocalStorage();
|
|
3
|
+
export function withCmsQueryContext(context, fn) {
|
|
4
|
+
return storage.run(context, fn);
|
|
5
|
+
}
|
|
6
|
+
export function getCmsQueryContext() {
|
|
7
|
+
return storage.getStore();
|
|
8
|
+
}
|
|
9
|
+
//# sourceMappingURL=queryContext.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"queryContext.js","sourceRoot":"","sources":["../../src/telemetry/queryContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAOrD,MAAM,OAAO,GAAG,IAAI,iBAAiB,EAAmB,CAAC;AAEzD,MAAM,UAAU,mBAAmB,CAAI,OAAwB,EAAE,EAAW;IAC1E,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AAClC,CAAC;AAED,MAAM,UAAU,kBAAkB;IAChC,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;AAC5B,CAAC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
export interface CmsQueryLogEntry {
|
|
2
|
+
url: string;
|
|
3
|
+
operation: string;
|
|
4
|
+
identifier?: string;
|
|
5
|
+
bytes: number;
|
|
6
|
+
ms: number;
|
|
7
|
+
}
|
|
8
|
+
export declare function isCmsQueryLoggingEnabled(): boolean;
|
|
9
|
+
/** Format byte count as a compact human-readable size (e.g. 23.5k, 1.2M). */
|
|
10
|
+
export declare function formatPayloadSize(bytes: number): string;
|
|
11
|
+
export declare function logCmsQuery(entry: Omit<CmsQueryLogEntry, 'operation' | 'identifier'> & Partial<Pick<CmsQueryLogEntry, 'operation' | 'identifier'>>): void;
|
|
12
|
+
/** Read response body bytes and return text for JSON parsing. */
|
|
13
|
+
export declare function readResponseBodyWithSize(response: Response): Promise<{
|
|
14
|
+
bytes: number;
|
|
15
|
+
text: string;
|
|
16
|
+
}>;
|
|
17
|
+
//# sourceMappingURL=queryLog.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"queryLog.d.ts","sourceRoot":"","sources":["../../src/telemetry/queryLog.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,wBAAgB,wBAAwB,IAAI,OAAO,CAElD;AAED,6EAA6E;AAC7E,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQvD;AAED,wBAAgB,WAAW,CACzB,KAAK,EAAE,IAAI,CAAC,gBAAgB,EAAE,WAAW,GAAG,YAAY,CAAC,GACvD,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,WAAW,GAAG,YAAY,CAAC,CAAC,GAC5D,IAAI,CAuBN;AAED,iEAAiE;AACjE,wBAAsB,wBAAwB,CAC5C,QAAQ,EAAE,QAAQ,GACjB,OAAO,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAc1C"}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { deriveOperationFromUrl } from './deriveOperation.js';
|
|
2
|
+
import { getCmsQueryContext } from './queryContext.js';
|
|
3
|
+
export function isCmsQueryLoggingEnabled() {
|
|
4
|
+
return process.env.LOG_CMS_QUERIES === '1';
|
|
5
|
+
}
|
|
6
|
+
/** Format byte count as a compact human-readable size (e.g. 23.5k, 1.2M). */
|
|
7
|
+
export function formatPayloadSize(bytes) {
|
|
8
|
+
if (bytes < 1024)
|
|
9
|
+
return `${bytes}`;
|
|
10
|
+
if (bytes < 1024 * 1024) {
|
|
11
|
+
const kb = bytes / 1024;
|
|
12
|
+
return kb >= 100 ? `${Math.round(kb)}k` : `${kb.toFixed(1)}k`;
|
|
13
|
+
}
|
|
14
|
+
const mb = bytes / (1024 * 1024);
|
|
15
|
+
return mb >= 100 ? `${Math.round(mb)}M` : `${mb.toFixed(1)}M`;
|
|
16
|
+
}
|
|
17
|
+
export function logCmsQuery(entry) {
|
|
18
|
+
if (!isCmsQueryLoggingEnabled())
|
|
19
|
+
return;
|
|
20
|
+
const context = getCmsQueryContext();
|
|
21
|
+
const derived = deriveOperationFromUrl(entry.url);
|
|
22
|
+
const payload = {
|
|
23
|
+
url: entry.url,
|
|
24
|
+
operation: entry.operation ?? context?.operation ?? derived.operation,
|
|
25
|
+
...(entry.identifier !== undefined
|
|
26
|
+
? entry.identifier
|
|
27
|
+
? { identifier: entry.identifier }
|
|
28
|
+
: {}
|
|
29
|
+
: context?.identifier
|
|
30
|
+
? { identifier: context.identifier }
|
|
31
|
+
: derived.identifier
|
|
32
|
+
? { identifier: derived.identifier }
|
|
33
|
+
: {}),
|
|
34
|
+
bytes: entry.bytes,
|
|
35
|
+
ms: entry.ms,
|
|
36
|
+
};
|
|
37
|
+
console.log(`[CMS query] ${JSON.stringify(payload)}`);
|
|
38
|
+
}
|
|
39
|
+
/** Read response body bytes and return text for JSON parsing. */
|
|
40
|
+
export async function readResponseBodyWithSize(response) {
|
|
41
|
+
const contentLength = response.headers.get('content-length');
|
|
42
|
+
if (contentLength) {
|
|
43
|
+
const parsed = Number.parseInt(contentLength, 10);
|
|
44
|
+
const text = await response.text();
|
|
45
|
+
return {
|
|
46
|
+
bytes: Number.isNaN(parsed) ? Buffer.byteLength(text, 'utf8') : parsed,
|
|
47
|
+
text,
|
|
48
|
+
};
|
|
49
|
+
}
|
|
50
|
+
const buffer = await response.arrayBuffer();
|
|
51
|
+
const text = new TextDecoder().decode(buffer);
|
|
52
|
+
return { bytes: buffer.byteLength, text };
|
|
53
|
+
}
|
|
54
|
+
//# sourceMappingURL=queryLog.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"queryLog.js","sourceRoot":"","sources":["../../src/telemetry/queryLog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAUpD,MAAM,UAAU,wBAAwB;IACtC,OAAO,OAAO,CAAC,GAAG,CAAC,eAAe,KAAK,GAAG,CAAC;AAC7C,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,iBAAiB,CAAC,KAAa;IAC7C,IAAI,KAAK,GAAG,IAAI;QAAE,OAAO,GAAG,KAAK,EAAE,CAAC;IACpC,IAAI,KAAK,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC;QACxB,MAAM,EAAE,GAAG,KAAK,GAAG,IAAI,CAAC;QACxB,OAAO,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;IAChE,CAAC;IACD,MAAM,EAAE,GAAG,KAAK,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;IACjC,OAAO,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,WAAW,CACzB,KAC6D;IAE7D,IAAI,CAAC,wBAAwB,EAAE;QAAE,OAAO;IAExC,MAAM,OAAO,GAAG,kBAAkB,EAAE,CAAC;IACrC,MAAM,OAAO,GAAG,sBAAsB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAElD,MAAM,OAAO,GAAqB;QAChC,GAAG,EAAE,KAAK,CAAC,GAAG;QACd,SAAS,EAAE,KAAK,CAAC,SAAS,IAAI,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,SAAS;QACrE,GAAG,CAAC,KAAK,CAAC,UAAU,KAAK,SAAS;YAChC,CAAC,CAAC,KAAK,CAAC,UAAU;gBAChB,CAAC,CAAC,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE;gBAClC,CAAC,CAAC,EAAE;YACN,CAAC,CAAC,OAAO,EAAE,UAAU;gBACnB,CAAC,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE;gBACpC,CAAC,CAAC,OAAO,CAAC,UAAU;oBAClB,CAAC,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE;oBACpC,CAAC,CAAC,EAAE,CAAC;QACX,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,EAAE,EAAE,KAAK,CAAC,EAAE;KACb,CAAC;IAEF,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;AACxD,CAAC;AAED,iEAAiE;AACjE,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,QAAkB;IAElB,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC7D,IAAI,aAAa,EAAE,CAAC;QAClB,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;QAClD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,OAAO;YACL,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM;YACtE,IAAI;SACL,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC5C,MAAM,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC;AAC5C,CAAC"}
|
package/docs/llms.md
CHANGED
|
@@ -304,6 +304,30 @@ import {
|
|
|
304
304
|
} from '@se-studio/contentful-rest-api';
|
|
305
305
|
```
|
|
306
306
|
|
|
307
|
+
## Query logging (dev)
|
|
308
|
+
|
|
309
|
+
Set `LOG_CMS_QUERIES=1` to emit structured per-fetch lines:
|
|
310
|
+
|
|
311
|
+
```
|
|
312
|
+
[CMS query] {"url":"...","operation":"Reading article","identifier":"my-slug","bytes":24064,"ms":45}
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
Merge with Next.js dev fetch cache lines (`(cache hit|miss)`) after the fact:
|
|
316
|
+
|
|
317
|
+
```bash
|
|
318
|
+
pnpm dev 2>&1 | tee dev.log
|
|
319
|
+
pnpm --filter @se-studio/contentful-rest-api consolidate-cms-logs -- dev.log
|
|
320
|
+
# => Reading article my-slug - 23.5k (cached) in 12ms
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
For reliable URL matching, enable full fetch URLs in the app's `next.config.js`:
|
|
324
|
+
|
|
325
|
+
```js
|
|
326
|
+
logging: { fetches: { fullUrl: true } }
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
Related: `LOG_CMS=1` (conversion warnings), `LOG_CMS_FETCH=1` (raw URLs only).
|
|
330
|
+
|
|
307
331
|
## Important Constraints
|
|
308
332
|
|
|
309
333
|
- Always supply `spaceId`, `accessToken`, and `environment`.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@se-studio/contentful-rest-api",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.14.0",
|
|
4
4
|
"description": "Type-safe Contentful REST API client with caching and rate limiting for Next.js applications",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
"@contentful/rich-text-types": "^17.2.7",
|
|
62
62
|
"contentful": "^11.12.5",
|
|
63
63
|
"server-only": "0.0.1",
|
|
64
|
-
"@se-studio/core-data-types": "1.
|
|
64
|
+
"@se-studio/core-data-types": "1.6.0"
|
|
65
65
|
},
|
|
66
66
|
"peerDependencies": {
|
|
67
67
|
"next": ">=15.5.0 <16"
|
|
@@ -78,7 +78,8 @@
|
|
|
78
78
|
"dev": "tsc --project tsconfig.build.json --watch",
|
|
79
79
|
"type-check": "tsc --noEmit",
|
|
80
80
|
"lint": "biome lint .",
|
|
81
|
-
"test": "vitest run",
|
|
81
|
+
"test": "vitest run && node --test scripts/cms-query-log-consolidate.test.mjs",
|
|
82
|
+
"consolidate-cms-logs": "node scripts/consolidate-cms-query-logs.mjs",
|
|
82
83
|
"clean": "rm -rf dist .turbo *.tsbuildinfo",
|
|
83
84
|
"extract-single-page": "bash -c 'set -a && source ../../.env.local && set +a && tsx scripts/extract-page.ts \"$@\"' --",
|
|
84
85
|
"extract-single-article": "bash -c 'set -a && source ../../.env.local && set +a && tsx scripts/extract-article.ts \"$@\"' --"
|