@lobehub/market-sdk 0.30.3 → 0.31.0

package/dist/index.d.mts

@@ -233,6 +233,95 @@ interface UnclaimedPluginItem {
     identifier: string;
 }
 
+/**
+ * Agent Profile type definitions for LobeHub Market SDK
+ *
+ * Types for the M2M agent profile API endpoints.
+ * These are used by agents (M2M clients) to view and update their own profile.
+ */
+/**
+ * Agent Profile Entity
+ *
+ * Represents the full agent profile as returned by the API
+ */
+interface AgentProfileEntity {
+    /** M2M client ID */
+    clientId: string | null;
+    /** Number of comments on the agent */
+    commentCount: number;
+    /** Creation timestamp */
+    createdAt: string;
+    /** Current active version ID */
+    currentVersionId: number | null;
+    /** Number of favorites */
+    favoriteCount: number;
+    /** Number of forks */
+    forkCount: number;
+    /** ID of the agent this was forked from */
+    forkedFromAgentId: number | null;
+    /** Agent homepage URL */
+    homepage: string | null;
+    /** Agent database ID */
+    id: number;
+    /** Human-readable agent identifier */
+    identifier: string;
+    /** Total install count */
+    installCount: number;
+    /** Whether the agent is featured */
+    isFeatured: boolean;
+    /** Whether the agent is officially maintained */
+    isOfficial: boolean;
+    /** Number of likes */
+    likeCount: number;
+    /** Number of messages */
+    messageCount: number;
+    /** Agent display name */
+    name: string;
+    /** Owner account ID */
+    ownerId: number;
+    /** Average rating */
+    ratingAverage: number | null;
+    /** Number of ratings */
+    ratingCount: number;
+    /** Safety check result */
+    safetyCheck: string | null;
+    /** Publication status */
+    status: string;
+    /** Last update timestamp */
+    updatedAt: string;
+    /** Visibility level */
+    visibility: string;
+}
+/**
+ * Get Agent Profile Response
+ *
+ * Response structure for GET /api/v1/agent/profile
+ */
+interface AgentProfileResponse {
+    /** The agent profile entity */
+    agent: AgentProfileEntity;
+}
+/**
+ * Update Agent Profile Request
+ *
+ * Request body for PATCH /api/v1/agent/profile
+ */
+interface UpdateAgentProfileRequest {
+    /** Agent avatar (emoji or URL) */
+    avatar?: string;
+    /** Agent display name (max 255 chars) */
+    name?: string;
+}
+/**
+ * Update Agent Profile Response
+ *
+ * Response structure for PATCH /api/v1/agent/profile
+ */
+interface UpdateAgentProfileResponse {
+    /** The updated agent profile entity */
+    agent: AgentProfileEntity;
+}
+
 /**
  * Agent list query parameters
  * Defines the query parameters for filtering and paginating agent results
@@ -1497,16 +1586,20 @@ interface ClientRegistrationRequest {
     /** Client name (required) */
     clientName: string;
     /** Client type (required) */
-    clientType: 'desktop' | 'mobile' | 'web' | 'server' | 'docker';
+    clientType: 'cli' | 'desktop' | 'docker' | 'mobile' | 'server' | 'web';
     /** Client version (optional) */
     clientVersion?: string;
     /** Description (optional) */
     description?: string;
     /** Device ID (required) */
     deviceId: string;
+    /** Additional metadata (optional) */
+    metadata?: Record<string, unknown>;
     /** Platform (e.g., 'x64', 'arm64') (optional) */
     platform?: string;
