@prismatic-io/spectral/dist/types/ComponentManifest.d.ts

Utility library for building Prismatic connectors and code-native integrations

import type { CollectionType } from "./ConfigVars";
import type { DataSourceType } from "./DataSourceResult";
import type { InputFieldType } from "./Inputs";
export interface ComponentManifest {
    key: string;
    public: boolean;
    signature: string | null;
    actions: Record<string, ComponentManifestAction>;
    triggers: Record<string, ComponentManifestTrigger>;
    dataSources: Record<string, ComponentManifestDataSource>;
    connections: Record<string, ComponentManifestConnection>;
}
interface BaseInput {
    inputType: InputFieldType;
    collection?: CollectionType | undefined;
    required?: boolean;
    default?: unknown;
}
export interface ComponentManifestAction {
    key?: string;
    perform: (values: any) => Promise<unknown>;
    inputs: Record<string, BaseInput>;
    examplePayload?: unknown;
}
export interface ComponentManifestTrigger {
    key?: string;
    perform: (values: any) => Promise<unknown>;
    inputs: Record<string, BaseInput>;
}
export interface ComponentManifestDataSource {
    key?: string;
    perform: (values: any) => Promise<unknown>;
    dataSourceType: DataSourceType;
    inputs: Record<string, BaseInput>;
}
export interface ComponentManifestConnection {
    key?: string;
    perform: (values: any) => Promise<unknown>;
    onPremAvailable?: boolean;
    inputs: Record<string, BaseInput & {
        onPremControlled?: boolean;
    }>;
}
export {};