@bkeenke/shm-contract 1.4.0

package/README.md

@@ -0,0 +1,169 @@
+# @bkeenke/shm-contract
+
+TypeScript/Zod контракты для SHM API. Используется для типизации запросов и ответов API на фронтенде
+
+## Установка
+
+```bash
+npm install @bkeenke/shm-contract
+# или
+yarn add @bkeenke/shm-contract
+```
+
+## Использование
+
+### Импорт типов и схем
+
+```typescript
+import {
+  // Models (Zod schemas + types)
+  User,
+  UserSchema,
+  Service,
+  ServiceSchema,
+
+  // API routes
+  REST_API,
+
+  // Commands
+  AuthLoginCommand,
+  AdminGetUsersCommand,
+
+  // Constants
+  USER_SERVICE_STATUS,
+  SPOOL_STATUS,
+} from '@bkeenke/shm-contract';
+```
+
+### Пример использования с axios
+
+```typescript
+import axios from 'axios';
+import { AuthLoginCommand, REST_API } from '@bkeenke/shm-contract';
+
+async function login(credentials: AuthLoginCommand.Request) {
+  // Валидация входных данных
+  const validated = AuthLoginCommand.RequestSchema.parse(credentials);
+
+  const response = await axios.post(AuthLoginCommand.url, validated);
+
+  // Валидация ответа
+  return AuthLoginCommand.ResponseSchema.parse(response.data);
+}
+```
+
+### Пример использования с TanStack Query
+
+```typescript
+import { useQuery } from '@tanstack/react-query';
+import { AdminGetUsersCommand } from '@bkeenke/shm-contract';
+
+function useUsers() {
+  return useQuery({
+    queryKey: ['users'],
+    queryFn: async () => {
+      const response = await fetch(AdminGetUsersCommand.url);
+      const data = await response.json();
+      return AdminGetUsersCommand.ResponseSchema.parse(data);
+    },
+  });
+}
+```
+
+## Структура пакета
+
+```
+@bkeenke/shm-contract/
+├── api/              # API routes и controllers
+│   ├── routes.ts     # Все API маршруты
+│   └── controllers.ts
+├── constants/        # Константы
+│   ├── user-service-status.constant.ts
+│   ├── spool-status.constant.ts
+│   └── http-method.constant.ts
+├── models/           # Zod схемы и типы
+│   ├── user.schema.ts
+│   ├── service.schema.ts
+│   ├── pay.schema.ts
+│   └── ...
+└── commands/         # API команды (контракты)
+    ├── auth/
+    ├── users/
+    ├── services/
+    ├── servers/
+    ├── spool/
+    ├── pay/
+    ├── templates/
+    ├── storage/
+    ├── config/
+    ├── promo/
+    └── telegram/
+```
+
+## API Routes
+
+Все маршруты доступны через объект `REST_API`:
+
+```typescript
+import { REST_API } from '@bkeenke/shm-contract';
+
+// User routes
+REST_API.USER.GET        // GET /shm/v1/user
+REST_API.USER.AUTH       // POST /shm/v1/user/auth
+REST_API.USER.SERVICE    // GET/DELETE /shm/v1/user/service
+
+// Admin routes
+REST_API.ADMIN.USER.ROOT       // CRUD /shm/v1/admin/user
+REST_API.ADMIN.SERVICE.ROOT    // CRUD /shm/v1/admin/service
+REST_API.ADMIN.SERVER.ROOT     // CRUD /shm/v1/admin/server
+REST_API.ADMIN.SPOOL.ROOT      // CRUD /shm/v1/admin/spool
+REST_API.ADMIN.TEMPLATE.ROOT   // CRUD /shm/v1/admin/template
+REST_API.ADMIN.CONFIG.ROOT     // CRUD /shm/v1/admin/config
+REST_API.ADMIN.PROMO.ROOT      // CRUD /shm/v1/admin/promo
+```
+
+## Commands (Контракты)
+
+Каждая команда содержит:
+- `url` - URL эндпоинта
+- `method` - HTTP метод
+- `RequestSchema` - Zod схема запроса
+- `ResponseSchema` - Zod схема ответа
+- `Request` - TypeScript тип запроса
+- `Response` - TypeScript тип ответа
+
+### Auth Commands
+- `AuthLoginCommand` - Авторизация
+- `AuthRegisterCommand` - Регистрация
+- `TelegramWebappAuthCommand` - Авторизация через Telegram WebApp
+- `PasskeyAuthCommand` - Авторизация через Passkey
+
+### User Commands
+- `GetCurrentUserCommand` - Получить текущего пользователя
+- `UpdateCurrentUserCommand` - Обновить профиль
+- `ChangePasswordCommand` - Сменить пароль
+
+### Admin Commands
+- `AdminGetUsersCommand` - Список пользователей
+- `AdminCreateUserCommand` - Создать пользователя
+- `AdminGetServicesCommand` - Список услуг
+- `AdminGetServersCommand` - Список серверов
+- `AdminGetSpoolCommand` - Список задач
+- и другие...
+
+## Разработка
+
+```bash
+# Установка зависимостей
+npm install
+
+# Сборка
+npm run build
+
+# Watch mode
+npm run dev
+```
+
+## Лицензия
+
+MIT

