@lobehub/market-sdk 0.14.0 → 0.16.0

package/dist/index.d.mts

@@ -169,8 +169,12 @@ interface PluginVersionUpdateParams {
 interface PluginUpdateParams {
     /** Unique identifier for the plugin */
     identifier?: string;
+    /** Whether this plugin has been claimed by its original author */
+    isClaimed?: boolean;
     /** Whether this plugin is featured */
     isFeatured?: boolean;
+    /** Whether this plugin is officially maintained by LobeHub */
+    isOfficial?: boolean;
     /** Publication status */
     status?: 'published' | 'draft' | 'review' | 'rejected';
     /** Visibility level */
@@ -213,6 +217,16 @@ interface PluginI18nImportResponse {
     /** Total number of processed localizations */
     totalLocalizations: number;
 }
+/**
+ * Unclaimed plugin item data structure
+ * Represents a plugin that has not been claimed by its author
+ */
+interface UnclaimedPluginItem {
+    /** Plugin ID */
+    id: number;
+    /** Plugin identifier */
+    identifier: string;
+}
 
 /**
  * Market Service Discovery Document
@@ -291,8 +305,12 @@ interface PluginItem extends MarketItemBase {
     installCount?: number;
     /** Installation method required by the plugin's recommended deployment option */
     installationMethods?: string;
+    /** Whether this plugin has been claimed by its original author */
+    isClaimed?: boolean;
     /** Whether the plugin is featured */
     isFeatured?: boolean;
+    /** Whether this plugin is officially maintained by LobeHub */
+    isOfficial?: boolean;
     /** Whether this plugin has been validated */
     isValidated?: boolean;
     /** Number of prompts provided by this plugin */
@@ -400,6 +418,129 @@ declare class BaseSDK {
     clearAuthToken(): void;
 }
 
+/**
+ * Market Overview Statistics Interface
+ * Defines the structure for market overview data
+ */
+interface MarketOverviewStats {
+    installs: {
+        count: number;
+        prevCount: number;
+    };
+    newPlugins: {
+        count: number;
+        prevCount: number;
+    };
+    period: string;
+    plugins: {
+        count: number;
+        prevCount: number;
+    };
+    scores: {
+        avg: number;
+        prevAvg: number;
+    };
+}
+/**
+ * Period type for analysis queries
+ */
+type AnalysisPeriod = '1d' | '7d' | '30d';
+/**
+ * Market overview query parameters
+ */
+interface MarketOverviewQuery {
+    /** Analysis period: 1d, 7d, or 30d */
+    period?: AnalysisPeriod;
+}
+/**
+ * Analysis Management Service
+ *
+ * Provides administrative functionality for accessing market analysis and statistics.
+ * This service handles retrieving various analytics reports including market overview,
+ * plugin trends, and installation analytics for administrative dashboards.
+ */
+declare class AnalysisService extends BaseSDK {
+    /**
+     * Retrieves market overview statistics
+     *
+     * Returns comprehensive market statistics including plugin counts,
+     * installation metrics, new plugin trends, and rating averages
+     * with comparison to previous periods.
+     *
+     * @param params - Query parameters for the analysis
+     * @returns Promise resolving to market overview statistics
+     */
+    getMarketOverview(params?: MarketOverviewQuery): Promise<MarketOverviewStats>;
+    /**
+     * Retrieves market overview statistics for 1 day period
+     *
+     * Convenience method for getting daily market statistics.
+     *
+     * @returns Promise resolving to market overview statistics for 1 day
+     */
+    getDailyOverview(): Promise<MarketOverviewStats>;
+    /**
+     * Retrieves market overview statistics for 7 days period
+     *
+     * Convenience method for getting weekly market statistics.
+     *
+     * @returns Promise resolving to market overview statistics for 7 days
+     */
+    getWeeklyOverview(): Promise<MarketOverviewStats>;
+    /**
+     * Retrieves market overview statistics for 30 days period
+     *
+     * Convenience method for getting monthly market statistics.
+     *
+     * @returns Promise resolving to market overview statistics for 30 days
+     */
+    getMonthlyOverview(): Promise<MarketOverviewStats>;
+    /**
+     * Calculates growth rate between current and previous values
+     *
+     * Utility method for calculating percentage growth rates from the statistics.
+     *
+     * @param current - Current period value
+     * @param previous - Previous period value
+     * @returns Growth rate as percentage (e.g., 15.5 for 15.5% growth)
+     */
+    static calculateGrowthRate(current: number, previous: number): number;
+    /**
+     * Formats market overview statistics with calculated growth rates
+     *
+     * Utility method that enhances the raw statistics with calculated growth rates
+     * for easier consumption in dashboards and reports.
+     *
+     * @param stats - Raw market overview statistics
+     * @returns Enhanced statistics with growth rate calculations
+     */
+    static formatMarketOverview(stats: MarketOverviewStats): {
+        growth: {
+            installs: number;
+            newPlugins: number;
+            plugins: number;
+            scores: number;
+        };
+        installs: {
+            count: number;
+            prevCount: number;
+        };
+        newPlugins: {
+            count: number;
+            prevCount: number;
+        };
+        period: string;
+        plugins: {
+            count: number;
+            prevCount: number;
+        };
+        scores: {
+            avg: number;
+            prevAvg: number;
+        };
+    };
+}
+
 /**
  * Plugin Management Service
  *
@@ -468,6 +609,13 @@ declare class PluginService extends BaseSDK {
      * @returns Promise resolving to the detailed plugin information with version history
      */
     getPlugin(id: number | string): Promise<AdminPluginItemDetail>;
+    /**
+     * Retrieves a plugin by its GitHub repository URL
+     *
+     * @param githubUrl - The GitHub repository URL to search for
+     * @returns Promise resolving to the detailed plugin information with version history
+     */
+    getPluginByGithubUrl(githubUrl: string): Promise<AdminPluginItemDetail>;
     /**
      * Updates plugin information
      *
@@ -691,14 +839,21 @@ declare class PluginService extends BaseSDK {
         versionId: number;
     }[]>;
     /**
-     * 获取i18n不完整的插件列表
+     * Retrieves plugins with incomplete internationalization
      *
-     * 返回pluginVersionLocalizations只有1个条目的插件。
-     * 这些插件需要添加更多语言的本地化内容。
+     * Returns plugins where pluginVersionLocalizations has only 1 entry.
      *
-     * @returns Promise resolving to array of plugins with incomplete i18n
+     * @returns Promise resolving to an array of plugins with incomplete i18n
      */
     getIncompleteI18nPlugins(): Promise<IncompleteI18nPlugin[]>;
+    /**
+     * Retrieves unclaimed plugins
+     *
+     * Returns plugins where isClaimed is false, containing only ID and identifier.
+     *
+     * @returns Promise resolving to an array of unclaimed plugins with basic info
+     */
+    getUnclaimedPlugins(): Promise<UnclaimedPluginItem[]>;
 }
 
 /**
@@ -1057,6 +1212,11 @@ declare class PluginEnvService extends BaseSDK {
  * system settings, and dependencies. It requires admin-level authentication.
  */
 declare class MarketAdmin extends BaseSDK {
+    /**
+     * Market analysis service
+     * Provides methods for accessing market analytics and statistics
+     */
+    readonly analysis: AnalysisService;
     /**
      * Plugin management service
      * Provides methods for creating, updating, and managing plugins
@@ -1205,4 +1365,4 @@ declare class MarketSDK extends BaseSDK {
     getDiscoveryDocument(): Promise<DiscoveryDocument>;
 }
 
-export { type AdminListQueryParams, type AdminListResponse, type AdminPluginParams, type DiscoveryDocument, MarketAdmin, MarketSDK, type MarketSDKOptions, type PluginI18nImportParams, type PluginI18nImportResponse, type PluginItem, type PluginListResponse, type PluginLocalization, type PluginQueryParams, type PluginUpdateParams, type PluginVersionCreateParams, type PluginVersionUpdateParams, type ReviewStatus, ReviewStatusEnumSchema, StatusEnumSchema, VisibilityEnumSchema };
+export { type AdminListQueryParams, type AdminListResponse, type AdminPluginParams, type DiscoveryDocument, MarketAdmin, MarketSDK, type MarketSDKOptions, type PluginI18nImportParams, type PluginI18nImportResponse, type PluginItem, type PluginListResponse, type PluginLocalization, type PluginQueryParams, type PluginUpdateParams, type PluginVersionCreateParams, type PluginVersionUpdateParams, type ReviewStatus, ReviewStatusEnumSchema, StatusEnumSchema, type UnclaimedPluginItem, VisibilityEnumSchema };