step

type AddModelObject ¶

type AddModelObject struct {
	Form     form.Element
	Defaults []Step
}

AddModelObject is an action that can add new model objects of any type

func NewAddModelObject(stepInfo mapof.Any) (AddModelObject, error)

func (step AddModelObject) AmStep()

type AddStream ¶ added in v0.6.0

type AddStream struct {
	Style         string                        // Style of input widget to use. Options are: "chooser", "modal", and "inline".  Defaults to "chooser".
	Title         string                        // Title to use on the create modal. Defaults to "Add a Stream"
	Location      string                        // Options are: "top", "child", "outbox".  Defaults to "child".
	TemplateID    string                        // ID of the template to use.  If empty, then template roles are used.
	TemplateRoles []string                      // List of acceptable Template Roles that can be used to make a stream.  If empty, then all template for this container are valid.
	WithData      map[string]*template.Template // Map of values to preset in the new stream
}

AddStream is an action that can add new sub-streams to the domain.

Uses: Display a pop-up to choose a template and create a new stream Embed a custom "create" widget into the current page - possibly selecting between multiple templates Create a new stream using a specific template as a part of a larger pipeline

func NewAddStream(stepInfo mapof.Any) (AddStream, error)

func (step AddStream) AmStep()

type AsConfirmation ¶

type AsConfirmation struct {
	Title   string
	Message string
	Submit  string
}

AsConfirmation displays a confirmation dialog on GET, giving users an option to continue or not

func NewAsConfirmation(stepInfo mapof.Any) (AsConfirmation, error)

func (step AsConfirmation) AmStep()

type AsModal ¶

type AsModal struct {
	SubSteps   []Step
	Options    []string
	Background string
}

AsModal is a Step that can update the data.DataMap custom data stored in a Stream

func NewAsModal(stepInfo mapof.Any) (AsModal, error)

func (step AsModal) AmStep()

type AsTooltip ¶ added in v0.6.0

type AsTooltip struct {
	SubSteps []Step
}

AsTooltip is a Step that can update the data.DataMap custom data stored in a Stream

func NewAsTooltip(stepInfo mapof.Any) (AsTooltip, error)

func (step AsTooltip) AmStep()

type CacheURL ¶ added in v0.7.0

type CacheURL struct {
	CacheControl string
}

CacheURL is an action that can add new model objects of any type

func NewCacheURL(stepInfo mapof.Any) (CacheURL, error)

func (step CacheURL) AmStep()

type Delete ¶

type Delete struct {
	Title   *template.Template
	Message *template.Template
	Submit  string
	Method  string
}

Delete is a Step that can delete a Stream from the Domain

func NewDelete(stepInfo mapof.Any) (Delete, error)

func (step Delete) AmStep()

type DeleteArchive ¶ added in v0.7.0

type DeleteArchive struct {
	Token string
}

DeleteArchive is a Step that removes a named archive from a Stream

func NewDeleteArchive(stepInfo mapof.Any) (DeleteArchive, error)

func (step DeleteArchive) AmStep()

type DeleteAttachments ¶

type DeleteAttachments struct {
	All      bool   // If TRUE, then ALL ATTACHMENTS for this object will be deleted.
	Field    string // If set, the the attachment named by this property will be deleted. (If zero, then NOOP)
	Category string // If set, then all attachments from a specified group are deleted.
}

DeleteAttachments represents an action that removes one or more attachments from an object. The filter criteria in this step is further narrowed by the "attachmentId" query parameter, if present.

func NewDeleteAttachments(stepInfo mapof.Any) (DeleteAttachments, error)

func (step DeleteAttachments) AmStep()

type Do ¶ added in v0.6.0

type Do struct {
	Action string
}

Do is a Step that calls anoter action to continue processing

func NewDo(stepInfo mapof.Any) (Do, error)

func (step Do) AmStep()

type Dump ¶ added in v0.7.0

type Dump struct {
	Value *template.Template
}

Dump is a Step that can update the data.DataMap custom data stored in a Stream

func NewDump(stepInfo mapof.Any) (Dump, error)

func (step Dump) AmStep()

type EditConnection ¶

type EditConnection struct{}

EditConnection contains the configuration data for a modal that lets administrators manage connections to external servers.

func NewEditConnection(stepInfo mapof.Any) (EditConnection, error)

func (step EditConnection) AmStep()

type EditContent ¶

type EditContent struct {
	Filename  string
	Fieldname string
	Format    string
}

EditContent is a Step that can edit/update Container in a streamDraft.

func NewEditContent(stepInfo mapof.Any) (EditContent, error)

