@lobehub/market-sdk 0.22.3 → 0.22.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/market-sdk",
-  "version": "0.22.3",
+  "version": "0.22.4",
   "description": "LobeHub Market JavaScript SDK",
   "keywords": [
     "lobehub",

package/README.md

@@ -1,335 +0,0 @@
-# LobeHub Market JavaScript SDK
-
-[![NPM version](https://img.shields.io/npm/v/@lobehub/market-sdk.svg?style=flat)](https://npmjs.org/package/@lobehub/market-sdk)
-[![NPM downloads](https://img.shields.io/npm/dm/@lobehub/market-sdk.svg?style=flat)](https://npmjs.org/package/@lobehub/market-sdk)
-
-JavaScript SDK for accessing the LobeHub Market API, providing easy integration with the LobeHub ecosystem.
-
-## Features
-
-- 🚀 **Easy Integration**: Simple API for accessing LobeHub Marketplace resources
-- 🔌 **Plugin Support**: Browse, search, and fetch plugin manifests
-- 🔒 **Authentication**: Secure API access with token-based authentication
-- 🧩 **Modular Architecture**: Logically separated services for different API domains
-- 🌐 **Localization**: Built-in support for localized content
-- 🔍 **Discovery**: Automatic service discovery for API capabilities
-- 📊 **Admin Tools**: Comprehensive admin APIs for marketplace management
-
-## Installation
-
-```bash
-# Using npm
-npm install @lobehub/market-sdk
-
-# Using yarn
-yarn add @lobehub/market-sdk
-
-# Using pnpm
-pnpm add @lobehub/market-sdk
-```
-
-## Package Structure
-
-```
-src/
-├── market/            - Market SDK implementation
-│   ├── services/      - Market services
-│   │   ├── PluginsService.ts    - Plugin-related operations
-│   │   └── DiscoveryService.ts  - API discovery
-│   └── market-sdk.ts  - Main SDK class
-├── admin/             - Admin SDK implementation
-│   ├── services/      - Admin services
-│   │   ├── PluginService.ts     - Plugin management
-│   │   ├── ReviewService.ts     - Review management
-│   │   ├── SettingsService.ts   - Settings management
-│   │   └── SystemDependencyService.ts - Dependencies management
-│   └── MarketAdmin.ts - Admin SDK class
-├── core/              - Core utilities and base classes
-├── types/             - TypeScript type definitions
-└── index.ts           - Main entry point
-```
-
-## Usage
-
-### Market SDK
-
-```typescript
-import { MarketSDK } from '@lobehub/market-sdk';
-
-// Create a client instance
-const market = new MarketSDK({
-  // Optional: custom API base URL (defaults to https://market.lobehub.com/api)
-  baseURL: 'https://your-api-url.com/api',
-  // Optional: API key for authentication
-  apiKey: 'your-api-key',
-  // Optional: default locale for localized content
-  defaultLocale: 'en-US',
-});
-
-// Example: Get a list of plugins
-async function getPlugins() {
-  try {
-    const result = await market.plugins.getPluginList({
-      page: 1,
-      pageSize: 10,
-      locale: 'en-US',
-      // Additional filter parameters
-    });
-
-    console.log(`Found ${result.data.items.length} plugins`);
-    console.log('Plugins:', result.data.items);
-  } catch (error) {
-    console.error('Error fetching plugins:', error);
-  }
-}
-
-// Example: Get plugin categories
-async function getCategories() {
-  try {
-    const result = await market.plugins.getCategories();
-    console.log('Categories:', result.data);
-  } catch (error) {
-    console.error('Error fetching categories:', error);
-  }
-}
-
-// Example: Get a plugin's manifest
-async function getPluginManifest(pluginId) {
-  try {
-    const result = await market.plugins.getPluginManifest({ id: pluginId });
-    console.log('Plugin manifest:', result.data);
-  } catch (error) {
-    console.error('Error fetching plugin manifest:', error);
-  }
-}
-```
-
-### Admin SDK
-
-For administrative operations, use the `MarketAdmin` class:
-
-```typescript
-import { MarketAdmin } from '@lobehub/market-sdk';
-
-// Create an admin client instance
-const admin = new MarketAdmin({
-  // Required: Admin API key
-  apiKey: 'your-admin-api-key',
-  // Optional: custom API base URL
-  baseURL: 'https://your-api-url.com/api',
-});
-
-// Example: Create a new plugin
-async function createPlugin() {
-  try {
-    const result = await admin.plugins.createPlugin({
-      meta: {
-        title: 'My Plugin',
-        description: 'A sample plugin',
-        author: 'LobeHub',
-        homepage: 'https://github.com/lobehub/my-plugin',
-      },
-      manifest: {
-        // Plugin manifest details
-      },
-    });
-
-    console.log('Plugin created:', result.data);
-  } catch (error) {
-    console.error('Error creating plugin:', error);
-  }
-}
-
-// Example: Update plugin settings
-async function updateSettings() {
-  try {
-    const result = await admin.settings.updateSettings({
-      pluginReviewEnabled: true,
-      publishPluginEnabled: true,
-    });
-
-    console.log('Settings updated:', result.data);
-  } catch (error) {
-    console.error('Error updating settings:', error);
-  }
-}
-```
-
-### M2M (Machine-to-Machine) Authentication
-
-For server-to-server authentication, you can use M2M authentication with client credentials:
-
-```typescript
-import { MarketAdmin, MarketSDK } from '@lobehub/market-sdk';
-
-// Using M2M authentication for Market SDK
-const market = new MarketSDK({
-  baseURL: 'https://market.lobehub.com/api',
-  clientId: 'your-client-id',
-  clientSecret: 'your-client-secret',
-  defaultLocale: 'en-US',
-});
-
-// Using M2M authentication for Admin SDK
-const admin = new MarketAdmin({
-  baseURL: 'https://market.lobehub.com/api',
-  clientId: 'your-client-id',
-  clientSecret: 'your-client-secret',
-});
-
-// The SDK will automatically handle token exchange
-async function useM2MAuthentication() {
-  try {
-    // For protected APIs that require authentication
-    const result = await market.plugins.reportInstallation({
-      identifier: 'plugin-id',
-      version: '1.0.0',
-      success: true,
-      installDurationMs: 1500,
-    });
-
-    console.log('Installation reported:', result);
-  } catch (error) {
-    console.error('Error with M2M authentication:', error);
-  }
-}
-```
-
-#### How M2M Authentication Works
-
-1. **Client Credentials**: You need to obtain `clientId` and `clientSecret` from the LobeHub Market administrator.
-
-2. **Automatic Token Exchange**: The SDK automatically:
-
-   - Creates a signed JWT using your client credentials
-   - Exchanges this JWT for an access token
-   - Uses the access token for authenticated API requests
-
-3. **Token Management**: The SDK handles token refresh automatically when needed.
-
-#### M2M vs API Key Authentication
-
-- **M2M Authentication**: More secure, uses JWT-based authentication with automatic token refresh
-- **API Key Authentication**: Simple but less secure, uses static API keys
-
-Choose M2M authentication for production environments and API keys for development/testing.
-
-## API Reference
-
-### MarketSDK Services
-
-#### plugins
-
-Methods for accessing plugin resources:
-
-- `getPluginList(params)`: Get a paginated list of plugins
-
-  ```typescript
-  market.plugins.getPluginList({
-    page: 1,
-    pageSize: 10,
-    locale: 'en-US',
-    category: 'tools',
-    searchKey: 'weather',
-    tags: ['api'],
-    sort: 'downloads',
-  });
-  ```
-
-- `getCategories()`: Get plugin categories
-
-  ```typescript
-  market.plugins.getCategories();
-  ```
-
-- `getPublishedIdentifiers()`: Get all published plugin identifiers
-
-  ```typescript
-  market.plugins.getPublishedIdentifiers();
-  ```
-
-- `getPluginManifest(params)`: Get a plugin's manifest
-
-  ```typescript
-  market.plugins.getPluginManifest({ id: 'plugin-id' });
-  ```
-
-- `getPluginDetail(params)`: Get detailed information about a plugin
-  ```typescript
-  market.plugins.getPluginDetail({ id: 'plugin-id' });
-  ```
-
-#### discovery
-
-- `getDiscoveryDocument()`: Get API capability information
-  ```typescript
-  market.discovery.getDiscoveryDocument();
-  ```
-
-### MarketAdmin Services
-
-#### plugins
-
-Methods for managing plugins:
-
-- `createPlugin(data)`: Create a new plugin
-- `updatePlugin(params, data)`: Update an existing plugin
-- `getPluginList(params)`: Get a list of plugins (admin view)
-- `getPluginDetail(params)`: Get detailed plugin information
-- `deletePlugin(params)`: Delete a plugin
-- `publishPlugin(params)`: Publish a plugin
-- `unpublishPlugin(params)`: Unpublish a plugin
-- `approvePlugin(params)`: Approve a plugin
-- `rejectPlugin(params)`: Reject a plugin
-
-#### reviews
-
-Methods for managing user reviews:
-
-- `getReviewList(params)`: Get a list of reviews
-- `createReview(data)`: Create a new review
-- `deleteReview(params)`: Delete a review
-- `approveReview(params)`: Approve a review
-- `rejectReview(params)`: Reject a review
-
-#### settings
-
-Methods for managing marketplace settings:
-
-- `getSettings()`: Get current marketplace settings
-- `updateSettings(data)`: Update marketplace settings
-
-#### dependencies
-
-Methods for managing system dependencies:
-
-- `getDependencyList(params)`: Get a list of system dependencies
-- `createDependency(data)`: Create a new system dependency
-- `updateDependency(params, data)`: Update an existing dependency
-- `deleteDependency(params)`: Delete a system dependency
-
-## TypeScript Support
-
-This SDK is written in TypeScript and provides comprehensive type definitions for all APIs. The types are automatically included when you install the package.
-
-## Error Handling
-
-The SDK throws standard errors with detailed information:
-
-```typescript
-try {
-  await market.plugins.getPluginList();
-} catch (error) {
-  console.error('Error code:', error.code);
-  console.error('Error message:', error.message);
-  console.error('Error details:', error.details);
-}
-```
-
-## Contributing
-
-We welcome contributions! Please see our [contributing guidelines](https://github.com/lobehub/lobehub-market/blob/main/CONTRIBUTING.md) for details.
-
-## License
-
-MIT