@planet-matrix/mobius-model 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.
Files changed (175) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/README.md +123 -36
  3. package/dist/index.js +45 -4
  4. package/dist/index.js.map +183 -11
  5. package/oxlint.config.ts +6 -0
  6. package/package.json +16 -10
  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/basic/README.md +69 -118
  12. package/src/basic/function.ts +81 -62
  13. package/src/basic/is.ts +152 -71
  14. package/src/basic/promise.ts +29 -8
  15. package/src/basic/string.ts +2 -33
  16. package/src/color/README.md +105 -0
  17. package/src/color/index.ts +3 -0
  18. package/src/color/internal.ts +42 -0
  19. package/src/color/rgb/analyze.ts +236 -0
  20. package/src/color/rgb/construct.ts +130 -0
  21. package/src/color/rgb/convert.ts +227 -0
  22. package/src/color/rgb/derive.ts +303 -0
  23. package/src/color/rgb/index.ts +6 -0
  24. package/src/color/rgb/internal.ts +208 -0
  25. package/src/color/rgb/parse.ts +302 -0
  26. package/src/color/rgb/serialize.ts +144 -0
  27. package/src/color/types.ts +57 -0
  28. package/src/color/xyz/analyze.ts +80 -0
  29. package/src/color/xyz/construct.ts +19 -0
  30. package/src/color/xyz/convert.ts +71 -0
  31. package/src/color/xyz/index.ts +3 -0
  32. package/src/color/xyz/internal.ts +23 -0
  33. package/src/css/README.md +93 -0
  34. package/src/css/class.ts +559 -0
  35. package/src/css/index.ts +1 -0
  36. package/src/encoding/README.md +66 -79
  37. package/src/encoding/base64.ts +13 -4
  38. package/src/environment/README.md +97 -0
  39. package/src/environment/basic.ts +26 -0
  40. package/src/environment/device.ts +311 -0
  41. package/src/environment/feature.ts +285 -0
  42. package/src/environment/geo.ts +337 -0
  43. package/src/environment/index.ts +7 -0
  44. package/src/environment/runtime.ts +400 -0
  45. package/src/environment/snapshot.ts +60 -0
  46. package/src/environment/variable.ts +239 -0
  47. package/src/event/README.md +90 -0
  48. package/src/event/class-event-proxy.ts +228 -0
  49. package/src/event/common.ts +19 -0
  50. package/src/event/event-manager.ts +203 -0
  51. package/src/event/index.ts +4 -0
  52. package/src/event/instance-event-proxy.ts +186 -0
  53. package/src/event/internal.ts +24 -0
  54. package/src/exception/README.md +96 -0
  55. package/src/exception/browser.ts +219 -0
  56. package/src/exception/index.ts +4 -0
  57. package/src/exception/nodejs.ts +169 -0
  58. package/src/exception/normalize.ts +106 -0
  59. package/src/exception/types.ts +99 -0
  60. package/src/identifier/README.md +92 -0
  61. package/src/identifier/id.ts +119 -0
  62. package/src/identifier/index.ts +2 -0
  63. package/src/identifier/uuid.ts +187 -0
  64. package/src/index.ts +16 -1
  65. package/src/log/README.md +79 -0
  66. package/src/log/index.ts +5 -0
  67. package/src/log/log-emitter.ts +72 -0
  68. package/src/log/log-record.ts +10 -0
  69. package/src/log/log-scheduler.ts +74 -0
  70. package/src/log/log-type.ts +8 -0
  71. package/src/log/logger.ts +543 -0
  72. package/src/orchestration/README.md +89 -0
  73. package/src/orchestration/coordination/barrier.ts +214 -0
  74. package/src/orchestration/coordination/count-down-latch.ts +215 -0
  75. package/src/orchestration/coordination/errors.ts +98 -0
  76. package/src/orchestration/coordination/index.ts +16 -0
  77. package/src/orchestration/coordination/internal/wait-constraints.ts +95 -0
  78. package/src/orchestration/coordination/internal/wait-queue.ts +109 -0
  79. package/src/orchestration/coordination/keyed-lock.ts +168 -0
  80. package/src/orchestration/coordination/mutex.ts +257 -0
  81. package/src/orchestration/coordination/permit.ts +127 -0
  82. package/src/orchestration/coordination/read-write-lock.ts +444 -0
  83. package/src/orchestration/coordination/semaphore.ts +280 -0
  84. package/src/orchestration/index.ts +1 -0
  85. package/src/random/README.md +55 -86
  86. package/src/random/index.ts +1 -1
  87. package/src/random/string.ts +35 -0
  88. package/src/reactor/README.md +4 -0
  89. package/src/reactor/reactor-core/primitive.ts +9 -9
  90. package/src/reactor/reactor-core/reactive-system.ts +5 -5
  91. package/src/singleton/README.md +79 -0
  92. package/src/singleton/factory.ts +55 -0
  93. package/src/singleton/index.ts +2 -0
  94. package/src/singleton/manager.ts +204 -0
  95. package/src/storage/README.md +107 -0
  96. package/src/storage/index.ts +1 -0
  97. package/src/storage/table.ts +449 -0
  98. package/src/timer/README.md +86 -0
  99. package/src/timer/expiration/expiration-manager.ts +594 -0
  100. package/src/timer/expiration/index.ts +3 -0
  101. package/src/timer/expiration/min-heap.ts +208 -0
  102. package/src/timer/expiration/remaining-manager.ts +241 -0
  103. package/src/timer/index.ts +1 -0
  104. package/src/type/README.md +54 -307
  105. package/src/type/class.ts +2 -2
  106. package/src/type/index.ts +14 -14
  107. package/src/type/is.ts +265 -2
  108. package/src/type/object.ts +37 -0
  109. package/src/type/string.ts +7 -2
  110. package/src/type/tuple.ts +6 -6
  111. package/src/type/union.ts +16 -0
  112. package/src/web/README.md +77 -0
  113. package/src/web/capture.ts +35 -0
  114. package/src/web/clipboard.ts +97 -0
  115. package/src/web/dom.ts +117 -0
  116. package/src/web/download.ts +16 -0
  117. package/src/web/event.ts +46 -0
  118. package/src/web/index.ts +10 -0
  119. package/src/web/local-storage.ts +113 -0
  120. package/src/web/location.ts +28 -0
  121. package/src/web/permission.ts +172 -0
  122. package/src/web/script-loader.ts +432 -0
  123. package/tests/unit/abort/abort-manager.spec.ts +225 -0
  124. package/tests/unit/abort/abort-signal-listener-manager.spec.ts +62 -0
  125. package/tests/unit/basic/array.spec.ts +1 -1
  126. package/tests/unit/basic/stream.spec.ts +1 -1
  127. package/tests/unit/basic/string.spec.ts +0 -9
  128. package/tests/unit/color/rgb/analyze.spec.ts +110 -0
  129. package/tests/unit/color/rgb/construct.spec.ts +56 -0
  130. package/tests/unit/color/rgb/convert.spec.ts +60 -0
  131. package/tests/unit/color/rgb/derive.spec.ts +103 -0
  132. package/tests/unit/color/rgb/parse.spec.ts +66 -0
  133. package/tests/unit/color/rgb/serialize.spec.ts +46 -0
  134. package/tests/unit/color/xyz/analyze.spec.ts +33 -0
  135. package/tests/unit/color/xyz/construct.spec.ts +10 -0
  136. package/tests/unit/color/xyz/convert.spec.ts +18 -0
  137. package/tests/unit/css/class.spec.ts +157 -0
  138. package/tests/unit/environment/basic.spec.ts +20 -0
  139. package/tests/unit/environment/device.spec.ts +146 -0
  140. package/tests/unit/environment/feature.spec.ts +388 -0
  141. package/tests/unit/environment/geo.spec.ts +111 -0
  142. package/tests/unit/environment/runtime.spec.ts +364 -0
  143. package/tests/unit/environment/snapshot.spec.ts +4 -0
  144. package/tests/unit/environment/variable.spec.ts +190 -0
  145. package/tests/unit/event/class-event-proxy.spec.ts +225 -0
  146. package/tests/unit/event/event-manager.spec.ts +246 -0
  147. package/tests/unit/event/instance-event-proxy.spec.ts +187 -0
  148. package/tests/unit/exception/browser.spec.ts +213 -0
  149. package/tests/unit/exception/nodejs.spec.ts +144 -0
  150. package/tests/unit/exception/normalize.spec.ts +57 -0
  151. package/tests/unit/identifier/id.spec.ts +71 -0
  152. package/tests/unit/identifier/uuid.spec.ts +85 -0
  153. package/tests/unit/log/log-emitter.spec.ts +33 -0
  154. package/tests/unit/log/log-scheduler.spec.ts +40 -0
  155. package/tests/unit/log/log-type.spec.ts +7 -0
  156. package/tests/unit/log/logger.spec.ts +222 -0
  157. package/tests/unit/orchestration/coordination/barrier.spec.ts +96 -0
  158. package/tests/unit/orchestration/coordination/count-down-latch.spec.ts +63 -0
  159. package/tests/unit/orchestration/coordination/errors.spec.ts +29 -0
  160. package/tests/unit/orchestration/coordination/keyed-lock.spec.ts +109 -0
  161. package/tests/unit/orchestration/coordination/mutex.spec.ts +132 -0
  162. package/tests/unit/orchestration/coordination/permit.spec.ts +43 -0
  163. package/tests/unit/orchestration/coordination/read-write-lock.spec.ts +154 -0
  164. package/tests/unit/orchestration/coordination/semaphore.spec.ts +135 -0
  165. package/tests/unit/random/string.spec.ts +11 -0
  166. package/tests/unit/reactor/alien-signals-effect.spec.ts +11 -10
  167. package/tests/unit/reactor/preact-signal.spec.ts +1 -2
  168. package/tests/unit/singleton/singleton.spec.ts +49 -0
  169. package/tests/unit/storage/table.spec.ts +620 -0
  170. package/tests/unit/timer/expiration/expiration-manager.spec.ts +464 -0
  171. package/tests/unit/timer/expiration/min-heap.spec.ts +71 -0
  172. package/tests/unit/timer/expiration/remaining-manager.spec.ts +234 -0
  173. package/.oxlintrc.json +0 -5
  174. package/src/random/uuid.ts +0 -103
  175. package/tests/unit/random/uuid.spec.ts +0 -37
