@tusi-ai/logger 0.0.0-stage → 0.0.1-beta.0

package/README.md

@@ -1,3 +1,43 @@
-# Temporary Holding Version
+# @tusi-ai/logger
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+> 吐司统一日志上报：`aegisV2` 优先 / 伽利略 HTTP 兜底。plugins / services 共用的通用层。
+
+## 用法
+
+```ts
+import { Logger } from '@tusi-ai/logger';
+
+const logger = new Logger({
+  env: 'production',          // 可选，未传回落 production
+  contentPrefix: 'geolocation', // 可选，与内容直接拼接（格式调用方控制）
+  appId: 'xxx',               // 可选，伽利略 ext.tusi_app_id
+  version: '1.0.0',           // 可选，伽利略 ext.tusi_app_version
+  mode: 'preview',            // 可选，伽利略 ext.tusi_mode
+});
+
+logger.error('获取定位失败');
+logger.info('环境判定完成');
+```
+
+## 通道策略
+
+| 通道 | 条件 | 行为 |
+|---|---|---|
+| Aegis V2 | `window.aegisV2` 存在（error/info 齐备，每次调用时判定） | 直接 `aegisV2.error/info(msg)`，env/appId/version/mode 忽略 |
+| 伽利略 HTTP | 无 aegisV2 | axios POST `https://galileotelemetry.tencent.com/collect`，TOPIC `SDK-42a0ae29a90bc4f6a218`，异步不阻塞、失败静默、超时 5s |
+
+## 目录结构
+
+```
+src/
+├── index.ts        # Logger 类与通道逻辑
+├── type/index.ts   # LoggerConfig / AegisV2 / LogLevel
+└── config/index.ts # 端点 / TOPIC / 协议常量
+test/
+└── index.spec.ts
+```
+
+## 硬约束
+
+- 唯一运行时依赖：axios（伽利略兜底上报）
+- 模块顶层无副作用（`sideEffects: false` 为诚实声明）

package/dist/index.cjs

@@ -0,0 +1,124 @@
+'use strict';
+
+var axios = require('axios');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var axios__default = /*#__PURE__*/_interopDefault(axios);
+
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/config/index.ts
+var GALILEO_ENDPOINT = "https://galileotelemetry.tencent.com/collect";
+var TOPIC = "SDK-42a0ae29a90bc4f6a218";
+var SCHEME = "v2";
+var TYPE = "normal";
+var REPORT_TIMEOUT = 5e3;
+var DEFAULT_ENV = "production";
+
+// src/index.ts
+function getAegisV2() {
+  const aegisV2 = window == null ? void 0 : window.aegisV2;
+  if (typeof (aegisV2 == null ? void 0 : aegisV2.error) === "function" && typeof (aegisV2 == null ? void 0 : aegisV2.info) === "function") {
+    return aegisV2;
+  }
+  return void 0;
+}
+function reportToGalileo(level, message, config) {
+  return __async(this, null, function* () {
+    var _a;
+    const fields = JSON.stringify({
+      type: TYPE,
+      level
+    });
+    const ext = JSON.stringify({
+      tusi_app_id: config.appId,
+      tusi_app_version: config.version,
+      tusi_mode: config.mode
+    });
+    const payload = {
+      topic: TOPIC,
+      bean: {
+        env: (_a = config.env) != null ? _a : DEFAULT_ENV
+      },
+      ext,
+      scheme: SCHEME,
+      d2: [
+        {
+          fields,
+          message: [JSON.stringify({ msg: message })],
+          timestamp: Date.now()
+        }
+      ]
+    };
+    try {
+      yield axios__default.default.post(GALILEO_ENDPOINT, JSON.stringify(payload), {
+        headers: {
+          "content-type": "text/plain;charset=UTF-8"
+        },
+        timeout: REPORT_TIMEOUT
+      });
+    } catch (e) {
+    }
+  });
+}
+var Logger = class {
+  /**
+   * 创建日志上报器。
+   *
+   * @param config - 通道配置。不传时环境为 production，且没有内容前缀
+   */
+  constructor(config = {}) {
+    this.config = config;
+  }
+  /**
+   * 上报 info 级日志。
+   *
+   * @param content - 日志正文。已配置 `contentPrefix` 时拼在前面
+   */
+  info(content) {
+    this.report("info", content);
+  }
+  /**
+   * 上报 error 级日志。
+   *
+   * @param content - 日志正文。已配置 `contentPrefix` 时拼在前面
+   */
+  error(content) {
+    this.report("error", content);
+  }
+  report(level, content) {
+    const message = this.formatContent(content);
+    const aegisV2 = getAegisV2();
+    if (aegisV2) {
+      aegisV2[level](message);
+      return;
+    }
+    void reportToGalileo(level, message, this.config);
+  }
+  formatContent(content) {
+    const { contentPrefix } = this.config;
+    return contentPrefix ? `${contentPrefix} ${content}` : content;
+  }
+};
+
+exports.Logger = Logger;

