@siteed/expo-audio-studio 2.1.1

package/package.json

@@ -0,0 +1,128 @@
+{
+  "name": "@siteed/expo-audio-studio",
+  "version": "2.1.1",
+  "description": "Comprehensive audio processing library for React Native and Expo with recording, analysis, visualization, and streaming capabilities across iOS, Android, and web",
+  "license": "MIT",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "author": "Arthur Breton <abreton@siteed.net> (https://github.com/deeeed)",
+  "homepage": "https://github.com/deeeed/expo-audio-stream/blob/main/packages/expo-audio-studio/README.md",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/deeeed/expo-audio-stream.git",
+    "directory": "packages/expo-audio-studio"
+  },
+  "bugs": {
+    "url": "https://github.com/deeeed/expo-audio-stream/issues"
+  },
+  "keywords": [
+    "react-native",
+    "expo",
+    "audio",
+    "recording",
+    "audio-analysis",
+    "audio-processing",
+    "audio-visualization",
+    "waveform",
+    "spectrogram",
+    "mel-spectrogram",
+    "mfcc",
+    "audio-features",
+    "audio-compression",
+    "opus",
+    "aac",
+    "pcm",
+    "wav",
+    "cross-platform",
+    "background-recording",
+    "audio-trimming",
+    "dual-stream"
+  ],
+  "files": [
+    "src",
+    "android",
+    "ios",
+    "cpp",
+    "plugin",
+    "app.plugin.js",
+    "LICENSE",
+    "CHANGELOG.md",
+    "generated",
+    "expo-module.config.json",
+    "README.md",
+    "package.json",
+    "*.podspec",
+    "build",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "build:plugin": "tsc --build plugin/tsconfig.json",
+    "build:plugin:dev": "expo-module build plugin",
+    "build:dev": "expo-module build",
+    "clean": "expo-module clean && rimraf plugin/build",
+    "lint": "expo-module lint",
+    "test": "expo-module test",
+    "typecheck": "tsc --noEmit",
+    "docgen": "typedoc src/index.ts --plugin typedoc-plugin-markdown --readme none --out ../../documentation_site/docs/api-reference/API",
+    "prepare": "yarn build && yarn build:plugin",
+    "prepublishOnly": "expo-module prepublishOnly",
+    "expo-module": "expo-module",
+    "open:ios": "open -a \"Xcode\" ../../apps/playground/ios",
+    "open:android": "open -a \"Android Studio\" ../../apps/playground/android",
+    "size": "bundle-size && size-limit",
+    "release": "./publish.sh"
+  },
+  "devDependencies": {
+    "@expo/config-plugins": "~9.0.0",
+    "@siteed/publisher": "^0.4.18",
+    "@size-limit/preset-big-lib": "^11.1.4",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.7",
+    "@types/react": "~18.3.12",
+    "@typescript-eslint/eslint-plugin": "^7.7.0",
+    "@typescript-eslint/parser": "^7.7.0",
+    "bundle-size": "^1.1.5",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-universe": "^12.0.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-react": "^7.34.1",
+    "expo": "^52.0.27",
+    "expo-module-scripts": "^4.0.2",
+    "jest": "^29.7.0",
+    "prettier": "^3.2.5",
+    "react-native": "0.76.6",
+    "rimraf": "^6.0.1",
+    "size-limit": "^11.1.4",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.27.4",
+    "typedoc-plugin-markdown": "^4.3.2",
+    "typescript": "~5.3.3"
+  },
+  "peerDependencies": {
+    "expo": "*",
+    "react": "*",
+    "react-native": "*"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "dependencies": {
+    "@siteed/design-system": "^0.35.1",
+    "crc-32": "^1.2.2",
+    "expo-modules-core": "~2.1.4"
+  }
+}

package/plugin/build/index.d.ts

@@ -0,0 +1,21 @@
+import { ConfigPlugin } from '@expo/config-plugins';
+interface AudioStreamPluginOptions {
+    enablePhoneStateHandling?: boolean;
+    enableNotifications?: boolean;
+    enableBackgroundAudio?: boolean;
+    iosBackgroundModes?: {
+        useVoIP?: boolean;
+        useAudio?: boolean;
+        useProcessing?: boolean;
+        useLocation?: boolean;
+        useExternalAccessory?: boolean;
+    };
+    iosConfig?: {
+        allowBackgroundAudioControls?: boolean;
+        backgroundProcessingTitle?: string;
+        microphoneUsageDescription?: string;
+        notificationUsageDescription?: string;
+    };
+}
+declare const withRecordingPermission: ConfigPlugin<AudioStreamPluginOptions>;
+export default withRecordingPermission;

