asaihost-nodejs 0.0.1 → 0.0.3

package/dist/asaihost-nodejs.d.ts

@@ -40,7 +40,135 @@ declare const _default$1: {
     };
 };
 
-declare const _default: ($asai: any) => void;
+/** 字段名：数组或逗号分隔字符串 */
+type Istrings = string[] | string;
+/** 插入值：多行二维数组或原始 SQL 片段 */
+type IValues = unknown[][] | string;
+/** 更新赋值：[字段, 值] 或 [字段, 运算符, 值] */
+type ISets = ([string, unknown] | [string, string, unknown] | string)[] | string;
+/** WHERE 条件：逻辑符 or/and 与三元组 [字段, 运算符, 值] 混排 */
+type IWheres = ([string, string, unknown] | string)[] | string;
+/** ORDER BY：[字段, asc|desc] 数组 */
+type IOrders = [string, 'asc' | 'desc' | 'ASC' | 'DESC'][] | string;
+/** 统一 SQL 风格操作数据结构 */
+interface Idb {
+    /** 操作类型：select | insert | update | delete | re（file 恢复） */
+    type: string;
+    /** 表名；file 类型为相对目录名 */
+    table: string;
+    /** 字段列表，如 ['id', 'name'] */
+    field?: Istrings;
+    /** 插入行数据，如 [['a', 1], ['b', 2]] */
+    value?: IValues;
+    /** 更新赋值，如 [['name', 'Tom']] */
+    set?: ISets;
+    /** 过滤条件，如 ['and', ['age', '>', 18]] */
+    where?: IWheres;
+    /** 排序，如 [['id', 'desc']] */
+    order?: IOrders;
+    /** 限制返回行数 */
+    limit?: number;
+    /** file：列表模式，返回 { open, delete } */
+    list?: number;
+    /** file：1 表示物理删除（软删除模式下） */
+    deltrue?: unknown;
+    /** file：子文件名（目录模式） */
+    filename?: string;
+    /** file：1=解析 JSON 单文件；2=目录 JSON 聚合查询 */
+    as?: number;
+}
+
+/** 统一对外接口（各驱动至少实现 sqlDb） */
+interface DbInstance {
+    sqlDb(sql: Idb): Promise<unknown>;
+}
+/** 支持回调查询的驱动接口 */
+interface QueryableDb extends DbInstance {
+    query(sql: Idb, callback: (err: string | null, result: unknown) => void): void;
+}
+/** 将 query 回调风格封装为 Promise，并统一空结果处理 */
+declare function promisifySqlDb(query: QueryableDb['query'], sql: Idb): Promise<unknown>;
+/** 将 Idb.field 规范为字符串数组 */
+declare function toFieldArray(field: Idb['field']): string[];
+/** 将 Idb.where 规范为 Excel 等值条件 [字段, 值][] */
+declare function toWherePairs(where: Idb['where']): [string, unknown][];
+/** 将 Idb.set 规范为键值对象 */
+declare function toSetObject(set: Idb['set']): Record<string, unknown>;
+/** 将 Idb.value 与 field 组合为插入行对象数组 */
+declare function toInsertRows(sql: Idb): Record<string, unknown>[];
+/**
+ * 判断目标路径是否在基准目录内（跨平台：Win/Linux/macOS）
+ * 使用 path.resolve + path.relative，兼容正反斜杠与不同盘符
+ */
+declare function isPathInside(baseDir: string, targetPath: string): boolean;
+/**
+ * 拼接 table 相对路径（始终使用 /，与 API 路由约定一致）
+ * path.resolve 在 Win/Linux/macOS 上均支持正斜杠
+ */
+declare function joinTablePath(table: string, ...segments: string[]): string;
+/** 判断 field 定义中是否已包含 id 列（兼容字符串 includes 语义） */
+declare function fieldHasId(field: Idb['field']): boolean;
+/** 判断错误是否为「表不存在」类错误 */
+declare function isTableMissingError(err: {
+    code?: string;
+    message?: string;
+} | null | undefined): boolean;
+
+type DbCommon_DbInstance = DbInstance;
+type DbCommon_QueryableDb = QueryableDb;
+declare const DbCommon_fieldHasId: typeof fieldHasId;
+declare const DbCommon_isPathInside: typeof isPathInside;
+declare const DbCommon_isTableMissingError: typeof isTableMissingError;
+declare const DbCommon_joinTablePath: typeof joinTablePath;
+declare const DbCommon_promisifySqlDb: typeof promisifySqlDb;
+declare const DbCommon_toFieldArray: typeof toFieldArray;
+declare const DbCommon_toInsertRows: typeof toInsertRows;
+declare const DbCommon_toSetObject: typeof toSetObject;
+declare const DbCommon_toWherePairs: typeof toWherePairs;
+declare namespace DbCommon {
+  export { type DbCommon_DbInstance as DbInstance, type DbCommon_QueryableDb as QueryableDb, DbCommon_fieldHasId as fieldHasId, DbCommon_isPathInside as isPathInside, DbCommon_isTableMissingError as isTableMissingError, DbCommon_joinTablePath as joinTablePath, DbCommon_promisifySqlDb as promisifySqlDb, DbCommon_toFieldArray as toFieldArray, DbCommon_toInsertRows as toInsertRows, DbCommon_toSetObject as toSetObject, DbCommon_toWherePairs as toWherePairs };
+}
+
+type JoinType = 'where' | 'order' | 'value' | 'set' | 'field';
+declare const _default: {
+    /**
+     * 将 Idb 中的指定片段转为 SQL 字符串片段
+     */
+    joinSql(sql: Idb, type: JoinType): string;
+    /**
+     * 将完整 Idb 对象转换为可执行 SQL 字符串
+     * 注意：值为字符串拼接，调用方需确保输入可信或自行转义
+     */
+    makeSql(sql: Idb): string;
+    /**
+     * 生成建表 SQL（自动补 id 主键与 asdate 时间戳列）
+     */
+    createSql(sql: Idb, dialect?: "mysql" | "sqlite" | string): string;
+};
+
+/** 传给各 db 驱动插件的共享依赖（sqlite/mysql 插件 factory 入参） */
+interface DbDriverContext {
+    IdbType: Idb;
+    Sql: typeof _default;
+    DbCommon: typeof DbCommon;
+}
+type DbDriverCtor = new (config: any) => DbInstance;
+type DbDriverFactory = (ctx: DbDriverContext) => DbDriverCtor;
+type DbDriversMap = Partial<Record<string, DbDriverFactory>>;
+
+/**
+ * 统一数据存储注册表 — file / sqlite / mysql 自由切换，全库数据读写经此入口
+ */
+
+type StoreDomain = 'user' | 'log' | (string & {});
+
+interface SysserverBootOptions {
+    /** 外部 db 驱动插件，键名与 dataStores.type 一致（sqlite / mysql …） */
+    db?: DbDriversMap;
+    [key: string]: unknown;
+}
+type SysserverFn = ($asai: unknown, opt?: SysserverBootOptions) => void;
+declare function sysserver($asai: any, opt?: SysserverBootOptions): void;
 
 /** 启动前归一化 host 配置 */
 declare function normalizeHostConfig(cfg: Record<string, any>): Record<string, any>;
