@lobehub/market-sdk 0.15.0 → 0.16.0

package/dist/index.d.mts

@@ -418,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
  *
@@ -1089,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