@michaelthielemann/kestrel-media-default 5.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,70 @@
+# media/default
+Uploads: bytes go to `blobstore@1` under `<prefix><folder>/<filename>`, metadata (`filename`,
+`folder`, `contentType`, `size`, `key`, `checksum`, `status`, `createdAt`, `provenance`) into the
+persistence collection `media_items`. `folder` is a path-like label (`2026/press`), tracked in `media_folders`, with
+folder-tree operations (create/rename/remove) that move blobs along. `alt`, `title`, `description`
+are per-locale texts (plain text: max 2000 characters, no control characters except tab and
+newline, `VALIDATION` otherwise – they are not HTML and are never sanitized, which would rewrite legitimate
+text such as `5 < 6`); `width`/`height` are read from the file header of PNG/JPEG/GIF/WebP uploads
+(no image library). `provenance` records who made the file (`origin: human | ai | mixed | unknown`,
+plus `tool`/`model`/`at`) and is exposed via `X-Content-Provenance` on download for every origin but
+`human` — the anchor for labelling obligations such as EU AI Act Art. 50 (not legal advice;
+labelling itself is the frontend's job). An upload without `provenance` is recorded as
+`{ origin: "unknown" }`: a missing declaration is not evidence that a human made the file, and the
+caller (the admin UI, an import script) is the one that knows.
+
+The row is the truth, the blobstore only the storage. An upload writes the row first
+(`status: "uploading"`, `checksum` = sha256 of the bytes as hex), then the blob, then
+`status: "ready"`; a failing blob write leaves `status: "failed"` and returns the blobstore's
+failure, so the pipeline still fails. Only `ready` items are returned by `media.get`, `media.list`
+and `media.download` (`NOT_FOUND` / filtered out otherwise), and a `failed` row is replaced when the same name is uploaded
+again, so a broken attempt never blocks a filename. `checksum` and `status` are additive: rows
+written before them read as `checksum: null` / `status: "ready"`. Deleting removes the row first
+and the blob after — a failing blob delete is logged, not fatal, and `media.reconcile` finds what
+is left over. A rename moves the blob first and moves it back if the row update fails.
+
+Why: a plain blobstore has no metadata, folders, locale texts or provenance tracking; this module
+adds the bookkeeping other modules (`delivery-static`, `references-default`) rely on, without
+depending on an image library.
+
+Config: `allowedTypes` (`image/*`, `application/pdf`, `*`), `deniedTypes` (default
+`image/svg+xml`, `text/html`, `application/xhtml+xml` — they can carry scripts), `maxBytes`,
+`prefix` (default `media/`, must end with `/`), `locales`/`defaultLocale`.
+
+Steps: `media.upload` (processes every file in `ctx.files`, in order, with the same checks; exactly
+one file returns the item unchanged, two or more return `{ items, errors, ids }` with a per-file
+`{ filename, status, code, message }` entry in `errors` — a rejected or conflicting file doesn't stop
+the others, partial success is a 200; a `TRANSIENT` blobstore or database failure is not per-file and
+fails the whole request), `media.get`, `media.list` (folder, recursive, search, sort, ids, paging),
+`media.listFolders`, `media.createFolder`, `media.renameFolder`, `media.folderItems` (for
+`references.guardAll:media`), `media.removeFolder`, `media.update`, `media.download`,
+`media.remove`, `media.reconcile`, `media.reconcileDelete`, `media.export:<dir>`.
+
+Error codes per step (every step can also answer `TRANSIENT` when the blobstore or the database is
+unavailable):
+
+| Step | codes |
+|---|---|
+| `media.upload` | `VALIDATION` (no file, invalid folder or provenance), `UNSUPPORTED` (type not allowed), `PAYLOAD_TOO_LARGE` (over `maxBytes`), `CONFLICT` (filename taken) |
+| `media.get` | `VALIDATION` (unknown locale), `NOT_FOUND` |
+| `media.list` | `VALIDATION` (invalid folder, unknown locale) |
+| `media.update` | `VALIDATION` (name, folder, provenance or text), `NOT_FOUND`, `CONFLICT` (filename taken) |
+| `media.download` | `NOT_FOUND` |
+| `media.remove` | `VALIDATION` (missing id) |
+| `media.createFolder` | `VALIDATION` |
+| `media.renameFolder` | `VALIDATION`, `NOT_FOUND`, `CONFLICT` (target exists or is inside the source) |
+| `media.folderItems` | `VALIDATION`, `NOT_FOUND`, `CONFLICT` (folder not empty and no `recursive`) |
+| `media.removeFolder` | `VALIDATION`, `NOT_FOUND` |
+| `media.listFolders`, `media.reconcile`, `media.reconcileDelete`, `media.export:<dir>` | – |
+
+`media.reconcile` lists the blobs under `prefix` and compares them with the `media_items` keys:
+`{ blobsWithoutRow, rowsWithoutBlob }`. With `delete: true` it deletes the blobs nothing points at;
+`media.reconcileDelete` is the same step with the deletion fixed in the pipeline instead of the
+request, so a route can offer the report and the cleanup as two different endpoints;
+rows are never deleted, because a row is the only record that a file was ever meant to exist. Keys
+under `media-variants/` are ignored — they belong to `images/default`, which this module cannot
+query. A row of an upload that is in flight right now shows up under `rowsWithoutBlob`, so run it
+from a cron trigger rather than after every write; no trigger is wired here, that is the
+consumer's job.
+
+Not included: image resizing, tags, linking media to content documents.

package/dist/imageSize.d.ts

@@ -0,0 +1,5 @@
+export interface Size {
+    width: number;
+    height: number;
+}
+export declare function imageSize(d: Uint8Array): Size | null;

package/dist/imageSize.js

@@ -0,0 +1,53 @@
+function u16be(d, i) {
+    return ((d[i] ?? 0) << 8) | (d[i + 1] ?? 0);
+}
+function u16le(d, i) {
+    return (d[i] ?? 0) | ((d[i + 1] ?? 0) << 8);
+}
+function u32be(d, i) {
+    return ((d[i] ?? 0) * 2 ** 24) + ((d[i + 1] ?? 0) << 16) + ((d[i + 2] ?? 0) << 8) + (d[i + 3] ?? 0);
+}
+function u24le(d, i) {
+    return (d[i] ?? 0) | ((d[i + 1] ?? 0) << 8) | ((d[i + 2] ?? 0) << 16);
+}
+function ascii(d, i, n) {
+    return String.fromCharCode(...d.subarray(i, i + n));
+}
+export function imageSize(d) {
+    if (d.length >= 24 && ascii(d, 1, 3) === "PNG")
+        return { width: u32be(d, 16), height: u32be(d, 20) };
+    if (d.length >= 10 && ascii(d, 0, 3) === "GIF")
+        return { width: u16le(d, 6), height: u16le(d, 8) };
+    if (d.length >= 30 && ascii(d, 0, 4) === "RIFF" && ascii(d, 8, 4) === "WEBP") {
+        const chunk = ascii(d, 12, 4);
+        if (chunk === "VP8X")
+            return { width: u24le(d, 24) + 1, height: u24le(d, 27) + 1 };
+        if (chunk === "VP8L") {
+            const b0 = d[21] ?? 0, b1 = d[22] ?? 0, b2 = d[23] ?? 0, b3 = d[24] ?? 0;
+            return { width: (b0 | ((b1 & 0x3f) << 8)) + 1, height: ((b1 >> 6) | (b2 << 2) | ((b3 & 0x0f) << 10)) + 1 };
+        }
+        if (chunk === "VP8 ")
+            return { width: u16le(d, 26) & 0x3fff, height: u16le(d, 28) & 0x3fff };
+        return null;
+    }
+    if (d.length >= 4 && d[0] === 0xff && d[1] === 0xd8) {
+        let i = 2;
+        while (i + 9 < d.length) {
+            if (d[i] !== 0xff)
+                return null;
+            const marker = d[i + 1] ?? 0;
+            if (marker === 0xd8 || (marker >= 0xd0 && marker <= 0xd7) || marker === 0x01 || marker === 0xff) {
+                i += marker === 0xff ? 1 : 2;
+                continue;
+            }
+            const length = u16be(d, i + 2);
+            if ((marker >= 0xc0 && marker <= 0xcf) && marker !== 0xc4 && marker !== 0xc8 && marker !== 0xcc) {
+                return { height: u16be(d, i + 5), width: u16be(d, i + 7) };
+            }
+            if (marker === 0xd9 || marker === 0xda)
+                return null;
+            i += 2 + length;
+        }
+    }
+    return null;
+}

package/dist/impl.d.ts

@@ -0,0 +1,129 @@
+import type { Blobstore } from "@michaelthielemann/kestrel-contracts/blobstore";
+import type { Document, FindOptions, Persistence } from "@michaelthielemann/kestrel-contracts/persistence";
+import { type KestrelError, type Result } from "@michaelthielemann/kestrel-contracts/errors";
+import type { Logger } from "@michaelthielemann/kestrel/logger";
+export declare const COLLECTION = "media_items";
+export declare const FOLDERS = "media_folders";
+export type MediaCode = "VALIDATION" | "NOT_FOUND" | "CONFLICT" | "UNSUPPORTED" | "PAYLOAD_TOO_LARGE" | "TRANSIENT";
+export type MediaError = KestrelError<MediaCode>;
+export type Origin = "human" | "ai" | "mixed" | "unknown";
+export interface Provenance {
+    origin: Origin;
+    tool?: string;
+    model?: string;
+    at?: number;
+}
+export type Texts = Record<string, string>;
+export type MediaStatus = "uploading" | "ready" | "failed";
+export interface MediaItem extends Document {
+    filename: string;
+    folder: string;
+    contentType: string;
+    size: number;
+    key: string;
+    checksum: string | null;
+    status: MediaStatus;
+    createdAt: number;
+    updatedAt: number;
+    provenance: Provenance;
+    width: number | null;
+    height: number | null;
+    alt: string | null;
+    title: string | null;
+    description: string | null;
+}
+export declare const TEXT_FIELDS: readonly ["alt", "title", "description"];
+export type TextField = (typeof TEXT_FIELDS)[number];
+export interface TextPatch {
+    alt?: string | null;
+    title?: string | null;
+    description?: string | null;
+}
+export interface Config {
+    allowedTypes: string[];
+    deniedTypes: string[];
+    maxBytes: number;
+    locales: string[];
+    defaultLocale?: string | undefined;
+    prefix: string;
+}
+export declare const SORTABLE: readonly ["createdAt", "filename", "size"];
+export type SortField = (typeof SORTABLE)[number];
+export interface ListOptions extends FindOptions {
+    folder?: string;
+    recursive?: boolean;
+    q?: string;
+    sortBy?: SortField;
+    direction?: "asc" | "desc";
+}
+export interface Reconciliation {
+    blobsWithoutRow: string[];
+    rowsWithoutBlob: string[];
+}
+export interface Media {
+    upload(file: {
+        filename: string;
+        contentType: string;
+        data: Uint8Array;
+    }, folder?: string, provenance?: unknown): Promise<Result<MediaItem, MediaError>>;
+    get(id: string, locale?: string): Promise<Result<MediaItem | null, MediaError>>;
+    list(options?: ListOptions & {
+        locale?: string;
+    }): Promise<Result<{
+        items: MediaItem[];
+        total: number;
+    }, MediaError>>;
+    byIds(ids: string[], locale?: string): Promise<Result<MediaItem[], MediaError>>;
+    folders(): Promise<Result<Array<{
+        folder: string;
+        count: number;
+    }>, MediaError>>;
+    update(id: string, patch: {
+        filename?: string;
+        folder?: string;
+        provenance?: unknown;
+    } & TextPatch, locale?: string): Promise<Result<MediaItem | null, MediaError>>;
+    read(id: string): Promise<Result<{
+        item: MediaItem;
+        data: Uint8Array;
+    } | null, MediaError>>;
+    remove(id: string): Promise<Result<void, MediaError>>;
+    exportTo(dir: string): Promise<Result<{
+        written: number;
+        skipped: number;
+        missing: number;
+        conflicts: number;
+    }, MediaError>>;
+    createFolder(path: string): Promise<Result<{
+        folder: string;
+        count: number;
+    }, MediaError>>;
+    renameFolder(from: string, to: string): Promise<Result<{
+        folder: string;
+        moved: number;
+    } | null, MediaError>>;
+    folderItems(path: string, recursive: boolean): Promise<Result<{
+        path: string;
+        ids: string[];
+    } | null, MediaError>>;
+    removeFolder(path: string): Promise<Result<{
+        ok: true;
+        removed: number;
+    } | null, MediaError>>;
+    migrateKeys(): Promise<Result<{
+        moved: number;
+        renamed: number;
+        missing: number;
+        skipped: number;
+    }, MediaError>>;
+    reconcile(options?: {
+        delete?: boolean;
+    }): Promise<Result<Reconciliation, MediaError>>;
+}
+export declare function sortItems(items: MediaItem[], sortBy: SortField | undefined, direction: "asc" | "desc" | undefined): MediaItem[];
+export declare function keyFor(folder: string, filename: string): string;
+export declare function parseProvenance(value: unknown): Result<Provenance, MediaError>;
+export declare function checkPlainText(field: string, value: string): Result<void, MediaError>;
+export declare function safeFolder(folder: string): Result<string, MediaError>;
+export declare function safeName(filename: string): string;
+export declare function createMediaDefault(config: Config, blobs: Blobstore, db: Persistence, logger: Logger, now?: () => number): Promise<Media>;