@sorokchat-messanger/contracts 1.0.2

package/dist/users/new-user.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"new-user.schema.js","sourceRoot":"","sources":["../../src/users/new-user.schema.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AAEpB,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC;AACrC,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAEvC,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,KAAK,EAAE,CAAC;SACL,MAAM,CAAC,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC;SAC5C,QAAQ,CAAC,EAAE,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC1C,QAAQ,EAAE,CAAC;SACR,MAAM,CAAC,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC;SAC7C,GAAG,CAAC,mBAAmB,EAAE;QACxB,OAAO,EAAE,6BAA6B,mBAAmB,WAAW;KACrE,CAAC;SACD,GAAG,CAAC,mBAAmB,EAAE;QACxB,OAAO,EAAE,8BAA8B,mBAAmB,WAAW;KACtE,CAAC;IACJ,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,6BAA6B,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC7E,CAAC,CAAC"}

package/dist/users/update-user.schema.d.ts

@@ -0,0 +1,8 @@
+import z from "zod";
+export declare const UpdateUserSchema: z.ZodObject<{
+    login: z.ZodOptional<z.ZodString>;
+    password: z.ZodOptional<z.ZodString>;
+    displayName: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>;
+export type UpdateUserPayload = z.infer<typeof UpdateUserSchema>;
+//# sourceMappingURL=update-user.schema.d.ts.map

package/dist/users/update-user.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-user.schema.d.ts","sourceRoot":"","sources":["../../src/users/update-user.schema.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AAGpB,eAAO,MAAM,gBAAgB;;;;iBAA0B,CAAC;AACxD,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC"}

package/dist/users/update-user.schema.js

@@ -0,0 +1,4 @@
+import z from "zod";
+import { NewUserSchema } from "./new-user.schema.js";
+export const UpdateUserSchema = NewUserSchema.partial();
+//# sourceMappingURL=update-user.schema.js.map

package/dist/users/update-user.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-user.schema.js","sourceRoot":"","sources":["../../src/users/update-user.schema.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AACpB,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,MAAM,CAAC,MAAM,gBAAgB,GAAG,aAAa,CAAC,OAAO,EAAE,CAAC"}

package/openapi.yaml

@@ -0,0 +1,568 @@
+openapi: 3.0.3
+info:
+  title: Sorokchat
+  description: Sorokchat - Український захищений месенджер
+  version: 1.0.0
+security:
+  - bearerAuthorization: []
+components:
+  securitySchemes:
+    bearerAuthorization:
+      type: http
+      bearerFormat: JWT
+      scheme: bearer
+    cookieAuthorization:
+      type: apiKey
+      in: cookie
+      name: __Host-refresh-token
+  schemas:
+    RegisterPayload:
+      type: object
+      required:
+        - login
+        - password
+      properties:
+        login:
+          type: string
+          description: Логін користувача
+          example: andrey
+        password:
+          type: string
+          description: Пароль користувача
+          example: <PASSWORD>
+        displayName:
+          type: string
+          description: Видиме ім'я користувача
+          example: Андрій
+    LoginPayload:
+      type: object
+      required:
+        - login
+        - password
+      properties:
+        login:
+          type: string
+          description: Логін користувача
+          example: andrey
+        password:
+          type: string
+          description: Пароль користувача
+          example: <PASSWORD>
+    AuthorizedPayload:
+      type: object
+      required:
+        - accessToken
+      properties:
+        accessToken:
+          type: string
+          description: Токен доступу
+          example: <TOKEN>
+    ErrorPayload:
+      type: object
+      required:
+        - message
+        - statusCode
+      properties:
+        message:
+          type: string
+          description: Повідомлення помилки
+          example: Не коректні данні
+        statusCode:
+          type: integer
+          description: Код помилки
+          example: 400
+      additionalProperties: true
+    GetUserPayload:
+      type: object
+      required:
+        - id
+        - login
+        - displayName
+      properties:
+        id:
+          type: integer
+          description: Унікальний ідентифікатор користувача
+          example: 1
+        login:
+          type: string
+          description: Логін користувача
+          example: andrey
+        displayName:
+          type: string
+          description: Видиме ім'я користувача
+          example: Андрій
+        role:
+          type: string
+          description: Роль користувача
+          example: USER
+    CreateChatPayload:
+      type: object
+      required:
+        - name
+        - description
+      properties:
+        name:
+          type: string
+          description: Назва чату
+          example: Крутий чат
+        description:
+          type: string
+          description: Опис чату
+          example: Дуже крутий чат
+    UpdateChatPayload:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Назва чату
+          example: Крутий чат
+        description:
+          type: string
+          description: Опис чату
+          example: Дуже крутий чат
+    GetMemberPayload:
+      type: object
+      required:
+        - userId
+        - login
+        - displayName
+        - role
+      properties:
+        userId:
+          type: integer
+          description: Унікальний ідентифікатор користувача
+          example: 1
+        login:
+          type: string
+          description: Логін користувача
+          example: andrey
+        displayName:
+          type: string
+          description: Видеме ім'я користувача
+          example: Андрій
+        role:
+          type: string
+          description: Роль користувача у чаті
+          example: MEMBER
+    GetChatPayload:
+      type: object
+      required:
+        - id
+        - name
+        - description
+      properties:
+        id:
+          type: integer
+          description: Унікальний ідентифікатор чату
+          example: 1
+        name:
+          type: string
+          description: Назва чату
+          example: Крутий чат
+        description:
+          type: string
+          description: Опис чату
+          example: Дуже крутий чат
+        members:
+          type: array
+          minLength: 1
+          items:
+            $ref: "#/components/schemas/GetMemberPayload"
+    GetChatListPayload:
+      type: array
+      items:
+        $ref: "#/components/schemas/GetChatPayload"
+  responses:
+    BadRequestResponse:
+      description: Не коректні данні
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/ErrorPayload"
+    UnauthorizedResponse:
+      description: Користувач не авторизований
+      headers:
+        WWW-Authenticate:
+          schema:
+            type: string
+            description: Бажаний спосіб авторизації
+            example: Bearer
+          description: Спосіб авторизації, який очікує сервер
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/ErrorPayload"
+    ForbiddenResponse:
+      description: У доступі відмовлено
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/ErrorPayload"
+    NotFoundResponse:
+      description: Не знайдено
+      content:
+        authorization/json:
+          schema:
+            $ref: "#/components/schemas/ErrorPayload"
+    ConflictResponse:
+      description: Сутність вже існує
+      content:
+        authorization/json:
+          schema:
+            $ref: "#/components/schemas/ErrorPayload"
+paths:
+  /authorization/register:
+    post:
+      security: []
+      summary: Реєстрація
+      description: Реєстрація користувача у системі
+      operationId: register
+      tags:
+        - Авторизація
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/RegisterPayload"
+      responses:
+        201:
+          description: Успішна реєстрація
+          headers:
+            Location:
+              schema:
+                type: string
+                description: Посилання на свої данні
+                example: authorization/profile
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AuthorizedPayload"
+        400:
+          $ref: "#/components/responses/BadRequestResponse"
+        403:
+          $ref: "#/components/responses/ForbiddenResponse"
+        409:
+          $ref: "#/components/responses/ConflictResponse"
+  /authorization/login:
+    post:
+      security: []
+      summary: Вхід
+      description: Вхід користувача у систему
+      operationId: login
+      tags:
+        - Авторизація
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/LoginPayload"
+      responses:
+        201:
+          description: Успішний вхід
+          headers:
+            Location:
+              schema:
+                type: string
+                description: Посилання на свої данні
+                example: authorization/profile
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AuthorizedPayload"
+        400:
+          $ref: "#/components/responses/BadRequestResponse"
+        403:
+          $ref: "#/components/responses/ForbiddenResponse"
+  /authorization/logout:
+    delete:
+      summary: Вихід із системи
+      description: Вихід користувача із системи
+      operationId: logout
+      tags:
+        - Авторизація
+      responses:
+        204:
+          description: Успішний вихід
+        401:
+          $ref: "#/components/responses/UnauthorizedResponse"
+  /authorization/refresh-tokens:
+    put:
+      summary: Оновлення токенів
+      description: Оновлює токени за наявності токена оновлення
+      operationId: refresh-tokens
+      tags:
+        - Авторизація
+      responses:
+        200:
+          description: Успішне оновлення токенів
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AuthorizedPayload"
+        401:
+          $ref: "#/components/responses/UnauthorizedResponse"
+  /authorization/profile:
+    get:
+      summary: Профіль
+      description: Можливість для користувача отримати свої данні
+      operationId: profile
+      tags:
+        - Авторизація
+      responses:
+        200:
+          description: Успішне отримання себе
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GetUserPayload"
+        401:
+          $ref: "#/components/responses/UnauthorizedResponse"
+  /chats:
+    post:
+      summary: Новий чат
+      description: Створення нового чату у системі
+      operationId: createChat
+      tags:
+        - Чати
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateChatPayload"
+      responses:
+        201:
+          description: Успішне створення чату
+          headers:
+            Location:
+              schema:
+                type: string
+                description: Посилання на створений чат
+                example: /chats/by-id/1
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GetChatPayload"
+        400:
+          $ref: "#/components/responses/BadRequestResponse"
+        401:
+          $ref: "#/components/responses/UnauthorizedResponse"
+  /chats/me:
+    get:
+      summary: Мої чати
+      description: Чати авторизованого користувача
+      operationId: my-chats
+      tags:
+        - Чати
+      responses:
+        200:
+          description: Успішне отримання чатів
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GetChatListPayload"
+        401:
+          $ref: "#/components/responses/UnauthorizedResponse"
+  /chats/by-id/{id}:
+    parameters:
+      - in: path
+        required: true
+        name: id
+        schema:
+          type: integer
+          description: Унікальний ідентифікатор чату
+          example: 1
+    put:
+      summary: Оновлення чату
+      description: Адмін чату може оновити чат
+      operationId: update-chat
+      tags:
+        - Чати
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpdateChatPayload"
+      responses:
+        204:
+          description: Успішне оновлення чату
+        400:
+          $ref: "#/components/responses/BadRequestResponse"
+        401:
+          $ref: "#/components/responses/UnauthorizedResponse"
+        403:
+          $ref: "#/components/responses/ForbiddenResponse"
+        404:
+          $ref: "#/components/responses/NotFoundResponse"
+    delete:
+      summary: Видалення чату
+      description: Адмін може видалити чат
+      operationId: delete-chat
+      tags:
+        - Чати
+      responses:
+        204:
+          description: Успішне видалення чату
+        401:
+          $ref: "#/components/responses/UnauthorizedResponse"
+        403:
+          $ref: "#/components/responses/ForbiddenResponse"
+        404:
+          $ref: "#/components/responses/NotFoundResponse"
+  /chats/by-id/{id}/add-member/{userId}:
+    put:
+      parameters:
+        - name: id
+          schema:
+            type: integer
+            description: Унікальне ім'я чату
+            example: 1
+          in: path
+          required: true
+        - name: userId
+          schema:
+            type: integer
+            description: Унікальне ім'я користувача
+            example: 1
+          in: path
+          required: true
+      summary: Додати учасника
+      description: Адмін додає учасника
+      operationId: add-member-to-chat
+      tags:
+        - Чати
+      responses:
+        204:
+          description: Успішне додавання учасника до чату
+        401:
+          $ref: "#/components/responses/UnauthorizedResponse"
+        403:
+          $ref: "#/components/responses/ForbiddenResponse"
+        404:
+          $ref: "#/components/responses/NotFoundResponse"
+        409:
+          $ref: "#/components/responses/ConflictResponse"
+  /chats/by-id/{id}/remove-member/{userId}:
+    put:
+      parameters:
+        - name: id
+          schema:
+            type: integer
+            description: Унікальне ім'я чату
+            example: 1
+          in: path
+          required: true
+        - name: userId
+          schema:
+            type: integer
+            description: Унікальне ім'я користувача
+            example: 1
+          in: path
+          required: true
+      summary: Видалити учасника
+      description: Адмін видаляє учасника
+      operationId: remove-member-from-chat
+      tags:
+        - Чати
+      responses:
+        204:
+          description: Успішне видалення учасника із чату
+        401:
+          $ref: "#/components/responses/UnauthorizedResponse"
+        403:
+          $ref: "#/components/responses/ForbiddenResponse"
+        404:
+          $ref: "#/components/responses/NotFoundResponse"
+  /chats/by-id/{id}/leave:
+    put:
+      summary: Покинути чат
+      description: Учасник може покинути чат
+      operationId: leave-chat
+      parameters:
+        - in: path
+          required: true
+          name: id
+          schema:
+            type: integer
+            description: Унікальний ідентифікатор чату
+            example: 1
+      tags:
+        - Чати
+      responses:
+        204:
+          description: Успішний вихід із чату
+        400:
+          $ref: "#/components/responses/BadRequestResponse"
+        401:
+          $ref: "#/components/responses/UnauthorizedResponse"
+        403:
+          $ref: "#/components/responses/ForbiddenResponse"
+  /chats/by-id/{id}/grant/{userId}/{role}:
+    put:
+      summary: Дати користувачу роль
+      description: Адмін може дати роль користувачу у чаті
+      operationId: grant-member
+      tags:
+        - Чати
+      parameters:
+        - name: id
+          schema:
+            type: integer
+            description: Унікальне ім'я чату
+            example: 1
+          in: path
+          required: true
+        - name: userId
+          schema:
+            type: integer
+            description: Унікальне ім'я користувача
+            example: 1
+          in: path
+          required: true
+        - name: role
+          in: path
+          required: true
+          schema:
+            type: string
+            description: Роль користувача у чаті
+      responses:
+        204:
+          description: Успішне надання ролі
+        401:
+          $ref: "#/components/responses/UnauthorizedResponse"
+        403:
+          $ref: "#/components/responses/ForbiddenResponse"
+        404:
+          $ref: "#/components/responses/NotFoundResponse"
+  /chats/by-id/{id}/revoke/{userId}:
+    put:
+      summary: Відкликання ролі
+      description: Адмін може забрати роль учасника чату
+      operationId: revoke-member
+      parameters:
+        - name: id
+          schema:
+            type: integer
+            description: Унікальне ім'я чату
+            example: 1
+          in: path
+          required: true
+        - name: userId
+          schema:
+            type: integer
+            description: Унікальне ім'я користувача
+            example: 1
+          in: path
+          required: true
+      tags:
+        - Чати
+      responses:
+        204:
+          description: Успішне відкликання ролі
+        400:
+          $ref: "#/components/responses/BadRequestResponse"
+        401:
+          $ref: "#/components/responses/UnauthorizedResponse"
+        403:
+          $ref: "#/components/responses/ForbiddenResponse"
+        404:
+          $ref: "#/components/responses/NotFoundResponse"

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@sorokchat-messanger/contracts",
+  "version": "1.0.2",
+  "description": "Contracts for sorokchat-messanger",
+  "keywords": [
+    "contracts",
+    "sorokchat",
+    "messanger"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "openapi.yaml"
+  ],
+  "author": "Srokovsky Andrey <Sorokovsky0809@gmail.com>",
+  "scripts": {
+    "build": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sorokchat-messanger/contracts.git"
+  },
+  "homepage": "https://github.com/sorokchat-messanger/contracts#readme",
+  "bugs": {
+    "url": "https://github.com/sorokchat-messanger/contracts/issues"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "MIT",
+  "type": "module",
+  "dependencies": {
+    "js-yaml": "^5.2.3",
+    "zod": "^4.4.3"
+  },
+  "peerDependencies": {
+    "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "@nestjs/swagger": "^11.4.6",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^26.2.0",
+    "typescript": "^7.0.2"
+  },
+  "exports": {
+    "browser": {
+      "types": "./dist/browser/index.d.ts",
+      "import": "./dist/browser/index.js",
+      "require": "./dist/browser/index.js"
+    },
+    "node": {
+      "types": "./dist/node/index.d.ts",
+      "import": "./dist/node/index.js",
+      "require": "./dist/node/index.js"
+    },
+    "default": {
+      "types": "./dist/node/index.d.ts",
+      "import": "./dist/node/index.js",
+      "require": "./dist/node/index.js"
+    }
+  },
+  "packageManager": "yarn@4.18.0"
+}