@snack-kit/lib 0.3.0 → 0.5.0

package/dist/types/http.d.ts

@@ -1,200 +1,6 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
-
-/**
- * HTTP 请求配置，扩展自 AxiosRequestConfig
- */
-interface HttpRequestConfig<D = unknown> extends AxiosRequestConfig<D> {
-    /** Context key，自动从 HttpContext 获取 baseURL */
-    ctx?: string;
-    /** 自定义请求 ID，用于主动取消 */
-    cancelId?: string;
-    /** 回调接收生成的 cancelId */
-    onCancelId?: (id: string) => void;
-    /**
-     * 是否添加时间戳防缓存，默认 false（添加防缓存时间戳）
-     * 设为 true 时不添加时间戳
-     */
-    cache?: boolean;
-}
-/**
- * HTTP 请求结果，扩展自 AxiosResponse
- */
-interface HttpResult<T = unknown> extends Partial<AxiosResponse<T>> {
-    /** 有 error 则请求失败，无 error 则成功 */
-    error?: HttpError;
-}
-/**
- * HTTP 错误信息
- */
-interface HttpError {
-    /** HTTP 状态码 */
-    status?: number;
-    /** 错误描述 */
-    message: string;
-    /** 服务端返回的原始错误体 */
-    data?: unknown;
-}
-/**
- * 网关 `/ngw/context` 接口返回的元数据（`$info` 字段）
- */
-interface ContextInfo {
-    /** 网关版本号，例如 `"4.6.2-r10"` */
-    version: string;
-    /** 网关域名，例如 `"http://172.16.32.155:20000"` */
-    domain: string;
-    /** 客户端标识 */
-    client: string;
-    /** 当前语言 */
-    lang: string;
-}
-/**
- * 网关 `/web-debug/host/list` 接口返回的服务列表项
- */
-interface ServerItem {
-    /** 服务唯一标识 */
-    key: string;
-    /** 服务名称 */
-    name: string;
-    /** 服务类型分组，可为空字符串 */
-    type: string;
-    /** 服务地址，用于 `context.load()` 切换路由映射 */
-    origin: string;
-    /** 代理配置（由网关管理，前端只读） */
-    proxyInfo: Record<string, unknown>;
-}
-
-/**
- * 管理服务地址映射的上下文单例
- *
- * 支持两种加载方式：
- * - **远程加载**：传入网关 URL，自动请求 `GET /ngw/context` 获取映射表
- * - **本地注入**：直接传入键值对象
- *
- * @example 远程加载
- * ```ts
- * import { Context } from '@snack-kit/lib/http'
- *
- * await Context.load('http://172.16.32.155:20000')
- * Context.get('ngw')   // 'http://172.16.32.155:20000/ngw'
- * Context.info         // { version: '4.6.2-r10', domain: '...', ... }
- * ```
- *
- * @example 本地注入
- * ```ts
- * await Context.load({
- *   'user-svc': 'http://user.api.com',
- *   'order-svc': 'http://order.api.com',
- * })
- * ```
- */
-declare class HttpContext {
-    private _store;
-    private _loaded;
-    private _info;
-    /**
-     * 加载服务地址映射
-     *
-     * 远程加载时，响应中的 `$info` 元数据字段会被单独存储，不计入路由映射表。
-     *
-     * @param source 远程加载传入网关 URL；本地注入传入键值对象
-     * @param timeout 远程加载超时（ms），默认 5000
-     *
-     * @example 远程加载
-     * ```ts
-     * await Context.load('http://172.16.32.155:20000', 3000)
-     * ```
-     *
-     * @example 本地注入
-     * ```ts
-     * await Context.load({ 'user-svc': 'http://user.api.com' })
-     * ```
-     */
-    load(source: string | Record<string, string>, timeout?: number): Promise<void>;
-    /**
-     * 获取指定 ctx key 对应的服务地址
-     * @param key ctx key，例如 `'ngw'`、`'osc'`
-     * @returns 服务地址，未找到时返回空字符串
-     *
-     * @example
-     * ```ts
-     * await Context.load('http://172.16.32.155:20000')
-     * Context.get('osc')  // 'http://172.16.32.155:20000/osc'
-     * Context.get('none') // ''
-     * ```
-     */
-    get(key: string): string;
-    /**
-     * 网关元数据（仅远程加载后可用）
-     *
-     * @example
-     * ```ts
-     * await Context.load('http://172.16.32.155:20000')
-     * Context.info?.version // '4.6.2-r10'
-     * Context.info?.domain  // 'http://172.16.32.155:20000'
-     * ```
-     */
-    get info(): ContextInfo | undefined;
-    /**
-     * Context 是否已加载
-     *
-     * @example
-     * ```ts
-     * Context.loaded // false
-     * await Context.load({ 'user-svc': 'http://user.api.com' })
-     * Context.loaded // true
-     * ```
-     */
-    get loaded(): boolean;
-    /**
-     * 清空所有映射并重置加载状态
-     *
-     * @example
-     * ```ts
-     * Context.clear()
-     * Context.loaded // false
-     * ```
-     */
-    clear(): void;
-}
-/**
- * HttpContext 全局单例
- *
- * @example
- * ```ts
- * import { Context } from '@snack-kit/lib/http'
- *
- * await Context.load('http://172.16.32.155:20000')
- * Context.get('osc') // 'http://172.16.32.155:20000/osc'
- * ```
- */
-declare const Context: HttpContext;
-/**
- * 当前页面的 origin（`protocol + host`）
- *
- * 在非浏览器环境（如 SSR/Node）返回空字符串。
- *
- * @example
- * ```ts
- * import { Origin } from '@snack-kit/lib/http'
- * // 浏览器中：'https://app.example.com'
- * // Node 环境：''
- * ```
- */
-declare const Origin: string;
-/**
- * 当前页面路径的首段，可直接用作 `ctx` 参数
- *
- * 例如 `/osc/employee` → `'osc'`，在非浏览器环境返回空字符串。
- *
- * @example
- * ```ts
- * import { Ctx, Get } from '@snack-kit/lib/http'
- *
- * // 当前路径为 /osc/... 时，Ctx === 'osc'
- * const result = await Get('/employee', { ctx: Ctx })
- * ```
- */
-declare const Ctx: string;
+import { d as HttpMethodConfig, f as HttpResult, e as HttpRequestConfig } from './context-C4dFUDbw.js';
+export { C as Context, a as ContextInfo, b as Ctx, H as HttpContext, c as HttpError, O as Origin, S as ServerItem } from './context-C4dFUDbw.js';
+export { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponse, default as axios } from 'axios';
 
 /**
  * 取消指定 id 的请求并从注册表移除
@@ -264,92 +70,111 @@ declare function Request<T>(config: HttpRequestConfig): Promise<HttpResult<T>>;
 /**
  * 发起 GET 请求
  *
- * @param url 请求地址
- * @param config 请求配置
+ * 支持两种调用方式：
+ * - `Get(url, config?)` — 位置参数形式
+ * - `Get(config)` — 纯配置对象形式（`method` 已预置，无需传入）
  *
- * @example
+ * @example 位置参数
  * ```ts
- * import { Get } from '@snack-kit/lib/http'
- *
  * const { data, error } = await Get<{ name: string }>('/api/user/1')
- * if (!error) console.log(data?.name)
  * ```
  *
- * @example 使用 ctx 自动路由
+ * @example 配置对象
  * ```ts
- * const { data } = await Get('/profile', { ctx: 'user-svc' })
+ * const { data } = await Get({ url: '/api/user/1', ctx: 'user-svc' })
  * ```
  *
  * @example 获取 cancelId 以便主动取消
  * ```ts
  * let cancelId = ''
  * Get('/api/list', { onCancelId: (id) => { cancelId = id } })
- * Cancel(cancelId) // 取消请求
+ * Cancel(cancelId)
  * ```
  */
