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

    Class App

    Index

    Constructors

    constructor

    Methods

    connect invoke invokeRaw invokeStream invokeStreamRaw invokeGraphQL invokeGraphQLRaw

    Constructors

    • Parameters

      • transport: Transport
      • Optionaloptions: { context?: RequestContext; timeoutMs?: number }

      Returns App

    Methods

    • Parameters

      • Optionaloptions: { name?: string; context?: RequestContext; timeoutMs?: number }

      Returns App

    • The result decodes with the standard JSON operation envelope semantics; envelope failures throw InvokeError.

      Type Parameters

      • T = unknown

      Parameters

      • app: string
      • operation: string
      • Optionalparams: object
      • Optionaloptions: {
            connection?: string;
            instance?: string;
            idempotencyKey?: string;
            credentialMode?: string;
            runAs?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            headers?: { [key: string]: string };
        }

      Returns Promise<T>

    • Parameters

      • request: {
            app?: string;
            operation?: string;
            params?: object;
            connection?: string;
            instance?: string;
            idempotencyKey?: string;
            credentialMode?: 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 };
            };
            runAs?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            headers?: { [key: string]: string };
        }
        • Optionalapp?: string
        • Optionaloperation?: string
        • Optionalparams?: object
        • Optionalconnection?: string
        • Optionalinstance?: string
        • OptionalidempotencyKey?: string
        • OptionalcredentialMode?: string
        • Optionalcontext?: {
              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 };
          }
          • Optionalsubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            }
          • Optionalcredential?: { mode?: string; subjectId?: string; connection?: string; instance?: string }
          • Optionalaccess?: { policy?: string; role?: string }
          • Optionalworkflow?: object
          • Optionalhost?: { publicBaseUrl?: string }
          • OptionalagentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            }

            Original agent caller when an agent tool executes with delegated run-as identity.

          • Optionalcaller?: { kind?: string; name?: string }
          • Optionalinvocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            }
          • OptionaltoolRefs?: {
                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?: ... }[];
                };
            }[]

            Agent tool refs granted to the operation request, when the request is executing as an agent tool.

          • OptionaltoolRefsSet?: boolean

            Preserves the distinction between an omitted tool-ref context and an explicitly empty inherited tool-ref context.

          • OptionalrequestMeta?: { clientIp?: string; remoteAddr?: string; userAgent?: string }
          • Optionalagent?: { providerName?: string; sessionId?: string; turnId?: string }
        • OptionalrunAs?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          }
        • Optionalheaders?: { [key: string]: string }

          headers overrides outbound static headers declared by the target provider.

      Returns Promise<OperationResult>

    • Parameters

      • app: string
      • operation: string
      • Optionalparams: object
      • Optionaloptions: {
            connection?: string;
            instance?: string;
            idempotencyKey?: string;
            credentialMode?: string;
            runAs?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            headers?: { [key: string]: string };
        }

      Returns AsyncIterable<InvokeFrame>

    • InvokeStream is the streaming counterpart of Invoke. It is gRPC-only (no REST binding) and shares Invoke's request shape, authorization, and signature policy. The first response frame is always InvokeMetadata; subsequent frames carry data bytes from the operation's stream response. 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: {
            app?: string;
            operation?: string;
            params?: object;
            connection?: string;
            instance?: string;
            idempotencyKey?: string;
            credentialMode?: 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 };
            };
            runAs?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            };
            headers?: { [key: string]: string };
        }
        • Optionalapp?: string
        • Optionaloperation?: string
        • Optionalparams?: object
        • Optionalconnection?: string
        • Optionalinstance?: string
        • OptionalidempotencyKey?: string
        • OptionalcredentialMode?: string
        • Optionalcontext?: {
              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 };
          }
          • Optionalsubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            }
          • Optionalcredential?: { mode?: string; subjectId?: string; connection?: string; instance?: string }
          • Optionalaccess?: { policy?: string; role?: string }
          • Optionalworkflow?: object
          • Optionalhost?: { publicBaseUrl?: string }
          • OptionalagentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            }

            Original agent caller when an agent tool executes with delegated run-as identity.

          • Optionalcaller?: { kind?: string; name?: string }
          • Optionalinvocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            }
          • OptionaltoolRefs?: {
                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?: ... }[];
                };
            }[]

            Agent tool refs granted to the operation request, when the request is executing as an agent tool.

          • OptionaltoolRefsSet?: boolean

            Preserves the distinction between an omitted tool-ref context and an explicitly empty inherited tool-ref context.

          • OptionalrequestMeta?: { clientIp?: string; remoteAddr?: string; userAgent?: string }
          • Optionalagent?: { providerName?: string; sessionId?: string; turnId?: string }
        • OptionalrunAs?: {
              id?: string;
              email?: string;
              displayName?: string;
              scopes?: string[];
              permissions?: {
                  app?: string;
                  operations?: string[];
                  allOperations?: boolean;
              }[];
          }
        • Optionalheaders?: { [key: string]: string }

          headers overrides outbound static headers declared by the target provider.

      Returns AsyncIterable<InvokeFrame>

    • Parameters

      • app: string
      • document: string
      • Optionaloptions: {
            connection?: string;
            instance?: string;
            idempotencyKey?: string;
            variables?: object;
            headers?: { [key: string]: string };
        }

      Returns Promise<OperationResult>

    • Parameters

      • request: {
            app?: string;
            document?: string;
            variables?: object;
            connection?: string;
            instance?: string;
            idempotencyKey?: 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 };
            };
            headers?: { [key: string]: string };
        }
        • Optionalapp?: string
        • Optionaldocument?: string
        • Optionalvariables?: object
        • Optionalconnection?: string
        • Optionalinstance?: string
        • OptionalidempotencyKey?: string
        • Optionalcontext?: {
              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 };
          }
          • Optionalsubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            }
          • Optionalcredential?: { mode?: string; subjectId?: string; connection?: string; instance?: string }
          • Optionalaccess?: { policy?: string; role?: string }
          • Optionalworkflow?: object
          • Optionalhost?: { publicBaseUrl?: string }
          • OptionalagentSubject?: {
                id?: string;
                email?: string;
                displayName?: string;
                scopes?: string[];
                permissions?: {
                    app?: string;
                    operations?: string[];
                    allOperations?: boolean;
                }[];
            }

            Original agent caller when an agent tool executes with delegated run-as identity.

          • Optionalcaller?: { kind?: string; name?: string }
          • Optionalinvocation?: {
                requestId?: string;
                depth?: number;
                callChain?: string[];
                surface?: string;
                internalConnectionAccess?: boolean;
                connection?: string;
            }
          • OptionaltoolRefs?: {
                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?: ... }[];
                };
            }[]

            Agent tool refs granted to the operation request, when the request is executing as an agent tool.

          • OptionaltoolRefsSet?: boolean

            Preserves the distinction between an omitted tool-ref context and an explicitly empty inherited tool-ref context.

          • OptionalrequestMeta?: { clientIp?: string; remoteAddr?: string; userAgent?: string }
          • Optionalagent?: { providerName?: string; sessionId?: string; turnId?: string }
        • Optionalheaders?: { [key: string]: string }

          headers overrides outbound static headers declared by the target provider.

      Returns Promise<OperationResult>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods