Add Blank Node support to getThing (#2369)

This adds support for Blank Nodes identifiers in getThing, so that one can get all the quads with a given blank node as subject. --------- Co-authored-by: Pete Edwards <[email protected]> Co-authored-by: Chelsea Pinka <[email protected]>
inrupt · Apr 12, 2024 · 5d35c2e · 5d35c2e
1 parent 2f84f89
commit 5d35c2e
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ The following changes are pending, and will be applied on the next major release
 
 ### Patch changes
 
+- `getThing` now supports Blank Node identifiers in addition to IRIs and skolems to refer to a subject.
 - `getThingAll(dataset, { allowacceptBlankNodes: true })` now returns all Blank Nodes
   subjects in the Dataset, in particular including those part of a single chain of
   predicates. For instance, given the following dataset:

diff --git a/src/thing/thing.test.ts b/src/thing/thing.test.ts
@@ -60,7 +60,7 @@ import {
 import type { WithAcl } from "../acl/acl";
 import { mockSolidDatasetFrom } from "../resource/mock";
 import { internal_setAcl } from "../acl/acl.internal";
-import type { LocalNodeIri } from "../rdf.internal";
+import type { BlankNodeId, LocalNodeIri } from "../rdf.internal";
 import { localNodeSkolemPrefix } from "../rdf.internal";
 
 describe("createThing", () => {
@@ -153,6 +153,16 @@ describe("getThing", () => {
       },
     },
   };
+  const mockBlankNodeThingId: BlankNodeId = "_:0";
+  const mockBlankNodeThing: Thing = {
+    type: "Subject",
+    url: mockBlankNodeThingId,
+    predicates: {
+      "https://arbitrary.vocab/predicate": {
+        namedNodes: ["https://arbitrary.vocab/predicate"],
+      },
+    },
+  };
   function getMockDataset(
     things = [mockThing1, mockThing2],
     otherGraphThings = [mockThing1],
@@ -286,6 +296,15 @@ describe("getThing", () => {
 
     expect(thrownError).toBeInstanceOf(ValidThingUrlExpectedError);
   });
+
+  it("accepts blank nodes identifiers", () => {
+    const thing = getThing(
+      getMockDataset([mockBlankNodeThing]),
+      mockBlankNodeThingId,
+    );
+
+    expect(thing).toStrictEqual(mockBlankNodeThing);
+  });
 });
 
 describe("getThingAll", () => {

diff --git a/src/thing/thing.ts b/src/thing/thing.ts
@@ -18,6 +18,8 @@
 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 //
+// There are multiple classes in this file for legacy reasons.
+/* eslint-disable max-classes-per-file */
 import { v4 as uuidv4 } from "uuid";
 import {
   isNamedNode,
@@ -42,7 +44,7 @@ import {
   internal_addDeletionsToChangeLog,
   internal_getReadableValue,
 } from "./thing.internal";
-import type { LocalNodeIri } from "../rdf.internal";
+import type { BlankNodeId, LocalNodeIri } from "../rdf.internal";
 import {
   freeze,
   getLocalNodeIri,
@@ -77,22 +79,22 @@ export function getThing(
 ): ThingLocal | null;
 export function getThing(
   solidDataset: SolidDataset,
-  thingUrl: UrlString | Url | LocalNodeIri,
+  thingUrl: UrlString | Url | LocalNodeIri | BlankNodeId,
   options?: GetThingOptions,
 ): Thing | null;
 /**
  * Extract Quads with a given Subject from a [[SolidDataset]] into a [[Thing]].
  *
  * @param solidDataset The [[SolidDataset]] to extract the [[Thing]] from.
- * @param thingUrl The URL of the desired [[Thing]].
+ * @param thingUrl The identifier of the desired [[Thing]] (URL or Blank Node identifier).
  * @param options Not yet implemented.
  */
 export function getThing(
   solidDataset: SolidDataset,
-  thingUrl: UrlString | Url | LocalNodeIri,
+  thingUrl: UrlString | Url | LocalNodeIri | BlankNodeId,
   options: GetThingOptions = {},
 ): Thing | null {
-  if (!internal_isValidUrl(thingUrl)) {
+  if (!internal_isValidUrl(thingUrl) && !thingUrl.match(/^_:/)) {
     throw new ValidThingUrlExpectedError(thingUrl);
   }