vconsole - npm Package Compare versions

Comparing version 3.11.2 to 3.12.0

CHANGELOG_CN.md

 [English](./CHANGELOG.md) | 简体中文
 
+## 3.12.0 (2022-02-17)
+
+- `Feat(Core)` 新增静态属性 `VConsole.instance` 以获取实例化后的单例 vConsole 对象。
+- `Feat(Core)` 新增配置项 `storage.defaultStorages`，见 [公共属性及方法](./doc/public_properties_methods_CN.md)。
+- `Feat(Core)` 更新 `vConsole.setOption()` 用法：通过 `setOption('log.maxLogNumber', 20)` 来单独设置 `maxLogNumber` 字段，或通过 `setOption({ log: { maxLogNumber: 20 }})` 来覆盖 `log` 对象。
+- `Feat(Core)` 废弃一些配置项，参见下面。
+- `Fix(Plugin)` 修复插件事件 `renderTab` 没有渲染出视图的 bug。
+- `Fix(Storage)` 修复某些情况下的 Cookie 解析错误问题。 (issue #508, #509)
+
+**废弃的配置项：**
+
+- `maxLogNumber`：用 `option.log.maxLogNumber` 替代。
+- `maxNetworkNumber`：用 `option.network.maxNetworkNumber` 替代。
+- `onClearLog`：移除。
+
+
 ## 3.11.2 (2022-01-20)
@@ -4,0 +20,0 @@

CHANGELOG.md

 English | [简体中文](./CHANGELOG_CN.md)
 
+## 3.12.0 (2022-02-17)
+
+- `Feat(Core)` Add new static property `VConsole.instance` to get the singleton instance.
+- `Feat(Core)` Add new options `storage.defaultStorages`, see [Public Properties & Methods](./doc/public_properties_methods.md).
+- `Feat(Core)` New way of using `vConsole.setOption()`: `setOption('log.maxLogNumber', 20)` to set `maxLogNumber` field only, and `setOption({ log: { maxLogNumber: 20 }})` to overwrite `log` object.
+- `Feat(Core)` Deprecated some options, see below.
+- `Fix(Plugin)` Fix the bug that event `renderTab` doesn't render plugin view.
+- `Fix(Storage)` Fix cookie parse error in some bad cases. (issue #508, #509)
+
+**Deprecated Options:**
+
+- `maxLogNumber`: Use `option.log.maxLogNumber` instead.
+- `maxNetworkNumber`: Use `option.network.maxNetworkNumber` instead.
+- `onClearLog`: Removed.
+
+
 ## 3.11.2 (2022-01-20)
@@ -4,0 +20,0 @@

dist/vconsole.min.d.ts

@@ -0,1 +1,34 @@
+declare module "core/options.interface" {
+    export interface VConsoleLogOptions {
+        maxLogNumber?: number;
+    }
+    export interface VConsoleNetworkOptions {
+        maxNetworkNumber?: number;
+    }
+    export interface VConsoleStorageOptions {
+        defaultStorages?: ('cookies' | 'localStorage' | 'sessionStorage' | 'wxStorage')[];
+    }
+    export interface VConsoleOptions {
+        target?: string | HTMLElement;
+        defaultPlugins?: ('system' | 'network' | 'element' | 'storage')[];
+        theme?: '' | 'dark' | 'light';
+        disableLogScrolling?: boolean;
+        onReady?: () => void;
+        log?: VConsoleLogOptions;
+        network?: VConsoleNetworkOptions;
+        storage?: VConsoleStorageOptions;
+        /**
+         * @deprecated Since v3.12.0, use `log.maxLogNumber`.
+         */
+        maxLogNumber?: number;
+        /**
+         * @deprecated Since v3.12.0, use `network.maxNetworkNumber`.
+         */
+        maxNetworkNumber?: number;
+        /**
+         * @deprecated Since v3.12.0.
+         */
+        onClearLog?: () => void;
+    }
+}
 declare module "lib/tool" {
@@ -691,18 +724,45 @@ /**
 }
-declare module "storage/cookieStorage" {
-    import { CookieStorage } from 'cookie-storage';
-    import type { CookieOptions } from 'cookie-storage/lib/cookie-options';
-    export class VConsoleCookieStorage extends CookieStorage {
+declare module "storage/storage.proxy" {
+    export const GetProxyHandler: <T extends Storage>() => ProxyHandler<T>;
+}
+declare module "storage/storage.cookie" {
+    export interface CookieOptions {
+        path?: string | null;
+        domain?: string | null;
+        expires?: Date | null;
+        secure?: boolean;
+        sameSite?: 'Strict' | 'Lax' | 'None';
+    }
+    export class CookieStorage implements Storage {
+        constructor();
+        get length(): number;
         /**
-         * Deep remove a cookie.
+         * Returns sorted keys.
          */
+        get keys(): string[];
+        key(index: number): string;
+        setItem(key: string, data: string, cookieOptions?: CookieOptions): void;
+        getItem(key: string): string;
         removeItem(key: string, cookieOptions?: CookieOptions): void;
-        /**
-         * Deep clear all cookies.
-         */
         clear(): void;
     }
 }
+declare module "storage/storage.wx" {
+    export const isWxEnv: () => any;
+    export const callWx: (method: string, ...args: any[]) => any;
+    export class WxStorage implements Storage {
+        constructor();
+        get length(): number;
+        get keys(): string[];
+        key(index: number): string;
+        getItem(key: string): any;
+        setItem(key: string, data: any): any;
+        removeItem(key: string): any;
+        clear(): void;
+    }
+}
 declare module "storage/storage.model" {
-    import { VConsoleCookieStorage } from "storage/cookieStorage";
+    import type { VConsoleStorageOptions } from "core/options.interface";
+    import { CookieStorage } from "storage/storage.cookie";
+    import { WxStorage } from "storage/storage.wx";
     import { VConsoleModel } from "lib/model";
@@ -714,3 +774,5 @@ interface IStorageItem {
     export class VConsoleStorageModel extends VConsoleModel {
-        protected cookiesStorage: VConsoleCookieStorage;
+        defaultStorages: VConsoleStorageOptions['defaultStorages'];
+        protected cookiesStorage: CookieStorage;
+        protected wxStorage: WxStorage;
         protected storages: IStorageItem[];
@@ -721,2 +783,3 @@ /**
         getAllStorages(): IStorageItem[];
+        updateEnabledStorages(): void;
     }
@@ -729,6 +792,11 @@ }
         protected model: VConsoleStorageModel;
+        protected onAddTopBarCallback: Function;
         constructor(id: string, name: string, renderProps?: {});
+        onInit(): void;
         onShow(): void;
         onAddTopBar(callback: Function): void;
         onAddTool(callback: Function): void;
+        onUpdateOption(): void;
+        protected setDefaultActivedName(): void;
+        protected updateTopBar(): void;
     }
@@ -741,2 +809,3 @@ }
     import type { SvelteComponent } from 'svelte';
+    import type { VConsoleOptions } from "core/options.interface";
     import { VConsolePlugin } from "lib/plugin";
@@ -751,12 +820,2 @@ import { VConsoleLogPlugin } from "log/log";
     import { VConsoleNetworkExporter } from "network/network.exporter";
-    interface VConsoleOptions {
-        target?: string | HTMLElement;
-        defaultPlugins?: ('system' | 'network' | 'element' | 'storage')[];
-        maxLogNumber?: number;
-        maxNetworkNumber?: number;
-        theme?: '' | 'dark' | 'light';
-        disableLogScrolling?: boolean;
-        onReady?: () => void;
-        onClearLog?: () => void;
-    }
     export class VConsole {
@@ -773,2 +832,3 @@ version: string;
         network: VConsoleNetworkExporter;
+        static instance: VConsole;
         static VConsolePlugin: typeof VConsolePlugin;
@@ -848,2 +908,4 @@ static VConsoleLogPlugin: typeof VConsoleLogPlugin;
          * Update option(s).
+         * @example `setOption('log.maxLogNumber', 20)`: set 'maxLogNumber' field only.
+         * @example `setOption({ log: { maxLogNumber: 20 }})`: overwrite 'log' object.
          */
@@ -850,0 +912,0 @@ setOption(keyOrObj: any, value?: any): void;

package.json

 {
   "name": "vconsole",
-  "version": "3.11.2",
+  "version": "3.12.0",
   "description": "A lightweight, extendable front-end developer tool for mobile web page.",
@@ -31,3 +31,2 @@ "homepage": "https://github.com/Tencent/vConsole",
   "dependencies": {
-    "cookie-storage": "^6.1.0",
     "copy-text-to-clipboard": "^3.0.1",
@@ -34,0 +33,0 @@ "core-js": "^3.11.0",

README_CN.md

@@ -54,3 +54,3 @@ [English](./README.md) | 简体中文
 // 或者使用配置参数来初始化，详情见文档
-const vConsole = new VConsole({ maxLogNumber: 1000 });
+const vConsole = new VConsole({ theme: 'dark' });
 
@@ -57,0 +57,0 @@ // 接下来即可照常使用 `console` 等方法

README.md

@@ -52,3 +52,3 @@ English | [简体中文](./README_CN.md)
 // or init with options
-const vConsole = new VConsole({ maxLogNumber: 1000 });
+const vConsole = new VConsole({ theme: 'dark' });
 
@@ -55,0 +55,0 @@ // call `console` methods as usual

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

296179

increased by1.67%

Dependency count

3

decreased by-25%

Lines of code

947

increased by7.01%

Dependency changes

• - Removedcookie-storage@^6.1.0

• - Removedcookie-storage@6.1.0(transitive)