@pod-os/core 0.21.1-rc.762dee0.0 → 0.21.1-rc.b558373.0

package/dist/index.js

@@ -3721,22 +3721,26 @@ var FileFetcher = class {
     });
   }
   createNewFile(container2, name9) {
-    const encodedName = encodeURIComponent(name9);
+    const isFile = name9 instanceof File;
+    const fileName = isFile ? name9.name : name9;
+    const encodedName = encodeURIComponent(fileName);
     const url7 = container2.uri + encodedName;
-    const contentTypeHeader = index_lite_default.getType(encodedName) ?? "text/turtle";
+    const contentTypeHeader = isFile ? name9.type : index_lite_default.getType(encodedName) ?? "text/turtle";
+    const body = isFile ? name9 : void 0;
     return ResultAsync.fromPromise(
       this.session.authenticatedFetch(url7, {
         method: "PUT",
         headers: {
           "Content-Type": contentTypeHeader,
           "If-None-Match": "*"
-        }
+        },
+        body
       }),
       (e) => networkProblem("The file could not be created", e)
     ).andThen(
       (response6) => response6.ok ? ok({
         url: url7,
-        name: name9,
+        name: fileName,
         contentType: contentTypeHeader
       }) : err(httpProblem("The file could not be created", response6))
     );
@@ -3994,6 +3998,89 @@ var Thing = class {
   assume(SpecificThing) {
     return new SpecificThing(this.uri, this.store, this.editable);
   }
+  /**
+   * Returns the container that contains this thing's document
+   * The container URI is derived from the thing's URI.
+   */
+  container() {
+    const doc = namedNode(this.uri).doc();
+    const baseUri = doc.value.endsWith("/") ? doc.value.slice(0, -1) : doc.value;
+    const uri6 = new URL(".", baseUri).toString();
+    return { uri: uri6 };
+  }
+};
+
+// src/ldp-container/LdpContainer.ts
+var LdpContainer = class extends Thing {
+  constructor(uri6, store, editable = false) {
+    super(uri6, store, editable);
+    this.uri = uri6;
+    this.store = store;
+    this.editable = editable;
+  }
+  contains() {
+    const contains3 = this.store.statementsMatching(
+      namedNode(this.uri),
+      namedNode("http://www.w3.org/ns/ldp#contains"),
+      null,
+      namedNode(this.uri)
+    );
+    return contains3.map((content5) => ({
+      uri: content5.object.value,
+      name: labelFromUri(content5.object.value)
+    }));
+  }
+};
+
+// src/picture/createPictureLinkOperation.ts
+var SCHEMA_IMAGE = "http://schema.org/image";
+function createPictureLinkOperation(thing, file2) {
+  return {
+    deletions: [],
+    filesToCreate: [],
+    insertions: [
+      st(
+        namedNode(thing.uri),
+        namedNode(SCHEMA_IMAGE),
+        namedNode(file2.url),
+        namedNode(thing.uri).doc()
+      )
+    ]
+  };
+}
+
+// src/picture/PictureGateway.ts
+var PictureGateway = class {
+  constructor(store, fileFetcher) {
+    this.store = store;
+    this.fileFetcher = fileFetcher;
+  }
+  /**
+   * Uploads a picture 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 picture to
+   * @param pictureFile - The picture file to upload
+   * @returns Result with the uploaded picture metadata (url, name, contentType) or error
+   */
+  uploadAndAddPicture(thing, pictureFile) {
+    const container2 = this.getContainerFromThing(thing);
+    return this.fileFetcher.createNewFile(container2, pictureFile).andThen((file2) => this.linkPictureToThing(thing, file2));
+  }
+  linkPictureToThing(thing, file2) {
+    const operation3 = createPictureLinkOperation(thing, file2);
+    return ResultAsync.fromPromise(
+      this.store.executeUpdate(operation3).then(() => file2),
+      () => ({
+        type: "network",
+        title: "Failed to link picture to thing"
+      })
+    );
+  }
+  getContainerFromThing(thing) {
+    return this.store.get(thing.container().uri).assume(LdpContainer);
+  }
 };
 
 // src/profile/WebIdProfile.ts
@@ -4041,7 +4128,7 @@ var WebIdProfile = class extends Thing {
 };
 
 // src/search/SearchIndex.ts
-var import_lunr = __toESM(require_lunr());
+var import_lunr = __toESM(require_lunr(), 1);
 var SearchIndex = class {
   constructor(labelIndexes) {
     this.labelIndexes = labelIndexes;
@@ -4339,6 +4426,12 @@ var Store = class {
       isOnline: onlineStatus.isOnline
     });
     this.updater = new UpdateManager(this.internalStore);
+    this.additions$ = new Subject();
+    this.removals$ = new Subject();
+    this.internalStore.addDataCallback((quad) => this.additions$.next(quad));
+    this.internalStore.addDataRemovalCallback(
+      (quad) => this.removals$.next(quad)
+    );
   }
   /**
    * Fetch data for the given URI to the internalStore
@@ -25739,7 +25832,7 @@ function listKnownTerms() {
 }
 
 // src/uri/UriService.ts
-var import_slugify = __toESM(require_slugify());
+var import_slugify = __toESM(require_slugify(), 1);
 var UriService = class {
   // We expect to use the store for calculating the uris for things
   // e.g. looking up locations in type index
@@ -25782,28 +25875,6 @@ var AnonymousSession = class {
   }
 };
 
-// src/ldp-container/LdpContainer.ts
-var LdpContainer = class extends Thing {
-  constructor(uri6, store, editable = false) {
-    super(uri6, store, editable);
-    this.uri = uri6;
-    this.store = store;
-    this.editable = editable;
-  }
-  contains() {
-    const contains3 = this.store.statementsMatching(
-      namedNode(this.uri),
-      namedNode("http://www.w3.org/ns/ldp#contains"),
-      null,
-      namedNode(this.uri)
-    );
-    return contains3.map((content5) => ({
-      uri: content5.object.value,
-      name: labelFromUri(content5.object.value)
-    }));
-  }
-};
-
 // src/index.ts
 var PodOS = class {
   constructor({
@@ -25821,9 +25892,10 @@ var PodOS = class {
       internalStore
     );
     this.searchGateway = new SearchGateway(this.store);
+    this.fileFetcher = new FileFetcher(this.session);
+    this.pictureGateway = new PictureGateway(this.store, this.fileFetcher);
     this.flagAuthorizationMetaDataOnSessionChange();
     this.uriService = new UriService(this.store);
-    this.fileFetcher = new FileFetcher(this.session);
   }
   /*
        Flagging authorization metadata is necessary every time the user
@@ -25925,6 +25997,17 @@ var PodOS = class {
   async createDefaultLabelIndex(profile2) {
     return await this.searchGateway.createDefaultLabelIndex(profile2);
   }
+  /**
+   * Uploads a picture file and associates it with a thing.
+   * The container is automatically derived from the thing's URI.
+   *
+   * @param thing - The thing to add the picture to
+   * @param pictureFile - The picture file to upload
+   * @returns Result with the picture URL or error
+   */
+  uploadAndAddPicture(thing, pictureFile) {
+    return this.pictureGateway.uploadAndAddPicture(thing, pictureFile);
+  }
 };
 export {
   AnonymousSession,
@@ -25937,6 +26020,7 @@ export {
   LdpContainer,
   NoOfflineCache,
   OfflineCapableFetcher,
+  PictureGateway,
   PodOS,
   RdfDocument,
   SearchGateway,
@@ -25945,6 +26029,7 @@ export {
   Thing,
   UriService,
   WebIdProfile,
+  createPictureLinkOperation,
   httpProblem,
   labelFromUri,
   listKnownTerms,

package/lib/index.js

@@ -34751,6 +34751,7 @@ _:patch
     LdpContainer: () => LdpContainer,
     NoOfflineCache: () => NoOfflineCache,
     OfflineCapableFetcher: () => OfflineCapableFetcher,
+    PictureGateway: () => PictureGateway,
     PodOS: () => PodOS,
     RdfDocument: () => RdfDocument,
     SearchGateway: () => SearchGateway,
@@ -34759,6 +34760,7 @@ _:patch
     Thing: () => Thing,
     UriService: () => UriService,
     WebIdProfile: () => WebIdProfile,
+    createPictureLinkOperation: () => createPictureLinkOperation,
     httpProblem: () => httpProblem,
     labelFromUri: () => labelFromUri,
     listKnownTerms: () => listKnownTerms,
@@ -36685,22 +36687,26 @@ _:patch
       });
     }
     createNewFile(container2, name9) {
-      const encodedName = encodeURIComponent(name9);
+      const isFile = name9 instanceof File;
+      const fileName = isFile ? name9.name : name9;
+      const encodedName = encodeURIComponent(fileName);
       const url7 = container2.uri + encodedName;
-      const contentTypeHeader = index_lite_default.getType(encodedName) ?? "text/turtle";
+      const contentTypeHeader = isFile ? name9.type : index_lite_default.getType(encodedName) ?? "text/turtle";
+      const body = isFile ? name9 : void 0;
       return ResultAsync.fromPromise(
         this.session.authenticatedFetch(url7, {
           method: "PUT",
           headers: {
             "Content-Type": contentTypeHeader,
             "If-None-Match": "*"
-          }
+          },
+          body
         }),
         (e) => networkProblem("The file could not be created", e)
       ).andThen(
         (response6) => response6.ok ? ok({
           url: url7,
-          name: name9,
+          name: fileName,
           contentType: contentTypeHeader
         }) : err(httpProblem("The file could not be created", response6))
       );
