@larksuiteoapi/node-sdk 1.30.0 → 1.31.0

package/README.md

@@ -1,5 +1,10 @@
 # Feishu open interface SDK
 
+![GitHub Repo stars](https://img.shields.io/github/stars/larksuite/node-sdk)
+![NPM Downloads](https://img.shields.io/npm/dw/%40larksuiteoapi%2Fnode-sdk)
+![NPM License](https://img.shields.io/npm/l/%40larksuiteoapi%2Fnode-sdk)
+
+
 [中文](https://github.com/larksuite/node-sdk/blob/main/README.zh.md)
 ## Overview
 [Feishu Open Platform](https://open.feishu.cn/document/ukTMukTMukTM/uITNz4iM1MjLyUzM) provides a series of atomic APIs on the server side to realize diversified functions, but the actual coding process is not very smooth: when using these APIs to complete operation, a lot of extra work needs to be considered, such as token acquisition and maintenance, data encryption and decryption, request signature verification, etc.; in the actual coding process, the semantics of function calls are missing, cause mental burden.

package/README.zh.md

@@ -1,4 +1,9 @@
 # 飞书开放接口SDK
+
+![GitHub Repo stars](https://img.shields.io/github/stars/larksuite/node-sdk)
+![NPM Downloads](https://img.shields.io/npm/dw/%40larksuiteoapi%2Fnode-sdk)
+![NPM License](https://img.shields.io/npm/l/%40larksuiteoapi%2Fnode-sdk)
+
 [English](https://github.com/larksuite/node-sdk/blob/main/README.md)
 ## 概述
 [飞书开放平台](https://open.feishu.cn/document/ukTMukTMukTM/uITNz4iM1MjLyUzM)提供了一系列服务端的原子api来实现多元化的功能，但在实际编码过程中感受不是很顺畅，原因在于使用这些api完成功能时，需要考虑很多额外的工作，如token的获取及其维护、数据加解密、请求的验签等等；再者，在实际编码过程中，少了函数调用的语义化描述，类型系统的支持，使得心智负担过重。

package/es/index.js

@@ -58,6 +58,18 @@ function __awaiter(thisArg, _arguments, P, generator) {
     });
 }
 
+function __values(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+}
+
 function __await(v) {
     return this instanceof __await ? (this.v = v, this) : new __await(v);
 }
@@ -74,6 +86,14 @@ function __asyncGenerator(thisArg, _arguments, generator) {
     function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
 }
 
+function __asyncValues(o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+}
+
 typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
     var e = new Error(message);
     return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
@@ -114,6 +134,8 @@ const CAppTicket = Symbol('app-ticket');
 const CTenantAccessToken = Symbol('tenant-access-token');
 const CWithHelpdeskAuthorization = Symbol('with-helpdesk-authorization');
 const CWithUserAccessToken = Symbol('with-user-access-token');
+const CUserAccessToken = Symbol('user-access-token');
+const CAilySessionRecord = Symbol('aily-session-record');
 
 const string2Base64 = (content) => Buffer.from(content).toString('base64');
 
@@ -61111,6 +61133,135 @@ class TokenManager {
     }
 }
 
+const mergeObject = (obj1, obj2) => {
+    const mergedObject = Object.assign({}, obj1);
+    for (let [key, value] of Object.entries(obj2)) {
+        if (value !== undefined) {
+            mergedObject[key] = value;
+        }
+    }
+    return mergedObject;
+};
+
+class UserAccessToken {
+    constructor(params) {
+        this.client = params.client;
+    }
+    getCacheKey(key, options) {
+        const namespace = get(options, 'namespace', this.client.appId);
+        return `${namespace}/${CUserAccessToken.toString()}/${key}`;
+    }
+    // the unit of time is seconds
+    calibrateTime(time) {
+        // Due to the time-consuming network, the time needs to be 3 minutes earlier
+        return new Date().getTime() + (time || 0) * 1000 - 3 * 60 * 1000;
+    }
+    initWithCode(key2Code, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const key2Info = {};
+            for (const [key, code] of Object.entries(key2Code)) {
+                const oidcAccessInfo = yield this.client.authen.oidcAccessToken.create({
+                    data: {
+                        grant_type: 'authorization_code',
+                        code
+                    }
+                });
+                if (oidcAccessInfo.code !== 0) {
+                    // @ts-ignore
+                    this.client.logger.error('init user access token error', key, oidcAccessInfo.msg || oidcAccessInfo.message);
+                    continue;
+                }
+                // code expired
+                if (!oidcAccessInfo.data) {
+                    this.client.logger.error('user access code expired', key, code);
+                    continue;
+                }
+                key2Info[key] = {
+                    code,
+                    token: oidcAccessInfo.data.access_token,
+                    refreshToken: oidcAccessInfo.data.refresh_token,
+                    expiredTime: this.calibrateTime(oidcAccessInfo.data.expires_in)
+                };
+            }
+            yield this.update(key2Info, { namespace: get(options, 'namespace') });
+            return key2Info;
+        });
+    }
+    update(key2Info, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const [key, info] of Object.entries(key2Info)) {
+                const cacheKey = this.getCacheKey(key, { namespace: get(options, 'namespace') });
+                const cacheValue = (yield this.client.cache.get(cacheKey)) || {};
+                const { code, token, refreshToken, expiredTime } = info;
+                const targetValue = mergeObject(cacheValue, { code, token, refreshToken, expiredTime });
+                yield this.client.cache.set(cacheKey, targetValue, Infinity);
+            }
+        });
+    }
+    get(key, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cacheKey = this.getCacheKey(key, { namespace: get(options, 'namespace') });
+            const cacheInfo = yield this.client.cache.get(cacheKey);
+            // cacheInfo是否存在
+            if (!cacheInfo) {
+                this.client.logger.error('user access token needs to be initialized or updated first');
+                return;
+            }
+            const { token, code, refreshToken, expiredTime } = cacheInfo;
+            // step1 token存在且未过期
+            if (token && expiredTime && expiredTime - new Date().getTime() > 0) {
+                return token;
+            }
+            // step2 refresh token存在，刷新token
+            if (refreshToken) {
+                const refreshAccessInfo = yield this.client.authen.oidcRefreshAccessToken.create({
+                    data: {
+                        grant_type: 'refresh_token',
+                        refresh_token: refreshToken
+                    }
+                });
+                if (refreshAccessInfo.code === 0 && refreshAccessInfo.data) {
+                    yield this.update({
+                        key: {
+                            token: refreshAccessInfo.data.access_token,
+                            refreshToken: refreshAccessInfo.data.refresh_token,
+                            expiredTime: this.calibrateTime(refreshAccessInfo.data.expires_in)
+                        }
+                    });
+                    return refreshAccessInfo.data.access_token;
+                }
+                else {
+                    this.client.logger.error('get user access token by refresh token failed.', refreshAccessInfo.msg);
+                    return;
+                }
+            }
+            // step3 code存在的话，用code重新获取
+            if (code) {
+                const oidcAccessInfo = yield this.client.authen.oidcAccessToken.create({
+                    data: {
+                        grant_type: "authorization_code",
+                        code: code
+                    }
+                });
+                if (oidcAccessInfo.code === 0 && oidcAccessInfo.data) {
+                    yield this.update({
+                        key: {
+                            token: oidcAccessInfo.data.access_token,
+                            refreshToken: oidcAccessInfo.data.refresh_token,
+                            expiredTime: this.calibrateTime(oidcAccessInfo.data.expires_in)
+                        }
+                    });
+                }
+                else {
+                    this.client.logger.error('get user access token by code failed.', oidcAccessInfo.msg);
+                }
+            }
+            // step4 重试完毕没结果后，返回undefine
+            return;
+        });
+    }
+}
+
 class Client extends Client$1 {
     constructor(params) {
         super();
@@ -61141,6 +61292,7 @@ class Client extends Client$1 {
             appType: this.appType,
             httpInstance: this.httpInstance,
         });
+        this.userAccessToken = new UserAccessToken({ client: this });
         this.logger.info('client ready');
     }
     formatPayload(payload, options) {
@@ -62744,4 +62896,265 @@ class WSClient {
     }
 }
 
-export { AESCipher, AppType, CAppTicket, CTenantAccessToken, CardActionHandler, Client, Domain, EventDispatcher, LoggerLevel, WSClient, adaptDefault, adaptExpress, adaptKoa, adaptKoaRouter, defaultHttpInstance, generateChallenge, messageCard, withAll, withHelpDeskCredential, withTenantKey, withTenantToken, withUserAccessToken };
+class SessionCache {
+    constructor() {
+        this.sessions = new Map();
+    }
+    set(key, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const sessions = this.sessions.get(key.toString()) || {};
+            const mergedSessions = mergeObject(sessions, value);
+            this.sessions.set(key.toString(), mergedSessions);
+            return true;
+        });
+    }
+    get(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.sessions.get(key.toString());
+        });
+    }
+}
+
+var EExecStatus;
+(function (EExecStatus) {
+    EExecStatus[EExecStatus["ERROR"] = -1] = "ERROR";
+    EExecStatus[EExecStatus["SUCCESS"] = 0] = "SUCCESS";
+    EExecStatus[EExecStatus["EXPIRED"] = 1] = "EXPIRED";
+    EExecStatus[EExecStatus["CANCELLED"] = 2] = "CANCELLED";
+    EExecStatus[EExecStatus["FAILED"] = 3] = "FAILED";
+    EExecStatus[EExecStatus["OTHER"] = 4] = "OTHER";
+})(EExecStatus || (EExecStatus = {}));
+class Aily {
+    constructor(params) {
+        this.completions = {
+            create: this.create.bind(this),
+            createWithStream: this.createWithStream.bind(this),
+            sessionRecords: {
+                get: this.getRecords.bind(this),
+                update: this.updateRecords.bind(this)
+            }
+        };
+        this.client = params.client;
+        this.logger = params.client.logger;
+        this.cache = params.cache || new SessionCache();
+    }
+    getSessionId(params) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const { sessionId, payload, options } = params;
+            const records = yield this.getRecords();
+            if (sessionId && sessionId in records) {
+                return records[sessionId];
+            }
+            const ailySession = yield this.client.aily.v1.ailySession.create({ data: payload }, options);
+            if (ailySession.code === 0 && ailySession.data) {
+                const ailySessionId = (_a = ailySession.data.session) === null || _a === void 0 ? void 0 : _a.id;
+                if (sessionId) {
+                    yield this.updateRecords({ [sessionId]: ailySessionId });
+                }
+                return ailySessionId;
+            }
+            else {
+                this.logger.error('get aily session id error', ailySession.msg);
+                return undefined;
+            }
+        });
+    }
+    waitReply(params, options) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const { sessionId, ailyAppId, message, sessionInfo, messageInfo, runInfo, skillId } = params;
+            // step1 get aily session id
+            const ailySessionId = yield this.getSessionId({ sessionId, payload: sessionInfo, options });
+            if (!ailySessionId) {
+                throw EExecStatus.ERROR;
+            }
+            // step2 create message and run
+            const ailySessionMessage = yield this.client.aily.v1.ailySessionAilyMessage.create({
+                path: {
+                    aily_session_id: ailySessionId
+                },
+                data: Object.assign(Object.assign({}, messageInfo), { content: message, idempotent_id: `${Date.now()}`, content_type: 'MDX' })
+            }, options);
+            if (!(ailySessionMessage.code === 0 && ailySessionMessage.data)) {
+                this.logger.error('create aily message error', ailySessionMessage.msg);
+                throw EExecStatus.ERROR;
+            }
+            const messageId = (_a = ailySessionMessage.data.message) === null || _a === void 0 ? void 0 : _a.id;
+            const ailySessionRun = yield this.client.aily.v1.ailySessionRun.create({
+                path: {
+                    aily_session_id: ailySessionId
+                },
+                data: Object.assign({ app_id: ailyAppId, skill_id: skillId }, runInfo)
+            }, options);
+            if (!(ailySessionRun.code === 0 && ailySessionRun.data)) {
+                this.logger.error('create aily session run error', ailySessionRun.msg);
+                throw EExecStatus.ERROR;
+            }
+            const runId = (_b = ailySessionRun.data.run) === null || _b === void 0 ? void 0 : _b.id;
+            if (!runId) {
+                this.logger.error('run id is empty');
+                throw EExecStatus.ERROR;
+            }
+            // step3 wait run complete
+            const polling = () => __awaiter(this, void 0, void 0, function* () {
+                return new Promise((resolve) => {
+                    setTimeout(() => __awaiter(this, void 0, void 0, function* () {
+                        var _a, _b;
+                        const runStatusInfo = yield this.client.aily.v1.ailySessionRun.get({
+                            path: {
+                                aily_session_id: ailySessionId,
+                                run_id: runId
+                            }
+                        }, options);
+                        if (!(runStatusInfo.code === 0 && runStatusInfo.data)) {
+                            resolve(3);
+                            return;
+                        }
+                        const status = (_b = (_a = runStatusInfo.data) === null || _a === void 0 ? void 0 : _a.run) === null || _b === void 0 ? void 0 : _b.status;
+                        switch (status) {
+                            case 'QUEUED':
+                            case 'IN_PROGRESS': yield (() => __awaiter(this, void 0, void 0, function* () {
+                                const ret = yield polling();
+                                resolve(ret);
+                            }))();
+                            case 'COMPLETED': resolve(EExecStatus.SUCCESS);
+                            case 'EXPIRED': resolve(EExecStatus.EXPIRED);
+                            case 'CANCELLED': resolve(EExecStatus.CANCELLED);
+                            case 'FAILED': resolve(EExecStatus.FAILED);
+                            default: resolve(EExecStatus.OTHER);
+                        }
+                    }), 500);
+                });
+            });
+            const pollingRet = yield polling();
+            if (pollingRet !== EExecStatus.SUCCESS) {
+                this.logger.error('aily run error');
+                throw pollingRet;
+            }
+            return {
+                ailySessionId,
+                runId,
+                messageId
+            };
+        });
+    }
+    create(params, options) {
+        var _a, e_1, _b, _c;
+        var _d;
+        return __awaiter(this, void 0, void 0, function* () {
+            const { ailySessionId, runId } = yield this.waitReply(params, options);
+            let reply;
+            try {
+                for (var _e = true, _f = __asyncValues(yield this.client.aily.v1.ailySessionAilyMessage.listWithIterator({
+                    path: {
+                        aily_session_id: ailySessionId,
+                    },
+                    params: {
+                        run_id: runId,
+                        with_partial_message: false,
+                    }
+                }, options)), _g; _g = yield _f.next(), _a = _g.done, !_a;) {
+                    _c = _g.value;
+                    _e = false;
+                    try {
+                        const items = _c;
+                        if (!items) {
+                            continue;
+                        }
+                        (_d = items === null || items === void 0 ? void 0 : items.messages) === null || _d === void 0 ? void 0 : _d.forEach(message => {
+                            var _a;
+                            if (((_a = message.sender) === null || _a === void 0 ? void 0 : _a.sender_type) === 'ASSISTANT') {
+                                reply = message;
+                            }
+                        });
+                    }
+                    finally {
+                        _e = true;
+                    }
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (!_e && !_a && (_b = _f.return)) yield _b.call(_f);
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+            if (!reply) {
+                this.logger.error('no aily reply');
+                throw EExecStatus.ERROR;
+            }
+            return reply;
+        });
+    }
+    createWithStream(params, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { ailySessionId, runId, messageId } = yield this.waitReply(params, options);
+            const listMessages = () => this.client.aily.v1.ailySessionAilyMessage.listWithIterator({
+                path: {
+                    aily_session_id: ailySessionId,
+                },
+                params: {
+                    run_id: runId,
+                    with_partial_message: true,
+                }
+            }, options);
+            let startOutput = false;
+            const Iterable = {
+                [Symbol.asyncIterator]() {
+                    return __asyncGenerator(this, arguments, function* _a() {
+                        var _b, e_2, _c, _d;
+                        try {
+                            for (var _e = true, _f = __asyncValues(yield __await(listMessages())), _g; _g = yield __await(_f.next()), _b = _g.done, !_b;) {
+                                _d = _g.value;
+                                _e = false;
+                                try {
+                                    const items = _d;
+                                    if (!items) {
+                                        continue;
+                                    }
+                                    for (const message of items.messages || []) {
+                                        if (startOutput) {
+                                            yield yield __await(message);
+                                            if (message.status === 'COMPLETED') {
+                                                return yield __await(void 0);
+                                            }
+                                        }
+                                        else if (message.id === messageId && message.status === 'COMPLETED') {
+                                            startOutput = true;
+                                        }
+                                    }
+                                }
+                                finally {
+                                    _e = true;
+                                }
+                            }
+                        }
+                        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+                        finally {
+                            try {
+                                if (!_e && !_b && (_c = _f.return)) yield __await(_c.call(_f));
+                            }
+                            finally { if (e_2) throw e_2.error; }
+                        }
+                    });
+                }
+            };
+            return Iterable;
+        });
+    }
+    getRecords() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const sessions = (yield this.cache.get(CAilySessionRecord)) || {};
+            return sessions;
+        });
+    }
+    updateRecords(records) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.cache.set(CAilySessionRecord, records);
+        });
+    }
+}
+
+export { AESCipher, Aily, AppType, CAppTicket, CTenantAccessToken, CardActionHandler, Client, Domain, EventDispatcher, LoggerLevel, WSClient, adaptDefault, adaptExpress, adaptKoa, adaptKoaRouter, defaultHttpInstance, generateChallenge, messageCard, withAll, withHelpDeskCredential, withTenantKey, withTenantToken, withUserAccessToken };

