@pod-os/core 0.23.1-rc.f73863c.0 → 0.24.0-rc.e770383.0

package/types/files/FileFetcher.d.ts

@@ -3,6 +3,9 @@ import { SolidFile } from "./SolidFile";
 import { LdpContainer } from "../ldp-container";
 import { HttpProblem, NetworkProblem } from "../problems";
 import { ResultAsync } from "neverthrow";
+/**
+ * Handles HTTP operations for files, like fetching and updating file contents.
+ */
 export declare class FileFetcher {
     private session;
     constructor(session: PodOsSession);

package/types/files/FileGateway.d.ts

@@ -0,0 +1,27 @@
+import { ResultAsync } from "neverthrow";
+import { Thing } from "../thing";
+import { Store } from "../Store";
+import { FileFetcher, NewFile } from "../files";
+import { HttpProblem, NetworkProblem } from "../problems";
+/**
+ * Gateway for file-related operations on Solid Pods and the store.
+ * @since 0.24.0
+ */
+export declare class FileGateway {
+    private readonly store;
+    private readonly fileFetcher;
+    constructor(store: Store, fileFetcher: FileFetcher);
+    /**
+     * Uploads a file and associates it with a thing.
+     * The container is automatically derived from the thing's URI.
+     * Uses schema:image as the predicate.
+     *
+     * @param thing - The thing to add the file to
+     * @param predicateUri - The URI of the predicate to use
+     * @param fileToUpload - The file to upload
+     * @returns Result with the uploaded metadata (url, name, contentType) or error
+     */
+    uploadAndLinkFile(thing: Thing, predicateUri: string, fileToUpload: File): ResultAsync<NewFile, HttpProblem | NetworkProblem>;
+    private linkFileToThing;
+    private getContainerFromThing;
+}

package/types/files/FileGateway.spec.d.ts

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

package/types/files/createFileLinkOperation.d.ts

@@ -0,0 +1,16 @@
+import { UpdateOperation } from "@solid-data-modules/rdflib-utils";
+import { Thing } from "../thing";
+import { NewFile } from "../files";
+/**
+ * Creates an update operation to link a file to a thing.
+ * Uses given predicate to establish the relationship.
+ *
+ * @since 0.24.0
+ * @internal
+ *
+ * @param thing - The thing to link the file to
+ * @param predicateUri - The URI of the predicate to use
+ * @param file - The uploaded file metadata
+ * @returns UpdateOperation that adds the file link to the thing's document
+ */
+export declare function createFileLinkOperation(thing: Thing, predicateUri: string, file: NewFile): UpdateOperation;

package/types/files/createFileLinkOperation.spec.d.ts

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

package/types/files/index.d.ts

@@ -3,3 +3,4 @@ export * from "./BinaryFile";
 export * from "./BrokenFile";
 export * from "./HttpStatus";
 export * from "./FileFetcher";
+export * from "./FileGateway";

package/types/index.d.ts

@@ -1,8 +1,8 @@
 import { ContactsModule } from "@solid-data-modules/contacts-rdflib";
 import { BehaviorSubject } from "rxjs";
-import { SessionInfo, PodOsSession } from "./authentication";
-import { SolidFile } from "./files";
-import { FileFetcher } from "./files/FileFetcher";
+import { PodOsSession, SessionInfo } from "./authentication";
+import { FileFetcher, SolidFile } from "./files";
+import { AttachmentGateway } from "./attachments";
 import { WebIdProfile } from "./profile";
 import { LabelIndex } from "./search";
 import { Store } from "./Store";
@@ -18,6 +18,7 @@ export * from "./files";
 export * from "./thing";
 export * from "./rdf-document";
 export * from "./ldp-container";
+export * from "./attachments";
 export * from "./picture";
 export * from "./profile";
 export * from "./search";
@@ -26,6 +27,7 @@ export * from "./terms";
 export * from "./Store";
 export * from "./uri";
 export * from "./problems";
+export * from "./type-index";
 export interface PodOsConfiguration {
     offlineCache?: OfflineCache;
     onlineStatus?: OnlineStatus;
@@ -38,6 +40,8 @@ export declare class PodOS {
     readonly uriService: UriService;
     private readonly fileFetcher;
     private readonly searchGateway;
+    private readonly fileGateway;
+    private readonly attachmentGateway;
     private readonly pictureGateway;
     private readonly offlineCache;
     private readonly profileGateway;
@@ -101,4 +105,10 @@ export declare class PodOS {
     uploadAndAddPicture(thing: Thing, pictureFile: File): ResultAsync<{
         url: string;
     }, HttpProblem | NetworkProblem>;
+    /**
+     * Provides access to attachment operations such as uploading and linking attachments to things
+     * @since 0.24.0
+     * @returns {AttachmentGateway} An instance of AttachmentGateway that handles attachment operations
+     */
+    attachments(): AttachmentGateway;
 }

package/types/namespaces/index.d.ts

@@ -1,3 +1,4 @@
 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;
+export declare const flow: (ln: string) => import("rdflib/lib/tf-types").NamedNode;

package/types/picture/PictureGateway.d.ts

@@ -1,12 +1,13 @@
 import { ResultAsync } from "neverthrow";
 import { Thing } from "../thing";
-import { Store } from "../Store";
-import { FileFetcher, NewFile } from "../files";
+import { FileGateway, NewFile } from "../files";
 import { HttpProblem, NetworkProblem } from "../problems";
+/**
+ * Gateway for picture-related operations on Solid Pods and the store.
+ */
 export declare class PictureGateway {
-    private readonly store;
-    private readonly fileFetcher;
-    constructor(store: Store, fileFetcher: FileFetcher);
+    private readonly attachmentGateway;
+    constructor(attachmentGateway: FileGateway);
     /**
      * Uploads a picture file and associates it with a thing.
      * The container is automatically derived from the thing's URI.
@@ -17,8 +18,6 @@ export declare class PictureGateway {
      * @returns Result with the uploaded picture metadata (url, name, contentType) or error
      */
     uploadAndAddPicture(thing: Thing, pictureFile: File): ResultAsync<UploadedPicture, HttpProblem | NetworkProblem>;
-    private linkPictureToThing;
-    private getContainerFromThing;
 }
 type UploadedPicture = NewFile;
 export {};

package/types/picture/index.d.ts

@@ -1,2 +1 @@
 export * from "./PictureGateway";
-export * from "./createPictureLinkOperation";

package/types/profile/ProfileGateway.d.ts

@@ -1,7 +1,17 @@
 import { WebIdProfile } from "./WebIdProfile";
 import { Store } from "../Store";
+/**
+ * Gateway for profile-related operations on Solid Pods and the store.
+ * @since 0.24.0
+ */
 export declare class ProfileGateway {
     private readonly store;
     constructor(store: Store);
+    /**
+     * Fetches the profile for the given WebID and all linked documents
+     * @since 0.24.0
+     * @param webId The WebID to fetch the profile for
+     * @returns {Promise<WebIdProfile>} The fetched profile
+     */
     fetchProfile(webId: string): Promise<WebIdProfile>;
 }

package/types/profile/WebIdProfile.d.ts

@@ -15,10 +15,12 @@ export declare class WebIdProfile extends Thing {
     getPreferencesFile(): string | undefined;
     /**
      * Returns the URI of the public type index document
+     * @since 0.24.0
      */
     getPublicTypeIndex(): string | undefined;
     /**
      * Returns the URI of the private type index document
+     * @since 0.24.0
      */
     getPrivateTypeIndex(): string | undefined;
     /**

package/types/thing/Thing.attachments.spec.d.ts

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

package/types/thing/Thing.d.ts

@@ -13,6 +13,10 @@ export interface RdfType {
     uri: string;
     label: string;
 }
+export interface Attachment {
+    uri: string;
+    label: string;
+}
 export declare class Thing {
     readonly uri: string;
     readonly store: IndexedFormula;
@@ -69,6 +73,10 @@ export declare class Thing {
      * Retrieves a list of RDF types for this thing.
      */
     types(): RdfType[];
+    /**
+     * Returns all attachments linked to this thing
+     */
+    attachments(): Attachment[];
     /**
      * Call this method to switch to a more specific subclass of Thing.
      *

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

@@ -3,6 +3,7 @@ import { IndexedFormula } from "rdflib";
 import { TypeRegistration } from "./TypeRegistration";
 /**
  * Represents a private or public type index document
+ * @since 0.24.0
  */
 export declare class TypeIndex extends Thing {
     readonly uri: string;

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

@@ -6,6 +6,10 @@ export interface TypeRegistration {
      * RDF class of the indexed item(s) (resembling terms:forClass)
      */
     forClass: string;
+    /**
+     * Short label for the class URI
+     */
+    label: string;
     /**
      * The containers or things this registration points to
      */

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

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

package/types/picture/createPictureLinkOperation.d.ts

@@ -1,12 +0,0 @@
-import { UpdateOperation } from "@solid-data-modules/rdflib-utils";
-import { Thing } from "../thing";
-import { NewFile } from "../files";
-/**
- * Creates an update operation to link a picture file to a thing.
- * Uses schema:image as the predicate to establish the relationship.
- *
- * @param thing - The thing to link the picture to
- * @param file - The uploaded picture file metadata
- * @returns UpdateOperation that adds the picture link to the thing's document
- */
-export declare function createPictureLinkOperation(thing: Thing, file: NewFile): UpdateOperation;