@valon-technologies/gestalt
    Preparing search index...

    Class PluginProvider

    Plugin provider implementation consumed by the Gestalt runtime.

    import { definePlugin, ok, operation, s } from "@valon-technologies/gestalt";

    export const plugin = definePlugin({
      displayName: "Example Provider",
      operations: [
        operation({
          id: "ping",
          method: "GET",
          readOnly: true,
          input: s.object({ name: s.string({ default: "World" }) }),
          output: s.object({ message: s.string() }),
          async handler(input) {
            return ok({ message: `Hello, ${input.name}` });
          },
        }),
      ],
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    kind iconSvg connectionMode authTypes connectionParams name displayName description version

    Methods

    supportsSessionCatalog catalogForRequest supportsPostConnect postConnectMetadata resolveHTTPSubject staticCatalog writeCatalog catalogJson execute resolveName runtimeMetadata configureProvider supportsHealthCheck healthCheck startProvider warnings closeProvider

    Constructors

    Properties

    kind: "integration" = ...
    iconSvg: string
    connectionMode: ConnectionMode
    authTypes: string[]
    connectionParams: Record<string, ConnectionParamDefinition>
    name: string
    displayName: string
    description: string
    version: string

    Methods

    • Reports whether the provider exposes a session-specific catalog.

      Returns boolean

    • Reports whether the provider exposes a connect-time metadata hook.

      Returns boolean

    • Computes additional connection metadata after a successful connect flow.

      Parameters

      Returns Promise<Record<string, string> | null | undefined>

    • Writes the provider's static catalog to disk as YAML.

      Parameters

      • path: string

      Returns void

    • Returns the static catalog serialized as JSON.

      Returns string

    • Executes an operation against validated input and request metadata.

      Parameters

      • operationId: string
      • params: Record<string, unknown>
      • request: Request

      Returns Promise<OperationResult>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods