baboon

package
v0.1.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 16, 2025 License: MIT Imports: 20 Imported by: 0

Documentation

Index

Constants

View Source
const AssetsPathPrefix = "/twirp/ttab.baboon.Assets/"

AssetsPathPrefix is a convenience constant that may identify URL paths. Should be used with caution, it only matches routes generated by Twirp Go clients, with the default "/twirp" prefix and default CamelCase service and method names. More info: https://twitchtv.github.io/twirp/docs/routing.html

View Source
const PrintPathPrefix = "/twirp/ttab.baboon.Print/"

PrintPathPrefix is a convenience constant that may identify URL paths. Should be used with caution, it only matches routes generated by Twirp Go clients, with the default "/twirp" prefix and default CamelCase service and method names. More info: https://twitchtv.github.io/twirp/docs/routing.html

Variables

View Source
var (
	FrameType_name = map[int32]string{
		0: "FRAME_UNKNOWN",
		1: "FRAME_TEXT",
		2: "FRAME_IMAGE",
	}
	FrameType_value = map[string]int32{
		"FRAME_UNKNOWN": 0,
		"FRAME_TEXT":    1,
		"FRAME_IMAGE":   2,
	}
)

Enum value maps for FrameType.

View Source
var File_baboon_service_proto protoreflect.FileDescriptor

Functions

func WriteError

func WriteError(resp http.ResponseWriter, err error)

WriteError writes an HTTP response with a valid Twirp error format (code, msg, meta). Useful outside of the Twirp server (e.g. http middleware), but does not trigger hooks. If err is not a twirp.Error, it will get wrapped with twirp.InternalErrorWith(err)

Types

type Assets

func NewAssetsJSONClient

func NewAssetsJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Assets

NewAssetsJSONClient creates a JSON client that implements the Assets interface. It communicates using JSON and can be configured with a custom HTTPClient.

func NewAssetsProtobufClient

func NewAssetsProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Assets

NewAssetsProtobufClient creates a Protobuf client that implements the Assets interface. It communicates using Protobuf and can be configured with a custom HTTPClient.

type CopyArticleToFlowRequest

type CopyArticleToFlowRequest struct {

	// SourceUuid is the UUID of the article that we want to copy. Required.
	SourceUuid string `protobuf:"bytes,1,opt,name=source_uuid,json=sourceUuid,proto3" json:"source_uuid,omitempty"`
	// FlowUuid to copy the article to. Required.
	FlowUuid string `protobuf:"bytes,2,opt,name=flow_uuid,json=flowUuid,proto3" json:"flow_uuid,omitempty"`
	// Date to set for the copy on in the format YYYY-MM-DD. Required.
	Date string `protobuf:"bytes,3,opt,name=date,proto3" json:"date,omitempty"`
	// Article is the name of the defined print content in the flow to
	// instantiate. Required.
	Article string `protobuf:"bytes,4,opt,name=article,proto3" json:"article,omitempty"`
	// contains filtered or unexported fields
}

func (*CopyArticleToFlowRequest) Descriptor deprecated

func (*CopyArticleToFlowRequest) Descriptor() ([]byte, []int)

Deprecated: Use CopyArticleToFlowRequest.ProtoReflect.Descriptor instead.

func (*CopyArticleToFlowRequest) GetArticle

func (x *CopyArticleToFlowRequest) GetArticle() string

func (*CopyArticleToFlowRequest) GetDate

func (x *CopyArticleToFlowRequest) GetDate() string

func (*CopyArticleToFlowRequest) GetFlowUuid

func (x *CopyArticleToFlowRequest) GetFlowUuid() string

func (*CopyArticleToFlowRequest) GetSourceUuid

func (x *CopyArticleToFlowRequest) GetSourceUuid() string

func (*CopyArticleToFlowRequest) ProtoMessage

func (*CopyArticleToFlowRequest) ProtoMessage()

func (*CopyArticleToFlowRequest) ProtoReflect

func (x *CopyArticleToFlowRequest) ProtoReflect() protoreflect.Message

func (*CopyArticleToFlowRequest) Reset

func (x *CopyArticleToFlowRequest) Reset()

func (*CopyArticleToFlowRequest) String

func (x *CopyArticleToFlowRequest) String() string

type CopyArticleToFlowResponse

type CopyArticleToFlowResponse struct {

	// Uuid of the created article.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// contains filtered or unexported fields
}

func (*CopyArticleToFlowResponse) Descriptor deprecated

func (*CopyArticleToFlowResponse) Descriptor() ([]byte, []int)

Deprecated: Use CopyArticleToFlowResponse.ProtoReflect.Descriptor instead.

func (*CopyArticleToFlowResponse) GetUuid

func (x *CopyArticleToFlowResponse) GetUuid() string

func (*CopyArticleToFlowResponse) ProtoMessage

func (*CopyArticleToFlowResponse) ProtoMessage()

func (*CopyArticleToFlowResponse) ProtoReflect

func (*CopyArticleToFlowResponse) Reset

func (x *CopyArticleToFlowResponse) Reset()

func (*CopyArticleToFlowResponse) String

func (x *CopyArticleToFlowResponse) String() string

type CreateFlowRequest

type CreateFlowRequest struct {

	// FlowUuid to instantiate on the given date. Required.
	FlowUuid string `protobuf:"bytes,1,opt,name=flow_uuid,json=flowUuid,proto3" json:"flow_uuid,omitempty"`
	// Date to instantiate the flow on in the format YYYY-MM-DD. Required.
	Date string `protobuf:"bytes,2,opt,name=date,proto3" json:"date,omitempty"`
	// Articles to instantiate. Names of the defined print contents in the
	// flow. Optional, omit to instantiate all.
	Articles []string `protobuf:"bytes,3,rep,name=articles,proto3" json:"articles,omitempty"`
	// TemplateUUID is the UUID of an article to use as a template for the created
	// print articles. Optional.
	TemplateUuid string `protobuf:"bytes,4,opt,name=template_uuid,json=templateUuid,proto3" json:"template_uuid,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateFlowRequest) Descriptor deprecated

func (*CreateFlowRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateFlowRequest.ProtoReflect.Descriptor instead.

func (*CreateFlowRequest) GetArticles

func (x *CreateFlowRequest) GetArticles() []string

func (*CreateFlowRequest) GetDate

func (x *CreateFlowRequest) GetDate() string

func (*CreateFlowRequest) GetFlowUuid

func (x *CreateFlowRequest) GetFlowUuid() string

func (*CreateFlowRequest) GetTemplateUuid added in v0.1.5

func (x *CreateFlowRequest) GetTemplateUuid() string

func (*CreateFlowRequest) ProtoMessage

func (*CreateFlowRequest) ProtoMessage()

func (*CreateFlowRequest) ProtoReflect

func (x *CreateFlowRequest) ProtoReflect() protoreflect.Message

func (*CreateFlowRequest) Reset

func (x *CreateFlowRequest) Reset()

func (*CreateFlowRequest) String

func (x *CreateFlowRequest) String() string

type CreateFlowResponse

type CreateFlowResponse struct {

	// Articles that were created.
	Articles []*PrintArticleReference `protobuf:"bytes,1,rep,name=articles,proto3" json:"articles,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateFlowResponse) Descriptor deprecated

func (*CreateFlowResponse) Descriptor() ([]byte, []int)

Deprecated: Use CreateFlowResponse.ProtoReflect.Descriptor instead.

func (*CreateFlowResponse) GetArticles

func (x *CreateFlowResponse) GetArticles() []*PrintArticleReference

func (*CreateFlowResponse) ProtoMessage

func (*CreateFlowResponse) ProtoMessage()

func (*CreateFlowResponse) ProtoReflect

func (x *CreateFlowResponse) ProtoReflect() protoreflect.Message

func (*CreateFlowResponse) Reset

func (x *CreateFlowResponse) Reset()

func (*CreateFlowResponse) String

func (x *CreateFlowResponse) String() string

type DeleteFontRequest

type DeleteFontRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteFontRequest) Descriptor deprecated

