connector

type APIClient struct {
	// contains filtered or unexported fields
}

type ActionEvent struct {
	InstanceId string
	RequestId  string
	Response   *ActionResponse
}

type ActionRequest struct {
	ID          string              `json:"id"`
	ThingID     string              `json:"thingId"`
	ComponentID string              `json:"componentId"`
	ActionID    string              `json:"actionId"`
	Status      ActionRequestStatus `json:"status"`
	Parameters  map[string]string   `json:"parameters"`
}

type ActionRequestStatus string

type ActionRequestStatusUpdate struct {
	Status ActionRequestStatus `json:"status"`
	Error  string              `json:"error"`
}

type ActionResponse struct {
	Status ActionRequestStatus `json:"status"`
	Error  string              `json:"error"`
}

type AddThingRequest struct {
	Thing connctd.Thing `json:"thing"`
}

type AddThingResponse struct {
	ID string `json:"id"`
}

type Client interface {
	// CreateThing can be used to create a thing.
	// The ID of the newly created thing is returned if the operation was successful.
	// Otherwise an error is returned.
	CreateThing(ctx context.Context, token InstantiationToken, thing connctd.Thing) (result connctd.Thing, err error)

	// UpdateThingPropertyValue returns an error if the update was not successful.
	UpdateThingPropertyValue(ctx context.Context, token InstantiationToken, thingID string, componentID string, propertyID string, value string, lastUpdate time.Time) error

	// UpdateThingStatus updates the status of a thing.
	// It can be used to set the availability of a thing.
	UpdateThingStatus(ctx context.Context, token InstantiationToken, thingID string, status connctd.StatusType) error

	// UpdateActionStatus can be used to inform the connctd platform about the new state of an action request.
	// It must be used to finish pending action request.
	// If the action request was not successful, an optional error can be set for additional error details.
	UpdateActionStatus(ctx context.Context, token InstantiationToken, actionRequestID string, status ActionRequestStatus, err string) error

	// UpdateInstallationState can be used to inform the connctd platform about the new state of an installation.
	// It must be called if the installation requires multiple steps, after it is finished.
	UpdateInstallationState(ctx context.Context, token InstallationToken, state InstallationState, details json.RawMessage) error

	// UpdateInstanceState can be used to inform the connctd platform about the new state of an instance creation.
	// It must be called if the instantiation requires multiple steps.
	UpdateInstanceState(ctx context.Context, token InstantiationToken, state InstantiationState, details json.RawMessage) error

	// DeleteThing can be used to delete a thing.
	DeleteThing(ctx context.Context, token InstantiationToken, thingID string) error
}

type ClientOptions struct {
	ConnctdBaseURL *url.URL
	HTTPClient     *http.Client
}

type Configuration struct {
	ID    string `json:"id"`
	Value string `json:"value"`
}

type ConnectorHandler struct {
	// contains filtered or unexported fields
}

type ConnectorService interface {
	// AddInstallation is called by the ConnectorHandler when it received an installation request.
	// The request is validated before calling AddInstallation but the connector can implemnet additional validation.
	// If the installation is completed successfully, the service should return nil and no error.
	// If the installation needs further steps, the service should respond with an InstallationResponse and no error.
	// It is then the responsibility of the service to update the installation state as soon as the installation is completed.
	// In case of an error, the service should respond with an appropriate error from errors.go and can also return an InstallationResponse.
	// The status code will be set to one defined in the error and the InstallationResponse will be returned to the connctd platform.
	AddInstallation(ctx context.Context, request InstallationRequest) (*InstallationResponse, error)

	// RemoveInstallation is called whenever an installation is removed by the the connctd platform.
	// The connector should remove the installation and can return an error if needed.
	// Regardless of the return value, the installation is removed from the connctd platform.
	RemoveInstallation(ctx context.Context, installationId string) error

	// AddInstance is called by the ConnectorHandler whenever a connector is instantiated via the connctd platform.
	// The request is validated before calling AddInstance but the connector can implemnet additional validation.
	// If the instantiation is completed successfully, the service should return nil and no error.
	// If the instantiation needs further steps, the service should respond with an InstantiationResponse and no error.
	// It is then the responsibility of the service to update the instantiation state as soon as the instantiation is completed.
	// In case of an error, the service should respond with an appropriate error from errors.go and can also return an InstantiationResponse.
	// The status code will be set to one defined in the error and the InstantiationResponse will be returned to the connctd platform.
	AddInstance(ctx context.Context, request InstantiationRequest) (*InstantiationResponse, error)

	//RemoveInstance is called whenever an instance is removed by the the connctd platform.
	RemoveInstance(ctx context.Context, instanceId string) error

	// PerformAction is called by the ConnectorHandler whenever an action is triggered via the connctd platform.
	// The request is validated before calling PerformAction but the connector can implement additional validation.
	// If the action is pending, the service should respond with an ActionResponse.
	// It is then the responsibility of the service to update the action request state as soon as the request is completed.
	// If the action is successfully completed, the service should return nil.
	// In case of an error, the service should respond with an appropriate error from errors.go.
	PerformAction(ctx context.Context, request ActionRequest) (*ActionResponse, error)
}

