@fbkworks/data 0.5.0 → 0.6.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/dist/create.mjs CHANGED
@@ -1,5 +1,5 @@
1
- import { warnOnce } from "@fbkworks/shared";
2
- import { FbkDataError } from "./error.mjs";
1
+ import { FbkDataError, previewRaw } from "./error.mjs";
2
+ import { warnOnce } from "./warn.mjs";
3
3
  import { extractRows, extractTotal } from "./path.mjs";
4
4
  function createPageRequest(config) {
5
5
  const { fetch, rows, total, mapRow, isSuccess, errorMessage, scope, onError, feature } = config;
@@ -22,6 +22,7 @@ function createPageRequest(config) {
22
22
  sort: query.sort,
23
23
  params: query.params
24
24
  });
25
+ const includeRaw = config.includeRaw === true;
25
26
  return async (query) => {
26
27
  let raw;
27
28
  try {
@@ -59,7 +60,8 @@ function createPageRequest(config) {
59
60
  feature,
60
61
  message: wrapped.message,
61
62
  cause: err,
62
- raw,
63
+ raw: includeRaw ? raw : void 0,
64
+ rawPreview: previewRaw(raw),
63
65
  context: snapshot(query)
64
66
  });
65
67
  throw wrapped;
@@ -70,7 +72,8 @@ function createPageRequest(config) {
70
72
  source: "request",
71
73
  feature,
72
74
  message: text,
73
- raw,
75
+ raw: includeRaw ? raw : void 0,
76
+ rawPreview: previewRaw(raw),
74
77
  context: snapshot(query)
75
78
  });
76
79
  throw new FbkDataError("business", text, raw);
