mashlib 1.7.22-92c8e9f9 → 1.7.22-c0322b07
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -9
- package/dist/mashlib.js +2 -2
- package/dist/mashlib.js.map +1 -1
- package/dist/mashlib.min.js +1 -1
- package/dist/mashlib.min.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -39,7 +39,7 @@ Check out [SolidOS Pod](https://solidos.solidcommunity.net/Team/docs/solidos.htm
|
|
|
39
39
|
|
|
40
40
|
# Documentation
|
|
41
41
|
|
|
42
|
-
## Different
|
|
42
|
+
## Different implementations
|
|
43
43
|
|
|
44
44
|
### SolidOS Databrowser Webapp
|
|
45
45
|
|
|
@@ -47,7 +47,7 @@ The `static/browse.html` page is compiled one to one into the `dist` (output) fo
|
|
|
47
47
|
|
|
48
48
|
You can see and try out a SolidOS Databrowser Webapp deployment at <https://solid.github.io/mashlib/dist/browse.html>.
|
|
49
49
|
|
|
50
|
-
`browse.html`serves as a perfect example for Solid WebID authentication and for making use of mashlib functions and variables.
|
|
50
|
+
`browse.html`serves as a perfect example for Solid WebID authentication and for making use of mashlib functions and variables.
|
|
51
51
|
|
|
52
52
|
### SolidOS Databrowser Frontend
|
|
53
53
|
|
|
@@ -59,20 +59,20 @@ More information about the SolidOS Front-end and how to use it visit the [User G
|
|
|
59
59
|
|
|
60
60
|
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).
|
|
61
61
|
|
|
62
|
-
## Mashlib global variables and
|
|
62
|
+
## Mashlib global variables and functions
|
|
63
63
|
|
|
64
|
-
If one wants to use mashlib as a direct import (as a package dependency or script import), one needs to know
|
|
64
|
+
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.
|
|
65
65
|
|
|
66
66
|
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).
|
|
67
67
|
|
|
68
68
|
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).
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
These are the most important window context/global variables and the sub-repos from which they are exported:
|
|
71
71
|
|
|
72
|
-
- [**solid-logic**](https://github.com/solid/solid-logic/blob/f606b31382a416ee6188930c3ca05cb4ae73cbda/src/index.ts#L29) exports among others: solidLogicSingleton
|
|
72
|
+
- [**solid-logic**](https://github.com/solid/solid-logic/blob/f606b31382a416ee6188930c3ca05cb4ae73cbda/src/index.ts#L29) exports among others: `solidLogicSingleton`, `authn`, `authSession`, `store`, `chat`, `profile`
|
|
73
73
|
- [**pane-registry**](https://github.com/solid/pane-registry) is exported entirely through the pane-registry variable
|
|
74
|
-
- [**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
|
|
75
|
-
- [**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
|
|
74
|
+
- [**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
|
|
75
|
+
- [**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
|
|
76
76
|
|
|
77
77
|
For backward compatibility reasons, there are now different ways to make use of the same variables from mashlib. For example:
|
|
78
78
|
|
|
@@ -83,7 +83,26 @@ For backward compatibility reasons, there are now different ways to make use of
|
|
|
83
83
|
- the currentUser function is called as `authn.currentUser()` or `UI.auth.currentUser()` or `panes.UI.authn.currentUser()`
|
|
84
84
|
- to make use of the login pop-up, one needs to call the `UI.login.loginStatusBox` function
|
|
85
85
|
|
|
86
|
-
You can see
|
|
86
|
+
You can see example usage in the [SolidOS Databrowser Webapp code](https://github.com/solid/mashlib/blob/main/static/browse.html#L11).
|
|
87
|
+
|
|
88
|
+
## Code changes due to moving authn from solid-ui to solid-logic
|
|
89
|
+
|
|
90
|
+
Some packages have been moved and with them some functions too. Here we report on these changes:
|
|
91
|
+
|
|
92
|
+
### Solid-ui & Solid-logic related:
|
|
93
|
+
|
|
94
|
+
* 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).
|
|
95
|
+
* Some functions in solid-ui which initially were found under `solid-ui/authn` are now under `solid-ui/login`.
|
|
96
|
+
* Two functions were renamed:
|
|
97
|
+
* logInLoadPreferences -> ensureLoadedPreferences
|
|
98
|
+
* logInLoadProfile -> ensureLoadedProfile
|
|
99
|
+
* logIn -> ensureLoggedIn
|
|
100
|
+
|
|
101
|
+
Functions that moved:
|
|
102
|
+
|
|
103
|
+
* `currentUser`, `checkUser`, `saveUser`, `offlineTestID` are now part of `solid-logic/authn/SolidAuthnLogic.ts`-> this is because `authn` itself moved to solid-logic.
|
|
104
|
+
* `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).
|
|
105
|
+
* `loadIndex`, `loadTypeIndexes`, `ensureTypeIndexes`, `registerInTypeIndex` and are exported in [index.ts](https://github.com/solid/solid-logic/blob/f606b31382a416ee6188930c3ca05cb4ae73cbda/src/index.ts#L16).
|
|
87
106
|
|
|
88
107
|
## The databrowser hack: upgrading your browser
|
|
89
108
|
|
package/dist/mashlib.js
CHANGED
|
@@ -149178,8 +149178,8 @@ __webpack_require__.r(__webpack_exports__);
|
|
|
149178
149178
|
"use strict";
|
|
149179
149179
|
__webpack_require__.r(__webpack_exports__);
|
|
149180
149180
|
/* harmony default export */ __webpack_exports__["default"] = ({
|
|
149181
|
-
buildTime: '2022-03-
|
|
149182
|
-
commit: '
|
|
149181
|
+
buildTime: '2022-03-07T20:36:15Z',
|
|
149182
|
+
commit: 'c0322b07a5b5fb6e03eaacf32ac3096072b45147',
|
|
149183
149183
|
npmInfo: {
|
|
149184
149184
|
mashlib: '1.7.22',
|
|
149185
149185
|
npm: '6.14.16',
|