@ddd-ts-kit/kernel 0.8.0 → 0.10.0

package/dist/application/files/content-matches.js

@@ -0,0 +1,39 @@
+import { signatureOf } from './signature-of.js';
+import { mediaTypeOf } from './media-type-of.js';
+/** Office and e-book documents are zip archives: their signature is the one of a zip. */
+const ZIP_CONTAINERS = new Set([
+    'application/zip',
+    'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+    'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+    'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+    'application/vnd.oasis.opendocument.text',
+    'application/vnd.oasis.opendocument.spreadsheet',
+    'application/epub+zip',
+]);
+/** Text has no signature: it is accepted when its first bytes are UTF-8 without control characters. */
+const TEXT_TYPES = new Set(['text/plain', 'text/csv', 'text/markdown', 'application/json']);
+/** Tab, line feed, form feed and carriage return are text; every other C0 control character is not. */
+const TEXT_CONTROLS = new Set([9, 10, 12, 13]);
+/**
+ * Whether the first bytes of a content are what its declared media type says, read on the bytes
+ * and never on a file name: a PDF starts with `%PDF-`, a PNG with its eight bytes. A binary
+ * format the kit does not recognise, SVG included, never matches.
+ */
+export function contentMatches(head, declared) {
+    const essence = mediaTypeOf(declared);
+    const signature = signatureOf(head);
+    if (signature !== undefined) {
+        return signature === essence || (signature === 'application/zip' && ZIP_CONTAINERS.has(essence));
+    }
+    return TEXT_TYPES.has(essence) && looksLikeText(head);
+}
+function looksLikeText(head) {
+    try {
+        new TextDecoder('utf-8', { fatal: true }).decode(head, { stream: true });
+    }
+    catch {
+        return false;
+    }
+    return head.every((byte) => byte >= 32 || TEXT_CONTROLS.has(byte));
+}
+//# sourceMappingURL=content-matches.js.map

package/dist/application/files/content-matches.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-matches.js","sourceRoot":"","sources":["../../../src/application/files/content-matches.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,yFAAyF;AACzF,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC;IAC7B,iBAAiB;IACjB,yEAAyE;IACzE,mEAAmE;IACnE,2EAA2E;IAC3E,yCAAyC;IACzC,gDAAgD;IAChD,sBAAsB;CACvB,CAAC,CAAC;AAEH,uGAAuG;AACvG,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,YAAY,EAAE,UAAU,EAAE,eAAe,EAAE,kBAAkB,CAAC,CAAC,CAAC;AAE5F,uGAAuG;AACvG,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;AAE/C;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,IAAgB,EAAE,QAAgB;IAC/D,MAAM,OAAO,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;IACtC,MAAM,SAAS,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAEpC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,SAAS,KAAK,OAAO,IAAI,CAAC,SAAS,KAAK,iBAAiB,IAAI,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;IACnG,CAAC;IAED,OAAO,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,aAAa,CAAC,IAAgB;IACrC,IAAI,CAAC;QACH,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,EAAE,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AACrE,CAAC"}

package/dist/application/files/download-url-options.d.ts

@@ -0,0 +1,7 @@
+export interface DownloadUrlOptions {
+    /** Short: at most `MAX_SIGNED_URL_SECONDS`. A link leaks with the page, the log or the mail that holds it. */
+    readonly expiresInSeconds: number;
+    /** Offered to the browser as the name to save under (`Content-Disposition: attachment`). */
+    readonly fileName?: string;
+}
+//# sourceMappingURL=download-url-options.d.ts.map

package/dist/application/files/download-url-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"download-url-options.d.ts","sourceRoot":"","sources":["../../../src/application/files/download-url-options.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB;IACjC,8GAA8G;IAC9G,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,4FAA4F;IAC5F,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B"}

package/dist/application/files/download-url-options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=download-url-options.js.map

package/dist/application/files/download-url-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"download-url-options.js","sourceRoot":"","sources":["../../../src/application/files/download-url-options.ts"],"names":[],"mappings":""}

