@doracli/type 0.0.6 → 0.0.8

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020-2029 zhangzhiguo
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2020-2029 zhangzhiguo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -3,5 +3,6 @@
 ## Usage
 
 ```
+dora type
 
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doracli/type",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "package by webpack",
   "author": "cclr <18843152354@163.com>",
   "homepage": "",
@@ -22,5 +22,5 @@
     "g:test": "vitest run",
     "build": "drr build"
   },
-  "gitHead": "b387668fa2986c56f245bc53bcb7072fd53b62e1"
+  "gitHead": "f0bd0475ac70c3c95336633ffdab4a4ec9794ca7"
 }

package/src/dora-config-browser-extension.ts

@@ -0,0 +1,440 @@
+/**
+ * Chrome Manifest V3 配置的主类型。
+ *
+ * 说明：
+ * - 这里只是一个“较完整”的示例类型，字段尽量覆盖常用/官方字段，但不保证绝对齐全。
+ * - 所有字段都是可选的，方便你按需组合使用。
+ * - 如果你只做 MV3，建议将 manifest_version 限制为 3。
+ */
+export interface TDoraConfigBrowserExtension {
+  /**
+   * Manifest 版本，目前推荐使用 3。
+   */
+  manifest_version?: 3;
+
+  /**
+   * 扩展名称（必填字段，但这里为了方便使用写成可选）。
+   */
+  name?: string;
+
+  /**
+   * 扩展描述。
+   */
+  description?: string;
+
+  /**
+   * 扩展版本号，语义化版本字符串。
+   */
+  version?: string;
+
+  /**
+   * 版本名称，通常用于显示给用户的完整版本信息。
+   */
+  version_name?: string;
+
+  /**
+   * 默认语言，使用 BCP-47 语言标签（如 "en"、"zh_CN"）。
+   */
+  default_locale?: string;
+
+  /**
+   * 扩展图标配置，不同尺寸的图标路径。
+   */
+  icons?: Partial<
+    Record<'16' | '19' | '32' | '38' | '48' | '64' | '128', string>
+  >;
+
+  /**
+   * 浏览器工具栏按钮（统一 action）。
+   */
+  action?: TAction;
+
+  /**
+   * 仅浏览器按钮（与 action 互斥，用于早期/兼容场景）。
+   */
+  browser_action?: TAction;
+
+  /**
+   * 页面（标签页）中的内容脚本配置。
+   */
+  content_scripts?: TContentScript[];
+
+  /**
+   * 背景脚本配置（MV3 下为 service_worker）。
+   */
+  background?: TBackground;
+
+  /**
+   * 选项页面（设置页）配置。
+   */
+  options_ui?: TOptionsUI;
+
+  /**
+   * 侧边栏（Side Panel）配置。
+   * Chrome MV3 中用于声明默认侧边栏页面。
+   */
+  side_panel?: TSidePanel;
+
+  /**
+   * 新标签页（chrome://newtab）替换配置。
+   */
+  chrome_url_overrides?: {
+    newtab?: string;
+    bookmarks?: string;
+    history?: string;
+  };
+
+  /**
+   * 权限列表（普通权限）。
+   */
+  permissions?: TPermission[];
+
+  /**
+   * 可选权限（用户按需授权）。
+   */
+  optional_permissions?: TPermission[];
+
+  /**
+   * 主机权限（匹配 URL 模式）。
+   * 例如："https://*//*"、"*://example.com/*"
+   */
+  host_permissions?: string[];
+
+  /**
+   * 可选主机权限。
+   */
+  optional_host_permissions?: string[];
+
+  /**
+   * 扩展在各个浏览器的兼容性信息。
+   */
+  browser_specific_settings?: {
+    gecko?: {
+      id?: string;
+      strict_min_version?: string;
+      strict_max_version?: string;
+      update_url?: string;
+    };
+    gecko_android?: {
+      id?: string;
+      strict_min_version?: string;
+      strict_max_version?: string;
+      update_url?: string;
+    };
+    edge?: {
+      browser_action_next_to_addressbar?: boolean;
+    };
+  };
+
+  /**
+   * 声明可在 declarativeNetRequest 等规则表中使用的资源。
+   */
+  declarative_net_request?: {
+    rule_resources?: Array<{
+      id: string;
+      enabled?: boolean;
+      path: string;
+    }>;
+  };
+
+  /**
+   * web_accessible_resources 声明。
+   * 注意：MV3 要使用对象数组形式。
+   */
+  web_accessible_resources?: Array<{
+    /**
+     * 可以被网页访问的资源路径（相对于扩展根目录）。
+     */
+    resources: string[];
+    /**
+     * 允许访问这些资源的 URL 匹配。
+     */
+    matches?: string[];
+    /**
+     * 运行时条件，例如 "manifest"。
+     */
+    extension_ids?: string[];
+  }>;
+
+  /**
+   * 命令（快捷键）配置。
+   */
+  commands?: Record<string, TCommand>;
+
+  /**
+   * 右键菜单、下载、标签页等 API 所需的声明式配置（一般通过 permissions 控制，这里不单独细分）。
+   */
+
+  /**
+   * 各种页面（popup、tab 等）中使用的 CSS 文件（不是内容脚本）。
+   * 只在部分场景中用到。
+   */
+  chrome_settings_overrides?: {
+    homepage?: string;
+    search_provider?: {
+      name: string;
+      keyword?: string;
+      favicon_url?: string;
+      search_url: string;
+      encoding?: string;
+      suggest_url?: string;
+      instant_url?: string;
+      image_url?: string;
+      search_url_post_params?: string;
+      suggest_url_post_params?: string;
+      instant_url_post_params?: string;
+      image_url_post_params?: string;
+      alternate_urls?: string[];
+      is_default?: boolean;
+    };
+    startup_pages?: string[];
+  };
+
+  /**
+   * omnibox 关键字（地址栏关键字）。
+   */
+  omnibox?: {
+    keyword: string;
+  };
+
+  /**
+   * 声明需要在剪贴板、文件系统等特殊能力。
+   * 实际上主要还是由 permissions 控制，这里只是保留结构位。
+   */
+
+  /**
+   * devtools 页面配置。
+   */
+  devtools_page?: string;
+
+  /**
+   * 远程调试页面（少用）。
+   */
+  devtools_page_experimental?: string;
+
+  /**
+   * 默认搜索引擎设置（一般通过 chrome_settings_overrides.search_provider 管理）。
+   */
+
+  /**
+   * 实验性字段、平台特定字段等可以统一放在扩展字段中，避免类型限制太死。
+   */
+  [key: string]: unknown;
+}
+
+/**
+ * 工具栏按钮 / 浏览器按钮 的统一类型。
+ */
+export interface TAction {
+  /**
+   * 按钮图标，可以设置不同尺寸。
+   */
+  default_icon?: Partial<
+    Record<'16' | '19' | '32' | '38' | '48' | '64' | '128', string>
+  >;
+
+  /**
+   * 按钮悬浮提示文本。
+   */
+  default_title?: string;
+
+  /**
+   * 点击按钮时弹出的页面（HTML）。
+   */
+  default_popup?: string;
+
+  /**
+   * 图标上显示的默认徽标文字。
+   */
+  default_badge_text?: string;
+}
+
+/**
+ * 内容脚本（注入到网页中的 JS/CSS）。
+ */
+export interface TContentScript {
+  /**
+   * 匹配的网页 URL 模式。
+   * 例如："https://*//*"、"*://*.example.com/*"
+   */
+  matches?: string[];
+
+  /**
+   * 排除的网页 URL 模式。
+   */
+  exclude_matches?: string[];
+
+  /**
+   * 只在这些页面中注入（更细粒度）。
+   */
+  include_globs?: string[];
+
+  /**
+   * 排除这些页面（更细粒度）。
+   */
+  exclude_globs?: string[];
+
+  /**
+   * 要注入的 JS 文件列表。
+   */
+  js?: string[];
+
+  /**
+   * 要注入的 CSS 文件列表。
+   */
+  css?: string[];
+
+  /**
+   * 在页面生命周期的哪个阶段注入脚本。
+   * - "document_start"：DOM 创建前
+   * - "document_end"：DOM 加载完成后
+   * - "document_idle"：页面空闲时（默认）
+   */
+  run_at?: 'document_start' | 'document_end' | 'document_idle';
+
+  /**
+   * 是否在所有 frame 中注入（包括 iframe）。
+   */
+  all_frames?: boolean;
+
+  /**
+   * 是否仅在顶级 frame 中注入。
+   */
+  match_about_blank?: boolean;
+
+  /**
+   * 是否隔离世界。
+   */
+  world?: 'ISOLATED' | 'CONTENT_SCRIPTS' | 'MAIN';
+}
+
+/**
+ * 背景脚本配置（MV3 下使用 service_worker）。
+ */
+export interface TBackground {
+  /**
+   * 背景 service worker 文件路径。
+   */
+  service_worker?: string;
+
+  /**
+   * 是否在页面关闭后仍尽快保持活跃（Chrome 部分版本支持）。
+   */
+  type?: 'module';
+}
+
+/**
+ * 选项页（设置页面）配置。
+ */
+export interface TOptionsUI {
+  /**
+   * 选项页 HTML 路径。
+   */
+  page?: string;
+
+  /**
+   * 是否以独立标签页形式打开。
+   */
+  open_in_tab?: boolean;
+
+  /**
+   * 是否使用 Chrome 提供的 IFrame 外壳（旧字段，通常不需要）。
+   */
+  chrome_style?: boolean;
+}
+
+/**
+ * 侧边栏（Side Panel）配置。
+ */
+export interface TSidePanel {
+  /**
+   * 默认侧边栏页面 HTML 路径。
+   */
+  default_path?: string;
+}
+
+/**
+ * 命令配置（快捷键）。
+ */
+export interface TCommand {
+  /**
+   * 用户可自定义的推荐快捷键。
+   * 示例："Ctrl+Shift+Y"
+   */
+  suggested_key?: {
+    default?: string;
+    mac?: string;
+    linux?: string;
+    chromeos?: string;
+    windows?: string;
+  };
+
+  /**
+   * 命令描述，会在快捷键设置页面中显示。
+   */
+  description?: string;
+
+  /**
+   * 是否是全局快捷键（即使没有浏览器窗口也能触发）。
+   */
+  global?: boolean;
+}
+
+/**
+ * MV3 常见权限类型。
+ * 如果有用到文档中未列出的权限，可以自行补充 string 类型。
+ */
+export type TPermission =
+  | 'activeTab'
+  | 'alarms'
+  | 'background'
+  | 'bookmarks'
+  | 'browsingData'
+  | 'clipboardRead'
+  | 'clipboardWrite'
+  | 'contentSettings'
+  | 'contextMenus'
+  | 'cookies'
+  | 'debugger'
+  | 'declarativeContent'
+  | 'declarativeNetRequest'
+  | 'declarativeNetRequestFeedback'
+  | 'declarativeNetRequestWithHostAccess'
+  | 'desktopCapture'
+  | 'downloads'
+  | 'downloads.open'
+  | 'favicon'
+  | 'fileBrowserHandler'
+  | 'fileSystemProvider'
+  | 'gcm'
+  | 'history'
+  | 'identity'
+  | 'idle'
+  | 'management'
+  | 'nativeMessaging'
+  | 'notifications'
+  | 'pageCapture'
+  | 'privacy'
+  | 'proxy'
+  | 'scripting'
+  | 'search'
+  | 'sessions'
+  | 'sidePanel'
+  | 'storage'
+  | 'system.cpu'
+  | 'system.display'
+  | 'system.memory'
+  | 'system.storage'
+  | 'tabCapture'
+  | 'tabGroups'
+  | 'tabs'
+  | 'topSites'
+  | 'tts'
+  | 'ttsEngine'
+  | 'unlimitedStorage'
+  | 'vpnProvider'
+  | 'wallpaper'
+  | 'webNavigation'
+  | 'webRequest'
+  | 'webRequestBlocking'
+  | (string & {});

package/src/dora-config.ts

@@ -1,4 +1,5 @@
 import type { PartialRecursive } from './common';
+import type { TDoraConfigBrowserExtension } from './dora-config-browser-extension';
 import type { TDoraConfigCommon } from './dora-config-common';
 import type { TDoraConfigDts } from './dora-config-dts';
 import type { TDoraConfigEsbuild } from './dora-config-esbuild';
@@ -15,6 +16,7 @@ export type TDoraConfig = TDoraConfigCommon & {
   esbuildConfig?: TDoraConfigEsbuild;
   serviceConfig?: Partial<TDoraConfigService>;
   dtsConfig?: TDoraConfigDts;
+  browserExtensionConfig?: TDoraConfigBrowserExtension;
 };
 
 export type TDoraConfigDefine =

package/src/index.ts

@@ -1,5 +1,6 @@
 export * from './cdn-type';
 export * from './dora-config';
+export * from './dora-config-browser-extension';
 export * from './dora-config-common';
 export * from './dora-config-multiple';
 export * from './dora-config-rollup';