starti.app 1.0.7 → 1.0.8

package/dist/app.d.ts

@@ -1,7 +1,11 @@
 export declare const App: IApp;
 export interface IApp {
+    /** The event will be called whenever the app enters the foreground on the device and when the app starts og thus also enters the foreground on the device. */
     onAppInForeground?: () => void;
+    /** Are the site running inside starti.app? Returns false if the site is loaded in a normal browser. */
     isStartiappLoaded(): boolean;
+    /** Use this method to control which URL the app load when it is initialized. */
     setAppUrl: (url: string) => void;
+    /** Returns the version number of the app (eg. 1.0.0). */
     version(): Promise<string>;
 }

package/dist/index.d.ts

@@ -2,8 +2,12 @@ import { IApp } from './app';
 import { IPushNotification } from './pushnotification';
 import { IQrScanner } from './qrscanner';
 export default class startiapp {
+    /** Basic calls to the app. */
     static App: IApp;
+    /** The QR- and barcode scanning functionality. */
     static QrScanner: IQrScanner;
+    /** Access to push notifications using Firebase. */
     static PushNotification: IPushNotification;
+    /** Call this method to initialize the starti.app API integration. */
     static initialize(): void;
 }

package/dist/index.js

@@ -11,12 +11,16 @@ untypedWindow.App = app_1.App;
 untypedWindow.QrScanner = qrscanner_1.QrScanner;
 untypedWindow.PushNotification = pushnotification_1.PushNotification;
 class startiapp {
+    /** Call this method to initialize the starti.app API integration. */
     static initialize() {
         // @ts-ignore
         AppIntegration.webAppIsReady();
     }
 }
 exports.default = startiapp;
+/** Basic calls to the app. */
 startiapp.App = app_1.App;
+/** The QR- and barcode scanning functionality. */
 startiapp.QrScanner = qrscanner_1.QrScanner;
+/** Access to push notifications using Firebase. */
 startiapp.PushNotification = pushnotification_1.PushNotification;

package/dist/pushnotification.d.ts

@@ -1,7 +1,11 @@
 export declare const PushNotification: IPushNotification;
 export interface IPushNotification {
+    /** Called with the token used to send push notifications to the current device. */
     onTokenReceived?: (token: string) => void;
+    /** Called with the notification that has been received by the mobile. The content of notification is the content that has been sent from the backend. There will also be a special property called appWasLaunchedFromNotification which indicated wether the app entered the foreground because a notification as pressed on the device or wether the app already was in the foreground when the notification was received. */
     onNotificationReceived?: (notification: any) => void;
+    /** This method should be called when the user want’s to receive push notifications. */
     initialize(): Promise<boolean>;
+    /** This method returns the token which should be used to send push notifications. */
     getLastPublishedToken(): Promise<string>;
 }

package/dist/qrscanner.d.ts

@@ -1,4 +1,5 @@
 export declare const QrScanner: IQrScanner;
 export interface IQrScanner {
+    /** Opens the camera on the phone og starts scanning after QR- and barcodes. When the camera has scanned a code the camera will be closed the user will be back on the website. */
     scan(): Promise<string>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "starti.app",
-    "version": "1.0.7",
+    "version": "1.0.8",
     "description": "Use this package for easy communication with the starti.app API.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",