piral-debug-utils 0.13.7 → 0.14.0-alpha.3154

package/src/state.ts

@@ -0,0 +1,79 @@
+import { useState, useEffect } from 'react';
+
+export const initialSettings = {
+  viewState: sessionStorage.getItem('dbg:view-state') !== 'off',
+  loadPilets: sessionStorage.getItem('dbg:load-pilets') === 'on',
+  hardRefresh: sessionStorage.getItem('dbg:hard-refresh') === 'on',
+  viewOrigins: sessionStorage.getItem('dbg:view-origins') === 'on',
+  extensionCatalogue: sessionStorage.getItem('dbg:extension-catalogue') !== 'off',
+  cataloguePath: '/$debug-extension-catalogue',
+};
+
+export interface PiralDebugState {
+  visualize: {
+    active: boolean;
+    force: boolean;
+  };
+  catalogue: {
+    active: boolean;
+    path: string;
+  };
+  route: {
+    path: string;
+    state?: any;
+  } | undefined;
+}
+
+const listeners: Array<() => void> = [];
+
+let state: PiralDebugState = {
+  visualize: {
+    active: initialSettings.viewOrigins,
+    force: false,
+  },
+  catalogue: {
+    active: initialSettings.extensionCatalogue,
+    path: initialSettings.cataloguePath,
+  },
+  route: undefined,
+};
+
+export function setState(dispatch: (arg: PiralDebugState) => PiralDebugState) {
+  const newState = dispatch(state);
+
+  if (newState !== state) {
+    state = newState;
+    listeners.forEach((listener) => listener());
+  }
+}
+
+export function getState() {
+  return state;
+}
+
+export function subscribe<T>(select: (arg: PiralDebugState) => T, notify: (state: T) => void) {
+  let prevState = select(state);
+  const cb = () => {
+    const nextState = select(state);
+
+    if (prevState !== nextState) {
+      prevState = nextState;
+      notify(nextState);
+    }
+  };
+  const unsubscribe = () => {
+    const idx = listeners.indexOf(cb);
+
+    if (idx !== -1) {
+      listeners.splice(idx, 1);
+    }
+  };
+  listeners.push(cb);
+  return unsubscribe;
+}
+
+export function useDebugState<T>(select: (arg: PiralDebugState) => T) {
+  const [state, setState] = useState(() => select(getState()));
+  useEffect(() => subscribe(select, setState), []);
+  return state;
+}

package/src/types.ts

@@ -1,25 +1,64 @@
-import { GlobalStateContext } from 'piral-core';
-import { AvailableDependencies, PiletApiCreator, PiletLoader, PiletRequester } from 'piral-base';
+import type { FC } from 'react';
+import type { AvailableDependencies, Pilet, PiletApiCreator, PiletLoader, PiletMetadata } from 'piral-base';
 
-export interface DebuggerOptions {
+export interface EmulatorConnectorOptions {
   createApi: PiletApiCreator;
   loadPilet: PiletLoader;
-  context?: GlobalStateContext;
-  requestPilets: PiletRequester;
-  getDependencies(): AvailableDependencies;
-  onChange?(cb: (previous: any, current: any) => void): void;
+  injectPilet?(pilet: Pilet): void;
+  piletApiFallback?: string;
 }
 
-export interface PiralDebugState {
-  $debug: {
-    visualize: {
-      force: boolean;
-      active: boolean;
-    };
-    route: string;
-  };
+export interface ChangeSet {
+  state?: boolean;
+  pages?: boolean;
+  pilets?: boolean;
+  extensions?: boolean;
+  dependencies?: boolean;
 }
 
-declare module 'piral-core/lib/types/custom' {
-  interface PiralCustomState extends PiralDebugState {}
+export interface DebugComponents {
+  wrappers: Record<string, FC>;
+  components: Record<string, FC>;
+  routes: Record<string, FC>;
+  onChange(previous: any, current: any, changed: ChangeSet): void;
+}
+
+export interface DebugCustomBooleanSetting {
+  value: boolean;
+  type: 'boolean';
+  onChange(newValue: boolean, prevValue: boolean): void;
+}
+
+export interface DebugCustomNumberSetting {
+  value: number;
+  type: 'number';
+  onChange(newValue: number, prevValue: number): void;
+}
+
+export interface DebugCustomStringSetting {
+  value: string;
+  type: 'string';
+  onChange(newValue: string, prevValue: string): void;
+}
+
+export type DebugCustomSetting = (DebugCustomBooleanSetting | DebugCustomNumberSetting | DebugCustomStringSetting) & {
+  label: string;
+};
+
+export interface DebuggerExtensionOptions {
+  customSettings?: Record<string, DebugCustomSetting>;
+}
+
+export interface DebuggerOptions extends DebuggerExtensionOptions {
+  getDependencies(): Array<string>;
+  createApi: PiletApiCreator;
+  loadPilet: PiletLoader;
+  injectPilet(pilet: Pilet): void;
+  fireEvent(name: string, arg: any): void;
+  getGlobalState(): any;
+  getPilets(): Array<PiletMetadata>;
+  getExtensions(): Array<string>;
+  getRoutes(): Array<string>;
+  setPilets(pilets: Array<PiletMetadata>): void;
+  integrate(components: DebugComponents): void;
 }