{"id":42044270,"url":"https://github.com/rkrishn7/objection-match","last_synced_at":"2026-01-26T06:05:50.898Z","repository":{"id":57312904,"uuid":"297044048","full_name":"rkrishn7/objection-match","owner":"rkrishn7","description":"A lightweight search DSL for Objection.js.","archived":false,"fork":false,"pushed_at":"2020-09-27T20:09:31.000Z","size":409,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-01T04:55:20.110Z","etag":null,"topics":["dsl","mariadb","mssql","mysql","objection-orm","objectionjs","postgresql","search","sqlite3"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rkrishn7.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-20T09:38:24.000Z","updated_at":"2020-09-27T20:09:33.000Z","dependencies_parsed_at":"2022-09-20T23:02:45.870Z","dependency_job_id":null,"html_url":"https://github.com/rkrishn7/objection-match","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/rkrishn7/objection-match","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rkrishn7%2Fobjection-match","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rkrishn7%2Fobjection-match/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rkrishn7%2Fobjection-match/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rkrishn7%2Fobjection-match/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rkrishn7","download_url":"https://codeload.github.com/rkrishn7/objection-match/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rkrishn7%2Fobjection-match/sbom","scorecard":{"id":778350,"data":{"date":"2025-08-11","repo":{"name":"github.com/rkrishn7/objection-match","commit":"9ff1dbe412e424d28ff2a191f6ffb023f09082a5"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/25 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 5 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"43 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-mhxj-85r3-2x55","Warn: Project is vulnerable to: GHSA-8mmm-9v2q-x3f9","Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-4jv9-3563-23j3","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-4r62-v4vq-hr96","Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj","Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf","Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-px4h-xg32-q955","Warn: Project is vulnerable to: GHSA-r659-8xfp-j327","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7","Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6","Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v","Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-23T04:14:08.434Z","repository_id":57312904,"created_at":"2025-08-23T04:14:08.434Z","updated_at":"2025-08-23T04:14:08.434Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28768058,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T03:54:34.369Z","status":"ssl_error","status_checked_at":"2026-01-26T03:54:33.031Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dsl","mariadb","mssql","mysql","objection-orm","objectionjs","postgresql","search","sqlite3"],"created_at":"2026-01-26T06:05:50.831Z","updated_at":"2026-01-26T06:05:50.892Z","avatar_url":"https://github.com/rkrishn7.png","language":"TypeScript","readme":"# objection-match\n\n[![npm version](https://badge.fury.io/js/objection-match.svg)](https://badge.fury.io/js/objection-match)\n\nA lightweight search plugin built on top of [Objection.js](https://github.com/Vincit/objection.js).\n\n**objection-match** was created for programs that wish to easily support dynamic searches. In a distributed setting, a set of constraints for a search may be defined on a client machine and sent to a server for processing. However, the task of parsing the payload, loading relations, and building a query can be cumbersome. This library provides a robust and portable query language that can be used to represent a complex search with various constraints, and from it, build an Objection query.\n\n## Installation\n\n```sh\n# npm\nnpm install --save objection-match\n\n# yarn\nyarn add objection-match\n```\n\n## Grammar\n\nThe grammar can be found in [src/lib/parser/parser.pegjs](https://github.com/rkrishn7/objection-match/blob/master/src/lib/parser/parser.pegjs). It defines the structure of the query language.\n\nBriefly, a query consists of _logical_ and _comparison_ nodes. The tables below describe the mapping from each node to their respective function.\n\n\u003ctable\u003e\n\u003ctr\u003e\u003cth\u003eLogical Node Mappings\u003c/th\u003e\u003cth\u003eComparison Node Mappings\u003c/th\u003e\u003c/tr\u003e\n\u003ctr\u003e\u003ctd\u003e\n\n| Logical Node | Corresponding Function |\n| ------------ | ---------------------- |\n| match_all    | AND                    |\n| match_any    | OR                     |\n\n\u003c/td\u003e\u003ctd\u003e\n\n| Comparison Node | Corresponding Function |\n| --------------- | ---------------------- |\n| eq              | =                      |\n| neq             | !=                     |\n| geq             | \u003e=                     |\n| leq             | \u003c=                     |\n| lt              | \u003c                      |\n| gt              | \u003e                      |\n| like            | LIKE                   |\n| in              | IN                     |\n\n\u003c/td\u003e\u003c/tr\u003e \u003c/table\u003e\n\nLogical nodes can contain children that include both node types while comparison nodes cannot contain any children. Here's an example:\n\n```js\nmatch_all: {\n  eq: [\"person.name\", \"Antonio\"],\n  neq: [\"shirt.color\", \"white\"],\n  match_any: {\n    eq: [\"shirt.style\", \"polo\"],\n    eq: [\"shirt.style\", \"dress\"]\n  }\n}\n```\n\nA simple, browser-compatible package that constructs this syntax will be available as well.\n\n## Usage\n\nThe `search()` method is invoked directly on a model class. In order to support this, the plugin mixin needs to be added to any models that wish to use it. Example usage:\n\n```tsx\nimport Search from 'objection-match';\n\nclass Employee extends Search({ ...plugin options })(Model) {\n  ...\n}\n```\n\nNow, you can call the `search()` method like so:\n\n```tsx\nconst results = await Employee.search({\n  predicate: `\n    match_all: {\n      geq: [\"salary\", 60000],\n      geq: [\"salary_start_date\", \"1986-06-26\"],\n      in: [\"first_name\", \"Georgi, Bob\"]\n    }\n  `,\n  limit: 5,\n  fields: ['salary', 'salary_start_date'],\n  aliases: {\n    salary: 'salaries.salary',\n    salary_start_date: 'salaries.from_date',\n  },\n  orderBy: ['salary', 'desc'],\n});\n```\n\n`search()` requires a `Search` object as its argument, which has the following properties:\n\n| Property                           | Description                                                                                                          |\n| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------- |\n| predicate `string` (required)      | The search string, as described in **Grammar**                                                                       |\n| limit `number`                     | A limit on the number of results                                                                                     |\n| fields `string[]`                  | Fields to select (supports aliased fields)                                                                           |\n| aliases `Record\u003cstring, string\u003e`   | An object that contains mappings from alias name to relation name. These are to be used in `predicate` and `fields`. |\n| orderBy `[string, 'desc' / 'asc']` | Used for ordering results.                                                                                           |\n\nFor more information on third-party plugins, check out [Objection's docs](https://vincit.github.io/objection.js/guide/plugins.html#_3rd-party-plugins). You might also be interested in the [API Reference](https://rkrishn7.github.io/objection-match/).\n\n## Caching\n\n**objection-match** can cache the query builder object so it doesn't have to parse and build frequently used searches. To enable caching, pass options to the mixin function when initializing the plugin on a model. The options include:\n\n| Property                           | Description                |\n| ---------------------------------- | -------------------------- |\n| enableCache `boolean`              | Turns on caching           |\n| cacheMaxSize `number` (default 10) | Sets the size of the cache |\n\nFor more information on third-party plugins, check out [Objection's docs](https://vincit.github.io/objection.js/guide/plugins.html#_3rd-party-plugins).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frkrishn7%2Fobjection-match","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frkrishn7%2Fobjection-match","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frkrishn7%2Fobjection-match/lists"}