@@ -300,7 +428,7 @@ interface LoggerConfig {
 }
 type WorkHandler = (req: unknown, res: unknown, hostdir: string) => void;
 type WsWorkHandler = (msg: unknown, ws: unknown, hostdir: string, req: unknown) => void;
-interface AsaiHostOptions {
+interface AsaiHostNodejsOptions {
     sysWork: WorkHandler;
     apiWork: WorkHandler;
     wsWork: WsWorkHandler;
@@ -341,20 +469,35 @@ interface AsaiRuntime {
 }
 /** npm 包标识（与 package.json name 一致） */
 declare const PLUGIN_NAME: "asaihost-nodejs";
+
 /** `fn($asai, opt)` 返回值：启动函数 + ws 模块引用 */
 interface HostBootResult {
-    StartAsaiHost: () => void;
+    StartAsaiHostNodejs: () => void;
     asaiWs: typeof ws;
 }
-/** 宿主插件对外 API 形状（具体方法签名见默认导出推断类型 AsaiNodejsHostPlugin） */
-interface AsaiNodejsHostPlugin {
+/** wsMock($asai) 返回值 — 供 asaimock 挂载与 WS 开发回包 */
+interface WsMockToolkit {
+    getKeyByData: (reqdata: unknown, hostdir?: string) => string;
+    wsWorkApi: (workopt: unknown) => void;
+    wsWorkMock: (workopt: unknown) => void;
+    wsWorkListen: (workopt: unknown, reqkey: unknown) => void;
+    getMockDb: (workopt: unknown) => Record<string, unknown>;
+}
+/** AsaiUtils 命名空间（见 src/utils/index.ts） */
+interface AsaiUtilsModule {
+    deUserInfoWithAsai: (userinfo: string[] | null | undefined, $asai: AsaiRuntime) => string[] | null;
+    wsMock: ($asai: AsaiRuntime) => WsMockToolkit;
+}
+/** 宿主插件核心 API（其余 host-api 方法通过交叉类型扩展） */
+interface AsaiNodejsHostPluginBase {
     readonly name: typeof PLUGIN_NAME;
-    fn: (runtime: AsaiRuntime, options: AsaiHostOptions) => HostBootResult;
-    sysserver: (runtime: AsaiRuntime) => void;
+    fn: (runtime: AsaiRuntime, options: AsaiHostNodejsOptions) => HostBootResult;
+    sysserver: (runtime: AsaiRuntime, opt?: SysserverBootOptions) => void;
     AsaiCommon: Record<string, unknown>;
-    AsaiUtils: Record<string, unknown>;
-    [key: string]: unknown;
+    AsaiUtils: AsaiUtilsModule;
 }
+/** 宿主插件对外 API 形状（含 normalizeHostConfig 等扩展方法） */
+type AsaiNodejsHostPlugin = AsaiNodejsHostPluginBase & Record<string, unknown>;
 
 declare function secureCompare(a: unknown, b: unknown): boolean;
 
@@ -392,15 +535,9 @@ interface AuthCheckResult {
 /** 校验 Userinfo 头（us##lv##tk），仅在 requireAuth=1 时由路由层调用 */
 declare function validateHttpAuth(req: any, $asai: any, pathname: string): AuthCheckResult;
 
-/**
- * 统一数据存储注册表 — file / sqlite / mysql 自由切换，全库数据读写经此入口
- */
-
-type StoreDomain = 'user' | 'log' | (string & {});
-
-declare const initAsaiHost: AsaiNodejsHostPlugin;
+declare const initAsaiHostNodejs: AsaiNodejsHostPlugin;
 
 /** 构建时注入的版本号（与 package.json version 同步） */
 declare const PLUGIN_VERSION: string;
 
-export { _default$1 as AsaiCommon, type AsaiHostOptions, type AsaiNodejsHostPlugin, type AsaiRuntime, type AsaiSecrets, index as AsaiUtils, type AuthCheckResult, type HostBootResult, type HostConfig, type HostSiteConfig, type LoggerConfig, PLUGIN_NAME, PLUGIN_VERSION, type ProxySiteConfig, type ReconnectOptions, type RouteFactory, type SecurityAuditEvent, type SecurityConfig, type SecurityEventType, type StoreDomain, type TransportKind, type WorkHandler, type WsWorkHandler, applySecretsToHostConfig, createTransportDataHandler, initAsaiHost as default, ensureDefaultConnection, getDefaultConnId, getHostAllowedRoots, getTransportBlock, getTransportDefault, hasTransportDefault, initAsaiHost, initHostserverApi, initHostserverWs, initTransportBridge, isDevDefaultPassword, loadAsaiSecrets, loadDotEnvFile, logSecurityEvent, normalizeHostConfig, normalizeSecurityConfig, registerApi, registerWs, resolveHttpsCertFromPaths, resolvePathUnderRoots, resolveReconnectOptions, sanitizeString, secureCompare, shouldAutoConnect, stripForbiddenSecretsFromHostConfig, syncApiRouteKeys, syncWsRouteKeys, _default as sysserver, validateAsaiSecrets, validateHostConfig, validateHttpAuth, validateProductionSecurity, wireTransportConnectionLogs };
+export { _default$1 as AsaiCommon, type AsaiHostNodejsOptions, type AsaiNodejsHostPlugin, type AsaiNodejsHostPluginBase, type AsaiRuntime, type AsaiSecrets, index as AsaiUtils, type AuthCheckResult, type HostBootResult, type HostConfig, type HostSiteConfig, type LoggerConfig, PLUGIN_NAME, PLUGIN_VERSION, type ProxySiteConfig, type ReconnectOptions, type RouteFactory, type SecurityAuditEvent, type SecurityConfig, type SecurityEventType, type StoreDomain, type SysserverBootOptions, type SysserverFn, type TransportKind, type WorkHandler, type WsWorkHandler, applySecretsToHostConfig, createTransportDataHandler, initAsaiHostNodejs as default, ensureDefaultConnection, getDefaultConnId, getHostAllowedRoots, getTransportBlock, getTransportDefault, hasTransportDefault, initAsaiHostNodejs, initHostserverApi, initHostserverWs, initTransportBridge, isDevDefaultPassword, loadAsaiSecrets, loadDotEnvFile, logSecurityEvent, normalizeHostConfig, normalizeSecurityConfig, registerApi, registerWs, resolveHttpsCertFromPaths, resolvePathUnderRoots, resolveReconnectOptions, sanitizeString, secureCompare, shouldAutoConnect, stripForbiddenSecretsFromHostConfig, syncApiRouteKeys, syncWsRouteKeys, sysserver, validateAsaiSecrets, validateHostConfig, validateHttpAuth, validateProductionSecurity, wireTransportConnectionLogs };