@dudousxd/nestjs-catalog 0.16.0 → 0.17.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Davide Carvalho
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/catalog.workspace.d.ts

@@ -302,8 +302,30 @@ export interface CatalogTraceSpan {
      * second answer to a question that already has one.
      */
     principalId?: string;
-    /** The event payload, verbatim — the same bytes the flat trail shows. */
-    detail: Record<string, unknown>;
+    /**
+     * The event payload, verbatim — the same bytes the flat trail shows.
+     *
+     * Optional, and which call you made decides whether it is there:
+     * {@link CatalogTraceStore.getTrace} carries it, {@link
+     * CatalogTraceStore.listTraces} does not.
+     *
+     * The asymmetry is the whole point. A payload is arbitrary JSON of unbounded
+     * width, and a page of traces carries every span of every trace on it — a
+     * real 50-trace page measured 28,022 spans, of which the payloads alone were
+     * 4.3 MB of a 10.4 MB answer, read from the database, parsed, and serialised
+     * again on a screen that re-polls every ten seconds. None of it was drawn:
+     * the list renders a waterfall, which needs when each event happened and
+     * whether it failed, and the payload is read only when somebody expands a
+     * trace — at which point there is exactly one trace to fetch it for.
+     *
+     * So the list is not missing anything it showed before. `failed` and `error`
+     * are still derived from the payload, in the database rather than from these
+     * bytes, and a consumer that needs the payload asks `getTrace` for the one
+     * trace it needs it for. Guard it rather than assuming it: a `??  {}` on a
+     * list span is correct, and dereferencing it is the one thing this shape
+     * makes unsafe.
+     */
+    detail?: Record<string, unknown>;
     occurredAt: string;
     /** Milliseconds from the first event of the trace. Where the bar starts. */
     offsetMs: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dudousxd/nestjs-catalog",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "A metadata registry for NestJS: object types, properties and relations, derived from your ORM and enriched with decorators.",
   "license": "MIT",
   "author": "Davide Carvalho",
@@ -30,10 +30,6 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsc -p tsconfig.json",
-    "dev": "tsc -p tsconfig.json --watch"
-  },
   "peerDependencies": {
     "@mikro-orm/core": ">=6",
     "@nestjs/common": ">=10",
@@ -50,5 +46,9 @@
   },
   "dependencies": {
     "@dudousxd/nestjs-diagnostics": "0.7.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "dev": "tsc -p tsconfig.json --watch"
   }
-}
+}