react-native-nitro-screen-recorder/lib/module/expo-plugin/support/validatePluginProps.ts

A library to capture screen recordings with react-native powered by NitroModules.

import type { ConfigProps } from '../@types';

const PLUGIN_NAME = 'Nitro Screen Recorder Expo Plugin';

const VALID_PLUGIN_PROP_NAMES: string[] = [
  'enableCameraPermission',
  'cameraPermissionText',
  'enableMicrophonePermission',
  'microphonePermissionText',
  'showPluginLogs',
  'iosBroadcastExtensionTargetName',
  'iosAppGroupIdentifier',
  'iosExtensionBundleIdentifier',
];

/**
 * Validate a single props object. Throws on invalid types or unknown properties.
 */
export function validatePluginProps(props: ConfigProps): void {
  if (props == null || typeof props !== 'object') {
    throw new Error(
      `${PLUGIN_NAME}: expected props to be an object, got ${typeof props}`
    );
  }

  if (
    props.enableCameraPermission !== undefined &&
    typeof props.enableCameraPermission !== 'boolean'
  ) {
    throw new Error(
      `${PLUGIN_NAME}: 'enableCameraPermission' must be a boolean.`
    );
  }

  if (
    props.cameraPermissionText !== undefined &&
    typeof props.cameraPermissionText !== 'string'
  ) {
    throw new Error(`${PLUGIN_NAME}: 'cameraPermissionText' must be a string.`);
  }

  if (
    props.enableMicrophonePermission !== undefined &&
    typeof props.enableMicrophonePermission !== 'boolean'
  ) {
    throw new Error(
      `${PLUGIN_NAME}: 'enableMicrophonePermission' must be a boolean.`
    );
  }

  if (
    props.microphonePermissionText !== undefined &&
    typeof props.microphonePermissionText !== 'string'
  ) {
    throw new Error(
      `${PLUGIN_NAME}: 'microphonePermissionText' must be a string.`
    );
  }

  if (
    props.showPluginLogs !== undefined &&
    typeof props.showPluginLogs !== 'boolean'
  ) {
    throw new Error(`${PLUGIN_NAME}: 'showPluginLogs' must be a boolean.`);
  }

  if (
    props.iosBroadcastExtensionTargetName !== undefined &&
    props.iosBroadcastExtensionTargetName.includes(' ')
  ) {
    throw new Error(
      `${PLUGIN_NAME}: 'iosBroadcastExtensionTargetName' cannot have spaces.`
    );
  }

  if (
    props.iosAppGroupIdentifier !== undefined &&
    !props.iosAppGroupIdentifier.startsWith('group')
  ) {
    throw new Error(
      `${PLUGIN_NAME}: 'iosAppGroupIdentifier' must start with group! Try changing to "group.(insert main app bundle id) or removing this line and letting the plugin manage the app group name for you.`
    );
  }

  const invalidKeys = Object.keys(props).filter(
    (k) => !VALID_PLUGIN_PROP_NAMES.includes(k)
  );
  if (invalidKeys.length > 0) {
    throw new Error(
      `${PLUGIN_NAME}: invalid propert${
        invalidKeys.length === 1 ? 'y' : 'ies'
      } ${invalidKeys.map((p) => `"${p}"`).join(', ')} provided.`
    );
  }
}