graphwise-reactodia 0.0.1-TR7 → 0.0.1-TR9

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

@@ -1,6 +1,2 @@
-import { LanguageKey } from './language-key';
-type TranslationBundle = {
-    [language: string]: Record<string, TranslationBundle | string | null>;
-};
-export declare const TRANSLATIONS: Partial<Record<LanguageKey, TranslationBundle>>;
-export {};
+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,4 +1,4 @@
-import { SerializedDiagram, SparqlDataProviderSettings } from '@reactodia/workspace';
+import { SparqlDataProviderSettings } from '@reactodia/workspace';
 import { LanguageKey } from '../i18n/language-key';
 import { ReactodiaConfig } from './reactodia-config';
 /**
@@ -22,15 +22,14 @@ export interface ReactodiaAppProps {
      * and is also used as the initial graph-data language.
      */
     language: LanguageKey;
-    /**
-     * 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;
     /**
      * 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

@@ -1,5 +1,5 @@
 import { SparqlQueryFunction } from '@reactodia/workspace';
-import { ReactodiaSeedLink } from './reactodia-seed-link';
+import { Triple } from './triple';
 /**
  * Host-supplied configuration read once when the workspace mounts (not reactive).
  *
@@ -14,16 +14,18 @@ export interface ReactodiaConfig {
      */
     queryFunction: SparqlQueryFunction;
     /**
-     * IRIs of the entities to place on the canvas on startup. When provided, each IRI is added
+     * 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, so if the resources are not in the DB, then this approach will not work.
+     * 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 edges to place on the canvas on startup. When provided, each link is added to the canvas and we do not
-     * request data from the connected sparql endpoint, since this is meant for non-persisted data, like construct and describe queries.
+     * 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?: ReactodiaSeedLink[];
+    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/{reactodia-seed-link.d.ts → triple.d.ts}

@@ -5,17 +5,13 @@
  * 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, mapping its `rawPredicates` onto {@link predicates}).
+ * `rest/explore-graph/graph` response onto {@link rawPredicates}).
  */
-export interface ReactodiaSeedLink {
+export interface Triple {
     /** Source element IRI. */
     source: string;
     /** Target element IRI. */
     target: string;
-    /**
-     * Short display friendly predicate
-     */
-    predicates: string[];
     /**
      * Full (absolute) predicate IRIs.
      */

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 type The service type to retrieve.
+     * @returns The shared instance of the service.
+     * @template T The type of the service to retrieve.
+     */
+    static get<T>(type: 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;
+}

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

@@ -0,0 +1,26 @@
+import type { SerializedDiagram } from '@reactodia/workspace';
+/**
+ * Service for local store-related diagram operations
+ */
+export declare class DiagramStorageService {
+    static readonly ID = "DiagramStorageService";
+    private static readonly STORAGE_KEY;
+    /**
+     * Load the persisted diagram from the local store, or `undefined` when nothing is stored (or the stored value
+     * is unreadable).
+     */
+    load(): SerializedDiagram | undefined;
+    /**
+     * Persists the given diagram serialization.
+     */
+    save(diagram: SerializedDiagram): void;
+    /**
+     * Removes the persisted diagram. Used when a new view (a seed) should take precedence over
+     * previously saved edits.
+     */
+    clear(): void;
+    /**
+     * Local storage getter
+     */
+    private get storage();
+}

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

@@ -0,0 +1,14 @@
+import { Subscription } from '../../models/subscription';
+/**
+ * Service for event based operations
+ */
+export declare class EventService {
+    static readonly ID = "EventService";
+    /**
+     * Subscribes to the host's "clear persisted diagram" command.
+     *
+     * @param onClear Called whenever the event fires.
+     * @returns A {@link Subscription} that, when called, removes the listener.
+     */
+    subscribeToClearDiagramStorage(onClear: () => void): Subscription;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * Service that provides access to browser window-related functionality.
+ */
+export declare class WindowService {
+    static readonly ID = "WindowService";
+    getWindow(): Window;
+}

package/dist/types/components/graphwise-reactodia/testing/storage.mock.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Minimal in-memory {@link Storage}, so services that read `localStorage` can be exercised
+ * without a real browser store and asserted against directly. Shared across test suites.
+ */
+export declare class StorageMock implements Storage {
+    private readonly store;
+    get length(): number;
+    clear(): void;
+    getItem(key: string): string | null;
+    key(index: number): string | null;
+    removeItem(key: string): void;
+    setItem(key: string, value: string): void;
+}
+/**
+ * Creates a fresh {@link StorageMock}. Suites install the returned instance as the global
+ * `localStorage` themselves.
+ */
+export declare function createStorageMock(): StorageMock;

package/dist/types/index.d.ts

@@ -1 +1 @@
-export {};
+export { CLEAR_DIAGRAM_STORAGE_EVENT } from './components/graphwise-reactodia/models/clear-diagram-storage-event';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphwise-reactodia",
-  "version": "0.0.1-TR7",
+  "version": "0.0.1-TR9",
   "description": "Graphwise wrapper around the Reactodia graph explorer.",
   "license": "Apache-2.0",
   "author": "Ontotext AD",
@@ -9,7 +9,8 @@
   "collection": "dist/collection/collection-manifest.json",
   "exports": {
     ".": {
-      "import": "./dist/graphwise-reactodia/graphwise-reactodia.esm.js",
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
       "require": "./dist/index.cjs.js"
     },
     "./loader": {
@@ -30,16 +31,21 @@
     "start": "npm run reactodia:build && stencil build --dev --watch --serve",
     "cy:open": "cypress open",
     "cy:run": "cypress run",
-    "cy:run:ci": "docker compose --ansi never up --exit-code-from cypress"
+    "cy:run:ci": "docker compose --ansi never up --exit-code-from cypress",
+    "test": "stencil test --spec",
+    "test.watch": "stencil test --spec --watchAll"
   },
   "devDependencies": {
     "@rdfjs/types": "^2.0.1",
     "@reactodia/workspace": "file:./reactodia-workspace",
     "@stencil/core": "4.35.1",
     "@stencil/sass": "^3.2.3",
+    "@types/jest": "^29.5.14",
     "@types/react": "^18.3.12",
     "@types/react-dom": "^18.3.1",
     "cypress": "^15.17.0",
+    "jest": "^29.7.0",
+    "jest-cli": "^29.7.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "rollup-plugin-node-polyfills": "^0.2.1"