package/dist/index.d.mts

@@ -0,0 +1,81 @@
+/** Logger 构造配置 */
+interface LoggerConfig {
+    /**
+     * 上报环境标识，写入伽利略通道 bean.env（production 进正式环境，其他值进测试环境）；
+     * 未传时回落默认值 production；aegisV2 通道忽略不使用
+     */
+    env?: string;
+    /**
+     * 日志内容前缀，与 content 直接拼接（不加任何修饰，格式由调用方自行控制，
+     * 如传 `'geolocation: '`）；各插件传自己的名字便于在日志平台检索区分来源
+     */
+    contentPrefix?: string;
+    /** 应用 ID（伽利略通道 ext.tusi_app_id；aegisV2 通道忽略不使用） */
+    appId?: string;
+    /** 应用版本（伽利略通道 ext.tusi_app_version） */
+    version?: string;
+    /** 运行模式（伽利略通道 ext.tusi_mode） */
+    mode?: string;
+}
+/** 日志级别 */
+type LogLevel = 'info' | 'error';
+
+/**
+ * @tusi-ai/logger —— 统一日志上报（plugins / services 共用的通用层）
+ *
+ * 通道策略（每次调用时判定，注入时序安全）：
+ * 1. window.aegisV2 存在（Aegis V2 前端监控 SDK，外部脚本注入）→ 直接走 Aegis 上报，
+ *    env / appId / version / mode 不参与，日志前拼 contentPrefix
+ * 2. 否则 → 伽利略可观测平台 HTTP 上报（axios，异步不阻塞、失败静默、超时 5s），
+ *    env 写入 bean.env；appId / version / mode 写入 ext 的 tusi_app_id / tusi_app_version / tusi_mode
+ *
+ * 端点与协议对齐现有实现（app-generator-vite-config/src/utils/logger.ts）：
+ * - https://galileotelemetry.tencent.com/collect，scheme v2，type normal
+ * - TOPIC：SDK-42a0ae29a90bc4f6a218（保持不变）；常量集中定义于 @/config
+ *
+ * 用法：
+ *   const logger = new Logger({
+ *     env: 'production',
+ *     contentPrefix: 'geolocation',
+ *     appId: 'xxx',
+ *     version: '1.0.0',
+ *     mode: 'preview',
+ *   });
+ *   logger.error('获取定位失败');
+ *   logger.info('环境判定完成');
+ */
+
+/**
+ * 统一日志上报器
+ *
+ * @example
+ * ```ts
+ * const logger = new Logger({ env: 'production', contentPrefix: 'geolocation: ', appId: 'app-123', mode: 'preview' });
+ * logger.error('获取定位失败');  // 上报内容：geolocation: 获取定位失败
+ * ```
+ */
+declare class Logger {
+    private readonly config;
+    /**
+     * 创建日志上报器。
+     *
+     * @param config - 通道配置。不传时环境为 production，且没有内容前缀
+     */
+    constructor(config?: LoggerConfig);
+    /**
+     * 上报 info 级日志。
+     *
+     * @param content - 日志正文。已配置 `contentPrefix` 时拼在前面
+     */
+    info(content: string): void;
+    /**
+     * 上报 error 级日志。
+     *
+     * @param content - 日志正文。已配置 `contentPrefix` 时拼在前面
+     */
+    error(content: string): void;
+    private report;
+    private formatContent;
+}
+
+export { type LogLevel, Logger, type LoggerConfig };

package/dist/index.d.ts