@@ -36728,7 +36734,7 @@ _:patch
     return store.loadModule(module3);
   }
 
-  // src/profile/WebIdProfile.ts
+  // src/ldp-container/LdpContainer.ts
   init_esm();
 
   // src/thing/Thing.ts
@@ -36965,9 +36971,94 @@ _:patch
     assume(SpecificThing) {
       return new SpecificThing(this.uri, this.store, this.editable);
     }
+    /**
+     * Returns the container that contains this thing's document
+     * The container URI is derived from the thing's URI.
+     */
+    container() {
+      const doc = namedNode(this.uri).doc();
+      const baseUri = doc.value.endsWith("/") ? doc.value.slice(0, -1) : doc.value;
+      const uri6 = new URL(".", baseUri).toString();
+      return { uri: uri6 };
+    }
+  };
+
+  // src/ldp-container/LdpContainer.ts
+  var LdpContainer = class extends Thing {
+    constructor(uri6, store, editable = false) {
+      super(uri6, store, editable);
+      this.uri = uri6;
+      this.store = store;
+      this.editable = editable;
+    }
+    contains() {
+      const contains3 = this.store.statementsMatching(
+        namedNode(this.uri),
+        namedNode("http://www.w3.org/ns/ldp#contains"),
+        null,
+        namedNode(this.uri)
+      );
+      return contains3.map((content5) => ({
+        uri: content5.object.value,
+        name: labelFromUri(content5.object.value)
+      }));
+    }
+  };
+
+  // src/picture/createPictureLinkOperation.ts
+  init_esm();
+  var SCHEMA_IMAGE = "http://schema.org/image";
+  function createPictureLinkOperation(thing, file2) {
+    return {
+      deletions: [],
+      filesToCreate: [],
+      insertions: [
+        st(
+          namedNode(thing.uri),
+          namedNode(SCHEMA_IMAGE),
+          namedNode(file2.url),
+          namedNode(thing.uri).doc()
+        )
+      ]
+    };
+  }
+
+  // src/picture/PictureGateway.ts
+  var PictureGateway = class {
+    constructor(store, fileFetcher) {
+      this.store = store;
+      this.fileFetcher = fileFetcher;
+    }
+    /**
+     * Uploads a picture 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 picture to
+     * @param pictureFile - The picture file to upload
+     * @returns Result with the uploaded picture metadata (url, name, contentType) or error
+     */
+    uploadAndAddPicture(thing, pictureFile) {
+      const container2 = this.getContainerFromThing(thing);
+      return this.fileFetcher.createNewFile(container2, pictureFile).andThen((file2) => this.linkPictureToThing(thing, file2));
+    }
+    linkPictureToThing(thing, file2) {
+      const operation3 = createPictureLinkOperation(thing, file2);
+      return ResultAsync.fromPromise(
+        this.store.executeUpdate(operation3).then(() => file2),
+        () => ({
+          type: "network",
+          title: "Failed to link picture to thing"
+        })
+      );
+    }
+    getContainerFromThing(thing) {
+      return this.store.get(thing.container().uri).assume(LdpContainer);
+    }
   };
 
   // src/profile/WebIdProfile.ts
