ntk-cms-api 20.25.3 → 20.25.4

package/README.md

@@ -1,63 +1,383 @@
-# NtkCmsApi
+# NTK CMS API Library
 
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.1.0.
+**ntk-cms-api** - Complete API service layer and data models for CMS operations
 
-## Code scaffolding
+## 📋 Overview
 
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
+The NTK CMS API library provides a comprehensive set of services, models, and utilities for building Content Management System applications. It includes complete API integration, data models, and business logic for various CMS modules.
+
+## 🚀 Installation
 
 ```bash
-ng generate component component-name
+npm install ntk-cms-api
 ```
 
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
+## 📦 Features
 
-```bash
-ng generate --help
+### Core Services
+
+- **Main Service** - Core API operations and configuration
+- **Log Service** - Logging and error handling
+- **Token Service** - Authentication and authorization
+- **File Service** - File management operations
+- **Link Service** - Link management and routing
+
+### Content Management
+
+- **News Service** - News article management
+- **Blog Service** - Blog post management
+- **Catalog Service** - Product catalog management
+- **Estate Service** - Real estate management
+- **Member Service** - User and member management
+
+### Additional Services
+
+- **SMS Service** - SMS notifications
+- **Payment Service** - Payment processing
+- **Ticketing Service** - Support ticket system
+- **Web Designer Service** - Website builder tools
+
+## 🔧 Usage
+
+### Basic Setup
+
+```typescript
+import { NgModule } from "@angular/core";
+import { HttpClientModule } from "@angular/common/http";
+import { NtkCmsApiModule } from "ntk-cms-api";
+
+@NgModule({
+  imports: [HttpClientModule, NtkCmsApiModule],
+})
+export class AppModule {}
 ```
 
-## Building
+### Configure API
 
-To build the library, run:
+```typescript
+import { NtkCmsApiService } from "ntk-cms-api";
 
-```bash
-ng build ntk-cms-api
+export class AppComponent {
+  constructor(private apiService: NtkCmsApiService) {
+    // Set API configuration
+    this.apiService.setApiUrl("https://api.example.com");
+    this.apiService.setToken("your-auth-token");
+  }
+}
 ```
 
-This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
+### Using Services
 
-### Publishing the Library
+```typescript
+import { NewsService, NewsModel } from "ntk-cms-api";
 
-Once the project is built, you can publish your library by following these steps:
+export class NewsComponent {
+  constructor(private newsService: NewsService) {}
 
-1. Navigate to the `dist` directory:
-   ```bash
-   cd dist/ntk-cms-api
-   ```
+  async getNews(): Promise<NewsModel[]> {
+    try {
+      const result = await this.newsService.ServiceGetAll().toPromise();
+      return result.listItems || [];
+    } catch (error) {
+      console.error("Error fetching news:", error);
+      return [];
+    }
+  }
 
-2. Run the `npm publish` command to publish your library to the npm registry:
-   ```bash
-   npm publish
-   ```
+  async createNews(news: NewsModel): Promise<boolean> {
+    try {
+      const result = await this.newsService.ServiceAdd(news).toPromise();
+      return result.isSuccess;
+    } catch (error) {
+      console.error("Error creating news:", error);
+      return false;
+    }
+  }
+}
+```
 
-## Running unit tests
+## 📚 API Reference
 
-To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
+### Core Models
 
