{"_id":"@andriyf/odata-v4-mongodb","_rev":"2-3a0e8801815c118f22b8c4bc52319dd7","name":"@andriyf/odata-v4-mongodb","description":"Service OData requests from a MongoDB data store","dist-tags":{"latest":"0.1.10"},"versions":{"0.1.10":{"name":"@andriyf/odata-v4-mongodb","version":"0.1.10","description":"Service OData requests from a MongoDB data store","main":"lib/index.js","typings":"lib/index","directories":{"test":"test"},"scripts":{"build":"tsc src/index.ts --outDir lib -d","pretest":"npm run build","test":"mocha","pretdd":"npm run build","tdd":"mocha -w","prepublish":"npm test"},"repository":{"type":"git","url":"git+https://github.com/jaystack/odata-v4-mongodb.git"},"keywords":["OData","server","V4","parser"],"author":{"name":"JayStack"},"license":"MIT","bugs":{"url":"https://github.com/jaystack/odata-v4-mongodb/issues"},"homepage":"https://github.com/jaystack/odata-v4-mongodb#readme","dependencies":{"odata-v4-literal":"^0.1.0","odata-v4-parser":"^0.1.18"},"devDependencies":{"chai":"^3.5.0","mocha":"^3.2.0","typescript":"^2.2.1"},"gitHead":"c6a9017e4a89eee4b03453e4946bf6cd20800f47","_id":"@andriyf/odata-v4-mongodb@0.1.10","_shasum":"7aa95945dcf122d5298641b78794ccf7b5b98966","_from":".","_npmVersion":"3.10.10","_nodeVersion":"6.10.2","_npmUser":{"name":"andriyf","email":"forspam.smith@gmail.com"},"dist":{"shasum":"7aa95945dcf122d5298641b78794ccf7b5b98966","tarball":"https://registry.npmjs.org/@andriyf/odata-v4-mongodb/-/odata-v4-mongodb-0.1.10.tgz","integrity":"sha512-8hhIHqQjUu4dqtrATZZsjTy2GFtnKTr7i2VnYGicTTx3sLViuHGZR6DOsnIpGtcREUEw9Bk6JkL88na9t0tV6w==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBrPtdF+2YixQy6rzwTVnKX7XAu7PDO0s5/Lo4Y01HFvAiA3PZ8VBIlNVkCyo56uAiVKinDGZzEWK3o/vSDYNQLhxw=="}]},"maintainers":[{"name":"andriyf","email":"forspam.smith@gmail.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/odata-v4-mongodb-0.1.10.tgz_1493819934143_0.8563591644633561"}}},"readme":"# OData V4 Service modules - MongoDB Connector\n\nService OData v4 requests from a MongoDB data store.\n\n## Synopsis\nThe OData V4 MongoDB Connector provides functionality to convert the various types of OData segments\ninto MongoDB query objects, that you can execute over a MongoDB database.\n\n## Potential usage scenarios\n\n- Create high speed, standard compliant data sharing APIs\n\n## Usage as server - TypeScript\n```javascript\nimport { createFilter } from 'odata-v4-mongodb'\n\n//example request:  GET /api/products?$filter=category/id eq 5 or color eq 'Red'\napp.get(\"/api/products\", (req: Request, res: Response) => {\n    const filter = createFilter(req.query.$filter);\n    // collection instance from MongoDB Node.JS Driver\n    collection.find(filter, function(err, data){\n        res.json({\n        \t'@odata.context': req.protocol + '://' + req.get('host') + '/api/$metadata#products',\n        \tvalue: data\n        });\n    });\n});\n```\n\n## Usage ES5\n```javascript\nvar createFilter = require('odata-v4-mongodb').createFilter;\n\napp.get(\"/api/products\", function(req, res) {\n    var filter = createFilter(req.query.$filter);\n    // collection instance from MongoDB Node.JS Driver\n    collection.find(filter, function(err, data){\n        res.json({\n        \t'@odata.context': req.protocol + '://' + req.get('host') + '/api/$metadata#products',\n        \tvalue: data\n        });\n    });\n})\n```\n\n## Supported OData segments\n\nFor now **$filter**, **$select**, **$skip** and **$top**\n\nSupport for **$expand** is next.\n\n### Supported $filter expressions\n\nThe [OData v4 Parser](https://www.npmjs.com/package/odata-v4-parser) layer supports 100% of the specification.\nThe Connector is supporting basic MongoDB queries.\n\n*We are into creating a comprehensive feature availability chart for V1 release*\n\n    √ expression 5.1.1.6.1: NullValue eq null\n    √ expression 5.1.1.6.1: TrueValue eq true\n    √ expression 5.1.1.6.1: FalseValue eq false\n    √ expression 5.1.1.6.1: IntegerValue lt -128\n    √ expression 5.1.1.6.1: DecimalValue eq 34.95\n    √ expression 5.1.1.6.1: StringValue eq 'Say Hello,then go'\n    √ expression 5.1.1.6.1: DurationValue eq duration'P12DT23H59M59.999999999999S'\n    √ expression 5.1.1.6.1: DateValue eq 2012-12-03\n    √ expression 5.1.1.6.1: DateTimeOffsetValue eq 2012-12-03T07:16:23Z\n    √ expression 5.1.1.6.1: GuidValue eq 01234567-89ab-cdef-0123-456789abcdef\n    √ expression 5.1.1.6.1: Int64Value eq 0\n    √ expression 5.1.1.6.1: A eq INF\n    √ expression 5.1.1.6.1: A eq 0.31415926535897931e1\n    √ expression 5.1.1.1.2: A ne 1\n    √ expression 5.1.1.1.3: A gt 2\n    √ expression 5.1.1.1.4: A ge 3\n    √ expression 5.1.1.1.5: A lt 2\n    √ expression 5.1.1.1.6: A le 2\n    √ expression: A/b eq 1\n    √ expression 5.1.1.3: (A/b eq 2) or (B/c lt 4) and ((E gt 5) or (E lt -1))\n","maintainers":[{"name":"andriyf","email":"forspam.smith@gmail.com"}],"time":{"modified":"2022-06-12T14:40:44.806Z","created":"2017-05-03T13:58:55.778Z","0.1.10":"2017-05-03T13:58:55.778Z"},"homepage":"https://github.com/jaystack/odata-v4-mongodb#readme","keywords":["OData","server","V4","parser"],"repository":{"type":"git","url":"git+https://github.com/jaystack/odata-v4-mongodb.git"},"author":{"name":"JayStack"},"bugs":{"url":"https://github.com/jaystack/odata-v4-mongodb/issues"},"license":"MIT","readmeFilename":"README.md"}