func (*DeleteFontRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteFontRequest.ProtoReflect.Descriptor instead.

func (*DeleteFontRequest) GetName

func (x *DeleteFontRequest) GetName() string

func (*DeleteFontRequest) ProtoMessage

func (*DeleteFontRequest) ProtoMessage()

func (*DeleteFontRequest) ProtoReflect

func (x *DeleteFontRequest) ProtoReflect() protoreflect.Message

func (*DeleteFontRequest) Reset

func (x *DeleteFontRequest) Reset()

func (*DeleteFontRequest) String

func (x *DeleteFontRequest) String() string

type DeleteFontResponse

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

func (*DeleteFontResponse) Descriptor deprecated

func (*DeleteFontResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeleteFontResponse.ProtoReflect.Descriptor instead.

func (*DeleteFontResponse) ProtoMessage

func (*DeleteFontResponse) ProtoMessage()

func (*DeleteFontResponse) ProtoReflect

func (x *DeleteFontResponse) ProtoReflect() protoreflect.Message

func (*DeleteFontResponse) Reset

func (x *DeleteFontResponse) Reset()

func (*DeleteFontResponse) String

func (x *DeleteFontResponse) String() string

type Font

type Font struct {
	Name        string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Version     string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	File        []byte `protobuf:"bytes,5,opt,name=file,proto3" json:"file,omitempty"`
	// contains filtered or unexported fields
}

func (*Font) Descriptor deprecated

func (*Font) Descriptor() ([]byte, []int)

Deprecated: Use Font.ProtoReflect.Descriptor instead.

func (*Font) GetDescription

func (x *Font) GetDescription() string

func (*Font) GetFile

func (x *Font) GetFile() []byte

func (*Font) GetName

func (x *Font) GetName() string

func (*Font) GetVersion

func (x *Font) GetVersion() string

func (*Font) ProtoMessage

func (*Font) ProtoMessage()

func (*Font) ProtoReflect

func (x *Font) ProtoReflect() protoreflect.Message

func (*Font) Reset

func (x *Font) Reset()

func (*Font) String

func (x *Font) String() string

type FontInfo

type FontInfo struct {
	Name        string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Version     string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

func (*FontInfo) Descriptor deprecated

func (*FontInfo) Descriptor() ([]byte, []int)

Deprecated: Use FontInfo.ProtoReflect.Descriptor instead.

func (*FontInfo) GetDescription

func (x *FontInfo) GetDescription() string

func (*FontInfo) GetName

func (x *FontInfo) GetName() string

func (*FontInfo) GetVersion

func (x *FontInfo) GetVersion() string

func (*FontInfo) ProtoMessage

func (*FontInfo) ProtoMessage()

func (*FontInfo) ProtoReflect

func (x *FontInfo) ProtoReflect() protoreflect.Message

func (*FontInfo) Reset

func (x *FontInfo) Reset()

func (*FontInfo) String

func (x *FontInfo) String() string

type FontRef

type FontRef struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// IfNotVersion can be used to only return a font if it hasn't been updated.
	IfNotVersion string `protobuf:"bytes,2,opt,name=if_not_version,json=ifNotVersion,proto3" json:"if_not_version,omitempty"`
	// contains filtered or unexported fields
}

func (*FontRef) Descriptor deprecated

func (*FontRef) Descriptor() ([]byte, []int)

Deprecated: Use FontRef.ProtoReflect.Descriptor instead.

func (*FontRef) GetIfNotVersion

func (x *FontRef) GetIfNotVersion() string

func (*FontRef) GetName

func (x *FontRef) GetName() string

func (*FontRef) ProtoMessage

func (*FontRef) ProtoMessage()

func (*FontRef) ProtoReflect

func (x *FontRef) ProtoReflect() protoreflect.Message

func (*FontRef) Reset

func (x *FontRef) Reset()

func (*FontRef) String

func (x *FontRef) String() string

type FrameType

type FrameType int32
const (
	FrameType_FRAME_UNKNOWN FrameType = 0
	FrameType_FRAME_TEXT    FrameType = 1
	FrameType_FRAME_IMAGE   FrameType = 2
)

func (FrameType) Descriptor

func (FrameType) Descriptor() protoreflect.EnumDescriptor

func (FrameType) Enum

func (x FrameType) Enum() *FrameType

func (FrameType) EnumDescriptor deprecated

func (FrameType) EnumDescriptor() ([]byte, []int)

Deprecated: Use FrameType.Descriptor instead.

func (FrameType) Number

func (x FrameType) Number() protoreflect.EnumNumber

func (FrameType) String

func (x FrameType) String() string

func (FrameType) Type

type GetEditableArchiveRequest

type GetEditableArchiveRequest struct {
	RenderId int64 `protobuf:"varint,1,opt,name=render_id,json=renderId,proto3" json:"render_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetEditableArchiveRequest) Descriptor deprecated

func (*GetEditableArchiveRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetEditableArchiveRequest.ProtoReflect.Descriptor instead.

func (*GetEditableArchiveRequest) GetRenderId

func (x *GetEditableArchiveRequest) GetRenderId() int64

func (*GetEditableArchiveRequest) ProtoMessage

func (*GetEditableArchiveRequest) ProtoMessage()

func (*GetEditableArchiveRequest) ProtoReflect

func (*GetEditableArchiveRequest) Reset

func (x *GetEditableArchiveRequest) Reset()

func (*GetEditableArchiveRequest) String

func (x *GetEditableArchiveRequest) String() string

type GetEditableArchiveResponse

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

func (*GetEditableArchiveResponse) Descriptor deprecated

func (*GetEditableArchiveResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetEditableArchiveResponse.ProtoReflect.Descriptor instead.

func (*GetEditableArchiveResponse) ProtoMessage

func (*GetEditableArchiveResponse) ProtoMessage()

func (*GetEditableArchiveResponse) ProtoReflect

func (*GetEditableArchiveResponse) Reset

func (x *GetEditableArchiveResponse) Reset()

func (*GetEditableArchiveResponse) String

func (x *GetEditableArchiveResponse) String() string

type GetFontsRequest

type GetFontsRequest struct {

	// Fonts to load, maximum of 20 fonts per batch.
	Fonts []*FontRef `protobuf:"bytes,1,rep,name=fonts,proto3" json:"fonts,omitempty"`
	// contains filtered or unexported fields
}

func (*GetFontsRequest) Descriptor deprecated

func (*GetFontsRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetFontsRequest.ProtoReflect.Descriptor instead.

func (*GetFontsRequest) GetFonts

func (x *GetFontsRequest) GetFonts() []*FontRef

func (*GetFontsRequest) ProtoMessage

func (*GetFontsRequest) ProtoMessage()

func (*GetFontsRequest) ProtoReflect

func (x *GetFontsRequest) ProtoReflect() protoreflect.Message

func (*GetFontsRequest) Reset

func (x *GetFontsRequest) Reset()

func (*GetFontsRequest) String

func (x *GetFontsRequest) String() string

type GetFontsResponse

type GetFontsResponse struct {
	Fonts []*Font `protobuf:"bytes,1,rep,name=fonts,proto3" json:"fonts,omitempty"`
	// contains filtered or unexported fields
}

func (*GetFontsResponse) Descriptor deprecated

func (*GetFontsResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetFontsResponse.ProtoReflect.Descriptor instead.

func (*GetFontsResponse) GetFonts

func (x *GetFontsResponse) GetFonts() []*Font

func (*GetFontsResponse) ProtoMessage

func (*GetFontsResponse) ProtoMessage()

func (*GetFontsResponse) ProtoReflect

func (x *GetFontsResponse) ProtoReflect() protoreflect.Message

func (*GetFontsResponse) Reset

func (x *GetFontsResponse) Reset()

func (*GetFontsResponse) String

func (x *GetFontsResponse) String() string

type GetRenderedArticlesRequest added in v0.1.1

type GetRenderedArticlesRequest struct {

	// After is used to control the position in the render event log.
	After int64 `protobuf:"varint,1,opt,name=after,proto3" json:"after,omitempty"`
	// contains filtered or unexported fields
}

func (*GetRenderedArticlesRequest) Descriptor deprecated added in v0.1.1

func (*GetRenderedArticlesRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetRenderedArticlesRequest.ProtoReflect.Descriptor instead.

func (*GetRenderedArticlesRequest) GetAfter added in v0.1.1

func (x *GetRenderedArticlesRequest) GetAfter() int64

func (*GetRenderedArticlesRequest) ProtoMessage added in v0.1.1

func (*GetRenderedArticlesRequest) ProtoMessage()

func (*GetRenderedArticlesRequest) ProtoReflect added in v0.1.1

func (*GetRenderedArticlesRequest) Reset added in v0.1.1

func (x *GetRenderedArticlesRequest) Reset()

func (*GetRenderedArticlesRequest) String added in v0.1.1

func (x *GetRenderedArticlesRequest) String() string

type GetRenderedArticlesResponse added in v0.1.1

type GetRenderedArticlesResponse struct {
	Events []*RenderEvent `protobuf:"bytes,1,rep,name=events,proto3" json:"events,omitempty"`
	// contains filtered or unexported fields
}

func (*GetRenderedArticlesResponse) Descriptor deprecated added in v0.1.1

func (*GetRenderedArticlesResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetRenderedArticlesResponse.ProtoReflect.Descriptor instead.

func (*GetRenderedArticlesResponse) GetEvents added in v0.1.1

func (x *GetRenderedArticlesResponse) GetEvents() []*RenderEvent

func (*GetRenderedArticlesResponse) ProtoMessage added in v0.1.1

func (*GetRenderedArticlesResponse) ProtoMessage()

func (*GetRenderedArticlesResponse) ProtoReflect added in v0.1.1

func (*GetRenderedArticlesResponse) Reset added in v0.1.1

func (x *GetRenderedArticlesResponse) Reset()

func (*GetRenderedArticlesResponse) String added in v0.1.1

func (x *GetRenderedArticlesResponse) String() string

type GetScribusInfoRequest

type GetScribusInfoRequest struct {

	// Uuid of the layout document to get information for. Required.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// contains filtered or unexported fields
}

func (*GetScribusInfoRequest) Descriptor deprecated

func (*GetScribusInfoRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetScribusInfoRequest.ProtoReflect.Descriptor instead.

func (*GetScribusInfoRequest) GetUuid

func (x *GetScribusInfoRequest) GetUuid() string

func (*GetScribusInfoRequest) ProtoMessage

func (*GetScribusInfoRequest) ProtoMessage()

func (*GetScribusInfoRequest) ProtoReflect

func (x *GetScribusInfoRequest) ProtoReflect() protoreflect.Message

func (*GetScribusInfoRequest) Reset

func (x *GetScribusInfoRequest) Reset()

func (*GetScribusInfoRequest) String

func (x *GetScribusInfoRequest) String() string

type GetScribusInfoResponse

type GetScribusInfoResponse struct {
	Fonts       []*ScribusDependency `protobuf:"bytes,1,rep,name=fonts,proto3" json:"fonts,omitempty"`
	IccProfiles []*ScribusDependency `protobuf:"bytes,2,rep,name=icc_profiles,json=iccProfiles,proto3" json:"icc_profiles,omitempty"`
	Slots       []string             `protobuf:"bytes,3,rep,name=slots,proto3" json:"slots,omitempty"`
	Layers      []*ScribusLayer      `protobuf:"bytes,4,rep,name=layers,proto3" json:"layers,omitempty"`
	// contains filtered or unexported fields
}

func (*GetScribusInfoResponse) Descriptor deprecated

func (*GetScribusInfoResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetScribusInfoResponse.ProtoReflect.Descriptor instead.

func (*GetScribusInfoResponse) GetFonts

func (x *GetScribusInfoResponse) GetFonts() []*ScribusDependency

func (*GetScribusInfoResponse) GetIccProfiles

func (x *GetScribusInfoResponse) GetIccProfiles() []*ScribusDependency

func (*GetScribusInfoResponse) GetLayers

func (x *GetScribusInfoResponse) GetLayers() []*ScribusLayer

func (*GetScribusInfoResponse) GetSlots

func (x *GetScribusInfoResponse) GetSlots() []string

func (*GetScribusInfoResponse) ProtoMessage

func (*GetScribusInfoResponse) ProtoMessage()

func (*GetScribusInfoResponse) ProtoReflect

func (x *GetScribusInfoResponse) ProtoReflect() protoreflect.Message

func (*GetScribusInfoResponse) Reset

func (x *GetScribusInfoResponse) Reset()

func (*GetScribusInfoResponse) String

func (x *GetScribusInfoResponse) String() string

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient is the interface used by generated clients to send HTTP requests. It is fulfilled by *(net/http).Client, which is sufficient for most users. Users can provide their own implementation for special retry policies.

HTTPClient implementations should not follow redirects. Redirects are automatically disabled if *(net/http).Client is passed to client constructors. See the withoutRedirects function in this file for more details.

type Hypenation added in v0.1.6

type Hypenation struct {
	Language  string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	Word      string `protobuf:"bytes,2,opt,name=word,proto3" json:"word,omitempty"`
	Created   string `protobuf:"bytes,3,opt,name=created,proto3" json:"created,omitempty"`
	Updated   string `protobuf:"bytes,4,opt,name=updated,proto3" json:"updated,omitempty"`
	UpdatedBy string `protobuf:"bytes,5,opt,name=updated_by,json=updatedBy,proto3" json:"updated_by,omitempty"`
	Hypenated string `protobuf:"bytes,6,opt,name=hypenated,proto3" json:"hypenated,omitempty"`
	Ignore    bool   `protobuf:"varint,7,opt,name=ignore,proto3" json:"ignore,omitempty"`
	// contains filtered or unexported fields
}

func (*Hypenation) Descriptor deprecated added in v0.1.6

func (*Hypenation) Descriptor() ([]byte, []int)

Deprecated: Use Hypenation.ProtoReflect.Descriptor instead.

func (*Hypenation) GetCreated added in v0.1.6

func (x *Hypenation) GetCreated() string

func (*Hypenation) GetHypenated added in v0.1.6

func (x *Hypenation) GetHypenated() string

func (*Hypenation) GetIgnore added in v0.1.6

func (x *Hypenation) GetIgnore() bool

func (*Hypenation) GetLanguage added in v0.1.6

func (x *Hypenation) GetLanguage() string

func (*Hypenation) GetUpdated added in v0.1.6

func (x *Hypenation) GetUpdated() string

func (*Hypenation) GetUpdatedBy added in v0.1.6

func (x *Hypenation) GetUpdatedBy() string

func (*Hypenation) GetWord added in v0.1.6

func (x *Hypenation) GetWord() string

func (*Hypenation) ProtoMessage added in v0.1.6

func (*Hypenation) ProtoMessage()

func (*Hypenation) ProtoReflect added in v0.1.6

func (x *Hypenation) ProtoReflect() protoreflect.Message

func (*Hypenation) Reset added in v0.1.6

func (x *Hypenation) Reset()

func (*Hypenation) String added in v0.1.6

func (x *Hypenation) String() string

type ICCProfileInfo

type ICCProfileInfo struct {
	Name        string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Version     string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

func (*ICCProfileInfo) Descriptor deprecated

func (*ICCProfileInfo) Descriptor() ([]byte, []int)

Deprecated: Use ICCProfileInfo.ProtoReflect.Descriptor instead.

func (*ICCProfileInfo) GetDescription

func (x *ICCProfileInfo) GetDescription() string

func (*ICCProfileInfo) GetName

func (x *ICCProfileInfo) GetName() string

func (*ICCProfileInfo) GetVersion

func (x *ICCProfileInfo) GetVersion() string

func (*ICCProfileInfo) ProtoMessage

func (*ICCProfileInfo) ProtoMessage()

func (*ICCProfileInfo) ProtoReflect

func (x *ICCProfileInfo) ProtoReflect() protoreflect.Message

func (*ICCProfileInfo) Reset

func (x *ICCProfileInfo) Reset()

func (*ICCProfileInfo) String

func (x *ICCProfileInfo) String() string

type LayoutPreviewRequest

type LayoutPreviewRequest struct {
	SlaFile       string            `protobuf:"bytes,1,opt,name=sla_file,json=slaFile,proto3" json:"sla_file,omitempty"`
	Layout        *newsdoc.Document `protobuf:"bytes,2,opt,name=layout,proto3" json:"layout,omitempty"`
	ContentUuid   string            `protobuf:"bytes,3,opt,name=content_uuid,json=contentUuid,proto3" json:"content_uuid,omitempty"`
	Content       *newsdoc.Document `protobuf:"bytes,4,opt,name=content,proto3" json:"content,omitempty"`
	ArticleLayout string            `protobuf:"bytes,5,opt,name=article_layout,json=articleLayout,proto3" json:"article_layout,omitempty"`
	Features      map[string]bool   `` /* 144-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*LayoutPreviewRequest) Descriptor deprecated

func (*LayoutPreviewRequest) Descriptor() ([]byte, []int)

Deprecated: Use LayoutPreviewRequest.ProtoReflect.Descriptor instead.

func (*LayoutPreviewRequest) GetArticleLayout

func (x *LayoutPreviewRequest) GetArticleLayout() string

func (*LayoutPreviewRequest) GetContent

func (x *LayoutPreviewRequest) GetContent() *newsdoc.Document

func (*LayoutPreviewRequest) GetContentUuid

func (x *LayoutPreviewRequest) GetContentUuid() string

func (*LayoutPreviewRequest) GetFeatures

func (x *LayoutPreviewRequest) GetFeatures() map[string]bool

func (*LayoutPreviewRequest) GetLayout

func (x *LayoutPreviewRequest) GetLayout() *newsdoc.Document

func (*LayoutPreviewRequest) GetSlaFile

func (x *LayoutPreviewRequest) GetSlaFile() string

func (*LayoutPreviewRequest) ProtoMessage

func (*LayoutPreviewRequest) ProtoMessage()

func (*LayoutPreviewRequest) ProtoReflect

func (x *LayoutPreviewRequest) ProtoReflect() protoreflect.Message

func (*LayoutPreviewRequest) Reset

func (x *LayoutPreviewRequest) Reset()

func (*LayoutPreviewRequest) String

func (x *LayoutPreviewRequest) String() string

type LayoutPreviewResponse

type LayoutPreviewResponse struct {

	// PDFData produced by the render.
	PdfData []byte `protobuf:"bytes,1,opt,name=pdf_data,json=pdfData,proto3" json:"pdf_data,omitempty"`
	// Images that were mounted.
	Images []*MountedImage `protobuf:"bytes,2,rep,name=images,proto3" json:"images,omitempty"`
	// Overflows is a list of text frames whose contents overflowed the frame.
	Overflows []*Overflow `protobuf:"bytes,3,rep,name=overflows,proto3" json:"overflows,omitempty"`
	// ScribusDoc is the Scribus document used to render the preview.
	ScribusDoc []byte `protobuf:"bytes,4,opt,name=scribus_doc,json=scribusDoc,proto3" json:"scribus_doc,omitempty"`
	// Underflows is a list of text frames whose contents underflowed.
	Underflows []*Underflow `protobuf:"bytes,5,rep,name=underflows,proto3" json:"underflows,omitempty"`
	// contains filtered or unexported fields
}

func (*LayoutPreviewResponse) Descriptor deprecated

func (*LayoutPreviewResponse) Descriptor() ([]byte, []int)

Deprecated: Use LayoutPreviewResponse.ProtoReflect.Descriptor instead.

func (*LayoutPreviewResponse) GetImages

func (x *LayoutPreviewResponse) GetImages() []*MountedImage

func (*LayoutPreviewResponse) GetOverflows

func (x *LayoutPreviewResponse) GetOverflows() []*Overflow

func (*LayoutPreviewResponse) GetPdfData

func (x *LayoutPreviewResponse) GetPdfData() []byte

func (*LayoutPreviewResponse) GetScribusDoc

func (x *LayoutPreviewResponse) GetScribusDoc() []byte

func (*LayoutPreviewResponse) GetUnderflows added in v0.1.8

func (x *LayoutPreviewResponse) GetUnderflows() []*Underflow

func (*LayoutPreviewResponse) ProtoMessage

func (*LayoutPreviewResponse) ProtoMessage()

func (*LayoutPreviewResponse) ProtoReflect

func (x *LayoutPreviewResponse) ProtoReflect() protoreflect.Message

func (*LayoutPreviewResponse) Reset

func (x *LayoutPreviewResponse) Reset()

func (*LayoutPreviewResponse) String

func (x *LayoutPreviewResponse) String() string

type ListFontsRequest

type ListFontsRequest struct {
	Page int64 `protobuf:"varint,1,opt,name=page,proto3" json:"page,omitempty"`
	// contains filtered or unexported fields
}

func (*ListFontsRequest) Descriptor deprecated

func (*ListFontsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListFontsRequest.ProtoReflect.Descriptor instead.

func (*ListFontsRequest) GetPage

func (x *ListFontsRequest) GetPage() int64

func (*ListFontsRequest) ProtoMessage

func (*ListFontsRequest) ProtoMessage()

func (*ListFontsRequest) ProtoReflect

func (x *ListFontsRequest) ProtoReflect() protoreflect.Message

func (*ListFontsRequest) Reset

func (x *ListFontsRequest) Reset()

func (*ListFontsRequest) String

func (x *ListFontsRequest) String() string

type ListFontsResponse

type ListFontsResponse struct {
	Items    []*FontInfo `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	NextPage int64       `protobuf:"varint,2,opt,name=next_page,json=nextPage,proto3" json:"next_page,omitempty"`
	// contains filtered or unexported fields
}

func (*ListFontsResponse) Descriptor deprecated

func (*ListFontsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListFontsResponse.ProtoReflect.Descriptor instead.

func (*ListFontsResponse) GetItems

func (x *ListFontsResponse) GetItems() []*FontInfo

func (*ListFontsResponse) GetNextPage

func (x *ListFontsResponse) GetNextPage() int64

func (*ListFontsResponse) ProtoMessage

func (*ListFontsResponse) ProtoMessage()

func (*ListFontsResponse) ProtoReflect

func (x *ListFontsResponse) ProtoReflect() protoreflect.Message

func (*ListFontsResponse) Reset

func (x *ListFontsResponse) Reset()

func (*ListFontsResponse) String

func (x *ListFontsResponse) String() string

type ListHypenationsRequest added in v0.1.6

type ListHypenationsRequest struct {
	Language string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	Page     int64  `protobuf:"varint,2,opt,name=page,proto3" json:"page,omitempty"`
	// contains filtered or unexported fields
}

func (*ListHypenationsRequest) Descriptor deprecated added in v0.1.6

func (*ListHypenationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListHypenationsRequest.ProtoReflect.Descriptor instead.

func (*ListHypenationsRequest) GetLanguage added in v0.1.6

func (x *ListHypenationsRequest) GetLanguage() string

func (*ListHypenationsRequest) GetPage added in v0.1.6

func (x *ListHypenationsRequest) GetPage() int64

func (*ListHypenationsRequest) ProtoMessage added in v0.1.6

func (*ListHypenationsRequest) ProtoMessage()

func (*ListHypenationsRequest) ProtoReflect added in v0.1.6

func (x *ListHypenationsRequest) ProtoReflect() protoreflect.Message

func (*ListHypenationsRequest) Reset added in v0.1.6

func (x *ListHypenationsRequest) Reset()

func (*ListHypenationsRequest) String added in v0.1.6

func (x *ListHypenationsRequest) String() string

type ListHypenationsResponse added in v0.1.6

type ListHypenationsResponse struct {
	Items []*Hypenation `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

func (*ListHypenationsResponse) Descriptor deprecated added in v0.1.6

func (*ListHypenationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListHypenationsResponse.ProtoReflect.Descriptor instead.

func (*ListHypenationsResponse) GetItems added in v0.1.6

func (x *ListHypenationsResponse) GetItems() []*Hypenation

func (*ListHypenationsResponse) ProtoMessage added in v0.1.6

func (*ListHypenationsResponse) ProtoMessage()

func (*ListHypenationsResponse) ProtoReflect added in v0.1.6

func (x *ListHypenationsResponse) ProtoReflect() protoreflect.Message

func (*ListHypenationsResponse) Reset added in v0.1.6

func (x *ListHypenationsResponse) Reset()

func (*ListHypenationsResponse) String added in v0.1.6

func (x *ListHypenationsResponse) String() string

type ListICCProfilesRequest

type ListICCProfilesRequest struct {
	Page int64 `protobuf:"varint,1,opt,name=page,proto3" json:"page,omitempty"`
	// contains filtered or unexported fields
}

func (*ListICCProfilesRequest) Descriptor deprecated

func (*ListICCProfilesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListICCProfilesRequest.ProtoReflect.Descriptor instead.

func (*ListICCProfilesRequest) GetPage

func (x *ListICCProfilesRequest) GetPage() int64

func (*ListICCProfilesRequest) ProtoMessage

func (*ListICCProfilesRequest) ProtoMessage()

func (*ListICCProfilesRequest) ProtoReflect

func (x *ListICCProfilesRequest) ProtoReflect() protoreflect.Message

func (*ListICCProfilesRequest) Reset

func (x *ListICCProfilesRequest) Reset()

func (*ListICCProfilesRequest) String

func (x *ListICCProfilesRequest) String() string

type ListICCProfilesResponse

type ListICCProfilesResponse struct {
	Items    []*ICCProfileInfo `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	NextPage int64             `protobuf:"varint,2,opt,name=next_page,json=nextPage,proto3" json:"next_page,omitempty"`
	// contains filtered or unexported fields
}

func (*ListICCProfilesResponse) Descriptor deprecated

func (*ListICCProfilesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListICCProfilesResponse.ProtoReflect.Descriptor instead.

func (*ListICCProfilesResponse) GetItems

func (x *ListICCProfilesResponse) GetItems() []*ICCProfileInfo

func (*ListICCProfilesResponse) GetNextPage

func (x *ListICCProfilesResponse) GetNextPage() int64

func (*ListICCProfilesResponse) ProtoMessage

func (*ListICCProfilesResponse) ProtoMessage()

func (*ListICCProfilesResponse) ProtoReflect

func (x *ListICCProfilesResponse) ProtoReflect() protoreflect.Message

func (*ListICCProfilesResponse) Reset

func (x *ListICCProfilesResponse) Reset()

func (*ListICCProfilesResponse) String

func (x *ListICCProfilesResponse) String() string

type MountedImage

type MountedImage struct {

	// Frame name that was used for the image.
	Frame string `protobuf:"bytes,1,opt,name=frame,proto3" json:"frame,omitempty"`
	// BoundingBox for the image in 0.0-1.0 coordinates relative to the page width
	// and height.
	BoundingBox *Rect `protobuf:"bytes,2,opt,name=bounding_box,json=boundingBox,proto3" json:"bounding_box,omitempty"`
	// PPI before any PDF downsampling was applied.
	Ppi float64 `protobuf:"fixed64,3,opt,name=ppi,proto3" json:"ppi,omitempty"`
	// contains filtered or unexported fields
}

func (*MountedImage) Descriptor deprecated

func (*MountedImage) Descriptor() ([]byte, []int)

Deprecated: Use MountedImage.ProtoReflect.Descriptor instead.

func (*MountedImage) GetBoundingBox

func (x *MountedImage) GetBoundingBox() *Rect

func (*MountedImage) GetFrame

func (x *MountedImage) GetFrame() string

func (*MountedImage) GetPpi

func (x *MountedImage) GetPpi() float64

func (*MountedImage) ProtoMessage

func (*MountedImage) ProtoMessage()

func (*MountedImage) ProtoReflect

func (x *MountedImage) ProtoReflect() protoreflect.Message

func (*MountedImage) Reset

func (x *MountedImage) Reset()

func (*MountedImage) String

func (x *MountedImage) String() string

type Overflow

type Overflow struct {

	// Frame name that overflowed.
	Frame string `protobuf:"bytes,1,opt,name=frame,proto3" json:"frame,omitempty"`
	// BoundingBox for the frame in 0.0-1.0 coordinates relative to the page width
	// and height.
	BoundingBox *Rect `protobuf:"bytes,2,opt,name=bounding_box,json=boundingBox,proto3" json:"bounding_box,omitempty"`
	// contains filtered or unexported fields
}

func (*Overflow) Descriptor deprecated

func (*Overflow) Descriptor() ([]byte, []int)

Deprecated: Use Overflow.ProtoReflect.Descriptor instead.

func (*Overflow) GetBoundingBox

func (x *Overflow) GetBoundingBox() *Rect

func (*Overflow) GetFrame

func (x *Overflow) GetFrame() string

func (*Overflow) ProtoMessage

func (*Overflow) ProtoMessage()

func (*Overflow) ProtoReflect

func (x *Overflow) ProtoReflect() protoreflect.Message

func (*Overflow) Reset

func (x *Overflow) Reset()

func (*Overflow) String

func (x *Overflow) String() string

type Print

type Print interface {
	RenderArticle(context.Context, *RenderArticleRequest) (*RenderArticleResponse, error)

	GetEditableArchive(context.Context, *GetEditableArchiveRequest) (*GetEditableArchiveResponse, error)

	// LayoutPreview is used by the CLI tool to do preview rendering.
	LayoutPreview(context.Context, *LayoutPreviewRequest) (*LayoutPreviewResponse, error)

	CreateFlow(context.Context, *CreateFlowRequest) (*CreateFlowResponse, error)

	CopyArticleToFlow(context.Context, *CopyArticleToFlowRequest) (*CopyArticleToFlowResponse, error)

	GetScribusInfo(context.Context, *GetScribusInfoRequest) (*GetScribusInfoResponse, error)

	// GetRenderedArticles allows a client to consume and download all finished renders.
	GetRenderedArticles(context.Context, *GetRenderedArticlesRequest) (*GetRenderedArticlesResponse, error)

	// SetHypenation allows clients to set custom hypenation for a word.
	SetHypenation(context.Context, *SetHypenationRequest) (*SetHypenationResponse, error)

	// ListHypenations is used to list words in the hypenation dictionary.
	ListHypenations(context.Context, *ListHypenationsRequest) (*ListHypenationsResponse, error)

	// RemoveHypenation is used to remove a custom hypenation for a word.
	RemoveHypenation(context.Context, *RemoveHypenationRequest) (*RemoveHypenationResponse, error)
}

func NewPrintJSONClient

func NewPrintJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Print

NewPrintJSONClient creates a JSON client that implements the Print interface. It communicates using JSON and can be configured with a custom HTTPClient.

func NewPrintProtobufClient

func NewPrintProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Print

NewPrintProtobufClient creates a Protobuf client that implements the Print interface. It communicates using Protobuf and can be configured with a custom HTTPClient.

type PrintArticleReference

type PrintArticleReference struct {
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*PrintArticleReference) Descriptor deprecated

func (*PrintArticleReference) Descriptor() ([]byte, []int)

Deprecated: Use PrintArticleReference.ProtoReflect.Descriptor instead.

func (*PrintArticleReference) GetName

func (x *PrintArticleReference) GetName() string

func (*PrintArticleReference) GetUuid

func (x *PrintArticleReference) GetUuid() string

func (*PrintArticleReference) ProtoMessage

func (*PrintArticleReference) ProtoMessage()

func (*PrintArticleReference) ProtoReflect

func (x *PrintArticleReference) ProtoReflect() protoreflect.Message

func (*PrintArticleReference) Reset

func (x *PrintArticleReference) Reset()

func (*PrintArticleReference) String

func (x *PrintArticleReference) String() string

type Rect

type Rect struct {
	X      float64 `protobuf:"fixed64,1,opt,name=x,proto3" json:"x,omitempty"`
	Y      float64 `protobuf:"fixed64,2,opt,name=y,proto3" json:"y,omitempty"`
	Width  float64 `protobuf:"fixed64,3,opt,name=width,proto3" json:"width,omitempty"`
	Height float64 `protobuf:"fixed64,4,opt,name=height,proto3" json:"height,omitempty"`
	// contains filtered or unexported fields
}

func (*Rect) Descriptor deprecated

func (*Rect) Descriptor() ([]byte, []int)

Deprecated: Use Rect.ProtoReflect.Descriptor instead.

func (*Rect) GetHeight

func (x *Rect) GetHeight() float64

func (*Rect) GetWidth

func (x *Rect) GetWidth() float64

func (*Rect) GetX

func (x *Rect) GetX() float64

func (*Rect) GetY

func (x *Rect) GetY() float64

func (*Rect) ProtoMessage

func (*Rect) ProtoMessage()

func (*Rect) ProtoReflect

func (x *Rect) ProtoReflect() protoreflect.Message

func (*Rect) Reset

func (x *Rect) Reset()

func (*Rect) String

func (x *Rect) String() string

type RemoveHypenationRequest added in v0.1.6

type RemoveHypenationRequest struct {
	Language string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	Word     string `protobuf:"bytes,2,opt,name=word,proto3" json:"word,omitempty"`
	// contains filtered or unexported fields
}

func (*RemoveHypenationRequest) Descriptor deprecated added in v0.1.6

func (*RemoveHypenationRequest) Descriptor() ([]byte, []int)

Deprecated: Use RemoveHypenationRequest.ProtoReflect.Descriptor instead.

func (*RemoveHypenationRequest) GetLanguage added in v0.1.6

func (x *RemoveHypenationRequest) GetLanguage() string

func (*RemoveHypenationRequest) GetWord added in v0.1.6

func (x *RemoveHypenationRequest) GetWord() string

func (*RemoveHypenationRequest) ProtoMessage added in v0.1.6

func (*RemoveHypenationRequest) ProtoMessage()

func (*RemoveHypenationRequest) ProtoReflect added in v0.1.6

func (x *RemoveHypenationRequest) ProtoReflect() protoreflect.Message

func (*RemoveHypenationRequest) Reset added in v0.1.6

func (x *RemoveHypenationRequest) Reset()

func (*RemoveHypenationRequest) String added in v0.1.6

func (x *RemoveHypenationRequest) String() string

type RemoveHypenationResponse added in v0.1.6

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

func (*RemoveHypenationResponse) Descriptor deprecated added in v0.1.6

func (*RemoveHypenationResponse) Descriptor() ([]byte, []int)

Deprecated: Use RemoveHypenationResponse.ProtoReflect.Descriptor instead.

func (*RemoveHypenationResponse) ProtoMessage added in v0.1.6

func (*RemoveHypenationResponse) ProtoMessage()

func (*RemoveHypenationResponse) ProtoReflect added in v0.1.6

func (x *RemoveHypenationResponse) ProtoReflect() protoreflect.Message

func (*RemoveHypenationResponse) Reset added in v0.1.6

func (x *RemoveHypenationResponse) Reset()

func (*RemoveHypenationResponse) String added in v0.1.6

func (x *RemoveHypenationResponse) String() string

type RenderArticleRequest

type RenderArticleRequest struct {

	// ArticleUuid is the UUID of the print article to render. Required.
	ArticleUuid string `protobuf:"bytes,1,opt,name=article_uuid,json=articleUuid,proto3" json:"article_uuid,omitempty"`
	// LayoutId is the ID of the article layout to render. Required.
	LayoutId string `protobuf:"bytes,2,opt,name=layout_id,json=layoutId,proto3" json:"layout_id,omitempty"`
	// RenderPDF will enable PDF rendering.
	RenderPdf bool `protobuf:"varint,3,opt,name=render_pdf,json=renderPdf,proto3" json:"render_pdf,omitempty"`
	// RenderPDF will enable PNG rendering.
	RenderPng bool `protobuf:"varint,4,opt,name=render_png,json=renderPng,proto3" json:"render_png,omitempty"`
	// PngScale is the DPI of the rendered PDF. Defaults to 200.
	PngScale int64 `protobuf:"varint,5,opt,name=png_scale,json=pngScale,proto3" json:"png_scale,omitempty"`
	// contains filtered or unexported fields
}

func (*RenderArticleRequest) Descriptor deprecated

func (*RenderArticleRequest) Descriptor() ([]byte, []int)

Deprecated: Use RenderArticleRequest.ProtoReflect.Descriptor instead.

func (*RenderArticleRequest) GetArticleUuid

func (x *RenderArticleRequest) GetArticleUuid() string

func (*RenderArticleRequest) GetLayoutId

func (x *RenderArticleRequest) GetLayoutId() string

func (*RenderArticleRequest) GetPngScale

func (x *RenderArticleRequest) GetPngScale() int64

func (*RenderArticleRequest) GetRenderPdf

func (x *RenderArticleRequest) GetRenderPdf() bool

func (*RenderArticleRequest) GetRenderPng

func (x *RenderArticleRequest) GetRenderPng() bool

func (*RenderArticleRequest) ProtoMessage

func (*RenderArticleRequest) ProtoMessage()

func (*RenderArticleRequest) ProtoReflect

func (x *RenderArticleRequest) ProtoReflect() protoreflect.Message

func (*RenderArticleRequest) Reset

func (x *RenderArticleRequest) Reset()

func (*RenderArticleRequest) String

func (x *RenderArticleRequest) String() string

type RenderArticleResponse

type RenderArticleResponse struct {
	Id         int64  `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	PdfUrl     string `protobuf:"bytes,2,opt,name=pdf_url,json=pdfUrl,proto3" json:"pdf_url,omitempty"`
	PngUrl     string `protobuf:"bytes,3,opt,name=png_url,json=pngUrl,proto3" json:"png_url,omitempty"`
	ScribusUrl string `protobuf:"bytes,4,opt,name=scribus_url,json=scribusUrl,proto3" json:"scribus_url,omitempty"`
	PngWidth   int32  `protobuf:"varint,5,opt,name=png_width,json=pngWidth,proto3" json:"png_width,omitempty"`
	PngHeight  int32  `protobuf:"varint,6,opt,name=png_height,json=pngHeight,proto3" json:"png_height,omitempty"`
	// Images that were mounted.
	Images []*MountedImage `protobuf:"bytes,7,rep,name=images,proto3" json:"images,omitempty"`
	// Overflows is a list of text frames whose contents overflowed the frame.
	Overflows []*Overflow `protobuf:"bytes,8,rep,name=overflows,proto3" json:"overflows,omitempty"`
	// TaggedTextUrl is a zip archive with the indesign-tagged text for the article.
	TaggedTextUrl string `protobuf:"bytes,9,opt,name=tagged_text_url,json=taggedTextUrl,proto3" json:"tagged_text_url,omitempty"`
	// Underflows is a list of text frames whose contents underflowed.
	Underflows []*Underflow `protobuf:"bytes,10,rep,name=underflows,proto3" json:"underflows,omitempty"`
	// contains filtered or unexported fields
}

func (*RenderArticleResponse) Descriptor deprecated

func (*RenderArticleResponse) Descriptor() ([]byte, []int)

Deprecated: Use RenderArticleResponse.ProtoReflect.Descriptor instead.

func (*RenderArticleResponse) GetId

func (x *RenderArticleResponse) GetId() int64

func (*RenderArticleResponse) GetImages

func (x *RenderArticleResponse) GetImages() []*MountedImage

func (*RenderArticleResponse) GetOverflows

func (x *RenderArticleResponse) GetOverflows() []*Overflow

func (*RenderArticleResponse) GetPdfUrl

func (x *RenderArticleResponse) GetPdfUrl() string

func (*RenderArticleResponse) GetPngHeight

func (x *RenderArticleResponse) GetPngHeight() int32

func (*RenderArticleResponse) GetPngUrl

func (x *RenderArticleResponse) GetPngUrl() string

func (*RenderArticleResponse) GetPngWidth

func (x *RenderArticleResponse) GetPngWidth() int32

func (*RenderArticleResponse) GetScribusUrl

func (x *RenderArticleResponse) GetScribusUrl() string

func (*RenderArticleResponse) GetTaggedTextUrl added in v0.1.2

func (x *RenderArticleResponse) GetTaggedTextUrl() string

func (*RenderArticleResponse) GetUnderflows added in v0.1.8

func (x *RenderArticleResponse) GetUnderflows() []*Underflow

func (*RenderArticleResponse) ProtoMessage

func (*RenderArticleResponse) ProtoMessage()

func (*RenderArticleResponse) ProtoReflect

func (x *RenderArticleResponse) ProtoReflect() protoreflect.Message

func (*RenderArticleResponse) Reset

func (x *RenderArticleResponse) Reset()

func (*RenderArticleResponse) String

func (x *RenderArticleResponse) String() string

type RenderEvent added in v0.1.1

type RenderEvent struct {

	// Id of the event.
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// Type of the event, one of "rendered", "failed", "failed_attempt".
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Article UUID.
	Article string `protobuf:"bytes,3,opt,name=article,proto3" json:"article,omitempty"`
	// Error - if any that prevented rendering.
	Error string `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`
	// Rendered articles that should be downloaded.
	Rendered []*RenderedArticle `protobuf:"bytes,5,rep,name=rendered,proto3" json:"rendered,omitempty"`
	// Removed articles that should be deleted.
	Removed []*RenderedArticle `protobuf:"bytes,6,rep,name=removed,proto3" json:"removed,omitempty"`
	// ArticleVersion is the version of the article that was rendered.
	ArticleVersion int64 `protobuf:"varint,7,opt,name=article_version,json=articleVersion,proto3" json:"article_version,omitempty"`
	// Time is the time the event as an RFC3339 timestamp.
	Time string `protobuf:"bytes,8,opt,name=time,proto3" json:"time,omitempty"`
	// contains filtered or unexported fields
}

func (*RenderEvent) Descriptor deprecated added in v0.1.1

func (*RenderEvent) Descriptor() ([]byte, []int)

Deprecated: Use RenderEvent.ProtoReflect.Descriptor instead.

func (*RenderEvent) GetArticle added in v0.1.2

func (x *RenderEvent) GetArticle() string

func (*RenderEvent) GetArticleVersion added in v0.1.3

func (x *RenderEvent) GetArticleVersion() int64

func (*RenderEvent) GetError added in v0.1.2

func (x *RenderEvent) GetError() string

func (*RenderEvent) GetId added in v0.1.1

func (x *RenderEvent) GetId() int64

func (*RenderEvent) GetRemoved added in v0.1.1

func (x *RenderEvent) GetRemoved() []*RenderedArticle

func (*RenderEvent) GetRendered added in v0.1.1

func (x *RenderEvent) GetRendered() []*RenderedArticle

func (*RenderEvent) GetTime added in v0.1.4

func (x *RenderEvent) GetTime() string

func (*RenderEvent) GetType added in v0.1.2

func (x *RenderEvent) GetType() string

func (*RenderEvent) ProtoMessage added in v0.1.1

func (*RenderEvent) ProtoMessage()

func (*RenderEvent) ProtoReflect added in v0.1.1

func (x *RenderEvent) ProtoReflect() protoreflect.Message

func (*RenderEvent) Reset added in v0.1.1

func (x *RenderEvent) Reset()

func (*RenderEvent) String added in v0.1.1

func (x *RenderEvent) String() string

type RenderedArticle added in v0.1.1

type RenderedArticle struct {
	Date       string         `protobuf:"bytes,1,opt,name=date,proto3" json:"date,omitempty"`
	Product    string         `protobuf:"bytes,2,opt,name=product,proto3" json:"product,omitempty"`
	Layout     string         `protobuf:"bytes,3,opt,name=layout,proto3" json:"layout,omitempty"`
	Position   string         `protobuf:"bytes,4,opt,name=position,proto3" json:"position,omitempty"`
	Pdf        *RenderedAsset `protobuf:"bytes,5,opt,name=pdf,proto3" json:"pdf,omitempty"`
	TaggedText *RenderedAsset `protobuf:"bytes,6,opt,name=tagged_text,json=taggedText,proto3" json:"tagged_text,omitempty"`
	// contains filtered or unexported fields
}

func (*RenderedArticle) Descriptor deprecated added in v0.1.1

func (*RenderedArticle) Descriptor() ([]byte, []int)

Deprecated: Use RenderedArticle.ProtoReflect.Descriptor instead.

func (*RenderedArticle) GetDate added in v0.1.1

func (x *RenderedArticle) GetDate() string

func (*RenderedArticle) GetLayout added in v0.1.1

func (x *RenderedArticle) GetLayout() string

func (*RenderedArticle) GetPdf added in v0.1.2

func (x *RenderedArticle) GetPdf() *RenderedAsset

func (*RenderedArticle) GetPosition added in v0.1.1

func (x *RenderedArticle) GetPosition() string

func (*RenderedArticle) GetProduct added in v0.1.2

func (x *RenderedArticle) GetProduct() string

func (*RenderedArticle) GetTaggedText added in v0.1.2

func (x *RenderedArticle) GetTaggedText() *RenderedAsset

func (*RenderedArticle) ProtoMessage added in v0.1.1

func (*RenderedArticle) ProtoMessage()

func (*RenderedArticle) ProtoReflect added in v0.1.1

func (x *RenderedArticle) ProtoReflect() protoreflect.Message

func (*RenderedArticle) Reset added in v0.1.1

func (x *RenderedArticle) Reset()

func (*RenderedArticle) String added in v0.1.1

func (x *RenderedArticle) String() string

type RenderedAsset added in v0.1.2

type RenderedAsset struct {

	// DownloadLink that can be used to fetch the asset.
	DownloadLink string `protobuf:"bytes,5,opt,name=download_link,json=downloadLink,proto3" json:"download_link,omitempty"`
	// Size of the PDF in bytes.
	Size int64 `protobuf:"varint,6,opt,name=size,proto3" json:"size,omitempty"`
	// Sha256Hash is the SHA-256 checksum for the PDF.
	Sha256Hash string `protobuf:"bytes,7,opt,name=sha256_hash,json=sha256Hash,proto3" json:"sha256_hash,omitempty"`
	// contains filtered or unexported fields
}

func (*RenderedAsset) Descriptor deprecated added in v0.1.2

func (*RenderedAsset) Descriptor() ([]byte, []int)

Deprecated: Use RenderedAsset.ProtoReflect.Descriptor instead.

func (x *RenderedAsset) GetDownloadLink() string

func (*RenderedAsset) GetSha256Hash added in v0.1.2

func (x *RenderedAsset) GetSha256Hash() string

func (*RenderedAsset) GetSize added in v0.1.2

func (x *RenderedAsset) GetSize() int64

func (*RenderedAsset) ProtoMessage added in v0.1.2

func (*RenderedAsset) ProtoMessage()

func (*RenderedAsset) ProtoReflect added in v0.1.2

func (x *RenderedAsset) ProtoReflect() protoreflect.Message

func (*RenderedAsset) Reset added in v0.1.2

func (x *RenderedAsset) Reset()

func (*RenderedAsset) String added in v0.1.2

func (x *RenderedAsset) String() string

type ScribusDependency

type ScribusDependency struct {
	Name      string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Satisfied bool   `protobuf:"varint,2,opt,name=satisfied,proto3" json:"satisfied,omitempty"`
	// contains filtered or unexported fields
}

func (*ScribusDependency) Descriptor deprecated

func (*ScribusDependency) Descriptor() ([]byte, []int)

Deprecated: Use ScribusDependency.ProtoReflect.Descriptor instead.

func (*ScribusDependency) GetName

func (x *ScribusDependency) GetName() string

func (*ScribusDependency) GetSatisfied

func (x *ScribusDependency) GetSatisfied() bool

func (*ScribusDependency) ProtoMessage

func (*ScribusDependency) ProtoMessage()

func (*ScribusDependency) ProtoReflect

func (x *ScribusDependency) ProtoReflect() protoreflect.Message

func (*ScribusDependency) Reset

func (x *ScribusDependency) Reset()

func (*ScribusDependency) String

func (x *ScribusDependency) String() string

type ScribusFrame

type ScribusFrame struct {
	Name string    `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Slot string    `protobuf:"bytes,2,opt,name=slot,proto3" json:"slot,omitempty"`
	Type FrameType `protobuf:"varint,3,opt,name=type,proto3,enum=ttab.baboon.FrameType" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*ScribusFrame) Descriptor deprecated

func (*ScribusFrame) Descriptor() ([]byte, []int)

Deprecated: Use ScribusFrame.ProtoReflect.Descriptor instead.

func (*ScribusFrame) GetName

func (x *ScribusFrame) GetName() string

func (*ScribusFrame) GetSlot

func (x *ScribusFrame) GetSlot() string

func (*ScribusFrame) GetType

func (x *ScribusFrame) GetType() FrameType

func (*ScribusFrame) ProtoMessage

func (*ScribusFrame) ProtoMessage()

func (*ScribusFrame) ProtoReflect

func (x *ScribusFrame) ProtoReflect() protoreflect.Message

func (*ScribusFrame) Reset

func (x *ScribusFrame) Reset()

func (*ScribusFrame) String

func (x *ScribusFrame) String() string

type ScribusLayer

type ScribusLayer struct {
	Id     string          `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Name   string          `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Slot   string          `protobuf:"bytes,3,opt,name=slot,proto3" json:"slot,omitempty"`
	Frames []*ScribusFrame `protobuf:"bytes,4,rep,name=frames,proto3" json:"frames,omitempty"`
	// contains filtered or unexported fields
}

func (*ScribusLayer) Descriptor deprecated

func (*ScribusLayer) Descriptor() ([]byte, []int)

Deprecated: Use ScribusLayer.ProtoReflect.Descriptor instead.

func (*ScribusLayer) GetFrames

func (x *ScribusLayer) GetFrames() []*ScribusFrame

func (*ScribusLayer) GetId

func (x *ScribusLayer) GetId() string

func (*ScribusLayer) GetName

func (x *ScribusLayer) GetName() string

func (*ScribusLayer) GetSlot

func (x *ScribusLayer) GetSlot() string

func (*ScribusLayer) ProtoMessage

func (*ScribusLayer) ProtoMessage()

func (*ScribusLayer) ProtoReflect

func (x *ScribusLayer) ProtoReflect() protoreflect.Message

func (*ScribusLayer) Reset

func (x *ScribusLayer) Reset()

func (*ScribusLayer) String

func (x *ScribusLayer) String() string

type SetHypenationRequest added in v0.1.6

type SetHypenationRequest struct {
	Language  string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	Word      string `protobuf:"bytes,2,opt,name=word,proto3" json:"word,omitempty"`
	Hypenated string `protobuf:"bytes,3,opt,name=hypenated,proto3" json:"hypenated,omitempty"`
	Ignore    bool   `protobuf:"varint,4,opt,name=ignore,proto3" json:"ignore,omitempty"`
	// contains filtered or unexported fields
}

func (*SetHypenationRequest) Descriptor deprecated added in v0.1.6

func (*SetHypenationRequest) Descriptor() ([]byte, []int)

Deprecated: Use SetHypenationRequest.ProtoReflect.Descriptor instead.

func (*SetHypenationRequest) GetHypenated added in v0.1.6

func (x *SetHypenationRequest) GetHypenated() string

func (*SetHypenationRequest) GetIgnore added in v0.1.6

func (x *SetHypenationRequest) GetIgnore() bool

func (*SetHypenationRequest) GetLanguage added in v0.1.6

func (x *SetHypenationRequest) GetLanguage() string

func (*SetHypenationRequest) GetWord added in v0.1.6

func (x *SetHypenationRequest) GetWord() string

func (*SetHypenationRequest) ProtoMessage added in v0.1.6

func (*SetHypenationRequest) ProtoMessage()

func (*SetHypenationRequest) ProtoReflect added in v0.1.6

func (x *SetHypenationRequest) ProtoReflect() protoreflect.Message

func (*SetHypenationRequest) Reset added in v0.1.6

func (x *SetHypenationRequest) Reset()

func (*SetHypenationRequest) String added in v0.1.6

func (x *SetHypenationRequest) String() string

type SetHypenationResponse added in v0.1.6

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

func (*SetHypenationResponse) Descriptor deprecated added in v0.1.6

func (*SetHypenationResponse) Descriptor() ([]byte, []int)

Deprecated: Use SetHypenationResponse.ProtoReflect.Descriptor instead.

func (*SetHypenationResponse) ProtoMessage added in v0.1.6

func (*SetHypenationResponse) ProtoMessage()

func (*SetHypenationResponse) ProtoReflect added in v0.1.6

func (x *SetHypenationResponse) ProtoReflect() protoreflect.Message

func (*SetHypenationResponse) Reset added in v0.1.6

func (x *SetHypenationResponse) Reset()

func (*SetHypenationResponse) String added in v0.1.6

func (x *SetHypenationResponse) String() string

type StoreFontRequest

type StoreFontRequest struct {
	Name        string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	Filename    string `protobuf:"bytes,3,opt,name=filename,proto3" json:"filename,omitempty"`
	File        []byte `protobuf:"bytes,4,opt,name=file,proto3" json:"file,omitempty"`
	// contains filtered or unexported fields
}

func (*StoreFontRequest) Descriptor deprecated

func (*StoreFontRequest) Descriptor() ([]byte, []int)

Deprecated: Use StoreFontRequest.ProtoReflect.Descriptor instead.

func (*StoreFontRequest) GetDescription

func (x *StoreFontRequest) GetDescription() string

func (*StoreFontRequest) GetFile

func (x *StoreFontRequest) GetFile() []byte

func (*StoreFontRequest) GetFilename

func (x *StoreFontRequest) GetFilename() string

func (*StoreFontRequest) GetName

func (x *StoreFontRequest) GetName() string

func (*StoreFontRequest) ProtoMessage

func (*StoreFontRequest) ProtoMessage()

func (*StoreFontRequest) ProtoReflect

func (x *StoreFontRequest) ProtoReflect() protoreflect.Message

func (*StoreFontRequest) Reset

func (x *StoreFontRequest) Reset()

func (*StoreFontRequest) String

func (x *StoreFontRequest) String() string

type StoreFontResponse

type StoreFontResponse struct {
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

func (*StoreFontResponse) Descriptor deprecated

func (*StoreFontResponse) Descriptor() ([]byte, []int)

Deprecated: Use StoreFontResponse.ProtoReflect.Descriptor instead.

func (*StoreFontResponse) GetVersion

func (x *StoreFontResponse) GetVersion() string

func (*StoreFontResponse) ProtoMessage

func (*StoreFontResponse) ProtoMessage()

func (*StoreFontResponse) ProtoReflect

func (x *StoreFontResponse) ProtoReflect() protoreflect.Message

func (*StoreFontResponse) Reset

func (x *StoreFontResponse) Reset()

func (*StoreFontResponse) String

func (x *StoreFontResponse) String() string

type StoreICCProfileRequest

type StoreICCProfileRequest struct {

	// Name is optional, will be extracted from ICC data if not provided. Setting
	// a name for the profile that differs from the one in the ICC data will not
	// make Scribus resolve it correctly. Forcing a different name should only be
	// done if baboon cannot parse the ICC file correctly.
	Name        string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	File        []byte `protobuf:"bytes,3,opt,name=file,proto3" json:"file,omitempty"`
	// contains filtered or unexported fields
}

func (*StoreICCProfileRequest) Descriptor deprecated

func (*StoreICCProfileRequest) Descriptor() ([]byte, []int)

Deprecated: Use StoreICCProfileRequest.ProtoReflect.Descriptor instead.

func (*StoreICCProfileRequest) GetDescription

func (x *StoreICCProfileRequest) GetDescription() string

func (*StoreICCProfileRequest) GetFile

func (x *StoreICCProfileRequest) GetFile() []byte

func (*StoreICCProfileRequest) GetName

func (x *StoreICCProfileRequest) GetName() string

func (*StoreICCProfileRequest) ProtoMessage

func (*StoreICCProfileRequest) ProtoMessage()

func (*StoreICCProfileRequest) ProtoReflect

func (x *StoreICCProfileRequest) ProtoReflect() protoreflect.Message

func (*StoreICCProfileRequest) Reset

func (x *StoreICCProfileRequest) Reset()

func (*StoreICCProfileRequest) String

func (x *StoreICCProfileRequest) String() string

type StoreICCProfileResponse

type StoreICCProfileResponse struct {
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

func (*StoreICCProfileResponse) Descriptor deprecated

func (*StoreICCProfileResponse) Descriptor() ([]byte, []int)

Deprecated: Use StoreICCProfileResponse.ProtoReflect.Descriptor instead.

func (*StoreICCProfileResponse) GetVersion

func (x *StoreICCProfileResponse) GetVersion() string

func (*StoreICCProfileResponse) ProtoMessage

func (*StoreICCProfileResponse) ProtoMessage()

func (*StoreICCProfileResponse) ProtoReflect

func (x *StoreICCProfileResponse) ProtoReflect() protoreflect.Message

func (*StoreICCProfileResponse) Reset

func (x *StoreICCProfileResponse) Reset()

func (*StoreICCProfileResponse) String

func (x *StoreICCProfileResponse) String() string

type TwirpServer

type TwirpServer interface {
	http.Handler

	// ServiceDescriptor returns gzipped bytes describing the .proto file that
	// this service was generated from. Once unzipped, the bytes can be
	// unmarshalled as a
	// google.golang.org/protobuf/types/descriptorpb.FileDescriptorProto.
	//
	// The returned integer is the index of this particular service within that
	// FileDescriptorProto's 'Service' slice of ServiceDescriptorProtos. This is a
	// low-level field, expected to be used for reflection.
	ServiceDescriptor() ([]byte, int)

	// ProtocGenTwirpVersion is the semantic version string of the version of
	// twirp used to generate this file.
	ProtocGenTwirpVersion() string

	// PathPrefix returns the HTTP URL path prefix for all methods handled by this
	// service. This can be used with an HTTP mux to route Twirp requests.
	// The path prefix is in the form: "/<prefix>/<package>.<Service>/"
	// that is, everything in a Twirp route except for the <Method> at the end.
	PathPrefix() string
}

TwirpServer is the interface generated server structs will support: they're HTTP handlers with additional methods for accessing metadata about the service. Those accessors are a low-level API for building reflection tools. Most people can think of TwirpServers as just http.Handlers.

func NewAssetsServer

func NewAssetsServer(svc Assets, opts ...interface{}) TwirpServer

NewAssetsServer builds a TwirpServer that can be used as an http.Handler to handle HTTP requests that are routed to the right method in the provided svc implementation. The opts are twirp.ServerOption modifiers, for example twirp.WithServerHooks(hooks).

func NewPrintServer

func NewPrintServer(svc Print, opts ...interface{}) TwirpServer

NewPrintServer builds a TwirpServer that can be used as an http.Handler to handle HTTP requests that are routed to the right method in the provided svc implementation. The opts are twirp.ServerOption modifiers, for example twirp.WithServerHooks(hooks).

type Underflow added in v0.1.8

type Underflow struct {

	// Frame name that underflowed.
	Frame string `protobuf:"bytes,1,opt,name=frame,proto3" json:"frame,omitempty"`
	// BoundingBox for the frame in 0.0-1.0 coordinates relative to the page width
	// and height.
	BoundingBox *Rect `protobuf:"bytes,2,opt,name=bounding_box,json=boundingBox,proto3" json:"bounding_box,omitempty"`
	// contains filtered or unexported fields
}

func (*Underflow) Descriptor deprecated added in v0.1.8

func (*Underflow) Descriptor() ([]byte, []int)

Deprecated: Use Underflow.ProtoReflect.Descriptor instead.

func (*Underflow) GetBoundingBox added in v0.1.8

func (x *Underflow) GetBoundingBox() *Rect

func (*Underflow) GetFrame added in v0.1.8

func (x *Underflow) GetFrame() string

func (*Underflow) ProtoMessage added in v0.1.8

func (*Underflow) ProtoMessage()

func (*Underflow) ProtoReflect added in v0.1.8

func (x *Underflow) ProtoReflect() protoreflect.Message

func (*Underflow) Reset added in v0.1.8

func (x *Underflow) Reset()

func (*Underflow) String added in v0.1.8

func (x *Underflow) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL