@marinoscar/platform-api 0.0.0-stage → 0.1.0-next.4

package/dist/doctor/support-bundle/support-bundle.options.js

@@ -0,0 +1,100 @@
+"use strict";
+// The support bundle's options, part of `DoctorModuleOptions` (issue #772).
+// Kept apart from doctor.module.ts so the service and the controller factory
+// can read them without importing the module.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SUPPORT_BUNDLE_AUDIT_ACTION = exports.SUPPORT_BUNDLE_SUBPATH = exports.SUPPORT_BUNDLE_MAX_BYTES = exports.SUPPORT_BUNDLE_SECTION_MAX_BYTES = exports.SUPPORT_BUNDLE_SECTION_TIMEOUT_MS = void 0;
+exports.defaultSupportBundlePrincipal = defaultSupportBundlePrincipal;
+exports.resolveSupportBundleOptions = resolveSupportBundleOptions;
+/**
+ * Ceiling for one section's `collect()` when it declares no `timeoutMs`, in
+ * milliseconds.
+ *
+ * @stability experimental
+ */
+exports.SUPPORT_BUNDLE_SECTION_TIMEOUT_MS = 10_000;
+/**
+ * A section whose serialized data is larger than this many bytes is replaced
+ * by `{ status: 'ok', data: null, truncated: true }`.
+ *
+ * @stability experimental
+ */
+exports.SUPPORT_BUNDLE_SECTION_MAX_BYTES = 512 * 1024;
+/**
+ * The whole bundle's ceiling, in bytes of pretty-printed JSON. Above it the
+ * largest sections are truncated first until it fits.
+ *
+ * @stability experimental
+ */
+exports.SUPPORT_BUNDLE_MAX_BYTES = 2 * 1024 * 1024;
+/**
+ * The route path under the Doctor's own path (`admin/doctor/support-bundle`).
+ *
+ * @stability experimental
+ */
+exports.SUPPORT_BUNDLE_SUBPATH = 'support-bundle';
+/**
+ * The audit action of one download.
+ *
+ * @stability experimental
+ */
+exports.SUPPORT_BUNDLE_AUDIT_ACTION = 'support_bundle:download';
+function isStringArray(value) {
+    return Array.isArray(value) && value.every((item) => typeof item === 'string');
+}
+/**
+ * The default {@link SupportBundleOptions.principal}: `request.requestUser`,
+ * then `request.user`, when either carries a string `id` and a string-array
+ * `permissions` (the reference app's `RequestUser`).
+ *
+ * @param request - the framework request.
+ * @returns the caller, or `null` when neither property has that shape.
+ *
+ * @stability experimental
+ */
+function defaultSupportBundlePrincipal(request) {
+    if (request === null || typeof request !== 'object')
+        return null;
+    const { requestUser, user } = request;
+    for (const candidate of [requestUser, user]) {
+        if (candidate === null || typeof candidate !== 'object')
+            continue;
+        const { id, permissions } = candidate;
+        if (typeof id === 'string' && id !== '' && isStringArray(permissions))
+            return { userId: id, permissions };
+    }
+    return null;
+}
+/**
+ * Validates `supportBundle` and applies its defaults.
+ *
+ * @param options - what the app passed (`undefined`, `false` or an object).
+ * @param fail - throws the module's own error.
+ * @returns the resolved, frozen options.
+ */
+function resolveSupportBundleOptions(options, fail) {
+    if (options === false) {
+        return Object.freeze({
+            enabled: false,
+            appSlug: 'app',
+            principal: defaultSupportBundlePrincipal,
+            sectionTimeoutMs: exports.SUPPORT_BUNDLE_SECTION_TIMEOUT_MS,
+        });
+    }
+    if (options !== undefined && (options === null || typeof options !== 'object')) {
+        fail('`supportBundle` must be an object or false');
+    }
+    const appSlug = options?.appSlug ?? 'app';
+    if (typeof appSlug !== 'string' || !/^[a-z0-9][a-z0-9-]{0,62}$/.test(appSlug)) {
+        fail('`supportBundle.appSlug` must be lowercase letters, digits and dashes');
+    }
+    const principal = options?.principal ?? defaultSupportBundlePrincipal;
+    if (typeof principal !== 'function')
+        fail('`supportBundle.principal` must be a function');
+    const sectionTimeoutMs = options?.sectionTimeoutMs ?? exports.SUPPORT_BUNDLE_SECTION_TIMEOUT_MS;
+    if (typeof sectionTimeoutMs !== 'number' || !Number.isFinite(sectionTimeoutMs) || sectionTimeoutMs <= 0) {
+        fail('`supportBundle.sectionTimeoutMs` must be a positive number of milliseconds');
+    }
+    return Object.freeze({ enabled: true, appSlug, principal, sectionTimeoutMs });
+}
+//# sourceMappingURL=support-bundle.options.js.map