-declare function Get<T>(url: string, config?: HttpRequestConfig): Promise<HttpResult<T>>;
+declare function Get<T>(url: string, config?: HttpMethodConfig): Promise<HttpResult<T>>;
+declare function Get<T>(config: HttpMethodConfig): Promise<HttpResult<T>>;
 /**
  * 发起 POST 请求
  *
- * @param url 请求地址
- * @param data 请求体数据
- * @param config 请求配置
+ * 支持两种调用方式：
+ * - `Post(url, data?, config?)` — 位置参数形式
+ * - `Post(config)` — 纯配置对象形式（`data` 通过 `config.data` 传入，`method` 已预置）
  *
- * @example
+ * @example 位置参数
  * ```ts
- * import { Post } from '@snack-kit/lib/http'
- *
  * const { data, error } = await Post<{ token: string }>('/api/login', {
  *   username: 'admin',
  *   password: '123456',
  * })
- * if (!error) console.log(data?.token)
+ * ```
+ *
+ * @example 配置对象
+ * ```ts
+ * const { data } = await Post({
+ *   url: '/api/login',
+ *   data: { username: 'admin', password: '123456' },
+ *   ctx: 'user-svc',
+ * })
  * ```
  */
-declare function Post<T>(url: string, data?: unknown, config?: HttpRequestConfig): Promise<HttpResult<T>>;
+declare function Post<T>(url: string, data?: unknown, config?: HttpMethodConfig): Promise<HttpResult<T>>;
+declare function Post<T>(config: HttpMethodConfig): Promise<HttpResult<T>>;
 /**
  * 发起 PUT 请求
  *
- * @param url 请求地址
- * @param data 请求体数据
- * @param config 请求配置
+ * 支持两种调用方式：
+ * - `Put(url, data?, config?)` — 位置参数形式
+ * - `Put(config)` — 纯配置对象形式（`data` 通过 `config.data` 传入，`method` 已预置）
  *
- * @example
+ * @example 位置参数
  * ```ts
- * import { Put } from '@snack-kit/lib/http'
- *
  * await Put('/api/user/1', { name: 'Alice' })
  * ```
+ *
+ * @example 配置对象
+ * ```ts
+ * await Put({ url: '/api/user/1', data: { name: 'Alice' }, ctx: 'user-svc' })
+ * ```
  */
