@myronsi/messenger-api 2.1.0-alpha.1 → 2.1.0-alpha.2

package/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 Contract changes only. The backend changelog is `CHANGELOG.md` in the repository root. Rules: `docs/api-compatibility.md`.
 
+## 2.1.0-alpha.2
+
+- Adds notification preferences, session-bound push device registration and per-tab activity leases.
+- Adds chat notification mutes for one hour, eight hours, indefinitely, or until unmuted.
+
 ## 2.1.0-alpha.1
 
 - Registration returns a one-time recovery_key. GET /me adds recovery_setup_required.

package/dist/index.d.ts

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

package/dist/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.1.0
 info:
   title: Messenger API
-  version: 2.1.0-alpha.1
+  version: 2.1.0-alpha.2
   summary: REST contract of the Messenger backend (v2).
   description: |
     Contract for the Go backend. The WebSocket protocol is described in `websocket/` and
@@ -1715,6 +1715,160 @@ paths:
         "404": { $ref: "#/components/responses/NotFound" }
         "409": { $ref: "#/components/responses/Conflict" }
 
+  /me/notifications:
+    get:
+      tags:
+        - me
+      operationId: getNotificationSettings
+      summary: Notification preferences and supported push platforms
+      responses:
+        "200":
+          description: Notification settings or registered device
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/NotificationSettings"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "404":
+          $ref: "#/components/responses/NotFound"
+        "409":
+          $ref: "#/components/responses/Conflict"
+    put:
+      tags:
+        - me
+      operationId: updateNotificationSettings
+      summary: Replace notification preferences
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/NotificationPreferences"
+      responses:
+        "204":
+          description: Saved
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "404":
+          $ref: "#/components/responses/NotFound"
+        "409":
+          $ref: "#/components/responses/Conflict"
+  /me/notification-devices:
+    post:
+      tags:
+        - me
+      operationId: registerNotificationDevice
+      summary: Register a push destination for the current session
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/NotificationDeviceRequest"
+      responses:
+        "200":
+          description: Notification settings or registered device
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/NotificationDeviceRegistered"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "404":
+          $ref: "#/components/responses/NotFound"
+        "409":
+          $ref: "#/components/responses/Conflict"
+  /me/notification-devices/{id}:
+    parameters:
+      - name: id
+        in: path
+        required: true
+        schema:
+          type: string
+          format: uuid
+    delete:
+      tags:
+        - me
+      operationId: deleteNotificationDevice
+      summary: Unregister a push destination for the current session
+      responses:
+        "204":
+          description: Saved
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "404":
+          $ref: "#/components/responses/NotFound"
+        "409":
+          $ref: "#/components/responses/Conflict"
+  /chats/{chatId}/notification-mute:
+    parameters:
+      - name: chatId
+        in: path
+        required: true
+        schema:
+          $ref: "#/components/schemas/Id"
+    put:
+      tags:
+        - me
+      operationId: setNotificationMute
+      summary: Mute or unmute a chat
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/NotificationMuteRequest"
+      responses:
+        "204":
+          description: Saved
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "404":
+          $ref: "#/components/responses/NotFound"
+        "409":
+          $ref: "#/components/responses/Conflict"
+  /me/notification-devices/{id}/activity:
+    parameters:
+      - name: id
+        in: path
+        required: true
+        schema:
+          type: string
+          format: uuid
+    put:
+      tags:
+        - me
+      operationId: updateNotificationActivity
+      summary: Report a visible client with a healthy live connection
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/NotificationActivity"
+      responses:
+        "204":
+          description: Saved
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "404":
+          $ref: "#/components/responses/NotFound"
+        "409":
+          $ref: "#/components/responses/Conflict"
+
 components:
   securitySchemes:
     bearerAuth:
@@ -1845,6 +1999,106 @@ components:
           schema: { $ref: "#/components/schemas/Problem" }
 
   schemas:
+    NotificationPreferences:
+      type: object
+      required:
+        - enabled
+        - sound
+        - previews
+      properties:
+        enabled:
+          type: boolean
+        sound:
+          type: boolean
+        previews:
+          type: boolean
+    NotificationSettings:
+      type: object
+      required:
+        - preferences
+        - mutes
+        - web_push
+        - android_push
+        - ios_push
+        - vapid_public_key
+      properties:
+        preferences:
+          $ref: "#/components/schemas/NotificationPreferences"
+        mutes:
+          type: array
+          items:
+            type: object
+            required:
+              - chat_id
+              - until
+            properties:
+              chat_id:
+                $ref: "#/components/schemas/Id"
+              until:
+                type: string
+                format: date-time
+        web_push:
+          type: boolean
+        android_push:
+          type: boolean
+        ios_push:
+          type: boolean
+        vapid_public_key:
+          type: string
+    NotificationDeviceRequest:
+      type: object
+      required:
+        - platform
+        - destination
+      properties:
+        platform:
+          type: string
+          enum:
+            - web
+            - android
+            - ios
+        destination:
+          type: string
+          minLength: 1
+          maxLength: 4096
+        p256dh:
+          type: string
+          maxLength: 128
+        auth:
+          type: string
+          maxLength: 64
+    NotificationDeviceRegistered:
+      type: object
+      required:
+        - id
+      properties:
+        id:
+          type: string
+          format: uuid
+    NotificationMuteRequest:
+      type: object
+      required:
+        - duration
+      properties:
+        duration:
+          type: string
+          enum:
+            - off
+            - 1h
+            - 8h
+            - forever
+    NotificationActivity:
+      type: object
+      required:
+        - active
+        - client_id
+      properties:
+        active:
+          type: boolean
+        client_id:
+          type: string
+          format: uuid
+
     # ---------------------------------------------------------- basics
     Id:
       type: string

package/dist/schema.d.ts

@@ -1,4 +1,4 @@
-/* Generated from api/openapi.yaml 2.1.0-alpha.1. Do not edit. */
+/* Generated from api/openapi.yaml 2.1.0-alpha.2. Do not edit. */
 export interface paths {
     "/meta": {
         parameters: {
@@ -1340,10 +1340,139 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/me/notifications": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Notification preferences and supported push platforms */
+        get: operations["getNotificationSettings"];
+        /** Replace notification preferences */
+        put: operations["updateNotificationSettings"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/me/notification-devices": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Register a push destination for the current session */
+        post: operations["registerNotificationDevice"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/me/notification-devices/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /** Unregister a push destination for the current session */
+        delete: operations["deleteNotificationDevice"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/chats/{chatId}/notification-mute": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                chatId: components["schemas"]["Id"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        /** Mute or unmute a chat */
+        put: operations["setNotificationMute"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/me/notification-devices/{id}/activity": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        /** Report a visible client with a healthy live connection */
+        put: operations["updateNotificationActivity"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        NotificationPreferences: {
+            enabled: boolean;
+            sound: boolean;
+            previews: boolean;
+        };
+        NotificationSettings: {
+            preferences: components["schemas"]["NotificationPreferences"];
+            mutes: {
+                chat_id: components["schemas"]["Id"];
+                /** Format: date-time */
+                until: string;
+            }[];
+            web_push: boolean;
+            android_push: boolean;
+            ios_push: boolean;
+            vapid_public_key: string;
+        };
+        NotificationDeviceRequest: {
+            /** @enum {string} */
+            platform: "web" | "android" | "ios";
+            destination: string;
+            p256dh?: string;
+            auth?: string;
+        };
+        NotificationDeviceRegistered: {
+            /** Format: uuid */
+            id: string;
+        };
+        NotificationMuteRequest: {
+            /** @enum {string} */
+            duration: "off" | "1h" | "8h" | "forever";
+        };
+        NotificationActivity: {
+            active: boolean;
+            /** Format: uuid */
+            client_id: string;
+        };
         /**
          * @description Decimal ID as a string (Snowflake IDs exceed 2^53).
          * @example 7217400317439950848
@@ -4311,4 +4440,162 @@ export interface operations {
             426: components["responses"]["ClientOutdated"];
         };
     };
+    getNotificationSettings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Notification settings or registered device */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["NotificationSettings"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            409: components["responses"]["Conflict"];
+        };
+    };
+    updateNotificationSettings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["NotificationPreferences"];
+            };
+        };
+        responses: {
+            /** @description Saved */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            409: components["responses"]["Conflict"];
+        };
+    };
+    registerNotificationDevice: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["NotificationDeviceRequest"];
+            };
+        };
+        responses: {
+            /** @description Notification settings or registered device */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["NotificationDeviceRegistered"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            409: components["responses"]["Conflict"];
+        };
+    };
+    deleteNotificationDevice: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Saved */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            409: components["responses"]["Conflict"];
+        };
+    };
+    setNotificationMute: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                chatId: components["schemas"]["Id"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["NotificationMuteRequest"];
+            };
+        };
+        responses: {
+            /** @description Saved */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            409: components["responses"]["Conflict"];
+        };
+    };
+    updateNotificationActivity: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["NotificationActivity"];
+            };
+        };
+        responses: {
+            /** @description Saved */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            409: components["responses"]["Conflict"];
+        };
+    };
 }