package/dist/application/files/file-content.d.ts

@@ -0,0 +1,8 @@
+import type { Readable } from 'node:stream';
+import type { FileMetadata } from './file-metadata.js';
+/** A file being read: what the storage knows of it, and its content as a stream to consume once. */
+export interface FileContent {
+    readonly metadata: FileMetadata;
+    readonly stream: Readable;
+}
+//# sourceMappingURL=file-content.d.ts.map

package/dist/application/files/file-content.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-content.d.ts","sourceRoot":"","sources":["../../../src/application/files/file-content.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvD,oGAAoG;AACpG,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;CAC3B"}

package/dist/application/files/file-content.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=file-content.js.map

package/dist/application/files/file-content.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-content.js","sourceRoot":"","sources":["../../../src/application/files/file-content.ts"],"names":[],"mappings":""}

package/dist/application/files/file-error.d.ts

@@ -0,0 +1,28 @@
+import { ConceptError } from '../../domain/errors/concept-error.js';
+/**
+ * The refusals of a file. `FILE_TOO_LARGE` and `UNSUPPORTED_MEDIA_TYPE` are answered 413 and 415
+ * by `@ddd-ts-kit/http`; the key itself never leaves the process.
+ */
+export declare class FileError extends ConceptError {
+    static tooLarge(maxBytes: number): import("../../index.js").Refusal<FileError, "FILE_TOO_LARGE", {
+        readonly maxBytes: number;
+    }>;
+    static unsupportedMediaType(mediaType: string, accepted: readonly string[]): import("../../index.js").Refusal<FileError, "UNSUPPORTED_MEDIA_TYPE", {
+        readonly mediaType: string;
+        readonly accepted: string;
+    }>;
+    static notFound(key: string): import("../../index.js").Refusal<FileError, "FILE_NOT_FOUND", {
+        readonly key: string;
+    }>;
+    static invalidKey(key: string): import("../../index.js").Refusal<FileError, "INVALID_FILE_KEY", {
+        readonly key: string;
+    }>;
+    static rejected(key: string, reason: string): import("../../index.js").Refusal<FileError, "FILE_REJECTED", {
+        readonly key: string;
+        readonly reason: string;
+    }>;
+    static invalidExpiry(seconds: number): import("../../index.js").Refusal<FileError, "INVALID_FILE_URL_EXPIRY", {
+        readonly seconds: number;
+    }>;
+}
+//# sourceMappingURL=file-error.d.ts.map

package/dist/application/files/file-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-error.d.ts","sourceRoot":"","sources":["../../../src/application/files/file-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAGpE;;;GAGG;AACH,qBAAa,SAAU,SAAQ,YAAY;IACzC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM;;OAI/B;IAED,MAAM,CAAC,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,MAAM,EAAE;;;OAMzE;IAED,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM;;OAE1B;IAED,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM;;OAM5B;IAED,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;;;OAE1C;IAED,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM;;OAMnC;CACF"}

package/dist/application/files/file-error.js

