evaengine 1.0.13 → 2.0.0

package/dist/utils/pagination.js

@@ -0,0 +1,242 @@
+import snakeCase from 'lodash/snakeCase.js';
+import transform from 'lodash/transform.js';
+import nodePath from 'path';
+const toUrl = (scheme, host, path, query = {}) => {
+    let queryString = Object.keys(query)
+        .map(key => `${key}=${query[key]}`)
+        .join('&');
+    queryString = queryString === '' ? '' : `?${queryString}`;
+    return `${scheme}://${host}${path}${queryString}`;
+};
+const toPaginationUrl = (query, req) => {
+    // 与原实现一致：host 缺失时由 split 直接抛 TypeError
+    const hostInfo = req.get('host').split(':');
+    let scheme = req.protocol;
+    let host = hostInfo[0];
+    let port = hostInfo[1];
+    if (!port) {
+        port = req.protocol === 'https' ? 443 : 80;
+    }
+    let requestPath = req.baseUrl;
+    if (req.get('x-forwarded-port')) {
+        port = req.get('x-forwarded-port');
+    }
+    if (req.get('x-forwarded-host')) {
+        host = req.get('x-forwarded-host');
+    }
+    if (req.get('x-forwarded-proto')) {
+        scheme = req.get('x-forwarded-proto');
+    }
+    if (req.get('x-forwarded-prefix')) {
+        requestPath = nodePath.join(req.get('x-forwarded-prefix'), requestPath, req.path);
+    }
+    if ((scheme === 'http' && String(port) !== '80')
+        || (scheme === 'https' && String(port) !== '443')) {
+        host = `${host}:${port}`;
+    }
+    return toUrl(scheme, host, requestPath, Object.assign({}, req.query, query));
+};
+const toPositiveInteger = (number) => {
+    // 入参可能为任意运行时类型，parseInt 的隐式转字符串行为保持不变
+    const integer = parseInt(number, 10);
+    return integer >= 0 ? integer : 0;
+};
+const transferProperties = (obj, useSnake = false) => {
+    if (useSnake === true) {
+        return transform(obj, (result, value, key) => {
+            result[snakeCase(key)] = value;
+        });
+    }
+    return obj;
+};
+//@formatter:off
+/**
+ @swagger
+ PaginationSnake:
+   type: object
+   properties:
+     total:
+       type: integer
+       description: 总数据量
+     offset:
+       type: integer
+       description: 偏移量
+     limit:
+       type: integer
+       description: 单页数据量
+     prev:
+       type: integer
+       description: 上页偏移量
+     next:
+       type: integer
+       description: 下页偏移量
+     prev_uri:
+       type: string
+       description: 上页Uri
+     next_uri:
+       type: string
+       description: 下页Uri
+     is_first:
+       type: boolean
+       description: 是否为首页
+     is_last:
+       type: boolean
+       description: 是否为末页
+     first_uri:
+       type: string
+       description: 首页Uri
+     last_uri:
+       type: string
+       description: 末页Uri
+   required:
+   - total
+   - offset
+   - limit
+   - prev
+   - next
+   - prev_uri
+   - next_uri
+   - is_first
+   - is_last
+   - first_uri
+   - last_uri
+   example:
+     total: 100
+     offset: 30
+     limit: 15
+     prev: 15
+     next: 45
+     prev_uri: http://localhost/v1/posts?offset=15&limit=15
+     next_uri: http://localhost/v1/posts?offset=30&limit=15
+     is_first: false
+     is_last: false
+     first_uri: http://localhost/v1/posts?offset=0&limit=15
+     last_uri: http://localhost/v1/posts?offset=90&limit=15
+ @swagger
+ Pagination:
+   type: object
+   properties:
+     total:
+       type: integer
+       description: 总数据量
+     offset:
+       type: integer
+       description: 偏移量
+     limit:
+       type: integer
+       description: 单页数据量
+     prev:
+       type: integer
+       description: 上页偏移量
+     next:
+       type: integer
+       description: 下页偏移量
+     prevUri:
+       type: string
+       description: 上页Uri
+     nextUri:
+       type: string
+       description: 下页Uri
+     isFirst:
+       type: boolean
+       description: 是否为首页
+     isLast:
+       type: boolean
+       description: 是否为末页
+     firstUri:
+       type: string
+       description: 首页Uri
+     lastUri:
+       type: string
+       description: 末页Uri
+   required:
+   - total
+   - offset
+   - limit
+   - prev
+   - next
+   - prevUri
+   - nextUri
+   - isFirst
+   - isLast
+   - firstUri
+   - lastUri
+   example:
+     total: 100
+     offset: 30
+     limit: 15
+     prev: 15
+     next: 45
+     prevUri: http://localhost/v1/posts?offset=15&limit=15
+     nextUri: http://localhost/v1/posts?offset=30&limit=15
+     isFirst: false
+     isLast: false
+     firstUri: http://localhost/v1/posts?offset=0&limit=15
+     lastUri: http://localhost/v1/posts?offset=90&limit=15
+ */
+//@formatter:on
+export const pagination = ({ total, limit, offset, req, snakeCase: useSnake }) => {
+    const totalNumber = toPositiveInteger(total);
+    let offsetNumber = parseInt(offset, 10);
+    offsetNumber = Number.isNaN(offsetNumber) ? 0 : offsetNumber;
+    let limitNumber = toPositiveInteger(limit);
+    limitNumber = limitNumber < 1 ? 1 : limitNumber;
+    const prev = offsetNumber - limitNumber;
+    const next = offsetNumber + limitNumber;
+    let prevUri = '';
+    let nextUri = '';
+    let firstUri = '';
+    let lastUri = '';
+    // total/limit/offset 运行时可能为任意类型；比较与减法沿用 JS 的数值强制转换语义
+    if (Number(total) < 1) {
+        return transferProperties({
+            total: totalNumber,
+            offset: offsetNumber,
+            limit: limitNumber,
+            isFirst: true,
+            isLast: true,
+            prev,
+            next,
+            prevUri,
+            nextUri,
+            firstUri,
+            lastUri
+        }, useSnake);
+    }
+    const isFirst = Number(offset) <= 0;
+    // 加法保留原始 JS 语义（字符串入参时会拼接），仅用类型断言满足编译
+    const isLast = offset + limit >= total;
+    const lastOffset = (total - offset) % limit;
+    const last = lastOffset === 0 ? total - limit : total - lastOffset;
+    prevUri = isFirst ? prevUri : toPaginationUrl({ offset: prev, limit: limitNumber }, req);
+    nextUri = isLast ? nextUri : toPaginationUrl({ offset: next, limit: limitNumber }, req);
+    firstUri = toPaginationUrl({ offset: 0, limit: limitNumber }, req);
+    lastUri = toPaginationUrl({ offset: last, limit: limitNumber }, req);
+    return transferProperties({
+        total: totalNumber,
+        offset: offsetNumber,
+        limit: limitNumber,
+        prev,
+        next,
+        isFirst,
+        isLast,
+        prevUri,
+        nextUri,
+        firstUri,
+        lastUri
+    }, useSnake);
+};
+export const paginationFilter = ({ offset, limit }, defaultLimit = 15, maxLimit = 100) => {
+    //Solve offset is negative
+    let offsetNumber = Number.parseInt(offset, 10);
+    offsetNumber = Number.isNaN(offsetNumber) ? 0 : offsetNumber;
+    let limitNumber = toPositiveInteger(limit);
+    limitNumber = limitNumber < 1 ? defaultLimit : limitNumber;
+    if (offsetNumber < 0) {
+        limitNumber += (offsetNumber % limitNumber);
+        offsetNumber = 0;
+    }
+    limitNumber = maxLimit > 0 && limitNumber > maxLimit ? maxLimit : limitNumber;
+    return { offset: offsetNumber, limit: limitNumber };
+};
+//# sourceMappingURL=pagination.js.map

