@stacknext/core 0.11.0 → 0.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +49 -3
- package/dist/types.d.ts +1 -1
- package/dist/types.js +1 -1
- package/docs/redaction.md +1 -1
- package/docs/schemas.md +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
# @stacknext/core
|
|
2
2
|
|
|
3
3
|
Core wire types, Zod schemas, redaction, configuration, framework span metadata,
|
|
4
|
-
bounded in-memory storage
|
|
4
|
+
bounded in-memory storage, async transport and snapshot storage for
|
|
5
|
+
[StackNext](https://github.com/marrrkkk/stacknext).
|
|
5
6
|
|
|
6
7
|
This package is the shared foundation for the StackNext CLI, adapters and app
|
|
7
8
|
instrumentation. Most applications should install `@stacknext/cli` and
|
|
@@ -13,7 +14,52 @@ npx stacknext init
|
|
|
13
14
|
npx stacknext dev
|
|
14
15
|
```
|
|
15
16
|
|
|
16
|
-
|
|
17
|
-
|
|
17
|
+
## Entry points
|
|
18
|
+
|
|
19
|
+
| Import | Contents |
|
|
20
|
+
| --- | --- |
|
|
21
|
+
| `@stacknext/core` | Wire types, Zod schemas, redaction, normalization, bounded store, framework span allowlist, coverage, diagnostic wire types, config, verbose status. |
|
|
22
|
+
| `@stacknext/core/transport` | Process-wide bounded transport, environment resolution and loopback validation. |
|
|
23
|
+
| `@stacknext/core/config-file` | `stacknext.config.json` path, reading and loading with Zod validation. |
|
|
24
|
+
| `@stacknext/core/snapshots` | Snapshot payloads, atomic local storage, listing, import/export and detached read views. |
|
|
25
|
+
| `@stacknext/core/package.json` | Installed version metadata. |
|
|
26
|
+
|
|
27
|
+
## Package boundary
|
|
28
|
+
|
|
29
|
+
`core` is the base of the dependency graph. It must not import CLI, Next.js,
|
|
30
|
+
React, Playwright or adapter code. It validates external data at the boundary,
|
|
31
|
+
performs both redaction layers' shared primitives, and never performs network
|
|
32
|
+
I/O unless a loopback collector URL and token are supplied.
|
|
33
|
+
|
|
34
|
+
## Documentation
|
|
35
|
+
|
|
36
|
+
- [Package overview](docs/index.md)
|
|
37
|
+
- [Wire schemas](docs/schemas.md)
|
|
38
|
+
- [Transport](docs/transport.md)
|
|
39
|
+
- [Redaction](docs/redaction.md)
|
|
40
|
+
- [Configuration](docs/configuration.md)
|
|
41
|
+
- [Snapshots](docs/snapshots.md)
|
|
42
|
+
|
|
43
|
+
The `docs/` directory ships in the npm archive and matches the installed
|
|
44
|
+
version. Public concepts live on the
|
|
45
|
+
[documentation site](https://github.com/marrrkkk/stacknext/tree/main/apps/docs).
|
|
46
|
+
|
|
47
|
+
## AI agents
|
|
48
|
+
|
|
49
|
+
Agents should read `docs/index.md` and the focused package pages from the
|
|
50
|
+
installed archive before changing wire fields, limits or redaction. The package
|
|
51
|
+
does not call a model and does not expose an MCP surface; the read-only server
|
|
52
|
+
is in `@stacknext/mcp`.
|
|
53
|
+
|
|
54
|
+
## Development
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
pnpm --filter @stacknext/core build
|
|
58
|
+
pnpm --filter @stacknext/core typecheck
|
|
59
|
+
pnpm test
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
This package is ESM-only, requires Node.js 20.9 or newer and is published as an
|
|
63
|
+
internal dependency of the StackNext CLI and integrations.
|
|
18
64
|
|
|
19
65
|
License: MIT.
|
package/dist/types.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { StackNextConfig } from './config.js';
|
|
2
2
|
import type { DiagnosticOverview, DiagnosticReference, DiagnosticReport } from './diagnostics.js';
|
|
3
3
|
export declare const STACKNEXT_SCHEMA_VERSION = 1;
|
|
4
|
-
export declare const STACKNEXT_SDK_VERSION = "0.11.
|
|
4
|
+
export declare const STACKNEXT_SDK_VERSION = "0.11.1";
|
|
5
5
|
export declare const SPAN_KINDS: readonly ["internal", "server", "client", "producer", "consumer"];
|
|
6
6
|
export type StackNextSpanKind = (typeof SPAN_KINDS)[number];
|
|
7
7
|
export declare const SPAN_STATUSES: readonly ["unset", "ok", "error"];
|
package/dist/types.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export const STACKNEXT_SCHEMA_VERSION = 1;
|
|
2
|
-
export const STACKNEXT_SDK_VERSION = '0.11.
|
|
2
|
+
export const STACKNEXT_SDK_VERSION = '0.11.1';
|
|
3
3
|
export const SPAN_KINDS = ['internal', 'server', 'client', 'producer', 'consumer'];
|
|
4
4
|
export const SPAN_STATUSES = ['unset', 'ok', 'error'];
|
|
5
5
|
export const DATABASE_SOURCES = ['drizzle', 'prisma', 'manual'];
|
package/docs/redaction.md
CHANGED
|
@@ -99,6 +99,6 @@ A new captured field is not complete until:
|
|
|
99
99
|
|
|
100
100
|
1. the app-side producer redacts it;
|
|
101
101
|
2. the collector validates and redacts it again;
|
|
102
|
-
3. `docs/privacy.md` and the package docs describe it;
|
|
102
|
+
3. `apps/docs/privacy.md` and the package docs describe it;
|
|
103
103
|
4. a test asserts that known secrets do not appear in API, export, regression
|
|
104
104
|
or snapshot output.
|
package/docs/schemas.md
CHANGED
|
@@ -150,5 +150,5 @@ read `meta.completeness` or response `limitations` before drawing conclusions.
|
|
|
150
150
|
correlation.
|
|
151
151
|
- Redaction runs before enqueueing and again before storage.
|
|
152
152
|
|
|
153
|
-
See [redaction](redaction.md) and the
|
|
154
|
-
|
|
153
|
+
See [redaction](redaction.md) and the repository `apps/docs/privacy.md` for the
|
|
154
|
+
data boundary.
|