@myronsi/messenger-api 2.1.0-alpha.10 → 2.1.0-alpha.11

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 Contract changes only. The backend changelog is `CHANGELOG.md` in the repository root. Rules: `docs/api-compatibility.md`.
 
+## 2.1.0-alpha.11
+
+- Attachments have `display_url`: a JPEG of at most 1600 px (`GET /attachments/{attachment_id}/content?variant=display`)
+  for showing a large still image in a viewer, much smaller than the original. It is `null` for small images and
+  GIFs. Older images get their display copy on the first request.
+
 ## 2.1.0-alpha.10
 
 - `GET /attachments/{attachment_id}/content` is cached for an hour again (`private, max-age=3600`) instead of a

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.1.0-alpha.10. Do not edit. */
-export declare const API_VERSION: "2.1.0-alpha.10";
+/* Generated from api/openapi.yaml 2.1.0-alpha.11. Do not edit. */
+export declare const API_VERSION: "2.1.0-alpha.11";
 export type { paths, components, operations } from "./schema.js";
 export * from "./ws-events.js";

package/dist/index.js

@@ -1 +1 @@
-export const API_VERSION = "2.1.0-alpha.10";
+export const API_VERSION = "2.1.0-alpha.11";

package/dist/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.1.0
 info:
   title: Messenger API
-  version: 2.1.0-alpha.10
+  version: 2.1.0-alpha.11
   summary: REST contract of the Messenger backend (v2).
   description: |
     Contract for the Go backend. The WebSocket protocol is described in `websocket/` and
@@ -1011,10 +1011,13 @@ paths:
       parameters:
         - name: variant
           in: query
-          description: "`thumbnail`: a JPEG of at most 320 px (images only; `thumbnail_url` of the attachment)."
+          description: |
+            `thumbnail`: a JPEG of at most 320 px (images only; `thumbnail_url` of the attachment).
+            `display`: a JPEG of at most 1600 px for viewing a large still image (`display_url` of the attachment);
+            the original for any other attachment.
           schema:
             type: string
-            enum: [thumbnail]
+            enum: [thumbnail, display]
       responses:
         "426": { $ref: "#/components/responses/ClientOutdated" }
         "400": { $ref: "#/components/responses/BadRequest" }
@@ -2714,6 +2717,10 @@ components:
         width: { type: [integer, "null"], minimum: 1 }
         height: { type: [integer, "null"], minimum: 1 }
         thumbnail_url: { type: [string, "null"], readOnly: true }
+        display_url:
+          type: [string, "null"]
+          readOnly: true
+          description: A JPEG of at most 1600 px to show in an image viewer instead of the original; `null` for small images and GIFs, which are shown as they are.
         duration_ms: { type: [integer, "null"], minimum: 0 }
         waveform:
           type: [array, "null"]

package/dist/schema.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.1.0-alpha.10. Do not edit. */
+/* Generated from api/openapi.yaml 2.1.0-alpha.11. Do not edit. */
 export interface paths {
     "/meta": {
         parameters: {
@@ -1911,6 +1911,8 @@ export interface components {
             width?: number | null;
             height?: number | null;
             readonly thumbnail_url?: string | null;
+            /** @description A JPEG of at most 1600 px to show in an image viewer instead of the original; `null` for small images and GIFs, which are shown as they are. */
+            readonly display_url?: string | null;
             duration_ms?: number | null;
             waveform?: number[] | null;
         };
@@ -3555,8 +3557,12 @@ export interface operations {
     getAttachmentContent: {
         parameters: {
             query?: {
-                /** @description `thumbnail`: a JPEG of at most 320 px (images only; `thumbnail_url` of the attachment). */
-                variant?: "thumbnail";
+                /**
+                 * @description `thumbnail`: a JPEG of at most 320 px (images only; `thumbnail_url` of the attachment).
+                 *     `display`: a JPEG of at most 1600 px for viewing a large still image (`display_url` of the attachment);
+                 *     the original for any other attachment.
+                 */
+                variant?: "thumbnail" | "display";
             };
             header?: {
                 /** @description Version of the client app, for logs and the per-client metric. */

package/dist/ws-events.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.1.0-alpha.10. Do not edit. */
+/* Generated from api/openapi.yaml 2.1.0-alpha.11. Do not edit. */
 
 /**
  * Any WebSocket event, in either direction.
@@ -335,6 +335,10 @@ export interface Attachment {
   width?: number | null;
   height?: number | null;
   thumbnail_url?: string | null;
+  /**
+   * A JPEG of at most 1600 px to show in an image viewer instead of the original; `null` for small images and GIFs, which are shown as they are.
+   */
+  display_url?: string | null;
   duration_ms?: number | null;
   waveform?: number[] | null;
 }

package/dist/ws-events.schema.json

@@ -1182,6 +1182,14 @@
           ],
           "readOnly": true
         },
+        "display_url": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "readOnly": true,
+          "description": "A JPEG of at most 1600 px to show in an image viewer instead of the original; `null` for small images and GIFs, which are shown as they are."
+        },
         "duration_ms": {
           "type": [
             "integer",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@myronsi/messenger-api",
-  "version": "2.1.0-alpha.10",
+  "version": "2.1.0-alpha.11",
   "description": "API contract of the Messenger backend: OpenAPI document, WebSocket event schemas and generated TypeScript types",
   "license": "MIT",
   "repository": {