zap-schema 1.0.0

ZAP Schema Compiler - Zero-Copy Application Protocol with whitespace-significant syntax
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

# chat.zap - Real-time chat application schema
# Demonstrates nested types, enums, unions, and interfaces

struct User
  id Text
  name Text
  avatar Text
  status Status

  enum Status
    online
    away
    busy
    offline

struct Message
  id Text
  author User
  timestamp UInt64
  content Content
  reactions List(Reaction)

  union Content
    text TextContent
    image ImageContent
    file FileContent
    system SystemContent

  struct TextContent
    body Text
    mentions List(Text)

  struct ImageContent
    url Text
    width UInt32
    height UInt32
    alt Text

  struct FileContent
    url Text
    name Text
    size UInt64
    mimeType Text

  struct SystemContent
    event Text
    data Text

struct Reaction
  emoji Text
  users List(Text)

struct Room
  id Text
  name Text
  description Text
  members List(User)
  messages List(Message)
  settings RoomSettings

  struct RoomSettings
    isPrivate Bool
    maxMembers UInt32 = 100
    allowFiles Bool = true
    allowImages Bool = true

interface ChatService
  # Authentication
  login (credentials Credentials) -> (session Session)
  logout (sessionId Text) -> ()

  # Rooms
  createRoom (name Text, settings RoomSettings) -> (room Room)
  joinRoom (roomId Text) -> (room Room)
  leaveRoom (roomId Text) -> ()
  listRooms () -> (rooms List(Room))

  # Messages
  sendMessage (roomId Text, content Content) -> (message Message)
  editMessage (messageId Text, content Content) -> (message Message)
  deleteMessage (messageId Text) -> ()
  getMessages (roomId Text, before UInt64, limit UInt32) -> (messages List(Message))

  # Real-time
  subscribe (roomId Text) -> (events List(ChatEvent))

  # Reactions
  addReaction (messageId Text, emoji Text) -> ()
  removeReaction (messageId Text, emoji Text) -> ()

struct Credentials
  username Text
  password Text

struct Session
  id Text
  user User
  expiresAt UInt64

struct ChatEvent
  type EventType
  payload Data
  timestamp UInt64

  enum EventType
    messageCreated
    messageUpdated
    messageDeleted
    userJoined
    userLeft
    userStatusChanged
    reactionAdded
    reactionRemoved