react-native-malwarelytics
Version:
Malwarelytics for React Native protects your banking or fintech app from a broad range of mobile security threats with an industry-leading mobile threat intelligence solution.
233 lines (204 loc) • 6.79 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.Malwarelytics = void 0;
var _MalwarelyticsModule = require("./internal/MalwarelyticsModule");
var _EventHelper = require("./internal/EventHelper");
var _MalwarelyticsRasp = require("./MalwarelyticsRasp");
var _MalwarelyticsAntivirus = require("./MalwarelyticsAntivirus");
var _reactNative = require("react-native");
var _MalwarelyticsError = require("./MalwarelyticsError");
//
// Copyright 2023 Wultra s.r.o.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions
// and limitations under the License.
//
/**
* JavaScript wrapper around native kotlin/swift Malwarelytics code.
*/
class Malwarelytics {
// Shared instance
/**
* Contains shared instance of Malwarelytics class.
*/
static get sharedInstance() {
if (this.instance === undefined) {
this.instance = new Malwarelytics();
}
return this.instance;
}
// Configuration
/**
* Get state of the Malwarelytics module.
*
* This function also updates content of `initializationResult` getter, if result
* is available.
*
* @returns State of the module.
*/
getState() {
return this.withModule(async module => {
const stateWithResult = await module.getState();
this.lastInitializationResult = stateWithResult.result;
return stateWithResult.state;
});
}
/**
* Apple specific: Obtain list of DetectableApp.KnownApp items that are predefined in native iOS library.
*
* @returns List of DetectableApp.KnownApp items.
*/
getKnownDetectableApps() {
if (_reactNative.Platform.OS != "ios") {
return Promise.reject(new _MalwarelyticsError.MalwarelyticsError("METHOD_NOT_SUPPORTED", "This method is supported only on Apple platforms"));
}
return this.withModule(module => module.getKnownDetectableApps());
}
/**
* Initialize Malwarelytics instance with given configuration.
*
* Note that if you want to change the configuration on the running instance,
* then you have to `shutdown()` the instance first.
*
* @param configuration Configuration to apply.
*/
initialize(configuration) {
return this.withModule(async module => {
this.lastInitializationResult = await module.initialize(configuration);
return this.lastInitializationResult;
});
}
/**
* Contains information about last initialization result.
*/
get initializationResult() {
return this.lastInitializationResult;
}
/**
* Shutdown the previously initialized Malwarelytics instance.
* @param clearAvUserId If `true`, then clears also persistent AV user ID, making the device appear as a newly created. The default value is `false`.
*/
shutdown(clearAvUserId = false) {
return this.withModule(async module => {
await module.shutdown(clearAvUserId);
this.lastInitializationResult = undefined;
});
}
/**
* Get information whether module is already initialized.
*/
async isInitialized() {
return (await this.getState()) == "READY";
}
/**
* Sets new client id that will be sent to the backend for user identification.
* Pass `undefined` to remove the current client id (for example when user logged-out).
*
* @param clientId Client id, `undefied` for deleting the value
*/
setClientId(clientId) {
return this.withModule(module => module.setClientId(clientId));
}
/**
* Sets new device id that will be sent to the backend for user identification.
* Pass `undefied` to remove the current device id.
*
* @param deviceId Device id, `undefied` for deleting the value
*/
setDeviceId(deviceId) {
return this.withModule(module => module.setDeviceId(deviceId));
}
/**
* Get AV User ID if it is available. The AV User ID will be available if the SDK initialized with
* result `SUCCESS`. Otherwise it might be undefined.
*/
getAvUserId() {
return this.withModule(module => module.getAvUserId());
}
// Events
/**
* Object representing a subscription to state events.
*/
/**
* Set listener for Malwarelytic's instance state changes.
* @param listener Listener implementation.
*/
async setStateListener(listener) {
this.stateEventsSubscription?.remove();
this.stateEventsSubscription = await this.eventHelper.addListener('Malwarelytics.STATE', data => {
listener.malwarelyticsStateChanged(data);
});
}
/**
* Remove state listener previously set by `setStateListener()` method.
*/
removeStateListener() {
this.stateEventsSubscription?.remove();
this.stateEventsSubscription = undefined;
}
// Private methods and properties
/**
* Instance of native module.
*/
/**
* Instance of event helper.
*/
/**
* RASP module
*/
/**
* Antivirus module
*/
/**
* Shared instnace of this class.
*/
/**
* Last initialization result
*/
/**
* Private constructor.
*/
constructor() {
this.nativeModule = _MalwarelyticsModule.MalwarelyticsModule;
this.eventHelper = new _EventHelper.EventHelper(this.nativeModule);
this.rasp = new _MalwarelyticsRasp.MalwarelyticsRasp(this.eventHelper);
this.antivirus = new _MalwarelyticsAntivirus.MalwarelyticsAntivirus(this.eventHelper);
}
/**
* Execute closure with action with properly acquired instnace to native module.
* @param action Action to execute.
* @returns Result returned from the action.
*/
async withModule(action) {
return (0, _MalwarelyticsModule.wrapNativeCall)(this.nativeModule, action);
}
}
/**
* Type defining the state of Malwarelytics module:
* - `"SHUTDOWN"` - Malwarelytics is not initialized.
* - `"PENDING_INIT"` - Malwarelytics is initializing.
* - `"READY"` - Malwarelytics is ready and prepared for use.
* - `"PENDING_SHUTDOWN"` - Malwarelytics is shutting down.
*/
/**
* Type defining the result of Malwarelytics initialization.
* - `'SUCCESS'` - Initialization completed successfully
* - `'PERMANENT_OFFLINE_MODE'` - SDK works in permanent offline mode.
* - `'TEMPORARY_OFFLINE_MODE'` - Android only: SDK works in temporary offline mode.
*/
/**
* Interface for listening Malwarelytics module state changes.
*/
exports.Malwarelytics = Malwarelytics;
//# sourceMappingURL=Malwarelytics.js.map