notebook

type Author struct {
	Name   string            `json:"name"`
	Extras map[string]string `json:"-"`
}

type Base64Figure struct {
	Id          string
	ContentType string
	Url         string
	Data        []byte
	Alt         string
	Caption     string
	IsPrimary   bool
	FullSize    bool
	Href        string
	Resource    *Resource
}

type Cell interface {
	GetType() string
	GetInput() []string
	GetOutputs() []Output
	GetMetadata() CellMetadata

	RenderInput(r Renderer) error
	RenderOutput(r Renderer) error
	GetRaw() []byte
}

type CellMetadata struct {
	Name      string   `json:"name,omitempty"`
	Tags      []string `json:"tags,omitempty"`
	Collapsed bool     `json:"collapsed,omitempty"`
	Editable  bool     `json:"editable,omitempty"`
	Deletable bool     `json:"deletable,omitempty"`
	Format    string   `json:"format,omitempty"`

	Jupyter JupyterMetaData `json:"jupyter,omitempty"`
}

type CodeCell struct {
	CellType string       `json:"cell_type"`
	Metadata CellMetadata `json:"metadata"`
	Source   []string     `json:"source"`
	Outputs  []Output     `json:"outputs"`
	Raw      []byte       `json:"-"`
}

type CodeMirrorMode struct {
	Name    string `json:"name,omitempty"`
	Version int    `json:"version,omitempty"`
}

type DisplayData struct {
	OutputType string         `json:"output_type"`
	Data       MimeBundle     `json:"data"`
	Metadata   OutputMetadata `json:"metadata"`
}

type ErrorOutput struct {
	OutputType string   `json:"output_type"`
	EName      string   `json:"ename"`
	EValue     string   `json:"evalue"`
	Traceback  []string `json:"traceback"`
}

type ExecuteResult struct {
	OutputType   string         `json:"output_type"`
	ExecuteCount int            `json:"execution_count"`
	Data         MimeBundle     `json:"data"`
	Metadata     OutputMetadata `json:"metadata"`
}

type Falsifiable struct {
	Title     string   `json:"title,omitempty"`
	Subtitle  string   `json:"subtitle,omitempty"`
	CreatedAt string   `json:"created_at,omitempty"`
	UpdatedAt string   `json:"updated_at,omitempty"`
	Authors   []string `json:"authors,omitempty"`

	User string `json:"user,omitempty"`
	Slug string `json:"slug,omitempty"`
	Repo string `json:"repo,omitempty"`

	PrimaryImageCH string `json:"-"`
}

type JupyterMetaData struct {
	SourceHidden  bool `json:"source_hidden,omitempty"`
	OutputsHidden bool `json:"outputs_hidden,omitempty"`
}

type KernelSpec struct {
	Name        string `json:"name"`
	DisplayName string `json:"display_name"`
	Language    string `json:"language"`
}

type LanguageInfo struct {
	CodeMirrorMode    CodeMirrorMode `json:"codemirror_mode,omitempty"`
	FileExtension     string         `json:"file_extension,omitempty"`
	MimeType          string         `json:"mimetype,omitempty"`
	Name              string         `json:"name,omitempty"`
	NBConvertExporter string         `json:"nbconvert_exporter,omitempty"`
	PygmentsLexer     string         `json:"pygments_lexer,omitempty"`
	Version           string         `json:"version,omitempty"`
}

type MarkdownCell struct {
	CellType string       `json:"cell_type"`
	Metadata CellMetadata `json:"metadata"`
	Source   []string     `json:"source"`
	Raw      []byte       `json:"-"`
}

type MetaData struct {
	LanguageInfo LanguageInfo `json:"language_info"`
	KernelSpec   KernelSpec   `json:"kernelspec"`
	Falsifiable  Falsifiable  `json:"falsifiable"`
	OrigFmt      int          `json:"orig_nbformat,omitempty"` // TODO
	Title        string       `json:"title,omitempty"`         // TODO
	Authors      []Author     `json:"authors,omitempty"`
	// TODO: SPDX license keys
	Raw []byte `json:"-"`
}

type MimeBundle = map[string][]string

type Notebook struct {
	VersionMajor int      `json:"nbformat"`
	VersionMinor int      `json:"nbformat_minor"`
	MetaData     MetaData `json:"metadata"`
	Cells        []Cell   `json:"cells"`

	Raw []byte `json:"-"`
}

type Opt func(p *Parser)

type Output interface {
	Type() string
	Render(r Renderer) error
}

type OutputFigureMetadata struct {
	Alt       string `json:"alt,omitempty"`
	Caption   string `json:"caption,omitempty"`
	Href      string `json:"href,omitempty"`
	FullSize  bool   `json:"fullsize,omitempty"`
	IsPrimary bool   `json:"primary,omitempty"`
}

type OutputMetadata struct {
	NeedsBackground string `json:"needs_background,omitempty"`
	FigureMeta      map[string]OutputFigureMetadata
}

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

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

type RawCell struct {
	CellType string       `json:"cell_type"`
	Metadata CellMetadata `json:"metadata"`
	Source   []string     `json:"source"`
	Raw      []byte       `json:"-"`
}

type Renderer interface {
	SetMetadata(metadata MetaData)
	GetDefaultLang() string

	WriteOutputs(outputs []Output) error
	WriteHTMLUnsafely(lines []string) error
	GetResources() map[string]*Resource
	WriteB64Image(fig *Base64Figure) (string, error)
	WriteHTMLEscapedLines(lines []string) error
	WriteMarkdownLines(lines []string) error
	WriteMarkdownCodeFenced(lang string, lines []string) error
	GetResource(contentHash string) *Resource
	WritePlainText(class string, lines []string, clean bool) error
}

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

type StreamOutput struct {
	Name       string   `json:"name"`
	OutputType string   `json:"output_type"`
	Text       []string `json:"text"`
}

type UnrecognizedCell struct {
	CellType string       `json:"cell_type"`
	Metadata CellMetadata `json:"metadata"`
	Raw      []byte       `json:"-"`
}