Skip to main content

Interface: IMarketplace

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:343

Interface for the Agent Marketplace

Methods​

checkUpdates()​

checkUpdates(): Promise<object[]>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:435

Check for updates

Returns​

Promise<object[]>

deleteReview()​

deleteReview(reviewId): Promise<void>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:474

Delete a review

Parameters​

reviewId​

string

Returns​

Promise<void>

deprecate()​

deprecate(itemId, reason, alternativeId?): Promise<void>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:457

Deprecate an item

Parameters​

itemId​

string

reason​

string

alternativeId?​

string

Returns​

Promise<void>

getByPublisher()​

getByPublisher(publisherId, options?): Promise<MarketplaceSearchResult>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:386

Get items by publisher

Parameters​

publisherId​

string

options?​

MarketplaceSearchOptions

Returns​

Promise<MarketplaceSearchResult>

getDependencyTree()​

getDependencyTree(itemId): Promise<{ dependencies: MarketplaceItem[]; item: MarketplaceItem; }>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:403

Get item dependencies tree

Parameters​

itemId​

string

Returns​

Promise<{ dependencies: MarketplaceItem[]; item: MarketplaceItem; }>

getFeatured()​

getFeatured(type?, limit?): Promise<MarketplaceItem[]>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:371

Get featured items

Parameters​

type?​

MarketplaceItemType

limit?​

number

Returns​

Promise<MarketplaceItem[]>

getInstallation()​

getInstallation(installationId): Promise<InstalledItem | undefined>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:430

Get installation by ID

Parameters​

installationId​

string

Returns​

Promise<InstalledItem | undefined>

getInstalled()​

getInstalled(options?): Promise<InstalledItem[]>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:425

Get installed items

Parameters​

options?​
status?​

InstallationStatus

type?​

MarketplaceItemType

Returns​

Promise<InstalledItem[]>

getItem()​

getItem(itemId): Promise<MarketplaceItem | undefined>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:361

Get item by ID

Parameters​

itemId​

string

Returns​

Promise<MarketplaceItem | undefined>

getItemAnalytics()​

getItemAnalytics(itemId, period?): Promise<{ activeInstalls: number; downloads: object[]; ratings: object[]; uninstalls: number; views: object[]; }>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:501

Get item analytics (for publishers)

Parameters​

itemId​

string

period?​

"day" | "week" | "month" | "year"

Returns​

Promise<{ activeInstalls: number; downloads: object[]; ratings: object[]; uninstalls: number; views: object[]; }>

getItems()​

getItems(itemIds): Promise<MarketplaceItem[]>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:366

Get multiple items by ID

Parameters​

itemIds​

string[]

Returns​

Promise<MarketplaceItem[]>

getRecent()​

getRecent(type?, limit?): Promise<MarketplaceItem[]>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:381

Get recently added items

Parameters​

type?​

MarketplaceItemType

limit?​

number

Returns​

Promise<MarketplaceItem[]>

getReviews()​

getReviews(itemId, options?): Promise<{ reviews: Review[]; total: number; }>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:393

Get item reviews

Parameters​

itemId​

string

options?​
limit?​

number

offset?​

number

sortBy?​

"rating" | "newest" | "helpful"

Returns​

Promise<{ reviews: Review[]; total: number; }>

getStats()​

getStats(): Promise<MarketplaceStats>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:491

Get marketplace statistics

Returns​

Promise<MarketplaceStats>

getTrending()​

getTrending(type?, period?, limit?): Promise<MarketplaceItem[]>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:376

Get trending items

Parameters​

type?​

MarketplaceItemType

period?​

"day" | "week" | "month"

limit?​

number

Returns​

Promise<MarketplaceItem[]>

getVersions()​

getVersions(itemId): Promise<object[]>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:398

Get item versions

Parameters​

itemId​

string

Returns​

Promise<object[]>

initialize()​

initialize(): Promise<void>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:349

Initialize the marketplace

Returns​

Promise<void>

install()​

install(itemId, options?): Promise<InstallationResult>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:410

Install an item

Parameters​

itemId​

string

options?​
autoUpdate?​

boolean

config?​

Record<string, unknown>

version?​

string

Returns​

Promise<InstallationResult>

markReviewHelpful()​

markReviewHelpful(reviewId): Promise<void>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:479

Mark review as helpful

Parameters​

reviewId​

string

Returns​

Promise<void>

publish()​

publish(item): Promise<MarketplaceItem>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:442

Publish a new item

Parameters​

item​

Omit<MarketplaceItem, "id" | "stats" | "ratings" | "createdAt" | "updatedAt" | "publishedAt">

Returns​

Promise<MarketplaceItem>

publishVersion()​

publishVersion(itemId, version, options?): Promise<void>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:452

Publish a new version

Parameters​

itemId​

string

version​

string

options?​
breaking?​

boolean

changelog?​

string

Returns​

Promise<void>

recordView()​

recordView(itemId): Promise<void>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:496

Record item view (for analytics)

Parameters​

itemId​

string

Returns​

Promise<void>

respondToReview()​

respondToReview(reviewId, response): Promise<void>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:484

Respond to a review (as publisher)

Parameters​

reviewId​

string

response​

string

Returns​

Promise<void>

search(options?): Promise<MarketplaceSearchResult>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:356

Search marketplace items

Parameters​

options?​

MarketplaceSearchOptions

Returns​

Promise<MarketplaceSearchResult>

submitReview()​

submitReview(itemId, review): Promise<Review>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:464

Submit a review

Parameters​

itemId​

string

review​
body​

string

rating​

number

title?​

string

Returns​

Promise<Review>

uninstall()​

uninstall(installationId): Promise<{ error?: string; success: boolean; }>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:420

Uninstall an item

Parameters​

installationId​

string

Returns​

Promise<{ error?: string; success: boolean; }>

update()​

update(installationId, options?): Promise<InstallationResult>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:415

Update an installed item

Parameters​

installationId​

string

options?​
config?​

Record<string, unknown>

version?​

string

Returns​

Promise<InstallationResult>

updateItem()​

updateItem(itemId, updates): Promise<MarketplaceItem>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:447

Update a published item

Parameters​

itemId​

string

updates​

Partial<MarketplaceItem>

Returns​

Promise<MarketplaceItem>

updateReview()​

updateReview(reviewId, updates): Promise<Review>

Defined in: packages/agentos/src/core/marketplace/IMarketplace.ts:469

Update a review

Parameters​

reviewId​

string

updates​
body?​

string

rating?​

number

title?​

string

Returns​

Promise<Review>