@pod-os/core 0.22.1-rc.77c38a0.0 → 0.23.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pod-os/core",
   "description": "Core module of PodOS",
-  "version": "0.22.1-rc.77c38a0.0",
+  "version": "0.23.0",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./types/index.d.ts",
@@ -30,6 +30,7 @@
     "build:types:watch": "rimraf types && tsc --emitDeclarationOnly --outDir types --watch",
     "build:watch": "node esbuild/watch-esm.mjs",
     "build:doc": "typedoc",
+    "postbuild:doc": "./scripts/postprocess-typedoc.sh",
     "dev": "run-p build:types:watch build:watch",
     "build": " npm run build:bundle && npm run build:types && npm run build:esm"
   },

package/types/Store.d.ts

@@ -3,7 +3,7 @@ import { PodOsSession } from "./authentication";
 import { Thing } from "./thing";
 import { ModuleConfig, UpdateOperation } from "@solid-data-modules/rdflib-utils";
 import { OfflineCache, OnlineStatus } from "./offline-cache";
-import { Subject } from "rxjs";
+import { Observable, Subject } from "rxjs";
 import { Quad } from "rdflib/lib/tf-types";
 /**
  * The Store contains all data that is known locally.
@@ -42,6 +42,18 @@ export declare class Store {
     executeUpdate(operation: UpdateOperation): Promise<void>;
     flagAuthorizationMetadata(): void;
     loadModule<T>(module: PodOsModule<T>): T;
+    /**
+     * Finds instances of the given class or its sub-classes
+     * @param {string} classUri
+     * @returns {string[]} An array of URIs
+     */
+    findMembers(classUri: string): string[];
+    /**
+     * Get an Observable that will push new results from {@link findMembers} when it changes
+     * @param {string} classUri
+     * @returns {Observable<string[]>} Observable that pushes an array of URIs of instances of the given class or its sub-classes
+     */
+    observeFindMembers(classUri: string): Observable<string[]>;
 }
 export interface PodOsModule<T> {
     readonly default: new (config: ModuleConfig) => T;

package/types/Store.findMembers.spec.d.ts

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

package/types/index.d.ts

@@ -40,6 +40,7 @@ export declare class PodOS {
     private readonly searchGateway;
     private readonly pictureGateway;
     private readonly offlineCache;
+    private readonly profileGateway;
     constructor({ session, offlineCache, onlineStatus, internalStore, }?: PodOsConfiguration);
     private flagAuthorizationMetaDataOnSessionChange;
     fetch(uri: string): Promise<Response>;

package/types/namespaces/index.d.ts

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

package/types/profile/ProfileGateway.d.ts

@@ -0,0 +1,7 @@
+import { WebIdProfile } from "./WebIdProfile";
+import { Store } from "../Store";
+export declare class ProfileGateway {
+    private readonly store;
+    constructor(store: Store);
+    fetchProfile(webId: string): Promise<WebIdProfile>;
+}

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

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

package/types/profile/WebIdProfile.d.ts

@@ -1,17 +1,26 @@
 import { IndexedFormula } from "rdflib";
 import { Thing } from "../thing";
 /**
- * Allows to find things related to the WebID and their profile document
+ * Allows finding things related to the WebID and their profile document
  */
 export declare class WebIdProfile extends Thing {
     readonly webId: string;
     readonly store: IndexedFormula;
     readonly editable: boolean;
+    private profileQuery;
     constructor(webId: string, store: IndexedFormula, editable?: boolean);
     /**
-     * Returns te URI of the preferences document
+     * Returns the URI of the preferences document
      */
-    getPreferencesFile(): string | void;
+    getPreferencesFile(): string | undefined;
+    /**
+     * Returns the URI of the public type index document
+     */
+    getPublicTypeIndex(): string | undefined;
+    /**
+     * Returns the URI of the private type index document
+     */
+    getPrivateTypeIndex(): string | undefined;
     /**
      * Returns the URIs of the private label indexes
      */

package/types/profile/index.d.ts

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

package/types/type-index/TypeIndex.d.ts

@@ -0,0 +1,13 @@
+import { Thing } from "../thing";
+import { IndexedFormula } from "rdflib";
+import { TypeRegistration } from "./TypeRegistration";
+/**
+ * Represents a private or public type index document
+ */
+export declare class TypeIndex extends Thing {
+    readonly uri: string;
+    readonly store: IndexedFormula;
+    readonly editable: boolean;
+    constructor(uri: string, store: IndexedFormula, editable?: boolean);
+    listAll(): TypeRegistration[];
+}

package/types/type-index/TypeIndex.spec.d.ts

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

package/types/type-index/TypeRegistration.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Registration of a type in the type index
+ */
+export interface TypeRegistration {
+    /**
+     * RDF class of the indexed item(s) (resembling terms:forClass)
+     */
+    forClass: string;
+    /**
+     * The containers or things this registration points to
+     */
+    targets: RegistrationTarget[];
+}
+/**
+ * Target of a type registration
+ */
+export interface RegistrationTarget {
+    /**
+     * container containing instances or direct reference to a single instance
+     */
+    type: "container" | "instance";
+    /**
+     * URI the index points to (resembling terms:instance or terms:instanceContainer)
+     */
+    uri: string;
+}

package/types/type-index/index.d.ts

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