package/plugin/build/index.js

@@ -0,0 +1,192 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_plugins_1 = require("@expo/config-plugins");
+const MICROPHONE_USAGE = 'Allow $(PRODUCT_NAME) to access your microphone';
+const NOTIFICATION_USAGE = 'Show recording notifications and controls';
+const LOG_PREFIX = '[@siteed/expo-audio-studio]';
+function debugLog(message, ...args) {
+    if (process.env.EXPO_DEBUG) {
+        console.log(`${LOG_PREFIX} ${message}`, ...args);
+    }
+}
+const withRecordingPermission = (config, props) => {
+    const options = {
+        enablePhoneStateHandling: true, // Default to true for backward compatibility
+        enableNotifications: true,
+        enableBackgroundAudio: true,
+        iosBackgroundModes: {
+            useVoIP: false,
+            useAudio: false,
+            useProcessing: false,
+            useLocation: false,
+            useExternalAccessory: false,
+        },
+        iosConfig: {
+            microphoneUsageDescription: MICROPHONE_USAGE,
+            notificationUsageDescription: NOTIFICATION_USAGE,
+        },
+        ...(props || {}),
+    };
+    const { enablePhoneStateHandling, enableNotifications, enableBackgroundAudio, } = options;
+    debugLog('📱 Configuring Recording Permissions Plugin...', options);
+    // iOS Configuration
+    config = (0, config_plugins_1.withInfoPlist)(config, (config) => {
+        // Always set the microphone usage description from options first
+        config.modResults['NSMicrophoneUsageDescription'] =
+            options.iosConfig?.microphoneUsageDescription ||
+                config.modResults['NSMicrophoneUsageDescription'] ||
+                MICROPHONE_USAGE;
+        if (enableNotifications) {
+            config.modResults['NSUserNotificationsUsageDescription'] =
+                options.iosConfig?.notificationUsageDescription ||
+                    config.modResults['NSUserNotificationsUsageDescription'] ||
+                    NOTIFICATION_USAGE;
+            config.modResults['NSUserNotificationAlertStyle'] = 'alert';
+        }
+        const existingBackgroundModes = config.modResults.UIBackgroundModes || [];
+        // Only add background modes if explicitly enabled and set to true
+        if (options.iosBackgroundModes?.useAudio === true &&
+            enableBackgroundAudio === true &&
+            !existingBackgroundModes.includes('audio')) {
+            // Don't automatically add 'audio' background mode as it's only for playback
+            // existingBackgroundModes.push('audio')
+            // Instead, ensure processing mode is used for background recording
+            if (options.iosBackgroundModes?.useProcessing !== true) {
+                console.warn(`${LOG_PREFIX} Warning: Background audio recording requires 'processing' background mode. Please enable 'useProcessing' in iosBackgroundModes.`);
+            }
+        }
+        if (options.iosBackgroundModes?.useVoIP === true &&
+            enablePhoneStateHandling === true) {
+            if (!existingBackgroundModes.includes('voip')) {
+                existingBackgroundModes.push('voip');
+            }
+            const existingCapabilities = (config.modResults
+                .UIRequiredDeviceCapabilities || []);
+            if (!existingCapabilities.includes('telephony')) {
+                existingCapabilities.push('telephony');
+            }
+            config.modResults.UIRequiredDeviceCapabilities =
+                existingCapabilities;
+        }
+        // Add additional background modes only if explicitly set to true
+        if (options.iosBackgroundModes?.useProcessing === true) {
+            if (!existingBackgroundModes.includes('processing')) {
+                existingBackgroundModes.push('processing');
+            }
+            // Add processing info if enabled
+            // Note: We keep the 'audiostream' namespace for native modules to maintain compatibility
+            config.modResults.BGTaskSchedulerPermittedIdentifiers = [
+                'com.siteed.audiostream.processing',
+            ];
+        }
+        if (options.iosBackgroundModes?.useLocation === true) {
+            if (!existingBackgroundModes.includes('location')) {
+                existingBackgroundModes.push('location');
+            }
+        }
+        if (options.iosBackgroundModes?.useExternalAccessory === true) {
+            if (!existingBackgroundModes.includes('external-accessory')) {
+                existingBackgroundModes.push('external-accessory');
+            }
+        }
+        // Configure background processing info if enabled
+        if (options.iosConfig?.backgroundProcessingTitle) {
+            config.modResults.BGProcessingTaskTitle =
+                options.iosConfig.backgroundProcessingTitle;
+        }
+        // Configure audio session behavior
+        if (options.iosConfig?.allowBackgroundAudioControls) {
+            config.modResults.UIBackgroundModes = [
+                ...existingBackgroundModes,
+                'remote-notification',
+            ];
+            config.modResults.MPNowPlayingInfoPropertyPlaybackRate = true;
+        }
+        config.modResults.UIBackgroundModes = existingBackgroundModes;
+        return config;
+    });
+    // Android Configuration
+    config = (0, config_plugins_1.withAndroidManifest)(config, (config) => {
+        const basePermissions = [
+            'android.permission.RECORD_AUDIO',
+            'android.permission.WAKE_LOCK',
+        ];
+        const optionalPermissions = [
+            enableNotifications && 'android.permission.POST_NOTIFICATIONS',
+            enablePhoneStateHandling && 'android.permission.READ_PHONE_STATE',
+            enableBackgroundAudio && 'android.permission.FOREGROUND_SERVICE',
+            enableBackgroundAudio &&
+                'android.permission.FOREGROUND_SERVICE_MICROPHONE',
+        ].filter(Boolean);
+        const permissionsToAdd = [...basePermissions, ...optionalPermissions];
+        debugLog('📋 Existing Android permissions:', config.modResults.manifest['uses-permission']?.map((p) => p.$?.['android:name']) || []);
+        debugLog('➕ Adding Android permissions:', permissionsToAdd);
+        const { addPermission } = config_plugins_1.AndroidConfig.Permissions;
+        // Add each permission only if it doesn't exist
+        permissionsToAdd.forEach((permission) => {
+            const existingPermission = config.modResults.manifest['uses-permission']?.find((p) => p.$?.['android:name'] === permission);
+            if (!existingPermission) {
+                addPermission(config.modResults, permission);
+            }
+        });
+        // Get the main application node
+        const mainApplication = config.modResults.manifest.application?.[0];
+        if (mainApplication) {
+            debugLog('📱 Configuring Android application components...');
+            // Add RecordingActionReceiver
+            if (!mainApplication.receiver) {
+                mainApplication.receiver = [];
+            }
+            const receiverConfig = {
+                $: {
+                    'android:name': '.RecordingActionReceiver',
+                    'android:exported': 'false',
+                },
+                'intent-filter': [
+                    {
+                        action: [
+                            { $: { 'android:name': 'PAUSE_RECORDING' } },
+                            { $: { 'android:name': 'RESUME_RECORDING' } },
+                            { $: { 'android:name': 'STOP_RECORDING' } },
+                        ],
+                    },
+                ],
+            };
+            const receiverIndex = mainApplication.receiver.findIndex((receiver) => receiver.$?.['android:name'] === '.RecordingActionReceiver');
+            if (receiverIndex >= 0) {
+                mainApplication.receiver[receiverIndex] = receiverConfig;
+            }
+            else {
+                mainApplication.receiver.push(receiverConfig);
+            }
+            debugLog('✅ RecordingActionReceiver configured');
+            // Add AudioRecordingService
+            if (!mainApplication.service) {
+                mainApplication.service = [];
+            }
+            const serviceConfig = {
+                $: {
+                    'android:name': '.AudioRecordingService',
+                    'android:enabled': 'true',
+                    'android:exported': 'false',
+                    'android:foregroundServiceType': 'microphone',
+                },
+            };
+            const serviceIndex = mainApplication.service.findIndex((service) => service.$?.['android:name'] === '.AudioRecordingService');
+            if (serviceIndex >= 0) {
+                mainApplication.service[serviceIndex] = serviceConfig;
+            }
+            else {
+                mainApplication.service.push(serviceConfig);
+            }
+            debugLog('✅ AudioRecordingService configured');
+        }
+        else {
+            console.error(`${LOG_PREFIX} ❌ Main application node not found in Android Manifest`);
+        }
+        return config;
+    });
+    debugLog('✨ Recording Permissions Plugin configuration completed');
+    return config;
+};
+exports.default = withRecordingPermission;

