solid-logic 1.3.16 → 1.3.17-1aa535b3

package/src/discovery/discoveryLogic.ts

@@ -1,90 +1,267 @@
-import { NamedNode, Namespace, LiveStore } from "rdflib";
+import { NamedNode, LiveStore, sym, st } from 'rdflib'
+import * as $rdf from 'rdflib'
+import { newThing } from "../util/utils"
+import solidNamespace from 'solid-namespace'
+import { authn } from '../logic/solidLogicSingleton'
 
-type TypeIndex = {  label: string, index: NamedNode, agent: NamedNode } ;
+const ns = solidNamespace($rdf)
 
-const ns ={
-  solid: Namespace('http://www.w3.org/ns/solid/terms#'),
-  space: Namespace('http://www.w3.org/ns/pim/space#')
+type TypeIndexScope = { label: string, index: NamedNode, agent: NamedNode }
+type ScopedApp = { instance: NamedNode, scope: TypeIndexScope }
+
+/**
+ * Create a resource if it really does not exist
+ * Be absolutely sure something does not exist before creating a new empty file
+ * as otherwise existing could  be deleted.
+ * @param doc {NamedNode} - The resource
+ */
+export async function loadOrCreateIfNotExists (store: LiveStore, doc: NamedNode) {
+    let response
+    try {
+      response = await store.fetcher.load(doc)
+    } catch (err) {
+        if (err.response.status === 404) {
+          try {
+            store.fetcher.webOperation('PUT', doc, {data: '', contentType: 'text/turtle'})
+          } catch (err) {
+            const msg = 'createIfNotExists: PUT FAILED: ' + doc + ': ' + err
+            throw new Error(msg)
+          }
+          delete store.fetcher.requested[doc.uri] // delete cached 404 error
+        } else {
+          const msg =  'createIfNotExists doc load error NOT 404:  ' + doc + ': ' + err
+          throw new Error(msg) // @@ add nested errors
+        }
+    }
+    return response
+}
+
+export function suggestPreferencesFile (me:NamedNode) {
+  const stripped = me.uri.replace('/profile/', '/').replace('/public/', '/')
+  // const stripped = me.uri.replace(\/[p|P]rofile/\g, '/').replace(\/[p|P]ublic/\g, '/')
+  const folderURI = stripped.split('/').slice(0,-1).join('/') + '/Settings/'
+  const fileURI = folderURI + 'Preferences.ttl'
+  return sym(fileURI)
+}
+
+export function suggestPublicTypeIndex (me:NamedNode) {
+  return sym(me.doc().dir()?.uri + 'publicTypeIndex.ttl')
+}
+// Note this one is based off the pref file not the profile
+
+export function suggestPrivateTypeIndex (preferencesFile:NamedNode) {
+  return sym(preferencesFile.doc().dir()?.uri + 'privateTypeIndex.ttl')
+}
+
+/* Follow link from this doc to another thing, or else make a new link
+**
+** return: null no ld one and failed to make a new one
+*/
+export async function followOrCreateLink (store: LiveStore, subject: NamedNode, predicate: NamedNode,
+     object: NamedNode, doc:NamedNode):Promise<NamedNode | null> {
+  await store.fetcher.load(doc)
+  const result = store.any(subject, predicate, null, doc)
+
+  if (result) return result as NamedNode
+  if (!store.updater.editable(doc)) {
+    return null
+  }
+  try {
+    await store.updater.update([], [ st(subject, predicate, object, doc)])
+  } catch (err) {
+    console.warn(`followOrCreateLink: Error making link in ${doc} to ${object}: ${err}`)
+    return null
+  }
+
+  try {
+    await loadOrCreateIfNotExists(store, object)
+    // store.fetcher.webOperation('PUT', object, { data: '', contentType: 'text/turtle'})
+  } catch (err) {
+    console.warn(`followOrCreateLink: Error loading or saving new linked document: ${object}: ${err}`)
+  }
+  return object
 }
 
-export async function loadProfile(store: LiveStore, user) {
+export async function loadProfile (store: LiveStore, user: NamedNode) {
   if (!user) {
     throw new Error(`loadProfile: no user given.`)
   }
   try {
     await store.fetcher.load(user.doc())
   } catch (err) {
-    throw new Error(`Unable to load profile of user <${user}>: ${err}`)
+    throw new Error(`Unable to load profile of user ${user}: ${err}`)
   }
   return user.doc()
 }
 
-export async function loadPreferences(store: LiveStore, user): Promise <NamedNode | undefined > {
-  const profile = await loadProfile(store as LiveStore, user)
-  const preferencesFile = store.any(user, ns.space('preferencesFile'), undefined, profile)
+export async function loadPreferences (store: LiveStore, user: NamedNode): Promise <NamedNode | undefined > {
+  await loadProfile(store as LiveStore, user)
+
+  const possiblePreferencesFile = suggestPreferencesFile(user)
+
+  const preferencesFile = await followOrCreateLink(store, user,  ns.space('preferencesFile') as NamedNode, possiblePreferencesFile, user.doc())
+
   if (!preferencesFile) {
-    // throw new Error(`USer ${user} has no pointer in profile to preferences file.`)
+    const message = `User ${user} has no pointer in profile to preferences file.`
+    console.warn(message)
     return undefined
   }
   try {
-    store.fetcher.load(preferencesFile as NamedNode)
-  } catch (err) { // Mabeb a permission propblem or origin problem
+    await store.fetcher.load(preferencesFile as NamedNode)
+  } catch (err) { // Maybe a permission propblem or origin problem
     return undefined
-    // throw new Error(`Unable to load preferences file ${preferencesFile} of user <${user}>: ${err}`)
   }
   return preferencesFile as NamedNode
 }
 
-export async function loadTypeIndexesFor(store: LiveStore, user:NamedNode): Promise<Array<TypeIndex>> {
+export async function loadTypeIndexesFor (store: LiveStore, user:NamedNode): Promise<Array<TypeIndexScope>> {
   if (!user) throw new Error(`loadTypeIndexesFor: No user given`)
   const profile = await loadProfile(store, user)
-  const publicTypeIndex = store.any(user, ns.solid('publicTypeIndex'), undefined, profile)
-  if (publicTypeIndex) {
-    try {
-      await store.fetcher.load(publicTypeIndex as NamedNode)
-    } catch {
-      // never mind
-    }
+
+  const suggestion = suggestPublicTypeIndex(user)
+
+  const publicTypeIndex = await followOrCreateLink(store, user, ns.solid('publicTypeIndex') as NamedNode, suggestion, profile)
+
+  const  publicScopes = publicTypeIndex ? [ { label: 'public', index: publicTypeIndex as NamedNode, agent: user } ] : []
+
+  let preferencesFile
+  try {
+    preferencesFile = await loadPreferences(store, user)
+  } catch (err) {
+    preferencesFile = null
   }
-  const  pub = publicTypeIndex ? [ { label: 'public', index: publicTypeIndex as NamedNode, agent: user } ] : []
 
-  const preferencesFile = await loadPreferences(store, user)
-  if (preferencesFile) { // watch out - can be in either as spec was not clear
-    const privateTypeIndexes = store.each(user, ns.solid('privateTypeIndex'), undefined, preferencesFile as NamedNode)
-      .concat(store.each(user, ns.solid('privateTypeIndex'), undefined, profile))
-    const priv = privateTypeIndexes.length > 0 ? [ { label: 'priSo @@@@@vate', index: privateTypeIndexes[0] as NamedNode, agent: user } ] : []
-    return pub.concat(priv)
+  let privateScopes
+  if (preferencesFile) { // watch out - can be in either as spec was not clear.  Legacy is profile.
+    // If there is a legacy one linked from the profile, use that.
+    // Otherwiae use or make one linked from Preferences
+    const suggestedPrivateTypeIndex = suggestPrivateTypeIndex(preferencesFile)
+
+    const privateTypeIndex = store.any(user, ns.solid('privateTypeIndex'), undefined, profile) ||
+
+    await followOrCreateLink(store, user, ns.solid('privateTypeIndex') as NamedNode, suggestedPrivateTypeIndex, preferencesFile);
+
+    privateScopes = privateTypeIndex ? [ { label: 'private', index: privateTypeIndex as NamedNode, agent: user } ] : []
+  } else {
+    privateScopes = []
+  }
+  const scopes =  publicScopes.concat(privateScopes)
+  if (scopes.length === 0) return scopes
+  const files = scopes.map(scope => scope.index)
+  try {
+    await store.fetcher.load(files)
+  } catch (err) {
+    console.warn('Problems loading type index: ', err)
   }
-  return pub
+  return scopes
 }
 
-export async function loadCommunityTypeIndexes (store:LiveStore, user:NamedNode): Promise<TypeIndex[][]> {
+export async function loadCommunityTypeIndexes (store:LiveStore, user:NamedNode): Promise<TypeIndexScope[][]> {
   const preferencesFile = await loadPreferences(store, user)
-  if (preferencesFile) {
-    const communities = store.each(user, ns.solid('community'), undefined, preferencesFile as NamedNode)
-    const communityTypeIndexesPromise = communities.map(async community => await loadTypeIndexesFor(store, community as NamedNode))
-    const result1 = Promise.all(communityTypeIndexesPromise)
-    // const result2 = Promise.all(result1)
-    // const flat = result2.flat()
-    return result1
-    // const communityTypeIndexes = await Promise.all(communityTypeIndexesPromise)
-      /*
-    let result = [] as TypeIndex[]
-    for(const community of communities) {
-      result = result.concat(await loadTypeIndexesFor(store, community as NamedNode)) as TypeIndex[] // @@ how oto make functional with async?
+  if (preferencesFile) { // For now, pick up communities as simple links from the preferences file.
+    const communities = store.each(user, ns.solid('community'), undefined, preferencesFile as NamedNode).concat(
+       store.each(user, ns.solid('community'), undefined, user.doc() as NamedNode)
+    )
+    let result = []
+    for (const org of communities) {
+      result = result.concat(await loadTypeIndexesFor(store, org as NamedNode) as any)
     }
-    */
-    // return communityTypeIndexesPromise.resolve()
+    return result
   }
-  return []
+  return [] // No communities
 }
 
 export async function loadAllTypeIndexes (store:LiveStore, user:NamedNode) {
   return (await loadTypeIndexesFor(store, user)).concat((await loadCommunityTypeIndexes(store, user)).flat())
 }
 
+// Utility: remove duplicates from Array of NamedNodes
+export function uniqueNodes (arr: NamedNode[]): NamedNode[] {
+  const uris = arr.map(x => x.uri)
+  const set = new Set(uris)
+  const uris2 = Array.from(set)
+  const arr2 = uris2.map(u => new NamedNode(u))
+  return arr2 // Array.from(new Set(arr.map(x => x.uri))).map(u => sym(u))
+}
+
+export async function getScopedAppsFromIndex (store, scope, theClass: NamedNode | null) {
+  const index = scope.index
+  const registrations = store.statementsMatching(null, ns.solid('instance'), null, index)
+    .concat(store.statementsMatching(null, ns.solid('instanceContainer'), null, index))
+    .map(st => st.subject)
+  const relevant = theClass ? registrations.filter(reg => store.any(reg, ns.solid('forClass'), null, index).sameTerm(theClass))
+                            : registrations
+  const directInstances = relevant.map(reg => store.each(reg as NamedNode, ns.solid('instance'), null, index)).flat()
+  let instances = uniqueNodes(directInstances)
+
+ const instanceContainers = relevant.map(
+     reg => store.each(reg as NamedNode, ns.solid('instanceContainer'), null, index)).flat()
+
+  //  instanceContainers may be deprocatable if no one has used them
+  const containers = uniqueNodes(instanceContainers)
+  if (containers.length > 0) { console.log('@@ getScopedAppsFromIndex containers ', containers)}
+  for (let i = 0; i < containers.length; i++) {
+    const cont = containers[i]
+    await store.fetcher.load(cont)
+    const contents = store.each(cont, ns.ldp('contains'), null, cont)
+    instances = instances.concat(contents)
+  }
+  return instances.map(instance => { return {instance, scope}})
+}
+
+export async function getScopedAppInstances (store:LiveStore, klass: NamedNode, user: NamedNode):Promise<ScopedApp[]> {
+  const scopes = await loadAllTypeIndexes(store, user)
+  let scopedApps = []
+  for (const scope of scopes) {
+    const scopedApps0 = await getScopedAppsFromIndex(store, scope, klass) as any
+    scopedApps = scopedApps.concat(scopedApps0)
+  }
+  return scopedApps
+}
+
+// This is the function signature which used to be in solid-ui/logic
+// Recommended to use getScopedAppInstances instead as it provides more information.
+//
+export async function getAppInstances (store:LiveStore, klass: NamedNode): Promise<NamedNode[]> {
+  const user = authn.currentUser()
+  if (!user) throw new Error('getAppInstances: Must be logged in to find apps.')
+  const scopedAppInstances = await getScopedAppInstances(store, klass, user)
+  return scopedAppInstances.map(scoped => scoped.instance)
+}
+
 /*
-export async function getAppInstances (store:LiveStore, klass: NamedNode) {
+ * Register a new app in a type index
+ * used in chat in bookmark.js (solid-ui)
+ * Returns the registration object if successful else null
+ */
+export async function registerInstanceInTypeIndex (
+  store:LiveStore,
+  instance: NamedNode,
+  index: NamedNode,
+  theClass: NamedNode,
+  // agent: NamedNode
+): Promise<NamedNode | null> {
+    const registration = newThing(index)
+    const ins = [
+        // See https://github.com/solid/solid/blob/main/proposals/data-discovery.md
+        st(registration, ns.rdf('type'), ns.solid('TypeRegistration'), index),
+        st(registration, ns.solid('forClass'), theClass, index),
+        st(registration, ns.solid('instance'), instance, index)
+    ]
+    try {
+        await store.updater.update([], ins)
+    } catch (err) {
+        const msg = `Unable to register ${instance} in index ${index}: ${err}`
+        console.warn(msg)
+        return null
+    }
+    return registration
+}
 
+export async function deleteTypeIndexRegistration (store: LiveStore, item) {
+  const reg = store.the(null, ns.solid('instance'), item.instance, item.scope.index) as NamedNode
+  if (!reg) throw new Error(`deleteTypeIndexRegistration: No registration found for ${item.instance}`)
+  const statements = store.statementsMatching(reg, null, null, item.scope.index)
+  await store.updater.update(statements, [])
 }
-*/
+// ENDS

package/src/inbox/inboxLogic.ts

@@ -0,0 +1,57 @@
+import { NamedNode } from "rdflib";
+import { getArchiveUrl } from "../util/utils";
+
+export function createInboxLogic(store, profileLogic, utilityLogic, containerLogic, aclLogic) {
+  
+    async function createInboxFor(peerWebId: string, nick: string) {
+      const myWebId: NamedNode = await profileLogic.loadMe();
+      const podRoot: NamedNode = await profileLogic.getPodRoot(myWebId);
+      const ourInbox = `${podRoot.value}p2p-inboxes/${encodeURIComponent(nick)}/`;
+      await containerLogic.createContainer(ourInbox);
+      const aclDocUrl = await aclLogic.findAclDocUrl(ourInbox);
+      await utilityLogic.setSinglePeerAccess({
+        ownerWebId: myWebId.value,
+        peerWebId,
+        accessToModes: 'acl:Append',
+        target: ourInbox
+      });
+      return ourInbox;
+  }
+
+  async function getNewMessages(
+      user?: NamedNode
+    ): Promise<string[]> {
+      if (!user) {
+        user = await profileLogic.loadMe();
+      }
+      const inbox = await profileLogic.getMainInbox(user);
+      const urls = await containerLogic.getContainerMembers(inbox.value);
+      return urls.filter(url => !containerLogic.isContainer(url));
+  }
+
+  async function markAsRead(url: string, date: Date) {
+    const downloaded = await store.fetcher._fetch(url);
+    if (downloaded.status !== 200) {
+      throw new Error(`Not OK! ${url}`);
+    }
+    const archiveUrl = getArchiveUrl(url, date);
+    const options = {
+      method: 'PUT',
+      body: await downloaded.text(),
+      headers: [
+        ['Content-Type', downloaded.headers.get('Content-Type') || 'application/octet-stream']
+      ]
+    };
+    const uploaded = await store.fetcher._fetch(archiveUrl, options);
+    if (uploaded.status.toString()[0] === '2') {
+      await store.fetcher._fetch(url, {
+        method: 'DELETE'
+      });
+    }
+  }
+  return {
+    createInboxFor,
+    getNewMessages,
+    markAsRead
+  }
+}

package/src/index.ts

@@ -1,39 +1,92 @@
 // Make these variables directly accessible as it is what you need most of the time
 // This also makes these variable globaly accesible in mashlib
-import { solidLogicSingleton } from './logic/solidLogicSingleton'
-const authn = solidLogicSingleton.authn
-const authSession = solidLogicSingleton.authn.authSession
-const store = solidLogicSingleton.store
+//import { solidLogicSingleton } from './logic/solidLogicSingleton'
+//const authn = solidLogicSingleton.authn
+//const authSession = solidLogicSingleton.authn.authSession
+//const store = solidLogicSingleton.store
 
-const chat = solidLogicSingleton.chat
-const profile = solidLogicSingleton.profile
+export {
+  ACL_LINK
+} from './acl/aclLogic'
 
 export {
+  findAclDocUrl,
   setACLUserPublic,
-  genACLText
-} from './acl/aclLogic'
+  genACLText,
+} from './logic/solidLogicSingleton'
 
 export {
   ensureTypeIndexes,
   loadTypeIndexes,
   registerInTypeIndex,
-  loadIndex
-} from './typeIndex/typeIndexLogic'
-
-export {
-  loadProfile,
-  loadPreferences,
+  loadIndex,
+  ensureOneTypeIndex,
+  putIndex,
+  makeIndexIfNecessary,
+  loadIndexes,
+  getTypeIndex,
+  getRegistrations,
+  //NEW function for discovery
   loadTypeIndexesFor,
   loadCommunityTypeIndexes,
-  loadAllTypeIndexes
-} from './discovery/discoveryLogic'
+  loadAllTypeIndexes,
+  getScopedAppInstances,
+  getAppInstances,
+  suggestPublicTypeIndex,
+  suggestPrivateTypeIndex,
+  registerInstanceInTypeIndex,
+  deleteTypeIndexRegistration,
+  getScopedAppsFromIndex
+} from './logic/solidLogicSingleton'
+
+export {
+  setAcl,
+  addToPrivateTypeIndex,
+  findChat,
+  createChatThing,
+  getChat,
+  sendInvite,
+  mintNew
+} from './logic/solidLogicSingleton'
 
-export { SolidLogic } from './logic/SolidLogic'
 export { offlineTestID, appContext } from './authn/authUtil'
-export { ACL_LINK } from './util/UtilityLogic'
+export { createInboxFor, getNewMessages, markAsRead } from './logic/solidLogicSingleton'
+export {
+  recursiveDelete,
+  setSinglePeerAccess,
+  createEmptyRdfDoc,
+  //NEW function for discovery
+  followOrCreateLink,
+  loadOrCreateIfNotExists,
+} from './logic/solidLogicSingleton'
+
+export {
+  ensureLoadedPreferences,
+  loadMe,
+  getPodRoot,
+  getMainInbox,
+  findStorage,
+   //NEW content from discovery
+  loadPreferences,
+  loadProfile,
+  //NEW function for discovery
+  silencedLoadPreferences
+} from './logic/solidLogicSingleton'
+
 export { getSuggestedIssuers } from './issuer/issuerLogic'
+
+export {
+    isContainer,
+    createContainer,
+    getContainerElements,
+    getContainerMembers
+} from './logic/solidLogicSingleton'
+
+export { authn, authSession, store } from './logic/solidLogicSingleton'
+
+//export { SolidLogic } from './logic/SolidLogic'
 export { AppDetails, SolidNamespace, AuthenticationContext } from './types'
 // solidLogicSingleton is exported entirely because it is used in solid-panes
-export { solidLogicSingleton } from './logic/solidLogicSingleton'
-export { UnauthorizedError, CrossOriginForbiddenError, SameOriginForbiddenError, NotFoundError, FetchError } from './logic/CustomError'
-export { authn, authSession, store, chat, profile }
+//export { solidLogicSingleton } from './logic/solidLogicSingleton'
+export { UnauthorizedError, CrossOriginForbiddenError, SameOriginForbiddenError, NotFoundError, FetchError, NotEditableError, WebOperationError } from './logic/CustomError'
+

package/src/logic/CustomError.ts

@@ -6,7 +6,7 @@ class CustomError extends Error {
         this.name = new.target.name; // stack traces display correctly now
     }
 }
-    
+
 export class UnauthorizedError extends CustomError {}
 
 export class CrossOriginForbiddenError extends CustomError {}
@@ -15,6 +15,10 @@ export class SameOriginForbiddenError extends CustomError {}
 
 export class NotFoundError extends CustomError {}
 
+export class NotEditableError extends CustomError { }
+
+export class WebOperationError extends CustomError {}
+
 export class FetchError extends CustomError {
     status: number;