{"_id":"@alexdicy/mongodb-data-api","_rev":"5-ef6fdf749f5ad505b42a249c251c0722","name":"@alexdicy/mongodb-data-api","dist-tags":{"latest":"0.4.0-1"},"versions":{"0.2.0":{"name":"@alexdicy/mongodb-data-api","version":"0.2.0","description":"MongoDB atlas data API SDK for Node.js","keywords":["MongoDB data API","MongoDB cloud data API","MongoDB Atlas data API SDK"],"license":"MIT","authors":["Surmon","AlexDicy"],"repository":{"type":"git","url":"git+https://github.com/AlexDicy/mongodb-data-api.git"},"sideEffects":false,"main":"dist/mongodb-data-api.cjs.js","module":"dist/mongodb-data-api.esm.js","types":"dist/mongodb-data-api.esm.d.ts","scripts":{"lint":"eslint --ext .ts src/**","format":"prettier --write --parser typescript \"src/**/*.ts\"","test":"npm run test:type && npm run test:unit","test:unit":"jest","test:type":"tsc -p ./tests-dts/tsconfig.json && tsc -p ./tests-dts/tsconfig.build.json","build":"libundler","rebirth":"npm run lint && npm run test && npm run build","release":". ./scripts/release.sh"},"dependencies":{"mongodb":"^4.5.0"},"devDependencies":{"@surmon-china/libundler":"^2.2.0","@types/jest":"^27.4.0","@typescript-eslint/eslint-plugin":"^5.9.1","@typescript-eslint/parser":"^5.9.1","eslint":"^8.7.0","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^4.0.0","jest":"^27.4.7","prettier":"^2.5.1","ts-jest":"^27.1.3","typescript":"^4.5.4"},"gitHead":"e0197250ec8e28f7403124cfd5227eb8c696952c","bugs":{"url":"https://github.com/AlexDicy/mongodb-data-api/issues"},"homepage":"https://github.com/AlexDicy/mongodb-data-api#readme","_id":"@alexdicy/mongodb-data-api@0.2.0","_nodeVersion":"16.13.1","_npmVersion":"8.6.0","dist":{"integrity":"sha512-vdCTm0MBkfGR1NJI/rFecY6FG0NKpg+ZvQ0Db8MvNmE77fPNpfo/iFA7NKJUkC5UaagEcnQySb1caEPflf0yww==","shasum":"1b161d47736096adad42fae8a7be16bc5d3df589","tarball":"https://registry.npmjs.org/@alexdicy/mongodb-data-api/-/mongodb-data-api-0.2.0.tgz","fileCount":8,"unpackedSize":48893,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCF0PVPTBynnJHFo2TLz4Kt3/XFhTxTaVXfUvrnR+pG8gIgSDsDBQu1E8O//yKFkYghkOo1nHT8lAGybIDTBBIalHc="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJicUR+ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpDVw//euQukDB5k08TDejowPScsTE/D5wCzmb3cpjS30RAOoPDuBgY\r\nT9oxqWG+1nGm7AxqJky4K6Mx4mJ0/no6rN/LTV5ccqqowsBQzrUeAB/PM6q0\r\nTnKiVeiPEdgoR/zduFEmjD0Ev++4XBeT7sr+x6HUUiIUG67DGGRFQdA9gZxy\r\nvqN2BUCjPxRvWkpQtl5PULIXr6O++GBTBgfec9656PYBQ3Oe16P2ZvJVF8sA\r\nihHOle6nTPKKboOZ2KK2Ez5AGRS4oItFUHiGEWDjQoW6tVBUtvW7s37iVOwY\r\ngvJFh/i1SZZE4+IQr14y8JVaLe7FCvUrLnFBgYRQJuLHH+aZP5TGGj1LJYxF\r\nnCMrejLt0yXDD+LowDTi++TuCBfH8/mpnpwxSJoy8qNlv0Iq5gaKEVA8m3qV\r\nbrU/bre8mhhp/edD5uTlYVt2i/DHFCb9f/A+GByQ1WLOBWGa/x8OHI4806HM\r\njJnC+jdxYXbXyZSDXWDJqrdwmiWr6yKH+kDvsQlxcoknrNZ15Bpzk5PVQCsG\r\nRXg/5/+y+0mlZhgFnSd2akwprRkGmJjuUL2M4jWUY6GPQgfWsv74qdMp6H1x\r\nkg3ulk7kzPyx0rZhEcC5IiY+FG4EyJgKAvJ5gM0QGfksx5CRKHgYy/1x9PhI\r\nU+68YAar7X7QU4LB+cS05nJZ5KO9v6bCBSA=\r\n=3DVk\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"alexdicy","email":"halexercraft@gmail.com"},"directories":{},"maintainers":[{"name":"alexdicy","email":"halexercraft@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mongodb-data-api_0.2.0_1651590270051_0.5458726212991891"},"_hasShrinkwrap":false},"0.2.1-patch":{"name":"@alexdicy/mongodb-data-api","version":"0.2.1-patch","description":"MongoDB atlas data API SDK for Node.js","author":{"name":"Surmon"},"license":"MIT","keywords":["MongoDB data API","MongoDB cloud data API","MongoDB Atlas data API SDK"],"repository":{"type":"git","url":"git+https://github.com/AlexDicy/mongodb-data-api.git"},"sideEffects":false,"main":"dist/mongodb-data-api.cjs.js","module":"dist/mongodb-data-api.esm.js","types":"dist/mongodb-data-api.esm.d.ts","scripts":{"lint":"eslint --ext .ts src/**","format":"prettier --write --parser typescript \"src/**/*.ts\"","test":"npm run test:type && npm run test:unit","test:unit":"jest","test:type":"tsc -p ./tests-dts/tsconfig.json && tsc -p ./tests-dts/tsconfig.build.json","build":"libundler","rebirth":"npm run lint && npm run test && npm run build","release":". ./scripts/release.sh"},"dependencies":{"mongodb":"^4.5.0"},"devDependencies":{"@surmon-china/libundler":"^2.2.0","@types/jest":"^27.4.0","@typescript-eslint/eslint-plugin":"^5.9.1","@typescript-eslint/parser":"^5.9.1","eslint":"^8.7.0","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^4.0.0","jest":"^27.4.7","prettier":"^2.5.1","ts-jest":"^27.1.3","typescript":"^4.5.4"},"gitHead":"d9cc0bfc5549dd991fd1e4027f52c15d971b841f","bugs":{"url":"https://github.com/AlexDicy/mongodb-data-api/issues"},"homepage":"https://github.com/AlexDicy/mongodb-data-api#readme","_id":"@alexdicy/mongodb-data-api@0.2.1-patch","_nodeVersion":"16.13.1","_npmVersion":"9.1.1","dist":{"integrity":"sha512-6tJImB9LP9V1XTn655xZF6MLTvJLjTZGGL4xQfTNc5KeWy/aOyEB4+VVqz4GDteoD3IBn6BQHt5CPRahY8EVdw==","shasum":"632c1a6365e2b1fb1e75632017b1bc1bc4b4a880","tarball":"https://registry.npmjs.org/@alexdicy/mongodb-data-api/-/mongodb-data-api-0.2.1-patch.tgz","fileCount":9,"unpackedSize":50153,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCKRKlRECwMizLQq4Nc5hm1RLgGYf+QTKBYwsVhl6MmsQIgDFMHRpbgQ9L8xBc/Cupnp708xLAcTwJuW+XBJrchiEw="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjfVBaACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrA4w/9Eg9n4mtZ7MNKbjjuCTFFipqO+wJNbiQQ8blG3TF4rX2BWlXL\r\nGtTbHp4HZNJBSD2BeDJ2H+U9jjKEr1amm0+YogDAsixV+wihdCOnEAzoGG5d\r\n6LZsKKS74bYUf8R/cs+ZpgYePL+1GWweiVbMF+U4Ozxy0UrFIUgz6rJy0ZMH\r\n9UY+jU8vTNHGf40ZbU7zhq4lJMHq+6SzJtoJmFFnhw5k7PkWtEuXqzuaRa6m\r\n4qA5zSykVt/fq43PPJtMPhCfJgAatKze2yzDU58viGsnu9w2u/V73WMVEYU8\r\nv/Bsn5ft87RkFbQjldDiHHtgz1RlE9+2VeQlRwMQSrbji4jpe0LdQ4dj1501\r\niHTV8DlJGmXlwQ8c8T4spYAM/z+ONtFhxqVR+13/lZ7byGVwweWOAz5+iIMo\r\nNrbDI5VFh1YC+ZKGALqNUH27hfAAF6fC/gmGdVH7bFFuY+ZTCivuQ7JeBIrZ\r\nH07ApnExJfRVwYv4GP+IDEYXyw2k4DjOJZ97LDK4N7HegqnvcFdwEU5U8jsp\r\nMVkVuoh1buvTimprIzoDnqIk08FoUGfE75q/e0w/nxylB3DvfztpugqScjtv\r\nW2lIneR4J2TjmdXtGuWqj8wDgANxzGx8poasKtgALED8vcUFfTdNUEfvlEys\r\njOoIlE4Z0DpD9GLd+lQWSgrCYUGFgr2xoy8=\r\n=o9xk\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"alexdicy","email":"halexercraft@gmail.com"},"directories":{},"maintainers":[{"name":"alexdicy","email":"halexercraft@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mongodb-data-api_0.2.1-patch_1669156953886_0.7108702757777279"},"_hasShrinkwrap":false},"0.4.0":{"name":"@alexdicy/mongodb-data-api","version":"0.4.0","description":"MongoDB atlas data API SDK for Node.js","author":{"name":"Surmon"},"license":"MIT","keywords":["MongoDB data API","MongoDB cloud data API","MongoDB Atlas data API SDK"],"repository":{"type":"git","url":"git+https://github.com/AlexDicy/mongodb-data-api.git"},"sideEffects":false,"main":"dist/mongodb-data-api.cjs.js","module":"dist/mongodb-data-api.esm.js","types":"dist/mongodb-data-api.esm.d.ts","scripts":{"lint":"eslint --ext .ts src/**","format":"prettier --write --parser typescript \"src/**/*.ts\"","test":"npm run test:type && npm run test:unit","test:unit":"jest","test:type":"tsc -p ./tests-dts/tsconfig.json && tsc -p ./tests-dts/tsconfig.build.json","build":"libundler","rebirth":"npm run lint && npm run test && npm run build","release":". ./scripts/release.sh"},"dependencies":{"mongodb":"^4.12.0"},"devDependencies":{"@surmon-china/libundler":"^2.3.0","@types/jest":"^29.2.0","@typescript-eslint/eslint-plugin":"^5.44.0","@typescript-eslint/parser":"^5.44.0","eslint":"^8.28.0","eslint-config-prettier":"^8.5.0","eslint-plugin-prettier":"^4.2.0","jest":"^29.3.0","prettier":"^2.5.1","ts-jest":"^29.0.0","typescript":"^4.9.0"},"gitHead":"771363b0d762fda9898b7172f9b2283ba6afed51","bugs":{"url":"https://github.com/AlexDicy/mongodb-data-api/issues"},"homepage":"https://github.com/AlexDicy/mongodb-data-api#readme","_id":"@alexdicy/mongodb-data-api@0.4.0","_nodeVersion":"16.13.1","_npmVersion":"9.1.1","dist":{"integrity":"sha512-Q8klUk5jW8OEoVrpBSSembExsfIe6md2KH7dRIt5VtmhyrfpUQxgu/vJwckdLQqjQ29T37BW9v6CcLlxj1qcAA==","shasum":"7cbb1cece689e6350a94d5c21a59a8fc53ce833f","tarball":"https://registry.npmjs.org/@alexdicy/mongodb-data-api/-/mongodb-data-api-0.4.0.tgz","fileCount":9,"unpackedSize":50332,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCh1A0E2OlCdi5yV6emORqOLFXCQHYg5DRh/OFcWdZRPwIhAJbYvtAow7p2jr19kpEhTv4DHPaHhEqsSxaGNyxhee8x"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjg14NACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqaNw//SHzTrnag7Ri7VRqd3t6KL/dS+9969KqZTukIDOzn1/Y0VaiO\r\ngpIsNvDu9RcTLLbx0uiAV63fednVjY6Jl2V9DB3nrb1Mlw4SuIsAqEiSs54v\r\nTFNaGeDueETiAEp5d814JmrIFEaMdLDvrObVYkIBkW2nc3e3mvE9f3DKBC6h\r\nBA1qYlnVJIMwA4+1q2Xk/rcr0bmseQAqy9rOOPYl8h+BTltKfUVmPY7PTAT9\r\nwekasO8Dq4xAoumlkgUEr5stbPGoYWLtzCTU0IDzeybfrmPIPBnOtBnEZvlm\r\nnnnqnI6Rn6JwmychEIx77APDiGVb/BKlKDuS9YOVp7lUW3fAQ81xhyZbJPuP\r\n1WXnnbIZLfWWwr8/I2TzDdtljI1I8mwV40kE8YTawHPlyl10R/njWWMcWO3c\r\nq43m6T9UhtPSmYE1ffsmBgtM/OtAomvUXNmE56xxQxY6zDpPmBTH/0HkiR7d\r\nKmgDXYNIOkLU4xdhekEv98AYE8NAN4ElQpKT6sVodjgbZwjVP7rcIjrW7mR3\r\nwFIATk6LQ0XYYSKS31PLAEcrE2dHcJRrin1lkumPTDV3xRm9z1sIDnWBl9JA\r\nm9gDjR+sqwK8CAGNmvfoURES9vcZ1brRIFtgBdjRyR1mu4W/S8kPiPz7Yj2C\r\nsJ8Ox61OgS1IpJgKNQ+6gQEmT3jSWX69mVE=\r\n=iyo+\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"alexdicy","email":"halexercraft@gmail.com"},"directories":{},"maintainers":[{"name":"alexdicy","email":"halexercraft@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mongodb-data-api_0.4.0_1669553677669_0.3070531070451703"},"_hasShrinkwrap":false},"0.4.0-1":{"name":"@alexdicy/mongodb-data-api","version":"0.4.0-1","description":"MongoDB atlas data API SDK for Node.js","author":{"name":"Surmon"},"license":"MIT","keywords":["MongoDB data API","MongoDB cloud data API","MongoDB Atlas data API SDK"],"repository":{"type":"git","url":"git+https://github.com/AlexDicy/mongodb-data-api.git"},"sideEffects":false,"main":"dist/mongodb-data-api.cjs.js","module":"dist/mongodb-data-api.esm.js","types":"dist/mongodb-data-api.esm.d.ts","scripts":{"lint":"eslint --ext .ts src/**","format":"prettier --write --parser typescript \"src/**/*.ts\"","test":"npm run test:type && npm run test:unit","test:unit":"jest","test:type":"tsc -p ./tests-dts/tsconfig.json && tsc -p ./tests-dts/tsconfig.build.json","build":"libundler","rebirth":"npm run lint && npm run test && npm run build","release":". ./scripts/release.sh"},"dependencies":{"mongodb":"^4.12.0"},"devDependencies":{"@surmon-china/libundler":"^2.3.0","@types/jest":"^29.2.0","@typescript-eslint/eslint-plugin":"^5.44.0","@typescript-eslint/parser":"^5.44.0","eslint":"^8.28.0","eslint-config-prettier":"^8.5.0","eslint-plugin-prettier":"^4.2.0","jest":"^29.3.0","prettier":"^2.5.1","ts-jest":"^29.0.0","typescript":"^4.9.0"},"gitHead":"771363b0d762fda9898b7172f9b2283ba6afed51","bugs":{"url":"https://github.com/AlexDicy/mongodb-data-api/issues"},"homepage":"https://github.com/AlexDicy/mongodb-data-api#readme","_id":"@alexdicy/mongodb-data-api@0.4.0-1","_nodeVersion":"16.13.1","_npmVersion":"9.1.1","dist":{"integrity":"sha512-uH2vxTHJmJTzjljALq4ESzcUZbFTkq4W7lur/svLwCyPPPI1XoThKl+sqteH31W8WY228y2SsbEeqFvULTyT4w==","shasum":"3a3e709666dc3821966aecd6671d8ef12f59c667","tarball":"https://registry.npmjs.org/@alexdicy/mongodb-data-api/-/mongodb-data-api-0.4.0-1.tgz","fileCount":9,"unpackedSize":50337,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIENJ/iySBv1imX/vCN+0Uc20nhWr2LX7tdN5XvskxkuhAiEAwWdUc3DAUIDunATq6vNeBA6F+oZqFV7O8oiku/n8Hsw="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjg4syACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoWYhAAhPCqUXz7E7I4GKxArrzMmgZIBbjY8OjD/C28ptptK3XhodGl\r\nXbtH9aMy7NgmaQH+/Hi/OxJ7nNTzThTdaf0jflcBTF15MRHcaPmiOMPapHUR\r\nY5Lpcj3h0kC4qUqIJb/GSza0Ad0hESFkhnptP+49W/MNARSgTcuRJXYHLoyJ\r\nRjkDVMp+3j9+s6q5KdhoWYKm5aIm0P5c2nkTlJJrkcS+74qbWxmt36JlOT8k\r\nA1vdjR9e9oSj2Scg4xWSfXcPkEJJXPcGa5uqSoKScGe8YESNAsoIfVCRUANU\r\n5IACEvek/365rFPACaf7eYJ9k3ENkqB0cb4rhOmjr8Rqqk70mnnCcgtdBEns\r\nkUU1g+ha/hhQGvKUb6x4o808j+0h7Mg4Npna+vOG6/ZyVXuv9qsPWAYmd3EO\r\ntqet9a2sMcN27zGv+qGjtQVnCtOrWvGDmK3GbUzAN/hkrw5vAqQxhggF7pIV\r\n00X672AhNTcUff7B16902ahuPEdlLepsUGixUAx0IrDvi01TFtRCRibLHT3q\r\nSigeiEDkd89x+3JpTiKsyTZq7s48TovXGE9uOFxi+XNpdEZnNpHy99w5sQJU\r\n2tm8amvVs1l4hB5V3AYmEoKILkoRWmwqYjUX3sa1B/WUb7wA4MdWQSSXEva5\r\nmYElKdN8frWtvgCLkdncfQF599XcStdNj8E=\r\n=oPXI\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"alexdicy","email":"halexercraft@gmail.com"},"directories":{},"maintainers":[{"name":"alexdicy","email":"halexercraft@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mongodb-data-api_0.4.0-1_1669565234346_0.22135212474398935"},"_hasShrinkwrap":false}},"time":{"created":"2022-05-03T15:04:29.946Z","0.2.0":"2022-05-03T15:04:30.241Z","modified":"2022-11-27T16:07:14.626Z","0.2.1":"2022-11-22T22:34:00.269Z","0.2.1-patch":"2022-11-22T22:42:34.048Z","0.4.0":"2022-11-27T12:54:37.864Z","0.4.0-1":"2022-11-27T16:07:14.543Z"},"maintainers":[{"name":"alexdicy","email":"halexercraft@gmail.com"}],"description":"MongoDB atlas data API SDK for Node.js","homepage":"https://github.com/AlexDicy/mongodb-data-api#readme","keywords":["MongoDB data API","MongoDB cloud data API","MongoDB Atlas data API SDK"],"repository":{"type":"git","url":"git+https://github.com/AlexDicy/mongodb-data-api.git"},"bugs":{"url":"https://github.com/AlexDicy/mongodb-data-api/issues"},"license":"MIT","readme":"<p align=\"center\">\n  <img src=\"/logo.png\" height=\"120px\" />\n</p>\n\n# @alexdicy/mongodb-data-api\n\n[![GitHub stars](https://img.shields.io/github/stars/AlexDicy/mongodb-data-api.svg?style=for-the-badge)](https://github.com/AlexDicy/mongodb-data-api/stargazers)\n&nbsp;\n[![npm](https://img.shields.io/npm/v/@alexdicy/mongodb-data-api?color=c7343a&label=npm&style=for-the-badge)](https://www.npmjs.com/package/@alexdicy/mongodb-data-api)\n&nbsp;\n[![Test Codecov](https://img.shields.io/codecov/c/github/AlexDicy/mongodb-data-api?style=for-the-badge)](https://codecov.io/gh/AlexDicy/mongodb-data-api)\n&nbsp;\n[![GitHub license](https://img.shields.io/github/license/AlexDicy/mongodb-data-api.svg?style=for-the-badge)](/LICENSE)\n\nMongoDB Atlas [Data API](https://www.mongodb.com/docs/atlas/api/data-api/) SDK for Node.js.\n\n---\n\n### Installation\n\n```bash\nnpm i @alexdicy/mongodb-data-api\n```\n\nor\n\n```bash\nyarn add @alexdicy/mongodb-data-api\n```\n\n### Usage\n\n#### Init\n\n```ts\nimport { createMongoDBDataAPI } from '@alexdicy/mongodb-data-api'\n\n// init by URL Endpoint\nconst api = createMongoDBDataAPI({\n  apiKey: '<your_mongodb_api_key>',\n  urlEndpoint: 'https://data.mongodb-api.com/app/<your_mongodb_app_id>/endpoint/data/v1'\n})\n\n// or init by app ID\nconst api = createMongoDBDataAPI({\n  apiKey: '<your_mongodb_api_key>',\n  appId: '<your_mongodb_app_id>'\n})\n\n// specific region and cloud of app\nconst api = createMongoDBDataAPI({\n  apiKey: '<your_mongodb_api_key>',\n  appId: '<your_mongodb_app_id>',\n  region: '<your_mongodb_app_region>', // e.g. us-east-1\n  cloud: '<your_mongodb_app_cloud>' // e.g. aws\n})\n```\n\n#### Actions\n\nSee [MongoDB Data API Resources](https://www.mongodb.com/docs/atlas/api/data-api-resources/).\n\n- [`API.findOne`](https://www.mongodb.com/docs/atlas/api/data-api-resources/#find-a-single-document)\n- [`API.find`](https://www.mongodb.com/docs/atlas/api/data-api-resources/#find-multiple-documents)\n- [`API.insertOne`](https://www.mongodb.com/docs/atlas/api/data-api-resources/#insert-a-single-document)\n- [`API.insertMany`](https://www.mongodb.com/docs/atlas/api/data-api-resources/#insert-multiple-documents)\n- [`API.updateOne`](https://www.mongodb.com/docs/atlas/api/data-api-resources/#update-a-single-document)\n- [`API.updateMany`](https://www.mongodb.com/docs/atlas/api/data-api-resources/#update-multiple-documents)\n- [`API.replaceOne`](https://www.mongodb.com/docs/atlas/api/data-api-resources/#replace-a-single-document)\n- [`API.deleteOne`](https://www.mongodb.com/docs/atlas/api/data-api-resources/#delete-a-single-document)\n- [`API.deleteMany`](https://www.mongodb.com/docs/atlas/api/data-api-resources/#delete-multiple-documents)\n- [`API.aggregate`](https://www.mongodb.com/docs/atlas/api/data-api-resources/#run-an-aggregation-pipeline)\n\n#### Action examples\n\n1. find a single document\n\n```ts\napi\n  .findOne({\n    dataSource: '<target_cluster_name>',\n    database: '<target_database_name>',\n    collection: '<target_collection_name>',\n    filter: { name: 'Surmon' }\n  })\n  .then((result) => {\n    console.log(result.document)\n  })\n```\n\n2. insert a single document\n\n```ts\napi\n  .insertOne({\n    dataSource: '<target_cluster_name>',\n    database: '<target_database_name>',\n    collection: '<target_collection_name>',\n    document: {\n      name: 'Surmon',\n      age: 19\n    }\n  })\n  .then((result) => {\n    console.log(result.insertedId)\n  })\n```\n\n3. run an aggregation pipeline\n\n```ts\napi\n  .aggregate({\n    dataSource: '<target_cluster_name>',\n    database: '<target_database_name>',\n    collection: '<target_collection_name>',\n    pipeline: [\n      { $match: { status: 'urgent' } },\n      { $group: { _id: '$productName', sumQuantity: { $sum: '$quantity' } } }\n    ]\n  })\n  .then((result) => {\n    console.log(result.documents)\n  })\n```\n\n#### Method chaining\n\n```ts\n// select cluster\nconst clusterA = api.$cluster('a')\n// select database\nconst databaseB = clusterA.$database('b')\n// select collection\nconst collectionC = databaseB.$collection<C>('c')\n// data actions\nconst data = await collectionC.findOne({\n  filter: {\n    /*...*/\n  }\n})\nconst result = await collectionC.insertOne({\n  document: {\n    /*...*/\n  }\n})\n\n// -------------\n\n// chaining is equivalent to the api call\napi.$cluster('a').$database('b').$collection<C>('c').findOne({ filter: {} })\n// the same as\napi.findOne<C>({\n  dataSource: 'a',\n  database: 'b',\n  collection: 'c',\n  filter: {}\n})\n```\n\n#### Specific Action\n\nYou can specify the action request to prevent this package from lagging relative to the official one.\n\n```ts\napi.$$action('findOne', {\n  dataSource: '...',\n  database: '...',\n  collection: '...',\n  filter: {}\n})\n```\n\n#### Original Class\n\nYou can use the original Class to implement some special requirements.\n\n```ts\nimport { MongoDBDataAPI } from 'mongodb-data-api'\n\nconst customerCollection = new MongoDBDataAPI<CustomerDocument>(\n  {\n    apiKey: '<your_mongodb_api_key>',\n    appId: '<your_mongodb_app_id>'\n  },\n  {\n    dataSource: '<target_cluster_name>',\n    database: '<target_database_name>',\n    collection: '<target_collection_name>'\n  }\n)\n\nconst customer = await customerCollection.findOne({ ... })\n```\n\n### Development\n\n```bash\n# install dependencies\nyarn\n\n# lint\nyarn lint\n\n# test\nyarn test\n\n# build\nyarn build\n```\n\n### Changelog\n\nDetailed changes for each release are documented in the [release notes](/CHANGELOG.md).\n\n### License\n\n[MIT](/LICENSE)\n","readmeFilename":"README.md","author":{"name":"Surmon"}}