package/dist/doctor/support-bundle/support-bundle.options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"support-bundle.options.js","sourceRoot":"","sources":["../../../src/doctor/support-bundle/support-bundle.options.ts"],"names":[],"mappings":";AAAA,4EAA4E;AAC5E,6EAA6E;AAC7E,8CAA8C;;;AAgG9C,sEASC;AASD,kEA0BC;AAxID;;;;;GAKG;AACU,QAAA,iCAAiC,GAAG,MAAM,CAAC;AAExD;;;;;GAKG;AACU,QAAA,gCAAgC,GAAG,GAAG,GAAG,IAAI,CAAC;AAE3D;;;;;GAKG;AACU,QAAA,wBAAwB,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AAExD;;;;GAIG;AACU,QAAA,sBAAsB,GAAG,gBAAgB,CAAC;AAEvD;;;;GAIG;AACU,QAAA,2BAA2B,GAAG,yBAAyB,CAAC;AA0CrE,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC;AACjF,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,6BAA6B,CAAC,OAAgB;IAC5D,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACjE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,OAAoD,CAAC;IACnF,KAAK,MAAM,SAAS,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,CAAC;QAC5C,IAAI,SAAS,KAAK,IAAI,IAAI,OAAO,SAAS,KAAK,QAAQ;YAAE,SAAS;QAClE,MAAM,EAAE,EAAE,EAAE,WAAW,EAAE,GAAG,SAAoD,CAAC;QACjF,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,EAAE,KAAK,EAAE,IAAI,aAAa,CAAC,WAAW,CAAC;YAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC;IAC5G,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,2BAA2B,CACzC,OAAiD,EACjD,IAA4B;IAE5B,IAAI,OAAO,KAAK,KAAK,EAAE,CAAC;QACtB,OAAO,MAAM,CAAC,MAAM,CAAC;YACnB,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,KAAK;YACd,SAAS,EAAE,6BAA6B;YACxC,gBAAgB,EAAE,yCAAiC;SACpD,CAAC,CAAC;IACL,CAAC;IACD,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,OAAO,KAAK,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC,EAAE,CAAC;QAC/E,IAAI,CAAC,4CAA4C,CAAC,CAAC;IACrD,CAAC;IACD,MAAM,OAAO,GAAG,OAAO,EAAE,OAAO,IAAI,KAAK,CAAC;IAC1C,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9E,IAAI,CAAC,sEAAsE,CAAC,CAAC;IAC/E,CAAC;IACD,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,6BAA6B,CAAC;IACtE,IAAI,OAAO,SAAS,KAAK,UAAU;QAAE,IAAI,CAAC,8CAA8C,CAAC,CAAC;IAC1F,MAAM,gBAAgB,GAAG,OAAO,EAAE,gBAAgB,IAAI,yCAAiC,CAAC;IACxF,IAAI,OAAO,gBAAgB,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,gBAAgB,IAAI,CAAC,EAAE,CAAC;QACxG,IAAI,CAAC,4EAA4E,CAAC,CAAC;IACrF,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC,CAAC;AAChF,CAAC"}

package/dist/doctor/support-bundle/support-bundle.registry.d.ts

@@ -0,0 +1,38 @@
+import { OnApplicationBootstrap } from '@nestjs/common';
+import type { SupportBundleSection } from './support-bundle-section.interface';
+/**
+ * The sections the support bundle collects. Provided (globally) by
+ * `DoctorModule.forRoot()`; a feature module's section injects it and
+ * registers itself from `onModuleInit`.
+ *
+ * @stability experimental
+ */
+export declare class SupportBundleRegistry implements OnApplicationBootstrap {
+    private readonly sections;
+    /**
+     * Adds `section`. Call it from the section's own `onModuleInit`.
+     *
+     * @param section - the section; its `id` must be unique across the application.
+     * @throws RegistryError `DUPLICATE_ID` when another section already uses its
+     *   id, `INVALID_ID` for an id that is not a lowercase identifier,
+     *   `INVALID_ENTRY` without `collect()` or a zod `schema`, `FROZEN` after the
+     *   application has bootstrapped.
+     *
+     * @example
+     * ```ts
+     * onModuleInit(): void {
+     *   this.registry.register(this);
+     * }
+     * ```
+     *
+     * @extensionPoint registry
+     */
+    register(section: SupportBundleSection): void;
+    /** The section registered under `id`, or `undefined`. */
+    get(id: string): SupportBundleSection | undefined;
+    /** Every registered section, in registration order. */
+    list(): SupportBundleSection[];
+    /** Refuses further registrations once every module's `onModuleInit` has run. */
+    onApplicationBootstrap(): void;
+}
+//# sourceMappingURL=support-bundle.registry.d.ts.map

package/dist/doctor/support-bundle/support-bundle.registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"support-bundle.registry.d.ts","sourceRoot":"","sources":["../../../src/doctor/support-bundle/support-bundle.registry.ts"],"names":[],"mappings":"AAcA,OAAO,EAAc,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAGpE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAK/E;;;;;;GAMG;AACH,qBACa,qBAAsB,YAAW,sBAAsB;IAClE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAgBtB;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI;IAI7C,yDAAyD;IACzD,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,oBAAoB,GAAG,SAAS;IAIjD,uDAAuD;IACvD,IAAI,IAAI,oBAAoB,EAAE;IAI9B,gFAAgF;IAChF,sBAAsB,IAAI,IAAI;CAG/B"}

package/dist/doctor/support-bundle/support-bundle.registry.js

