mashlib 1.8.1-859657ba → 1.8.1-bae51bcd
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 +16 -16
- package/dist/mashlib.js +4 -4
- 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 +4 -4
package/README.md
CHANGED
|
@@ -3,12 +3,12 @@
|
|
|
3
3
|
[](https://www.npmjs.com/package/mashlib)
|
|
4
4
|
|
|
5
5
|
The mashlib library (`mashlib.js`) is a solid-compatible code library of application-level functionality for the world of Solid. It compiles all of the following repositories into what we know as `mashlib.js`:
|
|
6
|
-
- [**solid-logic**](https://github.com/
|
|
7
|
-
- [**pane-registry**](https://github.com/
|
|
8
|
-
- [**solid-ui**](https://github.com/
|
|
9
|
-
- [**solid-panes**](https://github.com/
|
|
6
|
+
- [**solid-logic**](https://github.com/solidos/solid-logic) — core business logic of SolidOS
|
|
7
|
+
- [**pane-registry**](https://github.com/solidos/pane-registry) - an index to hold all loaded solid panes, whether statically or dynamically loaded
|
|
8
|
+
- [**solid-ui**](https://github.com/solidos/solid-ui) — User Interface widgets and utilities for Solid. Building blocks for solid-based apps
|
|
9
|
+
- [**solid-panes**](https://github.com/solidos/solid-panes) — a set of core solid-compatible panes based on solid-ui.
|
|
10
10
|
|
|
11
|
-
A colorful dependency tree can be seen [here](https://github.com/
|
|
11
|
+
A colorful dependency tree can be seen [here](https://github.com/solidos/solidos/blob/main/documentation/solidos_dependencies.svg).
|
|
12
12
|
|
|
13
13
|
## Content of README
|
|
14
14
|
### Intro
|
|
@@ -38,7 +38,7 @@ A colorful dependency tree can be seen [here](https://github.com/solid/solidos/b
|
|
|
38
38
|
|
|
39
39
|
## Developing mashlib
|
|
40
40
|
|
|
41
|
-
As part of the SolidOS stack, mashlib can be developed locally by setting up the SolidOS code. Read more about that on the [SolidOS Readme](https://github.com/
|
|
41
|
+
As part of the SolidOS stack, mashlib can be developed locally by setting up the SolidOS code. Read more about that on the [SolidOS Readme](https://github.com/solidos/solidos#-getting-started-with-the-solidos-code).
|
|
42
42
|
|
|
43
43
|
## Goals
|
|
44
44
|
|
|
@@ -51,7 +51,7 @@ One major use of mashlib is as a "databrowser" for a personal data store.
|
|
|
51
51
|
Mashlib is used in SolidOS and contributes to:
|
|
52
52
|
|
|
53
53
|
- SolidOS Databrowser Frontend - a frontend for Solid Servers like <solidcommunity.net>
|
|
54
|
-
- SolidOS Data-Kitchen - a stand-alone desktop app: <https://github.com/
|
|
54
|
+
- SolidOS Data-Kitchen - a stand-alone desktop app: <https://github.com/solidos/data-kitchen>
|
|
55
55
|
|
|
56
56
|
mashlib is also used stand-alone as the SolidOS Databrowser Webapp and can be tried out at <https://solid.github.io/mashlib/dist/browse.html>.
|
|
57
57
|
|
|
@@ -81,11 +81,11 @@ To run/test it locally we created a script `npm run startStaticOS`.
|
|
|
81
81
|
|
|
82
82
|
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.
|
|
83
83
|
|
|
84
|
-
More information about the SolidOS Front-end and how to use it visit the [User Guide](https://github.com/
|
|
84
|
+
More information about the SolidOS Front-end and how to use it visit the [User Guide](https://github.com/solidos/userguide).
|
|
85
85
|
|
|
86
86
|
### SolidOS Data-Kitchen
|
|
87
87
|
|
|
88
|
-
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/
|
|
88
|
+
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/solidos/data-kitchen).
|
|
89
89
|
|
|
90
90
|
## Mashlib global variables and functions
|
|
91
91
|
|
|
@@ -97,10 +97,10 @@ What does `global` mean in mashlib? We mean the `global object` which depends on
|
|
|
97
97
|
|
|
98
98
|
These are the most important window context/global variables and the sub-repos from which they are exported:
|
|
99
99
|
|
|
100
|
-
- [**solid-logic**](https://github.com/
|
|
101
|
-
- [**pane-registry**](https://github.com/
|
|
102
|
-
- [**solid-ui**](https://github.com/
|
|
103
|
-
- [**solid-panes**](https://github.com/
|
|
100
|
+
- [**solid-logic**](https://github.com/solidos/solid-logic/blob/f606b31382a416ee6188930c3ca05cb4ae73cbda/src/index.ts#L29) exports among others: `solidLogicSingleton`, `authn`, `authSession`, `store`, `chat`, `profile`
|
|
101
|
+
- [**pane-registry**](https://github.com/solidos/pane-registry) is exported entirely through the pane-registry variable
|
|
102
|
+
- [**solid-ui**](https://github.com/solidos/solid-ui/blob/c5a8888d6cb61363bc0445be007e3c96de593338/src/index.ts#L79) exports among others: authn, store, rdf, dom under the `UI` variable
|
|
103
|
+
- [**solid-panes**](https://github.com/solidos/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
|
|
104
104
|
|
|
105
105
|
For backward compatibility reasons, there are now different ways to make use of the same variables from mashlib. For example:
|
|
106
106
|
|
|
@@ -111,7 +111,7 @@ For backward compatibility reasons, there are now different ways to make use of
|
|
|
111
111
|
- the currentUser function is called as `authn.currentUser()` or `UI.auth.currentUser()` or `panes.UI.authn.currentUser()`
|
|
112
112
|
- to make use of the login pop-up, one needs to call the `UI.login.loginStatusBox` function
|
|
113
113
|
|
|
114
|
-
You can see example usage in the [SolidOS Databrowser Webapp code](https://github.com/
|
|
114
|
+
You can see example usage in the [SolidOS Databrowser Webapp code](https://github.com/solidos/mashlib/blob/main/static/browse.html#L11).
|
|
115
115
|
|
|
116
116
|
## Code changes due to moving authn from solid-ui to solid-logic
|
|
117
117
|
|
|
@@ -129,8 +129,8 @@ Some packages have been moved and with them some functions too. Here we report o
|
|
|
129
129
|
Functions that moved:
|
|
130
130
|
|
|
131
131
|
* `currentUser`, `checkUser`, `saveUser`, `offlineTestID` are now part of `solid-logic/authn/SolidAuthnLogic.ts`-> this is because `authn` itself moved to solid-logic.
|
|
132
|
-
* `setACLUserPublic`, `fetchACLRel` are not part of `solid-logic/src/acl/aclLogic.ts/` and are exported in [index.ts](https://github.com/
|
|
133
|
-
* `loadIndex`, `loadTypeIndexes`, `ensureTypeIndexes`, `registerInTypeIndex` and are exported in [index.ts](https://github.com/
|
|
132
|
+
* `setACLUserPublic`, `fetchACLRel` are not part of `solid-logic/src/acl/aclLogic.ts/` and are exported in [index.ts](https://github.com/solidos/solid-logic/blob/f606b31382a416ee6188930c3ca05cb4ae73cbda/src/index.ts#L12).
|
|
133
|
+
* `loadIndex`, `loadTypeIndexes`, `ensureTypeIndexes`, `registerInTypeIndex` and are exported in [index.ts](https://github.com/solidos/solid-logic/blob/f606b31382a416ee6188930c3ca05cb4ae73cbda/src/index.ts#L16).
|
|
134
134
|
|
|
135
135
|
## The databrowser hack: upgrading your browser
|
|
136
136
|
|
package/dist/mashlib.js
CHANGED
|
@@ -8958,8 +8958,8 @@ __webpack_require__.r(__webpack_exports__);
|
|
|
8958
8958
|
/* harmony export */ "default": () => (__WEBPACK_DEFAULT_EXPORT__)
|
|
8959
8959
|
/* harmony export */ });
|
|
8960
8960
|
/* harmony default export */ const __WEBPACK_DEFAULT_EXPORT__ = ({
|
|
8961
|
-
buildTime: "2022-
|
|
8962
|
-
commit: "
|
|
8961
|
+
buildTime: "2022-04-14T12:57:07Z",
|
|
8962
|
+
commit: "bae51bcdab42171f07c974618d42921644b08ec6",
|
|
8963
8963
|
npmInfo: {
|
|
8964
8964
|
mashlib: '1.8.1',
|
|
8965
8965
|
npm: '6.14.16',
|
|
@@ -8971,8 +8971,8 @@ __webpack_require__.r(__webpack_exports__);
|
|
|
8971
8971
|
modules: '83',
|
|
8972
8972
|
napi: '8',
|
|
8973
8973
|
nghttp2: '1.42.0',
|
|
8974
|
-
node: '14.19.
|
|
8975
|
-
openssl: '1.1.
|
|
8974
|
+
node: '14.19.1',
|
|
8975
|
+
openssl: '1.1.1n',
|
|
8976
8976
|
tz: '2021a3',
|
|
8977
8977
|
unicode: '14.0',
|
|
8978
8978
|
uv: '1.42.0',
|