package/lib/index.js

@@ -75,6 +75,18 @@ function __awaiter(thisArg, _arguments, P, generator) {
     });
 }
 
+function __values(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+}
+
 function __await(v) {
     return this instanceof __await ? (this.v = v, this) : new __await(v);
 }
@@ -91,6 +103,14 @@ function __asyncGenerator(thisArg, _arguments, generator) {
     function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
 }
 
+function __asyncValues(o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+}
+
 typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
     var e = new Error(message);
     return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
@@ -131,6 +151,8 @@ const CAppTicket = Symbol('app-ticket');
 const CTenantAccessToken = Symbol('tenant-access-token');
 const CWithHelpdeskAuthorization = Symbol('with-helpdesk-authorization');
 const CWithUserAccessToken = Symbol('with-user-access-token');
+const CUserAccessToken = Symbol('user-access-token');
+const CAilySessionRecord = Symbol('aily-session-record');
 
 const string2Base64 = (content) => Buffer.from(content).toString('base64');
 
@@ -61128,6 +61150,135 @@ class TokenManager {
     }
 }
 
+const mergeObject = (obj1, obj2) => {
+    const mergedObject = Object.assign({}, obj1);
+    for (let [key, value] of Object.entries(obj2)) {
+        if (value !== undefined) {
+            mergedObject[key] = value;
+        }
+    }
+    return mergedObject;
+};
+
+class UserAccessToken {
+    constructor(params) {
+        this.client = params.client;
+    }
+    getCacheKey(key, options) {
+        const namespace = get__default["default"](options, 'namespace', this.client.appId);
+        return `${namespace}/${CUserAccessToken.toString()}/${key}`;
+    }
+    // the unit of time is seconds
+    calibrateTime(time) {
+        // Due to the time-consuming network, the time needs to be 3 minutes earlier
+        return new Date().getTime() + (time || 0) * 1000 - 3 * 60 * 1000;
+    }
+    initWithCode(key2Code, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const key2Info = {};
+            for (const [key, code] of Object.entries(key2Code)) {
+                const oidcAccessInfo = yield this.client.authen.oidcAccessToken.create({
+                    data: {
+                        grant_type: 'authorization_code',
+                        code
+                    }
+                });
+                if (oidcAccessInfo.code !== 0) {
+                    // @ts-ignore
+                    this.client.logger.error('init user access token error', key, oidcAccessInfo.msg || oidcAccessInfo.message);
+                    continue;
+                }
+                // code expired
+                if (!oidcAccessInfo.data) {
+                    this.client.logger.error('user access code expired', key, code);
+                    continue;
+                }
+                key2Info[key] = {
+                    code,
+                    token: oidcAccessInfo.data.access_token,
+                    refreshToken: oidcAccessInfo.data.refresh_token,
+                    expiredTime: this.calibrateTime(oidcAccessInfo.data.expires_in)
+                };
+            }
+            yield this.update(key2Info, { namespace: get__default["default"](options, 'namespace') });
+            return key2Info;
+        });
+    }
+    update(key2Info, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const [key, info] of Object.entries(key2Info)) {
+                const cacheKey = this.getCacheKey(key, { namespace: get__default["default"](options, 'namespace') });
+                const cacheValue = (yield this.client.cache.get(cacheKey)) || {};
+                const { code, token, refreshToken, expiredTime } = info;
+                const targetValue = mergeObject(cacheValue, { code, token, refreshToken, expiredTime });
+                yield this.client.cache.set(cacheKey, targetValue, Infinity);
+            }
+        });
+    }
+    get(key, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cacheKey = this.getCacheKey(key, { namespace: get__default["default"](options, 'namespace') });
+            const cacheInfo = yield this.client.cache.get(cacheKey);
+            // cacheInfo是否存在
+            if (!cacheInfo) {
+                this.client.logger.error('user access token needs to be initialized or updated first');
+                return;
+            }
+            const { token, code, refreshToken, expiredTime } = cacheInfo;
+            // step1 token存在且未过期
+            if (token && expiredTime && expiredTime - new Date().getTime() > 0) {
+                return token;
+            }
+            // step2 refresh token存在，刷新token
+            if (refreshToken) {
+                const refreshAccessInfo = yield this.client.authen.oidcRefreshAccessToken.create({
+                    data: {
+                        grant_type: 'refresh_token',
+                        refresh_token: refreshToken
+                    }
+                });
+                if (refreshAccessInfo.code === 0 && refreshAccessInfo.data) {
+                    yield this.update({
+                        key: {
+                            token: refreshAccessInfo.data.access_token,
+                            refreshToken: refreshAccessInfo.data.refresh_token,
+                            expiredTime: this.calibrateTime(refreshAccessInfo.data.expires_in)
+                        }
+                    });
+                    return refreshAccessInfo.data.access_token;
+                }
+                else {
+                    this.client.logger.error('get user access token by refresh token failed.', refreshAccessInfo.msg);
+                    return;
+                }
+            }
+            // step3 code存在的话，用code重新获取
+            if (code) {
+                const oidcAccessInfo = yield this.client.authen.oidcAccessToken.create({
+                    data: {
+                        grant_type: "authorization_code",
+                        code: code
+                    }
+                });
+                if (oidcAccessInfo.code === 0 && oidcAccessInfo.data) {
+                    yield this.update({
+                        key: {
+                            token: oidcAccessInfo.data.access_token,
+                            refreshToken: oidcAccessInfo.data.refresh_token,
+                            expiredTime: this.calibrateTime(oidcAccessInfo.data.expires_in)
+                        }
+                    });
+                }
+                else {
+                    this.client.logger.error('get user access token by code failed.', oidcAccessInfo.msg);
+                }
+            }
+            // step4 重试完毕没结果后，返回undefine
+            return;
+        });
+    }
+}
+
 class Client extends Client$1 {
     constructor(params) {
         super();
@@ -61158,6 +61309,7 @@ class Client extends Client$1 {
             appType: this.appType,
             httpInstance: this.httpInstance,
         });
+        this.userAccessToken = new UserAccessToken({ client: this });
         this.logger.info('client ready');
     }
     formatPayload(payload, options) {
@@ -62761,7 +62913,269 @@ class WSClient {
     }
 }
 
