panel-backend-types

Panel Backend Types

🔧 Type-safe TypeScript definitions for Panel Backend API

این پکیج شامل تمام TypeScript types و interfaces مورد نیاز برای API Panel Backend است.

📦 نصب

npm install panel-backend-types

🚀 استفاده

import {
  UserResponseDTO,
  ProjectResponseDTO,
  ApiResponse,
  PaginatedResponse,
  LoginResponse,
  ApiStatus,
  UserStatus,
  ProjectStatus
} from 'panel-backend-types';

// استفاده از types
const user: UserResponseDTO = {
  id: "uuid",
  email: "[e-mail]",
  username: "testuser",
  firstName: "نام",
  lastName: "نام خانوادگی",
  status: UserStatus.ACTIVE,
  createdAt: "2024-01-01T...",
  updatedAt: "2024-01-01T..."
};

const response: ApiResponse<UserResponseDTO> = {
  status: "success",
  message: "User retrieved successfully",
  data: user,
  timestamp: new Date().toISOString()
};

📋 شامل Types

Base Types

• ApiResponse<T> - ساختار پاسخ API
• ApiErrorResponse - ساختار خطا
• PaginatedResponse<T> - پاسخ صفحه‌بندی شده
• PaginationInfo - اطلاعات صفحه‌بندی

User Types

• UserResponseDTO - پاسخ کاربر
• UserCreateDTO - ایجاد کاربر
• UserUpdateDTO - بروزرسانی کاربر
• UserStatus - وضعیت کاربر
• SystemRole - نقش سیستم

Auth Types

• LoginResponse - پاسخ ورود
• RegisterResponse - پاسخ ثبت‌نام
• LoginInput - ورودی ورود
• RegisterInput - ورودی ثبت‌نام
• JwtPayload - محتوای JWT

Project Types

• ProjectResponseDTO - پاسخ پروژه
• ProjectCreateDTO - ایجاد پروژه
• ProjectUpdateDTO - بروزرسانی پروژه
• ProjectStatus - وضعیت پروژه
• ProjectAccess - دسترسی پروژه

Widget Types

• WidgetResponseDTO - پاسخ ویجت
• WidgetCreateDTO - ایجاد ویجت
• WidgetType - نوع ویجت
• WidgetConfig - پیکربندی ویجت

Security Types

• SecurityEventResponseDTO - رویداد امنیتی
• SecurityEventType - نوع رویداد امنیتی
• SecurityEventSeverity - شدت رویداد امنیتی

Site Types

• SiteResponseDTO - پاسخ سایت
• SiteStatus - وضعیت سایت
• SSLStatus - وضعیت SSL

Settings Types

• SettingsResponseDTO - پاسخ تنظیمات
• SettingsEntityType - نوع موجودیت تنظیمات
• SettingsScope - دامنه تنظیمات

Token Types

• TokenResponseDTO - پاسخ توکن
• TokenType - نوع توکن

Session Types

• SessionResponseDTO - پاسخ جلسه
• DeviceInfo - اطلاعات دستگاه

🔧 Development

# نصب dependencies
npm install

# Build
npm run build

# Watch mode
npm run dev

📄 License

MIT

🤝 Contributing

برای مشارکت در این پروژه، لطفاً pull request ایجاد کنید.

✅ Type-safe، استاندارد و یکپارچه! 🚀