API Reference

func New() mizu.Middleware

func WithOptions(opts Options) mizu.Middleware

func VersionMiddleware(opts VersionOptions) mizu.Middleware

func UniversalLinkMiddleware(cfg UniversalLinkConfig) mizu.Middleware

type Options struct {
    RequireDeviceID       bool
    RequireAppVersion     bool
    AllowedPlatforms      []Platform
    MinAppVersion         string
    SkipPaths             []string
    SkipUserAgent         bool
    OnMissingHeader       func(c *mizu.Ctx, header string) error
    OnUnsupportedPlatform func(c *mizu.Ctx, platform Platform) error
    OnOutdatedApp         func(c *mizu.Ctx, version, minimum string) error
}

type Device struct {
    Platform     Platform
    OSVersion    string
    AppVersion   string
    AppBuild     string
    DeviceID     string
    DeviceModel  string
    Locale       string
    Timezone     string
    PushToken    string
    PushProvider PushProvider
    UserAgent    string
}

type Platform string

const (
    PlatformIOS     Platform = "ios"
    PlatformAndroid Platform = "android"
    PlatformWindows Platform = "windows"
    PlatformMacOS   Platform = "macos"
    PlatformWeb     Platform = "web"
    PlatformUnknown Platform = "unknown"
)

func (p Platform) String() string
func (p Platform) IsMobile() bool
func (p Platform) IsDesktop() bool
func (p Platform) IsNative() bool

type Version struct {
    Major int
    Minor int
}

func ParseVersion(s string) (Version, error)
func (v Version) String() string
func (v Version) IsZero() bool
func (v Version) Compare(other Version) int
func (v Version) AtLeast(major, minor int) bool
func (v Version) Before(major, minor int) bool

type VersionOptions struct {
    Header        string
    QueryParam    string
    PathPrefix    bool
    Default       Version
    Supported     []Version
    Deprecated    []Version
    EchoVersion   bool
    OnUnsupported func(c *mizu.Ctx, v Version) error
}

type Error struct {
    Code    string         `json:"code"`
    Message string         `json:"message"`
    Details map[string]any `json:"details,omitempty"`
    TraceID string         `json:"trace_id,omitempty"`
}

func NewError(code, message string) *Error
func (e *Error) WithDetails(key string, value any) *Error
func (e *Error) WithTraceID(traceID string) *Error
func (e *Error) Error() string

type SyncToken string

func NewSyncToken(t time.Time) SyncToken
func (t SyncToken) Time() time.Time
func (t SyncToken) String() string
func (t SyncToken) IsEmpty() bool

type SyncRequest struct {
    Token     SyncToken
    Resources []string
    FullSync  bool
    Limit     int
}

func ParseSyncRequest(c *mizu.Ctx) SyncRequest
func (r SyncRequest) Since() time.Time
func (r SyncRequest) IsInitial() bool

type Delta[T any] struct {
    Created []T      `json:"created,omitempty"`
    Updated []T      `json:"updated,omitempty"`
    Deleted []string `json:"deleted,omitempty"`
}

func (d Delta[T]) IsEmpty() bool
func (d Delta[T]) Count() int

type SyncDelta[T any] struct {
    Delta[T]
    SyncToken SyncToken `json:"sync_token"`
    HasMore   bool      `json:"has_more"`
    FullSync  bool      `json:"full_sync,omitempty"`
}

func NewSyncDelta[T any](delta Delta[T], token SyncToken, hasMore bool) SyncDelta[T]
func NewFullSyncDelta[T any](delta Delta[T], token SyncToken, hasMore bool) SyncDelta[T]

type PushToken struct {
    Token      string       `json:"token"`
    Provider   PushProvider `json:"provider"`
    DeviceID   string       `json:"device_id,omitempty"`
    Sandbox    bool         `json:"sandbox,omitempty"`
    CreatedAt  time.Time    `json:"created_at,omitempty"`
    UpdatedAt  time.Time    `json:"updated_at,omitempty"`
    AppVersion string       `json:"app_version,omitempty"`
}

func ParsePushToken(c *mizu.Ctx) *PushToken

type PushProvider string