@@ -0,0 +1,90 @@
+"use strict";
+// =============================================================================
+// Support-bundle section registry (issue #772, PP-13.1)
+// =============================================================================
+//
+// The one place that knows which sections `GET /api/admin/doctor/support-bundle`
+// collects. The same mechanism as `DoctorCheckRegistry` and for the same
+// reasons (read its header): explicit self-registration from `onModuleInit`,
+// duplicate ids THROW at boot, and the registry freezes in
+// `onApplicationBootstrap`, after every module's `onModuleInit` has run.
+//
+// Ids are restricted to lowercase identifiers because they become JSON keys of
+// the bundle and the keys of the download's audit row.
+// =============================================================================
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SupportBundleRegistry = void 0;
+const common_1 = require("@nestjs/common");
+const index_1 = require("../../core/index");
+/** Lowercase letters, digits, `.`, `_` and `-`, starting with a letter. */
+const SECTION_ID_PATTERN = /^[a-z][a-z0-9._-]*$/;
+/**
+ * The sections the support bundle collects. Provided (globally) by
+ * `DoctorModule.forRoot()`; a feature module's section injects it and
+ * registers itself from `onModuleInit`.
+ *
+ * @stability experimental
+ */
+let SupportBundleRegistry = class SupportBundleRegistry {
+    sections = new index_1.Registry({
+        name: 'support-bundle-sections',
+        idOf: (section) => section.id,
+        idPattern: SECTION_ID_PATTERN,
+        validate: (section) => {
+            if (typeof section.collect !== 'function')
+                throw new Error(`Support-bundle section "${section.id}" has no collect().`);
+            if (!section.schema || typeof section.schema.safeParse !== 'function') {
+                throw new Error(`Support-bundle section "${section.id}" has no zod schema.`);
+            }
+            if (section.timeoutMs !== undefined && (!Number.isFinite(section.timeoutMs) || section.timeoutMs <= 0)) {
+                throw new Error(`Support-bundle section "${section.id}" has an invalid timeoutMs.`);
+            }
+        },
+        describeDuplicate: (existing, incoming) => `Duplicate support-bundle section id "${incoming.id}": ${existing.constructor.name} and ` +
+            `${incoming.constructor.name} both register it. Section ids must be unique.`,
+    });
+    /**
+     * Adds `section`. Call it from the section's own `onModuleInit`.
+     *
+     * @param section - the section; its `id` must be unique across the application.
+     * @throws RegistryError `DUPLICATE_ID` when another section already uses its
+     *   id, `INVALID_ID` for an id that is not a lowercase identifier,
+     *   `INVALID_ENTRY` without `collect()` or a zod `schema`, `FROZEN` after the
+     *   application has bootstrapped.
+     *
+     * @example
+     * ```ts
+     * onModuleInit(): void {
+     *   this.registry.register(this);
+     * }
+     * ```
+     *
+     * @extensionPoint registry
+     */
+    register(section) {
+        this.sections.register(section);
+    }
+    /** The section registered under `id`, or `undefined`. */
+    get(id) {
+        return this.sections.get(id);
+    }
+    /** Every registered section, in registration order. */
+    list() {
+        return this.sections.list();
+    }
+    /** Refuses further registrations once every module's `onModuleInit` has run. */
+    onApplicationBootstrap() {
+        this.sections.freeze();
+    }
+};
+exports.SupportBundleRegistry = SupportBundleRegistry;
+exports.SupportBundleRegistry = SupportBundleRegistry = __decorate([
+    (0, common_1.Injectable)()
+], SupportBundleRegistry);
+//# sourceMappingURL=support-bundle.registry.js.map

package/dist/doctor/support-bundle/support-bundle.registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"support-bundle.registry.js","sourceRoot":"","sources":["../../../src/doctor/support-bundle/support-bundle.registry.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,wDAAwD;AACxD,gFAAgF;AAChF,EAAE;AACF,iFAAiF;AACjF,yEAAyE;AACzE,6EAA6E;AAC7E,2DAA2D;AAC3D,yEAAyE;AACzE,EAAE;AACF,+EAA+E;AAC/E,uDAAuD;AACvD,gFAAgF;;;;;;;;;AAEhF,2CAAoE;AAEpE,4CAA4C;AAG5C,2EAA2E;AAC3E,MAAM,kBAAkB,GAAG,qBAAqB,CAAC;AAEjD;;;;;;GAMG;AAEI,IAAM,qBAAqB,GAA3B,MAAM,qBAAqB;IACf,QAAQ,GAAG,IAAI,gBAAQ,CAAuB;QAC7D,IAAI,EAAE,yBAAyB;QAC/B,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE;QAC7B,SAAS,EAAE,kBAAkB;QAC7B,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE;YACpB,IAAI,OAAO,OAAO,CAAC,OAAO,KAAK,UAAU;gBAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,OAAO,CAAC,EAAE,qBAAqB,CAAC,CAAC;YACvH,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,OAAQ,OAAO,CAAC,MAAkC,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;gBACnG,MAAM,IAAI,KAAK,CAAC,2BAA2B,OAAO,CAAC,EAAE,sBAAsB,CAAC,CAAC;YAC/E,CAAC;YACD,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC;gBACvG,MAAM,IAAI,KAAK,CAAC,2BAA2B,OAAO,CAAC,EAAE,6BAA6B,CAAC,CAAC;YACtF,CAAC;QACH,CAAC;QACD,iBAAiB,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,CACxC,wCAAwC,QAAQ,CAAC,EAAE,MAAM,QAAQ,CAAC,WAAW,CAAC,IAAI,OAAO;YACzF,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,gDAAgD;KAC/E,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,OAA6B;QACpC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED,yDAAyD;IACzD,GAAG,CAAC,EAAU;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED,uDAAuD;IACvD,IAAI;QACF,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC9B,CAAC;IAED,gFAAgF;IAChF,sBAAsB;QACpB,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IACzB,CAAC;CACF,CAAA;AAvDY,sDAAqB;gCAArB,qBAAqB;IADjC,IAAA,mBAAU,GAAE;GACA,qBAAqB,CAuDjC"}

package/dist/doctor/support-bundle/support-bundle.service.d.ts

