graphwise-reactodia 0.0.1-TR17 → 0.0.1-TR18

package/dist/types/components/graphwise-reactodia/graphwise-reactodia.d.ts

@@ -2,7 +2,7 @@ import { EventEmitter } from '../../stencil-public-runtime';
 import { SparqlDataProviderSettings } from '@reactodia/workspace';
 import { LanguageKey } from './i18n/language-key';
 import { ReactodiaConfig } from './models/reactodia-config';
-import { ErrorReport } from './models/error/error-report';
+import { EventDetail } from './models/event/event-detail';
 /**
  * A web component that renders a graph with the Reactodia workspace.
  *
@@ -47,9 +47,9 @@ export declare class GraphwiseReactodia {
      */
     theme?: 'light' | 'dark';
     /**
-     * Fires, when an error has occurred. The host decides how to handle it.
+     * Fires for every event to the host, differentiated by `detail.type`.
      */
-    errorEmitter: EventEmitter<ErrorReport>;
+    eventEmitter: EventEmitter<EventDetail>;
     private reactRoot?;
     /**
      * `connectedCallback` and the watchers can run before all props are set: when the component's
@@ -66,7 +66,7 @@ export declare class GraphwiseReactodia {
     componentDidLoad(): void;
     disconnectedCallback(): void;
     render(): any;
-    private subscribeToErrors;
+    private subscribeToEvents;
     private renderGraph;
     private reportMissingPropError;
 }

package/dist/types/components/graphwise-reactodia/models/error/error-report.d.ts

@@ -1,8 +1,4 @@
 import { ErrorCode } from './error-code';
-/**
- * Name of the DOM event the `graphwise-reactodia` element dispatches for every reported error.
- */
-export declare const GRAPHWISE_REACTODIA_ERROR_EVENT = "graphwiseReactodiaError";
 /**
  * A failure the wrapper announces to the host.
  */

package/dist/types/components/graphwise-reactodia/models/event/event-callback.d.ts

@@ -0,0 +1,5 @@
+import { EventDetail } from './event-detail';
+/**
+ * Callback invoked with every emitted event.
+ */
+export type EventCallback = (detail: EventDetail) => void;

package/dist/types/components/graphwise-reactodia/models/event/event-detail.d.ts

@@ -0,0 +1,48 @@
+import { EventType } from './event-type';
+import { ErrorReport } from '../error/error-report';
+/**
+ * Name of the DOM event the `graphwise-reactodia` element dispatches for every event.
+ */
+export declare const GRAPHWISE_REACTODIA_EVENT = "graphwiseReactodiaEvent";
+/**
+ * The payload of each {@link EventType}. It is the single place that ties an event type to its payload, so
+ * adding an event is one {@link EventType} value and one entry here.
+ *
+ * @example
+ * ```ts
+ * interface EventPayloadMap {
+ *   [EventType.ERROR]: ErrorReport;
+ *   // A new event:
+ *   [EventType.NEW_TYPE]: NewTypePayload;
+ * }
+ * ```
+ */
+interface EventPayloadMap {
+    [EventType.ERROR]: ErrorReport;
+}
+/**
+ * Maps an {@link EventType} to its event detail: `{type, payload}`, with the payload from
+ * {@link EventPayloadMap}. If no event type is provided, it is the union of the details of all event types.
+ *
+ * @template T The event type to map.
+ *
+ * @example
+ * ```ts
+ * // Any event, narrowed by its type.
+ * function onEvent(detail: EventDetail): void {
+ *   if (detail.type === EventType.ERROR) {
+ *     const {code, error} = detail.payload; // an ErrorReport
+ *   }
+ * }
+ *
+ * // One event.
+ * const detail: EventDetail<EventType.ERROR> = {type: EventType.ERROR, payload: {code, error}};
+ * ```
+ */
+export type EventDetail<T extends EventType = EventType> = {
+    [K in T]: {
+        type: K;
+        payload: EventPayloadMap[K];
+    };
+}[T];
+export {};

package/dist/types/components/graphwise-reactodia/models/event/event-type.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The kind of event the wrapper announces to the host. It selects the payload of an {@link EventDetail}.
+ */
+export declare enum EventType {
+    ERROR = "error"
+}

package/dist/types/components/graphwise-reactodia/services/error/error.service.d.ts

@@ -1,5 +1,3 @@
-import { Subscription } from '../../models/subscription';
-import { ErrorCallback } from '../../models/error/error-callback';
 import { ErrorCode } from '../../models/error/error-code';
 /**
  * Service that collects the failures of the wrapper and the fork, so they can be announced to the host.
@@ -7,7 +5,7 @@ import { ErrorCode } from '../../models/error/error-code';
 export declare class ErrorService {
     static readonly ID = "ErrorService";
     private static readonly ABORT_ERROR_NAME;
-    private callback?;
+    private readonly eventService;
     private readonly reported;
     /**
      * Reports a failure to the host, unless it's an abort, or this exact error object is already reported
@@ -32,13 +30,6 @@ export declare class ErrorService {
      * @param thrown The thrown value.
      */
     report(code: ErrorCode, thrown: unknown): void;
