@marinoscar/platform-api 0.1.0-next.3 → 0.1.0-next.4

package/dist/storage/purge/run-storage-purge.d.ts

@@ -0,0 +1,179 @@
+/**
+ * `runStoragePurge`: what `npm run storage:purge`
+ * (`appctl deploy uninstall --purge-storage`) runs INSIDE the api image (issue #404; packaged in #736).
+ *
+ * =============================================================================
+ * ⚠ WHY THIS LIVES HERE AND NOT IN THE CLI
+ * =============================================================================
+ *
+ * The portable deploy specification assumes the bucket and credential are in
+ * the `.env`, and in this application they are not: since epic #372 the
+ * provider, bucket, region and endpoint are the `storage` system-settings
+ * namespace, and the secret access key is an encrypted row in `credentials`
+ * under a per-purpose sub-key derived by `CredentialsService`.
+ *
+ * The obvious port — query PostgreSQL from the CLI and decrypt there — was
+ * rejected for a concrete reason: `apps/cli/tsconfig.build.json` pins `rootDir`
+ * to `./src`, so the CLI PROVABLY CANNOT import from `apps/api`. Doing the
+ * crypto there would duplicate the sub-key label, the envelope layout AND the
+ * prefix list into a package that cannot import the originals — two modules
+ * required to agree with no mechanism to make them, which is the exact shape
+ * behind almost every defect this epic has fixed.
+ *
+ * Run inside the image, it calls the application's own cipher, its own
+ * `StorageConfigService` and its own `STORAGE_KEY_PREFIXES`, with the SDK
+ * already present. WHAT A PURGE OF THE ACTIVE BACKEND MEANS IS THE ACTIVE
+ * DRIVER'S: the S3 family's is version-aware (`drivers/s3/s3-purge.ts`), a
+ * driver that only lists keys (`StorageDriver.listKeys`) is purged by deleting
+ * each key through its provider, and a driver that offers neither is reported
+ * as `unsupported`. Credentials arrive by name through compose's `env_file`;
+ * the secret access key never leaves the container.
+ *
+ * =============================================================================
+ * ⚠ TWO PHASES, BECAUSE CONSENT NEEDS SOMETHING TO BE ABOUT
+ * =============================================================================
+ *
+ *   1. Default (`--json`): a DRY RUN. Counts objects and bytes under each
+ *      prefix and prints them. Deletes nothing. The CLI renders this and asks
+ *      the operator to type the bucket's name.
+ *   2. `--confirm --bucket <typed>`: re-checks the typed name against the LIVE
+ *      configuration *here*, inside the container, and refuses on a mismatch.
+ *      The confirmation is verified where the truth is, not only where it was
+ *      typed — a CLI that compared the name against its own copy would happily
+ *      approve a purge of whatever the application had been repointed at since.
+ *
+ * =============================================================================
+ * ⚠ VERSIONED BUCKETS, AND WHY UNKNOWN COUNTS AS VERSIONED
+ * =============================================================================
+ *
+ * A versioned bucket keeps every object version and a delete marker for each
+ * deletion, so `DeleteObject` on a listing leaves the data behind while
+ * reporting success. Versions are therefore enumerated and removed by id.
+ *
+ * When the versioning status cannot be READ — no permission, an S3-compatible
+ * endpoint that does not implement it — this treats the bucket as VERSIONED.
+ * Assuming the cheaper answer is exactly what produces silent retention, and
+ * silent retention is the one outcome a purge must never produce.
+ */
+import { type INestApplicationContext } from '@nestjs/common';
+import type { ResolvedStorageConfig } from '../config/storage-config';
+export type { StoragePurgeClient } from '../drivers/s3/s3-purge';
+import type { StoragePurgeClient } from '../drivers/s3/s3-purge';
+import '../drivers/builtin-storage-drivers';
+/**
+ * What the purge found (and, when not a dry run, deleted) under one prefix.
+ *
+ * @stability experimental
+ */
+export interface StoragePurgePrefixReport {
+    /** The registered root prefix. */
+    prefix: string;
+    /** Objects (or object versions) under it. */
+    objects: number;
+    /** Their bytes. */
+    bytes: number;
+}
+/**
+ * The JSON report `npm run storage:purge` prints and the CLI renders. Shape
+ * unchanged since #404.
+ *
+ * @stability experimental
+ */
+export interface StoragePurgeReport {
+    /** The live bucket (or container, or directory). */
+    bucket: string;
+    /** The live driver id. */
+    provider: string;
+    /** The live endpoint, or `null` for the SDK's own host. */
+    endpoint: string | null;
+    /** The bucket's versioning status; `unknown` is treated as versioned. */
+    versioning: 'enabled' | 'suspended' | 'unversioned' | 'unknown';
+    /** One entry per registered prefix, in registry order. */
+    prefixes: StoragePurgePrefixReport[];
+    /** Sums over {@link StoragePurgeReport.prefixes}. */
+    totals: {
+        /** Objects (or versions) under every prefix. */
+        objects: number;
+        /** Their bytes. */
+        bytes: number;
+    };
+    /** Objects, versions and delete markers deleted (0 on a dry run). */
+    deleted: number;
+    /** Whether nothing was deleted. */
+    dryRun: boolean;
+}
+/**
+ * Options of {@link runStoragePurge}.
+ *
+ * @stability experimental
+ */
+export interface StoragePurgeOptions {
+    /** `--confirm`: delete, after re-checking `bucket` against the LIVE configuration. Default: a dry run. */
+    confirm?: boolean;
+    /** `--bucket <typed>`: the bucket name the operator typed. */
+    bucket?: string;
+    /** Builds the active driver's own client from the live configuration; tests pass a fake. Default: the driver builds its own. */
+    createClient?: (config: ResolvedStorageConfig) => StoragePurgeClient;
+}
+/**
+ * The outcome of {@link runStoragePurge}.
+ *
+ * @stability experimental
+ */
+export type StoragePurgeOutcome = {
+    /** Storage was never configured: nothing to purge (not an error). */
+    kind: 'not-configured';
+} | {
+    /** `confirm` with a `bucket` that is not the live one: refused, nothing listed. */
+    kind: 'refused';
+    /** What was typed. */
+    typed: string | undefined;
+    /** The live bucket. */
+    bucket: string;
+} | {
+    /** The active driver can neither purge nor list its keys: nothing was done. */
+    kind: 'unsupported';
+    /** The live driver id. */
+    provider: string;
+} | {
+    /** The dry-run or deletion report. */
+    kind: 'report';
+    /** The report. */
+    report: StoragePurgeReport;
+};
+/**
+ * Purges (or, by default, counts) every object under every registered key
+ * prefix (`allKeyPrefixes()` of the booted app, platform and app prefixes
+ * alike) in the deployment's LIVE bucket. Targets come ONLY from the
+ * registry, never from a filtered listing of the whole bucket.
+ *
+ * @param app - the booted application context (`NestFactory.createApplicationContext(AppModule)`).
+ * @param opts - see {@link StoragePurgeOptions}.
+ * @returns what happened; see {@link StoragePurgeOutcome}.
+ *
+ * @example
+ * ```ts
+ * const outcome = await runStoragePurge(app, { confirm: false });
+ * ```
+ *
+ * @extensionPoint hook
+ * @stability experimental
+ */
+export declare function runStoragePurge(app: Pick<INestApplicationContext, 'get'>, opts?: StoragePurgeOptions): Promise<StoragePurgeOutcome>;
+/**
+ * The `npm run storage:purge` command line over {@link runStoragePurge}:
+ * `--confirm` and `--bucket <typed>` parsed from `argv`, the JSON written to
+ * `stdout`, a refusal to `stderr`. Output and exit codes unchanged since #404.
+ *
+ * @param app - the booted application context.
+ * @param argv - the process arguments (`process.argv`).
+ * @param io - where to write; defaults to the process streams.
+ * @returns the exit code: 0, 2 for a refused confirmation, or 3 when the active driver can neither purge nor list its keys.
+ *
+ * @stability experimental
+ */
+export declare function runStoragePurgeCli(app: Pick<INestApplicationContext, 'get'>, argv: readonly string[], io?: {
+    stdout: (text: string) => void;
+    stderr: (text: string) => void;
+}, createClient?: StoragePurgeOptions['createClient']): Promise<number>;
+//# sourceMappingURL=run-storage-purge.d.ts.map

