ExNtfy.Message (ex_ntfy v0.1.0)

A received ntfy message — the JSON schema shared by publish responses and subscribe events.

Parsing is lenient by design: the server adds fields over time, so unknown keys never crash and the original decoded map is retained in raw. Known event names become atoms; unrecognized ones become {:unknown, string}.

Summary

Types

event()

t()

Functions

from_json(binary)

Decodes a JSON binary (e.g. one NDJSON line from a /json subscription) into a message.

from_map(map)

Builds a message from a decoded JSON map.

Types

event()

@type event() ::
  :open
  | :keepalive
  | :message
  | :message_clear
  | :message_delete
  | :poll_request
  | {:unknown, String.t()}

t()

@type t() :: %ExNtfy.Message{
  actions: [ExNtfy.Action.t()] | nil,
  attachment: ExNtfy.Attachment.t() | nil,
  click: String.t() | nil,
  content_type: String.t() | nil,
  event: event(),
  expires: integer() | nil,
  icon: String.t() | nil,
  id: String.t(),
  message: String.t() | nil,
  priority: 1..5 | nil,
  raw: map(),
  sequence_id: String.t() | nil,
  tags: [String.t()] | nil,
  time: integer(),
  title: String.t() | nil,
  topic: String.t()
}

Functions

from_json(binary)

@spec from_json(binary()) :: {:ok, t()} | {:error, term()}

Decodes a JSON binary (e.g. one NDJSON line from a /json subscription) into a message.

Returns {:error, reason} on invalid JSON, non-object JSON, or missing always-present fields.

from_map(map)

@spec from_map(map()) :: {:ok, t()} | {:error, {:missing_fields, [String.t()]}}

Builds a message from a decoded JSON map.

Returns {:error, {:missing_fields, fields}} when any of the always-present fields (id, time, event, topic) are absent; everything else is optional and defaults to nil.

Examples

iex> {:ok, msg} = ExNtfy.Message.from_map(%{
...>   "id" => "sPs71M8A2T",
...>   "time" => 1735920000,
...>   "event" => "message",
...>   "topic" => "mytopic",
...>   "message" => "hi"
...> })
iex> {msg.event, msg.message, msg.priority}
{:message, "hi", nil}