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

package/dist/esm/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/esm/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/esm/doctor/constants.js

@@ -0,0 +1,54 @@
+// 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).
+/**
+ * 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 const 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
+ */
+export const 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
+ */
+export 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 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 const SUPPORT_BUNDLE_SECTION_STATUSES = ['ok', 'omitted', 'error'];
+//# sourceMappingURL=constants.js.map

package/dist/esm/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;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAU,CAAC;AAUzE;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAA2C;IACxE,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC;CACR,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAU,CAAC;AAEjD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,IAAa,CAAC;AAE5D;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,CAAU,CAAC"}

package/dist/esm/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/esm/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/esm/doctor/index.js

@@ -0,0 +1,10 @@
+// `@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`).
+export { DOCTOR_STATUSES, DOCTOR_STATUS_RANK, SUPPORT_BUNDLE_REDACTION_RULES, SUPPORT_BUNDLE_SECTION_STATUSES, SUPPORT_BUNDLE_VERSION, } from './constants.js';
+export { doctorCheckReportSchema, doctorQuerySchema, doctorReportSchema, doctorStatusSchema, supportBundleSchema, supportBundleSectionResultSchema, } from './schemas.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/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,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,8BAA8B,EAC9B,+BAA+B,EAC/B,sBAAsB,GACvB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,gCAAgC,GACjC,MAAM,cAAc,CAAC"}

package/dist/esm/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/esm/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"}

package/dist/esm/doctor/schemas.js

