piece-metadata-service.ts•2.01 kB
import { PieceMetadata,
PieceMetadataModel,
PieceMetadataModelSummary } from '@activepieces/pieces-framework'
import {
ApEdition,
ListVersionsResponse,
LocalesEnum,
PackageType,
PieceCategory,
PieceOrderBy,
PieceSortBy,
PieceType,
PlatformId,
ProjectId,
SuggestionType,
} from '@activepieces/shared'
import { EntityManager } from 'typeorm'
type ListParams = {
release: string
projectId?: string
platformId?: string
includeHidden: boolean
edition: ApEdition
categories?: PieceCategory[]
includeTags?: boolean
tags?: string[]
sortBy?: PieceSortBy
orderBy?: PieceOrderBy
searchQuery?: string
suggestionType?: SuggestionType
locale?: LocalesEnum
}
type GetOrThrowParams = {
name: string
version: string | undefined
entityManager?: EntityManager
projectId: string | undefined
platformId: string | undefined
locale?: LocalesEnum
}
type ListVersionsParams = {
name: string
projectId: string | undefined
release: string | undefined
edition: ApEdition
platformId: string | undefined
}
type CreateParams = {
pieceMetadata: PieceMetadata
platformId?: string
projectId?: string
packageType: PackageType
pieceType: PieceType
archiveId?: string
}
type UpdateUsage = {
id: string
usage: number
}
type GetExactPieceVersionParams = {
name: string
version: string
projectId: ProjectId
platformId: PlatformId
}
export type PieceMetadataService = {
list(params: ListParams): Promise<PieceMetadataModelSummary[]>
get(params: GetOrThrowParams): Promise<PieceMetadataModel | undefined>
getOrThrow(params: GetOrThrowParams): Promise<PieceMetadataModel>
getVersions(params: ListVersionsParams): Promise<ListVersionsResponse>
create(params: CreateParams): Promise<PieceMetadataModel>
updateUsage(params: UpdateUsage): Promise<void>
resolveExactVersion(params: GetExactPieceVersionParams): Promise<string>
}