@fecommunity/reactpress-toolkit 1.0.0-beta.1 → 1.0.0-beta.2

package/README.md

@@ -0,0 +1,190 @@
+# @fecommunity/reactpress-toolkit
+
+A TypeScript-based API client toolkit for ReactPress, automatically generated from OpenAPI/Swagger specifications.
+
+## Overview
+
+The ReactPress Toolkit is a comprehensive API client library that provides strongly-typed interfaces for interacting with the ReactPress backend services. It includes:
+
+- **Auto-generated API clients** for all ReactPress modules
+- **TypeScript definitions** for all data contracts
+- **Utility functions** for common operations
+- **HTTP client** with built-in authentication and error handling
+
+## Installation
+
+```bash
+npm install @fecommunity/reactpress-toolkit
+```
+
+or
+
+```bash
+yarn add @fecommunity/reactpress-toolkit
+```
+
+or
+
+```bash
+pnpm add @fecommunity/reactpress-toolkit
+```
+
+## Quick Start
+
+### Using the Default API Instance
+
+```typescript
+import api from '@fecommunity/reactpress-toolkit';
+
+// Get all articles
+const articles = await api.article.findAll();
+
+// Get a specific article by ID
+const article = await api.article.findById('article-id');
+
+// Create a new article
+const newArticle = await api.article.create({
+  title: 'My New Article',
+  content: 'Article content here...',
+  // ... other properties
+});
+```
+
+### Using Named Exports
+
+```typescript
+import { api, types, utils } from '@fecommunity/reactpress-toolkit';
+
+// Working with typed data
+const article: types.IArticle = {
+  id: '1',
+  title: 'Sample Article',
+  // ... other properties
+};
+
+// Using utility functions
+const formattedDate = utils.formatDate(new Date());
+```
+
+## API Modules
+
+The toolkit provides clients for all ReactPress backend modules:
+
+- `api.article` - Article management
+- `api.auth` - Authentication services
+- `api.category` - Category management
+- `api.comment` - Comment system
+- `api.file` - File management
+- `api.knowledge` - Knowledge base
+- `api.page` - Page management
+- `api.search` - Search functionality
+- `api.setting` - System settings
+- `api.smtp` - SMTP services
+- `api.tag` - Tag management
+- `api.user` - User management
+- `api.view` - View analytics
+
+## Configuration
+
+You can create a custom API instance with specific configuration:
+
+```typescript
+import { createApiInstance } from '@fecommunity/reactpress-toolkit';
+
+const customApi = createApiInstance({
+  baseURL: 'https://api.yourdomain.com',
+  timeout: 5000,
+  // ... other axios configuration options
+});
+
+// Use the custom instance
+const articles = await customApi.article.findAll();
+```
+
+## Type Definitions
+
+All data models are strongly typed and available through the `types` export:
+
+```typescript
+import { types } from '@fecommunity/reactpress-toolkit';
+
+const user: types.IUser = {
+  name: 'John Doe',
+  email: 'john@example.com',
+  // ... other properties
+};
+```
+
+Available type definitions include:
+- `types.IUser`
+- `types.IArticle`
+- `types.ICategory`
+- `types.ITag`
+- `types.IComment`
+- `types.IFile`
+- `types.ISetting`
+- `types.IPage`
+- `types.IKnowledge`
+- `types.IView`
+- `types.I_SMTP`
+
+## Utility Functions
+
+The toolkit includes helpful utility functions:
+
+```typescript
+import { utils } from '@fecommunity/reactpress-toolkit';
+
+// Date formatting
+const formattedDate = utils.formatDate(new Date(), 'YYYY-MM-DD');
+
+// Deep cloning
+const clonedObject = utils.deepClone(originalObject);
+
+// Error handling
+if (utils.ApiError.isInstance(error)) {
+  console.log(`API Error: ${error.code} - ${error.message}`);
+}
+```
+
+## Development
+
+### Generating API Definitions
+
+The toolkit is automatically generated from the ReactPress backend's OpenAPI specification:
+
+```bash
+npm run generate
+```
+
+This command will:
+1. Generate a new Swagger JSON from the ReactPress server
+2. Create TypeScript definitions from the specification
+3. Organize the generated files into appropriate directories
+4. Create API clients for each module
+
+### Building
+
+```bash
+npm run build
+```
+
+This will compile the TypeScript code to JavaScript in the `dist` directory.
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a pull request
+
+## License
+
+ISC
+
+## Related Projects
+
+- [ReactPress](https://github.com/fecommunity/reactpress) - The main ReactPress platform
+- [ReactPress Server](https://github.com/fecommunity/reactpress/server) - Backend server
+- [ReactPress Client](https://github.com/fecommunity/reactpress/client) - Frontend client

package/dist/Article.d.ts

@@ -0,0 +1,121 @@
+import { IArticleControllerCreateData } from './data-contracts';
+import { HttpClient, RequestParams } from './HttpClient';
+export declare class Article<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
+    /**
+     * No description
+     *
+     * @tags Article
+     * @name ArticleControllerCreate
+     * @request POST:/article
+     * @response `200` `IArticleControllerCreateData` 创建文章
+     */
+    articleControllerCreate: (params?: RequestParams) => Promise<import("axios").AxiosResponse<IArticleControllerCreateData, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Article
+     * @name ArticleControllerFindAll
+     * @request GET:/article
+     * @response `200` `IArticleControllerFindAllData`
+     */
+    articleControllerFindAll: (params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Article
+     * @name ArticleControllerFindArticlesByCategory
+     * @request GET:/article/category/{id}
+     * @response `200` `IArticleControllerFindArticlesByCategoryData`
+     */
+    articleControllerFindArticlesByCategory: (id: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Article
+     * @name ArticleControllerFindArticlesByTag
+     * @request GET:/article/tag/{id}
+     * @response `200` `IArticleControllerFindArticlesByTagData`
+     */
+    articleControllerFindArticlesByTag: (id: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Article
+     * @name ArticleControllerGetRecommendArticles
+     * @request GET:/article/all/recommend
+     * @response `200` `IArticleControllerGetRecommendArticlesData`
+     */
+    articleControllerGetRecommendArticles: (params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Article
+     * @name ArticleControllerGetArchives
+     * @request GET:/article/archives
+     * @response `200` `IArticleControllerGetArchivesData`
+     */
+    articleControllerGetArchives: (params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Article
+     * @name ArticleControllerRecommend
+     * @request GET:/article/recommend
+     * @response `200` `IArticleControllerRecommendData`
+     */
+    articleControllerRecommend: (params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Article
+     * @name ArticleControllerFindById
+     * @request GET:/article/{id}
+     * @response `200` `IArticleControllerFindByIdData`
+     */
+    articleControllerFindById: (id: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Article
+     * @name ArticleControllerUpdateById
+     * @request PATCH:/article/{id}
+     * @response `200` `IArticleControllerUpdateByIdData`
+     */
+    articleControllerUpdateById: (id: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Article
+     * @name ArticleControllerDeleteById
+     * @request DELETE:/article/{id}
+     * @response `200` `IArticleControllerDeleteByIdData`
+     */
+    articleControllerDeleteById: (id: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Article
+     * @name ArticleControllerCheckPassword
+     * @request POST:/article/{id}/checkPassword
+     * @response `200` `IArticleControllerCheckPasswordData`
+     */
+    articleControllerCheckPassword: (id: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Article
+     * @name ArticleControllerUpdateViewsById
+     * @request POST:/article/{id}/views
+     * @response `200` `IArticleControllerUpdateViewsByIdData`
+     */
+    articleControllerUpdateViewsById: (id: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Article
+     * @name ArticleControllerUpdateLikesById
+     * @request POST:/article/{id}/likes
+     * @response `200` `IArticleControllerUpdateLikesByIdData`
+     */
+    articleControllerUpdateLikesById: (id: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+}

package/dist/Article.js

@@ -0,0 +1,189 @@
+"use strict";
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Article = void 0;
+const HttpClient_1 = require("./HttpClient");
+class Article extends HttpClient_1.HttpClient {
+    constructor() {
+        super(...arguments);
+        /**
+         * No description
+         *
+         * @tags Article
+         * @name ArticleControllerCreate
+         * @request POST:/article
+         * @response `200` `IArticleControllerCreateData` 创建文章
+         */
+        this.articleControllerCreate = (params = {}) => this.request({
+            path: `/article`,
+            method: 'POST',
+            ...params,
+        });
+        /**
+         * No description
+         *
+         * @tags Article
+         * @name ArticleControllerFindAll
+         * @request GET:/article
+         * @response `200` `IArticleControllerFindAllData`
+         */
+        this.articleControllerFindAll = (params = {}) => this.request({
+            path: `/article`,
+            method: 'GET',
+            ...params,
+        });
+        /**
+         * No description
+         *
+         * @tags Article
+         * @name ArticleControllerFindArticlesByCategory
+         * @request GET:/article/category/{id}
+         * @response `200` `IArticleControllerFindArticlesByCategoryData`
+         */
+        this.articleControllerFindArticlesByCategory = (id, params = {}) => this.request({
+            path: `/article/category/${id}`,
+            method: 'GET',
+            ...params,
+        });
+        /**
+         * No description
+         *
+         * @tags Article
+         * @name ArticleControllerFindArticlesByTag
+         * @request GET:/article/tag/{id}
+         * @response `200` `IArticleControllerFindArticlesByTagData`
+         */
+        this.articleControllerFindArticlesByTag = (id, params = {}) => this.request({
+            path: `/article/tag/${id}`,
+            method: 'GET',
+            ...params,
+        });
+        /**
+         * No description
+         *
+         * @tags Article
+         * @name ArticleControllerGetRecommendArticles
+         * @request GET:/article/all/recommend
+         * @response `200` `IArticleControllerGetRecommendArticlesData`
+         */
+        this.articleControllerGetRecommendArticles = (params = {}) => this.request({
+            path: `/article/all/recommend`,
+            method: 'GET',
+            ...params,
+        });
+        /**
+         * No description
+         *
+         * @tags Article
+         * @name ArticleControllerGetArchives
+         * @request GET:/article/archives
+         * @response `200` `IArticleControllerGetArchivesData`
+         */
+        this.articleControllerGetArchives = (params = {}) => this.request({
+            path: `/article/archives`,
+            method: 'GET',
+            ...params,
+        });
+        /**
+         * No description
+         *
+         * @tags Article
+         * @name ArticleControllerRecommend
+         * @request GET:/article/recommend
+         * @response `200` `IArticleControllerRecommendData`
+         */
+        this.articleControllerRecommend = (params = {}) => this.request({
+            path: `/article/recommend`,
+            method: 'GET',
+            ...params,
+        });
+        /**
+         * No description
+         *
+         * @tags Article
+         * @name ArticleControllerFindById
+         * @request GET:/article/{id}
+         * @response `200` `IArticleControllerFindByIdData`
+         */
+        this.articleControllerFindById = (id, params = {}) => this.request({
+            path: `/article/${id}`,
+            method: 'GET',
+            ...params,
+        });
+        /**
+         * No description
+         *
+         * @tags Article
+         * @name ArticleControllerUpdateById
+         * @request PATCH:/article/{id}
+         * @response `200` `IArticleControllerUpdateByIdData`
+         */
+        this.articleControllerUpdateById = (id, params = {}) => this.request({
+            path: `/article/${id}`,
+            method: 'PATCH',
+            ...params,
+        });
+        /**
+         * No description
+         *
+         * @tags Article
+         * @name ArticleControllerDeleteById
+         * @request DELETE:/article/{id}
+         * @response `200` `IArticleControllerDeleteByIdData`
+         */
+        this.articleControllerDeleteById = (id, params = {}) => this.request({
+            path: `/article/${id}`,
+            method: 'DELETE',
+            ...params,
+        });
+        /**
+         * No description
+         *
+         * @tags Article
+         * @name ArticleControllerCheckPassword
+         * @request POST:/article/{id}/checkPassword
+         * @response `200` `IArticleControllerCheckPasswordData`
+         */
+        this.articleControllerCheckPassword = (id, params = {}) => this.request({
+            path: `/article/${id}/checkPassword`,
+            method: 'POST',
+            ...params,
+        });
+        /**
+         * No description
+         *
+         * @tags Article
+         * @name ArticleControllerUpdateViewsById
+         * @request POST:/article/{id}/views
+         * @response `200` `IArticleControllerUpdateViewsByIdData`
+         */
+        this.articleControllerUpdateViewsById = (id, params = {}) => this.request({
+            path: `/article/${id}/views`,
+            method: 'POST',
+            ...params,
+        });
+        /**
+         * No description
+         *
+         * @tags Article
+         * @name ArticleControllerUpdateLikesById
+         * @request POST:/article/{id}/likes
+         * @response `200` `IArticleControllerUpdateLikesByIdData`
+         */
+        this.articleControllerUpdateLikesById = (id, params = {}) => this.request({
+            path: `/article/${id}/likes`,
+            method: 'POST',
+            ...params,
+        });
+    }
+}
+exports.Article = Article;

package/dist/Auth.d.ts

@@ -0,0 +1,30 @@
+import { HttpClient, RequestParams } from './HttpClient';
+export declare class Auth<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
+    /**
+     * No description
+     *
+     * @tags Auth
+     * @name AuthControllerLogin
+     * @request POST:/auth/login
+     * @response `200` `IAuthControllerLoginData`
+     */
+    authControllerLogin: (params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Auth
+     * @name AuthControllerCreateBook
+     * @request POST:/auth/admin
+     * @response `201` `IAuthControllerCreateBookData`
+     */
+    authControllerCreateBook: (params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Auth
+     * @name AuthControllerLoginWithGithub
+     * @request POST:/auth/github
+     * @response `201` `IAuthControllerLoginWithGithubData`
+     */
+    authControllerLoginWithGithub: (params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+}

package/dist/Auth.js

@@ -0,0 +1,59 @@
+"use strict";
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Auth = void 0;
+const HttpClient_1 = require("./HttpClient");
+class Auth extends HttpClient_1.HttpClient {
+    constructor() {
+        super(...arguments);
+        /**
+         * No description
+         *
+         * @tags Auth
+         * @name AuthControllerLogin
+         * @request POST:/auth/login
+         * @response `200` `IAuthControllerLoginData`
+         */
+        this.authControllerLogin = (params = {}) => this.request({
+            path: `/auth/login`,
+            method: 'POST',
+            ...params,
+        });
+        /**
+         * No description
+         *
+         * @tags Auth
+         * @name AuthControllerCreateBook
+         * @request POST:/auth/admin
+         * @response `201` `IAuthControllerCreateBookData`
+         */
+        this.authControllerCreateBook = (params = {}) => this.request({
+            path: `/auth/admin`,
+            method: 'POST',
+            ...params,
+        });
+        /**
+         * No description
+         *
+         * @tags Auth
+         * @name AuthControllerLoginWithGithub
+         * @request POST:/auth/github
+         * @response `201` `IAuthControllerLoginWithGithubData`
+         */
+        this.authControllerLoginWithGithub = (params = {}) => this.request({
+            path: `/auth/github`,
+            method: 'POST',
+            ...params,
+        });
+    }
+}
+exports.Auth = Auth;

package/dist/Category.d.ts

@@ -0,0 +1,49 @@
+import { ICategoryControllerCreateData } from './data-contracts';
+import { HttpClient, RequestParams } from './HttpClient';
+export declare class Category<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
+    /**
+     * No description
+     *
+     * @tags Category
+     * @name CategoryControllerCreate
+     * @request POST:/category
+     * @response `200` `ICategoryControllerCreateData` 添加分类
+     */
+    categoryControllerCreate: (params?: RequestParams) => Promise<import("axios").AxiosResponse<ICategoryControllerCreateData, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Category
+     * @name CategoryControllerFindAll
+     * @request GET:/category
+     * @response `200` `ICategoryControllerFindAllData`
+     */
+    categoryControllerFindAll: (params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Category
+     * @name CategoryControllerFindById
+     * @request GET:/category/{id}
+     * @response `200` `ICategoryControllerFindByIdData`
+     */
+    categoryControllerFindById: (id: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Category
+     * @name CategoryControllerUpdateById
+     * @request PATCH:/category/{id}
+     * @response `200` `ICategoryControllerUpdateByIdData`
+     */
+    categoryControllerUpdateById: (id: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * No description
+     *
+     * @tags Category
+     * @name CategoryControllerDeleteById
+     * @request DELETE:/category/{id}
+     * @response `200` `ICategoryControllerDeleteByIdData`
+     */
+    categoryControllerDeleteById: (id: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+}