@pod-os/core 0.24.0-rc.47722fb.0 → 0.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -4966,12 +4966,14 @@ var WebIdProfile = class extends Thing {
4966
4966
  }
4967
4967
  /**
4968
4968
  * Returns the URI of the public type index document
4969
+ * @since 0.24.0
4969
4970
  */
4970
4971
  getPublicTypeIndex() {
4971
4972
  return this.profileQuery.queryPublicTypeIndex()?.value;
4972
4973
  }
4973
4974
  /**
4974
4975
  * Returns the URI of the private type index document
4976
+ * @since 0.24.0
4975
4977
  */
4976
4978
  getPrivateTypeIndex() {
4977
4979
  const preferences = this.profileQuery.queryPreferencesFile();
@@ -5013,6 +5015,12 @@ var ProfileGateway = class {
5013
5015
  constructor(store) {
5014
5016
  this.store = store;
5015
5017
  }
5018
+ /**
5019
+ * Fetches the profile for the given WebID and all linked documents
5020
+ * @since 0.24.0
5021
+ * @param webId The WebID to fetch the profile for
5022
+ * @returns {Promise<WebIdProfile>} The fetched profile
5023
+ */
5016
5024
  async fetchProfile(webId) {
5017
5025
  await this.store.fetch(webId);
5018
5026
  const profile2 = this.store.get(webId).assume(WebIdProfile);
@@ -26955,6 +26963,7 @@ var PodOS = class {
26955
26963
  }
26956
26964
  /**
26957
26965
  * Provides access to attachment operations such as uploading and linking attachments to things
26966
+ * @since 0.24.0
26958
26967
  * @returns {AttachmentGateway} An instance of AttachmentGateway that handles attachment operations
26959
26968
  */
26960
26969
  attachments() {
package/lib/index.js CHANGED
@@ -37952,12 +37952,14 @@ _:patch
37952
37952
  }
37953
37953
  /**
37954
37954
  * Returns the URI of the public type index document
37955
+ * @since 0.24.0
37955
37956
  */
37956
37957
  getPublicTypeIndex() {
37957
37958
  return this.profileQuery.queryPublicTypeIndex()?.value;
37958
37959
  }
37959
37960
  /**
37960
37961
  * Returns the URI of the private type index document
37962
+ * @since 0.24.0
37961
37963
  */
37962
37964
  getPrivateTypeIndex() {
37963
37965
  const preferences = this.profileQuery.queryPreferencesFile();
@@ -37999,6 +38001,12 @@ _:patch
37999
38001
  constructor(store) {
38000
38002
  this.store = store;
38001
38003
  }
38004
+ /**
38005
+ * Fetches the profile for the given WebID and all linked documents
38006
+ * @since 0.24.0
38007
+ * @param webId The WebID to fetch the profile for
38008
+ * @returns {Promise<WebIdProfile>} The fetched profile
38009
+ */
38002
38010
  async fetchProfile(webId) {
38003
38011
  await this.store.fetch(webId);
38004
38012
  const profile2 = this.store.get(webId).assume(WebIdProfile);
@@ -59952,6 +59960,7 @@ _:patch
59952
59960
  }
59953
59961
  /**
59954
59962
  * Provides access to attachment operations such as uploading and linking attachments to things
59963
+ * @since 0.24.0
59955
59964
  * @returns {AttachmentGateway} An instance of AttachmentGateway that handles attachment operations
59956
59965
  */
59957
59966
  attachments() {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@pod-os/core",
3
3
  "description": "Core module of PodOS",
4
- "version": "0.24.0-rc.47722fb.0",
4
+ "version": "0.24.0",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
7
7
  "types": "./types/index.d.ts",
@@ -4,6 +4,8 @@ import { FileGateway, NewFile } from "../files";
4
4
  import { HttpProblem, NetworkProblem } from "../problems";
5
5
  /**
6
6
  * Gateway for attachment-related operations on Solid Pods and the store.
7
+ *
8
+ * @since 0.24.0
7
9
  */
8
10
  export declare class AttachmentGateway {
9
11
  private readonly fileGateway;
@@ -5,6 +5,7 @@ import { FileFetcher, NewFile } from "../files";
5
5
  import { HttpProblem, NetworkProblem } from "../problems";
6
6
  /**
7
7
  * Gateway for file-related operations on Solid Pods and the store.
8
+ * @since 0.24.0
8
9
  */
9
10
  export declare class FileGateway {
10
11
  private readonly store;
@@ -5,6 +5,9 @@ import { NewFile } from "../files";
5
5
  * Creates an update operation to link a file to a thing.
6
6
  * Uses given predicate to establish the relationship.
7
7
  *
8
+ * @since 0.24.0
9
+ * @internal
10
+ *
8
11
  * @param thing - The thing to link the file to
9
12
  * @param predicateUri - The URI of the predicate to use
10
13
  * @param file - The uploaded file metadata
package/types/index.d.ts CHANGED
@@ -107,6 +107,7 @@ export declare class PodOS {
107
107
  }, HttpProblem | NetworkProblem>;
108
108
  /**
109
109
  * Provides access to attachment operations such as uploading and linking attachments to things
110
+ * @since 0.24.0
110
111
  * @returns {AttachmentGateway} An instance of AttachmentGateway that handles attachment operations
111
112
  */
112
113
  attachments(): AttachmentGateway;
@@ -2,9 +2,16 @@ import { WebIdProfile } from "./WebIdProfile";
2
2
  import { Store } from "../Store";
3
3
  /**
4
4
  * Gateway for profile-related operations on Solid Pods and the store.
5
+ * @since 0.24.0
5
6
  */
6
7
  export declare class ProfileGateway {
7
8
  private readonly store;
8
9
  constructor(store: Store);
10
+ /**
11
+ * Fetches the profile for the given WebID and all linked documents
12
+ * @since 0.24.0
13
+ * @param webId The WebID to fetch the profile for
14
+ * @returns {Promise<WebIdProfile>} The fetched profile
15
+ */
9
16
  fetchProfile(webId: string): Promise<WebIdProfile>;
10
17
  }
@@ -15,10 +15,12 @@ export declare class WebIdProfile extends Thing {
15
15
  getPreferencesFile(): string | undefined;
16
16
  /**
17
17
  * Returns the URI of the public type index document
18
+ * @since 0.24.0
18
19
  */
19
20
  getPublicTypeIndex(): string | undefined;
20
21
  /**
21
22
  * Returns the URI of the private type index document
23
+ * @since 0.24.0
22
24
  */
23
25
  getPrivateTypeIndex(): string | undefined;
24
26
  /**
@@ -3,6 +3,7 @@ import { IndexedFormula } from "rdflib";
3
3
  import { TypeRegistration } from "./TypeRegistration";
4
4
  /**
5
5
  * Represents a private or public type index document
6
+ * @since 0.24.0
6
7
  */
7
8
  export declare class TypeIndex extends Thing {
8
9
  readonly uri: string;