isr-engine 4.0.0 → 4.0.2

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "isr-engine",
3
- "version": "4.0.0",
3
+ "version": "4.0.2",
4
4
  "description": "ISR/SSG/Fallback rendering orchestration on Vite + React 19 RSC.",
5
5
  "license": "UNLICENSED",
6
6
  "repository": {
@@ -72,6 +72,7 @@ interface DefaultRscPayload {
72
72
  seoMeta?: PageSeoMeta | null;
73
73
  /** canonical / og:image 转绝对 URL 用 */
74
74
  siteBaseUrl?: string | null;
75
+ routeStatus?: 404;
75
76
  formState?: import('react-dom/client').ReactFormState;
76
77
  returnValue?: { ok: boolean; data: unknown };
77
78
  }
@@ -150,7 +151,7 @@ function transitionPayload(
150
151
 
151
152
  function PayloadRoot({ payload, generation, styleIds }: DefaultRscPayloadState): React.ReactNode {
152
153
  React.useLayoutEffect(() => {
153
- applySeoToDocument(payload.seoMeta, payload.siteBaseUrl ?? undefined);
154
+ applySeoToDocument(payload.seoMeta, payload.siteBaseUrl ?? undefined, payload.routeStatus);
154
155
  }, [payload]);
155
156
  if (!import.meta.env.DEV || generation === undefined) return payload.root;
156
157
  return (
@@ -61,6 +61,7 @@ interface DefaultRscPayload {
61
61
  seoMeta?: PageSeoMeta | null;
62
62
  /** 客户端 applySeoToDocument 用来把 canonical / og:image 转绝对 URL */
63
63
  siteBaseUrl?: string | null;
64
+ routeStatus?: 404;
64
65
  returnValue?: { ok: boolean; data: unknown };
65
66
  formState?: ReactFormState;
66
67
  }
@@ -248,7 +249,7 @@ export function defineServerEntry<C extends ServerCtx = ServerCtx>(
248
249
 
249
250
  const response = await runWithI18n(intl, () =>
250
251
  runRscPipeline(renderRequest, {
251
- routeStatus: notFound && !renderRequest.isAction ? 404 : undefined,
252
+ routeStatus: notFound ? 404 : undefined,
252
253
  intl,
253
254
  seoMeta,
254
255
  siteBaseUrl: hooks.siteBaseUrl,
@@ -297,6 +298,7 @@ async function runRscPipeline(
297
298
  extras: PipelineExtras
298
299
  ): Promise<Response> {
299
300
  const { request } = renderRequest;
301
+ const responseRouteStatus = renderRequest.isAction ? undefined : extras.routeStatus;
300
302
 
301
303
  let returnValue: DefaultRscPayload['returnValue'] | undefined;
302
304
  let formState: ReactFormState | undefined;
@@ -337,6 +339,7 @@ async function runRscPipeline(
337
339
  intl: extras.intl ?? null,
338
340
  seoMeta: extras.seoMeta ?? null,
339
341
  siteBaseUrl: extras.siteBaseUrl ?? null,
342
+ routeStatus: extras.routeStatus,
340
343
  formState,
341
344
  returnValue,
342
345
  };
@@ -357,7 +360,7 @@ async function runRscPipeline(
357
360
 
358
361
  if (renderRequest.isRsc) {
359
362
  return new Response(rscStream, {
360
- status: actionStatus ?? extras.routeStatus,
363
+ status: actionStatus ?? responseRouteStatus,
361
364
  headers: { 'content-type': 'text/x-component;charset=utf-8' },
362
365
  });
363
366
  }
@@ -410,7 +413,12 @@ async function runRscPipeline(
410
413
  let finalStream = ssrResult.stream;
411
414
  if (!ssrResult.csrShellFallback) {
412
415
  if (extras.seoMeta) {
413
- finalStream = injectSeoMeta(finalStream, extras.seoMeta, extras.siteBaseUrl);
416
+ finalStream = injectSeoMeta(
417
+ finalStream,
418
+ extras.seoMeta,
419
+ extras.siteBaseUrl,
420
+ extras.routeStatus
421
+ );
414
422
  }
415
423
  if (extras.headExtras) {
416
424
  finalStream = injectHeadExtras(finalStream, extras.headExtras);
@@ -418,7 +426,7 @@ async function runRscPipeline(
418
426
  }
419
427
 
420
428
  return new Response(finalStream, {
421
- status: ssrResult.status ?? extras.routeStatus,
429
+ status: ssrResult.status ?? responseRouteStatus,
422
430
  headers: responseHeaders,
423
431
  });
424
432
  }
@@ -70,7 +70,16 @@ function toAbsolute(href: string, baseUrl?: string): string {
70
70
  }
71
71
  }
72
72
 
73
- export function renderPageSeoMeta(meta: PageSeoMeta, baseUrl?: string): string {
73
+ function resolveCanonical(
74
+ meta: PageSeoMeta,
75
+ baseUrl?: string,
76
+ routeStatus?: 404
77
+ ): string | undefined {
78
+ if (meta.canonical) return toAbsolute(meta.canonical, baseUrl);
79
+ return routeStatus === 404 ? undefined : baseUrl;
80
+ }
81
+
82
+ export function renderPageSeoMeta(meta: PageSeoMeta, baseUrl?: string, routeStatus?: 404): string {
74
83
  const tags: string[] = [];
75
84
  const esc = (s: string) =>
76
85
  s.replace(/&/g, '&amp;').replace(/"/g, '&quot;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
@@ -86,10 +95,8 @@ export function renderPageSeoMeta(meta: PageSeoMeta, baseUrl?: string): string {
86
95
  if (meta.noindex) {
87
96
  tags.push(`<meta data-isr-seo name="robots" content="noindex, nofollow">`);
88
97
  }
89
- if (meta.canonical || baseUrl) {
90
- const href = toAbsolute(meta.canonical || '', baseUrl) || baseUrl || '';
91
- if (href) tags.push(`<link data-isr-seo rel="canonical" href="${esc(href)}">`);
92
- }
98
+ const canonical = resolveCanonical(meta, baseUrl, routeStatus);
99
+ if (canonical) tags.push(`<link data-isr-seo rel="canonical" href="${esc(canonical)}">`);
93
100
  if (meta.alternates?.length) {
94
101
  for (const a of meta.alternates) {
95
102
  tags.push(
@@ -129,11 +136,12 @@ const HEAD_OPEN_RE = /<head\b[^>]*>/i;
129
136
  export function injectSeoMeta(
130
137
  source: ReadableStream<Uint8Array>,
131
138
  meta: PageSeoMeta,
132
- baseUrl?: string
139
+ baseUrl?: string,
140
+ routeStatus?: 404
133
141
  ): ReadableStream<Uint8Array> {
134
142
  const encoder = new TextEncoder();
135
143
  const decoder = new TextDecoder('utf-8', { fatal: false });
136
- const injection = '\n ' + renderPageSeoMeta(meta, baseUrl) + '\n';
144
+ const injection = '\n ' + renderPageSeoMeta(meta, baseUrl, routeStatus) + '\n';
137
145
 
138
146
  let buffer = '';
139
147
  let injected = false;
@@ -179,7 +187,11 @@ export function clearInjectedSeo(): void {
179
187
  }
180
188
 
181
189
  /** Replace managed head metadata after the route commits. */
182
- export function applySeoToDocument(meta: PageSeoMeta | null | undefined, baseUrl?: string): void {
190
+ export function applySeoToDocument(
191
+ meta: PageSeoMeta | null | undefined,
192
+ baseUrl?: string,
193
+ routeStatus?: 404
194
+ ): void {
183
195
  if (typeof document === 'undefined' || !document.head) return;
184
196
  const head = document.head;
185
197
  clearInjectedSeo();
@@ -215,10 +227,8 @@ export function applySeoToDocument(meta: PageSeoMeta | null | undefined, baseUrl
215
227
  if (meta.noindex) {
216
228
  fragments.push(tag('meta', { name: 'robots', content: 'noindex, nofollow' }));
217
229
  }
218
- if (meta.canonical || baseUrl) {
219
- const href = toAbsolute(meta.canonical || '', baseUrl) || baseUrl || '';
220
- if (href) fragments.push(tag('link', { rel: 'canonical', href }));
221
- }
230
+ const canonical = resolveCanonical(meta, baseUrl, routeStatus);
231
+ if (canonical) fragments.push(tag('link', { rel: 'canonical', href: canonical }));
222
232
  if (meta.alternates?.length) {
223
233
  for (const a of meta.alternates) {
224
234
  fragments.push(
@@ -1 +0,0 @@
1
- {"version":3,"file":"i18n-CJ0leKhc.js","names":[],"sources":["../src/utils/cookie.ts","../src/utils/trimTrailingSlashes.ts","../src/runtime/i18n.ts"],"sourcesContent":["export type CookieHeaderSource =\n | string\n | null\n | undefined\n | {\n headers?: Headers | Record<string, string | string[] | number | undefined | null>;\n };\n\nexport function getCookieHeader(source: CookieHeaderSource): string {\n if (!source) return '';\n if (typeof source === 'string') return source;\n\n const headers = source.headers;\n if (!headers) return '';\n\n if (typeof (headers as Headers).get === 'function') {\n return (headers as Headers).get('cookie') ?? '';\n }\n\n const record = headers as Record<string, string | string[] | number | undefined | null>;\n const raw = record.cookie ?? record.Cookie;\n if (Array.isArray(raw)) return raw.join('; ');\n return raw === undefined || raw === null ? '' : String(raw);\n}\n\nexport function readCookie(source: CookieHeaderSource, name: string): string | undefined {\n if (!name) return undefined;\n const cookies = parseCookieHeader(getCookieHeader(source));\n return cookies[name];\n}\n\nexport function parseCookieHeader(header: string): Record<string, string> {\n const entries = new Map<string, string>();\n\n for (const part of header.split(';')) {\n const trimmed = part.trim();\n if (!trimmed) continue;\n\n const index = trimmed.indexOf('=');\n if (index <= 0) continue;\n\n const key = trimmed.slice(0, index).trim();\n if (!key) continue;\n\n const rawValue = trimmed.slice(index + 1).trim();\n entries.set(key, safeDecodeCookieValue(rawValue));\n }\n\n // fromEntries creates own data properties, including __proto__, without invoking setters.\n const cookies = Object.fromEntries(entries);\n Object.setPrototypeOf(cookies, null);\n return cookies;\n}\n\nfunction safeDecodeCookieValue(value: string): string {\n try {\n return decodeURIComponent(value);\n } catch {\n return value;\n }\n}\n","/** Remove only the trailing slash run; each character is inspected at most once. */\nexport function trimTrailingSlashes(value: string): string {\n let end = value.length;\n while (end > 0 && value[end - 1] === '/') end--;\n return value.slice(0, end);\n}\n","/**\n * i18n 路由工具 —— URL 前缀自动处理(无 React 依赖,server + client 通用)\n *\n * 业务侧用法:\n *\n * import { parseLocale, withLocale, negotiateLocale } from 'isr-engine/runtime';\n *\n * const I18N = { locales: ['zh', 'en'] as const, defaultLocale: 'zh' };\n *\n * // SSR 入口:从 URL 拆 locale + 干净 pathname 给路由\n * const { locale, pathname } = parseLocale(url.pathname, I18N);\n * return <Layout lang={locale}>{resolveRoute({ pathname, locale })}</Layout>;\n *\n * // Header 切换语言\n * const href = withLocale('/books/1', 'en', I18N); // → '/en/books/1'\n * const href = withLocale('/books/1', 'zh', I18N); // → '/books/1'(默认 locale 不前缀)\n *\n * // 服务器协商:Accept-Language 头 → locale\n * const locale = negotiateLocale(req.headers.get('accept-language'), I18N);\n *\n * 设计取舍:\n * - 默认 locale 不带前缀('/about'),其他 locale 带('/en/about')\n * → 与 Next.js i18n routing 默认 + Vue I18n 一致;SEO 友好(默认语言 URL 简洁)\n * - 用 `prefixDefault: true` 切到\"全部带前缀\"模式(如 '/zh/about')\n * - 不内置消息字典 / 翻译机制 —— 那是 react-intl / FormatJS / lingui 的活\n */\n\nimport { trimTrailingSlashes } from '../utils/trimTrailingSlashes';\nexport interface I18nConfig {\n /** 支持的 locale 列表,如 ['zh', 'en', 'ja'] */\n locales: readonly string[];\n /** 默认 locale —— 必须在 locales 内 */\n defaultLocale: string;\n /** 是否给默认 locale 也加 URL 前缀(默认 false:'/about';true:'/zh/about') */\n prefixDefault?: boolean;\n}\n\nexport interface ParsedLocale {\n /** 解析出的 locale(命中 URL 前缀则取前缀,否则取 defaultLocale) */\n locale: string;\n /** 去掉 locale 前缀后的\"业务 pathname\",路由表只需匹配这个 */\n pathname: string;\n /** URL 是否真的带了 locale 前缀 */\n hasPrefix: boolean;\n}\n\n/**\n * 从 pathname 拆出 locale 与业务 pathname\n *\n * '/zh/books/1' + { locales: ['zh','en'], defaultLocale: 'en' }\n * → { locale: 'zh', pathname: '/books/1', hasPrefix: true }\n *\n * '/books/1' 同上\n * → { locale: 'en', pathname: '/books/1', hasPrefix: false }\n */\nexport function parseLocale(pathname: string, config: I18nConfig): ParsedLocale {\n const segments = pathname.split('/');\n // segments[0] 是空串(leading '/'),segments[1] 才是首段\n const first = segments[1];\n if (first && config.locales.includes(first)) {\n const rest = '/' + segments.slice(2).join('/');\n return {\n locale: first,\n pathname: rest === '/' ? '/' : trimTrailingSlashes(rest),\n hasPrefix: true,\n };\n }\n return { locale: config.defaultLocale, pathname: pathname || '/', hasPrefix: false };\n}\n\n/**\n * 给业务 pathname 套上 locale 前缀(生成可跳转 URL)\n *\n * withLocale('/about', 'en', { defaultLocale: 'zh', locales: ['zh','en'] })\n * → '/en/about'\n *\n * withLocale('/about', 'zh', { defaultLocale: 'zh', locales: ['zh','en'] })\n * → '/about' (默认 locale 不前缀)\n *\n * withLocale('/about', 'zh', { ..., prefixDefault: true })\n * → '/zh/about'\n */\nexport function withLocale(pathname: string, locale: string, config: I18nConfig): string {\n if (!config.locales.includes(locale)) {\n throw new Error(`[i18n] unknown locale \"${locale}\"; allowed: ${config.locales.join(', ')}`);\n }\n const clean = pathname.startsWith('/') ? pathname : '/' + pathname;\n if (locale === config.defaultLocale && !config.prefixDefault) return clean;\n return `/${locale}${clean === '/' ? '' : clean}`;\n}\n\n/**\n * Accept-Language 协商 —— RFC 4647 lookup(含主语言回退)\n *\n * negotiateLocale('zh-CN,en;q=0.9', { locales: ['zh','en'], defaultLocale: 'en' })\n * → 'zh' ('zh-CN' 命中 'zh')\n *\n * negotiateLocale('en-GB', { locales: ['zh-hans','en-us'], defaultLocale: 'zh-hans' })\n * → 'en-us' ('en-GB' 主语言 'en' 回退到第一个 en-*)\n *\n * negotiateLocale(null, ...) → defaultLocale\n */\nexport function negotiateLocale(\n acceptLanguage: string | null | undefined,\n config: I18nConfig\n): string {\n if (!acceptLanguage) return config.defaultLocale;\n const ranked = acceptLanguage\n .split(',')\n .map(part => {\n const [tag, ...params] = part.trim().split(';');\n const q = params.find(p => p.startsWith('q='));\n return { tag: tag.toLowerCase(), q: q ? Number(q.slice(2)) || 0 : 1 };\n })\n .sort((a, b) => b.q - a.q);\n\n const supported = config.locales.map(l => l.toLowerCase());\n for (const { tag } of ranked) {\n // 1) 完整 code 精确匹配('en-us' === 'en-us')\n const exact = supported.indexOf(tag);\n if (exact >= 0) return config.locales[exact];\n\n const primary = tag.split('-')[0];\n\n // 2) 主语言精确匹配('ja' === 'ja',针对无地区后缀的 locale 如 ja/fr/tr)\n const sub = supported.indexOf(primary);\n if (sub >= 0) return config.locales[sub];\n\n // 3) 主语言回退('en' / 'en-GB' → 第一个 en-*;'zh' / 'zh-CN' → zh-hans)\n // 解决「浏览器只发 en / en-GB,而 locales 是 en-us/en-au」这类地区码不匹配问题。\n const primaryPrefix = supported.findIndex(l => l.startsWith(primary + '-'));\n if (primaryPrefix >= 0) return config.locales[primaryPrefix];\n }\n return config.defaultLocale;\n}\n\n/**\n * 列出某业务 pathname 在所有 locale 下的 URL —— 用于 <link rel=\"alternate\" hreflang>\n *\n * alternates('/about', { locales: ['zh','en'], defaultLocale: 'zh' })\n * → [{ hreflang: 'zh', href: '/about' }, { hreflang: 'en', href: '/en/about' }]\n */\nexport function alternates(\n pathname: string,\n config: I18nConfig\n): Array<{ hreflang: string; href: string }> {\n return config.locales.map(locale => ({\n hreflang: locale,\n href: withLocale(pathname, locale, config),\n }));\n}\n\n/**\n * 从 SiteHooks 的 intl 字段提取 URL 路由配置并填默认值\n *\n * 用途:消除消费者侧 `app.tsx` 里那段「从 siteHooks.intl 抠出 locales/defaultLocale/prefixDefault\n * 再补默认值组装 I18nConfig」的重复样板。\n *\n * // before\n * const intl = siteHooks.intl ?? {};\n * const I18N: I18nConfig = {\n * locales: intl.locales ?? ['en'],\n * defaultLocale: intl.defaultLocale ?? 'en',\n * prefixDefault: intl.prefixDefault,\n * };\n *\n * // after\n * const I18N = resolveI18nConfig(siteHooks.intl);\n *\n * 行为:\n * - 缺省 → `{ locales: ['en'], defaultLocale: 'en' }`(单语言英文兜底)\n * - locales 给了但 defaultLocale 没给 → 取 locales[0]\n * - 多余字段(endpoint / load / ttl / detect)忽略,只挑 URL 路由相关\n */\nexport function resolveI18nConfig(\n intl?: {\n locales?: readonly string[];\n defaultLocale?: string;\n prefixDefault?: boolean;\n } | null\n): I18nConfig {\n const locales = intl?.locales && intl.locales.length > 0 ? intl.locales : ['en'];\n const defaultLocale = intl?.defaultLocale ?? locales[0];\n return {\n locales,\n defaultLocale,\n prefixDefault: intl?.prefixDefault,\n };\n}\n"],"mappings":";AAQA,SAAgB,gBAAgB,QAAoC;CAClE,IAAI,CAAC,QAAQ,OAAO;CACpB,IAAI,OAAO,WAAW,UAAU,OAAO;CAEvC,MAAM,UAAU,OAAO;CACvB,IAAI,CAAC,SAAS,OAAO;CAErB,IAAI,OAAQ,QAAoB,QAAQ,YACtC,OAAQ,QAAoB,IAAI,QAAQ,KAAK;CAG/C,MAAM,SAAS;CACf,MAAM,MAAM,OAAO,UAAU,OAAO;CACpC,IAAI,MAAM,QAAQ,GAAG,GAAG,OAAO,IAAI,KAAK,IAAI;CAC5C,OAAO,QAAQ,KAAA,KAAa,QAAQ,OAAO,KAAK,OAAO,GAAG;AAC5D;AAEA,SAAgB,WAAW,QAA4B,MAAkC;CACvF,IAAI,CAAC,MAAM,OAAO,KAAA;CAElB,OADgB,kBAAkB,gBAAgB,MAAM,CACjD,CAAA,CAAQ;AACjB;AAEA,SAAgB,kBAAkB,QAAwC;CACxE,MAAM,0BAAU,IAAI,IAAoB;CAExC,KAAK,MAAM,QAAQ,OAAO,MAAM,GAAG,GAAG;EACpC,MAAM,UAAU,KAAK,KAAK;EAC1B,IAAI,CAAC,SAAS;EAEd,MAAM,QAAQ,QAAQ,QAAQ,GAAG;EACjC,IAAI,SAAS,GAAG;EAEhB,MAAM,MAAM,QAAQ,MAAM,GAAG,KAAK,CAAC,CAAC,KAAK;EACzC,IAAI,CAAC,KAAK;EAEV,MAAM,WAAW,QAAQ,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAK;EAC/C,QAAQ,IAAI,KAAK,sBAAsB,QAAQ,CAAC;CAClD;CAGA,MAAM,UAAU,OAAO,YAAY,OAAO;CAC1C,OAAO,eAAe,SAAS,IAAI;CACnC,OAAO;AACT;AAEA,SAAS,sBAAsB,OAAuB;CACpD,IAAI;EACF,OAAO,mBAAmB,KAAK;CACjC,QAAQ;EACN,OAAO;CACT;AACF;;;AC3DA,SAAgB,oBAAoB,OAAuB;CACzD,IAAI,MAAM,MAAM;CAChB,OAAO,MAAM,KAAK,MAAM,MAAM,OAAO,KAAK;CAC1C,OAAO,MAAM,MAAM,GAAG,GAAG;AAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACkDA,SAAgB,YAAY,UAAkB,QAAkC;CAC9E,MAAM,WAAW,SAAS,MAAM,GAAG;CAEnC,MAAM,QAAQ,SAAS;CACvB,IAAI,SAAS,OAAO,QAAQ,SAAS,KAAK,GAAG;EAC3C,MAAM,OAAO,MAAM,SAAS,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG;EAC7C,OAAO;GACL,QAAQ;GACR,UAAU,SAAS,MAAM,MAAM,oBAAoB,IAAI;GACvD,WAAW;EACb;CACF;CACA,OAAO;EAAE,QAAQ,OAAO;EAAe,UAAU,YAAY;EAAK,WAAW;CAAM;AACrF;;;;;;;;;;;;AAkCA,SAAgB,gBACd,gBACA,QACQ;CACR,IAAI,CAAC,gBAAgB,OAAO,OAAO;CACnC,MAAM,SAAS,eACZ,MAAM,GAAG,CAAC,CACV,KAAI,SAAQ;EACX,MAAM,CAAC,KAAK,GAAG,UAAU,KAAK,KAAK,CAAC,CAAC,MAAM,GAAG;EAC9C,MAAM,IAAI,OAAO,MAAK,MAAK,EAAE,WAAW,IAAI,CAAC;EAC7C,OAAO;GAAE,KAAK,IAAI,YAAY;GAAG,GAAG,IAAI,OAAO,EAAE,MAAM,CAAC,CAAC,KAAK,IAAI;EAAE;CACtE,CAAC,CAAC,CACD,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC;CAE3B,MAAM,YAAY,OAAO,QAAQ,KAAI,MAAK,EAAE,YAAY,CAAC;CACzD,KAAK,MAAM,EAAE,SAAS,QAAQ;EAE5B,MAAM,QAAQ,UAAU,QAAQ,GAAG;EACnC,IAAI,SAAS,GAAG,OAAO,OAAO,QAAQ;EAEtC,MAAM,UAAU,IAAI,MAAM,GAAG,CAAC,CAAC;EAG/B,MAAM,MAAM,UAAU,QAAQ,OAAO;EACrC,IAAI,OAAO,GAAG,OAAO,OAAO,QAAQ;EAIpC,MAAM,gBAAgB,UAAU,WAAU,MAAK,EAAE,WAAW,UAAU,GAAG,CAAC;EAC1E,IAAI,iBAAiB,GAAG,OAAO,OAAO,QAAQ;CAChD;CACA,OAAO,OAAO;AAChB;;;;;;;;;;;;;;;;;;;;;;;AAwCA,SAAgB,kBACd,MAKY;CACZ,MAAM,UAAU,MAAM,WAAW,KAAK,QAAQ,SAAS,IAAI,KAAK,UAAU,CAAC,IAAI;CAE/E,OAAO;EACL;EACA,eAHoB,MAAM,iBAAiB,QAAQ;EAInD,eAAe,MAAM;CACvB;AACF"}