package/dist/storage/purge/run-storage-purge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-storage-purge.d.ts","sourceRoot":"","sources":["../../../src/storage/purge/run-storage-purge.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,OAAO,EAAU,KAAK,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAEtE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAWtE,YAAY,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAEjE,OAAO,oCAAoC,CAAC;AAE5C;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,mBAAmB;IACnB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC;IACf,0BAA0B;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,yEAAyE;IACzE,UAAU,EAAE,SAAS,GAAG,WAAW,GAAG,aAAa,GAAG,SAAS,CAAC;IAChE,0DAA0D;IAC1D,QAAQ,EAAE,wBAAwB,EAAE,CAAC;IACrC,qDAAqD;IACrD,MAAM,EAAE;QACN,gDAAgD;QAChD,OAAO,EAAE,MAAM,CAAC;QAChB,mBAAmB;QACnB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IACF,qEAAqE;IACrE,OAAO,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,0GAA0G;IAC1G,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,8DAA8D;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gIAAgI;IAChI,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,qBAAqB,KAAK,kBAAkB,CAAC;CACtE;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAC3B;IACE,qEAAqE;IACrE,IAAI,EAAE,gBAAgB,CAAC;CACxB,GACD;IACE,mFAAmF;IACnF,IAAI,EAAE,SAAS,CAAC;IAChB,sBAAsB;IACtB,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;CAChB,GACD;IACE,+EAA+E;IAC/E,IAAI,EAAE,aAAa,CAAC;IACpB,0BAA0B;IAC1B,QAAQ,EAAE,MAAM,CAAC;CAClB,GACD;IACE,sCAAsC;IACtC,IAAI,EAAE,QAAQ,CAAC;IACf,kBAAkB;IAClB,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEN;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,eAAe,CACnC,GAAG,EAAE,IAAI,CAAC,uBAAuB,EAAE,KAAK,CAAC,EACzC,IAAI,GAAE,mBAAwB,GAC7B,OAAO,CAAC,mBAAmB,CAAC,CAkD9B;AAqCD;;;;;;;;;;;GAWG;AACH,wBAAsB,kBAAkB,CACtC,GAAG,EAAE,IAAI,CAAC,uBAAuB,EAAE,KAAK,CAAC,EACzC,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,EAAE,GAAE;IAAE,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAAC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;CAGnE,EACD,YAAY,CAAC,EAAE,mBAAmB,CAAC,cAAc,CAAC,GACjD,OAAO,CAAC,MAAM,CAAC,CA6BjB"}

