solid-logic 1.3.17-80b4d030 → 1.3.17-81536f11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "solid-logic",
-  "version": "1.3.17-80b4d030",
+  "version": "1.3.17-81536f11",
   "description": "Core business logic of Solid OS",
   "main": "lib/index.js",
   "scripts": {
@@ -25,24 +25,24 @@
   },
   "homepage": "https://github.com/solidos/solid-logic#readme",
   "devDependencies": {
-    "@babel/plugin-proposal-class-properties": "~7.16.7",
-    "@babel/plugin-proposal-optional-chaining": "~7.16.7",
-    "@babel/plugin-transform-async-to-generator": "~7.16.8",
-    "@babel/plugin-transform-runtime": "^7.17.0",
-    "@babel/preset-env": "~7.16.11",
-    "@babel/preset-typescript": "~7.16.7",
-    "@types/jest": "^27.4.1",
-    "@typescript-eslint/eslint-plugin": "^5.19.0",
-    "@typescript-eslint/parser": "^5.19.0",
-    "eslint": "^8.13.0",
+    "@babel/plugin-proposal-class-properties": "~7.18.6",
+    "@babel/plugin-proposal-optional-chaining": "~7.18.9",
+    "@babel/plugin-transform-async-to-generator": "~7.18.6",
+    "@babel/plugin-transform-runtime": "^7.18.10",
+    "@babel/preset-env": "~7.18.10",
+    "@babel/preset-typescript": "~7.18.6",
+    "@types/jest": "^27.5.2",
+    "@typescript-eslint/eslint-plugin": "^5.35.1",
+    "@typescript-eslint/parser": "^5.35.1",
+    "eslint": "^8.23.0",
     "jest": "^27.5.1",
     "jest-environment-node-debug": "^2.0.0",
     "jest-fetch-mock": "^3.0.3",
-    "typescript": "^4.6.3"
+    "typescript": "^4.8.2"
   },
   "dependencies": {
-    "@inrupt/solid-client-authn-browser": "^1.11.7",
-    "rdflib": "^2.2.19",
+    "@inrupt/solid-client-authn-browser": "^1.12.2",
+    "rdflib": "^2.2.20",
     "solid-namespace": "^0.5.2"
   }
 }

package/src/acl/aclLogic.ts

@@ -1,4 +1,5 @@
 import { graph, NamedNode, Namespace, serialize, sym } from "rdflib"
+import { AclLogic } from "../types";
 import { ns as namespace } from '../util/ns'
 
 
@@ -6,7 +7,7 @@ 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
     
@@ -116,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

@@ -6,158 +6,16 @@ const authn = solidLogicSingleton.authn
 const authSession = solidLogicSingleton.authn.authSession
 const store = solidLogicSingleton.store
 
-const aclLogic = solidLogicSingleton.aclLogic
-const utilityLogic = solidLogicSingleton.utilityLogic
-const containerLogic = solidLogicSingleton.containerLogic
-const profileLogic = solidLogicSingleton.profileLogic
-const inboxLogic = solidLogicSingleton.inboxLogic
-const typeIndexLogic = solidLogicSingleton.typeIndexLogic
-const chatLogic = solidLogicSingleton.chatLogic
-
-const {
-  findAclDocUrl,
-  setACLUserPublic,
-  genACLText,
-} = aclLogic
-
-const {
-  ensureTypeIndexes,
-  loadTypeIndexes,
-  registerInTypeIndex,
-  loadIndex,
-  ensureOneTypeIndex,
-  putIndex,
-  makeIndexIfNecessary,
-  loadIndexes,
-  getTypeIndex,
-  getRegistrations,
-  //NEW function for discovery
-  loadTypeIndexesFor,
-  loadCommunityTypeIndexes,
-  loadAllTypeIndexes,
-  getScopedAppInstances,
-  getAppInstances,
-  suggestPublicTypeIndex,
-  suggestPrivateTypeIndex,
-  registerInstanceInTypeIndex,
-  deleteTypeIndexRegistration,
-  getScopedAppsFromIndex
-} = typeIndexLogic
-
-const {
-  setAcl,
-  addToPrivateTypeIndex,
-  findChat,
-  createChatThing,
-  getChat,
-  sendInvite,
-  mintNew
-} = chatLogic
-
-const  { createInboxFor, getNewMessages, markAsRead } = inboxLogic
-const {
-  recursiveDelete,
-  setSinglePeerAccess,
-  createEmptyRdfDoc,
-  //NEW function for discovery
-  followOrCreateLink,
-  loadOrCreateIfNotExists,
-} = utilityLogic
-
-const  {
-  ensureLoadedPreferences,
-  loadMe,
-  getPodRoot,
-  getMainInbox,
-  findStorage,
-   //NEW content from discovery
-  loadPreferences,
-  loadProfile,
-  //NEW function for discovery
-  silencedLoadPreferences
-} = profileLogic
-
-const {
-  isContainer,
-  createContainer,
-  getContainerElements,
-  getContainerMembers
-} = containerLogic
-
 export { ACL_LINK } from './acl/aclLogic'
 export { offlineTestID, appContext } from './authn/authUtil'
 export { getSuggestedIssuers } from './issuer/issuerLogic'
