\n \n
\n Getting started \n | \n Contributing \n | \n License \n
\n\n---\n\nAn [Expo Module](https://docs.expo.dev/modules/overview/) and [Expo Config Plugin](https://docs.expo.dev/guides/config-plugins/) to automatically set up and configure the [Ausweis App SDK](https://www.ausweisapp.bund.de/sdk/intro.html) for iOS & Android in Expo apps.\n\n## Getting Started\n\nInstall the plugin and `expo-build-properties` using the following command. We need `expo-build-properties` to set the `minSdkVersion` for Android to at least 26, and enable `useLegacyPackaging` (see [App Bundle](https://www.ausweisapp.bund.de/sdk/android.html#app-bundle) in Ausweis SDK documentation).\n\n```sh\n# yarn\nyarn add @animo-id/expo-ausweis-sdk expo-build-properties\n\n# npm\nnpm install @animo-id/expo-ausweis-sdk expo-build-properties\n\n# npm\npnpm install @animo-id/expo-ausweis-sdk expo-build-properties\n```\n\nThen add the plugin to your Expo app config (`app.json`, `app.config.json` or `app.config.js`) `plugins` array:\n\n```json\n{\n \"expo\": {\n \"plugins\": [\n \"@animo-id/expo-ausweis-sdk\",\n [\n \"expo-build-properties\",\n {\n \"android\": {\n \"minSdkVersion\": 26,\n \"useLegacyPackaging\": true\n }\n }\n ]\n ]\n }\n}\n```\n\n> NOTE: the `expo` top level key is only needed in `app.json`. In `app.config.json`, `app.config.js` and `app.config.ts` the top level expo key is not present anymore.\n\nAnd lastly, prebuild the application so the Ausweis SDK and Expo Module wrapper can be added as native dependency (If you aren't making any manual modification to the iOS and Android directories you can add them to the gitignore of your project and generate them on demand):\n\n```sh\n# yarn\nyarn expo prebuild\n\n# npm\nnpx expo prebuild\n```\n\nThat's it, you now have Ausweis App SDK configured for your iOS and Android project.\n\n## Usage\n\nYou can now import `@animo-id/expo-ausweis-sdk` in your application and use the methods from the SDK. \n\nYou can see the available [commands](https://www.ausweisapp.bund.de/sdk/commands.html#) and [messages](https://www.ausweisapp.bund.de/sdk/messages.html), which are typed in the `sendCommand` and `addMessageListener` methods.\n\n```tsx\nimport { useEffect, useState } from 'react'\nimport { initializeSdk, sendCommand, addMessageListener } from '@animo-id/expo-ausweis-sdk'\n\nexport function App() {\n const [isSdkInitialized, setIsSdkInitialized] = useState(false)\n\n // Setup listener\n useEffect(\n addMessageListener((message) => {\n console.log('received message', JSON.stringify(message, null, 2))\n }).remove,\n []\n )\n\n // Initialize SDK\n useEffect(() => {\n initializeSdk()\n .then(() => setIsSdkInitialized(true))\n .catch((e) => {\n console.log('error setting up', e)\n })\n }, [])\n\n // Send command once SDK is initialized\n useEffect(() => {\n if (!isSdkInitialized) return\n\n sendCommand({ cmd: 'GET_INFO' })\n }, [isSdkInitialized])\n\n return null\n}\n```\n\n### Auth Flow\n\nThe package also exports an `AusweisAuthFlow` class that wraps the required logic for a general auth flow. An example of how to use the class can be found below.\n\nTo use the `AusweisAuthFlow` you need to configure it with the correct callbacks, and then call the `start()` method with the `tcTokenUrl`.\n\nTo cancel the flow, you can call the `cancel()` flow on the `AusweisAuthFlow` instance.\n\nThe Ausweis SDK only allows one flow to be active concurrently. It is important that you do not create multiple instances of the `AusweisAuthFlow`, as they will both receive the same events and messages, and will cause conflicts.\n\nNote that this class is optimized for a simple auth flow and thus it may not fit all use cases. For example, the `SET_CAN` and `SET_PUK` commands are not supported (in case of too many failed PIN attempts). Attached simulator cards are also not supported. For more advanced use cases you can use the lower level commands and message listeners methods.\n\n```tsx\nimport { AusweisAuthFlow } from '@animo-id/expo-ausweis-sdk'\nimport { useState } from 'react'\nimport { Button, StyleSheet, Text, View } from 'react-native'\n\nexport default function App() {\n const [message, setMessage] = useState![](\"https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg\"){kind=icon}
\n ![](\"https://img.shields.io/npm/v/@animo-id/expo-ausweis-sdk\")
\n