starti.app 2.0.35 → 2.0.51

package/dist/integrationWrapper.d.ts

@@ -2,15 +2,19 @@ import { Integrations } from "./integrations";
 type FunctionOfIntegrationMethod<TIntegrationKey extends keyof Integrations, TIntegrationMethodKey extends keyof Integrations[TIntegrationKey]> = Integrations[TIntegrationKey][TIntegrationMethodKey] extends (...args: infer TArgs) => infer TReturn ? (...args: TArgs) => TReturn : never;
 type MethodFunction = (...args: any) => any;
 type PromiseResolve<T> = (value?: T | PromiseLike<T>) => void;
+type PromiseReject = (reason?: any) => void;
 type AsyncIntegrationResolverCallOptions<TMethodKey, TMethodResponse> = {
     methodName: TMethodKey;
     shouldResolve?: (value: TMethodResponse) => boolean;
+    shouldReject?: (value: any) => boolean;
 };
 export declare class AsyncIntegrationResolver<TIntegrationKey extends keyof Integrations> {
     private integrationKey;
     promises: Record<string, Array<{
         resolve: PromiseResolve<any>;
-        shouldResolve?: (value: any) => boolean;
+        shouldResolve?: (value?: any) => boolean;
+        reject: PromiseReject;
+        shouldReject?: (value: any) => boolean;
     }>>;
     events: Record<string, Array<(...args: any[]) => void>>;
     private get integration();

package/dist/integrations/App/AppIntegration.d.ts

@@ -50,6 +50,44 @@ export declare class App extends EventTargetWithType<{
      * ```
      */
     addInternalDomain: (domain: string) => Promise<void>;
+    /**
+     * Get the internal domains of the app.
+     *
+     * @example
+     * ```typescript
+     * const internalDomains = await startiapp.App.getInternalDomains();
+     * console.log(internalDomains);
+     * ```
+     */
+    getInternalDomains: () => Promise<void>;
+    /**
+     * Add external domains to the app.
+     *
+     * @example
+     * ```typescript
+     * await startiapp.App.addExternalDomains(/example.com/, /starti.app/);
+     * ```
+     */
+    addExternalDomains: (...domains: RegExp[]) => Promise<void>;
+    /**
+     * Remove external domains from the app.
+     *
+     * @example
+     * ```typescript
+     * await startiapp.App.removeExternalDomains(/example.com/, /starti.app/);
+     * ```
+     */
+    removeExternalDomains: (...domains: RegExp[]) => Promise<void>;
+    /**
+     * Get the external domains of the app.
+     *
+     * @example
+     * ```typescript
+     * const externalDomains = await startiapp.App.getExternalDomains();
+     * console.log(externalDomains);
+     * ```
+     */
+    getExternalDomains: () => Promise<void>;
     /**
      * Remove an internal domain from the app.
      *
@@ -61,8 +99,27 @@ export declare class App extends EventTargetWithType<{
     removeInternalDomain: (domain: string) => Promise<void>;
     /** Sets the status bar options for the app. */
     setStatusBar: (options: SetStatusBarOptions) => Promise<void>;
+    /** Hides the status bar */
+    hideStatusBar: () => Promise<void>;
+    /** Shows the status bar */
+    showStatusBar: () => Promise<void>;
+    /** Sets the safe area background color for the app. */
+    setSafeAreaBackgroundColor: (color: string) => Promise<boolean>;
     /** Sets the navigation spinner options for the app. */
     setSpinner: (options: SpinnerOptions) => Promise<void>;
+    /**
+     * Hides the navigation spinner.
+     */
+    hideSpinner: () => Promise<void>;
+    /**
+     * Shows the navigation spinner.
+     *
+     * @example
+     * ```typescript
+     * await startiapp.App.showSpinner();
+     * ```
+     */
+    showSpinner: (options?: SpinnerOptions) => Promise<void>;
     /** Enables the screen to rotate */
     enableScreenRotation: () => Promise<void>;
     /** Prevents the screen from rotation */
@@ -103,6 +160,26 @@ export declare class App extends EventTargetWithType<{
      * Retrieves the current app url.
      */
     getAppUrl: () => Promise<string>;
+    openExternalBrowser: (url: string) => Promise<void>;
+    /**
+     * Set the app url.
+     *
+     * @example
+     * ```typescript
+     * await startiapp.App.setAppUrl("https://example.com");
+     * ```
+     *
+     */
+    setAppUrl: (url: string) => Promise<void>;
+    /**
+     * Reset the app url.
+     *
+     * @example
+     * ```typescript
+     * await startiapp.App.resetAppUrl();
+     * ```
+     */
+    resetAppUrl: () => Promise<void>;
     /**
      * Prompt the user to review the app.
      *

package/dist/integrations/Biometrics/BiometricService.d.ts

@@ -0,0 +1,12 @@
+import { PopulatedSaveUsernameAndPasswordConfiguration, SaveUsernameAndPasswordConfiguration } from "./BiometricsIntegration";
+export declare class BiometricService {
+    static saveConfigurationAndAddMiddlewareToSubmitButton(configurationKey: string, credentialsKey: string, request: SaveUsernameAndPasswordConfiguration): void;
+    static getCredentials(credentialsKey: string): {
+        username: string;
+        password: string;
+    } | null;
+    static removeConfiguration(configurationKey: string): void;
+    static promptForBiometrics(populatedConfiguration: PopulatedSaveUsernameAndPasswordConfiguration): Promise<boolean>;
+    static getPopulatedConfiguration(configurationKey: string): PopulatedSaveUsernameAndPasswordConfiguration;
+    static tryLoginAsync(configurationKey: string): Promise<boolean>;
+}

package/dist/integrations/Biometrics/BiometricsIntegration.d.ts

@@ -4,6 +4,8 @@ export declare class Biometrics extends EventTarget {
     private biometricsIntegration;
     private SECURED_CONTENT_KEY;
     private SECURED_LOGIN_KEY;
+    private BiometricsConfigurationKey;
+    private BiometricsCredentialsKey;
     private defaultScanTitle;
     private defaultScanReason;
     constructor(startiapp: Startiapp);
@@ -61,9 +63,44 @@ export declare class Biometrics extends EventTarget {
      * @returns A promise that resolves when the secured content is successfully removed.
      */
     removeSecuredContent(): Promise<void>;
+    /**
+     * Starts the process of saving a username and password using biometrics.
+     * When logged in successfully, make sure to call {@link endSaveUsernameAndPassword} to save the username and password.
+     *
+     * @param request - The configuration for saving the username and password.
+     */
+    startSaveUsernameAndPassword(request: SaveUsernameAndPasswordConfiguration): Promise<void>;
+    /**
+     * Ends the process of saving a username and password using biometrics.
+     *
+     * @returns A promise that resolves when the username and password are successfully saved.
+     */
+    endSaveUsernameAndPassword(): Promise<void>;
 }
 export type BiometricsAuthenticationType = "None" | "Face" | "Fingerprint";
 export type BiometricsResultReponse<T> = {
     key: string;
     result: T;
 };
+/**
+ * The configuration for saving a username and password using biometrics.
+ * @param usernameInputFieldSelector - The JS selector for the username input field.
+ * @param passwordInputFieldSelector - The JS selector for the password input field.
+ * @param submitButtonSelector - The JS selector for the submit button.
+ * @param title - The title of the biometrics scan.
+ * @param reason - The reason for the biometrics scan.
+ */
+export type SaveUsernameAndPasswordConfiguration = {
+    usernameInputFieldSelector: string;
+    passwordInputFieldSelector: string;
+    submitButtonSelector: string;
+    title: string;
+    reason: string;
+};
+export type PopulatedSaveUsernameAndPasswordConfiguration = SaveUsernameAndPasswordConfiguration & {
+    usernameInputField: HTMLInputElement;
+    passwordInputField: HTMLInputElement;
+    submitButton: HTMLButtonElement;
+} | {
+    error: string;
+};

package/dist/integrations/Location/LocationIntegration.d.ts

@@ -1,8 +1,10 @@
 import { EventTargetWithType } from "../../EventTarget";
 import { Startiapp } from "../../startiapp";
-import { Location as LocationDto, LocationListeningOptions, LocationOptions } from "./types";
+import { GeofenceRegion, Location as LocationDto, LocationListeningOptions, LocationOptions } from "./types";
 export declare class Location extends EventTargetWithType<{
     locationChanged: CustomEvent<LocationDto>;
+    onRegionEntered: CustomEvent<GeofenceRegion>;
+    onRegionExited: CustomEvent<GeofenceRegion>;
 }> {
     private readonly startiapp;
     private locationIntegration;
@@ -30,6 +32,10 @@ export declare class Location extends EventTargetWithType<{
      * Stops the location listener.
      */
     stopLocationListener(): Promise<void>;
+    createGeofence(region: GeofenceRegion): Promise<void>;
+    removeGeofence(region: GeofenceRegion): Promise<void>;
+    getGeofences(): Promise<GeofenceRegion[]>;
     private onListeningFailed;
     private onLocationChanged;
+    private onGeofenceEvent;
 }

package/dist/integrations/Location/types.d.ts

@@ -42,3 +42,18 @@ export declare enum LocationAccuracyDto {
     High = "High",
     Best = "Best"
 }
+export interface Position {
+    latitude: number;
+    longitude: number;
+}
+export interface Distance {
+    totalKilometers: number;
+}
+export interface GeofenceRegion {
+    identifier: string;
+    center: Position;
+    radius: Distance;
+    notifyOnEntry?: boolean;
+    notifyOnExit?: boolean;
+}
+export type GeofenceState = "entered" | "exited" | "unknown";

package/dist/integrations.d.ts

@@ -1,7 +1,7 @@
 import { NavigationSpinnerOptions, RegexDto } from "./integrations/App/typings";
-import { BiometricsAuthenticationType, BiometricsResultReponse } from "./integrations/Biometrics/BiometricsIntegration";
+import { BiometricsAuthenticationType, BiometricsResultReponse, SaveUsernameAndPasswordConfiguration } from "./integrations/Biometrics/BiometricsIntegration";
 import { InApPurchasePurchaseType, InAppPurchaseGetProductResponse, InAppPurchaseProductResponse, InAppPurchaseResponse } from "./integrations/InAppPurchase/InAppPurchaseIntegration";
-import { Location, LocationListeningOptions, LocationOptions } from "./integrations/Location/types";
+import { GeofenceRegion, Location, LocationListeningOptions, LocationOptions } from "./integrations/Location/types";
 import { ListenResponse, NetworkAccess } from "./integrations/Network/NetworkIntegration";
 import { SetStatusBarOptions } from "./startiapp";
 export type PushNotificationIntegration = {
@@ -49,6 +49,7 @@ type AppIntegration = {
     enableScreenRotation(): void;
     addInternalDomain(domain: string): void;
     removeInternalDomain(domain: string): void;
+    getInternalDomains(): void;
     setSafeAreaBackgroundColor(color: string): boolean;
     hideStatusBar(): void;
     showStatusBar(): void;
@@ -70,6 +71,8 @@ type BiometricIntegration = {
     getSecuredContent(key: string, title: string, reason: string): BiometricsResultReponse<string | null>;
     hasSecuredContent(key: string): BiometricsResultReponse<boolean>;
     removeSecuredContent(key: string): void;
+    startSaveUsernameAndPassword(request: SaveUsernameAndPasswordConfiguration): void;
+    endSaveUsernameAndPassword(): void;
 };
 type CalendarIntegration = {
     isAccessGranted(): void;
@@ -113,6 +116,9 @@ type LocationIntegration = {
     startLocationListener(options?: LocationListeningOptions): boolean;
     stopLocationListener(): void;
     isLocationListenerActive(): boolean;
+    createGeofence(region: GeofenceRegion): void;
+    removeGeofence(region: GeofenceRegion): void;
+    getGeofences(): GeofenceRegion[];
 };
 export type Integrations = {
     "AppIntegration": AppIntegration;

package/dist/lib/Storage.d.ts

@@ -0,0 +1,10 @@
+export declare const SessionStorage: {
+    getItem<T>(key: string): T | null;
+    setItem<T>(key: string, value: T): void;
+    removeItem(key: string): void;
+};
+export declare const LocalStorage: {
+    getItem<T>(key: string): T | null;
+    setItem<T>(key: string, value: T): void;
+    removeItem(key: string): void;
+};

package/dist/startiapp.d.ts

@@ -2,6 +2,7 @@ import { App } from "./integrations/App/AppIntegration";
 import { Biometrics } from "./integrations/Biometrics/BiometricsIntegration";
 import { Developer } from "./integrations/Developer/DeveloperIntegration";
 import { InAppPurchase } from "./integrations/InAppPurchase/InAppPurchaseIntegration";
+import { Location } from "./integrations/Location/LocationIntegration";
 import { Network } from "./integrations/Network/NetworkIntegration";
 import { NfcScanner } from "./integrations/NfcScanner/NfcScannerIntegration";
 import { PushNotification } from "./integrations/PushNotification/PushNotificationIntegration";
@@ -21,6 +22,7 @@ export declare class StartiappClass extends EventTarget {
     private readonly appIntegration;
     App: App;
     Share: Share;
+    Location: Location;
     NfcScanner: NfcScanner;
     QrScanner: QrScanner;
     Biometrics: Biometrics;

package/package.json

@@ -2,7 +2,7 @@
   "name": "starti.app",
   "author": "starti.app",
   "license": "MIT",
-  "version": "2.0.35",
+  "version": "2.0.51",
   "description": "Use this package for easy communication with the starti.app API.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",