package/dist/storage/purge/run-storage-purge.js

@@ -0,0 +1,205 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runStoragePurge = runStoragePurge;
+exports.runStoragePurgeCli = runStoragePurgeCli;
+/**
+ * `runStoragePurge`: what `npm run storage:purge`
+ * (`appctl deploy uninstall --purge-storage`) runs INSIDE the api image (issue #404; packaged in #736).
+ *
+ * =============================================================================
+ * ⚠ WHY THIS LIVES HERE AND NOT IN THE CLI
+ * =============================================================================
+ *
+ * The portable deploy specification assumes the bucket and credential are in
+ * the `.env`, and in this application they are not: since epic #372 the
+ * provider, bucket, region and endpoint are the `storage` system-settings
+ * namespace, and the secret access key is an encrypted row in `credentials`
+ * under a per-purpose sub-key derived by `CredentialsService`.
+ *
+ * The obvious port — query PostgreSQL from the CLI and decrypt there — was
+ * rejected for a concrete reason: `apps/cli/tsconfig.build.json` pins `rootDir`
+ * to `./src`, so the CLI PROVABLY CANNOT import from `apps/api`. Doing the
+ * crypto there would duplicate the sub-key label, the envelope layout AND the
+ * prefix list into a package that cannot import the originals — two modules
+ * required to agree with no mechanism to make them, which is the exact shape
+ * behind almost every defect this epic has fixed.
+ *
+ * Run inside the image, it calls the application's own cipher, its own
+ * `StorageConfigService` and its own `STORAGE_KEY_PREFIXES`, with the SDK
+ * already present. WHAT A PURGE OF THE ACTIVE BACKEND MEANS IS THE ACTIVE
+ * DRIVER'S: the S3 family's is version-aware (`drivers/s3/s3-purge.ts`), a
+ * driver that only lists keys (`StorageDriver.listKeys`) is purged by deleting
+ * each key through its provider, and a driver that offers neither is reported
+ * as `unsupported`. Credentials arrive by name through compose's `env_file`;
+ * the secret access key never leaves the container.
+ *
+ * =============================================================================
+ * ⚠ TWO PHASES, BECAUSE CONSENT NEEDS SOMETHING TO BE ABOUT
+ * =============================================================================
+ *
+ *   1. Default (`--json`): a DRY RUN. Counts objects and bytes under each
+ *      prefix and prints them. Deletes nothing. The CLI renders this and asks
+ *      the operator to type the bucket's name.
+ *   2. `--confirm --bucket <typed>`: re-checks the typed name against the LIVE
+ *      configuration *here*, inside the container, and refuses on a mismatch.
+ *      The confirmation is verified where the truth is, not only where it was
+ *      typed — a CLI that compared the name against its own copy would happily
+ *      approve a purge of whatever the application had been repointed at since.
+ *
+ * =============================================================================
+ * ⚠ VERSIONED BUCKETS, AND WHY UNKNOWN COUNTS AS VERSIONED
+ * =============================================================================
+ *
+ * A versioned bucket keeps every object version and a delete marker for each
+ * deletion, so `DeleteObject` on a listing leaves the data behind while
+ * reporting success. Versions are therefore enumerated and removed by id.
+ *
+ * When the versioning status cannot be READ — no permission, an S3-compatible
+ * endpoint that does not implement it — this treats the bucket as VERSIONED.
+ * Assuming the cheaper answer is exactly what produces silent retention, and
+ * silent retention is the one outcome a purge must never produce.
+ */
+const common_1 = require("@nestjs/common");
+const storage_config_service_1 = require("../config/storage-config.service");
+const storage_driver_1 = require("../drivers/storage-driver");
+const storage_key_prefix_registry_1 = require("../storage-key-prefix.registry");
+const storage_options_1 = require("../storage.options");
+// The built-in drivers register on import: whatever resolves a driver by id finds them.
+require("../drivers/builtin-storage-drivers");
+/**
+ * Purges (or, by default, counts) every object under every registered key
+ * prefix (`allKeyPrefixes()` of the booted app, platform and app prefixes
+ * alike) in the deployment's LIVE bucket. Targets come ONLY from the
+ * registry, never from a filtered listing of the whole bucket.
+ *
+ * @param app - the booted application context (`NestFactory.createApplicationContext(AppModule)`).
+ * @param opts - see {@link StoragePurgeOptions}.
+ * @returns what happened; see {@link StoragePurgeOutcome}.
+ *
+ * @example
+ * ```ts
+ * const outcome = await runStoragePurge(app, { confirm: false });
+ * ```
+ *
+ * @extensionPoint hook
+ * @stability experimental
+ */
+async function runStoragePurge(app, opts = {}) {
+    const storage = app.get(storage_config_service_1.StorageConfigService, { strict: false });
+    const config = await storage.resolveActiveConfig({ fresh: true });
+    if (config === null)
+        return { kind: 'not-configured' };
+    const confirm = opts.confirm === true;
+    if (confirm && opts.bucket !== config.bucket) {
+        // Verified HERE, against the live configuration, not against whatever the
+        // CLI last read.
+        return { kind: 'refused', typed: opts.bucket, bucket: config.bucket };
+    }
+    const driver = (0, storage_driver_1.requireStorageDriver)(config.provider);
+    // The purge runs in a bare application context with no HTTP request: the
+    // driver gets its settings, its secrets and the default part size.
+    const ctx = {
+        settings: config.settings,
+        secret: async (name) => config.secrets[name] ?? null,
+        logger: new common_1.Logger('StoragePurge'),
+        partSize: storage_options_1.DEFAULT_STORAGE_PART_SIZE_BYTES,
+    };
+    const input = { prefixes: (0, storage_key_prefix_registry_1.allKeyPrefixes)(), dryRun: !confirm };
+    let result;
+    if (driver.purge) {
+        result = await driver.purge(ctx, { ...input, ...(opts.createClient ? { client: opts.createClient(config) } : {}) });
+    }
+    else if (driver.listKeys) {
+        result = await purgeByListing(driver, ctx, input);
+    }
+    else {
+        return { kind: 'unsupported', provider: config.provider };
+    }
+    return {
+        kind: 'report',
+        report: {
+            bucket: config.bucket,
+            provider: config.provider,
+            endpoint: config.endpoint ?? null,
+            versioning: result.versioning,
+            prefixes: result.prefixes,
+            totals: {
+                objects: result.prefixes.reduce((sum, entry) => sum + entry.objects, 0),
+                bytes: result.prefixes.reduce((sum, entry) => sum + entry.bytes, 0),
+            },
+            deleted: result.deleted,
+            dryRun: input.dryRun,
+        },
+    };
+}
+/**
+ * The generic purge: list every key under each prefix with the driver's
+ * `listKeys`, and (unless a dry run) delete each through the provider the
+ * driver builds. Sizes are not known without a `HEAD` per key, so `bytes` is 0.
+ */
+async function purgeByListing(driver, ctx, input) {
+    const provider = input.dryRun ? undefined : await driver.build(ctx);
+    const prefixes = [];
+    let deleted = 0;
+    try {
+        for (const prefix of input.prefixes) {
+            const report = { prefix, objects: 0, bytes: 0 };
+            for await (const key of driver.listKeys(ctx, prefix)) {
+                report.objects += 1;
+                if (provider) {
+                    await provider.delete(key);
+                    deleted += 1;
+                }
+            }
+            prefixes.push(report);
+        }
+    }
+    finally {
+        provider?.destroy?.();
+    }
+    return { versioning: 'unversioned', prefixes, deleted };
+}
+/**
+ * The `npm run storage:purge` command line over {@link runStoragePurge}:
+ * `--confirm` and `--bucket <typed>` parsed from `argv`, the JSON written to
+ * `stdout`, a refusal to `stderr`. Output and exit codes unchanged since #404.
+ *
+ * @param app - the booted application context.
+ * @param argv - the process arguments (`process.argv`).
+ * @param io - where to write; defaults to the process streams.
+ * @returns the exit code: 0, 2 for a refused confirmation, or 3 when the active driver can neither purge nor list its keys.
+ *
+ * @stability experimental
+ */
+async function runStoragePurgeCli(app, argv, io = {
+    stdout: (text) => void process.stdout.write(text),
+    stderr: (text) => void process.stderr.write(text),
+}, createClient) {
+    const flag = (name) => argv.includes(`--${name}`);
+    const value = (name) => {
+        const index = argv.indexOf(`--${name}`);
+        return index === -1 ? undefined : argv[index + 1];
+    };
+    const outcome = await runStoragePurge(app, {
+        confirm: flag('confirm'),
+        bucket: value('bucket'),
+        ...(createClient ? { createClient } : {}),
+    });
+    if (outcome.kind === 'not-configured') {
+        // Not an error: a deployment that never configured storage has nothing
+        // to purge, and saying so is more useful than failing.
+        io.stdout(`${JSON.stringify({ configured: false, reason: 'object storage is not configured for this deployment' })}\n`);
+        return 0;
+    }
+    if (outcome.kind === 'refused') {
+        io.stderr(`Refusing: --bucket was ${String(outcome.typed)} but this deployment's bucket is ${outcome.bucket}.\n`);
+        return 2;
+    }
+    if (outcome.kind === 'unsupported') {
+        io.stderr(`The ${outcome.provider} storage driver can neither purge nor list its keys; nothing was done.\n`);
+        return 3;
+    }
+    io.stdout(`${JSON.stringify(outcome.report, null, 2)}\n`);
+    return 0;
+}
+//# sourceMappingURL=run-storage-purge.js.map