+class SessionCache {
+    constructor() {
+        this.sessions = new Map();
+    }
+    set(key, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const sessions = this.sessions.get(key.toString()) || {};
+            const mergedSessions = mergeObject(sessions, value);
+            this.sessions.set(key.toString(), mergedSessions);
+            return true;
+        });
+    }
+    get(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.sessions.get(key.toString());
+        });
+    }
+}
+
+var EExecStatus;
+(function (EExecStatus) {
+    EExecStatus[EExecStatus["ERROR"] = -1] = "ERROR";
+    EExecStatus[EExecStatus["SUCCESS"] = 0] = "SUCCESS";
+    EExecStatus[EExecStatus["EXPIRED"] = 1] = "EXPIRED";
+    EExecStatus[EExecStatus["CANCELLED"] = 2] = "CANCELLED";
+    EExecStatus[EExecStatus["FAILED"] = 3] = "FAILED";
+    EExecStatus[EExecStatus["OTHER"] = 4] = "OTHER";
+})(EExecStatus || (EExecStatus = {}));
+class Aily {
+    constructor(params) {
+        this.completions = {
+            create: this.create.bind(this),
+            createWithStream: this.createWithStream.bind(this),
+            sessionRecords: {
+                get: this.getRecords.bind(this),
+                update: this.updateRecords.bind(this)
+            }
+        };
+        this.client = params.client;
+        this.logger = params.client.logger;
+        this.cache = params.cache || new SessionCache();
+    }
+    getSessionId(params) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const { sessionId, payload, options } = params;
+            const records = yield this.getRecords();
+            if (sessionId && sessionId in records) {
+                return records[sessionId];
+            }
+            const ailySession = yield this.client.aily.v1.ailySession.create({ data: payload }, options);
+            if (ailySession.code === 0 && ailySession.data) {
+                const ailySessionId = (_a = ailySession.data.session) === null || _a === void 0 ? void 0 : _a.id;
+                if (sessionId) {
+                    yield this.updateRecords({ [sessionId]: ailySessionId });
+                }
+                return ailySessionId;
+            }
+            else {
+                this.logger.error('get aily session id error', ailySession.msg);
+                return undefined;
+            }
+        });
+    }
+    waitReply(params, options) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const { sessionId, ailyAppId, message, sessionInfo, messageInfo, runInfo, skillId } = params;
+            // step1 get aily session id
+            const ailySessionId = yield this.getSessionId({ sessionId, payload: sessionInfo, options });
+            if (!ailySessionId) {
+                throw EExecStatus.ERROR;
+            }
+            // step2 create message and run
+            const ailySessionMessage = yield this.client.aily.v1.ailySessionAilyMessage.create({
+                path: {
+                    aily_session_id: ailySessionId
+                },
+                data: Object.assign(Object.assign({}, messageInfo), { content: message, idempotent_id: `${Date.now()}`, content_type: 'MDX' })
+            }, options);
+            if (!(ailySessionMessage.code === 0 && ailySessionMessage.data)) {
+                this.logger.error('create aily message error', ailySessionMessage.msg);
+                throw EExecStatus.ERROR;
+            }
+            const messageId = (_a = ailySessionMessage.data.message) === null || _a === void 0 ? void 0 : _a.id;
+            const ailySessionRun = yield this.client.aily.v1.ailySessionRun.create({
+                path: {
+                    aily_session_id: ailySessionId
+                },
+                data: Object.assign({ app_id: ailyAppId, skill_id: skillId }, runInfo)
+            }, options);
+            if (!(ailySessionRun.code === 0 && ailySessionRun.data)) {
+                this.logger.error('create aily session run error', ailySessionRun.msg);
+                throw EExecStatus.ERROR;
+            }
+            const runId = (_b = ailySessionRun.data.run) === null || _b === void 0 ? void 0 : _b.id;
+            if (!runId) {
+                this.logger.error('run id is empty');
+                throw EExecStatus.ERROR;
+            }
+            // step3 wait run complete
+            const polling = () => __awaiter(this, void 0, void 0, function* () {
+                return new Promise((resolve) => {
+                    setTimeout(() => __awaiter(this, void 0, void 0, function* () {
+                        var _a, _b;
+                        const runStatusInfo = yield this.client.aily.v1.ailySessionRun.get({
+                            path: {
+                                aily_session_id: ailySessionId,
+                                run_id: runId
+                            }
+                        }, options);
+                        if (!(runStatusInfo.code === 0 && runStatusInfo.data)) {
+                            resolve(3);
+                            return;
+                        }
+                        const status = (_b = (_a = runStatusInfo.data) === null || _a === void 0 ? void 0 : _a.run) === null || _b === void 0 ? void 0 : _b.status;
+                        switch (status) {
+                            case 'QUEUED':
+                            case 'IN_PROGRESS': yield (() => __awaiter(this, void 0, void 0, function* () {
+                                const ret = yield polling();
+                                resolve(ret);
+                            }))();
+                            case 'COMPLETED': resolve(EExecStatus.SUCCESS);
+                            case 'EXPIRED': resolve(EExecStatus.EXPIRED);
+                            case 'CANCELLED': resolve(EExecStatus.CANCELLED);
+                            case 'FAILED': resolve(EExecStatus.FAILED);
+                            default: resolve(EExecStatus.OTHER);
+                        }
+                    }), 500);
+                });
+            });
+            const pollingRet = yield polling();
+            if (pollingRet !== EExecStatus.SUCCESS) {
+                this.logger.error('aily run error');
+                throw pollingRet;
+            }
+            return {
+                ailySessionId,
+                runId,
+                messageId
+            };
+        });
+    }
+    create(params, options) {
+        var _a, e_1, _b, _c;
+        var _d;
+        return __awaiter(this, void 0, void 0, function* () {
+            const { ailySessionId, runId } = yield this.waitReply(params, options);
+            let reply;
+            try {
+                for (var _e = true, _f = __asyncValues(yield this.client.aily.v1.ailySessionAilyMessage.listWithIterator({
+                    path: {
+                        aily_session_id: ailySessionId,
+                    },
+                    params: {
+                        run_id: runId,
+                        with_partial_message: false,
+                    }
+                }, options)), _g; _g = yield _f.next(), _a = _g.done, !_a;) {
+                    _c = _g.value;
+                    _e = false;
+                    try {
+                        const items = _c;
+                        if (!items) {
+                            continue;
+                        }
+                        (_d = items === null || items === void 0 ? void 0 : items.messages) === null || _d === void 0 ? void 0 : _d.forEach(message => {
+                            var _a;
+                            if (((_a = message.sender) === null || _a === void 0 ? void 0 : _a.sender_type) === 'ASSISTANT') {
+                                reply = message;
+                            }
+                        });
+                    }
+                    finally {
+                        _e = true;
+                    }
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (!_e && !_a && (_b = _f.return)) yield _b.call(_f);
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+            if (!reply) {
+                this.logger.error('no aily reply');
+                throw EExecStatus.ERROR;
+            }
+            return reply;
+        });
+    }
+    createWithStream(params, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { ailySessionId, runId, messageId } = yield this.waitReply(params, options);
+            const listMessages = () => this.client.aily.v1.ailySessionAilyMessage.listWithIterator({
+                path: {
+                    aily_session_id: ailySessionId,
+                },
+                params: {
+                    run_id: runId,
+                    with_partial_message: true,
+                }
+            }, options);
+            let startOutput = false;
+            const Iterable = {
+                [Symbol.asyncIterator]() {
+                    return __asyncGenerator(this, arguments, function* _a() {
+                        var _b, e_2, _c, _d;
+                        try {
+                            for (var _e = true, _f = __asyncValues(yield __await(listMessages())), _g; _g = yield __await(_f.next()), _b = _g.done, !_b;) {
+                                _d = _g.value;
+                                _e = false;
+                                try {
+                                    const items = _d;
+                                    if (!items) {
+                                        continue;
+                                    }
+                                    for (const message of items.messages || []) {
+                                        if (startOutput) {
+                                            yield yield __await(message);
+                                            if (message.status === 'COMPLETED') {
+                                                return yield __await(void 0);
+                                            }
+                                        }
+                                        else if (message.id === messageId && message.status === 'COMPLETED') {
+                                            startOutput = true;
+                                        }
+                                    }
+                                }
+                                finally {
+                                    _e = true;
+                                }
+                            }
+                        }
+                        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+                        finally {
+                            try {
+                                if (!_e && !_b && (_c = _f.return)) yield __await(_c.call(_f));
+                            }
+                            finally { if (e_2) throw e_2.error; }
+                        }
+                    });
+                }
+            };
+            return Iterable;
+        });
+    }
+    getRecords() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const sessions = (yield this.cache.get(CAilySessionRecord)) || {};
+            return sessions;
+        });
+    }
+    updateRecords(records) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.cache.set(CAilySessionRecord, records);
+        });
+    }
+}
+
 exports.AESCipher = AESCipher;
