graphwise-reactodia 0.0.1-TR19 → 0.0.1-TR20

package/dist/graphwise-reactodia/p-fwJ3Zupw.js

@@ -0,0 +1 @@
+const a="graphwise-reactodia:clear-diagram-storage";var n,o,r,e,i;!function(a){a.ERROR="error",a.TEXT_SEARCH="text-search"}(n||(n={})),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",a.UNKNOWN_UI_CONFIG="unknown-ui-config"}(o||(o={})),function(a){a.NW="nw",a.N="n",a.NE="ne",a.E="e",a.SE="se",a.S="s",a.SW="sw",a.W="w"}(r||(r={})),function(a){a.CLEAR_ALL="clear-all",a.EXPORT_PNG="export-png",a.EXPORT_SVG="export-svg",a.PRINT="print",a.EXPORT_JSON="export-json",a.IMPORT_JSON="import-json"}(e||(e={})),function(a){a.GROUP="group",a.REMOVE="remove",a.EXPAND="expand",a.OPEN_LINK="open-link",a.CONNECTIONS="connections",a.ADD_TO_FILTER="add-to-filter",a.ANNOTATE="annotate",a.ESTABLISH_LINK="establish-link"}(i||(i={}));export{a as C,n as E,e as M,i as N,r as T,o as a}

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

@@ -24,9 +24,9 @@ export declare class GraphwiseReactodia {
      */
     currentRepository?: string;
     /**
-     * Host-supplied configuration: the SPARQL `queryFunction` transport and an optional `seed`
-     * set of entities to pre-populate the canvas with. A DOM property (an object, not an
-     * attribute) passed in from outside the wrapper.
+     * Host-supplied configuration: the SPARQL `queryFunction` transport, an optional `seed`
+     * set of entities to pre-populate the canvas with and an optional `ui` configuration.
+     * A DOM property (an object, not an attribute) passed in from outside the wrapper.
      *
      * Read once on mount; not watched, as it only sets up the data source and initial canvas.
      */

package/dist/types/components/graphwise-reactodia/menu/export-diagram-action.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Exports the diagram as a JSON file.
+ */
+export declare function ExportDiagramAction(): import("react").FunctionComponentElement<import("@reactodia/workspace").ToolbarActionProps>;

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

@@ -1,9 +1,6 @@
+import { ReactElement } from 'react';
+import { MenuItem } from '../models/ui/menu-item';
 /**
- * The workspace main menu: Reactodia's default actions, followed by the diagram download and upload.
- *
- * Passing a `menu` to the `DefaultWorkspace` replaces its default actions, so they are listed here again.
- * Rendered inside the workspace, so the actions can use the workspace hooks.
+ * The menu entries for the given menu items.
  */
-export declare function GraphwiseMenu(): import("react").FunctionComponentElement<{
-    children?: import("react").ReactNode | undefined;
-}>;
+export declare function createMenuItems(items: MenuItem[]): ReactElement[];

package/dist/types/components/graphwise-reactodia/menu/import-diagram-action.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Imports a diagram from a JSON file into the workspace.
+ */
+export declare function ImportDiagramAction(): import("react").FunctionComponentElement<import("@reactodia/workspace").ToolbarActionOpenProps>;

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

@@ -13,5 +13,7 @@ export declare enum ErrorCode {
     /** Reading the diagram from local storage failed. */
     LOCAL_DIAGRAM_READ = "local-diagram-read",
     /** Saving the diagram in local storage failed. */
-    LOCAL_DIAGRAM_SAVE = "local-diagram-save"
+    LOCAL_DIAGRAM_SAVE = "local-diagram-save",
+    /** The host's UI configuration has an unknown value, which is skipped. */
+    UNKNOWN_UI_CONFIG = "unknown-ui-config"
 }

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

@@ -1,5 +1,6 @@
-import { SparqlQueryFunction } from '@reactodia/workspace';
+import { SparqlQueryFunction } from './sparql/sparql-query-function';
 import { Triple } from './triple';
+import { UiConfig } from './ui/ui-config';
 /**
  * Host-supplied configuration read once when the workspace mounts (not reactive).
  *
@@ -28,4 +29,8 @@ export interface ReactodiaConfig {
      * computed and not persisted in the repository
      */
     seedGraph?: Triple[];
+    /**
+     * A partial UI configuration, merged over the default UI configuration. JSON-serializable.
+     */
+    ui?: UiConfig;
 }

