@myronsi/messenger-api 2.1.0-alpha.6.next.71 → 2.1.0-alpha.9.next.74

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 Contract changes only. The backend changelog is `CHANGELOG.md` in the repository root. Rules: `docs/api-compatibility.md`.
 
+## 2.1.0-alpha.9
+
+- Privacy exceptions apply to every value of avatar, profile and presence visibility, not only to `*_except`:
+  an `allow` exception always shows the item to that user and a `deny` exception always hides it. Group invites
+  already worked this way.
+- `direct_messages` and `search_visibility` take exception lists too (`PUT /me/privacy/exceptions/{setting_key}/{effect}`
+  and `exceptions` of `PrivacySettings`): `allow` lets the user start a direct chat without approval or find you in
+  search, `deny` never does.
+
+## 2.1.0-alpha.8
+
+- Adds `POST /chats/{chat_id}/messages/forward` (up to 20 messages to up to 20 chats, at most 20 copies, oldest
+  first) and `POST /chats/{chat_id}/messages/delete` (up to 100 messages, `scope` me or everyone). Both check
+  every message first and change nothing when one is refused.
+
+## 2.1.0-alpha.7
+
+- Adds `DELETE /me/avatars/{avatar_id}`: removes one of your avatars from the history and answers the updated
+  `Me`. Deleting the current avatar makes the newest remaining one current again, or the default when none is left.
+
 ## 2.1.0-alpha.6
 
 - `Message` adds optional `reply_preview` (`ReplyPreview`: id, type, sender, the first 100 characters of the

package/dist/index.d.ts

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

package/dist/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.1.0
 info:
   title: Messenger API
-  version: 2.1.0-alpha.6
+  version: 2.1.0-alpha.9
   summary: REST contract of the Messenger backend (v2).
   description: |
     Contract for the Go backend. The WebSocket protocol is described in `websocket/` and
@@ -444,6 +444,33 @@ paths:
         "400": { $ref: "#/components/responses/BadRequest" }
         "401": { $ref: "#/components/responses/Unauthorized" }
         "404": { $ref: "#/components/responses/NotFound" }
+  /me/avatars/{avatar_id}:
+    parameters:
+      - $ref: "#/components/parameters/ClientVersion"
+      - $ref: "#/components/parameters/ClientApiVersion"
+      - name: avatar_id
+        in: path
+        required: true
+        description: "`id` of an `AvatarVersion` of the caller."
+        schema: { $ref: "#/components/schemas/Id" }
+    delete:
+      tags: [me]
+      operationId: deleteMyAvatar
+      summary: Delete one of your avatars
+      description: |
+        Removes the avatar from your history. When it is the current one, the newest remaining avatar becomes
+        current again; without one you get the default avatar. The image is deleted from storage once nothing
+        uses it any more.
+      responses:
+        "426": { $ref: "#/components/responses/ClientOutdated" }
+        "200":
+          description: Updated user
+          content:
+            application/json:
+              schema: { $ref: "#/components/schemas/Me" }
+        "400": { $ref: "#/components/responses/BadRequest" }
+        "401": { $ref: "#/components/responses/Unauthorized" }
+        "404": { $ref: "#/components/responses/NotFound" }
   /me/password:
     parameters:
       - $ref: "#/components/parameters/ClientVersion"
@@ -670,7 +697,7 @@ paths:
         required: true
         schema:
           type: string
-          enum: [avatar_visibility, profile_visibility, presence_visibility, group_invites]
+          enum: [avatar_visibility, profile_visibility, presence_visibility, group_invites, direct_messages, search_visibility]
       - name: effect
         in: path
         required: true
@@ -1362,6 +1389,69 @@ paths:
         "404": { $ref: "#/components/responses/NotFound" }
         "422": { $ref: "#/components/responses/ValidationFailed" }
         "429": { $ref: "#/components/responses/TooManyRequests" }
+  /chats/{chat_id}/messages/forward:
+    parameters:
+      - $ref: "#/components/parameters/ClientVersion"
+      - $ref: "#/components/parameters/ClientApiVersion"
+      - $ref: "#/components/parameters/ChatId"
+    post:
+      tags: [messages]
+      operationId: forwardMessages
+      summary: Forward several messages of a chat to other chats
+      description: |
+        Copies up to 20 messages of the chat, oldest first, into every target chat, at most 20 copies in all. Every
+        copy counts against the sender's message rate. Every message and target is checked before anything is
+        written, so a refused one forwards nothing.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema: { $ref: "#/components/schemas/ForwardMessagesRequest" }
+      responses:
+        "426": { $ref: "#/components/responses/ClientOutdated" }
+        "400": { $ref: "#/components/responses/BadRequest" }
+        "201":
+          description: The new messages, per target chat oldest first
+          content:
+            application/json:
+              schema:
+                type: object
+                required: [items]
+                properties:
+                  items:
+                    type: array
+                    items: { $ref: "#/components/schemas/Message" }
+        "401": { $ref: "#/components/responses/Unauthorized" }
+        "403": { $ref: "#/components/responses/Forbidden" }
+        "404": { $ref: "#/components/responses/NotFound" }
+        "422": { $ref: "#/components/responses/ValidationFailed" }
+        "429": { $ref: "#/components/responses/TooManyRequests" }
+  /chats/{chat_id}/messages/delete:
+    parameters:
+      - $ref: "#/components/parameters/ClientVersion"
+      - $ref: "#/components/parameters/ClientApiVersion"
+      - $ref: "#/components/parameters/ChatId"
+    post:
+      tags: [messages]
+      operationId: deleteMessages
+      summary: Delete several messages of a chat
+      description: |
+        Deletes up to 100 messages of the chat with the rules of `DELETE /messages/{message_id}`. Every message
+        is checked first: when one may not be deleted, none is.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema: { $ref: "#/components/schemas/DeleteMessagesRequest" }
+      responses:
+        "426": { $ref: "#/components/responses/ClientOutdated" }
+        "400": { $ref: "#/components/responses/BadRequest" }
+        "204":
+          description: Deleted
+        "401": { $ref: "#/components/responses/Unauthorized" }
+        "403": { $ref: "#/components/responses/Forbidden" }
+        "404": { $ref: "#/components/responses/NotFound" }
+        "422": { $ref: "#/components/responses/ValidationFailed" }
 
   # -------------------------------------------------------------- search
   /search/messages:
@@ -2446,7 +2536,7 @@ components:
           description: A code of the authenticator app, or an unused recovery code.
     Visibility:
       type: string
-      description: Who may see the item. `*_except` scopes use the exception lists.
+      description: Who may see the item. The exception lists apply to every value; `*_except` behave like `everyone` and `nobody`.
       enum: [everyone, contacts, everyone_except, nobody_except, nobody]
     DirectMessagePolicy:
       type: string
@@ -2459,7 +2549,7 @@ components:
       enum: [everyone, nobody]
     PrivacyExceptions:
       type: object
-      description: User IDs per setting; `allow` applies to `nobody_except`, `deny` to `everyone_except`.
+      description: User IDs per setting. An exception wins over the setting whatever its value; `allow` always lets the user in, `deny` always keeps them out.
       additionalProperties:
         type: object
         required: [allow, deny]
@@ -2810,6 +2900,35 @@ components:
           maxItems: 20
           uniqueItems: true
           items: { $ref: "#/components/schemas/Id" }
+    ForwardMessagesRequest:
+      type: object
+      required: [message_ids, chat_ids]
+      properties:
+        message_ids:
+          type: array
+          minItems: 1
+          maxItems: 20
+          uniqueItems: true
+          items: { $ref: "#/components/schemas/Id" }
+        chat_ids:
+          type: array
+          minItems: 1
+          maxItems: 20
+          uniqueItems: true
+          items: { $ref: "#/components/schemas/Id" }
+    DeleteMessagesRequest:
+      type: object
+      required: [message_ids, scope]
+      properties:
+        message_ids:
+          type: array
+          minItems: 1
+          maxItems: 100
+          uniqueItems: true
+          items: { $ref: "#/components/schemas/Id" }
+        scope:
+          type: string
+          enum: [me, everyone]
     MarkReadRequest:
       type: object
       required: [message_id]

package/dist/schema.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.1.0-alpha.6. Do not edit. */
+/* Generated from api/openapi.yaml 2.1.0-alpha.9. Do not edit. */
 export interface paths {
     "/meta": {
         parameters: {
@@ -328,6 +328,36 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/me/avatars/{avatar_id}": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Version of the client app, for logs and the per-client metric. */
+                "X-Client-Version"?: components["parameters"]["ClientVersion"];
+                /** @description Contract version the client was built with (`API_VERSION` of `@myronsi/messenger-api`). A different MAJOR or a version below `min_client_api_version` is answered with `426`; a malformed value with `400` (`invalid_client_version`). */
+                "X-Client-Api-Version"?: components["parameters"]["ClientApiVersion"];
+            };
+            path: {
+                /** @description `id` of an `AvatarVersion` of the caller. */
+                avatar_id: components["schemas"]["Id"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Delete one of your avatars
+         * @description Removes the avatar from your history. When it is the current one, the newest remaining avatar becomes
+         *     current again; without one you get the default avatar. The image is deleted from storage once nothing
+         *     uses it any more.
+         */
+        delete: operations["deleteMyAvatar"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/me/password": {
         parameters: {
             query?: never;
@@ -531,7 +561,7 @@ export interface paths {
                 "X-Client-Api-Version"?: components["parameters"]["ClientApiVersion"];
             };
             path: {
-                setting_key: "avatar_visibility" | "profile_visibility" | "presence_visibility" | "group_invites";
+                setting_key: "avatar_visibility" | "profile_visibility" | "presence_visibility" | "group_invites" | "direct_messages" | "search_visibility";
                 effect: "allow" | "deny";
             };
             cookie?: never;
@@ -1062,6 +1092,63 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/chats/{chat_id}/messages/forward": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Version of the client app, for logs and the per-client metric. */
+                "X-Client-Version"?: components["parameters"]["ClientVersion"];
+                /** @description Contract version the client was built with (`API_VERSION` of `@myronsi/messenger-api`). A different MAJOR or a version below `min_client_api_version` is answered with `426`; a malformed value with `400` (`invalid_client_version`). */
+                "X-Client-Api-Version"?: components["parameters"]["ClientApiVersion"];
+            };
+            path: {
+                chat_id: components["parameters"]["ChatId"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Forward several messages of a chat to other chats
+         * @description Copies up to 20 messages of the chat, oldest first, into every target chat, at most 20 copies in all. Every
+         *     copy counts against the sender's message rate. Every message and target is checked before anything is
+         *     written, so a refused one forwards nothing.
+         */
+        post: operations["forwardMessages"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/chats/{chat_id}/messages/delete": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Version of the client app, for logs and the per-client metric. */
+                "X-Client-Version"?: components["parameters"]["ClientVersion"];
+                /** @description Contract version the client was built with (`API_VERSION` of `@myronsi/messenger-api`). A different MAJOR or a version below `min_client_api_version` is answered with `426`; a malformed value with `400` (`invalid_client_version`). */
+                "X-Client-Api-Version"?: components["parameters"]["ClientApiVersion"];
+            };
+            path: {
+                chat_id: components["parameters"]["ChatId"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Delete several messages of a chat
+         * @description Deletes up to 100 messages of the chat with the rules of `DELETE /messages/{message_id}`. Every message
+         *     is checked first: when one may not be deleted, none is.
+         */
+        post: operations["deleteMessages"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/search/messages": {
         parameters: {
             query?: never;
@@ -1712,7 +1799,7 @@ export interface components {
             code: string;
         };
         /**
-         * @description Who may see the item. `*_except` scopes use the exception lists.
+         * @description Who may see the item. The exception lists apply to every value; `*_except` behave like `everyone` and `nobody`.
          * @enum {string}
          */
         Visibility: "everyone" | "contacts" | "everyone_except" | "nobody_except" | "nobody";
@@ -1722,7 +1809,7 @@ export interface components {
         GroupInvitePolicy: "everyone" | "contacts" | "everyone_except" | "nobody_except" | "nobody" | "wait_approval";
         /** @enum {string} */
         SearchVisibility: "everyone" | "nobody";
-        /** @description User IDs per setting; `allow` applies to `nobody_except`, `deny` to `everyone_except`. */
+        /** @description User IDs per setting. An exception wins over the setting whatever its value; `allow` always lets the user in, `deny` always keeps them out. */
         PrivacyExceptions: {
             [key: string]: {
                 allow: components["schemas"]["Id"][];
@@ -1902,6 +1989,15 @@ export interface components {
         ForwardMessageRequest: {
             chat_ids: components["schemas"]["Id"][];
         };
+        ForwardMessagesRequest: {
+            message_ids: components["schemas"]["Id"][];
+            chat_ids: components["schemas"]["Id"][];
+        };
+        DeleteMessagesRequest: {
+            message_ids: components["schemas"]["Id"][];
+            /** @enum {string} */
+            scope: "me" | "everyone";
+        };
         MarkReadRequest: {
             /** @description Everything up to and including this message is read. */
             message_id: components["schemas"]["Id"];
@@ -2641,6 +2737,38 @@ export interface operations {
             426: components["responses"]["ClientOutdated"];
         };
     };
+    deleteMyAvatar: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Version of the client app, for logs and the per-client metric. */
+                "X-Client-Version"?: components["parameters"]["ClientVersion"];
+                /** @description Contract version the client was built with (`API_VERSION` of `@myronsi/messenger-api`). A different MAJOR or a version below `min_client_api_version` is answered with `426`; a malformed value with `400` (`invalid_client_version`). */
+                "X-Client-Api-Version"?: components["parameters"]["ClientApiVersion"];
+            };
+            path: {
+                /** @description `id` of an `AvatarVersion` of the caller. */
+                avatar_id: components["schemas"]["Id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Updated user */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Me"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            426: components["responses"]["ClientOutdated"];
+        };
+    };
     changePassword: {
         parameters: {
             query?: never;
@@ -2992,7 +3120,7 @@ export interface operations {
                 "X-Client-Api-Version"?: components["parameters"]["ClientApiVersion"];
             };
             path: {
-                setting_key: "avatar_visibility" | "profile_visibility" | "presence_visibility" | "group_invites";
+                setting_key: "avatar_visibility" | "profile_visibility" | "presence_visibility" | "group_invites" | "direct_messages" | "search_visibility";
                 effect: "allow" | "deny";
             };
             cookie?: never;
@@ -3989,6 +4117,81 @@ export interface operations {
             429: components["responses"]["TooManyRequests"];
         };
     };
+    forwardMessages: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Version of the client app, for logs and the per-client metric. */
+                "X-Client-Version"?: components["parameters"]["ClientVersion"];
+                /** @description Contract version the client was built with (`API_VERSION` of `@myronsi/messenger-api`). A different MAJOR or a version below `min_client_api_version` is answered with `426`; a malformed value with `400` (`invalid_client_version`). */
+                "X-Client-Api-Version"?: components["parameters"]["ClientApiVersion"];
+            };
+            path: {
+                chat_id: components["parameters"]["ChatId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ForwardMessagesRequest"];
+            };
+        };
+        responses: {
+            /** @description The new messages, per target chat oldest first */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        items: components["schemas"]["Message"][];
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["ValidationFailed"];
+            426: components["responses"]["ClientOutdated"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    deleteMessages: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Version of the client app, for logs and the per-client metric. */
+                "X-Client-Version"?: components["parameters"]["ClientVersion"];
+                /** @description Contract version the client was built with (`API_VERSION` of `@myronsi/messenger-api`). A different MAJOR or a version below `min_client_api_version` is answered with `426`; a malformed value with `400` (`invalid_client_version`). */
+                "X-Client-Api-Version"?: components["parameters"]["ClientApiVersion"];
+            };
+            path: {
+                chat_id: components["parameters"]["ChatId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["DeleteMessagesRequest"];
+            };
+        };
+        responses: {
+            /** @description Deleted */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["ValidationFailed"];
+            426: components["responses"]["ClientOutdated"];
+        };
+    };
     searchAllMessages: {
         parameters: {
             query: {

package/dist/ws-events.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.1.0-alpha.6. Do not edit. */
+/* Generated from api/openapi.yaml 2.1.0-alpha.9. Do not edit. */
 
 /**
  * Any WebSocket event, in either direction.

package/dist/ws-events.schema.json

@@ -803,7 +803,7 @@
     },
     "Visibility": {
       "type": "string",
-      "description": "Who may see the item. `*_except` scopes use the exception lists.",
+      "description": "Who may see the item. The exception lists apply to every value; `*_except` behave like `everyone` and `nobody`.",
       "enum": [
         "everyone",
         "contacts",
@@ -840,7 +840,7 @@
     },
     "PrivacyExceptions": {
       "type": "object",
-      "description": "User IDs per setting; `allow` applies to `nobody_except`, `deny` to `everyone_except`.",
+      "description": "User IDs per setting. An exception wins over the setting whatever its value; `allow` always lets the user in, `deny` always keeps them out.",
       "additionalProperties": {
         "type": "object",
         "required": [
@@ -1627,6 +1627,58 @@
         }
       }
     },
+    "ForwardMessagesRequest": {
+      "type": "object",
+      "required": [
+        "message_ids",
+        "chat_ids"
+      ],
+      "properties": {
+        "message_ids": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 20,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/Id"
+          }
+        },
+        "chat_ids": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 20,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/Id"
+          }
+        }
+      }
+    },
+    "DeleteMessagesRequest": {
+      "type": "object",
+      "required": [
+        "message_ids",
+        "scope"
+      ],
+      "properties": {
+        "message_ids": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 100,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/Id"
+          }
+        },
+        "scope": {
+          "type": "string",
+          "enum": [
+            "me",
+            "everyone"
+          ]
+        }
+      }
+    },
     "MarkReadRequest": {
       "type": "object",
       "required": [

package/package.json

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