type Database interface {
	AddInstallation(ctx context.Context, installationRequest InstallationRequest) error
	AddInstallationConfiguration(ctx context.Context, installationId string, config []Configuration) error
	GetInstallations(ctx context.Context) ([]*Installation, error)
	RemoveInstallation(ctx context.Context, installationId string) error
	GetInstancesInstallationConfiguration(ctx context.Context, instanceID string) ([]*Configuration, error)

	AddInstance(ctx context.Context, instantiationRequest InstantiationRequest) error
	AddInstanceConfiguration(ctx context.Context, instanceId string, config []Configuration) error
	GetInstance(ctx context.Context, instanceId string) (*Instance, error)
	GetInstances(ctx context.Context) ([]*Instance, error)
	GetInstanceByThingId(ctx context.Context, thingId string) (*Instance, error)
	GetInstanceConfiguration(ctx context.Context, instanceId string) ([]Configuration, error)
	GetMappingByInstanceId(ctx context.Context, instanceId string) ([]ThingMapping, error)
	GetMappingByExternalId(ctx context.Context, instanceId string, externalID string) (*ThingMapping, error)
	RemoveInstance(ctx context.Context, instanceId string) error

	AddThingMapping(ctx context.Context, instanceID string, thingID string, externalId string) error
	RemoveThingMapping(ctx context.Context, instanceID string, thingID string) error
}

type Error struct {
	APIError    string `json:"error"`
	Description string `json:"description"`
	Status      int    `json:"status"`
}

type Installation struct {
	ID            string            `db:"id" json:"id"`
	Token         InstallationToken `db:"token" json:"token"`
	Configuration []Configuration   `json:"configuration"`
}

type InstallationRequest struct {
	ID            string            `json:"id"`
	Token         InstallationToken `json:"token"`
	State         InstallationState `json:"state"`
	Configuration []Configuration   `json:"configuration"`
}

type InstallationResponse struct {
	Details     json.RawMessage `json:"details,omitempty"`
	FurtherStep Step            `json:"furtherStep,omitempty"`
}

type InstallationState int

type InstallationStateUpdateRequest struct {
	State   InstallationState `json:"state"`
	Details json.RawMessage   `json:"details,omitempty"`
}

type InstallationToken string

type Instance struct {
	ID             string             `db:"id" json:"id"`
	InstallationID string             `db:"installation_id" json:"installationId"`
	Token          InstantiationToken `db:"token" json:"token"`
	ThingMapping   []ThingMapping     `json:"things"`
	Configuration  []Configuration    `json:"configuration"`
}

type InstanceStateUpdateRequest struct {
	State   InstantiationState `json:"state"`
	Details json.RawMessage    `json:"details,omitempty"`
}

type InstantiationRequest struct {
	ID             string             `json:"id"`
	InstallationID string             `json:"installation_id"`
	Token          InstantiationToken `json:"token"`
	State          InstantiationState `json:"state"`
	Configuration  []Configuration    `json:"configuration"`
}

type InstantiationResponse struct {
	Details     json.RawMessage `json:"details,omitempty"`
	FurtherStep Step            `json:"furtherStep,omitempty"`
}

type InstantiationState int

type InstantiationToken string

type PropertyUpdateEvent struct {
	ThingId     string
	InstanceId  string
	ComponentId string
	PropertyId  string
	Value       string
}

type Provider interface {
	// UpdateChannel is used by the connector service to receive update event.
	// The provider can push updates to the underlying channel or use directly use the connctd API client.
	UpdateChannel() <-chan UpdateEvent

	// RequestAction is called by the connector service when it received an action request.
	// The provider can execute the action synchronously and return an ActionRequestStatusCompleted or ActionRequestStatusFailed.
	// If it returns ActionRequestStatusFailed it is expected to also return an error with details on the failing condition.
	// In both cases an appropriate connector.ActionResponse is returned to the platform.
	// The provider can also decide to execute the action request asynchronously and return an ActionRequestStatusPending.
	// It is then the responsibility of the provider to update the action request as soon as it is finished.
	RequestAction(ctx context.Context, instance *Instance, actionRequest ActionRequest) (ActionRequestStatus, error)

	// RegisterInstallations is called by the connector service to register new installations
	// Installations are registered whenever the service received an successful installation request or when the connector is started.
	RegisterInstallations(installations ...*Installation) error

	// RemoveInstance is called by the service if it received an installation removal request.
	RemoveInstallation(installationId string) error

	// RegisterInstances is called by the connector service to register new instances.
	// Instances are registered whenever the service received an successful instantiation request or when the connector is started.
	RegisterInstances(instances ...*Instance) error

	// RemoveInstance is called by the service if it received an instance removal request.
	RemoveInstance(instanceId string) error
}

type Step struct {
	Type    StepType `json:"type"`
	Content string   `json:"content"`
}

type StepType int

type ThingMapping struct {
	InstanceID string `db:"instance_id" json:"-"`
	ThingID    string `db:"thing_id" json:"thing_id"`
	ExternalID string `db:"external_id" json:"external_id"`
}

type ThingTemplate struct {
	Thing      connctd.Thing
	ExternalID string
}

type ThingTemplates func(request InstantiationRequest) []ThingTemplate

type UpdateEvent struct {
	ActionEvent         *ActionEvent
	PropertyUpdateEvent *PropertyUpdateEvent
}

type UpdateThingPropertyValueRequest struct {
	Value      string    `json:"value"`
	LastUpdate time.Time `json:"lastUpdate"`
}

type UpdateThingStatusRequest struct {
	Status connctd.StatusType `json:"status"`
}

type ValidationParameters struct {
	Scheme     string
	Host       string
	RequestURI string
}

type ValidationPreProcessor func(r *http.Request) ValidationParameters