@forinda/kickjs 3.0.0 → 3.0.2

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.
Files changed (49) hide show
  1. package/dist/{application-lXO2earl.mjs → application-CY0B76xl.mjs} +5 -5
  2. package/dist/{application-lXO2earl.mjs.map → application-CY0B76xl.mjs.map} +1 -1
  3. package/dist/{bootstrap-DOiIsYo2.mjs → bootstrap-CuKq3zhn.mjs} +6 -6
  4. package/dist/{bootstrap-DOiIsYo2.mjs.map → bootstrap-CuKq3zhn.mjs.map} +1 -1
  5. package/dist/{chunk-fxuC9Wz4.mjs → chunk-C3KRcNIa.mjs} +1 -1
  6. package/dist/config/index.mjs +3 -3
  7. package/dist/{config-CcxCQldy.mjs → config-gtPdGHtT.mjs} +3 -3
  8. package/dist/{config-CcxCQldy.mjs.map → config-gtPdGHtT.mjs.map} +1 -1
  9. package/dist/{container-SCnTHnem.mjs → container-BGphC5K2.mjs} +3 -3
  10. package/dist/{container-SCnTHnem.mjs.map → container-BGphC5K2.mjs.map} +1 -1
  11. package/dist/core/adapter.mjs +1 -1
  12. package/dist/core/app-module.mjs +1 -1
  13. package/dist/core/cache.mjs +1 -1
  14. package/dist/core/container.mjs +2 -2
  15. package/dist/core/cron.mjs +2 -2
  16. package/dist/core/decorators.mjs +3 -3
  17. package/dist/core/errors.mjs +1 -1
  18. package/dist/core/interfaces.mjs +1 -1
  19. package/dist/core/logger.mjs +1 -1
  20. package/dist/core/path.mjs +1 -1
  21. package/dist/core/plugin.mjs +1 -1
  22. package/dist/core/reactivity.mjs +1 -1
  23. package/dist/{core-EhIgu2mK.mjs → core-pFjVMwPQ.mjs} +4 -4
  24. package/dist/{core-EhIgu2mK.mjs.map → core-pFjVMwPQ.mjs.map} +1 -1
  25. package/dist/{env-C2xY8HBc.mjs → env-D2YivbyS.mjs} +4 -4
  26. package/dist/{env-C2xY8HBc.mjs.map → env-D2YivbyS.mjs.map} +1 -1
  27. package/dist/http/application.mjs +2 -2
  28. package/dist/http/bootstrap.mjs +2 -2
  29. package/dist/http/context.mjs +2 -2
  30. package/dist/http/middleware/cors.mjs +1 -1
  31. package/dist/http/middleware/csrf.mjs +1 -1
  32. package/dist/http/middleware/error-handler.mjs +2 -2
  33. package/dist/http/middleware/helmet.mjs +1 -1
  34. package/dist/http/middleware/rate-limit.mjs +1 -1
  35. package/dist/http/middleware/request-id.mjs +1 -1
  36. package/dist/http/middleware/request-logger.mjs +2 -2
  37. package/dist/http/middleware/session.mjs +1 -1
  38. package/dist/http/middleware/spa.mjs +3 -3
  39. package/dist/http/middleware/upload.mjs +1 -1
  40. package/dist/http/middleware/validate.mjs +1 -1
  41. package/dist/http/middleware/views.mjs +2 -2
  42. package/dist/http/query/index.mjs +2 -2
  43. package/dist/http/router-builder.mjs +4 -4
  44. package/dist/index.mjs +9 -9
  45. package/dist/{metadata-ByYK2LKx.mjs → metadata-P_bHa4eZ.mjs} +2 -2
  46. package/dist/{metadata-ByYK2LKx.mjs.map → metadata-P_bHa4eZ.mjs.map} +1 -1
  47. package/dist/{query-Di9vf8zB.mjs → query-BH3B8vPm.mjs} +2 -2
  48. package/dist/{query-Di9vf8zB.mjs.map → query-BH3B8vPm.mjs.map} +1 -1
  49. package/package.json +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"query-Di9vf8zB.mjs","names":[],"sources":["../src/http/query/types.ts","../src/http/query/parse-query.ts"],"sourcesContent":["/** Supported filter operators for query string parsing */\nexport type FilterOperator =\n | 'eq'\n | 'neq'\n | 'gt'\n | 'gte'\n | 'lt'\n | 'lte'\n | 'between'\n | 'in'\n | 'contains'\n | 'starts'\n | 'ends'\n\nexport const FILTER_OPERATORS = new Set<string>([\n 'eq',\n 'neq',\n 'gt',\n 'gte',\n 'lt',\n 'lte',\n 'between',\n 'in',\n 'contains',\n 'starts',\n 'ends',\n])\n\nexport interface FilterItem {\n field: string\n operator: FilterOperator\n value: string\n}\n\nexport interface SortItem {\n field: string\n direction: 'asc' | 'desc'\n}\n\nexport interface PaginationParams {\n page: number\n limit: number\n offset: number\n}\n\n/**\n * The result of parsing a query string. ORM-agnostic — pass this to\n * a query builder adapter (Drizzle, Prisma, Sequelize, etc.) to produce\n * database-specific query objects.\n */\nexport interface ParsedQuery {\n filters: FilterItem[]\n sort: SortItem[]\n pagination: PaginationParams\n search: string\n}\n\n/**\n * Helper that extracts the literal field union from a `QueryFieldConfig`\n * key. When the user passes `{ filterable: ['status', 'category'] } as const`,\n * `FieldsOf<typeof config, 'filterable'>` resolves to `'status' | 'category'`.\n *\n * Without `as const`, the arrays widen to `string[]` and the union falls\n * back to `string`. This is the documented escape hatch.\n */\nexport type FieldsOf<\n TConfig extends QueryFieldConfig | undefined,\n K extends 'filterable' | 'sortable' | 'searchable',\n> = TConfig extends { readonly [P in K]: readonly (infer F)[] }\n ? F extends string\n ? F\n : string\n : TConfig extends { columns: infer C }\n ? K extends 'filterable'\n ? keyof C & string\n : string\n : string\n\n/**\n * Narrowed `ParsedQuery` whose `filters[].field` and `sort[].field`\n * unions are constrained to the literal whitelist passed to\n * `ctx.qs()` / `parseQuery()`. Extends `ParsedQuery`, so any function\n * accepting `ParsedQuery` accepts a `TypedParsedQuery<X>` automatically\n * (subtype assignment, no codegen, backward compatible).\n *\n * @example\n * ```ts\n * const parsed = ctx.qs({\n * filterable: ['status', 'priority'],\n * sortable: ['createdAt'],\n * } as const)\n * parsed.filters[0]?.field // 'status' | 'priority'\n * parsed.sort[0]?.field // 'createdAt'\n * ```\n */\nexport interface TypedParsedQuery<\n TConfig extends QueryFieldConfig | undefined,\n> extends ParsedQuery {\n filters: Array<FilterItem & { field: FieldsOf<TConfig, 'filterable'> }>\n sort: Array<SortItem & { field: FieldsOf<TConfig, 'sortable'> }>\n}\n\n/**\n * Restrict which fields can be filtered, sorted, or searched.\n * Fields not in the allow-list are silently ignored.\n *\n * Accepts two forms:\n * 1. **String arrays** (standard): `{ filterable: ['name', 'status'], sortable: ['createdAt'] }`\n * 2. **Column-object maps** (Drizzle-style): `{ columns: { name: col, status: col }, sortable: { createdAt: col } }`\n *\n * When column-object maps are provided, `Object.keys()` is used to derive the field names.\n */\nexport type QueryFieldConfig = StringQueryFieldConfig | ColumnQueryFieldConfig\n\nexport interface StringQueryFieldConfig {\n filterable?: string[]\n sortable?: string[]\n searchable?: string[]\n}\n\n/**\n * Column-object-based field config (e.g., from DrizzleQueryParamsConfig).\n * Keys are the field names used in query strings; values are ORM column references.\n */\nexport interface ColumnQueryFieldConfig {\n columns: Record<string, any>\n sortable?: Record<string, any>\n searchColumns?: any[]\n [key: string]: any\n}\n\n/** Standardized paginated response shape */\nexport interface PaginatedResponse<T = any> {\n data: T[]\n meta: {\n page: number\n limit: number\n total: number\n totalPages: number\n hasNext: boolean\n hasPrev: boolean\n }\n}\n\n/**\n * Interface for ORM-specific query builder adapters.\n * Implement this to translate a `ParsedQuery` into your ORM's query format.\n *\n * @example\n * ```ts\n * // Drizzle adapter\n * class DrizzleQueryAdapter implements QueryBuilderAdapter<DrizzleQueryResult> {\n * build(parsed: ParsedQuery, config: DrizzleConfig): DrizzleQueryResult {\n * // Convert filters → Drizzle SQL conditions\n * // Convert sort → Drizzle orderBy\n * return { where, orderBy, limit, offset }\n * }\n * }\n *\n * // Prisma adapter\n * class PrismaQueryAdapter implements QueryBuilderAdapter<PrismaQueryResult> {\n * build(parsed: ParsedQuery, config: PrismaConfig): PrismaQueryResult {\n * return { where, orderBy, skip, take }\n * }\n * }\n * ```\n */\nexport interface QueryBuilderAdapter<TResult = any, TConfig = any> {\n /** Human-readable name for debugging */\n readonly name: string\n\n /**\n * Convert a ParsedQuery into an ORM-specific query object.\n * @param parsed - The ORM-agnostic parsed query\n * @param config - ORM-specific configuration (column maps, search columns, etc.)\n */\n build(parsed: ParsedQuery, config: TConfig): TResult\n}\n","import {\n FILTER_OPERATORS,\n type FilterItem,\n type FilterOperator,\n type SortItem,\n type PaginationParams,\n type ParsedQuery,\n type QueryFieldConfig,\n type StringQueryFieldConfig,\n type TypedParsedQuery,\n} from './types'\n\nconst MAX_SEARCH_LENGTH = 200\nconst DEFAULT_PAGE = 1\nconst DEFAULT_LIMIT = 20\nconst MAX_LIMIT = 100\n\n// ── Individual parsers ──────────────────────────────────────────────────\n\n/** Parse filter strings like \"status:eq:active\" into structured objects */\nexport function parseFilters(\n filterParam: string | string[] | undefined,\n allowedFields?: string[],\n): FilterItem[] {\n if (!filterParam) return []\n\n const items = Array.isArray(filterParam) ? filterParam : [filterParam]\n const results: FilterItem[] = []\n const allowed = allowedFields ? new Set(allowedFields) : null\n\n for (const item of items) {\n // Split on first two colons only — value may contain colons (e.g. timestamps)\n const firstColon = item.indexOf(':')\n if (firstColon === -1) continue\n\n const secondColon = item.indexOf(':', firstColon + 1)\n if (secondColon === -1) continue\n\n const field = item.slice(0, firstColon)\n const operator = item.slice(firstColon + 1, secondColon)\n const value = item.slice(secondColon + 1)\n\n if (!field || !value) continue\n if (!FILTER_OPERATORS.has(operator)) continue\n if (allowed && !allowed.has(field)) continue\n\n results.push({ field, operator: operator as FilterOperator, value })\n }\n\n return results\n}\n\n/** Parse sort strings like \"firstName:asc\" into structured objects */\nexport function parseSort(\n sortParam: string | string[] | undefined,\n allowedFields?: string[],\n): SortItem[] {\n if (!sortParam) return []\n\n const items = Array.isArray(sortParam) ? sortParam : [sortParam]\n const results: SortItem[] = []\n const allowed = allowedFields ? new Set(allowedFields) : null\n\n for (const item of items) {\n // Split on last colon so field names with colons work\n const lastColon = item.lastIndexOf(':')\n if (lastColon === -1) continue\n\n const field = item.slice(0, lastColon)\n const dir = item.slice(lastColon + 1).toLowerCase()\n\n if (!field) continue\n if (dir !== 'asc' && dir !== 'desc') continue\n if (allowed && !allowed.has(field)) continue\n\n results.push({ field, direction: dir })\n }\n\n return results\n}\n\n/** Parse page/limit into pagination with computed offset */\nexport function parsePagination(params: {\n page?: string | number\n limit?: string | number\n}): PaginationParams {\n let page =\n typeof params.page === 'string'\n ? Number.parseInt(params.page, 10)\n : (params.page ?? DEFAULT_PAGE)\n let limit =\n typeof params.limit === 'string'\n ? Number.parseInt(params.limit, 10)\n : (params.limit ?? DEFAULT_LIMIT)\n\n if (Number.isNaN(page) || page < 1) page = DEFAULT_PAGE\n if (Number.isNaN(limit) || limit < 1) limit = DEFAULT_LIMIT\n if (limit > MAX_LIMIT) limit = MAX_LIMIT\n\n return { page, limit, offset: (page - 1) * limit }\n}\n\n/** Sanitize and truncate search query */\nexport function parseSearchQuery(q: string | undefined): string {\n if (!q) return ''\n return q.trim().slice(0, MAX_SEARCH_LENGTH)\n}\n\n// ── Config normalizer ───────────────────────────────────────────────────\n\n/**\n * Normalize a QueryFieldConfig into the string-based form.\n * Detects column-object-based configs (DrizzleQueryParamsConfig) by checking\n * for a `columns` property and extracts `Object.keys()`.\n */\nfunction normalizeFieldConfig(config?: QueryFieldConfig): StringQueryFieldConfig | undefined {\n if (!config) return undefined\n\n // Column-object-based config (e.g., DrizzleQueryParamsConfig)\n if ('columns' in config && config.columns && typeof config.columns === 'object') {\n return {\n filterable: Object.keys(config.columns),\n sortable: config.sortable ? Object.keys(config.sortable) : undefined,\n searchable: undefined, // searchColumns are Column objects, not used for string filtering\n }\n }\n\n // Already string-based\n return config as StringQueryFieldConfig\n}\n\n// ── Combined parser ─────────────────────────────────────────────────────\n\n/**\n * Parse a raw Express query object into a structured, ORM-agnostic ParsedQuery.\n *\n * @param query - Raw query string object from `req.query` or Zod-validated object\n * @param fieldConfig - Optional field restrictions (whitelist filterable/sortable/searchable).\n * Accepts both string-based configs (`{ filterable, sortable, searchable }`) and\n * column-object configs (`{ columns, sortable, searchColumns }`).\n *\n * @example\n * ```ts\n * // String-based config\n * const parsed = parseQuery(ctx.query, {\n * filterable: ['status', 'priority'],\n * sortable: ['createdAt', 'title'],\n * })\n *\n * // Column-object config (DrizzleQueryParamsConfig)\n * const parsed = parseQuery(ctx.query, TASK_QUERY_CONFIG)\n * ```\n *\n * Query string format:\n * - Filters: `?filter=field:operator:value` (repeatable)\n * - Sort: `?sort=field:asc|desc` (repeatable)\n * - Pagination: `?page=1&limit=20`\n * - Search: `?q=search+term`\n *\n * Filter operators: eq, neq, gt, gte, lt, lte, between, in, contains, starts, ends\n */\nexport function parseQuery<TConfig extends QueryFieldConfig | undefined = undefined>(\n query: Record<string, any>,\n fieldConfig?: TConfig,\n): TypedParsedQuery<TConfig> {\n const normalized = normalizeFieldConfig(fieldConfig)\n return {\n filters: parseFilters(query.filter, normalized?.filterable),\n sort: parseSort(query.sort, normalized?.sortable),\n pagination: parsePagination({ page: query.page, limit: query.limit }),\n search: parseSearchQuery(query.q),\n } as TypedParsedQuery<TConfig>\n}\n\n// ── Query URL builder (for client-side or testing) ──────────────────────\n\n/** Convert ParsedQuery back into query string parameters */\nexport function buildQueryParams(\n parsed: Partial<ParsedQuery>,\n): Record<string, string | string[] | number> {\n const params: Record<string, string | string[] | number> = {}\n\n if (parsed.filters?.length) {\n params.filter = parsed.filters.map((f) => `${f.field}:${f.operator}:${f.value}`)\n }\n\n if (parsed.sort?.length) {\n params.sort = parsed.sort.map((s) => `${s.field}:${s.direction}`)\n }\n\n if (parsed.pagination) {\n params.page = parsed.pagination.page\n params.limit = parsed.pagination.limit\n }\n\n if (parsed.search) {\n params.q = parsed.search\n }\n\n return params\n}\n"],"mappings":";;;;;;;;;;;AAcA,MAAa,mBAAmB,IAAI,IAAY;CAC9C;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD,CAAC;;;ACdF,MAAM,oBAAoB;AAC1B,MAAM,eAAe;AACrB,MAAM,gBAAgB;AACtB,MAAM,YAAY;;AAKlB,SAAgB,aACd,aACA,eACc;AACd,KAAI,CAAC,YAAa,QAAO,EAAE;CAE3B,MAAM,QAAQ,MAAM,QAAQ,YAAY,GAAG,cAAc,CAAC,YAAY;CACtE,MAAM,UAAwB,EAAE;CAChC,MAAM,UAAU,gBAAgB,IAAI,IAAI,cAAc,GAAG;AAEzD,MAAK,MAAM,QAAQ,OAAO;EAExB,MAAM,aAAa,KAAK,QAAQ,IAAI;AACpC,MAAI,eAAe,GAAI;EAEvB,MAAM,cAAc,KAAK,QAAQ,KAAK,aAAa,EAAE;AACrD,MAAI,gBAAgB,GAAI;EAExB,MAAM,QAAQ,KAAK,MAAM,GAAG,WAAW;EACvC,MAAM,WAAW,KAAK,MAAM,aAAa,GAAG,YAAY;EACxD,MAAM,QAAQ,KAAK,MAAM,cAAc,EAAE;AAEzC,MAAI,CAAC,SAAS,CAAC,MAAO;AACtB,MAAI,CAAC,iBAAiB,IAAI,SAAS,CAAE;AACrC,MAAI,WAAW,CAAC,QAAQ,IAAI,MAAM,CAAE;AAEpC,UAAQ,KAAK;GAAE;GAAiB;GAA4B;GAAO,CAAC;;AAGtE,QAAO;;;AAIT,SAAgB,UACd,WACA,eACY;AACZ,KAAI,CAAC,UAAW,QAAO,EAAE;CAEzB,MAAM,QAAQ,MAAM,QAAQ,UAAU,GAAG,YAAY,CAAC,UAAU;CAChE,MAAM,UAAsB,EAAE;CAC9B,MAAM,UAAU,gBAAgB,IAAI,IAAI,cAAc,GAAG;AAEzD,MAAK,MAAM,QAAQ,OAAO;EAExB,MAAM,YAAY,KAAK,YAAY,IAAI;AACvC,MAAI,cAAc,GAAI;EAEtB,MAAM,QAAQ,KAAK,MAAM,GAAG,UAAU;EACtC,MAAM,MAAM,KAAK,MAAM,YAAY,EAAE,CAAC,aAAa;AAEnD,MAAI,CAAC,MAAO;AACZ,MAAI,QAAQ,SAAS,QAAQ,OAAQ;AACrC,MAAI,WAAW,CAAC,QAAQ,IAAI,MAAM,CAAE;AAEpC,UAAQ,KAAK;GAAE;GAAO,WAAW;GAAK,CAAC;;AAGzC,QAAO;;;AAIT,SAAgB,gBAAgB,QAGX;CACnB,IAAI,OACF,OAAO,OAAO,SAAS,WACnB,OAAO,SAAS,OAAO,MAAM,GAAG,GAC/B,OAAO,QAAQ;CACtB,IAAI,QACF,OAAO,OAAO,UAAU,WACpB,OAAO,SAAS,OAAO,OAAO,GAAG,GAChC,OAAO,SAAS;AAEvB,KAAI,OAAO,MAAM,KAAK,IAAI,OAAO,EAAG,QAAO;AAC3C,KAAI,OAAO,MAAM,MAAM,IAAI,QAAQ,EAAG,SAAQ;AAC9C,KAAI,QAAQ,UAAW,SAAQ;AAE/B,QAAO;EAAE;EAAM;EAAO,SAAS,OAAO,KAAK;EAAO;;;AAIpD,SAAgB,iBAAiB,GAA+B;AAC9D,KAAI,CAAC,EAAG,QAAO;AACf,QAAO,EAAE,MAAM,CAAC,MAAM,GAAG,kBAAkB;;;;;;;AAU7C,SAAS,qBAAqB,QAA+D;AAC3F,KAAI,CAAC,OAAQ,QAAO,KAAA;AAGpB,KAAI,aAAa,UAAU,OAAO,WAAW,OAAO,OAAO,YAAY,SACrE,QAAO;EACL,YAAY,OAAO,KAAK,OAAO,QAAQ;EACvC,UAAU,OAAO,WAAW,OAAO,KAAK,OAAO,SAAS,GAAG,KAAA;EAC3D,YAAY,KAAA;EACb;AAIH,QAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCT,SAAgB,WACd,OACA,aAC2B;CAC3B,MAAM,aAAa,qBAAqB,YAAY;AACpD,QAAO;EACL,SAAS,aAAa,MAAM,QAAQ,YAAY,WAAW;EAC3D,MAAM,UAAU,MAAM,MAAM,YAAY,SAAS;EACjD,YAAY,gBAAgB;GAAE,MAAM,MAAM;GAAM,OAAO,MAAM;GAAO,CAAC;EACrE,QAAQ,iBAAiB,MAAM,EAAE;EAClC;;;AAMH,SAAgB,iBACd,QAC4C;CAC5C,MAAM,SAAqD,EAAE;AAE7D,KAAI,OAAO,SAAS,OAClB,QAAO,SAAS,OAAO,QAAQ,KAAK,MAAM,GAAG,EAAE,MAAM,GAAG,EAAE,SAAS,GAAG,EAAE,QAAQ;AAGlF,KAAI,OAAO,MAAM,OACf,QAAO,OAAO,OAAO,KAAK,KAAK,MAAM,GAAG,EAAE,MAAM,GAAG,EAAE,YAAY;AAGnE,KAAI,OAAO,YAAY;AACrB,SAAO,OAAO,OAAO,WAAW;AAChC,SAAO,QAAQ,OAAO,WAAW;;AAGnC,KAAI,OAAO,OACT,QAAO,IAAI,OAAO;AAGpB,QAAO"}