package/dist/utils/pagination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../../src/utils/pagination.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,qBAAqB,CAAC;AAC5C,OAAO,SAAS,MAAM,qBAAqB,CAAC;AAC5C,OAAO,QAAQ,MAAM,MAAM,CAAC;AAc5B,MAAM,KAAK,GAAG,CAAC,MAAc,EAAE,IAAY,EAAE,IAAY,EAAE,QAAiC,EAAE,EAAU,EAAE;IACxG,IAAI,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;SACjC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;SAClC,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,WAAW,GAAG,WAAW,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC;IAC1D,OAAO,GAAG,MAAM,MAAM,IAAI,GAAG,IAAI,GAAG,WAAW,EAAE,CAAC;AACpD,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,KAA8B,EAAE,GAAsB,EAAU,EAAE;IACzF,uCAAuC;IACvC,MAAM,QAAQ,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7C,IAAI,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC;IAC1B,IAAI,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IACvB,IAAI,IAAI,GAAoB,QAAQ,CAAC,CAAC,CAAC,CAAC;IACxC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,IAAI,GAAG,GAAG,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7C,CAAC;IACD,IAAI,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC;IAC9B,IAAI,GAAG,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAChC,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,kBAAkB,CAAE,CAAC;IACtC,CAAC;IACD,IAAI,GAAG,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAChC,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,kBAAkB,CAAE,CAAC;IACtC,CAAC;IACD,IAAI,GAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,EAAE,CAAC;QACjC,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,mBAAmB,CAAE,CAAC;IACzC,CAAC;IACD,IAAI,GAAG,CAAC,GAAG,CAAC,oBAAoB,CAAC,EAAE,CAAC;QAClC,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,oBAAoB,CAAE,EAAE,WAAW,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;IACrF,CAAC;IACD,IACE,CAAC,MAAM,KAAK,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;WACzC,CAAC,MAAM,KAAK,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,EACjD,CAAC;QACD,IAAI,GAAG,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC;IAC3B,CAAC;IACD,OAAO,KAAK,CACV,MAAM,EAAE,IAAI,EAAE,WAAW,EACzB,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CACpC,CAAC;AACJ,CAAC,CAAC;AAGF,MAAM,iBAAiB,GAAG,CAAC,MAAe,EAAU,EAAE;IACpD,sCAAsC;IACtC,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAgB,EAAE,EAAE,CAAC,CAAC;IAC/C,OAAO,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,GAA4B,EAAE,QAAQ,GAAG,KAAK,EAA2B,EAAE;IACrG,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtB,OAAO,SAAS,CAAmC,GAAG,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;YAC7E,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,gBAAgB;AAChB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2HG;AACH,eAAe;AACf,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,EACzB,KAAK,EACL,KAAK,EACL,MAAM,EACN,GAAG,EACH,SAAS,EAAE,QAAQ,EAOpB,EAA2B,EAAE;IAC5B,MAAM,WAAW,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC7C,IAAI,YAAY,GAAG,QAAQ,CAAC,MAAgB,EAAE,EAAE,CAAC,CAAC;IAClD,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;IAC7D,IAAI,WAAW,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC3C,WAAW,GAAG,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;IAChD,MAAM,IAAI,GAAG,YAAY,GAAG,WAAW,CAAC;IACxC,MAAM,IAAI,GAAG,YAAY,GAAG,WAAW,CAAC;IACxC,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,QAAQ,GAAG,EAAE,CAAC;IAClB,IAAI,OAAO,GAAG,EAAE,CAAC;IAEjB,qDAAqD;IACrD,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,kBAAkB,CAAC;YACxB,KAAK,EAAE,WAAW;YAClB,MAAM,EAAE,YAAY;YACpB,KAAK,EAAE,WAAW;YAClB,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,IAAI;YACZ,IAAI;YACJ,IAAI;YACJ,OAAO;YACP,OAAO;YACP,QAAQ;YACR,OAAO;SACR,EAAE,QAAQ,CAAC,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACpC,qCAAqC;IACrC,MAAM,MAAM,GAAI,MAAiB,GAAI,KAAgB,IAAK,KAAgB,CAAC;IAC3E,MAAM,UAAU,GAAG,CAAE,KAAgB,GAAI,MAAiB,CAAC,GAAI,KAAgB,CAAC;IAChF,MAAM,IAAI,GAAG,UAAU,KAAK,CAAC,CAAC,CAAC,CAAE,KAAgB,GAAI,KAAgB,CAAC,CAAC,CAAE,KAAgB,GAAG,UAAU,CAAC;IACvG,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,GAAG,CAAC,CAAC;IACzF,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,GAAG,CAAC,CAAC;IACxF,QAAQ,GAAG,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,GAAG,CAAC,CAAC;IACnE,OAAO,GAAG,eAAe,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,GAAG,CAAC,CAAC;IACrE,OAAO,kBAAkB,CAAC;QACxB,KAAK,EAAE,WAAW;QAClB,MAAM,EAAE,YAAY;QACpB,KAAK,EAAE,WAAW;QAClB,IAAI;QACJ,IAAI;QACJ,OAAO;QACP,MAAM;QACN,OAAO;QACP,OAAO;QACP,QAAQ;QACR,OAAO;KACR,EAAE,QAAQ,CAAC,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,EAAyC,EAAE,YAAY,GAAG,EAAE,EAAE,QAAQ,GAAG,GAAG,EAAqC,EAAE;IACjK,0BAA0B;IAC1B,IAAI,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAgB,EAAE,EAAE,CAAC,CAAC;IACzD,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;IAC7D,IAAI,WAAW,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC3C,WAAW,GAAG,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,WAAW,CAAC;IAE3D,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;QACrB,WAAW,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,CAAC;QAC5C,YAAY,GAAG,CAAC,CAAC;IACnB,CAAC;IAED,WAAW,GAAG,QAAQ,GAAG,CAAC,IAAI,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC;IAE9E,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;AACtD,CAAC,CAAC"}

