package app.cash.barber.api

Get desktop application:
View/edit binary Protocol Buffers messages

* Support recursive, primitive types in [DocumentData] protos

(message has no fields)

Used in: DocumentData.Field

• TYPE_DO_NOT_USE = 0

• STRING = 1

• LONG = 2

• DURATION = 3

• INSTANT = 4

Provides the necessary context to render a template matching template_token

• optional string template_token = 1

  A unique identifier for the corresponding DocumentTemplate that this DocumentData provides necessary context to render

• repeated DocumentData.Field fields = 2

  The context values required to render a DocumentTemplate of the given template_token

A representation of a field that supports a dynamic value type

Used in: DocumentData

• optional string key = 1

  Context variable name (can be dot separated path to support nesting) that is used in templates

• oneof value

  Context variable in a supported type (string, integer, duration, instant)

  • string value_string = 2

  • int64 value_long = 3

  • google.protobuf.Duration value_duration = 4

  • google.protobuf.Timestamp value_instant = 5

  • BarberSignature.Type value_null_type = 6

    For Kotlin DocumentData converted to Proto that have a null value, this field can provide a hint for the type which otherwise would be unknown since null would show up as all other value fields as null

    TODO add amount to support Money

Contains the templates for a given locale to render target Documents

• optional string template_token = 1

  A unique identifier used for lookup

• optional int64 version = 2

  An auto-incrementing integer to identify a unique version of the same DocumentTemplate

• optional string locale = 3

  RFC 5646 locale language-region that the DocumentTemplate targets

• optional string source_signature = 4

  Signature of the required DocumentData to render this DocumentTemplate

• repeated string target_signatures = 5

  Signature for the Documents that this DocumentTemplate can render

• repeated DocumentTemplate.Field fields = 6

  Fields that correspond to all fields of target Documents

A template field within a DocumentTemplate

Used in: DocumentTemplate

• optional string key = 1

  Field name matches one of the fields of the target Document

• optional string template = 2

  A Mustache compatible template string with values filled in by DocumentData