1
+ {"version":3,"file":"query-BH3B8vPm.mjs","names":[],"sources":["../src/http/query/types.ts","../src/http/query/parse-query.ts"],"sourcesContent":["/** Supported filter operators for query string parsing */\nexport type FilterOperator =\n | 'eq'\n | 'neq'\n | 'gt'\n | 'gte'\n | 'lt'\n | 'lte'\n | 'between'\n | 'in'\n | 'contains'\n | 'starts'\n | 'ends'\n\nexport const FILTER_OPERATORS = new Set<string>([\n 'eq',\n 'neq',\n 'gt',\n 'gte',\n 'lt',\n 'lte',\n 'between',\n 'in',\n 'contains',\n 'starts',\n 'ends',\n])\n\nexport interface FilterItem {\n field: string\n operator: FilterOperator\n value: string\n}\n\nexport interface SortItem {\n field: string\n direction: 'asc' | 'desc'\n}\n\nexport interface PaginationParams {\n page: number\n limit: number\n offset: number\n}\n\n/**\n * The result of parsing a query string. ORM-agnostic — pass this to\n * a query builder adapter (Drizzle, Prisma, Sequelize, etc.) to produce\n * database-specific query objects.\n */\nexport interface ParsedQuery {\n filters: FilterItem[]\n sort: SortItem[]\n pagination: PaginationParams\n search: string\n}\n\n/**\n * Helper that extracts the literal field union from a `QueryFieldConfig`\n * key. When the user passes `{ filterable: ['status', 'category'] } as const`,\n * `FieldsOf<typeof config, 'filterable'>` resolves to `'status' | 'category'`.\n *\n * Without `as const`, the arrays widen to `string[]` and the union falls\n * back to `string`. This is the documented escape hatch.\n */\nexport type FieldsOf<\n TConfig extends QueryFieldConfig | undefined,\n K extends 'filterable' | 'sortable' | 'searchable',\n> = TConfig extends { readonly [P in K]: readonly (infer F)[] }\n ? F extends string\n ? F\n : string\n : TConfig extends { columns: infer C }\n ? K extends 'filterable'\n ? keyof C & string\n : string\n : string\n\n/**\n * Narrowed `ParsedQuery` whose `filters[].field` and `sort[].field`\n * unions are constrained to the literal whitelist passed to\n * `ctx.qs()` / `parseQuery()`. Extends `ParsedQuery`, so any function\n * accepting `ParsedQuery` accepts a `TypedParsedQuery<X>` automatically\n * (subtype assignment, no codegen, backward compatible).\n *\n * @example\n * ```ts\n * const parsed = ctx.qs({\n * filterable: ['status', 'priority'],\n * sortable: ['createdAt'],\n * } as const)\n * parsed.filters[0]?.field // 'status' | 'priority'\n * parsed.sort[0]?.field // 'createdAt'\n * ```\n */\nexport interface TypedParsedQuery<\n TConfig extends QueryFieldConfig | undefined,\n> extends ParsedQuery {\n filters: Array<FilterItem & { field: FieldsOf<TConfig, 'filterable'> }>\n sort: Array<SortItem & { field: FieldsOf<TConfig, 'sortable'> }>\n}\n\n/**\n * Restrict which fields can be filtered, sorted, or searched.\n * Fields not in the allow-list are silently ignored.\n *\n * Accepts two forms:\n * 1. **String arrays** (standard): `{ filterable: ['name', 'status'], sortable: ['createdAt'] }`\n * 2. **Column-object maps** (Drizzle-style): `{ columns: { name: col, status: col }, sortable: { createdAt: col } }`\n *\n * When column-object maps are provided, `Object.keys()` is used to derive the field names.\n */\nexport type QueryFieldConfig = StringQueryFieldConfig | ColumnQueryFieldConfig\n\nexport interface StringQueryFieldConfig {\n filterable?: string[]\n sortable?: string[]\n searchable?: string[]\n}\n\n/**\n * Column-object-based field config (e.g., from DrizzleQueryParamsConfig).\n * Keys are the field names used in query strings; values are ORM column references.\n */\nexport interface ColumnQueryFieldConfig {\n columns: Record<string, any>\n sortable?: Record<string, any>\n searchColumns?: any[]\n [key: string]: any\n}\n\n/** Standardized paginated response shape */\nexport interface PaginatedResponse<T = any> {\n data: T[]\n meta: {\n page: number\n limit: number\n total: number\n totalPages: number\n hasNext: boolean\n hasPrev: boolean\n }\n}\n\n/**\n * Interface for ORM-specific query builder adapters.\n * Implement this to translate a `ParsedQuery` into your ORM's query format.\n *\n * @example\n * ```ts\n * // Drizzle adapter\n * class DrizzleQueryAdapter implements QueryBuilderAdapter<DrizzleQueryResult> {\n * build(parsed: ParsedQuery, config: DrizzleConfig): DrizzleQueryResult {\n * // Convert filters → Drizzle SQL conditions\n * // Convert sort → Drizzle orderBy\n * return { where, orderBy, limit, offset }\n * }\n * }\n *\n * // Prisma adapter\n * class PrismaQueryAdapter implements QueryBuilderAdapter<PrismaQueryResult> {\n * build(parsed: ParsedQuery, config: PrismaConfig): PrismaQueryResult {\n * return { where, orderBy, skip, take }\n * }\n * }\n * ```\n */\nexport interface QueryBuilderAdapter<TResult = any, TConfig = any> {\n /** Human-readable name for debugging */\n readonly name: string\n\n /**\n * Convert a ParsedQuery into an ORM-specific query object.\n * @param parsed - The ORM-agnostic parsed query\n * @param config - ORM-specific configuration (column maps, search columns, etc.)\n */\n build(parsed: ParsedQuery, config: TConfig): TResult\n}\n","import {\n FILTER_OPERATORS,\n type FilterItem,\n type FilterOperator,\n type SortItem,\n type PaginationParams,\n type ParsedQuery,\n type QueryFieldConfig,\n type StringQueryFieldConfig,\n type TypedParsedQuery,\n} from './types'\n\nconst MAX_SEARCH_LENGTH = 200\nconst DEFAULT_PAGE = 1\nconst DEFAULT_LIMIT = 20\nconst MAX_LIMIT = 100\n\n// ── Individual parsers ──────────────────────────────────────────────────\n\n/** Parse filter strings like \"status:eq:active\" into structured objects */\nexport function parseFilters(\n filterParam: string | string[] | undefined,\n allowedFields?: string[],\n): FilterItem[] {\n if (!filterParam) return []\n\n const items = Array.isArray(filterParam) ? filterParam : [filterParam]\n const results: FilterItem[] = []\n const allowed = allowedFields ? new Set(allowedFields) : null\n\n for (const item of items) {\n // Split on first two colons only — value may contain colons (e.g. timestamps)\n const firstColon = item.indexOf(':')\n if (firstColon === -1) continue\n\n const secondColon = item.indexOf(':', firstColon + 1)\n if (secondColon === -1) continue\n\n const field = item.slice(0, firstColon)\n const operator = item.slice(firstColon + 1, secondColon)\n const value = item.slice(secondColon + 1)\n\n if (!field || !value) continue\n if (!FILTER_OPERATORS.has(operator)) continue\n if (allowed && !allowed.has(field)) continue\n\n results.push({ field, operator: operator as FilterOperator, value })\n }\n\n return results\n}\n\n/** Parse sort strings like \"firstName:asc\" into structured objects */\nexport function parseSort(\n sortParam: string | string[] | undefined,\n allowedFields?: string[],\n): SortItem[] {\n if (!sortParam) return []\n\n const items = Array.isArray(sortParam) ? sortParam : [sortParam]\n const results: SortItem[] = []\n const allowed = allowedFields ? new Set(allowedFields) : null\n\n for (const item of items) {\n // Split on last colon so field names with colons work\n const lastColon = item.lastIndexOf(':')\n if (lastColon === -1) continue\n\n const field = item.slice(0, lastColon)\n const dir = item.slice(lastColon + 1).toLowerCase()\n\n if (!field) continue\n if (dir !== 'asc' && dir !== 'desc') continue\n if (allowed && !allowed.has(field)) continue\n\n results.push({ field, direction: dir })\n }\n\n return results\n}\n\n/** Parse page/limit into pagination with computed offset */\nexport function parsePagination(params: {\n page?: string | number\n limit?: string | number\n}): PaginationParams {\n let page =\n typeof params.page === 'string'\n ? Number.parseInt(params.page, 10)\n : (params.page ?? DEFAULT_PAGE)\n let limit =\n typeof params.limit === 'string'\n ? Number.parseInt(params.limit, 10)\n : (params.limit ?? DEFAULT_LIMIT)\n\n if (Number.isNaN(page) || page < 1) page = DEFAULT_PAGE\n if (Number.isNaN(limit) || limit < 1) limit = DEFAULT_LIMIT\n if (limit > MAX_LIMIT) limit = MAX_LIMIT\n\n return { page, limit, offset: (page - 1) * limit }\n}\n\n/** Sanitize and truncate search query */\nexport function parseSearchQuery(q: string | undefined): string {\n if (!q) return ''\n return q.trim().slice(0, MAX_SEARCH_LENGTH)\n}\n\n// ── Config normalizer ───────────────────────────────────────────────────\n\n/**\n * Normalize a QueryFieldConfig into the string-based form.\n * Detects column-object-based configs (DrizzleQueryParamsConfig) by checking\n * for a `columns` property and extracts `Object.keys()`.\n */\nfunction normalizeFieldConfig(config?: QueryFieldConfig): StringQueryFieldConfig | undefined {\n if (!config) return undefined\n\n // Column-object-based config (e.g., DrizzleQueryParamsConfig)\n if ('columns' in config && config.columns && typeof config.columns === 'object') {\n return {\n filterable: Object.keys(config.columns),\n sortable: config.sortable ? Object.keys(config.sortable) : undefined,\n searchable: undefined, // searchColumns are Column objects, not used for string filtering\n }\n }\n\n // Already string-based\n return config as StringQueryFieldConfig\n}\n\n// ── Combined parser ─────────────────────────────────────────────────────\n\n/**\n * Parse a raw Express query object into a structured, ORM-agnostic ParsedQuery.\n *\n * @param query - Raw query string object from `req.query` or Zod-validated object\n * @param fieldConfig - Optional field restrictions (whitelist filterable/sortable/searchable).\n * Accepts both string-based configs (`{ filterable, sortable, searchable }`) and\n * column-object configs (`{ columns, sortable, searchColumns }`).\n *\n * @example\n * ```ts\n * // String-based config\n * const parsed = parseQuery(ctx.query, {\n * filterable: ['status', 'priority'],\n * sortable: ['createdAt', 'title'],\n * })\n *\n * // Column-object config (DrizzleQueryParamsConfig)\n * const parsed = parseQuery(ctx.query, TASK_QUERY_CONFIG)\n * ```\n *\n * Query string format:\n * - Filters: `?filter=field:operator:value` (repeatable)\n * - Sort: `?sort=field:asc|desc` (repeatable)\n * - Pagination: `?page=1&limit=20`\n * - Search: `?q=search+term`\n *\n * Filter operators: eq, neq, gt, gte, lt, lte, between, in, contains, starts, ends\n */\nexport function parseQuery<TConfig extends QueryFieldConfig | undefined = undefined>(\n query: Record<string, any>,\n fieldConfig?: TConfig,\n): TypedParsedQuery<TConfig> {\n const normalized = normalizeFieldConfig(fieldConfig)\n return {\n filters: parseFilters(query.filter, normalized?.filterable),\n sort: parseSort(query.sort, normalized?.sortable),\n pagination: parsePagination({ page: query.page, limit: query.limit }),\n search: parseSearchQuery(query.q),\n } as TypedParsedQuery<TConfig>\n}\n\n// ── Query URL builder (for client-side or testing) ──────────────────────\n\n/** Convert ParsedQuery back into query string parameters */\nexport function buildQueryParams(\n parsed: Partial<ParsedQuery>,\n): Record<string, string | string[] | number> {\n const params: Record<string, string | string[] | number> = {}\n\n if (parsed.filters?.length) {\n params.filter = parsed.filters.map((f) => `${f.field}:${f.operator}:${f.value}`)\n }\n\n if (parsed.sort?.length) {\n params.sort = parsed.sort.map((s) => `${s.field}:${s.direction}`)\n }\n\n if (parsed.pagination) {\n params.page = parsed.pagination.page\n params.limit = parsed.pagination.limit\n }\n\n if (parsed.search) {\n params.q = parsed.search\n }\n\n return params\n}\n"],"mappings":";;;;;;;;;;;AAcA,MAAa,mBAAmB,IAAI,IAAY;CAC9C;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD,CAAC;;;ACdF,MAAM,oBAAoB;AAC1B,MAAM,eAAe;AACrB,MAAM,gBAAgB;AACtB,MAAM,YAAY;;AAKlB,SAAgB,aACd,aACA,eACc;AACd,KAAI,CAAC,YAAa,QAAO,EAAE;CAE3B,MAAM,QAAQ,MAAM,QAAQ,YAAY,GAAG,cAAc,CAAC,YAAY;CACtE,MAAM,UAAwB,EAAE;CAChC,MAAM,UAAU,gBAAgB,IAAI,IAAI,cAAc,GAAG;AAEzD,MAAK,MAAM,QAAQ,OAAO;EAExB,MAAM,aAAa,KAAK,QAAQ,IAAI;AACpC,MAAI,eAAe,GAAI;EAEvB,MAAM,cAAc,KAAK,QAAQ,KAAK,aAAa,EAAE;AACrD,MAAI,gBAAgB,GAAI;EAExB,MAAM,QAAQ,KAAK,MAAM,GAAG,WAAW;EACvC,MAAM,WAAW,KAAK,MAAM,aAAa,GAAG,YAAY;EACxD,MAAM,QAAQ,KAAK,MAAM,cAAc,EAAE;AAEzC,MAAI,CAAC,SAAS,CAAC,MAAO;AACtB,MAAI,CAAC,iBAAiB,IAAI,SAAS,CAAE;AACrC,MAAI,WAAW,CAAC,QAAQ,IAAI,MAAM,CAAE;AAEpC,UAAQ,KAAK;GAAE;GAAiB;GAA4B;GAAO,CAAC;;AAGtE,QAAO;;;AAIT,SAAgB,UACd,WACA,eACY;AACZ,KAAI,CAAC,UAAW,QAAO,EAAE;CAEzB,MAAM,QAAQ,MAAM,QAAQ,UAAU,GAAG,YAAY,CAAC,UAAU;CAChE,MAAM,UAAsB,EAAE;CAC9B,MAAM,UAAU,gBAAgB,IAAI,IAAI,cAAc,GAAG;AAEzD,MAAK,MAAM,QAAQ,OAAO;EAExB,MAAM,YAAY,KAAK,YAAY,IAAI;AACvC,MAAI,cAAc,GAAI;EAEtB,MAAM,QAAQ,KAAK,MAAM,GAAG,UAAU;EACtC,MAAM,MAAM,KAAK,MAAM,YAAY,EAAE,CAAC,aAAa;AAEnD,MAAI,CAAC,MAAO;AACZ,MAAI,QAAQ,SAAS,QAAQ,OAAQ;AACrC,MAAI,WAAW,CAAC,QAAQ,IAAI,MAAM,CAAE;AAEpC,UAAQ,KAAK;GAAE;GAAO,WAAW;GAAK,CAAC;;AAGzC,QAAO;;;AAIT,SAAgB,gBAAgB,QAGX;CACnB,IAAI,OACF,OAAO,OAAO,SAAS,WACnB,OAAO,SAAS,OAAO,MAAM,GAAG,GAC/B,OAAO,QAAQ;CACtB,IAAI,QACF,OAAO,OAAO,UAAU,WACpB,OAAO,SAAS,OAAO,OAAO,GAAG,GAChC,OAAO,SAAS;AAEvB,KAAI,OAAO,MAAM,KAAK,IAAI,OAAO,EAAG,QAAO;AAC3C,KAAI,OAAO,MAAM,MAAM,IAAI,QAAQ,EAAG,SAAQ;AAC9C,KAAI,QAAQ,UAAW,SAAQ;AAE/B,QAAO;EAAE;EAAM;EAAO,SAAS,OAAO,KAAK;EAAO;;;AAIpD,SAAgB,iBAAiB,GAA+B;AAC9D,KAAI,CAAC,EAAG,QAAO;AACf,QAAO,EAAE,MAAM,CAAC,MAAM,GAAG,kBAAkB;;;;;;;AAU7C,SAAS,qBAAqB,QAA+D;AAC3F,KAAI,CAAC,OAAQ,QAAO,KAAA;AAGpB,KAAI,aAAa,UAAU,OAAO,WAAW,OAAO,OAAO,YAAY,SACrE,QAAO;EACL,YAAY,OAAO,KAAK,OAAO,QAAQ;EACvC,UAAU,OAAO,WAAW,OAAO,KAAK,OAAO,SAAS,GAAG,KAAA;EAC3D,YAAY,KAAA;EACb;AAIH,QAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCT,SAAgB,WACd,OACA,aAC2B;CAC3B,MAAM,aAAa,qBAAqB,YAAY;AACpD,QAAO;EACL,SAAS,aAAa,MAAM,QAAQ,YAAY,WAAW;EAC3D,MAAM,UAAU,MAAM,MAAM,YAAY,SAAS;EACjD,YAAY,gBAAgB;GAAE,MAAM,MAAM;GAAM,OAAO,MAAM;GAAO,CAAC;EACrE,QAAQ,iBAAiB,MAAM,EAAE;EAClC;;;AAMH,SAAgB,iBACd,QAC4C;CAC5C,MAAM,SAAqD,EAAE;AAE7D,KAAI,OAAO,SAAS,OAClB,QAAO,SAAS,OAAO,QAAQ,KAAK,MAAM,GAAG,EAAE,MAAM,GAAG,EAAE,SAAS,GAAG,EAAE,QAAQ;AAGlF,KAAI,OAAO,MAAM,OACf,QAAO,OAAO,OAAO,KAAK,KAAK,MAAM,GAAG,EAAE,MAAM,GAAG,EAAE,YAAY;AAGnE,KAAI,OAAO,YAAY;AACrB,SAAO,OAAO,OAAO,WAAW;AAChC,SAAO,QAAQ,OAAO,WAAW;;AAGnC,KAAI,OAAO,OACT,QAAO,IAAI,OAAO;AAGpB,QAAO"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forinda/kickjs",
3
- "version": "3.0.0",
3
+ "version": "3.0.2",
4
4
  "description": "A production-grade, decorator-driven Node.js framework built on Express 5 and TypeScript.",
5
5
  "keywords": [
6
6
  "kickjs",