@@ -0,0 +1 @@
1
+ export * from "./coordination/index.ts"
@@ -1,109 +1,78 @@
1
1
  # Random
2
2
 
3
- Runtime utilities for generating random-oriented values with cross-runtime compatibility. This module currently focuses on UUID generation.
3
+ ## Description
4
4
 
5
- ## For Users
5
+ Random 模块用于提供随机值(random value)相关的基础能力,当前主要承载随机字符串生成语义。
6
6
 
7
- This module provides lightweight helpers for random value generation scenarios.
7
+ 它关注的是“如何生成一类通用、可复用、语义清楚的随机文本”,而不是各种标识格式校验、业务编码规则或安全承诺各异的随机机制集合。
8
8
 
9
- ### 1. Domain Areas
9
+ ## For Understanding
10
10
 
11
- 1. UUID: Generate RFC 4122 version-4 UUID strings with runtime-aware fallback behavior.
11
+ 理解 Random 模块时,应先把它放在应用边界附近。随机值通常意味着不可复现、带有环境依赖,或者会影响测试与调试行为,因此更合理的做法是把它看作边界输入的生成层,而不是让随机行为无约束地扩散到核心业务逻辑内部。
12
12
 
13
- Current public exports:
13
+ 当前这个模块的核心边界比较克制:它主要处理“随机字符串如何生成”这一类问题。也就是说,它更关心字符集、长度、结果格式和重复概率,而不再负责 UUID 这类已经具有明确标识语义的格式模型。
14
14
 
