@lobehub/market-types 1.11.2 → 1.11.4

package/dist/index.d.mts

@@ -1,172 +1,121 @@
 import { z } from 'zod';
 
 /**
- * Plugin Call Report Types
- *
- * This module defines the types for plugin call reporting functionality.
- * These types support users reporting their plugin method invocations to help improve
- * plugin performance monitoring and provide usage analytics.
- * These types are shared between the API server and client SDKs.
+ * Top Plugin Interface
+ * Unified interface for top plugins data
  */
+interface TopPlugin {
+    avatar: string;
+    /** Call count (when sortBy is 'calls') */
+    callCount?: number;
+    category: string;
+    identifier: string;
+    /** Install count (when sortBy is 'installs') */
+    installCount?: number;
+    name: string;
+}
 /**
- * Plugin method types
+ * Sort options for top plugins
  */
-type PluginMethodType = 'tool' | 'prompt' | 'resource';
+type PluginSortBy = 'installs' | 'calls';
 /**
- * Custom plugin information for non-marketplace plugins
+ * Top plugins query parameters
  */
-interface CustomPluginInfo {
-    avatar?: string;
-    /** Plugin description */
-    description?: string;
-    /** Plugin name/title */
-    name?: string;
+interface TopPluginsQuery {
+    /** Maximum number of plugins to return */
+    limit?: number;
+    /** Date range as [startDate, endDate] */
+    range: [string, string];
+    /** Sort criteria: 'installs' or 'calls' */
+    sortBy?: PluginSortBy;
 }
 /**
- * Call report request data
+ * Install Failure Analysis Interface
+ * Defines the structure for plugin install failure analysis data
  */
-interface CallReportRequest {
-    /** Call execution duration in milliseconds */
-    callDurationMs: number;
-    /** Client ID (optional, for M2M authentication) */
-    clientId?: string;
-    /** Client IP address (real user IP) */
-    clientIp?: string;
-    /** Custom plugin information (required if isCustomPlugin is true) */
-    customPluginInfo?: CustomPluginInfo;
-    /** Error code if call failed */
-    errorCode?: string;
-    /** Error message if call failed */
-    errorMessage?: string;
+interface InstallFailureAnalysis {
+    /** Number of failed installation attempts */
+    failureCount: number;
+    /** Failure rate as a decimal (e.g., 0.2736 for 27.36%) */
+    failureRate: number;
+    /** Most common error message for this plugin */
+    mostCommonError: string;
     /** Plugin identifier */
-    identifier: string;
-    /** Input parameters sent to the method */
-    inputParams?: any;
-    /** Whether this is a custom/local plugin (not from marketplace) */
-    isCustomPlugin?: boolean;
-    /** Additional metadata about the call */
-    metadata?: Record<string, any>;
-    /** Specific method name being called */
-    methodName: string;
-    /** Plugin method type (tool/prompt/resource) */
-    methodType: PluginMethodType;
-    /** Output/response from the method */
-    outputResult?: any;
-    /** Platform information */
-    platform?: string;
-    /** Request size in bytes */
-    requestSizeBytes?: number;
-    /** Response size in bytes */
-    responseSizeBytes?: number;
-    /** Session ID for correlating multiple calls */
-    sessionId?: string;
-    /** Whether the call was successful */
-    success: boolean;
-    /** Trace ID for distributed tracing */
-    traceId?: string;
-    /** User agent (real user agent) */
-    userAgent?: string;
-    /** Plugin version */
-    version: string;
+    pluginIdentifier: string;
+    /** Plugin display name */
+    pluginName: string;
+    /** Total number of installation attempts (successful + failed) */
+    totalInstallAttempts: number;
 }
 /**
- * Call report response data
+ * Install failure analysis query parameters
  */
-interface CallReportResponse {
-    /** Message about the processing result */
-    message: string;
-    /** Whether the report was successfully recorded */
-    success: boolean;
+interface InstallFailureAnalysisQuery {
+    /** Maximum number of plugins to return */
+    limit?: number;
+    /** Date range as [startDate, endDate] */
+    range: [string, string];
 }
+
 /**
- * Call statistics data
+ * Base structure for a single resource item in the marketplace.
+ * This interface defines the common properties shared by all marketplace items,
+ * including plugins, agents, and other resources.
  */
-interface CallStats {
-    /** Average call duration in milliseconds */
-    averageCallTime: number;
-    /** Call statistics by method type */
-    byMethodType: Record<PluginMethodType, {
-        averageCallTime: number;
-        failedCalls: number;
-        successRate: number;
-        successfulCalls: number;
-        totalCalls: number;
-    }>;
-    /** Statistics by plugin source (marketplace vs custom) */
-    byPluginSource: {
-        custom: {
-            averageCallTime: number;
-            successRate: number;
-            totalCalls: number;
-        };
-        marketplace: {
-            averageCallTime: number;
-            successRate: number;
-            totalCalls: number;
-        };
-    };
-    /** Number of failed calls */
-    failedCalls: number;
-    /** Success rate as percentage */
-    successRate: number;
-    /** Number of successful calls */
-    successfulCalls: number;
-    /** Most common call errors */
-    topErrors: Array<{
-        count: number;
-        errorCode: string;
-        errorMessage: string;
-    }>;
-    /** Most frequently called methods */
-    topMethods: Array<{
-        averageCallTime: number;
-        count: number;
-        methodName: string;
-        methodType: PluginMethodType;
-        successRate: number;
-    }>;
-    /** Total number of call attempts */
-    totalCalls: number;
+interface MarketItemBase {
+    /** Author or organization name */
+    author?: string;
+    /** Category name used for classification */
+    category?: string;
+    /** Optional: Compatibility information for different platforms or versions */
+    compatibility?: Record<string, any>;
+    /** Resource creation date in the marketplace (ISO 8601 format) */
+    createdAt: string;
+    /** Localized short description displayed in the marketplace listing */
+    description: string;
+    /** URL to the resource's homepage or documentation */
+    homepage?: string;
+    /** Icon URL or Emoji character */
+    icon?: string;
+    /** Globally unique identifier, typically contains author/namespace and name */
+    identifier: string;
+    /** URL pointing to the detailed manifest file for this resource */
+    manifestUrl: string;
+    /** Localized display name shown in the marketplace listing */
+    name: string;
+    /** List of localized tags for filtering and categorization */
+    tags?: string[];
+    /** Resource's last update date in the marketplace (ISO 8601 format) */
+    updatedAt: string;
 }
 /**
- * Call log entry data
+ * Category list request query parameters
+ *
+ * Query parameters for retrieving category statistics with optional filtering.
  */
-interface CallLogEntry {
-    /** Call execution duration in milliseconds */
-    callDurationMs: number;
-    /** When the log was created */
-    createdAt: string;
-    /** Custom plugin information */
-    customPluginInfo?: CustomPluginInfo | null;
-    /** Error code if failed */
-    errorCode?: string | null;
-    /** Error message if failed */
-    errorMessage?: string | null;
-    /** Log entry ID */
-    id: number;
-    /** Plugin identifier */
-    identifier: string;
-    /** Whether this is a custom plugin */
-    isCustomPlugin: boolean;
-    /** Method name */
-    methodName: string;
-    /** Plugin method type */
-    methodType: PluginMethodType;
-    /** Platform information */
-    platform?: string | null;
-    /** Request size in bytes */
-    requestSizeBytes?: number | null;
-    /** Response size in bytes */
-    responseSizeBytes?: number | null;
-    /** Session ID */
-    sessionId?: string | null;
-    /** Whether call was successful */
-    success: boolean;
-    /** Trace ID */
-    traceId?: string | null;
-    /** Plugin version */
-    version: string;
+interface CategoryListQuery {
+    /** Optional locale for localized search, defaults to 'en-US' */
+    locale?: string;
+    /** Optional search query to filter plugins before counting categories */
+    q?: string;
+}
+/**
+ * Single category item with plugin count
+ *
+ * Represents a category and the number of plugins in that category.
+ */
+interface CategoryItem {
+    /** Category name */
+    category: string;
+    /** Number of plugins in this category */
+    count: number;
 }
+/**
+ * Category list response type
+ *
+ * Array of categories with their respective plugin counts.
+ */
+type CategoryListResponse = CategoryItem[];
 
 /**
  * Connection types for plugin communication.
@@ -259,66 +208,6 @@ interface DeploymentOption {
     systemDependencies?: SystemDependency[];
 }
 
-/**
- * Base structure for a single resource item in the marketplace.
- * This interface defines the common properties shared by all marketplace items,
- * including plugins, agents, and other resources.
- */
-interface MarketItemBase {
-    /** Author or organization name */
-    author?: string;
-    /** Category name used for classification */
-    category?: string;
-    /** Optional: Compatibility information for different platforms or versions */
-    compatibility?: Record<string, any>;
-    /** Resource creation date in the marketplace (ISO 8601 format) */
-    createdAt: string;
-    /** Localized short description displayed in the marketplace listing */
-    description: string;
-    /** URL to the resource's homepage or documentation */
-    homepage?: string;
-    /** Icon URL or Emoji character */
-    icon?: string;
-    /** Globally unique identifier, typically contains author/namespace and name */
-    identifier: string;
-    /** URL pointing to the detailed manifest file for this resource */
-    manifestUrl: string;
-    /** Localized display name shown in the marketplace listing */
-    name: string;
-    /** List of localized tags for filtering and categorization */
-    tags?: string[];
-    /** Resource's last update date in the marketplace (ISO 8601 format) */
-    updatedAt: string;
-}
-/**
- * Category list request query parameters
- *
- * Query parameters for retrieving category statistics with optional filtering.
- */
-interface CategoryListQuery {
-    /** Optional locale for localized search, defaults to 'en-US' */
-    locale?: string;
-    /** Optional search query to filter plugins before counting categories */
-    q?: string;
-}
-/**
- * Single category item with plugin count
- *
- * Represents a category and the number of plugins in that category.
- */
-interface CategoryItem {
-    /** Category name */
-    category: string;
-    /** Number of plugins in this category */
-    count: number;
-}
-/**
- * Category list response type
- *
- * Array of categories with their respective plugin counts.
- */
-type CategoryListResponse = CategoryItem[];
-
 /**
  * Schema defining the capabilities a plugin can provide.
  * Each capability is represented as a boolean flag.
@@ -959,6 +848,174 @@ interface RangeQuery {
     range: [string, string];
 }
 
+/**
+ * Plugin Call Report Types
+ *
+ * This module defines the types for plugin call reporting functionality.
+ * These types support users reporting their plugin method invocations to help improve
+ * plugin performance monitoring and provide usage analytics.
+ * These types are shared between the API server and client SDKs.
+ */
+/**
+ * Plugin method types
+ */
+type PluginMethodType = 'tool' | 'prompt' | 'resource';
+/**
+ * Custom plugin information for non-marketplace plugins
+ */
+interface CustomPluginInfo {
+    avatar?: string;
+    /** Plugin description */
+    description?: string;
+    /** Plugin name/title */
+    name?: string;
+}
+/**
+ * Call report request data
+ */
+interface CallReportRequest {
+    /** Call execution duration in milliseconds */
+    callDurationMs: number;
+    /** Client ID (optional, for M2M authentication) */
+    clientId?: string;
+    /** Client IP address (real user IP) */
+    clientIp?: string;
+    /** Custom plugin information (required if isCustomPlugin is true) */
+    customPluginInfo?: CustomPluginInfo;
+    /** Error code if call failed */
+    errorCode?: string;
+    /** Error message if call failed */
+    errorMessage?: string;
+    /** Plugin identifier */
+    identifier: string;
+    /** Input parameters sent to the method */
+    inputParams?: any;
+    /** Whether this is a custom/local plugin (not from marketplace) */
+    isCustomPlugin?: boolean;
+    /** Additional metadata about the call */
+    metadata?: Record<string, any>;
+    /** Specific method name being called */
+    methodName: string;
+    /** Plugin method type (tool/prompt/resource) */
+    methodType: PluginMethodType;
+    /** Output/response from the method */
+    outputResult?: any;
+    /** Platform information */
+    platform?: string;
+    /** Request size in bytes */
+    requestSizeBytes?: number;
+    /** Response size in bytes */
+    responseSizeBytes?: number;
+    /** Session ID for correlating multiple calls */
+    sessionId?: string;
+    /** Whether the call was successful */
+    success: boolean;
+    /** Trace ID for distributed tracing */
+    traceId?: string;
+    /** User agent (real user agent) */
+    userAgent?: string;
+    /** Plugin version */
+    version: string;
+}
+/**
+ * Call report response data
+ */
+interface CallReportResponse {
+    /** Message about the processing result */
+    message: string;
+    /** Whether the report was successfully recorded */
+    success: boolean;
+}
+/**
+ * Call statistics data
+ */
+interface CallStats {
+    /** Average call duration in milliseconds */
+    averageCallTime: number;
+    /** Call statistics by method type */
+    byMethodType: Record<PluginMethodType, {
+        averageCallTime: number;
+        failedCalls: number;
+        successRate: number;
+        successfulCalls: number;
+        totalCalls: number;
+    }>;
+    /** Statistics by plugin source (marketplace vs custom) */
+    byPluginSource: {
+        custom: {
+            averageCallTime: number;
+            successRate: number;
+            totalCalls: number;
+        };
+        marketplace: {
+            averageCallTime: number;
+            successRate: number;
+            totalCalls: number;
+        };
+    };
+    /** Number of failed calls */
+    failedCalls: number;
+    /** Success rate as percentage */
+    successRate: number;
+    /** Number of successful calls */
+    successfulCalls: number;
+    /** Most common call errors */
+    topErrors: Array<{
+        count: number;
+        errorCode: string;
+        errorMessage: string;
+    }>;
+    /** Most frequently called methods */
+    topMethods: Array<{
+        averageCallTime: number;
+        count: number;
+        methodName: string;
+        methodType: PluginMethodType;
+        successRate: number;
+    }>;
+    /** Total number of call attempts */
+    totalCalls: number;
+}
+/**
+ * Call log entry data
+ */
+interface CallLogEntry {
+    /** Call execution duration in milliseconds */
+    callDurationMs: number;
+    /** When the log was created */
+    createdAt: string;
+    /** Custom plugin information */
+    customPluginInfo?: CustomPluginInfo | null;
+    /** Error code if failed */
+    errorCode?: string | null;
+    /** Error message if failed */
+    errorMessage?: string | null;
+    /** Log entry ID */
+    id: number;
+    /** Plugin identifier */
+    identifier: string;
+    /** Whether this is a custom plugin */
+    isCustomPlugin: boolean;
+    /** Method name */
+    methodName: string;
+    /** Plugin method type */
+    methodType: PluginMethodType;
+    /** Platform information */
+    platform?: string | null;
+    /** Request size in bytes */
+    requestSizeBytes?: number | null;
+    /** Response size in bytes */
+    responseSizeBytes?: number | null;
+    /** Session ID */
+    sessionId?: string | null;
+    /** Whether call was successful */
+    success: boolean;
+    /** Trace ID */
+    traceId?: string | null;
+    /** Plugin version */
+    version: string;
+}
+
 /**
  * Plugin Install Report Types
  *
@@ -1056,4 +1113,4 @@ interface InstallLogEntry {
     version: string;
 }
 
-export { type AdminDeploymentOption, type AdminPluginItem, type AdminPluginItemDetail, AdminPluginItemSchema, type AdminSystemDependency, type BasePluginItem, BasePluginItemSchema, type CallLogEntry, type CallReportRequest, type CallReportResponse, type CallStats, type CategoryItem, type CategoryListQuery, type CategoryListResponse, type ConnectionConfig, type ConnectionType, ConnectionTypeEnum, type CustomPluginInfo, type DeploymentOption, type IncompleteI18nPlugin, type InstallLogEntry, type InstallReportRequest, type InstallReportResponse, type InstallStats, type InstallationDetails, type InstallationMethod, InstallationMethodEnum, type MarketItemBase, type MarketPluginItem, PluginCapabilitiesSchema, type PluginCompatibility, type PluginConnectionType, PluginConnectionTypeEnum, type PluginItemDetail, type PluginManifest, type PluginMethodType, type PluginPrompt, type PluginResource, type PluginTool, type PluginVersion, type PluginVersionLocalization, type PluginVersionSummary, type PromptArgument, type RangeDataPoint, type RangeQuery, type RangeStats, type SystemDependency };
+export { type AdminDeploymentOption, type AdminPluginItem, type AdminPluginItemDetail, AdminPluginItemSchema, type AdminSystemDependency, type BasePluginItem, BasePluginItemSchema, type CallLogEntry, type CallReportRequest, type CallReportResponse, type CallStats, type CategoryItem, type CategoryListQuery, type CategoryListResponse, type ConnectionConfig, type ConnectionType, ConnectionTypeEnum, type CustomPluginInfo, type DeploymentOption, type IncompleteI18nPlugin, type InstallFailureAnalysis, type InstallFailureAnalysisQuery, type InstallLogEntry, type InstallReportRequest, type InstallReportResponse, type InstallStats, type InstallationDetails, type InstallationMethod, InstallationMethodEnum, type MarketItemBase, type MarketPluginItem, PluginCapabilitiesSchema, type PluginCompatibility, type PluginConnectionType, PluginConnectionTypeEnum, type PluginItemDetail, type PluginManifest, type PluginMethodType, type PluginPrompt, type PluginResource, type PluginSortBy, type PluginTool, type PluginVersion, type PluginVersionLocalization, type PluginVersionSummary, type PromptArgument, type RangeDataPoint, type RangeQuery, type RangeStats, type SystemDependency, type TopPlugin, type TopPluginsQuery };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/market-types",
-  "version": "1.11.2",
+  "version": "1.11.4",
   "keywords": [
     "lobehub",
     "market",