package/dist/utils/random.d.ts

@@ -0,0 +1,3 @@
+declare const randomString: (len?: number) => string;
+declare const randomNumber: (min: number, max?: number) => number;
+export { randomNumber, randomString };

package/dist/utils/random.js

@@ -0,0 +1,18 @@
+import random from 'lodash/random.js';
+const randomString = (len = 16) => {
+    const digits = '0123456789abcdefghijklmnopqrstuvwxyz';
+    let str = '';
+    for (let i = 0; i < len; i += 1) {
+        const rand = random(0, digits.length - 1);
+        str += digits[rand];
+    }
+    return str;
+};
+const randomNumber = (min, max) => {
+    if (max) {
+        return parseInt(String((Math.random() * ((max - min) + 1)) + min), 10);
+    }
+    return parseInt(String((Math.random() * min) + 1), 10);
+};
+export { randomNumber, randomString };
+//# sourceMappingURL=random.js.map

package/dist/utils/random.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"random.js","sourceRoot":"","sources":["../../src/utils/random.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,kBAAkB,CAAC;AAEtC,MAAM,YAAY,GAAG,CAAC,GAAG,GAAG,EAAE,EAAU,EAAE;IACxC,MAAM,MAAM,GAAG,sCAAsC,CAAC;IACtD,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC1C,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,GAAY,EAAU,EAAE;IACzD,IAAI,GAAG,EAAE,CAAC;QACR,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF,OAAO,EACL,YAAY,EACZ,YAAY,EACb,CAAC"}

