lexmount 0.5.10 → 0.5.13

package/README.md

@@ -88,6 +88,7 @@ Create a session with a persistent context:
 
 ```ts
 const context = await client.contexts.create({
+  description: 'Office login context',
   metadata: { userId: '1001' },
 });
 
@@ -142,11 +143,12 @@ Create and inspect contexts:
 
 ```ts
 const context = await client.contexts.create({
+  description: 'Demo context',
   metadata: { owner: 'demo' },
 });
 
 const details = await client.contexts.get(context.id);
-console.log(details.status);
+console.log(details.displayName, details.status);
 ```
 
 Fork an available context into a new context:
@@ -443,6 +445,7 @@ const session = await client.sessions.create({
 
 ```ts
 const context = await client.contexts.create({
+  description: 'Office login context',
   metadata: { userId: '1001' },
 });
 
@@ -497,11 +500,12 @@ const archive = await client.sessions.downloads.archive(session.id);
 
 ```ts
 const context = await client.contexts.create({
+  description: 'Demo context',
   metadata: { owner: 'demo' },
 });
 
 const details = await client.contexts.get(context.id);
-console.log(details.status);
+console.log(details.displayName, details.status);
 ```
 
 基于一个 `available` context 创建新的 fork：

package/dist/index.d.mts

@@ -68,6 +68,14 @@ interface SessionContext {
      * Context access mode.
      */
     mode: ContextAccessMode;
+    /**
+     * Optional context description when passing a ContextInfo-like object.
+     */
+    description?: string | null;
+    /**
+     * Optional display name when passing a ContextInfo-like object.
+     */
+    displayName?: string | null;
 }
 /**
  * Upstream proxy configuration for a session.
@@ -173,6 +181,10 @@ interface SessionCreateOptions {
      * Optional persistent context configuration.
      */
     context?: SessionContext;
+    /**
+     * Optional description for a context created as part of session creation.
+     */
+    contextDescription?: string;
     /**
      * Optional uploaded browser extension identifiers to mount.
      */