package/dist/types/components/graphwise-reactodia/models/sparql/sparql-query-function.d.ts

@@ -0,0 +1,6 @@
+import { SparqlQueryParams } from './sparql-query-params';
+/**
+ * HTTP transport for the SPARQL requests. The data provider passes it to the fork, so the compiler checks it against
+ * the fork's `SparqlQueryFunction`.
+ */
+export type SparqlQueryFunction = (params: SparqlQueryParams) => Promise<Response>;

package/dist/types/components/graphwise-reactodia/models/sparql/sparql-query-params.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The HTTP request a {@link SparqlQueryFunction} sends.
+ */
+export interface SparqlQueryParams {
+    url: string;
+    body?: string;
+    headers: {
+        [header: string]: string;
+    };
+    method: string;
+    signal?: AbortSignal;
+}

package/dist/types/components/graphwise-reactodia/models/ui/menu-config.d.ts

@@ -0,0 +1,8 @@
+import { MenuItem } from './menu-item';
+/**
+ * The workspace main menu.
+ */
+export interface MenuConfig {
+    /** The menu entries, in order. An empty list hides the menu. */
+    items?: MenuItem[];
+}

package/dist/types/components/graphwise-reactodia/models/ui/menu-item.d.ts

@@ -0,0 +1,17 @@
+/**
+ * An entry of the workspace main menu.
+ */
+export declare enum MenuItem {
+    /** Removes all nodes from the diagram. */
+    CLEAR_ALL = "clear-all",
+    /** Exports the diagram as a PNG image. */
+    EXPORT_PNG = "export-png",
+    /** Exports the diagram as an SVG image. */
+    EXPORT_SVG = "export-svg",
+    /** Prints the diagram. */
+    PRINT = "print",
+    /** Exports the diagram as a JSON file. */
+    EXPORT_JSON = "export-json",
+    /** Imports a diagram from a JSON file. */
+    IMPORT_JSON = "import-json"
+}

package/dist/types/components/graphwise-reactodia/models/ui/node-action.d.ts

@@ -0,0 +1,21 @@
+/**
+ * A button shown around a selected node that acts on it.
+ */
+export declare enum NodeAction {
+    /** Groups or ungroups the selected nodes. */
+    GROUP = "group",
+    /** Removes the node from the diagram. */
+    REMOVE = "remove",
+    /** Expands or collapses the node to show its properties. */
+    EXPAND = "expand",
+    /** Opens the node IRI. */
+    OPEN_LINK = "open-link",
+    /** Opens the menu to navigate to connected nodes. */
+    CONNECTIONS = "connections",
+    /** Searches for nodes connected to this one. */
+    ADD_TO_FILTER = "add-to-filter",
+    /** Adds an annotation to the node. */
+    ANNOTATE = "annotate",
+    /** Draws a new link from the node; for an entity, only in authoring mode. */
+    ESTABLISH_LINK = "establish-link"
+}

package/dist/types/components/graphwise-reactodia/models/ui/resolved-toolbar-position.d.ts

@@ -0,0 +1,8 @@
+import { ToolbarDock } from './toolbar-dock';
+import { ToolbarPosition } from './toolbar-position';
+/**
+ * A toolbar position with its dock set.
+ */
+export interface ResolvedToolbarPosition extends ToolbarPosition {
+    dock: ToolbarDock;
+}

package/dist/types/components/graphwise-reactodia/models/ui/resolved-ui-config.d.ts

