apex/up

package up

import (
    "io"
    "time"
)

// TODO: finalize and finish documentation

// LogsConfig is configuration for viewing logs.
type LogsConfig struct {
    // Region is the target region.
    Region string

    // Query is the filter pattern.
    Query string

    // Since is used as the starting point when filtering
    // historical logs, no logs before this point are returned.
    Since time.Time

    // Follow is used to stream new logs.
    Follow bool

    // Expand is used to expand logs to a verbose format.
    Expand bool

    // OutputJSON is used to output raw json.
    OutputJSON bool
}

// Logs is the interface for viewing platform logs.
type Logs interface {
    io.Reader
}

// Domains is the interface for purchasing and
// managing domains names.
type Domains interface {
    Availability(domain string) (*Domain, error)
    Suggestions(domain string) ([]*Domain, error)
    Purchase(domain string, contact DomainContact) error
    List() ([]*Domain, error)
}

// Deploy config.
type Deploy struct {
    Stage  string
    Commit string
    Author string
    Build  bool
}

// Platform is the interface for platform integration,
// defining the basic set of functionality required for
// Up applications.
type Platform interface {
    // Build the project.
    Build() error

    // Deploy to the given stage, to the
    // region(s) configured by the user.
    Deploy(Deploy) error

    // Logs returns an interface for working
    // with logging data.
    Logs(LogsConfig) Logs

    // Domains returns an interface for
    // managing domain names.
    Domains() Domains

    // URL returns the endpoint for the given
    // region and stage combination, or an
    // empty string.
    URL(region, stage string) (string, error)

    // Exists returns true if the application has been created.
    Exists(region string) (bool, error)

    CreateStack(region, version string) error
    DeleteStack(region string, wait bool) error
    ShowStack(region string) error
    PlanStack(region string) error
    ApplyStack(region string) error

    ShowMetrics(region, stage string, start time.Time) error
}

// Pruner is the interface used to prune old versions and
// the artifacts associated such as S3 zip files for Lambda.
type Pruner interface {
    Prune(region, stage string, versions int) error
}

// Runtime is the interface used by a platform to support
// runtime operations such as initializing environment
// variables from remote storage.
type Runtime interface {
    Init(stage string) error
}

// Zipper is the interface used by platforms which
// utilize zips for delivery of deployments.
type Zipper interface {
    Zip() io.Reader
}

// Domain is a domain name and its availability.
type Domain struct {
    Name      string
    Available bool
    Expiry    time.Time
    AutoRenew bool
}

// DomainContact is the domain name contact
// information required for registration.
type DomainContact struct {
    Email            string
    FirstName        string
    LastName         string
    CountryCode      string
    City             string
    Address          string
    OrganizationName string
    PhoneNumber      string
    State            string
    ZipCode          string
}