@oneplatform/plugin-sdk

@oneplatform/plugin-sdk / DestinationMetadata

Interface: DestinationMetadata¶

Defined in: packages/plugin-sdk/src/types/metadata.ts:82

Extends¶

• BaseMetadata

Properties¶

acceptedSchema?¶

optional acceptedSchema?: JSONSchema

Defined in: packages/plugin-sdk/src/types/metadata.ts:86

JSON Schema for the record shape this destination accepts. null = any shape.

author¶

author: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:25

Plugin author name or organization.

Inherited from¶

BaseMetadata.author

configSchema¶

configSchema: JSONSchema

Defined in: packages/plugin-sdk/src/types/metadata.ts:31

JSON Schema for the tenant-admin configuration form.

Inherited from¶

BaseMetadata.configSchema

deliveryGuarantee¶

deliveryGuarantee: "at-most-once" | "at-least-once" | "exactly-once"

Defined in: packages/plugin-sdk/src/types/metadata.ts:94

Delivery guarantee provided by this destination's write() implementation. "at-most-once": records may be lost on failure; no retry "at-least-once": records are retried on failure; destination must handle duplicates "exactly-once": records are deduplicated by sourceId; strongest guarantee

description¶

description: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:19

Brief description shown in the marketplace. 10-500 characters.

Inherited from¶

BaseMetadata.description

icon?¶

optional icon?: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:28

URL or data URI for the plugin icon. PNG or SVG, max 64KB.

Inherited from¶

BaseMetadata.icon

id¶

id: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:13

Must match manifest.id exactly.

Inherited from¶

BaseMetadata.id

name¶

name: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:16

Human-readable display name. 2-100 characters.

Inherited from¶

BaseMetadata.name

supportsBulk¶

supportsBulk: boolean

Defined in: packages/plugin-sdk/src/types/metadata.ts:97

True if the destination supports write() with batches > 1.

supportsStreaming¶

supportsStreaming: boolean

Defined in: packages/plugin-sdk/src/types/metadata.ts:100

True if the destination implements writeStream().

tags?¶

optional tags?: string[]

Defined in: packages/plugin-sdk/src/types/metadata.ts:34

Discoverability tags shown in the marketplace filter UI.

Inherited from¶

BaseMetadata.tags

type¶

readonly type: "destination"

Defined in: packages/plugin-sdk/src/types/metadata.ts:83

version¶

version: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:22

Must match manifest.version exactly.

Inherited from¶

BaseMetadata.version