td

type ActionAffordance struct {

	// AtType is the JSON-LD @type keyword to classify the action using standard vocabulary, or nil if not known
	// Intended for grouping and querying similar actions, and standardized presentation such as icons
	AtType any `json:"@type,omitempty"`

	// Multiline description
	Comments []string `json:"comments,omitempty"`
	// Provides additional (human-readable) information based on a default language
	Description string `json:"description,omitempty"`
	// Provides additional nulti-language information
	Descriptions []string `json:"descriptions,omitempty"`

	// Form hypermedia controls to describe how an operation can be performed
	// Forms are serializations of Protocol Bindings.
	Forms []Form `json:"forms,omitempty"`

	// Provides a human-readable title in the default language
	Title string `json:"title,omitempty"`
	// Provides a multi-language human-readable titles
	Titles []string `json:"titles,omitempty"`
	// Define URI template variables according to [RFC6570] as collection based on DataSchema declarations.
	// HiveOT supports linking uri variable to input
	UriVariables map[string]DataSchema `json:"uriVariables,omitempty"`
	// If this is a dataschema of a URIvariable, then:
	//  Hiveot:input links this as a URI variable schema to the affordance input
	//  If empty or '.', the matching URI variable will be pass as the default input
	//  Otherwise the content is a field name in the input dataschema.
	HiveotInput string `json:"hiveot:input,omitempty"`

	// Indicate whether the action is idempotent, eg repeated calls have the
	// same result.
	Idempotent bool `json:"idempotent,omitempty" default:"false"`

	// Define the input data Schema of the action or nil if the action doesn't take input data
	Input *DataSchema `json:"input,omitempty"`

	// Defines the output data Schema of the action or nil if the action doesn't have outputs
	Output *DataSchema `json:"output,omitempty"`

	// Signals if the Action is state safe or not.
	// Safe actions do not change the internal state of a resource.
	// Unsafe action are likely to affect one or more properties or emit events.
	Safe bool `json:"safe,omitempty" default:"false"`

	// A synchronous action means that the response of action contains all the information
	// about the result of the action and no further querying about the status of the action
	// is needed.
	// Lack of this keyword means that no claim on the synchronicity of the action
	// can be made.
	Synchronous bool `json:"synchronous,omitempty"`
}

type CredLoc string

type DataSchema struct {
	// JSON-LD keyword to classify the object with semantic tags, if any
	// Intended for grouping and querying similar data, and standardized presentation such as icons
	// For properties this would be the property type, eg temperature, humidity, etc.
	// For action input this is the action parameter type
	// For event data this is the event payload type
	AtType any `json:"@type,omitempty"`
	// Provides a human-readable title in the default language
	Title string `json:"title,omitempty"`
	// Provides a multi-language human-readable titles
	Titles []string `json:"titles,omitempty"`
	// Provides additional (human-readable) information based on a default language
	// this can be a string or array for multi-line description.
	Description string `json:"description,omitempty"`
	// Provides additional nulti-language information
	Descriptions []string `json:"descriptions,omitempty"`

	// Optional comments for additional multi-line descriptions
	// Not part of the WoT spec as it doesn't support multi-line descriptions
	Comments []string `json:"comments,omitempty"`

	// Provides a constant value of any type as per data Schema
	Const any `json:"const,omitempty"`

	// Provides a default value of any type as per data Schema
	Default any `json:"default,omitempty"`

	// Restricted set of values provided as an array.
	//  for example: ["option1", "option2"]
	Enum []any `json:"enum,omitempty"`

	// Allows validation based on a format pattern such as "date-time", "email", "uri", etc.
	// See vocab DataFormXyz "date-time", "email", "uri" (todo)
	Format string `json:"format,omitempty"`

	// OneOf provides constraint of data as one of the given data schemas
	OneOf []DataSchema `json:"oneOf,omitempty"`

	// Boolean value to indicate whether a property interaction / value is read-only (=true) or not (=false)
	// the value true implies read-only.
	ReadOnly bool `json:"readOnly"`

	// Boolean value to indicate whether a property interaction / value is write-only (=true) or not (=false)
	// the value true implies writable but not readable. Intended for secrets such as passwords.
	WriteOnly bool `json:"writeOnly,omitempty"`

	// Type provides JSON based data type,  one of DataTypeNumber, ...object, array, string, integer, boolean or null
	Type string `json:"type,omitempty"`

	// Reference to an external data schema when type is object
	Schema string `json:"schema,omitempty"`

	// Unit as used in international science, engineering, and business.
	// See vocab UnitNameXyz for units in the vocabulary
	Unit string `json:"unit,omitempty"`

	// ArraySchema with metadata describing data of type Array.
	// https://www.w3.org/TR/wot-thing-description/#arrayschema
	// Used to define the characteristics of an array.
	// Note that in golang a field cannot both be a single or an array of items
	// Right now 'items' has to be a dataschema
	ArrayItems *DataSchema `json:"items,omitempty"`
	// Defines the minimum number of items that have to be in the array
	ArrayMinItems uint `json:"minItems,omitempty"`
	// Defines the maximum number of items that have to be in the array.
	ArrayMaxItems uint `json:"maxItems,omitempty"`

	// NumberSchema with metadata describing data of type number.
	// This Subclass is indicated by the value number assigned to type in DataSchema instances.
	// Maximum specifies a maximum numeric value representing an upper limit
	// FIXME: both number and integer schemas have a minimum and maximum field.
	// Different types of course. How to flatten ?
	Maximum float64 `json:"maximum,omitempty"`
	// Minimum specifies a minimum numeric value representing a lower limit
	Minimum float64 `json:"minimum,omitempty"`

	// ObjectSchema with metadata describing data of type Object.
	// This Subclass is indicated by the value object assigned to type in DataSchema instances.
	// Properties of Object.
	Properties map[string]*DataSchema `json:"properties,omitempty"`
	// Defines which members of the object type are mandatory
	Required []string `json:"required,omitempty"`
	// object schema is a map with the data type defined in AdditionalProperties
	// this datatype can be a dataschema or a $ref string
	AdditionalProperties map[string]any `json:"additionalProperties,omitempty"`

	// StringSchema with metadata describing data of type string.
	// This Subclass is indicated by the value string assigned to type in DataSchema instances.
	// MaxLength specifies the maximum length of a string
	StringMaxLength uint `json:"maxLength,omitempty"`
	// MinLength specifies the minimum length of a string
	StringMinLength uint `json:"minLength,omitempty"`
	// Pattern provides a regular expression to express constraints.
	// The regular expression must follow the [ECMA-262] dialect.	optional
	StringPattern string `json:"pattern,omitempty"`
	// ContentEncoding specifies the encoding used to store the contents, as specified in RFC 2054.
	// e.g., 7bit, 8bit, binary, quoted-printable, or base64
	StringContentEncoding string `json:"contentEncoding,omitempty"`
	// ContentMediaType specifies the MIME type of the contents of a string value, as described in RFC 2046.
	// e.g., image/png, or audio/mpeg)
	StringContentMediaType string `json:"contentMediaType,omitempty"`
}

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

type EventAffordance struct {

	// AtType is the JSON-LD @type keyword to classify the action using standard vocabulary, or nil if not known
	// Intended for grouping and querying similar actions, and standardized presentation such as icons
	AtType any `json:"@type,omitempty"`

	// Multiline description
	Comments []string `json:"comments,omitempty"`
	// Provides additional (human-readable) information based on a default language
	Description string `json:"description,omitempty"`
	// Provides additional nulti-language information
	Descriptions []string `json:"descriptions,omitempty"`

	// Form hypermedia controls to describe how an operation can be performed
	// Forms are serializations of Protocol Bindings.
	Forms []Form `json:"forms,omitempty"`

	// Provides a human-readable title in the default language
	Title string `json:"title,omitempty"`
	// Provides a multi-language human-readable titles
	Titles []string `json:"titles,omitempty"`
	// Define URI template variables according to [RFC6570] as collection based on DataSchema declarations.
	// ... right
	UriVariables map[string]DataSchema `json:"uriVariables,omitempty"`

	// Data Schema of the event payload, if any. nil if the event comes without data
	Data *DataSchema `json:"data,omitempty"`
}

type Form map[string]any

type PropertyAffordance struct {
	DataSchema

	// This property contains a sensor value. This is not a WoT attribute.
	IsSensor bool `json:"isSensor,omitempty"`

	// This property contains an actuator state. This is not a WoT attribute.
	IsActuator bool `json:"isActuator,omitempty"`

	// Form hypermedia controls to describe how an operation can be performed
	// Forms are serializations of Protocol Bindings. Don't omit if empty as forms are mandatory.
	Forms []Form `json:"forms"`

	// Define URI template variables according to [RFC6570] as collection based on DataSchema declarations.
	// ... right
	UriVariables map[string]DataSchema `json:"uriVariables,omitempty"`

	// Optional nested properties. Map with PropertyAffordance
	Properties map[string]PropertyAffordance `json:"properties,omitempty"`
}