15
- - `isUuid(input: string): boolean`
16
- - `assertUuid(input: string): void`
17
- - `getUuidVersion(input: string): number`
18
- - `generateUuid(): string`
15
+ 不适合放入本模块的能力,通常包括两类:一类是与密码学安全直接绑定、需要单独安全承诺的能力;另一类是已经形成稳定标识语义的格式模型,例如 UUID。前者应以更明确的安全语义单独建模,后者则应放入更贴近标识问题域的模块。
19
16
 
20
- ## For Contributors
17
+ ## For Using
21
18
 
22
- This guide documents conventions and best practices for implementing random utilities in this module.
19
+ 当你需要在应用或库的边界层生成临时标识、关联值、会话键或其它非业务主键用途的随机文本时,可以使用这个模块。它更适合被理解为“随机字符串生成接口”,而不是一个什么都往里塞的杂项工具箱。
23
20
 
24
- ### 1. Documentation and Comments
21
+ 从使用角度看,当前公共能力主要围绕随机字符串生成展开。更合适的接入方式,是在边界层尽早生成这些随机文本,再把得到的结果作为普通输入传给后续模块,从而避免内部逻辑直接依赖随机过程本身。
25
22
 
26
- #### 1.1 JSDoc Comment Format
23
+ 需要特别注意的是,本模块中的“随机”默认应被理解为通用应用层随机,而不是自动带有密码学强度承诺的安全随机。只要调用场景对安全性、可预测性、重复碰撞风险或跨环境一致性有更严格要求,就应先在设计上明确这些前提,而不要仅凭模块名称推断安全等级。
27
24
 
28
- Every exported function should include JSDoc in this form:
25
+ ## For Contributing
29
26
 
30
- ```typescript
31
- /**
32
- * Brief one-line description of what the function does.
33
- *
34
- * @example
35
- * ```
36
- * const example1 = generateUuid()
37
- * // Expect: true
38
- * const example2 = /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(example1)
39
- * ```
40
- */
41
- export const generateUuid = (): string => {
42
- ...
43
- }
44
- ```
27
+ 贡献 Random 模块时,应先确认新增能力表达的是稳定、清楚且可长期承诺的随机语义,而不是某种实现手段的直接暴露。对外公开的重点应该是“调用方需要什么随机字符串能力”,而不是“内部恰好如何生成这些值”。只要一个能力过度依赖当前实现细节,或者只在某个很窄的业务上下文中成立,就不适合进入这个模块。
45
28
 
