@halo-dev/api-client 2.21.0 → 2.22.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@halo-dev/api-client",
-  "version": "2.21.0",
+  "version": "2.22.0",
   "description": "API Client for Halo 2",
   "homepage": "https://github.com/halo-dev/halo/tree/main/ui/packages/api-client#readme",
   "bugs": {
@@ -19,15 +19,14 @@
       "url": "https://github.com/ruibaby"
     }
   ],
+  "type": "module",
   "exports": {
-    ".": {
-      "types": "./dist/entry/index.d.ts",
-      "import": "./dist/halo-api-client.es.js"
-    }
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
   },
-  "main": "./dist/halo-api-client.iife.js",
-  "module": "./dist/halo-api-client.es.js",
-  "types": "./dist/entry/index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "typesVersions": {
     "*": {
       "*": [
@@ -36,26 +35,23 @@
       ]
     }
   },
+  "sideEffects": false,
   "files": [
     "dist"
   ],
+  "dependencies": {
+    "qs": "^6.14.0"
+  },
   "devDependencies": {
-    "@openapitools/openapi-generator-cli": "^2.13.4",
-    "@types/node": "^20.14.2",
-    "@types/qs": "^6.9.15",
-    "rimraf": "^5.0.7",
-    "typescript": "~5.5.4",
-    "unbuild": "^0.7.6",
-    "vite-plugin-dts": "^4.2.2"
+    "@openapitools/openapi-generator-cli": "^2.25.0",
+    "@types/qs": "^6.14.0",
+    "rimraf": "^5.0.10"
   },
   "peerDependencies": {
-    "axios": "^1.7.x"
-  },
-  "dependencies": {
-    "qs": "^6.13.0"
+    "axios": "^1.12.*"
   },
   "scripts": {
-    "build": "vite build",
-    "gen": "rimraf --glob './src/**' && openapi-generator-cli generate -i ../../../api-docs/openapi/v3_0/aggregated.json -g typescript-axios -c ./.openapi_config.yaml -o ./src --type-mappings='set=Array'"
+    "build": "tsdown",
+    "gen": "rimraf --glob './src/**' && openapi-generator-cli generate -i ../../../api-docs/openapi/v3_0/aggregated.json -g typescript-axios -c ./.openapi_config.yaml -o ./src --type-mappings='set=Array' --global-property apiDocs=false,modelDocs=false"
   }
 }

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

@@ -1,357 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { AnnotationSettingV1alpha1Api, AttachmentV1alpha1Api, AttachmentV1alpha1ConsoleApi, AttachmentV1alpha1UcApi, AuthProviderV1alpha1Api, AuthProviderV1alpha1ConsoleApi, BackupV1alpha1Api, CategoryV1alpha1Api, CommentV1alpha1Api, CommentV1alpha1ConsoleApi, CommentV1alpha1PublicApi, ConfigMapV1alpha1Api, CounterV1alpha1Api, DeviceV1alpha1UcApi, ExtensionDefinitionV1alpha1Api, ExtensionPointDefinitionV1alpha1Api, GroupV1alpha1Api, IndicesV1alpha1ConsoleApi, MenuItemV1alpha1Api, MenuV1alpha1Api, MenuV1alpha1PublicApi, MetricsV1alpha1PublicApi, MigrationV1alpha1ConsoleApi, NotificationTemplateV1alpha1Api, NotificationV1alpha1Api, NotificationV1alpha1PublicApi, NotificationV1alpha1UcApi, NotifierDescriptorV1alpha1Api, NotifierV1alpha1ConsoleApi, PersonalAccessTokenV1alpha1Api, PersonalAccessTokenV1alpha1UcApi, PluginV1alpha1Api, PluginV1alpha1ConsoleApi, PolicyTemplateV1alpha1Api, PolicyV1alpha1Api, PostV1alpha1Api, PostV1alpha1ConsoleApi, PostV1alpha1PublicApi, PostV1alpha1UcApi, ReasonTypeV1alpha1Api, ReasonV1alpha1Api, ReplyV1alpha1Api, ReplyV1alpha1ConsoleApi, ReverseProxyV1alpha1Api, RoleBindingV1alpha1Api, RoleV1alpha1Api, SecretV1alpha1Api, SettingV1alpha1Api, SinglePageV1alpha1Api, SinglePageV1alpha1ConsoleApi, SnapshotV1alpha1Api, SnapshotV1alpha1UcApi, SubscriptionV1alpha1Api, SystemConfigV1alpha1ConsoleApi, SystemV1alpha1ConsoleApi, SystemV1alpha1PublicApi, TagV1alpha1Api, TagV1alpha1ConsoleApi, ThemeV1alpha1Api, ThemeV1alpha1ConsoleApi, TwoFactorAuthV1alpha1UcApi, UserConnectionV1alpha1Api, UserV1alpha1Api, UserV1alpha1ConsoleApi, UserPreferenceV1alpha1UcApi, PolicyAlpha1ConsoleApi } 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;
-    };
-    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;
-    storage: {
-        attachment: AttachmentV1alpha1ConsoleApi;
-        policy: PolicyAlpha1ConsoleApi;
-    };
-    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;
-    };
-    configMap: {
-        system: SystemConfigV1alpha1ConsoleApi;
-    };
-};
-/**
- * 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;
-    };
-    user: {
-        preference: UserPreferenceV1alpha1UcApi;
-    };
-};
-/**
- * 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;
-    content: {
-        post: PostV1alpha1PublicApi;
-        comment: CommentV1alpha1PublicApi;
-    };
-    metrics: {
-        metrics: MetricsV1alpha1PublicApi;
-    };
-    notification: NotificationV1alpha1PublicApi;
-};
-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;
-    };
-    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;
-    storage: {
-        attachment: AttachmentV1alpha1ConsoleApi;
-        policy: PolicyAlpha1ConsoleApi;
-    };
-    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;
-    };
-    configMap: {
-        system: SystemConfigV1alpha1ConsoleApi;
-    };
-};
-declare const defaultUcApiClient: {
-    storage: {
-        attachment: AttachmentV1alpha1UcApi;
-    };
-    content: {
-        post: PostV1alpha1UcApi;
-        snapshot: SnapshotV1alpha1UcApi;
-    };
-    security: {
-        twoFactor: TwoFactorAuthV1alpha1UcApi;
-        personalAccessToken: PersonalAccessTokenV1alpha1UcApi;
-        device: DeviceV1alpha1UcApi;
-    };
-    notification: {
-        notification: NotificationV1alpha1UcApi;
-    };
-    user: {
-        preference: UserPreferenceV1alpha1UcApi;
-    };
-};
-declare const defaultPublicApiClient: {
-    menu: MenuV1alpha1PublicApi;
-    stats: SystemV1alpha1PublicApi;
-    content: {
-        post: PostV1alpha1PublicApi;
-        comment: CommentV1alpha1PublicApi;
-    };
-    metrics: {
-        metrics: MetricsV1alpha1PublicApi;
-    };
-    notification: NotificationV1alpha1PublicApi;
-};
-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

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