-    /**
-     * Subscribes to the reported errors, replacing the previous subscriber.
-     *
-     * @param callback Called with every reported error.
-     * @returns A {@link Subscription} that, when called, removes the callback, unless it has already been replaced.
-     */
-    subscribe(callback: ErrorCallback): Subscription;
     /**
      * Whether any link of the given cause chain is an abort or is already reported.
      */

package/dist/types/components/graphwise-reactodia/services/event/event.service.d.ts

@@ -1,9 +1,25 @@
 import { Subscription } from '../../models/subscription';
+import { EventCallback } from '../../models/event/event-callback';
+import { EventDetail } from '../../models/event/event-detail';
 /**
  * Service for event based operations
  */
 export declare class EventService {
     static readonly ID = "EventService";
+    private callback?;
+    /**
+     * Announces an event to the host.
+     *
+     * @param detail The event detail.
+     */
+    emit(detail: EventDetail): void;
+    /**
+     * Subscribes to the emitted events, replacing the previous subscriber.
+     *
+     * @param callback Called with every emitted event.
+     * @returns A {@link Subscription} that, when called, removes the callback, unless it has already been replaced.
+     */
+    subscribe(callback: EventCallback): Subscription;
     /**
      * Subscribes to the host's "clear persisted diagram" command.
      *

package/dist/types/components.d.ts

@@ -8,11 +8,11 @@ import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
 import { ReactodiaConfig } from "./components/graphwise-reactodia/models/reactodia-config";
 import { LanguageKey } from "./components/graphwise-reactodia/i18n/language-key";
 import { SparqlDataProviderSettings } from "@reactodia/workspace";
-import { ErrorReport } from "./components/graphwise-reactodia/models/error/error-report";
+import { EventDetail } from "./components/graphwise-reactodia/models/event/event-detail";
 export { ReactodiaConfig } from "./components/graphwise-reactodia/models/reactodia-config";
 export { LanguageKey } from "./components/graphwise-reactodia/i18n/language-key";
 export { SparqlDataProviderSettings } from "@reactodia/workspace";
-export { ErrorReport } from "./components/graphwise-reactodia/models/error/error-report";
+export { EventDetail } from "./components/graphwise-reactodia/models/event/event-detail";
 export namespace Components {
     /**
      * A web component that renders a graph with the Reactodia workspace.
@@ -53,7 +53,7 @@ export interface GraphwiseReactodiaCustomEvent<T> extends CustomEvent<T> {
 }
 declare global {
     interface HTMLGraphwiseReactodiaElementEventMap {
-        "graphwiseReactodiaError": ErrorReport;
+        "graphwiseReactodiaEvent": EventDetail;
     }
     /**
      * A web component that renders a graph with the Reactodia workspace.
@@ -107,9 +107,9 @@ declare namespace LocalJSX {
          */
         "language"?: LanguageKey;
         /**
-          * Fires, when an error has occurred. The host decides how to handle it.
+          * Fires for every event to the host, differentiated by `detail.type`.
          */
-        "onGraphwiseReactodiaError"?: (event: GraphwiseReactodiaCustomEvent<ErrorReport>) => void;
+        "onGraphwiseReactodiaEvent"?: (event: GraphwiseReactodiaCustomEvent<EventDetail>) => void;
         /**
           * Query preset for the SPARQL data provider, owned and configured by the host. A DOM property (an object, not an attribute) passed in from outside the wrapper. Required: the wrapper has no default preset and throws when it is missing. Changing it rebuilds the data provider and reloads the graph with it, keeping the current diagram.
          */

package/dist/types/index.d.ts

@@ -1,4 +1,6 @@
 export { CLEAR_DIAGRAM_STORAGE_EVENT } from './components/graphwise-reactodia/models/clear-diagram-storage-event';
-export { GRAPHWISE_REACTODIA_ERROR_EVENT } from './components/graphwise-reactodia/models/error/error-report';
+export { GRAPHWISE_REACTODIA_EVENT } from './components/graphwise-reactodia/models/event/event-detail';
+export { EventType } from './components/graphwise-reactodia/models/event/event-type';
+export type { EventDetail } from './components/graphwise-reactodia/models/event/event-detail';
 export { ErrorCode } from './components/graphwise-reactodia/models/error/error-code';
 export type { ErrorReport } from './components/graphwise-reactodia/models/error/error-report';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphwise-reactodia",
-  "version": "0.0.1-TR17",
+  "version": "0.0.1-TR18",
   "description": "Graphwise wrapper around the Reactodia graph explorer.",
   "license": "LGPL-3.0-or-later",
   "author": "Ontotext AD",

package/dist/graphwise-reactodia/p-7lGYbTwb.js

@@ -1 +0,0 @@
-const a="graphwise-reactodia:clear-diagram-storage";var r;!function(a){a.MISSING_REQUIRED_PROP="missing-required-prop",a.DATA_FETCH="data-fetch",a.DIAGRAM_LOAD="diagram-load",a.DIAGRAM_IMPORT="diagram-import",a.LOCAL_DIAGRAM_READ="local-diagram-read",a.LOCAL_DIAGRAM_SAVE="local-diagram-save"}(r||(r={}));export{a as C,r as E}