@forstaglobal/react-native-mobilesdk 3.12.0 → 3.13.0

package/src/index.tsx

@@ -1,155 +1,48 @@
-import { NativeModules, Platform } from 'react-native';
-import type { IScenarioCallback, IServerModel, IWebSurveyModel } from './models/models';
-import type { ISdkListener } from './program/triggerCallback';
+import { ConfirmitSdk } from './confirmitSdk';
+import {
+    IDefaultQuestion,
+    IInfoQuestion,
+    IMultiQuestion,
+    INumericQuestion,
+    IPageControl,
+    IQuestion,
+    IScenarioCallback,
+    IServerModel,
+    ISingleQuestion,
+    ISurveyError,
+    ISurveyErrored,
+    ISurveyFinished,
+    ISurveyFrameActionResult,
+    ISurveyModel,
+    ITextQuestion,
+    IWebSurveyModel,
+    NodeType,
+    QuestionAnswer
+} from './models/models';
 import { TriggerManager } from './program/triggerCallback';
+import { ServerSdk } from './serverSdk';
+import { SurveyFrameManager } from './survey/surveyFrameCallback';
+import { SurveySdk } from './surveySdk';
+import { TriggerSdk } from './triggerSdk';
 import SurveyWebView from './views/surveyWebView';
 