-declare function Put<T>(url: string, data?: unknown, config?: HttpRequestConfig): Promise<HttpResult<T>>;
+declare function Put<T>(url: string, data?: unknown, config?: HttpMethodConfig): Promise<HttpResult<T>>;
+declare function Put<T>(config: HttpMethodConfig): Promise<HttpResult<T>>;
 /**
  * 发起 PATCH 请求
  *
- * @param url 请求地址
- * @param data 请求体数据
- * @param config 请求配置
+ * 支持两种调用方式：
+ * - `Patch(url, data?, config?)` — 位置参数形式
+ * - `Patch(config)` — 纯配置对象形式（`data` 通过 `config.data` 传入，`method` 已预置）
  *
- * @example
+ * @example 位置参数
  * ```ts
- * import { Patch } from '@snack-kit/lib/http'
- *
  * await Patch('/api/user/1', { avatar: 'https://...' })
  * ```
+ *
+ * @example 配置对象
+ * ```ts
+ * await Patch({ url: '/api/user/1', data: { avatar: 'https://...' }, ctx: 'user-svc' })
+ * ```
  */
-declare function Patch<T>(url: string, data?: unknown, config?: HttpRequestConfig): Promise<HttpResult<T>>;
+declare function Patch<T>(url: string, data?: unknown, config?: HttpMethodConfig): Promise<HttpResult<T>>;
+declare function Patch<T>(config: HttpMethodConfig): Promise<HttpResult<T>>;
 /**
  * 发起 DELETE 请求
  *
- * @param url 请求地址
- * @param config 请求配置
+ * 支持两种调用方式：
+ * - `Del(url, config?)` — 位置参数形式
+ * - `Del(config)` — 纯配置对象形式（`method` 已预置）
  *
- * @example
+ * @example 位置参数
  * ```ts
- * import { Del } from '@snack-kit/lib/http'
- *
  * await Del('/api/user/1')
  * ```
+ *
+ * @example 配置对象
+ * ```ts
+ * await Del({ url: '/api/user/1', ctx: 'user-svc' })
+ * ```
  */
-declare function Del<T>(url: string, config?: HttpRequestConfig): Promise<HttpResult<T>>;
+declare function Del<T>(url: string, config?: HttpMethodConfig): Promise<HttpResult<T>>;
+declare function Del<T>(config: HttpMethodConfig): Promise<HttpResult<T>>;
 
-export { Cancel, CancelAll, Context, type ContextInfo, Ctx, Del, Get, HttpContext, type HttpError, type HttpRequestConfig, type HttpResult, Origin, Patch, Post, Put, Request, type ServerItem };
+export { Cancel, CancelAll, Del, Get, HttpMethodConfig, HttpRequestConfig, HttpResult, Patch, Post, Put, Request };

package/dist/types/index.d.ts

@@ -1,8 +1,9 @@
-export { Cancel, CancelAll, Context, ContextInfo, Ctx, Del, Get, HttpContext, HttpError, HttpRequestConfig, HttpResult, Origin, Patch, Post, Put, Request, ServerItem } from './http.js';
+export { C as Context, a as ContextInfo, b as Ctx, D as DEBUGGER_ACTIVE_KEY, H as HttpContext, c as HttpError, d as HttpMethodConfig, e as HttpRequestConfig, f as HttpResult, O as Origin, S as ServerItem } from './context-C4dFUDbw.js';
+export { Cancel, CancelAll, Del, Get, Patch, Post, Put, Request } from './http.js';
+export { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponse, default as axios } from 'axios';
 export { Debugger, DebuggerOptions } from './debugger.js';
 export { CleanObject, Debounce, DeepClone, Delay, FormatDate, GetDateOffset, GetDayRange, GetURLParam, GetURLParams, IsArray, IsBoolean, IsEmail, IsEqual, IsFunction, IsInteger, IsIpv4, IsNull, IsNumber, IsObject, IsPhone, IsPositiveInteger, IsRealNumber, IsString, IsUrl, Minus, ObjectToQuery, Omit, Pick, QueryToObject, REGEX, Throttle, UUID, Unique, UniqueByKey } from './utils.js';
