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

    Class AppProvider

    App provider implementation consumed by the Gestalt runtime.

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

    export const app = defineApp({
      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

    name displayName description version kind iconSvg connectionMode authTypes connectionParams

    Methods

    resolveName providerMetadata configureProvider supportsHealthCheck healthCheck startProvider warnings closeProvider declaredWorkflowSpecs supportsSessionCatalog catalogForRequest resolveHTTPSubject staticCatalog writeCatalog catalogJson execute executeStream

    Constructors

    Properties

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

    Methods

    • Parameters

      • name: string
      • config: Record<string, unknown>

      Returns Promise<void>

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

      Returns boolean

    • Resolves a catalog for the current request context, if configured.

      Parameters

      Returns Promise<SessionCatalog | null | undefined>

    • Returns the static catalog emitted during provider startup.

      Returns Catalog

    • 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>

    • Executes a streaming operation against validated input and request metadata. Returns a StreamReader yielding the metadata frame followed by encoded data frames. Only operations whose output is a StreamOutput are supported; other operations return an error metadata frame.

      Parameters

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

      Returns Promise<StreamReader>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods