gpt-driver-node 1.0.3 → 1.0.5

package/dist/index.d.cts

@@ -155,21 +155,36 @@ declare const SavableTestStoreSchema: z.ZodObject<{
         id: z.ZodOptional<z.ZodNumber>;
         descriptionText: z.ZodOptional<z.ZodString>;
         optional: z.ZodOptional<z.ZodBoolean>;
+        direction: z.ZodEnum<["left", "right", "up", "down"]>;
+        x1: z.ZodOptional<z.ZodNumber>;
+        y1: z.ZodOptional<z.ZodNumber>;
+        x2: z.ZodOptional<z.ZodNumber>;
+        y2: z.ZodOptional<z.ZodNumber>;
+        duration: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     } & {
         type: z.ZodLiteral<"scroll">;
-        direction: z.ZodEnum<["up", "down"]>;
     }, "strip", z.ZodTypeAny, {
         type: "scroll";
-        direction: "up" | "down";
+        direction: "left" | "right" | "up" | "down";
+        duration: number;
         id?: number | undefined;
         descriptionText?: string | undefined;
         optional?: boolean | undefined;
+        x1?: number | undefined;
+        y1?: number | undefined;
+        x2?: number | undefined;
+        y2?: number | undefined;
     }, {
         type: "scroll";
-        direction: "up" | "down";
+        direction: "left" | "right" | "up" | "down";
         id?: number | undefined;
         descriptionText?: string | undefined;
         optional?: boolean | undefined;
+        x1?: number | undefined;
+        y1?: number | undefined;
+        x2?: number | undefined;
+        y2?: number | undefined;
+        duration?: number | undefined;
     }>, z.ZodObject<{
         id: z.ZodOptional<z.ZodNumber>;
         descriptionText: z.ZodOptional<z.ZodString>;
@@ -259,6 +274,25 @@ declare const SavableTestStoreSchema: z.ZodObject<{
         id: z.ZodOptional<z.ZodNumber>;
         descriptionText: z.ZodOptional<z.ZodString>;
         optional: z.ZodOptional<z.ZodBoolean>;
+    } & {
+        type: z.ZodLiteral<"enter">;
+        delayNextStep: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    }, "strip", z.ZodTypeAny, {
+        type: "enter";
+        delayNextStep: number;
+        id?: number | undefined;
+        descriptionText?: string | undefined;
+        optional?: boolean | undefined;
+    }, {
+        type: "enter";
+        id?: number | undefined;
+        descriptionText?: string | undefined;
+        optional?: boolean | undefined;
+        delayNextStep?: number | undefined;
+    }>, z.ZodObject<{
+        id: z.ZodOptional<z.ZodNumber>;
+        descriptionText: z.ZodOptional<z.ZodString>;
+        optional: z.ZodOptional<z.ZodBoolean>;
     } & {
         type: z.ZodLiteral<"fileRef">;
         path: z.ZodString;
@@ -318,10 +352,15 @@ declare const SavableTestStoreSchema: z.ZodObject<{
         y2?: number | undefined;
     } | {
         type: "scroll";
-        direction: "up" | "down";
+        direction: "left" | "right" | "up" | "down";
+        duration: number;
         id?: number | undefined;
         descriptionText?: string | undefined;
         optional?: boolean | undefined;
+        x1?: number | undefined;
+        y1?: number | undefined;
+        x2?: number | undefined;
+        y2?: number | undefined;
     } | {
         type: "zoom";
         direction: "in" | "out";
@@ -349,6 +388,12 @@ declare const SavableTestStoreSchema: z.ZodObject<{
         id?: number | undefined;
         descriptionText?: string | undefined;
         optional?: boolean | undefined;
+    } | {
+        type: "enter";
+        delayNextStep: number;
+        id?: number | undefined;
+        descriptionText?: string | undefined;
+        optional?: boolean | undefined;
     } | {
         path: string;
         type: "fileRef";
@@ -397,10 +442,15 @@ declare const SavableTestStoreSchema: z.ZodObject<{
         duration?: number | undefined;
     } | {
         type: "scroll";
-        direction: "up" | "down";
+        direction: "left" | "right" | "up" | "down";
         id?: number | undefined;
         descriptionText?: string | undefined;
         optional?: boolean | undefined;
+        x1?: number | undefined;
+        y1?: number | undefined;
+        x2?: number | undefined;
+        y2?: number | undefined;
+        duration?: number | undefined;
     } | {
         type: "zoom";
         direction: "in" | "out";
@@ -428,6 +478,12 @@ declare const SavableTestStoreSchema: z.ZodObject<{
         id?: number | undefined;
         descriptionText?: string | undefined;
         optional?: boolean | undefined;
+    } | {
+        type: "enter";
+        id?: number | undefined;
+        descriptionText?: string | undefined;
+        optional?: boolean | undefined;
+        delayNextStep?: number | undefined;
     } | {
         path: string;
         type: "fileRef";
@@ -456,7 +512,11 @@ declare class GptDriver {
     private step_number;
     private organisationId?;
     private configFilePath?;
+    private _stats_startTime;
+    private _stats_executedSteps;
+    private _stats_cacheHits;
     private globalActionHistory;
+    private pendingLogPromises;
     /**
      * Creates an instance of the GptDriver class.
      *
@@ -500,7 +560,35 @@ declare class GptDriver {
      *
      * @throws {Error} If the request to stop the session fails.
      */
-    setSessionStatus(status: "failed" | "success"): Promise<void>;
+    /**
+     * Marks the current GPTDriver session as succeeded.
+     *
+     * This method stops the session and logs it as "succeeded"
+     *
+     * @throws {Error} If the request to stop the session fails.
+     */
+    setSessionSucceeded(): Promise<void>;
+    /**
+     * Marks the current GPTDriver session as failed.
+     *
+     * This method stops the session and logs it as "failed."
+     *
+     * @throws {Error} If the request to stop the session fails.
+     */
+    setSessionFailed(): Promise<void>;
+    /**
+     * Stops the current GPTDriver session and update its state.
+     *
+     * This method sends a request to the GPT Driver server to stop the session and logs the session status as either "failed" or "success."
+     *
+     * @param {"failed" | "success"} status - Indicates the outcome of the session.
+     *                                         Use "success" if the session completed as expected,
+     *                                         or "failed" if the session encountered an error or issue.
+     *
+     * @throws {Error} If the request to stop the session fails.
+     */
+    setSessionStatus(status: "failed" | "succeeded"): Promise<void>;
+    private printSessionSummary;
     /**
      * Creates a SmartLoopContext for the current session.
      * This context provides all the callbacks needed by the smart loop executor.
@@ -517,6 +605,7 @@ declare class GptDriver {
      */
     private performTap;
     private performType;
+    private performPressEnter;
     private clamp;
     private scaleForIOS;
     private performSwipe;
@@ -641,10 +730,32 @@ declare class GptDriver {
      * If the assertion fails, an error is thrown.
      *
      * @param {string} assertion - The condition to be asserted.
-     * @param cachingMode - The caching mode to be used for the assertion.
+     * @param {Object} options - Optional configuration object
+     * @param {CachingMode} options.cachingMode - The caching mode to be used for the assertion.
+     * @param {boolean} options.useSmartLoop - If true, uses the smart loop execution for optimized caching. Default: false
      * @throws {Error} If the assertion fails.
+     *
+     * @example
+     * // Basic usage
+     * await driver.assert('Login button is visible');
+     *
+     * @example
+     * // With caching mode
+     * await driver.assert('Login button is visible', {
+     *   cachingMode: "FULL_SCREEN"
+     * });
+     *
+     * @example
+     * // With smart loop enabled
+     * await driver.assert('Login button is visible', {
+     *   useSmartLoop: true,
+     *   cachingMode: "FULL_SCREEN"
+     * });
      */
-    assert(assertion: string, cachingMode?: CachingMode): Promise<void>;
+    assert(assertion: string, { cachingMode, useSmartLoop }: {
+        cachingMode?: CachingMode;
+        useSmartLoop?: boolean;
+    }): Promise<void>;
     /**
      * Asserts multiple conditions using the GPTDriver.
      *
@@ -652,10 +763,33 @@ declare class GptDriver {
      * If any assertion fails, an error is thrown listing all failed assertions.
      *
      * @param {string[]} assertions - An array of conditions to be asserted.
-     * @param cachingMode - The caching mode to be used for the assertions.
+     * @param {Object} options - Optional configuration object
+     * @param {CachingMode} options.cachingMode - The caching mode to be used for the assertions.
+     * @param {boolean} options.useSmartLoop - If true, uses the smart loop execution. Default: false
      * @throws {Error} If any of the assertions fail.
+     *
+     * @example
+     * // Basic usage
+     * await driver.assertBulk(['Login button is visible', 'Username field is enabled']);
+     *
+     * @example
+     * // With caching mode
+     * await driver.assertBulk(['Login button is visible'], {
+     *   cachingMode: "FULL_SCREEN"
+     * });
+     *
+     * @example
+     * // With smart loop enabled
+     * await driver.assertBulk(['Login button is visible'], {
+     *   useSmartLoop: true,
+     *   cachingMode: "FULL_SCREEN"
+     * });
      */
-    assertBulk(assertions: Array<string>, cachingMode?: CachingMode): Promise<void>;
+    assertBulk(assertions: Array<string>, { cachingMode, useSmartLoop }: {
+        cachingMode?: CachingMode;
+        useSmartLoop?: boolean;
+        useMiddleLayerAssertFunction?: boolean;
+    }): Promise<void>;
     /**
      * Checks multiple conditions and returns their results using the GPTDriver.
      *
@@ -666,10 +800,26 @@ declare class GptDriver {
      * @param {CachingMode} cachingMode - The caching mode to be used for the conditions.
      * @param {number} maxRetries - The maximum number of retries if any condition fails (default: 2).
      * @param {number} retryDelayMs - The delay in milliseconds between retries (default: 1000).
+     * @param {boolean} useSmartLoop - If true, uses the smart loop execution for optimized caching. Default: false
      * @returns {Promise<Record<string, boolean>>} A promise that resolves with an object mapping each condition
      *                                             to a boolean indicating whether the condition was met.
+     *
+     * @example
+     * // Basic usage
+     * const results = await driver.checkBulk(['Login button is visible', 'Username field is enabled']);
+     * console.log(results); // { 'Login button is visible': true, 'Username field is enabled': false }
+     *
+     * @example
+     * // With smart loop enabled
+     * const results = await driver.checkBulk(
+     *   ['Login button is visible'],
+     *   "FULL_SCREEN",
+     *   2,
+     *   1000,
+     *   true
+     * );
      */
-    checkBulk(conditions: Array<string>, cachingMode?: CachingMode, maxRetries?: number, retryDelayMs?: number): Promise<Record<string, boolean>>;
+    checkBulk(conditions: Array<string>, cachingMode?: CachingMode, maxRetries?: number, retryDelayMs?: number, useSmartLoop?: boolean): Promise<Record<string, boolean>>;
     /**
      * Internal method to check conditions once without retry logic.
      *