@@ -0,0 +1,29 @@
+import { ConceptError } from '../../domain/errors/concept-error.js';
+import { MAX_SIGNED_URL_SECONDS } from './max-signed-url-seconds.js';
+/**
+ * The refusals of a file. `FILE_TOO_LARGE` and `UNSUPPORTED_MEDIA_TYPE` are answered 413 and 415
+ * by `@ddd-ts-kit/http`; the key itself never leaves the process.
+ */
+export class FileError extends ConceptError {
+    static tooLarge(maxBytes) {
+        return FileError.refusal('FILE_TOO_LARGE', `The file is larger than ${String(maxBytes)} bytes.`, {
+            maxBytes,
+        }).exposing('maxBytes');
+    }
+    static unsupportedMediaType(mediaType, accepted) {
+        return FileError.refusal('UNSUPPORTED_MEDIA_TYPE', `The content is not one of ${accepted.join(', ')} (declared ${mediaType}).`, { mediaType, accepted: accepted.join(',') }).exposing('accepted');
+    }
+    static notFound(key) {
+        return FileError.refusal('FILE_NOT_FOUND', 'No file is stored under this key.', { key });
+    }
+    static invalidKey(key) {
+        return FileError.refusal('INVALID_FILE_KEY', 'A file key is made of segments of letters, digits, dots, hyphens and underscores, none starting with a dot.', { key });
+    }
+    static rejected(key, reason) {
+        return FileError.refusal('FILE_REJECTED', `The content was refused: ${reason}.`, { key, reason });
+    }
+    static invalidExpiry(seconds) {
+        return FileError.refusal('INVALID_FILE_URL_EXPIRY', `A signed link lives between 1 and ${String(MAX_SIGNED_URL_SECONDS)} seconds, not ${String(seconds)}.`, { seconds });
+    }
+}
+//# sourceMappingURL=file-error.js.map

package/dist/application/files/file-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-error.js","sourceRoot":"","sources":["../../../src/application/files/file-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;;GAGG;AACH,MAAM,OAAO,SAAU,SAAQ,YAAY;IACzC,MAAM,CAAC,QAAQ,CAAC,QAAgB;QAC9B,OAAO,SAAS,CAAC,OAAO,CAAC,gBAAgB,EAAE,2BAA2B,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE;YAC/F,QAAQ;SACT,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAC1B,CAAC;IAED,MAAM,CAAC,oBAAoB,CAAC,SAAiB,EAAE,QAA2B;QACxE,OAAO,SAAS,CAAC,OAAO,CACtB,wBAAwB,EACxB,6BAA6B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,SAAS,IAAI,EAC3E,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAC5C,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,GAAW;QACzB,OAAO,SAAS,CAAC,OAAO,CAAC,gBAAgB,EAAE,mCAAmC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,GAAW;QAC3B,OAAO,SAAS,CAAC,OAAO,CACtB,kBAAkB,EAClB,6GAA6G,EAC7G,EAAE,GAAG,EAAE,CACR,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,GAAW,EAAE,MAAc;QACzC,OAAO,SAAS,CAAC,OAAO,CAAC,eAAe,EAAE,4BAA4B,MAAM,GAAG,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;IACpG,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,OAAe;QAClC,OAAO,SAAS,CAAC,OAAO,CACtB,yBAAyB,EACzB,qCAAqC,MAAM,CAAC,sBAAsB,CAAC,iBAAiB,MAAM,CAAC,OAAO,CAAC,GAAG,EACtG,EAAE,OAAO,EAAE,CACZ,CAAC;IACJ,CAAC;CACF"}

package/dist/application/files/file-metadata.d.ts

@@ -0,0 +1,10 @@
+/** What a storage knows of a file it holds, without reading the content. */
+export interface FileMetadata {
+    readonly key: string;
+    readonly size: number;
+    readonly mediaType: string;
+    readonly lastModified: Date;
+    /** `sha256:<hex>`, when the connector keeps it: the S3 connector does not. */
+    readonly checksum?: string;
+}
+//# sourceMappingURL=file-metadata.d.ts.map

package/dist/application/files/file-metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-metadata.d.ts","sourceRoot":"","sources":["../../../src/application/files/file-metadata.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAC;IAC5B,8EAA8E;IAC9E,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B"}

package/dist/application/files/file-metadata.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=file-metadata.js.map

package/dist/application/files/file-metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-metadata.js","sourceRoot":"","sources":["../../../src/application/files/file-metadata.ts"],"names":[],"mappings":""}

package/dist/application/files/file-source.d.ts

@@ -0,0 +1,4 @@
+import type { Readable } from 'node:stream';
+/** The content handed to a storage: always a stream of chunks, never the whole file in memory. */
+export type FileSource = Readable | AsyncIterable<Uint8Array>;
+//# sourceMappingURL=file-source.d.ts.map