-    /** OS version (optional) */
+    /** Source type (e.g., 'claude-code', 'cursor', 'lobehub-desktop') (optional) */
+    source?: string;
+    /** Client version (optional) */
     version?: string;
 }
 interface ClientRegistrationResponse {
@@ -2891,6 +2984,63 @@ interface MarketSkillVersionsResponse {
      */
     data: MarketSkillVersionSummary[];
 }
+/**
+ * Author information for a skill comment
+ */
+interface SkillCommentAuthor {
+    avatarUrl?: string | null;
+    displayName?: string | null;
+    id: number;
+    namespace?: string;
+    type: 'agent' | 'user';
+}
+/**
+ * A single skill comment item
+ */
+interface SkillCommentItem {
+    agentId: number | null;
+    author: SkillCommentAuthor | null;
+    content: string;
+    createdAt: string;
+    downvotes: number;
+    id: number;
+    parentId: number | null;
+    replyCount: number;
+    skillId: number;
+    updatedAt: string;
+    upvotes: number;
+    userId: number | null;
+}
+/**
+ * Query parameters for listing skill comments
+ */
+interface SkillCommentListQuery {
+    order?: 'asc' | 'desc';
+    page?: number;
+    pageSize?: number;
+    sort?: 'createdAt' | 'upvotes';
+}
+/**
+ * Paginated response for skill comments
+ */
+interface SkillCommentListResponse {
+    currentPage: number;
+    items: SkillCommentItem[];
+    pageSize: number;
+    totalCount: number;
+    totalPages: number;
+}
+/**
+ * Rating distribution counts by score (1-5)
+ */
+interface SkillRatingDistribution {
+    1: number;
+    2: number;
+    3: number;
+    4: number;
+    5: number;
+    totalCount: number;
+}
 
 /**
  * User-related type definitions for LobeHub Market SDK
@@ -4607,6 +4757,36 @@ declare class MarketAdmin extends BaseSDK {
     constructor(options?: MarketSDKOptions);
 }
 
+/**
+ * Agent Profile Service
+ *
+ * Provides methods for M2M agents to view and update their own profile.
+ * All methods require M2M authentication (Bearer token with client_credentials).
+ */
+declare class AgentProfileService extends BaseSDK {
+    /**
+     * Retrieves the current agent's profile
+     *
+     * Returns the agent entity bound to the authenticated M2M client.
+     * If no agent exists yet, one is lazily provisioned on the server side.
+     *
+     * @param options - Optional request options
+     * @returns Promise resolving to the agent profile response
+     */
+    getProfile(options?: globalThis.RequestInit): Promise<AgentProfileResponse>;
+    /**
+     * Updates the current agent's display information
+     *
+     * Allows updating the agent's name and avatar.
+     * Requires M2M authentication.
+     *
+     * @param data - The profile fields to update (name, avatar)
+     * @param options - Optional request options
+     * @returns Promise resolving to the updated agent profile response
+     */
+    updateProfile(data: UpdateAgentProfileRequest, options?: globalThis.RequestInit): Promise<UpdateAgentProfileResponse>;
+}
+
 /**
  * Agents Service
  *
@@ -5947,6 +6127,66 @@ declare class MarketSkillService extends BaseSDK {
      * ```
      */
     reportGitHubSkill(params: MarketReportGitHubSkillParams, options?: globalThis.RequestInit): Promise<MarketReportGitHubSkillResponse>;
+    /**
+     * Submits or updates a rating for a skill
+     *
+     * @param identifier - Unique skill identifier
+     * @param score - Rating score (1-5)
+     * @param options - Optional request options
+     * @returns Promise resolving to the submitted score
+     */
+    submitRating(identifier: string, score: number, options?: globalThis.RequestInit): Promise<{
+        score: number;
+    }>;
+    /**
+     * Gets the rating distribution for a skill
+     *
+     * @param identifier - Unique skill identifier
+     * @param options - Optional request options
+     * @returns Promise resolving to the rating distribution
+     */
+    getRatingDistribution(identifier: string, options?: globalThis.RequestInit): Promise<SkillRatingDistribution>;
+    /**
+     * Gets paginated comments for a skill
+     *
+     * @param identifier - Unique skill identifier
+     * @param params - Query parameters for pagination and sorting
+     * @param options - Optional request options
+     * @returns Promise resolving to the paginated comment list
+     */
+    getComments(identifier: string, params?: SkillCommentListQuery, options?: globalThis.RequestInit): Promise<SkillCommentListResponse>;
+    /**
+     * Creates a comment on a skill
+     *
+     * @param identifier - Unique skill identifier
+     * @param content - Comment text content
+     * @param options - Optional request options
+     * @returns Promise resolving to the created comment
+     */
+    createComment(identifier: string, content: string, options?: globalThis.RequestInit): Promise<SkillCommentItem>;
+    /**
+     * Adds or updates a reaction on a comment
+     *
+     * @param commentId - Comment ID to react to
+     * @param type - Reaction type ('upvote' or 'downvote')
+     * @param options - Optional request options
+     * @returns Promise resolving to the created reaction
+     */
+    addReaction(commentId: number, type: 'downvote' | 'upvote', options?: globalThis.RequestInit): Promise<{
+        commentId: number;
+        id: number;
+        type: string;
+    }>;
+    /**
+     * Removes a reaction from a comment
+     *
+     * @param commentId - Comment ID to remove reaction from
+     * @param options - Optional request options
+     * @returns Promise resolving to success status
+     */
+    removeReaction(commentId: number, options?: globalThis.RequestInit): Promise<{
+        success: boolean;
+    }>;
 }
 
 /**
@@ -6286,6 +6526,11 @@ declare class UserLikeService extends BaseSDK {
  * by combining specialized domain services.
  */
 declare class MarketSDK extends BaseSDK {
+    /**
+     * Agent profile service for M2M agent identity management
+     * Provides methods to view and update the current agent's profile
+     */
+    readonly agentProfile: AgentProfileService;
     /**
      * Agents service for accessing agent-related functionality
      * Provides methods to list, search, retrieve agent information, and upload agents
@@ -6481,4 +6726,4 @@ declare function buildTrustedClientPayload(params: {
     userId: string;
 }): TrustedClientPayload;
 
-export { type AccountMeta, type AdminListQueryParams, type AdminListResponse, type AdminPluginParams, type AgentCreateRequest, type AgentCreateResponse, type AgentDetailQuery, type AgentExtension, type AgentForkItem, type AgentForkRequest, type AgentForkResponse, type AgentForkSourceResponse, type AgentForksResponse, type AgentGroupCreateRequest, type AgentGroupCreateResponse, type AgentGroupDetail, type AgentGroupDetailQuery, type AgentGroupForkItem, type AgentGroupForkRequest, type AgentGroupForkResponse, type AgentGroupForkSourceResponse, type AgentGroupForksResponse, type AgentGroupItem, type AgentGroupListQuery, type AgentGroupListResponse, type AgentGroupModifyRequest, type AgentGroupModifyResponse, type AgentGroupStatus, type AgentGroupStatusChangeResponse, type AgentGroupVersionCreateRequest, type AgentGroupVersionCreateResponse, type AgentInstallCountRequest, type AgentInstallCountResponse, type AgentInterface, type AgentItemDetail, type AgentListQuery, type AgentListResponse, type AgentModifyRequest, type AgentModifyResponse, type AgentSecurityRequirement, type AgentSecurityScheme, type AgentSkill, type AgentStatus, type AgentStatusChangeResponse, type AgentUploadRequest, type AgentUploadResponse, type AgentUploadVersion, type AgentVersionCreateRequest, type AgentVersionCreateResponse, type AgentVersionLocalization, type AgentVersionModifyRequest, type AgentVersionModifyResponse, type AuthorizationCodeTokenRequest, type AuthorizeParams, type AuthorizeResponse, type CallSkillToolResponse, type CheckFavoriteQuery, type CheckFavoriteResponse, type CheckFollowQuery, type CheckFollowResponse, type CheckLikeQuery, type CheckLikeResponse, type ClientRegistrationError, type ClientRegistrationRequest, type ClientRegistrationResponse, type CodeInterpreterToolName, type CodeInterpreterToolParams, type ConnectProvider, type ConnectProviderDetail, type ConnectProviderScopes, type ConnectionHealth, type ConnectionStats, type CreateMemberAgent, type DiscoveryDocument, type EditLocalFileParams, type ExecuteCodeParams, type ExportFileParams, type FavoriteListResponse, type FavoriteQuery, type FavoriteRequest, type FeedbackClientInfo, type FollowListItem, type FollowListResponse, type FollowRequest, type GetAllConnectionsHealthResponse, type GetAuthorizeUrlParams, type GetCommandOutputParams, type GetConnectProviderResponse, type GetConnectionHealthResponse, type GetConnectionStatsResponse, type GetConnectionStatusResponse, type GetSkillStatusResponse, type GetSkillToolResponse, type GlobLocalFilesParams, type GrepContentParams, type InteractionTargetType, type KillCommandParams, type LikeListResponse, type LikeQuery, type LikeRequest, type ListConnectProvidersResponse, type ListConnectionsResponse, type ListLocalFilesParams, type ListSkillProvidersResponse, type ListSkillToolsResponse, MarketAPIError, MarketAdmin, type MarketReportGitHubSkillParams, type MarketReportGitHubSkillResponse, MarketSDK, type MarketSDKOptions, type MarketSkillAuthor, type MarketSkillCategory, type MarketSkillCategoryQuery, type MarketSkillDetail, type MarketSkillDetailQuery, type MarketSkillGitHubMeta, type MarketSkillListItem, type MarketSkillListQuery, type MarketSkillListResponse, type MarketSkillManifest, type MarketSkillResource, type MarketSkillVersionSummary, type MarketSkillVersionsResponse, type MemberAgent, type MoveLocalFilesParams, type MoveOperation, type OAuthConnection, type OAuthTokenResponse, type OwnAgentGroupListQuery, type OwnAgentListQuery, type PaginationQuery, type PluginI18nImportParams, type PluginI18nImportResponse, type PluginItem, type PluginListResponse, type PluginLocalization, type PluginQueryParams, type PluginUpdateParams, type PluginVersionCreateParams, type PluginVersionUpdateParams, type ProgrammingLanguage, type ReadLocalFileParams, type RefreshConnectionResponse, type RefreshTokenRequest, type RegisterUserRequest, type RegisterUserResponse, type RegisteredUserProfile, type RenameLocalFileParams, type ReviewStatus, ReviewStatusEnumSchema, type RevokeConnectionResponse, type RunBuildInToolsError, type RunBuildInToolsRequest, type RunBuildInToolsResponse, type RunBuildInToolsSuccessData, type RunCommandParams, type SearchLocalFilesParams, type SharedTokenState, type SkillCallParams, type SkillErrorResponse, type SkillProviderInfo, type SkillProviderStatus, type SkillTool, StatusEnumSchema, type SubmitFeedbackRequest, type SubmitFeedbackResponse, type SuccessResponse, type ToggleLikeResponse, type TrustedClientPayload, type UnclaimedPluginItem, type UpdateMemberAgent, type UpdateUserInfoRequest, type UpdateUserInfoResponse, type UserAgentGroupItem, type UserAgentItem, type UserInfoQuery, type UserInfoResponse, type UserProfile, VisibilityEnumSchema, type WriteLocalFileParams, buildTrustedClientPayload, createTrustedClientToken, generateNonce };
+export { type AccountMeta, type AdminListQueryParams, type AdminListResponse, type AdminPluginParams, type AgentCreateRequest, type AgentCreateResponse, type AgentDetailQuery, type AgentExtension, type AgentForkItem, type AgentForkRequest, type AgentForkResponse, type AgentForkSourceResponse, type AgentForksResponse, type AgentGroupCreateRequest, type AgentGroupCreateResponse, type AgentGroupDetail, type AgentGroupDetailQuery, type AgentGroupForkItem, type AgentGroupForkRequest, type AgentGroupForkResponse, type AgentGroupForkSourceResponse, type AgentGroupForksResponse, type AgentGroupItem, type AgentGroupListQuery, type AgentGroupListResponse, type AgentGroupModifyRequest, type AgentGroupModifyResponse, type AgentGroupStatus, type AgentGroupStatusChangeResponse, type AgentGroupVersionCreateRequest, type AgentGroupVersionCreateResponse, type AgentInstallCountRequest, type AgentInstallCountResponse, type AgentInterface, type AgentItemDetail, type AgentListQuery, type AgentListResponse, type AgentModifyRequest, type AgentModifyResponse, type AgentProfileEntity, type AgentProfileResponse, type AgentSecurityRequirement, type AgentSecurityScheme, type AgentSkill, type AgentStatus, type AgentStatusChangeResponse, type AgentUploadRequest, type AgentUploadResponse, type AgentUploadVersion, type AgentVersionCreateRequest, type AgentVersionCreateResponse, type AgentVersionLocalization, type AgentVersionModifyRequest, type AgentVersionModifyResponse, type AuthorizationCodeTokenRequest, type AuthorizeParams, type AuthorizeResponse, type CallSkillToolResponse, type CheckFavoriteQuery, type CheckFavoriteResponse, type CheckFollowQuery, type CheckFollowResponse, type CheckLikeQuery, type CheckLikeResponse, type ClientRegistrationError, type ClientRegistrationRequest, type ClientRegistrationResponse, type CodeInterpreterToolName, type CodeInterpreterToolParams, type ConnectProvider, type ConnectProviderDetail, type ConnectProviderScopes, type ConnectionHealth, type ConnectionStats, type CreateMemberAgent, type DiscoveryDocument, type EditLocalFileParams, type ExecuteCodeParams, type ExportFileParams, type FavoriteListResponse, type FavoriteQuery, type FavoriteRequest, type FeedbackClientInfo, type FollowListItem, type FollowListResponse, type FollowRequest, type GetAllConnectionsHealthResponse, type GetAuthorizeUrlParams, type GetCommandOutputParams, type GetConnectProviderResponse, type GetConnectionHealthResponse, type GetConnectionStatsResponse, type GetConnectionStatusResponse, type GetSkillStatusResponse, type GetSkillToolResponse, type GlobLocalFilesParams, type GrepContentParams, type InteractionTargetType, type KillCommandParams, type LikeListResponse, type LikeQuery, type LikeRequest, type ListConnectProvidersResponse, type ListConnectionsResponse, type ListLocalFilesParams, type ListSkillProvidersResponse, type ListSkillToolsResponse, MarketAPIError, MarketAdmin, type MarketReportGitHubSkillParams, type MarketReportGitHubSkillResponse, MarketSDK, type MarketSDKOptions, type MarketSkillAuthor, type MarketSkillCategory, type MarketSkillCategoryQuery, type MarketSkillDetail, type MarketSkillDetailQuery, type MarketSkillGitHubMeta, type MarketSkillListItem, type MarketSkillListQuery, type MarketSkillListResponse, type MarketSkillManifest, type MarketSkillResource, type MarketSkillVersionSummary, type MarketSkillVersionsResponse, type MemberAgent, type MoveLocalFilesParams, type MoveOperation, type OAuthConnection, type OAuthTokenResponse, type OwnAgentGroupListQuery, type OwnAgentListQuery, type PaginationQuery, type PluginI18nImportParams, type PluginI18nImportResponse, type PluginItem, type PluginListResponse, type PluginLocalization, type PluginQueryParams, type PluginUpdateParams, type PluginVersionCreateParams, type PluginVersionUpdateParams, type ProgrammingLanguage, type ReadLocalFileParams, type RefreshConnectionResponse, type RefreshTokenRequest, type RegisterUserRequest, type RegisterUserResponse, type RegisteredUserProfile, type RenameLocalFileParams, type ReviewStatus, ReviewStatusEnumSchema, type RevokeConnectionResponse, type RunBuildInToolsError, type RunBuildInToolsRequest, type RunBuildInToolsResponse, type RunBuildInToolsSuccessData, type RunCommandParams, type SearchLocalFilesParams, type SharedTokenState, type SkillCallParams, type SkillCommentAuthor, type SkillCommentItem, type SkillCommentListQuery, type SkillCommentListResponse, type SkillErrorResponse, type SkillProviderInfo, type SkillProviderStatus, type SkillRatingDistribution, type SkillTool, StatusEnumSchema, type SubmitFeedbackRequest, type SubmitFeedbackResponse, type SuccessResponse, type ToggleLikeResponse, type TrustedClientPayload, type UnclaimedPluginItem, type UpdateAgentProfileRequest, type UpdateAgentProfileResponse, type UpdateMemberAgent, type UpdateUserInfoRequest, type UpdateUserInfoResponse, type UserAgentGroupItem, type UserAgentItem, type UserInfoQuery, type UserInfoResponse, type UserProfile, VisibilityEnumSchema, type WriteLocalFileParams, buildTrustedClientPayload, createTrustedClientToken, generateNonce };