mashlib 1.7.22-8da67d95 → 1.7.22-c82895cd
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 +13 -13
- 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
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/mashlib)
|
|
4
4
|
|
|
5
|
-
The mashlib library (`mashlib.js`) is a solid-compatible code library of application-level functionality for the world of Solid. It compiles
|
|
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
6
|
- [**solid-logic**](https://github.com/solid/solid-logic) — core business logic of SolidOS
|
|
7
7
|
- [**pane-registry**](https://github.com/solid/pane-registry) - an index to hold all loaded solid panes, whether statically or dynamically loaded
|
|
8
8
|
- [**solid-ui**](https://github.com/solid/solid-ui) — User Interface widgets and utilities for Solid. Building blocks for solid-based apps
|
|
@@ -16,7 +16,7 @@ As part of the SolidOS stack, mashlib can be developed locally by setting up the
|
|
|
16
16
|
|
|
17
17
|
## Goals
|
|
18
18
|
|
|
19
|
-
The goals of mashlib
|
|
19
|
+
The goals of mashlib overlap with the [SolidOS Goals](https://solidos.solidcommunity.net/Team/docs/SolidOSNorthStar.html).
|
|
20
20
|
|
|
21
21
|
## Typical uses
|
|
22
22
|
|
|
@@ -24,12 +24,12 @@ One major use of mashlib is as a "databrowser" for a personal data store.
|
|
|
24
24
|
|
|
25
25
|
Mashlib is used in SolidOS and contributes to:
|
|
26
26
|
|
|
27
|
-
- SolidOS Databrowser Frontend - a frontend for Solid Servers like
|
|
28
|
-
- SolidOS Data-Kitchen - a stand-alone desktop app: <https://github.com/solid/data-kitchen
|
|
27
|
+
- SolidOS Databrowser Frontend - a frontend for Solid Servers like <solidcommunity.net>
|
|
28
|
+
- SolidOS Data-Kitchen - a stand-alone desktop app: <https://github.com/solid/data-kitchen>
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
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>.
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
mashlib is also used as a library by adding `mashlib.js` (or minified version) directly to your applications. For example:
|
|
33
33
|
|
|
34
34
|
`<script src="https://solidcommunity.net/mashlib.js"></script>`.
|
|
35
35
|
|
|
@@ -45,15 +45,15 @@ Check out [SolidOS Pod](https://solidos.solidcommunity.net/Team/docs/solidos.htm
|
|
|
45
45
|
|
|
46
46
|
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.
|
|
47
47
|
|
|
48
|
-
You can see and try out a SolidOS Databrowser Webapp deployment
|
|
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
|
|
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
|
|
|
54
|
-
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
|
|
54
|
+
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.
|
|
55
55
|
|
|
56
|
-
More information about the SolidOS
|
|
56
|
+
More information about the SolidOS Front-end and how to use it visit the [User Guide](https://github.com/solid/userguide).
|
|
57
57
|
|
|
58
58
|
### SolidOS Data-Kitchen
|
|
59
59
|
|
|
@@ -61,11 +61,11 @@ SolidOS Data-Kitchen uses `mashlib.js`as a direct import in its source code. Vis
|
|
|
61
61
|
|
|
62
62
|
## Mashlib global variables and funtions
|
|
63
63
|
|
|
64
|
-
If one wants to use mashlib as a direct import (as a package dependency or script import) one needs to know how they
|
|
64
|
+
If one wants to use mashlib as a direct import (as a package dependency or script import), one needs to know how they make global variables and functions available.
|
|
65
65
|
|
|
66
|
-
The availability of these global variables depends on how the sub-modules are imported and exported
|
|
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
|
-
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
|
|
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
|
Next we list the most important window context/global variables and which sub-repos are they exported from:
|
|
71
71
|
|
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-03T09:01:37Z',
|
|
149182
|
+
commit: 'c82895cd5539097aed4a2e468cb5a2c68d6ec0c2',
|
|
149183
149183
|
npmInfo: {
|
|
149184
149184
|
mashlib: '1.7.22',
|
|
149185
149185
|
npm: '6.14.16',
|