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
|
-- Storage Interface API Description
--
-- This is written as a TypedLua description
-- Key-Value stores (the default)
interface keyval_store
get : ( self, string? ) -> (any) | (nil, string)
set : ( self, string?, any ) -> (boolean) | (nil, string)
end
-- Map stores (key-key-value stores)
interface map_store
get : ( self, string?, any ) -> (any) | (nil, string)
set : ( self, string?, any, any ) -> (boolean) | (nil, string)
set_keys : ( self, string?, { any : any }) -> (boolean) | (nil, string)
remove : {}
end
-- Archive stores
typealias archive_query = {
"start" : number?, -- timestamp
"end" : number?, -- timestamp
"with" : string?,
"after" : string?, -- archive id
"before" : string?, -- archive id
"total" : boolean?,
}
interface archive_store
-- Optional set of capabilities
caps : {
-- Optional total count of matching items returned as second return value from :find()
"total" : boolean?,
}?
-- Add to the archive
append : ( self, string?, string?, any, number?, string? ) -> (string) | (nil, string)
-- Iterate over archive
find : ( self, string?, archive_query? ) -> ( () -> ( string, any, number?, string? ), integer? )
-- Removal of items. API like find. Optional?
delete : ( self, string?, archive_query? ) -> (boolean) | (number) | (nil, string)
-- Array of dates which do have messages (Optional?)
dates : ( self, string? ) -> ({ string }) | (nil, string)
-- Map of counts per "with" field
summary : ( self, string?, archive_query? ) -> ( { string : integer } ) | (nil, string)
-- Map-store API
get : ( self, string, string ) -> (stanza, number?, string?) | (nil, string)
set : ( self, string, string, stanza, number?, string? ) -> (boolean) | (nil, string)
end
-- This represents moduleapi
interface module
-- If the first string is omitted then the name of the module is used
-- The second string is one of "keyval" (default), "map" or "archive"
open_store : (self, string?, string?) -> (keyval_store) | (map_store) | (archive_store) | (nil, string)
-- Other module methods omitted
end
module : module
|
