@pod-os/core 0.18.1-rc.54389d8.0 → 0.18.1-rc.8722696.0

package/dist/index.js

@@ -2821,6 +2821,12 @@ var Thing = class {
     this.store = store;
     this.editable = editable;
   }
+  /**
+   * Returns a human-readable label for this thing. Tries to match common RDF terms
+   * used for labels, such as `rdfs:label`, `schema:name` and others.
+   *
+   * If no such term is present, it will derive a label from the URI.
+   */
   label() {
     const value7 = this.anyValue(
       "http://www.w3.org/2006/vcard/ns#fn",
@@ -2840,6 +2846,9 @@ var Thing = class {
     }
     return labelFromUri(this.uri);
   }
+  /**
+   * Returns all the literal values that are linked to this thing
+   */
   literals() {
     const statements = this.store.statementsMatching(namedNode(this.uri));
     const values2 = statements.filter((it) => isLiteral(it.object)).reduce(accumulateValues, {});
@@ -2849,6 +2858,9 @@ var Thing = class {
       values: values2[predicate4]
     }));
   }
+  /**
+   * Returns all the links from this thing to other resources
+   */
   relations(predicate4) {
     const statements = this.store.statementsMatching(
       namedNode(this.uri),
@@ -2861,6 +2873,9 @@ var Thing = class {
       uris: values2[predicate5]
     }));
   }
+  /**
+   * Returns all the links from other resources to this thing
+   */
   reverseRelations(predicate4) {
     const statements = this.store.statementsMatching(
       void 0,
@@ -2874,6 +2889,10 @@ var Thing = class {
       uris: values2[predicate5]
     }));
   }
+  /**
+   * Returns any value linked from this thing via one of the given predicates
+   * @param predicateUris
+   */
   anyValue(...predicateUris) {
     let value7;
     predicateUris.some((it) => {
@@ -2882,6 +2901,10 @@ var Thing = class {
     });
     return value7;
   }
+  /**
+   * Returns a literal value that describes this thing. Tries to match common RDF terms
+   * used for descriptions, like `dct:description`, `schema:description` or `rdfs:comment`
+   */
   description() {
     return this.anyValue(
       "http://purl.org/dc/terms/description",
@@ -2895,6 +2918,13 @@ var Thing = class {
       "http://www.w3.org/2006/vcard/ns#note"
     );
   }
+  /**
+   * Returns the url of a picture or logo associated with this thing
+   * Tries to match common RDF terms used for pictures like `schema:image`,
+   * `vcard:photo` or `foaf:img`
+   *
+   * @return {Object} An object containing the `url` of the picture
+   */
   picture() {
     const directUrl = this.anyValue(
       "http://schema.org/image",
@@ -2936,6 +2966,9 @@ var Thing = class {
       url: url7
     } : null;
   }
+  /**
+   * Retrieves a list of RDF types for this thing.
+   */
   types() {
     const uriMap = this.store.findTypeURIs(namedNode(this.uri));
     return Object.keys(uriMap).map((uri6) => ({
@@ -2943,6 +2976,11 @@ var Thing = class {
       label: labelForType(uri6)
     }));
   }
+  /**
+   * Call this method to switch to a more specific subclass of Thing.
+   *
+   * @param SpecificThing - a subclass of Thing to assume
+   */
   assume(SpecificThing) {
     return new SpecificThing(this.uri, this.store, this.editable);
   }
@@ -3175,7 +3213,7 @@ var SearchGateway = class {
   }
   /**
    * Fetch the private label index for the given profile and build a search index from it
-   * @param webId
+   * @param profile
    */
   async buildSearchIndex(profile2) {
     const labelIndexUris = profile2.getPrivateLabelIndexes();
@@ -24836,7 +24874,7 @@ var PodOS = class {
   }
   /**
    * Fetch the private label index for the given profile and build a search index from it
-   * @param webId
+   * @param profile
    */
   async buildSearchIndex(profile2) {
     return this.searchGateway.buildSearchIndex(profile2);
@@ -24883,7 +24921,9 @@ export {
   RdfDocument,
   SearchGateway,
   SearchIndex,
+  Store,
   Thing,
+  UriService,
   WebIdProfile,
   labelFromUri,
   listKnownTerms

package/lib/index.js

@@ -34756,7 +34756,9 @@ _:patch
     RdfDocument: () => RdfDocument,
     SearchGateway: () => SearchGateway,
     SearchIndex: () => SearchIndex,
+    Store: () => Store,
     Thing: () => Thing,
+    UriService: () => UriService,
     WebIdProfile: () => WebIdProfile,
     labelFromUri: () => labelFromUri,
     listKnownTerms: () => listKnownTerms
@@ -35789,6 +35791,12 @@ _:patch
       this.store = store;
       this.editable = editable;
     }
+    /**
+     * Returns a human-readable label for this thing. Tries to match common RDF terms
+     * used for labels, such as `rdfs:label`, `schema:name` and others.
+     *
+     * If no such term is present, it will derive a label from the URI.
+     */
     label() {
       const value7 = this.anyValue(
         "http://www.w3.org/2006/vcard/ns#fn",
@@ -35808,6 +35816,9 @@ _:patch
       }
       return labelFromUri(this.uri);
     }
+    /**
+     * Returns all the literal values that are linked to this thing
+     */
     literals() {
       const statements = this.store.statementsMatching(namedNode(this.uri));
       const values2 = statements.filter((it) => isLiteral(it.object)).reduce(accumulateValues, {});
@@ -35817,6 +35828,9 @@ _:patch
         values: values2[predicate4]
       }));
     }
+    /**
+     * Returns all the links from this thing to other resources
+     */
     relations(predicate4) {
       const statements = this.store.statementsMatching(
         namedNode(this.uri),
@@ -35829,6 +35843,9 @@ _:patch
         uris: values2[predicate5]
       }));
     }
+    /**
+     * Returns all the links from other resources to this thing
+     */
     reverseRelations(predicate4) {
       const statements = this.store.statementsMatching(
         void 0,
@@ -35842,6 +35859,10 @@ _:patch
         uris: values2[predicate5]
       }));
     }
