piral-debug-utils - npm Package Compare versions

Comparing version 1.5.0-beta.6620 to 1.5.0-beta.6658

esm/debug.js

@@ -6,10 +6,31 @@ import { ExtensionCatalogue } from './ExtensionCatalogue';
 export function installPiralDebug(options) {
-    const { getGlobalState, getExtensions, getDependencies, getRoutes, getPilets, fireEvent, integrate, removePilet, updatePilet, addPilet, navigate, customSettings = {}, defaultSettings = {}, } = options;
+    const { getGlobalState, getExtensions, getDependencies, getRoutes, getPilets, fireEvent, integrate, removePilet, updatePilet, addPilet, navigate, emulator = true, customSettings = {}, defaultSettings = {}, } = options;
     const events = [];
     const legacyBrowser = !new Error().stack;
-    const initialSettings = getInitialSettings(defaultSettings);
-    const excludedRoutes = [initialSettings.cataloguePath];
     const selfSource = 'piral-debug-api';
     const debugApiVersion = 'v1';
     let setValue = initialSetter;
+    const initialSettings = getInitialSettings(defaultSettings);
+    const emulatorSettings = emulator
+        ? {
+            loadPilets: {
+                value: initialSettings.loadPilets,
+                type: 'boolean',
+                label: 'Load available pilets',
+                group: 'general',
+                onChange(value) {
+                    setValue(settingsKeys.loadPilets, value ? 'on' : 'off');
+                },
+            },
+            hardRefresh: {
+                value: initialSettings.hardRefresh,
+                type: 'boolean',
+                label: 'Full refresh on change',
+                group: 'general',
+                onChange(value) {
+                    setValue(settingsKeys.hardRefresh, value ? 'on' : 'off');
+                },
+            },
+        }
+        : {};
     const settings = {
@@ -21,2 +42,3 @@ ...customSettings,
             label: 'State container logging',
+            group: 'general',
             onChange(value) {
@@ -26,18 +48,3 @@ setValue(settingsKeys.viewState, value ? 'on' : 'off');
         },
-        loadPilets: {
-            value: initialSettings.loadPilets,
-            type: 'boolean',
-            label: 'Load available pilets',
-            onChange(value) {
-                setValue(settingsKeys.loadPilets, value ? 'on' : 'off');
-            },
-        },
-        hardRefresh: {
-            value: initialSettings.hardRefresh,
-            type: 'boolean',
-            label: 'Full refresh on change',
-            onChange(value) {
-                setValue(settingsKeys.hardRefresh, value ? 'on' : 'off');
-            },
-        },
+        ...emulatorSettings,
         viewOrigins: {
@@ -47,2 +54,3 @@ value: initialSettings.viewOrigins,
             label: 'Visualize component origins',
+            group: 'extensions',
             onChange(value, prev) {
@@ -59,2 +67,3 @@ setValue(settingsKeys.viewOrigins, value ? 'on' : 'off');
             label: 'Enable extension catalogue',
+            group: 'extensions',
             onChange(value) {
@@ -68,2 +77,3 @@ setValue(settingsKeys.extensionCatalogue, value ? 'on' : 'off');
             label: 'Clear console during HMR',
+            group: 'general',
             onChange(value) {
@@ -77,2 +87,3 @@ setValue(settingsKeys.clearConsole, value ? 'on' : 'off');
             label: 'Persist settings',
+            group: 'inspector',
             onChange(value) {
@@ -83,2 +94,3 @@ setValue = value ? enablePersistance() : disablePersistance();
     };
+    const excludedRoutes = [initialSettings.cataloguePath];
     if (initialSettings.viewOrigins) {
@@ -85,0 +97,0 @@ createVisualizer();

esm/types.d.ts

@@ -58,2 +58,3 @@ import type { FC } from 'react';
     label: string;
+    group?: string;
 };
@@ -63,2 +64,3 @@ export interface DebuggerBaseOptions {
     defaultSettings?: DefaultDebugSettings;
+    emulator?: boolean;
 }
@@ -65,0 +67,0 @@ export interface DebuggerOptions extends DebuggerBaseOptions {

lib/debug.js

@@ -9,10 +9,31 @@ "use strict";
 function installPiralDebug(options) {
-    const { getGlobalState, getExtensions, getDependencies, getRoutes, getPilets, fireEvent, integrate, removePilet, updatePilet, addPilet, navigate, customSettings = {}, defaultSettings = {}, } = options;
+    const { getGlobalState, getExtensions, getDependencies, getRoutes, getPilets, fireEvent, integrate, removePilet, updatePilet, addPilet, navigate, emulator = true, customSettings = {}, defaultSettings = {}, } = options;
     const events = [];
     const legacyBrowser = !new Error().stack;
-    const initialSettings = (0, state_1.getInitialSettings)(defaultSettings);
-    const excludedRoutes = [initialSettings.cataloguePath];
     const selfSource = 'piral-debug-api';
     const debugApiVersion = 'v1';
     let setValue = state_1.initialSetter;
+    const initialSettings = (0, state_1.getInitialSettings)(defaultSettings);
+    const emulatorSettings = emulator
+        ? {
+            loadPilets: {
+                value: initialSettings.loadPilets,
+                type: 'boolean',
+                label: 'Load available pilets',
+                group: 'general',
+                onChange(value) {
+                    setValue(state_1.settingsKeys.loadPilets, value ? 'on' : 'off');
+                },
+            },
+            hardRefresh: {
+                value: initialSettings.hardRefresh,
+                type: 'boolean',
+                label: 'Full refresh on change',
+                group: 'general',
+                onChange(value) {
+                    setValue(state_1.settingsKeys.hardRefresh, value ? 'on' : 'off');
+                },
+            },
+        }
+        : {};
     const settings = {
@@ -24,2 +45,3 @@ ...customSettings,
             label: 'State container logging',
+            group: 'general',
             onChange(value) {
@@ -29,18 +51,3 @@ setValue(state_1.settingsKeys.viewState, value ? 'on' : 'off');
         },
-        loadPilets: {
-            value: initialSettings.loadPilets,
-            type: 'boolean',
-            label: 'Load available pilets',
-            onChange(value) {
-                setValue(state_1.settingsKeys.loadPilets, value ? 'on' : 'off');
-            },
-        },
-        hardRefresh: {
-            value: initialSettings.hardRefresh,
-            type: 'boolean',
-            label: 'Full refresh on change',
-            onChange(value) {
-                setValue(state_1.settingsKeys.hardRefresh, value ? 'on' : 'off');
-            },
-        },
+        ...emulatorSettings,
         viewOrigins: {
@@ -50,2 +57,3 @@ value: initialSettings.viewOrigins,
             label: 'Visualize component origins',
+            group: 'extensions',
             onChange(value, prev) {
@@ -62,2 +70,3 @@ setValue(state_1.settingsKeys.viewOrigins, value ? 'on' : 'off');
             label: 'Enable extension catalogue',
+            group: 'extensions',
             onChange(value) {
@@ -71,2 +80,3 @@ setValue(state_1.settingsKeys.extensionCatalogue, value ? 'on' : 'off');
             label: 'Clear console during HMR',
+            group: 'general',
             onChange(value) {
@@ -80,2 +90,3 @@ setValue(state_1.settingsKeys.clearConsole, value ? 'on' : 'off');
             label: 'Persist settings',
+            group: 'inspector',
             onChange(value) {
@@ -86,2 +97,3 @@ setValue = value ? (0, state_1.enablePersistance)() : (0, state_1.disablePersistance)();
     };
+    const excludedRoutes = [initialSettings.cataloguePath];
     if (initialSettings.viewOrigins) {
@@ -88,0 +100,0 @@ (0, visualizer_1.createVisualizer)();

lib/types.d.ts

@@ -58,2 +58,3 @@ import type { FC } from 'react';
     label: string;
+    group?: string;
 };
@@ -63,2 +64,3 @@ export interface DebuggerBaseOptions {
     defaultSettings?: DefaultDebugSettings;
+    emulator?: boolean;
 }
@@ -65,0 +67,0 @@ export interface DebuggerOptions extends DebuggerBaseOptions {

package.json

 {
   "name": "piral-debug-utils",
-  "version": "1.5.0-beta.6620",
+  "version": "1.5.0-beta.6658",
   "description": "Utilities for debugging Piral instances.",
@@ -71,5 +71,5 @@ "keywords": [
   "devDependencies": {
-    "piral-base": "1.5.0-beta.6620"
+    "piral-base": "1.5.0-beta.6658"
   },
-  "gitHead": "a3cc22d3e4e600ab85d61f942d8eacfc7e6cfed9"
+  "gitHead": "3b5ce14949e37335fc7a0814d9b477fad61d0e26"
 }

src/debug.ts

@@ -20,2 +20,3 @@ import { ExtensionCatalogue } from './ExtensionCatalogue';
     navigate,
+    emulator = true,
     customSettings = {},
@@ -26,4 +27,2 @@ defaultSettings = {},
   const legacyBrowser = !new Error().stack;
-  const initialSettings = getInitialSettings(defaultSettings);
-  const excludedRoutes = [initialSettings.cataloguePath];
   const selfSource = 'piral-debug-api';
@@ -33,2 +32,27 @@ const debugApiVersion = 'v1';
 
+  const initialSettings = getInitialSettings(defaultSettings);
+
+  const emulatorSettings: Record<string, DebugCustomSetting> = emulator
+    ? {
+        loadPilets: {
+          value: initialSettings.loadPilets,
+          type: 'boolean',
+          label: 'Load available pilets',
+          group: 'general',
+          onChange(value) {
+            setValue(settingsKeys.loadPilets, value ? 'on' : 'off');
+          },
+        },
+        hardRefresh: {
+          value: initialSettings.hardRefresh,
+          type: 'boolean',
+          label: 'Full refresh on change',
+          group: 'general',
+          onChange(value) {
+            setValue(settingsKeys.hardRefresh, value ? 'on' : 'off');
+          },
+        },
+      }
+    : {};
+
   const settings: Record<string, DebugCustomSetting> = {
@@ -40,2 +64,3 @@ ...customSettings,
       label: 'State container logging',
+      group: 'general',
       onChange(value) {
@@ -45,18 +70,3 @@ setValue(settingsKeys.viewState, value ? 'on' : 'off');
     },
-    loadPilets: {
-      value: initialSettings.loadPilets,
-      type: 'boolean',
-      label: 'Load available pilets',
-      onChange(value) {
-        setValue(settingsKeys.loadPilets, value ? 'on' : 'off');
-      },
-    },
-    hardRefresh: {
-      value: initialSettings.hardRefresh,
-      type: 'boolean',
-      label: 'Full refresh on change',
-      onChange(value) {
-        setValue(settingsKeys.hardRefresh, value ? 'on' : 'off');
-      },
-    },
+    ...emulatorSettings,
     viewOrigins: {
@@ -66,2 +76,3 @@ value: initialSettings.viewOrigins,
       label: 'Visualize component origins',
+      group: 'extensions',
       onChange(value, prev) {
@@ -79,2 +90,3 @@ setValue(settingsKeys.viewOrigins, value ? 'on' : 'off');
       label: 'Enable extension catalogue',
+      group: 'extensions',
       onChange(value) {
@@ -88,2 +100,3 @@ setValue(settingsKeys.extensionCatalogue, value ? 'on' : 'off');
       label: 'Clear console during HMR',
+      group: 'general',
       onChange(value) {
@@ -97,2 +110,3 @@ setValue(settingsKeys.clearConsole, value ? 'on' : 'off');
       label: 'Persist settings',
+      group: 'inspector',
       onChange(value) {
@@ -104,2 +118,4 @@ setValue = value ? enablePersistance() : disablePersistance();
 
+  const excludedRoutes = [initialSettings.cataloguePath];
+
   if (initialSettings.viewOrigins) {
@@ -106,0 +122,0 @@ createVisualizer();

src/types.ts

@@ -70,2 +70,3 @@ import type { FC } from 'react';
   label: string;
+  group?: string;
 };
@@ -76,2 +77,3 @@
   defaultSettings?: DefaultDebugSettings;
+  emulator?: boolean;
 }
@@ -78,0 +80,0 @@

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

160674

increased by1.19%

Lines of code

2814

increased by1.55%

No dependency changes