@noeldemartin/solid-utils 0.1.1-next.8c064afc67573f7cf20fa4cbeecfad10a949a9ef → 0.1.1-next.9e1ba757a71d124d509b14f4ed0de95a13e0c196

package/src/helpers/wac.ts

@@ -0,0 +1,45 @@
+import { objectWithoutEmpty, requireUrlParentDirectory, urlResolve } from '@noeldemartin/utils';
+
+import { fetchSolidDocumentIfFound } from '@/helpers/io';
+import type SolidDocument from '@/models/SolidDocument';
+import type { Fetch } from '@/helpers/io';
+
+async function fetchACLResourceUrl(resourceUrl: string, fetch: Fetch): Promise<string> {
+    fetch = fetch ?? window.fetch.bind(window);
+
+    const resourceHead = await fetch(resourceUrl, { method: 'HEAD' });
+    const linkHeader = resourceHead.headers.get('Link') ?? '';
+    const url = linkHeader.match(/<([^>]+)>;\s*rel="acl"/)?.[1] ?? null;
+
+    if (!url) {
+        throw new Error(`Could not find ACL Resource for '${resourceUrl}'`);
+    }
+
+    return urlResolve(requireUrlParentDirectory(resourceUrl), url);
+}
+
+async function fetchEffectiveACL(
+    resourceUrl: string,
+    fetch: Fetch,
+    aclResourceUrl?: string | null,
+): Promise<SolidDocument> {
+    aclResourceUrl = aclResourceUrl ?? await fetchACLResourceUrl(resourceUrl, fetch);
+
+    return await fetchSolidDocumentIfFound(aclResourceUrl ?? '', fetch)
+        ?? await fetchEffectiveACL(requireUrlParentDirectory(resourceUrl), fetch);
+}
+
+export async function fetchSolidDocumentACL(documentUrl: string, fetch: Fetch): Promise<{
+    url: string;
+    effectiveUrl: string;
+    document: SolidDocument;
+}> {
+    const url = await fetchACLResourceUrl(documentUrl, fetch);
+    const document = await fetchEffectiveACL(documentUrl, fetch, url);
+
+    return objectWithoutEmpty({
+        url,
+        effectiveUrl: document.url,
+        document,
+    });
+}

package/src/models/SolidDocument.ts

@@ -1,30 +1,33 @@
-import { parseDate } from '@noeldemartin/utils';
+import { arrayFilter, parseDate, stringMatch } from '@noeldemartin/utils';
 import type { Quad } from 'rdf-js';
 
 import { expandIRI } from '@/helpers/vocabs';
 
-import SolidThing from './SolidThing';
+import SolidStore from './SolidStore';
 