func (step EditContent) AmStep()

type EditModelObject ¶

type EditModelObject struct {
	Form    form.Element
	Options []*template.Template
}

EditModelObject is an action that can add new sub-streams to the domain.

func NewEditModelObject(stepInfo mapof.Any) (EditModelObject, error)

func (step EditModelObject) AmStep()

type EditRegistration ¶ added in v0.7.0

type EditRegistration struct{}

EditRegistration is a Step that locates an existing widget and creates a builder for it.

func NewEditRegistration(stepInfo mapof.Any) (EditRegistration, error)

func (step EditRegistration) AmStep()

func (step EditRegistration) RequireType() string

type EditTemplate ¶ added in v0.7.0

type EditTemplate struct {
	Title string
	Paths []string
}

EditTemplate is a Step that lets users edit an object's template(s)

func NewEditTemplate(stepInfo mapof.Any) (EditTemplate, error)

func (step EditTemplate) AmStep()

type EditWidget ¶ added in v0.6.0

type EditWidget struct{}

EditWidget is a Step that locates an existing widget and creates a builder for it.

func NewEditWidget(stepInfo mapof.Any) (EditWidget, error)

func (step EditWidget) AmStep()

type ForwardTo ¶

type ForwardTo struct {
	URL *template.Template
}

ForwardTo is a Step that forwards the user to a new page.

func NewForwardTo(stepInfo mapof.Any) (ForwardTo, error)

func (step ForwardTo) AmStep()

type GetArchive ¶ added in v0.7.0

type GetArchive struct {
	Token       string
	Depth       int
	JSON        bool
	Attachments bool
	Metadata    [][]map[string]any
}

GetArchive is a Step that removes a named archive from a Stream

func NewGetArchive(stepInfo mapof.Any) (GetArchive, error)

func (step GetArchive) AmStep()

type Halt ¶ added in v0.6.0

type Halt struct{}

Halt is a Step that can update the data.DataMap custom data stored in a Stream

func NewHalt(stepInfo mapof.Any) (Halt, error)

func (step Halt) AmStep()

type IfCondition ¶

type IfCondition struct {
	Condition *template.Template
	Then      []Step
	Otherwise []Step
}

IfCondition is a Step that can update the data.DataMap custom data stored in a Stream

func NewIfCondition(stepInfo mapof.Any) (IfCondition, error)

func (step IfCondition) AmStep()

type InlineError ¶ added in v0.6.0

type InlineError struct {
	Message *template.Template
}

InlineError is a Step that displays an "inline failure" message on a form

func NewInlineError(stepInfo mapof.Any) (InlineError, error)

func (step InlineError) AmStep()

type InlineSaveButton ¶ added in v0.7.0

type InlineSaveButton struct {
	ID    *template.Template
	Class string
	Label *template.Template
}

InlineSaveButton is a Step that displays an "inline success" message on a form

func NewInlineSaveButton(stepInfo mapof.Any) (InlineSaveButton, error)

func (step InlineSaveButton) AmStep()

type InlineSuccess ¶ added in v0.6.0

type InlineSuccess struct {
	Message *template.Template
}

InlineSuccess is a Step that displays an "inline success" message on a form

func NewInlineSuccess(stepInfo mapof.Any) (InlineSuccess, error)

func (step InlineSuccess) AmStep()

type MakeArchive ¶ added in v0.7.0

type MakeArchive struct {
	Token       string
	Depth       int
	JSON        bool
	Attachments bool
	Metadata    [][]map[string]any
}

MakeArchive is a Step that removes a named archive from a Stream

func NewMakeArchive(stepInfo mapof.Any) (MakeArchive, error)

func (step MakeArchive) AmStep()

type ModelRequirer ¶ added in v0.7.0

type ModelRequirer interface {
	RequireModel() string
}

ModelRequirer interface wraps the "RequireModel" method, which specifies that a step can ONLY be used with a specific type of model object. (like: "stream", "follower", "following", etc.)

type ProcessContent ¶ added in v0.6.0

type ProcessContent struct {
	RemoveHTML bool
	AddTags    bool
	AddLinks   bool
}

ProcessContent is an action that can add new sub-streams to the domain.

func NewProcessContent(stepInfo mapof.Any) (ProcessContent, error)

func (step ProcessContent) AmStep()

type ProcessTags ¶ added in v0.7.0

type ProcessTags struct {
	Paths []string
}

ProcessTags is an action that can add new sub-streams to the domain.

func NewProcessTags(stepInfo mapof.Any) (ProcessTags, error)

