@kaleyra/video-react-native-module 1.0.0

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

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

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

@@ -0,0 +1,19 @@
+/**
+ * Screen Share tool configuration
+ */
+export interface ScreenShareToolConfiguration {
+    /**
+     * Set to true to enable the in app screen share
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: false</b>
+     */
+    inApp?: boolean;
+    /**
+     * Set to true to enable the whole device screen share
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: false</b>
+     */
+    wholeDevice?: boolean;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * Session
+ */
+export interface Session {
+    /**
+     * The user id you want to connect
+     */
+    userID: string;
+    /**
+     * The Kaleyra Video SDK adopts a strong authentication mechanism based on JWT access tokens.
+     * Whenever the SDK needs an access token for a particular user, this component will be asked to provide an access token for a particular user.
+     * @param userId the user which requires a token refresh
+     * @returns a promise containing the access token if completed successfully.
+     */
+    accessTokenProvider(userId: string): Promise<string>;
+}

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

@@ -0,0 +1,42 @@
+import { ScreenShareToolConfiguration } from "./ScreenShareToolConfiguration";
+import { ChatToolConfiguration } from "./ChatToolConfiguration";
+/**
+ * Video Module Tools
+ */
+export interface Tools {
+    /**
+     * Set to true to enable the file sharing feature
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: false</b>
+     */
+    fileShare?: boolean;
+    /**
+     * Set to enable the screen sharing feature
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: no screen share</b>
+     */
+    screenShare?: ScreenShareToolConfiguration;
+    /**
+     * Set to enable the chat feature
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: no chat</b>
+     */
+    chat?: ChatToolConfiguration;
+    /**
+     * Set to true to enable the whiteboard feature
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: false</b>
+     */
+    whiteboard?: boolean;
+    /**
+     * Set to true to enable the feedback request after a call ends.
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: false</b>
+     */
+    feedback?: boolean;
+}

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

@@ -0,0 +1,29 @@
+/**
+ * This is used to define the user details in the call/chat UI
+ */
+export interface UserDetails {
+    /**
+     * User identifier
+     */
+    userID: string;
+    /**
+     * Nickname for the user
+     */
+    nickName?: string;
+    /**
+     * First name of the user
+     */
+    firstName?: string;
+    /**
+     * Last name of the user
+     */
+    lastName?: string;
+    /**
+     * Email of the user
+     */
+    email?: string;
+    /**
+     * Image url to use as placeholder for the user.
+     */
+    profileImageUrl?: string;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * This is used to display the user details in the call/chat UI
+ */
+export interface UserDetailsFormat {
+    /**
+     * Format to be used to display a user details on the call/chat UI
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: ${userAlias}</b>
+     */
+    default: string;
+    /**
+     * Format to be used when displaying an android notification
+     * <br/>
+     * <br/>
+     * <b><font color="blue">default</font>: equals to UserDetailsFormatter.default</b>
+     */
+    androidNotification?: string;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * This class defines the voip notification strategy per call.
+ */
+export declare enum VoipHandlingStrategy {
+    /**
+     * The voip notifications will not be handled
+     */
+    DISABLED = "disabled",
+    /**
+     * The voip notifications will be handled automatically from the plugin
+     */
+    AUTOMATIC = "automatic"
+}

package/lib/typescript/src/KaleyraVideo.d.ts

@@ -0,0 +1,125 @@
+import type { KaleyraVideoConfiguration } from '../native-bridge/TypeScript/types/KaleyraVideoConfiguration';
+import type { CreateCallOptions } from '../native-bridge/TypeScript/types/CreateCallOptions';
+import type { UserDetails } from '../native-bridge/TypeScript/types/UserDetails';
+import type { UserDetailsFormat } from '../native-bridge/TypeScript/types/UserDetailsFormat';
+import { CallType } from '../native-bridge/TypeScript/types/CallType';
+import { Environments } from '../native-bridge/TypeScript/Environments';
+import { CallDisplayMode } from '../native-bridge/TypeScript/types/CallDisplayMode';
+import { Regions } from '../native-bridge/TypeScript/Regions';
+import type { Session } from '../native-bridge/TypeScript/types/Session';
+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 { ReactNativeEventEmitter } from './ReactNativeEventEmitter';
+import type { Events } from './events/Events';
+import { Tools } from '../native-bridge/TypeScript/types/Tools';
+import { IosConfiguration } from '../native-bridge/TypeScript/types/IosConfiguration';
+import { CallKitConfiguration } from '../native-bridge/TypeScript/types/CallKitConfiguration';
+import { ScreenShareToolConfiguration } from '../native-bridge/TypeScript/types/ScreenShareToolConfiguration';
+import { ChatToolConfiguration } from '../native-bridge/TypeScript/types/ChatToolConfiguration';
+import { AudioCallOptions } from '../native-bridge/TypeScript/types/AudioCallOptions';
+import { CallOptions } from '../native-bridge/TypeScript/types/CallOptions';
+/**
+ * KaleyraVideo
+ */
+declare class KaleyraVideo {
+    /**
+     * <b>To create an instance of the Kaleyra Video invoke the [[configure]] method</b>
+     */
+    static instance: KaleyraVideo;
+    private readonly eventEmitter;
+    events: Events;
+    constructor(eventEmitter: ReactNativeEventEmitter);
+    /**
+     * Call this method when device is ready to configure the module
+     * @param configuration
+     * @throws IllegalArgumentError
+     */
+    static configure(configuration: KaleyraVideoConfiguration): KaleyraVideo;
+    /**
+     * @ignore
+     * @private
+     */
+    private static _isAndroid;
+    /**
+     * @ignore
+     * @private
+     */
+    private static _isIOS;
+    /**
+     * Connect the plugin
+     * @param session session to connect with
+     * @throws IllegalArgumentError
+     */
+    connect(session: Session): void;
+    /**
+     * Stop the plugin
+     */
+    disconnect(): void;
+    /**
+     * This method allows you to reset the configuration.
+     */
+    reset(): void;
+    /**
+     * Get the current state of the plugin
+     * @return the state as a promise
+     */
+    /**
+     * Start Call with the callee defined
+     * @param callOptions
+     * @throws IllegalArgumentError
+     */
+    startCall(callOptions: CreateCallOptions): void;
+    /**
+     * Verify the user for the current call
+     * @param verify true if the user is verified, false otherwise
+     * @throws IllegalArgumentError
+     */
+    verifyCurrentCall(verify: boolean): void;
+    /**
+     * Set the UI display mode for the current call
+     * @param mode FOREGROUND, FOREGROUND_PICTURE_IN_PICTURE, BACKGROUND
+     * @throws IllegalArgumentError
+     */
+    setDisplayModeForCurrentCall(mode: CallDisplayMode): void;
+    /**
+     * Start Call from url
+     * @param url received
+     * @throws IllegalArgumentError
+     */
+    startCallFrom(url: string): void;
+    /**
+     * 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: UserDetails[]): void;
+    setUserDetailsFormat(format: UserDetailsFormat): void;
+    /**
+     * Call this method to remove all the user details previously provided.
+     */
+    removeUsersDetails(): void;
+    /**
+     * Call this method to handle a notification!
+     *
+     * @param payload notification data payload as String
+     * @throws IllegalArgumentError
+     */
+    handlePushNotificationPayload(payload: string): void;
+    /**
+     * Open chat
+     * @param userID user you want to chat with
+     * @throws IllegalArgumentError
+     */
+    startChat(userID: string): void;
+    /**
+     * This method allows you to clear all user cached data, such as chat messages and generic information.
+     */
+    clearUserCache(): void;
+    /**
+     * This method returns the current voip push token
+     * @return promise of voipPushToken or undefined if has not been generated yet.
+     */
+    getCurrentVoIPPushToken(): Promise<string>;
+}
+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/src/ReactNativeEventEmitter.d.ts

@@ -0,0 +1,15 @@
+import { NativeEventEmitter, NativeModule } from 'react-native';
+import type { Events } from './events/Events';
+import { Events as HybridEvents } from '../native-bridge/TypeScript/Events';
+export declare class ReactNativeEventEmitter extends NativeEventEmitter implements Events {
+    constructor(nativeModule: NativeModule);
+    onSetupError: (_: string) => void;
+    onCallModuleStatusChanged: (_: string) => void;
+    onCallError: (_: string) => void;
+    oniOSVoipPushTokenUpdated: (_: string) => void;
+    onChatError: (_: string) => void;
+    onChatModuleStatusChanged: (_: string) => void;
+    oniOSVoipPushTokenInvalidated: () => void;
+    on(event: HybridEvents, listener: (...args: any[]) => any): void;
+    clear(): void;
+}

package/lib/typescript/src/events/Events.d.ts

@@ -0,0 +1,37 @@
+/**
+ * This enum defines all the events that may be handled
+ * <br/>
+ * <br/>
+ * You can listen to these events via [[KaleyraVideo.on]]
+ */
+export interface Events {
+    /**
+     * @see [[SetupErrorEvent]]
+     */
+    onSetupError: ((reason: string) => void) | null;
+    /**
+     * @see [[CallStatusChangedEvent]]
+     */
+    onCallModuleStatusChanged: ((status: string) => void) | null;
+    /**
+     * Register to this event via [[KaleyraVideo.on]]
+     * @param callback with the reason as parameter
+     */
+    onCallError: ((reason: string) => void) | null;
+    /**
+     * @see [[ChatErrorEvent]]
+     */
+    onChatError: ((reason: string) => void) | null;
+    /**
+     * @see [[ChatStatusChangedEvent]]
+     */
+    onChatModuleStatusChanged: ((status: string) => void) | null;
+    /**
+     * @see [[VoipPushTokenEvents]]
+     */
+    oniOSVoipPushTokenUpdated: ((token: string) => void) | null;
+    /**
+     * @see [[VoipPushTokenEvents]]
+     */
+    oniOSVoipPushTokenInvalidated: (() => void) | null;
+}

package/native-bridge/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/native-bridge/TypeScript/Environments.ts

@@ -0,0 +1,44 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+
+import type { Environment } from './types/Environment';
+
+/**
+ * Available environments
+ */
+export class Environments implements Environment {
+  /**
+   * Sandbox environment
+   */
+  static sandbox(): Environment {
+    return new Environments('sandbox');
+  }
+
+  /**
+   * Production environment
+   */
+  static production(): Environment {
+    return new Environments('production');
+  }
+
+  /**
+   * Create environment by name
+   * @param name name of the environment
+   */
+  static new(name: string): Environment {
+    return new Environments(name);
+  }
+
+  /**
+   * name of the environment
+   * @ignore
+   */
+  name: string;
+
+  /**
+   * @ignore
+   */
+  private constructor(name: string) {
+    this.name = name;
+  }
+}

package/native-bridge/TypeScript/Events.ts

@@ -0,0 +1,43 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+
+/**
+ * This enum defines all the events that may be handled
+ * <br/>
+ * <br/>
+ * You can listen to these events via [[BandyerPlugin.on]]
+ */
+export 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/native-bridge/TypeScript/Regions.ts

@@ -0,0 +1,51 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+
+import type { Region } from './types/Region';
+
+/**
+ * Available regions
+ */
+export class Regions implements Region {
+  /**
+   * India region
+   */
+  static india(): Region {
+    return new Regions('india');
+  }
+
+  /**
+   * Europe region
+   */
+  static europe(): Region {
+    return new Regions('europe');
+  }
+
+  /**
+   * Us region
+   */
+  static us(): Region {
+    return new Regions('us');
+  }
+
+  /**
+   * Create region by name
+   * @param name name of the region
+   */
+  static new(name: string): Region {
+    return new Regions(name);
+  }
+
+  /**
+   * name of the region
+   * @ignore
+   */
+  name: string;
+
+  /**
+   * @ignore
+   */
+  private constructor(name: string) {
+    this.name = name;
+  }
+}

package/native-bridge/TypeScript/UserDetailsFormatValidator.ts

@@ -0,0 +1,35 @@
+// Copyright © 2018-2023 Kaleyra S.p.a. All Rights Reserved.
+// See LICENSE for licensing information
+
+import { IllegalArgumentError } from "./errors/IllegalArgumentError";
+
+export class UserDetailsFormatValidator {
+
+    validate(format: string) {
+        const keywords = this.findKeywords(format);
+
+        if (keywords.length === 0) {
+            throw new IllegalArgumentError("Could not find any keyword, at least one keyword in the format ${keyword} must be provided");
+        }
+
+        const allowedKeywords = ["userID", "nickName", "firstName", "lastName", "email", "profileImageUrl"];
+
+        keywords.forEach((keyword) => {
+            if (allowedKeywords.indexOf(keyword) === -1) {
+                throw new IllegalArgumentError("Declared keyword=${" + keyword + "} is not allowed. The allowedKeywords allowed are: " + allowedKeywords);
+            }
+        });
+    }
+
+    private findKeywords(format: string): string[] {
+        const regex = /\${([\w]+)}/g;
+        let match;
+        const matches: string[] = [];
+        while ((match = regex.exec(format)) !== null) {
+            if (match[1] && match[1] !== null) {
+                matches.push(match[1]);
+            }
+        }
+        return matches;
+    }
+}