@@ -0,0 +1,63 @@
+import type { SupportBundle, SupportBundleSectionStatus } from '@marinoscar/platform-contract/doctor';
+import type { AuditSink } from '../../core/index';
+import type { ResolvedDoctorModuleOptions } from '../doctor.options';
+import type { SupportBundlePrincipal } from './support-bundle-section.interface';
+import { SupportBundleRegistry } from './support-bundle.registry';
+/**
+ * One built bundle: the file, its name and what the audit row records.
+ *
+ * @stability experimental
+ */
+export interface SupportBundleBuild {
+    /** The file: pretty-printed JSON, UTF-8. */
+    body: Buffer;
+    /** `support-bundle-<appSlug>-<yyyyMMdd'T'HHmmss'Z'>.json`. */
+    filename: string;
+    /** The bundle the body serializes. */
+    bundle: SupportBundle;
+    /** Facts about the build, for the audit row and logs. */
+    meta: {
+        /** Each section's final status. */
+        sections: Record<string, SupportBundleSectionStatus>;
+        /** `body.length`. */
+        bytes: number;
+        /** `bundle.redaction.replacements`. */
+        replacements: number;
+        /** How long the build took, in milliseconds. */
+        durationMs: number;
+    };
+}
+/**
+ * Builds the support bundle from every section in {@link SupportBundleRegistry}.
+ * Provided by `DoctorModule.forRoot()`.
+ *
+ * @stability experimental
+ */
+export declare class SupportBundleService {
+    private readonly registry;
+    private readonly options;
+    private readonly audit?;
+    private readonly logger;
+    constructor(registry: SupportBundleRegistry, options: ResolvedDoctorModuleOptions, audit?: AuditSink | undefined);
+    /**
+     * Builds a bundle for `actor`, without auditing it.
+     *
+     * @param actor - the caller: their id (never written into the bundle) and permissions.
+     * @param now - the build instant. Default: now.
+     * @returns the file, its name, the bundle and its audit facts.
+     */
+    build(actor: SupportBundlePrincipal, now?: Date): Promise<SupportBundleBuild>;
+    /**
+     * Builds a bundle for `actor` and records one `support_bundle:download`
+     * audit event (after the body is built; a failed write is logged, not thrown).
+     *
+     * @param actor - the caller.
+     * @returns the built bundle.
+     */
+    download(actor: SupportBundlePrincipal): Promise<SupportBundleBuild>;
+    private describeSections;
+    private record;
+    /** Runs one section under its permission, timeout and schema. Never throws. */
+    private collect;
+}
+//# sourceMappingURL=support-bundle.service.d.ts.map

package/dist/doctor/support-bundle/support-bundle.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"support-bundle.service.d.ts","sourceRoot":"","sources":["../../../src/doctor/support-bundle/support-bundle.service.ts"],"names":[],"mappings":"AA6BA,OAAO,KAAK,EACV,aAAa,EAEb,0BAA0B,EAC3B,MAAM,sCAAsC,CAAC;AAG9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,mBAAmB,CAAC;AAGrE,OAAO,KAAK,EAAE,sBAAsB,EAAwB,MAAM,oCAAoC,CAAC;AAMvG,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAQlE;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,CAAC;IACjB,sCAAsC;IACtC,MAAM,EAAE,aAAa,CAAC;IACtB,yDAAyD;IACzD,IAAI,EAAE;QACJ,mCAAmC;QACnC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;QACrD,qBAAqB;QACrB,KAAK,EAAE,MAAM,CAAC;QACd,uCAAuC;QACvC,YAAY,EAAE,MAAM,CAAC;QACrB,gDAAgD;QAChD,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;CACH;AAkCD;;;;;GAKG;AACH,qBACa,oBAAoB;IAIE,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;IALzD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAsC;gBAGX,QAAQ,EAAE,qBAAqB,EAC/B,OAAO,EAAE,2BAA2B,EACnC,KAAK,CAAC,EAAE,SAAS,YAAA;IAUpE;;;;;;OAMG;IACG,KAAK,CAAC,KAAK,EAAE,sBAAsB,EAAE,GAAG,GAAE,IAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA6D/F;;;;;;OAMG;IACG,QAAQ,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAU1E,OAAO,CAAC,gBAAgB;YAMV,MAAM;IAiBpB,+EAA+E;YACjE,OAAO;CA2CtB"}

package/dist/doctor/support-bundle/support-bundle.service.js