func (step ProcessTags) AmStep()

type RedirectTo ¶

type RedirectTo struct {
	URL *template.Template
}

RedirectTo is a Step that forwards the user to a new page.

func NewRedirectTo(stepInfo mapof.Any) (RedirectTo, error)

func (step RedirectTo) AmStep()

type RefreshPage ¶

type RefreshPage struct{}

RefreshPage represents an pipeline-step that forwards the user to a new page.

func NewRefreshPage(stepInfo mapof.Any) (RefreshPage, error)

func (step RefreshPage) AmStep()

type ReloadPage ¶

type ReloadPage struct{}

ReloadPage represents an pipeline-step that forwards the user to a new page.

func NewReloadPage(stepInfo mapof.Any) (ReloadPage, error)

func (step ReloadPage) AmStep()

type RemoveEvent ¶ added in v0.6.0

type RemoveEvent struct {
	Event string
}

RemoveEvent is a Step that removes an HX-Trigger event from the HTTP result

func NewRemoveEvent(stepInfo mapof.Any) (RemoveEvent, error)

func (step RemoveEvent) AmStep()

type Save ¶

type Save struct {
	Comment *template.Template
	Method  string
}

Save is a Step that can save changes to any object

func NewSave(stepInfo mapof.Any) (Save, error)

func (step Save) AmStep()

type SaveAndPublish ¶ added in v0.7.0

type SaveAndPublish struct {
	Outbox bool // If TRUE, also send updates to this User's outbox.
}

SaveAndPublish is a Step that can update a stream's SaveAndPublishDate with the current time.

func NewSaveAndPublish(stepInfo mapof.Any) (SaveAndPublish, error)

func (step SaveAndPublish) AmStep()

type SearchIndex ¶ added in v0.7.0

type SearchIndex struct {
	Action string
	If     *template.Template
}

SearchIndex contains the configuration data for a modal that lets administrators manage connections to external servers.

func NewSearchIndex(stepInfo mapof.Any) (SearchIndex, error)

func (step SearchIndex) AmStep()

type SendEmail ¶ added in v0.6.0

type SendEmail struct {
	Email string
}

SendEmail is a Step that can send a named email to a user

func NewSendEmail(stepInfo mapof.Any) (SendEmail, error)

func (step SendEmail) AmStep()

type SetData ¶

type SetData struct {
	FromURL  []string                      // List of paths to pull from URL data
	FromForm []string                      // List of paths to pull from Form data
	Values   map[string]*template.Template // values to set directly into the object
	Defaults mapof.Any                     // values to set into the object IFF they are currently empty.
}

SetData is a Step that can update the custom data stored in a Stream

func NewSetData(stepInfo mapof.Any) (SetData, error)

func (step SetData) AmStep()

type SetHeader ¶

type SetHeader struct {
	Method string
	Name   string
	Value  *template.Template
}

SetHeader is a Step that can update the custom data stored in a Stream

func NewSetHeader(stepInfo mapof.Any) (SetHeader, error)

func (step SetHeader) AmStep()

type SetPassword ¶ added in v0.7.0

type SetPassword struct{}

SetPassword is a Step that can update the custom data stored in a Stream

func NewSetPassword(stepInfo mapof.Any) (SetPassword, error)

func (step SetPassword) AmStep()

type SetQueryParam ¶

type SetQueryParam struct {
	Values map[string]*template.Template
}

SetQueryParam is a Step that forwards the user to a new page.

func NewSetQueryParam(stepInfo mapof.Any) (SetQueryParam, error)

func (step SetQueryParam) AmStep()

type SetRenderData ¶ added in v0.6.0

type SetRenderData struct {
	Values map[string]*template.Template // values to set directly into the object
}

SetRenderData is a Step that can update the custom data stored in a builder

func NewSetRenderData(stepInfo mapof.Any) (SetRenderData, error)

func (step SetRenderData) AmStep()

type SetResponse ¶ added in v0.6.0

type SetResponse struct{}

SetResponse is a Step that can create/update a response to the current model object

func NewSetResponse(stepInfo mapof.Any) (SetResponse, error)

func (step SetResponse) AmStep()

type SetSimpleSharing ¶

type SetSimpleSharing struct {
	Title   string
	Message string
	Roles   []string
}

SetSimpleSharing represents an action that can edit a top-level folder in the Domain

func NewSetSimpleSharing(stepInfo mapof.Any) (SetSimpleSharing, error)

func (step SetSimpleSharing) AmStep()

type SetState ¶

type SetState struct {
	State string
}

SetState is a Step that can change a Stream's state

func NewSetState(stepInfo mapof.Any) (SetState, error)

func (step SetState) AmStep()

type SetThumbnail ¶

type SetThumbnail struct {
	Path string
}

SetThumbnail is a Step that can update the data.DataMap custom data stored in a Stream

func NewSetThumbnail(stepInfo mapof.Any) (SetThumbnail, error)

func (step SetThumbnail) AmStep()

type Sleep ¶ added in v0.7.0

type Sleep struct {
	Duration int
}

Sleep is a Step that sleeps for a determined amount of time. It should really only be used for debugging.

func NewSleep(stepInfo mapof.Any) (Sleep, error)

func (step Sleep) AmStep()

type Sort ¶

type Sort struct {
	Model   string
	Keys    string
	Values  string
	Message string
}

Sort is a Step that can update multiple records at once

func NewSort(stepInfo mapof.Any) (Sort, error)

func (step Sort) AmStep()

type SortAttachments ¶

type SortAttachments struct {
	Keys    string
	Values  string
	Message string
}

SortAttachments is a Step that can update multiple records at once

func NewSortAttachments(stepInfo mapof.Any) (SortAttachments, error)

func (step SortAttachments) AmStep()

type SortWidgets ¶

type SortWidgets struct{}

SortWidgets is a Step that can update multiple records at once

func NewSortWidgets(stepInfo mapof.Any) (SortWidgets, error)

func (step SortWidgets) AmStep()

type Step ¶

type Step interface {
	// AmStep is a NO-OP.  It is only used to validate that a struct contains "step-like" data.
	AmStep()
}

Step interface is used here to bind together the structs in this package

func New(stepInfo mapof.Any) (Step, error)

func NewPipeline[T ~map[string]any](stepInfo []T) ([]Step, error)

type StreamPromoteDraft ¶

type StreamPromoteDraft struct {
	StateID string
}

StreamPromoteDraft represents a pipeline-step that can copy the Container from a StreamDraft into its corresponding Stream

func NewStreamPromoteDraft(stepInfo mapof.Any) (StreamPromoteDraft, error)

func (step StreamPromoteDraft) AmStep()

type TableEditor ¶

type TableEditor struct {
	Path string
	Form form.Element
}

TableEditor is an action that can add new sub-streams to the domain.

func NewTableEditor(stepInfo mapof.Any) (TableEditor, error)

func (step TableEditor) AmStep()

type TriggerEvent ¶

type TriggerEvent struct {
	Event string
	Value *template.Template
}

TriggerEvent is a Step that forwards the user to a new page.

func NewTriggerEvent(stepInfo mapof.Any) (TriggerEvent, error)

func (step TriggerEvent) AmStep()

type TypeRequirer ¶ added in v0.7.0

type TypeRequirer interface {
	RequireType() string
}

TypeRequirer interface wraps the "RequireType" method, which specifies that a step can ONLY be used with a specific type of builder (like: "template", "registration", "widget", "email", etc.)

type UnPublish ¶

type UnPublish struct {
	Outbox bool
}

UnPublish is a Step that can update a stream's UnPublishDate with the current time.

func NewUnPublish(stepInfo mapof.Any) (UnPublish, error)

func (step UnPublish) AmStep()

type UploadAttachments ¶ added in v0.7.0

type UploadAttachments struct {
	Action         string // Action to perform when uploading the attachment ("append" or "replace")
	Fieldname      string // Name of the form field that contains the file data (Default: "file")
	AttachmentPath string // Path name to store the AttachmentID
	DownloadPath   string // Path name to store the download URL
	FilenamePath   string // Path name to store the original filename
	AcceptType     string // Mime Type(s) to accept (e.g. "image/*")
	Category       string // Category to apply to the Attachment
	Maximum        int    // Maximum number of uploads to allow (Default: 1)
	JSONResult     bool   // If TRUE, return a JSON structure with result data. This forces Maximum=1

	Label                string // Value to set as the attachment.label
	LabelFieldname       string // Form field that defines the attachment label
	Description          string // Value to set as the attachment.description
	DescriptionFieldname string // Form field that defines the attachment description

	RuleHeight int      // Fixed height for all downloads
	RuleWidth  int      // Fixed width for all downloads
	RuleTypes  []string // Allowed extensions.  The first value is used as the default.
}

UploadAttachments represents an action that can upload attachments. It can only be used on a StreamBuilder

func NewUploadAttachments(stepInfo mapof.Any) (UploadAttachments, error)

func (step UploadAttachments) AmStep()

