@skravets/alert-bot 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,29 @@
+# Alert Bot SDK
+
+Простой клиент для Alert Bot API.
+
+## Пример использования
+
+```ts
+import { AlertBot } from "alert-bot-sdk";
+
+const client = new AlertBot({
+  host: "https://api.example.com",
+  apiKey: process.env.ALERT_BOT_API_KEY!,
+});
+
+await client.updateServices({
+  services: [
+    { type: "healthcheck", endpoint: "https://example.com/health" },
+    { type: "openrouter", apiKey: "sk-openrouter" },
+  ],
+  title: "Project name",
+  chatId: "chat-123",
+});
+```
+
+## Публикация
+
+1. Задеплоить на Staging новые версии контракта. Нужно указывать tags в OpenAPI чтобы они попали в группу.
+2. Обновить в `package.json` версию.
+3. Запустить workflow `Publish package`.

package/dist/api-types.d.cts

@@ -0,0 +1,111 @@
+/**
+ * @module
+ *
+ * Сгенерированные TypeScript типы для [API](...).
+ */
+/**
+ * Сгенерированные из OpenAPI типы для `paths`
+ */
+interface paths {
+    "/hello": {
+        post: {
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** @example Alice */
+                        name: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Hello response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example Hello, Alice! */
+                            message: string;
+                            project: {
+                                id: string;
+                                title: string;
+                            };
+                        };
+                    };
+                };
+                /** @description Unauthorized */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    "/projects/services": {
+        put: {
+            requestBody: {
+                content: {
+                    "application/json": {
+                        services: ({
+                            /** @enum {string} */
+                            type: "healthcheck";
+                            /** Format: uri */
+                            endpoint: string;
+                        } | {
+                            /** @enum {string} */
+                            type: "openrouter";
+                            apiKey: string;
+                        })[];
+                        title?: string;
+                        chatId?: string;
+                        threadForumId?: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Services updated successfully */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            success: boolean;
+                            project: {
+                                id: string;
+                                title: string;
+                                services: ({
+                                    /** @enum {string} */
+                                    type: "healthcheck";
+                                    /** Format: uri */
+                                    endpoint: string;
+                                } | {
+                                    /** @enum {string} */
+                                    type: "openrouter";
+                                    apiKey: string;
+                                })[];
+                                updatedAt: null | string;
+                            };
+                        };
+                    };
+                };
+                /** @description Unauthorized */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+}
+/**
+ * Сгенерированные из OpenAPI типы для `components`
+ */
+type components = {};
+type $defs = Record<string, never>;
+type operations = Record<string, never>;
+
+export type { $defs, components, operations, paths };

package/dist/api-types.d.ts

@@ -0,0 +1,111 @@
+/**
+ * @module
+ *
+ * Сгенерированные TypeScript типы для [API](...).
+ */
+/**
+ * Сгенерированные из OpenAPI типы для `paths`
+ */
+interface paths {
+    "/hello": {
+        post: {
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** @example Alice */
+                        name: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Hello response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example Hello, Alice! */
+                            message: string;
+                            project: {
+                                id: string;
+                                title: string;
+                            };
+                        };
+                    };
+                };
+                /** @description Unauthorized */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+    "/projects/services": {
+        put: {
+            requestBody: {
+                content: {
+                    "application/json": {
+                        services: ({
+                            /** @enum {string} */
+                            type: "healthcheck";
+                            /** Format: uri */
+                            endpoint: string;
+                        } | {
+                            /** @enum {string} */
+                            type: "openrouter";
+                            apiKey: string;
+                        })[];
+                        title?: string;
+                        chatId?: string;
+                        threadForumId?: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Services updated successfully */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            success: boolean;
+                            project: {
+                                id: string;
+                                title: string;
+                                services: ({
+                                    /** @enum {string} */
+                                    type: "healthcheck";
+                                    /** Format: uri */
+                                    endpoint: string;
+                                } | {
+                                    /** @enum {string} */
+                                    type: "openrouter";
+                                    apiKey: string;
+                                })[];
+                                updatedAt: null | string;
+                            };
+                        };
+                    };
+                };
+                /** @description Unauthorized */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                };
+            };
+        };
+    };
+}
+/**
+ * Сгенерированные из OpenAPI типы для `components`
+ */
+type components = {};
+type $defs = Record<string, never>;
+type operations = Record<string, never>;
+
+export type { $defs, components, operations, paths };

