@lobehub/market-types 1.12.3 → 1.13.0

package/dist/index.d.mts

@@ -1226,4 +1226,291 @@ interface InstallLogEntry {
     version: string;
 }
 
-export { type AdminDeploymentOption, type AdminPluginItem, type AdminPluginItemDetail, AdminPluginItemSchema, type AdminSystemDependency, type AgentEventRequest, type AgentEventType, type AgentItem, type BasePluginItem, BasePluginItemSchema, type CallLogEntry, type CallReportRequest, type CallReportResponse, type CallStats, type CategoryItem, type CategoryListQuery, type CategoryListResponse, type CloudGatewayErrorResponse, type CloudGatewayRequest, type CloudGatewayResponse, 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, type McpToolContent, PluginCapabilitiesSchema, type PluginCompatibility, type PluginConnectionType, PluginConnectionTypeEnum, type PluginEventRequest, type PluginEventType, 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 };
+/**
+ * Skill Type Definitions
+ *
+ * This module defines types for skill entities in the marketplace.
+ * Skills are standalone packages that can be imported from GitHub,
+ * browsed, and downloaded.
+ */
+/**
+ * Skill author information
+ */
+interface SkillAuthor {
+    /** Author's display name */
+    name: string;
+    /** Author's URL (website, GitHub profile, etc.) */
+    url?: string;
+}
+/**
+ * GitHub metadata for skills
+ */
+interface SkillGitHubMeta {
+    /** Number of forks */
+    forks?: number;
+    /** Full repository name (owner/repo) */
+    fullName?: string;
+    /** Number of open issues */
+    openIssues?: number;
+    /** Number of GitHub stars */
+    stars?: number;
+    /** GitHub repository URL */
+    url?: string;
+    /** Number of watchers */
+    watchers?: number;
+}
+/**
+ * Skill license information
+ */
+interface SkillLicense {
+    /** License name (e.g., MIT, Apache-2.0) */
+    name: string;
+    /** URL to the license text */
+    url?: string;
+}
+/**
+ * Resource file metadata
+ */
+interface SkillResource {
+    /** SHA256 hash of the file */
+    fileHash: string;
+    /** File size in bytes */
+    size: number;
+}
+/**
+ * Skill manifest from SKILL.md frontmatter
+ */
+interface SkillManifest {
+    /** Author information */
+    author?: SkillAuthor;
+    /** Category */
+    category?: string;
+    /** Description */
+    description: string;
+    /** Icon URL or emoji */
+    icon?: string;
+    /** License identifier */
+    license?: string;
+    /** License URL */
+    licenseUrl?: string;
+    /** Skill name */
+    name: string;
+    /** GitHub repository URL */
+    repository?: string;
+    /** Original source URL */
+    sourceUrl?: string;
+    /** Short summary */
+    summary?: string;
+    /** Tags for categorization */
+    tags?: string[];
+    /** Version string */
+    version?: string;
+}
+/**
+ * Skill list item for marketplace listing
+ */
+interface SkillListItem {
+    /** Author name */
+    author?: string;
+    /** Category */
+    category?: string;
+    /** Creation timestamp (ISO string) */
+    createdAt: string;
+    /** Brief description */
+    description: string;
+    /** GitHub stats */
+    github?: {
+        forks?: number;
+        stars?: number;
+        watchers?: number;
+    };
+    /** Icon URL (GitHub org avatar) */
+    icon?: string;
+    /** Unique skill identifier */
+    identifier: string;
+    /** Install/download count */
+    installCount: number;
+    /** Whether the skill is featured */
+    isFeatured: boolean;
+    /** Whether the skill is validated */
+    isValidated: boolean;
+    /** License name */
+    license?: string;
+    /** Logo URL */
+    logo?: string;
+    /** Skill display name */
+    name: string;
+    /** Average rating */
+    ratingAvg?: number;
+    /** Number of ratings */
+    ratingCount: number;
+    /** Number of resources */
+    resourcesCount?: number;
+    /** Tags for discovery */
+    tags?: string[];
+    /** Last update timestamp (ISO string) */
+    updatedAt: string;
+    /** Current version string */
+    version: string;
+}
+/**
+ * Skill list response with pagination
+ */
+interface SkillListResponse {
+    /** Available categories */
+    categories: string[];
+    /** Current page number */
+    currentPage: number;
+    /** List of skills */
+    items: SkillListItem[];
+    /** Page size */
+    pageSize: number;
+    /** Total number of skills */
+    totalCount: number;
+    /** Total number of pages */
+    totalPages: number;
+}
+/**
+ * Skill version summary
+ */
+interface SkillVersionSummary {
+    /** Changelog for this version */
+    changelog?: string;
+    /** Creation timestamp (ISO string) */
+    createdAt: string;
+    /** Whether this is the latest version */
+    isLatest: boolean;
+    /** Whether this version has been validated */
+    isValidated?: boolean;
+    /** Version string */
+    version: string;
+    /** Version number */
+    versionNumber: number;
+}
+/**
+ * Detailed skill information
+ */
+interface SkillDetail {
+    /** Author information */
+    author?: SkillAuthor;
+    /** Category */
+    category?: string;
+    /** SKILL.md body content (markdown) */
+    content: string;
+    /** Creation timestamp (ISO string) */
+    createdAt: string;
+    /** Description */
+    description: string;
+    /** GitHub metadata */
+    github?: SkillGitHubMeta;
+    /** Homepage URL */
+    homepage?: string;
+    /** Icon URL (GitHub org avatar) */
+    icon?: string;
+    /** Unique skill identifier */
+    identifier: string;
+    /** Install/download count */
+    installCount: number;
+    /** Whether the skill is featured */
+    isFeatured: boolean;
+    /** Whether the skill is validated */
+    isValidated: boolean;
+    /** License information */
+    license?: SkillLicense;
+    /** Logo URL */
+    logo?: string;
+    /** Complete manifest from SKILL.md */
+    manifest: SkillManifest;
+    /** Skill display name */
+    name: string;
+    /** Overview information */
+    overview: {
+        summary?: string;
+    };
+    /** Average rating */
+    ratingAverage?: number;
+    /** Number of ratings */
+    ratingCount: number;
+    /** GitHub repository URL */
+    repository?: string;
+    /** Resource files: path -> metadata */
+    resources: Record<string, SkillResource>;
+    /** Tags */
+    tags?: string[];
+    /** Last update timestamp (ISO string) */
+    updatedAt: string;
+    /** Validation timestamp (ISO string) */
+    validatedAt?: string;
+    /** Current version string */
+    version: string;
+    /** Version number */
+    versionNumber: number;
+    /** All versions of this skill */
+    versions: SkillVersionSummary[];
+}
+/**
+ * Skill category with count
+ */
+interface SkillCategory {
+    /** Category name */
+    category: string;
+    /** Number of skills in this category */
+    count: number;
+}
+/**
+ * Query parameters for listing skills
+ */
+interface SkillListQuery {
+    /** Filter by category */
+    category?: string;
+    /** Locale for localized content (e.g., 'en-US', 'zh-CN') */
+    locale?: string;
+    /** Sort order */
+    order?: 'asc' | 'desc';
+    /** Page number (1-based) */
+    page?: number;
+    /** Number of items per page */
+    pageSize?: number;
+    /** Search query string */
+    search?: string;
+    /** Sort field */
+    sort?: 'createdAt' | 'forks' | 'installCount' | 'name' | 'stars' | 'updatedAt' | 'watchers';
+}
+/**
+ * Query parameters for skill detail
+ */
+interface SkillDetailQuery {
+    /** Locale for localized content */
+    locale?: string;
+    /** Specific version to retrieve */
+    version?: string;
+}
+/**
+ * Parameters for reporting a GitHub skill
+ */
+interface ReportGitHubSkillParams {
+    /** Branch name (optional) */
+    branch?: string;
+    /** GitHub repository URL */
+    gitUrl: string;
+}
+/**
+ * Response from reporting a GitHub skill
+ */
+interface ReportGitHubSkillResponse {
+    /** Skill identifier */
+    identifier: string;
+    /** Status message */
+    message: string;
+    /** Status: 'queued' for new import, 'exists' if skill already exists */
+    status: 'exists' | 'queued';
+}
+/**
+ * Response for skill versions list
+ */
+interface SkillVersionsResponse {
+    /** List of version summaries */
+    data: SkillVersionSummary[];
+}
+
+export { type AdminDeploymentOption, type AdminPluginItem, type AdminPluginItemDetail, AdminPluginItemSchema, type AdminSystemDependency, type AgentEventRequest, type AgentEventType, type AgentItem, type BasePluginItem, BasePluginItemSchema, type CallLogEntry, type CallReportRequest, type CallReportResponse, type CallStats, type CategoryItem, type CategoryListQuery, type CategoryListResponse, type CloudGatewayErrorResponse, type CloudGatewayRequest, type CloudGatewayResponse, 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, type McpToolContent, PluginCapabilitiesSchema, type PluginCompatibility, type PluginConnectionType, PluginConnectionTypeEnum, type PluginEventRequest, type PluginEventType, 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 ReportGitHubSkillParams, type ReportGitHubSkillResponse, type SkillAuthor, type SkillCategory, type SkillDetail, type SkillDetailQuery, type SkillGitHubMeta, type SkillLicense, type SkillListItem, type SkillListQuery, type SkillListResponse, type SkillManifest, type SkillResource, type SkillVersionSummary, type SkillVersionsResponse, type SystemDependency, type TopPlugin, type TopPluginsQuery };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/market-types",
-  "version": "1.12.3",
+  "version": "1.13.0",
   "keywords": [
     "lobehub",
     "market",
@@ -25,4 +25,4 @@
   "dependencies": {
     "zod": "^3.22.4"
   }
-}
+}