@@ -0,0 +1,244 @@
+"use strict";
+// =============================================================================
+// SupportBundleService: builds the support bundle (issue #772, PP-13.1)
+// =============================================================================
+//
+// One JSON file an operator can attach to a support ticket: every registered
+// section, collected in parallel, each validated by its own strict schema,
+// then the central redaction pass (`redact.ts`), then the size caps.
+//
+// BOUNDED, SO NOT A QUEUE JOB (CLAUDE.md: "every long-running activity is a
+// queue job"). The work finishes inside the request, like the telemetry
+// export:
+//   - sections run in parallel, each cut off after its `timeoutMs` (default
+//     10 s), so the build takes at most the longest section timeout;
+//   - the doctor section reads the Doctor's 15 s report cache
+//     (`run({ refresh: false })`), so downloading never multiplies probes;
+//   - the telemetry section reads the dashboard's 15 s result cache;
+//   - 512 KiB per section and 2 MiB per bundle.
+// A fork that registers a slow section is bounded by that section's timeout.
+//
+// FAIL CLOSED, PER SECTION. A throw, a timeout or output that breaks the
+// section's schema becomes `{ status: 'error', error: <one redacted line> }`
+// and the section's data is DROPPED; the rest of the bundle is intact.
+//
+// AUDITED after the body is built: one `support_bundle:download` row per
+// download, without the actor's email. A failed audit write is logged, not
+// fatal (the bundle has been built; refusing it would not undo anything).
+// =============================================================================
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SupportBundleService = void 0;
+const common_1 = require("@nestjs/common");
+const index_1 = require("../../core/index");
+const doctor_options_1 = require("../doctor.options");
+const redact_1 = require("./redact");
+const support_bundle_section_interface_1 = require("./support-bundle-section.interface");
+const support_bundle_options_1 = require("./support-bundle.options");
+const support_bundle_registry_1 = require("./support-bundle.registry");
+/** What a schema failure says. Never the value, never zod's message (it can quote input). */
+const SCHEMA_ERROR = 'section output did not match its schema';
+/** An `error` line longer than this is cut. */
+const MAX_ERROR_LENGTH = 300;
+class SectionTimeoutError extends Error {
+    constructor(ms) {
+        super(`timed out after ${ms} ms`);
+    }
+}
+/** One line, cut, with no stack: what an `error` field may say. */
+function oneLine(message) {
+    const line = (message.split(/\r?\n/)[0] ?? '').trim() || 'section failed';
+    return line.length > MAX_ERROR_LENGTH ? `${line.slice(0, MAX_ERROR_LENGTH - 1)}…` : line;
+}
+function messageOf(error) {
+    return error instanceof Error ? error.message : String(error);
+}
+function pad(n) {
+    return String(n).padStart(2, '0');
+}
+/** `yyyyMMdd'T'HHmmss'Z'`, UTC. */
+function filenameStamp(at) {
+    return (`${at.getUTCFullYear()}${pad(at.getUTCMonth() + 1)}${pad(at.getUTCDate())}` +
+        `T${pad(at.getUTCHours())}${pad(at.getUTCMinutes())}${pad(at.getUTCSeconds())}Z`);
+}
+function bytesOf(value) {
+    return Buffer.byteLength(JSON.stringify(value ?? null, null, 2), 'utf8');
+}
+/**
+ * Builds the support bundle from every section in {@link SupportBundleRegistry}.
+ * Provided by `DoctorModule.forRoot()`.
+ *
+ * @stability experimental
+ */
+let SupportBundleService = class SupportBundleService {
+    registry;
+    options;
+    audit;
+    logger = new common_1.Logger('SupportBundleService');
+    constructor(registry, options, audit) {
+        this.registry = registry;
+        this.options = options;
+        this.audit = audit;
+        if (!audit && options.supportBundle.enabled) {
+            this.logger.warn('No AUDIT_SINK is bound: support-bundle downloads will not be audited. ' +
+                'Bind one with PlatformHostModule.forRoot({ audit }).');
+        }
+    }
+    /**
+     * Builds a bundle for `actor`, without auditing it.
+     *
+     * @param actor - the caller: their id (never written into the bundle) and permissions.
+     * @param now - the build instant. Default: now.
+     * @returns the file, its name, the bundle and its audit facts.
+     */
+    async build(actor, now = new Date()) {
+        const started = Date.now();
+        const permissions = new Set(actor.permissions);
+        const sections = this.registry.list();
+        const results = await Promise.all(sections.map(async (section) => [section.id, await this.collect(section, actor.userId, permissions, now)]));
+        // The central redaction pass, one section at a time so a section id is
+        // never itself mistaken for a sensitive key.
+        let replacements = 0;
+        const redacted = {};
+        for (const [id, result] of results) {
+            const pass = (0, redact_1.redactValue)(result, { path: ['sections', id] });
+            replacements += pass.replacements;
+            redacted[id] = pass.value;
+        }
+        // Per-section cap, after redaction (what is measured is what is sent).
+        for (const [id, result] of Object.entries(redacted)) {
+            if (result.status === 'ok' && bytesOf(result.data) > support_bundle_options_1.SUPPORT_BUNDLE_SECTION_MAX_BYTES) {
+                this.logger.warn(`Support-bundle section "${id}" exceeded ${support_bundle_options_1.SUPPORT_BUNDLE_SECTION_MAX_BYTES} bytes and was truncated.`);
+                redacted[id] = { status: 'ok', data: null, truncated: true };
+            }
+        }
+        const bundle = {
+            bundleVersion: 1,
+            generatedAt: now.toISOString(),
+            redaction: { rules: redact_1.SUPPORT_BUNDLE_REDACTION_VERSION, replacements },
+            sections: redacted,
+        };
+        // Whole-bundle cap: the largest sections go first.
+        let body = JSON.stringify(bundle, null, 2);
+        while (Buffer.byteLength(body, 'utf8') > support_bundle_options_1.SUPPORT_BUNDLE_MAX_BYTES) {
+            const largest = Object.entries(redacted)
+                .filter(([, result]) => result.status === 'ok' && result.data !== null)
+                .map(([id, result]) => [id, bytesOf(result.data)])
+                .sort((a, b) => b[1] - a[1])[0];
+            if (!largest)
+                break;
+            this.logger.warn(`Support bundle exceeded ${support_bundle_options_1.SUPPORT_BUNDLE_MAX_BYTES} bytes; truncated section "${largest[0]}".`);
+            redacted[largest[0]] = { status: 'ok', data: null, truncated: true };
+            body = JSON.stringify(bundle, null, 2);
+        }
+        const buffer = Buffer.from(`${body}\n`, 'utf8');
+        return {
+            body: buffer,
+            filename: `support-bundle-${this.options.supportBundle.appSlug}-${filenameStamp(now)}.json`,
+            bundle,
+            meta: {
+                sections: Object.fromEntries(Object.entries(redacted).map(([id, result]) => [id, result.status])),
+                bytes: buffer.length,
+                replacements,
+                durationMs: Date.now() - started,
+            },
+        };
+    }
+    /**
+     * Builds a bundle for `actor` and records one `support_bundle:download`
+     * audit event (after the body is built; a failed write is logged, not thrown).
+     *
+     * @param actor - the caller.
+     * @returns the built bundle.
+     */
+    async download(actor) {
+        const built = await this.build(actor);
+        await this.record(actor, built);
+        this.logger.log(`Support bundle built: ${built.meta.bytes} bytes, ${built.meta.replacements} replacement(s), ` +
+            `${built.meta.durationMs} ms (${this.describeSections(built)}).`);
+        return built;
+    }
+    describeSections(built) {
+        return Object.entries(built.meta.sections)
+            .map(([id, status]) => `${id}=${status}`)
+            .join(',');
+    }
+    async record(actor, built) {
+        if (!this.audit)
+            return;
+        try {
+            await this.audit.record({
+                action: support_bundle_options_1.SUPPORT_BUNDLE_AUDIT_ACTION,
+                actorUserId: actor.userId,
+                targetType: 'deployment',
+                targetId: 'support_bundle',
+                // Scalars only (the AuditSink contract): the section statuses as one
+                // `id=status` list. Never the actor's email.
+                meta: { sections: this.describeSections(built), bytes: built.meta.bytes, replacements: built.meta.replacements },
+            });
+        }
+        catch (error) {
+            this.logger.warn(`Could not audit a support-bundle download: ${(0, redact_1.redactString)(oneLine(messageOf(error))).value}`);
+        }
+    }
+    /** Runs one section under its permission, timeout and schema. Never throws. */
+    async collect(section, actorUserId, permissions, now) {
+        if (section.permission && !permissions.has(section.permission)) {
+            return { status: 'omitted', reason: `requires the ${section.permission} permission` };
+        }
+        const timeoutMs = section.timeoutMs ?? this.options.supportBundle.sectionTimeoutMs;
+        const controller = new AbortController();
+        let timer;
+        try {
+            const raw = await Promise.race([
+                Promise.resolve().then(() => section.collect({ actorUserId, permissions, now, signal: controller.signal })),
+                new Promise((_resolve, reject) => {
+                    timer = setTimeout(() => {
+                        controller.abort();
+                        reject(new SectionTimeoutError(timeoutMs));
+                    }, timeoutMs);
+                }),
+            ]);
+            if ((0, support_bundle_section_interface_1.isSupportBundleOmission)(raw))
+                return { status: 'omitted', reason: oneLine(raw.reason) };
+            const parsed = section.schema.safeParse(raw);
+            if (!parsed.success) {
+                // Paths only: zod's messages can quote the offending input.
+                const paths = parsed.error.issues.map((issue) => issue.path.join('.') || '(root)').slice(0, 5);
+                this.logger.warn(`Support-bundle section "${section.id}" broke its schema at ${paths.join(', ')}; its data was dropped.`);
+                return { status: 'error', error: SCHEMA_ERROR };
+            }
+            return { status: 'ok', data: parsed.data ?? null };
+        }
+        catch (error) {
+            const line = oneLine(messageOf(error));
+            this.logger.warn(`Support-bundle section "${section.id}" failed: ${(0, redact_1.redactString)(line).value}`);
+            return { status: 'error', error: line };
+        }
+        finally {
+            if (timer)
+                clearTimeout(timer);
+        }
+    }
+};
+exports.SupportBundleService = SupportBundleService;
+exports.SupportBundleService = SupportBundleService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)(support_bundle_registry_1.SupportBundleRegistry)),
+    __param(1, (0, common_1.Inject)(doctor_options_1.DOCTOR_MODULE_OPTIONS)),
+    __param(2, (0, common_1.Optional)()),
+    __param(2, (0, common_1.Inject)(index_1.AUDIT_SINK)),
+    __metadata("design:paramtypes", [support_bundle_registry_1.SupportBundleRegistry, Object, Object])
+], SupportBundleService);
+//# sourceMappingURL=support-bundle.service.js.map

