sequelize-api-query-parser 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sequelize Query Parser contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,235 @@
-# Temporary Holding Version
+# sequelize-api-query-parser
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Turn HTTP-style query input into validated Sequelize v6 query options. The package is framework-independent, written in TypeScript, and ships ESM, CommonJS, source maps, and declaration files.
+
+## Requirements
+
+- Node.js 18 or newer
+- Sequelize `>=6.37.8 <7`
+- PostgreSQL for JSON text search, array containment, `iLike`, and formatted date search
+
+These are runtime requirements for package consumers. The repository's Vitest/Vite development toolchain requires Node.js 20.19+, 22.12+, or 24+.
+
+## Installation
+
+```bash
+npm install sequelize-api-query-parser sequelize
+```
+
+## TypeScript and ESM
+
+```ts
+import { QueryParser } from 'sequelize-api-query-parser';
+import type { ColumnDetail, QueryParserQuery } from 'sequelize-api-query-parser';
+import { Customer } from './models/customer.js';
+
+const query: QueryParserQuery = {
+  q: { active: 'b|true', age: { gte: 'n|18' } },
+  searchText: 'Ada',
+  searchFields: 'name,address.city',
+  select: 'id,name,age',
+  sort: '-createdAt',
+  limit: '25',
+  page: '2',
+};
+
+const columns: Readonly<Partial<Record<string, ColumnDetail>>> = {
+  age: { fieldName: 'age', type: 'INTEGER' },
+  name: { fieldName: 'name', type: 'STRING' },
+};
+
+const options = new QueryParser({
+  request: {
+    query,
+    headers: { 'client-tz': 'Asia/Kolkata' },
+  },
+  model: Customer,
+  columns,
+}).getFullQuery();
+
+const customers = await Customer.findAll(options);
+```
+
+The `request` option is structural: Express, Fastify, NestJS, another framework, or a plain object can provide `query` and `headers`. The package does not depend on a web framework or `sequelize-typescript`.
+
+## CommonJS
+
+```js
+const { QueryParser } = require('sequelize-api-query-parser');
+const { Customer } = require('./models/customer');
+
+const options = new QueryParser({
+  request: { query: req.query, headers: req.headers },
+  model: Customer,
+}).getFullQuery();
+```
+
+## Query input
+
+`getFullQuery(target?)` returns a new object and preserves extra options from `target`. It never mutates the request, query, headers, target, column metadata, or model metadata.
+
+| Input | Behavior |
+| --- | --- |
+| `q` | Field filters and nested `and`, `or`, or `not` groups |
+| `searchText` + `searchFields` | Comma-separated model or association fields searched with an `Op.or` group |
+| `checkYesNo` | Enables `yes`/`no` matching for boolean search fields |
+| `select` | Comma-separated attributes; `all` selects all and `notAll` selects none |
+| `sort` | Comma-separated fields; prefix a field with `-` for descending order |
+| `include` | Association include map described below |
+| `limit` + `page` | Positive pagination values |
+| `paranoid` | Boolean or `"true"`/`"false"` override |
+| `subQuery` | Boolean or `"true"`/`"false"` override |
+
+Fields may use validated association paths such as `address.city`. Sorting that field produces a Sequelize order path, while filtering and searching use Sequelize's `$address.city$` syntax.
+
+### Filters
+
+```ts
+const q = {
+  active: 'b|true',
+  age: { between: 'n|18,65' },
+  score: { gte: 'f|8.5' },
+  createdAt: { gt: 'd|2026-01-01T00:00:00.000Z' },
+  or: [
+    { name: { iLike: 'ada' } },
+    { 'address.city': { eq: 'Pune' } },
+  ],
+};
+```
+
+Supported operators are:
+
+- Equality and comparison: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`
+- Text and pattern: `like`, `notLike`, `iLike`, `notILike`, `iEq`, `startsWith`, `endsWith`
+- Collections and ranges: `contains`, `between`, `notBetween`, `in`, `notIn`
+- Regular expressions: `regexp`, `notRegexp`, `iRegexp`, `notIRegexp`
+- Logical groups: `and`, `or`, `not`
+
+An empty scalar string becomes `null`. Array-field `eq` and `contains` use PostgreSQL array containment; `ne` uses not-containment. JSON equality and pattern filters cast validated JSON columns to text without putting user values into the SQL literal.
+
+Typed string prefixes are useful when query-string parsers produce only strings:
+
+| Prefix | Value |
+| --- | --- |
+| `n|42` | Number |
+| `f|9.5` | Floating-point number |
+| `b|true` | Boolean |
+| `d|2026-10-22` | Date |
+| `s|0042` | String |
+
+List operators accept comma-separated values after the prefix, for example `n|18,65`. Untagged values are also coerced from Sequelize attribute metadata for integer, floating-point, boolean, and date fields. Untagged `BIGINT` and `DECIMAL` values remain validated strings so JavaScript number conversion cannot lose precision.
+
+When `columns` metadata is supplied, `whereFields` contains each configured field referenced by `q`, once, in traversal order.
+
+### Search
+
+```ts
+const query = {
+  searchText: 'Ada',
+  searchFields: 'name,notes,address.city',
+  checkYesNo: true,
+};
+```
+
+String and text fields use `Op.iLike`. Boolean fields accept yes/no matching only when `checkYesNo` is enabled. Other scalar, JSON, and array fields are searched through a validated PostgreSQL text cast. Date fields use `TO_CHAR(..., 'MM/DD/YYYY')`; a valid IANA timezone from the `client-tz` header adds `AT TIME ZONE`.
+
+Search predicates are appended to an existing top-level filter `Op.or` array without mutating either expression.
+
+### Includes
+
+Includes resolve `model.associations[name].target` directly; no application model registry is required.
+
+```ts
+const include = {
+  address: {
+    select: 'city,state',
+    required: 'true',
+    separate: false,
+    paranoid: 'false',
+    q: { city: { iLike: 'pun' } },
+    sort: '-city',
+    limit: '10',
+    page: '2',
+    include: {
+      country: 'code,name',
+    },
+  },
+  orders: 'all',
+};
+```
+
+A string value is either `all`, `notAll`, or a comma-separated selection. Object values can configure `select`, `required`, `separate`, `paranoid`, `q`, `sort`, `limit`, `page`, and nested `include`. Include recursion is capped at five association levels and circular input objects terminate safely. Passing `isGroupBy: true` to the constructor gives every include an empty attribute list.
+
+Sequelize supports `separate: true` only on `HasMany` associations; use it when a per-association limit must be applied by a separate child query.
+
+## Defaults
+
+- `limit`: `10`
+- `page`: `1`
+- maximum root and include limit: `100` (change with constructor option `maxLimit`)
+- `order`: `id DESC` when the model has an `id` attribute
+- `attributes`: all model attributes
+- `where`: empty
+- `include`: empty
+- `subQuery` and `paranoid`: `undefined` unless explicitly provided
+
+Explicit include objects default to `required: false`, `separate: false`, and `paranoid: true`.
+
+## Validation and security
+
+- Every selected, sorted, filtered, searched, and included path must resolve through supplied Sequelize model metadata.
+- Operator names come from an allowlist; dynamic access to Sequelize operators is not used.
+- Prototype-pollution keys and punctuation-bearing identifiers are rejected.
+- SQL fragments contain only validated model, attribute, association-alias, format, and timezone data. Search/filter values remain Sequelize comparison values.
+- Malformed optional fields and unknown associations are omitted instead of causing incidental parser errors.
+- Logical-filter and include recursion are bounded.
+
+Always keep normal database authorization, tenant scoping, and row-level access controls in the caller. A query parser does not replace those controls.
+
+## PostgreSQL-specific behavior
+
+Projection, ordering, pagination, basic comparisons, and includes are broadly dialect-neutral. `iLike`, regular expressions, JSON text casts, array containment, and `TO_CHAR` date search use PostgreSQL behavior and may not work on other Sequelize dialects.
+
+## Public API
+
+The package exports `QueryParser` and these TypeScript types:
+
+- `ColumnDetail`
+- `ParsedQuery`
+- `QueryParserOptions`
+- `QueryParserQuery`
+- `QueryParserRequest`
+
+Internal parser helpers are not part of the package export map.
+
+## Development
+
+```bash
+npm ci
+npm run check
+npm run test:coverage
+npm pack --dry-run
+```
+
+`npm run check` runs linting, strict type-checking, unit tests, both builds, ESM/CommonJS smoke imports, and the TypeScript consumer check.
+
+To verify an actual archive after `npm pack`:
+
+```bash
+node scripts/verify-tarball.mjs sequelize-api-query-parser-0.1.1.tgz
+```
+
+## Publishing
+
+Publishing is intentionally a separate authenticated step. Confirm that the unscoped registry name is available and that the version is correct, then run:
+
+```bash
+npm login
+npm run check
+npm pack --dry-run
+npm publish --access public
+```
+
+## License
+
+MIT

package/dist/cjs/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryParser = void 0;
+var query_parser_js_1 = require("./query-parser.js");
+Object.defineProperty(exports, "QueryParser", { enumerable: true, get: function () { return query_parser_js_1.QueryParser; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,qDAAgD;AAAvC,8GAAA,WAAW,OAAA","sourcesContent":["export { QueryParser } from './query-parser.js';\nexport type {\n  ColumnDetail,\n  ParsedQuery,\n  QueryParserOptions,\n  QueryParserQuery,\n  QueryParserRequest,\n} from './types.js';\n"]}

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/cjs/parsers/include.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseIncludes = void 0;
+const fields_js_1 = require("../utils/fields.js");
+const values_js_1 = require("../utils/values.js");
+const order_js_1 = require("./order.js");
+const select_js_1 = require("./select.js");
+const where_js_1 = require("./where.js");
+const MAX_INCLUDE_DEPTH = 5;
+const DEFAULT_MAX_LIMIT = 100;
+const getAssociationTarget = (model, associationName) => {
+    if (!(0, fields_js_1.isSafeIdentifier)(associationName)) {
+        return null;
+    }
+    const associations = model.associations;
+    if (!associations || !Object.prototype.hasOwnProperty.call(associations, associationName)) {
+        return null;
+    }
+    const target = associations[associationName]?.target;
+    return target && typeof target.getAttributes === 'function' ? target : null;
+};
+const parseOptionalPagination = (value, maxLimit) => {
+    if (value.limit === undefined) {
+        return {};
+    }
+    const limit = (0, values_js_1.parsePositiveInteger)(value.limit, 0, maxLimit);
+    if (limit === 0) {
+        return {};
+    }
+    const page = (0, values_js_1.parsePositiveInteger)(value.page, 1, Number.MAX_SAFE_INTEGER);
+    return {
+        limit,
+        offset: Math.min(limit * (page - 1), Number.MAX_SAFE_INTEGER),
+    };
+};
+const parseStringInclude = (associationName, target, value, isGroupBy) => ({
+    as: associationName,
+    model: target,
+    required: false,
+    attributes: isGroupBy ? [] : value === 'all' ? undefined : (0, select_js_1.parseSelection)(target, value),
+});
+const parseIncludes = ({ input, model, isGroupBy = false, depth = 0, seen = new WeakSet(), associationPath = [], maxLimit = DEFAULT_MAX_LIMIT, }) => {
+    if (!(0, values_js_1.isRecord)(input) || depth >= MAX_INCLUDE_DEPTH || seen.has(input)) {
+        return [];
+    }
+    seen.add(input);
+    try {
+        const normalizedMaxLimit = (0, values_js_1.parsePositiveInteger)(maxLimit, DEFAULT_MAX_LIMIT, Number.MAX_SAFE_INTEGER);
+        const result = [];
+        for (const associationName of Object.keys(input)) {
+            const target = getAssociationTarget(model, associationName);
+            if (!target) {
+                continue;
+            }
+            const value = input[associationName];
+            if (typeof value === 'string') {
+                result.push(parseStringInclude(associationName, target, value, isGroupBy));
+                continue;
+            }
+            if (!(0, values_js_1.isRecord)(value)) {
+                continue;
+            }
+            const currentAssociationPath = [...associationPath, associationName];
+            const required = (0, values_js_1.parseBoolean)(value.required, false) ?? false;
+            const separate = (0, values_js_1.parseBoolean)(value.separate, false) ?? false;
+            const paranoid = (0, values_js_1.parseBoolean)(value.paranoid, true) ?? true;
+            const queryAssociationPath = separate ? [] : currentAssociationPath;
+            const parsedWhere = Object.prototype.hasOwnProperty.call(value, 'q')
+                ? (0, where_js_1.parseWhere)({ input: value.q, model: target, associationPath: queryAssociationPath }).where
+                : undefined;
+            const where = parsedWhere && Reflect.ownKeys(parsedWhere).length > 0 ? parsedWhere : undefined;
+            const order = typeof value.sort === 'string' && value.sort.trim()
+                ? (0, order_js_1.parseOrder)(target, value.sort)
+                : undefined;
+            const attributes = isGroupBy
+                ? []
+                : typeof value.select === 'string'
+                    ? (0, select_js_1.parseSelection)(target, value.select)
+                    : undefined;
+            const nestedIncludes = Object.prototype.hasOwnProperty.call(value, 'include')
+                ? (0, exports.parseIncludes)({
+                    input: value.include,
+                    model: target,
+                    isGroupBy,
+                    depth: depth + 1,
+                    seen,
+                    associationPath: queryAssociationPath,
+                    maxLimit: normalizedMaxLimit,
+                })
+                : undefined;
+            result.push({
+                as: associationName,
+                model: target,
+                required,
+                separate,
+                paranoid,
+                where,
+                order,
+                ...parseOptionalPagination(value, normalizedMaxLimit),
+                attributes,
+                include: nestedIncludes,
+            });
+        }
+        return result;
+    }
+    finally {
+        seen.delete(input);
+    }
+};
+exports.parseIncludes = parseIncludes;
+//# sourceMappingURL=include.js.map

package/dist/cjs/parsers/include.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"include.js","sourceRoot":"","sources":["../../../src/parsers/include.ts"],"names":[],"mappings":";;;AAEA,kDAAsD;AACtD,kDAAkF;AAClF,yCAAwC;AACxC,2CAA6C;AAC7C,yCAAwC;AAExC,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAC5B,MAAM,iBAAiB,GAAG,GAAG,CAAC;AA8B9B,MAAM,oBAAoB,GAAG,CAC3B,KAAyB,EACzB,eAAuB,EACI,EAAE;IAC7B,IAAI,CAAC,IAAA,4BAAgB,EAAC,eAAe,CAAC,EAAE,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,YAAY,GAAG,KAAK,CAAC,YAA6D,CAAC;IACzF,IAAI,CAAC,YAAY,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,CAAC;QAC1F,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,MAAM,GAAG,YAAY,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IACrD,OAAO,MAAM,IAAI,OAAO,MAAM,CAAC,aAAa,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AAC9E,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,KAA8B,EAAE,QAAgB,EAAE,EAAE;IACnF,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,KAAK,GAAG,IAAA,gCAAoB,EAAC,KAAK,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC7D,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAChB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,IAAI,GAAG,IAAA,gCAAoB,EAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAC1E,OAAO;QACL,KAAK;QACL,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,gBAAgB,CAAC;KAC9D,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CACzB,eAAuB,EACvB,MAA0B,EAC1B,KAAa,EACb,SAAkB,EACH,EAAE,CAAC,CAAC;IACnB,EAAE,EAAE,eAAe;IACnB,KAAK,EAAE,MAAM;IACb,QAAQ,EAAE,KAAK;IACf,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,0BAAc,EAAC,MAAM,EAAE,KAAK,CAAC;CACzF,CAAC,CAAC;AAEI,MAAM,aAAa,GAAG,CAAC,EAC5B,KAAK,EACL,KAAK,EACL,SAAS,GAAG,KAAK,EACjB,KAAK,GAAG,CAAC,EACT,IAAI,GAAG,IAAI,OAAO,EAAU,EAC5B,eAAe,GAAG,EAAE,EACpB,QAAQ,GAAG,iBAAiB,GACP,EAAiB,EAAE;IACxC,IAAI,CAAC,IAAA,oBAAQ,EAAC,KAAK,CAAC,IAAI,KAAK,IAAI,iBAAiB,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QACtE,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAChB,IAAI,CAAC;QACH,MAAM,kBAAkB,GAAG,IAAA,gCAAoB,EAC7C,QAAQ,EACR,iBAAiB,EACjB,MAAM,CAAC,gBAAgB,CACxB,CAAC;QACF,MAAM,MAAM,GAAkB,EAAE,CAAC;QACjC,KAAK,MAAM,eAAe,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACjD,MAAM,MAAM,GAAG,oBAAoB,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;YAC5D,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,SAAS;YACX,CAAC;YAED,MAAM,KAAK,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC;YACrC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9B,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,eAAe,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAgB,CAAC,CAAC;gBAC1F,SAAS;YACX,CAAC;YACD,IAAI,CAAC,IAAA,oBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,SAAS;YACX,CAAC;YAED,MAAM,sBAAsB,GAAG,CAAC,GAAG,eAAe,EAAE,eAAe,CAAC,CAAC;YACrE,MAAM,QAAQ,GAAG,IAAA,wBAAY,EAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC;YAC9D,MAAM,QAAQ,GAAG,IAAA,wBAAY,EAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC;YAC9D,MAAM,QAAQ,GAAG,IAAA,wBAAY,EAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC;YAC5D,MAAM,oBAAoB,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,sBAAsB,CAAC;YACpE,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC;gBAClE,CAAC,CAAC,IAAA,qBAAU,EAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,oBAAoB,EAAE,CAAC,CAAC,KAAK;gBAC5F,CAAC,CAAC,SAAS,CAAC;YACd,MAAM,KAAK,GAAG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YAC/F,MAAM,KAAK,GAAG,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE;gBAC/D,CAAC,CAAC,IAAA,qBAAU,EAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC;gBAChC,CAAC,CAAC,SAAS,CAAC;YACd,MAAM,UAAU,GAAG,SAAS;gBAC1B,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ;oBAChC,CAAC,CAAC,IAAA,0BAAc,EAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;oBACtC,CAAC,CAAC,SAAS,CAAC;YAChB,MAAM,cAAc,GAAG,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC;gBAC3E,CAAC,CAAC,IAAA,qBAAa,EAAC;oBACZ,KAAK,EAAE,KAAK,CAAC,OAAO;oBACpB,KAAK,EAAE,MAAM;oBACb,SAAS;oBACT,KAAK,EAAE,KAAK,GAAG,CAAC;oBAChB,IAAI;oBACJ,eAAe,EAAE,oBAAoB;oBACrC,QAAQ,EAAE,kBAAkB;iBAC7B,CAAC;gBACJ,CAAC,CAAC,SAAS,CAAC;YAEd,MAAM,CAAC,IAAI,CAAC;gBACV,EAAE,EAAE,eAAe;gBACnB,KAAK,EAAE,MAAM;gBACb,QAAQ;gBACR,QAAQ;gBACR,QAAQ;gBACR,KAAK;gBACL,KAAK;gBACL,GAAG,uBAAuB,CAAC,KAAK,EAAE,kBAAkB,CAAC;gBACrD,UAAU;gBACV,OAAO,EAAE,cAAc;aACT,CAAC,CAAC;QACpB,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;YAAS,CAAC;QACT,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;AACH,CAAC,CAAC;AAlFW,QAAA,aAAa,iBAkFxB","sourcesContent":["import type { Includeable, Model, ModelStatic, Order, WhereOptions } from 'sequelize';\n\nimport { isSafeIdentifier } from '../utils/fields.js';\nimport { isRecord, parseBoolean, parsePositiveInteger } from '../utils/values.js';\nimport { parseOrder } from './order.js';\nimport { parseSelection } from './select.js';\nimport { parseWhere } from './where.js';\n\nconst MAX_INCLUDE_DEPTH = 5;\nconst DEFAULT_MAX_LIMIT = 100;\n\ninterface ParseIncludesOptions {\n  readonly input: unknown;\n  readonly model: ModelStatic<Model>;\n  readonly isGroupBy?: boolean;\n  readonly depth?: number;\n  readonly seen?: WeakSet<object>;\n  readonly associationPath?: readonly string[];\n  readonly maxLimit?: number;\n}\n\ninterface AssociationTarget {\n  readonly target?: ModelStatic<Model>;\n}\n\ninterface ParsedInclude {\n  readonly as: string;\n  readonly model: ModelStatic<Model>;\n  readonly required: boolean;\n  readonly separate?: boolean;\n  readonly paranoid?: boolean;\n  readonly where?: WhereOptions;\n  readonly order?: Order;\n  readonly limit?: number;\n  readonly offset?: number;\n  readonly attributes?: string[];\n  readonly include?: Includeable[];\n}\n\nconst getAssociationTarget = (\n  model: ModelStatic<Model>,\n  associationName: string,\n): ModelStatic<Model> | null => {\n  if (!isSafeIdentifier(associationName)) {\n    return null;\n  }\n\n  const associations = model.associations as Record<string, AssociationTarget> | undefined;\n  if (!associations || !Object.prototype.hasOwnProperty.call(associations, associationName)) {\n    return null;\n  }\n\n  const target = associations[associationName]?.target;\n  return target && typeof target.getAttributes === 'function' ? target : null;\n};\n\nconst parseOptionalPagination = (value: Record<string, unknown>, maxLimit: number) => {\n  if (value.limit === undefined) {\n    return {};\n  }\n\n  const limit = parsePositiveInteger(value.limit, 0, maxLimit);\n  if (limit === 0) {\n    return {};\n  }\n\n  const page = parsePositiveInteger(value.page, 1, Number.MAX_SAFE_INTEGER);\n  return {\n    limit,\n    offset: Math.min(limit * (page - 1), Number.MAX_SAFE_INTEGER),\n  };\n};\n\nconst parseStringInclude = (\n  associationName: string,\n  target: ModelStatic<Model>,\n  value: string,\n  isGroupBy: boolean,\n): ParsedInclude => ({\n  as: associationName,\n  model: target,\n  required: false,\n  attributes: isGroupBy ? [] : value === 'all' ? undefined : parseSelection(target, value),\n});\n\nexport const parseIncludes = ({\n  input,\n  model,\n  isGroupBy = false,\n  depth = 0,\n  seen = new WeakSet<object>(),\n  associationPath = [],\n  maxLimit = DEFAULT_MAX_LIMIT,\n}: ParseIncludesOptions): Includeable[] => {\n  if (!isRecord(input) || depth >= MAX_INCLUDE_DEPTH || seen.has(input)) {\n    return [];\n  }\n\n  seen.add(input);\n  try {\n    const normalizedMaxLimit = parsePositiveInteger(\n      maxLimit,\n      DEFAULT_MAX_LIMIT,\n      Number.MAX_SAFE_INTEGER,\n    );\n    const result: Includeable[] = [];\n    for (const associationName of Object.keys(input)) {\n      const target = getAssociationTarget(model, associationName);\n      if (!target) {\n        continue;\n      }\n\n      const value = input[associationName];\n      if (typeof value === 'string') {\n        result.push(parseStringInclude(associationName, target, value, isGroupBy) as Includeable);\n        continue;\n      }\n      if (!isRecord(value)) {\n        continue;\n      }\n\n      const currentAssociationPath = [...associationPath, associationName];\n      const required = parseBoolean(value.required, false) ?? false;\n      const separate = parseBoolean(value.separate, false) ?? false;\n      const paranoid = parseBoolean(value.paranoid, true) ?? true;\n      const queryAssociationPath = separate ? [] : currentAssociationPath;\n      const parsedWhere = Object.prototype.hasOwnProperty.call(value, 'q')\n        ? parseWhere({ input: value.q, model: target, associationPath: queryAssociationPath }).where\n        : undefined;\n      const where = parsedWhere && Reflect.ownKeys(parsedWhere).length > 0 ? parsedWhere : undefined;\n      const order = typeof value.sort === 'string' && value.sort.trim()\n        ? parseOrder(target, value.sort)\n        : undefined;\n      const attributes = isGroupBy\n        ? []\n        : typeof value.select === 'string'\n          ? parseSelection(target, value.select)\n          : undefined;\n      const nestedIncludes = Object.prototype.hasOwnProperty.call(value, 'include')\n        ? parseIncludes({\n            input: value.include,\n            model: target,\n            isGroupBy,\n            depth: depth + 1,\n            seen,\n            associationPath: queryAssociationPath,\n            maxLimit: normalizedMaxLimit,\n          })\n        : undefined;\n\n      result.push({\n        as: associationName,\n        model: target,\n        required,\n        separate,\n        paranoid,\n        where,\n        order,\n        ...parseOptionalPagination(value, normalizedMaxLimit),\n        attributes,\n        include: nestedIncludes,\n      } as Includeable);\n    }\n    return result;\n  } finally {\n    seen.delete(input);\n  }\n};\n"]}

package/dist/cjs/parsers/order.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseOrder = void 0;
+const fields_js_1 = require("../utils/fields.js");
+const tokenizeSort = (input) => {
+    const tokens = [];
+    let token = '';
+    let bracketDepth = 0;
+    const pushToken = () => {
+        const trimmed = token.trim();
+        if (trimmed) {
+            tokens.push(trimmed);
+        }
+        token = '';
+    };
+    for (const character of input) {
+        if (character === ',' && bracketDepth === 0) {
+            pushToken();
+            continue;
+        }
+        token += character;
+        if (character === '[') {
+            bracketDepth += 1;
+        }
+        else if (character === ']') {
+            bracketDepth = Math.max(0, bracketDepth - 1);
+        }
+    }
+    pushToken();
+    return tokens;
+};
+const defaultOrder = (model) => (0, fields_js_1.resolveField)(model, 'id') ? [['id', 'DESC']] : [];
+const parseOrder = (model, input) => {
+    if (typeof input !== 'string' || input.trim() === '') {
+        return defaultOrder(model);
+    }
+    const order = tokenizeSort(input).flatMap((token) => {
+        const descending = token.startsWith('-');
+        const fieldPath = descending ? token.slice(1) : token;
+        const resolved = (0, fields_js_1.resolveField)(model, fieldPath);
+        if (!resolved) {
+            return [];
+        }
+        return [[...resolved.path, descending ? 'DESC' : 'ASC']];
+    });
+    return order.length > 0 ? order : defaultOrder(model);
+};
+exports.parseOrder = parseOrder;
+//# sourceMappingURL=order.js.map

package/dist/cjs/parsers/order.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order.js","sourceRoot":"","sources":["../../../src/parsers/order.ts"],"names":[],"mappings":";;;AAEA,kDAAkD;AAElD,MAAM,YAAY,GAAG,CAAC,KAAa,EAAY,EAAE;IAC/C,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,IAAI,YAAY,GAAG,CAAC,CAAC;IAErB,MAAM,SAAS,GAAG,GAAG,EAAE;QACrB,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC7B,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;QACD,KAAK,GAAG,EAAE,CAAC;IACb,CAAC,CAAC;IAEF,KAAK,MAAM,SAAS,IAAI,KAAK,EAAE,CAAC;QAC9B,IAAI,SAAS,KAAK,GAAG,IAAI,YAAY,KAAK,CAAC,EAAE,CAAC;YAC5C,SAAS,EAAE,CAAC;YACZ,SAAS;QACX,CAAC;QAED,KAAK,IAAI,SAAS,CAAC;QACnB,IAAI,SAAS,KAAK,GAAG,EAAE,CAAC;YACtB,YAAY,IAAI,CAAC,CAAC;QACpB,CAAC;aAAM,IAAI,SAAS,KAAK,GAAG,EAAE,CAAC;YAC7B,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,GAAG,CAAC,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IACD,SAAS,EAAE,CAAC;IAEZ,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,KAAyB,EAAS,EAAE,CACxD,IAAA,wBAAY,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAE7C,MAAM,UAAU,GAAG,CAAC,KAAyB,EAAE,KAAc,EAAS,EAAE;IAC7E,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACrD,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAClD,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACtD,MAAM,QAAQ,GAAG,IAAA,wBAAY,EAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAChD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAE,KAAe,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;AACnE,CAAC,CAAC;AAjBW,QAAA,UAAU,cAiBrB","sourcesContent":["import type { Model, ModelStatic, Order } from 'sequelize';\n\nimport { resolveField } from '../utils/fields.js';\n\nconst tokenizeSort = (input: string): string[] => {\n  const tokens: string[] = [];\n  let token = '';\n  let bracketDepth = 0;\n\n  const pushToken = () => {\n    const trimmed = token.trim();\n    if (trimmed) {\n      tokens.push(trimmed);\n    }\n    token = '';\n  };\n\n  for (const character of input) {\n    if (character === ',' && bracketDepth === 0) {\n      pushToken();\n      continue;\n    }\n\n    token += character;\n    if (character === '[') {\n      bracketDepth += 1;\n    } else if (character === ']') {\n      bracketDepth = Math.max(0, bracketDepth - 1);\n    }\n  }\n  pushToken();\n\n  return tokens;\n};\n\nconst defaultOrder = (model: ModelStatic<Model>): Order =>\n  resolveField(model, 'id') ? [['id', 'DESC']] : [];\n\nexport const parseOrder = (model: ModelStatic<Model>, input: unknown): Order => {\n  if (typeof input !== 'string' || input.trim() === '') {\n    return defaultOrder(model);\n  }\n\n  const order = tokenizeSort(input).flatMap((token) => {\n    const descending = token.startsWith('-');\n    const fieldPath = descending ? token.slice(1) : token;\n    const resolved = resolveField(model, fieldPath);\n    if (!resolved) {\n      return [];\n    }\n\n    return [[...resolved.path, descending ? 'DESC' : 'ASC']];\n  });\n\n  return order.length > 0 ? (order as Order) : defaultOrder(model);\n};\n"]}

package/dist/cjs/parsers/search.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeSearchWhere = exports.parseSearch = void 0;
+const sequelize_1 = require("sequelize");
+const fields_js_1 = require("../utils/fields.js");
+const values_js_1 = require("../utils/values.js");
+const STRING_TYPES = new Set(['CHAR', 'CITEXT', 'STRING', 'TEXT', 'VARCHAR']);
+const DATE_TYPES = new Set(['DATE', 'DATEONLY', 'DATETIME']);
+const getOutputKey = (path) => path.length > 1 ? `$${path.join('.')}$` : path[0] ?? '';
+const parseSearchFields = (value) => {
+    if (typeof value !== 'string') {
+        return [];
+    }
+    return [...new Set(value.split(',').map((field) => field.trim()).filter(Boolean))];
+};
+const parseYesNo = (value) => {
+    const normalized = value.trim().toLowerCase();
+    if (normalized && 'yes'.includes(normalized)) {
+        return true;
+    }
+    if (normalized && 'no'.includes(normalized)) {
+        return false;
+    }
+    return null;
+};
+const buildTextCast = (reference, searchText) => (0, sequelize_1.where)((0, sequelize_1.literal)(`${reference}::text`), sequelize_1.Op.iLike, `%${searchText}%`);
+const parseSearch = ({ searchText, searchFields, checkYesNo, timezone, model, columns = {}, }) => {
+    if (typeof searchText !== 'string' || !searchText.trim()) {
+        return null;
+    }
+    const fields = parseSearchFields(searchFields);
+    const clauses = [];
+    const yesNo = (0, values_js_1.parseBoolean)(checkYesNo, false) ? parseYesNo(searchText) : null;
+    const validTimezone = (0, values_js_1.isValidTimeZone)(timezone) ? timezone : undefined;
+    for (const field of fields) {
+        const resolved = (0, fields_js_1.resolveField)(model, field);
+        if (!resolved) {
+            continue;
+        }
+        const typeName = resolved.typeName ?? columns[field]?.type;
+        const outputKey = getOutputKey(resolved.path);
+        if (typeName === 'BOOLEAN') {
+            if (yesNo !== null) {
+                clauses.push({ [outputKey]: yesNo });
+            }
+            continue;
+        }
+        if (STRING_TYPES.has(typeName ?? '')) {
+            clauses.push({ [outputKey]: { [sequelize_1.Op.iLike]: `%${searchText}%` } });
+            continue;
+        }
+        const reference = (0, fields_js_1.getSqlFieldReference)(model, resolved.path);
+        if (!reference) {
+            continue;
+        }
+        if (DATE_TYPES.has(typeName ?? '')) {
+            if (!(0, values_js_1.isValidDateText)(searchText)) {
+                continue;
+            }
+            const timezoneSql = validTimezone ? ` AT TIME ZONE '${validTimezone}'` : '';
+            clauses.push((0, sequelize_1.where)((0, sequelize_1.literal)(`TO_CHAR(${reference}${timezoneSql}, 'MM/DD/YYYY')`), sequelize_1.Op.iLike, `%${searchText}%`));
+            continue;
+        }
+        clauses.push(buildTextCast(reference, searchText));
+    }
+    return clauses.length > 0 ? { [sequelize_1.Op.or]: clauses } : null;
+};
+exports.parseSearch = parseSearch;
+const mergeSearchWhere = (filterWhere, searchWhere) => {
+    if (!searchWhere) {
+        return filterWhere;
+    }
+    const filterRecord = filterWhere;
+    const searchRecord = searchWhere;
+    const filterOrValue = filterRecord[sequelize_1.Op.or];
+    const searchOrValue = searchRecord[sequelize_1.Op.or];
+    const filterOr = Array.isArray(filterOrValue) ? filterOrValue : [];
+    const searchOr = Array.isArray(searchOrValue) ? searchOrValue : [];
+    return {
+        ...filterRecord,
+        [sequelize_1.Op.or]: [...filterOr, ...searchOr],
+    };
+};
+exports.mergeSearchWhere = mergeSearchWhere;
+//# sourceMappingURL=search.js.map

package/dist/cjs/parsers/search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/parsers/search.ts"],"names":[],"mappings":";;;AAAA,yCAAiE;AAIjE,kDAAwE;AACxE,kDAAoF;AAEpF,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;AAC9E,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;AAW7D,MAAM,YAAY,GAAG,CAAC,IAAuB,EAAU,EAAE,CACvD,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAE1D,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAAY,EAAE;IACrD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACrF,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,KAAa,EAAkB,EAAE;IACnD,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC9C,IAAI,UAAU,IAAI,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,UAAU,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,SAAiB,EAAE,UAAkB,EAAE,EAAE,CAC9D,IAAA,iBAAc,EAAC,IAAA,mBAAO,EAAC,GAAG,SAAS,QAAQ,CAAC,EAAE,cAAE,CAAC,KAAK,EAAE,IAAI,UAAU,GAAG,CAAC,CAAC;AAEtE,MAAM,WAAW,GAAG,CAAC,EAC1B,UAAU,EACV,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,KAAK,EACL,OAAO,GAAG,EAAE,GACO,EAAuB,EAAE;IAC5C,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC;QACzD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,MAAM,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAAC;IAC/C,MAAM,OAAO,GAAc,EAAE,CAAC;IAC9B,MAAM,KAAK,GAAG,IAAA,wBAAY,EAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC9E,MAAM,aAAa,GAAG,IAAA,2BAAe,EAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;IAEvE,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAG,IAAA,wBAAY,EAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,SAAS;QACX,CAAC;QAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC;QAC3D,MAAM,SAAS,GAAG,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBACnB,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;YACvC,CAAC;YACD,SAAS;QACX,CAAC;QAED,IAAI,YAAY,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE,CAAC;YACrC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,cAAE,CAAC,KAAK,CAAC,EAAE,IAAI,UAAU,GAAG,EAAE,EAAE,CAAC,CAAC;YACjE,SAAS;QACX,CAAC;QAED,MAAM,SAAS,GAAG,IAAA,gCAAoB,EAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAS;QACX,CAAC;QAED,IAAI,UAAU,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE,CAAC;YACnC,IAAI,CAAC,IAAA,2BAAe,EAAC,UAAU,CAAC,EAAE,CAAC;gBACjC,SAAS;YACX,CAAC;YAED,MAAM,WAAW,GAAG,aAAa,CAAC,CAAC,CAAC,kBAAkB,aAAa,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5E,OAAO,CAAC,IAAI,CACV,IAAA,iBAAc,EACZ,IAAA,mBAAO,EAAC,WAAW,SAAS,GAAG,WAAW,iBAAiB,CAAC,EAC5D,cAAE,CAAC,KAAK,EACR,IAAI,UAAU,GAAG,CAClB,CACF,CAAC;YACF,SAAS;QACX,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;IACrD,CAAC;IAED,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAE,EAAE,CAAC,cAAE,CAAC,EAAE,CAAC,EAAE,OAAO,EAAmB,CAAC,CAAC,CAAC,IAAI,CAAC;AAC5E,CAAC,CAAC;AA9DW,QAAA,WAAW,eA8DtB;AAEK,MAAM,gBAAgB,GAAG,CAC9B,WAAyB,EACzB,WAAgC,EAClB,EAAE;IAChB,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,MAAM,YAAY,GAAG,WAA2C,CAAC;IACjE,MAAM,YAAY,GAAG,WAA2C,CAAC;IACjE,MAAM,aAAa,GAAG,YAAY,CAAC,cAAE,CAAC,EAAE,CAAC,CAAC;IAC1C,MAAM,aAAa,GAAG,YAAY,CAAC,cAAE,CAAC,EAAE,CAAC,CAAC;IAC1C,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;IACnE,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;IAEnE,OAAO;QACL,GAAG,YAAY;QACf,CAAC,cAAE,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,GAAG,QAAQ,CAAC;KACpB,CAAC;AACpB,CAAC,CAAC;AAnBW,QAAA,gBAAgB,oBAmB3B","sourcesContent":["import { Op, literal, where as sequelizeWhere } from 'sequelize';\nimport type { Model, ModelStatic, WhereOptions } from 'sequelize';\n\nimport type { ColumnDetail } from '../types.js';\nimport { getSqlFieldReference, resolveField } from '../utils/fields.js';\nimport { isValidDateText, isValidTimeZone, parseBoolean } from '../utils/values.js';\n\nconst STRING_TYPES = new Set(['CHAR', 'CITEXT', 'STRING', 'TEXT', 'VARCHAR']);\nconst DATE_TYPES = new Set(['DATE', 'DATEONLY', 'DATETIME']);\n\ninterface ParseSearchOptions {\n  readonly searchText: unknown;\n  readonly searchFields: unknown;\n  readonly checkYesNo?: unknown;\n  readonly timezone?: unknown;\n  readonly model: ModelStatic<Model>;\n  readonly columns?: Readonly<Partial<Record<string, ColumnDetail>>>;\n}\n\nconst getOutputKey = (path: readonly string[]): string =>\n  path.length > 1 ? `$${path.join('.')}$` : path[0] ?? '';\n\nconst parseSearchFields = (value: unknown): string[] => {\n  if (typeof value !== 'string') {\n    return [];\n  }\n\n  return [...new Set(value.split(',').map((field) => field.trim()).filter(Boolean))];\n};\n\nconst parseYesNo = (value: string): boolean | null => {\n  const normalized = value.trim().toLowerCase();\n  if (normalized && 'yes'.includes(normalized)) {\n    return true;\n  }\n  if (normalized && 'no'.includes(normalized)) {\n    return false;\n  }\n  return null;\n};\n\nconst buildTextCast = (reference: string, searchText: string) =>\n  sequelizeWhere(literal(`${reference}::text`), Op.iLike, `%${searchText}%`);\n\nexport const parseSearch = ({\n  searchText,\n  searchFields,\n  checkYesNo,\n  timezone,\n  model,\n  columns = {},\n}: ParseSearchOptions): WhereOptions | null => {\n  if (typeof searchText !== 'string' || !searchText.trim()) {\n    return null;\n  }\n\n  const fields = parseSearchFields(searchFields);\n  const clauses: unknown[] = [];\n  const yesNo = parseBoolean(checkYesNo, false) ? parseYesNo(searchText) : null;\n  const validTimezone = isValidTimeZone(timezone) ? timezone : undefined;\n\n  for (const field of fields) {\n    const resolved = resolveField(model, field);\n    if (!resolved) {\n      continue;\n    }\n\n    const typeName = resolved.typeName ?? columns[field]?.type;\n    const outputKey = getOutputKey(resolved.path);\n    if (typeName === 'BOOLEAN') {\n      if (yesNo !== null) {\n        clauses.push({ [outputKey]: yesNo });\n      }\n      continue;\n    }\n\n    if (STRING_TYPES.has(typeName ?? '')) {\n      clauses.push({ [outputKey]: { [Op.iLike]: `%${searchText}%` } });\n      continue;\n    }\n\n    const reference = getSqlFieldReference(model, resolved.path);\n    if (!reference) {\n      continue;\n    }\n\n    if (DATE_TYPES.has(typeName ?? '')) {\n      if (!isValidDateText(searchText)) {\n        continue;\n      }\n\n      const timezoneSql = validTimezone ? ` AT TIME ZONE '${validTimezone}'` : '';\n      clauses.push(\n        sequelizeWhere(\n          literal(`TO_CHAR(${reference}${timezoneSql}, 'MM/DD/YYYY')`),\n          Op.iLike,\n          `%${searchText}%`,\n        ),\n      );\n      continue;\n    }\n\n    clauses.push(buildTextCast(reference, searchText));\n  }\n\n  return clauses.length > 0 ? ({ [Op.or]: clauses } as WhereOptions) : null;\n};\n\nexport const mergeSearchWhere = (\n  filterWhere: WhereOptions,\n  searchWhere: WhereOptions | null,\n): WhereOptions => {\n  if (!searchWhere) {\n    return filterWhere;\n  }\n\n  const filterRecord = filterWhere as Record<PropertyKey, unknown>;\n  const searchRecord = searchWhere as Record<PropertyKey, unknown>;\n  const filterOrValue = filterRecord[Op.or];\n  const searchOrValue = searchRecord[Op.or];\n  const filterOr = Array.isArray(filterOrValue) ? filterOrValue : [];\n  const searchOr = Array.isArray(searchOrValue) ? searchOrValue : [];\n\n  return {\n    ...filterRecord,\n    [Op.or]: [...filterOr, ...searchOr],\n  } as WhereOptions;\n};\n"]}

package/dist/cjs/parsers/select.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseSelection = void 0;
+const fields_js_1 = require("../utils/fields.js");
+const IDENTITY_FIELDS = ['id', 'deleted_at'];
+const parseSelection = (model, input) => {
+    if (typeof input !== 'string' || input.trim() === '' || input === 'all') {
+        return (0, fields_js_1.getAttributeNames)(model);
+    }
+    if (input === 'notAll') {
+        return [];
+    }
+    const selected = [];
+    for (const candidate of input.split(',')) {
+        const field = candidate.trim();
+        const resolved = (0, fields_js_1.resolveField)(model, field);
+        if (resolved?.path.length === 1 && !selected.includes(resolved.attribute)) {
+            selected.push(resolved.attribute);
+        }
+    }
+    for (const identityField of IDENTITY_FIELDS) {
+        if ((0, fields_js_1.resolveField)(model, identityField) && !selected.includes(identityField)) {
+            selected.push(identityField);
+        }
+    }
+    return selected;
+};
+exports.parseSelection = parseSelection;
+//# sourceMappingURL=select.js.map

package/dist/cjs/parsers/select.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"select.js","sourceRoot":"","sources":["../../../src/parsers/select.ts"],"names":[],"mappings":";;;AAEA,kDAAqE;AAErE,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,YAAY,CAAU,CAAC;AAE/C,MAAM,cAAc,GAAG,CAAC,KAAyB,EAAE,KAAc,EAAY,EAAE;IACpF,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;QACxE,OAAO,IAAA,6BAAiB,EAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,SAAS,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACzC,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,IAAA,wBAAY,EAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC5C,IAAI,QAAQ,EAAE,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1E,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;QAC5C,IAAI,IAAA,wBAAY,EAAC,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YAC5E,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAzBW,QAAA,cAAc,kBAyBzB","sourcesContent":["import type { Model, ModelStatic } from 'sequelize';\n\nimport { getAttributeNames, resolveField } from '../utils/fields.js';\n\nconst IDENTITY_FIELDS = ['id', 'deleted_at'] as const;\n\nexport const parseSelection = (model: ModelStatic<Model>, input: unknown): string[] => {\n  if (typeof input !== 'string' || input.trim() === '' || input === 'all') {\n    return getAttributeNames(model);\n  }\n\n  if (input === 'notAll') {\n    return [];\n  }\n\n  const selected: string[] = [];\n  for (const candidate of input.split(',')) {\n    const field = candidate.trim();\n    const resolved = resolveField(model, field);\n    if (resolved?.path.length === 1 && !selected.includes(resolved.attribute)) {\n      selected.push(resolved.attribute);\n    }\n  }\n\n  for (const identityField of IDENTITY_FIELDS) {\n    if (resolveField(model, identityField) && !selected.includes(identityField)) {\n      selected.push(identityField);\n    }\n  }\n\n  return selected;\n};\n"]}