package/build/api/controllers.d.ts

@@ -0,0 +1,25 @@
+export declare const CONTROLLERS: {
+    readonly USER: "user";
+    readonly SERVICE: "service";
+    readonly TEMPLATE: "template";
+    readonly PUBLIC: "public";
+    readonly STORAGE: "storage";
+    readonly PROMO: "promo";
+    readonly TELEGRAM: "telegram";
+    readonly ADMIN: {
+        readonly ROOT: "admin";
+        readonly SYSTEM: "admin/system";
+        readonly SERVICE: "admin/service";
+        readonly USER: "admin/user";
+        readonly SERVER: "admin/server";
+        readonly SPOOL: "admin/spool";
+        readonly TEMPLATE: "admin/template";
+        readonly STORAGE: "admin/storage";
+        readonly CONFIG: "admin/config";
+        readonly PROMO: "admin/promo";
+        readonly ANALYTICS: "admin/analytics";
+        readonly TRANSPORT: "admin/transport";
+        readonly CLOUD: "admin/cloud";
+    };
+};
+//# sourceMappingURL=controllers.d.ts.map

package/build/api/controllers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"controllers.d.ts","sourceRoot":"","sources":["../../src/api/controllers.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;CAuBd,CAAC"}

package/build/api/controllers.js

@@ -0,0 +1,25 @@
+export const CONTROLLERS = {
+    USER: 'user',
+    SERVICE: 'service',
+    TEMPLATE: 'template',
+    PUBLIC: 'public',
+    STORAGE: 'storage',
+    PROMO: 'promo',
+    TELEGRAM: 'telegram',
+    ADMIN: {
+        ROOT: 'admin',
+        SYSTEM: 'admin/system',
+        SERVICE: 'admin/service',
+        USER: 'admin/user',
+        SERVER: 'admin/server',
+        SPOOL: 'admin/spool',
+        TEMPLATE: 'admin/template',
+        STORAGE: 'admin/storage',
+        CONFIG: 'admin/config',
+        PROMO: 'admin/promo',
+        ANALYTICS: 'admin/analytics',
+        TRANSPORT: 'admin/transport',
+        CLOUD: 'admin/cloud',
+    },
+};
+//# sourceMappingURL=controllers.js.map