@@ -0,0 +1,180 @@
+// =============================================================================
+// The Doctor's wire shapes (issue #634; moved here from
+// `@marinoscar/platform-api/doctor` by #701)
+// =============================================================================
+//
+// ALWAYS A 200 FOR AN AUTHORIZED CALLER. A failing check is a row with
+// `status: 'fail'`, never an error status: the report is read precisely when
+// something is wrong, and a 500 or a 503 would withhold the list of what.
+//
+// Every nullable field is present on every row (`null` rather than absent), so
+// a client renders one shape without optional-chaining through it.
+//
+// ⚠ OpenAPI is generated from these schemas (nestjs-zod, through the DTOs of
+// `@marinoscar/platform-api/doctor`). Field order, `.describe()` texts and the
+// order of the status enum are part of the published document: change them
+// only as a deliberate API change.
+// =============================================================================
+import { z } from 'zod';
+import { SUPPORT_BUNDLE_REDACTION_RULES, SUPPORT_BUNDLE_VERSION } from './constants.js';
+/**
+ * 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 const doctorStatusSchema = z
+    .enum(['pass', 'warn', 'fail', 'skip'])
+    .describe('`pass` — verified healthy. `warn` — works, but needs attention. `fail` — broken. ' +
+    '`skip` — not evaluated: a check it depends on did not pass, or the capability is ' +
+    'intentionally switched off.');
+/**
+ * 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 const doctorCheckReportSchema = z.object({
+    /** Stable dotted id, e.g. `storage.bucket`. */
+    id: z.string(),
+    /** `core`, `auth`, `storage`, ... — a fork may add its own. */
+    category: z.string(),
+    /** Short human label: "Object storage bucket". */
+    label: z.string(),
+    /** The web route that fixes this check, when there is one. */
+    settingsPath: z.string().nullable(),
+    /** `pass`, `warn`, `fail` or `skip`. */
+    status: doctorStatusSchema,
+    /** One line: what was found. */
+    detail: z.string(),
+    /** What to do about a `warn` or `fail`. Always set on those two. */
+    remedy: z.string().nullable(),
+    /** The underlying error message, when a probe failed. */
+    error: z.string().nullable(),
+    /** Small scalar facts: counts, versions, latencies. Never secret material. */
+    data: z.record(z.string(), z.union([z.string(), z.number(), z.boolean(), z.null()])).nullable(),
+    /** How long this check took; 0 when it was skipped without running. */
+    durationMs: z.number().int(),
+});
+/**
+ * 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 const doctorReportSchema = z.object({
+    /** The worst status in `checks` (`pass < skip < warn < fail`); `skip` when none ran. */
+    verdict: doctorStatusSchema,
+    /** When this report was produced. A cached report keeps its original time. */
+    generatedAt: z.iso.datetime(),
+    /** Wall time of the whole run. */
+    durationMs: z.number().int(),
+    /** Sorted by category (shipped order first), then registration order. */
+    checks: z.array(doctorCheckReportSchema),
+});
+// The query's `'true' | 'false'` parameter, typed through its named entries.
+const booleanStringSchema = z.enum(['true', 'false']);
+/**
+ * `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 const doctorQuerySchema = z.object({
+    /** Only the checks in this category (plus, unreported, whatever they depend on). */
+    category: z
+        .string()
+        .regex(/^[a-z0-9][a-z0-9_-]{0,63}$/, 'category must be a lowercase identifier')
+        .optional(),
+    /** `true` bypasses the 15-second report cache. */
+    refresh: booleanStringSchema
+        .transform((value) => value === 'true')
+        .optional(),
+});
+const statusEnumMatchesConstants = true;
+const queryInputMatchesSchema = true;
+void statusEnumMatchesConstants;
+void queryInputMatchesSchema;
+// -----------------------------------------------------------------------------
+// The support bundle (issue #772): the envelope `GET /api/admin/doctor/support-bundle`
+// returns. Each section's `data` is validated by that section's own strict
+// schema on the server (`@marinoscar/platform-api/doctor`), so here it stays
+// `unknown`.
+// -----------------------------------------------------------------------------
+/**
+ * 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 const supportBundleSectionResultSchema = z.discriminatedUnion('status', [
+    z.object({
+        /** Collected. */
+        status: z.literal('ok'),
+        /** The section's data, validated by its strict schema and redacted; `null` when truncated. */
+        data: z.unknown().describe("The section's data, already validated by its strict schema and redacted."),
+        /** `true` when a size cap dropped the data. */
+        truncated: z.boolean().optional().describe('`true` when a size cap dropped the data (`data` is then `null`).'),
+    }),
+    z.object({
+        /** Not collected. */
+        status: z.literal('omitted'),
+        /** Why: a missing permission, a capability switched off. */
+        reason: z.string().describe('Why the section was not collected (a missing permission, a capability switched off).'),
+    }),
+    z.object({
+        /** Collected, but dropped. */
+        status: z.literal('error'),
+        /** One redacted line saying why. */
+        error: z.string().describe('One redacted line: a throw, a timeout or a schema violation. Never the raw value.'),
+    }),
+]);
+/**
+ * The support bundle: what `GET /api/admin/doctor/support-bundle` returns as a
+ * JSON attachment.
+ *
+ * @extensionPoint schema
+ * @stability experimental
+ */
+export const supportBundleSchema = z.object({
+    /** The bundle format version, {@link SUPPORT_BUNDLE_VERSION}. */
+    bundleVersion: z.literal(SUPPORT_BUNDLE_VERSION).describe('The bundle format version.'),
+    /** When the bundle was built (ISO 8601, UTC). */
+    generatedAt: z.string().describe('When the bundle was built (ISO 8601, UTC).'),
+    /** The central redaction pass. */
+    redaction: z
+        .object({
+        /** The rule set applied, {@link SUPPORT_BUNDLE_REDACTION_RULES}. */
+        rules: z.literal(SUPPORT_BUNDLE_REDACTION_RULES).describe('The redaction rule set applied.'),
+        /** How many values the pass replaced. */
+        replacements: z.number().int().describe('How many values the redaction pass replaced.'),
+    })
+        .describe('The central redaction pass, applied on top of every section schema.'),
+    /** One result per registered section, keyed by section id. */
+    sections: z
+        .record(z.string(), supportBundleSectionResultSchema)
+        .describe('One entry per registered section, keyed by section id.'),
+});
+//# sourceMappingURL=schemas.js.map

