@noeldemartin/solid-utils 0.1.1-next.f279ff39536b39493ea8febae8d8052a9a3b1365 → 0.2.0-next.1b9830994a89d900e969b890901e13f7f04df993

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;
@@ -5,7 +8,24 @@ export type JsonLD = Partial<{
 }> & { [k: string]: unknown };
 
 export type JsonLDResource = Omit<JsonLD, '@id'> & { '@id': string };
-export type JsonLDGraph = { '@graph': JsonLDResource[] };
+export type JsonLDGraph = {
+    '@context'?: Record<string, unknown>;
+    '@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,5 +1,6 @@
 import { objectWithoutEmpty, requireUrlParentDirectory, urlResolve } from '@noeldemartin/utils';
 
+import UnsupportedAuthorizationProtocolError from '@/errors/UnsupportedAuthorizationProtocolError';
 import { fetchSolidDocumentIfFound } from '@/helpers/io';
 import type SolidDocument from '@/models/SolidDocument';
 import type { Fetch } from '@/helpers/io';
@@ -25,8 +26,17 @@ async function fetchEffectiveACL(
 ): Promise<SolidDocument> {
     aclResourceUrl = aclResourceUrl ?? await fetchACLResourceUrl(resourceUrl, fetch);
 
-    return await fetchSolidDocumentIfFound(aclResourceUrl ?? '', fetch)
-        ?? await fetchEffectiveACL(requireUrlParentDirectory(resourceUrl), fetch);
+    const aclDocument = await fetchSolidDocumentIfFound(aclResourceUrl ?? '', fetch);
+
+    if (!aclDocument) {
+        return fetchEffectiveACL(requireUrlParentDirectory(resourceUrl), fetch);
+    }
+
+    if (aclDocument.isACPResource()) {
+        throw new UnsupportedAuthorizationProtocolError(resourceUrl, 'ACP');
+    }
+
+    return aclDocument;
 }
 
 export async function fetchSolidDocumentACL(documentUrl: string, fetch: Fetch): Promise<{

package/src/main.ts

@@ -2,3 +2,4 @@ export * from './errors/index';
 export * from './helpers/index';
 export * from './models/index';
 export * from './plugins/index';
+export * from './testing/index';

package/src/models/SolidDocument.ts

@@ -1,30 +1,38 @@
-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 isACPResource(): boolean {
+        return !!this.headers.get('Link')
+            ?.match(/<http:\/\/www\.w3\.org\/ns\/solid\/acp#AccessControlResource>;[^,]+rel="type"/);
     }
 
     public isPersonalProfile(): boolean {
         return !!this.statement(
             this.url,
-            expandIRI('rdfs:type'),
+            expandIRI('rdf:type'),
             expandIRI('foaf:PersonalProfileDocument'),
         );
     }
@@ -33,41 +41,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 +75,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/testing/ResponseStub.ts

@@ -0,0 +1,46 @@
+export default class ResponseStub implements Response {
+
+    private rawBody: string;
+
+    public readonly body!: ReadableStream<Uint8Array> | null;
+    public readonly bodyUsed!: boolean;
+    public readonly headers: Headers;
+    public readonly ok!: boolean;
+    public readonly redirected!: boolean;
+    public readonly status: number;
+    public readonly statusText!: string;
+    public readonly trailer!: Promise<Headers>;
+    public readonly type!: ResponseType;
+    public readonly url!: string;
+
+    public constructor(rawBody: string = '', headers: Record<string, string> = {}, status: number = 200) {
+        this.rawBody = rawBody;
+        this.headers = new Headers(headers);
+        this.status = status;
+    }
+
+    public async arrayBuffer(): Promise<ArrayBuffer> {
+        throw new Error('ResponseStub.arrayBuffer is not implemented');
+    }
+
+    public async blob(): Promise<Blob> {
+        throw new Error('ResponseStub.blob is not implemented');
+    }
+
+    public async formData(): Promise<FormData> {
+        throw new Error('ResponseStub.formData is not implemented');
+    }
+
+    public async json(): Promise<unknown> {
+        return JSON.parse(this.rawBody);
+    }
+
+    public async text(): Promise<string> {
+        return this.rawBody;
+    }
+
+    public clone(): Response {
+        return { ...this };
+    }
+
+}

package/src/testing/faking.ts

@@ -0,0 +1,36 @@
+import { faker } from '@noeldemartin/faker';
+import { stringToSlug } from '@noeldemartin/utils';
+
+export interface ContainerOptions {
+    baseUrl: string;
+}
+
+export interface DocumentOptions extends ContainerOptions {
+    containerUrl: string;
+    name: string;
+}
+
+export interface ResourceOptions extends DocumentOptions {
+    documentUrl: string;
+    hash: string;
+}
+
+export function fakeContainerUrl(options: Partial<ContainerOptions> = {}): string {
+    const baseUrl = options.baseUrl ?? faker.internet.url();
+
+    return baseUrl.endsWith('/') ? baseUrl : baseUrl + '/';
+}
+
+export function fakeDocumentUrl(options: Partial<DocumentOptions> = {}): string {
+    const containerUrl = options.containerUrl ?? fakeContainerUrl(options);
+    const name = options.name ?? faker.random.word();
+
+    return containerUrl + stringToSlug(name);
+}
+
+export function fakeResourceUrl(options: Partial<ResourceOptions> = {}): string {
+    const documentUrl = options.documentUrl ?? fakeDocumentUrl(options);
+    const hash = options.hash ?? 'it';
+
+    return documentUrl + '#' + hash;
+}

package/src/testing/index.ts

@@ -0,0 +1,3 @@
+export * from './faking';
+export * from './mocking';
+export { default as ResponseStub } from './ResponseStub';

package/src/testing/mocking.ts

@@ -0,0 +1,34 @@
+import { fail } from '@noeldemartin/utils';
+import type { GetClosureArgs, GetClosureResult } from '@noeldemartin/utils';
+
+import type { Fetch } from '@/helpers/io';
+
+import ResponseStub from './ResponseStub';
+
+export interface FetchMockMethods {
+    mockResponse(body?: string, headers?: Record<string, string>, status?: number): void;
+    mockNotFoundResponse(): void;
+}
+
+export type FetchMock = jest.Mock<GetClosureResult<Fetch>, GetClosureArgs<Fetch>> & Fetch & FetchMockMethods;
+
+export function mockFetch(): FetchMock {
+    const responses: ResponseStub[] = [];
+    const methods: FetchMockMethods = {
+        mockResponse(body, headers, status) {
+            responses.push(new ResponseStub(body, headers, status));
+        },
+        mockNotFoundResponse() {
+            responses.push(new ResponseStub('', {}, 404));
+        },
+    };
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    const fetchMock = jest.fn(async (...args: GetClosureArgs<Fetch>) => {
+        return responses.shift() ?? fail<Response>('fetch mock called without response');
+    });
+
+    Object.assign(fetchMock, methods);
+
+    return fetchMock as FetchMock;
+}

package/src/types/n3.d.ts

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