dtoro
d4d99a7473
Problem: the hexagonal refactor churns the backend tree for nine more phases; the UI delivery stack (web/ SPA, cmd/desktop Wails wrapper, compose/web image) must move to its own repo first so doc/layout rewrites land once on a backend-only tree. Change: - New repo git.hubris.network/dtoro/oikos-web (v0.33.0): web/, desktop/ (updateURL repointed to oikos-web releases), compose/, own CI (web + desktop jobs), own deploy script (CI-green gate, TOCTOU guard, version-tagged images, prune-to-3), own webhook receiver on :9798 + launchd unit, own compose project publishing the same 8091:80. - Cutover executed on mac-mini in order: oikos stack's web service stopped+removed, oikos-web project brought up on 8091; outer Caddy untouched (targets the published port) — serving + Authentik flow + /wails 404 quirk verified post-cutover. - Stripped from oikos: web/, cmd/desktop/, compose/web/, desktop CI workflow, ci.yml web job, Makefile ui/desktop/desktop-package/install targets, the compose web service, oikos-web from deploy.sh's fallback prune list; wails + go-keyring dropped from go.mod, vendor synced. - README / CONTRIBUTING / AGENTS.md / .agents dev+operations docs now point at the new repo; mbse + mascot design docs carry a path note. Risk: production SPA serving depends on the new pipeline now; rollback is versioned-image re-up of the old web service from a pre-split checkout (port 8091). Desktop builds installed before the split still check dtoro/oikos releases — one manual reinstall, noted in the oikos-web release notes. Verification: go vet, make test (race), make generate-check, golangci (no new findings; baseline down 400→365); post-cutover curls — localhost:8091 200, /wails/runtime.js 404, outer Caddy 302 Authentik.
112 lines
3.9 KiB
Markdown
112 lines
3.9 KiB
Markdown
# flatted
|
||
|
||
[](https://www.npmjs.com/package/flatted) [](https://coveralls.io/github/WebReflection/flatted?branch=main) [](https://opensource.org/licenses/ISC) 
|
||
|
||
|
||
|
||
<sup>**Social Media Photo by [Matt Seymour](https://unsplash.com/@mattseymour) on [Unsplash](https://unsplash.com/)**</sup>
|
||
|
||
A super light (0.5K) and fast circular JSON parser, directly from the creator of [CircularJSON](https://github.com/WebReflection/circular-json/#circularjson).
|
||
|
||
Available also for **[PHP](./php/flatted.php)**.
|
||
|
||
Available also for **[Python](./python/flatted.py)**.
|
||
|
||
Available also for **[Go](./golang/README.md)**.
|
||
|
||
- - -
|
||
|
||
## ℹ️ JSON only values
|
||
|
||
If you need anything more complex than values JSON understands, there is a standard approach to recursion and more data-types than what JSON allows, and it's part of the [Structured Clone polyfill](https://github.com/ungap/structured-clone/#readme).
|
||
|
||
- - -
|
||
|
||
```js
|
||
npm i flatted
|
||
```
|
||
|
||
Usable via [CDN](https://unpkg.com/flatted) or as regular module.
|
||
|
||
```js
|
||
// ESM
|
||
import {parse, stringify, toJSON, fromJSON} from 'flatted';
|
||
|
||
// CJS
|
||
const {parse, stringify, toJSON, fromJSON} = require('flatted');
|
||
|
||
const a = [{}];
|
||
a[0].a = a;
|
||
a.push(a);
|
||
|
||
stringify(a); // [["1","0"],{"a":"0"}]
|
||
```
|
||
|
||
## toJSON and fromJSON
|
||
|
||
If you'd like to implicitly survive JSON serialization, these two helpers helps:
|
||
|
||
```js
|
||
import {toJSON, fromJSON} from 'flatted';
|
||
|
||
class RecursiveMap extends Map {
|
||
static fromJSON(any) {
|
||
return new this(fromJSON(any));
|
||
}
|
||
toJSON() {
|
||
return toJSON([...this.entries()]);
|
||
}
|
||
}
|
||
|
||
const recursive = new RecursiveMap;
|
||
const same = {};
|
||
same.same = same;
|
||
recursive.set('same', same);
|
||
|
||
const asString = JSON.stringify(recursive);
|
||
const asMap = RecursiveMap.fromJSON(JSON.parse(asString));
|
||
asMap.get('same') === asMap.get('same').same;
|
||
// true
|
||
```
|
||
|
||
|
||
## Flatted VS JSON
|
||
|
||
As it is for every other specialized format capable of serializing and deserializing circular data, you should never `JSON.parse(Flatted.stringify(data))`, and you should never `Flatted.parse(JSON.stringify(data))`.
|
||
|
||
The only way this could work is to `Flatted.parse(Flatted.stringify(data))`, as it is also for _CircularJSON_ or any other, otherwise there's no granted data integrity.
|
||
|
||
Also please note this project serializes and deserializes only data compatible with JSON, so that sockets, or anything else with internal classes different from those allowed by JSON standard, won't be serialized and unserialized as expected.
|
||
|
||
|
||
### New in V1: Exact same JSON API
|
||
|
||
* Added a [reviver](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Syntax) parameter to `.parse(string, reviver)` and revive your own objects.
|
||
* Added a [replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Syntax) and a `space` parameter to `.stringify(object, replacer, space)` for feature parity with JSON signature.
|
||
|
||
|
||
### Compatibility
|
||
All ECMAScript engines compatible with `Map`, `Set`, `Object.keys`, and `Array.prototype.reduce` will work, even if polyfilled.
|
||
|
||
|
||
### How does it work ?
|
||
While stringifying, all Objects, including Arrays, and strings, are flattened out and replaced as unique index. `*`
|
||
|
||
Once parsed, all indexes will be replaced through the flattened collection.
|
||
|
||
<sup><sub>`*` represented as string to avoid conflicts with numbers</sub></sup>
|
||
|
||
```js
|
||
// logic example
|
||
var a = [{one: 1}, {two: '2'}];
|
||
a[0].a = a;
|
||
// a is the main object, will be at index '0'
|
||
// {one: 1} is the second object, index '1'
|
||
// {two: '2'} the third, in '2', and it has a string
|
||
// which will be found at index '3'
|
||
|
||
Flatted.stringify(a);
|
||
// [["1","2"],{"one":1,"a":"0"},{"two":"3"},"2"]
|
||
// a[one,two] {one: 1, a} {two: '2'} '2'
|
||
```
|