-const LINKING_ERROR =
-    `The package 'react-native-mobilesdk' 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 MobileSdk = NativeModules.MobileSdk
-    ? NativeModules.MobileSdk
-    : new Proxy(
-          {},
-          {
-              get() {
-                  throw new Error(LINKING_ERROR);
-              }
-          }
-      );
-
-export type { IScenarioCallback, IServerModel, IWebSurveyModel, ISdkListener };
-
-export { SurveyWebView, TriggerManager };
-
-function transformServer(result: any): IServerModel {
-    return {
-        host: result.host,
-        name: result.name,
-        serverId: result.serverId
-    };
-}
-
-export function injectWebView() {
-    MobileSdk.injectWebView();
-}
-
-// Confirmit
-export function initSdk() {
-    return MobileSdk.initSdk();
-}
-
-export function enableLog(enable: boolean) {
-    MobileSdk.enableLog(enable);
-}
-
-// Trigger
-export function notifyEvent(event: string) {
-    MobileSdk.notifyEvent(event);
-}
-
-export function notifyAppForeground(data: { [Name: string]: string }) {
-    MobileSdk.notifyAppForeground(data);
-}
-
-export function deleteProgram(serverId: string, programKey: string, deleteCustomData: boolean): Promise<void> {
-    return MobileSdk.deleteProgram(serverId, programKey, deleteCustomData);
-}
-
-export function deleteAll(deleteCustomData: boolean): Promise<void> {
-    return MobileSdk.deleteAll(deleteCustomData);
-}
-
-export function setCallback(serverId: string, programKey: string) {
-    MobileSdk.setCallback(serverId, programKey);
-}
-
-export function removeCallback(serverId: string, programKey: string) {
-    MobileSdk.removeCallback(serverId, programKey);
-}
-
-export function triggerDownload(serverId: string, programKey: string): Promise<boolean> {
-    return MobileSdk.triggerDownload(serverId, programKey);
-}
-
-export function notifyEventWithData(event: string, data: { [Name: string]: string }) {
-    MobileSdk.notifyEventWithData(event, data);
-}
-
-// Server
-export async function getUs(): Promise<IServerModel> {
-    return transformServer(await MobileSdk.getUs());
-}
-
-export async function getUk(): Promise<IServerModel> {
-    return transformServer(await MobileSdk.getUk());
-}
-
-export async function getAustralia(): Promise<IServerModel> {
-    return transformServer(await MobileSdk.getAustralia());
-}
-
-export async function getCanada(): Promise<IServerModel> {
-    return transformServer(await MobileSdk.getCanada());
-}
-
-export async function getGermany(): Promise<IServerModel> {
-    return transformServer(await MobileSdk.getGermany());
-}
-
-export async function getHxPlatform(): Promise<IServerModel> {
-    return transformServer(await MobileSdk.getHxPlatform());
-}
-
-export async function getHxAustralia(): Promise<IServerModel> {
-    return transformServer(await MobileSdk.getHxAustralia());
-}
-
-export async function configureUs(clientId: string, clientSecret: string): Promise<void> {
-    return await MobileSdk.configureUs(clientId, clientSecret);
-}
-
-export async function configureUk(clientId: string, clientSecret: string): Promise<void> {
-    return await MobileSdk.configureUk(clientId, clientSecret);
-}
-
-export async function configureAustralia(clientId: string, clientSecret: string): Promise<void> {
-    return await MobileSdk.configureAustralia(clientId, clientSecret);
-}
-
-export async function configureCanada(clientId: string, clientSecret: string): Promise<void> {
-    return await MobileSdk.configureCanada(clientId, clientSecret);
-}
-
-export async function configureGermany(clientId: string, clientSecret: string): Promise<void> {
-    return await MobileSdk.configureGermany(clientId, clientSecret);
-}
-
-export async function configureHxPlatform(clientId: string, clientSecret: string): Promise<void> {
-    return await MobileSdk.configureHxPlatform(clientId, clientSecret);
-}
-
-export async function configureHxAustralia(clientId: string, clientSecret: string): Promise<void> {
-    return await MobileSdk.configureHxAustralia(clientId, clientSecret);
-}
-
-export async function configureServer(name: string, host: string, clientId: string, clientSecret: string): Promise<IServerModel> {
-    return transformServer(await MobileSdk.configureServer(name, host, clientId, clientSecret));
-}
-
-export async function getServer(serverId: string): Promise<IServerModel> {
-    return transformServer(await MobileSdk.getServer(serverId));
-}
-
-export async function getServers(): Promise<IServerModel[]> {
-    const result = await MobileSdk.getServers();
-    const servers = [];
-    for (const server of result) {
-        servers.push(transformServer(server));
-    }
-
-    return servers;
-}
+export type {
+    IScenarioCallback,
+    IServerModel,
+    IWebSurveyModel,
+    ISurveyModel,
+    IQuestion,
+    IPageControl,
+    ISurveyErrored,
+    ISurveyFinished,
+    ISurveyError,
+    ISurveyFrameActionResult,
+    IDefaultQuestion,
+    ITextQuestion,
+    INumericQuestion,
+    ISingleQuestion,
+    IMultiQuestion,
+    IInfoQuestion
+};
+
+export { SurveyWebView, TriggerManager, SurveyFrameManager, NodeType, QuestionAnswer, ConfirmitSdk, TriggerSdk, ServerSdk, SurveySdk };

package/src/models/models.ts

@@ -9,8 +9,104 @@ export interface IWebSurveyModel {
     url: string;
 }
 
+export interface ISurveyModel {
+    serverId: string;
+    programKey: string;
+    surveyId: string;
+    languageId: number | null;
+    customData: { [key: string]: string };
+    respondentValue: { [key: string]: string };
+}
+
 export interface IScenarioCallback {
     serverId: string;
     programKey: string;
     error: string;
 }
+
+export interface ISurveyFrameActionResult {
+    success: string;
+    message: string;
+}
+
+export enum NodeType {
+    Single = 'SINGLE',
+    Multi = 'MULTI',
+    Text = 'TEXT',
+    Numeric = 'NUMERIC',
+    Info = 'INFO',
+    NotSupported = 'NOT_SUPPORTED'
+}
+
+export interface IQuestion {
+    id: string;
+    nodeType: NodeType;
+}
+
+export interface IPageControl {
+    forwardText: string;
+    backwardText: string;
+    okText: string;
+    showForward: boolean;
+    showBackward: boolean;
+    serverId: string;
+    surveyId: string;
+    programKey: string;
+}
+
+export interface ISurveyErrored extends IPageControl {
+    error: ISurveyError;
+    values: { [key: string]: string };
+}
+
+export interface ISurveyFinished extends IPageControl {
+    values: { [key: string]: string };
+}
+
+export interface ISurveyError {
+    message: string;
+    stack: string;
+}
+
+export interface IDefaultQuestion {
+    id: string;
+    nodeType: NodeType;
+    title: string;
+    titleSpan: string;
+    text: string;
+    instruction: string;
+    errors: ISurveyError[];
+}
+
+export interface IInfoQuestion extends IDefaultQuestion {}
+
+export interface ITextQuestion extends IDefaultQuestion {}
+
+export interface INumericQuestion extends IDefaultQuestion {}
+
+export interface ISingleQuestion extends IDefaultQuestion {
+    appearance: number;
+    answers: QuestionAnswer[];
+}
+
+export interface IMultiQuestion extends IDefaultQuestion {
+    appearance: number;
+    answers: QuestionAnswer[];
+}
+
+export interface QuestionAnswer {
+    code: string;
+    text: string;
+    isHeader: boolean;
+    answers: QuestionAnswer[];
+}
+
+export enum SingleAppearance {
+    radioButton,
+    answerButton,
+    dropDown,
+    slider,
+    horizontalRatingScale,
+    startRating,
+    gridBars
+}

package/src/program/triggerCallback.ts

@@ -1,42 +1,25 @@
 import { NativeEventEmitter, NativeModules } from 'react-native';
-import type { IScenarioCallback, IWebSurveyModel } from '../models/models';
-
-export interface ISdkListener {
-    onSurveyWebview(model: IWebSurveyModel): void;
-    onScenarioLoad(model: IScenarioCallback): void;
-    onScenarioError(model: IScenarioCallback): void;
-}
+import { IScenarioCallback, ISurveyModel, IWebSurveyModel } from '../models/models';
 
 class Manager {
-    private listener: ISdkListener | null = null;
     private sdkEmitter = NativeModules.SdkEmitter;
     private triggerManagerEmitter = new NativeEventEmitter(this.sdkEmitter);
 
-    public constructor() {
-        this.triggerManagerEmitter.addListener('__mobileOnWebSurveyStart', this.onWebSurveyStart);
-        this.triggerManagerEmitter.addListener('__mobileOnScenarioLoad', this.onScenarioLoad);
-        this.triggerManagerEmitter.addListener('__mobileOnScenarioError', this.onScenarioError);
+    public setOnWebSurveyStart(callback: (event: IWebSurveyModel) => void) {
+        return this.triggerManagerEmitter.addListener('__mobileOnWebSurveyStart', callback);
     }
 
-    public setSdkListener(callbackListener: ISdkListener) {
-        this.listener = callbackListener;
+    public setOnSurveyStart(callback: (event: ISurveyModel) => void) {
+        return this.triggerManagerEmitter.addListener('__mobileOnSurveyStart', callback);
     }
 
-    public removeSdkListener() {
-        this.listener = null;
+    public setOnScenarioLoad(callback: (event: IScenarioCallback) => void) {
+        return this.triggerManagerEmitter.addListener('__mobileOnScenarioLoad', callback);
     }
 
-    private onWebSurveyStart = (event: IWebSurveyModel) => {
-        this.listener?.onSurveyWebview(event);
-    };
-
-    private onScenarioLoad = (event: IScenarioCallback) => {
-        this.listener?.onScenarioLoad(event);
-    };
-
-    private onScenarioError = (event: IScenarioCallback) => {
-        this.listener?.onScenarioError(event);
-    };
+    public setOnScenarioError(callback: (event: IScenarioCallback) => void) {
+        return this.triggerManagerEmitter.addListener('__mobileOnScenarioError', callback);
+    }
 }
 
 export const TriggerManager = new Manager();

package/src/serverSdk.ts

@@ -0,0 +1,105 @@
+import { NativeModules, Platform } from 'react-native';
+import { IServerModel } from './models/models';
+
+const LINKING_ERROR =
+    `The package 'react-native-mobilesdk' 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 MobileSdk = NativeModules.MobileSdk
+    ? NativeModules.MobileSdk
+    : new Proxy(
+          {},
+          {
+              get() {
+                  throw new Error(LINKING_ERROR);
+              }
+          }
+      );
+
+class Manager {
+    public async getUs(): Promise<IServerModel> {
+        return this.transformServer(await MobileSdk.getUs());
+    }
+
+    public async getUk(): Promise<IServerModel> {
+        return this.transformServer(await MobileSdk.getUk());
+    }
+
+    public async getAustralia(): Promise<IServerModel> {
+        return this.transformServer(await MobileSdk.getAustralia());
+    }
+
+    public async getCanada(): Promise<IServerModel> {
+        return this.transformServer(await MobileSdk.getCanada());
+    }
+
+    public async getGermany(): Promise<IServerModel> {
+        return this.transformServer(await MobileSdk.getGermany());
+    }
+
+    public async getHxPlatform(): Promise<IServerModel> {
+        return this.transformServer(await MobileSdk.getHxPlatform());
+    }
+
+    public async getHxAustralia(): Promise<IServerModel> {
+        return this.transformServer(await MobileSdk.getHxAustralia());
+    }
+
+    public async configureUs(clientId: string, clientSecret: string): Promise<void> {
+        return await MobileSdk.configureUs(clientId, clientSecret);
+    }
+
+    public async configureUk(clientId: string, clientSecret: string): Promise<void> {
+        return await MobileSdk.configureUk(clientId, clientSecret);
+    }
+
+    public async configureAustralia(clientId: string, clientSecret: string): Promise<void> {
+        return await MobileSdk.configureAustralia(clientId, clientSecret);
+    }
+
+    public async configureCanada(clientId: string, clientSecret: string): Promise<void> {
+        return await MobileSdk.configureCanada(clientId, clientSecret);
+    }
+
+    public async configureGermany(clientId: string, clientSecret: string): Promise<void> {
+        return await MobileSdk.configureGermany(clientId, clientSecret);
+    }
+
+    public async configureHxPlatform(clientId: string, clientSecret: string): Promise<void> {
+        return await MobileSdk.configureHxPlatform(clientId, clientSecret);
+    }
+
+    public async configureHxAustralia(clientId: string, clientSecret: string): Promise<void> {
+        return await MobileSdk.configureHxAustralia(clientId, clientSecret);
+    }
+
+    public async configureServer(name: string, host: string, clientId: string, clientSecret: string): Promise<IServerModel> {
+        return this.transformServer(await MobileSdk.configureServer(name, host, clientId, clientSecret));
+    }
+
+    public async getServer(serverId: string): Promise<IServerModel> {
+        return this.transformServer(await MobileSdk.getServer(serverId));
+    }
+
+    public async getServers(): Promise<IServerModel[]> {
+        const result = await MobileSdk.getServers();
+        const servers = [];
+        for (const server of result) {
+            servers.push(this.transformServer(server));
+        }
+
+        return servers;
+    }
+
+    private transformServer(result: any): IServerModel {
+        return {
+            host: result.host,
+            name: result.name,
+            serverId: result.serverId
+        };
+    }
+}
+
+export const ServerSdk = new Manager();