package/dist/doctor/support-bundle/support-bundle.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"support-bundle.service.js","sourceRoot":"","sources":["../../../src/doctor/support-bundle/support-bundle.service.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,wEAAwE;AACxE,gFAAgF;AAChF,EAAE;AACF,6EAA6E;AAC7E,2EAA2E;AAC3E,qEAAqE;AACrE,EAAE;AACF,4EAA4E;AAC5E,wEAAwE;AACxE,UAAU;AACV,4EAA4E;AAC5E,qEAAqE;AACrE,8DAA8D;AAC9D,2EAA2E;AAC3E,qEAAqE;AACrE,gDAAgD;AAChD,6EAA6E;AAC7E,EAAE;AACF,yEAAyE;AACzE,6EAA6E;AAC7E,uEAAuE;AACvE,EAAE;AACF,yEAAyE;AACzE,2EAA2E;AAC3E,0EAA0E;AAC1E,gFAAgF;;;;;;;;;;;;;;;AAEhF,2CAAsE;AAOtE,4CAA8C;AAE9C,sDAA0D;AAE1D,qCAAuF;AACvF,yFAA6E;AAE7E,qEAIkC;AAClC,uEAAkE;AAElE,6FAA6F;AAC7F,MAAM,YAAY,GAAG,yCAAyC,CAAC;AAE/D,+CAA+C;AAC/C,MAAM,gBAAgB,GAAG,GAAG,CAAC;AA2B7B,MAAM,mBAAoB,SAAQ,KAAK;IACrC,YAAY,EAAU;QACpB,KAAK,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;CACF;AAED,mEAAmE;AACnE,SAAS,OAAO,CAAC,OAAe;IAC9B,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,gBAAgB,CAAC;IAC1E,OAAO,IAAI,CAAC,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,gBAAgB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;AAC3F,CAAC;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,GAAG,CAAC,CAAS;IACpB,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,mCAAmC;AACnC,SAAS,aAAa,CAAC,EAAQ;IAC7B,OAAO,CACL,GAAG,EAAE,CAAC,cAAc,EAAE,GAAG,GAAG,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,EAAE;QAC3E,IAAI,GAAG,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,GAAG,CACjF,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,KAAc;IAC7B,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,IAAI,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAC3E,CAAC;AAED;;;;;GAKG;AAEI,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IAImB;IACA;IACC;IALlC,MAAM,GAAG,IAAI,eAAM,CAAC,sBAAsB,CAAC,CAAC;IAE7D,YACkD,QAA+B,EAC/B,OAAoC,EACnC,KAAiB;QAFlB,aAAQ,GAAR,QAAQ,CAAuB;QAC/B,YAAO,GAAP,OAAO,CAA6B;QACnC,UAAK,GAAL,KAAK,CAAY;QAElE,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;YAC5C,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,wEAAwE;gBACtE,sDAAsD,CACzD,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAAC,KAA6B,EAAE,MAAY,IAAI,IAAI,EAAE;QAC/D,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3B,MAAM,WAAW,GAAwB,IAAI,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACpE,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEtC,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,CAAC,CAAU,CAAC,CACpH,CAAC;QAEF,uEAAuE;QACvE,6CAA6C;QAC7C,IAAI,YAAY,GAAG,CAAC,CAAC;QACrB,MAAM,QAAQ,GAA+C,EAAE,CAAC;QAChE,KAAK,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;YACnC,MAAM,IAAI,GAAG,IAAA,oBAAW,EAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;YAC7D,YAAY,IAAI,IAAI,CAAC,YAAY,CAAC;YAClC,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QAC5B,CAAC;QAED,uEAAuE;QACvE,KAAK,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YACpD,IAAI,MAAM,CAAC,MAAM,KAAK,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,yDAAgC,EAAE,CAAC;gBACtF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE,cAAc,yDAAgC,2BAA2B,CAAC,CAAC;gBACzH,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;YAC/D,CAAC;QACH,CAAC;QAED,MAAM,MAAM,GAAkB;YAC5B,aAAa,EAAE,CAAC;YAChB,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE;YAC9B,SAAS,EAAE,EAAE,KAAK,EAAE,yCAAgC,EAAE,YAAY,EAAE;YACpE,QAAQ,EAAE,QAAQ;SACnB,CAAC;QAEF,mDAAmD;QACnD,IAAI,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC3C,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,iDAAwB,EAAE,CAAC;YAClE,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;iBACrC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC;iBACtE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,OAAO,CAAE,MAA4B,CAAC,IAAI,CAAC,CAAU,CAAC;iBACjF,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAClC,IAAI,CAAC,OAAO;gBAAE,MAAM;YACpB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,iDAAwB,8BAA8B,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAClH,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;YACrE,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,EAAE,MAAM,CAAC,CAAC;QAChD,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,kBAAkB,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,IAAI,aAAa,CAAC,GAAG,CAAC,OAAO;YAC3F,MAAM;YACN,IAAI,EAAE;gBACJ,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;gBACjG,KAAK,EAAE,MAAM,CAAC,MAAM;gBACpB,YAAY;gBACZ,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO;aACjC;SACF,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,CAAC,KAA6B;QAC1C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACtC,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAChC,IAAI,CAAC,MAAM,CAAC,GAAG,CACb,yBAAyB,KAAK,CAAC,IAAI,CAAC,KAAK,WAAW,KAAK,CAAC,IAAI,CAAC,YAAY,mBAAmB;YAC5F,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,QAAQ,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CACnE,CAAC;QACF,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,gBAAgB,CAAC,KAAyB;QAChD,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;aACvC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,IAAI,MAAM,EAAE,CAAC;aACxC,IAAI,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IAEO,KAAK,CAAC,MAAM,CAAC,KAA6B,EAAE,KAAyB;QAC3E,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAO;QACxB,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;gBACtB,MAAM,EAAE,oDAA2B;gBACnC,WAAW,EAAE,KAAK,CAAC,MAAM;gBACzB,UAAU,EAAE,YAAY;gBACxB,QAAQ,EAAE,gBAAgB;gBAC1B,qEAAqE;gBACrE,6CAA6C;gBAC7C,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE;aACjH,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,8CAA8C,IAAA,qBAAY,EAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QAClH,CAAC;IACH,CAAC;IAED,+EAA+E;IACvE,KAAK,CAAC,OAAO,CACnB,OAA6B,EAC7B,WAAmB,EACnB,WAAgC,EAChC,GAAS;QAET,IAAI,OAAO,CAAC,UAAU,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/D,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,gBAAgB,OAAO,CAAC,UAAU,aAAa,EAAE,CAAC;QACxF,CAAC;QAED,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,gBAAgB,CAAC;QACnF,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,IAAI,KAAiC,CAAC;QAEtC,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC;gBAC7B,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;gBAC3G,IAAI,OAAO,CAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE;oBACtC,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;wBACtB,UAAU,CAAC,KAAK,EAAE,CAAC;wBACnB,MAAM,CAAC,IAAI,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC;oBAC7C,CAAC,EAAE,SAAS,CAAC,CAAC;gBAChB,CAAC,CAAC;aACH,CAAC,CAAC;YAEH,IAAI,IAAA,0DAAuB,EAAC,GAAG,CAAC;gBAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YAE5F,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YAC7C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACpB,4DAA4D;gBAC5D,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC/F,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,OAAO,CAAC,EAAE,yBAAyB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;gBAC1H,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;YAClD,CAAC;YACD,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;QACrD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YACvC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,OAAO,CAAC,EAAE,aAAa,IAAA,qBAAY,EAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;YAC/F,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAC1C,CAAC;gBAAS,CAAC;YACT,IAAI,KAAK;gBAAE,YAAY,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;CACF,CAAA;AAxKY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,mBAAU,GAAE;IAKR,WAAA,IAAA,eAAM,EAAC,+CAAqB,CAAC,CAAA;IAC7B,WAAA,IAAA,eAAM,EAAC,sCAAqB,CAAC,CAAA;IAC7B,WAAA,IAAA,iBAAQ,GAAE,CAAA;IAAE,WAAA,IAAA,eAAM,EAAC,kBAAU,CAAC,CAAA;qCAF2B,+CAAqB;GAJtE,oBAAoB,CAwKhC"}

package/dist/doctor/testing/describe-doctor-check-conformance.d.ts

@@ -0,0 +1,80 @@
+import type { ConformanceTestApi } from '../../testing/index';
+import type { DoctorCheck } from '../doctor-check.interface';
+import type { DoctorStatus } from '../doctor-check.interface';
+import type { RecordingPrisma, RecordingPrismaOptions } from './recording-prisma';
+import type { WriteFailingStorage, WriteFailingStorageOptions } from './write-failing-storage';
+/**
+ * The two doubles a check is built over for one test.
+ *
+ * @stability experimental
+ */
+export interface DoctorCheckDoubles {
+    /** A recording Prisma client; bind it where the check takes `PLATFORM_PRISMA` or its slice's client. */
+    readonly prisma: RecordingPrisma;
+    /** A write-failing storage provider; bind it where the check takes `STORAGE_PROVIDER`. */
+    readonly storage: WriteFailingStorage;
+}
+/**
+ * Builds the check under test over the doubles. Called once per test, so state
+ * never leaks between cases.
+ *
+ * @stability experimental
+ */
+export type DoctorCheckFactory = (doubles: DoctorCheckDoubles) => DoctorCheck | Promise<DoctorCheck>;
+/**
+ * One world to run the check in.
+ *
+ * @stability experimental
+ */
+export interface DoctorCheckScenario {
+    /** The scenario's name, shown in every test title (`configured`, `provider down`). */
+    readonly name: string;
+    /** Scripted reads for the Prisma double (`{ 'job.count': 12 }`) and the storage double. */
+    readonly prisma?: RecordingPrismaOptions;
+    /** Options for the storage double. */
+    readonly storage?: WriteFailingStorageOptions;
+    /** Builds the check for this scenario when it differs from the suite's factory. */
+    readonly build?: DoctorCheckFactory;
+    /** The statuses the scenario may return (default: any valid status). */
+    readonly expectStatus?: DoctorStatus | readonly DoctorStatus[];
+    /** Strings that are secret in this scenario; none may appear in the result. */
+    readonly secrets?: readonly string[];
+}
+/**
+ * What {@link describeDoctorCheckConformance} accepts.
+ *
+ * @example
+ * ```ts
+ * describeDoctorCheckConformance('example.capability', ({ prisma }) => new MyCheck(registry, prisma.client), {
+ *   scenarios: [
+ *     { name: 'enabled and configured', prisma: { results: { 'setting.findFirst': { value: 'on' } } }, expectStatus: 'pass' },
+ *     { name: 'switched off', expectStatus: 'skip' },
+ *   ],
+ * });
+ * ```
+ *
+ * @extensionPoint option
+ * @stability experimental
+ */
+export interface DoctorCheckConformanceOptions {
+    /** The worlds to run in; one default scenario when omitted. */
+    readonly scenarios?: readonly DoctorCheckScenario[];
+    /** The ceiling for a check that declares no `timeoutMs` (default 5000, the service's). */
+    readonly defaultTimeoutMs?: number;
+    /** A test API to register on; defaults to the runner's globals. */
+    readonly testApi?: ConformanceTestApi;
+}
+/**
+ * Registers the Doctor check conformance cases for one check: identity, a
+ * guarded run, a valid outcome, read-only against both doubles, and no secret
+ * material, once per scenario.
+ *
+ * @param name - the check's id or a title for the `describe` block.
+ * @param factory - builds the check over the doubles, once per test.
+ * @param options - scenarios, the default timeout and the test API.
+ *
+ * @extensionPoint hook
+ * @stability experimental
+ */
+export declare function describeDoctorCheckConformance(name: string, factory: DoctorCheckFactory, options?: DoctorCheckConformanceOptions): void;
+//# sourceMappingURL=describe-doctor-check-conformance.d.ts.map