@kaleyra/video-react-native-module 1.0.0

package/lib/module/native-bridge/TypeScript/types/VoipHandlingStrategy.js

@@ -0,0 +1,16 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+/**
+ * This class defines the voip notification strategy per call.
+ */
+export var VoipHandlingStrategy;
+(function (VoipHandlingStrategy) {
+    /**
+     * The voip notifications will not be handled
+     */
+    VoipHandlingStrategy["DISABLED"] = "disabled";
+    /**
+     * The voip notifications will be handled automatically from the plugin
+     */
+    VoipHandlingStrategy["AUTOMATIC"] = "automatic";
+})(VoipHandlingStrategy || (VoipHandlingStrategy = {}));

package/lib/module/src/KaleyraVideo.js

@@ -0,0 +1,249 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+import { NativeModules, Platform } from 'react-native';
+import { UserDetailsFormatValidator } from '../native-bridge/TypeScript/UserDetailsFormatValidator';
+import { CallType } from '../native-bridge/TypeScript/types/CallType';
+import { IllegalArgumentError } from '../native-bridge/TypeScript/errors/IllegalArgumentError';
+import { Environments } from '../native-bridge/TypeScript/Environments';
+import { CallDisplayMode } from '../native-bridge/TypeScript/types/CallDisplayMode';
+import { Regions } from '../native-bridge/TypeScript/Regions';
+import { RecordingType } from '../native-bridge/TypeScript/types/RecordingType';
+import { AudioCallType } from '../native-bridge/TypeScript/types/AudioCallType';
+import { VoipHandlingStrategy } from '../native-bridge/TypeScript/types/VoipHandlingStrategy';
+import { AccessTokenResponse } from '../native-bridge/TypeScript/types/AccessTokenResponse';
+import { Events as HybridEvents } from '../native-bridge/TypeScript/Events';
+import { ReactNativeEventEmitter } from './ReactNativeEventEmitter';
+const LINKING_ERROR = `The package 'video-react-native-module' doesn't seem to be linked. Make sure: \n\n` +
+    Platform.select({ ios: '- You have run \'pod install\'\n', default: '' }) +
+    '- You rebuilt the app after installing the package\n' +
+    '- You are not using Expo Go\n';
+const VideoNativeModuleBridge = NativeModules.VideoNativeModule
+    ? NativeModules.VideoNativeModule
+    : new Proxy({}, {
+        get() {
+            throw new Error(LINKING_ERROR);
+        },
+    });
+const VideoNativeEmitter = NativeModules.VideoNativeEmitter
+    ? NativeModules.VideoNativeEmitter
+    : new Proxy({}, {
+        get() {
+            throw new Error(LINKING_ERROR);
+        },
+    });
+/**
+ * KaleyraVideo
+ */
+class KaleyraVideo {
+    /**
+     * <b>To create an instance of the Kaleyra Video invoke the [[configure]] method</b>
+     */
+    static instance;
+    eventEmitter;
+    events;
+    constructor(eventEmitter) {
+        this.eventEmitter = eventEmitter;
+        this.events = eventEmitter;
+    }
+    /**
+     * Call this method when device is ready to configure the module
+     * @param configuration
+     * @throws IllegalArgumentError
+     */
+    static configure(configuration) {
+        if (configuration.appID === '') {
+            throw new IllegalArgumentError('Expected a not empty appId!');
+        }
+        if (this.instance) {
+            console.warn('KaleyraVideo was already setup.');
+            return this.instance;
+        }
+        VideoNativeModuleBridge.configure(JSON.stringify(configuration));
+        this.instance = new KaleyraVideo(new ReactNativeEventEmitter(VideoNativeEmitter));
+        return this.instance;
+    }
+    /**
+     * @ignore
+     * @private
+     */
+    static _isAndroid() {
+        return Platform.OS === 'android';
+    }
+    /**
+     * @ignore
+     * @private
+     */
+    static _isIOS() {
+        return Platform.OS === 'ios';
+    }
+    /**
+     * Connect the plugin
+     * @param session session to connect with
+     * @throws IllegalArgumentError
+     */
+    connect(session) {
+        if (session.userID === '') {
+            throw new IllegalArgumentError('Expected a not empty userId!');
+        }
+        this.eventEmitter.on(HybridEvents.accessTokenRequest, (data) => {
+            const accessTokenRequest = JSON.parse(data);
+            session.accessTokenProvider(accessTokenRequest.userID).then((token) => {
+                const response = AccessTokenResponse.success(accessTokenRequest.requestID, token);
+                VideoNativeModuleBridge.setAccessTokenResponse(JSON.stringify(response));
+            }, (err) => {
+                const response = AccessTokenResponse.failed(accessTokenRequest.requestID, err);
+                VideoNativeModuleBridge.setAccessTokenResponse(JSON.stringify(response));
+            });
+        });
+        VideoNativeModuleBridge.connect(session.userID);
+    }
+    /**
+     * Stop the plugin
+     */
+    disconnect() {
+        VideoNativeModuleBridge.disconnect();
+        this.eventEmitter.clear();
+    }
+    /**
+     * This method allows you to reset the configuration.
+     */
+    reset() {
+        if (KaleyraVideo._isAndroid()) {
+            VideoNativeModuleBridge.reset();
+        }
+        else {
+            console.warn('Not yet supported on ', Platform.OS, ' platform.');
+        }
+    }
+    /**
+     * Get the current state of the plugin
+     * @return the state as a promise
+     */
+    // state() {
+    //   return new Promise((resolve, reject) => {
+    //     cordova.exec(resolve, reject, 'BandyerPlugin', 'state', []);
+    //   });
+    // }
+    /**
+     * Start Call with the callee defined
+     * @param callOptions
+     * @throws IllegalArgumentError
+     */
+    startCall(callOptions) {
+        if (callOptions.callees.length === 0) {
+            throw new IllegalArgumentError('No userIds were provided!');
+        }
+        if (callOptions.callees.filter((str) => str.trim().length <= 0).length > 0) {
+            throw new IllegalArgumentError('Some empty userIds were provided');
+        }
+        VideoNativeModuleBridge.startCall(JSON.stringify(callOptions));
+    }
+    /**
+     * Verify the user for the current call
+     * @param verify true if the user is verified, false otherwise
+     * @throws IllegalArgumentError
+     */
+    verifyCurrentCall(verify) {
+        if (KaleyraVideo._isAndroid()) {
+            VideoNativeModuleBridge.verifyCurrentCall(verify);
+        }
+        else {
+            console.warn('Not yet supported on ', Platform.OS, ' platform.');
+        }
+    }
+    /**
+     * Set the UI display mode for the current call
+     * @param mode FOREGROUND, FOREGROUND_PICTURE_IN_PICTURE, BACKGROUND
+     * @throws IllegalArgumentError
+     */
+    setDisplayModeForCurrentCall(mode) {
+        if (KaleyraVideo._isAndroid()) {
+            VideoNativeModuleBridge.setDisplayModeForCurrentCall(JSON.stringify(mode));
+        }
+        else {
+            console.warn('Not supported by ', Platform.OS, ' platform.');
+        }
+    }
+    /**
+     * Start Call from url
+     * @param url received
+     * @throws IllegalArgumentError
+     */
+    startCallFrom(url) {
+        if (url === '' || url === 'undefined') {
+            throw new IllegalArgumentError('Invalid url!');
+        }
+        VideoNativeModuleBridge.startCallUrl(JSON.stringify(url));
+    }
+    // noinspection JSMethodCanBeStatic
+    /**
+     * Call this method to provide the details for each user to be used to set up the UI
+     * @param userDetails  array of user details
+     * @throws IllegalArgumentError
+     */
+    addUsersDetails(userDetails) {
+        if (userDetails.length === 0) {
+            throw new IllegalArgumentError('No userDetails were provided!');
+        }
+        VideoNativeModuleBridge.addUsersDetails(JSON.stringify(userDetails));
+    }
+    setUserDetailsFormat(format) {
+        const validator = new UserDetailsFormatValidator();
+        validator.validate(format.default);
+        if (format.androidNotification !== undefined) {
+            validator.validate(format.androidNotification);
+        }
+        VideoNativeModuleBridge.setUserDetailsFormat(JSON.stringify(format));
+    }
+    /**
+     * Call this method to remove all the user details previously provided.
+     */
+    removeUsersDetails() {
+        VideoNativeModuleBridge.removeUsersDetails();
+    }
+    /**
+     * Call this method to handle a notification!
+     *
+     * @param payload notification data payload as String
+     * @throws IllegalArgumentError
+     */
+    handlePushNotificationPayload(payload) {
+        if (payload === '' || payload === 'undefined') {
+            throw new IllegalArgumentError('Expected a not empty payload!');
+        }
+        VideoNativeModuleBridge.handlePushNotificationPayload(JSON.stringify(payload));
+    }
+    /**
+     * Open chat
+     * @param userID user you want to chat with
+     * @throws IllegalArgumentError
+     */
+    startChat(userID) {
+        if (userID === '') {
+            throw new IllegalArgumentError('Expected a not empty userId!');
+        }
+        VideoNativeModuleBridge.startChat(userID);
+    }
+    /**
+     * This method allows you to clear all user cached data, such as chat messages and generic information.
+     */
+    clearUserCache() {
+        if (KaleyraVideo._isAndroid()) {
+            VideoNativeModuleBridge.clearUserCache();
+        }
+        else {
+            console.warn('Not yet supported on ', Platform.OS, ' platform.');
+        }
+    }
+    /**
+     * This method returns the current voip push token
+     * @return promise of voipPushToken or undefined if has not been generated yet.
+     */
+    getCurrentVoIPPushToken() {
+        if (!KaleyraVideo._isIOS()) {
+            return Promise.reject('Token has not been generated yet.');
+        }
+        return VideoNativeModuleBridge.getCurrentVoIPPushToken();
+    }
+}
+export { KaleyraVideo, AudioCallType, RecordingType, VoipHandlingStrategy, CallType, Regions, CallDisplayMode, Environments, };