package/dist/utils/request_client.d.ts

@@ -0,0 +1,33 @@
+/**
+ * A request-promise-native compatible HTTP client built on the global fetch.
+ *
+ * Keeps the option object and error shape used by the legacy `request`
+ * ecosystem so callers of HttpClient/RestClient see no interface change:
+ * - resolves with the response body (or the full response with
+ *   `resolveWithFullResponse`)
+ * - rejects with an error carrying `.name` (`StatusCodeError`/`RequestError`),
+ *   `.statusCode`, `.response` and `.request`
+ * - supports `url`, `method`, `headers`, `body`, `json`, `qs`, `form`,
+ *   `formData`, `simple`, `resolveWithFullResponse` and `timeout`
+ */
+type RequestClientParams = {
+    url?: string;
+    method?: string;
+    headers?: Record<string, unknown>;
+    body?: unknown;
+    json?: unknown;
+    qs?: Record<string, unknown> | string;
+    form?: Record<string, unknown>;
+    formData?: Record<string, unknown>;
+    simple?: boolean;
+    resolveWithFullResponse?: boolean;
+    timeout?: number;
+};
+/**
+ * Create a request-promise-native compatible callable client.
+ * @param [logger] when given, verbose request/response logs are emitted
+ */
+export declare const createRequestClient: (logger?: {
+    verbose: (message: string, ...args: unknown[]) => void;
+} | null) => (params?: RequestClientParams) => Promise<unknown>;
+export {};

package/dist/utils/request_client.js