package/dist/storage/purge/run-storage-purge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-storage-purge.js","sourceRoot":"","sources":["../../../src/storage/purge/run-storage-purge.ts"],"names":[],"mappings":";;AAsLA,0CAqDC;AAiDD,gDAqCC;AAjUD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,2CAAsE;AAGtE,6EAAwE;AACxE,8DAKmC;AACnC,gFAAgE;AAChE,wDAAqE;AAIrE,wFAAwF;AACxF,8CAA4C;AA2F5C;;;;;;;;;;;;;;;;;GAiBG;AACI,KAAK,UAAU,eAAe,CACnC,GAAyC,EACzC,OAA4B,EAAE;IAE9B,MAAM,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,6CAAoB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IACjE,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAElE,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAEvD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC;IACtC,IAAI,OAAO,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;QAC7C,0EAA0E;QAC1E,iBAAiB;QACjB,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;IACxE,CAAC;IAED,MAAM,MAAM,GAAG,IAAA,qCAAoB,EAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACrD,yEAAyE;IACzE,mEAAmE;IACnE,MAAM,GAAG,GAAyB;QAChC,QAAQ,EAAE,MAAM,CAAC,QAAmC;QACpD,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI;QACpD,MAAM,EAAE,IAAI,eAAM,CAAC,cAAc,CAAC;QAClC,QAAQ,EAAE,iDAA+B;KAC1C,CAAC;IACF,MAAM,KAAK,GAAG,EAAE,QAAQ,EAAE,IAAA,4CAAc,GAAE,EAAE,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC;IAE/D,IAAI,MAAgC,CAAC;IAErC,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,GAAG,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACtH,CAAC;SAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC3B,MAAM,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;SAAM,CAAC;QACN,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC;IAC5D,CAAC;IAED,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE;YACN,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,IAAI;YACjC,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,MAAM,EAAE;gBACN,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;gBACvE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;aACpE;YACD,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,MAAM,EAAE,KAAK,CAAC,MAAM;SACrB;KACF,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,cAAc,CAC3B,MAAqB,EACrB,GAAyB,EACzB,KAAuD;IAEvD,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACpE,MAAM,QAAQ,GAA+B,EAAE,CAAC;IAChD,IAAI,OAAO,GAAG,CAAC,CAAC;IAEhB,IAAI,CAAC;QACH,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACpC,MAAM,MAAM,GAA6B,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;YAE1E,IAAI,KAAK,EAAE,MAAM,GAAG,IAAK,MAAM,CAAC,QAAmD,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC;gBACjG,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;gBACpB,IAAI,QAAQ,EAAE,CAAC;oBACb,MAAM,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;oBAC3B,OAAO,IAAI,CAAC,CAAC;gBACf,CAAC;YACH,CAAC;YAED,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;YAAS,CAAC;QACR,QAAiD,EAAE,OAAO,EAAE,EAAE,CAAC;IAClE,CAAC;IAED,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AAC1D,CAAC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,kBAAkB,CACtC,GAAyC,EACzC,IAAuB,EACvB,KAAyE;IACvE,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;IACjD,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;CAClD,EACD,YAAkD;IAElD,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IAC1D,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,EAAE;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;QACxC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,GAAG,EAAE;QACzC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;QACxB,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC;QACvB,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC1C,CAAC,CAAC;IAEH,IAAI,OAAO,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;QACtC,uEAAuE;QACvE,uDAAuD;QACvD,EAAE,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,sDAAsD,EAAE,CAAC,IAAI,CAAC,CAAC;QACxH,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC/B,EAAE,CAAC,MAAM,CAAC,0BAA0B,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,oCAAoC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC;QAClH,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;QACnC,EAAE,CAAC,MAAM,CAAC,OAAO,OAAO,CAAC,QAAQ,0EAA0E,CAAC,CAAC;QAC7G,OAAO,CAAC,CAAC;IACX,CAAC;IACD,EAAE,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;IAC1D,OAAO,CAAC,CAAC;AACX,CAAC"}

