graphwise-reactodia 0.0.1-TR1 → 0.0.1-TR10

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

@@ -1,32 +1,37 @@
-import { SparqlDataProviderSettings, SparqlQueryFunction } from '@reactodia/workspace';
+import { SparqlDataProviderSettings } from '@reactodia/workspace';
+import { LanguageKey } from './i18n/language-key';
+import { ReactodiaConfig } from './models/reactodia-config';
 /**
  * A web component that renders a graph with the Reactodia workspace.
  *
  * The component is backed by a SPARQL endpoint but is endpoint-agnostic: the host passes
- * the active repository's endpoint via `current-repository` and a `queryFunction` that
- * performs the actual HTTP request. Reactodia fetches all node, link and type data lazily
- * through them; the canvas starts empty and the user populates it via the search bar.
+ * the active repository's endpoint via `current-repository` and a `config.queryFunction`
+ * that performs the actual HTTP request. Reactodia fetches all node, link and type data
+ * lazily through them; the canvas starts empty and the user populates it via the search bar.
  *
  * The component is a thin wrapper around Reactodia: query configuration lives outside the
  * wrapper and is supplied through the `providerSettings` prop.
  */
 export declare class GraphwiseReactodia {
-    private readonly hostElement;
+    private readonly hostElement?;
     /**
      * The active repository id. Appended to {@link queryFunction} as the request `url`;
      * changing it re-points the graph at the new repository (and resets the canvas),
      * which is how runtime repository changes are handled.
      */
-    currentRepository: string;
+    currentRepository?: string;
     /**
-     * HTTP transport for the SPARQL requests. Set by the host so requests go through the host's HTTP layer (auth,
-     * interceptors) instead of a built-in `fetch`.
+     * 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.
      */
-    queryFunction: SparqlQueryFunction;
+    config?: ReactodiaConfig;
     /**
      * UI language code (e.g. `en`, `fr`) for the Reactodia interface. Defaults to English.
      */
-    language: string;
+    language: LanguageKey;
     /**
      * 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. When omitted,
@@ -34,10 +39,18 @@ export declare class GraphwiseReactodia {
      * the data provider and resets the canvas.
      */
     providerSettings?: SparqlDataProviderSettings;
-    private reactRoot;
+    /**
+     * The theme currently applied by the host (e.g. `light`, `dark`). The value itself is never read -
+     * the node colors are taken from the host's CSS custom properties - it only signals that those
+     * values have changed. The host owns the theme, including whether it follows the OS color scheme,
+     * so the change is passed in instead of being detected here.
+     */
+    theme?: string;
+    private reactRoot?;
     onProviderSettingsChange(): void;
     onLanguageChange(): void;
-    componentDidLoad(): void;
+    onThemeChange(): void;
+    connectedCallback(): void;
     disconnectedCallback(): void;
     render(): any;
     private renderGraph;

package/dist/types/components/graphwise-reactodia/i18n/language-key.d.ts

@@ -0,0 +1,4 @@
+export declare enum LanguageKey {
+    EN = "en",
+    FR = "fr"
+}

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

@@ -1,343 +1,2 @@
-export declare const TRANSLATIONS: {
-    fr: {
-        authoring_state: {
-            "entity_action_delete.label": string;
-            "entity_action_delete.title": string;
-            "entity_action_delete.title_disabled": string;
-            "entity_action_discard.label": string;
-            "entity_action_discard.title": string;
-            "entity_action_edit.label": string;
-            "entity_action_edit.title": string;
-            "entity_action_edit.title_disabled": string;
-            "entity_add.label": string;
-            "entity_change.label": string;
-            "entity_delete.label": string;
-            "relation_action_discard.label": string;
-            "relation_action_discard.title": string;
-            "relation_add.label": string;
-            "relation_change.label": string;
-            "relation_delete.label": string;
-        };
-        classic_workspace: {
-            "canvas.label": string;
-            "class_tree.heading": string;
-            "connections.heading": string;
-            "instances.heading": string;
-        };
-        commands: {
-            "change_entity.title": string;
-            "change_link_type_visibility.title": string;
-            "change_relation.title": string;
-            "collapse_element.title": string;
-            "expand_element.title": string;
-            "place_elements_around.title": string;
-            "restore_geometry.title": string;
-            "restore_link_vertices.title": string;
-            "restore_viewport.title": string;
-            "set_element_state.title": string;
-            "set_entity_data.title": string;
-            "set_entity_group_items.title": string;
-            "set_link_state.title": string;
-            "set_relation_data.title": string;
-            "set_relation_group_items.title": string;
-            "transform_elements.title": string;
-        };
-        connections_menu: {
-            "all_link.label": string;
-            "breadcrumbs_root.label": string;
-            "dialog.caption": string;
-            "entities.add_all": string;
-            "entities.add_group": string;
-            "entities.add_selected": string;
-            "entities.counter_label": string;
-            "entities.extra_label": string;
-            "entities.extra_title": string;
-            "entities.missing_label": string;
-            "entities.missing_title": string;
-            "entities.no_results": string;
-            "entities.truncated_results": string;
-            "entities.truncated_results_expand": string;
-            "input.placeholder": any;
-            "link.both_navigate_title": string;
-            "link.both_title": string;
-            "link.source_navigate_title": string;
-            "link.source_title": string;
-            "link.target_navigate_title": string;
-            "link.target_title": string;
-            "link.move_to_filter.title": string;
-            "links.no_results": string;
-            "links.suggest_similar": string;
-            "place_elements.command": string;
-            "select_all.label": string;
-            "select_all.title": string;
-            "sort_alphabetically.title": string;
-            "sort_smart.title": string;
-        };
-        data_diagram_model: {
-            "add_element.command": string;
-            "add_link.command": string;
-            "create_links.command": string;
-            "group_entities.command": string;
-            "import_layout.command": string;
-            "regroup_relations.command": string;
-            "request_entities.command": string;
-            "request_relations.command": string;
-            "remove_element.command": string;
-            "remove_link.command": string;
-            "ungroup_entities.command": string;
-        };
-        default_data_locale: {
-            iri: string;
-            iri_blank: string;
-        };
-        default_workspace: {
-            "search_section_entities.label": string;
-            "search_section_entities.title": string;
-            "search_section_entity_types.label": string;
-            "search_section_entity_types.title": string;
-            "search_section_link_types.label": string;
-            "search_section_link_types.title": string;
-        };
-        drop_on_canvas: {
-            "drop.command": string;
-        };
-        editor_controller: {
-            "apply_authored_changes.command": string;
-            "discard_change.command": string;
-            "entity_add.command": string;
-            "entity_change.command": string;
-            "entity_delete.command": string;
-            "relation_add.command": string;
-            "relation_change.command": string;
-            "relation_delete.command": string;
-            "relation_move_source.command": string;
-            "relation_move_target.command": string;
-            "remove_items.command": string;
-            "set_authoring_state.command": string;
-            "validate_entity_failed.message": string;
-        };
-        forms: {
-            "input_file.drag_hint": string;
-            "input_file.remove_value.title": string;
-            "input_file.select_files.label": string;
-            "input_list.add_value.title": string;
-            "input_list.remove_value.title": string;
-        };
-        group_paginator: {
-            "current_page.label": string;
-            "go_next.title": string;
-            "go_previous.title": string;
-            "page_size.title": string;
-        };
-        inline_entity: {
-            title: string;
-            title_extra: string;
-        };
-        link_action: {
-            "delete_annotation.title": string;
-            "delete_relation.title": string;
-            "delete_relation.title_disabled": string;
-            "edit_relation.title": string;
-            "edit_relation.title_disabled": string;
-            "rename_link.title": string;
-            "move_relation.move_source_title": string;
-            "move_relation.move_target_title": string;
-            "vertex.remove_title": string;
-        };
-        navigator: {
-            "toggle_collapse.title": string;
-            "toggle_expand.title": string;
-        };
-        note_annotation: {
-            "change_text.command": string;
-            "style_align_center.title": string;
-            "style_align_left.title": string;
-            "style_align_right.title": string;
-            "style_bold.title": string;
-            "style_color_variant.title": string;
-            "style_italic.title": string;
-            "style_strikethrough.title": string;
-            "style_underline.title": string;
-        };
-        overlay_controller: {
-            multiple_tasks_in_progress: string;
-            unknown_error: string;
-        };
-        search_defaults: {
-            empty_input_term: string;
-            "input.placeholder": string;
-            "input_clear.title": string;
-            "input_submit.title": string;
-            input_term_too_short: string;
-            no_results: string;
-        };
-        search_element_types: {
-            "drag_create.title": string;
-            "input.placeholder": any;
-            no_results: string;
-            "refresh_progress.title": string;
-            show_only_creatable: string;
-        };
-        search_entities: {
-            "add_group.label": string;
-            "add_group.title": string;
-            "add_selected.label": string;
-            "add_selected.title": string;
-            criteria_has_type: string;
-            criteria_connected: string;
-            criteria_connected_via: string;
-            criteria_connected_to_source: string;
-            criteria_connected_to_target: string;
-            "input.placeholder": any;
-            "place_elements.command": string;
-            "query_progress.title": string;
-            "show_more_results.label": string;
-            "show_more_results.title": string;
-        };
-        search_link_types: {
-            "add_to_filter.title": string;
-            heading_connected: string;
-            heading_connected_single: string;
-            heading_other: string;
-            "input.placeholder": any;
-            no_results: string;
-            "switch.command": string;
-            "switch_all.label": string;
-            "switch_hidden.title": string;
-            "switch_visible.title": string;
-            "switch_without_label.title": string;
-        };
-        selection_action: {
-            "add_to_filter.title": string;
-            "anchor.title": string;
-            "annotate.defaultContent": string;
-            "annotate.title": string;
-            "connections.title": string;
-            "expand.collapse_command": string;
-            "expand.expand_command": string;
-            "expand.title": string;
-            "expand.title_single": string;
-            "establish_relation.title": string;
-            "establish_relation.title_disabled": string;
-            "group.title": string;
-            "group.title_ungroup": string;
-            "layout.title": string;
-            "remove.title": string;
-            "remove.title_new": string;
-            "remove.title_single": string;
-            "zoom_to_fit.title": string;
-        };
-        standard_element: {
-            blank_node: string;
-            default_type: string;
-            "delete.label": string;
-            "delete.title": string;
-            "delete.title_disabled": string;
-            "edit.label": string;
-            "edit.title": string;
-            "edit.title_disabled": string;
-            "group_item.title": string;
-            "iri.label": string;
-            "iri.label_modified": string;
-            no_properties: string;
-            "property.title": string;
-            "ungroup.title": string;
-        };
-        standard_link: {
-            "group_source.title": string;
-            "group_source.value": string;
-            "group_target.title": string;
-            "group_target.value": string;
-            "label.title": string;
-            "property.title": string;
-        };
-        toolbar: {
-            "menu_toggle.title": string;
-        };
-        toolbar_action: {
-            "clear_all.command": string;
-            "clear_all.title": string;
-            "clear_all.label": string;
-            "export_print.label": string;
-            "export_print.title": string;
-            "export_raster.label": string;
-            "export_raster.title": string;
-            "export_svg.label": string;
-            "export_svg.title": string;
-            "redo.label": string;
-            "redo.title": string;
-            "redo.title_named": string;
-            "save_authoring.title": string;
-            "save_layout.title": string;
-            "language_selector.title": string;
-            "layout.label": string;
-            "layout.title": string;
-            "undo.label": string;
-            "undo.title": string;
-            "undo.title_named": string;
-        };
-        unified_search: {
-            "input.placeholder": any;
-            "input_clear.title": string;
-            "input_collapse.title": string;
-        };
-        visual_authoring: {
-            "dialog.apply.label": string;
-            "dialog.apply.title": string;
-            "dialog.cancel.label": string;
-            "dialog.cancel.title": string;
-            "edit_entity.dialog.apply.label": any;
-            "edit_entity.dialog.apply.title": any;
-            "edit_entity.dialog.caption": string;
-            "edit_entity.iri.label": string;
-            "edit_entity.iri.placeholder": string;
-            "edit_relation.dialog.apply.label": any;
-            "edit_relation.dialog.apply.title": any;
-            "edit_relation.dialog.caption": string;
-            "edit_relation.dialog.caption_new": string;
-            "edit_relation.validation_progress.title": string;
-            "find_or_create.connect_command": string;
-            "find_or_create.create_command": string;
-            "find_or_create.dialog.apply.label": any;
-            "find_or_create.dialog.apply.title": any;
-            "find_or_create.dialog.caption": string;
-            "find_or_create.loading.label": string;
-            "find_or_create.validation_progress.title": string;
-            "property.label": string;
-            "property.text_value.placeholder": string;
-            "property.title": string;
-            "rename_link.dialog.apply.label": any;
-            "rename_link.dialog.apply.title": any;
-            "rename_link.dialog.caption": string;
-            "rename_link.label.label": string;
-            "select_entity.entity_type.label": string;
-            "select_entity.input.placeholder": any;
-            "select_entity.type.label": string;
-            "select_entity.type.placeholder": string;
-            "select_entity.results.aria_label": string;
-            "select_entity.separator.label": string;
-            "select_entity.validation.error_required": string;
-            "select_relation.relation_type.label": string;
-            "select_relation.type.label": string;
-            "select_relation.type.placeholder": string;
-            "select_relation.validation.error_duplicate": string;
-            "select_relation.validation.error_required": string;
-        };
-        workspace: {
-            "group_entities.command": string;
-            "perform_layout.task": string;
-            "perform_layout.command": string;
-            "ungroup_entities.command": string;
-        };
-        workspace_layout: {
-            "toggle_collapse.title": string;
-            "toggle_expand.title": string;
-        };
-        zoom_control: {
-            "pointer_mode.title": string;
-            "zoom_in.title": string;
-            "zoom_out.title": string;
-            "zoom_to_fit.title": string;
-        };
-    };
-};
+export type TranslationBundle = Record<string, Record<string, string | null> | string>;
+export declare const TRANSLATIONS: Partial<Record<string, TranslationBundle>>;

package/dist/types/components/graphwise-reactodia/models/clear-diagram-storage-event.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 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.
+ */
+export declare const CLEAR_DIAGRAM_STORAGE_EVENT = "graphwise-reactodia:clear-diagram-storage";

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

@@ -1,34 +1,35 @@
-import { SerializedDiagram, SparqlDataProviderSettings, SparqlQueryFunction } from '@reactodia/workspace';
+import { SparqlDataProviderSettings } from '@reactodia/workspace';
+import { LanguageKey } from '../i18n/language-key';
+import { ReactodiaConfig } from './reactodia-config';
 /**
  * Props for the internal Reactodia React application.
  */
 export interface ReactodiaAppProps {
     /**
      * The active repository id. Passed to the SPARQL data provider as its `endpointUrl` and
-     * surfaced to {@link queryFunction} as the request `url`, which the host transport uses to
-     * target the repository. Changing it re-points the diagram at a different repository.
+     * surfaced to the {@link ReactodiaConfig.queryFunction} as the request `url`, which the host
+     * transport uses to target the repository. Changing it re-points the diagram at a different
+     * repository.
      */
     currentRepository: string;
     /**
-     * Transport for the SPARQL requests. The host owns the connection (auth, interceptors,
-     * base URL) inside this function; Reactodia delegates every SPARQL call to it instead
-     * of using the built-in `fetch`.
+     * Host-supplied configuration read once on mount: the SPARQL transport and the optional
+     * set of entities to pre-populate the canvas with.
      */
-    queryFunction: SparqlQueryFunction;
+    config: ReactodiaConfig;
     /**
      * UI language code (e.g. `en`, `fr`); selects the Reactodia translation bundle
      * and is also used as the initial graph-data language.
      */
-    language: string;
-    /**
-     * A previously exported diagram to restore on mount. Used to carry the user's current
-     * canvas across a remount (e.g. forced by a language change). When omitted, the canvas
-     * starts empty.
-     */
-    initialDiagram?: SerializedDiagram;
+    language: LanguageKey;
     /**
      * Query preset for the SPARQL data provider, owned and configured by the host. Falls back
      * to Reactodia's generic `OwlRdfsSettings` OWL/RDFS preset when omitted.
      */
     providerSettings?: SparqlDataProviderSettings;
+    /**
+     * When true, the host is remounting the component switch languages, so the workspace should not be seeded, if a seed is present.
+     * Rather, the current state should simply be reloaded.
+     */
+    isReload?: boolean;
 }

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

@@ -0,0 +1,31 @@
+import { SparqlQueryFunction } from '@reactodia/workspace';
+import { Triple } from './triple';
+/**
+ * Host-supplied configuration read once when the workspace mounts (not reactive).
+ *
+ * Groups the inputs the host wires up before the graph is created: the SPARQL transport
+ * and the optional set of entities to pre-populate the canvas with. Passed to the
+ * `graphwise-reactodia` component as a single DOM property (an object, not an attribute).
+ */
+export interface ReactodiaConfig {
+    /**
+     * HTTP transport for the SPARQL requests. Set by the host so requests go through the host's
+     * HTTP layer (auth, interceptors) instead of a built-in `fetch`.
+     */
+    queryFunction: SparqlQueryFunction;
+    /**
+     * IRIs of the elements(nodes) to place on the canvas on startup. When provided, each IRI is added
+     * as an element and its data (labels, types, properties) and links are resolved from the
+     * SPARQL provider, then the workspace lays them out. Note that when using this seed method reactodia will request data
+     * from the connected sparql endpoint for both elements and links, so if the resources are not in the DB, then this approach will not work.
+     * (e.g. in the case of a construct query)
+     */
+    seedIris?: string[];
+    /**
+     * Pre-resolved triples (source, rawPredicate, target) to place on the canvas on startup. Date for the links is provided
+     * here, so reactodia will not request data for them. Data for nodes will be requested based on the IRIs of the source
+     * and target of the links. This is useful for visualizing the result of a CONSTRUCT query, whose relationships are
+     * computed and not persisted in the repository
+     */
+    seedGraph?: Triple[];
+}

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

@@ -0,0 +1,26 @@
+import { Subscription } from './subscription';
+/**
+ * A collection of {@link Subscription}s that can be released together. Components collect the
+ * subscriptions they open and call {@link unsubscribeAll} on teardown so nothing is left
+ * listening.
+ */
+export declare class SubscriptionList {
+    private items;
+    constructor(subscriptions?: Subscription[]);
+    /**
+     * Adds a subscription to the list.
+     */
+    add(subscription: Subscription): void;
+    /**
+     * Adds multiple subscriptions to the list.
+     */
+    addAll(subscriptions: Subscription[]): void;
+    /**
+     * Removes a subscription from the list without unsubscribing it.
+     */
+    remove(subscription: Subscription): void;
+    /**
+     * Calls every subscription (unsubscribing it) and clears the list.
+     */
+    unsubscribeAll(): void;
+}

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

@@ -0,0 +1,4 @@
+/**
+ * A subscription: calling it unsubscribes (removes the underlying listener).
+ */
+export type Subscription = () => void;

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

@@ -0,0 +1,19 @@
+/**
+ * A pre-resolved edge to place on the canvas on startup, mirroring GraphDB's
+ * `rest/explore-graph` link shape. Used to visualize the result of a CONSTRUCT query, whose
+ * relationships are computed and therefore not persisted in the repository, so they cannot be
+ * fetched lazily through the SPARQL provider and must be supplied directly.
+ *
+ * The host adapts its source data into this neutral shape (e.g. the workbench maps the
+ * `rest/explore-graph/graph` response onto {@link rawPredicates}).
+ */
+export interface Triple {
+    /** Source element IRI. */
+    source: string;
+    /** Target element IRI. */
+    target: string;
+    /**
+     * Full (absolute) predicate IRIs.
+     */
+    rawPredicates: string[];
+}

package/dist/types/components/graphwise-reactodia/providers/service/service-inject.d.ts

@@ -0,0 +1,13 @@
+import { Service } from './service';
+/**
+ * Injects the singleton instance of the given service class from the {@link ServiceProvider}.
+ *
+ * @param serviceClass The class of the service to inject.
+ * @returns The shared instance of the specified service class.
+ * @template T The type of the service to inject.
+ * @example
+ * ```typescript
+ * const diagramStateService = service(DiagramStateService);
+ * ```
+ */
+export declare function service<T>(serviceClass: Service<T>): T;

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

@@ -0,0 +1,28 @@
+/**
+ * Interface for injectable services by the service provider. Each service needs to have a static unique ID, which
+ * is used by the {@link ServiceProvider} to cache and retrieve the singleton instance of the service. Unique IDs ensure
+ * correct working of the service provider, when the services are minified
+ *
+ * @template T the type of the service
+ */
+export interface Service<T> {
+    readonly ID: string;
+    new (): T;
+}
+/**
+ * Decorator for a service class.
+ * It receives the class and simply type checks it with the {@link Service} interface.
+ * Works as a contract, which enforces the service class to have a static ID member.
+ * We can't simply implement the interface, since this will enforce the ID to be an instance member, which is not what we want.
+ *
+ * @param _serviceClass The decorated service class, checked for its ID and discarded.
+ * @template T The type of the service instance.
+ * @example
+ * ```TypeScript
+ * @Service
+ * export class WindowService {
+ *   static readonly ID = 'WindowService';
+ * }
+ * ```
+ */
+export declare function Service<T>(_serviceClass: Service<T>): void;

package/dist/types/components/graphwise-reactodia/providers/service/service.provider.d.ts

@@ -0,0 +1,16 @@
+import { Service } from './service';
+/**
+ * Provider for all {@link Service} instances. Services are singletons: there is only one
+ * instance of each service, created on demand and cached here so every consumer shares it.
+ */
+export declare class ServiceProvider {
+    private static readonly SERVICE_INSTANCES;
+    /**
+     * Returns the instance of the given service type, creating and caching it on first request.
+     *
+     * @param serviceClass The service type to retrieve.
+     * @returns The shared instance of the service.
+     * @template T The type of the service to retrieve.
+     */
+    static get<T>(serviceClass: Service<T>): T;
+}

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

@@ -0,0 +1,26 @@
+import type { DataDiagramModel, SerializedDiagram } from '@reactodia/workspace';
+import { Subscription } from '../../models/subscription';
+/**
+ * Callback invoked with the current diagram layout whenever it changes.
+ */
+export type DiagramChangeCallback = (diagram: SerializedDiagram) => void;
+/**
+ * Service for diagram related operations and subscriptions
+ */
+export declare class DiagramService {
+    static readonly ID = "DiagramService";
+    private static readonly NOTIFY_DEBOUNCE_MS;
+    private static readonly HISTORY_CHANGED_EVENT;
+    /**
+     * Subscribes to diagram changes. On every debounced change the current layout is
+     * exported and passed to the callback.
+     * Debounce time for the callback trigger is needed, because certain events (like moving a node) can trigger
+     * multiple `historyChanged` events in a short time.
+     *
+     * @param model The diagram model to observe.
+     * @param onChangeCallback Called with the exported layout when the diagram changes.
+     * @returns A {@link Subscription} that, when called, removes the listener and drops any
+     * pending notification.
+     */
+    subscribeToDiagramChange(model: DataDiagramModel, onChangeCallback: DiagramChangeCallback): Subscription;
+}