-export default class SolidDocument {
+export enum SolidDocumentPermission {
+    Read = 'read',
+    Write = 'write',
+    Append = 'append',
+    Control = 'control',
+}
+
+export default class SolidDocument extends SolidStore {
 
     public readonly url: string;
     public readonly headers: Headers;
-    private quads: Quad[];
 
     public constructor(url: string, quads: Quad[], headers: Headers) {
+        super(quads);
+
         this.url = url;
-        this.quads = quads;
         this.headers = headers;
     }
 
-    public isEmpty(): boolean {
-        return this.statements.length === 0;
-    }
-
     public isPersonalProfile(): boolean {
         return !!this.statement(
             this.url,
-            expandIRI('rdfs:type'),
+            expandIRI('rdf:type'),
             expandIRI('foaf:PersonalProfileDocument'),
         );
     }
@@ -33,41 +36,27 @@ export default class SolidDocument {
         return !!this.headers.get('Link')?.match(/<http:\/\/www\.w3\.org\/ns\/pim\/space#Storage>;[^,]+rel="type"/);
     }
 
-    public getLastModified(): Date | null {
-        return parseDate(this.headers.get('last-modified'))
-            ?? parseDate(this.statement(this.url, 'purl:modified')?.object.value)
-            ?? this.getLatestDocumentDate()
-            ?? null;
+    public isUserWritable(): boolean {
+        return this.getUserPermissions().includes(SolidDocumentPermission.Write);
     }
 
-    public statements(subject?: string, predicate?: string, object?: string): Quad[] {
-        return this.quads.filter(
-            statement =>
-                (!object || statement.object.value === expandIRI(object, { defaultPrefix: this.url })) &&
-                (!subject || statement.subject.value === expandIRI(subject, { defaultPrefix: this.url })) &&
-                (!predicate || statement.predicate.value === expandIRI(predicate, { defaultPrefix: this.url })),
-        );
+    public getUserPermissions(): SolidDocumentPermission[] {
+        return this.getPermissionsFromWAC('user');
     }
 
-    public statement(subject?: string, predicate?: string, object?: string): Quad | null {
-        const statement = this.quads.find(
-            statement =>
-                (!object || statement.object.value === expandIRI(object, { defaultPrefix: this.url })) &&
-                (!subject || statement.subject.value === expandIRI(subject, { defaultPrefix: this.url })) &&
-                (!predicate || statement.predicate.value === expandIRI(predicate, { defaultPrefix: this.url })),
-        );
-
-        return statement ?? null;
+    public getPublicPermissions(): SolidDocumentPermission[] {
+        return this.getPermissionsFromWAC('public');
     }
 
-    public contains(subject: string, predicate?: string, object?: string): boolean {
-        return this.statement(subject, predicate, object) !== null;
+    public getLastModified(): Date | null {
+        return parseDate(this.headers.get('last-modified'))
+            ?? parseDate(this.statement(this.url, 'purl:modified')?.object.value)
+            ?? this.getLatestDocumentDate()
+            ?? null;
     }
 
-    public getThing(subject: string): SolidThing {
-        const statements = this.statements(subject);
-
-        return new SolidThing(subject, statements);
+    protected expandIRI(iri: string): string {
+        return expandIRI(iri, { defaultPrefix: this.url });
     }
 
     private getLatestDocumentDate(): Date | null {
@@ -81,4 +70,16 @@ export default class SolidDocument {
         return dates.length > 0 ? dates.reduce((a, b) => a > b ? a : b) : null;
     }
 
+    private getPermissionsFromWAC(type: string): SolidDocumentPermission[] {
+        const wacAllow = this.headers.get('WAC-Allow') ?? '';
+        const publicModes = stringMatch<2>(wacAllow, new RegExp(`${type}="([^"]+)"`))?.[1] ?? '';
+
+        return arrayFilter([
+            publicModes.includes('read') && SolidDocumentPermission.Read,
+            publicModes.includes('write') && SolidDocumentPermission.Write,
+            publicModes.includes('append') && SolidDocumentPermission.Append,
+            publicModes.includes('control') && SolidDocumentPermission.Control,
+        ]);
+    }
+
 }

package/src/models/SolidStore.ts

@@ -0,0 +1,61 @@
+import type { Quad } from 'rdf-js';
+
+import { expandIRI } from '@/helpers/vocabs';
+
+import SolidThing from './SolidThing';
+
+export default class SolidStore {
+
+    private quads: Quad[];
+
+    public constructor(quads: Quad[] = []) {
+        this.quads = quads;
+    }
+
+    public isEmpty(): boolean {
+        return this.statements.length === 0;
+    }
+
+    public getQuads(): Quad[] {
+        return this.quads.slice(0);
+    }
+
+    public addQuads(quads: Quad[]): void {
+        this.quads.push(...quads);
+    }
+
+    public statements(subject?: string, predicate?: string, object?: string): Quad[] {
+        return this.quads.filter(
+            statement =>
+                (!object || statement.object.value === this.expandIRI(object)) &&
+                (!subject || statement.subject.value === this.expandIRI(subject)) &&
+                (!predicate || statement.predicate.value === this.expandIRI(predicate)),
+        );
+    }
+
+    public statement(subject?: string, predicate?: string, object?: string): Quad | null {
+        const statement = this.quads.find(
+            statement =>
+                (!object || statement.object.value === this.expandIRI(object)) &&
+                (!subject || statement.subject.value === this.expandIRI(subject)) &&
+                (!predicate || statement.predicate.value === this.expandIRI(predicate)),
+        );
+
+        return statement ?? null;
+    }
+
+    public contains(subject: string, predicate?: string, object?: string): boolean {
+        return this.statement(subject, predicate, object) !== null;
+    }
+
+    public getThing(subject: string): SolidThing {
+        const statements = this.statements(subject);
+
+        return new SolidThing(subject, statements);
+    }
+
+    protected expandIRI(iri: string): string {
+        return expandIRI(iri);
+    }
+
+}

package/src/models/index.ts

@@ -1,2 +1,3 @@
-export { default as SolidDocument } from './SolidDocument';
+export { default as SolidDocument, SolidDocumentPermission } from './SolidDocument';
+export { default as SolidStore } from './SolidStore';
 export { default as SolidThing } from './SolidThing';

package/src/plugins/jest/matchers.ts

@@ -16,17 +16,15 @@ function formatResult(result: EqualityResult, options: FormatResultOptions) {
         ? () => [
             result.message,
             utils.matcherHint(options.hint),
+        ].join('\n\n')
+        : () => [
+            result.message,
+            utils.matcherHint(options.hint),
             [
                 `Expected: not ${utils.printExpected(options.expected)}`,
                 `Received: ${utils.printReceived(options.received)}`,
             ].join('\n'),
-        ].join('\n\n')
-        : () => {
-            return [
-                result.message,
-                utils.matcherHint(options.hint),
-            ].join('\n\n');
-        };
+        ].join('\n\n');
 
     return { pass, message };
 }

package/src/types/n3.d.ts

@@ -0,0 +1,9 @@
+import '@types/n3';
+
+declare module 'n3' {
+
+    interface Parser {
+        _resolveRelativeIRI(iri: string): string;
+    }
+
+}