package/dist/storage/status/dto/storage-status.dto.d.ts

@@ -0,0 +1,14 @@
+import { storageStatusResponseSchema } from '@marinoscar/platform-contract/storage';
+export { storageStatusResponseSchema };
+export type { StorageStatusResponse } from '@marinoscar/platform-contract/storage';
+declare const StorageStatusResponseDto_base: import("nestjs-zod").ZodDto<import("zod").ZodObject<{
+    configured: import("zod").ZodBoolean;
+}, import("zod/v4/core").$strip>, false>;
+/**
+ * `storageStatusResponseSchema` (`@marinoscar/platform-contract/storage`) as a Nest DTO: the OpenAPI component and the validated body or response.
+ *
+ * @stability experimental
+ */
+export declare class StorageStatusResponseDto extends StorageStatusResponseDto_base {
+}
+//# sourceMappingURL=storage-status.dto.d.ts.map

package/dist/storage/status/dto/storage-status.dto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-status.dto.d.ts","sourceRoot":"","sources":["../../../../src/storage/status/dto/storage-status.dto.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,2BAA2B,EAAE,MAAM,uCAAuC,CAAC;AAEpF,OAAO,EAAE,2BAA2B,EAAE,CAAC;AACvC,YAAY,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;;;;AAEnF;;;;GAIG;AACH,qBAAa,wBAAyB,SAAQ,6BAAyC;CAAG"}

