@lobehub/market-sdk 0.15.0 → 0.17.0

package/dist/index.d.mts

@@ -1,5 +1,4 @@
 import { MarketItemBase, PluginConnectionType, PluginManifest, AdminPluginItem, AdminPluginItemDetail, PluginVersion, PluginVersionLocalization, AdminDeploymentOption, InstallationDetails, SystemDependency, IncompleteI18nPlugin, CategoryListQuery, CategoryItem, PluginItemDetail } from '@lobehub/market-types';
-export * from '@lobehub/market-types';
 export { CategoryItem, CategoryListQuery, CategoryListResponse } from '@lobehub/market-types';
 import { z } from 'zod';
 
@@ -227,6 +226,43 @@ interface UnclaimedPluginItem {
     /** Plugin identifier */
     identifier: string;
 }
+/**
+ * Range Data Point Interface
+ * Defines the structure for daily trend data points
+ */
+interface RangeDataPoint$1 {
+    /** Date in YYYY-MM-DD format */
+    date: string;
+    /** Current period count */
+    count: number;
+    /** Previous period count for comparison */
+    prevCount: number;
+}
+/**
+ * Range Statistics Interface
+ * Defines the structure for range-based statistics
+ */
+interface RangeStats$1 {
+    /** Array of daily data points */
+    data: RangeDataPoint$1[];
+    /** Total sum for current period */
+    sum: number;
+    /** Total sum for previous period */
+    prevSum: number;
+    /** Display configuration */
+    display: string;
+}
+/**
+ * Range query parameters for trend analysis
+ */
+interface RangeQuery$1 {
+    /** Display configuration */
+    display: string;
+    /** Date range as [startDate, endDate] */
+    range: [string, string];
+    /** Optional previous period range for comparison */
+    prevRange?: [string, string];
+}
 
 /**
  * Market Service Discovery Document
@@ -418,6 +454,188 @@ 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;
+}
+/**
+ * Range Data Point Interface
+ * Defines the structure for daily trend data points
+ */
+interface RangeDataPoint {
+    count: number;
+    date: string;
+    prevCount: number;
+}
+/**
+ * Range Statistics Interface
+ * Defines the structure for range-based statistics
+ */
+interface RangeStats {
+    data: RangeDataPoint[];
+    display: string;
+    prevSum: number;
+    sum: number;
+}
+/**
+ * Range query parameters for trend analysis
+ */
+interface RangeQuery {
+    /** Display configuration */
+    display: string;
+    /** Optional previous period range for comparison */
+    prevRange?: [string, string];
+    /** Date range as [startDate, endDate] */
+    range: [string, string];
+}
+/**
+ * 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;
+        };
+    };
+    /**
+     * Retrieves installation trend statistics for a specified date range
+     *
+     * Returns daily installation counts and trends for the specified period
+     * with optional comparison to a previous period.
+     *
+     * @param params - Query parameters including date range and display config
+     * @returns Promise resolving to installation trend statistics
+     */
+    getRangeInstalls(params: RangeQuery): Promise<RangeStats>;
+    /**
+     * Retrieves plugin growth trend statistics for a specified date range
+     *
+     * Returns daily plugin creation counts and trends for the specified period
+     * with optional comparison to a previous period.
+     *
+     * @param params - Query parameters including date range and display config
+     * @returns Promise resolving to plugin growth trend statistics
+     */
+    getRangePlugins(params: RangeQuery): Promise<RangeStats>;
+    /**
+     * Calculates trend growth rate between current and previous period totals
+     *
+     * Utility method for calculating percentage growth rates from range statistics.
+     *
+     * @param stats - Range statistics with sum and prevSum
+     * @returns Growth rate as percentage (e.g., 15.5 for 15.5% growth)
+     */
+    static calculateTrendGrowthRate(stats: RangeStats): number;
+}
+
 /**
  * Plugin Management Service
  *
@@ -1089,6 +1307,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
@@ -1237,4 +1460,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, type UnclaimedPluginItem, 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 RangeDataPoint$1 as RangeDataPoint, type RangeQuery$1 as RangeQuery, type RangeStats$1 as RangeStats, type ReviewStatus, ReviewStatusEnumSchema, StatusEnumSchema, type UnclaimedPluginItem, VisibilityEnumSchema };