![\"rapiq\"](\"https://raw.githubusercontent.com/tada5hi/rapiq/master/.github/assets/logo.svg\"){kind=logo}
\n \n\n \n \n \n
\n Parse MongoDB-style filter documents into a rapiq Query.
\n $and / $or / $nor, $gte / $in / $not / $regex, $elemMatch
\n for clients that submit filters as JSON.\n
\n ![\"npm](\"https://img.shields.io/npm/v/@rapiq/parser-mongo?color=%23a21caf&label=npm\")
![\"types\"](\"https://img.shields.io/npm/types/@rapiq/parser-mongo?color=%23db2777\")
![\"License:](\"https://img.shields.io/npm/l/@rapiq/parser-mongo?color=blue\")
\n Documentation\n ยท\n Monorepo\n ยท\n npm\n
\n\n---\n\nPart of [**rapiq**](https://github.com/tada5hi/rapiq). Typed REST queries: *build, transport, validate, execute.*\nBring a familiar MongoDB-style query document to any rapiq backend. Useful when clients submit filters as typed JSON in request bodies or saved queries.\n\n```typescript\n{\n $or: [\n { name: 'John', age: { $gte: 18, $lt: 65 } },\n { 'realm.name': { $startsWith: 'mas' } },\n ],\n}\n```\n\n- ๐ **Familiar syntax**: `$and` / `$or` / `$nor` compounds, De Morgan `$not` / `$nor` negation, field operators (`$eq`, `$gte`, `$in`, `$regex`, `$elemMatch`, โฆ) and six `$contains`-family rapiq extensions.\n- ๐ข **Typed values**: JSON keeps its types (`{ $gte: 18 }` stays a number), no wire-string coercion.\n- ๐ก๏ธ **Two-class failure model**: grammar errors always throw `FiltersParseError`; field-key/allow-list failures follow the schema drop-vs-throw policy.\n- ๐ **Same AST as every dialect**: only `filters` is mongo-flavoured; fields, relations, pagination and sorts reuse `@rapiq/parser-simple`.\n\n## Installation\n\n```sh\nnpm install @rapiq/core @rapiq/parser-simple @rapiq/parser-mongo\n```\n\n## Usage\n\n```typescript\nimport { MongoParser } from '@rapiq/parser-mongo';\n\nconst parser = new MongoParser(registry);\n\nconst query = parser.parse({\n filters: { age: { $gte: 18 }, 'realm.name': 'master' },\n sorts: '-age',\n pagination: { limit: 25 },\n}, { schema: 'user' });\n```\n\nOnly the `filters` parameter uses the mongo dialect; fields, relations, pagination and sorts accept the same input as [@rapiq/parser-simple](https://www.npmjs.com/package/@rapiq/parser-simple), and the whole thing returns the same [`Query`](https://rapiq.tada5hi.net/guide/query-ast) AST.\n\nGrammar errors (unknown `$`-operators, misplaced operators, malformed operator arguments) always throw `FiltersParseError`; field keys that fail the schema allow-list are dropped by default and throw when `throwOnFailure` is set.\n\n## The rapiq family\n\n| Package | Purpose |\n|---|---|\n| [@rapiq/core](https://github.com/tada5hi/rapiq/tree/master/packages/core) | Query AST, typed build layer & schema system (the shared foundation) |\n| [@rapiq/parser-simple](https://github.com/tada5hi/rapiq/tree/master/packages/parser-simple) | Parse plain object/array input (the \"simple\" dialect) |\n| [@rapiq/parser-expression](https://github.com/tada5hi/rapiq/tree/master/packages/parser-expression) | Parse filter expressions like `and(eq(name,'John'), gte(age,'18'))` |\n| **[@rapiq/parser-mongo](https://github.com/tada5hi/rapiq/tree/master/packages/parser-mongo)** | Parse MongoDB-style filter documents like `{ age: { $gte: 18 } }` |\n| [@rapiq/codec-url](https://github.com/tada5hi/rapiq/tree/master/packages/codec-url) | URL query-string transport codec |\n| [@rapiq/adapter-sql](https://github.com/tada5hi/rapiq/tree/master/packages/adapter-sql) | Dialect-agnostic SQL fragment adapter (pg, mysql, sqlite, mssql, oracle) |\n| [@rapiq/adapter-typeorm](https://github.com/tada5hi/rapiq/tree/master/packages/adapter-typeorm) | Apply a query to a TypeORM `SelectQueryBuilder` |\n| [@rapiq/adapter-prisma](https://github.com/tada5hi/rapiq/tree/master/packages/adapter-prisma) | Serialize a query into a Prisma argument object |\n| [@rapiq/adapter-drizzle](https://github.com/tada5hi/rapiq/tree/master/packages/adapter-drizzle) | Serialize a query into a Drizzle relational query config |\n| [@rapiq/adapter-memory](https://github.com/tada5hi/rapiq/tree/master/packages/adapter-memory) | Evaluate a query against in-memory objects & arrays |\n\n## Documentation\n\nFull guide (operator table & deviations from MongoDB): [rapiq.tada5hi.net/packages/parser-mongo](https://rapiq.tada5hi.net/packages/parser-mongo)\n\n## License\n\nPublished under the [MIT License](https://github.com/tada5hi/rapiq/blob/master/LICENSE).\n","readmeFilename":"README.md"}