46
- **Documentation Rules:**
47
- - First line: Clear, concise description starting with a verb (Generate, Check, Convert, etc.)
48
- - Add a blank line after the description
49
- - Use `@example` tag followed by triple backticks
50
- - Include multiple cases showing different scenarios
51
- - Use comment format: `// Expect: <result>`
52
- - Assign example results to variables like `example1`, `example2` to keep examples readable
53
- - Place `@see`(if has) after the `@example` block, separated by a blank line
54
- - Prefer deterministic examples; avoid asserting exact random outputs
55
- - If a function returns a structured string, show expected format characteristics
29
+ 在扩展时,应特别警惕两个方向的边界漂移。其一,不要把安全领域的问题用模糊措辞塞进来,例如把需要明确密码学承诺的能力混入通用随机工具中。其二,不要把已经形成稳定标识语义的格式模型重新拉回 Random。Random 模块应尽量保持为面向广泛调用方的随机文本生成边界,而不是业务专用规则仓库。
56
30
 
57
- ### 2. Runtime Implementation Patterns
31
+ ### JSDoc 注释格式要求
58
32
 
59
- #### 2.1 Compatibility First
33
+ - 每个公开导出的目标(类型、函数、变量、类等)都应包含 JSDoc 注释,让人在不跳转实现的情况下就能理解用途。
34
+ - JSDoc 注释第一行应为清晰且简洁的描述,该描述优先使用中文(英文也可以)。
35
+ - 如果描述后还有其他内容,应在描述后加一个空行。
36
+ - 如果有示例,应使用 `@example` 标签,后接三重反引号代码块(不带语言标识)。
37
+ - 如果有示例,应包含多个场景,展示不同用法,尤其要覆盖常见组合方式或边界输入。
38
+ - 如果有示例,应使用注释格式说明每个场景:`// Expect: <result>`。
39
+ - 如果有示例,应将结果赋值给 `example1`、`example2` 之类的变量,以保持示例易读。
40
+ - 如果有示例,`// Expect: <result>` 应该位于 `example1`、`example2` 之前,以保持示例的逻辑清晰。
41
+ - 如果有示例,应优先使用确定性示例;避免断言精确的随机输出。
42
+ - 如果函数返回结构化字符串,应展示其预期格式特征。
43
+ - 如果有参考资料,应将 `@see` 放在 `@example` 代码块之后,并用一个空行分隔。
60
44
 
61
- - Prefer standard runtime APIs when available (for example, `crypto.randomUUID`).
62
- - Keep fallback logic for environments where modern APIs are unavailable.
45
+ ### 实现规范要求
63
46
 
64
- #### 2.2 Deterministic Interface
47
+ - 不同程序元素之间使用一个空行分隔,保持结构清楚。这里的程序元素,通常指函数、类型、常量,以及直接服务于它们的辅助元素。
48
+ - 某程序元素独占的辅助元素与该程序元素本身视为一个整体,不要在它们之间添加空行。
49
+ - 程序元素的辅助元素应该放置在该程序元素的上方,以保持阅读时的逻辑顺序。
50
+ - 若辅助元素被多个程序元素共享,则应将其视为独立的程序元素,放在这些程序元素中第一个相关目标的上方,并与后续程序元素之间保留一个空行。
51
+ - 辅助元素也应该像其它程序元素一样,保持清晰的命名和适当的注释,以便在需要阅读实现细节时能够快速理解它们的作用和使用方式。
52
+ - 辅助元素的命名必须以前缀 `internal` 开头(或 `Internal`,大小写不敏感)。
53
+ - 辅助元素永远不要公开导出。
54
+ - 被模块内多个不同文件中的程序元素共享的辅助元素,应该放在一个单独的文件中,例如 `./src/random/internal.ts`。
55
+ - 模块内可以包含子模块。只有当某个子目录表达一个稳定、可单独理解、且可能被父模块重导出的子问题域时,才应将其视为子模块。
56
+ - 子模块包含多个文件时,应该为其单独创建子文件夹,并为其创建单独的 Barrel 文件;父模块的 Barrel 文件再重导出子模块的 Barrel 文件。
57
+ - 子模块不需要有自己的 `README.md`。
58
+ - 子模块可以有自己的 `internal.ts` 文件,多个子模块共享的辅助元素应该放在父模块的 `internal.ts` 文件中,单个子模块共享的辅助元素应该放在该子模块的 `internal.ts` 文件中。
59
+ - 对模块依赖关系的要求(通常是不循环依赖或不反向依赖)与对 DRY 的要求可能产生冲突。此时,若复用的代码数量不大,可以适当牺牲 DRY,复制粘贴并保留必要的注释说明;若复用的代码数量较大,则可以将其抽象到新的文件或子模块中,如 `common.ts`,并在需要的地方导入使用。
60
+ - 与随机相关的实现应优先围绕结果格式、边界约束与调用方可理解的失败语义组织,不要把底层算法细节直接提升为公共承诺。
65
61
 