package/dist/application/files/file-source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-source.d.ts","sourceRoot":"","sources":["../../../src/application/files/file-source.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C,kGAAkG;AAClG,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC"}

package/dist/application/files/file-source.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=file-source.js.map

package/dist/application/files/file-source.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-source.js","sourceRoot":"","sources":["../../../src/application/files/file-source.ts"],"names":[],"mappings":""}

package/dist/application/files/file-upload.d.ts

@@ -0,0 +1,25 @@
+import type { ReceivedFile } from './received-file.js';
+import type { StoredFile } from './stored-file.js';
+/**
+ * A file a command carries. The controller hands over the `ReceivedFile`, still streaming, and
+ * the `fileUploadsMiddleware` of the bus stages it under a key of `area`, scanned, before the
+ * unit of work opens: no transaction waits on a client that uploads slowly. The handler then
+ * reads `file`, records it and asks `FileStaging.promoteOnCommit` for it.
+ */
+export declare class FileUpload {
+    readonly received: ReceivedFile;
+    /** A key prefix of the project, such as `appointment-documents`. */
+    readonly area: string;
+    private stored;
+    constructor(received: ReceivedFile, 
+    /** A key prefix of the project, such as `appointment-documents`. */
+    area: string);
+    /** The name the client gave: shown back to a person, never a key or a path. */
+    get fileName(): string;
+    get isStaged(): boolean;
+    /** The staged file, under its final key. Read before the middleware staged it, a defect of the wiring. */
+    get file(): StoredFile;
+    /** Called by whoever staged it, once. */
+    stagedAs(file: StoredFile): void;
+}
+//# sourceMappingURL=file-upload.d.ts.map

package/dist/application/files/file-upload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-upload.d.ts","sourceRoot":"","sources":["../../../src/application/files/file-upload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;;;;GAKG;AACH,qBAAa,UAAU;IAInB,QAAQ,CAAC,QAAQ,EAAE,YAAY;IAC/B,oEAAoE;IACpE,QAAQ,CAAC,IAAI,EAAE,MAAM;IALvB,OAAO,CAAC,MAAM,CAAyB;IAEvC,YACW,QAAQ,EAAE,YAAY;IAC/B,oEAAoE;IAC3D,IAAI,EAAE,MAAM,EACnB;IAEJ,+EAA+E;IAC/E,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED,0GAA0G;IAC1G,IAAI,IAAI,IAAI,UAAU,CAQrB;IAED,yCAAyC;IACzC,QAAQ,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI,CAE/B;CACF"}

package/dist/application/files/file-upload.js

@@ -0,0 +1,36 @@
+/**
+ * A file a command carries. The controller hands over the `ReceivedFile`, still streaming, and
+ * the `fileUploadsMiddleware` of the bus stages it under a key of `area`, scanned, before the
+ * unit of work opens: no transaction waits on a client that uploads slowly. The handler then
+ * reads `file`, records it and asks `FileStaging.promoteOnCommit` for it.
+ */
+export class FileUpload {
+    received;
+    area;
+    stored;
+    constructor(received, 
+    /** A key prefix of the project, such as `appointment-documents`. */
+    area) {
+        this.received = received;
+        this.area = area;
+    }
+    /** The name the client gave: shown back to a person, never a key or a path. */
+    get fileName() {
+        return this.received.fileName;
+    }
+    get isStaged() {
+        return this.stored !== undefined;
+    }
+    /** The staged file, under its final key. Read before the middleware staged it, a defect of the wiring. */
+    get file() {
+        if (this.stored === undefined) {
+            throw new Error(`The file upload of area "${this.area}" was read before it was staged: install fileUploadsMiddleware on the command bus, before the unit of work.`);
+        }
+        return this.stored;
+    }
+    /** Called by whoever staged it, once. */
+    stagedAs(file) {
+        this.stored = file;
+    }
+}
+//# sourceMappingURL=file-upload.js.map