package/dist/ws-events.d.ts

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

package/dist/ws-events.schema.json

@@ -1,6 +1,147 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$defs": {
+    "NotificationPreferences": {
+      "type": "object",
+      "required": [
+        "enabled",
+        "sound",
+        "previews"
+      ],
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "sound": {
+          "type": "boolean"
+        },
+        "previews": {
+          "type": "boolean"
+        }
+      }
+    },
+    "NotificationSettings": {
+      "type": "object",
+      "required": [
+        "preferences",
+        "mutes",
+        "web_push",
+        "android_push",
+        "ios_push",
+        "vapid_public_key"
+      ],
+      "properties": {
+        "preferences": {
+          "$ref": "#/$defs/NotificationPreferences"
+        },
+        "mutes": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "chat_id",
+              "until"
+            ],
+            "properties": {
+              "chat_id": {
+                "$ref": "#/$defs/Id"
+              },
+              "until": {
+                "type": "string",
+                "format": "date-time"
+              }
+            }
+          }
+        },
+        "web_push": {
+          "type": "boolean"
+        },
+        "android_push": {
+          "type": "boolean"
+        },
+        "ios_push": {
+          "type": "boolean"
+        },
+        "vapid_public_key": {
+          "type": "string"
+        }
+      }
+    },
+    "NotificationDeviceRequest": {
+      "type": "object",
+      "required": [
+        "platform",
+        "destination"
+      ],
+      "properties": {
+        "platform": {
+          "type": "string",
+          "enum": [
+            "web",
+            "android",
+            "ios"
+          ]
+        },
+        "destination": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 4096
+        },
+        "p256dh": {
+          "type": "string",
+          "maxLength": 128
+        },
+        "auth": {
+          "type": "string",
+          "maxLength": 64
+        }
+      }
+    },
+    "NotificationDeviceRegistered": {
+      "type": "object",
+      "required": [
+        "id"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid"
+        }
+      }
+    },
+    "NotificationMuteRequest": {
+      "type": "object",
+      "required": [
+        "duration"
+      ],
+      "properties": {
+        "duration": {
+          "type": "string",
+          "enum": [
+            "off",
+            "1h",
+            "8h",
+            "forever"
+          ]
+        }
+      }
+    },
+    "NotificationActivity": {
+      "type": "object",
+      "required": [
+        "active",
+        "client_id"
+      ],
+      "properties": {
+        "active": {
+          "type": "boolean"
+        },
+        "client_id": {
+          "type": "string",
+          "format": "uuid"
+        }
+      }
+    },
     "Id": {
       "type": "string",
       "pattern": "^[0-9]{1,19}$",

package/package.json

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