@ai0x0/utils 0.6.1 → 0.7.1

package/lib/backend/actions/get-list-query.d.ts

@@ -6,6 +6,8 @@ import { type ListQueryParams } from "./get-list-query-core.js";
 export declare function getListQuery<TTable extends BaseTable, TSelection extends SelectedFields>(args: {
     db: NodePgDatabase<Record<string, unknown>>;
     fields: TSelection;
+    /** 允许被当成筛选条件的键。不传等于不限制，见核心里的说明。 */
+    filterable?: readonly string[];
     jsonArrayFields?: string[];
     /**
      * 行级作用域。**必填**，不想隔离就显式传 NO_SCOPE —— 写成可选的话，漏传就退化成查全表，

package/lib/backend/actions/get-list-query.js

@@ -25,13 +25,13 @@ module.exports = __toCommonJS(get_list_query_exports);
 var import_drizzle_orm = require("drizzle-orm");
 var import_get_list_query_core = require("./get-list-query-core");
 var run = (0, import_get_list_query_core.createGetListQuery)({
-  contains: (column, keyword) => (0, import_drizzle_orm.ilike)(column, `%${keyword}%`),
+  contains: (column, pattern) => (0, import_drizzle_orm.ilike)(column, pattern),
   // jsonb 数组展开成行再逐个 LIKE。列存的是 text[] 形状的 jsonb（见 createTableSchema 的
   // jsonArrayFields），所以用 _text 那个变体，取到的 tag 直接就是字符串。
-  jsonArrayContains: (column, keyword) => import_drizzle_orm.sql`
+  jsonArrayContains: (column, pattern) => import_drizzle_orm.sql`
     EXISTS (
       SELECT 1 FROM jsonb_array_elements_text(${column}) tag
-      WHERE tag LIKE ${`%${keyword}%`}
+      WHERE tag LIKE ${pattern}
     )
   `
 });

package/lib/backend/actions/index.d.ts

@@ -4,3 +4,4 @@ export { createGetListAction } from "./create-get-list-action.js";
 export { createPostAction } from "./create-post-action.js";
 export { createPutAction } from "./create-put-action.js";
 export { getListQuery } from "./get-list-query.js";
+export { MAX_PAGE_SIZE, normalizePaging } from "./paging.js";

package/lib/backend/actions/index.js

@@ -19,12 +19,14 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/backend/actions/index.ts
 var actions_exports = {};
 __export(actions_exports, {
+  MAX_PAGE_SIZE: () => import_paging.MAX_PAGE_SIZE,
   createDeleteAction: () => import_create_delete_action.createDeleteAction,
   createGetAction: () => import_create_get_action.createGetAction,
   createGetListAction: () => import_create_get_list_action.createGetListAction,
   createPostAction: () => import_create_post_action.createPostAction,
   createPutAction: () => import_create_put_action.createPutAction,
-  getListQuery: () => import_get_list_query.getListQuery
+  getListQuery: () => import_get_list_query.getListQuery,
+  normalizePaging: () => import_paging.normalizePaging
 });
 module.exports = __toCommonJS(actions_exports);
 var import_create_delete_action = require("./create-delete-action");
@@ -33,12 +35,15 @@ var import_create_get_list_action = require("./create-get-list-action");
 var import_create_post_action = require("./create-post-action");
 var import_create_put_action = require("./create-put-action");
 var import_get_list_query = require("./get-list-query");
+var import_paging = require("./paging");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  MAX_PAGE_SIZE,
   createDeleteAction,
   createGetAction,
   createGetListAction,
   createPostAction,
   createPutAction,
-  getListQuery
+  getListQuery,
+  normalizePaging
 });

package/lib/backend/actions/paging.d.ts

@@ -0,0 +1,11 @@
+/** pageSize 的硬上界。取这个量级是因为「一次把一整块数据取回来」是列表的正常用法。 */
+export declare const MAX_PAGE_SIZE = 10000;
+export declare const DEFAULT_PAGE_SIZE = 10;
+/** 返回一定能安全喂给 limit / offset 的一对整数。 */
+export declare function normalizePaging({ current, pageSize, }: {
+    current?: unknown;
+    pageSize?: unknown;
+}): {
+    current: number;
+    pageSize: number;
+};

package/lib/backend/actions/paging.js

@@ -0,0 +1,50 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/backend/actions/paging.ts
+var paging_exports = {};
+__export(paging_exports, {
+  DEFAULT_PAGE_SIZE: () => DEFAULT_PAGE_SIZE,
+  MAX_PAGE_SIZE: () => MAX_PAGE_SIZE,
+  normalizePaging: () => normalizePaging
+});
+module.exports = __toCommonJS(paging_exports);
+var MAX_PAGE_SIZE = 1e4;
+var DEFAULT_PAGE_SIZE = 10;
+function toPositiveInt(value, fallback) {
+  const parsed = Math.floor(Number(value));
+  return Number.isFinite(parsed) && parsed >= 1 ? parsed : fallback;
+}
+function normalizePaging({
+  current,
+  pageSize
+}) {
+  return {
+    current: toPositiveInt(current, 1),
+    pageSize: Math.min(
+      toPositiveInt(pageSize, DEFAULT_PAGE_SIZE),
+      MAX_PAGE_SIZE
+    )
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DEFAULT_PAGE_SIZE,
+  MAX_PAGE_SIZE,
+  normalizePaging
+});

package/lib/backend/schemas/common.d.ts

@@ -32,7 +32,7 @@ export declare const BASIC_UPDATE_OMIT: {
     readonly createdAt: true;
     readonly updatedAt: true;
 };
-export declare const queryListSchema: <Incoming extends z.ZodObject<z.core.$ZodLooseShape, z.core.$strip>>(schema: Incoming) => z.ZodObject<(("orderBy" | "orderDir" | "pageSize" | "creatorId" | "current" | "createdAtFrom" | "createdAtTo") & keyof Incoming["shape"] extends never ? {
+export declare const queryListSchema: <Incoming extends z.ZodObject<z.core.$ZodLooseShape, z.core.$strip>>(schema: Incoming) => z.ZodObject<(("current" | "pageSize" | "orderBy" | "orderDir" | "creatorId" | "createdAtFrom" | "createdAtTo") & keyof Incoming["shape"] extends never ? {
     current: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     pageSize: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     createdAtFrom: z.ZodOptional<z.ZodString>;
@@ -65,7 +65,7 @@ export declare const queryListSchema: <Incoming extends z.ZodObject<z.core.$ZodL
         asc: "asc";
         desc: "desc";
     }>>;
-}[K]; } : never) & (Incoming["shape"] extends infer T_2 extends z.core.util.SomeObject ? { [K_1 in keyof T_2]: Incoming["shape"][K_1]; } : never)) extends infer T ? { [k in keyof T]: (("orderBy" | "orderDir" | "pageSize" | "creatorId" | "current" | "createdAtFrom" | "createdAtTo") & keyof Incoming["shape"] extends never ? {
+}[K]; } : never) & (Incoming["shape"] extends infer T_2 extends z.core.util.SomeObject ? { [K_1 in keyof T_2]: Incoming["shape"][K_1]; } : never)) extends infer T ? { [k in keyof T]: (("current" | "pageSize" | "orderBy" | "orderDir" | "creatorId" | "createdAtFrom" | "createdAtTo") & keyof Incoming["shape"] extends never ? {
     current: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     pageSize: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     createdAtFrom: z.ZodOptional<z.ZodString>;

package/lib/backend/schemas/common.js

@@ -46,7 +46,7 @@ var BASIC_UPDATE_OMIT = {
 var queryListSchema = (schema) => import_zod.z.object({
   current: import_zod.z.string().optional().default("1").describe("Page number, starting at 1."),
   pageSize: import_zod.z.string().optional().default("10").describe(
-    "Rows per page. Omitting it yields only 10 — pass a larger value to get the whole set."
+    "Rows per page. Omitting it yields only 10 — pass a larger value to get the whole set. Capped at 10000; compare `total` against what you received to tell whether more remain."
   ),
   createdAtFrom: import_zod.z.string().optional().describe(
     "Keep only rows created at or after this instant (ISO 8601, e.g. 2026-08-01T00:00:00Z)."

package/lib/backend/sqlite/actions/create-get-action.js

@@ -32,8 +32,9 @@ function createGetAction({
   table
 }) {
   return async (params, { scope }) => {
+    const exposed = Object.keys(bodySchema.shape);
     const fields = {};
-    for (const key of Object.keys(bodySchema.shape)) {
+    for (const key of exposed) {
       const field = table[key];
       if (field) {
         fields[key] = field;
@@ -42,6 +43,7 @@ function createGetAction({
     const { query, countQuery } = (0, import_get_list_query.getListQuery)({
       db,
       fields,
+      filterable: exposed,
       jsonArrayFields,
       params,
       scope,

package/lib/backend/sqlite/actions/create-get-list-action.js

@@ -33,8 +33,9 @@ function createGetListAction({
 }) {
   return async (params, { scope }) => {
     const { current, pageSize, ...other } = params;
+    const exposed = Object.keys(bodySchema.shape);
     const fields = {};
-    for (const key of Object.keys(bodySchema.shape)) {
+    for (const key of exposed) {
       const field = table[key];
       if (field) {
         fields[key] = field;
@@ -43,6 +44,7 @@ function createGetListAction({
     const { query, countQuery } = (0, import_get_list_query.getListQuery)({
       db,
       fields,
+      filterable: exposed,
       jsonArrayFields,
       params: other,
       scope,

package/lib/backend/sqlite/actions/get-list-data.d.ts

@@ -1,5 +1,5 @@
 import { getListQuery } from "./get-list-query.js";
-export declare function getListData({ query, countQuery, pageSize, current, }: {
+export declare function getListData({ query, countQuery, pageSize: rawPageSize, current: rawCurrent, }: {
     bodySchema?: any;
     current?: number;
     pageSize?: number;

package/lib/backend/sqlite/actions/get-list-data.js

@@ -22,6 +22,7 @@ __export(get_list_data_exports, {
   getListData: () => getListData
 });
 module.exports = __toCommonJS(get_list_data_exports);
+var import_paging = require("../../actions/paging");
 async function runSelect(query) {
   const executable = query;
   if (executable.all) {
@@ -35,11 +36,15 @@ async function runSelect(query) {
 function getListData({
   query,
   countQuery,
-  pageSize = 10,
-  current = 1
+  pageSize: rawPageSize,
+  current: rawCurrent
 }) {
+  const { current, pageSize } = (0, import_paging.normalizePaging)({
+    current: rawCurrent,
+    pageSize: rawPageSize
+  });
   return async () => {
-    const dataQuery = query.limit(+pageSize).offset((+current - 1) * +pageSize);
+    const dataQuery = query.limit(pageSize).offset((current - 1) * pageSize);
     const data = await runSelect(dataQuery);
     const [{ count }] = await runSelect(countQuery);
     return { data, total: Number(count) };

package/lib/backend/sqlite/actions/get-list-query.d.ts

@@ -5,6 +5,8 @@ import { type ListQueryParams } from "../../actions/get-list-query-core.js";
 export declare function getListQuery<TTable extends BaseTable, TSelection extends SelectedFields>(args: {
     db: any;
     fields: TSelection;
+    /** 允许被当成筛选条件的键。不传等于不限制，见核心里的说明。 */
+    filterable?: readonly string[];
     jsonArrayFields?: string[];
     /** 必填。与 pg 那套同义，见 backend/scope.ts。 */
     scope: ScopeArg;

package/lib/backend/sqlite/actions/get-list-query.js

@@ -25,13 +25,13 @@ module.exports = __toCommonJS(get_list_query_exports);
 var import_drizzle_orm = require("drizzle-orm");
 var import_get_list_query_core = require("../../actions/get-list-query-core");
 var run = (0, import_get_list_query_core.createGetListQuery)({
-  contains: (column, keyword) => (0, import_drizzle_orm.like)(column, `%${keyword}%`),
+  contains: (column, pattern) => import_drizzle_orm.sql`${column} LIKE ${pattern} ESCAPE '\\'`,
   // json_each 展开出来的行里，值在 tag.value 上（pg 那个 _text 变体是直接给字符串的）——
   // 这是两边唯一一处连字段名都不同的地方。
-  jsonArrayContains: (column, keyword) => import_drizzle_orm.sql`
+  jsonArrayContains: (column, pattern) => import_drizzle_orm.sql`
     EXISTS (
       SELECT 1 FROM json_each(${column}) tag
-      WHERE tag.value LIKE ${`%${keyword}%`}
+      WHERE tag.value LIKE ${pattern} ESCAPE '\\'
     )
   `
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai0x0/utils",
-  "version": "0.6.1",
+  "version": "0.7.1",
   "description": "AI0x0 utils",
   "keywords": [
     "ai0x0"