@halo-dev/api-client 2.16.0 → 2.17.0

package/README.md

@@ -2,23 +2,68 @@
 
 Halo 2.0 的 JavaScript API 客户端请求库。使用 [OpenAPI Generator](https://openapi-generator.tech/) 生成。
 
-## 开发环境
+## 使用
 
-```bash
-pnpm install
+```javascript
+import {
+  coreApiClient,
+  consoleApiClient,
+  ucApiClient,
+  publicApiClient,
+  createCoreApiClient,
+  createConsoleApiClient,
+  createUcApiClient,
+  createPublicApiClient,
+  axiosInstance
+} from "@halo-dev/api-client"
 ```
 
-```bash
-# 根据 OpenAPI 3.0 生成类型和网络请求的代码，此步骤需要启动 Halo 2.0 后端。
-pnpm gen
+- **coreApiClient**: 为 Halo 所有自定义模型的 CRUD 接口封装的 api client。
+- **consoleApiClient**: 为 Halo 针对 Console 提供的接口封装的 api client。
+- **ucApiClient**: 为 Halo 针对 UC 提供的接口封装的 api client。
+- **publicApiClient**: 为 Halo 所有公开访问的接口封装的 api client。
+- **createCoreApiClient**: 用于创建自定义模型的 CRUD 接口封装的 api client，需要传入 axios 实例。
+- **createConsoleApiClient**: 用于创建 Console 接口封装的 api client，需要传入 axios 实例。
+- **createUcApiClient**: 用于创建 UC 接口封装的 api client，需要传入 axios 实例。
+- **createPublicApiClient**: 用于创建公开访问接口封装的 api client，需要传入 axios 实例。
+- **axiosInstance**: 内部默认创建的 axios 实例。
+
+### 在插件中使用
+
+```shell
+pnpm install @halo-dev/api-client axios
 ```
 
-```bash
-pnpm build
+由于已经在 Console 和 UC 项目中引入并设置好了 Axios 拦截器，所以直接使用即可：
+
+```javascript
+import { coreApiClient } from "@halo-dev/api-client"
+
+coreApiClient.content.post.listPost().then(response => {
+  // handle response
+})
 ```
 
-## 发布版本
+此外，在最新的 `@halo-dev/ui-plugin-bundler-kit@2.17.0` 中，已经排除了 `@halo-dev/api-client`、`axios` 依赖，所以最终产物中的相关依赖会自动使用 Halo 本身提供的依赖，无需关心最终产物大小。
+
+详细文档可查阅：[插件开发 / API 请求](https://docs.halo.run/developer-guide/plugin/api-reference/ui/api-request)
+
+### 在外部项目中使用
+
+```shell
+pnpm install @halo-dev/api-client axios
+```
+
+```javascript
+import axios from "axios"
+
+const axiosInstance = axios.create({
+  baseURL: "http://localhost:8090"
+})
+
+const coreApiClient = createCoreApiClient(axiosInstance)
 
-```bash
-pnpm release
+coreApiClient.content.post.listPost().then(response => {
+  // handle response
+})
 ```

package/dist/entry/api-client.d.ts

@@ -0,0 +1,348 @@
+import { AxiosInstance } from 'axios';
+import { AnnotationSettingV1alpha1Api, AttachmentV1alpha1Api, AttachmentV1alpha1ConsoleApi, AttachmentV1alpha1UcApi, AuthProviderV1alpha1Api, AuthProviderV1alpha1ConsoleApi, BackupV1alpha1Api, CategoryV1alpha1Api, CommentV1alpha1Api, CommentV1alpha1ConsoleApi, CommentV1alpha1PublicApi, ConfigMapV1alpha1Api, CounterV1alpha1Api, DeviceV1alpha1UcApi, ExtensionDefinitionV1alpha1Api, ExtensionPointDefinitionV1alpha1Api, GroupV1alpha1Api, IndicesV1alpha1ConsoleApi, LoginApi, MenuItemV1alpha1Api, MenuV1alpha1Api, MenuV1alpha1PublicApi, MetricsV1alpha1PublicApi, MigrationV1alpha1ConsoleApi, NotificationTemplateV1alpha1Api, NotificationV1alpha1Api, NotificationV1alpha1UcApi, NotifierDescriptorV1alpha1Api, NotifierV1alpha1ConsoleApi, PersonalAccessTokenV1alpha1Api, PersonalAccessTokenV1alpha1UcApi, PluginV1alpha1Api, PluginV1alpha1ConsoleApi, PolicyTemplateV1alpha1Api, PolicyV1alpha1Api, PostV1alpha1Api, PostV1alpha1ConsoleApi, PostV1alpha1PublicApi, PostV1alpha1UcApi, ReasonTypeV1alpha1Api, ReasonV1alpha1Api, ReplyV1alpha1Api, ReplyV1alpha1ConsoleApi, ReverseProxyV1alpha1Api, RoleBindingV1alpha1Api, RoleV1alpha1Api, SearchEngineV1alpha1Api, SecretV1alpha1Api, SettingV1alpha1Api, SinglePageV1alpha1Api, SinglePageV1alpha1ConsoleApi, SnapshotV1alpha1Api, SnapshotV1alpha1UcApi, SubscriptionV1alpha1Api, SystemV1alpha1ConsoleApi, SystemV1alpha1PublicApi, TagV1alpha1Api, TagV1alpha1ConsoleApi, ThemeV1alpha1Api, ThemeV1alpha1ConsoleApi, TwoFactorAuthV1alpha1UcApi, UserConnectionV1alpha1Api, UserV1alpha1Api, UserV1alpha1ConsoleApi, UserV1alpha1PublicApi } from '../src';
+
+declare const defaultAxiosInstance: AxiosInstance;
+/**
+ * Create a core api client
+ *
+ * This is the API client for the CRUD interface that is automatically generated for Halo's core extensions.
+ *
+ * @see <https://github.com/halo-dev/rfcs/tree/main/extension>
+ * @param baseURL Halo backend base URL
+ * @param axiosInstance Axios instance
+ * @returns Core api client
+ * @example
+ * const axiosInstance = axios.create({
+ *  baseURL: "https://demo.halo.run",
+ *  withCredentials: true,
+ * })
+ *
+ * axiosInstance.interceptors.request.use((config) => {
+ *   // do something before request
+ *   return config;
+ * }, (error) => {
+ *   // do something with request error
+ *   return Promise.reject(error);
+ * });
+ *
+ * const coreApiClient = createCoreApiClient(axiosInstance);
+ *
+ * coreApiClient.content.post.listContentHaloRunV1alpha1Post().then(response => {
+ *    // handle response
+ * })
+ */
+declare function createCoreApiClient(axiosInstance: AxiosInstance): {
+    annotationSetting: AnnotationSettingV1alpha1Api;
+    menu: MenuV1alpha1Api;
+    menuItem: MenuItemV1alpha1Api;
+    setting: SettingV1alpha1Api;
+    configMap: ConfigMapV1alpha1Api;
+    secret: SecretV1alpha1Api;
+    user: UserV1alpha1Api;
+    role: RoleV1alpha1Api;
+    roleBinding: RoleBindingV1alpha1Api;
+    content: {
+        category: CategoryV1alpha1Api;
+        comment: CommentV1alpha1Api;
+        post: PostV1alpha1Api;
+        reply: ReplyV1alpha1Api;
+        singlePage: SinglePageV1alpha1Api;
+        snapshot: SnapshotV1alpha1Api;
+        tag: TagV1alpha1Api;
+    };
+    auth: {
+        authProvider: AuthProviderV1alpha1Api;
+        userConnection: UserConnectionV1alpha1Api;
+    };
+    storage: {
+        attachment: AttachmentV1alpha1Api;
+        group: GroupV1alpha1Api;
+        policy: PolicyV1alpha1Api;
+        policyTemplate: PolicyTemplateV1alpha1Api;
+    };
+    plugin: {
+        extensionDefinition: ExtensionDefinitionV1alpha1Api;
+        extensionPointDefinition: ExtensionPointDefinitionV1alpha1Api;
+        plugin: PluginV1alpha1Api;
+        reverseProxy: ReverseProxyV1alpha1Api;
+        searchEngine: SearchEngineV1alpha1Api;
+    };
+    metrics: {
+        counter: CounterV1alpha1Api;
+    };
+    theme: {
+        theme: ThemeV1alpha1Api;
+    };
+    notification: {
+        notification: NotificationV1alpha1Api;
+        notificationTemplate: NotificationTemplateV1alpha1Api;
+        notifierDescriptor: NotifierDescriptorV1alpha1Api;
+        reason: ReasonV1alpha1Api;
+        reasonType: ReasonTypeV1alpha1Api;
+        subscription: SubscriptionV1alpha1Api;
+    };
+    migration: {
+        backup: BackupV1alpha1Api;
+    };
+    security: {
+        personalAccessToken: PersonalAccessTokenV1alpha1Api;
+    };
+};
+/**
+ * Create a console api client
+ *
+ * Console api client is used for console related operations
+ *
+ * @param baseURL Halo backend base URL
+ * @param axiosInstance Axios instance
+ * @returns Console api client
+ * @example
+ * const axiosInstance = axios.create({
+ *  baseURL: "https://demo.halo.run",
+ *  withCredentials: true,
+ * })
+ *
+ * axiosInstance.interceptors.request.use((config) => {
+ *   // do something before request
+ *   return config;
+ * }, (error) => {
+ *   // do something with request error
+ *   return Promise.reject(error);
+ * });
+ *
+ * const consoleApiClient = createConsoleApiClient(axiosInstance);
+ *
+ * consoleApiClient.content.post.listPosts().then(response => {
+ *    // handle response
+ * })
+ */
+declare function createConsoleApiClient(axiosInstance: AxiosInstance): {
+    user: UserV1alpha1ConsoleApi;
+    system: SystemV1alpha1ConsoleApi;
+    migration: MigrationV1alpha1ConsoleApi;
+    login: LoginApi;
+    storage: {
+        attachment: AttachmentV1alpha1ConsoleApi;
+    };
+    auth: {
+        authProvider: AuthProviderV1alpha1ConsoleApi;
+    };
+    content: {
+        comment: CommentV1alpha1ConsoleApi;
+        reply: ReplyV1alpha1ConsoleApi;
+        indices: IndicesV1alpha1ConsoleApi;
+        post: PostV1alpha1ConsoleApi;
+        singlePage: SinglePageV1alpha1ConsoleApi;
+        tag: TagV1alpha1ConsoleApi;
+    };
+    notification: {
+        notifier: NotifierV1alpha1ConsoleApi;
+    };
+    plugin: {
+        plugin: PluginV1alpha1ConsoleApi;
+    };
+    theme: {
+        theme: ThemeV1alpha1ConsoleApi;
+    };
+};
+/**
+ * Create a uc api client
+ *
+ * Uc api client is used for user content related operations
+ *
+ * @param baseURL Halo backend base URL
+ * @param axiosInstance Axios instance
+ * @returns Uc api client
+ * @example
+ * const axiosInstance = axios.create({
+ *  baseURL: "https://demo.halo.run",
+ *  withCredentials: true,
+ * })
+ *
+ * axiosInstance.interceptors.request.use((config) => {
+ *   // do something before request
+ *   return config;
+ * }, (error) => {
+ *   // do something with request error
+ *   return Promise.reject(error);
+ * });
+ *
+ * const ucApiClient = createUcApiClient(axiosInstance);
+ *
+ * ucApiClient.content.post.listMyPosts().then(response => {
+ *    // handle response
+ * })
+ */
+declare function createUcApiClient(axiosInstance: AxiosInstance): {
+    storage: {
+        attachment: AttachmentV1alpha1UcApi;
+    };
+    content: {
+        post: PostV1alpha1UcApi;
+        snapshot: SnapshotV1alpha1UcApi;
+    };
+    security: {
+        twoFactor: TwoFactorAuthV1alpha1UcApi;
+        personalAccessToken: PersonalAccessTokenV1alpha1UcApi;
+        device: DeviceV1alpha1UcApi;
+    };
+    notification: {
+        notification: NotificationV1alpha1UcApi;
+    };
+};
+/**
+ * Create a public api client
+ *
+ * Public api client is used for public content related operations, no need authentication
+ *
+ * @param baseURL Halo backend base URL
+ * @param axiosInstance Axios instance
+ * @returns Public api client
+ * @example
+ * const axiosInstance = axios.create({
+ *   baseURL: "https://demo.halo.run",
+ *   withCredentials: true,
+ * })
+ *
+ * axiosInstance.interceptors.request.use((config) => {
+ *   // do something before request
+ *   return config;
+ * }, (error) => {
+ *   // do something with request error
+ *   return Promise.reject(error);
+ * });
+ *
+ * const publicApiClient = createPublicApiClient(axiosInstance);
+ *
+ * publicApiClient.content.post.searchPost({ keyword: "foo" }).then(response => {
+ *    // handle response
+ * })
+ */
+declare function createPublicApiClient(axiosInstance: AxiosInstance): {
+    menu: MenuV1alpha1PublicApi;
+    stats: SystemV1alpha1PublicApi;
+    user: UserV1alpha1PublicApi;
+    content: {
+        post: PostV1alpha1PublicApi;
+        comment: CommentV1alpha1PublicApi;
+    };
+    metrics: {
+        metrics: MetricsV1alpha1PublicApi;
+    };
+};
+declare const defaultCoreApiClient: {
+    annotationSetting: AnnotationSettingV1alpha1Api;
+    menu: MenuV1alpha1Api;
+    menuItem: MenuItemV1alpha1Api;
+    setting: SettingV1alpha1Api;
+    configMap: ConfigMapV1alpha1Api;
+    secret: SecretV1alpha1Api;
+    user: UserV1alpha1Api;
+    role: RoleV1alpha1Api;
+    roleBinding: RoleBindingV1alpha1Api;
+    content: {
+        category: CategoryV1alpha1Api;
+        comment: CommentV1alpha1Api;
+        post: PostV1alpha1Api;
+        reply: ReplyV1alpha1Api;
+        singlePage: SinglePageV1alpha1Api;
+        snapshot: SnapshotV1alpha1Api;
+        tag: TagV1alpha1Api;
+    };
+    auth: {
+        authProvider: AuthProviderV1alpha1Api;
+        userConnection: UserConnectionV1alpha1Api;
+    };
+    storage: {
+        attachment: AttachmentV1alpha1Api;
+        group: GroupV1alpha1Api;
+        policy: PolicyV1alpha1Api;
+        policyTemplate: PolicyTemplateV1alpha1Api;
+    };
+    plugin: {
+        extensionDefinition: ExtensionDefinitionV1alpha1Api;
+        extensionPointDefinition: ExtensionPointDefinitionV1alpha1Api;
+        plugin: PluginV1alpha1Api;
+        reverseProxy: ReverseProxyV1alpha1Api;
+        searchEngine: SearchEngineV1alpha1Api;
+    };
+    metrics: {
+        counter: CounterV1alpha1Api;
+    };
+    theme: {
+        theme: ThemeV1alpha1Api;
+    };
+    notification: {
+        notification: NotificationV1alpha1Api;
+        notificationTemplate: NotificationTemplateV1alpha1Api;
+        notifierDescriptor: NotifierDescriptorV1alpha1Api;
+        reason: ReasonV1alpha1Api;
+        reasonType: ReasonTypeV1alpha1Api;
+        subscription: SubscriptionV1alpha1Api;
+    };
+    migration: {
+        backup: BackupV1alpha1Api;
+    };
+    security: {
+        personalAccessToken: PersonalAccessTokenV1alpha1Api;
+    };
+};
+declare const defaultConsoleApiClient: {
+    user: UserV1alpha1ConsoleApi;
+    system: SystemV1alpha1ConsoleApi;
+    migration: MigrationV1alpha1ConsoleApi;
+    login: LoginApi;
+    storage: {
+        attachment: AttachmentV1alpha1ConsoleApi;
+    };
+    auth: {
+        authProvider: AuthProviderV1alpha1ConsoleApi;
+    };
+    content: {
+        comment: CommentV1alpha1ConsoleApi;
+        reply: ReplyV1alpha1ConsoleApi;
+        indices: IndicesV1alpha1ConsoleApi;
+        post: PostV1alpha1ConsoleApi;
+        singlePage: SinglePageV1alpha1ConsoleApi;
+        tag: TagV1alpha1ConsoleApi;
+    };
+    notification: {
+        notifier: NotifierV1alpha1ConsoleApi;
+    };
+    plugin: {
+        plugin: PluginV1alpha1ConsoleApi;
+    };
+    theme: {
+        theme: ThemeV1alpha1ConsoleApi;
+    };
+};
+declare const defaultUcApiClient: {
+    storage: {
+        attachment: AttachmentV1alpha1UcApi;
+    };
+    content: {
+        post: PostV1alpha1UcApi;
+        snapshot: SnapshotV1alpha1UcApi;
+    };
+    security: {
+        twoFactor: TwoFactorAuthV1alpha1UcApi;
+        personalAccessToken: PersonalAccessTokenV1alpha1UcApi;
+        device: DeviceV1alpha1UcApi;
+    };
+    notification: {
+        notification: NotificationV1alpha1UcApi;
+    };
+};
+declare const defaultPublicApiClient: {
+    menu: MenuV1alpha1PublicApi;
+    stats: SystemV1alpha1PublicApi;
+    user: UserV1alpha1PublicApi;
+    content: {
+        post: PostV1alpha1PublicApi;
+        comment: CommentV1alpha1PublicApi;
+    };
+    metrics: {
+        metrics: MetricsV1alpha1PublicApi;
+    };
+};
+export { defaultAxiosInstance as axiosInstance, defaultConsoleApiClient as consoleApiClient, defaultCoreApiClient as coreApiClient, createConsoleApiClient, createCoreApiClient, createPublicApiClient, createUcApiClient, defaultPublicApiClient as publicApiClient, defaultUcApiClient as ucApiClient };

package/dist/entry/index.d.ts

@@ -0,0 +1,2 @@
+export * from '../src';
+export * from './api-client';