package/dist/index.cjs

@@ -0,0 +1,60 @@
+'use strict';
+
+class AlertBot {
+  options;
+  constructor(options) {
+    this.options = options;
+  }
+  async request(path, data, options) {
+    const requestOptions = {
+      method: options?.method || "POST",
+      mimeType: "json",
+      ...this.options.requestOptions,
+      ...options,
+      body: data ? JSON.stringify(data) : void 0,
+      headers: {
+        "user-agent": "ALERT BOT SDK",
+        Authorization: `Bearer ${this.options.apiKey}`,
+        ...data ? { "content-type": "application/json" } : {},
+        ...this.options.requestOptions?.headers,
+        ...options?.headers
+      }
+    };
+    requestOptions.mimeType = void 0;
+    const response = await fetch(this.options.host + path, requestOptions);
+    if (!response.ok) {
+      throw new Error(
+        `${this.options.host + path} ${options?.method} ${response.status} ${await response.text()}`
+      );
+    }
+    const contentType = response.headers.get("content-type");
+    const length = response.headers.get("content-length");
+    if (contentType?.includes("application/json")) {
+      return response.json();
+    }
+    if (length) {
+      return response.text();
+    }
+    return void 0;
+  }
+  // on<T extends WebhookBodyTypes>(
+  // 	type: T,
+  // 	handler: (context: EventByType[T]) => unknown,
+  // ) {
+  // 	// @ts-expect-error
+  // 	this.listeners.push({ event: type, handler });
+  // }
+  // async emit(data: WebhookBody) {
+  // 	const listeners = this.listeners.find((x) => x.event === data.type);
+  // 	if (listeners) await listeners.handler(data);
+  // }
+  async updateServices(body) {
+    return this.request(
+      "/projects/services",
+      body,
+      { method: "PUT" }
+    );
+  }
+}
+
+exports.AlertBot = AlertBot;

package/dist/index.d.cts

@@ -0,0 +1,44 @@
+import { paths } from './api-types.cjs';
+
+type GetRequestBody<Path extends keyof paths, Method extends "get" | "post" | "put" | "delete", ContentType extends string = "application/json"> = paths[Path] extends {
+    [K in Method]: any;
+} ? paths[Path][Method] extends {
+    requestBody?: {
+        content: any;
+    };
+} ? NonNullable<paths[Path][Method]["requestBody"]>["content"][ContentType] : never : never;
+type GetResponse<Path extends keyof paths, Method extends "get" | "post" | "put" | "delete"> = paths[Path] extends {
+    [K in Method]: any;
+} ? paths[Path][Method] extends {
+    responses: {
+        200: {
+            content: {
+                "application/json": any;
+            };
+        };
+    };
+} ? paths[Path][Method]["responses"][200]["content"]["application/json"] : never : never;
+type RequestOptions = Omit<NonNullable<Parameters<typeof fetch>[1]>, "headers"> & {
+    mimeType?: "json" | "x-www-form-urlencoded";
+    headers?: Record<string, string>;
+};
+
+/**
+ * @module
+ *
+ * Библиотека для взаимодействия с Alert Bot API.
+ */
+
+interface AlertBotOptions {
+    apiKey: string;
+    host: string;
+    requestOptions?: RequestOptions;
+}
+declare class AlertBot {
+    private options;
+    constructor(options?: AlertBotOptions);
+    private request;
+    updateServices(body: GetRequestBody<"/projects/services", "put">): Promise<GetResponse<"/projects/services", "put">>;
+}
+
+export { AlertBot, type AlertBotOptions };

package/dist/index.d.ts