package/dist/esm/doctor/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/doctor/schemas.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,wDAAwD;AACxD,6CAA6C;AAC7C,gFAAgF;AAChF,EAAE;AACF,uEAAuE;AACvE,6EAA6E;AAC7E,0EAA0E;AAC1E,EAAE;AACF,+EAA+E;AAC/E,mEAAmE;AACnE,EAAE;AACF,6EAA6E;AAC7E,+EAA+E;AAC/E,2EAA2E;AAC3E,mCAAmC;AACnC,gFAAgF;AAEhF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,8BAA8B,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAkBxF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAgC,CAAC;KAC7D,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;KACtC,QAAQ,CACP,mFAAmF;IACjF,mFAAmF;IACnF,6BAA6B,CAChC,CAAC;AAEJ;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,+CAA+C;IAC/C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,+DAA+D;IAC/D,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,kDAAkD;IAClD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,8DAA8D;IAC9D,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,wCAAwC;IACxC,MAAM,EAAE,kBAAkB;IAC1B,gCAAgC;IAChC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,oEAAoE;IACpE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,yDAAyD;IACzD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,8EAA8E;IAC9E,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC/F,uEAAuE;IACvE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CAC7B,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,wFAAwF;IACxF,OAAO,EAAE,kBAAkB;IAC3B,8EAA8E;IAC9E,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;IAC7B,kCAAkC;IAClC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC5B,yEAAyE;IACzE,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC;CACzC,CAAC,CAAC;AAEH,6EAA6E;AAC7E,MAAM,mBAAmB,GAAuC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAE1F;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,oFAAoF;IACpF,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,KAAK,CAAC,4BAA4B,EAAE,yCAAyC,CAAC;SAC9E,QAAQ,EAAE;IACb,kDAAkD;IAClD,OAAO,EAAE,mBAAmB;SACzB,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,MAAM,CAAC;SACtC,QAAQ,EAAE;CACd,CAAC,CAAC;AAwCH,MAAM,0BAA0B,GAA2D,IAAI,CAAC;AAChG,MAAM,uBAAuB,GAA8C,IAAI,CAAC;AAChF,KAAK,0BAA0B,CAAC;AAChC,KAAK,uBAAuB,CAAC;AAE7B,gFAAgF;AAChF,uFAAuF;AACvF,2EAA2E;AAC3E,6EAA6E;AAC7E,aAAa;AACb,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE;IAC7E,CAAC,CAAC,MAAM,CAAC;QACP,iBAAiB;QACjB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;QACvB,8FAA8F;QAC9F,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,0EAA0E,CAAC;QACtG,+CAA+C;QAC/C,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,kEAAkE,CAAC;KAC/G,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,qBAAqB;QACrB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;QAC5B,4DAA4D;QAC5D,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sFAAsF,CAAC;KACpH,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,8BAA8B;QAC9B,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;QAC1B,oCAAoC;QACpC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,mFAAmF,CAAC;KAChH,CAAC;CACH,CAAC,CAAC;AASH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,iEAAiE;IACjE,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC,QAAQ,CAAC,4BAA4B,CAAC;IACvF,iDAAiD;IACjD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,4CAA4C,CAAC;IAC9E,kCAAkC;IAClC,SAAS,EAAE,CAAC;SACT,MAAM,CAAC;QACN,oEAAoE;QACpE,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,8BAA8B,CAAC,CAAC,QAAQ,CAAC,iCAAiC,CAAC;QAC5F,yCAAyC;QACzC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,8CAA8C,CAAC;KACxF,CAAC;SACD,QAAQ,CAAC,qEAAqE,CAAC;IAClF,8DAA8D;IAC9D,QAAQ,EAAE,CAAC;SACR,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,gCAAgC,CAAC;SACpD,QAAQ,CAAC,wDAAwD,CAAC;CACtE,CAAC,CAAC"}

package/dist/esm/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The npm name of this package, which holds Zod DTOs and types shared by the platform API and web packages.
+ *
+ * The root entry exports only this name, so the smoke imports in CI have
+ * something to load end to end. Every slice is a subpath export
+ * (`@marinoscar/platform-contract/<slice>`, the first being `./doctor`) and is
+ * deliberately not re-exported here: a consumer loads only the slices it
+ * imports, and importing the root never loads zod.
+ *
+ * @stability experimental
+ */
+export declare const PLATFORM_PACKAGE: "@marinoscar/platform-contract";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,EAAG,+BAAwC,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,13 @@
+/**
+ * The npm name of this package, which holds Zod DTOs and types shared by the platform API and web packages.
+ *
+ * The root entry exports only this name, so the smoke imports in CI have
+ * something to load end to end. Every slice is a subpath export
+ * (`@marinoscar/platform-contract/<slice>`, the first being `./doctor`) and is
+ * deliberately not re-exported here: a consumer loads only the slices it
+ * imports, and importing the root never loads zod.
+ *
+ * @stability experimental
+ */
+export const PLATFORM_PACKAGE = '@marinoscar/platform-contract';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,+BAAwC,CAAC"}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}