{"_id":"@eduact/lucid-fetch-helper","_rev":"4-06f8488295501a1f4fedfa6c567e66d4","name":"@eduact/lucid-fetch-helper","dist-tags":{"latest":"2.0.0"},"versions":{"1.0.5":{"name":"@eduact/lucid-fetch-helper","version":"1.0.5","description":"get all data for certain database model with pagination ,filtration ,date range ,sort by column and search query all in one request","main":"lib/index.js","types":"lib/index.d.ts","repository":{"type":"git","url":"git+https://github.com/Eduact-me/lucid-fetch-helper.git"},"homepage":"https://github.com/Eduact-me/lucid-fetch-helper#readme","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","format":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json","prepare":"npm run build","prepublishOnly":"npm run lint","preversion":"npm run lint","version":"npm run format && git add -A src","postversion":"git push && git push --tags"},"keywords":["lucid","adonis","helper","orm"],"author":{"name":"mohammed_essam"},"license":"ISC","dependencies":{"dayjs":"^1.10.4"},"devDependencies":{"prettier":"^2.3.0","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.2.4"},"gitHead":"13b8cd868d2c549cae9d951d14b6207955e943fc","bugs":{"url":"https://github.com/Eduact-me/lucid-fetch-helper/issues"},"_id":"@eduact/lucid-fetch-helper@1.0.5","_nodeVersion":"16.4.1","_npmVersion":"7.18.1","dist":{"integrity":"sha512-BGZKcd6+yEefPXOW23pWTLqXx2Hui35xXmcIWtBDEWAD2OrtUqtYtCeE0f/E9ElXXSdm6W2nDHhfV1WRaFUpuw==","shasum":"74ddadb0434de97eede13dc4a64cf66d6486c55f","tarball":"https://registry.npmjs.org/@eduact/lucid-fetch-helper/-/lucid-fetch-helper-1.0.5.tgz","fileCount":6,"unpackedSize":6421,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhC/l1CRA9TVsSAnZWagAA+Q0P/2sS+9BKLS8OBYvQINUo\nOb8aB66Jznr/O6+J44dwgHa+zDilSiM4U/4SLCQUzRwAi9PLW8FtWI9DH6jh\ngatFfofQU23SIfwj1Slw2gSTpOYAtbqGfPvJQ/Uivql6GzXdAfFYhOPuwGou\nNFhp2JhNptPd44c7bZShc4iK4Jp2pgaml2fjIuxTDk7zgdICMpYfbw7N8u0s\nC3OcUSsXHETb0KIiJQcuYtwY9H0/9aDy3pK9ssmJtYcrlE7gQVMYLZOLyc/Z\nqNyFB01tSPky6W6mwRKjzKQ+KekDRcp9RuEMA7XVd+u6zK9kGVyor4FhCEat\naH6VQAcPIRf5TWXki16yHbScnwaFiBN6MUvrlqBBvXjCPYfH6P3oh5f8wwf7\nEczeB1QNEsoI2tUu4CDHS2aPLQNcKdsYFHV9OImIuSsqMfRXZkBOYeUPzCzm\nuAUraHsddgeVXGXlxLmQavM2fIrTSSIyr64yWMpc4Gkjg1kA3fFCUarf8qr9\ndHLuh5fpgPCoLAlcIQn2zt9QRtXoGuaNboLyXkRSESgOv1fjw/2jsLlkkvMW\nxyHfTU2Xt8icPL3jaef1yU9Sf9pWCntKDrcERElmueATU99kTgJCR6lr3mh4\nJfX1Urk1AkKNQ1FLPwgVxNgdgapkLcSCd/VBahxyMYU4BQgE6Y/N+XIQdjGh\nDPq8\r\n=09Hj\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD9oCPBzuM49VTvRpmlb+WiFnfHjJ9iu9FDyVGUmNgNkgIgIi05PgtVo65PUS0My6ejuUdZcV/3PrA5S+u8mxt624k="}]},"_npmUser":{"name":"youssefnabil48","email":"youssef.nabil.mustafa@gmail.com"},"directories":{},"maintainers":[{"name":"youssefnabil48","email":"youssef.nabil.mustafa@gmail.com"},{"name":"mohammed_essam","email":"dev.mohammed.essam@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/lucid-fetch-helper_1.0.5_1628174709288_0.5138498615836626"},"_hasShrinkwrap":false},"2.0.0":{"name":"@eduact/lucid-fetch-helper","version":"2.0.0","description":"get all data for certain database model with pagination ,filtration ,date range ,sort by column and search query all in one request","main":"lib/index.js","types":"lib/index.d.ts","repository":{"type":"git","url":"git+https://github.com/Eduact-me/lucid-fetch-helper.git"},"homepage":"https://github.com/Eduact-me/lucid-fetch-helper#readme","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","format":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json","prepare":"npm run build","prepublishOnly":"npm run lint","preversion":"npm run lint","version":"npm run format && git add -A src","postversion":"git push && git push --tags"},"keywords":["lucid","adonis","helper","orm"],"author":{"name":"mohammed_essam"},"license":"ISC","dependencies":{"dayjs":"^1.10.4"},"devDependencies":{"prettier":"^2.3.0","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.2.4"},"bugs":{"url":"https://github.com/Eduact-me/lucid-fetch-helper/issues"},"directories":{"lib":"lib"},"gitHead":"7aba3a337596c369b50f2ce64a87e574f750acb4","_id":"@eduact/lucid-fetch-helper@2.0.0","_nodeVersion":"16.4.1","_npmVersion":"7.18.1","dist":{"integrity":"sha512-wF5SC4KEkTqxEJC1KL/zL024uzNDjYtlkll7nLT/56+XK1pvkHCKdrJ/eADD1hDCCEmuOCO2zKcWm1w7c1sHvA==","shasum":"ab6f925f7c1972441b2687834ba8962690d315a6","tarball":"https://registry.npmjs.org/@eduact/lucid-fetch-helper/-/lucid-fetch-helper-2.0.0.tgz","fileCount":6,"unpackedSize":6988,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhDAxVCRA9TVsSAnZWagAAWHgP/RAKSIBcXU4la03R1WWl\n5MmzHuPW5O7VcbrMhaeRKmND9lsuOjiEGrw45HsxaTTl0I6UF9UUIjf+d4c3\ngrhf2luOy4TzCWSjIVn08JrYLyGkXTQSdCsPe5E0P3x1hde8ra3BkbQfuUrf\nk346RjprZZR2VKMWh6RVkodBM12nDM2sGbiMx2pIN0g6AsMoCjd/D24NlhYB\nVos330xKcWA/ll8yvBSp+yIE4cEwHP4OeizbCf5LSZ/3GxNsr8eXHcNvH9n6\nwdjRuHFG+PwHnxIJyScDzmxv7TbddYF+0Dzf1m5HOxB99FVBknhvL5lZBngY\nvW3Rvwn7enOloTy7xFJzIlFnS0Jv9ONZ5r1d8YQEchhQu6bKhc5o+6QxP6F2\n9lTUhrGAbyQHD+n9Xw0jKYABqhlepuhXN+HBJFYjhWA25/75RvoZLlRpvb6o\n4hvR/87imjPw5upfqW5wgf4oKn0BbkAvLjRQp/go2d0SO41B9vwAlNMhFqu6\n2/nHo0QGsubin/v4hy2nuMl2Ak97SbiBlYNb0gZQftmKVok1Q2p5C32fitLn\nUdhXIQNpplFn5U8dBXg97lJ1gLo5o3gSWh7v93CeMmZgg7OU7SAFRbTldbQE\nqHnWHIi3CfZdGZMAiovj16MDbhY+cKREqp3kAKnCcWpHy4ah9PqcWtYv5LCo\nBXzr\r\n=QQ/O\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCiOKlAX6jfWoV2xnv3TW6AbyaM3vn2rnP7QMc6GUqyEQIgKaFjMezg3pH2lgSzf+WMnLAi4NmyjbVm3k9wTIBby50="}]},"_npmUser":{"name":"youssefnabil48","email":"youssef.nabil.mustafa@gmail.com"},"maintainers":[{"name":"youssefnabil48","email":"youssef.nabil.mustafa@gmail.com"},{"name":"mohammed_essam","email":"dev.mohammed.essam@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/lucid-fetch-helper_2.0.0_1628179541376_0.3781019214701662"},"_hasShrinkwrap":false}},"time":{"created":"2021-08-05T14:45:09.222Z","1.0.5":"2021-08-05T14:45:09.431Z","modified":"2022-06-01T15:30:02.404Z","2.0.0":"2021-08-05T16:05:41.498Z"},"maintainers":[{"email":"tubesniper@gmail.com","name":"desouky"},{"email":"youssef.nabil.mustafa@gmail.com","name":"youssefnabil48"}],"description":"get all data for certain database model with pagination ,filtration ,date range ,sort by column and search query all in one request","homepage":"https://github.com/Eduact-me/lucid-fetch-helper#readme","keywords":["lucid","adonis","helper","orm"],"repository":{"type":"git","url":"git+https://github.com/Eduact-me/lucid-fetch-helper.git"},"author":{"name":"mohammed_essam"},"bugs":{"url":"https://github.com/Eduact-me/lucid-fetch-helper/issues"},"license":"ISC","readme":"# lucid-fetch-helper\n\n## Installation\n\n`npm install --save lucid-fetch-helper`\n\nor using yarn\n\n`yarn add lucid-fetch-helper`\n\n## Usage\n\n```javascript\nimport fetch from \"lucid-fetch-helper\"\n\nconst response = await fetch(LucidModel,columnsSettings, pagination, orderBy, searchQuery, filters, dateRange, customColumnsSelectionList,excludedSearchColumns)\n...\n```\n\n## API\n\n| Parameter | Description |\n|-----------|-------------|\n|`LucidModel`|Lucid Orm Model|\n|`columnsSettings`| { customColumnsSelectionList : ['columnName1',...], method : 'include'|'exclude' }|\n|`pagination`|object defines pagination settings {page:number,perPage:number(defaults to 15)}|\n|`orderBy`|object defines column to order by {filed:\"columnName\" ,direction:\"asc\"|\"desc\"}|\n|`searchQuery`|string to search with in all database columns (generic search)|\n|`filters`|an array of key:value pairs defines filtration criteria  [{gender:\"male\"}]|\n|`dateRange`|date range to filter by {from:\"YYYY/MM/DD\",to:\"YYYY/MM/DD\"} note that from and to are optional witch means you can define dateRange object as follows {from:\"YYYY/MM/DD\"} Or {to:\"YYYY/MM/DD\"}|\n|`excludedSearchColumns`|list of columns that should be excluded from generic search i.e. any non string values ex ['isActive','id',...] Note by default 'id','updated_at','created_at' columns are excluded|","readmeFilename":"readme.md"}