@vue-skuilder/db 0.2.34 → 0.2.36
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/CLAUDE.md +15 -4
- package/build.entries.mjs +12 -0
- package/dist/_virtual/_rolldown/runtime.mjs +8 -0
- package/dist/{contentSource-CTQ4kWhR.d.cts → contentSource-D_E7JaxR.d.ts} +2 -2
- package/dist/core/UserDBDebugger.mjs +285 -0
- package/dist/core/UserDBDebugger.mjs.map +1 -0
- package/dist/core/bulkImport/cardProcessor.mjs +106 -0
- package/dist/core/bulkImport/cardProcessor.mjs.map +1 -0
- package/dist/core/{index.js → index.cjs} +6438 -7784
- package/dist/core/index.cjs.map +1 -0
- package/dist/core/index.d.ts +5 -5
- package/dist/core/index.mjs +20 -11368
- package/dist/core/interfaces/contentSource.mjs +20 -0
- package/dist/core/interfaces/contentSource.mjs.map +1 -0
- package/dist/core/navigators/Pipeline.mjs +723 -0
- package/dist/core/navigators/Pipeline.mjs.map +1 -0
- package/dist/core/navigators/PipelineAssembler.mjs +86 -0
- package/dist/core/navigators/PipelineAssembler.mjs.map +1 -0
- package/dist/core/navigators/PipelineDebugger.mjs +771 -0
- package/dist/core/navigators/PipelineDebugger.mjs.map +1 -0
- package/dist/core/navigators/SrsDebugger.mjs +34 -0
- package/dist/core/navigators/SrsDebugger.mjs.map +1 -0
- package/dist/core/navigators/StrategyPressureDebugger.mjs +19 -0
- package/dist/core/navigators/StrategyPressureDebugger.mjs.map +1 -0
- package/dist/core/navigators/defaults.mjs +96 -0
- package/dist/core/navigators/defaults.mjs.map +1 -0
- package/dist/core/navigators/diversityRerank.mjs +85 -0
- package/dist/core/navigators/diversityRerank.mjs.map +1 -0
- package/dist/core/navigators/filters/WeightedFilter.mjs +81 -0
- package/dist/core/navigators/filters/WeightedFilter.mjs.map +1 -0
- package/dist/core/navigators/filters/eloDistance.mjs +244 -0
- package/dist/core/navigators/filters/eloDistance.mjs.map +1 -0
- package/dist/core/navigators/filters/hierarchyDefinition.mjs +235 -0
- package/dist/core/navigators/filters/hierarchyDefinition.mjs.map +1 -0
- package/dist/core/navigators/filters/interferenceMitigator.mjs +201 -0
- package/dist/core/navigators/filters/interferenceMitigator.mjs.map +1 -0
- package/dist/core/navigators/filters/relativePriority.mjs +135 -0
- package/dist/core/navigators/filters/relativePriority.mjs.map +1 -0
- package/dist/core/navigators/filters/userTagPreference.mjs +101 -0
- package/dist/core/navigators/filters/userTagPreference.mjs.map +1 -0
- package/dist/core/navigators/generators/CompositeGenerator.mjs +203 -0
- package/dist/core/navigators/generators/CompositeGenerator.mjs.map +1 -0
- package/dist/core/navigators/generators/elo.mjs +77 -0
- package/dist/core/navigators/generators/elo.mjs.map +1 -0
- package/dist/core/navigators/generators/prescribed.mjs +676 -0
- package/dist/core/navigators/generators/prescribed.mjs.map +1 -0
- package/dist/core/navigators/generators/srs.mjs +158 -0
- package/dist/core/navigators/generators/srs.mjs.map +1 -0
- package/dist/core/navigators/index.mjs +345 -0
- package/dist/core/navigators/index.mjs.map +1 -0
- package/dist/core/navigators/pipelinePlan.mjs +109 -0
- package/dist/core/navigators/pipelinePlan.mjs.map +1 -0
- package/dist/core/navigators/regulators.mjs +128 -0
- package/dist/core/navigators/regulators.mjs.map +1 -0
- package/dist/core/orchestration/gradient.mjs +101 -0
- package/dist/core/orchestration/gradient.mjs.map +1 -0
- package/dist/core/orchestration/index.mjs +115 -0
- package/dist/core/orchestration/index.mjs.map +1 -0
- package/dist/core/orchestration/learning.mjs +140 -0
- package/dist/core/orchestration/learning.mjs.map +1 -0
- package/dist/core/orchestration/recording.mjs +64 -0
- package/dist/core/orchestration/recording.mjs.map +1 -0
- package/dist/core/orchestration/signal.mjs +40 -0
- package/dist/core/orchestration/signal.mjs.map +1 -0
- package/dist/core/types/contentNavigationStrategy.mjs +10 -0
- package/dist/core/types/contentNavigationStrategy.mjs.map +1 -0
- package/dist/core/types/hydration.mjs +13 -0
- package/dist/core/types/hydration.mjs.map +1 -0
- package/dist/core/types/strategyState.mjs +16 -0
- package/dist/core/types/strategyState.mjs.map +1 -0
- package/dist/core/types/studySession.mjs +14 -0
- package/dist/core/types/studySession.mjs.map +1 -0
- package/dist/core/types/types-legacy.mjs +44 -0
- package/dist/core/types/types-legacy.mjs.map +1 -0
- package/dist/core/util/index.mjs +31 -0
- package/dist/core/util/index.mjs.map +1 -0
- package/dist/core/versionStamps.mjs +46 -0
- package/dist/core/versionStamps.mjs.map +1 -0
- package/dist/courseConfigRegistration.mjs +306 -0
- package/dist/courseConfigRegistration.mjs.map +1 -0
- package/dist/{dataLayerProvider-rlLE2Mf-.d.ts → dataLayerProvider-BDshhSp_.d.ts} +1 -1
- package/dist/diagnostics/dataset.mjs +118 -0
- package/dist/diagnostics/dataset.mjs.map +1 -0
- package/dist/diagnostics/derive.mjs +318 -0
- package/dist/diagnostics/derive.mjs.map +1 -0
- package/dist/diagnostics/{index.js → index.cjs} +130 -1
- package/dist/diagnostics/index.cjs.map +1 -0
- package/dist/diagnostics/index.d.ts +108 -5
- package/dist/diagnostics/index.mjs +7 -914
- package/dist/diagnostics/loader.mjs +151 -0
- package/dist/diagnostics/loader.mjs.map +1 -0
- package/dist/diagnostics/pipeline.mjs +161 -0
- package/dist/diagnostics/pipeline.mjs.map +1 -0
- package/dist/diagnostics/tagElo.mjs +177 -0
- package/dist/diagnostics/tagElo.mjs.map +1 -0
- package/dist/diagnostics/text.mjs +174 -0
- package/dist/diagnostics/text.mjs.map +1 -0
- package/dist/factory.mjs +70 -0
- package/dist/factory.mjs.map +1 -0
- package/dist/impl/common/BaseUserDB.mjs +1103 -0
- package/dist/impl/common/BaseUserDB.mjs.map +1 -0
- package/dist/impl/common/userDBHelpers.mjs +49 -0
- package/dist/impl/common/userDBHelpers.mjs.map +1 -0
- package/dist/impl/common/userDBKeys.mjs +45 -0
- package/dist/impl/common/userDBKeys.mjs.map +1 -0
- package/dist/impl/couch/CouchDBSyncStrategy.mjs +272 -0
- package/dist/impl/couch/CouchDBSyncStrategy.mjs.map +1 -0
- package/dist/impl/couch/CourseSyncService.mjs +242 -0
- package/dist/impl/couch/CourseSyncService.mjs.map +1 -0
- package/dist/impl/couch/PouchDataLayerProvider.mjs +74 -0
- package/dist/impl/couch/PouchDataLayerProvider.mjs.map +1 -0
- package/dist/impl/couch/adminDB.mjs +61 -0
- package/dist/impl/couch/adminDB.mjs.map +1 -0
- package/dist/impl/couch/auth.mjs +33 -0
- package/dist/impl/couch/auth.mjs.map +1 -0
- package/dist/impl/couch/classroomDB.mjs +227 -0
- package/dist/impl/couch/classroomDB.mjs.map +1 -0
- package/dist/impl/couch/clientCache.mjs +15 -0
- package/dist/impl/couch/clientCache.mjs.map +1 -0
- package/dist/impl/couch/courseAPI.mjs +183 -0
- package/dist/impl/couch/courseAPI.mjs.map +1 -0
- package/dist/impl/couch/courseDB.mjs +729 -0
- package/dist/impl/couch/courseDB.mjs.map +1 -0
- package/dist/impl/couch/courseLookupDB.mjs +94 -0
- package/dist/impl/couch/courseLookupDB.mjs.map +1 -0
- package/dist/impl/couch/{index.js → index.cjs} +6911 -10367
- package/dist/impl/couch/index.cjs.map +1 -0
- package/dist/impl/couch/index.d.ts +12 -5
- package/dist/impl/couch/index.mjs +134 -12146
- package/dist/impl/couch/index.mjs.map +1 -1
- package/dist/impl/couch/pouchdb-setup.mjs +15 -0
- package/dist/impl/couch/pouchdb-setup.mjs.map +1 -0
- package/dist/impl/couch/updateQueue.mjs +101 -0
- package/dist/impl/couch/updateQueue.mjs.map +1 -0
- package/dist/impl/couch/user-course-relDB.mjs +55 -0
- package/dist/impl/couch/user-course-relDB.mjs.map +1 -0
- package/dist/impl/static/NoOpSyncStrategy.mjs +49 -0
- package/dist/impl/static/NoOpSyncStrategy.mjs.map +1 -0
- package/dist/impl/static/StaticDataLayerProvider.mjs +94 -0
- package/dist/impl/static/StaticDataLayerProvider.mjs.map +1 -0
- package/dist/impl/static/StaticDataUnpacker.mjs +311 -0
- package/dist/impl/static/StaticDataUnpacker.mjs.map +1 -0
- package/dist/impl/static/courseDB.mjs +368 -0
- package/dist/impl/static/courseDB.mjs.map +1 -0
- package/dist/impl/static/coursesDB.mjs +38 -0
- package/dist/impl/static/coursesDB.mjs.map +1 -0
- package/dist/impl/static/{index.js → index.cjs} +2461 -5992
- package/dist/impl/static/index.cjs.map +1 -0
- package/dist/impl/static/index.d.ts +4 -4
- package/dist/impl/static/index.mjs +6 -10741
- package/dist/{index-CVGehe_t.d.ts → index-BLDpFYG3.d.ts} +1 -1
- package/dist/{index.js → index.cjs} +14070 -14239
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.ts +12 -23
- package/dist/index.mjs +38 -16937
- package/dist/pouch/{index.js → index.cjs} +5 -1
- package/dist/pouch/index.cjs.map +1 -0
- package/dist/pouch/index.mjs +2 -19
- package/dist/study/ItemQueue.mjs +95 -0
- package/dist/study/ItemQueue.mjs.map +1 -0
- package/dist/study/MixerDebugger.mjs +303 -0
- package/dist/study/MixerDebugger.mjs.map +1 -0
- package/dist/study/SessionController.mjs +1187 -0
- package/dist/study/SessionController.mjs.map +1 -0
- package/dist/study/SessionDebugger.mjs +271 -0
- package/dist/study/SessionDebugger.mjs.map +1 -0
- package/dist/study/SessionOverlay.mjs +407 -0
- package/dist/study/SessionOverlay.mjs.map +1 -0
- package/dist/study/SourceMixer.mjs +45 -0
- package/dist/study/SourceMixer.mjs.map +1 -0
- package/dist/study/SpacedRepetition.mjs +108 -0
- package/dist/study/SpacedRepetition.mjs.map +1 -0
- package/dist/study/TagFilteredContentSource.mjs +136 -0
- package/dist/study/TagFilteredContentSource.mjs.map +1 -0
- package/dist/study/services/CardHydrationService.mjs +172 -0
- package/dist/study/services/CardHydrationService.mjs.map +1 -0
- package/dist/study/services/EloService.mjs +217 -0
- package/dist/study/services/EloService.mjs.map +1 -0
- package/dist/study/services/ResponseProcessor.mjs +190 -0
- package/dist/study/services/ResponseProcessor.mjs.map +1 -0
- package/dist/study/services/SrsService.mjs +49 -0
- package/dist/study/services/SrsService.mjs.map +1 -0
- package/dist/study/services/tagRecent.mjs +65 -0
- package/dist/study/services/tagRecent.mjs.map +1 -0
- package/dist/{types-dXWfyz9B.d.ts → types-DChCz22D.d.ts} +1 -1
- package/dist/{types-legacy-BkOYOR6U.d.cts → types-legacy-fT5Y1Wuy.d.ts} +1 -1
- package/dist/userDBKeys-ne1g4Xuq.d.ts +16 -0
- package/dist/util/Loggable.mjs +14 -0
- package/dist/util/Loggable.mjs.map +1 -0
- package/dist/util/dataDirectory.mjs +47 -0
- package/dist/util/dataDirectory.mjs.map +1 -0
- package/dist/util/logger.mjs +86 -0
- package/dist/util/logger.mjs.map +1 -0
- package/dist/util/migrator/FileSystemAdapter.mjs +18 -0
- package/dist/util/migrator/FileSystemAdapter.mjs.map +1 -0
- package/dist/util/migrator/StaticToCouchDBMigrator.mjs +428 -0
- package/dist/util/migrator/StaticToCouchDBMigrator.mjs.map +1 -0
- package/dist/util/migrator/types.mjs +11 -0
- package/dist/util/migrator/types.mjs.map +1 -0
- package/dist/util/migrator/validation.mjs +334 -0
- package/dist/util/migrator/validation.mjs.map +1 -0
- package/dist/util/packer/CouchDBToStaticPacker.mjs +438 -0
- package/dist/util/packer/CouchDBToStaticPacker.mjs.map +1 -0
- package/dist/util/packer/{index.js → index.cjs} +73 -9
- package/dist/util/packer/index.cjs.map +1 -0
- package/dist/util/packer/index.d.ts +3 -3
- package/dist/util/packer/index.mjs +2 -537
- package/eslint.config.mjs +9 -1
- package/package.json +25 -13
- package/rolldown.config.mjs +44 -0
- package/src/core/UserDBDebugger.ts +47 -46
- package/src/core/navigators/Pipeline.ts +10 -10
- package/src/core/navigators/PipelineDebugger.ts +55 -55
- package/src/core/navigators/filters/eloDistance.ts +11 -1
- package/src/core/navigators/generators/elo.ts +5 -1
- package/src/core/navigators/index.ts +9 -3
- package/src/diagnostics/derive.ts +6 -0
- package/src/diagnostics/index.ts +1 -0
- package/src/diagnostics/tagElo.ts +257 -0
- package/src/factory.ts +10 -1
- package/src/impl/common/BaseUserDB.ts +1 -3
- package/src/impl/common/index.ts +2 -0
- package/src/impl/common/userDBHelpers.ts +4 -58
- package/src/impl/common/userDBKeys.ts +64 -0
- package/src/impl/couch/courseDB.ts +15 -3
- package/src/impl/couch/index.ts +2 -18
- package/src/impl/couch/pouchdb-setup.ts +8 -0
- package/src/index.ts +1 -1
- package/src/study/MixerDebugger.ts +46 -46
- package/src/study/SessionDebugger.ts +20 -20
- package/src/study/SessionOverlay.ts +4 -4
- package/src/util/logger.ts +112 -13
- package/tests/core/navigators/eloGenerator.test.ts +36 -0
- package/tsup.config.ts +24 -21
- package/dist/SyncStrategy-BXliog1m.d.cts +0 -116
- package/dist/classroomDB-DLTtLZct.d.cts +0 -86
- package/dist/contentSource-JmWYu8IK.d.ts +0 -2007
- package/dist/core/index.d.cts +0 -521
- package/dist/core/index.js.map +0 -1
- package/dist/core/index.mjs.map +0 -1
- package/dist/dataLayerProvider-DfI_KYAe.d.cts +0 -61
- package/dist/diagnostics/index.d.cts +0 -458
- package/dist/diagnostics/index.js.map +0 -1
- package/dist/diagnostics/index.mjs.map +0 -1
- package/dist/impl/couch/index.d.cts +0 -620
- package/dist/impl/couch/index.js.map +0 -1
- package/dist/impl/static/index.d.cts +0 -232
- package/dist/impl/static/index.js.map +0 -1
- package/dist/impl/static/index.mjs.map +0 -1
- package/dist/index-Ktg72jKb.d.cts +0 -137
- package/dist/index.d.cts +0 -1663
- package/dist/index.js.map +0 -1
- package/dist/index.mjs.map +0 -1
- package/dist/pouch/index.d.cts +0 -1
- package/dist/pouch/index.js.map +0 -1
- package/dist/pouch/index.mjs.map +0 -1
- package/dist/types-D0oQeJAi.d.cts +0 -58
- package/dist/types-legacy-BkOYOR6U.d.ts +0 -168
- package/dist/util/packer/index.d.cts +0 -5
- package/dist/util/packer/index.js.map +0 -1
- package/dist/util/packer/index.mjs.map +0 -1
- package/src/study/getCardDataShape.ts +0 -34
|
@@ -170,15 +170,15 @@ const expanded: Record<string, boolean> = {
|
|
|
170
170
|
*/
|
|
171
171
|
export function toggleSessionOverlay(): void {
|
|
172
172
|
if (typeof document === 'undefined') {
|
|
173
|
-
logger.
|
|
173
|
+
logger.print('[Session Overlay] No DOM available (non-browser host); overlay unavailable.');
|
|
174
174
|
return;
|
|
175
175
|
}
|
|
176
176
|
if (overlayEl) {
|
|
177
177
|
teardown();
|
|
178
|
-
logger.
|
|
178
|
+
logger.print('[Session Overlay] Hidden.');
|
|
179
179
|
} else {
|
|
180
180
|
mount();
|
|
181
|
-
logger.
|
|
181
|
+
logger.print('[Session Overlay] Shown. Toggle off with window.skuilder.session.dbgOverlay().');
|
|
182
182
|
}
|
|
183
183
|
}
|
|
184
184
|
|
|
@@ -303,7 +303,7 @@ function copySnapshot(): void {
|
|
|
303
303
|
logger.warn(`[Session Overlay] Clipboard write failed: ${String(err)}`);
|
|
304
304
|
});
|
|
305
305
|
} else {
|
|
306
|
-
logger.
|
|
306
|
+
logger.print(`[Session Overlay] Clipboard unavailable; snapshot follows:\n${text}`);
|
|
307
307
|
}
|
|
308
308
|
}
|
|
309
309
|
|
package/src/util/logger.ts
CHANGED
|
@@ -1,18 +1,82 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Simple logging utility for @vue-skuilder/db package
|
|
3
3
|
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
4
|
+
* Level-gated logging with ESLint suppressions to resolve console statement
|
|
5
|
+
* violations while maintaining logging functionality.
|
|
6
|
+
*
|
|
7
|
+
* Level resolution:
|
|
8
|
+
* - Browser: `localStorage['sk.logLevel']`, else `warn`. Change it live (and
|
|
9
|
+
* persistently) with `window.skuilder.logLevel('info')`.
|
|
10
|
+
* - Node: `SK_LOG_LEVEL`, else `debug` when NODE_ENV=development, else `info`
|
|
11
|
+
* (CLI tools report progress through `info`).
|
|
6
12
|
*/
|
|
7
13
|
|
|
8
|
-
|
|
14
|
+
export type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'silent';
|
|
15
|
+
|
|
16
|
+
const LEVELS: Record<LogLevel, number> = { debug: 0, info: 1, warn: 2, error: 3, silent: 4 };
|
|
17
|
+
const STORAGE_KEY = 'sk.logLevel';
|
|
18
|
+
|
|
19
|
+
const isBrowser = typeof window !== 'undefined';
|
|
20
|
+
|
|
21
|
+
function isLevel(v: unknown): v is LogLevel {
|
|
22
|
+
return typeof v === 'string' && v in LEVELS;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
function initialLevel(): LogLevel {
|
|
26
|
+
if (isBrowser) {
|
|
27
|
+
try {
|
|
28
|
+
const stored = window.localStorage?.getItem(STORAGE_KEY);
|
|
29
|
+
if (isLevel(stored)) return stored;
|
|
30
|
+
} catch {
|
|
31
|
+
// storage blocked (private mode, sandboxed iframe) - fall through
|
|
32
|
+
}
|
|
33
|
+
return 'warn';
|
|
34
|
+
}
|
|
35
|
+
if (typeof process !== 'undefined') {
|
|
36
|
+
const env = process.env.SK_LOG_LEVEL;
|
|
37
|
+
if (isLevel(env)) return env;
|
|
38
|
+
if (process.env.NODE_ENV === 'development') return 'debug';
|
|
39
|
+
}
|
|
40
|
+
return 'info';
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
// tsup builds each db entry point without code splitting, so a consumer can
|
|
44
|
+
// hold several copies of this module. Keep the level on a shared global so
|
|
45
|
+
// `window.skuilder.logLevel(...)` reaches all of them.
|
|
46
|
+
const shared: { level: LogLevel } = ((globalThis as any).__skuilderDbLog ??= {
|
|
47
|
+
level: initialLevel(),
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
export function getLogLevel(): LogLevel {
|
|
51
|
+
return shared.level;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Set the active log level. In the browser this persists across reloads
|
|
56
|
+
* unless `persist` is false.
|
|
57
|
+
*/
|
|
58
|
+
export function setLogLevel(level: LogLevel, persist = true): void {
|
|
59
|
+
if (!isLevel(level)) {
|
|
60
|
+
// eslint-disable-next-line no-console
|
|
61
|
+
console.warn(`[DB] Unknown log level '${level}'. Use one of: ${Object.keys(LEVELS).join(', ')}`);
|
|
62
|
+
return;
|
|
63
|
+
}
|
|
64
|
+
shared.level = level;
|
|
65
|
+
if (isBrowser && persist) {
|
|
66
|
+
try {
|
|
67
|
+
window.localStorage?.setItem(STORAGE_KEY, level);
|
|
68
|
+
} catch {
|
|
69
|
+
// storage blocked - level still applies for this page load
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
}
|
|
9
73
|
|
|
10
74
|
export const logger = {
|
|
11
75
|
/**
|
|
12
|
-
* Debug-level logging
|
|
76
|
+
* Debug-level logging
|
|
13
77
|
*/
|
|
14
78
|
debug: (message: string, ...args: any[]): void => {
|
|
15
|
-
if (
|
|
79
|
+
if (LEVELS[shared.level] <= LEVELS.debug) {
|
|
16
80
|
// eslint-disable-next-line no-console
|
|
17
81
|
console.debug(`[DB:DEBUG] ${message}`, ...args);
|
|
18
82
|
}
|
|
@@ -22,33 +86,68 @@ export const logger = {
|
|
|
22
86
|
* Info-level logging - general information
|
|
23
87
|
*/
|
|
24
88
|
info: (message: string, ...args: any[]): void => {
|
|
25
|
-
|
|
26
|
-
|
|
89
|
+
if (LEVELS[shared.level] <= LEVELS.info) {
|
|
90
|
+
// eslint-disable-next-line no-console
|
|
91
|
+
console.info(`[DB:INFO] ${message}`, ...args);
|
|
92
|
+
}
|
|
27
93
|
},
|
|
28
94
|
|
|
29
95
|
/**
|
|
30
96
|
* Warning-level logging - potential issues
|
|
31
97
|
*/
|
|
32
98
|
warn: (message: string, ...args: any[]): void => {
|
|
33
|
-
|
|
34
|
-
|
|
99
|
+
if (LEVELS[shared.level] <= LEVELS.warn) {
|
|
100
|
+
// eslint-disable-next-line no-console
|
|
101
|
+
console.warn(`[DB:WARN] ${message}`, ...args);
|
|
102
|
+
}
|
|
35
103
|
},
|
|
36
104
|
|
|
37
105
|
/**
|
|
38
106
|
* Error-level logging - serious problems
|
|
39
107
|
*/
|
|
40
108
|
error: (message: string, ...args: any[]): void => {
|
|
41
|
-
|
|
42
|
-
|
|
109
|
+
if (LEVELS[shared.level] <= LEVELS.error) {
|
|
110
|
+
// eslint-disable-next-line no-console
|
|
111
|
+
console.error(`[DB:ERROR] ${message}`, ...args);
|
|
112
|
+
}
|
|
43
113
|
},
|
|
44
114
|
|
|
45
115
|
/**
|
|
46
|
-
* Log function for backward compatibility with existing log() usage
|
|
116
|
+
* Log function for backward compatibility with existing log() usage.
|
|
117
|
+
* Debug level.
|
|
47
118
|
*/
|
|
48
119
|
log: (message: string, ...args: any[]): void => {
|
|
49
|
-
if (
|
|
120
|
+
if (LEVELS[shared.level] <= LEVELS.debug) {
|
|
50
121
|
// eslint-disable-next-line no-console
|
|
51
122
|
console.log(`[DB:LOG] ${message}`, ...args);
|
|
52
123
|
}
|
|
53
124
|
},
|
|
125
|
+
|
|
126
|
+
/**
|
|
127
|
+
* Ungated output for interactive console tools (`window.skuilder.*`). The
|
|
128
|
+
* user asked for it, so it prints regardless of level.
|
|
129
|
+
*/
|
|
130
|
+
print: (message: string, ...args: any[]): void => {
|
|
131
|
+
// eslint-disable-next-line no-console
|
|
132
|
+
console.log(message, ...args);
|
|
133
|
+
},
|
|
54
134
|
};
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* Mount the level control on window.skuilder.logLevel
|
|
138
|
+
*
|
|
139
|
+
* window.skuilder.logLevel() // current level
|
|
140
|
+
* window.skuilder.logLevel('info') // set + persist
|
|
141
|
+
*/
|
|
142
|
+
export function mountLogLevelControl(): void {
|
|
143
|
+
if (!isBrowser) return;
|
|
144
|
+
|
|
145
|
+
const win = window as any;
|
|
146
|
+
win.skuilder = win.skuilder || {};
|
|
147
|
+
win.skuilder.logLevel = (level?: LogLevel): LogLevel => {
|
|
148
|
+
if (level !== undefined) setLogLevel(level);
|
|
149
|
+
return getLogLevel();
|
|
150
|
+
};
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
mountLogLevelControl();
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { describe, it, expect, vi } from 'vitest';
|
|
2
|
+
import ELONavigator from '../../../src/core/navigators/generators/elo';
|
|
3
|
+
import type { CourseDBInterface } from '../../../src/core/interfaces/courseDB';
|
|
4
|
+
import type { UserDBInterface } from '../../../src/core/interfaces/userDB';
|
|
5
|
+
|
|
6
|
+
// The generator's retrieval window must be centred on the ELO of the user it
|
|
7
|
+
// runs for, passed explicitly, never resolved by the course DB from its own
|
|
8
|
+
// notion of the current user (`elo: 'user'`).
|
|
9
|
+
|
|
10
|
+
function setup() {
|
|
11
|
+
const getCardsCenteredAtELO = vi.fn().mockResolvedValue([]);
|
|
12
|
+
const course = {
|
|
13
|
+
getCourseID: () => 'c1',
|
|
14
|
+
getCardsCenteredAtELO,
|
|
15
|
+
} as unknown as CourseDBInterface;
|
|
16
|
+
const user = {
|
|
17
|
+
getCourseRegDoc: vi.fn().mockResolvedValue({ courseID: 'c1', elo: 1234 }),
|
|
18
|
+
getActiveCards: vi.fn().mockResolvedValue([]),
|
|
19
|
+
getSeenCards: vi.fn().mockResolvedValue([]),
|
|
20
|
+
} as unknown as UserDBInterface;
|
|
21
|
+
return { gen: new ELONavigator(user, course), getCardsCenteredAtELO };
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
describe('ELONavigator retrieval', () => {
|
|
25
|
+
it("centres on the pipeline context's user ELO", async () => {
|
|
26
|
+
const { gen, getCardsCenteredAtELO } = setup();
|
|
27
|
+
await gen.getWeightedCards(5, { userElo: 987 } as never);
|
|
28
|
+
expect(getCardsCenteredAtELO.mock.calls[0][0]).toEqual({ limit: 5, elo: 987 });
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
it("falls back to its own user's registration, not the course DB's current user", async () => {
|
|
32
|
+
const { gen, getCardsCenteredAtELO } = setup();
|
|
33
|
+
await gen.getWeightedCards(5);
|
|
34
|
+
expect(getCardsCenteredAtELO.mock.calls[0][0]).toEqual({ limit: 5, elo: 1234 });
|
|
35
|
+
});
|
|
36
|
+
});
|
package/tsup.config.ts
CHANGED
|
@@ -1,26 +1,29 @@
|
|
|
1
|
+
// The CommonJS bundle (Node and tests) and the types. The ESM build, one file
|
|
2
|
+
// per module, is rolldown.config.mjs.
|
|
3
|
+
//
|
|
4
|
+
// No `clean`: the two configs run in parallel, and rolldown writes into the
|
|
5
|
+
// same dist. The build script empties dist first.
|
|
1
6
|
import { readFileSync } from 'node:fs';
|
|
2
7
|
import { defineConfig } from 'tsup';
|
|
8
|
+
import { entries } from './build.entries.mjs';
|
|
3
9
|
|
|
4
10
|
const { version } = JSON.parse(readFileSync(new URL('./package.json', import.meta.url), 'utf-8'));
|
|
5
11
|
|
|
6
|
-
export default defineConfig(
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
'
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
js: format === 'esm' ? '.mjs' : '.js',
|
|
25
|
-
}),
|
|
26
|
-
});
|
|
12
|
+
export default defineConfig([
|
|
13
|
+
{
|
|
14
|
+
entry: entries,
|
|
15
|
+
format: ['cjs'],
|
|
16
|
+
dts: false,
|
|
17
|
+
splitting: false,
|
|
18
|
+
sourcemap: true,
|
|
19
|
+
// Session records stamp the framework version (core/versionStamps.ts).
|
|
20
|
+
define: { __SKUILDER_DB_VERSION__: JSON.stringify(version) },
|
|
21
|
+
outExtension: () => ({ js: '.cjs' }),
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
// ESM-flavoured .d.ts, for both conditions (as before).
|
|
25
|
+
entry: entries,
|
|
26
|
+
format: ['esm'],
|
|
27
|
+
dts: { only: true },
|
|
28
|
+
},
|
|
29
|
+
]);
|
|
@@ -1,116 +0,0 @@
|
|
|
1
|
-
import { Status } from '@vue-skuilder/common';
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* Common types used by UserDB implementations across different sync strategies
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
/**
|
|
8
|
-
* Result type for account creation operations
|
|
9
|
-
*/
|
|
10
|
-
interface AccountCreationResult {
|
|
11
|
-
status: Status;
|
|
12
|
-
error?: string;
|
|
13
|
-
}
|
|
14
|
-
/**
|
|
15
|
-
* Result type for authentication operations
|
|
16
|
-
*/
|
|
17
|
-
interface AuthenticationResult {
|
|
18
|
-
ok: boolean;
|
|
19
|
-
error?: string;
|
|
20
|
-
}
|
|
21
|
-
interface AdoptSessionResult extends AuthenticationResult {
|
|
22
|
-
/** The adopted session's user, when ok. */
|
|
23
|
-
username?: string;
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* Strategy interface for handling user data synchronization
|
|
28
|
-
* Different implementations handle remote sync vs local-only storage
|
|
29
|
-
*/
|
|
30
|
-
interface SyncStrategy {
|
|
31
|
-
/**
|
|
32
|
-
* Set up the remote database for a user
|
|
33
|
-
* @param username The username to set up remote DB for
|
|
34
|
-
* @returns PouchDB database instance (may be same as local for no-op)
|
|
35
|
-
*/
|
|
36
|
-
setupRemoteDB(username: string): PouchDB.Database;
|
|
37
|
-
/**
|
|
38
|
-
* Get the database to use for write operations (local-first approach)
|
|
39
|
-
* @param username The username to get write DB for
|
|
40
|
-
* @returns PouchDB database instance for write operations
|
|
41
|
-
*/
|
|
42
|
-
getWriteDB?(username: string): PouchDB.Database;
|
|
43
|
-
/**
|
|
44
|
-
* Pull the remote database into the local one and RESOLVE WHEN DONE.
|
|
45
|
-
*
|
|
46
|
-
* Distinct from startSync(): this is a one-shot, awaitable catch-up used to
|
|
47
|
-
* populate an empty local mirror before the user object is handed out. A
|
|
48
|
-
* strategy that omits it declares that it has no remote worth waiting for.
|
|
49
|
-
*
|
|
50
|
-
* Mechanism only — BaseUser owns the policy (whether to run it, timeout,
|
|
51
|
-
* marker bookkeeping, resulting hydration state).
|
|
52
|
-
*
|
|
53
|
-
* @param localDB The local PouchDB instance
|
|
54
|
-
* @param remoteDB The remote PouchDB instance
|
|
55
|
-
* @returns Count of documents written locally, and — only when the pull is
|
|
56
|
-
* known to have landed the remote's complete current state — the sequence
|
|
57
|
-
* it corresponds to, for startSync() to resume from. Omitted means "no
|
|
58
|
-
* safe shortcut, walk from the checkpoint".
|
|
59
|
-
*/
|
|
60
|
-
hydrate?(localDB: PouchDB.Database, remoteDB: PouchDB.Database): Promise<{
|
|
61
|
-
docsWritten: number;
|
|
62
|
-
lastSeq?: string | number;
|
|
63
|
-
}>;
|
|
64
|
-
/**
|
|
65
|
-
* Start synchronization between local and remote databases
|
|
66
|
-
* @param localDB The local PouchDB instance
|
|
67
|
-
* @param remoteDB The remote PouchDB instance
|
|
68
|
-
* @param since Sequence to start the pull from, as returned by a hydrate()
|
|
69
|
-
* in the same session. Omit to resume from the stored checkpoint.
|
|
70
|
-
*/
|
|
71
|
-
startSync(localDB: PouchDB.Database, remoteDB: PouchDB.Database, since?: string | number): void;
|
|
72
|
-
/**
|
|
73
|
-
* Stop synchronization (optional - for cleanup)
|
|
74
|
-
*/
|
|
75
|
-
stopSync?(): void;
|
|
76
|
-
/**
|
|
77
|
-
* Whether this strategy supports account creation
|
|
78
|
-
*/
|
|
79
|
-
canCreateAccount(): boolean;
|
|
80
|
-
/**
|
|
81
|
-
* Whether this strategy supports authentication
|
|
82
|
-
*/
|
|
83
|
-
canAuthenticate(): boolean;
|
|
84
|
-
/**
|
|
85
|
-
* Create a new user account (if supported)
|
|
86
|
-
* @param username The username for the new account
|
|
87
|
-
* @param password The password for the new account
|
|
88
|
-
*/
|
|
89
|
-
createAccount?(username: string, password: string): Promise<AccountCreationResult>;
|
|
90
|
-
/**
|
|
91
|
-
* Authenticate a user (if supported)
|
|
92
|
-
* @param username The username to authenticate
|
|
93
|
-
* @param password The password to authenticate with
|
|
94
|
-
*/
|
|
95
|
-
authenticate?(username: string, password: string): Promise<AuthenticationResult>;
|
|
96
|
-
/**
|
|
97
|
-
* Log out the current user (if supported)
|
|
98
|
-
*/
|
|
99
|
-
logout?(): Promise<AuthenticationResult>;
|
|
100
|
-
/**
|
|
101
|
-
* Adopt a remote session established outside this client (e.g. a server that
|
|
102
|
-
* verified a third-party sign-in and set the session cookie), optionally
|
|
103
|
-
* migrating a guest account's local data into it (if supported).
|
|
104
|
-
* @param migrateFromGuest Guest username whose local data should be carried
|
|
105
|
-
* over. The caller must capture it BEFORE the session switched, since the
|
|
106
|
-
* remote now reports the adopted user.
|
|
107
|
-
*/
|
|
108
|
-
adoptSession?(migrateFromGuest?: string): Promise<AdoptSessionResult>;
|
|
109
|
-
/**
|
|
110
|
-
* Get the current logged-in username
|
|
111
|
-
* Returns the username if logged in, or a default guest username
|
|
112
|
-
*/
|
|
113
|
-
getCurrentUsername(): Promise<string>;
|
|
114
|
-
}
|
|
115
|
-
|
|
116
|
-
export type { AccountCreationResult as A, SyncStrategy as S, AuthenticationResult as a, AdoptSessionResult as b };
|
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
import { CourseConfig, ClassroomConfig } from '@vue-skuilder/common';
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* Admin functionality
|
|
5
|
-
*/
|
|
6
|
-
interface AdminDBInterface {
|
|
7
|
-
/**
|
|
8
|
-
* Get all users
|
|
9
|
-
*/
|
|
10
|
-
getUsers(): Promise<PouchDB.Core.Document<{}>[]>;
|
|
11
|
-
/**
|
|
12
|
-
* Get all courses
|
|
13
|
-
*/
|
|
14
|
-
getCourses(): Promise<CourseConfig[]>;
|
|
15
|
-
/**
|
|
16
|
-
* Remove a course
|
|
17
|
-
*/
|
|
18
|
-
removeCourse(id: string): Promise<PouchDB.Core.Response>;
|
|
19
|
-
/**
|
|
20
|
-
* Get all classrooms
|
|
21
|
-
*/
|
|
22
|
-
getClassrooms(): Promise<(ClassroomConfig & {
|
|
23
|
-
_id: string;
|
|
24
|
-
})[]>;
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
/**
|
|
28
|
-
* Classroom management
|
|
29
|
-
*/
|
|
30
|
-
interface ClassroomDBInterface {
|
|
31
|
-
/**
|
|
32
|
-
* Get classroom config
|
|
33
|
-
*/
|
|
34
|
-
getConfig(): ClassroomConfig;
|
|
35
|
-
/**
|
|
36
|
-
* Get assigned content
|
|
37
|
-
*/
|
|
38
|
-
getAssignedContent(): Promise<AssignedContent[]>;
|
|
39
|
-
}
|
|
40
|
-
interface TeacherClassroomDBInterface extends ClassroomDBInterface {
|
|
41
|
-
/**
|
|
42
|
-
* For teacher interfaces: assign content
|
|
43
|
-
*/
|
|
44
|
-
assignContent?(content: AssignedContent): Promise<boolean>;
|
|
45
|
-
/**
|
|
46
|
-
* For teacher interfaces: remove content
|
|
47
|
-
*/
|
|
48
|
-
removeContent?(content: AssignedContent): Promise<void>;
|
|
49
|
-
}
|
|
50
|
-
/**
|
|
51
|
-
* Student-facing classroom interface.
|
|
52
|
-
* Content is accessed via StudyContentSource.getWeightedCards().
|
|
53
|
-
*/
|
|
54
|
-
type StudentClassroomDBInterface = ClassroomDBInterface;
|
|
55
|
-
type AssignedContent = AssignedCourse | AssignedTag | AssignedCard;
|
|
56
|
-
interface AssignedTag extends ContentBase {
|
|
57
|
-
type: 'tag';
|
|
58
|
-
tagID: string;
|
|
59
|
-
}
|
|
60
|
-
interface AssignedCourse extends ContentBase {
|
|
61
|
-
type: 'course';
|
|
62
|
-
}
|
|
63
|
-
interface AssignedCard extends ContentBase {
|
|
64
|
-
type: 'card';
|
|
65
|
-
cardID: string;
|
|
66
|
-
}
|
|
67
|
-
interface ContentBase {
|
|
68
|
-
type: 'course' | 'tag' | 'card';
|
|
69
|
-
/**
|
|
70
|
-
* Username of the assigning teacher.
|
|
71
|
-
*/
|
|
72
|
-
assignedBy: string;
|
|
73
|
-
/**
|
|
74
|
-
* Date the content was assigned.
|
|
75
|
-
*/
|
|
76
|
-
assignedOn: moment.Moment;
|
|
77
|
-
/**
|
|
78
|
-
* A 'due' date for this assigned content, for scheduling content
|
|
79
|
-
* in advance. Content will not be actively pushed to students until
|
|
80
|
-
* this date.
|
|
81
|
-
*/
|
|
82
|
-
activeOn: moment.Moment;
|
|
83
|
-
courseID: string;
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
export type { AdminDBInterface as A, ClassroomDBInterface as C, StudentClassroomDBInterface as S, TeacherClassroomDBInterface as T, AssignedContent as a, AssignedTag as b, AssignedCourse as c, AssignedCard as d };
|