@pod-os/core 0.14.0 → 0.14.1-01c71c6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pod-os/core",
-  "version": "0.14.0",
+  "version": "0.14.1-01c71c6.0",
   "main": "./dist/index.js",
   "types": "./types/index.d.ts",
   "files": [

package/types/Store.d.ts

@@ -1,7 +1,7 @@
 import { Fetcher, IndexedFormula, UpdateManager } from "rdflib";
 import { PodOsSession } from "./authentication";
 import { Thing } from "./thing";
-import { LabelIndex } from "./search";
+import { UpdateOperation } from "@solid-data-modules/rdflib-utils";
 /**
  * The store contains all data that is known locally.
  * It can be used to fetch additional data from the web and also update data and sync it back to editable resources.
@@ -34,5 +34,5 @@ export declare class Store {
      */
     addPropertyValue(thing: Thing, property: string, value: string): Promise<void>;
     addNewThing(uri: string, name: string, type: string): Promise<void>;
-    addToLabelIndex(thing: Thing, labelIndex: LabelIndex): Promise<void>;
+    executeUpdate(operation: UpdateOperation): Promise<void>;
 }

package/types/index.d.ts

@@ -3,7 +3,7 @@ import { BehaviorSubject } from "rxjs";
 import { SessionInfo } from "./authentication";
 import { SolidFile } from "./files";
 import { WebIdProfile } from "./profile";
-import { LabelIndex, SearchIndex } from "./search";
+import { LabelIndex } from "./search";
 import { Store } from "./Store";
 import { Term } from "./terms";
 import { Thing } from "./thing";
@@ -20,6 +20,7 @@ export declare class PodOS {
     readonly store: Store;
     readonly uriService: UriService;
     private fileFetcher;
+    private searchGateway;
     constructor();
     private flagAuthorizationMetaDataOnSessionChange;
     handleIncomingRedirect(restorePreviousSession?: boolean): void;
@@ -53,7 +54,7 @@ export declare class PodOS {
      * Fetch the private label index for the given profile and build a search index from it
      * @param webId
      */
-    buildSearchIndex(profile: WebIdProfile): Promise<SearchIndex>;
+    buildSearchIndex(profile: WebIdProfile): Promise<import("./search").SearchIndex>;
     logout(): Promise<void>;
     login(oidcIssuer?: string): Promise<void>;
     loadContactsModule(): Promise<ContactsModule>;
@@ -63,4 +64,11 @@ export declare class PodOS {
      * @param labelIndex - The index to update
      */
     addToLabelIndex(thing: Thing, labelIndex: LabelIndex): Promise<void>;
+    /**
+     * Creates a new label index document at a default location and links it to the user's profile or preferences document
+     *
+     * @param profile - The profile for that to create the index
+     * @returns the newly created label index
+     */
+    createDefaultLabelIndex(profile: WebIdProfile): Promise<LabelIndex>;
 }

package/types/namespaces/index.d.ts

@@ -1 +1,2 @@
 export declare const rdfs: (ln: string) => import("rdflib/lib/tf-types").NamedNode;
+export declare const pim: (ln: string) => import("rdflib/lib/tf-types").NamedNode;

package/types/search/SearchGateway.d.ts

@@ -0,0 +1,16 @@
+import { WebIdProfile } from "../profile";
+import { Store } from "../Store";
+import { LabelIndex } from "./LabelIndex";
+import { Thing } from "../thing";
+import { SearchIndex } from "./SearchIndex";
+export declare class SearchGateway {
+    private store;
+    constructor(store: Store);
+    /**
+     * Fetch the private label index for the given profile and build a search index from it
+     * @param webId
+     */
+    buildSearchIndex(profile: WebIdProfile): Promise<SearchIndex>;
+    addToLabelIndex(thing: Thing, labelIndex: LabelIndex): Promise<void>;
+    createDefaultLabelIndex(profile: WebIdProfile): Promise<LabelIndex>;
+}

package/types/search/SearchGateway.integration.spec.d.ts

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

package/types/search/SearchIndex.d.ts

@@ -4,8 +4,13 @@ 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 labelIndexes;
     private index;
-    constructor(indexes: LabelIndex[]);
+    constructor(labelIndexes: LabelIndex[]);
+    /**
+     * Recreates the search index with the current data from all label indexes
+     */
+    rebuild(): this;
     /**
      * Search the index for a given term. It finds partial matches, but will rank exact matches higher.
      *

package/types/search/createDefaultLabelIndex.d.ts

@@ -0,0 +1,5 @@
+import { UpdateOperation } from "@solid-data-modules/rdflib-utils";
+import { WebIdProfile } from "../profile";
+export declare function createDefaultLabelIndex(profile: WebIdProfile): {
+    uri: string;
+} & UpdateOperation;

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

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

package/types/search/index.d.ts

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