package/lib/module/src/ReactNativeEventEmitter.js

@@ -0,0 +1,36 @@
+/* eslint-disable @typescript-eslint/no-empty-function,@typescript-eslint/no-unused-vars,@typescript-eslint/no-explicit-any */
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+import { NativeEventEmitter } from 'react-native';
+import { Events as HybridEvents } from '../native-bridge/TypeScript/Events';
+export class ReactNativeEventEmitter extends NativeEventEmitter {
+    constructor(nativeModule) {
+        super(nativeModule);
+        this.on(HybridEvents.setupError, (args) => this.onSetupError(args));
+        this.on(HybridEvents.callError, (args) => this.onCallError(args));
+        this.on(HybridEvents.chatError, (args) => this.onChatError(args));
+        this.on(HybridEvents.iOSVoipPushTokenInvalidated, () => this.oniOSVoipPushTokenInvalidated());
+        this.on(HybridEvents.iOSVoipPushTokenUpdated, (args) => this.oniOSVoipPushTokenUpdated(args));
+        this.on(HybridEvents.callModuleStatusChanged, (args) => {
+            this.onCallModuleStatusChanged(args);
+        });
+        this.on(HybridEvents.chatModuleStatusChanged, (args) => this.onChatModuleStatusChanged(args));
+    }
+    onSetupError = (_) => { };
+    onCallModuleStatusChanged = (_) => { };
+    onCallError = (_) => { };
+    oniOSVoipPushTokenUpdated = (_) => { };
+    onChatError = (_) => { };
+    onChatModuleStatusChanged = (_) => { };
+    oniOSVoipPushTokenInvalidated = () => { };
+    on(event, listener) {
+        if (this.listenerCount(event) > 0)
+            this.removeAllListeners(event);
+        this.addListener(event, listener);
+    }
+    clear() {
+        for (const event in HybridEvents) {
+            this.removeAllListeners(event);
+        }
+    }
+}