package/build/api/controllers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"controllers.js","sourceRoot":"","sources":["../../src/api/controllers.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE;QACL,IAAI,EAAE,OAAO;QACb,MAAM,EAAE,cAAc;QACtB,OAAO,EAAE,eAAe;QACxB,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE,cAAc;QACtB,KAAK,EAAE,aAAa;QACpB,QAAQ,EAAE,gBAAgB;QAC1B,OAAO,EAAE,eAAe;QACxB,MAAM,EAAE,cAAc;QACtB,KAAK,EAAE,aAAa;QACpB,SAAS,EAAE,iBAAiB;QAC5B,SAAS,EAAE,iBAAiB;QAC5B,KAAK,EAAE,aAAa;KACrB;CACO,CAAC"}

package/build/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from './controllers';
+export * from './routes';
+//# sourceMappingURL=index.d.ts.map

package/build/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC"}

package/build/api/index.js

@@ -0,0 +1,3 @@
+export * from './controllers';
+export * from './routes';
+//# sourceMappingURL=index.js.map

package/build/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC"}

package/build/api/routes.d.ts

@@ -0,0 +1,264 @@
+export declare const API_ROOT = "/shm/v1";
+export declare const USER_ROUTES: {
+    readonly ROOT: "/user";
+    readonly AUTH: "/user/auth";
+    readonly PASSWORD_AUTH: "/user/password-auth";
+    readonly PASSWD: "/user/passwd";
+    readonly PASSWD_RESET: "/user/passwd/reset";
+    readonly PASSWD_RESET_VERIFY: "/user/passwd/reset/verify";
+    readonly EMAIL_SET: "/user/email/set";
+    readonly EMAIL_VERIFY: "/user/email/verify";
+    readonly SERVICE: "/user/service";
+    readonly SERVICE_STOP: "/user/service/stop";
+    readonly SERVICE_CHANGE: "/user/service/change";
+    readonly WITHDRAW: "/user/withdraw";
+    readonly AUTOPAYMENT: "/user/autopayment";
+    readonly PAY: "/user/pay";
+    readonly PAY_FORECAST: "/user/pay/forecast";
+    readonly PAY_PAYSYSTEMS: "/user/pay/paysystems";
+    readonly OTP: {
+        readonly ROOT: "/user/otp";
+        readonly SETUP: "/user/otp/setup";
+    };
+    readonly PASSKEY: {
+        readonly ROOT: "/user/passkey";
+        readonly REGISTER: "/user/passkey/register";
+        readonly AUTH: "/user/auth/passkey";
+    };
+    readonly TICKET: {
+        readonly ROOT: "/user/ticket";
+        readonly ITEM: (id: number) => string;
+    };
+};
+export declare const SERVICE_ROUTES: {
+    readonly ROOT: "/service";
+    readonly ORDER: "/service/order";
+};
+export declare const TEMPLATE_ROUTES: {
+    readonly SHOW: (id: string) => string;
+    readonly PUBLIC: (id: string) => string;
+};
+export declare const STORAGE_ROUTES: {
+    readonly MANAGE: "/storage/manage";
+    readonly MANAGE_ITEM: (name: string) => string;
+    readonly DOWNLOAD: (name: string) => string;
+};
+export declare const PROMO_ROUTES: {
+    readonly ROOT: "/promo";
+    readonly APPLY: (code: string) => string;
+};
+export declare const TELEGRAM_ROUTES: {
+    readonly USER: "/telegram/user";
+    readonly BOT: "/telegram/bot";
+    readonly BOT_TEMPLATE: (template: string) => string;
+    readonly SET_WEBHOOK: "/telegram/set_webhook";
+    readonly WEBAPP_AUTH: "/telegram/webapp/auth";
+    readonly WEB_AUTH: "/telegram/web/auth";
+};
+export declare const ADMIN_ROUTES: {
+    readonly SYSTEM: {
+        readonly VERSION: "/admin/system/version";
+    };
+    readonly SERVICE: {
+        readonly ROOT: "/admin/service";
+        readonly ORDER: "/admin/service/order";
+        readonly CHILDREN: "/admin/service/children";
+        readonly EVENT: "/admin/service/event";
+    };
+    readonly USER: {
+        readonly ROOT: "/admin/user";
+        readonly PASSWD: "/admin/user/passwd";
+        readonly PAYMENT: "/admin/user/payment";
+        readonly PROFILE: "/admin/user/profile";
+        readonly PAY: "/admin/user/pay";
+        readonly BONUS: "/admin/user/bonus";
+        readonly SERVICE: "/admin/user/service";
+        readonly SERVICE_CATEGORIES: "/admin/user/service/categories";
+        readonly SERVICE_WITHDRAW: "/admin/user/service/withdraw";
+        readonly SERVICE_STATUS: "/admin/user/service/status";
+        readonly SERVICE_STOP: "/admin/user/service/stop";
+        readonly SERVICE_ACTIVATE: "/admin/user/service/activate";
+        readonly SERVICE_TOUCH: "/admin/user/service/touch";
+        readonly SERVICE_CHANGE: "/admin/user/service/change";
+        readonly SERVICE_SPOOL: "/admin/user/service/spool";
+        readonly SESSION: "/admin/user/session";
+    };
+    readonly SERVER: {
+        readonly ROOT: "/admin/server";
+        readonly GROUP: "/admin/server/group";
+        readonly IDENTITY: "/admin/server/identity";
+        readonly IDENTITY_GENERATE: "/admin/server/identity/generate";
+    };
+    readonly SPOOL: {
+        readonly ROOT: "/admin/spool";
+        readonly STATUSES: "/admin/spool/statuses";
+        readonly HISTORY: "/admin/spool/history";
+        readonly MANUAL: (action: string) => string;
+    };
+    readonly TEMPLATE: {
+        readonly ROOT: "/admin/template";
+        readonly ITEM: (id: string) => string;
+    };
+    readonly STORAGE: {
+        readonly MANAGE: "/admin/storage/manage";
+        readonly MANAGE_ITEM: (name: string) => string;
+    };
+    readonly CONFIG: {
+        readonly ROOT: "/admin/config";
+        readonly ITEM: (key: string) => string;
+    };
+    readonly PROMO: {
+        readonly ROOT: "/admin/promo";
+        readonly ITEM: (id: string) => string;
+    };
+    readonly ANALYTICS: {
+        readonly ROOT: "/admin/analytics";
+        readonly CACHE_CLEAR: "/admin/analytics/cache/clear";
+    };
+    readonly TRANSPORT: {
+        readonly SSH_TEST: "/admin/transport/ssh/test";
+        readonly SSH_INIT: "/admin/transport/ssh/init";
+        readonly MAIL_TEST: "/admin/transport/mail/test";
+    };
+    readonly CLOUD: {
+        readonly USER: "/admin/cloud/user";
+        readonly USER_AUTH: "/admin/cloud/user/auth";
+        readonly PAYSYSTEMS: "/admin/cloud/paysystems";
+        readonly CURRENCIES: "/admin/cloud/currencies";
+        readonly PROXY: (uri: string) => string;
+    };
+};
+export declare const REST_API: {
+    readonly USER: {
+        readonly GET: "/shm/v1/user";
+        readonly REGISTER: "/shm/v1/user";
+        readonly UPDATE: "/shm/v1/user";
+        readonly AUTH: "/shm/v1/user/auth";
+        readonly PASSWORD_AUTH: "/shm/v1/user/password-auth";
+        readonly PASSWD: "/shm/v1/user/passwd";
+        readonly PASSWD_RESET: "/shm/v1/user/passwd/reset";
+        readonly PASSWD_RESET_VERIFY: "/shm/v1/user/passwd/reset/verify";
+        readonly EMAIL_SET: "/shm/v1/user/email/set";
+        readonly EMAIL_VERIFY: "/shm/v1/user/email/verify";
+        readonly SERVICE: "/shm/v1/user/service";
+        readonly SERVICE_STOP: "/shm/v1/user/service/stop";
+        readonly SERVICE_CHANGE: "/shm/v1/user/service/change";
+        readonly WITHDRAW: "/shm/v1/user/withdraw";
+        readonly AUTOPAYMENT: "/shm/v1/user/autopayment";
+        readonly PAY: "/shm/v1/user/pay";
+        readonly PAY_FORECAST: "/shm/v1/user/pay/forecast";
+        readonly PAY_PAYSYSTEMS: "/shm/v1/user/pay/paysystems";
+        readonly OTP: {
+            readonly ROOT: "/shm/v1/user/otp";
+            readonly SETUP: "/shm/v1/user/otp/setup";
+        };
+        readonly PASSKEY: {
+            readonly ROOT: "/shm/v1/user/passkey";
+            readonly REGISTER: "/shm/v1/user/passkey/register";
+            readonly AUTH: "/shm/v1/user/auth/passkey";
+        };
+        readonly TICKET: {
+            readonly ROOT: "/shm/v1/user/ticket";
+            readonly ITEM: (id: number) => string;
+        };
+    };
+    readonly SERVICE: {
+        readonly GET: "/shm/v1/service";
+        readonly ORDER: "/shm/v1/service/order";
+    };
+    readonly TEMPLATE: {
+        readonly SHOW: (id: string) => string;
+        readonly PUBLIC: (id: string) => string;
+    };
+    readonly STORAGE: {
+        readonly MANAGE: "/shm/v1/storage/manage";
+        readonly MANAGE_ITEM: (name: string) => string;
+        readonly DOWNLOAD: (name: string) => string;
+    };
+    readonly PROMO: {
+        readonly ROOT: "/shm/v1/promo";
+        readonly APPLY: (code: string) => string;
+    };
+    readonly TELEGRAM: {
+        readonly USER: "/shm/v1/telegram/user";
+        readonly BOT: "/shm/v1/telegram/bot";
+        readonly BOT_TEMPLATE: (template: string) => string;
+        readonly SET_WEBHOOK: "/shm/v1/telegram/set_webhook";
+        readonly WEBAPP_AUTH: "/shm/v1/telegram/webapp/auth";
+        readonly WEB_AUTH: "/shm/v1/telegram/web/auth";
+    };
+    readonly ADMIN: {
+        readonly SYSTEM: {
+            readonly VERSION: "/shm/v1/admin/system/version";
+        };
+        readonly SERVICE: {
+            readonly ROOT: "/shm/v1/admin/service";
+            readonly ORDER: "/shm/v1/admin/service/order";
+            readonly CHILDREN: "/shm/v1/admin/service/children";
+            readonly EVENT: "/shm/v1/admin/service/event";
+        };
+        readonly USER: {
+            readonly ROOT: "/shm/v1/admin/user";
+            readonly PASSWD: "/shm/v1/admin/user/passwd";
+            readonly PAYMENT: "/shm/v1/admin/user/payment";
+            readonly PROFILE: "/shm/v1/admin/user/profile";
+            readonly PAY: "/shm/v1/admin/user/pay";
+            readonly BONUS: "/shm/v1/admin/user/bonus";
+            readonly SERVICE: "/shm/v1/admin/user/service";
+            readonly SERVICE_CATEGORIES: "/shm/v1/admin/user/service/categories";
+            readonly SERVICE_WITHDRAW: "/shm/v1/admin/user/service/withdraw";
+            readonly SERVICE_STATUS: "/shm/v1/admin/user/service/status";
+            readonly SERVICE_STOP: "/shm/v1/admin/user/service/stop";
+            readonly SERVICE_ACTIVATE: "/shm/v1/admin/user/service/activate";
+            readonly SERVICE_TOUCH: "/shm/v1/admin/user/service/touch";
+            readonly SERVICE_CHANGE: "/shm/v1/admin/user/service/change";
+            readonly SERVICE_SPOOL: "/shm/v1/admin/user/service/spool";
+            readonly SESSION: "/shm/v1/admin/user/session";
+        };
+        readonly SERVER: {
+            readonly ROOT: "/shm/v1/admin/server";
+            readonly GROUP: "/shm/v1/admin/server/group";
+            readonly IDENTITY: "/shm/v1/admin/server/identity";
+            readonly IDENTITY_GENERATE: "/shm/v1/admin/server/identity/generate";
+        };
+        readonly SPOOL: {
+            readonly ROOT: "/shm/v1/admin/spool";
+            readonly STATUSES: "/shm/v1/admin/spool/statuses";
+            readonly HISTORY: "/shm/v1/admin/spool/history";
+            readonly MANUAL: (action: string) => string;
+        };
+        readonly TEMPLATE: {
+            readonly ROOT: "/shm/v1/admin/template";
+            readonly ITEM: (id: string) => string;
+        };
+        readonly STORAGE: {
+            readonly MANAGE: "/shm/v1/admin/storage/manage";
+            readonly MANAGE_ITEM: (name: string) => string;
+        };
+        readonly CONFIG: {
+            readonly ROOT: "/shm/v1/admin/config";
+            readonly ITEM: (key: string) => string;
+        };
+        readonly PROMO: {
+            readonly ROOT: "/shm/v1/admin/promo";
+            readonly ITEM: (id: string) => string;
+        };
+        readonly ANALYTICS: {
+            readonly ROOT: "/shm/v1/admin/analytics";
+            readonly CACHE_CLEAR: "/shm/v1/admin/analytics/cache/clear";
+        };
+        readonly TRANSPORT: {
+            readonly SSH_TEST: "/shm/v1/admin/transport/ssh/test";
+            readonly SSH_INIT: "/shm/v1/admin/transport/ssh/init";
+            readonly MAIL_TEST: "/shm/v1/admin/transport/mail/test";
+        };
+        readonly CLOUD: {
+            readonly USER: "/shm/v1/admin/cloud/user";
+            readonly USER_AUTH: "/shm/v1/admin/cloud/user/auth";
+            readonly PAYSYSTEMS: "/shm/v1/admin/cloud/paysystems";
+            readonly CURRENCIES: "/shm/v1/admin/cloud/currencies";
+            readonly PROXY: (uri: string) => string;
+        };
+    };
+};
+//# sourceMappingURL=routes.d.ts.map

