client

Documentation

Index

• Constants
• type Client
  • func NewClient() (*Client, error)
  • func (client *Client) Authenticate() error
  • func (client *Client) Clear() error
  • func (client *Client) Connect(ctx context.Context) error
  • func (client *Client) Disconnect() error
  • func (client *Client) GetLocalDiffs() []NoteChange
  • func (client *Client) GetNoteName(noteID NoteID, content string) string
  • func (client *Client) OpenBucket(bucketName string, ctx context.Context) error
  • func (client *Client) OpenProjectDir() error
  • func (client *Client) RefetchSync(ctx context.Context) error
  • func (client *Client) Sync(ctx context.Context) error
  • func (client *Client) Upload(ctx context.Context, diffs []NoteChange) error
• type Note
• type NoteChange
• type NoteDiff
• type NoteID
• type NoteResponse

Constants

const (
	CHANGE_VERSION = "cv"
	AUTH_TOKEN     = "tok"
)

storage keys

const API_KEY = "26864ab5d6fd4a37b80343439f107350"

from official Simplenote application

const APP_ID = "chalk-bump-f49"

Types

type Client

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

func NewClient

func NewClient() (*Client, error)

func (*Client) Authenticate

func (client *Client) Authenticate() error

retrieve user authentication token

func (*Client) Clear

func (client *Client) Clear() error

clear and remove all data

func (*Client) Connect

func (client *Client) Connect(ctx context.Context) error

connect to the server websocket

func (*Client) Disconnect

func (client *Client) Disconnect() error

disconnect from the server websocket

func (*Client) GetLocalDiffs

func (client *Client) GetLocalDiffs() []NoteChange

func (*Client) GetNoteName

func (client *Client) GetNoteName(noteID NoteID, content string) string

given a note id and content string, returns a unique note name identifier if one does not already exist in storage

func (*Client) OpenBucket

func (client *Client) OpenBucket(bucketName string, ctx context.Context) error

authorize access to a given bucket

func (*Client) OpenProjectDir

func (client *Client) OpenProjectDir() error

func (*Client) RefetchSync

func (client *Client) RefetchSync(ctx context.Context) error

initial sync to load (or reload) all notes

func (*Client) Sync

func (client *Client) Sync(ctx context.Context) error

sync client notes

func (*Client) Upload

func (client *Client) Upload(ctx context.Context, diffs []NoteChange) error

upload and sync local diffs with server

type Note

type Note struct {
	// do not store ID, it will be used as the map key
	Version int    `json:"v"`
	Name    string `json:"n"`
}

type NoteChange

type NoteChange s.Change[NoteDiff]

type NoteDiff

type NoteDiff struct {
	Tags             j.JSONDiff[[]string] `json:"tags,omitempty"`
	Deleted          j.BoolJSONDiff       `json:"deleted,omitempty"`
	ShareURL         j.StringJSONDiff     `json:"shareURL,omitempty"`
	PublishURL       j.StringJSONDiff     `json:"publishURL,omitempty"`
	Content          j.StringJSONDiff     `json:"content,omitempty"`
	SystemTags       j.JSONDiff[[]string] `json:"systemTags,omitempty"`
	ModificationDate j.Float32JSONDiff    `json:"modificationDate,omitempty"`
	CreationDate     j.Float32JSONDiff    `json:"creationDate,omitempty"`
}

type NoteID

type NoteID string

type NoteResponse

type NoteResponse struct {
	Tags             []string `json:"tags"`
	Deleted          bool     `json:"deleted"`
	ShareURL         string   `json:"shareURL"`
	PublishURL       string   `json:"publishURL"`
	Content          string   `json:"content"`
	SystemTags       []string `json:"systemTags"`
	ModificationDate float32  `json:"modificationDate"`
	CreationDate     float32  `json:"creationDate"`
}