package/dist/application/files/file-upload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-upload.js","sourceRoot":"","sources":["../../../src/application/files/file-upload.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,MAAM,OAAO,UAAU;IAIV,QAAQ;IAER,IAAI;IALP,MAAM,CAAyB;IAEvC,YACW,QAAsB;IAC/B,oEAAoE;IAC3D,IAAY;wBAFZ,QAAQ;oBAER,IAAI;IACZ,CAAC;IAEJ,+EAA+E;IAC/E,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAChC,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC;IACnC,CAAC;IAED,0GAA0G;IAC1G,IAAI,IAAI;QACN,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,4BAA4B,IAAI,CAAC,IAAI,6GAA6G,CACnJ,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,yCAAyC;IACzC,QAAQ,CAAC,IAAgB;QACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IACrB,CAAC;CACF"}

package/dist/application/files/index.d.ts

@@ -0,0 +1,31 @@
+export * from './accepts-media-type.js';
+export * from './assert-expiry.js';
+export * from './content-disposition.js';
+export * from './content-expectation.js';
+export * from './content-matches.js';
+export * from './download-url-options.js';
+export * from './file-content.js';
+export * from './file-error.js';
+export * from './assert-file-key.js';
+export * from './assert-final-key.js';
+export * from './is-file-key.js';
+export * from './file-metadata.js';
+export * from './file-source.js';
+export * from './file-upload.js';
+export * from './inspection-limits.js';
+export * from './listed-file.js';
+export * from './max-signed-url-seconds.js';
+export * from './media-type-of.js';
+export * from './pending-upload.js';
+export * from './pending-upload-link.js';
+export * from './put-options.js';
+export * from './received-file.js';
+export * from './scan-verdict.js';
+export * from './signature-of.js';
+export * from './signed-download.js';
+export * from './signed-upload.js';
+export * from './signed-url.js';
+export * from './staged-key-of.js';
+export * from './stored-file.js';
+export * from './upload-url-options.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/application/files/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/application/files/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AACjC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC"}

package/dist/application/files/index.js

@@ -0,0 +1,31 @@
+export * from './accepts-media-type.js';
+export * from './assert-expiry.js';
+export * from './content-disposition.js';
+export * from './content-expectation.js';
+export * from './content-matches.js';
+export * from './download-url-options.js';
+export * from './file-content.js';
+export * from './file-error.js';
+export * from './assert-file-key.js';
+export * from './assert-final-key.js';
+export * from './is-file-key.js';
+export * from './file-metadata.js';
+export * from './file-source.js';
+export * from './file-upload.js';
+export * from './inspection-limits.js';
+export * from './listed-file.js';
+export * from './max-signed-url-seconds.js';
+export * from './media-type-of.js';
+export * from './pending-upload.js';
+export * from './pending-upload-link.js';
+export * from './put-options.js';
+export * from './received-file.js';
+export * from './scan-verdict.js';
+export * from './signature-of.js';
+export * from './signed-download.js';
+export * from './signed-upload.js';
+export * from './signed-url.js';
+export * from './staged-key-of.js';
+export * from './stored-file.js';
+export * from './upload-url-options.js';
+//# sourceMappingURL=index.js.map

package/dist/application/files/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/application/files/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AACjC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC"}

package/dist/application/files/inspection-limits.d.ts

@@ -0,0 +1,8 @@
+import type { ContentExpectation } from './content-expectation.js';
+export interface InspectionLimits {
+    /** Beyond it the stream fails with `FILE_TOO_LARGE`. */
+    readonly maxBytes?: number;
+    /** When given, the first bytes are checked against it before any byte goes on. */
+    readonly expected?: ContentExpectation;
+}
+//# sourceMappingURL=inspection-limits.d.ts.map

package/dist/application/files/inspection-limits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inspection-limits.d.ts","sourceRoot":"","sources":["../../../src/application/files/inspection-limits.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAEnE,MAAM,WAAW,gBAAgB;IAC/B,wDAAwD;IACxD,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,kFAAkF;IAClF,QAAQ,CAAC,QAAQ,CAAC,EAAE,kBAAkB,CAAC;CACxC"}

