@myronsi/messenger-api 2.1.0-alpha.2.next.63 → 2.1.0-alpha.4.next.68

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 Contract changes only. The backend changelog is `CHANGELOG.md` in the repository root. Rules: `docs/api-compatibility.md`.
 
+## 2.1.0-alpha.4
+
+- Editing a file message accepts an empty `content` (HTTP `PATCH /messages/{message_id}` and the WebSocket `edit`
+  event): it removes the caption. A text message still needs at least one character.
+
+## 2.1.0-alpha.3
+
+- Adds `GET /notifications/avatar/{token}` and `POST /notifications/read/{token}` without a session, for the
+  sender photo and the "Mark as read" action of a web push. Both answer `404` for a forged, expired or ended token.
+- Web push payloads add `preview`, `read_token` and, with previews on, `sender_id` and `avatar_token`. Tokens are bound to the push
+  device and its session.
+
 ## 2.1.0-alpha.2
 
 - Adds notification preferences, session-bound push device registration and per-tab activity leases.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.1.0-alpha.2. Do not edit. */
-export declare const API_VERSION: "2.1.0-alpha.2";
+/* Generated from api/openapi.yaml 2.1.0-alpha.4. Do not edit. */
+export declare const API_VERSION: "2.1.0-alpha.4";
 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.2";
+export const API_VERSION = "2.1.0-alpha.4";

package/dist/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.1.0
 info:
   title: Messenger API
-  version: 2.1.0-alpha.2
+  version: 2.1.0-alpha.4
   summary: REST contract of the Messenger backend (v2).
   description: |
     Contract for the Go backend. The WebSocket protocol is described in `websocket/` and
@@ -1281,7 +1281,8 @@ paths:
     patch:
       tags: [messages]
       operationId: editMessage
-      summary: Edit your text message
+      summary: Edit your text message or the caption of your file
+      description: An empty `content` removes the caption of a file message; a text message needs at least one character.
       requestBody:
         required: true
         content:
@@ -1758,6 +1759,58 @@ paths:
           $ref: "#/components/responses/NotFound"
         "409":
           $ref: "#/components/responses/Conflict"
