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

package/src/helpers/interop.ts

@@ -1,59 +1,95 @@
 import { uuid } from '@noeldemartin/utils';
 
 import { createSolidDocument, fetchSolidDocument, solidDocumentExists, updateSolidDocument } from '@/helpers/io';
-import type SolidThing from '@/models/SolidThing';
 import type { Fetch } from '@/helpers/io';
 import type { SolidUserProfile } from '@/helpers/auth';
 
-async function mintPrivateTypeIndexUrl(user: SolidUserProfile, fetch?: Fetch): Promise<string> {
+type TypeIndexType = 'public' | 'private';
+
+async function mintTypeIndexUrl(user: SolidUserProfile, type: TypeIndexType, fetch?: Fetch): Promise<string> {
     fetch = fetch ?? window.fetch.bind(fetch);
 
     const storageUrl = user.storageUrls[0];
-    const typeIndexUrl = `${storageUrl}settings/privateTypeIndex`;
+    const typeIndexUrl = `${storageUrl}settings/${type}TypeIndex`;
 
     return await solidDocumentExists(typeIndexUrl, fetch)
-        ? `${storageUrl}settings/privateTypeIndex-${uuid()}`
+        ? `${storageUrl}settings/${type}TypeIndex-${uuid()}`
         : typeIndexUrl;
 }
 
-export async function createPrivateTypeIndex(user: SolidUserProfile, fetch?: Fetch): Promise<string> {
+async function createTypeIndex(user: SolidUserProfile, type: TypeIndexType, fetch?: Fetch) {
+    if (user.writableProfileUrl === null) {
+        throw new Error('Can\'t create type index without a writable profile document');
+    }
+
     fetch = fetch ?? window.fetch.bind(fetch);
 
-    const typeIndexUrl = await mintPrivateTypeIndexUrl(user, fetch);
-    const typeIndexBody = `
-        <> a
-            <http://www.w3.org/ns/solid/terms#TypeIndex>,
-            <http://www.w3.org/ns/solid/terms#UnlistedDocument> .
-    `;
+    const typeIndexUrl = await mintTypeIndexUrl(user, type, fetch);
+    const typeIndexBody = type === 'public'
+        ? '<> a <http://www.w3.org/ns/solid/terms#TypeIndex> .'
+        : `
+            <> a
+                <http://www.w3.org/ns/solid/terms#TypeIndex>,
+                <http://www.w3.org/ns/solid/terms#UnlistedDocument> .
+        `;
     const profileUpdateBody = `
         INSERT DATA {
-            <${user.webId}> <http://www.w3.org/ns/solid/terms#privateTypeIndex> <${typeIndexUrl}> .
+            <${user.webId}> <http://www.w3.org/ns/solid/terms#${type}TypeIndex> <${typeIndexUrl}> .
         }
     `;
 
     await Promise.all([
         createSolidDocument(typeIndexUrl, typeIndexBody, fetch),
-        updateSolidDocument(user.webId, profileUpdateBody, fetch),
+        updateSolidDocument(user.writableProfileUrl, profileUpdateBody, fetch),
     ]);
 
+    if (type === 'public') {
+        // TODO Implement updating ACLs for the listing itself to public
+    }
+
     return typeIndexUrl;
 }
 
-export async function findContainerRegistration(
+async function findRegistrations(
     typeIndexUrl: string,
-    childrenType: string,
+    type: string | string[],
+    predicate: string,
     fetch?: Fetch,
-): Promise<SolidThing | null> {
+): Promise<string[]> {
     const typeIndex = await fetchSolidDocument(typeIndexUrl, fetch);
-    const containerQuad = typeIndex
-        .statements(undefined, 'rdfs:type', 'solid:TypeRegistration')
-        .find(
-            statement =>
-                typeIndex.contains(statement.subject.value, 'solid:forClass', childrenType) &&
-                typeIndex.contains(statement.subject.value, 'solid:instanceContainer'),
-        );
-
-    return containerQuad
-        ? typeIndex.getThing(containerQuad.subject.value) ?? null
-        : null;
+    const types = Array.isArray(type) ? type : [type];
+
+    return types.map(
+        type => typeIndex
+            .statements(undefined, 'rdf:type', 'solid:TypeRegistration')
+            .filter(statement => typeIndex.contains(statement.subject.value, 'solid:forClass', type))
+            .map(statement => typeIndex.statements(statement.subject.value, predicate))
+            .flat()
+            .map(statement => statement.object.value)
+            .filter(url => !!url),
+    ).flat();
+}
+
+export async function createPublicTypeIndex(user: SolidUserProfile, fetch?: Fetch): Promise<string> {
+    return createTypeIndex(user, 'public', fetch);
+}
+
+export async function createPrivateTypeIndex(user: SolidUserProfile, fetch?: Fetch): Promise<string> {
+    return createTypeIndex(user, 'private', fetch);
+}
+
+export async function findContainerRegistrations(
+    typeIndexUrl: string,
+    type: string | string[],
+    fetch?: Fetch,
+): Promise<string[]> {
+    return findRegistrations(typeIndexUrl, type, 'solid:instanceContainer', fetch);
+}
+
+export async function findInstanceRegistrations(
+    typeIndexUrl: string,
+    type: string | string[],
+    fetch?: Fetch,
+): Promise<string[]> {
+    return findRegistrations(typeIndexUrl, type, 'solid:instance', fetch);
 }

package/src/helpers/io.ts

@@ -1,10 +1,15 @@
 import md5 from 'md5';
+import {
+    TurtleParser,
+    TurtleWriter,
+    createBlankNode,
+    createQuad,
+    jsonLDFromRDF,
+    jsonLDToRDF,
+} from '@noeldemartin/solid-utils-external';
 import { arr, arrayFilter, arrayReplace, objectWithoutEmpty, stringMatchAll, tap } from '@noeldemartin/utils';
-import { BlankNode as N3BlankNode, Quad as N3Quad, Parser as TurtleParser, Writer as TurtleWriter } from 'n3';
-import { fromRDF, toRDF } from 'jsonld';
-import type { JsonLdDocument } from 'jsonld';
 import type { Quad } from 'rdf-js';
-import type { Term as N3Term } from 'n3';
+import type { JsonLdDocument, Term } from '@noeldemartin/solid-utils-external';
 
 import SolidDocument from '@/models/SolidDocument';
 
@@ -84,25 +89,25 @@ function normalizeBlankNodes(quads: Quad[]): Quad[] {
 
         for (const index of quadIndexes) {
             const quad = normalizedQuads[index] as Quad;
-            const terms: Record<string, N3Term> = {
-                subject: quad.subject as N3Term,
-                object: quad.object as N3Term,
+            const terms: Record<string, Term> = {
+                subject: quad.subject as Term,
+                object: quad.object as Term,
             };
 
             for (const [termName, termValue] of Object.entries(terms)) {
                 if (termValue.termType !== 'BlankNode' || termValue.value !== originalId)
                     continue;
 
-                terms[termName] = new N3BlankNode(normalizedId);
+                terms[termName] = createBlankNode(normalizedId) as Term;
             }
 
             arrayReplace(
                 normalizedQuads,
                 quad,
-                new N3Quad(
-                    terms.subject as N3Term,
-                    quad.predicate as N3Term,
-                    terms.object as N3Term,
+                createQuad(
+                    terms.subject as Term,
+                    quad.predicate as Term,
+                    terms.object as Term,
                 ),
             );
         }
@@ -112,10 +117,15 @@ function normalizeBlankNodes(quads: Quad[]): Quad[] {
 }
 
 export interface ParsingOptions {
-    documentUrl: string;
+    baseIRI: string;
     normalizeBlankNodes: boolean;
 }
 
+export interface RDFGraphData {
+    quads: Quad[];
+    containsRelativeIRIs: boolean;
+}
+
 export async function createSolidDocument(url: string, body: string, fetch?: Fetch): Promise<SolidDocument> {
     fetch = fetch ?? window.fetch.bind(window);
 
@@ -132,7 +142,7 @@ export async function createSolidDocument(url: string, body: string, fetch?: Fet
 
 export async function fetchSolidDocument(url: string, fetch?: Fetch): Promise<SolidDocument> {
     const { body: data, headers } = await fetchRawSolidDocument(url, fetch ?? window.fetch);
-    const statements = await turtleToQuads(data, { documentUrl: url });
+    const statements = await turtleToQuads(data, { baseIRI: url });
 
     return new SolidDocument(url, statements, headers);
 }
@@ -150,14 +160,14 @@ export async function fetchSolidDocumentIfFound(url: string, fetch?: Fetch): Pro
     }
 }
 
-export async function jsonldToQuads(jsonld: JsonLD): Promise<Quad[]> {
+export async function jsonldToQuads(jsonld: JsonLD, baseIRI?: string): Promise<Quad[]> {
     if (isJsonLDGraph(jsonld)) {
-        const graphQuads = await Promise.all(jsonld['@graph'].map(jsonldToQuads));
+        const graphQuads = await Promise.all(jsonld['@graph'].map(resource => jsonldToQuads(resource, baseIRI)));
 
         return graphQuads.flat();
     }
 
-    return toRDF(jsonld as JsonLdDocument) as Promise<Quad[]>;
+    return jsonLDToRDF(jsonld as JsonLdDocument, { base: baseIRI }) as Promise<Quad[]>;
 }
 
 export function normalizeSparql(sparql: string): string {
@@ -173,8 +183,54 @@ export function normalizeSparql(sparql: string): string {
         .join(' ;\n');
 }
 
+export function parseTurtle(turtle: string, options: Partial<ParsingOptions> = {}): Promise<RDFGraphData> {
+    const parserOptions = objectWithoutEmpty({ baseIRI: options.baseIRI });
+    const parser = new TurtleParser(parserOptions);
+    const data: RDFGraphData = {
+        quads: [],
+        containsRelativeIRIs: false,
+    };
+
+    return new Promise((resolve, reject) => {
+        const resolveRelativeIRI = parser._resolveRelativeIRI;
+
+        parser._resolveRelativeIRI = (...args) => {
+            data.containsRelativeIRIs = true;
+            parser._resolveRelativeIRI = resolveRelativeIRI;
+
+            return parser._resolveRelativeIRI(...args);
+        };
+
+        parser.parse(turtle, (error, quad) => {
+            if (error) {
+                reject(
+                    new MalformedSolidDocumentError(
+                        options.baseIRI ?? null,
+                        SolidDocumentFormat.Turtle,
+                        error.message,
+                    ),
+                );
+
+                return;
+            }
+
+            if (!quad) {
+                // data.quads = options.normalizeBlankNodes
+                //     ? normalizeBlankNodes(data.quads)
+                //     : data.quads;
+
+                resolve(data);
+
+                return;
+            }
+
+            data.quads.push(quad);
+        });
+    });
+}
+
 export async function quadsToJsonLD(quads: Quad[]): Promise<JsonLDGraph> {
-    const graph = await fromRDF(quads);
+    const graph = await jsonLDFromRDF(quads);
 
     return {
         '@graph': graph as JsonLDResource[],
@@ -235,38 +291,13 @@ export function sparqlToQuadsSync(sparql: string, options: Partial<ParsingOption
 }
 
 export async function turtleToQuads(turtle: string, options: Partial<ParsingOptions> = {}): Promise<Quad[]> {
-    const parserOptions = objectWithoutEmpty({ baseIRI: options.documentUrl });
-    const parser = new TurtleParser(parserOptions);
-    const quads: Quad[] = [];
-
-    return new Promise((resolve, reject) => {
-        parser.parse(turtle, (error, quad) => {
-            if (error) {
-                reject(
-                    new MalformedSolidDocumentError(
-                        options.documentUrl ?? null,
-                        SolidDocumentFormat.Turtle,
-                        error.message,
-                    ),
-                );
-                return;
-            }
-
-            if (!quad) {
-                options.normalizeBlankNodes
-                    ? resolve(normalizeBlankNodes(quads))
-                    : resolve(quads);
+    const { quads } = await parseTurtle(turtle, options);
 
-                return;
-            }
-
-            quads.push(quad);
-        });
-    });
+    return quads;
 }
 
 export function turtleToQuadsSync(turtle: string, options: Partial<ParsingOptions> = {}): Quad[] {
-    const parserOptions = objectWithoutEmpty({ baseIRI: options.documentUrl });
+    const parserOptions = objectWithoutEmpty({ baseIRI: options.baseIRI });
     const parser = new TurtleParser(parserOptions);
 
     try {
@@ -277,7 +308,7 @@ export function turtleToQuadsSync(turtle: string, options: Partial<ParsingOption
             : quads;
     } catch (error) {
         throw new MalformedSolidDocumentError(
-            options.documentUrl ?? null,
+            options.baseIRI ?? null,
             SolidDocumentFormat.Turtle,
             (error as Error).message ?? '',
         );

package/src/helpers/jsonld.ts

@@ -1,3 +1,6 @@
+import { compactJsonLD } from '@noeldemartin/solid-utils-external';
+import type { JsonLdDocument } from '@noeldemartin/solid-utils-external';
+
 export type JsonLD = Partial<{
     '@context': Record<string, unknown>;
     '@id': string;
@@ -7,6 +10,20 @@ export type JsonLD = Partial<{
 export type JsonLDResource = Omit<JsonLD, '@id'> & { '@id': string };
 export type JsonLDGraph = { '@graph': JsonLDResource[] };
 
+export async function compactJsonLDGraph(jsonld: JsonLDGraph): Promise<JsonLDGraph> {
+    const compactedJsonLD = await compactJsonLD(jsonld as JsonLdDocument, {});
+
+    if ('@graph' in compactedJsonLD) {
+        return compactedJsonLD as JsonLDGraph;
+    }
+
+    if ('@id' in compactedJsonLD) {
+        return { '@graph': [compactedJsonLD] } as JsonLDGraph;
+    }
+
+    return { '@graph': [] };
+}
+
 export function isJsonLDGraph(jsonld: JsonLD): jsonld is JsonLDGraph {
     return '@graph' in jsonld;
 }

package/src/helpers/testing.ts

@@ -1,4 +1,4 @@
-import { Error, arrayRemove, pull, stringMatchAll } from '@noeldemartin/utils';
+import { JSError, arrayRemove, pull, stringMatchAll } from '@noeldemartin/utils';
 import type { JsonLD } from '@/helpers/jsonld';
 import type { Quad, Quad_Object } from 'rdf-js';
 
@@ -9,7 +9,7 @@ const builtInPatterns: Record<string, string> = {
     '%uuid%': '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}',
 };
 
-class ExpectedQuadAssertionError extends Error {
+class ExpectedQuadAssertionError extends JSError {
 
     constructor(public readonly expectedQuad: Quad) {
         super(`Couldn't find the following triple: ${quadToTurtle(expectedQuad)}`);

package/src/helpers/vocabs.ts

@@ -10,7 +10,8 @@ const knownPrefixes: RDFContext = {
     foaf: 'http://xmlns.com/foaf/0.1/',
     pim: 'http://www.w3.org/ns/pim/space#',
     purl: 'http://purl.org/dc/terms/',
-    rdfs: 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
+    rdf: 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
+    rdfs: 'http://www.w3.org/2000/01/rdf-schema#',
     schema: 'https://schema.org/',
     solid: 'http://www.w3.org/ns/solid/terms#',
     vcard: 'http://www.w3.org/2006/vcard/ns#',

package/src/helpers/wac.ts

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

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;
+    }
+
+}