solid-logic 1.3.17-a849582e → 1.3.17-af110ecf

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "solid-logic",
-  "version": "1.3.17-a849582e",
+  "version": "1.3.17-af110ecf",
   "description": "Core business logic of Solid OS",
   "main": "lib/index.js",
   "scripts": {

package/src/acl/aclLogic.ts

@@ -1,12 +1,15 @@
 import { graph, NamedNode, Namespace, serialize, sym } from "rdflib"
-import ns from '../util/ns'
+import { AclLogic } from "../types";
+import { ns as namespace } from '../util/ns'
 
 
 export const ACL_LINK = sym(
     "http://www.iana.org/assignments/link-relations/acl"
 );
 
-export function createAclLogic(store) {
+export function createAclLogic(store): AclLogic {
+
+    const ns = namespace
     
     async function findAclDocUrl(url: string) {
         const doc = store.sym(url);
@@ -114,9 +117,9 @@ export function createAclLogic(store) {
     me: NamedNode,
     aclURI: string,
     options: {
-        defaultForNew?: boolean,
-        public?: []
-    } = {}
+            defaultForNew?: boolean,
+            public?: []
+        } = {}
     ): string | undefined {
         const optPublic = options.public || []
         const g = graph()

package/src/chat/chatLogic.ts

@@ -1,13 +1,13 @@
 import { NamedNode, Node, st, term } from "rdflib"
-import { CreatedPaneOptions, NewPaneOptions } from "../types"
+import { ChatLogic, CreatedPaneOptions, NewPaneOptions, Chat } from "../types"
+import { ns as namespace } from "../util/ns";
 import { determineChatContainer, newThing } from "../util/utils"
-import { ns as namespace } from '../util/ns'
 
-const CHAT_LOCATION_IN_CONTAINER = "index.ttl#this";
+const CHAT_LOCATION_IN_CONTAINER = "index.ttl#this"
 
-export function createChatLogic(store, profileLogic) {
+export function createChatLogic(store, profileLogic): ChatLogic {
     const ns = namespace
-    
+
     async function setAcl(
         chatContainer: NamedNode,
         me: NamedNode,
@@ -87,7 +87,7 @@ export function createChatLogic(store, profileLogic) {
         });
     }
 
-    async function findChat(invitee: NamedNode) {
+    async function findChat(invitee: NamedNode): Promise<Chat> {
         const me = await profileLogic.loadMe();
         const podRoot = await profileLogic.getPodRoot(me);
         const chatContainer = determineChatContainer(invitee, podRoot);
@@ -206,7 +206,7 @@ export function createChatLogic(store, profileLogic) {
         ${ns.rdf("seeAlso")} <${chatThing.value}> .
         `;
 
-        const inviteResponse = await store.fetcher.webOperation(
+        const inviteResponse = await store.fetcher?.webOperation(
             "POST",
             inviteeInbox.value,
             {

package/src/inbox/inboxLogic.ts

@@ -1,7 +1,8 @@
 import { NamedNode } from "rdflib";
+import { InboxLogic } from "../types";
 import { getArchiveUrl } from "../util/utils";
 
-export function createInboxLogic(store, profileLogic, utilityLogic, containerLogic, aclLogic) {
+export function createInboxLogic(store, profileLogic, utilityLogic, containerLogic, aclLogic): InboxLogic {
   
     async function createInboxFor(peerWebId: string, nick: string) {
       const myWebId: NamedNode = await profileLogic.loadMe();

package/src/index.ts

@@ -1,92 +1,21 @@
 // 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'
 
-export {
-  ACL_LINK
-} from './acl/aclLogic'
-
-export {
-  findAclDocUrl,
-  setACLUserPublic,
-  genACLText,
-} from './logic/solidLogicSingleton'
-
-export {
-  ensureTypeIndexes,
-  loadTypeIndexes,
-  registerInTypeIndex,
-  loadIndex,
-  ensureOneTypeIndex,
-  putIndex,
-  makeIndexIfNecessary,
-  loadIndexes,
-  getTypeIndex,
-  getRegistrations,
-  //NEW function for discovery
-  loadTypeIndexesFor,
-  loadCommunityTypeIndexes,
-  loadAllTypeIndexes,
-  getScopedAppInstances,
-  getAppInstances,
-  suggestPublicTypeIndex,
-  suggestPrivateTypeIndex,
-  registerInstanceInTypeIndex,
-  deleteTypeIndexRegistration,
-  getScopedAppsFromIndex
-} from './logic/solidLogicSingleton'
-
-export {
-  setAcl,
-  addToPrivateTypeIndex,
-  findChat,
-  createChatThing,
-  getChat,
-  sendInvite,
-  mintNew
-} from './logic/solidLogicSingleton'
+const authn = solidLogicSingleton.authn
+const authSession = solidLogicSingleton.authn.authSession
+const store = solidLogicSingleton.store
 
+export { ACL_LINK } from './acl/aclLogic'
 export { offlineTestID, appContext } from './authn/authUtil'
-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 { AppDetails, SolidNamespace, AuthenticationContext, SolidLogic } from './types'
+export { UnauthorizedError, CrossOriginForbiddenError, SameOriginForbiddenError, NotFoundError, FetchError, NotEditableError, WebOperationError } from './logic/CustomError'
 
 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, NotEditableError, WebOperationError } from './logic/CustomError'
+  solidLogicSingleton, // solidLogicSingleton is exported entirely because it is used in solid-panes
+  store,
+  authn,
+  authSession
+}
 

package/src/logic/solidLogic.ts

@@ -0,0 +1,75 @@
+import { Session } from "@inrupt/solid-client-authn-browser";
+import * as rdf from "rdflib";
+import { LiveStore, NamedNode, Statement } from "rdflib";
+import { createAclLogic } from "../acl/aclLogic";
+import { SolidAuthnLogic } from "../authn/SolidAuthnLogic";
+import { createChatLogic } from "../chat/chatLogic";
+import { createInboxLogic } from "../inbox/inboxLogic";
+import { createProfileLogic } from "../profile/profileLogic";
+import { createTypeIndexLogic } from "../typeIndex/typeIndexLogic";
+import { createContainerLogic } from "../util/containerLogic";
+import { createUtilityLogic } from "../util/utilityLogic";
+import { AuthnLogic, SolidLogic } from "../types";
+import * as debug from "../util/debug";
+/*
+** It is important to distinquish `fetch`, a function provided by the browser
+** and `Fetcher`, a helper object for the rdflib Store which turns it
+** into a `ConnectedStore` or a `LiveStore`.  A Fetcher object is
+** available at store.fetcher, and `fetch` function at `store.fetcher._fetch`,
+*/
+export function createSolidLogic(specialFetch: { fetch: (url: any, requestInit: any) => any }, session: Session): SolidLogic {
+
+    debug.log("SolidLogic: Unique instance created.  There should only be one of these.")
+    const store: LiveStore = rdf.graph() as LiveStore
+    rdf.fetcher(store, {fetch: specialFetch.fetch}); // Attach a web I/O module, store.fetcher
+    store.updater = new rdf.UpdateManager(store); // Add real-time live updates store.updater
+    store.features = [] // disable automatic node merging on store load
+
+    const authn: AuthnLogic = new SolidAuthnLogic(session)
+    
+    const acl = createAclLogic(store)
+    const containerLogic = createContainerLogic(store)
+    const utilityLogic = createUtilityLogic(store, acl, containerLogic)
+    const profile = createProfileLogic(store, authn, utilityLogic)
+    const chat = createChatLogic(store, profile)
+    const inbox = createInboxLogic(store, profile, utilityLogic, containerLogic, acl)
+    const typeIndex = createTypeIndexLogic(store, authn, profile, utilityLogic)
+    debug.log('SolidAuthnLogic initialized')
+
+    function load(doc: NamedNode | NamedNode[] | string) {
+        return store.fetcher.load(doc);
+    }
+
+    // @@@@ use the one in rdflib.js when it is available and delete this
+    function updatePromise(
+        del: Array<Statement>,
+        ins: Array<Statement> = []
+    ): Promise<void> {
+        return new Promise((resolve, reject) => {
+        store.updater.update(del, ins, function (_uri, ok, errorBody) {
+            if (!ok) {
+            reject(new Error(errorBody));
+            } else {
+            resolve();
+            }
+        }); // callback
+        }); // promise
+    }
+
+    function clearStore() {
+        store.statements.slice().forEach(store.remove.bind(store));
+    }
+
+    return {
+        store,
+        authn,
+        acl,
+        inbox,
+        chat,
+        profile,
+        typeIndex,
+        load,
+        updatePromise,
+        clearStore
+    }
+}

package/src/logic/solidLogicSingleton.ts

@@ -1,14 +1,6 @@
-import * as rdf from "rdflib"
-import { SolidAuthnLogic } from "../authn/SolidAuthnLogic"
-import { authSession } from "../authSession/authSession"
-import { createContainerLogic } from "../util/containerLogic"
-import { createTypeIndexLogic } from "../typeIndex/typeIndexLogic"
 import * as debug from "../util/debug"
-import { createUtilityLogic } from "../util/utilityLogic"
-import { createProfileLogic } from "../profile/profileLogic"
-import { createInboxLogic } from "../inbox/inboxLogic"
-import { createChatLogic } from "../chat/chatLogic"
-import { createAclLogic } from "../acl/aclLogic"
+import { authSession } from "../authSession/authSession"
+import { createSolidLogic } from "./solidLogic"
 
 const _fetch = async (url, requestInit) => {
     const omitCreds = requestInit && requestInit.credentials && requestInit.credentials == 'omit'
@@ -20,154 +12,9 @@ const _fetch = async (url, requestInit) => {
     }
 }
 
-debug.log("SolidLogicSingleton: Unique instance created.  There should only be one of these.")
-
-const store = rdf.graph() as rdf.LiveStore; // Make a Quad store
-rdf.fetcher(store, { fetch: _fetch}); // Attach a web I/O module, store.fetcher
-store.updater = new rdf.UpdateManager(store); // Add real-time live updates store.updater
-store.features = [] // disable automatic node merging on store load
-
-debug.log('SolidAuthnLogic initialized')
-const authn = new SolidAuthnLogic(authSession)
-
-const aclLogic = createAclLogic(store)
-const {
-    findAclDocUrl,
-    setACLUserPublic,
-    genACLText
-} = aclLogic
-
-const containerLogic = createContainerLogic(store)
-const {
-    isContainer,
-    createContainer,
-    getContainerElements,
-    getContainerMembers
-} = containerLogic
+//this const makes solidLogicSingleton global accessible in mashlib
+const solidLogicSingleton = createSolidLogic({ fetch: _fetch }, authSession)
 
-const utilityLogic = createUtilityLogic(store, aclLogic, containerLogic)
-const {
-    recursiveDelete,
-    setSinglePeerAccess,
-    createEmptyRdfDoc,
-    followOrCreateLink,
-    loadOrCreateIfNotExists
-} = utilityLogic
-
-const profileLogic = createProfileLogic(store, authn, utilityLogic)
-const {
-    ensureLoadedPreferences,
-    loadMe,
-    getPodRoot,
-    getMainInbox,
-    findStorage,
-    loadPreferences,
-    loadProfile,
-    silencedLoadPreferences
-} = profileLogic
-
-const chatLogic = createChatLogic(store, profileLogic)
-const {
-    setAcl,
-    addToPrivateTypeIndex,
-    findChat,
-    createChatThing,
-    getChat,
-    sendInvite,
-    mintNew
-} = chatLogic
-
-const inboxLogic  = createInboxLogic(store, profileLogic, utilityLogic, containerLogic, aclLogic)
-const {
-    createInboxFor,
-    getNewMessages,
-    markAsRead
-} = inboxLogic
-
-const typeIndexLogic = createTypeIndexLogic(store, authn, profileLogic, utilityLogic)
-const {
-    ensureTypeIndexes,
-    loadTypeIndexes,
-    registerInTypeIndex,
-    loadIndex,
-    ensureOneTypeIndex,
-    putIndex,
-    makeIndexIfNecessary,
-    loadIndexes,
-    getTypeIndex,
-    getRegistrations,
-    loadTypeIndexesFor,
-    loadCommunityTypeIndexes,
-    loadAllTypeIndexes,
-    getScopedAppInstances,
-    getAppInstances,
-    suggestPublicTypeIndex,
-    suggestPrivateTypeIndex,
-    registerInstanceInTypeIndex,
-    deleteTypeIndexRegistration,
-    getScopedAppsFromIndex
-} = typeIndexLogic
-
-export {
-    store,
-    authn,
-    authSession,
-    //unilityLogic
-    recursiveDelete,
-    setSinglePeerAccess,
-    createEmptyRdfDoc,
-    followOrCreateLink,
-    loadOrCreateIfNotExists,
-    //containerLogic
-    isContainer,
-    createContainer,
-    getContainerElements,
-    getContainerMembers,
-    //typeIndexLogic
-    ensureTypeIndexes,
-    loadTypeIndexes,
-    registerInTypeIndex,
-    loadIndex,
-    ensureOneTypeIndex,
-    putIndex,
-    makeIndexIfNecessary,
-    loadIndexes,
-    getTypeIndex,
-    getRegistrations,
-    loadTypeIndexesFor,
-    loadCommunityTypeIndexes,
-    loadAllTypeIndexes,
-    getScopedAppInstances,
-    getAppInstances,
-    suggestPublicTypeIndex,
-    suggestPrivateTypeIndex,
-    registerInstanceInTypeIndex,
-    deleteTypeIndexRegistration,
-    getScopedAppsFromIndex,
-    //profileLogic
-    ensureLoadedPreferences,
-    loadMe,
-    getPodRoot,
-    getMainInbox,
-    findStorage,
-    loadPreferences,
-    loadProfile,
-    silencedLoadPreferences,
-    //inboxLogic
-    createInboxFor,
-    getNewMessages,
-    markAsRead,
-    //chatLogic
-    setAcl,
-    addToPrivateTypeIndex,
-    findChat,
-    createChatThing,
-    getChat,
-    sendInvite,
-    mintNew,
-    //aclLogic
-    findAclDocUrl,
-    setACLUserPublic,
-    genACLText
-}
+debug.log('Unique quadstore initialized.')
 
+export { solidLogicSingleton }

package/src/profile/profileLogic.ts

@@ -1,20 +1,13 @@
 import { NamedNode } from "rdflib";
 import { CrossOriginForbiddenError, FetchError, NotEditableError, SameOriginForbiddenError, UnauthorizedError, WebOperationError } from "../logic/CustomError";
-import { AuthenticationContext } from "../types";
 import * as debug from "../util/debug";
-import { differentOrigin, suggestPreferencesFile } from "../util/utils";
-import { ns as namespace } from '../util/ns'
+import { ns as namespace } from '../util/ns';
+import { differentOrigin, suggestPreferencesFile } from "../util/utils"
+import { ProfileLogic } from "../types"
 
-export function createProfileLogic(store, authn, utilityLogic) {
+export function createProfileLogic(store, authn, utilityLogic): ProfileLogic {
     const ns = namespace
 
-    async function ensureLoadedPreferences (context: AuthenticationContext) {
-        if (!context.me) throw new Error('@@ ensureLoadedPreferences: no user specified')
-        context.publicProfile = await loadProfile(context.me)
-        context.preferencesFile = await silencedLoadPreferences(context.me)
-        return context
-    }
-
     /**
      * loads the preference without throwing errors - if it can create it it does so.
      * remark: it still throws error if it cannot load profile.
@@ -121,7 +114,6 @@ export function createProfileLogic(store, authn, utilityLogic) {
     }
 
     return {
-        ensureLoadedPreferences,
         loadMe,
         getPodRoot,
         getMainInbox,