@matdata/yasr 4.6.1

package/CHANGELOG.md

@@ -0,0 +1,150 @@
+# Change Log
+
+## 4.6.1
+
+### Patch Changes
+
+- 2285bff: Fix the display of results of DESCRIBE and CONSTRUCT queries.
+- Updated dependencies [2285bff]
+  - @zazuko/yasqe@4.6.1
+  - @zazuko/yasgui-utils@4.6.1
+
+## 4.6.0
+
+### Patch Changes
+
+- 2e04999: Upgrade various dependencies
+- 0cd6b8e: Fix the documentation links
+- Updated dependencies [2e04999]
+  - @zazuko/yasqe@4.6.0
+  - @zazuko/yasgui-utils@4.6.0
+
+## 4.5.0
+
+### Patch Changes
+
+- @zazuko/yasgui-utils@4.5.0
+- @zazuko/yasqe@4.5.0
+
+## 4.4.3
+
+### Patch Changes
+
+- Updated dependencies [b835764]
+  - @zazuko/yasqe@4.4.3
+  - @zazuko/yasgui-utils@4.4.3
+
+## 4.4.2
+
+### Patch Changes
+
+- Updated dependencies [c7ae45e]
+  - @zazuko/yasqe@4.4.2
+  - @zazuko/yasgui-utils@4.4.2
+
+## 4.4.1
+
+### Patch Changes
+
+- @zazuko/yasgui-utils@4.4.1
+- @zazuko/yasqe@4.4.1
+
+## 4.4.0
+
+### Minor Changes
+
+- 2489238: Replace `superagent` with standard `fetch` (from @vemonet in #19)
+
+### Patch Changes
+
+- Updated dependencies [2489238]
+  - @zazuko/yasqe@4.4.0
+  - @zazuko/yasgui-utils@4.4.0
+
+## 4.3.3
+
+### Patch Changes
+
+- d918c63: Upgrade some dependencies
+- Updated dependencies [d918c63]
+- Updated dependencies [d918c63]
+- Updated dependencies [d918c63]
+  - @zazuko/yasgui-utils@4.3.3
+  - @zazuko/yasqe@4.3.3
+
+## 4.3.2
+
+### Patch Changes
+
+- @zazuko/yasgui-utils@4.3.2
+- @zazuko/yasqe@4.3.2
+
+## 4.3.1
+
+### Patch Changes
+
+- 8aef253: Upgrade datatables.net to 2.0.5
+- cbf8286: Use the right type for DataTables configuration
+- 6e78f30: This fixes the style of the table by using the new `layout` property from DataTables
+  - @zazuko/yasgui-utils@4.3.1
+  - @zazuko/yasqe@4.3.1
+
+## 4.3.0
+
+### Minor Changes
+
+- 981b776: Upgrade datatables to v2
+
+### Patch Changes
+
+- b14ed24: Update Git repository to https://github.com/zazuko/Yasgui
+- Updated dependencies [b14ed24]
+  - @zazuko/yasgui-utils@4.3.0
+  - @zazuko/yasqe@4.3.0
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [4.0.113](https://github.com/TriplyDB/yasgui/compare/v4.0.112...v4.0.113) (2020-04-08)
+
+**Note:** Version bump only for package @triply/yasr
+
+## [4.0.112](https://github.com/TriplyDB/yasgui/compare/v4.0.111...v4.0.112) (2020-04-07)
+
+**Note:** Version bump only for package @triply/yasr
+
+## [4.0.111](https://github.com/TriplyDB/yasgui/compare/v4.0.109...v4.0.111) (2020-03-20)
+
+**Note:** Version bump only for package @triply/yasr
+
+## [4.0.110](https://github.com/TriplyDB/yasgui/compare/v4.0.109...v4.0.110) (2020-03-20)
+
+**Note:** Version bump only for package @triply/yasr
+
+## [4.0.108](https://github.com/TriplyDB/yasgui/compare/v4.0.107...v4.0.108) (2020-03-10)
+
+**Note:** Version bump only for package @triply/yasr
+
+## [4.0.107](https://github.com/TriplyDB/yasgui/compare/v4.0.106...v4.0.107) (2020-03-01)
+
+**Note:** Version bump only for package @triply/yasr
+
+## [4.0.106](https://github.com/TriplyDB/yasgui/compare/v4.0.105...v4.0.106) (2020-02-25)
+
+**Note:** Version bump only for package @triply/yasr
+
+## [4.0.105](https://github.com/TriplyDB/yasgui/compare/v4.0.104...v4.0.105) (2020-02-10)
+
+**Note:** Version bump only for package @triply/yasr
+
+## [4.0.104](https://github.com/TriplyDB/yasgui/compare/v4.0.103...v4.0.104) (2020-02-10)
+
+**Note:** Version bump only for package @triply/yasr
+
+## [4.0.103](https://github.com/TriplyDB/yasgui/compare/v4.0.102...v4.0.103) (2020-02-10)
+
+**Note:** Version bump only for package @triply/yasr
+
+## [4.0.102](https://github.com/TriplyDB/yasgui/compare/v4.0.101...v4.0.102) (2020-02-07)
+
+**Note:** Version bump only for package @triply/yasr

package/build/ts/src/bindingsToCsv.d.ts

@@ -0,0 +1,2 @@
+import Parser from "./parsers";
+export default function (result: Parser.SparqlResults): string;

package/build/ts/src/defaults.d.ts

@@ -0,0 +1,2 @@
+import { Config } from "./";
+export default function get(): Config;

package/build/ts/src/helpers/addCSS.d.ts

@@ -0,0 +1 @@
+export default function addCss(href: string): void;

package/build/ts/src/helpers/addScript.d.ts

@@ -0,0 +1 @@
+export default function addScript(src: string, text?: string): Promise<void>;

package/build/ts/src/helpers/index.d.ts

@@ -0,0 +1,3 @@
+export { default as addCss } from "./addCSS";
+export { default as addScript } from "./addScript";
+export { default as sanitize } from "./sanitize";

package/build/ts/src/helpers/sanitize.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (val: string | Node) => string;
+export default _default;

package/build/ts/src/imgs.d.ts

@@ -0,0 +1,4 @@
+export declare var download: string;
+export declare var pivot: string;
+export declare var fullscreen: string;
+export declare var fullscreenExit: string;

package/build/ts/src/index.d.ts

@@ -0,0 +1,130 @@
+import { EventEmitter } from "events";
+import { Plugin } from "./plugins";
+import { Storage as YStorage } from "@matdata/yasgui-utils";
+import Parser from "./parsers";
+export { default as Parser } from "./parsers";
+import { addScript, addCss } from "./helpers";
+export interface PersistentConfig {
+    selectedPlugin?: string;
+    pluginsConfig?: {
+        [pluginName: string]: any;
+    };
+}
+export interface Yasr {
+    on(event: "change", listener: (instance: Yasr) => void): this;
+    emit(event: "change", instance: Yasr): boolean;
+    on(event: "draw", listener: (instance: Yasr, plugin: Plugin<any>) => void): this;
+    emit(event: "draw", instance: Yasr, plugin: Plugin<any>): boolean;
+    on(event: "drawn", listener: (instance: Yasr, plugin: Plugin<any>) => void): this;
+    emit(event: "drawn", instance: Yasr, plugin: Plugin<any>): boolean;
+    on(event: "toggle-help", listener: (instance: Yasr) => void): this;
+    emit(event: "toggle-help", instance: Yasr): boolean;
+}
+export declare class Yasr extends EventEmitter {
+    results?: Parser;
+    rootEl: HTMLDivElement;
+    headerEl: HTMLDivElement;
+    fallbackInfoEl: HTMLDivElement;
+    resultsEl: HTMLDivElement;
+    pluginControls: HTMLDivElement;
+    config: Config;
+    storage: YStorage;
+    plugins: {
+        [name: string]: Plugin<any>;
+    };
+    helpDrawn: Boolean;
+    private drawnPlugin;
+    private selectedPlugin;
+    private fullscreenBtn;
+    private isFullscreen;
+    private loadingEl;
+    private isLoading;
+    utils: {
+        addScript: typeof addScript;
+        addCSS: typeof addCss;
+        sanitize: (val: string | Node) => string;
+    };
+    constructor(parent: HTMLElement, conf?: Partial<Config>, data?: any);
+    private getConfigFromStorage;
+    renderError(error: Parser.ErrorSummary): Promise<HTMLElement | undefined>;
+    getStorageId(label: string, getter?: Config["persistenceId"]): string | undefined;
+    somethingDrawn(): boolean;
+    emptyFallbackElement(): void;
+    getSelectedPluginName(): string;
+    getSelectedPlugin(): Plugin<any>;
+    private updatePluginSelectors;
+    private getCompatiblePlugins;
+    draw(): void;
+    refresh(): void;
+    destroy(): void;
+    getPrefixes(): Prefixes;
+    selectPlugin(plugin: string): void;
+    private pluginSelectorsEl;
+    drawPluginSelectors(): void;
+    private fillFallbackBox;
+    private drawPluginElement;
+    private drawHeader;
+    private downloadBtn;
+    private drawDownloadIcon;
+    private dataElement;
+    private drawResponseInfo;
+    private updateResponseInfo;
+    private updateHelpButton;
+    updateExportHeaders(): void;
+    private drawFullscreenButton;
+    toggleFullscreen(): void;
+    getIsFullscreen(): boolean;
+    private createLoadingElement;
+    showLoading(): void;
+    hideLoading(): void;
+    private documentationLink;
+    private drawDocumentationButton;
+    download(): void;
+    handleLocalStorageQuotaFull(_e: any): void;
+    getResponseFromStorage(): unknown;
+    getPersistentConfig(): PersistentConfig;
+    storePluginConfig(pluginName: string, conf: any): void;
+    private storeConfig;
+    private storeResponse;
+    setResponse(data: any, duration?: number): void;
+    private initializePlugins;
+    static defaults: Config;
+    static plugins: {
+        [key: string]: typeof Plugin & {
+            defaults?: any;
+        };
+    };
+    static registerPlugin(name: string, plugin: typeof Plugin, enable?: boolean): void;
+    static Dependencies: {
+        [name: string]: Promise<any>;
+    };
+    static storageNamespace: string;
+    static clearStorage(): void;
+}
+export type Prefixes = {
+    [prefixLabel: string]: string;
+};
+export interface PluginConfig {
+    dynamicConfig?: any;
+    staticConfig?: any;
+    enabled?: boolean;
+}
+export interface Config {
+    persistenceId: ((yasr: Yasr) => string) | string | null;
+    persistenceLabelResponse: string;
+    persistenceLabelConfig: string;
+    maxPersistentResponseSize: number;
+    persistencyExpire: number;
+    getPlainQueryLinkToEndpoint: (() => string | undefined) | undefined;
+    getDownloadFileName?: () => string | undefined;
+    plugins: {
+        [pluginName: string]: PluginConfig;
+    };
+    pluginOrder: string[];
+    defaultPlugin: string;
+    prefixes: Prefixes | ((yasr: Yasr) => Prefixes);
+    errorRenderers?: ((error: Parser.ErrorSummary) => Promise<HTMLElement | undefined>)[];
+}
+export declare function registerPlugin(name: string, plugin: typeof Plugin, enable?: boolean): void;
+export { Plugin, DownloadInfo } from "./plugins";
+export default Yasr;

package/build/ts/src/parsers/csv.d.ts

@@ -0,0 +1,2 @@
+import Parser from "./";
+export default function (csvString: string): Parser.SparqlResults;

package/build/ts/src/parsers/index.d.ts

@@ -0,0 +1,68 @@
+import N3 from "n3";
+declare namespace Parser {
+    interface ErrorSummary {
+        status?: number;
+        text: string;
+        statusText?: string;
+    }
+    interface BindingValue {
+        value: string;
+        type: "uri" | "literal" | "typed-literal" | "bnode";
+        datatype?: string;
+        "xml:lang"?: string;
+    }
+    interface Binding {
+        [varname: string]: BindingValue;
+    }
+    interface SparqlResults {
+        head: {
+            vars: string[];
+        };
+        boolean?: boolean;
+        results?: {
+            bindings: Binding[];
+        };
+    }
+    interface ResponseSummary {
+        data?: any;
+        error?: ErrorSummary;
+        status?: number;
+        contentType?: string;
+        executionTime?: number;
+    }
+    type PostProcessBinding = (binding: Binding) => Binding;
+}
+type QueryResponse = Response & {
+    content: string;
+};
+declare class Parser {
+    private res;
+    private summary;
+    private errorSummary;
+    private error;
+    private type;
+    private executionTime;
+    constructor(responseOrObject: Parser.ResponseSummary | QueryResponse | Error | any, executionTime?: number);
+    setResponse(res: QueryResponse): void;
+    setSummary(summary: Parser.ResponseSummary | any): void;
+    hasError(): boolean;
+    getError(): Parser.ErrorSummary;
+    getContentType(): string;
+    private json;
+    getAsJson(): false | Parser.SparqlResults;
+    private getData;
+    getResponseTime(): number;
+    private getParserFromContentType;
+    private doLuckyGuess;
+    getVariables(): string[];
+    getBoolean(): boolean | undefined;
+    getBindings(): Parser.Binding[];
+    private statements;
+    getStatements(): N3.Quad[];
+    getOriginalResponseAsString(): string;
+    getType(): "json" | "xml" | "csv" | "tsv" | "ttl";
+    getStatus(): number | undefined;
+    getAsStoreObject(maxResponseSize: number): Parser.ResponseSummary | undefined;
+    asCsv(): string;
+}
+export default Parser;

package/build/ts/src/parsers/json.d.ts

@@ -0,0 +1,2 @@
+import Parser from "./";
+export default function (queryResponse: any, postProcessBinding: Parser.PostProcessBinding): Parser.SparqlResults;

package/build/ts/src/parsers/tsv.d.ts

@@ -0,0 +1,2 @@
+import Parser from "./";
+export default function (tsvString: string): Parser.SparqlResults;

package/build/ts/src/parsers/turtleFamily.d.ts

@@ -0,0 +1,4 @@
+import Parser from "./";
+import * as N3 from "n3";
+export default function (queryResponse: any): Parser.SparqlResults;
+export declare function getTurtleAsStatements(queryResponse: any): N3.Quad[];

package/build/ts/src/parsers/xml.d.ts

@@ -0,0 +1,2 @@
+import Parser from "./";
+export default function (xmlString: string, postProcessBinding: Parser.PostProcessBinding): Parser.SparqlResults | undefined;

package/build/ts/src/plugins/boolean/index.d.ts

@@ -0,0 +1,13 @@
+import Yasr from "../../";
+import { Plugin } from "../";
+export interface PluginConfig {
+}
+export default class Boolean implements Plugin<PluginConfig> {
+    private yasr;
+    priority: number;
+    hideFromSelection: boolean;
+    constructor(yasr: Yasr);
+    draw(): void;
+    canHandleResults(): boolean;
+    getIcon(): HTMLElement;
+}

package/build/ts/src/plugins/error/index.d.ts

@@ -0,0 +1,13 @@
+import { Plugin } from "../";
+import Yasr from "../../";
+export default class Error implements Plugin<never> {
+    private yasr;
+    constructor(yasr: Yasr);
+    canHandleResults(): boolean;
+    private getTryBtn;
+    private getCorsMessage;
+    draw(): Promise<void>;
+    getIcon(): HTMLElement;
+    priority: number;
+    hideFromSelection: boolean;
+}

package/build/ts/src/plugins/index.d.ts

@@ -0,0 +1,19 @@
+export interface Plugin<Opts extends any> {
+    priority: number;
+    canHandleResults(): boolean;
+    hideFromSelection?: boolean;
+    label?: string;
+    options?: Opts;
+    initialize?(): Promise<void>;
+    destroy?(): void;
+    draw(persistentConfig: any, runtimeConfig?: any): Promise<void> | void;
+    getIcon(): Element | undefined;
+    download?(filename?: string): DownloadInfo | undefined;
+    helpReference?: string;
+}
+export interface DownloadInfo {
+    contentType: string;
+    getData: () => string;
+    filename: string;
+    title: string;
+}

package/build/ts/src/plugins/response/index.d.ts

@@ -0,0 +1,28 @@
+import { Plugin } from "../";
+import Yasr from "../../";
+export interface PluginConfig {
+    maxLines: number;
+}
+export default class Response implements Plugin<PluginConfig> {
+    private yasr;
+    label: string;
+    priority: number;
+    helpReference: string;
+    private config;
+    private overLay;
+    private cm;
+    constructor(yasr: Yasr);
+    canHandleResults(): boolean;
+    getIcon(): HTMLDivElement;
+    download(filename?: string): {
+        getData: () => string;
+        filename: string;
+        contentType: string;
+        title: string;
+    };
+    draw(persistentConfig: PluginConfig): void;
+    private limitData;
+    showLess(setValue?: boolean): void;
+    showMore(): void;
+    static defaults: PluginConfig;
+}

package/build/ts/src/plugins/table/index.d.ts

@@ -0,0 +1,49 @@
+import { Plugin, DownloadInfo } from "../";
+import Yasr from "../../";
+import type { Config } from "datatables.net";
+export interface PluginConfig {
+    openIriInNewWindow: boolean;
+    tableConfig: Config;
+}
+export interface PersistentConfig {
+    pageSize?: number;
+    compact?: boolean;
+    isEllipsed?: boolean;
+}
+export default class Table implements Plugin<PluginConfig> {
+    private config;
+    private persistentConfig;
+    private yasr;
+    private tableControls;
+    private tableEl;
+    private dataTable;
+    private tableFilterField;
+    private tableSizeField;
+    private tableCompactSwitch;
+    private tableEllipseSwitch;
+    private tableResizer;
+    helpReference: string;
+    label: string;
+    priority: number;
+    getIcon(): HTMLDivElement;
+    constructor(yasr: Yasr);
+    static defaults: PluginConfig;
+    private getRows;
+    private getUriLinkFromBinding;
+    private getCellContent;
+    private formatLiteral;
+    private getColumns;
+    private getSizeFirstColumn;
+    draw(persistentConfig: PersistentConfig): void;
+    private setEllipsisHandlers;
+    private handleTableSearch;
+    private handleTableSizeSelect;
+    private handleSetCompactToggle;
+    private handleSetEllipsisToggle;
+    drawControls(): void;
+    download(filename?: string): DownloadInfo;
+    canHandleResults(): boolean;
+    private removeControls;
+    private destroyResizer;
+    destroy(): void;
+}

package/build/yasr.html

@@ -0,0 +1,32 @@
+<!doctype html><html><head><meta charset="UTF-8"/><style>body {
+        font-family: "Roboto", sans-serif;
+        margin: 0px;
+      }
+      .navItem a {
+  			color: #555;
+  			text-decoration: none;
+  			padding: 5px;
+  			padding-right:15px;
+  		}
+  		.navItem a:hover {
+  			color:#222
+  		}
+  		.navItem.active a {
+  			color: black;
+  			font-size:110%;
+  		}</style><link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"/><script src="../../packages/yasgui/static/yasgui.polyfill.min.js"></script><script defer="defer" src="/yasqe.min.js"></script><script defer="defer" src="/yasr.min.js"></script><link href="/yasqe.min.css" rel="stylesheet"><link href="/yasr.min.css" rel="stylesheet"></head><body><div style="background:#eee"><nav style="display: flex"><img src="webpack/yasgui.png" style="max-height:50px;padding:5px;margin-left: 10px" alt="Yasgui Logo"><ul style="display: flex; list-style: none; align-self: center"><li class="navItem false"><a class="nav-link" href="yasgui.html">Yasgui</a></li><li class="navItem false"><a class="nav-link" href="yasqe.html">Yasqe</a></li><li class="navItem active"><a class="nav-link" href="yasr.html">Yasr</a></li></ul></nav></div><div id="yasqe"></div><div id="yasr"></div><script>window.onpageshow = function() {
+        window.yasqe = new Yasqe(document.getElementById("yasqe"), {
+          requestConfig: {
+            endpoint: "https://dbpedia.org/sparql"
+          }
+        });
+        yasqe.on("queryResponse", function(yasqe, response, duration) {
+          console.log({ response: response });
+          window.yasr.setResponse(response, duration);
+        });
+        window.yasr = new Yasr(document.getElementById("yasr"), {
+          prefixes: function() {
+            return yasqe.getPrefixesFromQuery();
+          }
+        });
+      };</script></body></html>