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

    Class AppProvider

    AppProvider models the shared Gestalt integration-provider protocol.

    Index

    Constructors

    constructor

    Methods

    getMetadata startProvider startProviderRaw execute executeRaw executeStream executeStreamRaw resolveHTTPSubject getSessionCatalog getSessionCatalogRaw

    Constructors

    Methods

    • Parameters

      • name: string
      • protocolVersion: number
      • Optionalconfig: object

      Returns Promise<StartProviderResponse>

    • Parameters

      • request: { name?: string; config?: object; protocolVersion?: number }

      Returns Promise<StartProviderResponse>

    • Parameters

      • operation: string
      • token: string
      • invocationId: string
      • idempotencyKey: string
      • Optionalparams: object

      Returns Promise<OperationResult>

    • Parameters

      • request: {
            operation?: string;
            params?: object;
            token?: string;
            connectionParams?: { [key: string]: string };
            invocationId?: string;
            context?: {
                subject?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: object;
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
            idempotencyKey?: string;
        }

      Returns Promise<OperationResult>

    • Parameters

      • operation: string
      • token: string
      • invocationId: string
      • idempotencyKey: string
      • Optionalparams: object

      Returns AsyncIterable<InvokeFrame>

    • ExecuteStream is the streaming counterpart of Execute. The first response frame is always InvokeMetadata; subsequent frames carry encoded data bytes. A mid-stream error may emit a trailing metadata frame with an error status followed by a JSON error body, after which the stream ends.

      Parameters

      • request: {
            operation?: string;
            params?: object;
            token?: string;
            connectionParams?: { [key: string]: string };
            invocationId?: string;
            context?: {
                subject?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: object;
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
            idempotencyKey?: string;
        }

      Returns AsyncIterable<InvokeFrame>

    • Parameters

      • request: {
            request?: {
                binding?: string;
                method?: string;
                path?: string;
                contentType?: string;
                headers?: { [key: string]: { values?: string[] } };
                query?: { [key: string]: { values?: string[] } };
                params?: object;
                rawBody?: Uint8Array<ArrayBufferLike>;
                securityScheme?: string;
                verifiedSubject?: string;
                verifiedClaims?: { [key: string]: string };
            };
            context?: {
                subject?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: object;
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<ResolveHTTPSubjectResponse>

    • Parameters

      • request: {
            token?: string;
            connectionParams?: { [key: string]: string };
            invocationId?: string;
            context?: {
                subject?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                credential?: {
                    mode?: string;
                    subjectId?: string;
                    connection?: string;
                    instance?: string;
                };
                access?: { policy?: string; role?: string };
                workflow?: object;
                host?: { publicBaseUrl?: string };
                agentSubject?: {
                    id?: string;
                    email?: string;
                    displayName?: string;
                    scopes?: string[];
                    permissions?: {
                        app?: string;
                        operations?: string[];
                        allOperations?: boolean;
                    }[];
                };
                caller?: { kind?: string; name?: string };
                invocation?: {
                    requestId?: string;
                    depth?: number;
                    callChain?: string[];
                    surface?: string;
                    internalConnectionAccess?: boolean;
                    connection?: string;
                };
                toolRefs?: {
                    app?: string;
                    operation?: string;
                    connection?: string;
                    instance?: string;
                    title?: string;
                    description?: string;
                    credentialMode?: string;
                    system?: string;
                    runAs?: {
                        id?: string;
                        email?: string;
                        displayName?: string;
                        scopes?: string[];
                        permissions?: { app?: ...; operations?: ...; allOperations?: ... }[];
                    };
                }[];
                toolRefsSet?: boolean;
                requestMeta?: {
                    clientIp?: string;
                    remoteAddr?: string;
                    userAgent?: string;
                };
                agent?: { providerName?: string; sessionId?: string; turnId?: string };
            };
        }

      Returns Promise<GetSessionCatalogResponse>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods