@tinywork/glass 1.0.49 → 1.1.0

package/index.d.ts

@@ -1,6 +1,9 @@
 import type { OutgoingHttpHeaders, IncomingHttpHeaders } from "node:http";
 
-type IGlassExtensionEvent<T> = (params: T) => Promise<T>;
+type IGlassExtensionEvent<T> = (
+  params: T,
+  api?: Glass.IGlassBridge,
+) => Promise<T>;
 type IGlassExtensionInvokeResponse<T> = Promise<{
   success: boolean;
   message?: string;
@@ -9,6 +12,180 @@ type IGlassExtensionInvokeResponse<T> = Promise<{
 
 declare global {
   namespace Glass {
+    type ExtensionKind = "extension" | "agent";
+
+    type AgentFailurePolicy = "open" | "closed";
+
+    type TrafficMatch = {
+      origins?: string[];
+      pathnames?: string[];
+      methods?: string[];
+      requestHeaders?: Record<string, string>;
+      statusCodes?: number[];
+      resourceTypes?: ResourceType[];
+    };
+
+    type AgentExtensionOptions = {
+      entry?: string;
+      match?: TrafficMatch;
+      timeoutMs?: number;
+      maxBodyBytes?: number;
+      maxDelayMs?: number;
+      failurePolicy?: AgentFailurePolicy;
+    };
+
+    type ExtensionManifest = {
+      kind?: ExtensionKind;
+      capabilities?: string[];
+      agent?: AgentExtensionOptions;
+    };
+
+    type TrafficDiagnostic = {
+      level: "info" | "warning" | "error";
+      message: string;
+      details?: unknown;
+    };
+
+    type TrafficResponse = {
+      statusCode?: number;
+      statusMessage?: string;
+      headers?: OutgoingHttpHeaders;
+      body?: any;
+      source?: "agent" | "mock" | "upstream";
+    };
+
+    type TrafficRequestContext = {
+      requestId?: string;
+      /** url为null时表示break了请求 */
+      url: string | null;
+      originUrl?: string | null;
+      method?: string;
+      headers?: IncomingHttpHeaders;
+      body?: any;
+      response?: TrafficResponse;
+      isLocal?: boolean;
+      rule?: RuleSchema;
+      delayMs?: number;
+      diagnostics?: TrafficDiagnostic[];
+    };
+
+    type TrafficRequestSnapshot = {
+      requestId: string;
+      url: string;
+      originUrl?: string;
+      method?: string;
+      headers?: IncomingHttpHeaders;
+      body?: any;
+      isLocal?: boolean;
+      rule?: RuleSchema;
+    };
+
+    type TrafficResponseContext = {
+      request: TrafficRequestSnapshot;
+      response: TrafficResponse;
+      resourceType?: ResourceType;
+      delayMs?: number;
+      diagnostics?: TrafficDiagnostic[];
+    };
+
+    type TrafficResponseChunkContext = TrafficResponseContext & {
+      chunk: string;
+      sequence: number;
+      isLast: boolean;
+      terminate?: boolean;
+      terminateReason?: string;
+    };
+
+    type TrafficCompleteContext = TrafficResponseContext & {
+      duration?: number;
+    };
+
+    type AgentTrafficChange = {
+      path: string;
+      before?: unknown;
+      after?: unknown;
+      masked?: boolean;
+    };
+
+    type AgentTrafficMessage = {
+      id: string;
+      conversationId: string;
+      agentId: string;
+      requestUid: string;
+      hook: keyof IGlassExtension;
+      action: string;
+      title: string;
+      summary?: string;
+      changes?: AgentTrafficChange[];
+      diagnostics?: TrafficDiagnostic[];
+      duration?: number;
+      createdAt: number;
+    };
+
+    type AgentExtensionRuntimeStatus = "stopped" | "validating" | "starting" | "running" | "reloading" | "stopping" | "error";
+
+    type AgentExtensionDraft = {
+      id: string;
+      name: string;
+      description?: string;
+      version?: string;
+      required?: string;
+      icon?: string;
+      private?: boolean;
+      manifest?: ExtensionManifest;
+      source: string;
+      readme?: string;
+      revision?: string;
+    };
+
+    type AgentExtensionSummary = {
+      id: string;
+      name: string;
+      description?: string;
+      version?: string;
+      required?: string;
+      icon?: string;
+      private?: boolean;
+      revision?: string;
+      md5?: string;
+      publishedMd5?: string;
+      hasChanges?: boolean;
+      status?: boolean;
+      runtimeStatus: AgentExtensionRuntimeStatus;
+      hooks?: string[];
+      lastError?: string;
+    };
+
+    type AgentExtensionValidation = {
+      valid: boolean;
+      hooks?: string[];
+      revision?: string;
+      message?: string;
+    };
+
+    type AgentExtensionMutationResult = AgentExtensionSummary & {
+      reloaded?: boolean;
+      rollback?: boolean;
+    };
+
+    type AgentExtensionPublishInput = {
+      id: string;
+      name?: string;
+      description?: string;
+      version?: string;
+      icon?: string;
+      orgId?: string;
+      teamId?: string;
+      private?: boolean;
+    };
+
+    type AgentExtensionActionParams = {
+      type: "agentExtension";
+      action: "create" | "update" | "publish";
+      data: AgentExtensionDraft;
+      conversationId?: string;
+    };
+
     type MenuItem = {
       /** 用来click回调时区分 */
       id: string;
@@ -295,12 +472,8 @@ declare global {
     };
 
     type BatchSchema = BatchItemSchema & {
-      mocks?: Array<{
-        mockId: string;
-      }>;
-      actions?: Array<{
-        actionId?: string;
-      }>;
+      mocks?: Array<MockModelSchema>;
+      actions?: Array<RewriteActionSchema>;
     };
 
     type NetLog = {
@@ -329,20 +502,16 @@ declare global {
       activate?: IGlassExtensionEvent<void>;
       /** 通过设置页面修改数据 */
       onItemChange?: IGlassExtensionEvent<void>;
-      /** 要修改url时，直接在params.url = new URL方式修改 */
-      onRequest?: IGlassExtensionEvent<{
-        /** url为null时表示break了请求 */
-        url: string | null;
-        originUrl?: string | null;
-        response?: {
-          statusCode?: number;
-          headers?: OutgoingHttpHeaders;
-          body?: any;
-        };
-        isLocal?: boolean;
-        headers?: IncomingHttpHeaders;
-        rule?: RuleSchema;
-      }>;
+      /** 请求发送到上游或本地 Mock 处理前触发 */
+      onRequest?: IGlassExtensionEvent<TrafficRequestContext>;
+      /** 响应头返回客户端前触发 */
+      onResponseHeaders?: IGlassExtensionEvent<TrafficResponseContext>;
+      /** 响应体返回客户端前触发；命中该 Hook 时 Glass 会按配置限制缓冲响应体 */
+      onResponseBody?: IGlassExtensionEvent<TrafficResponseContext>;
+      /** SSE 事件帧返回客户端前触发；可修改单帧、延迟发送或主动中断连接 */
+      onResponseChunk?: IGlassExtensionEvent<TrafficResponseChunkContext>;
+      /** 请求处理完成后触发；用于诊断与观察，不再修改客户端响应 */
+      onComplete?: IGlassExtensionEvent<TrafficCompleteContext>;
       /** 在执行请求用例时触发，用于修改config */
       onRequestExec?: IGlassExtensionEvent<{
         url: string;
@@ -513,6 +682,30 @@ declare global {
         isFinish: boolean;
       }): IGlassExtensionInvokeResponse<void>;
 
+      queryAgentExtensions(): IGlassExtensionInvokeResponse<AgentExtensionSummary[]>;
+      getAgentExtension(id: string): IGlassExtensionInvokeResponse<AgentExtensionDraft>;
+      createAgentExtension(
+        input: AgentExtensionDraft,
+      ): IGlassExtensionInvokeResponse<AgentExtensionMutationResult>;
+      updateAgentExtension(
+        input: AgentExtensionDraft,
+      ): IGlassExtensionInvokeResponse<AgentExtensionMutationResult>;
+      validateAgentExtension(
+        input: AgentExtensionDraft | { id: string },
+      ): IGlassExtensionInvokeResponse<AgentExtensionValidation>;
+      publishAgentExtension(
+        input: AgentExtensionPublishInput,
+      ): IGlassExtensionInvokeResponse<AgentExtensionSummary>;
+      setAgentExtensionStatus(input: {
+        id: string;
+        enabled: boolean;
+      }): IGlassExtensionInvokeResponse<AgentExtensionSummary>;
+      queryAgentExtensionMessages(params: {
+        id: string;
+        requestUid?: string;
+        limit?: number;
+      }): IGlassExtensionInvokeResponse<AgentTrafficMessage[]>;
+
       queryRules(): IGlassExtensionInvokeResponse<RuleSchema[]>;
       getRule(
         params: { apiId: string } | { ruleId: string },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinywork/glass",
-  "version": "1.0.49",
+  "version": "1.1.0",
   "description": "",
   "types": "index.d.ts",
   "files": [