package/dist/application/files/inspection-limits.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=inspection-limits.js.map

package/dist/application/files/inspection-limits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inspection-limits.js","sourceRoot":"","sources":["../../../src/application/files/inspection-limits.ts"],"names":[],"mappings":""}

package/dist/application/files/is-file-key.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Whether a key is one the storages accept: segments separated by `/`, each made of letters,
+ * digits, dots, hyphens and underscores and none starting with a dot, so a key can never climb
+ * out of its directory or prefix (`..`), be absolute, or hide a file.
+ */
+export declare function isFileKey(key: string): boolean;
+//# sourceMappingURL=is-file-key.d.ts.map

package/dist/application/files/is-file-key.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-file-key.d.ts","sourceRoot":"","sources":["../../../src/application/files/is-file-key.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAE9C"}

package/dist/application/files/is-file-key.js

@@ -0,0 +1,11 @@
+const SEGMENT = /^[A-Za-z0-9_-][A-Za-z0-9._-]*$/;
+const MAX_KEY_LENGTH = 1_024;
+/**
+ * Whether a key is one the storages accept: segments separated by `/`, each made of letters,
+ * digits, dots, hyphens and underscores and none starting with a dot, so a key can never climb
+ * out of its directory or prefix (`..`), be absolute, or hide a file.
+ */
+export function isFileKey(key) {
+    return key.length > 0 && key.length <= MAX_KEY_LENGTH && key.split('/').every((segment) => SEGMENT.test(segment));
+}
+//# sourceMappingURL=is-file-key.js.map

package/dist/application/files/is-file-key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-file-key.js","sourceRoot":"","sources":["../../../src/application/files/is-file-key.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,GAAG,gCAAgC,CAAC;AACjD,MAAM,cAAc,GAAG,KAAK,CAAC;AAE7B;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,IAAI,cAAc,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AACpH,CAAC"}

package/dist/application/files/listed-file.d.ts

@@ -0,0 +1,7 @@
+/** One file of a listing: enough to decide what to purge, without a request per file. */
+export interface ListedFile {
+    readonly key: string;
+    readonly size: number;
+    readonly lastModified: Date;
+}
+//# sourceMappingURL=listed-file.d.ts.map

package/dist/application/files/listed-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listed-file.d.ts","sourceRoot":"","sources":["../../../src/application/files/listed-file.ts"],"names":[],"mappings":"AAAA,yFAAyF;AACzF,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAC;CAC7B"}

package/dist/application/files/listed-file.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=listed-file.js.map

package/dist/application/files/listed-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listed-file.js","sourceRoot":"","sources":["../../../src/application/files/listed-file.ts"],"names":[],"mappings":""}

package/dist/application/files/max-signed-url-seconds.d.ts

@@ -0,0 +1,3 @@
+/** The longest a signed link may live: one hour. Five minutes is a sensible default for a download. */
+export declare const MAX_SIGNED_URL_SECONDS = 3600;
+//# sourceMappingURL=max-signed-url-seconds.d.ts.map

package/dist/application/files/max-signed-url-seconds.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"max-signed-url-seconds.d.ts","sourceRoot":"","sources":["../../../src/application/files/max-signed-url-seconds.ts"],"names":[],"mappings":"AAAA,uGAAuG;AACvG,eAAO,MAAM,sBAAsB,OAAQ,CAAC"}

package/dist/application/files/max-signed-url-seconds.js

@@ -0,0 +1,3 @@
+/** The longest a signed link may live: one hour. Five minutes is a sensible default for a download. */
+export const MAX_SIGNED_URL_SECONDS = 3_600;
+//# sourceMappingURL=max-signed-url-seconds.js.map