package/plugin/src/index.ts

@@ -0,0 +1,279 @@
+import {
+    ConfigPlugin,
+    withAndroidManifest,
+    withInfoPlist,
+    AndroidConfig,
+} from '@expo/config-plugins'
+import { ExpoConfig } from '@expo/config-types'
+
+const MICROPHONE_USAGE = 'Allow $(PRODUCT_NAME) to access your microphone'
+const NOTIFICATION_USAGE = 'Show recording notifications and controls'
+const LOG_PREFIX = '[@siteed/expo-audio-studio]'
+
+function debugLog(message: string, ...args: unknown[]): void {
+    if (process.env.EXPO_DEBUG) {
+        console.log(`${LOG_PREFIX} ${message}`, ...args)
+    }
+}
+
+interface AudioStreamPluginOptions {
+    enablePhoneStateHandling?: boolean // Controls READ_PHONE_STATE permission
+    enableNotifications?: boolean
+    enableBackgroundAudio?: boolean
+    iosBackgroundModes?: {
+        useVoIP?: boolean
+        useAudio?: boolean
+        useProcessing?: boolean
+        useLocation?: boolean
+        useExternalAccessory?: boolean
+    }
+    iosConfig?: {
+        allowBackgroundAudioControls?: boolean
+        backgroundProcessingTitle?: string
+        microphoneUsageDescription?: string
+        notificationUsageDescription?: string
+    }
+}
+
+const withRecordingPermission: ConfigPlugin<AudioStreamPluginOptions> = (
+    config: ExpoConfig,
+    props: AudioStreamPluginOptions | void
+) => {
+    const options: AudioStreamPluginOptions = {
+        enablePhoneStateHandling: true, // Default to true for backward compatibility
+        enableNotifications: true,
+        enableBackgroundAudio: true,
+        iosBackgroundModes: {
+            useVoIP: false,
+            useAudio: false,
+            useProcessing: false,
+            useLocation: false,
+            useExternalAccessory: false,
+        },
+        iosConfig: {
+            microphoneUsageDescription: MICROPHONE_USAGE,
+            notificationUsageDescription: NOTIFICATION_USAGE,
+        },
+        ...(props || {}),
+    }
+
+    const {
+        enablePhoneStateHandling,
+        enableNotifications,
+        enableBackgroundAudio,
+    } = options
+
+    debugLog('📱 Configuring Recording Permissions Plugin...', options)
+
+    // iOS Configuration
+    config = withInfoPlist(config as any, (config) => {
+        // Always set the microphone usage description from options first
+        config.modResults['NSMicrophoneUsageDescription'] =
+            options.iosConfig?.microphoneUsageDescription ||
+            config.modResults['NSMicrophoneUsageDescription'] ||
+            MICROPHONE_USAGE
+
+        if (enableNotifications) {
+            config.modResults['NSUserNotificationsUsageDescription'] =
+                options.iosConfig?.notificationUsageDescription ||
+                config.modResults['NSUserNotificationsUsageDescription'] ||
+                NOTIFICATION_USAGE
+            config.modResults['NSUserNotificationAlertStyle'] = 'alert'
+        }
+
+        const existingBackgroundModes =
+            config.modResults.UIBackgroundModes || []
+
+        // Only add background modes if explicitly enabled and set to true
+        if (
+            options.iosBackgroundModes?.useAudio === true &&
+            enableBackgroundAudio === true &&
+            !existingBackgroundModes.includes('audio')
+        ) {
+            // Don't automatically add 'audio' background mode as it's only for playback
+            // existingBackgroundModes.push('audio')
+
+            // Instead, ensure processing mode is used for background recording
+            if (options.iosBackgroundModes?.useProcessing !== true) {
+                console.warn(
+                    `${LOG_PREFIX} Warning: Background audio recording requires 'processing' background mode. Please enable 'useProcessing' in iosBackgroundModes.`
+                )
+            }
+        }
+
+        if (
+            options.iosBackgroundModes?.useVoIP === true &&
+            enablePhoneStateHandling === true
+        ) {
+            if (!existingBackgroundModes.includes('voip')) {
+                existingBackgroundModes.push('voip')
+            }
+            const existingCapabilities = (config.modResults
+                .UIRequiredDeviceCapabilities || []) as string[]
+            if (!existingCapabilities.includes('telephony')) {
+                existingCapabilities.push('telephony')
+            }
+            config.modResults.UIRequiredDeviceCapabilities =
+                existingCapabilities
+        }
+
+        // Add additional background modes only if explicitly set to true
+        if (options.iosBackgroundModes?.useProcessing === true) {
+            if (!existingBackgroundModes.includes('processing')) {
+                existingBackgroundModes.push('processing')
+            }
+            // Add processing info if enabled
+            // Note: We keep the 'audiostream' namespace for native modules to maintain compatibility
+            config.modResults.BGTaskSchedulerPermittedIdentifiers = [
+                'com.siteed.audiostream.processing',
+            ]
+        }
+
+        if (options.iosBackgroundModes?.useLocation === true) {
+            if (!existingBackgroundModes.includes('location')) {
+                existingBackgroundModes.push('location')
+            }
+        }
+
+        if (options.iosBackgroundModes?.useExternalAccessory === true) {
+            if (!existingBackgroundModes.includes('external-accessory')) {
+                existingBackgroundModes.push('external-accessory')
+            }
+        }
+
+        // Configure background processing info if enabled
+        if (options.iosConfig?.backgroundProcessingTitle) {
+            config.modResults.BGProcessingTaskTitle =
+                options.iosConfig.backgroundProcessingTitle
+        }
+
+        // Configure audio session behavior
+        if (options.iosConfig?.allowBackgroundAudioControls) {
+            config.modResults.UIBackgroundModes = [
+                ...existingBackgroundModes,
+                'remote-notification',
+            ]
+            config.modResults.MPNowPlayingInfoPropertyPlaybackRate = true
+        }
+
+        config.modResults.UIBackgroundModes = existingBackgroundModes
+        return config
+    })
+
+    // Android Configuration
+    config = withAndroidManifest(config as any, (config) => {
+        const basePermissions = [
+            'android.permission.RECORD_AUDIO',
+            'android.permission.WAKE_LOCK',
+        ]
+
+        const optionalPermissions = [
+            enableNotifications && 'android.permission.POST_NOTIFICATIONS',
+            enablePhoneStateHandling && 'android.permission.READ_PHONE_STATE',
+            enableBackgroundAudio && 'android.permission.FOREGROUND_SERVICE',
+            enableBackgroundAudio &&
+                'android.permission.FOREGROUND_SERVICE_MICROPHONE',
+        ].filter(Boolean) as string[]
+
+        const permissionsToAdd = [...basePermissions, ...optionalPermissions]
+
+        debugLog(
+            '📋 Existing Android permissions:',
+            config.modResults.manifest['uses-permission']?.map(
+                (p) => p.$?.['android:name']
+            ) || []
+        )
+
+        debugLog('➕ Adding Android permissions:', permissionsToAdd)
+
+        const { addPermission } = AndroidConfig.Permissions
+
+        // Add each permission only if it doesn't exist
+        permissionsToAdd.forEach((permission) => {
+            const existingPermission = config.modResults.manifest[
+                'uses-permission'
+            ]?.find((p) => p.$?.['android:name'] === permission)
+            if (!existingPermission) {
+                addPermission(config.modResults, permission)
+            }
+        })
+
+        // Get the main application node
+        const mainApplication = config.modResults.manifest.application?.[0]
+        if (mainApplication) {
+            debugLog('📱 Configuring Android application components...')
+
+            // Add RecordingActionReceiver
+            if (!mainApplication.receiver) {
+                mainApplication.receiver = []
+            }
+
+            const receiverConfig = {
+                $: {
+                    'android:name': '.RecordingActionReceiver',
+                    'android:exported': 'false' as const,
+                },
+                'intent-filter': [
+                    {
+                        action: [
+                            { $: { 'android:name': 'PAUSE_RECORDING' } },
+                            { $: { 'android:name': 'RESUME_RECORDING' } },
+                            { $: { 'android:name': 'STOP_RECORDING' } },
+                        ],
+                    },
+                ],
+            }
+
+            const receiverIndex = mainApplication.receiver.findIndex(
+                (receiver: any) =>
+                    receiver.$?.['android:name'] === '.RecordingActionReceiver'
+            )
+
+            if (receiverIndex >= 0) {
+                mainApplication.receiver[receiverIndex] = receiverConfig
+            } else {
+                mainApplication.receiver.push(receiverConfig)
+            }
+
+            debugLog('✅ RecordingActionReceiver configured')
+
+            // Add AudioRecordingService
+            if (!mainApplication.service) {
+                mainApplication.service = []
+            }
+
+            const serviceConfig = {
+                $: {
+                    'android:name': '.AudioRecordingService',
+                    'android:enabled': 'true' as const,
+                    'android:exported': 'false' as const,
+                    'android:foregroundServiceType': 'microphone',
+                },
+            }
+
+            const serviceIndex = mainApplication.service.findIndex(
+                (service: any) =>
+                    service.$?.['android:name'] === '.AudioRecordingService'
+            )
+
+            if (serviceIndex >= 0) {
+                mainApplication.service[serviceIndex] = serviceConfig
+            } else {
+                mainApplication.service.push(serviceConfig)
+            }
+
+            debugLog('✅ AudioRecordingService configured')
+        } else {
+            console.error(
+                `${LOG_PREFIX} ❌ Main application node not found in Android Manifest`
+            )
+        }
+
+        return config
+    })
+
+    debugLog('✨ Recording Permissions Plugin configuration completed')
+    return config as any
+}
+
+export default withRecordingPermission

package/plugin/tsconfig.json

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

package/plugin/tsconfig.tsbuildinfo

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