package/lib/module/src/events/Events.js

@@ -0,0 +1,3 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+export {};

package/lib/typescript/index.d.ts

@@ -0,0 +1,2 @@
+import { KaleyraVideo, KaleyraVideoConfiguration, CreateCallOptions, Tools, ScreenShareToolConfiguration, ChatToolConfiguration, AudioCallOptions, AudioCallType, CallOptions, RecordingType, IosConfiguration, CallKitConfiguration, VoipHandlingStrategy, CallType, Regions, UserDetails, UserDetailsFormat, CallDisplayMode, Session, Environments, Events } from './src/KaleyraVideo';
+export { KaleyraVideo, KaleyraVideoConfiguration, CreateCallOptions, Tools, ScreenShareToolConfiguration, ChatToolConfiguration, AudioCallOptions, AudioCallType, CallOptions, RecordingType, IosConfiguration, CallKitConfiguration, VoipHandlingStrategy, CallType, Regions, UserDetails, UserDetailsFormat, CallDisplayMode, Session, Environments, Events, };

package/lib/typescript/native-bridge/TypeScript/Environments.d.ts

@@ -0,0 +1,28 @@
+import type { Environment } from './types/Environment';
+/**
+ * Available environments
+ */
+export declare class Environments implements Environment {
+    /**
+     * Sandbox environment
+     */
+    static sandbox(): Environment;
+    /**
+     * Production environment
+     */
+    static production(): Environment;
+    /**
+     * Create environment by name
+     * @param name name of the environment
+     */
+    static new(name: string): Environment;
+    /**
+     * name of the environment
+     * @ignore
+     */
+    name: string;
+    /**
+     * @ignore
+     */
+    private constructor();
+}