package/dist/storage/status/dto/storage-status.dto.js

@@ -0,0 +1,19 @@
+"use strict";
+// The wire schemas live in `@marinoscar/platform-contract/storage` (#736),
+// with their design notes; this file wraps them as Nest DTOs (the OpenAPI
+// component names are these class names) and re-exports them under their
+// old names, so no import in the slice changed.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorageStatusResponseDto = exports.storageStatusResponseSchema = void 0;
+const nestjs_zod_1 = require("nestjs-zod");
+const storage_1 = require("@marinoscar/platform-contract/storage");
+Object.defineProperty(exports, "storageStatusResponseSchema", { enumerable: true, get: function () { return storage_1.storageStatusResponseSchema; } });
+/**
+ * `storageStatusResponseSchema` (`@marinoscar/platform-contract/storage`) as a Nest DTO: the OpenAPI component and the validated body or response.
+ *
+ * @stability experimental
+ */
+class StorageStatusResponseDto extends (0, nestjs_zod_1.createZodDto)(storage_1.storageStatusResponseSchema) {
+}
+exports.StorageStatusResponseDto = StorageStatusResponseDto;
+//# sourceMappingURL=storage-status.dto.js.map

package/dist/storage/status/dto/storage-status.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-status.dto.js","sourceRoot":"","sources":["../../../../src/storage/status/dto/storage-status.dto.ts"],"names":[],"mappings":";AAAA,2EAA2E;AAC3E,0EAA0E;AAC1E,yEAAyE;AACzE,gDAAgD;;;AAEhD,2CAA0C;AAC1C,mEAAoF;AAE3E,4GAFA,qCAA2B,OAEA;AAGpC;;;;GAIG;AACH,MAAa,wBAAyB,SAAQ,IAAA,yBAAY,EAAC,qCAA2B,CAAC;CAAG;AAA1F,4DAA0F"}

package/dist/storage/status/storage-status.controller.d.ts

@@ -0,0 +1,16 @@
+import { StorageConfigService } from '../config/storage-config.service';
+import { StorageStatusResponse } from './dto/storage-status.dto';
+/**
+ * `GET /api/storage/status` (`storage:read`): whether object storage is configured.
+ *
+ * @internal
+ *
+ * @stability experimental
+ */
+export declare class StorageStatusController {
+    private readonly storageConfig;
+    private readonly logger;
+    constructor(storageConfig: StorageConfigService);
+    getStatus(): Promise<StorageStatusResponse>;
+}
+//# sourceMappingURL=storage-status.controller.d.ts.map

