preview

type Artboard struct {
	ID    string `json:"id"`
	Title string `json:"title"`
	Slug  string `json:"slug,omitempty"`
	Kind  string `json:"kind,omitempty"`
	// URL is the address of the artifact document the artboard frames.
	URL string `json:"url"`
	// Width and Height are the logical viewport the artboard is rendered at,
	// before the canvas zoom scales it. A deck is 1280x720, a page 1440x900.
	Width  int `json:"width"`
	Height int `json:"height"`
	// Version is the artifact's snapshot number, shown on the artboard label.
	Version int `json:"version,omitempty"`
	// Status is "ready", "building" or "error". The canvas renders a badge for
	// anything that is not ready.
	Status string `json:"status,omitempty"`
	// Note carries the error message, or whatever the status needs to explain.
	Note string `json:"note,omitempty"`
	// Revision changes whenever the document underneath changes. The canvas
	// watches it to flash the artboard and to force a reload of its frame.
	Revision  uint64    `json:"revision"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type CanvasGrant struct {
	Token     string    `json:"token"`
	SessionID string    `json:"session_id,omitempty"`
	ExpiresAt time.Time `json:"expires_at"`
}

type Grant struct {
	Token      string `json:"token"`
	ArtifactID string `json:"artifact_id"`
	SessionID  string `json:"session_id,omitempty"`
	// Dir is the absolute artifact directory. Nothing outside it is served.
	Dir string `json:"-"`
	// Entry is the directory-relative default document.
	Entry     string    `json:"entry"`
	ExpiresAt time.Time `json:"expires_at"`
	// contains filtered or unexported fields
}

type Options struct {
	// BaseURL resolves the origin to build absolute URLs with. It is a function
	// because the API server's bind address changes at runtime when the
	// external-access toggle is flipped. When it is nil or returns an empty
	// string the server falls back to its own loopback listener, and to a
	// relative URL when it has none.
	BaseURL func() string
	// Access is consulted on every request and before every publish. A non-nil
	// error refuses the operation. It exists so the API server can enforce
	// "never on a non-loopback bind without basic auth".
	Access func() error
	// TTL overrides DefaultTTL.
	TTL time.Duration
	// FrameAncestors overrides the CSP frame-ancestors list. It defaults to
	// 'self', which is right whenever the preview and the UI framing it share
	// an origin — the mounted deployment. A shell that runs the UI on its own
	// origin (the Wails desktop app) has to widen it, and doing that here keeps
	// the decision in the caller that knows its own origin.
	FrameAncestors string
	// Inject is JavaScript spliced into a ?bridge=1 document ahead of the
	// bridge itself. internal/design supplies the renderer's own element
	// walker here, so the data-pando-id a user clicks in the browser is the
	// same id the stored node index holds. Keeping it an option is what lets
	// this package stay ignorant of the design model.
	Inject []byte
	// Artboards supplies the canvas view with the session's artifacts. It is a
	// function for the same reason Inject is a byte slice: the canvas needs the
	// design model and this package must not depend on it. A nil provider
	// leaves the canvas served but empty.
	Artboards func(sessionID string) ([]Artboard, error)
}

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

type URLOptions struct {
	// Slide adds a #slide-N fragment (decks).
	Slide int
	// Bridge asks for the selection bridge to be injected. Only the Pando UI
	// sets it; a URL opened in a plain browser stays untouched markup.
	Bridge bool
	// Doc overrides the entry document with another directory-relative file.
	Doc string
}