package/lib/typescript/native-bridge/TypeScript/Events.d.ts

@@ -0,0 +1,40 @@
+/**
+ * This enum defines all the events that may be handled
+ * <br/>
+ * <br/>
+ * You can listen to these events via [[BandyerPlugin.on]]
+ */
+export declare enum Events {
+    /**
+     * Used for access token retrieval
+     */
+    accessTokenRequest = "accessTokenRequest",
+    /**
+     * Used to notify setup errors
+     */
+    setupError = "setupError",
+    /**
+     * Used to notify call module status changed
+     */
+    callModuleStatusChanged = "callModuleStatusChanged",
+    /**
+     * Used to notify call errors
+     */
+    callError = "callError",
+    /**
+     * Used to notify chat errors
+     */
+    chatError = "chatError",
+    /**
+     * Used to notify chat module status changed
+     */
+    chatModuleStatusChanged = "chatModuleStatusChanged",
+    /**
+     * Used to notify voip push token updates
+     */
+    iOSVoipPushTokenUpdated = "iOSVoipPushTokenUpdated",
+    /**
+     * Used to notify voip push token invalidation
+     */
+    iOSVoipPushTokenInvalidated = "iOSVoipPushTokenInvalidated"
+}

package/lib/typescript/native-bridge/TypeScript/Regions.d.ts

@@ -0,0 +1,32 @@
+import type { Region } from './types/Region';
+/**
+ * Available regions
+ */
+export declare class Regions implements Region {
+    /**
+     * India region
+     */
+    static india(): Region;
+    /**
+     * Europe region
+     */
+    static europe(): Region;
+    /**
+     * Us region
+     */
+    static us(): Region;
+    /**
+     * Create region by name
+     * @param name name of the region
+     */
+    static new(name: string): Region;
+    /**
+     * name of the region
+     * @ignore
+     */
+    name: string;
+    /**
+     * @ignore
+     */
+    private constructor();
+}