@@ -80,13 +83,15 @@ function createPageRequest(config) {
80
83
  const rawRows = extractRows(raw, rows);
81
84
  const totalValue = total !== void 0 ? extractTotal(raw, total) : rawRows.length;
82
85
  const list = mapRow ? rawRows.map((item, index) => mapRow(item, index)) : rawRows;
83
- return { list, total: totalValue };
86
+ const hasMore = total !== void 0 && query.page > 0 && query.pageSize > 0 ? query.page * query.pageSize < totalValue : void 0;
87
+ return { list, total: totalValue, hasMore };
84
88
  } catch (err) {
85
89
  report({
86
90
  source: "request",
87
91
  feature,
88
92
  message: err instanceof Error ? err.message : String(err),
89
- raw,
93
+ raw: includeRaw ? raw : void 0,
94
+ rawPreview: previewRaw(raw),
90
95
  cause: err,
91
96
  context: snapshot(query)
92
97
  });
@@ -1 +1 @@
1
- {"version":3,"file":"create.mjs","sources":["../src/create.ts"],"sourcesContent":["import { warnOnce } from '@fbkworks/shared'\nimport { FbkDataError } from './error'\nimport { extractRows, extractTotal } from './path'\nimport type {\n CreatePageRequestConfig,\n Page,\n PageFetcher,\n PageQuery,\n PageRequestErrorEvent,\n} from './types'\n\n/**\n * 把「任意形状的后端响应」映射成组件库期望的 `Page<T>`。\n *\n * 这是 @fbkworks/data 的核心:业务方只写「字段在哪」,\n * 不写分页、不写错误处理、不写类型转换。\n *\n * ```ts\n * // ruoyi\n * export const fetchOrders = createPageRequest({\n * fetch: ({ page, pageSize, params, signal }) =>\n * http.get('/api/order/list', { params: { pageNum: page, pageSize, ...params }, signal }),\n * rows: 'rows',\n * total: 'total',\n * isSuccess: (res) => res.code === 200,\n * errorMessage: (res) => res.msg,\n * scope: 'server-filtered',\n * })\n * ```\n */\nexport function createPageRequest<TRaw, T = unknown>(\n config: CreatePageRequestConfig<TRaw, T>,\n): PageFetcher<T> {\n const { fetch, rows, total, mapRow, isSuccess, errorMessage, scope, onError, feature } = config\n\n /* 数据级权限提醒。\n 这不是运行时校验 —— 前端无法真正校验权限。它的价值在于\n 把「前端隐藏不构成权限」这件事,出现在写代码的那一刻。 */\n if (scope === 'client-filtered') {\n warnOnce(\n 'data-scope-client-filtered',\n '[fbk/data] scope 为 client-filtered:数据级权限必须由服务端过滤。\\n' +\n ' 前端隐藏不构成权限 —— 列表接口已返回全部数据,\\n' +\n ' 任何用户都能在浏览器 Network 面板看到完整内容。\\n' +\n ' 如果服务端确实做了过滤,请改为 scope: \"server-filtered\"。',\n )\n }\n\n /** 统一的错误上报。不上报 AbortError —— 取消不是错误 */\n const report = (event: PageRequestErrorEvent) => {\n if (!onError) return\n try {\n onError(event)\n } catch {\n /* 上报器自身抛错不能影响业务请求 */\n }\n }\n\n /** 参数快照:只留可复现所需的最小信息,避免大对象进日志 */\n const snapshot = (query: PageQuery): Record<string, unknown> => ({\n page: query.page,\n pageSize: query.pageSize,\n sort: query.sort,\n params: query.params,\n })\n\n return async (query) => {\n let raw: TRaw\n try {\n raw = await fetch(query)\n } catch (err) {\n /* 取消是正常流程(快速翻页时旧请求被 abort),不能当成错误上报 —— 否则监控里全是噪音。\n 判据要覆盖三种真实形状:\n · fetch 原生取消 → DOMException('AbortError')\n · axios v1 signal 取消 → CanceledError(name='CanceledError', code='ERR_CANCELED')\n · abort(customReason) → 直接以 reason 拒约,形状任意\n 最后一种无法靠形状识别,所以**第一判据看 signal 本身**:调用方已经 abort 了,\n 那么无论抛出来的是什么,都不该算错误。 */\n const canceledBySignal = query.signal?.aborted === true\n const cancelLike =\n typeof err === 'object' &&\n err !== null &&\n ((err as { name?: string }).name === 'AbortError' ||\n (err as { name?: string }).name === 'CanceledError' ||\n (err as { code?: string }).code === 'ERR_CANCELED')\n const aborted = canceledBySignal || cancelLike\n if (!aborted) {\n report({\n source: 'request',\n feature,\n message: err instanceof Error ? err.message : String(err),\n cause: err,\n context: snapshot(query),\n })\n }\n throw err\n }\n\n /* 业务码判定。\n 有业务码的后端(ruoyi 的 code===200)如果不传 isSuccess,\n 失败响应会被当成空列表 —— 用户看到「暂无数据」,\n 而真实原因是 token 过期或参数错误。 */\n /* isSuccess / errorMessage 是调用方给的函数,它们自己也可能抛错 ——\n 最常见的是空 body(raw 是 null/undefined)时读 `raw.code`。\n 这两行以前在 try 之外:异常直接冒成裸 TypeError,onError 一次都收不到,\n 等于「请求失败了但监控里什么都没有」。 */\n if (isSuccess) {\n let ok: boolean\n let message: string | undefined\n try {\n ok = isSuccess(raw)\n if (!ok) message = errorMessage?.(raw)\n } catch (err) {\n const reason = err instanceof Error ? err.message : String(err)\n const wrapped = new FbkDataError(\n 'business',\n `[fbk/data] isSuccess/errorMessage 判定抛错(${reason})。响应可能是空 body 或结构不符。`,\n raw,\n )\n report({\n source: 'request',\n feature,\n message: wrapped.message,\n cause: err,\n raw,\n context: snapshot(query),\n })\n throw wrapped\n }\n\n /* 判据必须是「falsy 即失败」,不能写 ok === false:\n `isSuccess: (res) => res.code`、`(res) => res.data?.ok`、`(res) => res.status`\n 这些写法返回的是 undefined / 0 / '' ,用 === false 会把业务失败全部放过 ——\n 失败响应带空数组时用户看到「暂无数据」,不带数组时报「列表位置不是数组」,\n 把排查引到字段名上。`!ok` 才是「不是成功」的意思。 */\n if (!ok) {\n const text = message ?? '请求失败(未提供 errorMessage)'\n report({\n source: 'request',\n feature,\n message: text,\n raw,\n context: snapshot(query),\n })\n throw new FbkDataError('business', text, raw)\n }\n }\n\n try {\n const rawRows = extractRows(raw, rows)\n const totalValue = total !== undefined ? extractTotal(raw, total) : rawRows.length\n\n const list = mapRow\n ? rawRows.map((item, index) => mapRow(item, index))\n : (rawRows as unknown as T[])\n\n return { list, total: totalValue } satisfies Page<T>\n } catch (err) {\n /* 路径解析失败是**开发期错误**(字段名写错),\n 但线上同样会走到这里,所以也要上报。 */\n report({\n source: 'request',\n feature,\n message: err instanceof Error ? err.message : String(err),\n raw,\n cause: err,\n context: snapshot(query),\n })\n throw err\n }\n }\n}\n"],"names":[],"mappings":";;;AA8BO,SAAS,kBACd,QACgB;AAChB,QAAM,EAAE,OAAO,MAAM,OAAO,QAAQ,WAAW,cAAc,OAAO,SAAS,QAAA,IAAY;AAKzF,MAAI,UAAU,mBAAmB;AAC/B;AAAA,MACE;AAAA,MACA;AAAA,IAAA;AAAA,EAKJ;AAGA,QAAM,SAAS,CAAC,UAAiC;AAC/C,QAAI,CAAC,QAAS;AACd,QAAI;AACF,cAAQ,KAAK;AAAA,IACf,QAAQ;AAAA,IAER;AAAA,EACF;AAGA,QAAM,WAAW,CAAC,WAA+C;AAAA,IAC/D,MAAM,MAAM;AAAA,IACZ,UAAU,MAAM;AAAA,IAChB,MAAM,MAAM;AAAA,IACZ,QAAQ,MAAM;AAAA,EAAA;AAGhB,SAAO,OAAO,UAAU;AACtB,QAAI;AACJ,QAAI;AACF,YAAM,MAAM,MAAM,KAAK;AAAA,IACzB,SAAS,KAAK;AAQZ,YAAM,mBAAmB,MAAM,QAAQ,YAAY;AACnD,YAAM,aACJ,OAAO,QAAQ,YACf,QAAQ,SACN,IAA0B,SAAS,gBAClC,IAA0B,SAAS,mBACnC,IAA0B,SAAS;AACxC,YAAM,UAAU,oBAAoB;AACpC,UAAI,CAAC,SAAS;AACZ,eAAO;AAAA,UACL,QAAQ;AAAA,UACR;AAAA,UACA,SAAS,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAAA,UACxD,OAAO;AAAA,UACP,SAAS,SAAS,KAAK;AAAA,QAAA,CACxB;AAAA,MACH;AACA,YAAM;AAAA,IACR;AAUA,QAAI,WAAW;AACb,UAAI;AACJ,UAAI;AACJ,UAAI;AACF,aAAK,UAAU,GAAG;AAClB,YAAI,CAAC,GAAI,WAAU,eAAe,GAAG;AAAA,MACvC,SAAS,KAAK;AACZ,cAAM,SAAS,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAC9D,cAAM,UAAU,IAAI;AAAA,UAClB;AAAA,UACA,0CAA0C,MAAM;AAAA,UAChD;AAAA,QAAA;AAEF,eAAO;AAAA,UACL,QAAQ;AAAA,UACR;AAAA,UACA,SAAS,QAAQ;AAAA,UACjB,OAAO;AAAA,UACP;AAAA,UACA,SAAS,SAAS,KAAK;AAAA,QAAA,CACxB;AACD,cAAM;AAAA,MACR;AAOA,UAAI,CAAC,IAAI;AACP,cAAM,OAAO,WAAW;AACxB,eAAO;AAAA,UACL,QAAQ;AAAA,UACR;AAAA,UACA,SAAS;AAAA,UACT;AAAA,UACA,SAAS,SAAS,KAAK;AAAA,QAAA,CACxB;AACD,cAAM,IAAI,aAAa,YAAY,MAAM,GAAG;AAAA,MAC9C;AAAA,IACF;AAEA,QAAI;AACF,YAAM,UAAU,YAAY,KAAK,IAAI;AACrC,YAAM,aAAa,UAAU,SAAY,aAAa,KAAK,KAAK,IAAI,QAAQ;AAE5E,YAAM,OAAO,SACT,QAAQ,IAAI,CAAC,MAAM,UAAU,OAAO,MAAM,KAAK,CAAC,IAC/C;AAEL,aAAO,EAAE,MAAM,OAAO,WAAA;AAAA,IACxB,SAAS,KAAK;AAGZ,aAAO;AAAA,QACL,QAAQ;AAAA,QACR;AAAA,QACA,SAAS,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAAA,QACxD;AAAA,QACA,OAAO;AAAA,QACP,SAAS,SAAS,KAAK;AAAA,MAAA,CACxB;AACD,YAAM;AAAA,IACR;AAAA,EACF;AACF;"}
1
+ {"version":3,"file":"create.mjs","sources":["../src/create.ts"],"sourcesContent":["import { previewRaw } from './error'\nimport { warnOnce } from './warn'\nimport { FbkDataError } from './error'\nimport { extractRows, extractTotal } from './path'\nimport type {\n CreatePageRequestConfig,\n Page,\n PageFetcher,\n PageQuery,\n PageRequestErrorEvent,\n} from './types'\n\n/**\n * 把「任意形状的后端响应」映射成组件库期望的 `Page<T>`。\n *\n * 这是 @fbkworks/data 的核心:业务方只写「字段在哪」,\n * 不写分页、不写错误处理、不写类型转换。\n *\n * ```ts\n * // ruoyi\n * export const fetchOrders = createPageRequest({\n * fetch: ({ page, pageSize, params, signal }) =>\n * http.get('/api/order/list', { params: { pageNum: page, pageSize, ...params }, signal }),\n * rows: 'rows',\n * total: 'total',\n * isSuccess: (res) => res.code === 200,\n * errorMessage: (res) => res.msg,\n * scope: 'server-filtered',\n * })\n * ```\n */\nexport function createPageRequest<TRaw, T = unknown>(\n config: CreatePageRequestConfig<TRaw, T>,\n): PageFetcher<T> {\n const { fetch, rows, total, mapRow, isSuccess, errorMessage, scope, onError, feature } = config\n\n /* 数据级权限提醒。\n 这不是运行时校验 —— 前端无法真正校验权限。它的价值在于\n 把「前端隐藏不构成权限」这件事,出现在写代码的那一刻。 */\n if (scope === 'client-filtered') {\n warnOnce(\n 'data-scope-client-filtered',\n '[fbk/data] scope 为 client-filtered:数据级权限必须由服务端过滤。\\n' +\n ' 前端隐藏不构成权限 —— 列表接口已返回全部数据,\\n' +\n ' 任何用户都能在浏览器 Network 面板看到完整内容。\\n' +\n ' 如果服务端确实做了过滤,请改为 scope: \"server-filtered\"。',\n )\n }\n\n /** 统一的错误上报。不上报 AbortError —— 取消不是错误 */\n const report = (event: PageRequestErrorEvent) => {\n if (!onError) return\n try {\n onError(event)\n } catch {\n /* 上报器自身抛错不能影响业务请求 */\n }\n }\n\n /** 参数快照:只留可复现所需的最小信息,避免大对象进日志 */\n const snapshot = (query: PageQuery): Record<string, unknown> => ({\n page: query.page,\n pageSize: query.pageSize,\n sort: query.sort,\n params: query.params,\n })\n\n /* 完整响应体只在显式开启时才进事件(默认不收集:事件通常直接进监控,\n 整包业务数据带着 PII 不该是默认行为)。rawPreview 无论如何都有。 */\n const includeRaw = config.includeRaw === true\n\n return async (query) => {\n let raw: TRaw\n try {\n raw = await fetch(query)\n } catch (err) {\n /* 取消是正常流程(快速翻页时旧请求被 abort),不能当成错误上报 —— 否则监控里全是噪音。\n 判据要覆盖三种真实形状:\n · fetch 原生取消 → DOMException('AbortError')\n · axios v1 signal 取消 → CanceledError(name='CanceledError', code='ERR_CANCELED')\n · abort(customReason) → 直接以 reason 拒约,形状任意\n 最后一种无法靠形状识别,所以**第一判据看 signal 本身**:调用方已经 abort 了,\n 那么无论抛出来的是什么,都不该算错误。 */\n const canceledBySignal = query.signal?.aborted === true\n const cancelLike =\n typeof err === 'object' &&\n err !== null &&\n ((err as { name?: string }).name === 'AbortError' ||\n (err as { name?: string }).name === 'CanceledError' ||\n (err as { code?: string }).code === 'ERR_CANCELED')\n const aborted = canceledBySignal || cancelLike\n if (!aborted) {\n report({\n source: 'request',\n feature,\n message: err instanceof Error ? err.message : String(err),\n cause: err,\n context: snapshot(query),\n })\n }\n throw err\n }\n\n /* 业务码判定。\n 有业务码的后端(ruoyi 的 code===200)如果不传 isSuccess,\n 失败响应会被当成空列表 —— 用户看到「暂无数据」,\n 而真实原因是 token 过期或参数错误。 */\n /* isSuccess / errorMessage 是调用方给的函数,它们自己也可能抛错 ——\n 最常见的是空 body(raw 是 null/undefined)时读 `raw.code`。\n 这两行以前在 try 之外:异常直接冒成裸 TypeError,onError 一次都收不到,\n 等于「请求失败了但监控里什么都没有」。 */\n if (isSuccess) {\n let ok: boolean\n let message: string | undefined\n try {\n ok = isSuccess(raw)\n if (!ok) message = errorMessage?.(raw)\n } catch (err) {\n const reason = err instanceof Error ? err.message : String(err)\n const wrapped = new FbkDataError(\n 'business',\n `[fbk/data] isSuccess/errorMessage 判定抛错(${reason})。响应可能是空 body 或结构不符。`,\n raw,\n )\n report({\n source: 'request',\n feature,\n message: wrapped.message,\n cause: err,\n raw: includeRaw ? raw : undefined,\n rawPreview: previewRaw(raw),\n context: snapshot(query),\n })\n throw wrapped\n }\n\n /* 判据必须是「falsy 即失败」,不能写 ok === false:\n `isSuccess: (res) => res.code`、`(res) => res.data?.ok`、`(res) => res.status`\n 这些写法返回的是 undefined / 0 / '' ,用 === false 会把业务失败全部放过 ——\n 失败响应带空数组时用户看到「暂无数据」,不带数组时报「列表位置不是数组」,\n 把排查引到字段名上。`!ok` 才是「不是成功」的意思。 */\n if (!ok) {\n const text = message ?? '请求失败(未提供 errorMessage)'\n report({\n source: 'request',\n feature,\n message: text,\n raw: includeRaw ? raw : undefined,\n rawPreview: previewRaw(raw),\n context: snapshot(query),\n })\n throw new FbkDataError('business', text, raw)\n }\n }\n\n try {\n const rawRows = extractRows(raw, rows)\n const totalValue = total !== undefined ? extractTotal(raw, total) : rawRows.length\n\n const list = mapRow\n ? rawRows.map((item, index) => mapRow(item, index))\n : (rawRows as unknown as T[])\n\n /* hasMore:契约里写着(无限滚动用它判断到头),但以前从来不产出 ——\n 业务方想用就只能放弃 createPageRequest 手写 fetcher,否则只能落到\n 「空页才结束」这条兜底上(每次滚到底多打一次必然为空的请求)。\n 只在调用方声明了 total 字段路径时才下结论:没声明时 totalValue 是当前页行数,\n 据此算出的 hasMore 永远是 false,比不给更糟。 */\n const hasMore =\n total !== undefined && query.page > 0 && query.pageSize > 0\n ? query.page * query.pageSize < totalValue\n : undefined\n\n return { list, total: totalValue, hasMore } satisfies Page<T>\n } catch (err) {\n /* 路径解析失败是**开发期错误**(字段名写错),\n 但线上同样会走到这里,所以也要上报。 */\n report({\n source: 'request',\n feature,\n message: err instanceof Error ? err.message : String(err),\n raw: includeRaw ? raw : undefined,\n rawPreview: previewRaw(raw),\n cause: err,\n context: snapshot(query),\n })\n throw err\n }\n }\n}\n"],"names":[],"mappings":";;;AA+BO,SAAS,kBACd,QACgB;AAChB,QAAM,EAAE,OAAO,MAAM,OAAO,QAAQ,WAAW,cAAc,OAAO,SAAS,QAAA,IAAY;AAKzF,MAAI,UAAU,mBAAmB;AAC/B;AAAA,MACE;AAAA,MACA;AAAA,IAAA;AAAA,EAKJ;AAGA,QAAM,SAAS,CAAC,UAAiC;AAC/C,QAAI,CAAC,QAAS;AACd,QAAI;AACF,cAAQ,KAAK;AAAA,IACf,QAAQ;AAAA,IAER;AAAA,EACF;AAGA,QAAM,WAAW,CAAC,WAA+C;AAAA,IAC/D,MAAM,MAAM;AAAA,IACZ,UAAU,MAAM;AAAA,IAChB,MAAM,MAAM;AAAA,IACZ,QAAQ,MAAM;AAAA,EAAA;AAKhB,QAAM,aAAa,OAAO,eAAe;AAEzC,SAAO,OAAO,UAAU;AACtB,QAAI;AACJ,QAAI;AACF,YAAM,MAAM,MAAM,KAAK;AAAA,IACzB,SAAS,KAAK;AAQZ,YAAM,mBAAmB,MAAM,QAAQ,YAAY;AACnD,YAAM,aACJ,OAAO,QAAQ,YACf,QAAQ,SACN,IAA0B,SAAS,gBAClC,IAA0B,SAAS,mBACnC,IAA0B,SAAS;AACxC,YAAM,UAAU,oBAAoB;AACpC,UAAI,CAAC,SAAS;AACZ,eAAO;AAAA,UACL,QAAQ;AAAA,UACR;AAAA,UACA,SAAS,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAAA,UACxD,OAAO;AAAA,UACP,SAAS,SAAS,KAAK;AAAA,QAAA,CACxB;AAAA,MACH;AACA,YAAM;AAAA,IACR;AAUA,QAAI,WAAW;AACb,UAAI;AACJ,UAAI;AACJ,UAAI;AACF,aAAK,UAAU,GAAG;AAClB,YAAI,CAAC,GAAI,WAAU,eAAe,GAAG;AAAA,MACvC,SAAS,KAAK;AACZ,cAAM,SAAS,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAC9D,cAAM,UAAU,IAAI;AAAA,UAClB;AAAA,UACA,0CAA0C,MAAM;AAAA,UAChD;AAAA,QAAA;AAEF,eAAO;AAAA,UACL,QAAQ;AAAA,UACR;AAAA,UACA,SAAS,QAAQ;AAAA,UACjB,OAAO;AAAA,UACP,KAAK,aAAa,MAAM;AAAA,UACxB,YAAY,WAAW,GAAG;AAAA,UAC1B,SAAS,SAAS,KAAK;AAAA,QAAA,CACxB;AACD,cAAM;AAAA,MACR;AAOA,UAAI,CAAC,IAAI;AACP,cAAM,OAAO,WAAW;AACxB,eAAO;AAAA,UACL,QAAQ;AAAA,UACR;AAAA,UACA,SAAS;AAAA,UACT,KAAK,aAAa,MAAM;AAAA,UACxB,YAAY,WAAW,GAAG;AAAA,UAC1B,SAAS,SAAS,KAAK;AAAA,QAAA,CACxB;AACD,cAAM,IAAI,aAAa,YAAY,MAAM,GAAG;AAAA,MAC9C;AAAA,IACF;AAEA,QAAI;AACF,YAAM,UAAU,YAAY,KAAK,IAAI;AACrC,YAAM,aAAa,UAAU,SAAY,aAAa,KAAK,KAAK,IAAI,QAAQ;AAE5E,YAAM,OAAO,SACT,QAAQ,IAAI,CAAC,MAAM,UAAU,OAAO,MAAM,KAAK,CAAC,IAC/C;AAOL,YAAM,UACJ,UAAU,UAAa,MAAM,OAAO,KAAK,MAAM,WAAW,IACtD,MAAM,OAAO,MAAM,WAAW,aAC9B;AAEN,aAAO,EAAE,MAAM,OAAO,YAAY,QAAA;AAAA,IACpC,SAAS,KAAK;AAGZ,aAAO;AAAA,QACL,QAAQ;AAAA,QACR;AAAA,QACA,SAAS,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAAA,QACxD,KAAK,aAAa,MAAM;AAAA,QACxB,YAAY,WAAW,GAAG;AAAA,QAC1B,OAAO;AAAA,QACP,SAAS,SAAS,KAAK;AAAA,MAAA,CACxB;AACD,YAAM;AAAA,IACR;AAAA,EACF;AACF;"}
package/dist/scope.mjs CHANGED
@@ -1,4 +1,4 @@
1
- import { warnOnce } from "@fbkworks/shared";
1
+ import { warnOnce } from "./warn.mjs";
2
2
  function assertServerScope(feature) {
3
3
  if (typeof process !== "undefined" && process.env?.NODE_ENV === "production") return;
4
4
  warnOnce(
@@ -1 +1 @@
1
- {"version":3,"file":"scope.mjs","sources":["../src/scope.ts"],"sourcesContent":["import { warnOnce } from '@fbkworks/shared'\n\n/**\n * 数据级权限提醒。\n *\n * **这不是校验 —— 前端无法真正校验权限。**\n * 若接口返回了 1000 条,前端隐藏 900 条,那 1000 条依然在\n * 浏览器 Network 面板里。任何有浏览器的人都能看到。\n *\n * 它的价值在于:把「前端隐藏不构成权限」这件事,\n * 出现在写代码的那一刻,而不是等安全审计时被指出来。\n *\n * 仅开发环境提醒。用 NODE_ENV 而不是 import.meta.env:\n * 后者依赖 vite 类型,会让这个纯逻辑包绑定构建工具。\n */\nexport function assertServerScope(feature: string): void {\n // 生产环境直接返回,零开销\n if (typeof process !== 'undefined' && process.env?.NODE_ENV === 'production') return\n\n warnOnce(\n `data-scope-${feature}`,\n `[fbk/data] \"${feature}\" 的数据级权限必须由服务端过滤。\\n` +\n ' 前端隐藏不构成权限 —— 列表接口已返回全部数据,\\n' +\n ' 任何用户都能在浏览器 Network 面板看到完整内容。\\n' +\n ' 如果你确认服务端已按权限过滤,可以忽略这条提醒,\\n' +\n ' 或改用 createPageRequest({ scope: \"server-filtered\" }) 显式声明。',\n )\n}\n"],"names":[],"mappings":";AAeO,SAAS,kBAAkB,SAAuB;AAEvD,MAAI,OAAO,YAAY,eAAe,QAAQ,KAAK,aAAa,aAAc;AAE9E;AAAA,IACE,cAAc,OAAO;AAAA,IACrB,eAAe,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,EAAA;AAM1B;"}
1
+ {"version":3,"file":"scope.mjs","sources":["../src/scope.ts"],"sourcesContent":["import { warnOnce } from './warn'\n\n/**\n * 数据级权限提醒。\n *\n * **这不是校验 —— 前端无法真正校验权限。**\n * 若接口返回了 1000 条,前端隐藏 900 条,那 1000 条依然在\n * 浏览器 Network 面板里。任何有浏览器的人都能看到。\n *\n * 它的价值在于:把「前端隐藏不构成权限」这件事,\n * 出现在写代码的那一刻,而不是等安全审计时被指出来。\n *\n * 仅开发环境提醒。用 NODE_ENV 而不是 import.meta.env:\n * 后者依赖 vite 类型,会让这个纯逻辑包绑定构建工具。\n */\nexport function assertServerScope(feature: string): void {\n // 生产环境直接返回,零开销\n if (typeof process !== 'undefined' && process.env?.NODE_ENV === 'production') return\n\n warnOnce(\n `data-scope-${feature}`,\n `[fbk/data] \"${feature}\" 的数据级权限必须由服务端过滤。\\n` +\n ' 前端隐藏不构成权限 —— 列表接口已返回全部数据,\\n' +\n ' 任何用户都能在浏览器 Network 面板看到完整内容。\\n' +\n ' 如果你确认服务端已按权限过滤,可以忽略这条提醒,\\n' +\n ' 或改用 createPageRequest({ scope: \"server-filtered\" }) 显式声明。',\n )\n}\n"],"names":[],"mappings":";AAeO,SAAS,kBAAkB,SAAuB;AAEvD,MAAI,OAAO,YAAY,eAAe,QAAQ,KAAK,aAAa,aAAc;AAE9E;AAAA,IACE,cAAc,OAAO;AAAA,IACrB,eAAe,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,EAAA;AAM1B;"}
package/dist/types.d.ts CHANGED
@@ -110,6 +110,14 @@ export interface CreatePageRequestConfig<TRaw, T> {
110
110
  * ```
111
111
  */
112
112
  onError?: (event: PageRequestErrorEvent) => void;
113
+ /**
114
+ * 是否把**完整响应体**放进错误事件的 raw。
115
+ *
116
+ * 默认 false:事件通常直接进监控,而整包响应可能包含大量业务数据(含 PII)。
117
+ * 打开后 raw 是原始对象,可读 raw.code 这类结构化字段做分支处理;
118
+ * 无论开关如何,rawPreview(截断字符串)始终可用。
119
+ */
120
+ includeRaw?: boolean;
113
121
  }
114
122
  /** 数据层错误事件。与 adapter-core 的 FbkErrorEvent 形状对齐,但不依赖它 */
115
123
  export interface PageRequestErrorEvent {
@@ -118,8 +126,20 @@ export interface PageRequestErrorEvent {
118
126
  /** 业务标识:通常是接口名,由 feature 选项提供 */
119
127
  feature?: string;
120
128
  message: string;
121
- /** 原始响应(截断后)。网络层错误时为 undefined */
129
+ /**
130
+ * 原始响应。**默认不填充**(`includeRaw: true` 时才给),网络层错误时也是 undefined。
131
+ *
132
+ * 为什么不默认给:这个事件的设计用途是直接进监控(见下面 onError 的示例),
133
+ * 而 raw 是整个 HTTP 响应体 —— 列表接口一页 1000 行是常态,带上就是整页业务数据(含 PII)。
134
+ * 需要读后端错误码做分支处理时显式打开 includeRaw。
135
+ */
122
136
  raw?: unknown;
137
+ /**
138
+ * 原始响应的**截断预览**(字符串,约 500 字符)。永远有值(网络层错误时除外)。
139
+ *
140
+ * 这条是给日志用的:默认路径下 raw 不填充,想看到「响应长什么样」就看它。
141
+ */
142
+ rawPreview?: string;
123
143
  /** 原始异常(fetch 抛错时) */
124
144
  cause?: unknown;
125
145
  /** 本次请求的参数快照(用于复现) */
package/dist/warn.d.ts ADDED
@@ -0,0 +1 @@
1
+ export declare function warnOnce(key: string, message: string): void;
package/dist/warn.mjs ADDED
@@ -0,0 +1,10 @@
1
+ const warned = /* @__PURE__ */ new Set();
2
+ function warnOnce(key, message) {
3
+ if (warned.has(key)) return;
4
+ warned.add(key);
5
+ if (typeof console !== "undefined") console.warn(`[fbk/data] ${message}`);
6
+ }
7
+ export {
8
+ warnOnce
9
+ };
10
+ //# sourceMappingURL=warn.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"warn.mjs","sources":["../src/warn.ts"],"sourcesContent":["/**\n * 本地的一份 warnOnce。\n *\n * 为什么不从 @fbkworks/shared 引:shared 的入口会 re-export useControllableState,\n * 于是它的产物顶层就是 `import { ref, computed } from \"vue\"` ——\n * 任何 import @fbkworks/data 的场景(Node 侧脚本、单测、非 Vue 宿主)都要能解析到 vue,\n * 而这个包对外宣称自己是「与 UI 库无关的纯逻辑」。\n * 代价是 14 行重复代码,换来 data 的运行时依赖清零。\n */\nconst warned = new Set<string>()\n\nexport function warnOnce(key: string, message: string): void {\n if (warned.has(key)) return\n warned.add(key)\n if (typeof console !== \"undefined\") console.warn(`[fbk/data] ${message}`)\n}\n"],"names":[],"mappings":"AASA,MAAM,6BAAa,IAAA;AAEZ,SAAS,SAAS,KAAa,SAAuB;AAC3D,MAAI,OAAO,IAAI,GAAG,EAAG;AACrB,SAAO,IAAI,GAAG;AACd,MAAI,OAAO,YAAY,qBAAqB,KAAK,cAAc,OAAO,EAAE;AAC1E;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fbkworks/data",
3
- "version": "0.5.0",
3
+ "version": "0.6.0",
4
4
  "type": "module",
5
5
  "sideEffects": false,
6
6
  "files": [
@@ -16,9 +16,7 @@
16
16
  },
17
17
  "./package.json": "./package.json"
18
18
  },
19
- "dependencies": {
20
- "@fbkworks/shared": "^0.3.0"
21
- },
19
+ "dependencies": {},
22
20
  "publishConfig": {
23
21
  "access": "public"
24
22
  },