+  init_esm();
   var WebIdProfile = class extends Thing {
     constructor(webId, store, editable = false) {
       super(webId, store, editable);
@@ -37012,7 +37103,7 @@ _:patch
   };
 
   // src/search/SearchIndex.ts
-  var import_lunr = __toESM(require_lunr());
+  var import_lunr = __toESM(require_lunr(), 1);
   var SearchIndex = class {
     constructor(labelIndexes) {
       this.labelIndexes = labelIndexes;
@@ -37324,6 +37415,12 @@ _:patch
         isOnline: onlineStatus.isOnline
       });
       this.updater = new UpdateManager(this.internalStore);
+      this.additions$ = new Subject();
+      this.removals$ = new Subject();
+      this.internalStore.addDataCallback((quad3) => this.additions$.next(quad3));
+      this.internalStore.addDataRemovalCallback(
+        (quad3) => this.removals$.next(quad3)
+      );
     }
     /**
      * Fetch data for the given URI to the internalStore
@@ -58724,7 +58821,7 @@ _:patch
   }
 
   // src/uri/UriService.ts
-  var import_slugify = __toESM(require_slugify());
+  var import_slugify = __toESM(require_slugify(), 1);
   var UriService = class {
     // We expect to use the store for calculating the uris for things
     // e.g. looking up locations in type index
@@ -58767,29 +58864,6 @@ _:patch
     }
   };
 
-  // src/ldp-container/LdpContainer.ts
-  init_esm();
-  var LdpContainer = class extends Thing {
-    constructor(uri6, store, editable = false) {
-      super(uri6, store, editable);
-      this.uri = uri6;
-      this.store = store;
-      this.editable = editable;
-    }
-    contains() {
-      const contains3 = this.store.statementsMatching(
-        namedNode(this.uri),
-        namedNode("http://www.w3.org/ns/ldp#contains"),
-        null,
-        namedNode(this.uri)
-      );
-      return contains3.map((content5) => ({
-        uri: content5.object.value,
-        name: labelFromUri(content5.object.value)
-      }));
-    }
-  };
-
   // src/index.ts
   var PodOS = class {
     constructor({
@@ -58807,9 +58881,10 @@ _:patch
         internalStore
       );
       this.searchGateway = new SearchGateway(this.store);
+      this.fileFetcher = new FileFetcher(this.session);
+      this.pictureGateway = new PictureGateway(this.store, this.fileFetcher);
       this.flagAuthorizationMetaDataOnSessionChange();
       this.uriService = new UriService(this.store);
-      this.fileFetcher = new FileFetcher(this.session);
     }
     /*
          Flagging authorization metadata is necessary every time the user
@@ -58911,6 +58986,17 @@ _:patch
     async createDefaultLabelIndex(profile2) {
       return await this.searchGateway.createDefaultLabelIndex(profile2);
     }
+    /**
+     * Uploads a picture file and associates it with a thing.
+     * The container is automatically derived from the thing's URI.
+     *
+     * @param thing - The thing to add the picture to
+     * @param pictureFile - The picture file to upload
+     * @returns Result with the picture URL or error
+     */
+    uploadAndAddPicture(thing, pictureFile) {
+      return this.pictureGateway.uploadAndAddPicture(thing, pictureFile);
+    }
   };
   return __toCommonJS(index_exports);
 })();

package/package.json