package/lib/typescript/native-bridge/TypeScript/UserDetailsFormatValidator.d.ts

@@ -0,0 +1,4 @@
+export declare class UserDetailsFormatValidator {
+    validate(format: string): void;
+    private findKeywords;
+}

package/lib/typescript/native-bridge/TypeScript/errors/IllegalArgumentError.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This error will be thrown when arguments given to a function are not of the expected type
+ */
+export declare class IllegalArgumentError extends Error {
+    name: string;
+}

package/lib/typescript/native-bridge/TypeScript/types/AccessTokenRequest.d.ts

@@ -0,0 +1,4 @@
+export interface AccessTokenRequest {
+    requestID: string;
+    userID: string;
+}

package/lib/typescript/native-bridge/TypeScript/types/AccessTokenResponse.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @ignore
+ */
+export declare class AccessTokenResponse {
+    constructor(requestID: string, success: boolean, data: string, error: string);
+    static failed(requestID: string, reason?: string): AccessTokenResponse;
+    static success(requestID: string, token: string): AccessTokenResponse;
+    requestID: string;
+    success: boolean;
+    data: string;
+    error?: string;
+}

package/lib/typescript/native-bridge/TypeScript/types/AudioCallOptions.d.ts

@@ -0,0 +1,11 @@
+import { CallOptions } from "./CallOptions";
+import { AudioCallType } from "./AudioCallType";
+/**
+ * Audio call options used for chat
+ */
+export interface AudioCallOptions extends CallOptions {
+    /**
+     * Type of audioCall to launch when an option of the chat is tapped.
+     */
+    type: AudioCallType;
+}

package/lib/typescript/native-bridge/TypeScript/types/AudioCallType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This class defines the types of audio calls supported.
+ */
+export declare enum AudioCallType {
+    /**
+     * Audio only is a call that will only use the microphone
+     */
+    AUDIO = "audio",
+    /**
+     * Audio Upgradable is a call a type of call that starts in audio only and may be upgraded to audio&video type
+     */
+    AUDIO_UPGRADABLE = "audioUpgradable"
+}

package/lib/typescript/native-bridge/TypeScript/types/CallDisplayMode.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This class defines the display modes supported per call.
+ */
+export declare enum CallDisplayMode {
+    /**
+     * The call UI fits completely the available window.
+     */
+    FOREGROUND = "FOREGROUND",
+    /**
+     * If the device has picture in picture feature the call UI is floating on the screen's device.
+     */
+    FOREGROUND_PICTURE_IN_PICTURE = "FOREGROUND_PICTURE_IN_PICTURE",
+    /**
+     * The call UI is not visible to the user.
+     */
+    BACKGROUND = "BACKGROUND"
+}

package/lib/typescript/native-bridge/TypeScript/types/CallKitConfiguration.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Configuration for callkit
+ */
+export interface CallKitConfiguration {
+    /**
+     * Set to false to disable
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: true</b>
+     */
+    enabled?: boolean;
+    /**
+     * The icon resource name to be used in the callkit UI to represent the app
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: null</b>
+     */
+    appIconName?: string;
+    /**
+     * The ringtone resource name to be used when callkit is launched
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: system</b>
+     */
+    ringtoneSoundName?: string;
+}

package/lib/typescript/native-bridge/TypeScript/types/CallOptions.d.ts

@@ -0,0 +1,13 @@
+import { RecordingType } from "./RecordingType";
+/**
+ * Options available for a call
+ */
+export interface CallOptions {
+    /**
+     * May have three different values, NONE, AUTOMATIC, MANUAL
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: none</b>
+     */
+    recordingType?: RecordingType;
+}

