@eventcatalog/generator-github/dist/types.d.mts

Pull and Sync schemas from GitHub to EventCatalog

type EventCatalogConfig = any;
type MessageType = 'event' | 'command' | 'query';
type Message = {
    id: string;
    name?: string;
    version?: string;
    schemaPath: string;
    type: MessageType;
};
type Service = {
    id: string;
    name?: string;
    version: string;
    sends?: Message[];
    receives?: Message[];
};
type Domain = {
    id: string;
    name: string;
    version: string;
};
type Channel = {
    id: string;
    name: string;
    address: string;
};
type GeneratorProps = {
    /**
     * The license key for the plugin
     */
    licenseKey?: string;
    /**
     * The repository to clone
     */
    source: string;
    /**
     * The branch to clone
     */
    branch?: string;
    /**
     * The path to clone
     */
    path?: string;
    /**
     * Optional list of services to add to the catalog
     */
    services?: Service[];
    /**
     * Optional domain to add to the catalog and attach the services too
     */
    domain?: Domain;
    /**
     * Optional list of messages to add to the catalog
     */
    messages?: Message[];
};

export type { Channel, Domain, EventCatalogConfig, GeneratorProps, Message, MessageType, Service };