libsf

type Auth interface {
	// Email returns the email used for authentication.
	Email() string
	// Identifier returns the identifier (email) used for authentication.
	Identifier() string
	// Version returns the encryption scheme version.
	Version() string
	// IntegrityCheck checks if the Auth params are valid.
	IntegrityCheck() error
	// SymmetricKeyPair returns a KeyChain for the given uip (plaintext password of the user).
	// https://github.com/standardfile/standardfile.github.io/blob/master/doc/spec.md#client-instructions
	SymmetricKeyPair(uip string) *KeyChain
}

type Client interface {
	// GetAuthParams returns the parameters of a user from StandardFile server.
	GetAuthParams(email string) (Auth, error)
	// Login connects the Client to the StandardFile server.
	Login(email, password string) error
	// Logout disconnects the client (since API 20200115).
	Logout() error
	// BearerToken returns the authentication used for requests sent to the StandardFile server.
	// It can be a JWT or an access token from a session.
	BearerToken() string
	// SetBearerToken sets the authentication used for requests sent to the StandardFile server.
	// It can be a JWT or an access token from a session.
	SetBearerToken(token string)
	// Session returns the authentication session used for authentication (since API 20200115).
	Session() Session
	// SetSession sets the authentication session used for authentication (since API 20200115).
	// It also uses its access token as the bearer token.
	SetSession(session Session)
	// RefreshSession gets a new pair of tokens by refreshing the session.
	RefreshSession(access, refresh string) (*Session, error)
	// SyncItems synchronizes local items with the StandardFile server.
	SyncItems(si SyncItems) (SyncItems, error)
}

type ConflictItem struct {
	UnsavedItem Item   `json:"unsaved_item,omitempty"`
	ServerItem  Item   `json:"server_item,omitempty"`
	Type        string `json:"type"`
}

type Item struct {
	ID        string     `json:"uuid"`
	CreatedAt *time.Time `json:"created_at"`
	UpdatedAt *time.Time `json:"updated_at"`

	UserID           string `json:"user_uuid"`
	Content          string `json:"content"`
	ContentType      string `json:"content_type"`
	ItemsKeyID       string `json:"items_key_id"` // Since 20200115
	EncryptedItemKey string `json:"enc_item_key"`
	Deleted          bool   `json:"deleted"`

	// Internal
	Version    string `json:"-"`
	AuthParams Auth   `json:"-"`
	Note       *Note  `json:"-"`
	// contains filtered or unexported fields
}

type KeyChain struct {
	Version   string            `json:"version"`
	Password  string            `json:"password,omitempty"` // Server's password
	MasterKey string            `json:"mk"`
	AuthKey   string            `json:"ak,omitempty"` // Before protocol 004
	ItemsKey  map[string]string `json:"-"`            // Since protocol 004
}

type Note struct {
	Title        string          `json:"title"`
	Text         string          `json:"text"`
	PreviewPlain string          `json:"preview_plain"`
	PreviewHTML  string          `json:"preview_html"`
	References   json.RawMessage `json:"references"` // unstructured data
	AppData      json.RawMessage `json:"appData"`    // unstructured data
	// contains filtered or unexported fields
}

type SFError struct {
	StatusCode int
	Err        struct {
		Message string `json:"message"`
	} `json:"error"`
}

type Session struct {
	AccessToken       string    `json:"access_token"`
	RefreshToken      string    `json:"refresh_token"`
	AccessExpiration  time.Time `json:"access_expiration"`
	RefreshExpiration time.Time `json:"refresh_expiration"`
}

type SyncItems struct {
	// Common fields
	API              string `json:"api"` // Since 20190520
	ComputeIntegrity bool   `json:"compute_integrity,omitempty"`
	Limit            int    `json:"limit,omitempty"`
	SyncToken        string `json:"sync_token,omitempty"`
	CursorToken      string `json:"cursor_token,omitempty"`
	ContentType      string `json:"content_type,omitempty"` // optional, only return items of these type if present

	// Fields used for request
	Items []*Item `json:"items,omitempty"`

	// Fields used in response
	Retrieved []*Item `json:"retrieved_items,omitempty"`
	Saved     []*Item `json:"saved_items,omitempty"`

	Unsaved   []*UnsavedItem  `json:"unsaved,omitempty"`   // Before 20190520 (Since 20161215 at least)
	Conflicts []*ConflictItem `json:"conflicts,omitempty"` // Since 20190520
}

type UnsavedItem struct {
	Item  Item `json:"item"`
	Error struct {
		Message string `json:"message"`
		Tag     string `json:"tag"`
	} `json:"error"`
}