type ViewCSS ¶ added in v0.7.0

type ViewCSS struct {
	File string
}

ViewCSS is a Step that can build a Stream into HTML

func NewViewCSS(stepInfo mapof.Any) (ViewCSS, error)

func (step ViewCSS) AmStep()

type ViewFeed ¶

type ViewFeed struct {
}

ViewFeed is a Step that can build a Stream into HTML

func NewViewFeed(stepInfo mapof.Any) (ViewFeed, error)

func (step ViewFeed) AmStep()

type ViewHTML ¶

type ViewHTML struct {
	File       string
	Method     string
	AsFullPage bool
}

ViewHTML is a Step that can build a Stream into HTML

func NewViewHTML(stepInfo mapof.Any) (ViewHTML, error)

func (step ViewHTML) AmStep()

type ViewJSONLD ¶ added in v0.6.0

type ViewJSONLD struct {
	Method string
}

ViewJSONLD is a Step that can build a Stream into HTML

func NewViewJSONLD(stepInfo mapof.Any) (ViewJSONLD, error)

func (step ViewJSONLD) AmStep()

type WebSub ¶

type WebSub struct {
}

WebSub is a Step that can build a Stream into HTML

func NewWebSub(stepInfo mapof.Any) (WebSub, error)

func (step WebSub) AmStep()

type WithAttachment ¶ added in v0.7.0

type WithAttachment struct {
	SubSteps []Step
}

WithAttachment is a Step that returns a new Attachment Builder

func NewWithAttachment(stepInfo mapof.Any) (WithAttachment, error)

func (step WithAttachment) AmStep()

type WithChildren ¶

type WithChildren struct {
	SubSteps []Step
}

WithChildren is a Step executes a list of sub-steps on every child of the current Stream

func NewWithChildren(stepInfo mapof.Any) (WithChildren, error)

func (step WithChildren) AmStep()

type WithDraft ¶

type WithDraft struct {
	SubSteps []Step
}

WithDraft is a Step that returns a new StreamDraft Builder

func NewWithDraft(stepInfo mapof.Any) (WithDraft, error)

func (step WithDraft) AmStep()

type WithFolder ¶

type WithFolder struct {
	SubSteps []Step
}

WithFolder is a Step that returns a new Folder Builder

func NewWithFolder(stepInfo mapof.Any) (WithFolder, error)

func (step WithFolder) AmStep()

type WithFollower ¶

type WithFollower struct {
	SubSteps []Step
}

WithFollower is a Step that returns a new Follower Builder

func NewWithFollower(stepInfo mapof.Any) (WithFollower, error)

func (step WithFollower) AmStep()

type WithFollowing ¶

type WithFollowing struct {
	SubSteps []Step
}

WithFollowing is a Step that returns a new Following builder

func NewWithFollowing(stepInfo mapof.Any) (WithFollowing, error)

func (step WithFollowing) AmStep()

type WithMessage ¶

type WithMessage struct {
	SubSteps []Step
}

WithMessage is a Step that returns a new Message Builder

func NewWithMessage(stepInfo mapof.Any) (WithMessage, error)

func (step WithMessage) AmStep()

type WithNextSibling ¶

type WithNextSibling struct {
	SubSteps []Step
}

WithNextSibling is a Step that returns a new Stream Builder keyed to the next sibling of the current Stream

func NewWithNextSibling(stepInfo mapof.Any) (WithNextSibling, error)

func (step WithNextSibling) AmStep()

type WithParent ¶

type WithParent struct {
	SubSteps []Step
}

WithParent is a Step that returns a new Stream Builder keyed to the parent of the current Stream

func NewWithParent(stepInfo mapof.Any) (WithParent, error)

func (step WithParent) AmStep()

type WithPrevSibling ¶

type WithPrevSibling struct {
	SubSteps []Step
}

WithPrevSibling is a Step that returns a new Stream builder keyed to the previous sibling of the current stream

func NewWithPrevSibling(stepInfo mapof.Any) (WithPrevSibling, error)

func (step WithPrevSibling) AmStep()

type WithResponse ¶ added in v0.6.0

type WithResponse struct {
	SubSteps []Step
}

WithResponse is a Step that returns a new Response Builder

func NewWithResponse(stepInfo mapof.Any) (WithResponse, error)

func (step WithResponse) AmStep()

type WithRule ¶ added in v0.6.0

type WithRule struct {
	SubSteps []Step
}

WithRule is a Step that returns a new Rule Builder

func NewWithRule(stepInfo mapof.Any) (WithRule, error)

func (step WithRule) AmStep()