@@ -0,0 +1,153 @@
+/**
+ * A request-promise-native compatible HTTP client built on the global fetch.
+ *
+ * Keeps the option object and error shape used by the legacy `request`
+ * ecosystem so callers of HttpClient/RestClient see no interface change:
+ * - resolves with the response body (or the full response with
+ *   `resolveWithFullResponse`)
+ * - rejects with an error carrying `.name` (`StatusCodeError`/`RequestError`),
+ *   `.statusCode`, `.response` and `.request`
+ * - supports `url`, `method`, `headers`, `body`, `json`, `qs`, `form`,
+ *   `formData`, `simple`, `resolveWithFullResponse` and `timeout`
+ */
+const MAX_BODY_LENGTH = parseInt(process.env.MAX_REQUEST_DEBUG_BODY, 10) || 3000;
+const TOO_LONG_BODY = '____TLDR____';
+let debugId = 0;
+const toPlainHeaders = (headers = {}) => {
+    const result = {};
+    Object.entries(headers).forEach(([key, value]) => {
+        result[key] = String(value);
+    });
+    return result;
+};
+const buildQueryString = (qs) => {
+    if (qs === undefined || qs === null) {
+        return '';
+    }
+    if (typeof qs === 'string') {
+        return qs.startsWith('?') ? qs : `?${qs}`;
+    }
+    return `?${new URLSearchParams(qs).toString()}`;
+};
+const buildBody = (params) => {
+    if (params.formData) {
+        const form = new FormData();
+        Object.entries(params.formData).forEach(([key, value]) => {
+            // FormData.append 运行时按 WebIDL 语义转换非字符串值，断言仅满足编译
+            form.append(key, value);
+        });
+        return { body: form, contentType: null };
+    }
+    if (params.form) {
+        return {
+            body: new URLSearchParams(params.form).toString(),
+            contentType: 'application/x-www-form-urlencoded'
+        };
+    }
+    //The legacy `json` option also accepts a value used as the JSON body
+    if (params.json !== undefined && params.json !== false && params.json !== true) {
+        return { body: JSON.stringify(params.json), contentType: 'application/json' };
+    }
+    if (params.json === true && params.body !== undefined) {
+        return { body: JSON.stringify(params.body), contentType: 'application/json' };
+    }
+    return { body: params.body, contentType: null };
+};
+const truncateBody = (body) => {
+    if (typeof body !== 'string') {
+        return body ? String(body) : '';
+    }
+    return body.length > MAX_BODY_LENGTH ? TOO_LONG_BODY : body;
+};
+/**
+ * Create a request-promise-native compatible callable client.
+ * @param [logger] when given, verbose request/response logs are emitted
+ */
+export const createRequestClient = (logger) => {
+    const request = (params = {}) => new Promise((resolve, reject) => {
+        const { url, method: rawMethod = 'GET', headers = {}, resolveWithFullResponse = false, simple = true, timeout = 0, qs } = params;
+        const method = String(rawMethod).toUpperCase();
+        const targetUrl = `${url}${buildQueryString(qs)}`;
+        const { body, contentType } = buildBody(params);
+        const requestHeaders = toPlainHeaders(headers);
+        if (contentType
+            && !Object.keys(requestHeaders).some(key => key.toLowerCase() === 'content-type')) {
+            requestHeaders['Content-Type'] = contentType;
+        }
+        const abortController = new AbortController();
+        const timer = timeout > 0
+            ? setTimeout(() => abortController.abort(new Error('Request timed out')), timeout)
+            : null;
+        const requestForDump = {
+            method,
+            uri: {
+                protocol: new URL(targetUrl).protocol,
+                href: targetUrl
+            },
+            headers: requestHeaders,
+            req: {},
+            _json: params.json !== undefined && params.json !== false
+                ? true : body !== undefined,
+            formData: params.formData || null,
+            body: params.formData
+                ? new URLSearchParams(params.formData).toString()
+                : body
+        };
+        const id = ++debugId;
+        if (logger) {
+            logger.verbose('[HTTP_REQUEST_%s] [%s %s] [REQ_HEADERS: %s] [REQ_BODY: %s]', id, method, targetUrl, JSON.stringify(requestHeaders), truncateBody(body));
+        }
+        fetch(targetUrl, {
+            method,
+            headers: requestHeaders,
+            body,
+            signal: abortController.signal,
+            redirect: 'follow'
+        }).then(async (response) => {
+            if (timer) {
+                clearTimeout(timer);
+            }
+            const rawBody = await response.text();
+            let parsedBody = rawBody;
+            if (params.json !== undefined && params.json !== false) {
+                try {
+                    parsedBody = JSON.parse(rawBody);
+                }
+                catch {
+                    parsedBody = rawBody;
+                }
+            }
+            const responseForDump = {
+                statusCode: response.status,
+                statusMessage: response.statusText,
+                headers: toPlainHeaders(Object.fromEntries(response.headers.entries())),
+                body: parsedBody,
+                request: requestForDump
+            };
+            if (logger) {
+                logger.verbose('[HTTP_RESPONSE_%s] [%s %s] [%s] [RES_HEADERS: %s] [RES_BODY: %s]', id, method, targetUrl, response.status, JSON.stringify(responseForDump.headers), truncateBody(parsedBody));
+            }
+            if (response.status >= 400 && simple) {
+                const error = new Error(`Response status ${response.status}`);
+                error.name = 'StatusCodeError';
+                error.statusCode = response.status;
+                error.response = responseForDump;
+                error.request = requestForDump;
+                reject(error);
+                return;
+            }
+            resolve(resolveWithFullResponse ? responseForDump : parsedBody);
+        }).catch((err) => {
+            if (timer) {
+                clearTimeout(timer);
+            }
+            // 与原实现一致：非 Error 值时 err.message 为 undefined，new Error(undefined) 的语义保持不变
+            const error = new Error(err.message);
+            error.name = 'RequestError';
+            error.request = requestForDump;
+            reject(error);
+        });
+    });
+    return request;
+};
+//# sourceMappingURL=request_client.js.map