package/src/survey/pageControl.ts

@@ -0,0 +1,97 @@
+import { NativeModules, Platform } from 'react-native';
+import { IDefaultQuestion, IPageControl, ISurveyFrameActionResult, QuestionAnswer } from 'react-native-mobilesdk';
+
+const LINKING_ERROR =
+    `The package 'react-native-mobilesdk' 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 MobileSdkSurvey = NativeModules.MobileSdkSurvey
+    ? NativeModules.MobileSdkSurvey
+    : new Proxy(
+          {},
+          {
+              get() {
+                  throw new Error(LINKING_ERROR);
+              }
+          }
+      );
+
+export class PageControl {
+    public forwardText: string;
+    public backwardText: string;
+    public showForward: boolean;
+    public showBackward: boolean;
+    public okText: string;
+    public serverId: string;
+    public programKey: string;
+    public surveyId: string;
+
+    public constructor(page: IPageControl) {
+        this.forwardText = page.forwardText;
+        this.backwardText = page.backwardText;
+        this.showForward = page.showForward;
+        this.showBackward = page.showBackward;
+        this.okText = page.okText;
+        this.serverId = page.serverId;
+        this.programKey = page.programKey;
+        this.surveyId = page.surveyId;
+    }
+
+    public async getQuestion(): Promise<IDefaultQuestion[]> {
+        return await MobileSdkSurvey.getQuestions(this.serverId, this.programKey, this.surveyId);
+    }
+
+    public async getMulti(questionId: string): Promise<QuestionAnswer[]> {
+        return await MobileSdkSurvey.getMulti(this.serverId, this.programKey, this.surveyId, questionId);
+    }
+
+    public async setMulti(questionId: string, code: string, selected: boolean) {
+        return await MobileSdkSurvey.setMulti(this.serverId, this.programKey, this.surveyId, questionId, code, selected);
+    }
+
+    public async getSingle(questionId: string): Promise<QuestionAnswer> {
+        return await MobileSdkSurvey.getSingle(this.serverId, this.programKey, this.surveyId, questionId);
+    }
+
+    public async setSingle(questionId: string, code: string): Promise<void> {
+        return await MobileSdkSurvey.setSingle(this.serverId, this.programKey, this.surveyId, questionId, code);
+    }
+
+    public async getText(questionId: string): Promise<string> {
+        return await MobileSdkSurvey.getText(this.serverId, this.programKey, this.surveyId, questionId);
+    }
+
+    public async setText(questionId: string, value: string): Promise<void> {
+        return await MobileSdkSurvey.setText(this.serverId, this.programKey, this.surveyId, questionId, value);
+    }
+
+    public async getNumeric(questionId: string): Promise<string> {
+        return await MobileSdkSurvey.getNumeric(this.serverId, this.programKey, this.surveyId, questionId);
+    }
+
+    public async setNumeric(questionId: string, value: number, isDouble: boolean): Promise<void> {
+        return await MobileSdkSurvey.setNumeric(this.serverId, this.programKey, this.surveyId, questionId, value, isDouble);
+    }
+
+    public async next(): Promise<ISurveyFrameActionResult> {
+        return await MobileSdkSurvey.next(this.serverId, this.programKey, this.surveyId);
+    }
+
+    public async back(): Promise<ISurveyFrameActionResult> {
+        return await MobileSdkSurvey.back(this.serverId, this.programKey, this.surveyId);
+    }
+
+    public async quit(upload: boolean): Promise<ISurveyFrameActionResult> {
+        return await MobileSdkSurvey.quit(this.serverId, this.programKey, this.surveyId, upload);
+    }
+
+    public async title(): Promise<string> {
+        return await MobileSdkSurvey.getTitle(this.serverId, this.programKey, this.surveyId);
+    }
+
+    public async text(): Promise<string> {
+        return await MobileSdkSurvey.getText(this.serverId, this.programKey, this.surveyId);
+    }
+}

package/src/survey/surveyFrameCallback.ts

@@ -0,0 +1,28 @@
+import { NativeEventEmitter, NativeModules } from 'react-native';
+import { PageControl } from './pageControl';
+import { IPageControl, ISurveyErrored, ISurveyFinished } from '../models/models';
+
+class Manager {
+    private sdkEmitter = NativeModules.SdkEmitter;
+    private triggerManagerEmitter = new NativeEventEmitter(this.sdkEmitter);
+
+    public setOnSurveyPageReady(callback: (event: PageControl) => void) {
+        return this.triggerManagerEmitter.addListener('__mobileOnSurveyPageReady', (event: IPageControl) => {
+            callback(new PageControl(event));
+        });
+    }
+
+    public setOnSurveyErrored(callback: (event: ISurveyErrored) => void) {
+        return this.triggerManagerEmitter.addListener('__mobileOnSurveyErrored', callback);
+    }
+
+    public setOnSurveyFinished(callback: (event: ISurveyFinished) => void) {
+        return this.triggerManagerEmitter.addListener('__mobileOnSurveyFinished', callback);
+    }
+
+    public setOnSurveyQuit(callback: (values: { [key: string]: string }) => void) {
+        return this.triggerManagerEmitter.addListener('__mobileOnSurveyQuit', callback);
+    }
+}
+
+export const SurveyFrameManager = new Manager();

package/src/surveySdk.ts

@@ -0,0 +1,32 @@
+import { NativeModules, Platform } from 'react-native';
+
+const LINKING_ERROR =
+    `The package 'react-native-mobilesdk' 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 MobileSdkSurvey = NativeModules.MobileSdkSurvey
+    ? NativeModules.MobileSdkSurvey
+    : new Proxy(
+          {},
+          {
+              get() {
+                  throw new Error(LINKING_ERROR);
+              }
+          }
+      );
+
+class Manager {
+    public async startSurvey(
+        serverId: string,
+        programKey: string,
+        surveyId: string,
+        data: { [Name: string]: string },
+        respondentValues: { [Name: string]: string }
+    ): Promise<void> {
+        return await MobileSdkSurvey.startSurvey(serverId, programKey, surveyId, data, respondentValues);
+    }
+}
+
+export const SurveySdk = new Manager();