-```bash
-ng test
+#### NewsModel
+
+```typescript
+interface NewsModel {
+  id?: string;
+  title: string;
+  description?: string;
+  body?: string;
+  linkMainImageId?: number;
+  linkMainImageIdSrc?: string;
+  createdDate?: Date;
+  updatedDate?: Date;
+  // ... other properties
+}
 ```
 
-## Running end-to-end tests
+#### BlogModel
 
-For end-to-end (e2e) testing, run:
+```typescript
+interface BlogModel {
+  id?: string;
+  title: string;
+  description?: string;
+  body?: string;
+  linkMainImageId?: number;
+  linkMainImageIdSrc?: string;
+  createdDate?: Date;
+  updatedDate?: Date;
+  // ... other properties
+}
+```
 
-```bash
-ng e2e
+### Service Methods
+
+#### NewsService
+
+- `ServiceGetAll()` - Get all news articles
+- `ServiceGetById(id: string)` - Get news by ID
+- `ServiceAdd(model: NewsModel)` - Create new news
+- `ServiceEdit(model: NewsModel)` - Update news
+- `ServiceDelete(id: string)` - Delete news
+
+#### BlogService
+
+- `ServiceGetAll()` - Get all blog posts
+- `ServiceGetById(id: string)` - Get blog by ID
+- `ServiceAdd(model: BlogModel)` - Create new blog
+- `ServiceEdit(model: BlogModel)` - Update blog
+- `ServiceDelete(id: string)` - Delete blog
+
+## 🔐 Authentication
+
+### Token Management
+
+```typescript
+import { TokenService } from "ntk-cms-api";
+
+export class AuthService {
+  constructor(private tokenService: TokenService) {}
+
+  async login(username: string, password: string): Promise<boolean> {
+    try {
+      const result = await this.tokenService.ServiceAccessToken(username, password).toPromise();
+      if (result.isSuccess) {
+        localStorage.setItem("token", result.token);
+        return true;
+      }
+      return false;
+    } catch (error) {
+      console.error("Login error:", error);
+      return false;
+    }
+  }
+
+  logout(): void {
+    localStorage.removeItem("token");
+  }
+
+  isAuthenticated(): boolean {
+    return !!localStorage.getItem("token");
+  }
+}
+```
+
+## 📁 File Management
+
+### File Operations
+
+```typescript
+import { FileService, FileModel } from "ntk-cms-api";
+
+export class FileComponent {
+  constructor(private fileService: FileService) {}
+
+  async uploadFile(file: File): Promise<FileModel | null> {
+    try {
+      const formData = new FormData();
+      formData.append("file", file);
+
+      const result = await this.fileService.ServiceUploadFile(formData).toPromise();
+      return result.isSuccess ? result.item : null;
+    } catch (error) {
+      console.error("Upload error:", error);
+      return null;
+    }
+  }
+
+  async getFiles(): Promise<FileModel[]> {
+    try {
+      const result = await this.fileService.ServiceGetAll().toPromise();
+      return result.listItems || [];
+    } catch (error) {
+      console.error("Error fetching files:", error);
+      return [];
+    }
+  }
+}
+```
+
+## 🌐 Internationalization
+
+The API library supports multiple languages through the translation service:
+
+```typescript
+import { TranslateService } from "ntk-cms-api";
+
+export class AppComponent {
+  constructor(private translateService: TranslateService) {
+    // Set default language
+    this.translateService.setDefaultLang("en");
+    this.translateService.use("en");
+  }
+
+  changeLanguage(lang: string): void {
+    this.translateService.use(lang);
+  }
+}
+```
+
+## 🔧 Configuration
+
+### Environment Setup
+
+```typescript
+// environment.ts
+export const environment = {
+  production: false,
+  apiUrl: "https://api.example.com",
+  apiVersion: "v1",
+  timeout: 30000,
+};
+```
+
+### Service Configuration
+
+```typescript
+import { NtkCmsApiService } from "ntk-cms-api";
+
+export class AppComponent {
+  constructor(private apiService: NtkCmsApiService) {
+    // Configure API service
+    this.apiService.setApiUrl(environment.apiUrl);
+    this.apiService.setTimeout(environment.timeout);
+
+    // Set default headers
+    this.apiService.setDefaultHeaders({
+      "Content-Type": "application/json",
+      Accept: "application/json",
+    });
+  }
+}
+```
+
+## 🧪 Testing
+
+### Unit Tests
+
+```typescript
+import { TestBed } from "@angular/core/testing";
+import { HttpClientTestingModule } from "@angular/common/http/testing";
+import { NewsService } from "ntk-cms-api";
+
+describe("NewsService", () => {
+  let service: NewsService;
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({
+      imports: [HttpClientTestingModule],
+      providers: [NewsService],
+    });
+    service = TestBed.inject(NewsService);
+  });
+
+  it("should be created", () => {
+    expect(service).toBeTruthy();
+  });
+
+  it("should fetch news articles", async () => {
+    const result = await service.ServiceGetAll().toPromise();
+    expect(result).toBeDefined();
+  });
+});
 ```
 
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
+## 📊 Error Handling
+
+### Global Error Handler
+
+```typescript
+import { Injectable } from "@angular/core";
+import { HttpErrorResponse } from "@angular/common/http";
+import { NtkCmsApiService } from "ntk-cms-api";
+
+@Injectable()
+export class GlobalErrorHandler {
+  constructor(private apiService: NtkCmsApiService) {}
+
+  handleError(error: HttpErrorResponse): void {
+    if (error.status === 401) {
+      // Handle unauthorized access
+      this.handleUnauthorized();
+    } else if (error.status === 403) {
+      // Handle forbidden access
+      this.handleForbidden();
+    } else {
+      // Handle other errors
+      console.error("API Error:", error);
+    }
+  }
+
+  private handleUnauthorized(): void {
+    // Redirect to login or refresh token
+    localStorage.removeItem("token");
+    // Redirect to login page
+  }
+
+  private handleForbidden(): void {
+    // Handle forbidden access
+    console.error("Access forbidden");
+  }
+}
+```
+
+## 🔄 Version History
+
+### v18.26.17
+
+- Enhanced API services and models
+- Improved error handling
+- Added new content management features
+- Updated TypeScript definitions
+
+### v18.26.16
+
+- Bug fixes and performance improvements
+- Added new service methods
+- Enhanced authentication system
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests for new features
+5. Submit a pull request
+
+## 📄 License
+
+This library is licensed under the ISC License.
+
+## 🆘 Support
+
+For support and questions:
+
+- Create an issue on GitHub
+- Contact: [ntk.ir](https://ntk.ir)
+- Documentation: Check the main README.md
 
-## Additional Resources
+---
 
-For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+**Note**: This library is part of the NTK CMS Angular Libraries collection. For more information, see the main project README.