package/build/api/routes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../../src/api/routes.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ,YAAY,CAAC;AAElC,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BA4BT,MAAM;;CAEX,CAAC;AAEX,eAAO,MAAM,cAAc;;;CAGjB,CAAC;AAEX,eAAO,MAAM,eAAe;wBACf,MAAM;0BACJ,MAAM;CACX,CAAC;AAEX,eAAO,MAAM,cAAc;;iCAEL,MAAM;8BACT,MAAM;CACf,CAAC;AAEX,eAAO,MAAM,YAAY;;2BAET,MAAM;CACZ,CAAC;AAEX,eAAO,MAAM,eAAe;;;sCAGD,MAAM;;;;CAIvB,CAAC;AAEX,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kCAsCJ,MAAM;;;;4BAIZ,MAAM;;;;qCAIG,MAAM;;;;6BAId,MAAM;;;;4BAIP,MAAM;;;;;;;;;;;;;;;;8BAgBJ,MAAM;;CAEb,CAAC;AAEX,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCA+BJ,MAAM;;;;;;;;4BAQR,MAAM;8BACJ,MAAM;;;;qCAIC,MAAM;kCACT,MAAM;;;;+BAIT,MAAM;;;;;0CAKK,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sCA2CZ,MAAM;;;;gCAIZ,MAAM;;;;yCAIG,MAAM;;;;iCAId,MAAM;;;;gCAIP,MAAM;;;;;;;;;;;;;;;;kCAgBJ,MAAM;;;CAGf,CAAC"}