@larksuiteoapi/node-sdk 1.62.0 → 1.62.1

package/es/index.js

@@ -146,19 +146,21 @@ function getSdkVersion() {
 function sanitizeSource(raw) {
     return raw.replace(/[^a-zA-Z0-9._-]/g, '_').slice(0, 64);
 }
-/**
- * Build the User-Agent value. When `source` is provided it appends a
- * `source/<sanitized>` product token, e.g.
- *     oapi-node-sdk/1.62.0 source/cursor-bot
- * Falsy or all-invalid-char `source` values produce the base UA without
- * the extra token.
- */
-function buildUserAgent(source) {
-    const base = `oapi-node-sdk/${getSdkVersion()}`;
-    if (!source)
-        return base;
-    const clean = sanitizeSource(source);
-    return clean ? `${base} source/${clean}` : base;
+function buildUserAgent(source, opts) {
+    let ua = `oapi-node-sdk/${getSdkVersion()}`;
+    if (source) {
+        const clean = sanitizeSource(source);
+        if (clean)
+            ua += ` source/${clean}`;
+    }
+    if (opts === null || opts === void 0 ? void 0 : opts.extraTags) {
+        for (const t of opts.extraTags) {
+            const clean = sanitizeSource(t);
+            if (clean)
+                ua += ` ${clean}`;
+        }
+    }
+    return ua;
 }
 
 const defaultHttpInstance = axios.create();
@@ -83993,7 +83995,7 @@ class Client extends Client$1 {
         this.appId = params.appId;
         this.appSecret = params.appSecret;
         this.disableTokenCache = params.disableTokenCache;
-        this.userAgent = buildUserAgent(params.source);
+        this.userAgent = buildUserAgent(params.source, { extraTags: params.extraUaTags });
         assert(!this.appId, () => this.logger.error('appId is needed'));
         assert(!this.appSecret, () => this.logger.error('appSecret is needed'));
         this.helpDeskId = params.helpDeskId;
@@ -85362,8 +85364,8 @@ class WSClient {
         /** True if the WS has ever connected successfully in this client's
          *  lifetime — used to distinguish first-connect from reconnect. */
         this.hasEverConnected = false;
-        const { appId, appSecret, agent, domain = Domain.Feishu, httpInstance = defaultHttpInstance, loggerLevel = LoggerLevel.info, logger = defaultLogger, autoReconnect = true, source, onReady, onError, onReconnecting, onReconnected, } = params;
-        this.userAgent = buildUserAgent(source);
+        const { appId, appSecret, agent, domain = Domain.Feishu, httpInstance = defaultHttpInstance, loggerLevel = LoggerLevel.info, logger = defaultLogger, autoReconnect = true, source, extraUaTags, onReady, onError, onReconnecting, onReconnected, } = params;
+        this.userAgent = buildUserAgent(source, { extraTags: extraUaTags });
         this.logger = new LoggerProxy(loggerLevel, logger);
         assert(!appId, () => this.logger.error('appId is needed'));
         assert(!appSecret, () => this.logger.error('appSecret is needed'));
@@ -89328,6 +89330,7 @@ class LarkChannel {
             logger: opts.logger,
             loggerLevel: opts.loggerLevel,
             source: opts.source,
+            extraUaTags: ['channel'],
         });
         this.dispatcher = new EventDispatcher({
             verificationToken: (_d = opts.webhook) === null || _d === void 0 ? void 0 : _d.verificationToken,
@@ -89405,6 +89408,7 @@ class LarkChannel {
                 httpInstance: this.opts.httpInstance,
                 autoReconnect: true,
                 source: this.opts.source,
+                extraUaTags: ['channel'],
                 onReady: () => {
                     if (settled)
                         return;

package/lib/index.js

@@ -164,19 +164,21 @@ function getSdkVersion() {
 function sanitizeSource(raw) {
     return raw.replace(/[^a-zA-Z0-9._-]/g, '_').slice(0, 64);
 }
-/**
- * Build the User-Agent value. When `source` is provided it appends a
- * `source/<sanitized>` product token, e.g.
- *     oapi-node-sdk/1.62.0 source/cursor-bot
- * Falsy or all-invalid-char `source` values produce the base UA without
- * the extra token.
- */
-function buildUserAgent(source) {
-    const base = `oapi-node-sdk/${getSdkVersion()}`;
-    if (!source)
-        return base;
-    const clean = sanitizeSource(source);
-    return clean ? `${base} source/${clean}` : base;
+function buildUserAgent(source, opts) {
+    let ua = `oapi-node-sdk/${getSdkVersion()}`;
+    if (source) {
+        const clean = sanitizeSource(source);
+        if (clean)
+            ua += ` source/${clean}`;
+    }
+    if (opts === null || opts === void 0 ? void 0 : opts.extraTags) {
+        for (const t of opts.extraTags) {
+            const clean = sanitizeSource(t);
+            if (clean)
+                ua += ` ${clean}`;
+        }
+    }
+    return ua;
 }
 
 const defaultHttpInstance = axios__default["default"].create();
@@ -84011,7 +84013,7 @@ class Client extends Client$1 {
         this.appId = params.appId;
         this.appSecret = params.appSecret;
         this.disableTokenCache = params.disableTokenCache;
-        this.userAgent = buildUserAgent(params.source);
+        this.userAgent = buildUserAgent(params.source, { extraTags: params.extraUaTags });
         assert(!this.appId, () => this.logger.error('appId is needed'));
         assert(!this.appSecret, () => this.logger.error('appSecret is needed'));
         this.helpDeskId = params.helpDeskId;
@@ -85380,8 +85382,8 @@ class WSClient {
         /** True if the WS has ever connected successfully in this client's
          *  lifetime — used to distinguish first-connect from reconnect. */
         this.hasEverConnected = false;
-        const { appId, appSecret, agent, domain = exports.Domain.Feishu, httpInstance = defaultHttpInstance, loggerLevel = exports.LoggerLevel.info, logger = defaultLogger, autoReconnect = true, source, onReady, onError, onReconnecting, onReconnected, } = params;
-        this.userAgent = buildUserAgent(source);
+        const { appId, appSecret, agent, domain = exports.Domain.Feishu, httpInstance = defaultHttpInstance, loggerLevel = exports.LoggerLevel.info, logger = defaultLogger, autoReconnect = true, source, extraUaTags, onReady, onError, onReconnecting, onReconnected, } = params;
+        this.userAgent = buildUserAgent(source, { extraTags: extraUaTags });
         this.logger = new LoggerProxy(loggerLevel, logger);
         assert(!appId, () => this.logger.error('appId is needed'));
         assert(!appSecret, () => this.logger.error('appSecret is needed'));
@@ -89346,6 +89348,7 @@ class LarkChannel {
             logger: opts.logger,
             loggerLevel: opts.loggerLevel,
             source: opts.source,
+            extraUaTags: ['channel'],
         });
         this.dispatcher = new EventDispatcher({
             verificationToken: (_d = opts.webhook) === null || _d === void 0 ? void 0 : _d.verificationToken,
@@ -89423,6 +89426,7 @@ class LarkChannel {
                 httpInstance: this.opts.httpInstance,
                 autoReconnect: true,
                 source: this.opts.source,
+                extraUaTags: ['channel'],
                 onReady: () => {
                     if (settled)
                         return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@larksuiteoapi/node-sdk",
-  "version": "1.62.0",
+  "version": "1.62.1",
   "description": "larksuite open sdk for nodejs",
   "keywords": [
     "feishu",

package/types/index.d.ts

@@ -112,6 +112,8 @@ interface IClientParams {
     httpInstance?: HttpInstance;
     /** Caller tag appended to User-Agent as `source/<name>`. */
     source?: string;
+    /** @internal Extra bare tokens appended to User-Agent, set by sub-modules. */
+    extraUaTags?: string[];
 }
 interface IPayload {
     params?: Record<string, any>;
@@ -293052,6 +293054,8 @@ interface IConstructorParams {
     agent?: any;
     /** Caller tag appended to User-Agent as `source/<name>`. */
     source?: string;
+    /** @internal Extra bare tokens appended to User-Agent, set by sub-modules. */
+    extraUaTags?: string[];
     /** Fires once when the first WebSocket handshake succeeds. */
     onReady?: () => void;
     /**