@@ -0,0 +1,12 @@
+import { MenuConfig } from './menu-config';
+import { NodeAction } from './node-action';
+import { ResolvedToolbarPosition } from './resolved-toolbar-position';
+/**
+ * The host's UI configuration merged over the default, with every field set.
+ */
+export interface ResolvedUiConfig {
+    mainToolbar: ResolvedToolbarPosition;
+    actionsToolbar: ResolvedToolbarPosition;
+    menu: Required<MenuConfig>;
+    nodeActions: NodeAction[];
+}

package/dist/types/components/graphwise-reactodia/models/ui/toolbar-dock.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The side or corner of the canvas a toolbar is docked to.
+ */
+export declare enum ToolbarDock {
+    NW = "nw",
+    N = "n",
+    NE = "ne",
+    E = "e",
+    SE = "se",
+    S = "s",
+    SW = "sw",
+    W = "w"
+}

package/dist/types/components/graphwise-reactodia/models/ui/toolbar-position.d.ts

@@ -0,0 +1,11 @@
+import { ToolbarDock } from './toolbar-dock';
+/**
+ * Where a toolbar is placed on the canvas.
+ */
+export interface ToolbarPosition {
+    dock?: ToolbarDock;
+    /** Horizontal offset from the dock, in pixels. */
+    offsetX?: number;
+    /** Vertical offset from the dock, in pixels. */
+    offsetY?: number;
+}

package/dist/types/components/graphwise-reactodia/models/ui/ui-config.d.ts

@@ -0,0 +1,17 @@
+import { MenuConfig } from './menu-config';
+import { NodeAction } from './node-action';
+import { ToolbarPosition } from './toolbar-position';
+/**
+ * The UI configuration a host passes. It is partial and merged over the default UI configuration: objects are merged
+ * key by key, lists replace the default whole.
+ */
+export interface UiConfig {
+    /** The toolbar with the menu and the search. */
+    mainToolbar?: ToolbarPosition;
+    /** The toolbar with undo, redo and layout. */
+    actionsToolbar?: ToolbarPosition;
+    /** The main menu in the main toolbar. */
+    menu?: MenuConfig;
+    /** The actions shown around a selected node. */
+    nodeActions?: NodeAction[];
+}

package/dist/types/components/graphwise-reactodia/node-action/node-actions.d.ts

@@ -0,0 +1,6 @@
+import { ReactElement } from 'react';
+import { NodeAction } from '../models/ui/node-action';
+/**
+ * The `Halo` children for the given node actions.
+ */
+export declare function createNodeActions(actions: NodeAction[]): ReactElement[];

package/dist/types/components/graphwise-reactodia/ui-config/default-ui-config.d.ts

@@ -0,0 +1,5 @@
+import { ResolvedUiConfig } from '../models/ui/resolved-ui-config';
+/**
+ * The default UI configuration: Reactodia's behaviour, plus the diagram download and upload in the menu.
+ */
+export declare const DEFAULT_UI_CONFIG: ResolvedUiConfig;

package/dist/types/components/graphwise-reactodia/ui-config/ui-config-mapper.d.ts

@@ -0,0 +1,14 @@
+import { DefaultWorkspaceProps } from '@reactodia/workspace';
+import { UiConfig } from '../models/ui/ui-config';
+/**
+ * The `DefaultWorkspace` props the UI configuration sets.
+ */
+export type UiConfigProps = Pick<DefaultWorkspaceProps, 'menu' | 'mainToolbar' | 'actionsToolbar' | 'halo'>;
+/**
+ * Merges the host's UI configuration over the default and maps the result to `DefaultWorkspace` props. A `null` or
+ * missing field keeps the default; objects merge key by key and lists replace the default whole. Unknown values are
+ * reported and left out; a repeated list entry is kept once.
+ *
+ * @param ui The host's UI configuration.
+ */
+export declare function toWorkspaceProps(ui: UiConfig | undefined): UiConfigProps;