const (
    PushAPNS PushProvider = "apns"
    PushFCM  PushProvider = "fcm"
    PushWNS  PushProvider = "wns"
)

type PushPayload struct {
    Title            string         `json:"title,omitempty"`
    Body             string         `json:"body,omitempty"`
    Badge            *int           `json:"badge,omitempty"`
    Sound            string         `json:"sound,omitempty"`
    Data             map[string]any `json:"data,omitempty"`
    Category         string         `json:"category,omitempty"`
    ThreadID         string         `json:"thread_id,omitempty"`
    ChannelID        string         `json:"channel_id,omitempty"`
    CollapseKey      string         `json:"collapse_key,omitempty"`
    Priority         string         `json:"priority,omitempty"`
    TTL              int            `json:"ttl,omitempty"`
    ContentAvailable bool           `json:"content_available,omitempty"`
    MutableContent   bool           `json:"mutable_content,omitempty"`
}

func (p *PushPayload) WithData(key string, value any) *PushPayload
func (p *PushPayload) SetBadge(n int) *PushPayload
func (p *PushPayload) ToAPNS() map[string]any
func (p *PushPayload) ToFCM() map[string]any

type DeepLink struct {
    Scheme   string
    Host     string
    Paths    []string
    Fallback string
}

func (d DeepLink) AppleAppSiteAssociation(teamID, bundleID string) []byte
func (d DeepLink) AssetLinks(packageName, fingerprint string) []byte

type AppInfo struct {
    CurrentVersion     string            `json:"current_version"`
    MinimumVersion     string            `json:"minimum_version"`
    UpdateURL          string            `json:"update_url"`
    ReleaseNotes       string            `json:"release_notes,omitempty"`
    ReleasedAt         time.Time         `json:"released_at,omitempty"`
    ForceUpdate        bool              `json:"force_update"`
    MaintenanceMode    bool              `json:"maintenance_mode"`
    MaintenanceMessage string            `json:"maintenance_message,omitempty"`
    MaintenanceEndTime *time.Time        `json:"maintenance_end_time,omitempty"`
    Features           map[string]bool   `json:"features,omitempty"`
}

func DeviceFromCtx(c *mizu.Ctx) *Device

func VersionFromCtx(c *mizu.Ctx) Version

func SendError(c *mizu.Ctx, status int, err *Error) error

func SetSyncToken(c *mizu.Ctx, token SyncToken)

func ValidateToken(token string, provider PushProvider) bool

func ValidateAPNS(token string) bool

func ValidateFCM(token string) bool

func CheckUpdate(clientVersion, latestVersion, minimumVersion string) UpdateStatus

func NewStaticAppInfo(currentVersion, minVersion, updateURL string) *StaticAppInfo

func NewIOSStoreURL(appID string) string

func NewAndroidStoreURL(packageName string) string

const (
    ErrInvalidRequest  = "invalid_request"
    ErrUnauthorized    = "unauthorized"
    ErrForbidden       = "forbidden"
    ErrNotFound        = "not_found"
    ErrConflict        = "conflict"
    ErrValidation      = "validation_error"
    ErrRateLimited     = "rate_limited"
    ErrUpgradeRequired = "upgrade_required"
    ErrMaintenance     = "maintenance"
    ErrInternal        = "internal_error"
)

const (
    HeaderDeviceID    = "X-Device-ID"
    HeaderAppVersion  = "X-App-Version"
    HeaderAppBuild    = "X-App-Build"
    HeaderDeviceModel = "X-Device-Model"
    HeaderPlatform    = "X-Platform"
    HeaderOSVersion   = "X-OS-Version"
    HeaderTimezone    = "X-Timezone"
    HeaderLocale      = "X-Locale"
    HeaderPushToken   = "X-Push-Token"
    HeaderAPIVersion  = "X-API-Version"
    HeaderSyncToken   = "X-Sync-Token"
    HeaderIdempotency = "X-Idempotency-Key"
    HeaderRequestID   = "X-Request-ID"
    HeaderMinVersion  = "X-Min-App-Version"
    HeaderDeprecated  = "X-API-Deprecated"
)