66
- - Public API shape should remain deterministic even if output values are random.
67
- - Return values should always conform to the documented output format.
62
+ ### 导出策略要求
68
63
 
69
- #### 2.3 Helper Placement
64
+ - 保持内部辅助项和内部符号为私有,不要让外部接入依赖临时性的内部结构。
65
+ - 每个模块都应有一个用于重导出所有公共 API 的 Barrel 文件。
66
+ - Barrel 文件应命名为 `index.ts`,放在模块目录根部,并且所有公共 API 都应从该文件导出。
67
+ - 新增公共能力时,应优先检查它是否表达稳定、清楚且值得长期维护的随机语义,而不是某段实现细节的便捷暴露;仅在确认需要长期对外承诺时再加入 Barrel 导出。
70
68
 
71
- - Place local helper constants/functions immediately before the utility they support.
72
- - Prefix non-exported helpers with `internal`.
73
- - Never export internal helpers.
69
+ ### 测试要求
74
70
 
75
- #### 2.4 Spacing
76
-
77
- - Separate different utility functions with a single blank line.
78
-
79
- ### 3. Naming Conventions
80
-
81
- #### 3.1 Function Name Format
82
-
83
- Use clear operation-oriented names in the `random` domain:
84
-
85
- - `isUuid` for UUID format validation checks
86
- - `assertUuid` for UUID validation that throws on malformed input
87
- - `getUuidVersion` for extracting UUID version numbers
88
- - `generateUuid` for UUID creation helpers
89
-
90
- Prefer names that clearly indicate output format and intent.
91
-
92
- ### 4. Export Strategy
93
-
94
- - Export all public utilities from domain files.
95
- - Re-export them through `index.ts`.
96
- - Do not export internal helpers.
97
-
98
- ### 5. Common Pitfalls to Avoid
99
-
100
- 1. Do not assume browser-only APIs are always available.
101
- 2. Do not couple random utilities to a specific runtime unless documented.
102
- 3. Do not assert exact random results in tests.
103
- 4. Do not mutate shared/global state permanently.
104
-
105
- ### 6. Testing Requirements
106
-
107
- - Write one test per function.
108
- - If multiple cases are needed, include them within the same test.
109
- - For random outputs, validate shape/constraints instead of exact value.
71
+ - 若程序元素是函数,则只为该函数编写一个测试,如果该函数需要测试多个用例,应放在同一个测试中。
72
+ - 若程序元素是类,则至少要为该类的每一个方法编写一个测试,如果该方法需要测试多个用例,应放在同一个测试中。
73
+ - 若程序元素是类,除了为该类的每一个方法编写至少一个测试之外,还可以为该类编写任意多个测试,以覆盖该类的不同使用场景或边界情况。
74
+ - 若编写测试时需要用到辅助元素(Mock 或 Spy 等),可以在测试文件中直接定义这些辅助元素。若辅助元素较为简单,则可以直接放在每一个测试内部,优先保证每个测试的独立性,而不是追求极致 DRY;若辅助元素较为复杂或需要在多个测试中复用,则可以放在测试文件顶部,供该测试文件中的所有测试使用。
75
+ - 测试顺序应与源文件中被测试目标的原始顺序保持一致。
76
+ - 若该模块不需要测试,必须在说明文件中明确说明该模块不需要测试,并说明理由。一般来说,只有在该模块没有可执行的公共函数、只承载类型层表达,或其语义已被上层模块的测试完整覆盖且重复测试几乎不再带来额外价值时,才适合这样处理。
77
+ - 模块的单元测试文件目录是 `./tests/unit/random`,若模块包含子模块,则子模块的单元测试文件目录为 `./tests/unit/random/<sub-module-name>`。
78
+ - 对随机字符串相关能力,应优先测试长度约束、字符集边界与结果特征,而不要把测试建立在脆弱的精确随机输出之上。
@@ -1 +1 @@
1
- export * from "./uuid.ts"
1
+ export * from "./string.ts"
@@ -0,0 +1,35 @@
1
+ const internalRandomStringPacket: Record<number, string[]> = {}
2
+ /**
3
+ * 生成指定长度的随机字符串,并可选限制字符集。
4
+ *
5
+ * 该函数适合生成界面状态键、临时标识或其它非业务主键用途的随机文本。
6
+ *
7
+ * 当未传入字符集时,将使用数字、小写字母与大写字母组成的默认字符集。
8
+ * 同一运行时内会按长度记录已生成结果,尽量避免返回同长度的重复值。
9
+ *
10
+ * @example
11
+ * ```
12
+ * // Expect: 8
13
+ * const example1 = randomString(8).length
14
+ * // Expect: true
15
+ * const example2 = randomString(4, "ab").split("").every(char => char === "a" || char === "b")
16
+ * ```
17
+ */
18
+ export const randomString = (length: number, chars?: string | undefined): string => {
19
+ let result = ""
20
+ const preparedChars = chars ?? "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
21
+
22
+ Array.from({ length }).forEach(() => {
23
+ result = result + preparedChars[Math.floor(Math.random() * preparedChars.length)]!
24
+ })
25
+
26
+ internalRandomStringPacket[length] = internalRandomStringPacket[length] ?? []
27
+ const packet = internalRandomStringPacket[length]
28
+ if (packet.includes(result)) {
29
+ return randomString(length, preparedChars)
30
+ }
31
+ else {
32
+ packet.push(result)
33
+ return result
34
+ }
35
+ }
@@ -1,5 +1,9 @@
1
1
  # Reactor
