Diagnosability
- The 0.3.0 release exists because of this. A mapping layer that loses your data and reports + The 0.3.0 release existed because of this. A mapping layer that loses your data and reports success is worse than one that stops, so every silent failure found in the engine was turned into an error that names the cause and the way out.
@@ -663,7 +665,8 @@ Break the cycle with @JsonIgnore() on the back-reference, or supply acereale reads the metadata that only a standard decorator transform emits, so - which compiler you use decides whether it works at all. The three โ rows are executed by a + which compiler you use decides whether it works at all. The three โ rows in the first table are + executed by a test on every CI run rather than asserted here โ each one compiles a decorated class with that tool and checks the metadata arrived. The โ row cannot be: oxc ships inside a native binary with no standalone transform API, so it was established by hand, and the plugin below @@ -678,7 +681,7 @@ Break the cycle with @JsonIgnore() on the back-reference, or supply a
tscexperimentalDecorators: false, target: ES2022+tsc 5.2+experimentalDecorators: false, target: ES2022+experimentalDecorators: false via tsconfigRaw, plus esbuild's own top-level target: es2022 โ its default esnext leaves the decorators in placejsc.transform.decoratorVersion: "2022-03"experimentalDecorators to false โ Angular does not need ittsctscemitDecoratorMetadata; same precompiled routeemitDecoratorMetadata; same precompiled route- Each of these was set up and run before it was written down. + Each of these was set up and run before it was written down, on 2026-08-05, against the + versions listed. FRAMEWORKS.md has the full recipe for every one, including the two that need the precompiled route.
@@ -740,7 +744,7 @@ export default defineConfig({Getting started
-not on npm yet installing it today
git clone https://github.com/Avalon-Vanguard/cereale
+ git clone https://github.com/avalon-vanguard/cereale
cd cereale
npm install && npm run build
-npm pack # โ cereale-0.3.0.tgz
+npm pack # โ cereale-0.4.0.tgz
# then, from your own project
-npm install ../cereale/cereale-0.3.0.tgz
+npm install ../cereale/cereale-0.4.0.tgz
npm install cereale does not resolve to
@@ -784,6 +788,95 @@ npm install ../cereale/cereale-0.3.0.tgz
+ cereale/min is the whole library flattened into one
+ minified ES module โ 33.9 KB, 9.6 KB gzipped โ for import maps,
+ a bare <script type="module">, Deno and Workers.
+
<script type="importmap">
+ { "imports": { "cereale": "./node_modules/cereale/dist/cereale.min.js" } }
+</script>
+<script type="module">
+ import { IsString, toInstanceSync } from 'cereale';
+</script>+ If you are using a bundler, do not use it. It is the whole library in one + file, so nothing can be dropped from it. The default entry point tree-shakes; this one + cannot, because there is nothing left to shake. +
+Bundle size
++ Sixty-eight decorators is a lot to ship to a browser, so none of the ones you did not + import are shipped. Minified bytes, measured through all three bundlers. +
+| What you import | +esbuild | rollup | webpack | +
|---|---|---|---|
flattenErrors | 394 | 367 | 394 |
| one decorator | 1,837 | 1,823 | 1,818 |
validateSync | 3,722 | 3,554 | 3,738 |
toPlainSync | 7,744 | 7,769 | 7,771 |
toInstanceSync | 7,900 | 7,942 | 7,944 |
| a typical DTO | 10,395 | 10,402 | 10,360 |
| the whole library | 26,266 | 25,671 | 26,879 |
+ Import toInstanceSync and you do not pay for the
+ serializer. The validator stays in both, because
+ validate defaults to
+ true โ a real reference, not a missed optimisation.
+
+ Every rule is a top-level call. rollup proves such a call side-effect-free by reading
+ the factory; esbuild and webpack will not. Without a
+ /*#__PURE__*/ on each, one decorator cost
+ 4,909 bytes instead of 1,837. Nothing failed โ the library was just
+ three times heavier in every bundle, and the only way to find out was to measure.
+
+ It was already producing 1,823 bytes and hid the problem. That is the argument for + measuring through more than one bundler, and it is why + a test + now pins the property rather than the prose. +
+0.3.0 lives in the repository. npm install cereale does not
+
0.4.0 lives in the repository. npm install cereale does not
resolve to this library โ build it from source until it is published.