package/dist/application/files/max-signed-url-seconds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"max-signed-url-seconds.js","sourceRoot":"","sources":["../../../src/application/files/max-signed-url-seconds.ts"],"names":[],"mappings":"AAAA,uGAAuG;AACvG,MAAM,CAAC,MAAM,sBAAsB,GAAG,KAAK,CAAC"}

package/dist/application/files/media-type-of.d.ts

@@ -0,0 +1,3 @@
+/** `Image/PNG; charset=binary` is `image/png`: the essence of a media type, which is what is compared. */
+export declare function mediaTypeOf(contentType: string): string;
+//# sourceMappingURL=media-type-of.d.ts.map

package/dist/application/files/media-type-of.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"media-type-of.d.ts","sourceRoot":"","sources":["../../../src/application/files/media-type-of.ts"],"names":[],"mappings":"AAAA,0GAA0G;AAC1G,wBAAgB,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAEvD"}

package/dist/application/files/media-type-of.js

@@ -0,0 +1,5 @@
+/** `Image/PNG; charset=binary` is `image/png`: the essence of a media type, which is what is compared. */
+export function mediaTypeOf(contentType) {
+    return (contentType.split(';')[0] ?? '').trim().toLowerCase();
+}
+//# sourceMappingURL=media-type-of.js.map

package/dist/application/files/media-type-of.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"media-type-of.js","sourceRoot":"","sources":["../../../src/application/files/media-type-of.ts"],"names":[],"mappings":"AAAA,0GAA0G;AAC1G,MAAM,UAAU,WAAW,CAAC,WAAmB;IAC7C,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;AAChE,CAAC"}

package/dist/application/files/pending-upload-link.d.ts

@@ -0,0 +1,10 @@
+import type { PendingUpload } from './pending-upload.js';
+import type { SignedUpload } from './signed-upload.js';
+/** What `FileStaging.uploadUrl` answers: the request for the client, and the grant for the server to keep. */
+export interface PendingUploadLink {
+    /** Handed to the client. */
+    readonly link: SignedUpload;
+    /** Kept on the server, on the aggregate that awaits the file; never handed to the client to send back. */
+    readonly pending: PendingUpload;
+}
+//# sourceMappingURL=pending-upload-link.d.ts.map

package/dist/application/files/pending-upload-link.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pending-upload-link.d.ts","sourceRoot":"","sources":["../../../src/application/files/pending-upload-link.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvD,8GAA8G;AAC9G,MAAM,WAAW,iBAAiB;IAChC,4BAA4B;IAC5B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,0GAA0G;IAC1G,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;CACjC"}

package/dist/application/files/pending-upload-link.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=pending-upload-link.js.map

package/dist/application/files/pending-upload-link.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pending-upload-link.js","sourceRoot":"","sources":["../../../src/application/files/pending-upload-link.ts"],"names":[],"mappings":""}

package/dist/application/files/pending-upload.d.ts

@@ -0,0 +1,15 @@
+import type { ContentExpectation } from './content-expectation.js';
+/**
+ * What the server granted when it signed a link to upload a file straight to the storage: the
+ * key, the size cap and the media types. Recorded on the server, on the aggregate that awaits
+ * the file, by the command that signed the link; the command that confirms the upload reads it
+ * back from there, never from what the client sends, so a client can neither choose the key it
+ * confirms nor raise the cap.
+ */
+export interface PendingUpload extends ContentExpectation {
+    /** The final key, generated by `FileKeys`; the file waits under its staged key. */
+    readonly key: string;
+    /** In bytes: what `FileStaging.confirm` accepts at most. */
+    readonly maxBytes: number;
+}
+//# sourceMappingURL=pending-upload.d.ts.map

package/dist/application/files/pending-upload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pending-upload.d.ts","sourceRoot":"","sources":["../../../src/application/files/pending-upload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAEnE;;;;;;GAMG;AACH,MAAM,WAAW,aAAc,SAAQ,kBAAkB;IACvD,mFAAmF;IACnF,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,4DAA4D;IAC5D,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B"}