2
2
 
3
+ ## Description
4
+
5
+ > 本模块纯人工实现,AI 不要插手!
6
+
3
7
  Reactor 的实现与以下项目有关:
4
8
 
5
9
  - [alien-signals](https://github.com/stackblitz/alien-signals): Reactor 源于该项目,是在对该项目进行重构的基础上添加了其它个性化实现得到的,两者核心区别包括:1、alien-signals 的 API 更加“函数式”,而 Reactor 的 API 更加“对象式”;2、alien-signals 的源码更注重性能,因而比较晦涩,而 Reactor 的实现更注重可维护性与可扩展性因而比较易懂;3、alien-signals 的功能更单一更克制,几乎只提供了核心的响应式算法,而 Reactor 则提供了更多的相关功能与工具函数。
@@ -107,7 +107,7 @@ export abstract class BaseReactor<V = unknown> implements Node {
107
107
  }
108
108
 
109
109
  const VOID = Symbol("void") as unknown;
110
- const isVoid = <T>(value: T): boolean => {
110
+ const isVoid = (value: unknown): boolean => {
111
111
  return value === VOID;
112
112
  }
113
113
 
@@ -241,7 +241,7 @@ export interface SignalOptions<V> extends BaseReactorOptions {
241
241
  * Signal 的值只有在被获取的时候才会更新。
242
242
  */
243
243
  export class Signal<V = unknown> extends BaseReactor<V> {
244
- private isEqual: (oldValue: V, newValue: V) => boolean;
244
+ private readonly isEqual: (oldValue: V, newValue: V) => boolean;
245
245
 
246
246
  private valueGetter: SignalValueGetter<V>;
247
247
 
@@ -377,9 +377,9 @@ export interface DerivedOptions<V> extends BaseReactorOptions {
377
377
  * Derived 的下游节点全部解除连接时会自动与所有上游节点解除连接,并回到初始状态。
378
378
  */
379
379
  export class Derived<V = unknown> extends BaseReactor<V> {
380
- private isEqual: (oldValue: V, newValue: V) => boolean;
380
+ private readonly isEqual: (oldValue: V, newValue: V) => boolean;
381
381
 
382
- private valueGetter: DerivedValueGetter<V>;
382
+ private readonly valueGetter: DerivedValueGetter<V>;
383
383
  private manualValueGetter: DerivedValueGetter<V> | undefined;
384
384
 
385
385
  constructor(valueGetter: DerivedValueGetter<V>, options: DerivedOptions<V>) {
@@ -558,9 +558,9 @@ export interface ComputedOptions<V> extends BaseReactorOptions {
558
558
  * Computed 的下游节点全部解除连接时会自动与所有上游节点解除连接,并回到初始状态。
559
559
  */
560
560
  export class Computed<V = unknown> extends BaseReactor<V> {
561
- private isEqual: (oldValue: V, newValue: V) => boolean;
561
+ private readonly isEqual: (oldValue: V, newValue: V) => boolean;
562
562
 
563
- private valueGetter: ComputedValueGetter<V>;
563
+ private readonly valueGetter: ComputedValueGetter<V>;
564
564
 
565
565
  constructor(valueGetter: ComputedValueGetter<V>, options: ComputedOptions<V>) {
566
566
  super(options);
@@ -684,7 +684,7 @@ export interface EffectOptions extends BaseReactorOptions {
684
684
  * 作为上游节点的 Effect 在没有下游节点时会自动与所有上游节点解除连接,并将标记清空。
685
685
  */
686
686
  export class Effect<V = void> extends BaseReactor<V> {
687
- private valueGetter: EffectValueGetter<V>;
687
+ private readonly valueGetter: EffectValueGetter<V>;
688
688
  private cleanupFn: CleanupFn | undefined;
689
689
 
690
690
  constructor(valueGetter: EffectValueGetter<V>, options: EffectOptions) {
@@ -799,7 +799,7 @@ export type EffectScopeValueGetter<V> = (context: EffectScopeValueGetterContext<
799
799
  export interface EffectScopeOptions extends BaseReactorOptions {
800
800
  }
801
801
  export class EffectScope<V = void> extends BaseReactor<V> {
802
- private valueGetter: EffectScopeValueGetter<V>;
802
+ private readonly valueGetter: EffectScopeValueGetter<V>;
803
803
  private cleanupFn: CleanupFn | void;
804
804
 
805
805
  constructor(valueGetter: EffectScopeValueGetter<V>, options: EffectScopeOptions) {
@@ -894,7 +894,7 @@ export type TriggerValueGetter<V> = (context: TriggerValueGetterContext<V>) => V
894
894
  export interface TriggerOptions extends BaseReactorOptions {
895
895
  }
896
896
  export class Trigger<V = void> extends BaseReactor<V> {
897
- private valueGetter: TriggerValueGetter<V>;
897
+ private readonly valueGetter: TriggerValueGetter<V>;
898
898
  private cleanupFn: CleanupFn | void;
899
899
 
900
900
  constructor(valueGetter: TriggerValueGetter<V>, options: TriggerOptions) {
@@ -178,7 +178,7 @@ export interface ReactiveSystem {
178
178
  /**
179
179
  * 设置当前正在进行依赖收集的节点。
180
180
  */
181
- setActiveNodeAsSub(nodeAsSub: Node | undefined): void;
181
+ setActiveNodeAsSub(nodeAsSub: Node | undefined): Node | undefined;
182
182
  /**
183
183
  * 设置当前正在进行依赖收集的节点为空。
184
184
  */
@@ -186,7 +186,7 @@ export interface ReactiveSystem {
186
186
  /**
187
187
  * 重置当前正在进行依赖收集的节点。
188
188
  */
189
- resetActiveNodeAsSub(): void;
189
+ resetActiveNodeAsSub(): Node | undefined;
190
190
  /**
191
191
  * 将指定节点作为当前正在进行依赖收集的节点执行指定函数。
192
192
  */
@@ -591,7 +591,7 @@ export const createReactiveSystem = (options: CreateReactiveSystemOptions): Reac
591
591
  return subNodes;
592
592
  }
593
593
 
594
- let prevActiveNodeAsSubStack: Array<Node | undefined> = [];
594
+ const prevActiveNodeAsSubStack: Array<Node | undefined> = [];
595
595
  let activeNodeAsSub: Node | undefined = undefined;
596
596
  const getActiveNodeAsSub = (): Node | undefined => {
597
597
  return activeNodeAsSub;
@@ -636,7 +636,7 @@ export const createReactiveSystem = (options: CreateReactiveSystemOptions): Reac
636
636
  const endTracking = (nodeAsSub: Node): void => {
637
637
  const flags = nodeAsSub.flags;
638
638
  if (flags.hasTrackingReusing() === true) {
639
- const firstRedundantDepLink = nodeAsSub?.tailDepLink?.nextDepLink;
639
+ const firstRedundantDepLink = nodeAsSub.tailDepLink?.nextDepLink;
640
640
  if (firstRedundantDepLink !== undefined) {
641
641
  let toRemove: Link | undefined = firstRedundantDepLink;
642
642
  while (toRemove !== undefined) {
@@ -703,7 +703,7 @@ export const createReactiveSystem = (options: CreateReactiveSystemOptions): Reac
703
703
  }
704
704
  }
705
705
  const track = (node: Node): void => {
706
- let targetSub = getActiveNodeAsSub();
706
+ const targetSub = getActiveNodeAsSub();
707
707
  if (targetSub !== undefined) {
708
708
  addLinkBetweenOptimizedForTracking(node, targetSub);
709
709
  }
@@ -0,0 +1,79 @@
1
+ # Singleton
2
+
3
+ ## Description
4
+
5
+ Singleton 模块用于提供单例(singleton)相关的基础能力,主要承载惰性初始化(lazy initialization)、结果缓存以及具名共享实例的组织语义。
6
+
7
+ 它关注的不是“如何制造全局变量”,而是“当某个值确实只应初始化一次并被稳定复用时,应如何用清楚、可维护的方式表达这种共享关系”。因此,这个模块更适合用来建模实例生命周期与访问边界,而不是无差别地为任何对象增加全局缓存入口。
8
+
9
+ ## For Understanding
10
+
11
+ 理解 Singleton 模块时,重点不在“单例”这个词本身,而在“共享值的生命周期由谁负责、初始化在什么时候发生、调用方如何稳定访问它”。这个模块解决的是共享实例的建模问题:某个值是否应在首次读取时才创建、是否应在后续始终复用、是否需要通过名称组织多个共享项。
12
+
13
+ 因此,它适合放在那些需要明确所有权和初始化时机的边界中,例如基础配置、昂贵对象构造结果、应用级共享资源或一组可按名称访问的依赖项。它不适合表达的,则是带有复杂销毁规则、作用域切换规则或线程级隔离要求的资源管理问题;那类问题通常需要更完整的生命周期模型,不能仅靠“只创建一次”来概括。
14
+
15
+ 还需要注意的是,单例只是一种共享策略,不应被误解为默认设计。只有当值的复用边界、初始化副作用和缓存语义都足够清楚时,它才适合进入这个模块。否则,过早把普通依赖硬塞进单例模型,只会把状态管理问题隐藏起来,而不会真正减少复杂度。
16
+
17
+ ## For Using
18
+
19
+ 当你需要把某个值设计为“首次访问时初始化,之后持续复用”的共享实例时,可以使用这个模块。它适合那些初始化成本较高、创建时机需要延后、并且复用边界明确的场景。
20
+
21
+ 从使用角度看,这个模块大致包含两类能力。一类是惰性工厂能力,用来把一次性初始化逻辑包装成可复用入口,使值只在真正需要时才被创建。另一类是具名单例集合能力,用来把多个共享实例组织成一个稳定的命名集合,便于调用方按名称读取相应的缓存结果。
22
+
23
+ 更合理的使用方式,是把单例能力放在应用或模块边界附近,并让初始化逻辑保持尽量确定。特别是在初始化会接触 I/O、环境变量、全局对象或其它外部资源时,应先明确这些副作用是否真的适合缓存。测试场景中也应明确控制缓存状态的生命周期,避免不同用例之间因为共享状态而互相影响。
24
+
25
+ ## For Contributing
26
+
27
+ 贡献 Singleton 模块时,应优先判断新增能力解决的是不是稳定的共享生命周期问题,而不是某个局部实现里一时方便的缓存技巧。这个模块的公共语义应围绕“值只初始化一次并被复用”以及“多个共享项如何被命名和访问”展开,而不是替调用方偷偷管理越来越复杂的状态机。
28
+
29
+ 在继续扩展时,应守住几个边界。不要把作用域管理、资源销毁、并发隔离或依赖注入容器的完整语义混入 Singleton 模块;这些问题虽然与共享实例有关,但通常比单例语义更大。也不要为了省掉几次参数传递,就把本应显式注入的依赖升级为全局单例。只有当共享关系本身就是模块想表达的稳定模型时,新增能力才值得公开。
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/singleton/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/singleton`,若模块包含子模块,则子模块的单元测试文件目录为 `./tests/unit/singleton/<sub-module-name>`。
79
+ - 对单例相关能力,应优先覆盖首次初始化、重复访问复用、不同名称隔离、错误分支以及测试间状态控制等场景。
@@ -0,0 +1,55 @@
1
+ /**
2
+ * 定义惰性单例工厂函数类型。
3
+ */
4
+ export type SingletonFactory<T> = () => T
5
+
6
+ /**
7
+ * 创建一个会缓存首次结果的单例工厂。
8
+ *
9
+ * @example
10
+ * ```
11
+ * // Scenario 1: object values are created once and then reused.
12
+ * let calls = 0
13
+ * const getConfig = getSingletonFactory(() => {
14
+ * calls += 1
15
+ * return { env: "test" }
16
+ * })
17
+ *
18
+ * const example1 = getConfig()
19
+ * const example2 = getConfig()
20
+ * const example3 = example1 === example2
21
+ * const example4 = calls
22
+ *
23
+ * // Expect: true
24
+ * example3
25
+ * // Expect: 1
26
+ * example4
27
+ *
28
+ * // Scenario 2: primitive values are also cached after the first read.
29
+ * let count = 0
30
+ * const getPort = getSingletonFactory(() => {
31
+ * count += 1
32
+ * return 3000
33
+ * })
34
+ *
35
+ * const example5 = getPort()
36
+ * const example6 = getPort()
37
+ * const example7 = count
38
+ *
39
+ * // Expect: 3000
40
+ * example5
41
+ * // Expect: 3000
42
+ * example6
43
+ * // Expect: 1
44
+ * example7
45
+ * ```
46
+ */
47
+ export const getSingletonFactory = <T>(make: () => T): SingletonFactory<T> => {
48
+ let singleton: T | undefined = undefined
49
+ return () => {
50
+ if (singleton === undefined) {
51
+ singleton = make()
52
+ }
53
+ return singleton
54
+ }
55
+ }
@@ -0,0 +1,2 @@
1
+ export * from "./factory.ts"
2
+ export * from "./manager.ts"