@skravets/eapi 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Kravets
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# EAPI
+
+MVP

package/dist/api-types.d.cts

@@ -0,0 +1,498 @@
+/**
+ * @module
+ *
+ * Сгенерированные TypeScript типы для [API](...).
+ */
+/**
+ * Сгенерированные из OpenAPI типы для `paths`
+ */
+interface paths {
+    "/": {
+        /** Get Hello World! */
+        get: operations["app.getHello"];
+    };
+    "/channels": {
+        /** Get Hello World! */
+        get: operations["channels.getHello"];
+    };
+    "/channels/{channelId}/last-message": {
+        /** Get last channel message */
+        get: operations["channels.getLastMessage"];
+    };
+    "/channels/{channelId}/new-messages": {
+        /** Get channel messages */
+        post: operations["channels.getMessages"];
+    };
+    "/subscriptions": {
+        /** Create subscription */
+        post: operations["subscriptions.create"];
+    };
+    "/subscriptions/{subId}": {
+        /** Get subscription by subscription id */
+        get: operations["subscriptions.getById"];
+        /** Update subscription by subscription id */
+        put: operations["subscriptions.update"];
+        /** Delete subscription by subscription id */
+        delete: operations["subscriptions.delete"];
+    };
+}
+/**
+ * Сгенерированные из OpenAPI типы для `components`
+ */
+interface components {
+    schemas: {
+        IGetChannelMessages: {
+            /**
+             * @description Cursor to get messages from id to id
+             * @example {
+             *       "from": 1,
+             *       "to": 10
+             *     }
+             */
+            cursor: Record<string, never>;
+        };
+        ChatDataDto: {
+            /** @example true */
+            id?: boolean;
+            /** @example true */
+            username?: boolean;
+            /** @example true */
+            title?: boolean;
+            /** @example true */
+            type?: boolean;
+            /** @example true */
+            participants_count?: boolean;
+            /** @example true */
+            last_offset_id?: boolean;
+            /** @example true */
+            last_parsed_date?: boolean;
+            /** @example true */
+            is_locked?: boolean;
+            /** @example true */
+            about?: boolean;
+            /** @example true */
+            avatar_id?: boolean;
+        };
+        SubscriptionChatDataDto: {
+            /**
+             * @description Chat schema
+             * @example {
+             *       "id": true,
+             *       "username": true,
+             *       "title": true,
+             *       "type": true,
+             *       "participants_count": true,
+             *       "last_offset_id": true,
+             *       "last_parsed_date": true,
+             *       "is_locked": true,
+             *       "about": true,
+             *       "avatar_id": true
+             *     }
+             */
+            data: components["schemas"]["ChatDataDto"];
+        };
+        SubscriptionMessageDataDto: {
+            /**
+             * @description Messages schema
+             * @example {
+             *       "channel_id": true,
+             *       "created_at": true,
+             *       "first_name": true,
+             *       "has_comments": true,
+             *       "has_reactions": true,
+             *       "last_name": true,
+             *       "message_created_at": true,
+             *       "message_id": true,
+             *       "reply_message_id": true,
+             *       "search_text": true,
+             *       "text": true,
+             *       "user_id": true,
+             *       "username": true
+             *     }
+             */
+            data: Record<string, never>;
+            /** @description Messages limit per request */
+            limit?: number;
+        };
+        SubscriptionDataDto: {
+            /**
+             * @description Chat meta data
+             * @example {
+             *       "data": {
+             *         "id": true,
+             *         "username": true,
+             *         "title": true,
+             *         "type": true,
+             *         "participants_count": true,
+             *         "last_offset_id": true,
+             *         "last_parsed_date": true,
+             *         "is_locked": true,
+             *         "about": true,
+             *         "avatar_id": true
+             *       }
+             *     }
+             */
+            chat?: components["schemas"]["SubscriptionChatDataDto"];
+            /**
+             * @description Messages data
+             * @example {
+             *       "data": {
+             *         "channel_id": true,
+             *         "created_at": true,
+             *         "first_name": true,
+             *         "has_comments": true,
+             *         "has_reactions": true,
+             *         "last_name": true,
+             *         "message_created_at": true,
+             *         "message_id": true,
+             *         "reply_message_id": true,
+             *         "search_text": true,
+             *         "text": true,
+             *         "user_id": true,
+             *         "username": true
+             *       },
+             *       "limit": 100
+             *     }
+             */
+            messages?: components["schemas"]["SubscriptionMessageDataDto"];
+        };
+        SubscribeDto: {
+            /**
+             * @description Chat Id to subscribe
+             * @example 1234567890
+             */
+            chatId: number;
+            /** @example {
+             *       "chat": {
+             *         "data": {
+             *           "id": true,
+             *           "username": true,
+             *           "title": true,
+             *           "type": true,
+             *           "participants_count": true,
+             *           "last_offset_id": true,
+             *           "last_parsed_date": true,
+             *           "is_locked": true,
+             *           "about": true,
+             *           "avatar_id": true
+             *         }
+             *       },
+             *       "messages": {
+             *         "data": {
+             *           "channel_id": true,
+             *           "created_at": true,
+             *           "first_name": true,
+             *           "has_comments": true,
+             *           "has_reactions": true,
+             *           "last_name": true,
+             *           "message_created_at": true,
+             *           "message_id": true,
+             *           "reply_message_id": true,
+             *           "search_text": true,
+             *           "text": true,
+             *           "user_id": true,
+             *           "username": true
+             *         },
+             *         "limit": 100
+             *       }
+             *     } */
+            data: components["schemas"]["SubscriptionDataDto"];
+            /**
+             * @description Webhook url
+             * @example https://example.com/webhook
+             */
+            webhookUrl: string;
+            /**
+             * @description Short description
+             * @example to get messages from chat 123
+             */
+            description?: string;
+        };
+        UpdateSubscribeDto: {
+            /**
+             * @description Scopes to subscribe
+             * @example {
+             *       "chat": {
+             *         "data": {
+             *           "username": true
+             *         }
+             *       }
+             *     }
+             */
+            data?: components["schemas"]["SubscriptionDataDto"];
+            /**
+             * @description Webhook url
+             * @example https://example.com/webhook
+             */
+            webhookUrl?: string;
+        };
+    };
+}
+type $defs = Record<string, never>;
+/**
+ * Сгенерированные из OpenAPI типы для `operations`
+ */
+interface operations {
+    "app.getHello": {
+        parameters: {
+            header: {
+                /** @description `Basic token`, where token is `id:secret` base64 encoded */
+                Authorization: string;
+            };
+        };
+        responses: {
+            /** @description returns Hello World! */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": unknown;
+                };
+            };
+        };
+    };
+    "channels.getHello": {
+        parameters: {
+            header: {
+                /** @description `Basic token`, where token is `id:secret` base64 encoded */
+                Authorization: string;
+            };
+        };
+        responses: {
+            /** @description returns Hello World! */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": unknown;
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+            };
+        };
+    };
+    "channels.getLastMessage": {
+        parameters: {
+            header: {
+                /** @description `Basic token`, where token is `id:secret` base64 encoded */
+                Authorization: string;
+            };
+            path: {
+                channelId: number;
+            };
+        };
+        responses: {
+            /** @description Returns array with last message by channel id */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": unknown;
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+            };
+        };
+    };
+    "channels.getMessages": {
+        parameters: {
+            header: {
+                /** @description `Basic token`, where token is `id:secret` base64 encoded */
+                Authorization: string;
+            };
+            path: {
+                channelId: number;
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["IGetChannelMessages"];
+            };
+        };
+        responses: {
+            /** @description Returns array of messages by channel id and cursors */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": unknown;
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+            };
+        };
+    };
+    "subscriptions.create": {
+        parameters: {
+            header: {
+                /** @description `Basic token`, where token is `id:secret` base64 encoded */
+                Authorization: string;
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SubscribeDto"];
+            };
+        };
+        responses: {
+            /** @description Subscription created, returns created subscription */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SubscribeDto"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+            };
+        };
+    };
+    "subscriptions.getById": {
+        parameters: {
+            header: {
+                /** @description `Basic token`, where token is `id:secret` base64 encoded */
+                Authorization: string;
+            };
+            path: {
+                subId: number;
+            };
+        };
+        responses: {
+            /** @description Subscription found, returns subscription */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SubscribeDto"];
+                };
+            };
+            /** @description Invalid subscription id */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+            };
+            /** @description You have no rights to manipulate subscription */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+            };
+        };
+    };
+    "subscriptions.update": {
+        parameters: {
+            header: {
+                /** @description `Basic token`, where token is `id:secret` base64 encoded */
+                Authorization: string;
+            };
+            path: {
+                subId: number;
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateSubscribeDto"];
+            };
+        };
+        responses: {
+            /** @description Subscription updated, returns updated subscription */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SubscribeDto"];
+                };
+            };
+            /** @description Invalid subscription id */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+            };
+            /** @description You have no rights to manipulate subscription */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+            };
+        };
+    };
+    "subscriptions.delete": {
+        parameters: {
+            header: {
+                /** @description `Basic token`, where token is `id:secret` base64 encoded */
+                Authorization: string;
+            };
+            path: {
+                subId: number;
+            };
+        };
+        responses: {
+            /** @description Subscription deleted, returns deleted subscription */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SubscribeDto"];
+                };
+            };
+            /** @description Invalid subscription id */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+            };
+            /** @description You have no rights to manipulate subscription */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+            };
+        };
+    };
+}
+
+export type { $defs, components, operations, paths };