@planet-matrix/mobius-model 0.5.0 → 0.9.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.
Files changed (379) hide show
  1. package/CHANGELOG.md +61 -0
  2. package/README.md +123 -36
  3. package/dist/index.js +715 -4
  4. package/dist/index.js.map +981 -13
  5. package/oxlint.config.ts +6 -0
  6. package/package.json +36 -18
  7. package/src/abort/README.md +92 -0
  8. package/src/abort/abort-manager.ts +278 -0
  9. package/src/abort/abort-signal-listener-manager.ts +81 -0
  10. package/src/abort/index.ts +2 -0
  11. package/src/ai/README.md +1 -0
  12. package/src/ai/ai.ts +107 -0
  13. package/src/ai/chat-completion-ai/aihubmix-chat-completion.ts +78 -0
  14. package/src/ai/chat-completion-ai/chat-completion-ai.ts +270 -0
  15. package/src/ai/chat-completion-ai/chat-completion.ts +189 -0
  16. package/src/ai/chat-completion-ai/index.ts +7 -0
  17. package/src/ai/chat-completion-ai/lingyiwanwu-chat-completion.ts +78 -0
  18. package/src/ai/chat-completion-ai/ohmygpt-chat-completion.ts +78 -0
  19. package/src/ai/chat-completion-ai/openai-next-chat-completion.ts +78 -0
  20. package/src/ai/embedding-ai/embedding-ai.ts +63 -0
  21. package/src/ai/embedding-ai/embedding.ts +50 -0
  22. package/src/ai/embedding-ai/index.ts +4 -0
  23. package/src/ai/embedding-ai/openai-next-embedding.ts +23 -0
  24. package/src/ai/index.ts +4 -0
  25. package/src/aio/README.md +100 -0
  26. package/src/aio/content.ts +141 -0
  27. package/src/aio/index.ts +3 -0
  28. package/src/aio/json.ts +127 -0
  29. package/src/aio/prompt.ts +246 -0
  30. package/src/basic/README.md +72 -116
  31. package/src/basic/error.ts +19 -5
  32. package/src/basic/function.ts +83 -64
  33. package/src/basic/index.ts +1 -0
  34. package/src/basic/is.ts +152 -71
  35. package/src/basic/promise.ts +29 -8
  36. package/src/basic/schedule.ts +111 -0
  37. package/src/basic/stream.ts +135 -25
  38. package/src/basic/string.ts +2 -33
  39. package/src/color/README.md +105 -0
  40. package/src/color/index.ts +3 -0
  41. package/src/color/internal.ts +42 -0
  42. package/src/color/rgb/analyze.ts +236 -0
  43. package/src/color/rgb/construct.ts +130 -0
  44. package/src/color/rgb/convert.ts +227 -0
  45. package/src/color/rgb/derive.ts +303 -0
  46. package/src/color/rgb/index.ts +6 -0
  47. package/src/color/rgb/internal.ts +208 -0
  48. package/src/color/rgb/parse.ts +302 -0
  49. package/src/color/rgb/serialize.ts +144 -0
  50. package/src/color/types.ts +57 -0
  51. package/src/color/xyz/analyze.ts +80 -0
  52. package/src/color/xyz/construct.ts +19 -0
  53. package/src/color/xyz/convert.ts +71 -0
  54. package/src/color/xyz/index.ts +3 -0
  55. package/src/color/xyz/internal.ts +23 -0
  56. package/src/credential/README.md +107 -0
  57. package/src/credential/api-key.ts +158 -0
  58. package/src/credential/bearer.ts +73 -0
  59. package/src/credential/index.ts +4 -0
  60. package/src/credential/json-web-token.ts +96 -0
  61. package/src/credential/password.ts +170 -0
  62. package/src/cron/README.md +86 -0
  63. package/src/cron/cron.ts +87 -0
  64. package/src/cron/index.ts +1 -0
  65. package/src/css/README.md +93 -0
  66. package/src/css/class.ts +559 -0
  67. package/src/css/index.ts +1 -0
  68. package/src/drizzle/README.md +1 -0
  69. package/src/drizzle/drizzle.ts +1 -0
  70. package/src/drizzle/helper.ts +47 -0
  71. package/src/drizzle/index.ts +5 -0
  72. package/src/drizzle/infer.ts +52 -0
  73. package/src/drizzle/kysely.ts +8 -0
  74. package/src/drizzle/pagination.ts +200 -0
  75. package/src/email/README.md +1 -0
  76. package/src/email/index.ts +1 -0
  77. package/src/email/resend.ts +25 -0
  78. package/src/encoding/README.md +66 -79
  79. package/src/encoding/base64.ts +13 -4
  80. package/src/environment/README.md +97 -0
  81. package/src/environment/basic.ts +26 -0
  82. package/src/environment/device.ts +311 -0
  83. package/src/environment/feature.ts +285 -0
  84. package/src/environment/geo.ts +337 -0
  85. package/src/environment/index.ts +7 -0
  86. package/src/environment/runtime.ts +400 -0
  87. package/src/environment/snapshot.ts +60 -0
  88. package/src/environment/variable.ts +239 -0
  89. package/src/event/README.md +90 -0
  90. package/src/event/class-event-proxy.ts +229 -0
  91. package/src/event/common.ts +29 -0
  92. package/src/event/event-manager.ts +203 -0
  93. package/src/event/index.ts +4 -0
  94. package/src/event/instance-event-proxy.ts +187 -0
  95. package/src/event/internal.ts +24 -0
  96. package/src/exception/README.md +96 -0
  97. package/src/exception/browser.ts +219 -0
  98. package/src/exception/index.ts +4 -0
  99. package/src/exception/nodejs.ts +169 -0
  100. package/src/exception/normalize.ts +106 -0
  101. package/src/exception/types.ts +99 -0
  102. package/src/form/README.md +25 -0
  103. package/src/form/index.ts +1 -0
  104. package/src/form/inputor-controller/base.ts +874 -0
  105. package/src/form/inputor-controller/boolean.ts +39 -0
  106. package/src/form/inputor-controller/file.ts +39 -0
  107. package/src/form/inputor-controller/form.ts +181 -0
  108. package/src/form/inputor-controller/helper.ts +117 -0
  109. package/src/form/inputor-controller/index.ts +17 -0
  110. package/src/form/inputor-controller/multi-select.ts +99 -0
  111. package/src/form/inputor-controller/number.ts +116 -0
  112. package/src/form/inputor-controller/select.ts +109 -0
  113. package/src/form/inputor-controller/text.ts +82 -0
  114. package/src/http/READMD.md +1 -0
  115. package/src/http/api/api-core.ts +84 -0
  116. package/src/http/api/api-handler.ts +79 -0
  117. package/src/http/api/api-host.ts +47 -0
  118. package/src/http/api/api-result.ts +56 -0
  119. package/src/http/api/api-schema.ts +154 -0
  120. package/src/http/api/api-server.ts +130 -0
  121. package/src/http/api/api-test.ts +142 -0
  122. package/src/http/api/api-type.ts +37 -0
  123. package/src/http/api/api.ts +81 -0
  124. package/src/http/api/index.ts +11 -0
  125. package/src/http/api-adapter/api-core-node-http.ts +260 -0
  126. package/src/http/api-adapter/api-host-node-http.ts +156 -0
  127. package/src/http/api-adapter/api-result-arktype.ts +297 -0
  128. package/src/http/api-adapter/api-result-zod.ts +286 -0
  129. package/src/http/api-adapter/index.ts +5 -0
  130. package/src/http/bin/gen-api-list/gen-api-list.ts +126 -0
  131. package/src/http/bin/gen-api-list/index.ts +1 -0
  132. package/src/http/bin/gen-api-test/gen-api-test.ts +136 -0
  133. package/src/http/bin/gen-api-test/index.ts +1 -0
  134. package/src/http/bin/gen-api-type/calc-code.ts +25 -0
  135. package/src/http/bin/gen-api-type/gen-api-type.ts +127 -0
  136. package/src/http/bin/gen-api-type/index.ts +2 -0
  137. package/src/http/bin/index.ts +2 -0
  138. package/src/http/index.ts +3 -0
  139. package/src/huawei/README.md +1 -0
  140. package/src/huawei/index.ts +2 -0
  141. package/src/huawei/moderation/index.ts +1 -0
  142. package/src/huawei/moderation/moderation.ts +355 -0
  143. package/src/huawei/obs/esdk-obs-nodejs.d.ts +87 -0
  144. package/src/huawei/obs/index.ts +1 -0
  145. package/src/huawei/obs/obs.ts +42 -0
  146. package/src/identifier/README.md +92 -0
  147. package/src/identifier/id.ts +119 -0
  148. package/src/identifier/index.ts +2 -0
  149. package/src/identifier/uuid.ts +187 -0
  150. package/src/index.ts +33 -1
  151. package/src/json/README.md +92 -0
  152. package/src/json/index.ts +1 -0
  153. package/src/json/repair.ts +18 -0
  154. package/src/log/README.md +79 -0
  155. package/src/log/index.ts +5 -0
  156. package/src/log/log-emitter.ts +72 -0
  157. package/src/log/log-record.ts +10 -0
  158. package/src/log/log-scheduler.ts +74 -0
  159. package/src/log/log-type.ts +8 -0
  160. package/src/log/logger.ts +554 -0
  161. package/src/openai/README.md +1 -0
  162. package/src/openai/index.ts +1 -0
  163. package/src/openai/openai.ts +510 -0
  164. package/src/orchestration/README.md +91 -0
  165. package/src/orchestration/coordination/barrier.ts +214 -0
  166. package/src/orchestration/coordination/count-down-latch.ts +215 -0
  167. package/src/orchestration/coordination/errors.ts +98 -0
  168. package/src/orchestration/coordination/index.ts +16 -0
  169. package/src/orchestration/coordination/internal/wait-constraints.ts +95 -0
  170. package/src/orchestration/coordination/internal/wait-queue.ts +109 -0
  171. package/src/orchestration/coordination/keyed-lock.ts +168 -0
  172. package/src/orchestration/coordination/mutex.ts +257 -0
  173. package/src/orchestration/coordination/permit.ts +127 -0
  174. package/src/orchestration/coordination/read-write-lock.ts +444 -0
  175. package/src/orchestration/coordination/semaphore.ts +280 -0
  176. package/src/orchestration/dispatching/dispatcher.ts +83 -0
  177. package/src/orchestration/dispatching/index.ts +2 -0
  178. package/src/orchestration/dispatching/selector/base-selector.ts +39 -0
  179. package/src/orchestration/dispatching/selector/down-count-selector.ts +119 -0
  180. package/src/orchestration/dispatching/selector/index.ts +2 -0
  181. package/src/orchestration/index.ts +3 -0
  182. package/src/orchestration/scheduling/index.ts +2 -0
  183. package/src/orchestration/scheduling/scheduler.ts +103 -0
  184. package/src/orchestration/scheduling/task.ts +32 -0
  185. package/src/random/README.md +56 -86
  186. package/src/random/base.ts +66 -0
  187. package/src/random/index.ts +5 -1
  188. package/src/random/random-boolean.ts +40 -0
  189. package/src/random/random-integer.ts +60 -0
  190. package/src/random/random-number.ts +72 -0
  191. package/src/random/random-string.ts +66 -0
  192. package/src/reactor/README.md +4 -0
  193. package/src/reactor/reactor-core/primitive.ts +9 -9
  194. package/src/reactor/reactor-core/reactive-system.ts +5 -5
  195. package/src/request/README.md +108 -0
  196. package/src/request/fetch/base.ts +108 -0
  197. package/src/request/fetch/browser.ts +285 -0
  198. package/src/request/fetch/general.ts +20 -0
  199. package/src/request/fetch/index.ts +4 -0
  200. package/src/request/fetch/nodejs.ts +285 -0
  201. package/src/request/index.ts +2 -0
  202. package/src/request/request/base.ts +250 -0
  203. package/src/request/request/general.ts +64 -0
  204. package/src/request/request/index.ts +3 -0
  205. package/src/request/request/resource.ts +68 -0
  206. package/src/result/README.md +4 -0
  207. package/src/result/controller.ts +54 -0
  208. package/src/result/either.ts +193 -0
  209. package/src/result/index.ts +2 -0
  210. package/src/route/README.md +105 -0
  211. package/src/route/adapter/browser.ts +122 -0
  212. package/src/route/adapter/driver.ts +56 -0
  213. package/src/route/adapter/index.ts +2 -0
  214. package/src/route/index.ts +3 -0
  215. package/src/route/router/index.ts +2 -0
  216. package/src/route/router/route.ts +630 -0
  217. package/src/route/router/router.ts +1642 -0
  218. package/src/route/uri/hash.ts +308 -0
  219. package/src/route/uri/index.ts +7 -0
  220. package/src/route/uri/pathname.ts +376 -0
  221. package/src/route/uri/search.ts +413 -0
  222. package/src/singleton/README.md +79 -0
  223. package/src/singleton/factory.ts +55 -0
  224. package/src/singleton/index.ts +2 -0
  225. package/src/singleton/manager.ts +204 -0
  226. package/src/socket/README.md +105 -0
  227. package/src/socket/client/index.ts +2 -0
  228. package/src/socket/client/socket-unit.ts +660 -0
  229. package/src/socket/client/socket.ts +203 -0
  230. package/src/socket/common/index.ts +2 -0
  231. package/src/socket/common/socket-unit-common.ts +23 -0
  232. package/src/socket/common/socket-unit-heartbeat.ts +427 -0
  233. package/src/socket/index.ts +3 -0
  234. package/src/socket/server/index.ts +3 -0
  235. package/src/socket/server/server.ts +183 -0
  236. package/src/socket/server/socket-unit.ts +449 -0
  237. package/src/socket/server/socket.ts +264 -0
  238. package/src/storage/README.md +107 -0
  239. package/src/storage/index.ts +1 -0
  240. package/src/storage/table.ts +449 -0
  241. package/src/timer/README.md +86 -0
  242. package/src/timer/expiration/expiration-manager.ts +594 -0
  243. package/src/timer/expiration/index.ts +3 -0
  244. package/src/timer/expiration/min-heap.ts +208 -0
  245. package/src/timer/expiration/remaining-manager.ts +241 -0
  246. package/src/timer/index.ts +1 -0
  247. package/src/tube/README.md +99 -0
  248. package/src/tube/helper.ts +138 -0
  249. package/src/tube/index.ts +2 -0
  250. package/src/tube/tube.ts +880 -0
  251. package/src/type/README.md +54 -307
  252. package/src/type/class.ts +2 -2
  253. package/src/type/index.ts +14 -14
  254. package/src/type/is.ts +265 -2
  255. package/src/type/object.ts +37 -0
  256. package/src/type/string.ts +7 -2
  257. package/src/type/tuple.ts +6 -6
  258. package/src/type/union.ts +16 -0
  259. package/src/web/README.md +77 -0
  260. package/src/web/capture.ts +35 -0
  261. package/src/web/clipboard.ts +97 -0
  262. package/src/web/dom.ts +117 -0
  263. package/src/web/download.ts +16 -0
  264. package/src/web/event.ts +46 -0
  265. package/src/web/index.ts +10 -0
  266. package/src/web/local-storage.ts +113 -0
  267. package/src/web/location.ts +28 -0
  268. package/src/web/permission.ts +172 -0
  269. package/src/web/script-loader.ts +432 -0
  270. package/src/weixin/README.md +1 -0
  271. package/src/weixin/index.ts +2 -0
  272. package/src/weixin/official-account/authorization.ts +159 -0
  273. package/src/weixin/official-account/index.ts +2 -0
  274. package/src/weixin/official-account/js-api.ts +134 -0
  275. package/src/weixin/open/index.ts +1 -0
  276. package/src/weixin/open/oauth2.ts +133 -0
  277. package/tests/unit/abort/abort-manager.spec.ts +225 -0
  278. package/tests/unit/abort/abort-signal-listener-manager.spec.ts +62 -0
  279. package/tests/unit/ai/ai.spec.ts +85 -0
  280. package/tests/unit/aio/content.spec.ts +105 -0
  281. package/tests/unit/aio/json.spec.ts +147 -0
  282. package/tests/unit/aio/prompt.spec.ts +111 -0
  283. package/tests/unit/basic/array.spec.ts +1 -1
  284. package/tests/unit/basic/error.spec.ts +16 -4
  285. package/tests/unit/basic/schedule.spec.ts +74 -0
  286. package/tests/unit/basic/stream.spec.ts +91 -38
  287. package/tests/unit/basic/string.spec.ts +0 -9
  288. package/tests/unit/color/rgb/analyze.spec.ts +110 -0
  289. package/tests/unit/color/rgb/construct.spec.ts +56 -0
  290. package/tests/unit/color/rgb/convert.spec.ts +60 -0
  291. package/tests/unit/color/rgb/derive.spec.ts +103 -0
  292. package/tests/unit/color/rgb/parse.spec.ts +66 -0
  293. package/tests/unit/color/rgb/serialize.spec.ts +46 -0
  294. package/tests/unit/color/xyz/analyze.spec.ts +33 -0
  295. package/tests/unit/color/xyz/construct.spec.ts +10 -0
  296. package/tests/unit/color/xyz/convert.spec.ts +18 -0
  297. package/tests/unit/credential/api-key.spec.ts +37 -0
  298. package/tests/unit/credential/bearer.spec.ts +23 -0
  299. package/tests/unit/credential/json-web-token.spec.ts +23 -0
  300. package/tests/unit/credential/password.spec.ts +41 -0
  301. package/tests/unit/cron/cron.spec.ts +84 -0
  302. package/tests/unit/css/class.spec.ts +157 -0
  303. package/tests/unit/environment/basic.spec.ts +20 -0
  304. package/tests/unit/environment/device.spec.ts +146 -0
  305. package/tests/unit/environment/feature.spec.ts +388 -0
  306. package/tests/unit/environment/geo.spec.ts +111 -0
  307. package/tests/unit/environment/runtime.spec.ts +364 -0
  308. package/tests/unit/environment/snapshot.spec.ts +4 -0
  309. package/tests/unit/environment/variable.spec.ts +190 -0
  310. package/tests/unit/event/class-event-proxy.spec.ts +225 -0
  311. package/tests/unit/event/event-manager.spec.ts +246 -0
  312. package/tests/unit/event/instance-event-proxy.spec.ts +187 -0
  313. package/tests/unit/exception/browser.spec.ts +213 -0
  314. package/tests/unit/exception/nodejs.spec.ts +144 -0
  315. package/tests/unit/exception/normalize.spec.ts +57 -0
  316. package/tests/unit/form/inputor-controller/base.spec.ts +458 -0
  317. package/tests/unit/form/inputor-controller/boolean.spec.ts +30 -0
  318. package/tests/unit/form/inputor-controller/file.spec.ts +27 -0
  319. package/tests/unit/form/inputor-controller/form.spec.ts +120 -0
  320. package/tests/unit/form/inputor-controller/helper.spec.ts +67 -0
  321. package/tests/unit/form/inputor-controller/multi-select.spec.ts +34 -0
  322. package/tests/unit/form/inputor-controller/number.spec.ts +36 -0
  323. package/tests/unit/form/inputor-controller/select.spec.ts +49 -0
  324. package/tests/unit/form/inputor-controller/text.spec.ts +34 -0
  325. package/tests/unit/http/api/api-core-host.spec.ts +207 -0
  326. package/tests/unit/http/api/api-schema.spec.ts +120 -0
  327. package/tests/unit/http/api/api-server.spec.ts +363 -0
  328. package/tests/unit/http/api/api-test.spec.ts +117 -0
  329. package/tests/unit/http/api/api.spec.ts +121 -0
  330. package/tests/unit/http/api-adapter/node-http.spec.ts +191 -0
  331. package/tests/unit/identifier/id.spec.ts +71 -0
  332. package/tests/unit/identifier/uuid.spec.ts +85 -0
  333. package/tests/unit/json/repair.spec.ts +11 -0
  334. package/tests/unit/log/log-emitter.spec.ts +33 -0
  335. package/tests/unit/log/log-scheduler.spec.ts +40 -0
  336. package/tests/unit/log/log-type.spec.ts +7 -0
  337. package/tests/unit/log/logger.spec.ts +237 -0
  338. package/tests/unit/openai/openai.spec.ts +64 -0
  339. package/tests/unit/orchestration/coordination/barrier.spec.ts +96 -0
  340. package/tests/unit/orchestration/coordination/count-down-latch.spec.ts +63 -0
  341. package/tests/unit/orchestration/coordination/errors.spec.ts +29 -0
  342. package/tests/unit/orchestration/coordination/keyed-lock.spec.ts +109 -0
  343. package/tests/unit/orchestration/coordination/mutex.spec.ts +132 -0
  344. package/tests/unit/orchestration/coordination/permit.spec.ts +43 -0
  345. package/tests/unit/orchestration/coordination/read-write-lock.spec.ts +154 -0
  346. package/tests/unit/orchestration/coordination/semaphore.spec.ts +135 -0
  347. package/tests/unit/orchestration/dispatching/dispatcher.spec.ts +41 -0
  348. package/tests/unit/orchestration/dispatching/selector/down-count-selector.spec.ts +81 -0
  349. package/tests/unit/orchestration/scheduling/scheduler.spec.ts +103 -0
  350. package/tests/unit/random/base.spec.ts +58 -0
  351. package/tests/unit/random/random-boolean.spec.ts +25 -0
  352. package/tests/unit/random/random-integer.spec.ts +32 -0
  353. package/tests/unit/random/random-number.spec.ts +33 -0
  354. package/tests/unit/random/random-string.spec.ts +22 -0
  355. package/tests/unit/reactor/alien-signals-effect.spec.ts +11 -10
  356. package/tests/unit/reactor/preact-signal.spec.ts +1 -2
  357. package/tests/unit/request/fetch/browser.spec.ts +222 -0
  358. package/tests/unit/request/fetch/general.spec.ts +43 -0
  359. package/tests/unit/request/fetch/nodejs.spec.ts +225 -0
  360. package/tests/unit/request/request/base.spec.ts +385 -0
  361. package/tests/unit/request/request/general.spec.ts +161 -0
  362. package/tests/unit/route/router/route.spec.ts +431 -0
  363. package/tests/unit/route/router/router.spec.ts +407 -0
  364. package/tests/unit/route/uri/hash.spec.ts +72 -0
  365. package/tests/unit/route/uri/pathname.spec.ts +147 -0
  366. package/tests/unit/route/uri/search.spec.ts +107 -0
  367. package/tests/unit/singleton/singleton.spec.ts +49 -0
  368. package/tests/unit/socket/client.spec.ts +208 -0
  369. package/tests/unit/socket/server.spec.ts +135 -0
  370. package/tests/unit/socket/socket-unit-heartbeat.spec.ts +214 -0
  371. package/tests/unit/storage/table.spec.ts +620 -0
  372. package/tests/unit/timer/expiration/expiration-manager.spec.ts +464 -0
  373. package/tests/unit/timer/expiration/min-heap.spec.ts +71 -0
  374. package/tests/unit/timer/expiration/remaining-manager.spec.ts +234 -0
  375. package/tests/unit/tube/helper.spec.ts +139 -0
  376. package/tests/unit/tube/tube.spec.ts +501 -0
  377. package/.oxlintrc.json +0 -5
  378. package/src/random/uuid.ts +0 -103
  379. package/tests/unit/random/uuid.spec.ts +0 -37