+    /**
+     * Returns any value linked from this thing via one of the given predicates
+     * @param predicateUris
+     */
     anyValue(...predicateUris) {
       let value7;
       predicateUris.some((it) => {
@@ -35850,6 +35871,10 @@ _:patch
       });
       return value7;
     }
+    /**
+     * Returns a literal value that describes this thing. Tries to match common RDF terms
+     * used for descriptions, like `dct:description`, `schema:description` or `rdfs:comment`
+     */
     description() {
       return this.anyValue(
         "http://purl.org/dc/terms/description",
@@ -35863,6 +35888,13 @@ _:patch
         "http://www.w3.org/2006/vcard/ns#note"
       );
     }
+    /**
+     * Returns the url of a picture or logo associated with this thing
+     * Tries to match common RDF terms used for pictures like `schema:image`,
+     * `vcard:photo` or `foaf:img`
+     *
+     * @return {Object} An object containing the `url` of the picture
+     */
     picture() {
       const directUrl = this.anyValue(
         "http://schema.org/image",
@@ -35904,6 +35936,9 @@ _:patch
         url: url7
       } : null;
     }
+    /**
+     * Retrieves a list of RDF types for this thing.
+     */
     types() {
       const uriMap = this.store.findTypeURIs(namedNode(this.uri));
       return Object.keys(uriMap).map((uri6) => ({
@@ -35911,6 +35946,11 @@ _:patch
         label: labelForType(uri6)
       }));
     }
+    /**
+     * Call this method to switch to a more specific subclass of Thing.
+     *
+     * @param SpecificThing - a subclass of Thing to assume
+     */
     assume(SpecificThing) {
       return new SpecificThing(this.uri, this.store, this.editable);
     }