+exports.Aily = Aily;
 exports.CAppTicket = CAppTicket;
 exports.CTenantAccessToken = CTenantAccessToken;
 exports.CardActionHandler = CardActionHandler;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@larksuiteoapi/node-sdk",
-  "version": "1.30.0",
+  "version": "1.31.0",
   "description": "larksuite open sdk for nodejs",
   "keywords": [
     "feishu",
@@ -22,7 +22,7 @@
   "scripts": {
     "build": "rm -r lib es types & rollup -c",
     "test": "jest",
-    "test:watch": "jest --watch --testPathPattern=ws-client/__tests__"
+    "test:watch": "jest --watch --testPathPattern=utils/__tests__"
   },
   "author": "mazhe.nerd",
   "license": "MIT",

package/types/index.d.ts

@@ -166065,6 +166065,30 @@ declare class TokenManager {
     }): Promise<any>;
 }
 
+interface ITokenInfo {
+    code?: string;
+    token?: string;
+    refreshToken?: string;
+    expiredTime?: number;
+}
+declare class UserAccessToken {
+    client: Client;
+    constructor(params: {
+        client: Client;
+    });
+    private getCacheKey;
+    private calibrateTime;
+    initWithCode(key2Code: Record<string, string>, options?: {
+        namespace?: string;
+    }): Promise<Record<string, ITokenInfo>>;
+    update(key2Info: Record<string, ITokenInfo>, options?: {
+        namespace?: string;
+    }): Promise<void>;
+    get(key: string, options?: {
+        namespace?: string;
+    }): Promise<any>;
+}
+
 declare class Client extends Client$1 {
     appId: string;
     appSecret: string;
@@ -166077,6 +166101,7 @@ declare class Client extends Client$1 {
     appType: AppType;
     domain: string;
     httpInstance: HttpInstance;
+    userAccessToken: UserAccessToken;
     constructor(params: IClientParams);
     formatPayload(payload?: IPayload, options?: IRequestOptions): Promise<Required<IPayload>>;
     request<T = any>(payload: AxiosRequestConfig, options?: IRequestOptions): Promise<T>;
@@ -171519,4 +171544,104 @@ declare class WSClient {
     }): Promise<void>;
 }
 
