@animo-id/expo-mdoc-data-transfer 0.1.5 → 0.2.0-alpha.0

package/plugin/src/withAndroid.ts

@@ -0,0 +1,199 @@
+import {
+  AndroidConfig,
+  type ConfigPlugin,
+  withAndroidManifest,
+  withAppBuildGradle,
+  withPlugins,
+} from '@expo/config-plugins'
+
+type InnerManifest = AndroidConfig.Manifest.AndroidManifest['manifest']
+
+type ManifestPermission = InnerManifest['permission']
+
+type ExtraItems = {
+  'tools:targetApi'?: string
+  'android:usesPermissionFlags'?: string
+  'android:maxSdkVersion'?: string
+}
+
+type ManifestUsesPermissionWithExtraItems = {
+  $: AndroidConfig.Manifest.ManifestUsesPermission['$'] & ExtraItems
+}
+
+type AndroidManifest = {
+  manifest: InnerManifest & {
+    permission?: ManifestPermission
+    'uses-permission'?: ManifestUsesPermissionWithExtraItems[]
+    'uses-feature'?: InnerManifest['uses-feature']
+  }
+}
+
+const withBleAndroidManifest: ConfigPlugin = (config) =>
+  withAndroidManifest(config, (config) => {
+    config.modResults = addScanAndAdvertisePermissionToManifest(config.modResults)
+    config.modResults = addConnectPermissionToManifest(config.modResults)
+    config.modResults = addLegacyBlePermissionToManifest(config.modResults)
+
+    return config
+  })
+
+function addLegacyBlePermissionToManifest(androidManifest: AndroidManifest) {
+  if (!Array.isArray(androidManifest.manifest['uses-permission'])) {
+    androidManifest.manifest['uses-permission'] = []
+  }
+
+  if (
+    !androidManifest.manifest['uses-permission'].find(
+      (item) => item.$['android:name'] === 'android.permission.BLUETOOTH'
+    )
+  ) {
+    AndroidConfig.Manifest.ensureToolsAvailable(androidManifest)
+    androidManifest.manifest['uses-permission']?.push({
+      $: {
+        'android:name': 'android.permission.BLUETOOTH',
+        'android:maxSdkVersion': '30',
+      },
+    })
+    androidManifest.manifest['uses-permission']?.push({
+      $: {
+        'android:name': 'android.permission.BLUETOOTH_ADMIN',
+        'android:maxSdkVersion': '30',
+      },
+    })
+  }
+  return androidManifest
+}
+
+function addScanAndAdvertisePermissionToManifest(androidManifest: AndroidManifest) {
+  if (!Array.isArray(androidManifest.manifest['uses-permission'])) {
+    androidManifest.manifest['uses-permission'] = []
+  }
+
+  if (
+    !androidManifest.manifest['uses-permission'].find(
+      (item) => item.$['android:name'] === 'android.permission.BLUETOOTH_SCAN'
+    )
+  ) {
+    AndroidConfig.Manifest.ensureToolsAvailable(androidManifest)
+    androidManifest.manifest['uses-permission']?.push({
+      $: {
+        'android:name': 'android.permission.BLUETOOTH_SCAN',
+        'android:usesPermissionFlags': 'neverForLocation',
+        'tools:targetApi': '31',
+      },
+    })
+    androidManifest.manifest['uses-permission']?.push({
+      $: {
+        'android:name': 'android.permission.BLUETOOTH_ADVERTISE',
+        'tools:targetApi': '31',
+      },
+    })
+  }
+  return androidManifest
+}
+
+function addConnectPermissionToManifest(androidManifest: AndroidManifest) {
+  if (!Array.isArray(androidManifest.manifest['uses-permission'])) {
+    androidManifest.manifest['uses-permission'] = []
+  }
+
+  if (
+    !androidManifest.manifest['uses-permission'].find(
+      (item) => item.$['android:name'] === 'android.permission.BLUETOOTH_CONNECT'
+    )
+  ) {
+    AndroidConfig.Manifest.ensureToolsAvailable(androidManifest)
+    androidManifest.manifest['uses-permission']?.push({
+      $: {
+        'android:name': 'android.permission.BLUETOOTH_CONNECT',
+      },
+    })
+  }
+  return androidManifest
+}
+
+const withAndroidExcludeBcProv: ConfigPlugin = (expoConfig) =>
+  withAppBuildGradle(expoConfig, (c) => {
+    if (c.modResults.contents.includes("all*.exclude module: 'bcprov-jdk15to18'")) return c
+    c.modResults.contents += `android { configurations { all*.exclude module: 'bcprov-jdk15to18' } }`
+    return c
+  })
+
+const withAndroidNfcProperties: ConfigPlugin = (expoConfig) =>
+  withAndroidManifest(expoConfig, (c) => {
+    const androidManifest = c.modResults.manifest
+
+    if (!androidManifest['uses-permission']?.some((p) => p.$['android:name'] === 'android.permission.NFC')) {
+      androidManifest['uses-permission']?.push({
+        $: {
+          'android:name': 'android.permission.NFC',
+        },
+      })
+    }
+
+    for (const app of androidManifest.application ?? []) {
+      if (app.service?.some((s) => s.$['android:name'] === 'id.animo.mdoc.datatransfer.NfcEngagementServiceImpl'))
+        continue
+      app.service ??= []
+      app.service.push({
+        $: {
+          'android:exported': 'true',
+          'android:name': 'id.animo.mdoc.datatransfer.NfcEngagementServiceImpl',
+          'android:permission': 'android.permission.BIND_NFC_SERVICE',
+        },
+        'intent-filter': [
+          {
+            action: [
+              {
+                $: {
+                  'android:name': 'android.nfc.action.NDEF_DISCOVERED',
+                },
+              },
+              {
+                $: {
+                  'android:name': 'android.nfc.cardemulation.action.HOST_APDU_SERVICE',
+                },
+              },
+            ],
+          },
+        ],
+        // @ts-expect-error
+        'meta-data': {
+          $: {
+            'android:name': 'android.nfc.cardemulation.host_apdu_service',
+            'android:resource': '@xml/nfc_engagement_apdu_service',
+          },
+        },
+      })
+    }
+
+    return c
+  })
+
+const withAndroidFixMetaInfConflict: ConfigPlugin = (expoConfig) =>
+  withAppBuildGradle(expoConfig, (c) => {
+    if (c.modResults.contents.includes('META-INF/versions/9/OSGI-INF/MANIFEST.MF')) {
+      return c
+    }
+
+    c.modResults.contents = c.modResults.contents.replace(
+      /android\s?{/,
+      `android {
+        packagingOptions {
+          resources {
+            excludes += "META-INF/versions/9/OSGI-INF/MANIFEST.MF"
+          }
+        }`
+    )
+
+    return c
+  })
+
+export const withAndroid: ConfigPlugin = (config) =>
+  withPlugins(config, [
+    (c) => AndroidConfig.Permissions.withPermissions(c, ['android.permission.BLUETOOTH_CONNECT']),
+    withBleAndroidManifest,
+    withAndroidExcludeBcProv,
+    withAndroidNfcProperties,
+    withAndroidFixMetaInfConflict,
+  ])

package/plugin/src/withIos.ts

@@ -0,0 +1,48 @@
+import { type ConfigPlugin, withInfoPlist, withPlugins, withPodfile } from '@expo/config-plugins'
+import type { Props } from '.'
+
+const BLUETOOTH_ALWAYS = 'Allow $(PRODUCT_NAME) to connect to bluetooth devices for data sharing'
+
+const withIosBuildStatic: ConfigPlugin<Props> = (expoConfig, props) =>
+  withPodfile(expoConfig, (c) => {
+    if (!props.ios?.buildStatic) return c
+    const staticLibraries = `mdoc_data_transfer_static_libraries=[${props.ios.buildStatic.map((i) => `"${i}"`).join(', ')}]`
+    if (c.modResults.contents.includes('mdoc_data_transfer_static_libraries')) {
+      c.modResults.contents = c.modResults.contents.replace(/mdoc_data_transfer_static_libraries=.*/, staticLibraries)
+    } else {
+      c.modResults.contents += staticLibraries
+    }
+
+    if (c.modResults.contents.includes('Pod::BuildType.static_library')) return c
+
+    c.modResults.contents += `
+pre_install do |installer|
+  installer.pod_targets.each do |pod|
+    if mdoc_data_transfer_static_libraries.include?(pod.name)
+      def pod.build_type;
+        Pod::BuildType.static_library
+      end
+    end
+  end
+end
+  `
+    return c
+  })
+
+const withBluetoothPermissions: ConfigPlugin<{
+  bluetoothAlwaysPermission?: string | false
+}> = (c, { bluetoothAlwaysPermission } = {}) => {
+  return withInfoPlist(c, (config) => {
+    if (bluetoothAlwaysPermission !== false) {
+      config.modResults.NSBluetoothAlwaysUsageDescription =
+        bluetoothAlwaysPermission || config.modResults.NSBluetoothAlwaysUsageDescription || BLUETOOTH_ALWAYS
+    }
+    return config
+  })
+}
+
+export const withIos: ConfigPlugin<Props> = (config, props) =>
+  withPlugins(config, [
+    [withBluetoothPermissions, props],
+    [withIosBuildStatic, props],
+  ])

package/plugin/tsconfig.json

@@ -0,0 +1,9 @@
+{
+	"extends": "expo-module-scripts/tsconfig.plugin",
+	"compilerOptions": {
+		"outDir": "build",
+		"rootDir": "src"
+	},
+	"include": ["./src"],
+	"exclude": ["**/__mocks__/*", "**/__tests__/*"]
+}

package/plugin/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/index.ts","./src/withandroid.ts","./src/withios.ts"],"version":"5.9.3"}

package/src/MdocDataTransfer.ts

@@ -0,0 +1,89 @@
+import { Buffer } from 'buffer'
+import { MdocDataTransferError } from './MdocDataTransferError'
+import {
+  MdocDataTransferEvent,
+  type OnErrorPayload,
+  type OnRequestReceivedEventPayload,
+  type OnResponseSentPayload,
+} from './MdocDataTransferEvent'
+import { NativeMdocDataTransfer } from './NativeMdocDataTransfer'
+
+export let instance: MdocDataTransfer | undefined = undefined
+export const mdocDataTransfer = {
+  instance: () => {
+    if (instance) return instance
+    return MdocDataTransfer.initialize()
+  },
+  isInitialized: () => !!instance,
+}
+
+class MdocDataTransfer {
+  public isNfcEnabled = false
+
+  private static handleError(nativeCall: () => void) {
+    let error: string | undefined
+    const subscription = NativeMdocDataTransfer.addListener(
+      MdocDataTransferEvent.OnError,
+      (payload: OnErrorPayload) => {
+        error = payload.error
+      }
+    )
+
+    nativeCall()
+
+    subscription.remove()
+
+    if (error) {
+      throw new MdocDataTransferError(error)
+    }
+  }
+
+  public static initialize() {
+    MdocDataTransfer.handleError(NativeMdocDataTransfer.initialize)
+
+    instance = new MdocDataTransfer()
+    return instance
+  }
+
+  public async startQrEngagement() {
+    return await NativeMdocDataTransfer.startQrEngagement()
+  }
+
+  public async waitForDeviceRequest() {
+    return await new Promise<{ deviceRequest: Uint8Array; sessionTranscript: Uint8Array }>((resolve) =>
+      NativeMdocDataTransfer.addListener(
+        MdocDataTransferEvent.OnRequestReceived,
+        (payload: OnRequestReceivedEventPayload) => {
+          resolve({
+            deviceRequest: new Uint8Array(Buffer.from(payload.deviceRequest, 'base64')),
+            sessionTranscript: new Uint8Array(Buffer.from(payload.sessionTranscript, 'base64')),
+          })
+        }
+      )
+    )
+  }
+
+  public async sendDeviceResponse(deviceResponse: Uint8Array) {
+    const p = new Promise<OnResponseSentPayload>((resolve) =>
+      NativeMdocDataTransfer.addListener(MdocDataTransferEvent.OnResponseSent, resolve)
+    )
+
+    MdocDataTransfer.handleError(() =>
+      NativeMdocDataTransfer.sendDeviceResponse(Buffer.from(deviceResponse).toString('base64'))
+    )
+
+    await p
+  }
+
+  public shutdown() {
+    this.isNfcEnabled = false
+    MdocDataTransfer.handleError(NativeMdocDataTransfer.shutdown)
+    instance = undefined
+  }
+
+  public enableNfc() {
+    if (this.isNfcEnabled) return
+    NativeMdocDataTransfer.enableNfc()
+    this.isNfcEnabled = true
+  }
+}

package/src/MdocDataTransferError.ts

@@ -0,0 +1 @@
+export class MdocDataTransferError extends Error {}

package/src/MdocDataTransferEvent.ts

@@ -0,0 +1,16 @@
+export enum MdocDataTransferEvent {
+  OnRequestReceived = 'onRequestReceived',
+  OnResponseSent = 'onResponseSent',
+  OnError = 'onError',
+}
+
+export type OnResponseSentPayload = null
+
+export type OnRequestReceivedEventPayload = {
+  deviceRequest: string
+  sessionTranscript: string
+}
+
+export type OnErrorPayload = {
+  error: string
+}

package/src/NativeMdocDataTransfer.ts

@@ -0,0 +1,18 @@
+import { NativeModule, requireNativeModule } from 'expo-modules-core'
+import type { OnErrorPayload, OnRequestReceivedEventPayload, OnResponseSentPayload } from './MdocDataTransferEvent'
+
+export type MdocDataTransferEvents = {
+  onRequestReceived: (payload: OnRequestReceivedEventPayload) => void
+  onResponseSent: (payload: OnResponseSentPayload) => void
+  onError: (payload: OnErrorPayload) => void
+}
+
+declare class MdocDataTransferModule extends NativeModule<MdocDataTransferEvents> {
+  initialize: () => void
+  startQrEngagement: () => Promise<string>
+  sendDeviceResponse: (devceResponse: string) => void
+  shutdown: () => void
+  enableNfc: () => void
+}
+
+export const NativeMdocDataTransfer = requireNativeModule<MdocDataTransferModule>('MdocDataTransfer')

package/src/index.ts

@@ -0,0 +1,2 @@
+export { mdocDataTransfer } from './MdocDataTransfer'
+export { useMdocDataTransferShutdownOnUnmount } from './useMdocDataTransferShutdownOnUnmount'

package/src/useMdocDataTransferShutdownOnUnmount.ts

@@ -0,0 +1,9 @@
+import { useEffect } from 'react'
+import { instance } from './MdocDataTransfer'
+
+export const useMdocDataTransferShutdownOnUnmount = () =>
+  useEffect(() => {
+    return () => {
+      if (instance) instance.shutdown()
+    }
+  }, [])

package/tsconfig.json

@@ -0,0 +1,9 @@
+// @generated by expo-module-scripts
+{
+	"extends": "expo-module-scripts/tsconfig.base",
+	"compilerOptions": {
+		"outDir": "./build"
+	},
+	"include": ["./src"],
+	"exclude": ["**/__mocks__/*", "**/__tests__/*"]
+}

package/README.md

@@ -1,41 +0,0 @@
-# @animo-id/mdoc-data-transfer
-
-mdoc data transfer module
-
-# API documentation
-
-- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/@animo-id/expo-mdoc-data-transfer.md)
-- [Documentation for the latest stable release](https://docs.expo.dev/versions/latest/sdk/@animo-id/expo-mdoc-data-transfer/)
-
-# Installation in managed Expo projects
-
-For [managed](https://docs.expo.dev/archive/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation). If you follow the link and there is no documentation available then this library is not yet usable within managed projects — it is likely to be included in an upcoming Expo SDK release.
-
-TODO: plugin config for iOS and android:
-
-- iOS
-  - add `expo-build-properties` with `ios.useFrameworks: "dynamic"`
-  - the library works with both new and old arch, but is most efficient on new arch
-    - to enable new arch add `expo-build-properties` with `newArchEnabled: true`
-- Android
-  - @berend?
-
-# Installation in bare React Native projects
-
-For bare React Native projects, you must ensure that you have [installed and configured the `expo` package](https://docs.expo.dev/bare/installing-expo-modules/) before continuing.
-
-### Add the package to your npm dependencies
-
-```
-npm install @animo-id/expo-mdoc-data-transfer
-```
-
-### Configure for iOS
-
-Run `USE_FRAMEWORKS=dynamic npx pod-install` after installing the npm package.
-
-### Configure for Android
-
-# Contributing
-
-Contributions are very welcome! Please refer to guidelines described in the [contributing guide](https://github.com/expo/expo#contributing).

package/ios/MdocDataTransfer.mm

@@ -1,23 +0,0 @@
-#import "React/RCTBridgeModule.h"
-#import "React/RCTEventEmitter.h"
-
-@interface RCT_EXTERN_MODULE (MdocDataTransfer, RCTEventEmitter)
-
-+ (BOOL)requiresMainQueueSetup {
-    return NO;
-}
-
-RCT_EXTERN_METHOD(enableNfc)
-
-RCT_EXTERN_METHOD(initialize:(NSString *)serviceName)
-
-RCT_EXTERN_METHOD(startQrEngagement:(RCTPromiseResolveBlock)resolve
-                  reject:(RCTPromiseRejectBlock)reject)
-
-RCT_EXTERN_METHOD(sendDeviceResponse:(NSString)deviceResponse
-                  resolve:(RCTPromiseResolveBlock)resolve
-                  reject:(RCTPromiseRejectBlock)reject)
-
-RCT_EXTERN_METHOD(shutdown)
-
-@end

package/src/specs/NativeMdocDataTransfer.ts

@@ -1,13 +0,0 @@
-export interface Spec {
-  enableNfc: () => void
-
-  // String indicates an error on iOS legacy architecture
-  initialize: (serviceName: string) => undefined | string
-
-  startQrEngagement: () => Promise<string>
-
-  sendDeviceResponse: (devceResponse: string) => Promise<void>
-
-  // String indicates an error on iOS legacy architecture
-  shutdown: () => undefined | string
-}