mirror of
https://github.com/ilyakooo0/urbit.git
synced 2024-12-19 12:51:51 +03:00
8bf4373d13
Fixes #6216 - bitcoin: removed - garden: new location https://github.com/tloncorp/landscape - hs: removed - urbit (vere), docker-image, ent, urcrypt: new repo https://github.com/urbit/vere
160 lines
4.5 KiB
Plaintext
160 lines
4.5 KiB
Plaintext
^?
|
|
::
|
|
:: %hark-store: Notification, unreads store
|
|
::
|
|
:: Timeboxing & binning:
|
|
::
|
|
:: Unread notifications accumulate in $unreads. They are grouped by
|
|
:: their $bin. A notification may become read by either:
|
|
:: a) being read by a %read-count or %read-each or %read-note
|
|
:: b) being read by a %seen
|
|
::
|
|
:: If a) then we insert the corresponding bin into $reads at the
|
|
:: current timestamp
|
|
:: If b) then we empty $unreads and move all bins to $reads at the
|
|
:: current timestamp
|
|
::
|
|
:: Unread tracking:
|
|
:: Unread tracking has two 'modes' which may be used concurrently,
|
|
:: if necessary.
|
|
::
|
|
:: count:
|
|
:: This stores the unreads as a simple atom, describing the number
|
|
:: of unread items. May be increased with %unread-count and
|
|
:: set to zero with %read-count. Ideal for high-frequency linear
|
|
:: datastructures, e.g. chat
|
|
:: each:
|
|
:: This stores the unreads as a set of paths, describing the set of
|
|
:: unread items. Unreads may be added to the set with %unread-each
|
|
:: and removed with %read-each. Ideal for non-linear, low-frequency
|
|
:: datastructures, e.g. blogs
|
|
::
|
|
|%
|
|
:: $place: A location, under which landscape stores stats
|
|
::
|
|
:: .desk must match q.byk.bowl
|
|
:: Examples:
|
|
:: A chat:
|
|
:: [%landscape /~dopzod/urbit-help]
|
|
:: A note in a notebook:
|
|
:: [%landscape /~darrux-landes/feature-requests/12374893234232]
|
|
:: A group:
|
|
:: [%hark-group-hook /~bitbet-bolbel/urbit-community]
|
|
:: Comments on a link
|
|
:: [%landscape /~dabben-larbet/urbit-in-the-news/17014118450499614194868/2]
|
|
::
|
|
+$ place [=desk =path]
|
|
::
|
|
:: $bin: Identifier for grouping notifications
|
|
::
|
|
:: Examples
|
|
:: A mention in a chat:
|
|
:: [/mention %landscape /~dopzod/urbit-help]
|
|
:: New messages in a chat
|
|
:: [/message %landscape /~dopzod/urbit-help]
|
|
:: A new comment in a notebook:
|
|
:: [/comment %landscape /~darrux-landes/feature-requests/12374893234232/2]
|
|
::
|
|
+$ bin [=path =place]
|
|
::
|
|
:: $lid: Reference to a timebox
|
|
::
|
|
+$ lid
|
|
$% [%archive =time]
|
|
[%seen ~]
|
|
[%unseen ~]
|
|
==
|
|
:: $content: Notification content
|
|
+$ content
|
|
$% [%ship =ship]
|
|
[%text =cord]
|
|
==
|
|
::
|
|
:: $body: A notification body
|
|
::
|
|
+$ body
|
|
$: title=(list content)
|
|
content=(list content)
|
|
=time
|
|
binned=path
|
|
link=path
|
|
==
|
|
::
|
|
+$ notification
|
|
[date=@da =bin body=(list body)]
|
|
:: $timebox: Group of notificatons
|
|
+$ timebox
|
|
(map bin notification)
|
|
:: $archive: Archived notifications, ordered by time
|
|
+$ archive
|
|
((mop @da timebox) gth)
|
|
::
|
|
+$ action
|
|
$% :: hook actions
|
|
::
|
|
:: %add-note: add a notification
|
|
[%add-note =bin =body]
|
|
::
|
|
:: %del-place: Underlying resource disappeared, remove all
|
|
:: associated notifications
|
|
[%del-place =place]
|
|
:: %unread-count: Change unread count by .count
|
|
[%unread-count =place inc=? count=@ud]
|
|
:: %unread-each: Add .path to list of unreads for .place
|
|
[%unread-each =place =path]
|
|
:: %saw-place: Update last-updated for .place to now.bowl
|
|
[%saw-place =place time=(unit time)]
|
|
:: store actions
|
|
::
|
|
:: %archive: archive single notification
|
|
:: if .time is ~, then archiving unread notification
|
|
:: else, archiving read notification
|
|
[%archive =lid =bin]
|
|
:: %read-count: set unread count to zero
|
|
[%read-count =place]
|
|
:: %read-each: remove path from unreads for .place
|
|
[%read-each =place =path]
|
|
:: %read-note: Read note at .bin
|
|
[%read-note =bin]
|
|
:: %archive-all: Archive all notifications
|
|
[%archive-all ~]
|
|
:: %opened: User opened notifications, reset timeboxing logic.
|
|
::
|
|
[%opened ~]
|
|
::
|
|
:: XX: previously in hark-store, now deprecated
|
|
:: the hooks responsible for creating notifications may offer pokes
|
|
:: similar to this
|
|
:: [%read-graph =resource]
|
|
:: [%read-group =resource]
|
|
:: [%remove-graph =resource]
|
|
::
|
|
==
|
|
:: .stats: Statistics for a .place
|
|
::
|
|
+$ stats
|
|
$: count=@ud
|
|
each=(set path)
|
|
last=@da
|
|
timebox=(unit @da)
|
|
==
|
|
::
|
|
+$ update
|
|
$% action
|
|
:: %more: more updates
|
|
[%archived =time =lid =notification]
|
|
[%more more=(list update)]
|
|
:: %note-read: note has been read with timestamp
|
|
[%note-read =time =bin]
|
|
[%added =notification]
|
|
:: %timebox: description of timebox.
|
|
::
|
|
[%timebox =lid =(list notification)]
|
|
:: %place-stats: description of .stats for a .place
|
|
[%place-stats =place =stats]
|
|
:: %place-stats: stats for all .places
|
|
[%all-stats places=(map place stats)]
|
|
==
|
|
--
|
|
|