@logilab/sparqlexplorer 0.7.0

package/README.md

@@ -0,0 +1,73 @@
+# SparqlExplorer
+
+SparqlExplorer is a web application you can use to explore the content of any SPARQL endpoint without writing SPARQL queries.
+
+The stable version is available at [sparqlexplorer.app](https://sparqlexplorer.app). The CI deploys there the latest version with a tag.
+
+The unstable version (public head of this repository) is automatically deployed on
+[open-source.pages.logilab.fr/SemWeb/sparqlexplorer/](https://open-source.pages.logilab.fr/SemWeb/sparqlexplorer/) by the CI.
+
+## Interface walkthrough
+
+In this example we use data from data.culture hosted at [data.idref.fr/sparql](https://data.idref.fr/sparql).
+
+The first step is to enter the sparql endpoint:
+
+<img alt='Input a Sparql endpoint URL' src='./img/entry_sparql.png' width='500px'/>
+
+When clicking on "explore" SparqlExplorer will display a list of all the classes available on the SPARQL endpoint with their number of instances. This list can be filtered thanks to the filter bar.
+
+<img alt='Class list' src='./img/classes.png' width='500px'/>
+
+If we click on a Class, we obtain the triples in which the URL is the subject or the object.
+This tabular view is the _default view_. Every URL is clickable and you can navigate from URL to URL keeping the same view.
+
+<img alt='Default view' src='./img/default_view.png' width='750px'/>
+
+### Using custom views
+
+While the default view will work on any vocabulary it may not be the most user friendly.
+Sparql explorer comes with a set of custom views for specific vocabularies such as SKOS, FOAF and others.
+
+When viewing a URL description, the left burger menu lists the available views.
+The current view is highlighted in blue and views not applicable to the current URI description are faded out.
+<img alt='Default view' src='./img/burger_view.png' width='750px'/>
+
+An automatic mode is available (check the "Automatic" checkbox) to select an applicable custom view automatically. 
+Each custom view will send a SPARQL query to check if it is compatible with the current URI.
+The selected view will be displayed in the burger menu.
+<img alt='Automatic view' src='./img/automatic.png' width='750px'/>
+
+
+If no view is suited for the URL description, a pop up will appear and the view will fallback to default.
+<img alt='Wrong view' src='./img/wrong_view.png' width='750px'/>
+
+## Running SparqlExplorer locally
+
+To run Sparql Explorer, clone with Mercurial and install the npm project.
+
+```
+hg clone https://forge.extranet.logilab.fr/open-source/SemWeb/sparqlexplorer
+npm install
+```
+
+Then you can start the development server on your http://localhost:3000 with
+
+```
+npm run serve
+```
+
+To edit custom views, please refer to the [readme in the generic-views repo](https://forge.extranet.logilab.fr/open-source/SemWeb/generic-views).
+
+## Deployment
+
+Test the [unstable version](https://open-source.pages.logilab.fr/SemWeb/sparqlexplorer/) then increment version number
+and publish a tag to have it deployed at [sparqlexplorer.app](https://sparqlexplorer.app).
+
+## Contributing
+
+SparqlExplorer is licensed under [AGPLv3](./LICENSE), all contributions are welcome!
+
+As the project is on the Logilab code hosting platform, you will need an account to create pull requests and open issues.
+
+Please reach us on our [public matrix channel](https://matrix.to/#/#public:matrix.logilab.org) or via email at [contact@logilab.fr](mailto:contact@logilab.fr) if you want to contribute.

package/build/src/lib/App.d.ts

@@ -0,0 +1,6 @@
+import type { SparqlViewConfig } from "@logilab/sparqlexplorer-views";
+import "./App.css";
+declare function App({ views }: {
+    views: Array<SparqlViewConfig>;
+}): import("react/jsx-runtime").JSX.Element;
+export default App;

package/build/src/lib/components/ClassList.d.ts

@@ -0,0 +1,9 @@
+export interface ListQueryResult {
+    uri: string;
+    nbInstances?: string;
+    label?: string;
+}
+export interface ClassListProps {
+    endpoint: string;
+}
+export declare function ClassList({ endpoint }: ClassListProps): import("react/jsx-runtime").JSX.Element;

package/build/src/lib/components/EndpointForm.d.ts

@@ -0,0 +1 @@
+export declare const EndpointForm: () => import("react/jsx-runtime").JSX.Element;

package/build/src/lib/components/GraphSelector.d.ts

@@ -0,0 +1 @@
+export declare function GraphSelector(): import("react/jsx-runtime").JSX.Element | null;

package/build/src/lib/components/HomePage.d.ts

@@ -0,0 +1 @@
+export declare function HomePage(): import("react/jsx-runtime").JSX.Element;

package/build/src/lib/components/SearchPage.d.ts

@@ -0,0 +1 @@
+export declare function SearchPage(): import("react/jsx-runtime").JSX.Element | null;

package/build/src/lib/components/UriPage.d.ts

@@ -0,0 +1 @@
+export declare function UriPage(): import("react/jsx-runtime").JSX.Element | null;

package/build/src/lib/components/UtilsComponents.d.ts

@@ -0,0 +1,11 @@
+import { type RDFNode } from "../utils/utils";
+export declare function Loading(): import("react/jsx-runtime").JSX.Element;
+export declare function AlertError({ error }: {
+    error: string;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function NoResults(): import("react/jsx-runtime").JSX.Element;
+export declare function URILink({ node, focusUri, label, }: {
+    node: RDFNode;
+    focusUri?: string;
+    label?: string;
+}): import("react/jsx-runtime").JSX.Element;

package/build/src/lib/components/ViewSelector.d.ts

@@ -0,0 +1,2 @@
+import "./ViewSelector.css";
+export declare function ViewSelector(): import("react/jsx-runtime").JSX.Element;

package/build/src/lib/components/Yasgui.d.ts

@@ -0,0 +1,6 @@
+import "@logilab/yasgui/build/yasgui.min.css";
+export interface YasguiModuleProps {
+    endpoint: string;
+}
+export declare function YasguiModule({ endpoint }: YasguiModuleProps): import("react/jsx-runtime").JSX.Element;
+export declare function YasguiPage(): import("react/jsx-runtime").JSX.Element | null;

package/build/src/lib/components/YasrTableResults.d.ts

@@ -0,0 +1,55 @@
+import type Yasr from "@logilab/yasr";
+import type { DownloadInfo, Plugin } from "@logilab/yasr";
+import { type Config } from "datatables.net";
+import "@logilab/yasr/src/plugins/table/index.scss";
+import "datatables.net-dt/css/jquery.dataTables.css";
+export interface PluginConfig {
+    openIriInNewWindow: boolean;
+    tableConfig: Config;
+    urlParams: string;
+}
+export interface PersistentConfig {
+    pageSize?: number;
+    compact?: boolean;
+    isEllipsed?: boolean;
+}
+export declare class YasrTableResults 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;
+    /**
+     * Draws controls on each update
+     */
+    drawControls(): void;
+    download(filename?: string): DownloadInfo;
+    canHandleResults(): boolean;
+    private removeControls;
+    private destroyResizer;
+    destroy(): void;
+}

package/build/src/lib/components/layout/DrawerContent.d.ts

@@ -0,0 +1,4 @@
+export declare const DRAWER_WIDTH = 340;
+export declare function DrawerContent({ onClose }: {
+    onClose: () => void;
+}): import("react/jsx-runtime").JSX.Element;

package/build/src/lib/components/layout/Footer.d.ts

@@ -0,0 +1 @@
+export declare function Footer(): import("react/jsx-runtime").JSX.Element;

package/build/src/lib/components/layout/Layout.d.ts

@@ -0,0 +1,2 @@
+import { type PropsWithChildren } from "react";
+export declare function Layout({ children }: PropsWithChildren): import("react/jsx-runtime").JSX.Element;

package/build/src/lib/components/layout/Navbar.d.ts

@@ -0,0 +1,4 @@
+export declare function NavBar({ onBurgerPressed, drawerOpen, }: {
+    onBurgerPressed: () => void;
+    drawerOpen: boolean;
+}): import("react/jsx-runtime").JSX.Element;

package/build/src/lib/components/uri/URIDefaultView.d.ts

@@ -0,0 +1,6 @@
+export declare function URIDefaultView({ endpoint, uri, graphs, showUri, }: {
+    endpoint: string;
+    uri: string;
+    graphs: string[];
+    showUri?: boolean;
+}): import("react/jsx-runtime").JSX.Element;

package/build/src/lib/components/uri/URIWithSelectedView.d.ts

@@ -0,0 +1,7 @@
+import type { SparqlViewConfig } from "@logilab/sparqlexplorer-views";
+export interface URIWithSelectedViewProps {
+    endpoint: string;
+    uri: string;
+    viewWrapper: SparqlViewConfig;
+}
+export declare function URIWithSelectedView({ endpoint, uri, viewWrapper, }: URIWithSelectedViewProps): import("react/jsx-runtime").JSX.Element;

package/build/src/lib/context/AuthContext.d.ts

@@ -0,0 +1,11 @@
+import type { BasicAuth } from "@logilab/sparqlutils";
+import { type PropsWithChildren } from "react";
+export type AuthContextType = {
+    auth: BasicAuth | undefined;
+    setAuth: (auth: BasicAuth | undefined) => void;
+};
+export declare function AuthProvider({ children }: PropsWithChildren): import("react/jsx-runtime").JSX.Element;
+export declare function useAuth(): {
+    auth: BasicAuth | undefined;
+    setAuth: (auth: BasicAuth | undefined) => void;
+};

package/build/src/lib/context/ConfigContext.d.ts

@@ -0,0 +1,15 @@
+import { type PropsWithChildren } from "react";
+export type SparqlExplorerConfig = {
+    endpoint: string | null;
+    canEditEndpoint: boolean;
+    view: string | null;
+    selectedGraphs: string[];
+};
+export declare function ConfigProvider({ children, config, }: PropsWithChildren<{
+    config: SparqlExplorerConfig;
+}>): import("react/jsx-runtime").JSX.Element;
+export declare function useConfig(): SparqlExplorerConfig;
+export declare function useEndpoint(): string | null;
+export declare function useView(): string | null;
+export declare function useCanEditEndpoint(): boolean;
+export declare function useSelectedGraphs(): string[];

package/build/src/lib/context/ViewsContext.d.ts

@@ -0,0 +1,14 @@
+import type { SparqlViewConfig } from "@logilab/sparqlexplorer-views";
+import { type PropsWithChildren, type Dispatch, type SetStateAction } from "react";
+type ViewsProps = {
+    views: SparqlViewConfig[];
+};
+export declare const ViewsContext: import("react").Context<{
+    views: SparqlViewConfig[];
+    selectedView?: SparqlViewConfig;
+    setSelectedView: Dispatch<SetStateAction<SparqlViewConfig | undefined>>;
+    applicableViews?: SparqlViewConfig[];
+    setApplicableViews: Dispatch<SetStateAction<SparqlViewConfig[] | undefined>>;
+}>;
+export declare function ViewsProvider({ views, children, }: PropsWithChildren<ViewsProps>): import("react/jsx-runtime").JSX.Element;
+export {};

package/build/src/lib/hooks/useClasses.d.ts

@@ -0,0 +1,6 @@
+import type { ClassListProps, ListQueryResult } from "../components/ClassList";
+export declare function useClasses({ endpoint }: ClassListProps): {
+    classes: ListQueryResult[];
+    error: string | null;
+    isLoaded: boolean;
+};

package/build/src/lib/hooks/useGraphs.d.ts

@@ -0,0 +1,8 @@
+export interface ListQueryResult {
+    graph: string;
+}
+export declare function useGraphs(showAll?: boolean): {
+    graphs: ListQueryResult[];
+    error: string | null;
+    isLoaded: boolean;
+};

package/build/src/lib/hooks/useNavigateWithParams.d.ts

@@ -0,0 +1,5 @@
+export declare function useNavigateWithParams(): (pathname: string, newParams?: Record<string, string | null>, replace?: boolean) => void;
+export declare function useSearchParamsString(): (newParams?: Record<string, string | null>) => string;
+export declare function useChangeView(): (view: string | null) => void;
+export declare function useAddGraph(): (graph: string) => void;
+export declare function useRemoveGraph(): (graph: string) => void;

package/build/src/lib/hooks/useParams.d.ts

@@ -0,0 +1 @@
+export declare function useParam(param: string): string | null;

package/build/src/lib/hooks/useURIData.d.ts

@@ -0,0 +1,21 @@
+import { type Label, type RDFNode } from "../utils/utils";
+export interface ITriples {
+    subject: RDFNode;
+    predicate: RDFNode;
+    object: RDFNode;
+    graph: RDFNode;
+}
+export declare function useURIData({ endpoint, uri, graphs, search, page, perPage, }: {
+    endpoint: string;
+    uri: string;
+    graphs: string[];
+    search: string;
+    page: number;
+    perPage: number;
+}): {
+    triples: ITriples[];
+    total: number;
+    labels: Label[];
+    error: string | null;
+    isLoaded: boolean;
+};

package/build/src/lib/hooks/useURILink.d.ts

@@ -0,0 +1 @@
+export declare function useURILink(uri: string): string;

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

@@ -0,0 +1,8 @@
+export * from "./App";
+export * from "./utils/utils";
+export * from "./context/ViewsContext";
+export * from "./context/AuthContext";
+export * from "./context/ConfigContext";
+export * from "./utils/getIconFromURI";
+import App from "./App";
+export default App;

package/build/src/lib/public-path.d.ts

@@ -0,0 +1 @@
+declare var SPARQL_ENDPOINT: string;

package/build/src/lib/routes/Home.d.ts

@@ -0,0 +1 @@
+export declare function Home(): import("react/jsx-runtime").JSX.Element;

package/build/src/lib/routes/Search.d.ts

@@ -0,0 +1 @@
+export declare function Search(): import("react/jsx-runtime").JSX.Element;

package/build/src/lib/routes/Uri.d.ts

@@ -0,0 +1 @@
+export declare function Uri(): import("react/jsx-runtime").JSX.Element;

package/build/src/lib/routes/Yasgui.d.ts

@@ -0,0 +1 @@
+export declare function Yasgui(): import("react/jsx-runtime").JSX.Element;

package/build/src/lib/setupTests.d.ts

@@ -0,0 +1 @@
+import "@testing-library/jest-dom/extend-expect";

package/build/src/lib/utils/getIconFromURI.d.ts

@@ -0,0 +1,3 @@
+export declare function getIconFromURI(uri: string): import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material/SvgIcon").SvgIconTypeMap<{}, "svg">> & {
+    muiName: string;
+};

package/build/src/lib/utils/utils.d.ts

@@ -0,0 +1,24 @@
+import { type SparqlViewConfig } from "@logilab/sparqlexplorer-views";
+import type { SparqlAuth } from "@logilab/sparqlutils";
+export interface RDFNode {
+    type: "uri" | "bnode" | "literal";
+    value: string;
+}
+export declare function stringIncludes(a: string, b: string): boolean;
+export declare function computeRedirect(uri: string, params: string): string;
+export declare function prefixedNameFromUri(uri: string): string;
+export declare function getSavedEndpoints(): Array<string>;
+export declare function addToSavedEndpoints(value: string): void;
+export declare function getApplicableViews(uri: string, endpoint: string, auth?: SparqlAuth): Promise<Array<SparqlViewConfig>>;
+export declare const DEFAUT_VIEW_NAME = "Default view";
+export declare function isDefaultView(viewName: string | null): viewName is "Default view";
+export declare function getLabelSparqlClause(uri?: string, onlyRdfsLabel?: boolean): string;
+export interface Label {
+    value: string;
+    lang: string | null;
+}
+export interface UriAndLabels {
+    uri: string;
+    labels: Label[];
+}
+export declare function getBestLabel(instance: UriAndLabels): string;

package/build/src/lib/yasgui-utils/Storage.d.ts

@@ -0,0 +1,16 @@
+export interface ItemWrapper<V = Record<string, unknown>> {
+    exp: number;
+    val: V;
+    namespace: string;
+    time: number;
+}
+export default class Storage {
+    private namespace;
+    constructor(namespace: string);
+    set<V = Record<string, unknown>>(key: string | undefined, val: any, expInSeconds: number, onQuotaExceeded: (e: any) => void): void;
+    remove(key: string): void;
+    removeExpiredKeys(): void;
+    removeAll(): void;
+    removeNamespace(): void;
+    get<V>(key?: string): V | undefined;
+}

package/build/src/lib/yasgui-utils/index.d.ts

@@ -0,0 +1,16 @@
+export declare function drawSvgStringAsElement(svgString: string): HTMLDivElement;
+export interface FaIcon {
+    width: number;
+    height: number;
+    svgPathData: string;
+}
+/**
+ * Draws font fontawesome icon as svg. This is a lot more lightweight then the option that is offered by fontawesome
+ * @param faIcon
+ * @returns
+ */
+export declare function drawFontAwesomeIconAsSvg(faIcon: FaIcon): string;
+export declare function hasClass(el: Element | undefined, className: string): boolean | undefined;
+export declare function addClass(el: Element | undefined | null, ...classNames: string[]): void;
+export declare function removeClass(el: Element | undefined | null, className: string): void;
+export declare function getAsValue<E, A>(valueOrFn: E | ((arg: A) => E), arg: A): E;