draft

type Error ¶

type Error struct {
	Kind      ErrorKind
	Operation string
	Path      string
	Err       error
	Mutation  *Mutation
}

Error carries a stable class while leaving its human text non-normative.

func (e *Error) Error() string

func (e *Error) Unwrap() error

type ErrorKind ¶

type ErrorKind string

ErrorKind is a stable, protocol-ready failure class.

const (
	ErrorUsage       ErrorKind = "usage"
	ErrorCancelled   ErrorKind = "cancelled"
	ErrorInternal    ErrorKind = "internal"
	ErrorCapability  ErrorKind = "capability"
	ErrorConflict    ErrorKind = "conflict"
	ErrorConcurrency ErrorKind = "concurrency"
	ErrorRepository  ErrorKind = "repository"
	ErrorIO          ErrorKind = "io"
)

func KindOf(err error) ErrorKind

type FileChange ¶

type FileChange struct {
	Path   string
	Before []byte
	After  []byte
	Create bool
	Delete bool
}

FileChange is an immutable copy of one planned logical file update. Before is nil when the path must be absent. After is nil for a deletion. Create and Delete are mutually exclusive.

type FmtOptions ¶

type FmtOptions struct {
	Paths      []string
	Check      bool
	DryRun     bool
	Rendezvous Locker
}

FmtOptions controls literal README selection and read-only modes. With no Paths, every logical content-directory README is selected.

type FmtResult ¶

type FmtResult struct {
	DryRun  bool     `json:"dry_run"`
	Check   bool     `json:"check"`
	Changed bool     `json:"changed"`
	Paths   []string `json:"paths"`
}

func Fmt(ctx context.Context, root string, options FmtOptions) (FmtResult, error)

func Format(ctx context.Context, root string, options FmtOptions) (FmtResult, error)

type Locker ¶

type Locker interface {
	LockDraft(ctx context.Context, root string) (Unlock, error)
}

Locker coordinates publication with other managed worktree writers. The portable draft package performs exact compare-and-swap-style rechecks even when no Locker is supplied, but a managed CLI should always supply its annex-defined worktree rendezvous.

type LockerFunc ¶

type LockerFunc func(ctx context.Context, root string) (Unlock, error)

LockerFunc adapts a function to Locker.

func (f LockerFunc) LockDraft(ctx context.Context, root string) (Unlock, error)

type MoveOptions ¶

type MoveOptions struct {
	DryRun     bool
	Rendezvous Locker
}

MoveOptions controls publication of one literal record move.

type MoveResult ¶

type MoveResult struct {
	DryRun   bool     `json:"dry_run"`
	Changed  bool     `json:"changed"`
	From     string   `json:"from"`
	To       string   `json:"to"`
	Paths    []string `json:"paths"`
	Catalogs []string `json:"catalogs"`
}

MoveResult is the stable result shape of mv. Paths contains final logical paths of documents whose non-catalog link bytes changed; Catalogs contains README paths whose generated regions changed.

func Move(ctx context.Context, root, from, to string, options MoveOptions) (MoveResult, error)

type Mutation ¶

type Mutation struct {
	Durable          bool
	CheckoutChanged  bool
	RecoveryRequired bool
}

Mutation is the closed local effect set known after a draft publication error. Draft helpers never update refs, HEAD, or remotes.

func MutationOf(err error) (Mutation, bool)

type NewOptions ¶

type NewOptions struct {
	Description   string
	Fields        []byte
	Body          []byte
	BodyProvided  bool
	Title         string
	TitleProvided bool
	DryRun        bool
	Rendezvous    Locker
}

NewOptions contains already-read option inputs. BodyProvided distinguishes an explicit body from generated-body mode; a non-nil Body also counts as provided. Fields is nil when --fields was absent.

type NewResult ¶

type NewResult struct {
	DryRun   bool     `json:"dry_run"`
	Changed  bool     `json:"changed"`
	Record   string   `json:"record"`
	Catalogs []string `json:"catalogs"`
}

func New(ctx context.Context, root, typeName, logicalPath string, options NewOptions) (NewResult, error)

type Phase ¶

type Phase string

Phase identifies a deterministic per-plan fault boundary.

const (
	PhaseApplied  Phase = "applied"
	PhaseRollback Phase = "rollback"
	PhaseCleanup  Phase = "cleanup"
)

type Plan ¶

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

Plan is a one-shot, immutable publication plan. Its exported methods return copies so callers cannot invalidate captured preimages or final bytes.

func (p *Plan) Changed() bool

func (p *Plan) Changes() []FileChange

func (p *Plan) Operation() string

func (p *Plan) Publish(ctx context.Context) error

func (p *Plan) PublishWith(ctx context.Context, locker Locker) (resultErr error)

func (p *Plan) Root() string

type SchemaCopyOptions ¶

type SchemaCopyOptions struct {
	Scope         string
	ScopeProvided bool
	DryRun        bool
	Rendezvous    Locker
}

SchemaCopyOptions selects an existing logical content-directory scope. The empty Scope denotes the store root, matching the CLI default.

type SchemaCopyResult ¶

type SchemaCopyResult struct {
	DryRun  bool                      `json:"dry_run"`
	Changed bool                      `json:"changed"`
	Schema  checker.SchemaDescription `json:"schema"`
	Path    string                    `json:"path"`
}

func SchemaCopy(ctx context.Context, root, typeName string, options SchemaCopyOptions) (SchemaCopyResult, error)

type Unlock ¶

type Unlock func() error

Unlock releases a caller-owned worktree rendezvous.