{"_id":"@blackbox-vision/ra-audit-log","_rev":"1-bdb9f687155bb506c5e4fd5a1755c10b","name":"@blackbox-vision/ra-audit-log","dist-tags":{"latest":"4.1.0"},"versions":{"4.0.0":{"name":"@blackbox-vision/ra-audit-log","description":"> TODO: description","version":"4.0.0","license":"MIT","pika":true,"sideEffects":false,"homepage":"https://github.com/BlackBoxVision/react-admin-extensions#readme","bugs":{"url":"https://github.com/BlackBoxVision/react-admin-extensions/issues"},"dependencies":{},"peerDependencies":{"react":"*","react-admin":"*"},"devDependencies":{"@babel/core":"^7.11.4","@babel/plugin-proposal-class-properties":"^7.10.4","@babel/plugin-proposal-object-rest-spread":"^7.11.0","@babel/preset-react":"^7.10.4","@babel/preset-typescript":"^7.10.4","@pika/pack":"^0.5.0","@pika/plugin-build-types":"^0.9.2","@pika/plugin-build-web":"^0.9.2","@pika/plugin-standard-pkg":"^0.9.2","@types/react":"^16.9.48","react":"^16.13.1","react-admin":"^4.5.0","rimraf":"^3.0.2","typescript":"^3.9.7"},"esnext":"dist-src/index.js","module":"dist-web/index.js","_id":"@blackbox-vision/ra-audit-log@4.0.0","_nodeVersion":"14.18.2","_npmVersion":"6.14.15","dist":{"integrity":"sha512-HGZiI0x63As1UIU4AeK1nTpoobqMROn0E/y9frwvJoZ6M3zdndorKdsi70hSySD3UYqwwK7oqalyzFN7VOqYEw==","shasum":"817d936b7e5feff4261233a5193f1c51d96cd82f","tarball":"https://registry.npmjs.org/@blackbox-vision/ra-audit-log/-/ra-audit-log-4.0.0.tgz","fileCount":5,"unpackedSize":13260,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICFuLy0/PgfJJ1Mpr/bG+UDDtimpulCBFm5zV9nlBBFDAiAJbkRE2WePTkZjtqEa+lHQ6QO/0046yzn3TNHr7bcOqg=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjaODGACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmrz6A//c6zdZ6+uwBv70PUvz0E35lwhwZ8Vs5YWJYeN8Y8LUxWqGtLJ\r\nCNMzTvFe3CwBr0E2KlOhqSH2OOaRcZAAU6rzLknlJR+6xdsNpU74lU7vOlbp\r\nqX9DC6TYzzoWZF2cpXt9FR4WAXNj2x3T2q09Maqou3J9CJtOgCzTWvA39R5C\r\ndBO+iMgkR4zDc9GiCZCctlIYtAeQJuiaSUZjZkLsOMWabZZY0GT5QAMI7OFU\r\nDKuM7N5MO2u6EJB9q5TbFWb8KcqPn7TfnegjFOR5NMohMtAObKY/uHq7r7pS\r\nlH15Wq/ZpVwSoGoeWm9VFUOwHOGAt0SUI9XaRhvPQMNU33+pZsyYrnxI3gfp\r\nJ9pStviMnfIv+7qsABPeWBUP/i3TztNoN+m+NRBIY9OGJQwDs+2DT5p9uQn1\r\nscGU1TLjKGyVO/9OT2QkcTtDd6a9/pnvJ3Ub+3eECztnYD491Ok11c4zi68z\r\nFlJOH0w+dV0ZVZce2FO5nwE/slN5ESdmspWGmyWg4TXI/rDdKBGRbPSmBE6z\r\nDfsavsnNAU4FiNG0ZILVYW7s7S1/HJ4hXREiwG/fXPvhq9TLleqwQIJbUvr/\r\npMzZGccb58EKbd4GuUmWVMQv1Ex3lXCSVTSgrDtom45SXTZXQoyssG4DKf8h\r\n++5mWTfRmCIIMOWoAOZpxb+Vhe1+CpHWEmQ=\r\n=uagG\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"jonatansalas","email":"jonatan.salas@blackbox-vision.tech"},"directories":{},"maintainers":[{"name":"jonatansalas","email":"jonatan.salas@blackbox-vision.tech"},{"name":"manutuero","email":"manuel.tuero@blackbox-vision.tech"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ra-audit-log_4.0.0_1667817669995_0.34866871952798717"},"_hasShrinkwrap":false},"4.1.0":{"name":"@blackbox-vision/ra-audit-log","description":"> TODO: description","version":"4.1.0","license":"MIT","pika":true,"sideEffects":false,"homepage":"https://github.com/BlackBoxVision/react-admin-extensions#readme","bugs":{"url":"https://github.com/BlackBoxVision/react-admin-extensions/issues"},"dependencies":{},"peerDependencies":{"react":"*","react-admin":"*"},"devDependencies":{"@babel/core":"^7.11.4","@babel/plugin-proposal-class-properties":"^7.10.4","@babel/plugin-proposal-object-rest-spread":"^7.11.0","@babel/preset-react":"^7.10.4","@babel/preset-typescript":"^7.10.4","@pika/pack":"^0.5.0","@pika/plugin-build-types":"^0.9.2","@pika/plugin-build-web":"^0.9.2","@pika/plugin-standard-pkg":"^0.9.2","@types/react":"^16.9.48","react":"^16.13.1","react-admin":"^4.5.0","rimraf":"^3.0.2","typescript":"^3.9.7"},"esnext":"dist-src/index.js","module":"dist-web/index.js","_id":"@blackbox-vision/ra-audit-log@4.1.0","_nodeVersion":"14.18.2","_npmVersion":"6.14.15","dist":{"integrity":"sha512-VZJd+C0c0Kj5wGRaQue+xeFFldQcxuRBAvaepsQIyKr9XnLCKcKgdXKA2nTe1IOAAWvOT4cuBstc+7It3zgEtg==","shasum":"b99fb4e17f1390c8df5c1a5609958c396f38fc3f","tarball":"https://registry.npmjs.org/@blackbox-vision/ra-audit-log/-/ra-audit-log-4.1.0.tgz","fileCount":5,"unpackedSize":13982,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDBabusV4gUk/kn3bEog+n0X5nE8/S7VobXE2JpoAn5cAiEA/R7JxeSimYApfhStYNxSgc17HmTiikAPkJXMpAtP+MI="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkDyPJACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq/aw/9EuErC2rfFsrOT3F80NQ3Srb01OKGmYx/Cu0le5wvXZfS1/PQ\r\nX6cb9o/LA4F6dSIFWdAWHM1n+55kTeaDbkUQYjt1N61A5KIrymhnaH4RvtqU\r\nekKabESFJOOBxMSTH3N+TVA7AAJ3uN2XVw3FOqp8brlXly027Pzwa0In+7Tp\r\n4k7uFhYJSqmSPjifnnC6GSEaYEB+4a7oODIYB1ktocmNwsEzcZE/UHQOHfIJ\r\nECiLi9sZaV5NdPyAfvpeRtWnf7F7B9LaveMEy4dINYyyCGD3GuevgQxPqfkv\r\n04cr0jWyP1dIpm69gERm/GZusDqR2E3HUQob19lQFliwVUmtSPcDIHIFgu7s\r\n+R3/7L0lQpngA1E4jOa5IroQCRYNu1nFhi8cTtEsro4uj7HqPiecMvF2GLJa\r\njtdZzbhK04XrWWHTKeF7sZD2ssHMm7Njn0K8JH2xh809oboFGmk+ACqLdiZx\r\n1ouaBhON5+Y8Ijr2ojFaTdLcj+UpxeGsiOAIKTjzLOZwfiimbQVnoD3b6a7t\r\nIsRmCpGGNHYcDHJMxes9IpuhXh0lko0fD++oqSem8ZborYWd7KX5pQebPcI8\r\nnFzBZ5UIXIyvysffLHHmgFR/HfF/5v4QzLPNBN1ncbM6+1KxsFHCZb89YQg6\r\nfXF9slUDLG2RHm4VVEy/saLkeE9VG5EFMXE=\r\n=janQ\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"jonatansalas","email":"jonatan.salas@blackbox-vision.tech"},"directories":{},"maintainers":[{"name":"jonatansalas","email":"jonatan.salas@blackbox-vision.tech"},{"name":"manutuero","email":"manuel.tuero@blackbox-vision.tech"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ra-audit-log_4.1.0_1678713801050_0.009963055183376035"},"_hasShrinkwrap":false}},"time":{"created":"2022-11-07T10:41:09.921Z","4.0.0":"2022-11-07T10:41:10.197Z","modified":"2023-03-13T13:23:21.281Z","4.1.0":"2023-03-13T13:23:21.190Z"},"maintainers":[{"name":"jonatansalas","email":"jonatan.salas@blackbox-vision.tech"},{"name":"manutuero","email":"manuel.tuero@blackbox-vision.tech"}],"description":"> TODO: description","homepage":"https://github.com/BlackBoxVision/react-admin-extensions#readme","bugs":{"url":"https://github.com/BlackBoxVision/react-admin-extensions/issues"},"license":"MIT","readme":"# RA Audit Log [![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)\n\nAn audit log for `React Admin`.\n\n## Install\n\nYou can install this library via NPM or YARN.\n\n### NPM\n\n```bash\nnpm i @blackbox-vision/ra-audit-log\n```\n\n### YARN\n\n```bash\nyarn add @blackbox-vision/ra-audit-log\n```\n\n## Use case\n\nYou need to track user events over your `React Admin` app.\n\n## Usage\n\nThe usage is really simple:\n \nDefine your `dataProvider` function like the following:\n\n```typescript\nimport { addEventsForMutations } from \"@blackbox-vision/ra-audit-log\";\nimport simpleRestProvider from \"ra-data-simple-rest\";\nimport authProvider from \"./authProvider\";\n\nconst dataProvider = addEventsForMutations(\n  simpleRestProvider(\"http://path.to.my.api/\"),\n  authProvider\n);\n```\n\nThe `addEventsForMutations` function accepts the following options:\n\n- `name`: the name of the event logs resource (defaults to events)\n\n```typescript\nimport { addEventsForMutations } from \"@blackbox-vision/ra-audit-log\";\nimport simpleRestProvider from \"ra-data-simple-rest\";\nimport authProvider from \"./authProvider\";\n\nconst dataProvider = addEventsForMutations(\n  simpleRestProvider(\"http://path.to.my.api/\"),\n  authProvider,\n  { name: \"events\" }\n);\n```\n\n- `resources`: the resources and mutations you want to track with events. It can be an array of resource names or an array of arrays defining both the resource and the dataProvider calls to track\n\n```typescript\nimport { addEventsForMutations } from \"@blackbox-vision/ra-audit-log\";\nimport simpleRestProvider from \"ra-data-simple-rest\";\nimport authProvider from \"./authProvider\";\n\nconst dataProvider = addEventsForMutations(\n  simpleRestProvider(\"http://path.to.my.api/\"),\n  authProvider,\n  {\n    resources: [\n      // create an event for all known mutations on posts\n      \"posts\",\n      // create an event only for create and update on comments, but not for delete, deleteMany or updateMany\n      [\"comments\", [\"create\", \"update\"]],\n    ],\n  }\n);\n```\n\n- `shouldAudit`: as an alternative to resources, you can specify a function which, given a dataProvider method name (create, update, etc.) and the arguments it was called with, should return true to create an event. This allows to target custom dataProvider methods:\n\n```typescript\nimport { addEventsForMutations } from \"@react-admin/ra-audit-log\";\nimport simpleRestProvider from \"ra-data-simple-rest\";\nimport authProvider from \"./authProvider\";\n\nconst dataProvider = addEventsForMutations(\n  simpleRestProvider(\"http://path.to.my.api/\"),\n  authProvider,\n  {\n    shouldAudit: (action, ...args) => {\n      if (action === \"myCustomMethod\") {\n        return true;\n      }\n    },\n  }\n);\n```\n\n## Issues\n\nPlease, open an [issue](https://github.com/BlackBoxVision/react-admin-extensions/issues) following one of the issues templates. We will do our best to fix them.\n\n## Contributing\n\nIf you want to contribute to this project see [contributing](https://github.com/BlackBoxVision/react-admin-extensions/blob/master/CONTRIBUTING.md) for more information.\n\n## License\n\nDistributed under the **MIT license**. See [LICENSE](https://github.com/BlackBoxVision/react-admin-extensions/blob/master/LICENSE) for more information.\n","readmeFilename":"README.md"}