package/lib/typescript/native-bridge/TypeScript/types/CallType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This class defines the types of calls supported.
+ */
+export declare enum CallType {
+    /**
+     * Audio only is a call that will only use the microphone
+     */
+    AUDIO = "audio",
+    /**
+     * Audio Upgradable is a call a type of call that starts in audio only and may be upgraded to audio&video type
+     */
+    AUDIO_UPGRADABLE = "audioUpgradable",
+    /**
+     * Audio Video is a call that will use both the camera and the microphone
+     */
+    AUDIO_VIDEO = "audioVideo"
+}

package/lib/typescript/native-bridge/TypeScript/types/ChatToolConfiguration.d.ts

@@ -0,0 +1,15 @@
+import { CallOptions } from "./CallOptions";
+import { AudioCallOptions } from "./AudioCallOptions";
+/**
+ * Chat tool configuration
+ */
+export interface ChatToolConfiguration {
+    /**
+     * Defining this object will enable an option to start an audio call from chat UI
+     */
+    audioCallOption?: AudioCallOptions;
+    /**
+     * Defining this object will enable an option to start an audio&video call from chat UI
+     */
+    videoCallOption?: CallOptions;
+}

package/lib/typescript/native-bridge/TypeScript/types/CreateCallOptions.d.ts

@@ -0,0 +1,15 @@
+import { CallType } from './CallType';
+import { CallOptions } from './CallOptions';
+/**
+ * Options to be used when creating a call
+ */
+export interface CreateCallOptions extends CallOptions {
+    /**
+     * Array of callees identifiers to call.
+     */
+    callees: string[];
+    /**
+     * Type of call to create
+     */
+    callType: CallType;
+}

package/lib/typescript/native-bridge/TypeScript/types/Environment.d.ts

@@ -0,0 +1,9 @@
+/**
+ * An environment where your integration will run
+ */
+export interface Environment {
+    /**
+     * name of the environment
+     */
+    name: string;
+}

package/lib/typescript/native-bridge/TypeScript/types/IosConfiguration.d.ts

@@ -0,0 +1,23 @@
+import { CallKitConfiguration } from "./CallKitConfiguration";
+import { VoipHandlingStrategy } from "./VoipHandlingStrategy";
+/**
+ * Configuration for iOS platform
+ */
+export interface IosConfiguration {
+    /**
+     * Specify the callkit configuration to enable the usage and it's behaviour
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: enabled</b>
+     */
+    callkit?: CallKitConfiguration;
+    /**
+     * Specify the voip handling strategy.
+     * <br/>
+     * This allows you to disable or leave the plugin behaviour for handling the voip notifications.
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: VoipHandlingStrategy.AUTOMATIC </b>
+     */
+    voipHandlingStrategy?: VoipHandlingStrategy;
+}

package/lib/typescript/native-bridge/TypeScript/types/KaleyraVideoConfiguration.d.ts

@@ -0,0 +1,33 @@
+import { IosConfiguration } from "./IosConfiguration";
+import { Tools } from "./Tools";
+import { Environment } from "./Environment";
+import { Region } from "./Region";
+/**
+ * Generic configuration used for setup
+ */
+export interface KaleyraVideoConfiguration {
+    /**
+     * This key will be provided to you by us.
+     */
+    appID: string;
+    /**
+     * This variable defines the environment where you will be sandbox or production.
+     */
+    environment: Environment;
+    /**
+     * This variable defines the region where you will be europe, india or us.
+     */
+    region: Region;
+    /**
+     * Set to true to enable log, default value is false
+     */
+    logEnabled?: boolean;
+    /**
+     * Define the tools to use
+     */
+    tools?: Tools;
+    /**
+     * Define to customize the iOS configuration
+     */
+    iosConfig?: IosConfiguration;
+}

package/lib/typescript/native-bridge/TypeScript/types/RecordingType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Recording type of the call
+ */
+export declare enum RecordingType {
+    /**
+     * The call will be recorded on demand
+     */
+    MANUAL = "manual",
+    /**
+     * The call will be recorded as soon it starts
+     */
+    AUTOMATIC = "automatic",
+    /**
+     * The call will not be recorded
+     */
+    NONE = "none"
+}