ali-skills 0.0.21 → 0.0.22

package/node_modules/@ali/cli-skills/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ali/cli-skills",
-  "version": "2.0.21",
+  "version": "2.0.22",
   "description": "The open agent skills ecosystem",
   "type": "module",
   "bin": {
@@ -112,5 +112,8 @@
   "engines": {
     "node": ">=18"
   },
-  "packageManager": "pnpm@10.17.1"
+  "packageManager": "pnpm@10.17.1",
+  "dependencies": {
+    "@ali/o2-open-client": "^0.2.0"
+  }
 }

package/node_modules/@ali/o2-open-client/.editorconfig

@@ -0,0 +1,11 @@
+[*]
+indent_style = space
+end_of_line = lf
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+max_line_length = 0
+trim_trailing_whitespace = false

package/node_modules/@ali/o2-open-client/README.md

@@ -0,0 +1,80 @@
+## 安装
+```
+npm i @ali/o2-open-client
+```
+
+## 使用
+开放接口调用请参考[文档](https://open.o2.alibaba-inc.com/docs/o2)
+### 浏览器端使用
+```
+import { O2Client } from '@ali/o2-open-client/es/browser';
+
+const client = new O2Client({ 
+  // 枚举值 {'daily', 'pre', 'prod'}，默认为 prod
+  env: 'prod',
+  // 请求超时配置，默认10s
+  timeout: 5 * 1000,
+  // 响应格式处理函数，默认实现参考 https://yuque.antfin-inc.com/docs/share/dcdebe27-97cc-4c6d-a65f-7d288241c060#:~:text=%E5%88%A4%E6%96%AD%E5%93%8D%E5%BA%94%E6%98%AF%E5%90%A6%E6%88%90%E5%8A%9F%EF%BC%8C%E5%B9%B6%E6%A0%B9%E6%8D%AE%E5%85%B6%E4%BB%96%E5%AD%97%E6%AE%B5%E8%AE%BE%E7%BD%AE%E7%9B%B8%E5%85%B3%E6%95%B0%E6%8D%AE
+  // 若提供的默认处理不满足，需要调用者在该函数中进行适配
+  resultFormatCallback: (data) => {
+    return data;
+  }
+});
+
+// 初始化client，需传入应用的BUC SSO_TICKET（该应用需与 def-auth 免登）
+client.init('${sso-ticket}');
+
+// client调用
+client.get('/v1.0/work/apps', {name: 'test'});
+```
+
+### Node端使用
+
+基于AK认证的客户端初始化
+```
+import { O2Client } from '@ali/o2-open-client';
+// 需传入AK、SK
+client = new O2Client({
+  // 枚举值 {'pre', 'prod'}，默认为 prod
+  env: 'pre',
+  accessKeyId: 'xxx',
+  accessKeySecret: 'xxx',
+  // 响应格式处理函数，默认实现参考 https://yuque.antfin-inc.com/docs/share/dcdebe27-97cc-4c6d-a65f-7d288241c060#:~:text=%E5%88%A4%E6%96%AD%E5%93%8D%E5%BA%94%E6%98%AF%E5%90%A6%E6%88%90%E5%8A%9F%EF%BC%8C%E5%B9%B6%E6%A0%B9%E6%8D%AE%E5%85%B6%E4%BB%96%E5%AD%97%E6%AE%B5%E8%AE%BE%E7%BD%AE%E7%9B%B8%E5%85%B3%E6%95%B0%E6%8D%AE
+  // 若提供的默认处理不满足，需要调用者在该函数中进行适配
+  resultFormatCallback: (data) => {
+    return data;
+  },
+  // 额外参数，参考 https://web.npm.alibaba-inc.com/package/httpx request()的options参数
+  opts: {
+    timeout: 5000 // 默认超时10s
+  };
+});
+// client调用
+client.get('/v1.0/work/apps', {name: 'test'});
+client.get('/v1.1/work/apps', {name: 'test'});
+```
+
+基于client-token认证的客户端初始化
+```
+import { O2Client } from '@ali/o2-open-client';
+// 需传入token
+client = new O2Client({
+  env: 'prod',
+  token: 'testtoken',
+  // 是否关闭关闭逃逸能力
+  // 关闭后不再初始化 configClient，也不再拉取逃逸相关配置
+  disableEscape: false,
+});
+// client调用
+client.get('/v1.0/work/apps', {name: 'test'});
+```
+
+调用buc认证的接口需要在header中传入SSO_TICKET
+```
+client.get(`/v1.0/work/iterations/1514335/detail`, {}, {
+	SSO_TICKET: 'xxxx'
+});
+client.post('/v1.0/work/aone/issues/search', null, {}, {
+  SSO_TICKET: 'xxx'
+});
+```

package/node_modules/@ali/o2-open-client/abc.json

@@ -0,0 +1,8 @@
+{
+  "assets": {
+    "type": "builder",
+    "builder": {
+      "name": "@ali/builder-component"
+    }
+  }
+}

package/node_modules/@ali/o2-open-client/es/browser/ee.d.ts

@@ -0,0 +1,23 @@
+/**
+ * on(event, listener)：为指定事件注册一个监听器，接受一个字符串 event 和一个回调函数。
+ * emit(event, [arg1], [arg2])： 按监听器的顺序执行执行每个监听器
+ * addListener(event, listener)：on的同名函数（alias）
+ * once(event, listener): 和on类似，但只触发一次，随后便解除事件监听
+ * removeListener(event, listener)： 移除指定事件的某个监听回调
+ * removeAllListeners([event])：移除指定事件的所有监听回调
+ * setMaxListeners(n)：用于提高监听器的默认限制的数量。（默认10监听回调个产生警告）
+ * listeners(event)： 返回指定事件的监听器数组。
+ */
+export declare class EventEmitter {
+    maxListeners: number;
+    events: object;
+    constructor(ops: any);
+    on(event: any, listener: any): void;
+    emit(event: any): void;
+    addListener(event: any, listener: any): void;
+    once(event: any, listener: any): void;
+    removeListener(event: any, listener: any): void;
+    removeAllListeners(event: any): void;
+    setMaxListeners(n: any): void;
+    listeners(event: any): any;
+}

package/node_modules/@ali/o2-open-client/es/browser/ee.js

@@ -0,0 +1,82 @@
+/**
+ * on(event, listener)：为指定事件注册一个监听器，接受一个字符串 event 和一个回调函数。
+ * emit(event, [arg1], [arg2])： 按监听器的顺序执行执行每个监听器
+ * addListener(event, listener)：on的同名函数（alias）
+ * once(event, listener): 和on类似，但只触发一次，随后便解除事件监听
+ * removeListener(event, listener)： 移除指定事件的某个监听回调
+ * removeAllListeners([event])：移除指定事件的所有监听回调
+ * setMaxListeners(n)：用于提高监听器的默认限制的数量。（默认10监听回调个产生警告）
+ * listeners(event)： 返回指定事件的监听器数组。
+ */
+export class EventEmitter {
+    constructor(ops) {
+        this.maxListeners = ops.maxListeners || 100;
+        this.events = {};
+    }
+    on(event, listener) {
+        if (!this.events[event]) {
+            this.events[event] = [listener];
+            return;
+        }
+        this.events[event].push(listener);
+        if (this.events[event].length > this.maxListeners) {
+            console.warn(event + '超出' + this.maxListeners + '监听');
+        }
+    }
+    emit(event) {
+        var params = [].slice.call(arguments);
+        params.shift();
+        if (!this.events[event]) {
+            return;
+        }
+        var originLen = this.listeners(event).length;
+        for (var i = 0; i < this.events[event].length; i++) {
+            this.events[event][i].apply(null, params);
+            if (originLen > this.events[event].length) {
+                // 解决 once执行removeListener函数的时候长度问题导致的event漏执行问题
+                i--;
+                originLen--;
+            }
+        }
+    }
+    addListener(event, listener) {
+        return this.on(event, listener);
+    }
+    once(event, listener) {
+        var self = this;
+        function fn() {
+            var args = [].slice.call(arguments);
+            listener.apply(null, args);
+            self.removeListener(event, fn);
+        }
+        this.on(event, fn);
+    }
+    removeListener(event, listener) {
+        if (!this.events[event]) {
+            return;
+        }
+        var index = this.events[event].indexOf(listener);
+        if (index >= 0) {
+            this.events[event].splice(index, 1);
+        }
+    }
+    removeAllListeners(event) {
+        if (event) {
+            delete this.events[event];
+        }
+        else {
+            this.events = {};
+        }
+    }
+    setMaxListeners(n) {
+        this.maxListeners = n;
+    }
+    listeners(event) {
+        if (this.events[event]) {
+            return this.events[event];
+        }
+        else {
+            return [];
+        }
+    }
+}

package/node_modules/@ali/o2-open-client/es/browser/entry.d.ts

@@ -0,0 +1,32 @@
+/// <reference types="./typings" />
+import { IResponse_DTO } from '../common/format';
+export declare type O2ClientOptions = {
+    timeout?: number;
+    escape?: boolean;
+};
+export declare class O2Client {
+    private endpoint;
+    env: string;
+    timeout: number;
+    resultCallback: Function;
+    private ticket;
+    private count;
+    private isLogin;
+    private queue;
+    private ee;
+    private initError;
+    readyState: Promise<string | Error>;
+    constructor(ops: O2Open.IO2ClientConfig);
+    mockInit(): Promise<void>;
+    init(ticket: string): Promise<this>;
+    private _login;
+    updateTicket(ticket: any): void;
+    private checkState;
+    private handleQueue;
+    private $req;
+    private request;
+    get<T>(path: any, query?: any, headers?: any, options?: O2ClientOptions): Promise<IResponse_DTO<T>>;
+    put<T>(path: any, query: any, body: any, headers: any, options?: O2ClientOptions): Promise<IResponse_DTO<T>>;
+    post<T>(path: any, query: any, body: any, headers: any, options?: O2ClientOptions): Promise<IResponse_DTO<T>>;
+    delete<T>(path: any, query: any, headers: any, options?: O2ClientOptions): Promise<IResponse_DTO<T>>;
+}

package/node_modules/@ali/o2-open-client/es/browser/entry.js

@@ -0,0 +1,306 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+// 基于oapi.alibaba-inc.com的调用
+import { SSO_TICKET, H_REQ_ID, CLIENT_TOKEN } from '../common/constant';
+import { format } from '../common/format';
+import { EventEmitter } from './ee';
+import { CUSTOM_CODE, maybeEscape, saveMetadata, handleHttpInfo, doExc } from './escape';
+const PROD_GW = 'https://oapi.o2.alibaba-inc.com';
+const PRE_GW = 'https://pre-oapi.o2.alibaba-inc.com';
+const DAILY_GW = 'https://oapi-def.taobao.net';
+const PROD_GW_OXS = 'https://oapi-o2.aliyun-inc.com';
+const PRE_GW_OXS = 'https://pre-oapi-o2.aliyun-inc.com';
+export class O2Client {
+    constructor(ops) {
+        var _a;
+        this.env = ops.env || 'prod';
+        this.endpoint = this.env == 'prod' ? PROD_GW : this.env == 'daily' ? DAILY_GW : PRE_GW;
+        if ((_a = ops.opts) === null || _a === void 0 ? void 0 : _a.fromOXS) {
+            // 支持来自 OXS 区的请求
+            this.endpoint = this.env == 'prod' ? PROD_GW_OXS : this.env == 'daily' ? DAILY_GW : PRE_GW_OXS;
+        }
+        // 默认超时10s
+        this.timeout = ops.timeout || 10 * 1000;
+        this.count = 0;
+        // 返回结果处理
+        this.resultCallback = ops.resultFormatCallback;
+        this.isLogin = false;
+        // 记录初始化是否失败
+        this.initError = false;
+        this.queue = [];
+        this.ee = new EventEmitter({});
+        // this.readyState = this.ready();
+    }
+    mockInit() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.isLogin = true;
+            this.count += 1;
+        });
+    }
+    init(ticket) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // 有效期1min
+            this.ticket = ticket;
+            try {
+                // 建立登录态
+                yield this._login();
+                this.isLogin = true;
+                this.ee.emit('loginReady');
+                return this;
+            }
+            catch (e) {
+                this.count = 0;
+                this.initError = true;
+                this.ee.emit('loginError');
+                return Promise.reject(e);
+            }
+        });
+    }
+    // 单点问题
+    _login() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.$req({
+                path: '/v1.0/auth/system/echo',
+                query: {
+                    p: 'q'
+                },
+            }).then((rstArray) => {
+                let rst = rstArray[0];
+                // 网关错误，如认证出错、接口降级、限流等
+                if ((rst && rst.error) || (rst && rst.Code && rst.Message)) {
+                    throw rst;
+                }
+                if (rst && rst.args && rst.args.p == 'q') {
+                    // ok
+                    this.count += 1;
+                }
+                else {
+                    // echo服务挂了，由业务方建立登录态
+                    this.count = 0;
+                }
+            });
+        });
+    }
+    updateTicket(ticket) {
+        this.ticket = ticket;
+        this.count = 0;
+    }
+    checkState() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((res, rej) => {
+                this.ee.once('loginReady', () => {
+                    res(0);
+                });
+                this.ee.once('loginError', () => {
+                    res(1);
+                });
+            });
+        });
+    }
+    handleQueue(number) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let code = yield this.checkState();
+            if (code == 1) {
+                console.error('SDK初始化失败');
+            }
+            const param = this.queue[number];
+            // 已处理
+            if (param.handled) {
+                // console.info('当前任务已处理')
+            }
+            else {
+                param.handled = true;
+                return yield this.request(param.method, param.uriPattern, param.query, param.body, param.headers, param.opts);
+            }
+        });
+    }
+    $req(params) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            let { method, path, query = {}, body, headers = {}, opts } = params;
+            // const systemQs = ['Format', 'SSO_TICKET'];
+            let urlString;
+            let reqTimeout = opts && opts.timeout || this.timeout;
+            const urlObj = new URL(path, this.endpoint);
+            urlObj.searchParams.append('Format', 'json');
+            if (this.count == 0 && this.initError !== true) {
+                urlObj.searchParams.append(SSO_TICKET, this.ticket);
+            }
+            query = Object.assign({}, query);
+            headers = Object.assign({}, headers);
+            let keys = Object.keys(query);
+            if (query && keys.length > 0) {
+                keys.forEach(key => {
+                    if (key && query[key] !== null && query[key] !== undefined) {
+                        urlObj.searchParams.append(key, query[key]);
+                    }
+                });
+            }
+            let userToken = location.host;
+            if (!userToken && ((_a = navigator.userAgent) === null || _a === void 0 ? void 0 : _a.indexOf('o2/')) !== -1) {
+                userToken = 'o2.alibaba-inc.com';
+            }
+            let h = Object.assign({ 'content-type': 'application/json', [CLIENT_TOKEN]: userToken }, headers);
+            if (method != 'GET' && method != 'HEAD') {
+                // formdata上传，无需设置contentType
+                if (body instanceof FormData) {
+                    delete h['content-type'];
+                    delete h['Content-Type'];
+                }
+                else {
+                    body = JSON.stringify(body);
+                }
+            }
+            urlString = urlObj.toString();
+            const errorMessage = `Host: ${this.endpoint} Path: ${path} Method: ${method}`;
+            let resData, requestId, httpcode = 500;
+            try {
+                const startTime = Date.now();
+                resData = yield fetch(urlString, {
+                    method,
+                    body,
+                    headers: h,
+                    credentials: 'include'
+                }).then((res) => {
+                    const headers = res.headers;
+                    const ct = headers.get('content-type');
+                    httpcode = res.status;
+                    requestId = headers.get(H_REQ_ID);
+                    // 判断是否超时
+                    if ((Date.now() - startTime) >= reqTimeout) {
+                        console.error(`[o2-open-client] request timeout error`);
+                        httpcode = CUSTOM_CODE.REQ_TIMEOUT;
+                        return {
+                            error: true,
+                            code: 'REQ_TIMEOUT',
+                            message: `请求超时, ${errorMessage}`
+                        };
+                    }
+                    const errorMessageWithRequestId = `Host: ${this.endpoint} Path: ${path} Method: ${method} RequestId: ${requestId}`;
+                    // 正常响应
+                    if (ct === null || ct === void 0 ? void 0 : ct.startsWith('application/json')) {
+                        // 网关请求成功时保存逃逸元信息
+                        if (httpcode == 200) {
+                            saveMetadata(res);
+                        }
+                        return res.json();
+                    }
+                    console.error(`[o2-open-client] request error, ${errorMessageWithRequestId}`);
+                    // 业务网关透传服务响应
+                    if (ct === null || ct === void 0 ? void 0 : ct.startsWith('text/html')) {
+                        return {
+                            error: true,
+                            code: 'upstream.error',
+                            message: `服务接口出错, ${errorMessage}`
+                        };
+                    }
+                    else {
+                        return {
+                            error: true,
+                            code: 'unknown.error',
+                            message: `系统未知错误, ${errorMessage}`
+                        };
+                    }
+                });
+            }
+            catch (e) {
+                console.error(`[o2-open-client] request error`, e);
+                httpcode = CUSTOM_CODE.OTHER_ERROR;
+                resData = {
+                    error: true,
+                    code: 'NET_ERROR',
+                    message: `网络超时, ${errorMessage}`
+                };
+            }
+            return [resData, requestId, httpcode];
+        });
+    }
+    request(method, uriPattern, query = {}, body = '', headers = {}, opts = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.initError) {
+                console.error('[o2-open-client] 初始化失败，请检查 gatewayConnect方法');
+            }
+            if (!this.initError && !this.isLogin) {
+                let count = this.queue.push({
+                    method,
+                    uriPattern,
+                    query,
+                    body,
+                    headers,
+                    opts,
+                    handled: false
+                });
+                return yield this.handleQueue(count - 1);
+            }
+            const params = {
+                method,
+                path: uriPattern,
+                headers,
+                query,
+                body,
+                opts
+            };
+            let resArray = yield this.$req(params);
+            let resData = resArray[0], reqId = resArray[1], httpCode = resArray[2];
+            // 逃逸
+            if (opts.escape !== false && maybeEscape(httpCode, resData)) {
+                const httpInfo = handleHttpInfo(this.endpoint, uriPattern, query, headers, body, method);
+                if (query && Object.keys(query).length) {
+                    const qs = [];
+                    Object.keys(query).forEach((k) => {
+                        qs.push(`${k}=${query[k]}`);
+                    });
+                    if (uriPattern.indexOf('?') !== -1) {
+                        uriPattern += `&${qs.join('&')}`;
+                    }
+                    else {
+                        uriPattern += `?${qs.join('&')}`;
+                    }
+                }
+                resArray = yield doExc(this.env, uriPattern, {
+                    method,
+                    body: httpInfo.body,
+                    headers: httpInfo.headers,
+                    mode: 'cors'
+                    // credentials: 'include'
+                });
+                if (Array.isArray(resArray)) {
+                    resData = resArray[0],
+                        reqId = resArray[1],
+                        httpCode = resArray[2];
+                }
+            }
+            let res_format;
+            if (this.resultCallback) {
+                res_format = this.resultCallback(resData);
+            }
+            else {
+                res_format = format(resData);
+            }
+            // 针对响应提供rawData
+            res_format.rawData = resData;
+            res_format.requestId = reqId;
+            res_format.httpCode = httpCode;
+            return res_format;
+        });
+    }
+    get(path, query, headers, options) {
+        return this.request('GET', path, query, null, headers, options);
+    }
+    put(path, query, body, headers, options) {
+        return this.request('PUT', path, query, body, headers, options);
+    }
+    post(path, query, body, headers, options) {
+        return this.request('POST', path, query, body, headers, options);
+    }
+    delete(path, query, headers, options) {
+        return this.request('DELETE', path, query, null, headers, options);
+    }
+}

package/node_modules/@ali/o2-open-client/es/browser/escape.d.ts

@@ -0,0 +1,12 @@
+export declare enum CUSTOM_CODE {
+    REQ_TIMEOUT = 1009,
+    OTHER_ERROR = 1010
+}
+export declare function maybeEscape(httpCode: any, resData: any): boolean;
+export declare function handleHttpInfo(host: any, path: any, query: any, headers: any, body: any, method: any): {
+    url: string;
+    headers: any;
+    body: any;
+};
+export declare function saveMetadata(res: any): void;
+export declare function doExc(env: any, uriPattern: any, options: any): Promise<any[]>;