lexmount 0.5.5 → 0.5.7

package/README.md

@@ -224,6 +224,41 @@ await session.close();
 client.close();
 ```
 
+### Integrated Auth with lexmount-extra
+
+For NTLM or Kerberos integrated auth, install `lexmount-extra` in your
+application and register the callback factories it provides:
+
+```ts
+import { Lexmount, connectOverCDP, registerIntegratedAuthCallback } from 'lexmount';
+import { createKerberosAuthCallback, createNTLMAuthCallback } from 'lexmount-extra';
+
+const client = new Lexmount();
+const session = await client.sessions.create({ browserMode: 'normal' });
+const cdpClient = await connectOverCDP(session);
+
+await registerIntegratedAuthCallback(
+  cdpClient,
+  createNTLMAuthCallback({
+    hostname: 'web.lab.local',
+    domain: 'LAB',
+    username: process.env.LEXMOUNT_NTLM_USERNAME,
+    password: process.env.LEXMOUNT_NTLM_PASSWORD,
+  })
+);
+
+await registerIntegratedAuthCallback(
+  cdpClient,
+  createKerberosAuthCallback({
+    hostname: 'web.lab.test',
+  })
+);
+```
+
+`lexmount-extra` can derive some NTLM and Kerberos defaults from the current
+environment, but explicit callback options are usually clearer for reproducible
+integrations.
+
 ### Error Handling
 
 ```ts
@@ -283,6 +318,7 @@ Generated files are written to `generated-docs/` and are not meant to be committ
 
 Example scripts live in [examples](./examples):
 
+- `auth-basic.ts`
 - `playwright-basic.ts`
 - `session-management.ts`
 - `context-basic.ts`
@@ -299,6 +335,7 @@ Run them with:
 ```bash
 cd examples
 npm install
+npm run auth-basic
 npm run context-fork
 npm run playwright-basic
 npm run session-management
@@ -542,6 +579,40 @@ await session.close();
 client.close();
 ```
 
+### 使用 lexmount-extra 集成认证
+
+如果需要 NTLM 或 Kerberos 集成认证，可以在业务项目中安装 `lexmount-extra`，
+并注册它提供的回调工厂：
+
+```ts
+import { Lexmount, connectOverCDP, registerIntegratedAuthCallback } from 'lexmount';
+import { createKerberosAuthCallback, createNTLMAuthCallback } from 'lexmount-extra';
+
+const client = new Lexmount();
+const session = await client.sessions.create({ browserMode: 'normal' });
+const cdpClient = await connectOverCDP(session);
+
+await registerIntegratedAuthCallback(
+  cdpClient,
+  createNTLMAuthCallback({
+    hostname: 'web.lab.local',
+    domain: 'LAB',
+    username: process.env.LEXMOUNT_NTLM_USERNAME,
+    password: process.env.LEXMOUNT_NTLM_PASSWORD,
+  })
+);
+
+await registerIntegratedAuthCallback(
+  cdpClient,
+  createKerberosAuthCallback({
+    hostname: 'web.lab.test',
+  })
+);
+```
+
+`lexmount-extra` 可以从当前环境推导部分 NTLM/Kerberos 默认值，但显式传入回调
+选项更适合可复现的集成。
+
 ### 错误处理
 
 ```ts
@@ -601,6 +672,7 @@ npm run docs:html
 
 示例脚本位于 [examples](./examples)：
 
+- `auth-basic.ts`
 - `playwright-basic.ts`
 - `session-management.ts`
 - `context-basic.ts`
@@ -617,6 +689,7 @@ npm run docs:html
 ```bash
 cd examples
 npm install
+npm run auth-basic
 npm run context-fork
 npm run playwright-basic
 npm run session-management

package/dist/index.d.mts

