@pod-os/core 0.11.2-fe7524c.0 → 0.12.1-eddb6ac.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pod-os/core",
-  "version": "0.11.2-fe7524c.0",
+  "version": "0.12.1-eddb6ac.0",
   "main": "./dist/index.js",
   "types": "./types/index.d.ts",
   "files": [
@@ -24,8 +24,8 @@
   "author": "Angelo Veltens",
   "license": "MIT",
   "devDependencies": {
-    "@babel/preset-env": "^7.24.0",
-    "@babel/preset-typescript": "^7.23.3",
+    "@babel/preset-env": "^7.24.5",
+    "@babel/preset-typescript": "^7.24.1",
     "@types/jest": "^29.5.12",
     "@types/jest-when": "^3.5.5",
     "@types/sparqljs": "^3.1.10",
@@ -37,17 +37,18 @@
     "jest-when": "^3.6.0",
     "prettier": "^3.2.5",
     "rdf-namespaces": "^1.12.0",
-    "rimraf": "^5.0.5",
+    "rimraf": "^5.0.7",
     "sparqljs": "^3.7.1",
-    "typescript": "^5.3.3"
+    "typescript": "^5.4.5"
   },
   "dependencies": {
     "@inrupt/solid-client-authn-browser": "^1.17.5",
-    "@solid-data-modules/contacts-rdflib": "^0.4.0",
+    "@solid-data-modules/contacts-rdflib": "^0.5.0",
     "@types/lunr": "^2.3.7",
     "buffer": "^6.0.3",
     "lunr": "^2.3.9",
-    "rdflib": "^2.2.33",
+    "rdflib": "^2.2.35",
+    "rxjs": "^7.8.1",
     "slugify": "^1.6.6",
     "url": "^0.11.3"
   },

package/types/authentication/index.d.ts

@@ -1,15 +1,23 @@
 import { ISessionInfo } from "@inrupt/solid-client-authn-browser";
+import { BehaviorSubject } from "rxjs";
 export type AuthenticatedFetch = (url: RequestInfo, init?: RequestInit | undefined) => Promise<Response>;
+export type SessionInfo = ISessionInfo;
 export interface PodOsSession {
     authenticatedFetch: AuthenticatedFetch;
 }
 export declare class BrowserSession implements PodOsSession {
     private readonly session;
     private readonly _authenticatedFetch;
+    private readonly sessionInfo$;
     get authenticatedFetch(): (url: RequestInfo, init?: RequestInit | undefined) => Promise<Response>;
     constructor();
-    handleIncomingRedirect(): Promise<ISessionInfo | undefined>;
+    handleIncomingRedirect(restorePreviousSession?: boolean): Promise<ISessionInfo | undefined>;
     login(oidcIssuer: string): Promise<void>;
     logout(): Promise<void>;
-    trackSession(callback: (session: ISessionInfo) => unknown): void;
+    /**
+     * @deprecated use observeSession instead
+     */
+    trackSession(callback: (session: SessionInfo) => unknown): void;
+    observeSession(): BehaviorSubject<SessionInfo>;
+    onSessionRestore(callback: (url: string) => void): void;
 }

package/types/authentication/observeSession.d.ts

@@ -0,0 +1,4 @@
+import { Session } from "@inrupt/solid-client-authn-browser";
+import { BehaviorSubject } from "rxjs";
+import { SessionInfo } from "./index";
+export declare function observeSession(session: Session): BehaviorSubject<SessionInfo>;

package/types/authentication/observeSession.spec.d.ts

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

package/types/index.d.ts

@@ -1,8 +1,9 @@
-import { ISessionInfo } from "@inrupt/solid-client-authn-browser";
 import { ContactsModule } from "@solid-data-modules/contacts-rdflib";
+import { BehaviorSubject } from "rxjs";
+import { SessionInfo } from "./authentication";
 import { SolidFile } from "./files";
 import { WebIdProfile } from "./profile";
-import { SearchIndex } from "./search/SearchIndex";
+import { SearchIndex } from "./search";
 import { Store } from "./Store";
 import { Term } from "./terms";
 import { Thing } from "./thing";
@@ -20,7 +21,8 @@ export declare class PodOS {
     readonly uriService: UriService;
     private fileFetcher;
     constructor();
-    handleIncomingRedirect(): void;
+    private flagAuthorizationMetaDataOnSessionChange;
+    handleIncomingRedirect(restorePreviousSession?: boolean): void;
     fetch(uri: string): Promise<Response>;
     fetchAll(uris: string[]): Promise<PromiseSettledResult<Response>[]>;
     fetchFile(url: string): Promise<SolidFile>;
@@ -28,7 +30,20 @@ export declare class PodOS {
     listKnownTerms(): Term[];
     addNewThing(uri: string, name: string, type: string): Promise<void>;
     proposeUriForNewThing(referenceUri: string, name: string): string;
-    trackSession(callback: (session: ISessionInfo) => unknown): void;
+    /**
+     * @deprecated use observeSession instead
+     * @param callback
+     */
+    trackSession(callback: (session: SessionInfo) => unknown): void;
+    /**
+     * returns a behavior subject that can be used to observe changes in the session state
+     */
+    observeSession(): BehaviorSubject<SessionInfo>;
+    /**
+     * Calls the provided callback with the original URL that was open before the silent auth redirect
+     * @param callback
+     */
+    onSessionRestore(callback: (url: string) => unknown): void;
     /**
      * Fetch the WebId profile and preferences file for the given WebID
      * @param webId

package/dist/dist-D3HKZNEN.js

@@ -1,384 +0,0 @@
-import {
-  Namespace,
-  isNamedNode,
-  lit,
-  namedNode,
-  st,
-  v4_default
-} from "./chunk-NJZBRQIY.js";
-import "./chunk-5NEDDTD5.js";
-
-// ../node_modules/@solid-data-modules/contacts-rdflib/dist/rdflib/namespaces.js
-var rdf = Namespace("http://www.w3.org/1999/02/22-rdf-syntax-ns#");
-var vcard = Namespace("http://www.w3.org/2006/vcard/ns#");
-var dc = Namespace("http://purl.org/dc/elements/1.1/");
-
-// ../node_modules/@solid-data-modules/contacts-rdflib/dist/rdflib/queries/AddressBookQuery.js
-var AddressBookQuery = class {
-  constructor(store, addressBookNode) {
-    this.store = store;
-    this.addressBookNode = addressBookNode;
-    this.addressBookDoc = addressBookNode.doc();
-  }
-  proposeNewContactNode() {
-    return this.proposeNewNode("Person");
-  }
-  proposeNewGroupNode() {
-    return this.proposeNewNode("Group");
-  }
-  proposeNewNode(containerPath) {
-    const id = v4_default();
-    const baseUri = this.addressBookNode.dir()?.uri;
-    return namedNode(`${baseUri}${containerPath}/${id}/index.ttl#this`);
-  }
-  queryTitle() {
-    return this.store.anyValue(this.addressBookNode, dc("title"), void 0, this.addressBookDoc) ?? "";
-  }
-  queryNameEmailIndex() {
-    const index = this.store.any(this.addressBookNode, vcard("nameEmailIndex"), void 0, this.addressBookDoc);
-    if (isNamedNode(index)) {
-      return index;
-    } else {
-      return null;
-    }
-  }
-  queryContacts() {
-    const nameEmailIndex = this.queryNameEmailIndex();
-    return nameEmailIndex && isNamedNode(nameEmailIndex) ? this.store.each(null, vcard("inAddressBook"), this.addressBookNode, nameEmailIndex).filter((it) => isNamedNode(it)).map((node) => ({
-      name: this.store.anyValue(node, vcard("fn"), null, nameEmailIndex) ?? "",
-      uri: node.value
-    })) : [];
-  }
-  queryGroupIndex() {
-    const index = this.store.any(this.addressBookNode, vcard("groupIndex"), void 0, this.addressBookDoc);
-    if (isNamedNode(index)) {
-      return index;
-    } else {
-      return null;
-    }
-  }
-  queryGroups() {
-    const groupIndex = this.queryGroupIndex();
-    return groupIndex && isNamedNode(groupIndex) ? this.store.each(this.addressBookNode, vcard("includesGroup"), null, groupIndex).filter((it) => isNamedNode(it)).map((node) => ({
-      name: this.store.anyValue(node, vcard("fn"), null, groupIndex) ?? "",
-      uri: node.value
-    })) : [];
-  }
-};
-
-// ../node_modules/@solid-data-modules/contacts-rdflib/dist/rdflib/queries/ContactQuery.js
-var MAILTO_URI_SCHEME = "mailto:";
-var TEl_URI_SCHEME = "tel:";
-var ContactQuery = class {
-  constructor(store, contactNode) {
-    this.store = store;
-    this.contactNode = contactNode;
-    this.contactDoc = contactNode.doc();
-  }
-  queryName() {
-    return this.store.anyValue(this.contactNode, vcard("fn"), void 0, this.contactDoc) ?? "";
-  }
-  queryEmails() {
-    const uris = this.getValuesOf(vcard("hasEmail"));
-    if (uris.length === 0) {
-      return [];
-    }
-    return uris.map((uri) => {
-      const valueNode = this.getValueNode(uri);
-      if (isMailtoNode(valueNode)) {
-        return {
-          uri,
-          value: valueNode.value.split(MAILTO_URI_SCHEME)[1]
-        };
-      }
-    }).filter((value) => !!value);
-  }
-  queryPhoneNumbers() {
-    const uris = this.getValuesOf(vcard("hasTelephone"));
-    if (uris.length === 0) {
-      return [];
-    }
-    return uris.map((uri) => {
-      const valueNode = this.getValueNode(uri);
-      if (isTelNode(valueNode)) {
-        return {
-          uri,
-          value: valueNode.value.split(TEl_URI_SCHEME)[1]
-        };
-      }
-    }).filter((value) => !!value);
-  }
-  getValuesOf(predicate) {
-    return this.store.statementsMatching(this.contactNode, predicate, void 0, this.contactDoc).map((it) => it.object.value);
-  }
-  getValueNode(uri) {
-    return this.store.any(namedNode(uri), vcard("value"), void 0, this.contactDoc);
-  }
-};
-function isMailtoNode(valueNode) {
-  return isNamedNode(valueNode) && valueNode.value.startsWith(MAILTO_URI_SCHEME);
-}
-function isTelNode(valueNode) {
-  return isNamedNode(valueNode) && valueNode.value.startsWith(TEl_URI_SCHEME);
-}
-
-// ../node_modules/@solid-data-modules/contacts-rdflib/dist/rdflib/update-operations/createAddressBook.js
-function createAddressBook(container, name) {
-  const id = v4_default();
-  const uri = `${container}${id}/index.ttl#this`;
-  const nameEmailIndexUri = `${container}${id}/people.ttl`;
-  const groupIndexUri = `${container}${id}/groups.ttl`;
-  const insertions = [
-    st(namedNode(uri), namedNode("http://www.w3.org/1999/02/22-rdf-syntax-ns#type"), vcard("AddressBook"), namedNode(uri).doc()),
-    st(namedNode(uri), dc("title"), lit(name), namedNode(uri).doc()),
-    st(namedNode(uri), vcard("nameEmailIndex"), namedNode(nameEmailIndexUri), namedNode(uri).doc()),
-    st(namedNode(uri), vcard("groupIndex"), namedNode(groupIndexUri), namedNode(uri).doc())
-  ];
-  return {
-    uri,
-    deletions: [],
-    insertions,
-    filesToCreate: [{ uri: nameEmailIndexUri }, { uri: groupIndexUri }]
-  };
-}
-
-// ../node_modules/@solid-data-modules/contacts-rdflib/dist/rdflib/update-operations/createNewContact.js
-function createNewContact(addressBook, newContact) {
-  const contactNode = addressBook.proposeNewContactNode();
-  const nameEmailIndex = addressBook.queryNameEmailIndex();
-  if (!nameEmailIndex) {
-    throw new Error("name-email index is missing or invalid");
-  }
-  const insertions = [
-    st(contactNode, vcard("inAddressBook"), addressBook.addressBookNode, nameEmailIndex),
-    st(contactNode, vcard("fn"), lit(newContact.name), nameEmailIndex),
-    st(contactNode, vcard("fn"), lit(newContact.name), contactNode.doc()),
-    st(contactNode, rdf("type"), vcard("Individual"), contactNode.doc())
-  ];
-  if (newContact.email) {
-    const emailNode = namedNode(contactNode.doc().uri + "#email");
-    insertions.push(st(contactNode, vcard("hasEmail"), emailNode, contactNode.doc()), st(emailNode, vcard("value"), namedNode("mailto:" + newContact.email), contactNode.doc()));
-  }
-  if (newContact.phoneNumber) {
-    const phoneNode = namedNode(contactNode.doc().uri + "#phone");
-    insertions.push(st(contactNode, vcard("hasTelephone"), phoneNode, contactNode.doc()), st(phoneNode, vcard("value"), namedNode("tel:" + newContact.phoneNumber), contactNode.doc()));
-  }
-  return {
-    uri: contactNode.uri,
-    deletions: [],
-    insertions,
-    filesToCreate: []
-  };
-}
-
-// ../node_modules/@solid-data-modules/contacts-rdflib/dist/rdflib/web-operations/executeUpdate.js
-async function executeUpdate(fetcher, updater, operation) {
-  await updater.updateMany(operation.deletions, operation.insertions);
-  operation.filesToCreate.map((file) => {
-    createEmptyTurtleFile(fetcher, file.uri);
-  });
-}
-function createEmptyTurtleFile(fetcher, uri) {
-  return fetcher.webOperation("PUT", uri, {
-    contentType: "text/turtle"
-  });
-}
-
-// ../node_modules/@solid-data-modules/contacts-rdflib/dist/rdflib/web-operations/fetchNode.js
-async function fetchNode(fetcher, node) {
-  if (node) {
-    await fetcher.load(node.value);
-  }
-}
-
-// ../node_modules/@solid-data-modules/contacts-rdflib/dist/rdflib/update-operations/createNewGroup.js
-function createNewGroup(addressBook, groupName) {
-  const groupIndex = addressBook.queryGroupIndex();
-  if (!groupIndex) {
-    throw new Error("group index is missing or invalid");
-  }
-  const groupNode = addressBook.proposeNewGroupNode();
-  const groupDoc = groupNode.doc();
-  return {
-    uri: groupNode.uri,
-    insertions: [
-      st(groupNode, vcard("fn"), lit(groupName), groupIndex),
-      st(groupNode, vcard("fn"), lit(groupName), groupDoc),
-      st(groupNode, rdf("type"), vcard("Group"), groupDoc),
-      st(addressBook.addressBookNode, vcard("includesGroup"), groupNode, groupIndex)
-    ],
-    deletions: [],
-    filesToCreate: []
-  };
-}
-
-// ../node_modules/@solid-data-modules/contacts-rdflib/dist/rdflib/queries/GroupQuery.js
-var GroupQuery = class {
-  constructor(store, groupNode) {
-    this.store = store;
-    this.groupNode = groupNode;
-    this.groupDoc = groupNode.doc();
-  }
-  queryName() {
-    return this.store.anyValue(this.groupNode, vcard("fn"), void 0, this.groupDoc) ?? "";
-  }
-  queryMembers() {
-    return this.store.each(this.groupNode, vcard("hasMember"), null, this.groupDoc).filter((it) => isNamedNode(it)).map((node) => ({
-      uri: node.value,
-      name: this.store.anyValue(node, vcard("fn"), null, this.groupDoc) ?? ""
-    }));
-  }
-};
-
-// ../node_modules/@solid-data-modules/contacts-rdflib/dist/rdflib/update-operations/addContactToGroup.js
-function addContactToGroup(contactQuery, groupQuery) {
-  const name = contactQuery.queryName();
-  return {
-    uri: "",
-    insertions: [
-      st(groupQuery.groupNode, vcard("hasMember"), contactQuery.contactNode, groupQuery.groupNode.doc()),
-      st(contactQuery.contactNode, vcard("fn"), lit(name), groupQuery.groupNode.doc())
-    ],
-    deletions: [],
-    filesToCreate: []
-  };
-}
-
-// ../node_modules/@solid-data-modules/contacts-rdflib/dist/rdflib/update-operations/removeContactFromGroup.js
-function removeContactFromGroup(contactQuery, groupQuery) {
-  const contactUri = contactQuery.contactNode.uri;
-  const member = groupQuery.queryMembers().find((it) => it.uri === contactUri);
-  if (!member) {
-    throw new Error("member not found in group");
-  }
-  return {
-    uri: "",
-    insertions: [],
-    deletions: [
-      st(groupQuery.groupNode, vcard("hasMember"), contactQuery.contactNode, groupQuery.groupNode.doc()),
-      st(contactQuery.contactNode, vcard("fn"), lit(member.name), groupQuery.groupNode.doc())
-    ],
-    filesToCreate: []
-  };
-}
-
-// ../node_modules/@solid-data-modules/contacts-rdflib/dist/rdflib/ContactsModuleRdfLib.js
-var ContactsModuleRdfLib = class {
-  constructor(config) {
-    this.store = config.store;
-    this.fetcher = config.fetcher;
-    this.updater = config.updater;
-  }
-  async readAddressBook(uri) {
-    const addressBookNode = namedNode(uri);
-    await this.fetchNode(addressBookNode);
-    const query = new AddressBookQuery(this.store, addressBookNode);
-    const title = query.queryTitle();
-    const nameEmailIndex = query.queryNameEmailIndex();
-    const groupIndex = query.queryGroupIndex();
-    await Promise.allSettled([
-      this.fetchNode(nameEmailIndex),
-      this.fetchNode(groupIndex)
-    ]);
-    await this.fetchAll([nameEmailIndex, groupIndex]);
-    const contacts = query.queryContacts();
-    const groups = query.queryGroups();
-    return {
-      uri,
-      title,
-      contacts,
-      groups
-    };
-  }
-  async fetchNode(node) {
-    return fetchNode(this.fetcher, node);
-  }
-  async fetchAll(nodes) {
-    return Promise.all(nodes.map((it) => this.fetchNode(it)));
-  }
-  async createAddressBook({ containerUri, name }) {
-    const operation = createAddressBook(containerUri, name);
-    await executeUpdate(this.fetcher, this.updater, operation);
-    return operation.uri;
-  }
-  async createNewContact({ addressBookUri, contact, groupUris }) {
-    const contactQuery = await this.executeCreateNewContact(addressBookUri, contact);
-    await this.executeAddContactToGroups(groupUris, contactQuery);
-    return contactQuery.contactNode.uri;
-  }
-  async executeAddContactToGroups(groupUris, contactQuery) {
-    const groupNodes = (groupUris ?? []).map((it) => namedNode(it));
-    await this.fetchAll(groupNodes);
-    const groupUpdates = groupNodes.map((groupNode) => {
-      const groupQuery = new GroupQuery(this.store, groupNode);
-      const operation = addContactToGroup(contactQuery, groupQuery);
-      return executeUpdate(this.fetcher, this.updater, operation);
-    });
-    await Promise.allSettled(groupUpdates);
-  }
-  async executeCreateNewContact(addressBookUri, contact) {
-    const addressBookNode = namedNode(addressBookUri);
-    await this.fetchNode(addressBookNode);
-    const operation = createNewContact(new AddressBookQuery(this.store, addressBookNode), contact);
-    await executeUpdate(this.fetcher, this.updater, operation);
-    return new ContactQuery(this.store, namedNode(operation.uri));
-  }
-  async readContact(uri) {
-    const contactNode = namedNode(uri);
-    await this.fetchNode(contactNode);
-    const query = new ContactQuery(this.store, contactNode);
-    const name = query.queryName();
-    const emails = query.queryEmails();
-    const phoneNumbers = query.queryPhoneNumbers();
-    return {
-      uri,
-      name,
-      emails,
-      phoneNumbers
-    };
-  }
-  async createNewGroup({ addressBookUri, groupName }) {
-    const addressBookNode = namedNode(addressBookUri);
-    await this.fetchNode(addressBookNode);
-    const query = new AddressBookQuery(this.store, addressBookNode);
-    const operation = createNewGroup(query, groupName);
-    await executeUpdate(this.fetcher, this.updater, operation);
-    return operation.uri;
-  }
-  async readGroup(uri) {
-    const groupNode = namedNode(uri);
-    await this.fetchNode(groupNode);
-    const query = new GroupQuery(this.store, groupNode);
-    const name = query.queryName();
-    const members = query.queryMembers();
-    return {
-      uri,
-      name,
-      members
-    };
-  }
-  async addContactToGroup({ contactUri, groupUri }) {
-    const contactNode = namedNode(contactUri);
-    const groupNode = namedNode(groupUri);
-    await this.fetchNode(contactNode);
-    const contactQuery = new ContactQuery(this.store, contactNode);
-    const groupQuery = new GroupQuery(this.store, groupNode);
-    const operation = addContactToGroup(contactQuery, groupQuery);
-    await executeUpdate(this.fetcher, this.updater, operation);
-  }
-  async removeContactFromGroup({ contactUri, groupUri }) {
-    const contactNode = namedNode(contactUri);
-    const groupNode = namedNode(groupUri);
-    await this.fetchNode(groupNode);
-    const contactQuery = new ContactQuery(this.store, contactNode);
-    const groupQuery = new GroupQuery(this.store, groupNode);
-    const operation = removeContactFromGroup(contactQuery, groupQuery);
-    await executeUpdate(this.fetcher, this.updater, operation);
-  }
-};
-
-// ../node_modules/@solid-data-modules/contacts-rdflib/dist/index.js
-var dist_default = ContactsModuleRdfLib;
-export {
-  dist_default as default
-};