@pod-os/core 0.14.1-178554f.0 → 0.14.1-bcfffa2.0

package/dist/index.js

@@ -13833,13 +13833,21 @@ var WebIdProfile = class extends Thing {
 // src/search/SearchIndex.ts
 var import_lunr = __toESM(require_lunr());
 var SearchIndex = class {
-  constructor(indexes) {
+  constructor(labelIndexes) {
+    this.labelIndexes = labelIndexes;
+    this.index = this.rebuild().index;
+  }
+  /**
+   * Recreates the search index with the current data from all label indexes
+   */
+  rebuild() {
+    const labelIndexes = this.labelIndexes;
     this.index = (0, import_lunr.default)(function() {
       this.ref("uri");
       this.field("uri");
       this.field("label");
       this.metadataWhitelist = ["position"];
-      const items2 = indexes.flatMap((it) => it.getIndexedItems());
+      const items2 = labelIndexes.flatMap((it) => it.getIndexedItems());
       items2.forEach((item4) => {
         this.add({
           uri: item4.uri,
@@ -13847,6 +13855,7 @@ var SearchIndex = class {
         });
       });
     });
+    return this;
   }
   /**
    * Search the index for a given term. It finds partial matches, but will rank exact matches higher.
@@ -13902,6 +13911,7 @@ var RdfDocument = class extends Thing {
 
 // src/namespaces/index.ts
 var rdfs = Namespace("http://www.w3.org/2000/01/rdf-schema#");
+var pim = Namespace("http://www.w3.org/ns/pim/space#");
 
 // src/search/LabelIndex.ts
 var LabelIndex = class extends RdfDocument {
@@ -13949,13 +13959,37 @@ function createEmptyTurtleFile(fetcher2, url7) {
 // node_modules/@solid-data-modules/rdflib-utils/dist/namespaces/index.js
 var rdf = Namespace("http://www.w3.org/1999/02/22-rdf-syntax-ns#");
 var solid = Namespace("http://www.w3.org/ns/solid/terms#");
-var pim = Namespace("http://www.w3.org/ns/pim/space#");
+var pim2 = Namespace("http://www.w3.org/ns/pim/space#");
 var ldp = Namespace("http://www.w3.org/ns/ldp#");
 
 // node_modules/@solid-data-modules/rdflib-utils/dist/identifier/generate-id.js
 var import_short_unique_id = __toESM(require_short_unique_id(), 1);
 var uid = new import_short_unique_id.default({ length: 10 });
 
+// src/search/createDefaultLabelIndex.ts
+function createDefaultLabelIndex(profile2) {
+  const webId = namedNode(profile2.webId);
+  const preferencesFile2 = profile2.getPreferencesFile();
+  const defaultFileName = "privateLabelIndex.ttl";
+  const indexUrl = preferencesFile2 ? new URL(defaultFileName, preferencesFile2).href : new URL(defaultFileName, webId.uri).href;
+  const preferencesOrProfileDoc = preferencesFile2 ? namedNode(preferencesFile2) : webId.doc();
+  const indexDocument = namedNode(indexUrl);
+  return {
+    uri: indexDocument.uri,
+    insertions: [
+      st(
+        webId,
+        solid("privateLabelIndex"),
+        indexDocument,
+        preferencesOrProfileDoc
+      ),
+      st(indexDocument, rdfs("label"), lit("Default Index"), indexDocument)
+    ],
+    deletions: [],
+    filesToCreate: []
+  };
+}
+
 // src/search/addToLabelIndex.ts
 var addToLabelIndex = (thing, labelIndex) => {
   return {
@@ -13972,6 +14006,36 @@ var addToLabelIndex = (thing, labelIndex) => {
   };
 };
 
+// src/search/SearchGateway.ts
+var SearchGateway = class {
+  constructor(store) {
+    this.store = store;
+  }
+  /**
+   * Fetch the private label index for the given profile and build a search index from it
+   * @param webId
+   */
+  async buildSearchIndex(profile2) {
+    const labelIndexUris = profile2.getPrivateLabelIndexes();
+    if (labelIndexUris.length > 0) {
+      await this.store.fetchAll(labelIndexUris);
+      const labelIndex = labelIndexUris.map(
+        (uri6) => this.store.get(uri6).assume(LabelIndex)
+      );
+      return new SearchIndex(labelIndex);
+    }
+    return new SearchIndex([]);
+  }
+  async addToLabelIndex(thing, labelIndex) {
+    await this.store.executeUpdate(addToLabelIndex(thing, labelIndex));
+  }
+  async createDefaultLabelIndex(profile2) {
+    const operation3 = createDefaultLabelIndex(profile2);
+    await this.store.executeUpdate(operation3);
+    return this.store.get(operation3.uri).assume(LabelIndex);
+  }
+};
+
 // src/Store.ts
 var Store = class {
   constructor(session4) {
@@ -14056,8 +14120,7 @@ var Store = class {
       }
     );
   }
-  async addToLabelIndex(thing, labelIndex) {
-    const operation3 = addToLabelIndex(thing, labelIndex);
+  async executeUpdate(operation3) {
     await executeUpdate(this.fetcher, this.updater, operation3);
   }
 };
@@ -34412,6 +34475,7 @@ var PodOS = class {
   constructor() {
     this.session = new BrowserSession();
     this.store = new Store(this.session);
+    this.searchGateway = new SearchGateway(this.store);
     this.flagAuthorizationMetaDataOnSessionChange();
     this.uriService = new UriService(this.store);
     this.fileFetcher = new FileFetcher(this.session);
@@ -34494,15 +34558,7 @@ var PodOS = class {
    * @param webId
    */
   async buildSearchIndex(profile2) {
-    const labelIndexUris = profile2.getPrivateLabelIndexes();
-    if (labelIndexUris.length > 0) {
-      await this.fetchAll(labelIndexUris);
-      const labelIndex = labelIndexUris.map(
-        (uri6) => this.store.get(uri6).assume(LabelIndex)
-      );
-      return new SearchIndex(labelIndex);
-    }
-    return new SearchIndex([]);
+    return this.searchGateway.buildSearchIndex(profile2);
   }
   logout() {
     return this.session.logout();
@@ -34519,7 +34575,16 @@ var PodOS = class {
    * @param labelIndex - The index to update
    */
   async addToLabelIndex(thing, labelIndex) {
-    await this.store.addToLabelIndex(thing, labelIndex);
+    await this.searchGateway.addToLabelIndex(thing, labelIndex);
+  }
+  /**
+   * 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
+   */
+  async createDefaultLabelIndex(profile2) {
+    return await this.searchGateway.createDefaultLabelIndex(profile2);
   }
 };
 export {
@@ -34531,6 +34596,7 @@ export {
   LdpContainer,
   PodOS,
   RdfDocument,
+  SearchGateway,
   SearchIndex,
   Thing,
   WebIdProfile,

package/lib/index.js

@@ -41436,6 +41436,7 @@ _:patch
     LdpContainer: () => LdpContainer,
     PodOS: () => PodOS,
     RdfDocument: () => RdfDocument,
+    SearchGateway: () => SearchGateway,
     SearchIndex: () => SearchIndex,
     Thing: () => Thing,
     WebIdProfile: () => WebIdProfile,
@@ -46795,13 +46796,21 @@ _:patch
   // src/search/SearchIndex.ts
   var import_lunr = __toESM(require_lunr());
   var SearchIndex = class {
-    constructor(indexes) {
+    constructor(labelIndexes) {
+      this.labelIndexes = labelIndexes;
+      this.index = this.rebuild().index;
+    }
+    /**
+     * Recreates the search index with the current data from all label indexes
+     */
+    rebuild() {
+      const labelIndexes = this.labelIndexes;
       this.index = (0, import_lunr.default)(function() {
         this.ref("uri");
         this.field("uri");
         this.field("label");
         this.metadataWhitelist = ["position"];
-        const items2 = indexes.flatMap((it) => it.getIndexedItems());
+        const items2 = labelIndexes.flatMap((it) => it.getIndexedItems());
         items2.forEach((item4) => {
           this.add({
             uri: item4.uri,
@@ -46809,6 +46818,7 @@ _:patch
           });
         });
       });
+      return this;
     }
     /**
      * Search the index for a given term. It finds partial matches, but will rank exact matches higher.
@@ -46869,6 +46879,7 @@ _:patch
   // src/namespaces/index.ts
   init_esm();
   var rdfs = Namespace("http://www.w3.org/2000/01/rdf-schema#");
+  var pim2 = Namespace("http://www.w3.org/ns/pim/space#");
 
   // src/search/LabelIndex.ts
   var LabelIndex = class extends RdfDocument {
@@ -46900,7 +46911,7 @@ _:patch
     }
   };
 
-  // src/Store.ts
+  // src/search/createDefaultLabelIndex.ts
   init_esm();
 
   // node_modules/@solid-data-modules/rdflib-utils/dist/web-operations/executeUpdate.js
@@ -46920,13 +46931,37 @@ _:patch
   init_esm();
   var rdf4 = Namespace("http://www.w3.org/1999/02/22-rdf-syntax-ns#");
   var solid2 = Namespace("http://www.w3.org/ns/solid/terms#");
-  var pim2 = Namespace("http://www.w3.org/ns/pim/space#");
+  var pim3 = Namespace("http://www.w3.org/ns/pim/space#");
   var ldp2 = Namespace("http://www.w3.org/ns/ldp#");
 
   // node_modules/@solid-data-modules/rdflib-utils/dist/identifier/generate-id.js
   var import_short_unique_id2 = __toESM(require_short_unique_id(), 1);
   var uid2 = new import_short_unique_id2.default({ length: 10 });
 
+  // src/search/createDefaultLabelIndex.ts
+  function createDefaultLabelIndex(profile2) {
+    const webId = namedNode(profile2.webId);
+    const preferencesFile2 = profile2.getPreferencesFile();
+    const defaultFileName = "privateLabelIndex.ttl";
+    const indexUrl = preferencesFile2 ? new URL(defaultFileName, preferencesFile2).href : new URL(defaultFileName, webId.uri).href;
+    const preferencesOrProfileDoc = preferencesFile2 ? namedNode(preferencesFile2) : webId.doc();
+    const indexDocument = namedNode(indexUrl);
+    return {
+      uri: indexDocument.uri,
+      insertions: [
+        st(
+          webId,
+          solid2("privateLabelIndex"),
+          indexDocument,
+          preferencesOrProfileDoc
+        ),
+        st(indexDocument, rdfs("label"), lit("Default Index"), indexDocument)
+      ],
+      deletions: [],
+      filesToCreate: []
+    };
+  }
+
   // src/search/addToLabelIndex.ts
   init_esm();
   var addToLabelIndex = (thing, labelIndex) => {
@@ -46944,7 +46979,38 @@ _:patch
     };
   };
 
+  // src/search/SearchGateway.ts
+  var SearchGateway = class {
+    constructor(store) {
+      this.store = store;
+    }
+    /**
+     * Fetch the private label index for the given profile and build a search index from it
+     * @param webId
+     */
+    async buildSearchIndex(profile2) {
+      const labelIndexUris = profile2.getPrivateLabelIndexes();
+      if (labelIndexUris.length > 0) {
+        await this.store.fetchAll(labelIndexUris);
+        const labelIndex = labelIndexUris.map(
+          (uri6) => this.store.get(uri6).assume(LabelIndex)
+        );
+        return new SearchIndex(labelIndex);
+      }
+      return new SearchIndex([]);
+    }
+    async addToLabelIndex(thing, labelIndex) {
+      await this.store.executeUpdate(addToLabelIndex(thing, labelIndex));
+    }
+    async createDefaultLabelIndex(profile2) {
+      const operation3 = createDefaultLabelIndex(profile2);
+      await this.store.executeUpdate(operation3);
+      return this.store.get(operation3.uri).assume(LabelIndex);
+    }
+  };
+
   // src/Store.ts
+  init_esm();
   var Store = class {
     constructor(session4) {
       this.graph = graph();
@@ -47028,8 +47094,7 @@ _:patch
         }
       );
     }
-    async addToLabelIndex(thing, labelIndex) {
-      const operation3 = addToLabelIndex(thing, labelIndex);
+    async executeUpdate(operation3) {
       await executeUpdate2(this.fetcher, this.updater, operation3);
     }
   };
@@ -67385,6 +67450,7 @@ _:patch
     constructor() {
       this.session = new BrowserSession();
       this.store = new Store(this.session);
+      this.searchGateway = new SearchGateway(this.store);
       this.flagAuthorizationMetaDataOnSessionChange();
       this.uriService = new UriService(this.store);
       this.fileFetcher = new FileFetcher(this.session);
@@ -67467,15 +67533,7 @@ _:patch
      * @param webId
      */
     async buildSearchIndex(profile2) {
-      const labelIndexUris = profile2.getPrivateLabelIndexes();
-      if (labelIndexUris.length > 0) {
-        await this.fetchAll(labelIndexUris);
-        const labelIndex = labelIndexUris.map(
-          (uri6) => this.store.get(uri6).assume(LabelIndex)
-        );
-        return new SearchIndex(labelIndex);
-      }
-      return new SearchIndex([]);
+      return this.searchGateway.buildSearchIndex(profile2);
     }
     logout() {
       return this.session.logout();
@@ -67492,7 +67550,16 @@ _:patch
      * @param labelIndex - The index to update
      */
     async addToLabelIndex(thing, labelIndex) {
-      await this.store.addToLabelIndex(thing, labelIndex);
+      await this.searchGateway.addToLabelIndex(thing, labelIndex);
+    }
+    /**
+     * 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
+     */
+    async createDefaultLabelIndex(profile2) {
+      return await this.searchGateway.createDefaultLabelIndex(profile2);
     }
   };
   return __toCommonJS(index_exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pod-os/core",
-  "version": "0.14.1-178554f.0",
+  "version": "0.14.1-bcfffa2.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";