@@ -181,6 +193,12 @@ interface SessionCreateOptions {
      * Optional upstream proxy configuration.
      */
     proxy?: SessionProxyConfig;
+    /**
+     * Use the Lexmount official proxy pool for this session.
+     *
+     * Cannot be used together with `proxy`.
+     */
+    officialProxy?: boolean;
     /**
      * Forward weak_lock to the API when creating sessions with read-write contexts.
      */
@@ -242,6 +260,10 @@ interface ContextCreateOptions {
      * Optional metadata used to organize contexts.
      */
     metadata?: ContextMetadata;
+    /**
+     * Optional UTF-8 description used for UI display.
+     */
+    description?: string;
 }
 /**
  * Context list options.
@@ -367,12 +389,19 @@ declare class ContextInfo {
     readonly id: string;
     readonly status: ContextStatus;
     readonly metadata: ContextMetadata;
+    readonly regionId: string | null;
+    readonly region_id: string | null;
+    readonly description: string | null;
+    readonly displayName: string;
     readonly createdAt: string | null;
     readonly updatedAt: string | null;
     constructor(options: {
         id: string;
         status: ContextStatus;
         metadata?: ContextMetadata;
+        regionId?: string | null;
+        description?: string | null;
+        displayName?: string | null;
         createdAt?: string | null;
         updatedAt?: string | null;
     });
@@ -556,6 +585,9 @@ interface SessionInfoOptions {
     apiKey: string;
     projectId: string;
     regionId?: string | null;
+    contextId?: string | null;
+    contextDescription?: string | null;
+    contextDisplayName?: string | null;
     browserType: BrowserMode | string;
     createdAt: string;
     inspectUrl: string;
@@ -574,6 +606,12 @@ declare class SessionInfo {
     readonly projectId: string;
     readonly regionId: string | null;
     readonly region_id: string | null;
+    readonly contextId: string | null;
+    readonly context_id: string | null;
+    readonly contextDescription: string | null;
+    readonly context_description: string | null;
+    readonly contextDisplayName: string | null;
+    readonly context_display_name: string | null;
     readonly browserType: BrowserMode | string;
     readonly createdAt: string;
     readonly inspectUrl: string;
@@ -851,6 +889,6 @@ declare class TimeoutError extends LexmountError {
 /**
  * Lexmount Node.js SDK.
  */
-declare const VERSION = "0.5.10";
+declare const VERSION = "0.5.13";
 
 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

@@ -68,6 +68,14 @@ interface SessionContext {
      * Context access mode.
      */
     mode: ContextAccessMode;
+    /**
+     * Optional context description when passing a ContextInfo-like object.
+     */
+    description?: string | null;
+    /**
+     * Optional display name when passing a ContextInfo-like object.
+     */
+    displayName?: string | null;
 }
 /**
  * Upstream proxy configuration for a session.
@@ -173,6 +181,10 @@ interface SessionCreateOptions {
      * Optional persistent context configuration.
      */
     context?: SessionContext;
+    /**
+     * Optional description for a context created as part of session creation.
+     */
+    contextDescription?: string;
     /**
      * Optional uploaded browser extension identifiers to mount.
      */
@@ -181,6 +193,12 @@ interface SessionCreateOptions {
      * Optional upstream proxy configuration.
      */
     proxy?: SessionProxyConfig;
+    /**
+     * Use the Lexmount official proxy pool for this session.
+     *
+     * Cannot be used together with `proxy`.
+     */
+    officialProxy?: boolean;
     /**
      * Forward weak_lock to the API when creating sessions with read-write contexts.
      */
@@ -242,6 +260,10 @@ interface ContextCreateOptions {
      * Optional metadata used to organize contexts.
      */
     metadata?: ContextMetadata;
+    /**
+     * Optional UTF-8 description used for UI display.
+     */
+    description?: string;
 }
 /**
  * Context list options.
@@ -367,12 +389,19 @@ declare class ContextInfo {
     readonly id: string;
     readonly status: ContextStatus;
     readonly metadata: ContextMetadata;
+    readonly regionId: string | null;
+    readonly region_id: string | null;
+    readonly description: string | null;
+    readonly displayName: string;
     readonly createdAt: string | null;
     readonly updatedAt: string | null;
     constructor(options: {
         id: string;
         status: ContextStatus;
         metadata?: ContextMetadata;
+        regionId?: string | null;
+        description?: string | null;
+        displayName?: string | null;
         createdAt?: string | null;
         updatedAt?: string | null;
     });
@@ -556,6 +585,9 @@ interface SessionInfoOptions {
     apiKey: string;
     projectId: string;
     regionId?: string | null;
+    contextId?: string | null;
+    contextDescription?: string | null;
+    contextDisplayName?: string | null;
     browserType: BrowserMode | string;
     createdAt: string;
     inspectUrl: string;
@@ -574,6 +606,12 @@ declare class SessionInfo {
     readonly projectId: string;
     readonly regionId: string | null;
     readonly region_id: string | null;
+    readonly contextId: string | null;
+    readonly context_id: string | null;
+    readonly contextDescription: string | null;
+    readonly context_description: string | null;
+    readonly contextDisplayName: string | null;
+    readonly context_display_name: string | null;
     readonly browserType: BrowserMode | string;
     readonly createdAt: string;
     readonly inspectUrl: string;
@@ -851,6 +889,6 @@ declare class TimeoutError extends LexmountError {
 /**
  * Lexmount Node.js SDK.
  */
-declare const VERSION = "0.5.10";
+declare const VERSION = "0.5.13";
 
 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

@@ -356,6 +356,12 @@ var SessionInfo = class {
     this.projectId = options.projectId;
     this.regionId = options.regionId ?? null;
     this.region_id = this.regionId;
+    this.contextId = options.contextId ?? null;
+    this.context_id = this.contextId;
+    this.contextDescription = options.contextDescription ?? null;
+    this.context_description = this.contextDescription;
+    this.contextDisplayName = options.contextDisplayName ?? this.contextDescription ?? this.contextId;
+    this.context_display_name = this.contextDisplayName;
     this.browserType = options.browserType;
     this.createdAt = options.createdAt;
     this.inspectUrl = options.inspectUrl;
@@ -576,6 +582,9 @@ var SessionsResource = class {
         mode: normalizeContextMode(options.context.mode)
       };
       payload.context = contextPayload;
+      if (options.contextDescription !== void 0) {
+        payload.context_description = options.contextDescription;
+      }
       getLogger().debug(
         `Creating session with context (id=${options.context.id}, mode=${contextPayload.mode})`
       );
@@ -588,6 +597,12 @@ var SessionsResource = class {
     if (options.proxy) {
       payload.proxy = this.normalizeProxy(options.proxy);
     }
+    if (options.officialProxy) {
+      if (options.proxy) {
+        throw new ValidationError("officialProxy cannot be used together with proxy");
+      }
+      payload.official_proxy = true;
+    }
     if (options.weakLock) {
       payload.weak_lock = true;
     }
@@ -622,6 +637,9 @@ var SessionsResource = class {
       apiKey: this.client.apiKey,
       projectId,
       regionId: createdSession?.regionId ?? this.client.selectedRegion ?? this.client.region ?? null,
+      contextId: createdSession?.contextId ?? options.context?.id ?? null,
+      contextDescription: createdSession?.contextDescription ?? options.context?.description ?? null,
+      contextDisplayName: createdSession?.contextDisplayName ?? options.context?.displayName ?? null,
       browserType: createdSession?.browserType ?? (options.browserMode ?? "normal"),
       createdAt: createdSession?.createdAt ?? (/* @__PURE__ */ new Date()).toISOString(),
       inspectUrl: createdSession?.inspectUrl ?? `${this.client.baseUrl}/inspect?session_id=${sessionId}`,
@@ -662,6 +680,9 @@ var SessionsResource = class {
           apiKey: this.client.apiKey,
           projectId,
           regionId: info.regionId ?? this.client.selectedRegion ?? this.client.region ?? null,
+          contextId: info.contextId ?? options.context?.id ?? null,
+          contextDescription: info.contextDescription ?? options.context?.description ?? null,
+          contextDisplayName: info.contextDisplayName ?? options.context?.displayName ?? null,
           browserType: info.browserType || (options.browserMode ?? "normal"),
           createdAt: info.createdAt,
           inspectUrl: info.inspectUrl,
@@ -926,6 +947,9 @@ var SessionsResource = class {
       apiKey: getString(raw.api_key) ?? this.client.apiKey,
       projectId: getString(raw.project_id) ?? (projectId ?? this.client.projectId),
       regionId: getString(raw.region_id) ?? this.client.selectedRegion ?? this.client.region ?? null,
+      contextId: getString(raw.context_id) ?? null,
+      contextDescription: getString(raw.context_description) ?? null,
+      contextDisplayName: getString(raw.context_display_name) ?? null,
       browserType: getString(raw.browser_type) ?? getString(raw.browser_mode) ?? "normal",
       createdAt: getString(raw.created_at) ?? "",
       inspectUrl: getString(raw.inspect_url) ?? `${this.client.baseUrl}/inspect?session_id=${sessionId}`,
@@ -1126,6 +1150,10 @@ var ContextInfo = class {
     this.id = options.id;
     this.status = options.status;
     this.metadata = options.metadata ?? {};
+    this.regionId = options.regionId ?? null;
+    this.region_id = this.regionId;
+    this.description = options.description ?? null;
+    this.displayName = options.displayName ?? options.description ?? options.id;
     this.createdAt = options.createdAt ?? null;
     this.updatedAt = options.updatedAt ?? null;
   }
@@ -1180,6 +1208,9 @@ var ContextsResource = class {
     if (options.metadata) {
       payload.metadata = options.metadata;
     }
+    if (options.description !== void 0) {
+      payload.description = options.description;
+    }
     const response = await this.client._post(url, payload);
     if (response.status >= 400) {
       this.handleError(response, "create");
@@ -1196,6 +1227,9 @@ var ContextsResource = class {
       id: contextId,
       status: normalizeContextStatus(result.locked),
       metadata: result.metadata ?? options.metadata ?? {},
+      regionId: getString2(result.region_id) ?? null,
+      description: getString2(result.description) ?? null,
+      displayName: getString2(result.display_name) ?? null,
       createdAt: parseTimestamp(result.created_at)
     });
     getLogger().info(`Successfully created context '${context.id}'`);
@@ -1226,7 +1260,10 @@ var ContextsResource = class {
         status: normalizeContextStatus(context.locked),
         createdAt: parseTimestamp(context.created_at),
         updatedAt: parseTimestamp(context.updated_at),
-        metadata: context.metadata ?? {}
+        metadata: context.metadata ?? {},
+        regionId: getString2(context.region_id) ?? null,
+        description: getString2(context.description) ?? null,
+        displayName: getString2(context.display_name) ?? null
       });
     }) : [];
     getLogger().info(`Retrieved ${contexts.length} contexts`);
@@ -1251,6 +1288,9 @@ var ContextsResource = class {
       id: getString2(context.context_id) ?? contextId,
       status: normalizeContextStatus(context.locked),
       metadata: context.metadata ?? {},
+      regionId: getString2(context.region_id) ?? null,
+      description: getString2(context.description) ?? null,
+      displayName: getString2(context.display_name) ?? null,
       createdAt: parseTimestamp(context.created_at),
       updatedAt: parseTimestamp(context.updated_at)
     });
@@ -1282,6 +1322,9 @@ var ContextsResource = class {
       id: forkedContextId,
       status: normalizeContextStatus(result.locked),
       metadata: result.metadata ?? {},
+      regionId: getString2(result.region_id) ?? null,
+      description: getString2(result.description) ?? null,
+      displayName: getString2(result.display_name) ?? null,
       createdAt: parseTimestamp(result.created_at),
       updatedAt: parseTimestamp(result.updated_at)
     });
@@ -1767,7 +1810,7 @@ var Lexmount = class {
 };
 
 // src/index.ts
-var VERSION = "0.5.10";
+var VERSION = "0.5.13";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   APIError,