package/src/triggerSdk.ts

@@ -0,0 +1,62 @@
+import { NativeModules, Platform } from 'react-native';
+
+const LINKING_ERROR =
+    `The package 'react-native-mobilesdk' 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 MobileSdk = NativeModules.MobileSdk
+    ? NativeModules.MobileSdk
+    : new Proxy(
+          {},
+          {
+              get() {
+                  throw new Error(LINKING_ERROR);
+              }
+          }
+      );
+
+class Manager {
+    public notifyEvent(event: string) {
+        MobileSdk.notifyEvent(event);
+    }
+
+    public notifyAppForeground(data: { [Name: string]: string }) {
+        MobileSdk.notifyAppForeground(data);
+    }
+
+    public async deleteProgram(serverId: string, programKey: string, deleteCustomData: boolean): Promise<void> {
+        return MobileSdk.deleteProgram(serverId, programKey, deleteCustomData);
+    }
+
+    public async deleteAll(deleteCustomData: boolean): Promise<void> {
+        return MobileSdk.deleteAll(deleteCustomData);
+    }
+
+    public setCallback(serverId: string, programKey: string) {
+        MobileSdk.setCallback(serverId, programKey);
+    }
+
+    public removeCallback(serverId: string, programKey: string) {
+        MobileSdk.removeCallback(serverId, programKey);
+    }
+
+    public async triggerDownload(serverId: string, programKey: string): Promise<boolean> {
+        return MobileSdk.triggerDownload(serverId, programKey);
+    }
+
+    public notifyEventWithData(event: string, data: { [Name: string]: string }) {
+        MobileSdk.notifyEventWithData(event, data);
+    }
+
+    public addJourneyLog(data: { [Name: string]: string }) {
+        MobileSdk.addJourneyLog(data);
+    }
+
+    public addJourneyLogWithServer(serverId: string, programKey: string, data: { [Name: string]: string }) {
+        MobileSdk.addJourneyLogWithServer(serverId, programKey, data);
+    }
+}
+
+export const TriggerSdk = new Manager();