package/dist/application/files/pending-upload.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=pending-upload.js.map

package/dist/application/files/pending-upload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pending-upload.js","sourceRoot":"","sources":["../../../src/application/files/pending-upload.ts"],"names":[],"mappings":""}

package/dist/application/files/put-options.d.ts

@@ -0,0 +1,7 @@
+export interface PutOptions {
+    /** The media type the content was verified to be. */
+    readonly mediaType: string;
+    /** Beyond it the write fails with `FILE_TOO_LARGE` and leaves nothing under the key. */
+    readonly maxBytes?: number;
+}
+//# sourceMappingURL=put-options.d.ts.map

package/dist/application/files/put-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"put-options.d.ts","sourceRoot":"","sources":["../../../src/application/files/put-options.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,qDAAqD;IACrD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,wFAAwF;IACxF,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B"}

package/dist/application/files/put-options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=put-options.js.map

package/dist/application/files/put-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"put-options.js","sourceRoot":"","sources":["../../../src/application/files/put-options.ts"],"names":[],"mappings":""}

package/dist/application/files/received-file.d.ts

@@ -0,0 +1,15 @@
+import type { Readable } from 'node:stream';
+/**
+ * A file received from a client, still streaming: what a controller hands to a command, and the
+ * handler to `FileStaging.stage`. Nothing of it is trusted but its bytes, which the edge checks
+ * against the declared media type as they stream.
+ */
+export interface ReceivedFile {
+    /** The name the client gave: shown back to a person, never a key or a path. */
+    readonly fileName: string;
+    /** The media type the client declared, which the first bytes must prove. */
+    readonly mediaType: string;
+    /** The content, to consume once. It fails on its way with `FILE_TOO_LARGE` or `UNSUPPORTED_MEDIA_TYPE`. */
+    readonly stream: Readable;
+}
+//# sourceMappingURL=received-file.d.ts.map

package/dist/application/files/received-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"received-file.d.ts","sourceRoot":"","sources":["../../../src/application/files/received-file.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,+EAA+E;IAC/E,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,4EAA4E;IAC5E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,2GAA2G;IAC3G,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;CAC3B"}

package/dist/application/files/received-file.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=received-file.js.map

package/dist/application/files/received-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"received-file.js","sourceRoot":"","sources":["../../../src/application/files/received-file.ts"],"names":[],"mappings":""}

package/dist/application/files/scan-verdict.d.ts

@@ -0,0 +1,8 @@
+/** What a `FileScanner` concludes: accepted, or refused with a stable reason (`INFECTED`, `ENCRYPTED_ARCHIVE`). */
+export type ScanVerdict = {
+    readonly accepted: true;
+} | {
+    readonly accepted: false;
+    readonly reason: string;
+};
+//# sourceMappingURL=scan-verdict.d.ts.map

package/dist/application/files/scan-verdict.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scan-verdict.d.ts","sourceRoot":"","sources":["../../../src/application/files/scan-verdict.ts"],"names":[],"mappings":"AAAA,mHAAmH;AACnH,MAAM,MAAM,WAAW,GAAG;IAAE,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/dist/application/files/scan-verdict.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=scan-verdict.js.map

package/dist/application/files/scan-verdict.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scan-verdict.js","sourceRoot":"","sources":["../../../src/application/files/scan-verdict.ts"],"names":[],"mappings":""}

package/dist/application/files/signature-of.d.ts

@@ -0,0 +1,3 @@
+/** The binary format the first bytes of a content announce, or `undefined` when none is recognised. */
+export declare function signatureOf(head: Uint8Array): string | undefined;
+//# sourceMappingURL=signature-of.d.ts.map

package/dist/application/files/signature-of.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signature-of.d.ts","sourceRoot":"","sources":["../../../src/application/files/signature-of.ts"],"names":[],"mappings":"AAuBA,uGAAuG;AACvG,wBAAgB,WAAW,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAGhE"}