@@ -0,0 +1,92 @@
1
+ # Identifier
2
+
3
+ ## Description
4
+
5
+ Identifier 模块用于提供围绕逻辑标识(logical identifier)进行生成、判断、断言、比较与序列化的基础能力,并统一收纳与通用唯一标识符(UUID, Universally Unique Identifier)相关的格式校验与生成语义。
6
+
7
+ 它关注的是“系统如何稳定表达身份与标识”,而不是某个业务系统的编号规则、数据库主键策略或外部协议字段约定。
8
+
9
+ ## For Understanding
10
+
11
+ 理解 Identifier 模块时,应先把逻辑身份与标识格式区分开。这里同时承载两类彼此相关、但层次不同的能力:
12
+
13
+ - `Id` 用于表达库内部的逻辑身份,是一种不透明的运行时标识值。
14
+ - `UUID` 用于表达广泛使用的通用标识字符串格式,适合在系统边界做校验、断言、版本读取和字符串生成。
15
+
16
+ 把这两类能力放在同一个模块中,核心原因不是它们实现方式相同,而是它们都服务于“谁是谁、一个标识是否合法、一个标识如何被稳定生成和传递”这一共同问题域。相对地,随机字符串本身更偏向随机输入生成,不再属于这个边界。
17
+
18
+ 这个模块不适合承载数据库自增键、雪花算法、业务编码规则、分布式全局编号体系或任何需要额外持久化与跨系统一致性承诺的标识模型。若未来出现这类需求,应按更明确的问题域继续建模,而不是直接膨胀当前模块。
19
+
20
+ ## For Using
21
+
22
+ 当你需要在系统中稳定表达身份语义,或在边界层处理 UUID 一类的通用标识字符串时,可以使用这个模块。它适合放在跨模块协作、基础设施边界、日志关联、资源索引和接口参数校验等场景中。
23
+
24
+ 当前公共能力大致可以按以下几类理解:
25
+
26
+ - 逻辑身份生成:用于创建新的 `Id`,或基于同一种子复用同一个运行时标识实例。
27
+ - 逻辑身份判断与比较:用于判断一个值是否为 `Id`,以及区分“同一个实例”和“同一个内部标识值”。
28
+ - 逻辑身份序列化:用于把 `Id` 转换为适合日志、调试和展示的字符串形式。
29
+ - UUID 校验与断言:用于在外部输入进入系统前确认其格式是否合法。
30
+ - UUID 生成:用于生成 UUID v4 与 UUID v7 字符串,以满足常规唯一性和近似时间有序标识场景。
31
+
32
+ 更合理的接入方式,是在边界层尽早决定你需要的是“内部逻辑身份”还是“外部通用标识字符串”。两者虽然都属于 Identifier,但不应相互混用。
33
+
34
+ ## For Contributing
35
+
36
+ 贡献 Identifier 模块时,应优先判断新增能力是否真的在澄清标识语义,而不是借“编号”或“随机”名义引入其它问题域。这里应长期承载的是逻辑身份模型与通用标识格式模型,而不是各种临时编码技巧的集合。
37
+
38
+ 在扩展时,应优先遵守以下边界:
39
+
40
+ - `Id` 应继续保持为不透明的逻辑身份值,不要让调用方依赖其内部结构。
41
+ - UUID 相关能力应围绕格式判断、断言、版本提取和生成展开,不要混入业务编号规则。
42
+ - 如果某个能力的重点已经变成“随机文本如何生成”,应优先考虑 Random 模块,而不是继续放入 Identifier。
43
+ - 如果某个能力需要更强的持久化、安全性或跨系统一致性承诺,应在更具体的问题域中单独建模。
44
+
45
+ ### JSDoc 注释格式要求
46
+
47
+ - 每个公开导出的目标(类型、函数、变量、类等)都应包含 JSDoc 注释,让人在不跳转实现的情况下就能理解用途。
48
+ - JSDoc 注释第一行应为清晰且简洁的描述,该描述优先使用中文(英文也可以)。
49
+ - 如果描述后还有其他内容,应在描述后加一个空行。
50
+ - 如果有示例,应使用 `@example` 标签,后接三重反引号代码块(不带语言标识)。
51
+ - 如果有示例,应包含多个场景,展示不同用法,尤其要覆盖常见组合方式或边界输入。
52
+ - 如果有示例,应使用注释格式说明每个场景:`// Expect: <result>`。
53
+ - 如果有示例,应将结果赋值给 `example1`、`example2` 之类的变量,以保持示例易读。
54
+ - 如果有示例,`// Expect: <result>` 应该位于 `example1`、`example2` 之前,以保持示例的逻辑清晰。
55
+ - 如果有示例,应优先使用确定性示例;避免断言精确的随机输出。
56
+ - 如果函数返回结构化字符串,应展示其预期格式特征。
57
+ - 如果有参考资料,应将 `@see` 放在 `@example` 代码块之后,并用一个空行分隔。
58
+
59
+ ### 实现规范要求
60
+
61
+ - 不同程序元素之间使用一个空行分隔,保持结构清楚。这里的程序元素,通常指函数、类型、常量,以及直接服务于它们的辅助元素。
62
+ - 某程序元素独占的辅助元素与该程序元素本身视为一个整体,不要在它们之间添加空行。
63
+ - 程序元素的辅助元素应该放置在该程序元素的上方,以保持阅读时的逻辑顺序。
64
+ - 若辅助元素被多个程序元素共享,则应将其视为独立的程序元素,放在这些程序元素中第一个相关目标的上方,并与后续程序元素之间保留一个空行。
65
+ - 辅助元素也应该像其它程序元素一样,保持清晰的命名和适当的注释,以便在需要阅读实现细节时能够快速理解它们的作用和使用方式。
66
+ - 辅助元素的命名必须以前缀 `internal` 开头(或 `Internal`,大小写不敏感)。
67
+ - 辅助元素永远不要公开导出。
68
+ - 被模块内多个不同文件中的程序元素共享的辅助元素,应该放在一个单独的文件中,例如 `./src/identifier/internal.ts`;若当前没有必要,不必为了形式强行拆分。
69
+ - 模块内可以包含子模块。只有当某个子目录表达一个稳定、可单独理解、且可能被父模块重导出的子问题域时,才应将其视为子模块。
70
+ - 子模块包含多个文件时,应该为其单独创建子文件夹,并为其创建单独的 Barrel 文件;父模块的 Barrel 文件再重导出子模块的 Barrel 文件。
71
+ - 子模块不需要有自己的 `README.md`。
72
+ - 子模块可以有自己的 `internal.ts` 文件,多个子模块共享的辅助元素应该放在父模块的 `internal.ts` 文件中,单个子模块共享的辅助元素应该放在该子模块的 `internal.ts` 文件中。
73
+ - 对模块依赖关系的要求(通常是不循环依赖或不反向依赖)与对 DRY 的要求可能产生冲突。此时,若复用的代码数量不大,可以适当牺牲 DRY,复制粘贴并保留必要的注释说明;若复用的代码数量较大,则可以将其抽象到新的文件或子模块中,如 `common.ts`,并在需要的地方导入使用。
74
+ - 实现应继续保证逻辑身份语义与标识字符串语义都通过稳定公共入口暴露,而不是通过内部形状或偶然路径被外部依赖。
75
+
76
+ ### 导出策略要求
77
+
78
+ - 保持内部辅助项和内部符号为私有,不要让外部接入依赖临时性的内部结构。
79
+ - 每个模块都应有一个用于重导出所有公共 API 的 Barrel 文件。
80
+ - Barrel 文件应命名为 `index.ts`,放在模块目录根部,并且所有公共 API 都应从该文件导出。
81
+ - 新增公共能力时,应优先检查它是否表达稳定、清楚且值得长期维护的标识语义,而不是某段实现细节的便捷暴露;仅在确认需要长期对外承诺时再加入 Barrel 导出。
82
+
83
+ ### 测试要求
84
+
85
+ - 若程序元素是函数,则只为该函数编写一个测试,如果该函数需要测试多个用例,应放在同一个测试中。
86
+ - 若程序元素是类,则至少要为该类的每一个方法编写一个测试,如果该方法需要测试多个用例,应放在同一个测试中。
87
+ - 若程序元素是类,除了为该类的每一个方法编写至少一个测试之外,还可以为该类编写任意多个测试,以覆盖该类的不同使用场景或边界情况。
88
+ - 若编写测试时需要用到辅助元素(Mock 或 Spy 等),可以在测试文件中直接定义这些辅助元素。若辅助元素较为简单,则可以直接放在每一个测试内部,优先保证每个测试的独立性,而不是追求极致 DRY;若辅助元素较为复杂或需要在多个测试中复用,则可以放在测试文件顶部,供该测试文件中的所有测试使用。
89
+ - 测试顺序应与源文件中被测试目标的原始顺序保持一致。
90
+ - 若该模块不需要测试,必须在说明文件中明确说明该模块不需要测试,并说明理由。一般来说,只有在该模块没有可执行的公共函数、只承载类型层表达,或其语义已被上层模块的测试完整覆盖且重复测试几乎不再带来额外价值时,才适合这样处理。
91
+ - 模块的单元测试文件目录是 `./tests/unit/identifier`,若模块包含子模块,则子模块的单元测试文件目录为 `./tests/unit/identifier/<sub-module-name>`。
92
+ - 测试应重点覆盖带种子与不带种子的 `Id` 生成语义、`Id` 的比较与序列化,以及 UUID 的格式校验、版本读取和不同生成路径的结果特征。
@@ -0,0 +1,119 @@
1
+ import { generateUuidV7 } from "./uuid.ts"
2
+
3
+ const INTERNAL_ID: unique symbol = Symbol("INTERNAL_ID")
4
+ type IdentifierSeed = string | number | symbol
5
+
6
+ /**
7
+ * Represent a logical identity value.
8
+ *
9
+ * @example
10
+ * ```
11
+ * const userId = generateId("user:1")
12
+ * const example1 = isId(userId)
13
+ * // Expect: true
14
+ *
15
+ * const example2 = String(userId)
16
+ * // Expect: starts with "Symbol-ID-"
17
+ * ```
18
+ */
19
+ export interface Id {
20
+ [INTERNAL_ID]: string
21
+ [Symbol.toPrimitive]: (hint: string) => string
22
+ }
23
+
24
+ const internalIdPacket: Record<IdentifierSeed, Id> = {}
25
+
26
+ /**
27
+ * 根据种子生成 `Id`,或在未提供种子时生成一个新的 `Id`。
28
+ *
29
+ * 当传入种子时,同一种子会复用同一个 `Id` 实例;未传入种子时,每次都会得到新的 `Id`。
30
+ *
31
+ * @example
32
+ * ```
33
+ * const stableA = generateId("user:1")
34
+ * const stableB = generateId("user:1")
35
+ * const example1 = Object.is(stableA, stableB)
36
+ * // Expect: true
37
+ *
38
+ * const freshA = generateId()
39
+ * const freshB = generateId()
40
+ * const example2 = Object.is(freshA, freshB)
41
+ * // Expect: false
42
+ * ```
43
+ */
44
+ export const generateId = (seed?: IdentifierSeed | undefined): Id => {
45
+ if (seed === undefined) {
46
+ const id = {
47
+ [INTERNAL_ID]: generateUuidV7(),
48
+ [Symbol.toPrimitive]: (): string => {
49
+ return idToString(id)
50
+ },
51
+ }
52
+ return id
53
+ }
54
+
55
+ const id = internalIdPacket[seed] ?? {
56
+ [INTERNAL_ID]: generateUuidV7(),
57
+ [Symbol.toPrimitive]: (): string => {
58
+ return idToString(id)
59
+ },
60
+ }
61
+ internalIdPacket[seed] = id
62
+
63
+ return id
64
+ }
65
+
66
+ /**
67
+ * 判断一个值是否为 `Id`。
68
+ */
69
+ export const isId = (target: unknown): target is Id => {
70
+ return typeof target === "object" && target !== null && INTERNAL_ID in target
71
+ }
72
+
73
+ type AssertId = (target: unknown) => asserts target is Id
74
+
75
+ /**
76
+ * 断言一个值是 `Id`。
77
+ *
78
+ * @throws {TypeError} 当 target 不是 `Id` 时抛出
79
+ */
80
+ export const assertId: AssertId = (target: unknown): void => {
81
+ if (isId(target) === false) {
82
+ throw new TypeError(`Expected Id, got: ${String(target)}`)
83
+ }
84
+ }
85
+
86
+ /**
87
+ * 按引用身份比较两个 `Id` 值是否为同一个实例。
88
+ */
89
+ export const isSameId = (a: Id, b: Id): boolean => {
90
+ return Object.is(a, b)
91
+ }
92
+
93
+ /**
94
+ * 按内部标识值比较两个 `Id` 是否相等。
95
+ */
96
+ export const isEqualId = (a: Id, b: Id): boolean => {
97
+ return a[INTERNAL_ID] === b[INTERNAL_ID]
98
+ }
99
+
100
+ /**
101
+ * 将 `Id` 转换为可读字符串。
102
+ *
103
+ * 返回值格式为 `Symbol-ID-<uuid>`。
104
+ *
105
+ * @example
106
+ * ```
107
+ * const userId = generateId("user:1")
108
+ * const example1 = idToString(userId)
109
+ * // Expect: starts with "Symbol-ID-"
110
+ *
111
+ * const anonymousId = generateId()
112
+ * const example2 = idToString(anonymousId)
113
+ * // Expect: matches the format "Symbol-ID-<uuid>"
114
+ * ```
115
+ */
116
+ export const idToString = (id: Id): string => {
117
+ assertId(id)
118
+ return `Symbol-ID-${id[INTERNAL_ID]}`
119
+ }
@@ -0,0 +1,2 @@
1
+ export * from "./id.ts"
2
+ export * from "./uuid.ts"
@@ -0,0 +1,187 @@
1
+
2
+ const internalUUID_REGEXP = /^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i
3
+
4
+ /**
5
+ * 判断输入值是否为合法的 UUID 字符串。
6
+ *
7
+ * @example
8
+ * ```
9
+ * // Expect: true
10
+ * const example1 = isUuid("550e8400-e29b-41d4-a716-446655440000")
11
+ * // Expect: false
12
+ * const example2 = isUuid("not-a-uuid")
13
+ * ```
14
+ */
15
+ export const isUuid = (input: string): boolean => {
16
+ return internalUUID_REGEXP.test(input)
17
+ }
18
+
19
+ /**
20
+ * 断言输入值是合法的 UUID 字符串。
21
+ *
22
+ * 当输入值不满足 UUID 格式时,该函数会抛出 TypeError,适合在标识边界层做快速失败。
23
+ *
24
+ * @example
25
+ * ```
26
+ * // Expect: no throw
27
+ * const example1 = assertUuid("550e8400-e29b-41d4-a716-446655440000")
28
+ * // Expect: throws TypeError
29
+ * const example2 = () => assertUuid("not-a-uuid")
30
+ * ```
31
+ *
32
+ * @throws {TypeError} when input is not a valid UUID
33
+ */
34
+ export const assertUuid = (input: string): void => {
35
+ if (isUuid(input) === false) {
36
+ throw new TypeError(`Expected a valid UUID string, got: ${input}`)
37
+ }
38
+ }
39
+
40
+ /**
41
+ * 读取合法 UUID 字符串中的版本号。
42
+ *
43
+ * 该函数会先校验输入格式;如果输入不是合法 UUID,则会抛出 TypeError。
44
+ *
45
+ * @example
46
+ * ```
47
+ * // Expect: 4
48
+ * const example1 = getUuidVersion("550e8400-e29b-41d4-a716-446655440000")
49
+ * // Expect: 1
50
+ * const example2 = getUuidVersion("123e4567-e89b-12d3-a456-426614174000")
51
+ * ```
52
+ *
53
+ * @throws {TypeError} when input is not a valid UUID
54
+ */
55
+ export const getUuidVersion = (input: string): number => {
56
+ assertUuid(input)
57
+ return Number.parseInt(input[14]!, 16)
58
+ }
59
+
60
+ /**
61
+ * 生成 UUID v4 字符串。
62
+ *
63
+ * 当运行时提供 Web Crypto 能力时,优先使用安全随机源;否则回退到兼容性方案。
64
+ *
65
+ * @example
66
+ * ```
67
+ * const uuid = generateUuidV4()
68
+ * // Expect: true
69
+ * const example1 = /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(uuid)
70
+ * ```
71
+ */
72
+ export const generateUuidV4 = (): string => {
73
+ if (globalThis.crypto !== undefined) {
74
+ const { crypto } = globalThis
75
+
76
+ if (typeof crypto.randomUUID === "function") {
77
+ return crypto.randomUUID()
78
+ }
79
+
80
+ if (typeof crypto.getRandomValues === "function" && typeof Uint8Array === "function") {
81
+ const buffer = new Uint8Array(16)
82
+ crypto.getRandomValues(buffer)
83
+
84
+ buffer[6] = (buffer[6]! & 0x0F) | 0x40
85
+ buffer[8] = (buffer[8]! & 0x3F) | 0x80
86
+
87
+ const hex = [...buffer].map(value => value.toString(16).padStart(2, "0")).join("")
88
+ return `${hex.slice(0, 8)}-${hex.slice(8, 12)}-${hex.slice(12, 16)}-${hex.slice(16, 20)}-${hex.slice(20)}`
89
+ }
90
+ }
91
+
92
+ const fallbackUUID = (): string => {
93
+ const random = (value: number): string => {
94
+ return ((value ^ ((Math.random() * 16) >> (value / 4))) & 15).toString(16)
95
+ }
96
+
97
+ return "10000000-1000-4000-8000-100000000000".replaceAll(/[018]/g, (char: string) => random(Number(char)))
98
+ }
99
+
100
+ return fallbackUUID()
101
+ }
102
+
103
+ /**
104
+ * 通过 URL.createObjectURL 侧向取得一个 UUID v4 风格的字符串。
105
+ *
106
+ * 该函数依赖 Blob 与 URL API,适合浏览器等具备对象 URL 能力的环境。
107
+ * 如果只需要常规 UUID v4,优先使用 generateUuidV4。
108
+ *
109
+ * @example
110
+ * ```
111
+ * const uuid = generateUuidV4FromUrl()
112
+ * // Expect: true
113
+ * const example1 = /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(uuid)
114
+ * // Expect: 36
115
+ * const example2 = uuid.length
116
+ * ```
117
+ */
118
+ export const generateUuidV4FromUrl = (): string => {
119
+ const tempURL = URL.createObjectURL(new Blob())
120
+ const uuidInUrl = tempURL
121
+ URL.revokeObjectURL(tempURL)
122
+ const uuid = uuidInUrl.slice(uuidInUrl.lastIndexOf("/") + 1)
123
+ return uuid
124
+ }
125
+
126
+ const internalUUIDv7RandomMask74 = (1n << 74n) - 1n
127
+ const internalUUIDv7RandomMask48 = (1n << 48n) - 1n
128
+ let internalUUIDv7LastTimestamp = -1n
129
+ let internalUUIDv7MonotonicValue = 0n
130
+
131
+ const internalUUIDv7FillRandom = (buffer: Uint8Array): void => {
132
+ if (globalThis.crypto !== undefined) {
133
+ const { crypto } = globalThis
134
+ if (typeof crypto.getRandomValues === "function") {
135
+ crypto.getRandomValues(buffer)
136
+ return
137
+ }
138
+ }
139
+
140
+ console.warn("generateUuidV7 requires crypto.getRandomValues")
141
+ for (let i = 0; i < 10; i = i + 1) {
142
+ buffer[i] = Math.floor(Math.random() * 256)
143
+ }
144
+ }
145
+
146
+ const internalUUIDv7NextRandom74 = (timestamp: bigint): bigint => {
147
+ if (timestamp !== internalUUIDv7LastTimestamp) {
148
+ const randomValues = new Uint8Array(10)
149
+ internalUUIDv7FillRandom(randomValues)
150
+
151
+ const randomHex = Array.from(randomValues, value => value.toString(16).padStart(2, "0")).join("")
152
+ internalUUIDv7MonotonicValue = BigInt(`0x${randomHex}`) & internalUUIDv7RandomMask74
153
+ internalUUIDv7LastTimestamp = timestamp
154
+ return internalUUIDv7MonotonicValue
155
+ }
156
+
157
+ internalUUIDv7MonotonicValue = (internalUUIDv7MonotonicValue + 1n) & internalUUIDv7RandomMask74
158
+ return internalUUIDv7MonotonicValue
159
+ }
160
+
161
+ /**
162
+ * 生成 UUID v7 字符串。
163
+ *
164
+ * 结果以前导时间戳编码排序信息,适合需要近似按生成时间排序的标识场景。
165
+ *
166
+ * @example
167
+ * ```
168
+ * const uuid = generateUuidV7()
169
+ * // Expect: true
170
+ * const example1 = /^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(uuid)
171
+ * ```
172
+ */
173
+ export const generateUuidV7 = (): string => {
174
+ const timestamp = BigInt(Date.now())
175
+ const random74 = internalUUIDv7NextRandom74(timestamp)
176
+ const timeHex = timestamp.toString(16).padStart(12, "0")
177
+
178
+ const randAValue = Number((random74 >> 62n) & 0xFFFn)
179
+ const randBValue = Number((random74 >> 48n) & 0x3FFFn)
180
+ const trailingValue = random74 & internalUUIDv7RandomMask48
181
+
182
+ const randA = ((0x7 << 12) | randAValue) & 0xFFFF
183
+ const randB = ((0x2 << 14) | randBValue) & 0xFFFF
184
+ const trailingHex = trailingValue.toString(16).padStart(12, "0")
185
+
186
+ return `${timeHex.slice(0, 8)}-${timeHex.slice(8, 12)}-${randA.toString(16).padStart(4, "0")}-${randB.toString(16).padStart(4, "0")}-${trailingHex}`
187
+ }
package/src/index.ts CHANGED
@@ -1,5 +1,37 @@
1
1
  export * as Basic from "./basic/index.ts"