-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 { AppDetails, SolidNamespace, AuthenticationContext, SolidLogic } from './types'
 export { UnauthorizedError, CrossOriginForbiddenError, SameOriginForbiddenError, NotFoundError, FetchError, NotEditableError, WebOperationError } from './logic/CustomError'
 
 export {
+  solidLogicSingleton, // solidLogicSingleton is exported entirely because it is used in solid-panes
   store,
   authn,
-  authSession,
-  aclLogic,
-  utilityLogic,
-  containerLogic,
-  profileLogic,
-  inboxLogic,
-  typeIndexLogic,
-  chatLogic,
-  //aclLogic
-  findAclDocUrl,
-  setACLUserPublic,
-  genACLText,
-  //typeIndexLogic
-  ensureTypeIndexes,
-  loadTypeIndexes,
-  registerInTypeIndex,
-  loadIndex,
-  ensureOneTypeIndex,
-  putIndex,
-  makeIndexIfNecessary,
-  loadIndexes,
-  getTypeIndex,
-  getRegistrations,
-  loadTypeIndexesFor,
-  loadCommunityTypeIndexes,
-  loadAllTypeIndexes,
-  getScopedAppInstances,
-  getAppInstances,
-  suggestPublicTypeIndex,
-  suggestPrivateTypeIndex,
-  registerInstanceInTypeIndex,
-  deleteTypeIndexRegistration,
-  getScopedAppsFromIndex,
-  setAcl,
-  addToPrivateTypeIndex,
-  findChat,
-  createChatThing,
-  getChat,
-  sendInvite,
-  //inboxLogic
-  mintNew,
-  createInboxFor,
-  getNewMessages,
-  markAsRead,
-  //utilityLogic
-  recursiveDelete,
-  setSinglePeerAccess,
-  createEmptyRdfDoc,
-  followOrCreateLink,
-  loadOrCreateIfNotExists,
-  //profileLogic
-  ensureLoadedPreferences,
-  loadMe,
-  getPodRoot,
-  getMainInbox,
-  findStorage,
-  loadPreferences,
-  loadProfile,
-  silencedLoadPreferences,
-  //containerLogic
-  isContainer,
-  createContainer,
-  getContainerElements,
-  getContainerMembers
-}
+  authSession
+}
+

package/src/issuer/issuerLogic.ts

@@ -13,7 +13,7 @@ const DEFAULT_ISSUERS = [
   },
   {
     name: 'pod.Inrupt.com',
-    uri: 'https://broker.pod.inrupt.com'
+    uri: 'https://login.inrupt.com'
   }
 ]
 

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,6 +1,6 @@
 import * as debug from "../util/debug"
 import { authSession } from "../authSession/authSession"
-import { SolidLogic } from "./SolidLogic"
+import { createSolidLogic } from "./solidLogic"
 
 const _fetch = async (url, requestInit) => {
     const omitCreds = requestInit && requestInit.credentials && requestInit.credentials == 'omit'
@@ -13,7 +13,7 @@ const _fetch = async (url, requestInit) => {
 }
 
 //this const makes solidLogicSingleton global accessible in mashlib
-const solidLogicSingleton = new SolidLogic({ fetch: _fetch }, authSession)
+const solidLogicSingleton = createSolidLogic({ fetch: _fetch }, authSession)
 
 debug.log('Unique quadstore initialized.')
 

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,