@pod-os/core 0.7.1-497f3ef.0 → 0.7.1-5e652ae.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pod-os/core",
-  "version": "0.7.1-497f3ef.0",
+  "version": "0.7.1-5e652ae.0",
   "main": "./dist/index.js",
   "types": "./types/index.d.ts",
   "files": [
@@ -25,23 +25,27 @@
   "license": "MIT",
   "devDependencies": {
     "@babel/preset-env": "^7.20.2",
-    "@babel/preset-typescript": "^7.18.6",
-    "@types/jest": "^29.2.5",
+    "@babel/preset-typescript": "^7.21.0",
+    "@types/jest": "^29.5.0",
     "@types/jest-when": "^3.5.2",
-    "@typescript-eslint/eslint-plugin": "^5.48.1",
-    "@typescript-eslint/parser": "^5.48.1",
-    "esbuild": "^0.16.16",
-    "eslint": "^8.31.0",
-    "jest": "^29.3.1",
+    "@types/sparqljs": "^3.1.3",
+    "@typescript-eslint/eslint-plugin": "^5.56.0",
+    "@typescript-eslint/parser": "^5.56.0",
+    "esbuild": "^0.16.17",
+    "eslint": "^8.36.0",
+    "jest": "^29.5.0",
     "jest-when": "^3.5.2",
-    "prettier": "^2.8.2",
+    "prettier": "^2.8.6",
+    "rdf-namespaces": "^1.10.1",
     "rimraf": "^3.0.2",
-    "typescript": "^4.9.4"
+    "sparqljs": "^3.6.2",
+    "typescript": "^4.9.5"
   },
   "dependencies": {
-    "@inrupt/solid-client-authn-browser": "^1.12.4",
+    "@inrupt/solid-client-authn-browser": "^1.13.4",
     "buffer": "^6.0.3",
-    "rdflib": "^2.2.21"
+    "rdflib": "^2.2.31",
+    "url": "^0.11.0"
   },
   "directories": {
     "lib": "lib"

package/types/Store.d.ts

@@ -1,10 +1,30 @@
-import { Fetcher, IndexedFormula } from "rdflib";
+import { Fetcher, IndexedFormula, UpdateManager } from "rdflib";
 import { PodOsSession } from "./authentication";
 import { Thing } from "./thing";
+/**
+ * The store contains all data that is known locally.
+ * It can be used to fetch additional data from the web and also update data and sync it back to editable resources.
+ */
 export declare class Store {
     fetcher: Fetcher;
+    updater: UpdateManager;
     graph: IndexedFormula;
     constructor(session: PodOsSession);
+    /**
+     * Fetch data for the given URI to the store
+     * @param uri
+     */
     fetch(uri: string): Promise<Response>;
+    /**
+     * Retrieve the thing identified by the given URI from the store
+     * @param uri
+     */
     get(uri: string): Thing;
+    /**
+     * Adds a new value to the property of the given thing
+     * @param thing
+     * @param property
+     * @param value
+     */
+    addPropertyValue(thing: Thing, property: string, value: string): Promise<void>;
 }

package/types/Store.spec.d.ts

@@ -1 +1,3 @@
-export {};
+/// <reference types="jest" />
+import { AuthenticatedFetch } from "./authentication";
+export declare function thenSparqlUpdateIsSentToUrl(fetchMock: jest.Mock<AuthenticatedFetch>, url: string, query: string): void;

package/types/index.d.ts

@@ -1,6 +1,8 @@
 import { ISessionInfo } from "@inrupt/solid-client-authn-browser";
 import { SolidFile } from "./files";
 import { Store } from "./Store";
+import { Term } from "./terms";
+import { Thing } from "./thing";
 export * from "./authentication";
 export * from "./files";
 export * from "./thing";
@@ -14,6 +16,8 @@ export declare class PodOS {
     handleIncomingRedirect(): void;
     fetch(uri: string): Promise<Response>;
     fetchFile(url: string): Promise<SolidFile>;
+    addPropertyValue(thing: Thing, property: string, value: string): Promise<void>;
+    listKnownTerms(): Term[];
     trackSession(callback: (session: ISessionInfo) => unknown): void;
     logout(): Promise<void>;
     login(oidcIssuer?: string): Promise<void>;

package/types/ldp-container/LdpContainer.assume.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/types/ldp-container/LdpContainer.d.ts

@@ -7,6 +7,7 @@ export interface ContainerContent {
 export declare class LdpContainer extends Thing {
     readonly uri: string;
     readonly store: IndexedFormula;
-    constructor(uri: string, store: IndexedFormula);
+    readonly editable: boolean;
+    constructor(uri: string, store: IndexedFormula, editable?: boolean);
     contains(): ContainerContent[];
 }

package/types/rdf-document/RdfDocument.assume.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/types/rdf-document/RdfDocument.d.ts

@@ -6,7 +6,8 @@ export interface Subject {
 export declare class RdfDocument extends Thing {
     readonly uri: string;
     readonly store: IndexedFormula;
-    constructor(uri: string, store: IndexedFormula);
+    readonly editable: boolean;
+    constructor(uri: string, store: IndexedFormula, editable?: boolean);
     subjects(): {
         uri: string;
     }[];

package/types/terms/Term.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Represents a term from a RDF vocabulary
+ */
+export interface Term {
+    /**
+     * Full URI of the term, e.g. http://xmlns.com/foaf/0.1/name
+     */
+    uri: string;
+    /**
+     * Shorthand syntax of the term, using a well-known prefix, e.g. foaf:name
+     */
+    shorthand: string;
+}

package/types/terms/createListOfTerms.d.ts

@@ -0,0 +1,8 @@
+export declare const createListOfTerms: (terms: {
+    [prefix: string]: {
+        [name: string]: string;
+    };
+}) => {
+    uri: string;
+    shorthand: string;
+}[];

package/types/terms/createListOfTerms.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/types/terms/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Term";
+export * from "./listKnownTerms";

package/types/terms/listKnownTerms.d.ts

@@ -0,0 +1,5 @@
+import { Term } from "./Term";
+/**
+ * Returns a list of terms from commonly used and well-known RDF vocabularies
+ */
+export declare function listKnownTerms(): Term[];

package/types/terms/listKnownTerms.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/types/thing/Thing.d.ts

@@ -14,7 +14,15 @@ export interface RdfType {
 export declare class Thing {
     readonly uri: string;
     readonly store: IndexedFormula;
-    constructor(uri: string, store: IndexedFormula);
+    /**
+     * Whether the Thing can be edited according to its access control settings
+     */
+    readonly editable: boolean;
+    constructor(uri: string, store: IndexedFormula, 
+    /**
+     * Whether the Thing can be edited according to its access control settings
+     */
+    editable?: boolean);
     label(): string;
     literals(): Literal[];
     relations(): Relation[];
@@ -26,5 +34,5 @@ export declare class Thing {
     } | null;
     private findActivityStreamsPicture;
     types(): RdfType[];
-    assume<T>(SpecificThing: new (uri: string, store: IndexedFormula) => T): T;
+    assume<T>(SpecificThing: new (uri: string, store: IndexedFormula, editable: boolean) => T): T;
 }