2
- export * as Type from "./type/index.ts"
2
+ export type * as Type from "./type/index.ts"
3
+
4
+ export * as Environment from "./environment/index.ts"
5
+ export * as Exception from "./exception/index.ts"
6
+ export * as Event from "./event/index.ts"
7
+ export * as Singleton from "./singleton/index.ts"
8
+
9
+ export * as Abort from "./abort/index.ts"
10
+ export * as Log from "./log/index.ts"
3
11
  export * as Reactor from "./reactor/index.ts"
12
+ export * as Result from "./result/index.ts"
13
+ export * as Form from "./form/index.ts"
14
+ export * as Request from "./request/index.ts"
15
+ export * as Route from "./route/index.ts"
16
+ export * as Timer from "./timer/index.ts"
17
+ export * as Cron from "./cron/index.ts"
18
+ export * as Orchestration from "./orchestration/index.ts"
19
+ export * as Socket from "./socket/index.ts"
20
+ export * as Http from "./http/index.ts"
21
+
22
+ export * as Identifier from "./identifier/index.ts"
23
+ export * as Credential from "./credential/index.ts"
4
24
  export * as Encoding from "./encoding/index.ts"
5
25
  export * as Random from "./random/index.ts"
26
+ export * as Color from "./color/index.ts"
27
+ export * as Json from "./json/index.ts"
28
+ export * as Aio from "./aio/index.ts"
29
+
30
+ export * as Web from "./web/index.ts"
31
+ export * as CSS from "./css/index.ts"
32
+ export * as Drizzle from "./drizzle/index.ts"
33
+ export * as Email from "./email/index.ts"
34
+ export * as Huawei from "./huawei/index.ts"
35
+ export * as Openai from "./openai/index.ts"
36
+ export * as Weixin from "./weixin/index.ts"
37
+ export * as Ai from "./ai/index.ts"
@@ -0,0 +1,92 @@
1
+ # JSON
2
+
3
+ ## Description
4
+
5
+ JSON 模块提供围绕 JSON(JavaScript Object Notation)这一数据表示格式的相关基础能力,用于承载与 JSON 本身直接相关、且值得长期稳定维护的公共语义。
6
+
7
+ 当前模块公开能力还很少,暂时只有 `repair` 这一项文本修复入口;但这不意味着模块边界仅限于修复本身,而是说明 JSON 相关能力仍在逐步沉淀中。
8
+
9
+ ## For Understanding
10
+
11
+ 理解 JSON 模块时,应把它看作一个围绕 JSON 本身建立的问题域模块,而不是一个泛化的数据清洗工具箱,也不是任意对象处理逻辑的收纳处。判断某项能力是否应进入这里,关键不在于它“碰巧输入或输出了 JSON”,而在于它是否直接服务于 JSON 这一表示格式本身的稳定语义。
12
+
13
+ 这类能力通常可能包括 JSON 文本修复、序列化与反序列化辅助、稳定格式化、合法性判断、边界明确的表示转换,或其它直接围绕 JSON 文本与 JSON 语义展开的基础能力。当前仓库里之所以只有 `repair`,只是因为模块还处在较早阶段,而不是因为其它 JSON 相关能力天然不属于这里。
14
+
15
+ 当前边界可以概括为:
16
+
17
+ - 它可以承载与 JSON 本身直接相关的公共能力,而不局限于当前已经存在的 `repair`。
18
+ - 它关注的是 JSON 作为表示格式时的稳定语义,而不是解析后对象在业务上的含义。
19
+ - 它可以处理文本层问题,也可以在未来扩展到仍然属于 JSON 语义边界内的其它能力。
20
+ - 它不应因为名称宽泛就退化成杂项对象工具箱或通用数据清洗工具箱。
21
+
22
+ 因此,这个模块不应承载对象结构校验、字段语义补全、领域模型迁移、容错合并或业务级默认值推导。那些问题可能发生在 JSON 之前或之后,也可能依赖 JSON 作为载体,但并不因此自动属于 JSON 模块。
23
+
24
+ ## For Using
25
+
26
+ 当你需要复用一类与 JSON 本身直接相关的基础能力,而不是在业务代码里零散处理 JSON 文本、解析入口或表示细节时,可以使用这个模块。当前最直接的使用场景,是在解析之前先修复接近 JSON、但带有轻微格式噪声的文本,例如人工编辑配置、LLM 输出、宽松的第三方接口返回、日志片段复制结果,或历史遗留系统吐出的近似 JSON 文本。
27
+
28
+ 当前公共能力可以从使用意图上理解为一类入口:
29
+
30
+ - 文本修复入口:把接近 JSON 的字符串整理成可继续交给标准解析器处理的 JSON 文本。
31
+
32
+ 随着模块扩展,未来也可以继续容纳其它直接服务于 JSON 语义的公共入口。但即便如此,使用时仍应区分“JSON 本身的问题”和“业务对象的问题”:如果你的问题已经变成对象级校验、字段默认值注入、结构迁移或业务容错,那么应在其它模块或上层流程中继续分层,而不要把这些职责压回 JSON 模块。
33
+
34
+ ## For Contributing
35
+
36
+ 贡献 JSON 模块时,应优先判断新增能力是否直接表达 JSON 本身的稳定语义,而不是借着 JSON 的名字引入对象级处理、业务级清洗或协议级解释逻辑。这个模块可以继续增长,但增长方向应围绕 JSON 自身的问题域展开,而不是因为名字宽泛就无限吸纳一切与对象或文本有关的工具。
37
+
38
+ 在扩展时,应优先遵守以下边界:
39
+
40
+ - 公共能力应直接围绕 JSON 本身展开,例如表示修复、合法性处理、稳定序列化或其它明确属于 JSON 语义的能力。
41
+ - 不要把 schema 校验、字段补全、结构迁移、业务默认值或容错合并直接写成 JSON 模块的公共职责。
42
+ - 若新增能力只是“使用了 JSON”但核心问题并不属于 JSON 本身,则应放在更合适的模块,而不是为了归类方便塞进这里。
43
+ - 对于像 `repair` 这类带有容错性质的能力,应保持失败语义清楚;当输入不能被稳定处理时,抛错通常比返回含糊结果更符合模块边界。
44
+
45
+ ### JSDoc 注释格式要求
46
+
47
+ - 每个公开导出的目标(类型、函数、变量、类等)都应包含 JSDoc 注释,让人在不跳转实现的情况下就能理解用途。
48
+ - JSDoc 注释第一行应为清晰且简洁的描述,该描述优先使用中文(英文也可以)。
49
+ - 如果描述后还有其他内容,应在描述后加一个空行。
50
+ - 如果有示例,应使用 `@example` 标签,后接三重反引号代码块(不带语言标识)。
51
+ - 如果有示例,应包含多个场景,展示不同用法,尤其要覆盖常见组合方式或边界输入。
52
+ - 如果有示例,应使用注释格式说明每个场景:`// Expect: <result>`。
53
+ - 如果有示例,应将结果赋值给 `example1`、`example2` 之类的变量,以保持示例易读。
54
+ - 如果有示例,`// Expect: <result>` 应该位于 `example1`、`example2` 之前,以保持示例的逻辑清晰。
55
+ - 如果有示例,应优先使用确定性示例;避免断言精确的随机输出。
56
+ - 如果函数返回结构化字符串,应展示其预期格式特征。
57
+ - 如果有参考资料,应将 `@see` 放在 `@example` 代码块之后,并用一个空行分隔。
58
+
59
+ ### 实现规范要求
60
+
61
+ - 不同程序元素之间使用一个空行分隔,保持结构清楚。这里的程序元素,通常指函数、类型、常量,以及直接服务于它们的辅助元素。
62
+ - 某程序元素独占的辅助元素与该程序元素本身视为一个整体,不要在它们之间添加空行。
63
+ - 程序元素的辅助元素应该放置在该程序元素的上方,以保持阅读时的逻辑顺序。
64
+ - 若辅助元素被多个程序元素共享,则应将其视为独立的程序元素,放在这些程序元素中第一个相关目标的上方,并与后续程序元素之间保留一个空行。
65
+ - 辅助元素也应该像其它程序元素一样,保持清晰的命名和适当的注释,以便在需要阅读实现细节时能够快速理解它们的作用和使用方式。
66
+ - 辅助元素的命名必须以前缀 `internal` 开头(或 `Internal`,大小写不敏感)。
67
+ - 辅助元素永远不要公开导出。
68
+ - 被模块内多个不同文件中的程序元素共享的辅助元素,应该放在一个单独的文件中,例如 `./src/json/internal.ts`;若当前模块仍然很小,则不必为了形式拆出没有稳定价值的共享文件。
69
+ - 模块内可以包含子模块。只有当某个子目录表达一个稳定、可单独理解、且可能被父模块重导出的子问题域时,才应将其视为子模块。
70
+ - 子模块包含多个文件时,应该为其单独创建子文件夹,并为其创建单独的 Barrel 文件;父模块的 Barrel 文件再重导出子模块的 Barrel 文件。
71
+ - 子模块不需要有自己的 `README.md`。
72
+ - 子模块可以有自己的 `internal.ts` 文件,多个子模块共享的辅助元素应该放在父模块的 `internal.ts` 文件中,单个子模块共享的辅助元素应该放在该子模块的 `internal.ts` 文件中。
73
+ - 对模块依赖关系的要求(通常是不循环依赖或不反向依赖)与对 DRY 的要求可能产生冲突。此时,若复用的代码数量不大,可以适当牺牲 DRY,复制粘贴并保留必要的注释说明;若复用的代码数量较大,则可以将其抽象到新的文件或子模块中,如 `common.ts`,并在需要的地方导入使用。
74
+ - 实现时应优先保持输入、输出与失败条件的语义清楚;若某项能力具有容错或修复性质,不应为了支持更多特例不断堆叠难以解释的隐式规则。
75
+
76
+ ### 导出策略要求
77
+
78
+ - 保持内部辅助项和内部符号为私有,不要让外部接入依赖临时性的内部结构。
79
+ - 每个模块都应有一个用于重导出所有公共 API 的 Barrel 文件。
80
+ - Barrel 文件应命名为 `index.ts`,放在模块目录根部,并且所有公共 API 都应从该文件导出。
81
+ - 新增公共能力时,应优先检查它是否表达稳定、清楚且值得长期维护的 JSON 模块语义,而不是某段实现细节的便捷暴露;仅在确认需要长期对外承诺时再加入 Barrel 导出。
82
+
83
+ ### 测试要求
84
+
85
+ - 若程序元素是函数,则只为该函数编写一个测试,如果该函数需要测试多个用例,应放在同一个测试中。
86
+ - 若程序元素是类,则至少要为该类的每一个方法编写一个测试,如果该方法需要测试多个用例,应放在同一个测试中。
87
+ - 若程序元素是类,除了为该类的每一个方法编写至少一个测试之外,还可以为该类编写任意多个测试,以覆盖该类的不同使用场景或边界情况。
88
+ - 若编写测试时需要用到辅助元素(Mock 或 Spy 等),可以在测试文件中直接定义这些辅助元素。若辅助元素较为简单,则可以直接放在每一个测试内部,优先保证每个测试的独立性,而不是追求极致 DRY;若辅助元素较为复杂或需要在多个测试中复用,则可以放在测试文件顶部,供该测试文件中的所有测试使用。
89
+ - 测试顺序应与源文件中被测试目标的原始顺序保持一致。
90
+ - 若该模块不需要测试,必须在说明文件中明确说明该模块不需要测试,并说明理由。一般来说,只有在该模块没有可执行的公共函数、只承载类型层表达,或其语义已被上层模块的测试完整覆盖且重复测试几乎不再带来额外价值时,才适合这样处理。
91
+ - 模块的单元测试文件目录是 `./tests/unit/json`,若模块包含子模块,则子模块的单元测试文件目录为 `./tests/unit/json/<sub-module-name>`。
92
+ - 测试应覆盖各公共能力各自的稳定语义。对于当前已有的 `repair`,重点覆盖可稳定修复的常见格式问题,以及超出修复边界时是否以明确失败结束,而不是返回含糊结果。
@@ -0,0 +1 @@
1
+ export * from "./repair.ts"
@@ -0,0 +1,18 @@
1
+ import { jsonrepair } from "jsonrepair"
2
+
3
+ /**
4
+ * 修复常见格式问题后的 JSON 文本字符串。
5
+ *
6
+ * 该函数面向“文本表示修复”这一问题:当输入接近 JSON、但包含单引号、未加引号的键名、尾随逗号等常见格式问题时,可以先把它整理成合法 JSON 文本,再交给后续解析流程。
7
+ *
8
+ * @example
9
+ * ```
10
+ * // Expect: "{\"foo\":1}"
11
+ * const example1 = repairJson("{foo:1,}")
12
+ * // Expect: "{\"name\":\"mobius\"}"
13
+ * const example2 = repairJson("{'name':'mobius',}")
14
+ * ```
15
+ */
16
+ export const repairJson = (text: string): string => {
17
+ return jsonrepair(text)
18
+ }
@@ -0,0 +1,79 @@
1
+ # Log
2
+
3
+ ## Description
4
+
5
+ Log 模块用于提供结构化日志(structured logging)能力,主要承载日志记录、日志上下文组织、日志发送以及日志调度等稳定语义。
6
+
7
+ 它面向的是“如何把日志当作一类可长期维护的数据模型”这一问题,而不是若干零散的输出函数。模块内的公共能力应帮助调用方稳定地表达日志类型、日志记录、日志发送端和日志调度过程,而不是把日志格式拼接、上下文透传和输出策略分散到业务代码里临时处理。
8
+
9
+ ## For Understanding
10
+
11
+ 理解 Log 模块时,首先应把它看作日志生命周期的建模层,而不是异常捕获入口的集合。它解决的是“如何描述一条日志、如何附加上下文、如何把日志发往不同输出端、如何协调这些输出过程”这一类问题,因此适合放在应用、服务、组件或基础设施边界之间,作为统一的日志语义层。
12
+
13
+ 这个模块的边界重点在于“组织和消费日志”,而不是“发现错误来源”。像浏览器全局异常监听、Node.js 进程级未处理异常监听、框架级错误边界之类的能力,虽然最终经常会把结果送入 logger,但它们表达的是上游事件来源,不应直接并入 Log 模块本身。否则模块会同时承担异常捕获、日志建模和日志分发三类职责,边界会迅速变得模糊。
14
+
15
+ 因此,适合进入本模块的能力,应当围绕以下几类稳定语义展开:日志级别与日志记录本身的表达、logger 的上下文继承与派生、日志发送端的抽象、以及对发送过程的统一调度。若新增能力主要是在监听某个宿主环境的异常入口,通常应优先放到更靠近环境或异常语义的模块中,再由上层决定是否接入 Log 模块。
16
+
17
+ ## For Using
18
+
19
+ 当你希望在系统内维持一致的日志结构,而不是在每次输出时手工拼接字符串、标签和上下文时,可以使用这个模块。它适合那些需要长期保留日志语义、希望在多个输出端之间复用同一份日志记录结构的场景。
20
+
21
+ 从使用角度看,这个模块大致可以理解为几类能力的组合。第一类是日志记录本身,用来表达日志类型、消息和附加数据,让日志作为结构化对象被传递与消费。第二类是 logger 入口,用来在局部范围中派生带上下文的日志能力,使业务层不必重复附加相同的标签、作用域或元信息。第三类是发送与调度能力,用来把日志记录发往控制台或其它输出端,并把输出时机与策略统一收敛到日志系统内部。
22
+
23
+ 更合适的接入方式,是在业务边界尽早把日志上下文组织清楚,再将记录交给 logger、emitter 或 scheduler 处理,而不是在底层输出瞬间才临时补齐信息。这样做能够让日志在演进过程中保持稳定结构,也便于后续替换输出端、追加上下文或统一调整日志策略。
24
+
25
+ ## For Contributing
26
+
27
+ 贡献 Log 模块时,首要任务不是补一个“能打印出来”的便捷函数,而是确认新增能力是否确实表达了稳定的日志语义。这个模块应长期围绕日志记录、上下文组织、输出抽象和调度协作展开;任何新增公共能力,都应说明它解决的是哪一段日志生命周期问题,以及它为什么值得成为长期承诺的一部分。
28
+
29
+ 在扩展时,应持续守住以下边界:不要把宿主环境特有的异常捕获入口直接塞进来;不要把只对某个特定日志平台或某个业务日志格式成立的细节公开承诺出去;不要让 logger 退化为简单字符串打印器。对外语义应优先是“日志模型”和“日志协作方式”,而不是某一次实现中的输出技巧。
30
+
31
+ ### JSDoc 注释格式要求
32
+
33
+ - 每个公开导出的目标(类型、函数、变量、类等)都应包含 JSDoc 注释,让人在不跳转实现的情况下就能理解用途。
34
+ - JSDoc 注释第一行应为清晰且简洁的描述,该描述优先使用中文(英文也可以)。
35
+ - 如果描述后还有其他内容,应在描述后加一个空行。
36
+ - 如果有示例,应使用 `@example` 标签,后接三重反引号代码块(不带语言标识)。
37
+ - 如果有示例,应包含多个场景,展示不同用法,尤其要覆盖常见组合方式或边界输入。
38
+ - 如果有示例,应使用注释格式说明每个场景:`// Expect: <result>`。
39
+ - 如果有示例,应将结果赋值给 `example1`、`example2` 之类的变量,以保持示例易读。
40
+ - 如果有示例,`// Expect: <result>` 应该位于 `example1`、`example2` 之前,以保持示例的逻辑清晰。
41
+ - 如果有示例,应优先使用确定性示例;避免断言精确的随机输出。
42
+ - 如果函数返回结构化字符串,应展示其预期格式特征。
43
+ - 如果有参考资料,应将 `@see` 放在 `@example` 代码块之后,并用一个空行分隔。
44
+
45
+ ### 实现规范要求
46
+
47
+ - 不同程序元素之间使用一个空行分隔,保持结构清楚。这里的程序元素,通常指函数、类型、常量,以及直接服务于它们的辅助元素。
48
+ - 某程序元素独占的辅助元素与该程序元素本身视为一个整体,不要在它们之间添加空行。
49
+ - 程序元素的辅助元素应该放置在该程序元素的上方,以保持阅读时的逻辑顺序。
50
+ - 若辅助元素被多个程序元素共享,则应将其视为独立的程序元素,放在这些程序元素中第一个相关目标的上方,并与后续程序元素之间保留一个空行。
51
+ - 辅助元素也应该像其它程序元素一样,保持清晰的命名和适当的注释,以便在需要阅读实现细节时能够快速理解它们的作用和使用方式。
52
+ - 辅助元素的命名必须以前缀 `internal` 开头(或 `Internal`,大小写不敏感)。
53
+ - 辅助元素永远不要公开导出。
54
+ - 被模块内多个不同文件中的程序元素共享的辅助元素,应该放在一个单独的文件中,例如 `./src/log/internal.ts`。
55
+ - 模块内可以包含子模块。只有当某个子目录表达一个稳定、可单独理解、且可能被父模块重导出的子问题域时,才应将其视为子模块。
56
+ - 子模块包含多个文件时,应该为其单独创建子文件夹,并为其创建单独的 Barrel 文件;父模块的 Barrel 文件再重导出子模块的 Barrel 文件。
57
+ - 子模块不需要有自己的 `README.md`。
58
+ - 子模块可以有自己的 `internal.ts` 文件,多个子模块共享的辅助元素应该放在父模块的 `internal.ts` 文件中,单个子模块共享的辅助元素应该放在该子模块的 `internal.ts` 文件中。
59
+ - 对模块依赖关系的要求(通常是不循环依赖或不反向依赖)与对 DRY 的要求可能产生冲突。此时,若复用的代码数量不大,可以适当牺牲 DRY,复制粘贴并保留必要的注释说明;若复用的代码数量较大,则可以将其抽象到新的文件或子模块中,如 `common.ts`,并在需要的地方导入使用。
60
+
61
+ - 与日志相关的实现应优先围绕记录模型、上下文继承、发送端抽象与调度协作展开,避免把宿主异常来源或业务平台专用格式混入模块边界。
62
+
63
+ ### 导出策略要求
64
+
65
+ - 保持内部辅助项和内部符号为私有,不要让外部接入依赖临时性的内部结构。
66
+ - 每个模块都应有一个用于重导出所有公共 API 的 Barrel 文件。
67
+ - Barrel 文件应命名为 `index.ts`,放在模块目录根部,并且所有公共 API 都应从该文件导出。
68
+ - 新增公共能力时,应优先检查它是否表达稳定、清楚且值得长期维护的日志语义,而不是某段实现细节的便捷暴露;仅在确认需要长期对外承诺时再加入 Barrel 导出。
69
+
70
+ ### 测试要求
71
+
72
+ - 若程序元素是函数,则只为该函数编写一个测试,如果该函数需要测试多个用例,应放在同一个测试中。
73
+ - 若程序元素是类,则至少要为该类的每一个方法编写一个测试,如果该方法需要测试多个用例,应放在同一个测试中。
74
+ - 若程序元素是类,除了为该类的每一个方法编写至少一个测试之外,还可以为该类编写任意多个测试,以覆盖该类的不同使用场景或边界情况。
75
+ - 若编写测试时需要用到辅助元素(Mock 或 Spy 等),可以在测试文件中直接定义这些辅助元素。若辅助元素较为简单,则可以直接放在每一个测试内部,优先保证每个测试的独立性,而不是追求极致 DRY;若辅助元素较为复杂或需要在多个测试中复用,则可以放在测试文件顶部,供该测试文件中的所有测试使用。
76
+ - 测试顺序应与源文件中被测试目标的原始顺序保持一致。
77
+ - 若该模块不需要测试,必须在说明文件中明确说明该模块不需要测试,并说明理由。一般来说,只有在该模块没有可执行的公共函数、只承载类型层表达,或其语义已被上层模块的测试完整覆盖且重复测试几乎不再带来额外价值时,才适合这样处理。
78
+ - 模块的单元测试文件目录是 `./tests/unit/log`,若模块包含子模块,则子模块的单元测试文件目录为 `./tests/unit/log/<sub-module-name>`。
79
+ - 对 logger、emitter、scheduler 这一类能力,应优先覆盖上下文继承、发送顺序、失败传播、默认行为与资源清理等关键场景。
@@ -0,0 +1,5 @@
1
+ export * from "./log-type.ts"
2
+ export type * from "./log-record.ts"
3
+ export * from "./log-emitter.ts"
4
+ export * from "./log-scheduler.ts"
5
+ export * from "./logger.ts"