@fishjam-cloud/react-native-client 0.23.0 → 0.25.0-rc.1

package/plugin/build/withFishjamIos.js

@@ -33,23 +33,21 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSbePodfileSnippet = getSbePodfileSnippet;
-// ios-related code was mostly copied from OneSignal expo plugin: https://github.com/OneSignal/onesignal-expo-plugin/blob/main/onesignal/withOneSignalIos.ts
+exports.withFishjamIos = void 0;
 const config_plugins_1 = require("@expo/config-plugins");
-const fs = __importStar(require("promise-fs"));
 const path = __importStar(require("path"));
+const fs = __importStar(require("promise-fs"));
 function getSbeTargetName(props) {
-    return (props?.ios?.broadcastExtensionTargetName ||
-        'FishjamScreenBroadcastExtension');
+    return props?.ios?.broadcastExtensionTargetName || 'ScreenBroadcastExtension';
 }
-function getSbePodfileSnippet(props) {
-    const targetName = getSbeTargetName(props);
-    return `\ntarget '${targetName}' do\n  pod 'FishjamCloudClient/Broadcast'\nend`;
+function getSbeDisplayName(props) {
+    return props?.ios?.broadcastExtensionDisplayName || 'ScreenBroadcast';
 }
 const TARGETED_DEVICE_FAMILY = `"1,2"`;
 const IPHONEOS_DEPLOYMENT_TARGET = '15.1';
 const GROUP_IDENTIFIER_TEMPLATE_REGEX = /{{GROUP_IDENTIFIER}}/gm;
 const BUNDLE_IDENTIFIER_TEMPLATE_REGEX = /{{BUNDLE_IDENTIFIER}}/gm;
+const DISPLAY_NAME_TEMPLATE_REGEX = /{{DISPLAY_NAME}}/gm;
 /**
  * A helper function for updating a value in a file for given regex
  */
@@ -60,36 +58,9 @@ async function updateFileWithRegex(iosPath, fileName, regex, value, props) {
     file = file.replace(regex, value);
     await fs.writeFile(filePath, file);
 }
-/**
- * Inserts a required target to Podfile.
- * This is needed to provide the dependency of FishjamCloudClient/Broadcast to the extension.
- */
-async function updatePodfile(iosPath, props) {
-    const podfileSnippet = getSbePodfileSnippet(props);
-    let matches;
-    try {
-        const podfile = await fs.readFile(`${iosPath}/Podfile`, {
-            encoding: 'utf-8',
-        });
-        matches = podfile.match(podfileSnippet);
-    }
-    catch (e) {
-        console.error('Error reading from Podfile: ', e);
-    }
-    if (matches) {
-        console.log(`${getSbeTargetName(props)} target already added to Podfile. Skipping...`);
-        return;
-    }
-    try {
-        fs.appendFile(`${iosPath}/Podfile`, podfileSnippet);
-    }
-    catch (e) {
-        console.error('Error writing to Podfile: ', e);
-    }
-}
 /**
  * Adds "App Group" permission
- * App Group allow your app and the FishjamScreenBroadcastExtension to communicate with each other.
+ * App Group allows your app and the ScreenBroadcastExtension to communicate with each other.
  */
 const withAppGroupPermissions = (config, props) => {
     const APP_GROUP_KEY = 'com.apple.security.application-groups';
@@ -111,6 +82,7 @@ const withAppGroupPermissions = (config, props) => {
         newConfig.modResults[APP_GROUP_KEY] = modResultsArray;
         return newConfig;
     });
+    // eslint-disable-next-line no-shadow
     config = (0, config_plugins_1.withXcodeProject)(config, (props) => {
         const xcodeProject = props.modResults;
         const targets = xcodeProject.getFirstTarget();
@@ -124,8 +96,7 @@ const withAppGroupPermissions = (config, props) => {
         projectObj.attributes ??= {};
         projectObj.attributes.TargetAttributes ??= {};
         projectObj.attributes.TargetAttributes[targetUuid] ??= {};
-        projectObj.attributes.TargetAttributes[targetUuid].SystemCapabilities ??=
-            {};
+        projectObj.attributes.TargetAttributes[targetUuid].SystemCapabilities ??= {};
         projectObj.attributes.TargetAttributes[targetUuid].SystemCapabilities['com.apple.ApplicationGroups.iOS'] = {
             enabled: 1,
         };
@@ -133,6 +104,7 @@ const withAppGroupPermissions = (config, props) => {
         const entitlementsFilePath = `${mainTargetName}/${mainTargetName}.entitlements`;
         const configurations = xcodeProject.pbxXCBuildConfigurationSection();
         Object.keys(configurations).forEach((key) => {
+            // eslint-disable-next-line no-shadow
             const config = configurations[key];
             if (config.buildSettings?.PRODUCT_NAME?.includes(mainTargetName)) {
                 if (!config.buildSettings.CODE_SIGN_ENTITLEMENTS) {
@@ -146,14 +118,13 @@ const withAppGroupPermissions = (config, props) => {
 };
 /**
  * Adds constants to Info.plist
- * In other to dynamically retreive extension's bundleId and group name we need to store it in Info.plist.
+ * In order to dynamically retrieve extension's bundleId and group name we need to store it in Info.plist.
  */
 const withInfoPlistConstants = (config, props) => (0, config_plugins_1.withInfoPlist)(config, (configuration) => {
     const bundleIdentifier = configuration.ios?.bundleIdentifier || '';
     const groupIdentifier = props?.ios?.appGroupContainerId || `group.${bundleIdentifier}`;
-    configuration.modResults['AppGroupName'] = groupIdentifier;
-    configuration.modResults['ScreenShareExtensionBundleId'] =
-        `${bundleIdentifier}.${getSbeTargetName(props)}`;
+    configuration.modResults['RTCScreenSharingExtension'] = `${bundleIdentifier}.${getSbeTargetName(props)}`;
+    configuration.modResults['RTCAppGroupIdentifier'] = groupIdentifier;
     return configuration;
 });
 /**
@@ -169,18 +140,25 @@ const withFishjamSBE = (config, options) => (0, config_plugins_1.withXcodeProjec
     const targetName = getSbeTargetName(options);
     const pluginDir = require.resolve('@fishjam-cloud/react-native-client/package.json');
     const extensionSourceDir = path.join(pluginDir, '../plugin/broadcastExtensionFiles/');
-    await updatePodfile(iosPath, options);
     const projPath = `${iosPath}/${appName}.xcodeproj/project.pbxproj`;
-    const templateTargetName = 'FishjamScreenBroadcastExtension';
+    const templateTargetName = 'ScreenBroadcastExtension';
     const extFiles = [
-        'FishjamBroadcastSampleHandler.swift',
+        'SampleHandler.swift',
+        'SampleUploader.swift',
         `${templateTargetName}.entitlements`,
         `Info.plist`,
+        'SocketConnection.swift',
+        'DarwinNotificationCenter.swift',
+        'Atomic.swift',
     ];
     const destFiles = [
-        'FishjamBroadcastSampleHandler.swift',
+        'SampleHandler.swift',
+        'SampleUploader.swift',
         `${targetName}.entitlements`,
         `Info.plist`,
+        'SocketConnection.swift',
+        'DarwinNotificationCenter.swift',
+        'Atomic.swift',
     ];
     await xcodeProject.parse(async function (err) {
         if (err) {
@@ -188,6 +166,7 @@ const withFishjamSBE = (config, options) => (0, config_plugins_1.withXcodeProjec
             return;
         }
         if (xcodeProject.pbxTargetByName(targetName)) {
+            // eslint-disable-next-line no-console
             console.log(`${targetName} already exists in project. Skipping...`);
             return;
         }
@@ -201,10 +180,17 @@ const withFishjamSBE = (config, options) => (0, config_plugins_1.withXcodeProjec
         }
         catch (e) {
             console.error('Error copying extension files: ', e);
+            throw e;
+        }
+        try {
+            await updateFileWithRegex(iosPath, `${targetName}.entitlements`, GROUP_IDENTIFIER_TEMPLATE_REGEX, groupIdentifier, options);
+            await updateFileWithRegex(iosPath, 'SampleHandler.swift', GROUP_IDENTIFIER_TEMPLATE_REGEX, groupIdentifier, options);
+            await updateFileWithRegex(iosPath, 'SampleUploader.swift', BUNDLE_IDENTIFIER_TEMPLATE_REGEX, bundleIdentifier || '', options);
+            await updateFileWithRegex(iosPath, 'Info.plist', DISPLAY_NAME_TEMPLATE_REGEX, getSbeDisplayName(options), options);
+        }
+        catch (e) {
+            console.error('Error updating extension files: ', e);
         }
-        await updateFileWithRegex(iosPath, `${targetName}.entitlements`, GROUP_IDENTIFIER_TEMPLATE_REGEX, groupIdentifier, options);
-        await updateFileWithRegex(iosPath, 'FishjamBroadcastSampleHandler.swift', GROUP_IDENTIFIER_TEMPLATE_REGEX, groupIdentifier, options);
-        await updateFileWithRegex(iosPath, 'FishjamBroadcastSampleHandler.swift', BUNDLE_IDENTIFIER_TEMPLATE_REGEX, bundleIdentifier || '', options);
         // Create new PBXGroup for the extension
         const extGroup = xcodeProject.addPbxGroup(extFiles, targetName, targetName);
         // Add the new PBXGroup to the top level group. This makes the
@@ -220,15 +206,19 @@ const withFishjamSBE = (config, options) => (0, config_plugins_1.withXcodeProjec
         // An upstream fix should be made to the code referenced in this link:
         //   - https://github.com/apache/cordova-node-xcode/blob/8b98cabc5978359db88dc9ff2d4c015cba40f150/lib/pbxProject.js#L860
         const projObjects = xcodeProject.hash.project.objects;
-        projObjects['PBXTargetDependency'] =
-            projObjects['PBXTargetDependency'] || {};
-        projObjects['PBXContainerItemProxy'] =
-            projObjects['PBXTargetDependency'] || {};
+        projObjects['PBXTargetDependency'] = projObjects['PBXTargetDependency'] || {};
+        projObjects['PBXContainerItemProxy'] = projObjects['PBXContainerItemProxy'] || {};
         // Add the SBE target
         // This adds PBXTargetDependency and PBXContainerItemProxy for you
         const sbeTarget = xcodeProject.addTarget(targetName, 'app_extension', targetName, `${bundleIdentifier}.${targetName}`);
         // Add build phases to the new target
-        xcodeProject.addBuildPhase(['FishjamBroadcastSampleHandler.swift'], 'PBXSourcesBuildPhase', 'Sources', sbeTarget.uuid);
+        xcodeProject.addBuildPhase([
+            'SampleHandler.swift',
+            'SampleUploader.swift',
+            'SocketConnection.swift',
+            'DarwinNotificationCenter.swift',
+            'Atomic.swift',
+        ], 'PBXSourcesBuildPhase', 'Sources', sbeTarget.uuid);
         xcodeProject.addBuildPhase([], 'PBXResourcesBuildPhase', 'Resources', sbeTarget.uuid);
         xcodeProject.addBuildPhase([], 'PBXFrameworksBuildPhase', 'Frameworks', sbeTarget.uuid);
         xcodeProject.addFramework('ReplayKit.framework', {
@@ -257,14 +247,6 @@ const withFishjamSBE = (config, options) => (0, config_plugins_1.withXcodeProjec
     });
     return props;
 });
-const withFishjamPictureInPicture = (config, props) => (0, config_plugins_1.withInfoPlist)(config, (configuration) => {
-    if (props?.ios?.supportsPictureInPicture) {
-        const backgroundModes = new Set(configuration.modResults.UIBackgroundModes ?? []);
-        backgroundModes.add('audio');
-        configuration.modResults.UIBackgroundModes = Array.from(backgroundModes);
-    }
-    return configuration;
-});
 /**
  * Adds iOS VoIP background mode to keep the app running during calls
  */
@@ -276,10 +258,14 @@ const withFishjamVoIPBackgroundMode = (config, props) => (0, config_plugins_1.wi
     }
     return configuration;
 });
-/**
- * Applies screen sharing plugin if enabled. In order for screensharing to work, we need to copy extension files to your iOS project.
- * Allows for dynamically changing deploymentTarget.
- */
+const withFishjamPictureInPicture = (config, props) => (0, config_plugins_1.withInfoPlist)(config, (configuration) => {
+    if (props?.ios?.supportsPictureInPicture) {
+        const backgroundModes = new Set(configuration.modResults.UIBackgroundModes ?? []);
+        backgroundModes.add('audio');
+        configuration.modResults.UIBackgroundModes = Array.from(backgroundModes);
+    }
+    return configuration;
+});
 const withFishjamIos = (config, props) => {
     if (props?.ios?.enableScreensharing) {
         config = withAppGroupPermissions(config, props);
@@ -287,12 +273,11 @@ const withFishjamIos = (config, props) => {
         config = withFishjamSBE(config, props);
     }
     config = (0, config_plugins_1.withPodfileProperties)(config, (configuration) => {
-        configuration.modResults['ios.deploymentTarget'] =
-            props?.ios?.iphoneDeploymentTarget ?? IPHONEOS_DEPLOYMENT_TARGET;
+        configuration.modResults['ios.deploymentTarget'] = props?.ios?.iphoneDeploymentTarget ?? IPHONEOS_DEPLOYMENT_TARGET;
         return configuration;
     });
     config = withFishjamPictureInPicture(config, props);
     config = withFishjamVoIPBackgroundMode(config, props);
     return config;
 };
-exports.default = withFishjamIos;
+exports.withFishjamIos = withFishjamIos;

package/plugin/src/types.ts

@@ -0,0 +1,19 @@
+export type FishjamPluginOptions =
+  | {
+      android?: {
+        enableForegroundService?: boolean;
+        enableScreensharing?: boolean;
+        supportsPictureInPicture?: boolean;
+      };
+      ios?: {
+        enableScreensharing?: boolean;
+        supportsPictureInPicture?: boolean;
+        broadcastExtensionTargetName?: string;
+        broadcastExtensionDisplayName?: string;
+        appGroupContainerId?: string;
+        mainTargetName?: string;
+        iphoneDeploymentTarget?: string;
+        enableVoIPBackgroundMode?: boolean;
+      };
+    }
+  | undefined;

package/plugin/src/withFishjam.ts

@@ -0,0 +1,42 @@
+import type { ConfigPlugin } from '@expo/config-plugins';
+
+import type { FishjamPluginOptions } from './types';
+import { withFishjamAndroid } from './withFishjamAndroid';
+import { withFishjamIos } from './withFishjamIos';
+
+/**
+ * Main Fishjam Expo config plugin.
+ *
+ * This plugin configures both iOS and Android platforms for Picture-in-Picture support.
+ *
+ * ## Usage
+ *
+ * ```json
+ * {
+ *   "plugins": [
+ *     [
+ *       "@fishjam-cloud/react-native-client",
+ *       {
+ *         "android": {
+ *           "supportsPictureInPicture": true
+ *         },
+ *         "ios": {
+ *           "supportsPictureInPicture": true
+ *         }
+ *       }
+ *     ]
+ *   ]
+ * }
+ * ```
+ *
+ * @param config - Expo config object
+ * @param options - Plugin configuration options
+ * @returns Modified config object
+ */
+const withFishjam: ConfigPlugin<FishjamPluginOptions> = (config, options) => {
+  config = withFishjamAndroid(config, options);
+  config = withFishjamIos(config, options);
+  return config;
+};
+
+export default withFishjam;

package/plugin/src/withFishjamAndroid.ts

@@ -0,0 +1,112 @@
+import type { ConfigPlugin } from '@expo/config-plugins';
+import { AndroidConfig, withAndroidManifest } from '@expo/config-plugins';
+import { getMainApplicationOrThrow } from '@expo/config-plugins/build/android/Manifest';
+
+import type { FishjamPluginOptions } from './types';
+
+const withFishjamPictureInPicture: ConfigPlugin<FishjamPluginOptions> = (config, props) =>
+  withAndroidManifest(config, (configuration) => {
+    const activity = AndroidConfig.Manifest.getMainActivityOrThrow(configuration.modResults);
+
+    if (props?.android?.supportsPictureInPicture) {
+      activity.$['android:supportsPictureInPicture'] = 'true';
+    } else {
+      delete activity.$['android:supportsPictureInPicture'];
+    }
+    return configuration;
+  });
+
+const withFishjamForegroundService: ConfigPlugin<FishjamPluginOptions> = (config, props) =>
+  withAndroidManifest(config, async (configuration) => {
+    if (!props?.android?.enableForegroundService) {
+      return configuration;
+    }
+
+    const mainApplication = getMainApplicationOrThrow(configuration.modResults);
+    mainApplication.service = mainApplication.service || [];
+
+    const webRTCForegroundService = {
+      $: {
+        'android:name': 'com.oney.WebRTCModule.foregroundService.WebRTCForegroundService',
+        'android:foregroundServiceType': 'camera|microphone',
+        'android:stopWithTask': 'true',
+      },
+    };
+
+    const existingWebRTCForegroundServiceIndex = mainApplication.service.findIndex(
+      (service) => service.$['android:name'] === webRTCForegroundService.$['android:name'],
+    );
+
+    if (existingWebRTCForegroundServiceIndex !== -1) {
+      mainApplication.service[existingWebRTCForegroundServiceIndex] = webRTCForegroundService;
+    } else {
+      mainApplication.service.push(webRTCForegroundService);
+    }
+
+    if (props?.android?.enableScreensharing) {
+      const mediaProjectionService = {
+        $: {
+          'android:name': 'com.oney.WebRTCModule.MediaProjectionService',
+          'android:foregroundServiceType': 'mediaProjection',
+          'android:stopWithTask': 'true',
+        },
+      };
+
+      const existingMediaProjectionServiceIndex = mainApplication.service.findIndex(
+        (service) => service.$['android:name'] === mediaProjectionService.$['android:name'],
+      );
+
+      if (existingMediaProjectionServiceIndex !== -1) {
+        mainApplication.service[existingMediaProjectionServiceIndex] = mediaProjectionService;
+      } else {
+        mainApplication.service.push(mediaProjectionService);
+      }
+    }
+    return configuration;
+  });
+
+const withFishjamForegroundServicePermission: ConfigPlugin<FishjamPluginOptions> = (config, props) =>
+  withAndroidManifest(config, (configuration) => {
+    if (!props?.android?.enableForegroundService) {
+      return configuration;
+    }
+
+    const mainApplication = configuration.modResults;
+    if (!mainApplication.manifest) {
+      return configuration;
+    }
+
+    if (!mainApplication.manifest['uses-permission']) {
+      mainApplication.manifest['uses-permission'] = [];
+    }
+
+    const permissions = mainApplication.manifest['uses-permission'];
+
+    const foregroundServicePermissions = [
+      'android.permission.FOREGROUND_SERVICE',
+      'android.permission.FOREGROUND_SERVICE_CAMERA',
+      'android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION',
+      'android.permission.FOREGROUND_SERVICE_MICROPHONE',
+    ];
+
+    foregroundServicePermissions.forEach((permissionName) => {
+      const hasPermission = permissions.some((perm) => perm.$?.['android:name'] === permissionName);
+
+      if (!hasPermission) {
+        permissions.push({
+          $: {
+            'android:name': permissionName,
+          },
+        });
+      }
+    });
+
+    return configuration;
+  });
+
+export const withFishjamAndroid: ConfigPlugin<FishjamPluginOptions> = (config, props) => {
+  config = withFishjamForegroundServicePermission(config, props);
+  config = withFishjamForegroundService(config, props);
+  config = withFishjamPictureInPicture(config, props);
+  return config;
+};