kireji
Version:
A web framework for stateful, entropy-perfect, multi-origin web applications. Currently in alpha. Expect breaking changes for version 0. Use with caution!
117 lines (90 loc) • 9 kB
Markdown
# kireji: Entropy-Perfect Multi-Origin Web Applications
**kireji** is a web framework that maximally compresses data models using minimal perfect hash functions (MPHFs).
It achieves the information-theoretic lower bound, creating the smallest possible collision-free, duplicate-free and gap-free hashes for arbitrary data.
Any group of applications powered by kireji can have its entire group state stored in a tight place - like a single URL or even a DNS TXT record.
Model data is recovered instantly from a hash and vice-versa.
This gives applications deterministic, lossless deep linking, state bookmarking, historical replay and peer-to-peer sharing (via simple URL sharing) without users interacting with a central server.
## Entropy-Perfect Encoding
Each application state is assigned a unique variable-length base64 hash, derived from a bijective minimal perfect hash function.
This makes them as compact and expressive as is mathematically possible.
kireji provides a compression solution that is uniquely built for the given data model and can represent every state in that model.
All kireji hashes are inherently integers (implemented using the `bigint` primitive in JavaScript).
Because the hash function has no gaps, no duplicates, and no collisions, it is not possible to achieve a smaller lossless hash of a given data model than this.
If there are 10,000,000,000,000,000,000,000,000,000,000,000,000,000,000 possible ways to populate your application's data model, then kireji produces a hash integer that is always between 0 and 9,999,999,999,999,999,999,999,999,999,999,999,999,999,999.
kireji can then instantly hash any instance of the data model and instantly recover one from any integer in that range.
An example use-case of this is embedding rich state information in places with limited space, such as a URL or DNS TXT record, without the syntactical overhead of query parameters,JSON objects, or delimiters.
```
https://www.ejaugust.com/0.126.3/4lb5kAsH_R0Dv_UHg/
```
### Further Reading
* [Entropy-Perfect Encoding](https://www.ejaugust.com/0.126.4/4lb5kAh4PhZXOKxrM/)
## MVC + MPHF Architecture
kireji can also be used as a complete front-end framework.
Its minimal perfect hash function is highly reactive with a built-in event system
It instantly reflects per-component tweaks to a given model with an extensible model-view-controller (MVC) architecture.
* Each controller is a stateful component (called a <strong>part</strong>) with its own cardinality.
* Parts assemble like LEGO® bricks, with a root part producing a hash representing its entire hierarchy.
* JavaScript's prototype chain enables compositional inheritance between parts.
## DNS-Based Namespacing
When used as a web application front-end framework, each part in a kireji model can be assigned a name that follows DNS semantics so that a web application's URL (such as [www.ejaugust.com](https://www.ejaugust.com)) can be quickly discerned from a runtime reference to one of its parts, such as:
```js
_.app.kireji.www.editor.selected
```
The root part is represented by `_` and is the only global object.
This prevents polluting the global namespace and allows all parts to make absolute reference to each other.
The framework stores its MVC abstracts and MPHF arithmetic under the domain name `"core.parts"`, allowing them to be reached like so:
```js
_.parts.core
```
You can explore this organization in action by going to [www.kireji.app](https://www.kireji.app).
### Further Reading
* [Why DNS?](https://www.ejaugust.com/0.126.4/4lbHaxsKnzRXOKxrM/)
## Live Applications
kireji is in alpha.
To see the technology in action, check out the [demo](https://github.com/kireji-app/demo) repo.
### **Zero Dependencies: A Simpler Equation**
kireji is written entirely with vanilla JavaScript, CSS, and HTML.
No libraries, frameworks, or third-party packages are imported.
This choice was made to preserve full control over the performance of the framework, align as closely as possible with web standards, reduce dependency resolution for applications using kireji, and to offer an opportunity to simplify the equation that defines the system's behavior.
By encoding its own components within its data model, kireji and its surrounding data model can be reasoned about end-to-end, as a self-contained and self-descriptive system.
<!--
## **Current Status**
The following milestones completed:
* Core framework functionality
* CI/CD pipeline
* MPFH for stateless deep linking and data compression
* Reactive front-end framework via MVC + MPFH
* Domain-named architecture ready for DNS integration
* In-platform part inspector
* Node.js server built-in
* Local debugging and development at localhost:3000
* Desktop operating system preview
* Ready-made stateful components with HTML and CSS, such as
- Scroller with custom scroll-bar implementation (more customizable than the native scrollbar)
- Color mode management that automatically computes shades from a given color palette
- Additive parts for mutually exclusive variable assignments
- Multiplicative parts for independent variables
- Movie clip part for animating data models with a dedicated hash for every frame
- Notebook - a blog template
### **Roadmap**
| Phase | Status |
| ---------------------------------------- | ----------- |
| **Minimal Perfect Hashing For Any Data** | Completed |
| **Reacting MVC Framework** | Completed |
| **CI/CD Pipeline** | Completed |
| **Model LTS and Versioning Strategy** | Completed |
| **NPM Packages and Project Generation** | In Progress |
| **Debug Tools, Docs** | In Progress |
| **Operating System Concept** | In Progress |
| **Transfinite State Space** | Planned |
| **Advanced DNS Integration** | Planned |
| **Integrated Development Environment** | Planned |
-->
## Status and License
[](https://www.npmjs.com/kireji)
<br>[](https://www.repostatus.org/#alpha)
<br>[](https://github.com/kireji-app/demo/commits/)
<br>[](https://github.com/kireji-app/demo)
<br>[](http://www.ejaugust.com/)
<br>[](https://github.com/kireji-app/kireji/LICENSE.md)
<br>[](https://github.com/sponsors/EJAugust)