@@ -0,0 +1,81 @@
+/** Logger 构造配置 */
+interface LoggerConfig {
+    /**
+     * 上报环境标识，写入伽利略通道 bean.env（production 进正式环境，其他值进测试环境）；
+     * 未传时回落默认值 production；aegisV2 通道忽略不使用
+     */
+    env?: string;
+    /**
+     * 日志内容前缀，与 content 直接拼接（不加任何修饰，格式由调用方自行控制，
+     * 如传 `'geolocation: '`）；各插件传自己的名字便于在日志平台检索区分来源
+     */
+    contentPrefix?: string;
+    /** 应用 ID（伽利略通道 ext.tusi_app_id；aegisV2 通道忽略不使用） */
+    appId?: string;
+    /** 应用版本（伽利略通道 ext.tusi_app_version） */
+    version?: string;
+    /** 运行模式（伽利略通道 ext.tusi_mode） */
+    mode?: string;
+}
+/** 日志级别 */
+type LogLevel = 'info' | 'error';
+
+/**
+ * @tusi-ai/logger —— 统一日志上报（plugins / services 共用的通用层）
+ *
+ * 通道策略（每次调用时判定，注入时序安全）：
+ * 1. window.aegisV2 存在（Aegis V2 前端监控 SDK，外部脚本注入）→ 直接走 Aegis 上报，
+ *    env / appId / version / mode 不参与，日志前拼 contentPrefix
+ * 2. 否则 → 伽利略可观测平台 HTTP 上报（axios，异步不阻塞、失败静默、超时 5s），
+ *    env 写入 bean.env；appId / version / mode 写入 ext 的 tusi_app_id / tusi_app_version / tusi_mode
+ *
+ * 端点与协议对齐现有实现（app-generator-vite-config/src/utils/logger.ts）：
+ * - https://galileotelemetry.tencent.com/collect，scheme v2，type normal
+ * - TOPIC：SDK-42a0ae29a90bc4f6a218（保持不变）；常量集中定义于 @/config
+ *
+ * 用法：
+ *   const logger = new Logger({
+ *     env: 'production',
+ *     contentPrefix: 'geolocation',
+ *     appId: 'xxx',
+ *     version: '1.0.0',
+ *     mode: 'preview',
+ *   });
+ *   logger.error('获取定位失败');
+ *   logger.info('环境判定完成');
+ */
+
+/**
+ * 统一日志上报器
+ *
+ * @example
+ * ```ts
+ * const logger = new Logger({ env: 'production', contentPrefix: 'geolocation: ', appId: 'app-123', mode: 'preview' });
+ * logger.error('获取定位失败');  // 上报内容：geolocation: 获取定位失败
+ * ```
+ */
+declare class Logger {
+    private readonly config;
+    /**
+     * 创建日志上报器。
+     *
+     * @param config - 通道配置。不传时环境为 production，且没有内容前缀
+     */
+    constructor(config?: LoggerConfig);
+    /**
+     * 上报 info 级日志。
+     *
+     * @param content - 日志正文。已配置 `contentPrefix` 时拼在前面
+     */
+    info(content: string): void;
+    /**
+     * 上报 error 级日志。
+     *
+     * @param content - 日志正文。已配置 `contentPrefix` 时拼在前面
+     */
+    error(content: string): void;
+    private report;
+    private formatContent;
+}
+
+export { type LogLevel, Logger, type LoggerConfig };

package/dist/index.js

@@ -0,0 +1,118 @@
+import axios from 'axios';
+
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/config/index.ts
+var GALILEO_ENDPOINT = "https://galileotelemetry.tencent.com/collect";
+var TOPIC = "SDK-42a0ae29a90bc4f6a218";
+var SCHEME = "v2";
+var TYPE = "normal";
+var REPORT_TIMEOUT = 5e3;
+var DEFAULT_ENV = "production";
+
+// src/index.ts
+function getAegisV2() {
+  const aegisV2 = window == null ? void 0 : window.aegisV2;
+  if (typeof (aegisV2 == null ? void 0 : aegisV2.error) === "function" && typeof (aegisV2 == null ? void 0 : aegisV2.info) === "function") {
+    return aegisV2;
+  }
+  return void 0;
+}
+function reportToGalileo(level, message, config) {
+  return __async(this, null, function* () {
+    var _a;
+    const fields = JSON.stringify({
+      type: TYPE,
+      level
+    });
+    const ext = JSON.stringify({
+      tusi_app_id: config.appId,
+      tusi_app_version: config.version,
+      tusi_mode: config.mode
+    });
+    const payload = {
+      topic: TOPIC,
+      bean: {
+        env: (_a = config.env) != null ? _a : DEFAULT_ENV
+      },
+      ext,
+      scheme: SCHEME,
+      d2: [
+        {
+          fields,
+          message: [JSON.stringify({ msg: message })],
+          timestamp: Date.now()
+        }
+      ]
+    };
+    try {
+      yield axios.post(GALILEO_ENDPOINT, JSON.stringify(payload), {
+        headers: {
+          "content-type": "text/plain;charset=UTF-8"
+        },
+        timeout: REPORT_TIMEOUT
+      });
+    } catch (e) {
+    }
+  });
+}
+var Logger = class {
+  /**
+   * 创建日志上报器。
+   *
+   * @param config - 通道配置。不传时环境为 production，且没有内容前缀
+   */
+  constructor(config = {}) {
+    this.config = config;
+  }
+  /**
+   * 上报 info 级日志。
+   *
+   * @param content - 日志正文。已配置 `contentPrefix` 时拼在前面
+   */
+  info(content) {
+    this.report("info", content);
+  }
+  /**
+   * 上报 error 级日志。
+   *
+   * @param content - 日志正文。已配置 `contentPrefix` 时拼在前面
+   */
+  error(content) {
+    this.report("error", content);
+  }
+  report(level, content) {
+    const message = this.formatContent(content);
+    const aegisV2 = getAegisV2();
+    if (aegisV2) {
+      aegisV2[level](message);
+      return;
+    }
+    void reportToGalileo(level, message, this.config);
+  }
+  formatContent(content) {
+    const { contentPrefix } = this.config;
+    return contentPrefix ? `${contentPrefix} ${content}` : content;
+  }
+};
+
+export { Logger };

package/package.json

@@ -1,6 +1,36 @@
 {
   "name": "@tusi-ai/logger",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.1-beta.0",
+  "description": "吐司日志上报工具",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "axios": "^1.19.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit"
+  }
 }