@casual-simulation/aux-vm 2.0.28 → 2.0.29

package/auth/AuxAuth.d.ts

@@ -1,5 +1,45 @@
 import { AuthData } from '@casual-simulation/aux-common';
 import { CreatePublicRecordKeyResult } from '@casual-simulation/aux-records';
+/**
+ * Defines an interface that represents the login state of the user.
+ */
+export interface LoginStatus {
+    /**
+     * Whether the auth services are loading.
+     */
+    isLoading?: boolean;
+    /**
+     * Whether the user is in the process of logging in.
+     */
+    isLoggingIn?: boolean;
+    /**
+     * The auth data for the user.
+     */
+    authData?: AuthData;
+}
+export declare type LoginUIStatus = LoginUINoStatus | LoginUIEmailStatus | LoginUICheckEmailStatus;
+export interface LoginUINoStatus {
+    page: false;
+}
+export interface LoginUIEmailStatus {
+    page: 'enter_email';
+    /**
+     * The page that should be linked to as the terms of service.
+     */
+    termsOfServiceUrl: string;
+    /**
+     * The name of the site that is being logged into.
+     */
+    siteName: string;
+    showAcceptTermsOfServiceError?: boolean;
+    showEnterEmailError?: boolean;
+    showInvalidEmailError?: boolean;
+    errorCode?: string;
+    errorMessage?: string;
+}
+export interface LoginUICheckEmailStatus {
+    page: 'check_email';
+}
 /**
  * Defines an interface for an object that is able to communicate with an authentication service.
  */
@@ -23,5 +63,45 @@ export interface AuxAuth {
      * Gets the auth token for the user.
      */
     getAuthToken(): Promise<string>;
+    /**
+     * Gets the protocol version that this object supports.
+     */
+    getProtocolVersion(): Promise<number>;
+    /**
+     * Requests that the account page or login page (if not authenticated) be opened in a new tab.
+     * Only supported on protocol version 2 or more.
+     */
+    openAccountPage(): Promise<void>;
+    /**
+     * Adds the given function as a callback for login status information.
+     * Only supported on protocol version 2 or more.
+     * @param callback The function that should be called when the login status changes.
+     */
+    addLoginStatusCallback(callback: (status: LoginStatus) => void): Promise<void>;
+    /**
+     * Adds the given function as a callback for login UI status information.
+     * Only supported on protocol version 2 or more.
+     * @param callback The function that should be called when the login UI should change.
+     */
+    addLoginUICallback(callback: (status: LoginUIStatus) => void): Promise<void>;
+    /**
+     * Sets whether a custom user interface should be used for the login process.
+     * If set to true, then there should be at least one callback registered for the login UI.
+     * Only supported on protocol version 2 or more.
+     * @param useCustomUI Whether a custom user interface should be used instead of the new tab login flow.
+     */
+    setUseCustomUI(useCustomUI: boolean): Promise<void>;
+    /**
+     * Specifies the email address and whether the user accepted the terms of service during the login process.
+     * Resolves with a validation result that indicates whether an error occurred and what should be shown to the user.
+     * Only supported on protocol version 2 or more.
+     * @param email The email address that should be used to login.
+     * @param acceptedTermsOfService Whether the user accepted the terms of service.
+     */
+    provideEmailAddress(email: string, acceptedTermsOfService: boolean): Promise<void>;
+    /**
+     * Cancels the in-progress login attempt.
+     */
+    cancelLogin(): Promise<void>;
 }
 //# sourceMappingURL=AuxAuth.d.ts.map

package/managers/AuthHelperInterface.d.ts

@@ -1,10 +1,23 @@
 import { AuthData } from '@casual-simulation/aux-common';
 import { CreatePublicRecordKeyResult } from '@casual-simulation/aux-records';
-import { SubscriptionLike } from 'rxjs';
+import { Observable, SubscriptionLike } from 'rxjs';
+import { LoginStatus, LoginUIStatus } from '../auth/AuxAuth';
 /**
  * Defines an interface for objects that are able to keep track of the user's authentication state.
  */
 export interface AuthHelperInterface extends SubscriptionLike {
+    /**
+     * Gets whether this inst supports authentication.
+     */
+    supportsAuthentication: boolean;
+    /**
+     * Gets an observable that resolves whenever a login status is available.
+     */
+    loginStatus: Observable<LoginStatus>;
+    /**
+     * Gets an observable that resolves whenever the login UI should be updated.
+     */
+    loginUIStatus: Observable<LoginUIStatus>;
     /**
      * Determines whether the user is currently authenticated.
      * Returns true if the user is logged in, false otherwise.
@@ -23,5 +36,24 @@ export interface AuthHelperInterface extends SubscriptionLike {
      * @param recordName The name of the record that the key should be created for.
      */
     createPublicRecordKey(recordName: string): Promise<CreatePublicRecordKeyResult>;
+    /**
+     * Opens the user account page or the login page in a new tab.
+     */
+    openAccountPage(): Promise<void>;
+    /**
+     * Sets whether a custom login UI should be used.
+     * @param useCustomUI Whether the custom login UI should be used.
+     */
+    setUseCustomUI(useCustomUI: boolean): Promise<void>;
+    /**
+     * Provides the given email address and whether the user accepted the terms of service for the login flow.
+     * @param email The email address that the user provided.
+     * @param acceptedTermsOfService Whether the user accepted the terms of service.
+     */
+    provideEmailAddress(email: string, acceptedTermsOfService: boolean): Promise<void>;
+    /**
+     * Cancels the current login if it is using the custom UI flow.
+     */
+    cancelLogin(): Promise<void>;
 }
 //# sourceMappingURL=AuthHelperInterface.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@casual-simulation/aux-vm",
-    "version": "2.0.28",
+    "version": "2.0.29",
     "description": "A set of abstractions required to securely run an AUX.",
     "keywords": [
         "aux"
@@ -40,7 +40,7 @@
         "url": "https://github.com/casual-simulation/casualos/issues"
     },
     "dependencies": {
-        "@casual-simulation/aux-common": "^2.0.28",
+        "@casual-simulation/aux-common": "^2.0.29",
         "@casual-simulation/aux-records": "^2.0.28",
         "@casual-simulation/causal-tree-client-socketio": "^2.0.22",
         "@casual-simulation/causal-trees": "^2.0.22",
@@ -54,5 +54,5 @@
         "rxjs": "^6.5.2",
         "uuid": "^8.3.2"
     },
-    "gitHead": "e1f6accd3dd4725ad13655550bbab3aa200afdb7"
+    "gitHead": "e0c65922931f9a2ac9bda7827460113930a1ad6d"
 }