fix: Allow relative URLs (#26)

Author: herzog31

gallery/ImageObject/dataUrl.json

@@ -0,0 +1,11 @@
+{
+  "@context": "https://schema.org/",
+  "@type": "ImageObject",
+  "url": "data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/XBs/fNwfjZ0frl3/zy7////wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAkAABAALAAAAAAQABAAAAVVICSOZGlCQAosJ6mu7fiyZeKqNKToQGDsM8hBADgUXoGAiqhSvp5QAnQKGIgUhwFUYLCVDFCrKUE1lBavAViFIDlTImbKC5Gm2hB0SlBCBMQiB0UjIQA7",
+  "acquireLicensePage": "https://example.com/how-to-use-my-images",
+  "creator": {
+    "@type": "Person",
+    "name": "Brixton Brownstone"
+  },
+  "copyrightNotice": "Clara Kent"
+}

gallery/ImageObject/valid3.json

@@ -0,0 +1,11 @@
+{
+  "@context": "https://schema.org/",
+  "@type": "ImageObject",
+  "url": "/photos/1x1/black-labrador-puppy.jpg",
+  "acquireLicensePage": "https://example.com/how-to-use-my-images",
+  "creator": {
+    "@type": "Person",
+    "name": "Brixton Brownstone"
+  },
+  "copyrightNotice": "Clara Kent"
+}

src/types/ImageObject.js

@@ -20,6 +20,7 @@ export default class ImageObjectValidator extends BaseValidator {
     // Only require these additional fields for root image objects
     if (this.path.length === 1) {
       conditions.push(
+        // Be aware, this rule is not shown as an error in the validator. Instead the entity is completely ignored if not at least one of these fields is present.
         this.or(
           this.required('creator'),
           this.required('creditText'),

src/types/__tests__/ImageObject.test.js

@@ -32,13 +32,40 @@ describe('ImageObjectValidator', () => {
     it('should validate a correct image object structure in valid2.json', async () => {
       const data = await loadTestData('ImageObject/valid2.json', 'jsonld');
       const issues = await validator.validate(data);
-      expect(issues).to.have.lengthOf(2);
+      const errors = issues.filter((issue) => issue.severity === 'ERROR');
+      expect(errors).to.have.lengthOf(0);
     });
 
     it('should ignore additional fields on nested image objects', async () => {
       const data = await loadTestData('ImageObject/nested.json', 'jsonld');
       const issues = await validator.validate(data);
       expect(issues).to.have.lengthOf(0);
     });
+
+    it('should allow relative URLs', async () => {
+      const data = await loadTestData('ImageObject/valid3.json', 'jsonld');
+      const issues = await validator.validate(data);
+      const errors = issues.filter((issue) => issue.severity === 'ERROR');
+      expect(errors).to.have.lengthOf(0);
+    });
+
+    it('should not allow data: URLs', async () => {
+      const data = await loadTestData('ImageObject/dataUrl.json', 'jsonld');
+      const issues = await validator.validate(data);
+      const errors = issues.filter((issue) => issue.severity === 'ERROR');
+      expect(errors).to.have.lengthOf(1);
+      expect(errors[0]).to.deep.include({
+        rootType: 'ImageObject',
+        issueMessage:
+          'One of the following conditions needs to be met: Required attribute "contentUrl" is missing or Invalid type for attribute "url"',
+        severity: 'ERROR',
+        path: [
+          {
+            type: 'ImageObject',
+            index: 0,
+          },
+        ],
+      });
+    });
   });
 });

src/types/base.js

@@ -140,8 +140,12 @@ export default class BaseValidator {
       const date = new Date(data);
       return !isNaN(date.getTime());
     } else if (type === 'url') {
+      // Absolute or relative URL, but no data: URLs
+      if (data.startsWith('data:')) {
+        return false;
+      }
       try {
-        new URL(data);
+        new URL(data, 'https://example.com');
       } catch (e) {
         return false;
       }