package/dist/storage/status/storage-status.controller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-status.controller.d.ts","sourceRoot":"","sources":["../../../src/storage/status/storage-status.controller.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAA4B,MAAM,0BAA0B,CAAC;AAE3F;;;;;;GAMG;AACH,qBAEa,uBAAuB;IAGtB,OAAO,CAAC,QAAQ,CAAC,aAAa;IAF1C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA4C;gBAEtC,aAAa,EAAE,oBAAoB;IAe1D,SAAS,IAAI,OAAO,CAAC,qBAAqB,CAAC;CAYlD"}

package/dist/storage/status/storage-status.controller.js

@@ -0,0 +1,85 @@
+"use strict";
+// =============================================================================
+// /api/storage/status — is object storage usable at all?
+// =============================================================================
+//
+// For every `storage:read` holder, so the web app can replace an upload control
+// that would fail with a "not enabled yet" notice. It answers ONE boolean and
+// never the provider, bucket, region or any credential: those stay behind
+// `storage_config:read` on `/api/admin/storage`.
+//
+// The completeness rule is not restated here: the answer is exactly whether
+// the Doctor's `storage.config` decision (`decideStorageConfig`) would pass on
+// the resolved configuration. Cheap and read-only: a settings read through the
+// service's short cache plus the credential lookup, never a bucket round trip.
+// A configuration that cannot be read at all is reported as not configured,
+// which is what the Doctor reports for it too.
+// =============================================================================
+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 StorageStatusController_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorageStatusController = void 0;
+const common_1 = require("@nestjs/common");
+const swagger_1 = require("@nestjs/swagger");
+const index_1 = require("../../identity/index");
+const index_2 = require("../../core/index");
+const storage_constants_1 = require("../storage.constants");
+const storage_config_doctor_check_1 = require("../config/doctor/storage-config.doctor-check");
+const storage_config_service_1 = require("../config/storage-config.service");
+const storage_status_dto_1 = require("./dto/storage-status.dto");
+/**
+ * `GET /api/storage/status` (`storage:read`): whether object storage is configured.
+ *
+ * @internal
+ *
+ * @stability experimental
+ */
+let StorageStatusController = StorageStatusController_1 = class StorageStatusController {
+    storageConfig;
+    logger = new common_1.Logger(StorageStatusController_1.name);
+    constructor(storageConfig) {
+        this.storageConfig = storageConfig;
+    }
+    async getStatus() {
+        try {
+            const resolution = await this.storageConfig.resolve();
+            return { configured: (0, storage_config_doctor_check_1.decideStorageConfig)(resolution).status === 'pass' };
+        }
+        catch (error) {
+            this.logger.warn(`Storage configuration unreadable for status: ${error instanceof Error ? error.message : String(error)}`);
+            return { configured: false };
+        }
+    }
+};
+exports.StorageStatusController = StorageStatusController;
+__decorate([
+    (0, common_1.Get)(),
+    (0, index_1.Auth)({ permissions: [storage_constants_1.PERMISSIONS.STORAGE_READ] }),
+    (0, swagger_1.ApiOperation)({
+        summary: 'Is object storage configured?',
+        description: 'Returns `{ configured }`: `true` when the object-storage configuration is complete, the ' +
+            'same rule the Doctor\'s `storage.config` check applies. Lets a client show a ' +
+            '"not enabled yet" notice instead of an upload control that would fail.\n\n' +
+            'Never returns the provider, bucket, region or any credential. Read-only and cheap: ' +
+            'no request reaches the object store. A configuration that cannot be read is reported ' +
+            'as `configured: false`.',
+    }),
+    (0, index_2.ApiDataResponse)(storage_status_dto_1.StorageStatusResponseDto, { description: 'Whether object storage is configured.' }),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], StorageStatusController.prototype, "getStatus", null);
+exports.StorageStatusController = StorageStatusController = StorageStatusController_1 = __decorate([
+    (0, swagger_1.ApiTags)('Storage'),
+    (0, common_1.Controller)('storage/status'),
+    __metadata("design:paramtypes", [storage_config_service_1.StorageConfigService])
+], StorageStatusController);
+//# sourceMappingURL=storage-status.controller.js.map

