gpt-driver-node 1.0.0 → 1.0.1

package/dist/index.cjs

@@ -442,7 +442,7 @@ async function executeSmartLoop(ctx, params) {
         try {
           globalLogger.debug(`[SmartLoop] Checking cache (Attempt ${attempt + 1}/${maxCacheAttempts})`);
           const cacheResult = await executeFromCache({
-            apiKey: ctx.apiKey,
+            apiKey: ctx.organisationId,
             stepNumber: params.stepNumber,
             stepDescription: params.description,
             screenshot,
@@ -472,7 +472,7 @@ async function executeSmartLoop(ctx, params) {
         anyCacheMiss = true;
         globalLogger.info(`[SmartLoop] Cache Miss. Requesting AI agent...`);
         const agentResponse = await executeAgentStep({
-          apiKey: ctx.apiKey,
+          apiKey: ctx.organisationId,
           base64_screenshot: screenshot,
           instruction: params.instruction,
           action_history: actionHistory
@@ -555,7 +555,7 @@ async function executeSmartLoop(ctx, params) {
           globalLogger.info(`[SmartLoop] Populating cache with ${currentExecutionData.length} frame(s)...`);
           try {
             await populateCache({
-              apiKey: ctx.apiKey,
+              apiKey: ctx.organisationId,
               stepNumber: params.stepNumber,
               stepDescription: params.description,
               executionData: currentExecutionData,
@@ -604,6 +604,7 @@ class GptDriver {
     });
   }
   apiKey;
+  organisationId;
   gptDriverSessionId;
   gptDriverBaseUrl;
   appiumSessionConfig;
@@ -628,6 +629,7 @@ class GptDriver {
    *
    * @param {GptDriverConfig} config - The configuration object for initializing the GptDriver instance. This includes:
    *                                    - `apiKey`: The API key for authenticating requests to the GPT Driver server.
+   *                                    - `organisationId` (optional): The Organisation Identifier for authenticating requests to the GPT Driver Cache Server.
    *                                    - `driver` (optional): An existing WebDriver instance.
    *                                    - `severConfig` (optional): Configuration for the Appium server, including URL and device settings.
    * @throws {Error} If a WebDriver instance is provided without a server URL, or if neither a WebDriver instance nor
@@ -638,6 +640,7 @@ class GptDriver {
   constructor(config) {
     this.testId = config.testId;
     this.apiKey = config.apiKey;
+    this.organisationId = config.organisationId;
     this.buildId = config.buildId;
     this.useGptDriverCloud = config.useGptDriverCloud;
     this.gptDriverBaseUrl = GPT_DRIVER_BASE_URL;
@@ -821,6 +824,9 @@ class GptDriver {
    * This context provides all the callbacks needed by the smart loop executor.
    */
   createSmartLoopContext() {
+    if (!this.organisationId) {
+      throw new Error("Organisation ID is missing, please set it in the GPTDriver constructor");
+    }
     return {
       apiKey: this.apiKey,
       platform: this.appiumSessionConfig?.platform,
@@ -830,7 +836,8 @@ class GptDriver {
       performTap: (x, y) => this.performTap(x, y),
       performScroll: (direction) => this.performScroll(direction),
       performType: (text) => this.performType(text),
-      logCodeExecution: async (screenshot, command) => this.logCodeExecution(screenshot, command)
+      logCodeExecution: async (screenshot, command) => this.logCodeExecution(screenshot, command),
+      organisationId: this.organisationId
     };
   }
   /**

package/dist/index.d.cts

@@ -14,6 +14,7 @@ interface ServerSessionInitConfig {
 interface GptDriverConfig {
     testId?: string;
     apiKey: string;
+    organisationId?: string;
     driver?: WebDriver | Browser;
     serverConfig: {
         device?: ServerSessionInitConfig;
@@ -385,6 +386,7 @@ type SavableTestStore = z.infer<typeof SavableTestStoreSchema>;
 declare class GptDriver {
     private interpolateTemplate;
     private apiKey;
+    private organisationId?;
     private gptDriverSessionId?;
     private gptDriverBaseUrl;
     private appiumSessionConfig?;
@@ -408,6 +410,7 @@ declare class GptDriver {
      *
      * @param {GptDriverConfig} config - The configuration object for initializing the GptDriver instance. This includes:
      *                                    - `apiKey`: The API key for authenticating requests to the GPT Driver server.
+     *                                    - `organisationId` (optional): The Organisation Identifier for authenticating requests to the GPT Driver Cache Server.
      *                                    - `driver` (optional): An existing WebDriver instance.
      *                                    - `severConfig` (optional): Configuration for the Appium server, including URL and device settings.
      * @throws {Error} If a WebDriver instance is provided without a server URL, or if neither a WebDriver instance nor

package/dist/index.mjs

@@ -440,7 +440,7 @@ async function executeSmartLoop(ctx, params) {
         try {
           globalLogger.debug(`[SmartLoop] Checking cache (Attempt ${attempt + 1}/${maxCacheAttempts})`);
           const cacheResult = await executeFromCache({
-            apiKey: ctx.apiKey,
+            apiKey: ctx.organisationId,
             stepNumber: params.stepNumber,
             stepDescription: params.description,
             screenshot,
@@ -470,7 +470,7 @@ async function executeSmartLoop(ctx, params) {
         anyCacheMiss = true;
         globalLogger.info(`[SmartLoop] Cache Miss. Requesting AI agent...`);
         const agentResponse = await executeAgentStep({
-          apiKey: ctx.apiKey,
+          apiKey: ctx.organisationId,
           base64_screenshot: screenshot,
           instruction: params.instruction,
           action_history: actionHistory
@@ -553,7 +553,7 @@ async function executeSmartLoop(ctx, params) {
           globalLogger.info(`[SmartLoop] Populating cache with ${currentExecutionData.length} frame(s)...`);
           try {
             await populateCache({
-              apiKey: ctx.apiKey,
+              apiKey: ctx.organisationId,
               stepNumber: params.stepNumber,
               stepDescription: params.description,
               executionData: currentExecutionData,
@@ -602,6 +602,7 @@ class GptDriver {
     });
   }
   apiKey;
+  organisationId;
   gptDriverSessionId;
   gptDriverBaseUrl;
   appiumSessionConfig;
@@ -626,6 +627,7 @@ class GptDriver {
    *
    * @param {GptDriverConfig} config - The configuration object for initializing the GptDriver instance. This includes:
    *                                    - `apiKey`: The API key for authenticating requests to the GPT Driver server.
+   *                                    - `organisationId` (optional): The Organisation Identifier for authenticating requests to the GPT Driver Cache Server.
    *                                    - `driver` (optional): An existing WebDriver instance.
    *                                    - `severConfig` (optional): Configuration for the Appium server, including URL and device settings.
    * @throws {Error} If a WebDriver instance is provided without a server URL, or if neither a WebDriver instance nor
@@ -636,6 +638,7 @@ class GptDriver {
   constructor(config) {
     this.testId = config.testId;
     this.apiKey = config.apiKey;
+    this.organisationId = config.organisationId;
     this.buildId = config.buildId;
     this.useGptDriverCloud = config.useGptDriverCloud;
     this.gptDriverBaseUrl = GPT_DRIVER_BASE_URL;
@@ -819,6 +822,9 @@ class GptDriver {
    * This context provides all the callbacks needed by the smart loop executor.
    */
   createSmartLoopContext() {
+    if (!this.organisationId) {
+      throw new Error("Organisation ID is missing, please set it in the GPTDriver constructor");
+    }
     return {
       apiKey: this.apiKey,
       platform: this.appiumSessionConfig?.platform,
@@ -828,7 +834,8 @@ class GptDriver {
       performTap: (x, y) => this.performTap(x, y),
       performScroll: (direction) => this.performScroll(direction),
       performType: (text) => this.performType(text),
-      logCodeExecution: async (screenshot, command) => this.logCodeExecution(screenshot, command)
+      logCodeExecution: async (screenshot, command) => this.logCodeExecution(screenshot, command),
+      organisationId: this.organisationId
     };
   }
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gpt-driver-node",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.cts",