mirror of
https://github.com/tiennm99/miti99bot.git
synced 2026-04-17 13:21:31 +00:00
tiennm99
83c6892d6e
- SqlStore interface + CF D1 wrapper + per-module factory (table prefix convention)
- init signature extended to ({ db, sql, env }); sql is null when DB binding absent
- custom migration runner walks src/modules/*/migrations/*.sql, tracks applied in _migrations table
- npm run db:migrate with --dry-run and --local flags; chained into deploy
- fake-d1 test helper with subset of SQL semantics for retention and history tests
45 lines
1.7 KiB
JavaScript
45 lines
1.7 KiB
JavaScript
/**
|
|
* @file KVStore interface — JSDoc typedefs only, no runtime code.
|
|
*
|
|
* This is the contract every storage backend must satisfy. modules receive
|
|
* a prefixed `KVStore` (via {@link module:db/create-store}) and must NEVER
|
|
* touch the underlying binding. to swap Cloudflare KV for a different
|
|
* backend (D1, Upstash Redis, ...) in the future, implement this interface
|
|
* in a new file and change the one import in create-store.js — no module
|
|
* code changes required.
|
|
*/
|
|
|
|
/**
|
|
* @typedef {object} KVStorePutOptions
|
|
* @property {number} [expirationTtl] seconds — value auto-deletes after this many seconds.
|
|
*/
|
|
|
|
/**
|
|
* @typedef {object} KVStoreListOptions
|
|
* @property {string} [prefix] additional prefix (appended AFTER the module namespace).
|
|
* @property {number} [limit]
|
|
* @property {string} [cursor] pagination cursor from a previous list() call.
|
|
*/
|
|
|
|
/**
|
|
* @typedef {object} KVStoreListResult
|
|
* @property {string[]} keys — module namespace already stripped.
|
|
* @property {string} [cursor] — present if more pages available.
|
|
* @property {boolean} done — true when list_complete.
|
|
*/
|
|
|
|
/**
|
|
* @typedef {object} KVStore
|
|
* @property {(key: string) => Promise<string|null>} get
|
|
* @property {(key: string, value: string, opts?: KVStorePutOptions) => Promise<void>} put
|
|
* @property {(key: string) => Promise<void>} delete
|
|
* @property {(opts?: KVStoreListOptions) => Promise<KVStoreListResult>} list
|
|
* @property {(key: string) => Promise<any|null>} getJSON
|
|
* returns null on missing key OR malformed JSON (logs a warning — does not throw).
|
|
* @property {(key: string, value: any, opts?: KVStorePutOptions) => Promise<void>} putJSON
|
|
* throws if value is undefined or contains a cycle.
|
|
*/
|
|
|
|
// JSDoc-only module. No runtime exports.
|
|
export {};
|