package/dist/types/components/graphwise-reactodia/utils/object-util.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Merges an object with default values. Ported from the GraphDB Workbench `ObjectUtil.mergeWithDefaults`.
+ *
+ * For each property in `defaults`, if the value in `object` is `null` or `undefined`, the default value is used instead.
+ * Nested objects are merged recursively. Arrays and other non-plain values are treated as single values and are not
+ * merged.
+ *
+ * The returned object is a new object and does not share references with the inputs. The inputs must be
+ * structured-cloneable.
+ *
+ * @param object Source object whose values take precedence over defaults.
+ * @param defaults Default values applied when properties are missing or null.
+ * @returns A new object containing the merged result.
+ */
+export declare function mergeWithDefaults<T extends object>(object: object, defaults: T): T;

package/dist/types/components.d.ts

@@ -25,7 +25,7 @@ export namespace Components {
      */
     interface GraphwiseReactodia {
         /**
-          * Host-supplied configuration: the SPARQL `queryFunction` transport and an optional `seed` set of entities to pre-populate the canvas with. A DOM property (an object, not an attribute) passed in from outside the wrapper.  Read once on mount; not watched, as it only sets up the data source and initial canvas.
+          * Host-supplied configuration: the SPARQL `queryFunction` transport, an optional `seed` set of entities to pre-populate the canvas with and an optional `ui` configuration. A DOM property (an object, not an attribute) passed in from outside the wrapper.  Read once on mount; not watched, as it only sets up the data source and initial canvas.
          */
         "config"?: ReactodiaConfig;
         /**
@@ -94,7 +94,7 @@ declare namespace LocalJSX {
      */
     interface GraphwiseReactodia {
         /**
-          * Host-supplied configuration: the SPARQL `queryFunction` transport and an optional `seed` set of entities to pre-populate the canvas with. A DOM property (an object, not an attribute) passed in from outside the wrapper.  Read once on mount; not watched, as it only sets up the data source and initial canvas.
+          * Host-supplied configuration: the SPARQL `queryFunction` transport, an optional `seed` set of entities to pre-populate the canvas with and an optional `ui` configuration. A DOM property (an object, not an attribute) passed in from outside the wrapper.  Read once on mount; not watched, as it only sets up the data source and initial canvas.
          */
         "config"?: ReactodiaConfig;
         /**

package/dist/types/index.d.ts

@@ -4,3 +4,12 @@ export { EventType } from './components/graphwise-reactodia/models/event/event-t
 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';
+export type { ReactodiaConfig } from './components/graphwise-reactodia/models/reactodia-config';
+export type { Triple } from './components/graphwise-reactodia/models/triple';
+export type { SparqlQueryFunction } from './components/graphwise-reactodia/models/sparql/sparql-query-function';
+export type { SparqlQueryParams } from './components/graphwise-reactodia/models/sparql/sparql-query-params';
+export type { UiConfig } from './components/graphwise-reactodia/models/ui/ui-config';
+export type { ToolbarPosition } from './components/graphwise-reactodia/models/ui/toolbar-position';
+export { ToolbarDock } from './components/graphwise-reactodia/models/ui/toolbar-dock';
+export { MenuItem } from './components/graphwise-reactodia/models/ui/menu-item';
+export { NodeAction } from './components/graphwise-reactodia/models/ui/node-action';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphwise-reactodia",
-  "version": "0.0.1-TR19",
+  "version": "0.0.1-TR20",
   "description": "Graphwise wrapper around the Reactodia graph explorer.",
   "license": "LGPL-3.0-or-later",
   "author": "Ontotext AD",
@@ -52,5 +52,8 @@
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "rollup-plugin-node-polyfills": "^0.2.1"
+  },
+  "overrides": {
+    "vitest": "^4.1.12"
   }
 }

package/dist/cjs/error-code-BjU_V9e8.js

@@ -1,37 +0,0 @@
-'use strict';
-
-/**
- * Event name for clearing the local store state of the diagram. There is an event listener listening for it, which
- * will clear the local store state, whenever this event is fired.
- */
-const CLEAR_DIAGRAM_STORAGE_EVENT = 'graphwise-reactodia:clear-diagram-storage';
-
-/**
- * The kind of event the wrapper announces to the host. It selects the payload of an {@link EventDetail}.
- */
-exports.EventType = void 0;
-(function (EventType) {
-    EventType["ERROR"] = "error";
-    EventType["TEXT_SEARCH"] = "text-search";
-})(exports.EventType || (exports.EventType = {}));
-
-/**
- * The stable category of a reported error. The host uses it to choose its own message.
- */
-exports.ErrorCode = void 0;
-(function (ErrorCode) {
-    /** A required prop is missing. */
-    ErrorCode["MISSING_REQUIRED_PROP"] = "missing-required-prop";
-    /** A SPARQL data provider call failed. */
-    ErrorCode["DATA_FETCH"] = "data-fetch";
-    /** The startup load, a reload or a repository switch failed. */
-    ErrorCode["DIAGRAM_LOAD"] = "diagram-load";
-    /** The uploaded file was rejected or its import failed. */
-    ErrorCode["DIAGRAM_IMPORT"] = "diagram-import";
-    /** Reading the diagram from local storage failed. */
-    ErrorCode["LOCAL_DIAGRAM_READ"] = "local-diagram-read";
-    /** Saving the diagram in local storage failed. */
-    ErrorCode["LOCAL_DIAGRAM_SAVE"] = "local-diagram-save";
-})(exports.ErrorCode || (exports.ErrorCode = {}));
-
-exports.CLEAR_DIAGRAM_STORAGE_EVENT = CLEAR_DIAGRAM_STORAGE_EVENT;

package/dist/esm/error-code-HfC639tc.js

@@ -1,35 +0,0 @@
-/**
- * Event name for clearing the local store state of the diagram. There is an event listener listening for it, which
- * will clear the local store state, whenever this event is fired.
- */
-const CLEAR_DIAGRAM_STORAGE_EVENT = 'graphwise-reactodia:clear-diagram-storage';
-
-/**
- * The kind of event the wrapper announces to the host. It selects the payload of an {@link EventDetail}.
- */
-var EventType;
-(function (EventType) {
-    EventType["ERROR"] = "error";
-    EventType["TEXT_SEARCH"] = "text-search";
-})(EventType || (EventType = {}));
-
-/**
- * The stable category of a reported error. The host uses it to choose its own message.
- */
-var ErrorCode;
-(function (ErrorCode) {
-    /** A required prop is missing. */
-    ErrorCode["MISSING_REQUIRED_PROP"] = "missing-required-prop";
-    /** A SPARQL data provider call failed. */
-    ErrorCode["DATA_FETCH"] = "data-fetch";
-    /** The startup load, a reload or a repository switch failed. */
-    ErrorCode["DIAGRAM_LOAD"] = "diagram-load";
-    /** The uploaded file was rejected or its import failed. */
-    ErrorCode["DIAGRAM_IMPORT"] = "diagram-import";
-    /** Reading the diagram from local storage failed. */
-    ErrorCode["LOCAL_DIAGRAM_READ"] = "local-diagram-read";
-    /** Saving the diagram in local storage failed. */
-    ErrorCode["LOCAL_DIAGRAM_SAVE"] = "local-diagram-save";
-})(ErrorCode || (ErrorCode = {}));
-
-export { CLEAR_DIAGRAM_STORAGE_EVENT as C, EventType as E, ErrorCode as a };

package/dist/graphwise-reactodia/p-HfC639tc.js

@@ -1 +0,0 @@
-const a="graphwise-reactodia:clear-diagram-storage";var r,e;!function(a){a.ERROR="error",a.TEXT_SEARCH="text-search"}(r||(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"}(e||(e={}));export{a as C,r as E,e as a}