{"id":15040589,"url":"https://github.com/danivek/json-api-mongo-parser","last_synced_at":"2025-04-14T18:33:38.847Z","repository":{"id":57284694,"uuid":"53210069","full_name":"danivek/json-api-mongo-parser","owner":"danivek","description":"JSON API (http://jsonapi.org/) query parser for MongoDB/Mongoose queries","archived":false,"fork":false,"pushed_at":"2016-04-17T15:24:44.000Z","size":11,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-09T10:34:11.346Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/danivek.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-03-05T16:11:17.000Z","updated_at":"2020-09-26T17:56:38.000Z","dependencies_parsed_at":"2022-08-25T07:21:52.591Z","dependency_job_id":null,"html_url":"https://github.com/danivek/json-api-mongo-parser","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danivek%2Fjson-api-mongo-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danivek%2Fjson-api-mongo-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danivek%2Fjson-api-mongo-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danivek%2Fjson-api-mongo-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danivek","download_url":"https://codeload.github.com/danivek/json-api-mongo-parser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248937120,"owners_count":21186168,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-09-24T20:44:46.350Z","updated_at":"2025-04-14T18:33:38.822Z","avatar_url":"https://github.com/danivek.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# json-api-mongo-parser\n[![Build Status](https://travis-ci.org/danivek/json-api-mongo-parser.svg?branch=master)](https://travis-ci.org/danivek/json-api-mongo-parser)\n[![Coverage Status](https://coveralls.io/repos/github/danivek/json-api-mongo-parser/badge.svg?branch=master)](https://coveralls.io/github/danivek/json-api-mongo-parser?branch=master)\n\nJSON API query parser for MongoDB/Mongoose queries.\n\nConvert query object from any querystring parser to MongoDB/Mongoose queries.\n\n## Installation\n```bash\nnpm install --save json-api-mongo-parser\n```\n\n## Usage\n\n```javascript\n// Input query object for the article resource\nvar query = {\n  fields: {\n    article: 'title,body', // Can be comma delimited string or Array of string\n    people: 'firstname,lastname',\n    comment: 'title,body'\n  },\n  sort: '-title,body,+created', // Can be comma delimited string or Array of string\n  page: {\n    offset: 2,\n    limit: 10\n  },\n  include: 'author,comments.tag,comments.author,comments.author.tag' // Can be comma delimited string or Array of string\n}\n```\n\n```javascript\nvar JSONAPIMongoParser = require(json-api-mongo-parser);\n\nvar jsonApiMongoParser = new JSONAPIMongoParser({\n  article: {\n    relationships: { // Declaring relationships with its type\n      author: 'people', // can be a string\n      comments: { // Or an object with extra options for population query\n        type : 'comment',\n        options: {\n          lean: true\n        }\n      },\n    }\n  },\n  comment: {\n    relationships: {\n      author: 'people',\n      tag: 'tag'\n    }\n  },\n  people: {\n    relationships: {\n      tag: 'tag'\n    }\n  }\n});\n\n// Parse\njsonApiMongoParser.parse('article', query);\n```\nOutput mongo query for the article resource :\n\n```javascript\n{\n  select: {\n    title: 1,\n    body: 1,\n    author: 1,\n    comments: 1\n  },\n  sort: {\n    title: -1,\n    body: 1,\n    created: 1\n  },\n  page: {\n    skip: 2,\n    limit: 10\n  },\n  populate: [{\n    path: 'author',\n    select: {\n      firstname: 1,\n      lastname: 1,\n      tag: 1\n    }\n  }, {\n    path: 'comments',\n    populate: [{\n      path: 'tag'\n    }, {\n      path: 'author',\n      populate: [{\n        path: 'tag'\n      }],\n      select: {\n        firstname: 1,\n        lastname: 1,\n        tag: 1\n      }\n    }],\n    select: {\n      title: 1,\n      body: 1,\n      author: 1,\n      tag: 1\n    },\n    options: {\n      lean: true\n    }\n  }]\n}\n```\n\n## Requirements\n\njson-api-mongo-parser only use ECMAScript 2015 (ES6) features supported natively by Node.js 4 and above ([ECMAScript 2015 (ES6) | Node.js](https://nodejs.org/en/docs/es6/)). Make sure that you have Node.js 4+ or above.\n\n## License\n\n[MIT](https://github.com/danivek/json-api-mongo-parser/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanivek%2Fjson-api-mongo-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanivek%2Fjson-api-mongo-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanivek%2Fjson-api-mongo-parser/lists"}