@pod-os/core 0.9.1-4851250.0 → 0.9.1-6931b20.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pod-os/core",
-  "version": "0.9.1-4851250.0",
+  "version": "0.9.1-6931b20.0",
   "main": "./dist/index.js",
   "types": "./types/index.d.ts",
   "files": [
@@ -24,29 +24,31 @@
   "author": "Angelo Veltens",
   "license": "MIT",
   "devDependencies": {
-    "@babel/preset-env": "^7.22.9",
-    "@babel/preset-typescript": "^7.22.5",
-    "@types/jest": "^29.5.3",
-    "@types/jest-when": "^3.5.2",
-    "@types/sparqljs": "^3.1.4",
-    "@typescript-eslint/eslint-plugin": "^6.0.0",
-    "@typescript-eslint/parser": "^6.0.0",
-    "esbuild": "^0.18.12",
-    "eslint": "^8.44.0",
-    "jest": "^29.6.1",
-    "jest-when": "^3.5.2",
-    "prettier": "^3.0.0",
-    "rdf-namespaces": "^1.11.0",
-    "rimraf": "^5.0.1",
+    "@babel/preset-env": "^7.22.20",
+    "@babel/preset-typescript": "^7.23.0",
+    "@types/jest": "^29.5.5",
+    "@types/jest-when": "^3.5.3",
+    "@types/sparqljs": "^3.1.5",
+    "@typescript-eslint/eslint-plugin": "^6.7.3",
+    "@typescript-eslint/parser": "^6.7.3",
+    "esbuild": "^0.19.4",
+    "eslint": "^8.50.0",
+    "jest": "^29.7.0",
+    "jest-when": "^3.6.0",
+    "prettier": "^3.0.3",
+    "rdf-namespaces": "^1.12.0",
+    "rimraf": "^5.0.5",
     "sparqljs": "^3.7.1",
-    "typescript": "^5.1.6"
+    "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@inrupt/solid-client-authn-browser": "^1.13.4",
+    "@inrupt/solid-client-authn-browser": "^1.17.2",
+    "@types/lunr": "^2.3.5",
     "buffer": "^6.0.3",
+    "lunr": "^2.3.9",
     "rdflib": "^2.2.32",
     "slugify": "^1.6.6",
-    "url": "^0.11.1"
+    "url": "^0.11.3"
   },
   "directories": {
     "lib": "lib"

package/types/index.d.ts

@@ -1,5 +1,7 @@
 import { ISessionInfo } from "@inrupt/solid-client-authn-browser";
 import { SolidFile } from "./files";
+import { WebIdProfile } from "./profile";
+import { SearchIndex } from "./search/SearchIndex";
 import { Store } from "./Store";
 import { Term } from "./terms";
 import { Thing } from "./thing";
@@ -9,6 +11,8 @@ export * from "./files";
 export * from "./thing";
 export * from "./rdf-document";
 export * from "./ldp-container";
+export * from "./profile";
+export * from "./search";
 export declare class PodOS {
     private readonly session;
     readonly store: Store;
@@ -23,6 +27,16 @@ export declare class PodOS {
     addNewThing(uri: string, name: string, type: string): Promise<void>;
     proposeUriForNewThing(referenceUri: string, name: string): string;
     trackSession(callback: (session: ISessionInfo) => unknown): void;
+    /**
+     * Fetch the WebId profile and preferences file for the given WebID
+     * @param webId
+     */
+    fetchProfile(webId: string): Promise<WebIdProfile>;
+    /**
+     * Fetch the private label index for the given profile and build a search index from it
+     * @param webId
+     */
+    buildSearchIndex(profile: WebIdProfile): Promise<SearchIndex>;
     logout(): Promise<void>;
     login(oidcIssuer?: string): Promise<void>;
 }

package/types/profile/WebIdProfile.d.ts

@@ -0,0 +1,19 @@
+import { IndexedFormula } from "rdflib";
+import { Thing } from "../thing";
+/**
+ * Allows to find things related to the WebID and their profile document
+ */
+export declare class WebIdProfile extends Thing {
+    readonly webId: string;
+    readonly store: IndexedFormula;
+    readonly editable: boolean;
+    constructor(webId: string, store: IndexedFormula, editable?: boolean);
+    /**
+     * Returns te URI of the preferences document
+     */
+    getPreferencesFile(): string | void;
+    /**
+     * Returns the URI of a private label index
+     */
+    getPrivateLabelIndex(): string | void;
+}

package/types/profile/WebIdProfile.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/types/profile/index.d.ts

@@ -0,0 +1 @@
+export { WebIdProfile } from "./WebIdProfile";

package/types/rdf-document/index.d.ts

@@ -1 +1 @@
-export * from './RdfDocument';
+export * from "./RdfDocument";

package/types/search/LabelIndex.d.ts

@@ -0,0 +1,19 @@
+import { IndexedFormula } from "rdflib";
+import { RdfDocument } from "../rdf-document";
+/**
+ * Represents a label index document as described in
+ * https://github.com/pod-os/PodOS/blob/main/docs/features/full-text-search.md
+ */
+export declare class LabelIndex extends RdfDocument {
+    readonly uri: string;
+    readonly store: IndexedFormula;
+    readonly editable: boolean;
+    constructor(uri: string, store: IndexedFormula, editable?: boolean);
+    /**
+     * Returns the URIs and labels for all the things listed in the document.
+     */
+    getIndexedItems(): {
+        uri: string;
+        label: string;
+    }[];
+}

package/types/search/LabelIndex.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/types/search/SearchIndex.d.ts

@@ -0,0 +1,27 @@
+import { LabelIndex } from "./LabelIndex";
+import { Index } from "lunr";
+/**
+ * A fast, in-memory search index based on data from label indexes. Both labels and URIs are indexed.
+ */
+export declare class SearchIndex {
+    private index;
+    constructor(indexes: LabelIndex[]);
+    /**
+     * Search the index for a given term. It finds partial matches, but will rank exact matches higher.
+     *
+     * The rank order is:
+     *
+     *  1. exact matches
+     *  2. prefix matches
+     *  3. suffix matches
+     *  4. any matches inside a literal
+     *
+     * @param term The (partial) term to search for
+     * @param maxResults The maximum number of results to return (defaults to 10)
+     */
+    search(term: string, maxResults?: number): Index.Result[];
+    /**
+     * Remove all data from the search index.
+     */
+    clear(): void;
+}

package/types/search/SearchIndex.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/types/search/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./SearchIndex";
+export * from "./LabelIndex";