-import 'axios';
 
-var version = "0.3.0";
+var version = "0.5.0";
 
 export { version as VERSION };

package/dist/umd/debugger.global.js

@@ -15373,6 +15373,7 @@ var SnackKit = (function (exports, crypto2, url, http, https, http2, util2, zlib
   } = axios_default;
 
   // src/http/context.ts
+  var DEBUGGER_ACTIVE_KEY = "__snackkit_debugger__active";
   var HttpContext = class {
     constructor() {
       this._store = /* @__PURE__ */ new Map();
@@ -15381,12 +15382,24 @@ var SnackKit = (function (exports, crypto2, url, http, https, http2, util2, zlib
     /**
      * 加载服务地址映射
      *
+     * 支持三种调用方式：
+     * - **传入字符串**：作为网关地址，自动请求 `GET /ngw/context` 获取映射表
+     * - **传入对象**：直接注入键值映射，不发起网络请求
+     * - **不传参数**：
+     *   - 生产环境（`NODE_ENV === 'production'`）：以当前页面 `Origin` 为网关地址自动加载
+     *   - 开发环境：立即返回，不做任何操作（应由 `Debugger.init()` 接管加载流程）
+     *
      * 远程加载时，响应中的 `$info` 元数据字段会被单独存储，不计入路由映射表。
      *
-     * @param source 远程加载传入网关 URL；本地注入传入键值对象
+     * @param source 网关 URL / 键值对象 / 省略
      * @param timeout 远程加载超时（ms），默认 5000
      *
-     * @example 远程加载
+     * @example 不传参——生产环境自动使用当前页面 Origin
+     * ```ts
+     * await Context.load()
+     * ```
+     *
+     * @example 传入网关地址
      * ```ts
      * await Context.load('http://172.16.32.155:20000', 3000)
      * ```
@@ -15397,6 +15410,11 @@ var SnackKit = (function (exports, crypto2, url, http, https, http2, util2, zlib
      * ```
      */
     async load(source, timeout = 5e3) {
+      if (source === void 0) {
+        if (globalThis[DEBUGGER_ACTIVE_KEY]) return;
+        if (!Origin) return;
+        source = Origin;
+      }
       if (typeof source === "string") {
         const url2 = `${source}/ngw/context`;
         const res = await axios_default.get(url2, { timeout });
@@ -15478,7 +15496,7 @@ var SnackKit = (function (exports, crypto2, url, http, https, http2, util2, zlib
   var _instance = new HttpContext();
   var Context = _instance;
   var _loc = typeof globalThis !== "undefined" ? globalThis["location"] : void 0;
-  _loc?.protocol && _loc?.host ? `${_loc.protocol}//${_loc.host}` : "";
+  var Origin = _loc?.protocol && _loc?.host ? `${_loc.protocol}//${_loc.host}` : "";
   _loc?.pathname ? _loc.pathname.split("/")[1] ?? "" : "";
 
   // src/http/cancel.ts
@@ -15537,8 +15555,11 @@ var SnackKit = (function (exports, crypto2, url, http, https, http2, util2, zlib
       Unregister(cancelId);
     }
   }
-  function Get(url2, config) {
-    return Request({ ...config, method: "GET", url: url2 });
+  function Get(urlOrConfig, config) {
+    if (typeof urlOrConfig === "string") {
+      return Request({ ...config, method: "GET", url: urlOrConfig });
+    }
+    return Request({ ...urlOrConfig, method: "GET" });
   }
 
   // src/debugger/debugger.ts
@@ -16111,6 +16132,7 @@ var SnackKit = (function (exports, crypto2, url, http, https, http2, util2, zlib
      * ```
      */
     static async init(options) {
+      globalThis[DEBUGGER_ACTIVE_KEY] = true;
       const instance = new _Debugger({ timeout: 1e4, ...options });
       instance.injectStyle();
       instance.buildDOM();
@@ -16420,6 +16442,7 @@ var SnackKit = (function (exports, crypto2, url, http, https, http2, util2, zlib
      *)
   */
 
+  exports.DEBUGGER_ACTIVE_KEY = DEBUGGER_ACTIVE_KEY;
   exports.Debugger = Debugger;
 
   return exports;