sdkintegrations

Documentation

Index

• func New(is []sdkservices.Integration) sdkservices.Integrations
• func NewIntegration(desc sdktypes.Integration, mod sdkmodule.Module, opts ...OptFn) sdkservices.Integration
• type ConnectionInit
  • func NewConnectionInit(l *zap.Logger, w http.ResponseWriter, r *http.Request, i sdktypes.Integration) (ConnectionInit, *zap.Logger)
  • func (c ConnectionInit) AbortBadRequest(err string)
  • func (c ConnectionInit) AbortServerError(err string)
  • func (c ConnectionInit) AbortWithStatus(status int, err string)
  • func (c ConnectionInit) FinalURL() (string, error)
  • func (c ConnectionInit) Finalize(data []sdktypes.Var)
• type OAuthData
  • func DecodeOAuthData(raw string) (data *OAuthData, err error)
  • func GetOAuthDataFromURL(u *url.URL) (raw string, oauth *OAuthData, err error)
  • func (d OAuthData) Encode() (string, error)
  • func (d OAuthData) ToVars() sdktypes.Vars
• type OptFn
  • func WithConnectionConfig(fn func(context.Context, sdktypes.ConnectionID) (map[string]string, error)) OptFn
  • func WithConnectionConfigFromVars(cvars sdkservices.Vars) OptFn
  • func WithConnectionStatus(fn func(context.Context, sdktypes.ConnectionID) (sdktypes.Status, error)) OptFn
  • func WithConnectionTest(fn func(context.Context, sdktypes.ConnectionID) (sdktypes.Status, error)) OptFn

Functions

func New

func New(is []sdkservices.Integration) sdkservices.Integrations

func NewIntegration

func NewIntegration(
	desc sdktypes.Integration,
	mod sdkmodule.Module,
	opts ...OptFn,
) sdkservices.Integration

NewIntegration creates a new integration, augmenting the given `desc` with the members definition from `mod`.

Types

type ConnectionInit

type ConnectionInit struct {
	Writer       http.ResponseWriter
	Request      *http.Request
	Integration  sdktypes.Integration
	ConnectionID string
	Origin       string
	// contains filtered or unexported fields
}

func NewConnectionInit

func NewConnectionInit(l *zap.Logger, w http.ResponseWriter, r *http.Request, i sdktypes.Integration) (ConnectionInit, *zap.Logger)

func (ConnectionInit) AbortBadRequest

func (c ConnectionInit) AbortBadRequest(err string)

AbortBadRequest is the same as [AbortWithStatus] with HTTP 400 (Bad Request).

func (ConnectionInit) AbortServerError

func (c ConnectionInit) AbortServerError(err string)

AbortServerError is the same as [AbortWithStatus] with HTTP 500 (Internal Server Error).

func (ConnectionInit) AbortWithStatus

func (c ConnectionInit) AbortWithStatus(status int, err string)

Abort aborts the connection initialization flow due to a runtime error. It encodes the error status and message, and redirects the user to the last HTTP response, based on its origin (local AK server / local VS Code extension / SaaS web UI).

func (ConnectionInit) FinalURL

func (c ConnectionInit) FinalURL() (string, error)

FinalURL returns the final redirect URL at the end of the connection flow in each integration, based on the origin of the connection initialization request. TODO(INT-195): Deprecate "Finalize" above and the "postinit" webhook.

func (ConnectionInit) Finalize

func (c ConnectionInit) Finalize(data []sdktypes.Var)

Finalize finalizes all integration-specific connection flows. It encodes their resulting details and redirects the user to the final HTTP handler ("post-init") that saves the data in the connection's scope, and redirects the user to the last HTTP response, based on its origin (local AK server / local VS Code extension / SaaS web UI).

type OAuthData

type OAuthData struct {
	Token  *oauth2.Token
	Params url.Values
}

func DecodeOAuthData

func DecodeOAuthData(raw string) (data *OAuthData, err error)

func GetOAuthDataFromURL

func GetOAuthDataFromURL(u *url.URL) (raw string, oauth *OAuthData, err error)

func (OAuthData) Encode

func (d OAuthData) Encode() (string, error)

func (OAuthData) ToVars

func (d OAuthData) ToVars() sdktypes.Vars

type OptFn

type OptFn func(*integration)

func WithConnectionConfig

func WithConnectionConfig(fn func(context.Context, sdktypes.ConnectionID) (map[string]string, error)) OptFn

func WithConnectionConfigFromVars

func WithConnectionConfigFromVars(cvars sdkservices.Vars) OptFn

func WithConnectionStatus

func WithConnectionStatus(fn func(context.Context, sdktypes.ConnectionID) (sdktypes.Status, error)) OptFn

func WithConnectionTest

func WithConnectionTest(fn func(context.Context, sdktypes.ConnectionID) (sdktypes.Status, error)) OptFn