@matdata/yasgui 4.6.1

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@matdata/yasgui",
+  "description": "Yet Another SPARQL GUI",
+  "version": "4.6.1",
+  "main": "build/yasgui.min.js",
+  "types": "build/ts/src/index.d.ts",
+  "license": "MIT",
+  "author": "Triply <info@triply.cc>",
+  "homepage": "https://github.com/Matdata-eu/Yasgui",
+  "keywords": [
+    "JavaScript",
+    "SPARQL",
+    "Editor",
+    "Semantic Web",
+    "Linked Data"
+  ],
+  "bugs": "https://github.com/Matdata-eu/Yasgui/issues/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Matdata-eu/Yasgui.git",
+    "directory": "packages/yasgui"
+  },
+  "dependencies": {
+    "@tarekraafat/autocomplete.js": "^7.2.0",
+    "@matdata/yasgui-utils": "^4.6.1",
+    "@matdata/yasqe": "^4.6.1",
+    "@matdata/yasr": "^4.6.1",
+    "autosuggest-highlight": "^3.1.1",
+    "blueimp-md5": "^2.12.0",
+    "choices.js": "^9.0.1",
+    "dompurify": "^3.2.4",
+    "es6-object-assign": "^1.1.0",
+    "jsuri": "^1.3.1",
+    "lodash-es": "^4.17.15",
+    "sortablejs": "^1.10.2",
+    "@matdata/yasgui-graph-plugin": "^1.0.0"
+  },
+  "devDependencies": {
+    "@types/autosuggest-highlight": "^3.1.0",
+    "@types/blueimp-md5": "^2.7.0",
+    "@types/jsuri": "^1.3.30",
+    "@types/lodash-es": "^4.17.3",
+    "@types/node": "^22.5.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/PersistentConfig.ts

@@ -0,0 +1,159 @@
+import { Storage as YStorage } from "@matdata/yasgui-utils";
+import Yasgui from "./";
+import * as Tab from "./Tab";
+export var storageNamespace = "triply";
+export interface PersistedJson {
+  endpointHistory: string[];
+  tabs: string[];
+  active: string | undefined;
+  tabConfig: { [tabId: string]: Tab.PersistedJson };
+  lastClosedTab: { index: number; tab: Tab.PersistedJson } | undefined;
+  prefixes?: string;
+  autoCaptureEnabled?: boolean;
+}
+function getDefaults(): PersistedJson {
+  return {
+    endpointHistory: [],
+    tabs: [],
+    active: undefined,
+    tabConfig: {},
+    lastClosedTab: undefined,
+    prefixes: "",
+    autoCaptureEnabled: true,
+  };
+}
+
+export default class PersistentConfig {
+  private persistedJson!: PersistedJson;
+  private storageId: string | undefined;
+  private yasgui: Yasgui;
+  private storage: YStorage;
+  constructor(yasgui: Yasgui) {
+    this.yasgui = yasgui;
+    this.storageId = this.yasgui.getStorageId(this.yasgui.config.persistenceLabelConfig);
+    this.storage = new YStorage(storageNamespace);
+    this.fromStorage();
+    this.registerListeners();
+  }
+
+  public setActive(id: string) {
+    this.persistedJson.active = id;
+    this.toStorage();
+  }
+  public getActiveId(): string | undefined {
+    return this.persistedJson.active;
+  }
+  public addToTabList(tabId: string, index?: number) {
+    if (index !== undefined && this.persistedJson.tabs.length > index) {
+      this.persistedJson.tabs.splice(index, 0, tabId);
+    } else {
+      this.persistedJson.tabs.push(tabId);
+    }
+
+    this.toStorage();
+  }
+  public setTabOrder(tabs: string[]) {
+    this.persistedJson.tabs = tabs;
+    this.toStorage();
+  }
+  public getEndpointHistory() {
+    return this.persistedJson.endpointHistory;
+  }
+  public retrieveLastClosedTab() {
+    const tabCopy = this.persistedJson.lastClosedTab;
+    if (tabCopy === undefined) return tabCopy;
+    this.persistedJson.lastClosedTab = undefined;
+    return tabCopy;
+  }
+  public hasLastClosedTab() {
+    return !!this.persistedJson.lastClosedTab;
+  }
+  public deleteTab(tabId: string) {
+    const i = this.persistedJson.tabs.indexOf(tabId);
+    if (i > -1) {
+      this.persistedJson.tabs.splice(i, 1);
+    }
+    if (this.tabIsActive(tabId)) {
+      this.persistedJson.active = undefined;
+    }
+    this.persistedJson.lastClosedTab = { index: i, tab: this.persistedJson.tabConfig[tabId] };
+    delete this.persistedJson.tabConfig[tabId];
+    this.toStorage();
+  }
+  private registerListeners() {
+    this.yasgui.on("tabChange", (_yasgui, tab) => {
+      this.persistedJson.tabConfig[tab.getId()] = tab.getPersistedJson();
+      this.toStorage();
+    });
+    this.yasgui.on("endpointHistoryChange", (_yasgui, history) => {
+      this.persistedJson.endpointHistory = history;
+      this.toStorage();
+    });
+  }
+
+  private toStorage() {
+    this.storage.set(
+      this.storageId,
+      this.persistedJson,
+      this.yasgui.config.persistencyExpire,
+      this.handleLocalStorageQuotaFull,
+    );
+  }
+  private fromStorage(): PersistedJson {
+    this.persistedJson = this.storage.get<PersistedJson>(this.storageId) || getDefaults();
+    /**
+     * Modify some settings for backwards compatability
+     */
+    if (!this.persistedJson.endpointHistory) {
+      this.persistedJson.endpointHistory = [];
+    }
+    return this.persistedJson;
+  }
+
+  private handleLocalStorageQuotaFull(_e: any) {
+    console.warn("Localstorage quota exceeded. Clearing all YASGUI configurations");
+    PersistentConfig.clear();
+  }
+
+  public getTabs() {
+    return this.persistedJson.tabs;
+  }
+  public getTab(tabId: string) {
+    return this.persistedJson.tabConfig[tabId];
+  }
+
+  /**
+   * We shouldnt normally need this (as this object simply listens to tab change events)
+   * Only exception is when we're loading a tab config from the url
+   * Then we'd like to forward that config to this object, so we can simply keep initializing from this persistence class
+   */
+  public setTab(tabId: string, tabConfig: Tab.PersistedJson) {
+    this.persistedJson.tabs.push(tabId);
+    this.persistedJson.tabConfig[tabId] = tabConfig;
+    this.persistedJson.active = tabId;
+  }
+  public tabIsActive(tabId: string) {
+    return tabId === this.persistedJson.active;
+  }
+  public currentId() {
+    return this.persistedJson.active;
+  }
+  public getPrefixes(): string {
+    return this.persistedJson.prefixes || "";
+  }
+  public setPrefixes(prefixes: string) {
+    this.persistedJson.prefixes = prefixes;
+    this.toStorage();
+  }
+  public getAutoCaptureEnabled(): boolean {
+    return this.persistedJson.autoCaptureEnabled !== false;
+  }
+  public setAutoCaptureEnabled(enabled: boolean) {
+    this.persistedJson.autoCaptureEnabled = enabled;
+    this.toStorage();
+  }
+  public static clear() {
+    const storage = new YStorage(storageNamespace);
+    storage.removeNamespace();
+  }
+}