type SecurityScheme struct {
	// JSON-LD keyword to label the object with semantic tags (or types).
	AtType []string `json:"@type,omitempty"`

	// Provides additional (human-readable) information based on a default language
	Description string `json:"description,omitempty"`

	// Can be used to support (human-readable) information in different languages. Also see MultiLanguage.
	Descriptions []string `json:"descriptions,omitempty"`

	// URI of the proxy server this security configuration provides access to.
	// If not given, the corresponding security configuration is for the endpoint.
	Proxy string `json:"proxy,omitempty"`

	// Identification of the security mechanism being configured.
	// See also SecSchemeXyz above.
	Scheme string `json:"scheme"`

	//--- fields for bearer schema
	// URI of the authorization server
	// Used in Bearer Schema
	Authorization string `json:"authorization,omitempty"`

	// Name for query, header, cookie or uri parameters
	// Used in Bearer Schema
	Name string `json:"name,omitempty"`

	// Encoding, encryption, or digest algorithm
	// eg: ES256, ES512-256
	// Used in Bearer Schema
	Alg string `json:"alg,omitempty"`

	// Specifies format of security authentication information
	// e.g.: jwt, cwt, jwe, jws
	// Used in Bearer Schema
	Format string `json:"format,omitempty"`

	// Specifies the location of security authentication information.
	// one of: header, query, body, cookie or auto
	In CredLoc `json:"in,omitempty"`
}

type TD struct {
	// All action-based interaction affordances of the things
	Actions map[string]*ActionAffordance `json:"actions"`

	// AgentID is a hiveot extension containing the clientID of the agent that provided this TD
	// Intended for supporting reverse connections instead of forms.
	// FIXME: this field is tentative for use in the digitwin. If possible try to remove this dependency.
	AgentID string `json:"hiveot:agentID,omitempty"`

	// JSON-LD keyword to define shorthand names called terms that are used throughout a TD document. Required.
	// in order to add the "hiveot" namespace, the context value can be a string or map
	// Type: anyURO or Array
	AtContext []any `json:"@context"`

	// JSON-LD keyword to label the object with semantic tags (or types).
	// in HiveOT this contains the device type defined in the vocabulary.
	// Intended for grouping and querying similar devices, and standardized presentation such as icons
	AtType any `json:"@type,omitempty"`

	// Base: The base URI that is used for all relative URI references throughout a TD document.
	Base string `json:"base,omitempty"`

	// ISO8601 timestamp this document was first created. See also 'Modified'.
	Created string `json:"created,omitempty"`

	// Describe the device in the default human-readable language.
	// It is recommended to use the product description.
	Description string `json:"description,omitempty"`
	// Provides additional nulti-language information
	Descriptions []string `json:"descriptions,omitempty"`

	// All event-based interaction affordances of the things
	Events map[string]*EventAffordance `json:"events"`

	// Form hypermedia controls to describe how an operation can be performed. Forms are serializations of
	// Protocol Bindings. Thing-level forms are used to describe endpoints for a group of interaction affordances.
	Forms []Form `json:"forms,omitempty"`

	// ID is the Thing instance identifier.
	ID string `json:"id,omitempty"`

	// ISO8601 timestamp this document was last modified. See also 'Created'.
	Modified string `json:"modified,omitempty"`

	// Indicates the WoT Profile mechanisms followed by this Thing Description and
	// the corresponding Thing implementation.
	// Type: anyURI or Array of anyURI
	Profile any `json:"profile,omitempty"`

	// All properties-based interaction affordances of the things
	Properties map[string]*PropertyAffordance `json:"properties"`

	SchemaDefinitions map[string]DataSchema `json:"schemaDefinitions,omitempty"`

	// Security is a string or array of strings, chosen from those defined in securityDefinitions.
	// See also constants defined 'SecSchemeXyz'
	Security any `json:"security"`

	// Set of named security configurations (definitions only).
	// Not actually applied unless names are used in a security name-value pair. (why is this mandatory then?)
	SecurityDefinitions map[string]SecurityScheme `json:"securityDefinitions"`

	// Title is the name of the thing in human-readable in the default language. Required.
	// The same name is provided through the properties configuration, where it can be changed.
	// This allows to present the TD by its name without having to load its property values.
	Title string `json:"title"`
	// Human-readable titles in the different languages
	Titles map[string]string `json:"titles,omitempty"`

	// Provides information about the TD maintainer as URI scheme (e.g., mailto [RFC6068], tel [RFC3966], https [RFC9112]).
	Support string `json:"support,omitempty"`
}