+  /notifications/avatar/{token}:
+    parameters:
+      - name: token
+        in: path
+        required: true
+        description: "`avatar_token` of a push notification."
+        schema: { type: string, maxLength: 256 }
+    get:
+      tags: [me]
+      operationId: getNotificationAvatar
+      summary: Sender avatar for a push notification
+      description: |
+        For the service worker, which has no session: the token in the push payload names the recipient
+        and the sender and expires after an hour. Follows the sender's avatar visibility for the recipient.
+      security: []
+      responses:
+        "200":
+          description: Image
+          content:
+            image/*:
+              schema: { type: string, format: binary }
+        "206":
+          description: The requested byte range (`Range` header)
+          content:
+            image/*:
+              schema: { type: string, format: binary }
+        "302":
+          description: Redirect to a short-lived signed storage URL (with `MEDIA_SIGNED_URLS`)
+        "304":
+          description: Not modified (`If-None-Match` with the `ETag` of an earlier answer)
+        "416":
+          description: The requested range is outside the file
+        "404": { $ref: "#/components/responses/NotFound" }
+  /notifications/read/{token}:
+    parameters:
+      - name: token
+        in: path
+        required: true
+        description: "`read_token` of a push notification."
+        schema: { type: string, maxLength: 256 }
+    post:
+      tags: [me]
+      operationId: markNotificationRead
+      summary: Mark a chat read from a push notification
+      description: |
+        For the notification's "Mark as read" action: marks the chat read up to the notified message for
+        the recipient the token names. The token expires after seven days.
+      security: []
+      responses:
+        "204":
+          description: Marked as read
+        "404": { $ref: "#/components/responses/NotFound" }
   /me/notification-devices:
     post:
       tags:
@@ -2712,7 +2765,10 @@ components:
       type: object
       required: [content]
       properties:
-        content: { type: string, minLength: 1, maxLength: 4096 }
+        content:
+          type: string
+          maxLength: 4096
+          description: New text, or the new caption of a file. Empty removes a file's caption; a text message rejects it.
     ForwardMessageRequest:
       type: object
       required: [chat_ids]

package/dist/schema.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.1.0-alpha.2. Do not edit. */
+/* Generated from api/openapi.yaml 2.1.0-alpha.4. Do not edit. */
 export interface paths {
     "/meta": {
         parameters: {
@@ -1029,7 +1029,10 @@ export interface paths {
         delete: operations["deleteMessage"];
         options?: never;
         head?: never;
-        /** Edit your text message */
+        /**
+         * Edit your text message or the caption of your file
+         * @description An empty `content` removes the caption of a file message; a text message needs at least one character.
+         */
         patch: operations["editMessage"];
         trace?: never;
     };
@@ -1358,6 +1361,54 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/notifications/avatar/{token}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description `avatar_token` of a push notification. */
+                token: string;
+            };
+            cookie?: never;
+        };
+        /**
+         * Sender avatar for a push notification
+         * @description For the service worker, which has no session: the token in the push payload names the recipient
+         *     and the sender and expires after an hour. Follows the sender's avatar visibility for the recipient.
+         */
+        get: operations["getNotificationAvatar"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/notifications/read/{token}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description `read_token` of a push notification. */
+                token: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Mark a chat read from a push notification
+         * @description For the notification's "Mark as read" action: marks the chat read up to the notified message for
+         *     the recipient the token names. The token expires after seven days.
+         */
+        post: operations["markNotificationRead"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/me/notification-devices": {
         parameters: {
             query?: never;
@@ -1828,6 +1879,7 @@ export interface components {
             reply_to?: components["schemas"]["Id"] | null;
         };
         EditMessageRequest: {
+            /** @description New text, or the new caption of a file. Empty removes a file's caption; a text message rejects it. */
             content: string;
         };
         ForwardMessageRequest: {
@@ -4490,6 +4542,82 @@ export interface operations {
             409: components["responses"]["Conflict"];
         };
     };
+    getNotificationAvatar: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description `avatar_token` of a push notification. */
+                token: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Image */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "image/*": string;
+                };
+            };
+            /** @description The requested byte range (`Range` header) */
+            206: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "image/*": string;
+                };
+            };
+            /** @description Redirect to a short-lived signed storage URL (with `MEDIA_SIGNED_URLS`) */
+            302: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not modified (`If-None-Match` with the `ETag` of an earlier answer) */
+            304: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            404: components["responses"]["NotFound"];
+            /** @description The requested range is outside the file */
+            416: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    markNotificationRead: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description `read_token` of a push notification. */
+                token: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Marked as read */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            404: components["responses"]["NotFound"];
+        };
+    };
     registerNotificationDevice: {
         parameters: {
             query?: never;

package/dist/ws-events.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.1.0-alpha.2. Do not edit. */
+/* Generated from api/openapi.yaml 2.1.0-alpha.4. Do not edit. */
 
 /**
  * Any WebSocket event, in either direction.
@@ -97,7 +97,7 @@ export interface ClientDeleteEvent {
   };
 }
 /**
- * Edit your own text message.
+ * Edit your own text message or the caption of your file. An empty content removes a file's caption.
  */
 export interface ClientEditEvent {
   type: "edit";

package/dist/ws-events.schema.json

@@ -1551,8 +1551,8 @@
       "properties": {
         "content": {
           "type": "string",
-          "minLength": 1,
-          "maxLength": 4096
+          "maxLength": 4096,
+          "description": "New text, or the new caption of a file. Empty removes a file's caption; a text message rejects it."
         }
       }
     },
@@ -1965,7 +1965,7 @@
     },
     "ClientEditEvent": {
       "title": "ClientEditEvent",
-      "description": "Edit your own text message.",
+      "description": "Edit your own text message or the caption of your file. An empty content removes a file's caption.",
       "type": "object",
       "properties": {
         "type": {
@@ -1985,7 +1985,6 @@
             },
             "content": {
               "type": "string",
-              "minLength": 1,
               "maxLength": 4096
             }
           },

package/package.json

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