Package Exports
- solid-logic
Readme
solid-logic
Core business logic of SolidOS which can be used for any webapp as well.
Usage
Install via npm
npm install solid-logicImport in your project (ESM/TypeScript)
import { someFunction } from 'solid-logic';Use directly in a browser
UMD bundle (global variable)
<!-- Load dependencies first -->
<script src="https://unpkg.com/rdflib/dist/rdflib.min.js"></script>
<!-- or -->
<!-- script src="https://cdn.jsdelivr.net/npm/rdflib/dist/rdflib.min.js"></script -->
<!-- Load solid-logic UMD bundle -->
<script src="https://unpkg.com/solid-logic/dist/solid-logic.umd.min.js"></script>
<!-- or -->
<!-- script src="https://cdn.jsdelivr.net/npm/solid-logic/dist/solid-logic.umd.min.js"></script -->
<!-- or -->
<!-- script src="dist/solid-logic.umd.js"></script -->
<script>
// Access via global variable
const logic = window.SolidLogic;
// Example usage
// logic.someFunction(...)
</script>ESM bundle (import as module)
<script type="module">
import * as rdflib from 'https://esm.sh/rdflib';
import { someFunction } from 'https://esm.sh/solid-logic';
// Example usage
// someFunction(...)
</script>or
ESM bundle with import map (bare specifiers)
<script type="importmap">
{
"imports": {
"rdflib": "https://esm.sh/rdflib",
"solid-logic": "https://esm.sh/solid-logic"
}
}
</script>
<script type="module">
import * as rdflib from 'rdflib';
import { someFunction } from 'solid-logic';
// Example usage
// someFunction(...)
</script>Files
- For npm/ESM:
dist/solid-logic.esm.js(referenced automatically in npm projects) - For browser UMD:
dist/solid-logic.umd.js(globalwindow.SolidLogic) - For browser ESM:
dist/solid-logic.esm.js(import as module)
How to develop
Check the scripts in the package.json for build, watch, lint and test.
Used stack
- TypeScript + Babel
- Jest
- ESLint
- Rollup
How to release
Change version and push directly to main. This will trigger the npm release latest script in CI.
History
Solid-logic was a move to separate business logic from UI functionality so that people using different UI frameworks could use logic code.
It was created when the "chat with me" feature was built. We needed to share logic between chat-pane and profile-pane (which was part of solid-panes back then I think) due to that feature. The whole idea of it is to separate core solid logic from UI components, to make logic reusable, e.g. by other UI libraries or even non web apps like CLI tools etc.