package/dist/utils/request_client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request_client.js","sourceRoot":"","sources":["../../src/utils/request_client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAgDH,MAAM,eAAe,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAgC,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC;AAC3F,MAAM,aAAa,GAAG,cAAc,CAAC;AAErC,IAAI,OAAO,GAAG,CAAC,CAAC;AAEhB,MAAM,cAAc,GAAG,CAAC,UAAmC,EAAE,EAA0B,EAAE;IACvF,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC/C,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,EAAqC,EAAU,EAAE;IAAI,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;QACjH,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;QAC3B,OAAO,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;IAC5C,CAAC;IACD,OAAO,IAAI,IAAI,eAAe,CAAC,EAA4B,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;AAC5E,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,MAA2B,EAA8D,EAAE;IAC5G,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpB,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC5B,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACvD,gDAAgD;YAChD,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,KAAsB,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QACH,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;IAC3C,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,OAAO;YACL,IAAI,EAAE,IAAI,eAAe,CAAC,MAAM,CAAC,IAA8B,CAAC,CAAC,QAAQ,EAAE;YAC3E,WAAW,EAAE,mCAAmC;SACjD,CAAC;IACJ,CAAC;IACD,qEAAqE;IACrE,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAC/E,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAChF,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QACtD,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAChF,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAA4B,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;AAC1E,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,IAAa,EAAU,EAAE;IAC7C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAClC,CAAC;IACD,OAAO,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC;AAC9D,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAA0E,EAAE,EAAE;IAChH,MAAM,OAAO,GAAG,CAAC,SAA8B,EAAE,EAAoB,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACtG,MAAM,EACJ,GAAG,EACH,MAAM,EAAE,SAAS,GAAG,KAAK,EACzB,OAAO,GAAG,EAAE,EACZ,uBAAuB,GAAG,KAAK,EAC/B,MAAM,GAAG,IAAI,EACb,OAAO,GAAG,CAAC,EACX,EAAE,EACH,GAAG,MAAM,CAAC;QAEX,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;QAC/C,MAAM,SAAS,GAAG,GAAG,GAAG,GAAG,gBAAgB,CAAC,EAAE,CAAC,EAAE,CAAC;QAClD,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;QAEhD,MAAM,cAAc,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;QAC/C,IAAI,WAAW;eACV,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,EAAE,CAAC;YACpF,cAAc,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC;QAC/C,CAAC;QAED,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;QAC9C,MAAM,KAAK,GAAG,OAAO,GAAG,CAAC;YACvB,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC,EAAE,OAAO,CAAC;YAClF,CAAC,CAAC,IAAI,CAAC;QAET,MAAM,cAAc,GAAmB;YACrC,MAAM;YACN,GAAG,EAAE;gBACH,QAAQ,EAAE,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,QAAQ;gBACrC,IAAI,EAAE,SAAS;aAChB;YACD,OAAO,EAAE,cAAc;YACvB,GAAG,EAAE,EAAE;YACP,KAAK,EAAE,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK;gBACvD,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS;YAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,IAAI;YACjC,IAAI,EAAE,MAAM,CAAC,QAAQ;gBACnB,CAAC,CAAC,IAAI,eAAe,CAAC,MAAM,CAAC,QAAkC,CAAC,CAAC,QAAQ,EAAE;gBAC3E,CAAC,CAAC,IAAI;SACT,CAAC;QAEF,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC;QACrB,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,OAAO,CAAC,4DAA4D,EAAE,EAAE,EAC7E,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3E,CAAC;QAED,KAAK,CAAC,SAAS,EAAE;YACf,MAAM;YACN,OAAO,EAAE,cAAc;YACvB,IAAI;YACJ,MAAM,EAAE,eAAe,CAAC,MAAM;YAC9B,QAAQ,EAAE,QAAQ;SACnB,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YACzB,IAAI,KAAK,EAAE,CAAC;gBACV,YAAY,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;YACD,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACtC,IAAI,UAAU,GAAY,OAAO,CAAC;YAClC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;gBACvD,IAAI,CAAC;oBACH,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBACnC,CAAC;gBAAC,MAAM,CAAC;oBACP,UAAU,GAAG,OAAO,CAAC;gBACvB,CAAC;YACH,CAAC;YAED,MAAM,eAAe,GAAoB;gBACvC,UAAU,EAAE,QAAQ,CAAC,MAAM;gBAC3B,aAAa,EAAE,QAAQ,CAAC,UAAU;gBAClC,OAAO,EAAE,cAAc,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;gBACvE,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,cAAc;aACxB,CAAC;YAEF,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,CAAC,OAAO,CAAC,kEAAkE,EAAE,EAAE,EACnF,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,OAAO,CAAC,EAC3E,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC;YAC9B,CAAC;YAED,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,MAAM,EAAE,CAAC;gBACrC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,mBAAmB,QAAQ,CAAC,MAAM,EAAE,CAAuB,CAAC;gBACpF,KAAK,CAAC,IAAI,GAAG,iBAAiB,CAAC;gBAC/B,KAAK,CAAC,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC;gBACnC,KAAK,CAAC,QAAQ,GAAG,eAAe,CAAC;gBACjC,KAAK,CAAC,OAAO,GAAG,cAAc,CAAC;gBAC/B,MAAM,CAAC,KAAK,CAAC,CAAC;gBACd,OAAO;YACT,CAAC;YAED,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE;YACxB,IAAI,KAAK,EAAE,CAAC;gBACV,YAAY,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;YACD,yEAAyE;YACzE,MAAM,KAAK,GAAG,IAAI,KAAK,CAAE,GAAa,CAAC,OAAO,CAAuB,CAAC;YACtE,KAAK,CAAC,IAAI,GAAG,cAAc,CAAC;YAC5B,KAAK,CAAC,OAAO,GAAG,cAAc,CAAC;YAC/B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC"}