package/dist/storage/status/storage-status.controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-status.controller.js","sourceRoot":"","sources":["../../../src/storage/status/storage-status.controller.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,yDAAyD;AACzD,gFAAgF;AAChF,EAAE;AACF,gFAAgF;AAChF,8EAA8E;AAC9E,0EAA0E;AAC1E,iDAAiD;AACjD,EAAE;AACF,4EAA4E;AAC5E,+EAA+E;AAC/E,+EAA+E;AAC/E,+EAA+E;AAC/E,4EAA4E;AAC5E,+CAA+C;AAC/C,gFAAgF;;;;;;;;;;;;;AAEhF,2CAAyD;AACzD,6CAAwD;AAExD,gDAA4C;AAC5C,4CAAmD;AACnD,4DAAmD;AACnD,8FAAmF;AACnF,6EAAwE;AACxE,iEAA2F;AAE3F;;;;;;GAMG;AAGI,IAAM,uBAAuB,+BAA7B,MAAM,uBAAuB;IAGL;IAFZ,MAAM,GAAG,IAAI,eAAM,CAAC,yBAAuB,CAAC,IAAI,CAAC,CAAC;IAEnE,YAA6B,aAAmC;QAAnC,kBAAa,GAAb,aAAa,CAAsB;IAAG,CAAC;IAe9D,AAAN,KAAK,CAAC,SAAS;QACb,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;YAEtD,OAAO,EAAE,UAAU,EAAE,IAAA,iDAAmB,EAAC,UAAU,CAAC,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;QAC3E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,gDAAgD,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CACzG,CAAC;YACF,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;QAC/B,CAAC;IACH,CAAC;CACF,CAAA;AA9BY,0DAAuB;AAkB5B;IAbL,IAAA,YAAG,GAAE;IACL,IAAA,YAAI,EAAC,EAAE,WAAW,EAAE,CAAC,+BAAW,CAAC,YAAY,CAAC,EAAE,CAAC;IACjD,IAAA,sBAAY,EAAC;QACZ,OAAO,EAAE,+BAA+B;QACxC,WAAW,EACT,0FAA0F;YAC1F,+EAA+E;YAC/E,4EAA4E;YAC5E,qFAAqF;YACrF,uFAAuF;YACvF,yBAAyB;KAC5B,CAAC;IACD,IAAA,uBAAe,EAAC,6CAAwB,EAAE,EAAE,WAAW,EAAE,uCAAuC,EAAE,CAAC;;;;wDAYnG;kCA7BU,uBAAuB;IAFnC,IAAA,iBAAO,EAAC,SAAS,CAAC;IAClB,IAAA,mBAAU,EAAC,gBAAgB,CAAC;qCAIiB,6CAAoB;GAHrD,uBAAuB,CA8BnC"}

package/dist/storage/storage-credential.constants.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Credential store address for the storage secret access key: the sub-key
+ * domain.
+ *
+ * `purpose` is also the AES-GCM sub-key domain (see `CredentialsService`), so
+ * changing this string orphans every already-stored secret access key — they
+ * remain in the table and become permanently unreadable. It is not a rename.
+ *
+ * @stability experimental
+ */
+export declare const STORAGE_CREDENTIAL_PURPOSE = "storage";
+/**
+ * Discriminator within the purpose. 'default' because this app talks to one
+ * object store; a future multi-bucket or multi-provider setup keys additional
+ * rows by provider id without touching anything above.
+ *
+ * @stability experimental
+ */
+export declare const STORAGE_CREDENTIAL_NAME = "default";
+/**
+ * Human label written alongside the stored secret access key.
+ *
+ * NON-SECRET, and it must stay that way: `CredentialMeta` carries a
+ * compile-time proof that it has no secret-bearing field, and this string is
+ * shown verbatim in any credential listing. It exists so a row in that listing
+ * says what it is for rather than only `storage/default`.
+ *
+ * @stability experimental
+ */
+export declare const STORAGE_CREDENTIAL_LABEL = "Storage secret access key";
+/**
+ * The `storage` purpose's declaration for the credential purpose registry
+ * (#735), registered by `platform/credentials/credential-purposes.manifest.ts`.
+ *
+ * @stability experimental
+ */
+export declare const STORAGE_CREDENTIAL_PURPOSE_DEF: {
+    /** The purpose (and cipher sub-key domain). */
+    readonly purpose: "storage";
+    /** The owning slice. */
+    readonly owner: "storage";
+    /** The admin label. */
+    readonly label: "Storage secret access key";
+    /** Deployment-wide only. */
+    readonly tiers: readonly ["system"];
+};
+//# sourceMappingURL=storage-credential.constants.d.ts.map

package/dist/storage/storage-credential.constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-credential.constants.d.ts","sourceRoot":"","sources":["../../src/storage/storage-credential.constants.ts"],"names":[],"mappings":"AAyCA;;;;;;;;;GASG;AACH,eAAO,MAAM,0BAA0B,YAAY,CAAC;AAEpD;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,YAAY,CAAC;AAEjD;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB,8BAA8B,CAAC;AAEpE;;;;;GAKG;AACH,eAAO,MAAM,8BAA8B;IACzC,+CAA+C;;IAE/C,wBAAwB;;IAExB,uBAAuB;;IAEvB,4BAA4B;;CAEW,CAAC"}