@@ -161,6 +161,10 @@ interface SessionCreateOptions {
      * Browser mode to start.
      */
     browserMode?: BrowserMode;
+    /**
+     * Optional custom browser image identifier to use for this session.
+     */
+    customImageId?: string;
     /**
      * Optional persistent context configuration.
      */
@@ -838,6 +842,6 @@ declare class TimeoutError extends LexmountError {
 /**
  * Lexmount Node.js SDK.
  */
-declare const VERSION = "0.5.5";
+declare const VERSION = "0.5.7";
 
 export { APIError, AuthenticationError, type BrowserMode, CDPClient, type CDPEventMessage, type CatalogInfo, type ContextAccessMode, type ContextCreateOptions, ContextInfo, type ContextListOptions, ContextListResponse, ContextLockedError, type ContextMetadata, ContextNotFoundError, type ContextStatus, ContextsResource, ExtensionInfo, type ExtensionInfoShape, type ExtensionListOptions, type ExtensionUploadOptions, ExtensionsResource, type ForceReleaseResponse, type IntegratedAuthCallback, type IntegratedAuthCallbackResult, Lexmount, type LexmountConfig, LexmountError, LexmountLogger, type LogLevel, NetworkError, PaginationInfo, type PaginationInfoShape, type RegionCatalogEntry, type RegionInfo, type SessionContext, type SessionCreateOptions, type SessionCreateResponse, type SessionDeleteOptions, SessionDownloadInfo, type SessionDownloadInfoShape, SessionDownloadsDeleteResponse, type SessionDownloadsDeleteResponseShape, SessionDownloadsListResponse, type SessionDownloadsListResponseShape, SessionDownloadsResource, SessionInfo, type SessionListOptions, SessionListResponse, SessionNotFoundError, type SessionProxyConfig, type SessionStatus, SessionTargetInfo, type SessionTargetInfoShape, SessionsResource, TimeoutError, VERSION, ValidationError, connectOverCDP, Lexmount as default, deregisterIntegratedAuthCallback, disableLogging, enableLogging, getLogger, registerIntegratedAuthCallback, setLogLevel };

package/dist/index.d.ts

@@ -161,6 +161,10 @@ interface SessionCreateOptions {
      * Browser mode to start.
      */
     browserMode?: BrowserMode;
+    /**
+     * Optional custom browser image identifier to use for this session.
+     */
+    customImageId?: string;
     /**
      * Optional persistent context configuration.
      */
@@ -838,6 +842,6 @@ declare class TimeoutError extends LexmountError {
 /**
  * Lexmount Node.js SDK.
  */
-declare const VERSION = "0.5.5";
+declare const VERSION = "0.5.7";
 
 export { APIError, AuthenticationError, type BrowserMode, CDPClient, type CDPEventMessage, type CatalogInfo, type ContextAccessMode, type ContextCreateOptions, ContextInfo, type ContextListOptions, ContextListResponse, ContextLockedError, type ContextMetadata, ContextNotFoundError, type ContextStatus, ContextsResource, ExtensionInfo, type ExtensionInfoShape, type ExtensionListOptions, type ExtensionUploadOptions, ExtensionsResource, type ForceReleaseResponse, type IntegratedAuthCallback, type IntegratedAuthCallbackResult, Lexmount, type LexmountConfig, LexmountError, LexmountLogger, type LogLevel, NetworkError, PaginationInfo, type PaginationInfoShape, type RegionCatalogEntry, type RegionInfo, type SessionContext, type SessionCreateOptions, type SessionCreateResponse, type SessionDeleteOptions, SessionDownloadInfo, type SessionDownloadInfoShape, SessionDownloadsDeleteResponse, type SessionDownloadsDeleteResponseShape, SessionDownloadsListResponse, type SessionDownloadsListResponseShape, SessionDownloadsResource, SessionInfo, type SessionListOptions, SessionListResponse, SessionNotFoundError, type SessionProxyConfig, type SessionStatus, SessionTargetInfo, type SessionTargetInfoShape, SessionsResource, TimeoutError, VERSION, ValidationError, connectOverCDP, Lexmount as default, deregisterIntegratedAuthCallback, disableLogging, enableLogging, getLogger, registerIntegratedAuthCallback, setLogLevel };

package/dist/index.js

@@ -314,6 +314,10 @@ function asRecord(value) {
 function getString(value) {
   return typeof value === "string" ? value : void 0;
 }
+function withRequestedRegion(client, payload) {
+  const regionId = client.selectedRegion ?? client.region;
+  return regionId ? { ...payload, region_id: regionId } : payload;
+}
 function getNumber(value) {
   return typeof value === "number" && Number.isFinite(value) ? value : void 0;
 }
@@ -566,6 +570,9 @@ var SessionsResource = class {
       project_id: options.projectId ?? this.client.projectId,
       browser_mode: options.browserMode ?? "normal"
     };
+    if (options.customImageId) {
+      payload.custom_image_id = options.customImageId;
+    }
     if (options.context) {
       const contextPayload = {
         id: options.context.id,
@@ -588,10 +595,10 @@ var SessionsResource = class {
       payload.weak_lock = true;
     }
     if (options.asyncCreate !== false) {
-      return this.createAsync(payload, options);
+      return this.createAsync(withRequestedRegion(this.client, payload), options);
     }
     const url = `${this.client.baseUrl}/instance`;
-    const response = await this.client._post(url, payload);
+    const response = await this.client._post(url, withRequestedRegion(this.client, payload));
     if (response.status >= 400) {
       this.handleCreateError(response);
     }
@@ -613,6 +620,7 @@ var SessionsResource = class {
       status: createdSession?.status ?? "active",
       apiKey: this.client.apiKey,
       projectId,
+      regionId: createdSession?.regionId ?? this.client.selectedRegion ?? this.client.region ?? null,
       browserType: createdSession?.browserType ?? (options.browserMode ?? "normal"),
       createdAt: createdSession?.createdAt ?? (/* @__PURE__ */ new Date()).toISOString(),
       inspectUrl: createdSession?.inspectUrl ?? `${this.client.baseUrl}/inspect?session_id=${sessionId}`,
@@ -648,6 +656,7 @@ var SessionsResource = class {
           status: "active",
           apiKey: this.client.apiKey,
           projectId,
+          regionId: info.regionId ?? this.client.selectedRegion ?? this.client.region ?? null,
           browserType: info.browserType || (options.browserMode ?? "normal"),
           createdAt: info.createdAt,
           inspectUrl: info.inspectUrl,
@@ -682,11 +691,11 @@ var SessionsResource = class {
    * intentionally uses POST even though the operation is read-only.
    */
   async get(sessionId, projectId) {
-    const response = await this.client._post(`${this.client.baseUrl}/instance/session`, {
+    const response = await this.client._post(`${this.client.baseUrl}/instance/session`, withRequestedRegion(this.client, {
       api_key: this.client.apiKey,
       project_id: projectId ?? this.client.projectId,
       session_id: sessionId
-    });
+    }));
     if (response.status >= 400) {
       this.handleGetError(response, sessionId);
     }
@@ -704,7 +713,7 @@ var SessionsResource = class {
     if (options.status) {
       payload.status = options.status;
     }
-    const response = await this.client._post(url, payload);
+    const response = await this.client._post(url, withRequestedRegion(this.client, payload));
     if (response.status >= 400) {
       this.handleListError(response);
     }
@@ -730,11 +739,11 @@ var SessionsResource = class {
    */
   async delete(options) {
     const url = `${this.client.baseUrl}/instance`;
-    const payload = {
+    const payload = withRequestedRegion(this.client, {
       api_key: this.client.apiKey,
       project_id: options.projectId ?? this.client.projectId,
       session_id: options.sessionId
-    };
+    });
     const response = await this.client._delete(url, payload);
     if (response.status >= 400) {
       this.handleDeleteError(response, options.sessionId);
@@ -1729,7 +1738,7 @@ var Lexmount = class {
 };
 
 // src/index.ts
-var VERSION = "0.5.5";
+var VERSION = "0.5.7";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   APIError,