client

type APIError struct {
	// The response that triggered this error
	HTTPResponse *http.Response
}

type AuthAppInfo struct {
	// The name of the app that will appear in the SAFE launcher
	Name string `json:"name"`
	// The ID of the app
	ID string `json:"id"`
	// The app version
	Version string `json:"version"`
	// The app vendor name
	Vendor string `json:"vendor"`
}

type AuthInfo struct {
	// This is the required app information
	App AuthAppInfo `json:"app"`
	// Set of permissions that this app will register with. See AuthPerm* constants.
	Permissions []string `json:"permissions"`
	// The public key to use when authorizing. Leave blank to generate at runtime.
	PublicKey []byte `json:"publicKey"`
	// The private key to use when authorizing. Leave blank to generate at runtime.
	PrivateKey []byte `json:"-"`
	// The nonce to use when authorizing. Leave blank to generate at runtime.
	Nonce []byte `json:"nonce"`
}

type AuthResult struct {
	// The original request
	Request AuthInfo
	// The JSON web token for this app to use
	Token string
	// The shared key to use when encrypting/decrypting to/from the SAFE launcher
	SharedKey []byte
	// The nonce to use when encrypting/decrypting to/from the SAFE launcher
	Nonce []byte
}

type ChangeDirInfo struct {
	// The path to change
	DirPath string `json:"-"`
	// Whether the directory is shared
	Shared bool `json:"-"`
	// The name to change it to. If Metadata is not set, this must be set.
	NewName string `json:"name,omitempty"`
	// The metadata to set. If NewName is not set, this must be set.
	Metadata string `json:"metadata,omitempty"`
}

type ChangeFileInfo struct {
	FilePath string `json:"-"`
	Shared   bool   `json:"-"`
	NewName  string `json:"name,omitempty"`
	Metadata string `json:"metadata,omitempty"`
}

type Client struct {
	// The configuration for the client including auth and encryption information
	Conf Conf
	// The HTTP client to use. This must be present. NewClient populates this with http.DefaultClient by default.
	HTTPClient *http.Client
	// A custom request builder. If not set it will default to the normal builder. NewClient populates this with the
	// default value so developers can override this value as a proxy and call the existing one if necessary.
	RequestBuilder RequestBuilder
	// A custom response handler. If not set it will default to the normal builder. NewClient populates this with
	// the default value so developers can override this value as a proxy and call the existing one if necessary.
	ResponseHandler ResponseHandler
	// If present, debug logs will be logged here
	Logger *log.Logger
}

type Conf struct {
	// The LauncherBaseURL. If this is not present it is defaulted to http://localhost:8100/ in NewClient.
	LauncherBaseURL string `json:"launcherServer,omitempty"`
	// The JSON web token to use to authenticate on authenticated calls. This is required for authenticated calls.
	// It is autopopulated by Client.EnsureAuthed if invalid.
	Token string `json:"token,omitempty"`
	// The shared key for encryption/decryption. This is required for encrypted calls. It is autopopulated by
	// Client.EnsureAuthed if invalid.
	SharedKey []byte `json:"sharedKey,omitempty"`
	// The nonce for encryption/decryption. This is required for encrypted calls. It is autopopulated by
	// Client.EnsureAuthed if invalid.
	Nonce []byte `json:"nonce,omitempty"`
}

type CreateDirInfo struct {
	// The path to create
	DirPath string `json:"dirPath"`
	// Whether the directory is private
	Private bool `json:"isPrivate"`
	// Whether the directory is versioned
	Versioned bool `json:"isVersioned"`
	// Metadata to store with the directory
	Metadata string `json:"metadata"`
	// Whether the directory is shared
	Shared bool `json:"isPathShared"`
}

type CreateFileInfo struct {
	// The path to create
	FilePath string `json:"filePath"`
	// Whether the path is shared
	Shared bool `json:"isPathShared"`
	// Metadata to store with the file
	Metadata string `json:"metadata"`
}

type DNSAddServiceInfo struct {
	// The DNS name to add the service to
	Name string `json:"longName"`
	// The service name to add
	ServiceName string `json:"serviceName"`
	// The directory to assign
	HomeDirPath string `json:"serviceHomeDirPath"`
	// Whether the path is shared
	Shared bool `json:"isPathShared"`
}

type DNSFile struct {
	// File info about the DNS file
	Info FileInfo
	// The mime type of the content from SAFE
	ContentType string
	// The contents of the file
	Body io.ReadCloser
}

type DNSFileInfo struct {
	// The DNS name this file is at
	Name string
	// The service name this file is at
	Service string
	// The path to the file
	FilePath string
	// The offset to read from
	Offset int64
	// The number of bytes to read. 0 means no limit.
	Length int64
}

type DNSRegisterInfo struct {
	// The DNS name to register
	Name string `json:"longName"`
	// The service name to register
	ServiceName string `json:"serviceName"`
	// The home directory path to register
	HomeDirPath string `json:"serviceHomeDirPath"`
	// Whether the path is shared or not
	Shared bool `json:"isPathShared"`
}

type DeleteDirInfo struct {
	// The path to delete
	DirPath string
	// Whether the path is shared
	Shared bool
}

type DeleteFileInfo struct {
	// The path to delete
	FilePath string
	// Whether the path is shared
	Shared bool
}

type DirInfo struct {
	Name       string `json:"name"`
	Private    bool   `json:"isPrivate"`
	Versioned  bool   `json:"isVersioned"`
	CreatedOn  Time   `json:"createdOn"`
	ModifiedOn Time   `json:"modifiedOn"`
	Metadata   string `json:"metadata"`
}

type DirResponse struct {
	// Info about the directory requested
	Info DirInfo `json:"info"`
	// All files inside the directory
	Files Files `json:"files"`
	// All sub directories in the directory
	SubDirs Dirs `json:"subDirectories"`
}

type Dirs []DirInfo

type FileInfo struct {
	Name       string `json:"name"`
	Size       int64  `json:"size"`
	CreatedOn  Time   `json:"createdOn"`
	ModifiedOn Time   `json:"modifiedOn"`
	Metadata   string `json:"metadata"`
}

type Files []FileInfo

type GetDirInfo struct {
	// The path to fetch
	DirPath string
	// Whether the directory is shared
	Shared bool
}

type GetFileInfo struct {
	// The path to get
	FilePath string
	// Whether the path is shared
	Shared bool
	// The byte offset to start reading at
	Offset int64
	// The amount of bytes to read. If the value is 0 then there is no length constraint
	Length int64
}

type MoveDirInfo struct {
	SrcPath      string `json:"srcPath"`
	SrcShared    bool   `json:"isSrcPathShared"`
	DestPath     string `json:"destPath"`
	DestShared   bool   `json:"isDestPathShared"`
	RetainSource bool   `json:"retainSource"`
}

type MoveFileInfo struct {
	SrcPath      string `json:"srcPath"`
	SrcShared    bool   `json:"isSrcPathShared"`
	DestPath     string `json:"destPath"`
	DestShared   bool   `json:"isDestPathShared"`
	RetainSource bool   `json:"retainSource"`
}

type Request struct {
	// The URL path to call not including the host information. Note, if there are things inside of the path that
	// should be URL encoded, they must be encoded before calling this. If this value does not start with a slash,
	// it is treated as though it does.
	Path string
	// The HTTP method to use for the call
	Method string
	// If not nil, this value will be JSON marshalled into the body overriding any value that may be in RawBody
	JSONBody interface{}
	// If not nil and JSONBody is nil, this will be used as the HTTP request body. NOTE: an empty array is still
	// considered a body of content length 0.
	RawBody []byte
	// The query values to send in the request
	Query url.Values
	// If true, the request body and query params will NOT be encrypted and the response body will NOT be decrypted
	DoNotEncrypt bool
	// If not nil, successful responses will JSON-unmarshalled into this object
	JSONResponse interface{}
	// If true, the request will not be authenticated with Client.Conf.Token
	DoNotAuth bool
}

type RequestBuilder func(c *Client, req *Request) (*http.Request, error)

type ResponseHandler func(c *Client, resp *http.Response, decrypt bool, jsonResponse interface{}) error

type Time int64

type WriteFileInfo struct {
	// The path to write to
	FilePath string
	// Whether the path is shared
	Shared bool
	// The contents to write
	Contents io.ReadCloser
	// The byte offset in the file to start writing
	Offset int64
}