mashlib 1.7.22-f2c8fbbb → 1.8.0

package/README.md

@@ -39,51 +39,70 @@ Check out [SolidOS Pod](https://solidos.solidcommunity.net/Team/docs/solidos.htm
 
 # Documentation
 
-## Different implemnetation
+## Different implementations
 
 ### SolidOS Databrowser Webapp
 
 The `static/browse.html` page is compiled one to one into the `dist` (output) folder of mashlib and makes mashlib available stand-alone as the SolidOS Databrowser Webapp.
 
-You can see and try out a SolidOS Databrowser Webapp deployment under this link: <https://solid.github.io/mashlib/dist/browse.html>
+You can see and try out a SolidOS Databrowser Webapp deployment at <https://solid.github.io/mashlib/dist/browse.html>.
 
-`browse.html`serves as a perfect example for: Solid WebID authentication and how to make use of mashlib function and variables. 
+`browse.html`serves as a perfect example for Solid WebID authentication and for making use of mashlib functions and variables.
 
 ### SolidOS Databrowser Frontend
 
-The `src/databrowser.html`page is compiled into the SolidOS Databrowser Frontend which is displayed for each WebID on [solidcommunity.net](https://solidcommunity.net/). This is the case because the [solidcommunity.net](https://solidcommunity.net/) Solid Server is configured with SolidOS as its frontend.
+The `src/databrowser.html`page is compiled into the SolidOS Databrowser Frontend which is displayed for each WebID on [solidcommunity.net](https://solidcommunity.net/). This is the case because the [solidcommunity.net](https://solidcommunity.net/) Solid Server is configured with SolidOS as its front-end.
 
-More information about the SolidOS Frontend and how to use it visit the [User Guide](https://github.com/solid/userguide).
+More information about the SolidOS Front-end and how to use it visit the [User Guide](https://github.com/solid/userguide).
 
 ### SolidOS Data-Kitchen
 
 SolidOS Data-Kitchen uses `mashlib.js`as a direct import in its source code. Visit the code at [SolidOS Data-Kitchen GitHub](https://github.com/solid/data-kitchen).
 
-## Mashlib global variables and funtions
+## Mashlib global variables and functions
 
-If one wants to use mashlib as a direct import (as a package dependency or script import) one needs to know how they immediate available global variables and functions.
+If one wants to use mashlib as a direct import (as a package dependency or script import), one needs to know which global variables and functions are available.
 
-The availability of these global variables depends on how the sub-modules are imported and exported but also on where the variables are instanciated. For a basic theoretical read please read [this resource](https://www.javatpoint.com/javascript-global-variable).
+The availability of these global variables depends on how the sub-modules are imported and exported and on where the variables are instantiated. For a basic theoretical read, please see [this resource](https://www.javatpoint.com/javascript-global-variable).
 
-What does `global` mean in mashlib? We mean the `global object` which depends on different environments. In mashlib, for now, we use the `window`context which means these variables will not work in non-window contexts such as Node.js environments if directly used. (This does not mean you cannot use mashlib in Node.js environments -> just import it through npm). We will switch this at some point to the [`globalThis`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis).
+What does `global` mean in mashlib? We mean the `global object` which depends on different environments. In mashlib, for now, we use the `window` context which means these variables will not work if directly used in non-window contexts such as `Node.js` environments. (This does not mean you cannot use mashlib in `Node.js` environments; just import it through `npm`). At some point, we will switch this to the [`globalThis`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis).
 
-Next we list the most important window context/global variables and which sub-repos are they exported from:
+These are the most important window context/global variables and the sub-repos from which they are exported:
 
-- [**solid-logic**](https://github.com/solid/solid-logic/blob/f606b31382a416ee6188930c3ca05cb4ae73cbda/src/index.ts#L29) exports among others: solidLogicSingleton, authn, authSession, store, chat, profile;
-- [**pane-registry**](https://github.com/solid/pane-registry) is exported entirely through the pane-registry variable;
-- [**solid-ui**](https://github.com/solid/solid-ui/blob/c5a8888d6cb61363bc0445be007e3c96de593338/src/index.ts#L79) exports among others: authn, store, rdf, dom under the UI variable;
-- [**solid-panes**](https://github.com/solid/solid-panes/blob/033f48f8987364cb131455b13e8b0637da95a5ab/src/index.ts#L53) exports getOutliner and the entire solid-ui through the UI variable, and solid-panes itself can be used through the `panes` variable.
+- [**solid-logic**](https://github.com/solid/solid-logic/blob/f606b31382a416ee6188930c3ca05cb4ae73cbda/src/index.ts#L29) exports among others: `solidLogicSingleton`, `authn`, `authSession`, `store`, `chat`, `profile`
+- [**pane-registry**](https://github.com/solid/pane-registry) is exported entirely through the pane-registry variable
+- [**solid-ui**](https://github.com/solid/solid-ui/blob/c5a8888d6cb61363bc0445be007e3c96de593338/src/index.ts#L79) exports among others: authn, store, rdf, dom under the `UI` variable
+- [**solid-panes**](https://github.com/solid/solid-panes/blob/033f48f8987364cb131455b13e8b0637da95a5ab/src/index.ts#L53) exports getOutliner and the entire solid-ui through the `UI` variable, and solid-panes itself can be used through the `panes` variable
 
 For backward compatibility reasons, there are now different ways to make use of the same variables from mashlib. For example:
 
-- to make use of the UI (solid-ui) one can use `UI` or `panes.UI`;
-- authentication session, part of solid-logic, can be called as `authSession` or `UI.authn.authSession` or `panes.UI.authn.authSession`;
-- the store (from solid-logic) can be used as `store` or `UI.store` or `panes.UI.store`;
+- to make use of the UI (solid-ui) one can use `UI` or `panes.UI`
+- authentication session, part of solid-logic, can be called as `authSession` or `UI.authn.authSession` or `panes.UI.authn.authSession`
+- the store (from solid-logic) can be used as `store` or `UI.store` or `panes.UI.store`
 - rdflib is entirely acessible as `UI.rdf` or `panes.UI.rdf`
 - the currentUser function is called as `authn.currentUser()` or `UI.auth.currentUser()` or `panes.UI.authn.currentUser()`
-- and to make use of the login pop up one needs to call `UI.login.loginStatusBox`function.
+- to make use of the login pop-up, one needs to call the `UI.login.loginStatusBox` function
 
-You can see an example usage in the [SolidOS Databrowser Webapp code](https://github.com/solid/mashlib/blob/main/static/browse.html#L11).
+You can see example usage in the [SolidOS Databrowser Webapp code](https://github.com/solid/mashlib/blob/main/static/browse.html#L11).
+
+## Code changes due to moving authn from solid-ui to solid-logic
+
+Some packages have been moved and with them some functions too. Here we report on these changes:
+
+### Solid-ui & Solid-logic related:
+
+* There is no more `authn` as you might have known it in solid-ui pre mashlib version 1.7.18 (solid-ui 2.4.16).
+* Some functions in solid-ui which initially were found under `solid-ui/authn` are now under `solid-ui/login`.
+* Two functions were renamed:
+    * logInLoadPreferences -> ensureLoadedPreferences 
+    * logInLoadProfile -> ensureLoadedProfile
+    * logIn -> ensureLoggedIn
+
+Functions that moved: 
+
+* `currentUser`, `checkUser`, `saveUser`, `offlineTestID` are now part of `solid-logic/authn/SolidAuthnLogic.ts`-> this is because `authn` itself moved to solid-logic. 
+* `setACLUserPublic`, `fetchACLRel` are not part of `solid-logic/src/acl/aclLogic.ts/` and are exported in [index.ts](https://github.com/solid/solid-logic/blob/f606b31382a416ee6188930c3ca05cb4ae73cbda/src/index.ts#L12).
+* `loadIndex`, `loadTypeIndexes`, `ensureTypeIndexes`, `registerInTypeIndex` and are exported in [index.ts](https://github.com/solid/solid-logic/blob/f606b31382a416ee6188930c3ca05cb4ae73cbda/src/index.ts#L16).
 
 ## The databrowser hack: upgrading your browser
 
@@ -99,6 +118,7 @@ How does the data browser work?
 1. The server supplies the actual data of the to-do list or whatever it was.
 1. The `mashlib.js` code provides an editable visualization on the data.
 
-The mashlib part of SolidOS Databrowser Frontend is *read-write*. Where the user is allowed to edit: it lets them edit the data and create new things. It is *live* in that often the databrowser signed up (using a websocket) for any changes which other users make, so users' screens are synchronized.
+The mashlib part of SolidOS Databrowser Frontend is *read-write;* that is, the user is allowed to edit data and create new things. It is *live,* in that often the databrowser subscribed (using a websocket) for any changes which other users make, so users' screens are synchronized.
+
+A major limitation of this data browser hack is that current web browsers are made to distrust any code loaded from one domain that uses data from another domain. This makes it hard, strangely complicated, and sometimes impossible to do some things.
 
-A major limitation of their data browser hack is that current web browsers are made to distrust any code loaded from one domain that uses data from another domain. This makes it hard, strangely complicated, and sometimes impossible to do some things.

package/dist/databrowser.html

@@ -1,3 +1,3 @@
 <!doctype html><html><head><meta charset="utf-8"/><title>SolidOS Web App</title><script>document.addEventListener('DOMContentLoaded', function() {
         panes.runDataBrowser()
-      })</script><link href="/mash.css" rel="stylesheet"></head><body class="db-layout"><header class="db-layout__header header" id="PageHeader"></header><div class="TabulatorOutline db-layout__content" id="DummyUUID" role="main"><table id="outline"></table><div id="GlobalDashboard"></div></div><footer class="db-layout__footer" id="PageFooter"></footer><script src="/mashlib.min.js"></script></body></html>
+      })</script><link href="/mash.css" rel="stylesheet"></head><body id="PageBody"><header id="PageHeader"></header><div class="TabulatorOutline" id="DummyUUID" role="main"><table id="outline"></table><div id="GlobalDashboard"></div></div><footer id="PageFooter"></footer><script src="/mashlib.min.js"></script></body></html>