@oneplatform/plugin-sdk / TransformerMetadata

Interface: TransformerMetadata¶

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

Extends¶

BaseMetadata

Properties¶

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

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

idempotent¶

idempotent: boolean

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

True if transform(transform(x)) === transform(x) for all x. Idempotent transformers can be safely retried without data duplication.

inputSchema?¶

optional inputSchema?: JSONSchema

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

JSON Schema for accepted record shape. null means any shape is accepted.

name¶

name: string

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

Human-readable display name. 2-100 characters.

Inherited from¶

BaseMetadata.name

outputSchema?¶

optional outputSchema?: JSONSchema

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

JSON Schema for output record shape. null means shape mirrors input.

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: "transformer"

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

version¶

version: string

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

Must match manifest.version exactly.

Inherited from¶

BaseMetadata.version