@kumbatio/energy-system 0.5.0 → 0.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api-surface.json +337 -0
- package/package.json +5 -2
package/api-surface.json
ADDED
|
@@ -0,0 +1,337 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": "0.5.2",
|
|
3
|
+
"entryPoints": [
|
|
4
|
+
{
|
|
5
|
+
"specifier": "@kumbatio/energy-system",
|
|
6
|
+
"values": [
|
|
7
|
+
"DEFERRAL_PRESET_IDS",
|
|
8
|
+
"ENERGY_LEVEL_VALUES",
|
|
9
|
+
"ENERGY_PRESENCE_VALUES",
|
|
10
|
+
"ENERGY_SOURCE_VALUES",
|
|
11
|
+
"UNPRODUCED_ORIGIN",
|
|
12
|
+
"UNPRODUCED_TIMESTAMP",
|
|
13
|
+
"createDeferralPresets",
|
|
14
|
+
"createEnergyEngine",
|
|
15
|
+
"createEnergyState",
|
|
16
|
+
"createExternalLevelCompatibility",
|
|
17
|
+
"createFocusSessionController",
|
|
18
|
+
"createNotificationGate",
|
|
19
|
+
"createPresenceStrategy",
|
|
20
|
+
"cycleDiscreteLevel",
|
|
21
|
+
"cycleEnergyLevel",
|
|
22
|
+
"deferralStrategy",
|
|
23
|
+
"defineEnergyPresence",
|
|
24
|
+
"getEnergyLevel",
|
|
25
|
+
"getEnergyLevels",
|
|
26
|
+
"getEnergyMetrics",
|
|
27
|
+
"interactionForgivenessStrategy",
|
|
28
|
+
"isEnergyLevel",
|
|
29
|
+
"isEnergyPresence",
|
|
30
|
+
"isEnergySource",
|
|
31
|
+
"isHigherEnergy",
|
|
32
|
+
"isNotificationPriority",
|
|
33
|
+
"isPresenceVisible",
|
|
34
|
+
"isSessionExpired",
|
|
35
|
+
"isUnproducedState",
|
|
36
|
+
"mapToNearestDiscreteLevel",
|
|
37
|
+
"mapToNearestEnergyLevel",
|
|
38
|
+
"notificationStrategy",
|
|
39
|
+
"presenceAtOrAbove",
|
|
40
|
+
"presenceAtOrBelow",
|
|
41
|
+
"resolveDeferral",
|
|
42
|
+
"resolveEnergyPresence",
|
|
43
|
+
"resolveNotificationOutcome",
|
|
44
|
+
"sessionRemainingMs",
|
|
45
|
+
"taskComplexityStrategy",
|
|
46
|
+
"uiVisibilityStrategy"
|
|
47
|
+
],
|
|
48
|
+
"types": [
|
|
49
|
+
"AdaptationStrategy",
|
|
50
|
+
"CognitiveProfile",
|
|
51
|
+
"DecisionCapacity",
|
|
52
|
+
"DeferralConfig",
|
|
53
|
+
"DeferralPreset",
|
|
54
|
+
"DeferralPresetOptions",
|
|
55
|
+
"EnergyChangeListener",
|
|
56
|
+
"EnergyClock",
|
|
57
|
+
"EnergyEngine",
|
|
58
|
+
"EnergyEngineOptions",
|
|
59
|
+
"EnergyLevel",
|
|
60
|
+
"EnergyLevelDefinition",
|
|
61
|
+
"EnergyMetrics",
|
|
62
|
+
"EnergyNotification",
|
|
63
|
+
"EnergyPersistence",
|
|
64
|
+
"EnergyPresence",
|
|
65
|
+
"EnergyPresenceMap",
|
|
66
|
+
"EnergyPresenceSpec",
|
|
67
|
+
"EnergySource",
|
|
68
|
+
"EnergyState",
|
|
69
|
+
"ExternalLevelCompatibility",
|
|
70
|
+
"ExternalLevelCompatibilityOptions",
|
|
71
|
+
"FocusDuration",
|
|
72
|
+
"FocusSession",
|
|
73
|
+
"FocusSessionController",
|
|
74
|
+
"FocusSessionControllerOptions",
|
|
75
|
+
"FocusSessionEvent",
|
|
76
|
+
"FocusSessionListener",
|
|
77
|
+
"FocusSuppressible",
|
|
78
|
+
"GateScheduler",
|
|
79
|
+
"InteractionForgivenessConfig",
|
|
80
|
+
"InterruptionTolerance",
|
|
81
|
+
"NotificationChannels",
|
|
82
|
+
"NotificationConfig",
|
|
83
|
+
"NotificationDelivery",
|
|
84
|
+
"NotificationDeliveryReason",
|
|
85
|
+
"NotificationGate",
|
|
86
|
+
"NotificationGateOptions",
|
|
87
|
+
"NotificationPriority",
|
|
88
|
+
"PublishOutcome",
|
|
89
|
+
"StartFocusSessionOptions",
|
|
90
|
+
"TaskComplexity",
|
|
91
|
+
"TaskComplexityConfig",
|
|
92
|
+
"UIVisibilityConfig"
|
|
93
|
+
]
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
"specifier": "@kumbatio/energy-system/dom",
|
|
97
|
+
"values": [
|
|
98
|
+
"applyEnergyLevel",
|
|
99
|
+
"observeEnergyLevel",
|
|
100
|
+
"readEnergyLevel"
|
|
101
|
+
],
|
|
102
|
+
"types": []
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"specifier": "@kumbatio/energy-system/react",
|
|
106
|
+
"values": [
|
|
107
|
+
"EnergyGate",
|
|
108
|
+
"EnergyIndicator",
|
|
109
|
+
"EnergyProvider",
|
|
110
|
+
"useEnergyGate",
|
|
111
|
+
"useEnergyLevel",
|
|
112
|
+
"useEnergyLevelCycler",
|
|
113
|
+
"useEnergyPresence",
|
|
114
|
+
"useEnergyState",
|
|
115
|
+
"useStrategy"
|
|
116
|
+
],
|
|
117
|
+
"types": [
|
|
118
|
+
"EnergyGateProps",
|
|
119
|
+
"EnergyHiddenBehavior",
|
|
120
|
+
"EnergyIndicatorProps",
|
|
121
|
+
"EnergyIndicatorRenderProps",
|
|
122
|
+
"EnergyProviderProps"
|
|
123
|
+
]
|
|
124
|
+
},
|
|
125
|
+
{
|
|
126
|
+
"specifier": "@kumbatio/energy-system/persistence",
|
|
127
|
+
"values": [
|
|
128
|
+
"localStoragePersistence",
|
|
129
|
+
"memoryPersistence"
|
|
130
|
+
],
|
|
131
|
+
"types": []
|
|
132
|
+
}
|
|
133
|
+
],
|
|
134
|
+
"members": {
|
|
135
|
+
"ExternalLevelCompatibilityOptions": [
|
|
136
|
+
"fallbackEnergyLevel",
|
|
137
|
+
"fallbackLevel",
|
|
138
|
+
"levels",
|
|
139
|
+
"toEnergyLevel"
|
|
140
|
+
],
|
|
141
|
+
"ExternalLevelCompatibility": [
|
|
142
|
+
"cycleExternalLevel",
|
|
143
|
+
"cycleMappedEnergyLevel",
|
|
144
|
+
"fallbackEnergyLevel",
|
|
145
|
+
"fallbackLevel",
|
|
146
|
+
"fromEnergyLevel",
|
|
147
|
+
"levels",
|
|
148
|
+
"toEnergyLevel"
|
|
149
|
+
],
|
|
150
|
+
"DeferralPreset": [
|
|
151
|
+
"compute",
|
|
152
|
+
"id",
|
|
153
|
+
"label"
|
|
154
|
+
],
|
|
155
|
+
"DeferralPresetOptions": [
|
|
156
|
+
"eveningHour",
|
|
157
|
+
"morningHour"
|
|
158
|
+
],
|
|
159
|
+
"DeferralConfig": [
|
|
160
|
+
"defaultPresetId",
|
|
161
|
+
"orderedPresetIds"
|
|
162
|
+
],
|
|
163
|
+
"EnergyEngineOptions": [
|
|
164
|
+
"autoStart",
|
|
165
|
+
"clock",
|
|
166
|
+
"initialLevel",
|
|
167
|
+
"maxFutureSkewMs",
|
|
168
|
+
"onChange",
|
|
169
|
+
"onPersistenceError",
|
|
170
|
+
"originId",
|
|
171
|
+
"persistence"
|
|
172
|
+
],
|
|
173
|
+
"EnergyEngine": [
|
|
174
|
+
"cycleLevel",
|
|
175
|
+
"dispose",
|
|
176
|
+
"flush",
|
|
177
|
+
"getState",
|
|
178
|
+
"hydrate",
|
|
179
|
+
"setLevel",
|
|
180
|
+
"start",
|
|
181
|
+
"subscribe"
|
|
182
|
+
],
|
|
183
|
+
"EnergyNotification": [
|
|
184
|
+
"createdAt",
|
|
185
|
+
"payload",
|
|
186
|
+
"priority"
|
|
187
|
+
],
|
|
188
|
+
"NotificationChannels": [
|
|
189
|
+
"sound",
|
|
190
|
+
"vibration",
|
|
191
|
+
"visual"
|
|
192
|
+
],
|
|
193
|
+
"NotificationDelivery": [
|
|
194
|
+
"channels",
|
|
195
|
+
"level",
|
|
196
|
+
"notifications",
|
|
197
|
+
"reason"
|
|
198
|
+
],
|
|
199
|
+
"GateScheduler": [
|
|
200
|
+
"clearTimeout",
|
|
201
|
+
"setTimeout"
|
|
202
|
+
],
|
|
203
|
+
"NotificationGateOptions": [
|
|
204
|
+
"clock",
|
|
205
|
+
"onDeliver",
|
|
206
|
+
"scheduler",
|
|
207
|
+
"strategy"
|
|
208
|
+
],
|
|
209
|
+
"NotificationGate": [
|
|
210
|
+
"dispose",
|
|
211
|
+
"flush",
|
|
212
|
+
"isSuppressed",
|
|
213
|
+
"pendingCount",
|
|
214
|
+
"publish",
|
|
215
|
+
"setSuppressed"
|
|
216
|
+
],
|
|
217
|
+
"EnergyProviderProps": [
|
|
218
|
+
"applyToDOM",
|
|
219
|
+
"children",
|
|
220
|
+
"defaultLevel",
|
|
221
|
+
"domTarget",
|
|
222
|
+
"engine",
|
|
223
|
+
"onLevelChange",
|
|
224
|
+
"persistence"
|
|
225
|
+
],
|
|
226
|
+
"EnergyIndicatorRenderProps": [
|
|
227
|
+
"cognitiveProfile",
|
|
228
|
+
"cycle",
|
|
229
|
+
"definition",
|
|
230
|
+
"description",
|
|
231
|
+
"label",
|
|
232
|
+
"level",
|
|
233
|
+
"levels",
|
|
234
|
+
"setLevel",
|
|
235
|
+
"state"
|
|
236
|
+
],
|
|
237
|
+
"EnergyIndicatorProps": [
|
|
238
|
+
"children"
|
|
239
|
+
],
|
|
240
|
+
"FocusSession": [
|
|
241
|
+
"breakIntervalMs",
|
|
242
|
+
"endsAt",
|
|
243
|
+
"startedAt"
|
|
244
|
+
],
|
|
245
|
+
"FocusSuppressible": [
|
|
246
|
+
"setSuppressed"
|
|
247
|
+
],
|
|
248
|
+
"FocusSessionControllerOptions": [
|
|
249
|
+
"clock",
|
|
250
|
+
"engine",
|
|
251
|
+
"gate",
|
|
252
|
+
"scheduler"
|
|
253
|
+
],
|
|
254
|
+
"StartFocusSessionOptions": [
|
|
255
|
+
"breakEveryMinutes",
|
|
256
|
+
"durationMinutes"
|
|
257
|
+
],
|
|
258
|
+
"FocusSessionController": [
|
|
259
|
+
"dispose",
|
|
260
|
+
"getSession",
|
|
261
|
+
"remainingMs",
|
|
262
|
+
"start",
|
|
263
|
+
"stop",
|
|
264
|
+
"subscribe"
|
|
265
|
+
],
|
|
266
|
+
"UIVisibilityConfig": [
|
|
267
|
+
"chromeOpacity",
|
|
268
|
+
"chromeOpacityHover",
|
|
269
|
+
"contentFontScale",
|
|
270
|
+
"contentMaxWidth",
|
|
271
|
+
"readOnlyCursor",
|
|
272
|
+
"sidebar",
|
|
273
|
+
"statusBar",
|
|
274
|
+
"tabBar",
|
|
275
|
+
"toolbar"
|
|
276
|
+
],
|
|
277
|
+
"NotificationConfig": [
|
|
278
|
+
"allowSound",
|
|
279
|
+
"allowVibration",
|
|
280
|
+
"allowVisual",
|
|
281
|
+
"batchInterval",
|
|
282
|
+
"priorityThreshold"
|
|
283
|
+
],
|
|
284
|
+
"TaskComplexityConfig": [
|
|
285
|
+
"breakIntervalMinutes",
|
|
286
|
+
"maxComplexity",
|
|
287
|
+
"suggestBreaks"
|
|
288
|
+
],
|
|
289
|
+
"InteractionForgivenessConfig": [
|
|
290
|
+
"autosaveIntervalMs",
|
|
291
|
+
"confirmDestructive",
|
|
292
|
+
"undoWindowMs"
|
|
293
|
+
],
|
|
294
|
+
"EnergyState": [
|
|
295
|
+
"level",
|
|
296
|
+
"origin",
|
|
297
|
+
"revision",
|
|
298
|
+
"source",
|
|
299
|
+
"timestamp"
|
|
300
|
+
],
|
|
301
|
+
"EnergyClock": [
|
|
302
|
+
"now"
|
|
303
|
+
],
|
|
304
|
+
"CognitiveProfile": [
|
|
305
|
+
"decisionCapacity",
|
|
306
|
+
"focusDuration",
|
|
307
|
+
"interruptionTolerance",
|
|
308
|
+
"taskComplexity"
|
|
309
|
+
],
|
|
310
|
+
"EnergyLevelDefinition": [
|
|
311
|
+
"cognitiveProfile",
|
|
312
|
+
"description",
|
|
313
|
+
"key",
|
|
314
|
+
"label",
|
|
315
|
+
"value"
|
|
316
|
+
],
|
|
317
|
+
"AdaptationStrategy": [
|
|
318
|
+
"describe",
|
|
319
|
+
"name",
|
|
320
|
+
"resolve"
|
|
321
|
+
],
|
|
322
|
+
"EnergyPersistence": [
|
|
323
|
+
"load",
|
|
324
|
+
"observe",
|
|
325
|
+
"save"
|
|
326
|
+
],
|
|
327
|
+
"EnergyMetrics": [
|
|
328
|
+
"expectedProductivityWindowMinutes",
|
|
329
|
+
"recommendedTaskComplexity",
|
|
330
|
+
"recoveryHintMinutes",
|
|
331
|
+
"stateAgeMinutes",
|
|
332
|
+
"stateAgeMs",
|
|
333
|
+
"suggestedBreakIntervalMinutes",
|
|
334
|
+
"sustainable"
|
|
335
|
+
]
|
|
336
|
+
}
|
|
337
|
+
}
|
package/package.json
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kumbatio/energy-system",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.2",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Framework-agnostic TypeScript library for energy-aware application behavior.",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"files": [
|
|
8
8
|
"dist",
|
|
9
9
|
"src/energy.css",
|
|
10
|
+
"api-surface.json",
|
|
10
11
|
"README.md"
|
|
11
12
|
],
|
|
12
13
|
"type": "module",
|
|
@@ -33,6 +34,7 @@
|
|
|
33
34
|
"import": "./dist/persistence.js"
|
|
34
35
|
},
|
|
35
36
|
"./css": "./src/energy.css",
|
|
37
|
+
"./api-surface.json": "./api-surface.json",
|
|
36
38
|
"./package.json": "./package.json"
|
|
37
39
|
},
|
|
38
40
|
"publishConfig": {
|
|
@@ -66,7 +68,8 @@
|
|
|
66
68
|
"node": ">=24"
|
|
67
69
|
},
|
|
68
70
|
"scripts": {
|
|
69
|
-
"build": "tsc -p tsconfig.build.json",
|
|
71
|
+
"build": "tsc -p tsconfig.build.json && pnpm run api:surface",
|
|
72
|
+
"api:surface": "tsx scripts/extract-api-surface.ts",
|
|
70
73
|
"check-types": "tsc --noEmit -p tsconfig.json",
|
|
71
74
|
"test": "pnpm run build && node --test --import tsx",
|
|
72
75
|
"validate": "pnpm run format:check && pnpm run lint && pnpm run check-types && pnpm run test && pnpm run pack:dry-run",
|