@tinywork/glass 1.0.1 → 1.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinywork/glass",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "",
   "main": "src/index.ts",
   "types": "src/index.ts",

package/src/index.ts

@@ -1,557 +1,492 @@
-import type { IncomingMessage, ServerResponse } from "node:http";
-
-/** electron类型 */
-export type MenuItemConstructorOptions = {
-  label: string;
-  click: () => void;
-};
-export type Cookie = {
-  value?: string;
-};
-export abstract class Cookies {
-  abstract get(options: { name: string }): Promise<Cookie[]>;
-  abstract addListener(
-    event: "changed",
-    listener: (
-      event: Event,
-      /**
-       * The cookie that was changed.
-       */
-      cookie: Cookie,
-      /**
-       * The cause of the change with one of the following values:
-       */
-      cause:
-        | "explicit"
-        | "overwrite"
-        | "expired"
-        | "evicted"
-        | "expired-overwrite",
-      /**
-       * `true` if the cookie was removed, `false` otherwise.
-       */
-      removed: boolean
-    ) => void
-  ): this;
-  abstract removeListener(
-    event: "changed",
-    listener: (
-      event: Event,
-      /**
-       * The cookie that was changed.
-       */
-      cookie: Cookie,
-      /**
-       * The cause of the change with one of the following values:
-       */
-      cause:
-        | "explicit"
-        | "overwrite"
-        | "expired"
-        | "evicted"
-        | "expired-overwrite",
-      /**
-       * `true` if the cookie was removed, `false` otherwise.
-       */
-      removed: boolean
-    ) => void
-  ): this;
-}
-export type Session = {
-  setProxy: (options: { mode: "direct" }) => Promise<void>;
-  cookies: Cookies;
-};
-export abstract class BrowserWindow {
-  webContents: {
-    session: Session;
-  };
-}
+export {};
+
+type IGlassExtensionEvent<T> = (params: T) => Promise<T>;
+type IGlassExtensionInvokeResponse<T> = Promise<{
+  success: boolean;
+  message?: string;
+  data?: T;
+}>;
+
+declare global {
+  namespace Glass {
+    type MenuItem = {
+      /** 用来click回调时区分 */
+      id: string;
+      label: string;
+    };
 
-/** 1-新增，2-修改，3-删除 */
-export type Operation = 1 | 2 | 3;
+    /** 1-新增，2-修改，3-删除 */
+    type Operation = 1 | 2 | 3;
 
-export type GlassAction = "file" | "remove" | "bind" | "unbind" | "check";
-export type GlassActionParams =
-  | {
-      type: "file";
-      data: DocSchema;
-      declare?: boolean;
-      output: { code: string; filename?: string };
-    }
-  | {
-      type: "bind" | "unbind";
-      data: DocSchema;
-    }
-  | {
-      type: "check";
+    type Cookie = {
+      name: string;
+      origin?: string;
+      path?: string;
+      value?: string;
     };
 
-export type ResourceType =
-  | "Fetch/XHR"
-  | "JS"
-  | "CSS"
-  | "Img"
-  | "Media"
-  | "Font"
-  | "Doc"
-  | "WS"
-  | "Wasm"
-  | "Other";
-
-export type JSONPropertySchema = {
-  type: string;
-  description?: string;
-  items?: JSONPropertySchema;
-  properties?: {
-    [key: string]: JSONPropertySchema;
-  };
-  required?: string[];
-};
-
-export type JSONSchema = JSONPropertySchema & {
-  $schema?: string;
-  $id?: string;
-  title?: string;
-};
-
-export type DocSchema = {
-  apiId: string;
-  groupId: string;
-  name: string;
-  desc?: string;
-  pathname?: string;
-  method?: "GET" | "POST" | "PUT" | "DELETE";
-  code?: string; // ts声明
-  modifier?: string; // 最后操作人
-  modifyTime?: string; // 最后操作时间
-  tags?: string[] | null;
-  status: boolean;
-  hash?: string;
-  /** 无hash时，用updatedAt */
-  updatedAt?: string;
-  /** 是否支持app编辑 */
-  readonly?: boolean;
-
-  prefix?: string;
-};
-
-export type DocFullSchema = DocSchema & {
-  external: {
-    group: string;
-    orgId?: string;
-    teamId?: string;
-  };
-};
-
-export type GroupSchema = {
-  id: string;
-  orgId?: string | null;
-  teamId?: string | null;
-  parentId: string | null;
-  name: string;
-  desc?: string;
-  origin?: string;
-  prefix?: string;
-  code?: string;
-  status: boolean;
-  hash?: string;
-  /** 无hash时，用updatedAt */
-  updatedAt?: string;
-  /** 是否支持app编辑 */
-  readonly?: boolean;
-};
-
-export type Project = {
-  id: string;
-  orgId?: string | null;
-  teamId?: string | null;
-  name: string;
-  desc?: string;
-  status: boolean;
-  actived?: boolean;
-  hash?: string;
-};
-
-export type Version = {
-  id: string;
-  projectId: string;
-  name: string;
-  desc?: string;
-  status: boolean;
-  actived?: boolean;
-  hash?: string;
-};
-
-export type Plan = {
-  id: string;
-  versionId: string;
-  name: string;
-  desc?: string;
-  origin: string;
-  prefix: string;
-  params?: string;
-  headers?: string;
-  body?: string;
-  /** 校验结果的ts类型声明 */
-  assert?: string;
-  hash?: string;
-};
-
-export type Case = {
-  id: string;
-  versionId: string;
-  planId?: string;
-  name: string;
-  desc?: string;
-  origin: string;
-  pathname: string;
-  method: "GET" | "POST" | "PUT" | "DELETE";
-  params?: Record<string, any>;
-  headers?: Record<string, any>;
-  body?: any;
-  apiId?: string;
-  /** 校验结果的ts类型声明 */
-  assert?: string;
-  hash?: string;
-};
-
-export type CaseData = Omit<Case, "params" | "headers" | "body"> & {
-  params?: string;
-  headers?: string;
-  body?: string;
-};
-
-export type Association = {
-  versionId: string;
-  apiId: string;
-  tags?: string[];
-  hash?: string;
-};
-
-export type MockMode = "None" | "Local" | "Advance";
-export type ActionMode = "Modify" | "Add" | "Remove";
-export type ActionTarget = "Origin";
-export type ContextMenuType =
-  | "log"
-  | "group"
-  | "doc"
-  | "rule"
-  | "project"
-  | "version"
-  | "plan"
-  | "case"
-  | "association";
-
-export type ContextMenuParams =
-  | { type: "log"; data: NetLog }
-  | { type: "group"; data: GroupSchema }
-  | { type: "doc"; data: DocSchema }
-  | { type: "rule"; data: RuleSchema }
-  | { type: "project"; data: Project }
-  | { type: "version"; data: Version }
-  | { type: "plan"; data: Plan }
-  | { type: "case"; data: Case }
-  | { type: "association"; data: Association };
-
-export type SyncDataType =
-  | "group"
-  | "doc"
-  | "rule"
-  | "project"
-  | "version"
-  | "plan"
-  | "case";
-
-export type SyncDataParams =
-  | { type: "group"; data: GroupSchema }
-  | { type: "doc"; data: DocSchema }
-  | { type: "rule"; data: RuleSchema }
-  | { type: "project"; data: Project }
-  | { type: "version"; data: Version }
-  | { type: "plan"; data: Plan }
-  | { type: "case"; data: CaseData };
-
-export type MockModelSchema = {
-  id: string;
-  ruleId?: string;
-  contentType?: string;
-  example?: string;
-  name?: string;
-  statusCode?: number;
-  status?: boolean;
-  updatedAt?: string;
-};
-
-export type RewriteActionSchema = {
-  id: string;
-  ruleId?: string;
-  name?: string;
-  action?: ActionMode;
-  target?: ActionTarget;
-  oldValue?: string;
-  newValue?: string;
-  status?: boolean;
-  updatedAt?: string;
-};
-
-export type FilterSchema = {
-  origin?: string;
-  pathname?: string;
-  params?: { key: string; value?: string }[];
-};
-
-export type RuleSchema = FilterSchema & {
-  id: string;
-  orgId?: string | null;
-  teamId?: string | null;
-  mode?: MockMode; // 是否走mock
-  name?: string;
-  apiId?: string;
-  throttle?: number;
-  /** 本地匹配规则是排序用 */
-  sort?: number;
-  tags?: string[];
-  localOptions?: MockModelSchema[];
-  actions?: RewriteActionSchema[];
-  hash?: string;
-  updatedAt?: string;
-};
-
-export type NetLog = {
-  uid: string;
-  url: string;
-  realUrl: string;
-  method: string;
-  requestHeaders: string[][];
-  query?: string;
-  body?: any;
-  statusCode?: number;
-  responseHeaders?: string[][];
-  resourceType?: ResourceType;
-  response?: any;
-  rule?: RuleSchema;
-};
-export interface IProgress {
-  update: (option: { percent: number; text?: string }) => Promise<void>;
-  destroy: () => Promise<void>;
-}
-export interface IGlassContext {
-  getItem: <T>(key: string) => Promise<T>;
-  setItem: <T>(key: string, value: T) => Promise<void>;
-
-  saveGroup: (
-    group: GroupSchema
-  ) => Promise<{ success: boolean; message?: string }>;
-  saveGroups: (
-    groups: GroupSchema[]
-  ) => Promise<{ success: boolean; message?: string }>;
-  saveDoc: (
-    doc: DocSchema,
-    options?: {
-      /** 是否触发缓存更新 */
-      hooks?: boolean;
-      /** 是否根据文档自动生成rule规则 */
-      defaultRule?: Partial<{
-        name: string;
-        origin: string;
-        pathname: string;
-        params: { key: string; value?: string }[];
-      }>;
-    }
-  ) => Promise<{
-    success: boolean;
-    message?: string;
-    data?: {
+    type GlassAction = "file" | "remove" | "bind" | "unbind" | "check";
+    type GlassActionParams =
+      | {
+          type: "file";
+          data: DocSchema;
+          declare?: boolean;
+          output: { code: string; filename?: string };
+        }
+      | {
+          type: "remove";
+          data: DocSchema;
+        }
+      | {
+          type: "bind" | "unbind";
+          data: DocSchema;
+        }
+      | {
+          type: "check";
+        };
+
+    type ResourceType =
+      | "Fetch/XHR"
+      | "JS"
+      | "CSS"
+      | "Img"
+      | "Media"
+      | "Font"
+      | "Doc"
+      | "WS"
+      | "Wasm"
+      | "Other";
+
+    type JSONPropertySchema = {
+      type: string;
+      description?: string;
+      items?: JSONPropertySchema;
+      properties?: {
+        [key: string]: JSONPropertySchema;
+      };
+      required?: string[];
+    };
+
+    type JSONSchema = JSONPropertySchema & {
+      $schema?: string;
+      $id?: string;
+      title?: string;
+    };
+
+    type DocSchema = {
       apiId: string;
-      ruleId?: string;
+      groupId: string;
+      name: string;
+      desc?: string;
+      pathname?: string;
+      method?: "GET" | "POST" | "PUT" | "DELETE";
+      code?: string; // ts声明
+      modifier?: string; // 最后操作人
+      modifyTime?: string; // 最后操作时间
+      tags?: string[] | null;
+      status: boolean;
+      hash?: string;
+      /** 无hash时，用updatedAt */
+      updatedAt?: string;
+      /** 是否支持app编辑 */
+      readonly?: boolean;
+
+      prefix?: string;
     };
-  }>;
-  saveDocs: (
-    docs: DocSchema[],
-    options?: {
-      /** 是否根据文档自动生成rule规则 */
-      defaultRules?: {
-        name: string;
-        origin: string;
-        pathname: string;
-        apiId: string;
-        params?: { key: string; value?: string }[] | null;
-      }[];
-    }
-  ) => Promise<{ success: boolean; message?: string }>;
-  /** 批量更新rule的本地数据 */
-  saveExamples: (
-    ruleId: string,
-    examples: {
+
+    type DocFullSchema = DocSchema & {
+      external: {
+        group: string;
+        orgId?: string;
+        teamId?: string;
+      };
+    };
+
+    type GroupSchema = {
+      id: string;
+      orgId?: string | null;
+      teamId?: string | null;
+      parentId: string | null;
+      name: string;
+      desc?: string;
+      origin?: string;
+      prefix?: string;
+      code?: string;
+      status: boolean;
+      hash?: string;
+      /** 无hash时，用updatedAt */
+      updatedAt?: string;
+      /** 是否支持app编辑 */
+      readonly?: boolean;
+    };
+
+    type Project = {
+      id: string;
+      orgId?: string | null;
+      teamId?: string | null;
+      name: string;
+      desc?: string;
+      status: boolean;
+      actived?: boolean;
+      hash?: string;
+    };
+
+    type Version = {
+      id: string;
+      projectId: string;
+      name: string;
+      desc?: string;
+      status: boolean;
+      actived?: boolean;
+      hash?: string;
+    };
+
+    type Plan = {
+      id: string;
+      versionId: string;
+      name: string;
+      desc?: string;
+      origin: string;
+      prefix: string;
+      params?: string;
+      headers?: string;
+      body?: string;
+      /** 校验结果的ts类型声明 */
+      assert?: string;
+      hash?: string;
+    };
+
+    type Case = {
+      id: string;
+      versionId: string;
+      planId?: string;
+      name: string;
+      desc?: string;
+      origin: string;
+      pathname: string;
+      method: "GET" | "POST" | "PUT" | "DELETE";
+      params?: Record<string, any>;
+      headers?: Record<string, any>;
+      body?: any;
+      apiId?: string;
+      /** 校验结果的ts类型声明 */
+      assert?: string;
+      hash?: string;
+    };
+
+    type CaseData = Omit<Case, "params" | "headers" | "body"> & {
+      params?: string;
+      headers?: string;
+      body?: string;
+    };
+
+    type Association = {
+      versionId: string;
+      apiId: string;
+      tags?: string[];
+      hash?: string;
+    };
+
+    type MockMode = "None" | "Local" | "Advance";
+    type ActionMode = "Modify" | "Add" | "Remove";
+    type ActionTarget = "Origin";
+    type ContextMenuType =
+      | "log"
+      | "group"
+      | "doc"
+      | "rule"
+      | "project"
+      | "version"
+      | "plan"
+      | "case"
+      | "association";
+
+    type ContextMenuParams =
+      | { type: "log"; data: NetLog }
+      | { type: "group"; data: GroupSchema }
+      | { type: "doc"; data: DocSchema }
+      | { type: "rule"; data: RuleSchema }
+      | { type: "project"; data: Project }
+      | { type: "version"; data: Version }
+      | { type: "plan"; data: Plan }
+      | { type: "case"; data: Case }
+      | { type: "association"; data: Association };
+
+    type SyncDataType =
+      | "group"
+      | "doc"
+      | "rule"
+      | "project"
+      | "version"
+      | "plan"
+      | "case";
+
+    type SyncDataParams = (
+      | { type: "group"; data: GroupSchema }
+      | { type: "doc"; data: DocSchema }
+      | { type: "rule"; data: RuleSchema }
+      | { type: "project"; data: Project }
+      | { type: "version"; data: Version }
+      | { type: "plan"; data: Plan }
+      | { type: "case"; data: CaseData }
+    ) & { operation: Operation; orgId?: string | null };
+
+    type MockModelSchema = {
       id: string;
+      ruleId?: string;
       contentType?: string;
       example?: string;
       name?: string;
       statusCode?: number;
       status?: boolean;
-    }[]
-  ) => Promise<{ success: boolean; message?: string }>;
-
-  registerMenu: (id: string, options: MenuItemConstructorOptions) => void;
-  unregisterMenu: (id: string) => void;
-
-  getSession: (id: string, isPersist?: boolean) => Session;
-  showInputBox: (option: {
-    title?: string;
-    placeholder?: string;
-    value?: string;
-  }) => Promise<string>;
-  showMessage: (options: {
-    message: string;
-    title?: string;
-    type?: "success" | "info" | "error";
-  }) => Promise<void>;
-  showProgress: () => IProgress;
-
-  transformDocToJsonSchema: (doc: DocFullSchema) => JSONSchema;
-  genDataFromDocSchema: (doc: DocFullSchema) => Record<string, any>;
-
-  postMessage: (message: Partial<NetLog>) => Promise<void>;
-}
+      updatedAt?: string;
+    };
 
-export interface IGlassExtension {
-  install?(context: IGlassContext): Promise<void>;
-  activate?(context: IGlassContext): Promise<void>;
-  /** 通过设置页面修改数据 */
-  onItemChange?(context: IGlassContext): Promise<void>;
-  /** 要修改url时，直接在params.url = new URL方式修改 */
-  onRequest?(
-    context: IGlassContext,
-    params: {
-      /** url为null时表示break了请求 */
-      url: URL | null;
-      req: IncomingMessage;
-      res: ServerResponse;
-      isLocal?: boolean;
-    }
-  ): Promise<void>;
-  /** 在执行请求用例时触发，用于修改config */
-  onRequestExec?(
-    context: IGlassContext,
-    config: {
+    type RewriteActionSchema = {
+      id: string;
+      ruleId?: string;
+      name?: string;
+      action?: ActionMode;
+      target?: ActionTarget;
+      oldValue?: string;
+      newValue?: string;
+      status?: boolean;
+      updatedAt?: string;
+    };
+
+    type FilterSchema = {
+      origin?: string;
+      pathname?: string;
+      params?: { key: string; value?: string }[];
+    };
+
+    type RuleSchema = FilterSchema & {
+      id: string;
+      orgId?: string | null;
+      teamId?: string | null;
+      mode?: MockMode; // 是否走mock
+      name?: string;
+      apiId?: string;
+      throttle?: number;
+      /** 本地匹配规则是排序用 */
+      sort?: number;
+      tags?: string[];
+      localOptions?: MockModelSchema[];
+      actions?: RewriteActionSchema[];
+      hash?: string;
+      updatedAt?: string;
+    };
+
+    type NetLog = {
+      uid: string;
       url: string;
+      realUrl: string;
       method: string;
-      headers?: Record<string, any>;
-      params?: Record<string, any>;
-      data?: any;
+      requestHeaders: string[][];
+      query?: string;
+      body?: any;
+      statusCode?: number;
+      responseHeaders?: string[][];
+      resourceType?: ResourceType;
+      response?: any;
+      rule?: RuleSchema;
+    };
+    interface IProgress {
+      update: (option: { percent: number; text?: string }) => Promise<void>;
+      destroy: () => Promise<void>;
     }
-  ): Promise<void>;
-
-  /** 在用例批量执行前触发 */
-  beforeCasesExec?(
-    context: IGlassContext,
-    data: { list: Case[] }
-  ): Promise<void>;
-  /** 在单条用例执行时触发 */
-  onCaseExec?(context: IGlassContext, data: Case): Promise<void>;
-  /** 在用例批量执行后触发 */
-  afterCasesExec?(
-    context: IGlassContext,
-    data: { list: Case[]; failCases: { id: string; message?: string }[] }
-  ): Promise<void>;
-
-  /** 远程服务同步数据至本机 */
-  onSyncDownload?(
-    context: IGlassContext,
-    operation: Operation,
-    params: SyncDataParams,
-    orgId?: string | null
-  ): Promise<void>;
-  /** 本机变更同步数据至远程服务 */
-  onSyncUpload?(
-    context: IGlassContext,
-    operation: Operation,
-    params: SyncDataParams,
-    orgId?: string | null
-  ): Promise<void>;
-
-  /** 在postMessage到页面之前 */
-  onMessagePost?(
-    context: IGlassContext,
-    message: Partial<NetLog>
-  ): Promise<void>;
-  onResponse?(
-    context: IGlassContext,
-    params: {
-      url: URL;
-      req: IncomingMessage;
-      res: ServerResponse;
+
+    interface IGlassExtension {
+      install?: IGlassExtensionEvent<void>;
+      activate?: IGlassExtensionEvent<void>;
+      /** 通过设置页面修改数据 */
+      onItemChange?: IGlassExtensionEvent<void>;
+      /** 要修改url时，直接在params.url = new URL方式修改 */
+      onRequest?: IGlassExtensionEvent<{
+        /** url为null时表示break了请求 */
+        url: URL | null;
+        isLocal?: boolean;
+      }>;
+      /** 在执行请求用例时触发，用于修改config */
+      onRequestExec?: IGlassExtensionEvent<{
+        url: string;
+        method: string;
+        headers?: Record<string, any>;
+        params?: Record<string, any>;
+        data?: any;
+      }>;
+
+      /** 在用例批量执行前触发 */
+      beforeCasesExec?: IGlassExtensionEvent<{ list: Case[] }>;
+      /** 在单条用例执行时触发 */
+      onCaseExec?: IGlassExtensionEvent<Case>;
+      /** 在用例批量执行后触发 */
+      afterCasesExec?: IGlassExtensionEvent<{
+        list: Case[];
+        failCases: { id: string; message?: string }[];
+      }>;
+
+      /** 远程服务同步数据至本机 */
+      onSyncDownload?: IGlassExtensionEvent<SyncDataParams>;
+      /** 本机变更同步数据至远程服务 */
+      onSyncUpload?: IGlassExtensionEvent<SyncDataParams>;
+
+      /** 在postMessage到页面之前 */
+      onMessagePost?: IGlassExtensionEvent<{ log: Partial<NetLog> }>;
+      onResponse?: IGlassExtensionEvent<{ url: URL }>;
+      deactivate?: IGlassExtensionEvent<void>;
+      uninstall?: IGlassExtensionEvent<void>;
+
+      onDocChange?: IGlassExtensionEvent<{
+        doc: DocFullSchema | null;
+        originDoc: DocFullSchema | null;
+        orgId?: string | null;
+      }>;
+      onGroupChange?: IGlassExtensionEvent<{
+        group: GroupSchema | null;
+        originGroup: GroupSchema | null;
+        orgId?: string | null;
+      }>;
+      /** glass cli拉取接口文档 */
+      onDocCliUpdate?: IGlassExtensionEvent<{
+        id: string;
+        orgId?: string | null;
+      }>;
+      /** glass cli执行 */
+      onGlassAction?: IGlassExtensionEvent<{
+        params: GlassActionParams;
+        orgId?: string | null;
+      }>;
+      /** 右键请求日志 */
+      onContextMenu?: IGlassExtensionEvent<{
+        params: ContextMenuParams;
+      }>;
+
+      onRuleDefault?: IGlassExtensionEvent<{
+        docs: DocSchema[];
+        log: NetLog;
+        rule?: RuleSchema;
+      }>;
+      /** 根据doc或者log来初始化case */
+      onCaseDefault?: IGlassExtensionEvent<{
+        docs: DocSchema[];
+        log?: NetLog;
+        caseData?: CaseData;
+      }>;
     }
-  ): Promise<void>;
-  deactivate?(context: IGlassContext): Promise<void>;
-  uninstall?(context: IGlassContext): Promise<void>;
-
-  onDocChange?(
-    context: IGlassContext,
-    doc: DocFullSchema | null,
-    originDoc: DocFullSchema | null,
-    orgId?: string | null
-  ): Promise<boolean>;
-  onGroupChange?(
-    context: IGlassContext,
-    group: GroupSchema | null,
-    originGroup: GroupSchema | null,
-    orgId?: string | null
-  ): Promise<boolean>;
-  /** glass cli拉取接口文档 */
-  onDocCliUpdate?(
-    context: IGlassContext,
-    id: string,
-    orgId?: string | null
-  ): Promise<void>;
-  /** glass cli执行 */
-  onGlassAction?(
-    context: IGlassContext,
-    params: GlassActionParams,
-    orgId?: string | null
-  ): Promise<void>;
-  /** 右键请求日志 */
-  onContextMenu?(
-    context: IGlassContext,
-    params: ContextMenuParams,
-    menus?: MenuItemConstructorOptions[]
-  ): Promise<void>;
-
-  getDefaultRule?(
-    context: IGlassContext,
-    docs: DocSchema[],
-    log: NetLog,
-    rule?: {
-      id: string;
-      mode: "None";
-    } & Partial<{
+
+    type writeText = (text: string) => Promise<void>;
+    type openExternal = (url: string) => Promise<void>;
+    type getItem = <T>(key: string) => Promise<T>;
+    type setItem = <T>(key: string, value: T) => Promise<void>;
+    /** 保存cookie */
+    type setCookie = (params: {
       name: string;
-      origin: string;
-      pathname: string;
-      params: { key: string; value?: string }[];
+      origin?: string;
+      path?: string;
+      value: string;
+    }) => IGlassExtensionInvokeResponse<void>;
+    /** 获取cookie */
+    type getCookie = (params: {
+      name: string;
+      origin?: string;
+      path?: string;
+    }) => IGlassExtensionInvokeResponse<string>;
+    /** 保存文档组 */
+    type saveGroup = (
+      group: GroupSchema
+    ) => IGlassExtensionInvokeResponse<void>;
+    /** 批量保存文档组 */
+    type saveGroups = (
+      groups: GroupSchema[]
+    ) => IGlassExtensionInvokeResponse<void>;
+    /** 保存文档 */
+    type saveDoc = (
+      doc: DocSchema,
+      options?: {
+        /** 是否触发缓存更新 */
+        hooks?: boolean;
+        /** 是否根据文档自动生成rule规则 */
+        defaultRule?: Partial<{
+          name: string;
+          origin: string;
+          pathname: string;
+          params: { key: string; value?: string }[];
+        }>;
+      }
+    ) => IGlassExtensionInvokeResponse<{
       apiId: string;
-    }>
-  ): Promise<void>;
-  /** 根据doc或者log来初始化case */
-  getDefaultCase?(
-    context: IGlassContext,
-    docs: DocSchema[],
-    log?: NetLog,
-    defaultCase?: Partial<Case>
-  ): Promise<void>;
+      ruleId?: string;
+    }>;
+    /** 批量保存文档 */
+    type saveDocs = (
+      docs: DocSchema[],
+      options?: {
+        /** 是否根据文档自动生成rule规则 */
+        defaultRules?: {
+          name: string;
+          origin: string;
+          pathname: string;
+          apiId: string;
+          params?: { key: string; value?: string }[] | null;
+        }[];
+      }
+    ) => IGlassExtensionInvokeResponse<void>;
+    /** 批量更新rule的本地数据 */
+    type saveExamples = (
+      ruleId: string,
+      examples: {
+        id: string;
+        contentType?: string;
+        example?: string;
+        name?: string;
+        statusCode?: number;
+        status?: boolean;
+      }[]
+    ) => IGlassExtensionInvokeResponse<void>;
+    /** 注册菜单项 */
+    type registerMenu = (
+      id: string,
+      options: MenuItem
+    ) => IGlassExtensionInvokeResponse<void>;
+    /** 移除菜单 */
+    type unregisterMenu = (id: string) => IGlassExtensionInvokeResponse<void>;
+
+    type showInputBox = (option: {
+      title?: string;
+      placeholder?: string;
+      value?: string;
+    }) => IGlassExtensionInvokeResponse<string>;
+    type showMessage = (options: {
+      message: string;
+      title?: string;
+      type?: "success" | "info" | "error";
+    }) => IGlassExtensionInvokeResponse<void>;
+    type showProgress = () => IProgress;
+
+    type transformDocToJsonSchema = (
+      doc: DocFullSchema
+    ) => IGlassExtensionInvokeResponse<JSONSchema>;
+    type genDataFromDocSchema = (
+      doc: DocFullSchema
+    ) => IGlassExtensionInvokeResponse<Record<string, any>>;
+
+    type postMessage = (
+      message: Partial<NetLog>
+    ) => IGlassExtensionInvokeResponse<void>;
+    type openBrowserWindow = (browserWindowOptions: {
+      width?: number;
+      height?: number;
+      minHeight?: number;
+      minWidth?: number;
+      show?: boolean;
+      alwaysOnTop?: boolean;
+      url: string;
+      until?: {
+        mode: "cookie";
+        type: "added" | "removed";
+        info: Glass.Cookie;
+      };
+    }) => IGlassExtensionInvokeResponse<Glass.Cookie>;
+  }
 }
-
-export type writeText = (text: string) => void;
-export type openExternal = (url: string) => void;
-export type openBrowserWindow = (browserWindowOptions: {
-  width?: number;
-  height?: number;
-  minHeight?: number;
-  minWidth?: number;
-  show?: boolean;
-  alwaysOnTop?: boolean;
-  url: string;
-  webPreferences?: {
-    session?: Session;
-  };
-}) => Promise<BrowserWindow>;