-export { AESCipher, AppType, CAppTicket, CTenantAccessToken, Cache, CardActionHandler, Client, Domain, EventDispatcher, IHandles as EventHandles, HttpInstance, HttpRequestOptions, InteractiveCard, InteractiveCardActionEvent, InteractiveCardActionItem, InteractiveCardButtonActionItem, InteractiveCardDatePickerActionItem, InteractiveCardDivElement, InteractiveCardDividerElement, InteractiveCardElement, InteractiveCardField, InteractiveCardImageElement, InteractiveCardImageItem, InteractiveCardLarkMdItem, InteractiveCardMarkdownElement, InteractiveCardNoteElement, InteractiveCardOverflowActionItem, InteractiveCardPlainTextItem, InteractiveCardSelectMenuActionItem, InteractiveCardTextItem, InteractiveCardTitle, InteractiveCardUrlItem, InterfaceCardActionElement, LoggerLevel, WSClient, adaptDefault, adaptExpress, adaptKoa, adaptKoaRouter, defaultHttpInstance, generateChallenge, messageCard, withAll, withHelpDeskCredential, withTenantKey, withTenantToken, withUserAccessToken };
+type TClientInstance = typeof Client extends new (...args: any[]) => infer R ? R : any;
+type TPickParams<T extends (...args: any) => any> = Exclude<Parameters<T>['0'], undefined>;
+type TCreateSessionParams = TPickParams<TClientInstance['aily']['v1']['ailySession']['create']>;
+type TCreateMessageParams = TPickParams<TClientInstance['aily']['v1']['ailySessionAilyMessage']['create']>;
+type TCreateRunParams = TPickParams<TClientInstance['aily']['v1']['ailySessionRun']['create']>;
+interface ICreateParams {
+    sessionId?: string;
+    sessionInfo?: TCreateSessionParams['data'];
+    message: string;
+    messageInfo?: Omit<TCreateMessageParams['data'], 'idempotent_id' | 'content_type' | 'content'>;
+    ailyAppId: string;
+    skillId?: string;
+    runInfo?: Omit<TCreateRunParams['data'], 'app_id' | 'skill_id'>;
+}
+declare class Aily {
+    client: Client;
+    cache: Cache;
+    logger: Logger;
+    constructor(params: {
+        client: Client;
+        cache?: Cache;
+    });
+    private getSessionId;
+    private waitReply;
+    private create;
+    private createWithStream;
+    private getRecords;
+    private updateRecords;
+    completions: {
+        create: (params: ICreateParams, options?: IRequestOptions) => Promise<{
+            id?: string | undefined;
+            session_id?: string | undefined;
+            run_id?: string | undefined;
+            content_type?: string | undefined;
+            content?: string | undefined;
+            files?: {
+                id?: string | undefined;
+                mime_type?: string | undefined;
+                file_name?: string | undefined;
+                metadata?: string | undefined;
+                created_at?: string | undefined;
+            }[] | undefined;
+            quote_message_id?: string | undefined;
+            sender?: {
+                entity_id?: string | undefined;
+                identity_provider?: string | undefined;
+                sender_type?: string | undefined;
+                aily_id?: string | undefined;
+            } | undefined;
+            mentions?: {
+                entity_id?: string | undefined;
+                identity_provider?: string | undefined;
+                key?: string | undefined;
+                name?: string | undefined;
+                aily_id?: string | undefined;
+            }[] | undefined;
+            plain_text?: string | undefined;
+            created_at?: string | undefined;
+            status?: string | undefined;
+        }>;
+        createWithStream: (params: ICreateParams, options?: IRequestOptions) => Promise<{
+            [Symbol.asyncIterator](): AsyncGenerator<{
+                id?: string | undefined;
+                session_id?: string | undefined;
+                run_id?: string | undefined;
+                content_type?: string | undefined;
+                content?: string | undefined;
+                files?: {
+                    id?: string | undefined;
+                    mime_type?: string | undefined;
+                    file_name?: string | undefined;
+                    metadata?: string | undefined;
+                    created_at?: string | undefined;
+                }[] | undefined;
+                quote_message_id?: string | undefined;
+                sender?: {
+                    entity_id?: string | undefined;
+                    identity_provider?: string | undefined;
+                    sender_type?: string | undefined;
+                    aily_id?: string | undefined;
+                } | undefined;
+                mentions?: {
+                    entity_id?: string | undefined;
+                    identity_provider?: string | undefined;
+                    key?: string | undefined;
+                    name?: string | undefined;
+                    aily_id?: string | undefined;
+                }[] | undefined;
+                plain_text?: string | undefined;
+                created_at?: string | undefined;
+                status?: string | undefined;
+            }, void, unknown>;
+        }>;
+        sessionRecords: {
+            get: () => Promise<any>;
+            update: (records: Record<string, string>) => Promise<void>;
+        };
+    };
+}
+
+export { AESCipher, Aily, AppType, CAppTicket, CTenantAccessToken, Cache, CardActionHandler, Client, Domain, EventDispatcher, IHandles as EventHandles, HttpInstance, HttpRequestOptions, InteractiveCard, InteractiveCardActionEvent, InteractiveCardActionItem, InteractiveCardButtonActionItem, InteractiveCardDatePickerActionItem, InteractiveCardDivElement, InteractiveCardDividerElement, InteractiveCardElement, InteractiveCardField, InteractiveCardImageElement, InteractiveCardImageItem, InteractiveCardLarkMdItem, InteractiveCardMarkdownElement, InteractiveCardNoteElement, InteractiveCardOverflowActionItem, InteractiveCardPlainTextItem, InteractiveCardSelectMenuActionItem, InteractiveCardTextItem, InteractiveCardTitle, InteractiveCardUrlItem, InterfaceCardActionElement, LoggerLevel, WSClient, adaptDefault, adaptExpress, adaptKoa, adaptKoaRouter, defaultHttpInstance, generateChallenge, messageCard, withAll, withHelpDeskCredential, withTenantKey, withTenantToken, withUserAccessToken };