@@ -0,0 +1,44 @@
+import { paths } from './api-types.js';
+
+type GetRequestBody<Path extends keyof paths, Method extends "get" | "post" | "put" | "delete", ContentType extends string = "application/json"> = paths[Path] extends {
+    [K in Method]: any;
+} ? paths[Path][Method] extends {
+    requestBody?: {
+        content: any;
+    };
+} ? NonNullable<paths[Path][Method]["requestBody"]>["content"][ContentType] : never : never;
+type GetResponse<Path extends keyof paths, Method extends "get" | "post" | "put" | "delete"> = paths[Path] extends {
+    [K in Method]: any;
+} ? paths[Path][Method] extends {
+    responses: {
+        200: {
+            content: {
+                "application/json": any;
+            };
+        };
+    };
+} ? paths[Path][Method]["responses"][200]["content"]["application/json"] : never : never;
+type RequestOptions = Omit<NonNullable<Parameters<typeof fetch>[1]>, "headers"> & {
+    mimeType?: "json" | "x-www-form-urlencoded";
+    headers?: Record<string, string>;
+};
+
+/**
+ * @module
+ *
+ * Библиотека для взаимодействия с Alert Bot API.
+ */
+
+interface AlertBotOptions {
+    apiKey: string;
+    host: string;
+    requestOptions?: RequestOptions;
+}
+declare class AlertBot {
+    private options;
+    constructor(options?: AlertBotOptions);
+    private request;
+    updateServices(body: GetRequestBody<"/projects/services", "put">): Promise<GetResponse<"/projects/services", "put">>;
+}
+
+export { AlertBot, type AlertBotOptions };

package/dist/index.js

@@ -0,0 +1,58 @@
+class AlertBot {
+  options;
+  constructor(options) {
+    this.options = options;
+  }
+  async request(path, data, options) {
+    const requestOptions = {
+      method: options?.method || "POST",
+      mimeType: "json",
+      ...this.options.requestOptions,
+      ...options,
+      body: data ? JSON.stringify(data) : void 0,
+      headers: {
+        "user-agent": "ALERT BOT SDK",
+        Authorization: `Bearer ${this.options.apiKey}`,
+        ...data ? { "content-type": "application/json" } : {},
+        ...this.options.requestOptions?.headers,
+        ...options?.headers
+      }
+    };
+    requestOptions.mimeType = void 0;
+    const response = await fetch(this.options.host + path, requestOptions);
+    if (!response.ok) {
+      throw new Error(
+        `${this.options.host + path} ${options?.method} ${response.status} ${await response.text()}`
+      );
+    }
+    const contentType = response.headers.get("content-type");
+    const length = response.headers.get("content-length");
+    if (contentType?.includes("application/json")) {
+      return response.json();
+    }
+    if (length) {
+      return response.text();
+    }
+    return void 0;
+  }
+  // on<T extends WebhookBodyTypes>(
+  // 	type: T,
+  // 	handler: (context: EventByType[T]) => unknown,
+  // ) {
+  // 	// @ts-expect-error
+  // 	this.listeners.push({ event: type, handler });
+  // }
+  // async emit(data: WebhookBody) {
+  // 	const listeners = this.listeners.find((x) => x.event === data.type);
+  // 	if (listeners) await listeners.handler(data);
+  // }
+  async updateServices(body) {
+    return this.request(
+      "/projects/services",
+      body,
+      { method: "PUT" }
+    );
+  }
+}
+
+export { AlertBot };

package/package.json

@@ -0,0 +1,47 @@
+{
+	"name": "@skravets/alert-bot",
+	"version": "0.0.1",
+	"module": "./dist/index.js",
+	"main": "./dist/index.cjs",
+	"types": "./dist/index.d.ts",
+	"scripts": {
+		"generate": "bun scripts/generate.ts",
+		"build": "bunx pkgroll",
+		"prepublishOnly": "bunx pkgroll"
+	},
+	"exports": {
+		".": {
+			"import": {
+				"types": "./dist/index.d.ts",
+				"default": "./dist/index.js"
+			},
+			"require": {
+				"types": "./dist/index.d.cts",
+				"default": "./dist/index.cjs"
+			}
+		},
+		"./openapi": {
+			"import": {
+				"types": "./dist/api-types.d.ts"
+			},
+			"require": {
+				"types": "./dist/api-types.d.cts"
+			}
+		}
+	},
+	"type": "module",
+	"devDependencies": {
+		"@biomejs/biome": "^1.8.3",
+		"@scalar/openapi-parser": "^0.7.2",
+		"@types/bun": "^1.1.6",
+		"openapi-typescript": "^7.0.2",
+		"pkgroll": "^2.1.1",
+		"ts-dedent": "^2.2.0",
+		"typescript": "^5.5.3"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"license": "MIT",
+	"files": ["dist"]
+}