@marinoscar/platform-contract 0.0.0-stage → 0.1.0-next.3

package/CHANGELOG.md

@@ -0,0 +1,33 @@
+# @marinoscar/platform-contract
+
+## 0.1.0-next.3
+
+### Minor Changes
+
+- 738d71c: Add `@marinoscar/platform-contract/telemetry` (#702): the telemetry wire shapes (config, status, explorer, connection, stack, dashboard, assistant) and the `telemetry` settings namespace as zod schemas with their inferred types, plus the zod-free limits and enums they are built from, the `/metrics` schema builders for a server with its own metric-group registry, and the settings and connection no-secret proofs. Moved from the reference app's API DTOs and web mirrors without changing a field, a limit or a rule; the generated OpenAPI document is byte-identical.
+- 55a3402: Add the support bundle: `@marinoscar/platform-contract/doctor` (`supportBundleSchema`), `GET <doctor path>/support-bundle` with `SupportBundleRegistry`, `SupportBundleService`, redaction rules v1 and the built-in `meta`, `doctor` and `egress` sections in `@marinoscar/platform-api/doctor`, and the "Download support bundle" button and `useSupportBundleDownload` hook in `@marinoscar/platform-web/doctor` (plus the optional `PlatformApiClient.getBlob`).
+
+### Patch Changes
+
+- bd9ad6f: Add the telemetry slice (`@marinoscar/platform-web/telemetry/headless`, `/telemetry/ui` and a subpath per page): the telemetry settings page, explorer and dashboard with their client, hooks, config provider, route guard, `TelemetryWebAdapters`, `telemetryAdminCards` and the `withTelemetryTokens` theme-token contract. `PlatformApiClient` gains optional request options (`signal`, `ifMatch`), `postBlob` and `postSse`, and `PlatformApiError` an optional `details`; the test host answers all of them. The contract's telemetry README points at the web client's new home.
+
+## 0.1.0-next.2
+
+### Minor Changes
+
+- fd29180: Add `@marinoscar/platform-contract/doctor`, the first contract slice (#701): the Doctor's report, row, status and query schemas, their types and the zod-free status constants. `platform-api`'s Doctor DTOs now wrap these schemas and `platform-web`'s Doctor takes its types from them; both re-export the old names (`DOCTOR_STATUS_ORDER` and `DoctorReportQuery` in `platform-web` are deprecated aliases). No wire or OpenAPI change. Sets the contract conventions (slice layout, zod-free constants, import rules, `schema` catalog kind).
+
+## 0.1.0-next.1
+
+## 0.1.0-next.0
+
+### Minor Changes
+
+- a66fef1: First pre-release of the platform packages: the six-package scaffold (build formats, boundary lint, pack check, TSDoc and generated API reference, single-instance peer dependencies) plus the first slices.
+
+  - `@marinoscar/platform-api/core`: the typed registry primitive (`defineRegistry`, `Registry`, `RegistryError`, `RegistryFreezeService`, `withTemporaryEntries`).
+  - `@marinoscar/platform-api/testing`: the conformance harness (`runPlatformConformance`, `conformanceSuites`) with the `cron-enqueue-only` suite.
+  - `@marinoscar/platform-cli/core`: the CLI command and env-spec fragment registries.
+  - `@marinoscar/platform-cli/telemetry`: the node span relay and the telemetry env-spec fragment.
+  - `@marinoscar/platform-infra`: `infraFile()`, the `platform-infra` command (`sync` materialises fragments into an app) and the `telemetry` slice (collector and GreptimeDB compose fragments, collector config and overlay, typed manifest).
+  - `@marinoscar/platform-contract`, `@marinoscar/platform-web` and `@marinoscar/platform-db` ship their package scaffold only; their slices follow in later releases.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 marinoscar
+
+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/README.md

@@ -1,3 +1,146 @@
-# Temporary Holding Version
+# @marinoscar/platform-contract
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Zod schemas, DTOs and TypeScript types shared by `@marinoscar/platform-api` and `@marinoscar/platform-web`, so the server and the browser validate and type the same shapes. It is the only dual-format package: it ships CommonJS (for the API, which is CommonJS) and ESM (for the web app and the CLI) from one source, selected by the `exports` map.
+
+## Purpose and scope
+
+The request and response shapes of every platform slice, as zod schemas plus the inferred types and plain constants. It holds no runtime behaviour beyond validation: no NestJS, no React, no I/O. The API wraps the schemas as its nestjs-zod DTOs (so the OpenAPI document is generated from them); the web app imports their types and constants. Nothing is described twice by hand.
+
+Slices (each a subpath export with its own README):
+
+| Subpath | What | README |
+|---|---|---|
+| `@marinoscar/platform-contract/doctor` | The admin Doctor's report, row, status and query (#701), and the support bundle envelope (#772) | [src/doctor/README.md](src/doctor/README.md) |
+| `@marinoscar/platform-contract/telemetry` | Telemetry wire shapes, `stable`: config, status, explorer, connection, stack, dashboard, assistant and the `telemetry` settings namespace (#702) | [src/telemetry/README.md](src/telemetry/README.md) |
+
+The root entry exports only `PLATFORM_PACKAGE`; schemas are reached through their slice's subpath, so a consumer loads only the slices it uses.
+
+### Conventions
+
+Every slice follows these rules. The mechanical ones are enforced.
+
+| Rule | Enforced by |
+|---|---|
+| One directory per slice, `src/<slice>/{schemas.ts,constants.ts,index.ts}` plus its `README.md`; subpath export `./<slice>` with an `import` and a `require` condition, each with its own `types` | `test/no-zod-in-constants.test.ts` (layout), `test/dual-format.test.ts` (exports map, both halves load with the same keys), `packages/platform-api/test/slice-graph.spec.ts` (the slice is in `packages/platform-slices.json`), the pack check |
+| `schemas.ts` holds zod schemas named `<thing>Schema` (camelCase) and the inferred types `export type <Thing> = z.infer<typeof <thing>Schema>` (`z.output` where a transform applies) | review, TSDoc catalog |
+| `constants.ts` holds plain readonly values and string-literal unions and never imports zod (nor `schemas.ts`), so a browser that needs only a constant or a type never bundles zod | `test/no-zod-in-constants.test.ts` |
+| `src/` imports zod and its own files only: no `@nestjs/*`, `nestjs-zod`, `react`, `@mui/*`, Node built-in, or other platform package | `no-restricted-imports` block for `packages/platform-contract/src/**` in [`eslint.config.mjs`](../../eslint.config.mjs) (`npm run lint:packages`) |
+| Wire shapes are explicit: a response field that is always present is `.nullable()`, never `.optional()`; dates are ISO strings (`z.iso.datetime()`) | review |
+| Every schema an app may extend is tagged `@extensionPoint schema` and listed in its slice README's catalog | `npm run check:package-docs` |
+| Schemas are extension surface: renaming or removing a field, or narrowing a type, is a breaking change (`major` changeset with a migration note); adding an optional field or a new schema is `minor` | [docs/PACKAGES.md](../../docs/PACKAGES.md#contract-conventions), changeset review |
+| Apps extend in app code with `.extend()` / `.merge()` / `.strict()`; never edit a contract file to add an app field | this README, "Extending a contract in an app" below |
+| A schema moved here from a package keeps its field order, `.describe()` texts and enum order, so the generated OpenAPI document does not change | the OpenAPI diff in the slice's pull request |
+
+### Who depends on it
+
+`@marinoscar/platform-api` and `@marinoscar/platform-web` depend on this package at the lockstep version (a dependency, not a peer: it is part of the platform). `packages/platform-slices.json` records slice edges inside one package only; the package edges are these two, and the contract depends on no platform package.
+
+### Dual format
+
+`npm run build` runs `tsc` twice (`tsconfig.cjs.json` into `dist/cjs`, `tsconfig.esm.json` into `dist/esm`) and writes a `package.json` stub into each half that sets its module format. Each half carries its own `.d.ts` files, so a CommonJS consumer on `moduleResolution: node16` never sees ESM-format declarations. `"sideEffects": false` lets a bundler drop a slice's `schemas.ts` (and zod) when only its constants and types are used.
+
+## Install and peer dependencies
+
+```bash
+npm install @marinoscar/platform-contract zod
+```
+
+Install these in the app; the package never bundles its own copy (a second copy of zod breaks `instanceof ZodError` across the boundary).
+
+| Package | Range |
+|---|---|
+| `zod` | `^4.4.3` |
+
+An app that uses `@marinoscar/platform-api` or `@marinoscar/platform-web` gets this package with them, but still installs `zod` itself.
+
+## Quick start
+
+Validate with a slice's schema, or use its types:
+
+```ts
+import { doctorReportSchema } from '@marinoscar/platform-contract/doctor';
+import type { DoctorReport } from '@marinoscar/platform-contract/doctor';
+
+const report: DoctorReport = doctorReportSchema.parse(body.data);
+```
+
+In browser code, import types with `import type` and constants only, so zod stays out of the bundle.
+
+### Extending a contract in an app
+
+An app that needs more than the contract says extends the schema in its own code; it never edits a contract file:
+
+```ts
+import { doctorCheckReportSchema, doctorReportSchema } from '@marinoscar/platform-contract/doctor';
+import { z } from 'zod';
+
+// Stricter: refuse any field the contract does not declare.
+const exactReportSchema = doctorReportSchema
+  .extend({ checks: z.array(doctorCheckReportSchema.strict()) })
+  .strict();
+
+// Wider: an app-only field on its own rows.
+const ownedRowSchema = doctorCheckReportSchema.extend({ owner: z.string() });
+type OwnedRow = z.infer<typeof ownedRowSchema>;
+```
+
+The reference app's Doctor integration test uses the first form ([`doctor.integration.spec.ts`](../../apps/api/test/doctor/doctor.integration.spec.ts)). A field every app needs belongs in the contract: file a seam request.
+
+## Configuration
+
+None. Schemas take no options; the routes that use them are configured in `@marinoscar/platform-api`.
+
+## Extension-point catalog
+
+None. The root entry exports only `PLATFORM_PACKAGE`; every schema is an extension point of its slice and is catalogued in that slice's README (`schema` kind), for example [the Doctor's](src/doctor/README.md#extension-point-catalog).
+
+## Data
+
+None. The package holds schemas of HTTP payloads, not database models; models live in `@marinoscar/platform-db`.
+
+## Permissions and settings
+
+None. Schemas declare no permission or setting; the API slices that use them do.
+
+## UI
+
+None. The package renders nothing; `@marinoscar/platform-web` imports its types and constants.
+
+## Infra
+
+None. The package ships no deployment configuration and reads no environment variable. The API and web images copy and build it before the package that depends on it.
+
+## Observability
+
+None. Validation is pure; the API and web packages log and trace around it.
+
+## Security notes
+
+Schemas are the single source of input validation for both sides. Never loosen a schema in an app to accept a payload the API rejects; file a seam request instead. A schema documents which fields never carry secret material, but cannot enforce it; the slice that fills the payload does.
+
+## Conformance suite
+
+None yet. The package ships no conformance suite; `runPlatformConformance()` and the suites arrive with the platform's conformance harness. Its own tests (`test/`) cover every slice's schemas and both module formats.
+
+## Upgrade notes
+
+What counts as breaking, for every slice: renaming or removing a field, making an optional field required, narrowing a type (a smaller enum, a stricter pattern), changing a nullable field to optional or the reverse, or changing what a transform outputs. Each is a `major` changeset with a migration note. Adding an optional request field, a new response field an app can ignore, or a new schema or slice is `minor`.
+
+- #701: first slice, `./doctor`. The Doctor's schemas moved here from `@marinoscar/platform-api/doctor` and its types from `@marinoscar/platform-web/doctor/headless`; both packages re-export the old names. No wire or OpenAPI change.
+- #702: `./telemetry`. The telemetry wire shapes moved here from the API's telemetry DTOs and the web's hand-written mirrors; both keep their old names. No wire or OpenAPI change.
+
+## Troubleshooting
+
+- **`Cannot find module '@marinoscar/platform-contract/<slice>'`.** The package is not built (`npm run build:packages` builds it first), or the slice is missing from the `exports` map.
+- **`ERR_REQUIRE_ESM` or `exports is not defined` at load.** A `dist/<cjs|esm>/package.json` stub is missing; rebuild (`scripts/write-dist-stubs.mjs` writes them).
+- **zod appears in the web bundle.** Browser code imports a schema at run time; switch to `import type` and the slice's constants.
+
+Build and import problems common to every platform package are in [DEVELOPMENT.md § Platform packages](../../docs/DEVELOPMENT.md#platform-packages).
+
+## Links
+
+- [Platform packages spec](../../docs/specs/platform-packages.md): the extension contract and the package documentation standard
+- [Package documentation standard and checks](../../docs/PACKAGES.md): how this README, the TSDoc and the catalog are checked, and the contract conventions summary
+- [DEVELOPMENT.md § Platform packages](../../docs/DEVELOPMENT.md#platform-packages): build, test and lint commands
+- [Doctor slice](src/doctor/README.md)
+- [Telemetry slice](src/telemetry/README.md)

package/dist/cjs/doctor/constants.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Every status of a Doctor check, in severity order, lowest first
+ * (`pass < skip < warn < fail`). Also the display order of the web page.
+ *
+ * - `pass`: verified healthy.
+ * - `skip`: not evaluated (a check it depends on did not pass, or the
+ *   capability is intentionally switched off).
+ * - `warn`: works, but needs attention.
+ * - `fail`: broken.
+ *
+ * @stability stable
+ */
+export declare const DOCTOR_STATUSES: readonly ["pass", "skip", "warn", "fail"];
+/**
+ * The four outcomes of a check, identical to the CLI doctor's `CheckStatus`:
+ * `pass`, `warn`, `fail` or `skip`.
+ *
+ * @stability stable
+ */
+export type DoctorStatus = (typeof DOCTOR_STATUSES)[number];
+/**
+ * How bad a status is, for a report's overall verdict: the worst wins.
+ *
+ * `skip` ranks just above `pass`: a report whose only non-pass entries are
+ * intentional skips (AI off, telemetry off) is healthy, but it proved less than
+ * an all-pass one, and a report where nothing ran must not read as `pass`.
+ *
+ * @stability stable
+ */
+export declare const DOCTOR_STATUS_RANK: Readonly<Record<DoctorStatus, number>>;
+/**
+ * The version of the support bundle format (`GET /api/admin/doctor/support-bundle`,
+ * issue #772). Bumped only by a breaking change to `supportBundleSchema`.
+ *
+ * @stability experimental
+ */
+export declare const SUPPORT_BUNDLE_VERSION: 1;
+/**
+ * The redaction rule set applied to every support bundle. `v1` is documented
+ * in docs/specs/doctor.md ("Support bundle").
+ *
+ * @stability experimental
+ */
+export declare const SUPPORT_BUNDLE_REDACTION_RULES: "v1";
+/**
+ * The statuses of one support-bundle section: `ok` (collected), `omitted` (not
+ * collected: a permission is missing or the capability is off) and `error`
+ * (the section threw, timed out or broke its schema; its data is dropped).
+ *
+ * @stability experimental
+ */
+export declare const SUPPORT_BUNDLE_SECTION_STATUSES: readonly ["ok", "omitted", "error"];
+/**
+ * One support-bundle section's status.
+ *
+ * @stability experimental
+ */
+export type SupportBundleSectionStatus = (typeof SUPPORT_BUNDLE_SECTION_STATUSES)[number];
+//# sourceMappingURL=constants.d.ts.map

package/dist/cjs/doctor/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/doctor/constants.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,2CAA4C,CAAC;AAEzE;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE5D;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAKrE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,EAAG,CAAU,CAAC;AAEjD;;;;;GAKG;AACH,eAAO,MAAM,8BAA8B,EAAG,IAAa,CAAC;AAE5D;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B,qCAAsC,CAAC;AAEnF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,OAAO,+BAA+B,CAAC,CAAC,MAAM,CAAC,CAAC"}

package/dist/cjs/doctor/constants.js

@@ -0,0 +1,57 @@
+"use strict";
+// The Doctor's plain values (issue #701). Zod-free by rule: a browser that only
+// needs a status list or a type never pulls the schemas, and with them zod,
+// into its bundle (test/no-zod-in-constants.test.ts).
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SUPPORT_BUNDLE_SECTION_STATUSES = exports.SUPPORT_BUNDLE_REDACTION_RULES = exports.SUPPORT_BUNDLE_VERSION = exports.DOCTOR_STATUS_RANK = exports.DOCTOR_STATUSES = void 0;
+/**
+ * Every status of a Doctor check, in severity order, lowest first
+ * (`pass < skip < warn < fail`). Also the display order of the web page.
+ *
+ * - `pass`: verified healthy.
+ * - `skip`: not evaluated (a check it depends on did not pass, or the
+ *   capability is intentionally switched off).
+ * - `warn`: works, but needs attention.
+ * - `fail`: broken.
+ *
+ * @stability stable
+ */
+exports.DOCTOR_STATUSES = ['pass', 'skip', 'warn', 'fail'];
+/**
+ * How bad a status is, for a report's overall verdict: the worst wins.
+ *
+ * `skip` ranks just above `pass`: a report whose only non-pass entries are
+ * intentional skips (AI off, telemetry off) is healthy, but it proved less than
+ * an all-pass one, and a report where nothing ran must not read as `pass`.
+ *
+ * @stability stable
+ */
+exports.DOCTOR_STATUS_RANK = {
+    pass: 0,
+    skip: 1,
+    warn: 2,
+    fail: 3,
+};
+/**
+ * The version of the support bundle format (`GET /api/admin/doctor/support-bundle`,
+ * issue #772). Bumped only by a breaking change to `supportBundleSchema`.
+ *
+ * @stability experimental
+ */
+exports.SUPPORT_BUNDLE_VERSION = 1;
+/**
+ * The redaction rule set applied to every support bundle. `v1` is documented
+ * in docs/specs/doctor.md ("Support bundle").
+ *
+ * @stability experimental
+ */
+exports.SUPPORT_BUNDLE_REDACTION_RULES = 'v1';
+/**
+ * The statuses of one support-bundle section: `ok` (collected), `omitted` (not
+ * collected: a permission is missing or the capability is off) and `error`
+ * (the section threw, timed out or broke its schema; its data is dropped).
+ *
+ * @stability experimental
+ */
+exports.SUPPORT_BUNDLE_SECTION_STATUSES = ['ok', 'omitted', 'error'];
+//# sourceMappingURL=constants.js.map

package/dist/cjs/doctor/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/doctor/constants.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,4EAA4E;AAC5E,sDAAsD;;;AAEtD;;;;;;;;;;;GAWG;AACU,QAAA,eAAe,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAU,CAAC;AAUzE;;;;;;;;GAQG;AACU,QAAA,kBAAkB,GAA2C;IACxE,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC;CACR,CAAC;AAEF;;;;;GAKG;AACU,QAAA,sBAAsB,GAAG,CAAU,CAAC;AAEjD;;;;;GAKG;AACU,QAAA,8BAA8B,GAAG,IAAa,CAAC;AAE5D;;;;;;GAMG;AACU,QAAA,+BAA+B,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,CAAU,CAAC"}

package/dist/cjs/doctor/index.d.ts

@@ -0,0 +1,5 @@
+export { DOCTOR_STATUSES, DOCTOR_STATUS_RANK, SUPPORT_BUNDLE_REDACTION_RULES, SUPPORT_BUNDLE_SECTION_STATUSES, SUPPORT_BUNDLE_VERSION, } from './constants.js';
+export type { DoctorStatus, SupportBundleSectionStatus } from './constants.js';
+export { doctorCheckReportSchema, doctorQuerySchema, doctorReportSchema, doctorStatusSchema, supportBundleSchema, supportBundleSectionResultSchema, } from './schemas.js';
+export type { DoctorBooleanStringEnum, DoctorCheckReport, DoctorQuery, DoctorReport, DoctorReportQueryInput, DoctorStatusEnum, SupportBundle, SupportBundleSectionResult, } from './schemas.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/doctor/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/doctor/index.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,8BAA8B,EAC9B,+BAA+B,EAC/B,sBAAsB,GACvB,MAAM,gBAAgB,CAAC;AACxB,YAAY,EAAE,YAAY,EAAE,0BAA0B,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,gCAAgC,GACjC,MAAM,cAAc,CAAC;AACtB,YAAY,EACV,uBAAuB,EACvB,iBAAiB,EACjB,WAAW,EACX,YAAY,EACZ,sBAAsB,EACtB,gBAAgB,EAChB,aAAa,EACb,0BAA0B,GAC3B,MAAM,cAAc,CAAC"}

package/dist/cjs/doctor/index.js

@@ -0,0 +1,24 @@
+"use strict";
+// `@marinoscar/platform-contract/doctor`: the Doctor's wire shapes, shared by
+// `@marinoscar/platform-api/doctor` (the DTOs) and
+// `@marinoscar/platform-web/doctor` (the client's types) (issue #701).
+// Documented in ./README.md. Explicit named exports only.
+//
+// constants.ts is zod-free; a consumer that imports only the constants and the
+// types (the web app) never bundles schemas.ts or zod (`"sideEffects": false`).
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.supportBundleSectionResultSchema = exports.supportBundleSchema = exports.doctorStatusSchema = exports.doctorReportSchema = exports.doctorQuerySchema = exports.doctorCheckReportSchema = exports.SUPPORT_BUNDLE_VERSION = exports.SUPPORT_BUNDLE_SECTION_STATUSES = exports.SUPPORT_BUNDLE_REDACTION_RULES = exports.DOCTOR_STATUS_RANK = exports.DOCTOR_STATUSES = void 0;
+var constants_js_1 = require("./constants.js");
+Object.defineProperty(exports, "DOCTOR_STATUSES", { enumerable: true, get: function () { return constants_js_1.DOCTOR_STATUSES; } });
+Object.defineProperty(exports, "DOCTOR_STATUS_RANK", { enumerable: true, get: function () { return constants_js_1.DOCTOR_STATUS_RANK; } });
+Object.defineProperty(exports, "SUPPORT_BUNDLE_REDACTION_RULES", { enumerable: true, get: function () { return constants_js_1.SUPPORT_BUNDLE_REDACTION_RULES; } });
+Object.defineProperty(exports, "SUPPORT_BUNDLE_SECTION_STATUSES", { enumerable: true, get: function () { return constants_js_1.SUPPORT_BUNDLE_SECTION_STATUSES; } });
+Object.defineProperty(exports, "SUPPORT_BUNDLE_VERSION", { enumerable: true, get: function () { return constants_js_1.SUPPORT_BUNDLE_VERSION; } });
+var schemas_js_1 = require("./schemas.js");
+Object.defineProperty(exports, "doctorCheckReportSchema", { enumerable: true, get: function () { return schemas_js_1.doctorCheckReportSchema; } });
+Object.defineProperty(exports, "doctorQuerySchema", { enumerable: true, get: function () { return schemas_js_1.doctorQuerySchema; } });
+Object.defineProperty(exports, "doctorReportSchema", { enumerable: true, get: function () { return schemas_js_1.doctorReportSchema; } });
+Object.defineProperty(exports, "doctorStatusSchema", { enumerable: true, get: function () { return schemas_js_1.doctorStatusSchema; } });
+Object.defineProperty(exports, "supportBundleSchema", { enumerable: true, get: function () { return schemas_js_1.supportBundleSchema; } });
+Object.defineProperty(exports, "supportBundleSectionResultSchema", { enumerable: true, get: function () { return schemas_js_1.supportBundleSectionResultSchema; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/doctor/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/doctor/index.ts"],"names":[],"mappings":";AAAA,8EAA8E;AAC9E,mDAAmD;AACnD,uEAAuE;AACvE,0DAA0D;AAC1D,EAAE;AACF,+EAA+E;AAC/E,gFAAgF;;;AAEhF,+CAMwB;AALtB,+GAAA,eAAe,OAAA;AACf,kHAAA,kBAAkB,OAAA;AAClB,8HAAA,8BAA8B,OAAA;AAC9B,+HAAA,+BAA+B,OAAA;AAC/B,sHAAA,sBAAsB,OAAA;AAGxB,2CAOsB;AANpB,qHAAA,uBAAuB,OAAA;AACvB,+GAAA,iBAAiB,OAAA;AACjB,gHAAA,kBAAkB,OAAA;AAClB,gHAAA,kBAAkB,OAAA;AAClB,iHAAA,mBAAmB,OAAA;AACnB,8HAAA,gCAAgC,OAAA"}

package/dist/cjs/doctor/schemas.d.ts

@@ -0,0 +1,186 @@
+import { z } from 'zod';
+import type { DoctorStatus } from './constants.js';
+/**
+ * The entries of {@link doctorStatusSchema}, as `z.enum` types them: each
+ * status keyed by itself. Named so the schema's type reads as a reference.
+ *
+ * @stability stable
+ */
+export type DoctorStatusEnum = {
+    [S in DoctorStatus]: S;
+};
+/**
+ * The entries of the `refresh` query parameter: the strings `'true'` and
+ * `'false'`, each keyed by itself, as `z.enum` types them.
+ *
+ * @stability stable
+ */
+export type DoctorBooleanStringEnum = {
+    [S in 'true' | 'false']: S;
+};
+/**
+ * A check's status on the wire.
+ *
+ * The enum lists the values in the order the OpenAPI document has always
+ * published (`pass, warn, fail, skip`), which is not the severity order of
+ * {@link DOCTOR_STATUSES}; rank statuses with {@link DOCTOR_STATUS_RANK}.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const doctorStatusSchema: z.ZodEnum<DoctorStatusEnum>;
+/**
+ * One row of the report, as `GET /api/admin/doctor` returns it.
+ *
+ * Fields: `id` (stable dotted id, `storage.bucket`), `category` (`core`,
+ * `auth`, ...; an app may add its own), `label`, `settingsPath` (the web route
+ * that fixes it, or `null`), `status`, `detail` (one line: what was found),
+ * `remedy` (set on `warn` and `fail`, otherwise `null`), `error` (the
+ * underlying probe error, or `null`), `data` (small scalar facts, never secret
+ * material, or `null`) and `durationMs` (0 when skipped without running).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const doctorCheckReportSchema: z.ZodObject<{
+    id: z.ZodString;
+    category: z.ZodString;
+    label: z.ZodString;
+    settingsPath: z.ZodNullable<z.ZodString>;
+    status: z.ZodEnum<DoctorStatusEnum>;
+    detail: z.ZodString;
+    remedy: z.ZodNullable<z.ZodString>;
+    error: z.ZodNullable<z.ZodString>;
+    data: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+    durationMs: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * The whole report, as `GET /api/admin/doctor` returns it: `verdict` (the
+ * worst status in `checks`, `skip` when none ran), `generatedAt` (ISO 8601; a
+ * cached report keeps its original time), `durationMs` (wall time of the run)
+ * and `checks` (sorted by category, configured order first, then registration
+ * order).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const doctorReportSchema: z.ZodObject<{
+    verdict: z.ZodEnum<DoctorStatusEnum>;
+    generatedAt: z.ZodISODateTime;
+    durationMs: z.ZodNumber;
+    checks: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        category: z.ZodString;
+        label: z.ZodString;
+        settingsPath: z.ZodNullable<z.ZodString>;
+        status: z.ZodEnum<DoctorStatusEnum>;
+        detail: z.ZodString;
+        remedy: z.ZodNullable<z.ZodString>;
+        error: z.ZodNullable<z.ZodString>;
+        data: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+        durationMs: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * `GET /api/admin/doctor` query: `category` (a lowercase identifier; only the
+ * checks in that category, plus, unreported, whatever they depend on) and
+ * `refresh` (`'true'` bypasses the 15-second report cache).
+ *
+ * `refresh` is `z.enum(['true','false']).transform(...)` and NOT
+ * `z.coerce.boolean()`: every query parameter is a string and
+ * `Boolean('false')` is `true`.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const doctorQuerySchema: z.ZodObject<{
+    category: z.ZodOptional<z.ZodString>;
+    refresh: z.ZodOptional<z.ZodPipe<z.ZodEnum<DoctorBooleanStringEnum>, z.ZodTransform<boolean, "true" | "false">>>;
+}, z.core.$strip>;
+/**
+ * One row of the report. Every nullable field is present on every row.
+ *
+ * @stability stable
+ */
+export type DoctorCheckReport = z.infer<typeof doctorCheckReportSchema>;
+/**
+ * The whole report.
+ *
+ * @stability stable
+ */
+export type DoctorReport = z.infer<typeof doctorReportSchema>;
+/**
+ * The parsed query of `GET /api/admin/doctor` (`refresh` already a boolean).
+ *
+ * @stability stable
+ */
+export type DoctorQuery = z.output<typeof doctorQuerySchema>;
+/**
+ * The query a client builds before serializing it: restrict the run to one
+ * `category`, or `refresh` to bypass the server-side cache.
+ *
+ * @stability stable
+ */
+export interface DoctorReportQueryInput {
+    /** Restrict the run to one category (a lowercase identifier). */
+    category?: string;
+    /** Bypass the server-side report cache and run every probe again. */
+    refresh?: boolean;
+}
+/**
+ * One section of a bundle. `truncated: true` with `data: null` means the
+ * section was larger than its size cap and its data was dropped.
+ *
+ * @extensionPoint schema
+ * @stability experimental
+ */
+export declare const supportBundleSectionResultSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    status: z.ZodLiteral<"ok">;
+    data: z.ZodUnknown;
+    truncated: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>, z.ZodObject<{
+    status: z.ZodLiteral<"omitted">;
+    reason: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    status: z.ZodLiteral<"error">;
+    error: z.ZodString;
+}, z.core.$strip>], "status">;
+/**
+ * One section of a bundle, as parsed.
+ *
+ * @stability experimental
+ */
+export type SupportBundleSectionResult = z.infer<typeof supportBundleSectionResultSchema>;
+/**
+ * The support bundle: what `GET /api/admin/doctor/support-bundle` returns as a
+ * JSON attachment.
+ *
+ * @extensionPoint schema
+ * @stability experimental
+ */
+export declare const supportBundleSchema: z.ZodObject<{
+    bundleVersion: z.ZodLiteral<1>;
+    generatedAt: z.ZodString;
+    redaction: z.ZodObject<{
+        rules: z.ZodLiteral<"v1">;
+        replacements: z.ZodNumber;
+    }, z.core.$strip>;
+    sections: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUnion<[z.ZodObject<{
+        status: z.ZodLiteral<"ok">;
+        data: z.ZodUnknown;
+        truncated: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>, z.ZodObject<{
+        status: z.ZodLiteral<"omitted">;
+        reason: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        status: z.ZodLiteral<"error">;
+        error: z.ZodString;
+    }, z.core.$strip>], "status">>;
+}, z.core.$strip>;
+/**
+ * The support bundle, as parsed.
+ *
+ * @stability experimental
+ */
+export type SupportBundle = z.infer<typeof supportBundleSchema>;
+//# sourceMappingURL=schemas.d.ts.map

package/dist/cjs/doctor/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../src/doctor/schemas.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAGnD;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG;KAAG,CAAC,IAAI,YAAY,GAAG,CAAC;CAAE,CAAC;AAE1D;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG;KAAG,CAAC,IAAI,MAAM,GAAG,OAAO,GAAG,CAAC;CAAE,CAAC;AAErE;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAMxD,CAAC;AAEJ;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;iBAqBlC,CAAC;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;iBAS7B,CAAC;AAKH;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB;;;iBAU5B,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE7D;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAkBD;;;;;;GAMG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;6BAqB3C,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAE1F;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;iBAkB9B,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC"}