starti.app 2.0.43 → 2.0.52

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

@@ -50,9 +50,43 @@ 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.
@@ -73,7 +107,18 @@ export declare class App extends EventTargetWithType<{
     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>;

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.d.ts

@@ -1,5 +1,5 @@
 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 { GeofenceRegion, Location, LocationListeningOptions, LocationOptions } from "./integrations/Location/types";
 import { ListenResponse, NetworkAccess } from "./integrations/Network/NetworkIntegration";
@@ -71,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;

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/package.json

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