{"_id":"@asephermann/capacitor-plugin-app-tracking-transparency","_rev":"1-25712f0d9a806b0cfed1a46439fa3df5","name":"@asephermann/capacitor-plugin-app-tracking-transparency","dist-tags":{"latest":"2.0.5"},"versions":{"2.0.4":{"name":"@asephermann/capacitor-plugin-app-tracking-transparency","version":"2.0.4","description":"Capacitor plugin to request user authorization to access app-related data for tracking the user or the device.","main":"dist/plugin.cjs.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","author":{"name":"Manuel Heidrich"},"contributors":[{"name":"Manuel Heidrich","email":"manuel@heidrich.dev","url":"https://www.manuel-heidrich.dev"},{"name":"prototype.berlin GmbH","email":"info@prototype.berlin","url":"https://www.prototype.berlin"}],"license":"MIT","repository":{"type":"git","url":"git+https://github.com/mahnuh/capacitor-plugin-app-tracking-transparency.git"},"bugs":{"url":"https://github.com/mahnuh/capacitor-plugin-app-tracking-transparency/issues"},"keywords":["capacitor","plugin","native"],"scripts":{"verify":"npm run verify:ios && npm run verify:web","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- autocorrect --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","docgen":"docgen --api AppTrackingTransparencyPlugin --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","prepublishOnly":"npm run build","test":"echo \"TODO: implement tests\""},"devDependencies":{"@capacitor/core":"^5.0.0","@capacitor/docgen":"^0.2.0","@capacitor/ios":"^5.0.0","@ionic/eslint-config":"^0.3.0","@ionic/prettier-config":"^2.0.0","@ionic/swiftlint-config":"^1.1.2","eslint":"^7.11.0","prettier":"~2.2.0","rimraf":"^3.0.2","rollup":"^2.32.0","swiftlint":"^1.0.1","typescript":"~4.0.3"},"peerDependencies":{"@capacitor/core":"^5.0.0"},"prettier":"@ionic/prettier-config","swiftlint":"@ionic/swiftlint-config","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"capacitor":{"ios":{"src":"ios"}},"gitHead":"5e6f30af818fd9d4bc22759a4d8a4295b62be202","homepage":"https://github.com/mahnuh/capacitor-plugin-app-tracking-transparency#readme","_id":"@asephermann/capacitor-plugin-app-tracking-transparency@2.0.4","_nodeVersion":"18.12.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-L7sDkrgmKWKN5Mrl8GNRVFIdqidghBQRBmqPMmlOLbJgmdLM+Z+PdiQktUtMf6QJCG9kRts5s54UfYtyS8gX5w==","shasum":"db6e66a968ec73d41c7eff871f212650e2ded9aa","tarball":"https://registry.npmjs.org/@asephermann/capacitor-plugin-app-tracking-transparency/-/capacitor-plugin-app-tracking-transparency-2.0.4.tgz","fileCount":23,"unpackedSize":20547,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFvhdBKJbBe6gndk47lJmdGiMxjrD+l703an28YNfVM+AiEAsOzQCPL9FkLcuLPqpZHrN/K+ALWR3i06Nx3efUU23E4="}]},"_npmUser":{"name":"asephermann","email":"asephnursalam@gmail.com"},"directories":{},"maintainers":[{"name":"asephermann","email":"asephnursalam@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/capacitor-plugin-app-tracking-transparency_2.0.4_1685070729168_0.252141423201796"},"_hasShrinkwrap":false},"2.0.5":{"name":"@asephermann/capacitor-plugin-app-tracking-transparency","version":"2.0.5","description":"Capacitor plugin to request user authorization to access app-related data for tracking the user or the device.","main":"dist/plugin.cjs.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","author":{"name":"Manuel Heidrich"},"contributors":[{"name":"Manuel Heidrich","email":"manuel@heidrich.dev","url":"https://www.manuel-heidrich.dev"},{"name":"prototype.berlin GmbH","email":"info@prototype.berlin","url":"https://www.prototype.berlin"}],"license":"MIT","repository":{"type":"git","url":"git+https://github.com/mahnuh/capacitor-plugin-app-tracking-transparency.git"},"bugs":{"url":"https://github.com/mahnuh/capacitor-plugin-app-tracking-transparency/issues"},"keywords":["capacitor","plugin","native"],"scripts":{"verify":"npm run verify:ios && npm run verify:web","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- autocorrect --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","docgen":"docgen --api AppTrackingTransparencyPlugin --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","prepublishOnly":"npm run build","test":"echo \"TODO: implement tests\""},"devDependencies":{"@capacitor/android":"^5.0.4","@capacitor/cli":"^5.0.4","@capacitor/core":"^5.0.4","@capacitor/docgen":"^0.2.0","@capacitor/ios":"^5.0.4","@ionic/eslint-config":"^0.3.0","@ionic/prettier-config":"^2.0.0","@ionic/swiftlint-config":"^1.1.2","eslint":"^7.11.0","prettier":"~2.2.0","rimraf":"^3.0.2","rollup":"^2.32.0","swiftlint":"^1.0.1","typescript":"~4.0.3"},"peerDependencies":{"@capacitor/core":"^5.0.4"},"prettier":"@ionic/prettier-config","swiftlint":"@ionic/swiftlint-config","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"capacitor":{"ios":{"src":"ios"}},"gitHead":"063bcf69a383c2654f4e45487762af3e71c63163","homepage":"https://github.com/mahnuh/capacitor-plugin-app-tracking-transparency#readme","_id":"@asephermann/capacitor-plugin-app-tracking-transparency@2.0.5","_nodeVersion":"18.12.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-3zLVv2y3Tzgvy/d9hHw1mgQE0hUHByDKxEfAi+2l0h3WGSwGGuqbMaQj5p7CRdal0gwS46eYrIPudhtveMkyyQ==","shasum":"2cef86305c63a356e287071e91e0f18ab267506d","tarball":"https://registry.npmjs.org/@asephermann/capacitor-plugin-app-tracking-transparency/-/capacitor-plugin-app-tracking-transparency-2.0.5.tgz","fileCount":23,"unpackedSize":20615,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHeTM6O2VYMRCWIdKMVdVF6PXDh2ZG6vpeij9KfFaBCzAiBpQnplwsHkx7ubZDe8U97hMpYA4LEiYpt9l7J6acaC1A=="}]},"_npmUser":{"name":"asephermann","email":"asephnursalam@gmail.com"},"directories":{},"maintainers":[{"name":"asephermann","email":"asephnursalam@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/capacitor-plugin-app-tracking-transparency_2.0.5_1686018630884_0.5185522743943032"},"_hasShrinkwrap":false}},"time":{"created":"2023-05-26T03:12:09.032Z","2.0.4":"2023-05-26T03:12:09.423Z","modified":"2023-06-06T02:30:31.148Z","2.0.5":"2023-06-06T02:30:31.037Z"},"maintainers":[{"name":"asephermann","email":"asephnursalam@gmail.com"}],"description":"Capacitor plugin to request user authorization to access app-related data for tracking the user or the device.","homepage":"https://github.com/mahnuh/capacitor-plugin-app-tracking-transparency#readme","keywords":["capacitor","plugin","native"],"repository":{"type":"git","url":"git+https://github.com/mahnuh/capacitor-plugin-app-tracking-transparency.git"},"contributors":[{"name":"Manuel Heidrich","email":"manuel@heidrich.dev","url":"https://www.manuel-heidrich.dev"},{"name":"prototype.berlin GmbH","email":"info@prototype.berlin","url":"https://www.prototype.berlin"}],"author":{"name":"Manuel Heidrich"},"bugs":{"url":"https://github.com/mahnuh/capacitor-plugin-app-tracking-transparency/issues"},"license":"MIT","readme":"# capacitor-plugin-app-tracking-transparency\r\n\r\n\r\n\r\n\r\n\r\nCapacitor plugin to request user authorization to access app-related data for tracking the user or the device. iOS only.\r\n\r\nRead more about Apple's App Tracking Transparency framework [here](https://developer.apple.com/documentation/apptrackingtransparency). Also [this](https://developer.apple.com/app-store/user-privacy-and-data-use/) might be a good read.\r\n\r\n## Platform support\r\n\r\niOS only but with web fallback for development purposes.\r\n\r\n## Plugin versions\r\n\r\n| Capacitor version | Plugin version |\r\n| ---------- | ----------------------------------------- |\r\n| 4.x | >= 2.0.2 |\r\n| 3.x | >= 2.0.0 |\r\n| < 3.0.0 | 1.x.x |\r\n\r\nFor plugin version 1.x.x docs please refer to [branch v1](https://github.com/mahnuh/capacitor-plugin-app-tracking-transparency/tree/v1).\r\n\r\n## Maintainers\r\n\r\n| Maintainer | GitHub | Social |\r\n| ---------- | ----------------------------------------- | --------------------------------------------- |\r\n| Manuel Heidrich | [mahnuh](https://github.com/mahnuh) | [@mahnuh](https://twitter.com/mahnuh) |\r\n\r\n## Install\r\n\r\n```bash\r\nnpm install capacitor-plugin-app-tracking-transparency\r\nnpx cap sync\r\n```\r\n\r\n## Configuration\r\n\r\nAdd this to your app's Info.plist and update the message according to your needs:\r\n\r\n```xml\r\nNSUserTrackingUsageDescription\r\nYour data will be used to deliver personalized ads to you.\r\n```\r\n\r\nThis message can be provided in multiple languages by using a `InfoPlist.strings` file. See the [Apple docs](https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html) or [this stack overflow answer](https://stackoverflow.com/a/25736915) for help.\r\n\r\n## Usage\r\n\r\n```typescript\r\nimport 'capacitor-plugin-app-tracking-transparency'; // only if you want web support\r\n\r\nimport {\r\n AppTrackingTransparency,\r\n AppTrackingStatusResponse,\r\n} from 'capacitor-plugin-app-tracking-transparency';\r\n\r\n...\r\n\r\npublic async getStatus(): Promise {\r\n const response = await AppTrackingTransparency.getStatus();\r\n\r\n console.log(response);\r\n // { status: 'authorized' } for example\r\n\r\n return response;\r\n}\r\n\r\npublic async requestPermission(): Promise {\r\n const response = await AppTrackingTransparency.requestPermission();\r\n\r\n console.log(response);\r\n // { status: 'authorized' } for example\r\n\r\n return response;\r\n}\r\n```\r\n\r\nBoth available methods return `AppTrackingStatusResponse` with `status: AppTrackingStatus`, which will be one of the following: `authorized`, `denied`, `notDetermined` or `restricted`. See [Apple's docs](https://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/authorizationstatus) for reference.\r\n\r\n## API\r\n\r\n\n\n* [`getStatus()`](#getstatus)\n* [`requestPermission()`](#requestpermission)\n* [Type Aliases](#type-aliases)\n\n\r\n\r\n\n\n\n### getStatus()\n\n```typescript\ngetStatus() => Promise\n```\n\n**Returns:** Promise<AppTrackingStatusResponse>\n\n--------------------\n\n\n### requestPermission()\n\n```typescript\nrequestPermission() => Promise\n```\n\n**Returns:** Promise<AppTrackingStatusResponse>\n\n--------------------\n\n\n### Type Aliases\n\n\n#### AppTrackingStatusResponse\n\n{ status: AppTrackingStatus }\n\n\n#### AppTrackingStatus\n\n'authorized' | 'denied' | 'notDetermined' | 'restricted'\n\n\r\n\r\n## Todos\r\n\r\n- [x] Extend API docs\r\n\r\n## License\r\n\r\n[MIT](https://github.com/mahnuh/capacitor-plugin-app-tracking-transparency/blob/main/LICENSE)\r\n","readmeFilename":"README.md"}