package/dist/utils/smart_query.d.ts

@@ -0,0 +1,144 @@
+type SmartQueryWhere = Record<string, Record<PropertyKey, unknown>>;
+type SmartQueryCriteria = {
+    order?: unknown[];
+    where?: SmartQueryWhere;
+};
+/**
+ * 自动根据 req.query 生成 sequelize 查询条件, 自动判断参数清单中是否有值
+ */
+export default class SmartQuery {
+    query: Record<string, unknown>;
+    /** WHERE 查询条件 */
+    where: SmartQueryWhere;
+    /**
+     * 排序列表
+     */
+    order: unknown[];
+    constructor(query: Record<string, unknown>);
+    /**
+     * 当 query 中包含名为 paramName 的属性时，为 fieldName 添加全等查询条件
+     * @param paramName query 中的参数名称
+     * @param fieldName 对应的数据库字段名称，默认与 paramName 一致
+     * @param defaultValue 当 query 中不包含 paramName 或为空时，使用该值
+     */
+    equal(paramName: string, fieldName?: string, defaultValue?: unknown): this;
+    /**
+     * 当 query 中包含名为 paramName 的属性时，为 fieldName 添加 in 查询条件, 值可以为 `delimiter` 分割的字符串或者数组
+     * @param paramName query 中的参数名称
+     * @param [fieldName=paramName] 对应的数据库字段名称，默认与 paramName 一致
+     * @param [defaultValue=null] 当 query 中不包含 paramName 或为空时，使用该值
+     * @param [delimiter=,] 当值为字符串时的分隔符，默认为 ,
+     */
+    in(paramName: string, fieldName?: string, defaultValue?: unknown, delimiter?: string): this;
+    /**
+     * 当 query 中包含名为 paramName 的属性时，为 fieldName 添加 not in 查询条件, 值可以为 `delimiter` 分割的字符串或者数组
+     * @param paramName query 中的参数名称
+     * @param [fieldName=paramName] 对应的数据库字段名称，默认与 paramName 一致
+     * @param [defaultValue=null] 当 query 中不包含 paramName 或为空时，使用该值
+     * @param [delimiter=,] 当值为字符串时的分隔符，默认为 ,
+     */
+    notIn(paramName: string, fieldName?: string, defaultValue?: unknown, delimiter?: string): this;
+    /**
+     * 当 query 中包含名为 paramName 的属性时，为 fieldName 添加 LIKE 查询条件，并自动在值的头尾添加 %
+     * @param paramName query 中的参数名称
+     * @param fieldName 对应的数据库字段名称，默认与 paramName 一致
+     * @param defaultValue 当 query 中不包含 paramName 或为空时，使用该值
+     */
+    like(paramName: string, fieldName?: string, defaultValue?: unknown): this;
+    /**
+     * 当 query 中包含名为 paramName 的属性时，为 fieldName 添加 LIKE 查询条件，并自动在值的尾部添加 %
+     * @param paramName query 中的参数名称
+     * @param fieldName 对应的数据库字段名称，默认与 paramName 一致
+     * @param defaultValue 当 query 中不包含 paramName 或为空时，使用该值
+     */
+    startsWith(paramName: string, fieldName?: string, defaultValue?: unknown): this;
+    /**
+     * 当 query 中包含名为 paramName 的属性时，为 fieldName 添加 LIKE 查询条件，并自动在值的头部添加 %
+     * @param paramName query 中的参数名称
+     * @param fieldName 对应的数据库字段名称，默认与 paramName 一致
+     * @param defaultValue 当 query 中不包含 paramName 或为空时，使用该值
+     */
+    endsWith(paramName: string, fieldName?: string, defaultValue?: unknown): this;
+    /**
+     * 当 query 中包含名为 paramName 的属性时，为 fieldName 添加 >= 查询条件
+     * @param paramName query 中的参数名称
+     * @param fieldName 对应的数据库字段名称，默认与 paramName 一致
+     * @param defaultValue 当 query 中不包含 paramName 或为空时，使用该值
+     */
+    gte(paramName: string, fieldName?: string, defaultValue?: unknown): this;
+    /**
+     * 当 query 中包含名为 paramName 的属性时，为 fieldName 添加 <= 查询条件
+     * @param paramName query 中的参数名称
+     * @param fieldName 对应的数据库字段名称，默认与 paramName 一致
+     * @param defaultValue 当 query 中不包含 paramName 或为空时，使用该值
+     */
+    lte(paramName: string, fieldName?: string, defaultValue?: unknown): this;
+    /**
+     * 当 query 中包含名为 minParamName 的属性时，为 fieldName 添加 >= 查询条件，
+     * 当 query 中包含名为 maxParamName 的属性时，为 fieldName 添加 <= 查询条件
+     * @param minParamName query 中的最小值参数名称
+     * @param maxParamName query 中的最大值参数名称
+     * @param fieldName 对应的数据库字段名称
+     * @param minDefault 当 query 中不包含 minParamName 或为空时，使用该值作为默认值
+     * @param maxDefault 当 query 中不包含 maxParamName 或为空时，使用该值作为默认值
+     */
+    range(minParamName: string, maxParamName: string, fieldName: string, minDefault?: unknown, maxDefault?: unknown): this;
+    /**
+     * 当 query 中包含名为 minParamName 的属性时，为 fieldName 添加 >= 查询条件并将时分秒设为0格式化到 targetFormat ，
+     * 当 query 中包含名为 maxParamName 的属性时，为 fieldName 添加 <= 查询条件并将时分秒分别设为 23:59:59 后格式化到 targetFormat
+     * @param minParamName query 中的最小值参数名称
+     * @param maxParamName query 中的最大值参数名称
+     * @param fieldName 对应的数据库字段名称
+     * @param [minDefault=null] 当 query 中不包含 minParamName 或为空时，使用该值作为默认值
+     * @param [maxDefault=null] 当 query 中不包含 maxParamName 或为空时，使用该值作为默认值
+     * @param [sourceFormat='YYYY-MM-DD'] 原值时间格式
+     * @param [targetFormat='X'] 数据库时间格式
+     */
+    dateRange(minParamName: string, maxParamName: string, fieldName: string, minDefault?: string | null, maxDefault?: string | null, sourceFormat?: string, targetFormat?: string): this;
+    /**
+     * 当 query 中包含名为 minParamName 的属性时，为 fieldName 添加 >= 查询条件并格式化到 targetFormat ，
+     * 当 query 中包含名为 maxParamName 的属性时，为 fieldName 添加 <= 查询条件并并格式化到 targetFormat
+     * @param minParamName query 中的最小值参数名称
+     * @param maxParamName query 中的最大值参数名称
+     * @param fieldName 对应的数据库字段名称
+     * @param [minDefault=null] 当 query 中不包含 minParamName 或为空时，使用该值作为默认值
+     * @param [maxDefault=null] 当 query 中不包含 maxParamName 或为空时，使用该值作为默认值
+     * @param [sourceFormat='YYYY-MM-DD HH:mm:ss'] 原值时间格式
+     * @param [targetFormat='X'] 数据库时间格式
+     */
+    dateTimeRange(minParamName: string, maxParamName: string, fieldName: string, minDefault?: string | null, maxDefault?: string | null, sourceFormat?: string, targetFormat?: string): this;
+    /**
+     * 处理用户的排序请求
+     * @param [autoMapping=[]] 根据字段名自动排序，数组成员为字段名，每个字段名自动生成正反序，
+     *                                  如 `created_at` 生成 `created_at` 正序和 `-created_at` 倒序
+     * @param [manualMapping={}]
+     * @param [defaultOrder=null] 默认排序，当 query 中不包含 `paramName` 属性时使用。如不设置则为 `autoMapping` 的第一个字段的倒序
+     * @param [paramName='order'] 参数名称
+     */
+    orderable(autoMapping?: string[], manualMapping?: Record<string, unknown>, defaultOrder?: unknown, paramName?: string): this;
+    /**
+     * 获取完整的有效查询参数
+     */
+    getCriteria(): SmartQueryCriteria;
+    /**
+     * 当 query 中包含名为 paramName 的属性时，为 fieldName 添加 in 或 not in 查询条件, 值可以为 `delimiter` 分割的字符串或者数组
+     * @protected
+     * @param paramName query 中的参数名称
+     * @param fieldName 对应的数据库字段名称
+     * @param [defaultValue=null] 当 query 中不包含 paramName 或为空时，使用该值
+     * @param [delimiter=,] 当值为字符串时的分隔符，默认为 ,
+     * @param [negation=false] 是否取反，为 true 时使用 $notIn
+     */
+    applyIn(paramName: string, fieldName: string, defaultValue?: unknown, delimiter?: string, negation?: boolean): this;
+    /**
+     * 添加 where
+     *
+     * @protected
+     */
+    applyWhere(filedName: string, predicate: string, value: unknown): void;
+    /**
+     * 判定指定名称的参数是否有效
+     */
+    determineParam(paramName: string): boolean;
+}
+export {};