@@ -1,13 +1,25 @@
 {
   "name": "@pod-os/core",
-  "version": "0.21.1-rc.762dee0.0",
+  "description": "Core module of PodOS",
+  "version": "0.21.1-rc.b558373.0",
+  "type": "module",
   "main": "./dist/index.js",
   "types": "./types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./types/index.d.ts",
+      "require": "./lib/index.js"
+    }
+  },
   "files": [
     "lib/",
     "dist/",
     "types/"
   ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "scripts": {
     "test": "jest",
     "test:watch": "jest --watch",
@@ -60,9 +72,6 @@
     "slugify": "^1.6.6",
     "url": "^0.11.4"
   },
-  "directories": {
-    "lib": "lib"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/pod-os/pod-os.git"
@@ -70,6 +79,5 @@
   "bugs": {
     "url": "https://github.com/pod-os/pod-os/issues"
   },
-  "homepage": "https://github.com/pod-os/pod-os#readme",
-  "description": ""
+  "homepage": "https://github.com/pod-os/pod-os#readme"
 }

package/types/Store.d.ts

@@ -3,14 +3,18 @@ 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 { Quad } from "rdflib/lib/tf-types";
 /**
- * The internalStore contains all data that is known locally.
+ * 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.
  */
 export declare class Store {
     private readonly internalStore;
     private readonly fetcher;
     private readonly updater;
+    additions$: Subject<Quad>;
+    removals$: Subject<Quad>;
     constructor(session: PodOsSession, offlineCache?: OfflineCache, onlineStatus?: OnlineStatus, internalStore?: IndexedFormula);
     /**
      * Fetch data for the given URI to the internalStore

package/types/files/FileFetcher.d.ts

@@ -19,14 +19,14 @@ export declare class FileFetcher {
      * @returns {Promise<Response>} The HTTP response
      */
     putFile(file: SolidFile, newContent: string): Promise<Response>;
-    createNewFile(container: LdpContainer, name: string): ResultAsync<NewFile, NotCreated>;
+    createNewFile(container: LdpContainer, name: string | File): ResultAsync<NewFile, NotCreated>;
     createNewFolder(container: LdpContainer, name: string): ResultAsync<NewFolder, NotCreated>;
 }
-interface NewFolder {
+export interface NewFolder {
     url: string;
     name: string;
 }
-interface NewFile {
+export interface NewFile {
     url: string;
     name: string;
     contentType: string;

package/types/index.d.ts

@@ -11,11 +11,14 @@ import { Thing } from "./thing";
 import { UriService } from "./uri/UriService";
 import { OfflineCache, OnlineStatus } from "./offline-cache";
 import { IndexedFormula } from "rdflib";
+import { ResultAsync } from "neverthrow";
+import { HttpProblem, NetworkProblem } from "./problems";
 export * from "./authentication";
 export * from "./files";
 export * from "./thing";
 export * from "./rdf-document";
 export * from "./ldp-container";
+export * from "./picture";
 export * from "./profile";
 export * from "./search";
 export * from "./offline-cache";
@@ -35,6 +38,7 @@ export declare class PodOS {
     readonly uriService: UriService;
     private readonly fileFetcher;
     private readonly searchGateway;
+    private readonly pictureGateway;
     private readonly offlineCache;
     constructor({ session, offlineCache, onlineStatus, internalStore, }?: PodOsConfiguration);
     private flagAuthorizationMetaDataOnSessionChange;
@@ -85,4 +89,15 @@ export declare class PodOS {
      * @returns the newly created label index
      */
     createDefaultLabelIndex(profile: WebIdProfile): Promise<LabelIndex>;
+    /**
+     * Uploads a picture file and associates it with a thing.
+     * The container is automatically derived from the thing's URI.
+     *
+     * @param thing - The thing to add the picture to
+     * @param pictureFile - The picture file to upload
+     * @returns Result with the picture URL or error
+     */
+    uploadAndAddPicture(thing: Thing, pictureFile: File): ResultAsync<{
+        url: string;
+    }, HttpProblem | NetworkProblem>;
 }

package/types/picture/PictureGateway.d.ts

@@ -0,0 +1,24 @@
+import { ResultAsync } from "neverthrow";
+import { Thing } from "../thing";
+import { Store } from "../Store";
+import { FileFetcher, NewFile } from "../files";
+import { HttpProblem, NetworkProblem } from "../problems";
+export declare class PictureGateway {
+    private readonly store;
+    private readonly fileFetcher;
+    constructor(store: Store, fileFetcher: FileFetcher);
+    /**
+     * Uploads a picture 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 picture to
+     * @param pictureFile - The picture file to upload
+     * @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/PictureGateway.spec.d.ts

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

package/types/picture/createPictureLinkOperation.d.ts

@@ -0,0 +1,12 @@
+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;

package/types/picture/createPictureLinkOperation.spec.d.ts

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

package/types/picture/index.d.ts

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

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

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

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

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

package/types/thing/Thing.d.ts

@@ -75,4 +75,11 @@ export declare class Thing {
      * @param SpecificThing - a subclass of Thing to assume
      */
     assume<T>(SpecificThing: new (uri: string, store: IndexedFormula, editable: boolean) => T): T;
+    /**
+     * Returns the container that contains this thing's document
+     * The container URI is derived from the thing's URI.
+     */
+    container(): {
+        uri: string;
+    };
 }