@checksum-ai/runtime 1.1.48 → 1.1.50-beta

package/index.d.ts

@@ -22,6 +22,8 @@ type EnumValues<T> = T[keyof T];
 export interface IVariableStore {
   [key: string]: any;
 }
+// backward compatibility
+export type IVariablesStore = IVariableStore;
 
 type ModifyLocatorMethodToChecksumLocator<T> = {
   [K in keyof T]: T[K] extends (...args: any[]) => Locator // Check if the property is a function returning Locator
@@ -219,34 +221,9 @@ export type ChecksumConfig = {
    * Checksum API key
    */
   apiKey: string;
-  /**
-   * Base URL of the tested app (i.e http://staging.example.com)
-   */
-  baseURL: string;
 
   environments?: ChecksumConfigEnvironment[];
 
-  /**
-   * The username/email that will be used
-   * to login into your testing environment
-   */
-  username?: string;
-  /**
-   * The password that will be used
-   * to login into your testing environment
-   */
-  password?: string;
-
-  /**
-   * The credentials of the users that will be used to login into your testing environment
-   */
-  users?: {
-    role: string;
-    username?: string;
-    password?: string;
-    default?: boolean;
-  }[];
-
   /**
    * Checksum runtime options
    */
@@ -268,6 +245,18 @@ export type EnvironmentUser = {
   default?: boolean;
 };
 
+export type ChecksumLoginFunctionParams<PayloadType = any> = {
+  environment: ChecksumConfigEnvironment;
+  user: EnvironmentUser;
+  config: ChecksumConfig;
+  payload?: PayloadType;
+};
+
+export type ChecksumLoginFunction<PayloadType = any> = (
+  page: IChecksumPage,
+  params: ChecksumLoginFunctionParams<PayloadType>
+) => Promise<void>;
+
 export function getLogin(): (
   page: Page,
   { role, environment }?: { role?: string; environment?: string }