@@ -36153,7 +36193,7 @@ _:patch
     }
     /**
      * Fetch the private label index for the given profile and build a search index from it
-     * @param webId
+     * @param profile
      */
     async buildSearchIndex(profile2) {
       const labelIndexUris = profile2.getPrivateLabelIndexes();
@@ -57819,7 +57859,7 @@ _:patch
     }
     /**
      * Fetch the private label index for the given profile and build a search index from it
-     * @param webId
+     * @param profile
      */
     async buildSearchIndex(profile2) {
       return this.searchGateway.buildSearchIndex(profile2);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pod-os/core",
-  "version": "0.18.1-rc.54389d8.0",
+  "version": "0.18.1-rc.8722696.0",
   "main": "./dist/index.js",
   "types": "./types/index.d.ts",
   "files": [

package/types/Store.d.ts

@@ -39,7 +39,6 @@ export declare class Store {
     flagAuthorizationMetadata(): void;
     loadModule<T>(module: PodOsModule<T>): T;
 }
-interface PodOsModule<T> {
+export interface PodOsModule<T> {
     readonly default: new (config: ModuleConfig) => T;
 }
-export {};

package/types/index.d.ts

@@ -19,6 +19,8 @@ export * from "./profile";
 export * from "./search";
 export * from "./offline-cache";
 export * from "./terms";
+export * from "./Store";
+export * from "./uri";
 export interface PodOsConfiguration {
     offlineCache?: OfflineCache;
     onlineStatus?: OnlineStatus;
@@ -52,7 +54,7 @@ export declare class PodOS {
     fetchProfile(webId: string): Promise<WebIdProfile>;
     /**
      * Fetch the private label index for the given profile and build a search index from it
-     * @param webId
+     * @param profile
      */
     buildSearchIndex(profile: WebIdProfile): Promise<import("./search").SearchIndex>;
     logout(): Promise<void>;

package/types/offline-cache/index.d.ts

@@ -1,3 +1,3 @@
-export { OfflineCapableFetcher } from "./OfflineCapableFetcher";
+export { OfflineCapableFetcher, OfflineCapableFetcherOptions, } from "./OfflineCapableFetcher";
 export { OfflineCache, CachedRdfDocument, NoOfflineCache, } from "./OfflineCache";
 export { OnlineStatus, AssumeAlwaysOnline } from "./OnlineStatus";

package/types/search/SearchGateway.d.ts

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

package/types/thing/Thing.d.ts

@@ -25,16 +25,54 @@ export declare class Thing {
      * Whether the Thing can be edited according to its access control settings
      */
     editable?: boolean);
+    /**
+     * Returns a human-readable label for this thing. Tries to match common RDF terms
+     * used for labels, such as `rdfs:label`, `schema:name` and others.
+     *
+     * If no such term is present, it will derive a label from the URI.
+     */
     label(): string;
+    /**
+     * Returns all the literal values that are linked to this thing
+     */
     literals(): Literal[];
+    /**
+     * Returns all the links from this thing to other resources
+     */
     relations(predicate?: string): Relation[];
+    /**
+     * Returns all the links from other resources to this thing
+     */
     reverseRelations(predicate?: string): Relation[];
+    /**
+     * Returns any value linked from this thing via one of the given predicates
+     * @param predicateUris
+     */
     anyValue(...predicateUris: string[]): undefined;
+    /**
+     * Returns a literal value that describes this thing. Tries to match common RDF terms
+     * used for descriptions, like `dct:description`, `schema:description` or `rdfs:comment`
+     */
     description(): undefined;
+    /**
+     * Returns the url of a picture or logo associated with this thing
+     * Tries to match common RDF terms used for pictures like `schema:image`,
+     * `vcard:photo` or `foaf:img`
+     *
+     * @return {Object} An object containing the `url` of the picture
+     */
     picture(): {
         url: string;
     } | null;
     private findActivityStreamsPicture;
+    /**
+     * Retrieves a list of RDF types for this thing.
+     */
     types(): RdfType[];
+    /**
+     * Call this method to switch to a more specific subclass of Thing.
+     *
+     * @param SpecificThing - a subclass of Thing to assume
+     */
     assume<T>(SpecificThing: new (uri: string, store: IndexedFormula, editable: boolean) => T): T;
 }

package/types/uri/index.d.ts

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