acebase-server 1.19.0 → 1.19.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintrc.json +49 -49
- package/.github/workflows/publish.yml +125 -0
- package/Dockerfile +26 -26
- package/LICENSE +21 -21
- package/bin/acebase-server.js +8 -8
- package/create-package-files.sh +25 -0
- package/dist/cjs/routes/data-exists.js +2 -2
- package/dist/cjs/routes/data-export.js +2 -2
- package/dist/cjs/routes/data-get.js +2 -2
- package/dist/cjs/routes/data-reflect.js +2 -2
- package/dist/cjs/routes/docs.js +1 -1
- package/dist/cjs/routes/meta-info.js +1 -1
- package/dist/esm/routes/data-exists.js +1 -2
- package/dist/esm/routes/data-export.js +1 -2
- package/dist/esm/routes/data-get.js +1 -1
- package/dist/esm/routes/data-reflect.js +1 -2
- package/dist/esm/routes/docs.js +1 -1
- package/dist/esm/routes/meta-info.js +1 -1
- package/package.json +6 -7
- package/release_notes.md +2 -0
- package/src/routes/auth-change-password.yaml +73 -73
- package/src/routes/auth-delete.yaml +77 -77
- package/src/routes/auth-forgot-password.yaml +49 -49
- package/src/routes/auth-reset-password.yaml +53 -53
- package/src/routes/auth-signin.yaml +129 -129
- package/src/routes/auth-signout.yaml +46 -46
- package/src/routes/auth-signup.yaml +135 -135
- package/src/routes/auth-state.yaml +28 -28
- package/src/routes/auth-update.yaml +151 -151
- package/src/routes/auth-verify-email.yaml +52 -52
- package/src/routes/data-exists.yaml +44 -44
- package/src/routes/data-export.yaml +63 -63
- package/src/routes/data-import.yaml +74 -74
- package/src/routes/data-index-create.yaml +105 -105
- package/src/routes/data-index-delete.yaml +51 -51
- package/src/routes/data-index-list.yaml +84 -84
- package/src/routes/data-query.yaml +165 -165
- package/src/routes/data-reflect.yaml +124 -124
- package/src/routes/data-schema-get.yaml +53 -53
- package/src/routes/data-schema-set.yaml +64 -64
- package/src/routes/data-schema-test.yaml +66 -66
- package/src/routes/data-schemas-list.yaml +41 -41
- package/src/routes/data-set.yaml +77 -77
- package/src/routes/data-sync-changes.yaml +66 -66
- package/src/routes/data-sync-mutations.yaml +66 -66
- package/src/routes/data-transaction-finish.yaml +82 -82
- package/src/routes/data-transaction-start.yaml +58 -58
- package/src/routes/data-update.yaml +77 -77
- package/src/routes/meta-info.yaml +40 -40
- package/src/routes/meta-ping.yaml +22 -22
- package/src/routes/meta-stats.yaml +40 -40
- package/src/routes/oauth2-init.yaml +62 -62
- package/src/routes/oauth2-refresh.yaml +64 -64
- package/src/routes/oauth2-signin.yaml +65 -65
- package/webmanager/acebase-client-browser.min.js +12 -12
- package/webmanager/index.html +271 -271
- package/webmanager/index.js +437 -437
|
@@ -1,84 +1,84 @@
|
|
|
1
|
-
/index/{dbname}:
|
|
2
|
-
get:
|
|
3
|
-
tags:
|
|
4
|
-
- data
|
|
5
|
-
- indexes
|
|
6
|
-
summary: Get indexes in the database
|
|
7
|
-
description: Gets a list of indexes created in the database (admin only)
|
|
8
|
-
parameters:
|
|
9
|
-
- name: dbname
|
|
10
|
-
in: path
|
|
11
|
-
description: name of the database
|
|
12
|
-
required: true
|
|
13
|
-
schema:
|
|
14
|
-
type: string
|
|
15
|
-
example: mydb
|
|
16
|
-
responses:
|
|
17
|
-
200:
|
|
18
|
-
description: Returns an array of indexes in the database
|
|
19
|
-
content:
|
|
20
|
-
'application/json':
|
|
21
|
-
schema:
|
|
22
|
-
type: array
|
|
23
|
-
items:
|
|
24
|
-
type: object
|
|
25
|
-
properties:
|
|
26
|
-
path:
|
|
27
|
-
type: string
|
|
28
|
-
description: path of the indexed collection
|
|
29
|
-
example: books
|
|
30
|
-
key:
|
|
31
|
-
type: string
|
|
32
|
-
description: key (property) of the indexed items in the collection
|
|
33
|
-
example: title
|
|
34
|
-
caseSensitive:
|
|
35
|
-
type: boolean
|
|
36
|
-
description: Whether the values are indexed with case sensitivity or not (applies to string values only)
|
|
37
|
-
example: false
|
|
38
|
-
textLocale:
|
|
39
|
-
type: string
|
|
40
|
-
description: Locale of the indexed string values
|
|
41
|
-
example: en-us
|
|
42
|
-
textLocaleKey:
|
|
43
|
-
type: string
|
|
44
|
-
description: Key (property) that contains the locale of an indexed item, overrides the default in textLocale
|
|
45
|
-
example: en-us
|
|
46
|
-
includeKeys:
|
|
47
|
-
type: array
|
|
48
|
-
description: keys (properties) whose values are included in the index
|
|
49
|
-
items:
|
|
50
|
-
type: string
|
|
51
|
-
example:
|
|
52
|
-
- rating
|
|
53
|
-
- year
|
|
54
|
-
indexMetadataKeys:
|
|
55
|
-
type: array
|
|
56
|
-
description: Any additional info that is being stored with the items. Eg for fulltext indexes, it contains the word count and location
|
|
57
|
-
items:
|
|
58
|
-
type: string
|
|
59
|
-
type:
|
|
60
|
-
type: string
|
|
61
|
-
description: Type of index
|
|
62
|
-
enum:
|
|
63
|
-
- normal
|
|
64
|
-
- array
|
|
65
|
-
- fulltext
|
|
66
|
-
- geo
|
|
67
|
-
fileName:
|
|
68
|
-
type: string
|
|
69
|
-
description: name of the index file on disk
|
|
70
|
-
description:
|
|
71
|
-
type: string
|
|
72
|
-
description: description of the index
|
|
73
|
-
403:
|
|
74
|
-
description: Returns a "403 Forbidden" if the signed in user is not admin
|
|
75
|
-
content:
|
|
76
|
-
'application/json':
|
|
77
|
-
schema:
|
|
78
|
-
$ref: '#/components/schemas/Error'
|
|
79
|
-
500:
|
|
80
|
-
description: An unexpected error occurred
|
|
81
|
-
content:
|
|
82
|
-
'application/json':
|
|
83
|
-
schema:
|
|
84
|
-
$ref: '#/components/schemas/UnexpectedError'
|
|
1
|
+
/index/{dbname}:
|
|
2
|
+
get:
|
|
3
|
+
tags:
|
|
4
|
+
- data
|
|
5
|
+
- indexes
|
|
6
|
+
summary: Get indexes in the database
|
|
7
|
+
description: Gets a list of indexes created in the database (admin only)
|
|
8
|
+
parameters:
|
|
9
|
+
- name: dbname
|
|
10
|
+
in: path
|
|
11
|
+
description: name of the database
|
|
12
|
+
required: true
|
|
13
|
+
schema:
|
|
14
|
+
type: string
|
|
15
|
+
example: mydb
|
|
16
|
+
responses:
|
|
17
|
+
200:
|
|
18
|
+
description: Returns an array of indexes in the database
|
|
19
|
+
content:
|
|
20
|
+
'application/json':
|
|
21
|
+
schema:
|
|
22
|
+
type: array
|
|
23
|
+
items:
|
|
24
|
+
type: object
|
|
25
|
+
properties:
|
|
26
|
+
path:
|
|
27
|
+
type: string
|
|
28
|
+
description: path of the indexed collection
|
|
29
|
+
example: books
|
|
30
|
+
key:
|
|
31
|
+
type: string
|
|
32
|
+
description: key (property) of the indexed items in the collection
|
|
33
|
+
example: title
|
|
34
|
+
caseSensitive:
|
|
35
|
+
type: boolean
|
|
36
|
+
description: Whether the values are indexed with case sensitivity or not (applies to string values only)
|
|
37
|
+
example: false
|
|
38
|
+
textLocale:
|
|
39
|
+
type: string
|
|
40
|
+
description: Locale of the indexed string values
|
|
41
|
+
example: en-us
|
|
42
|
+
textLocaleKey:
|
|
43
|
+
type: string
|
|
44
|
+
description: Key (property) that contains the locale of an indexed item, overrides the default in textLocale
|
|
45
|
+
example: en-us
|
|
46
|
+
includeKeys:
|
|
47
|
+
type: array
|
|
48
|
+
description: keys (properties) whose values are included in the index
|
|
49
|
+
items:
|
|
50
|
+
type: string
|
|
51
|
+
example:
|
|
52
|
+
- rating
|
|
53
|
+
- year
|
|
54
|
+
indexMetadataKeys:
|
|
55
|
+
type: array
|
|
56
|
+
description: Any additional info that is being stored with the items. Eg for fulltext indexes, it contains the word count and location
|
|
57
|
+
items:
|
|
58
|
+
type: string
|
|
59
|
+
type:
|
|
60
|
+
type: string
|
|
61
|
+
description: Type of index
|
|
62
|
+
enum:
|
|
63
|
+
- normal
|
|
64
|
+
- array
|
|
65
|
+
- fulltext
|
|
66
|
+
- geo
|
|
67
|
+
fileName:
|
|
68
|
+
type: string
|
|
69
|
+
description: name of the index file on disk
|
|
70
|
+
description:
|
|
71
|
+
type: string
|
|
72
|
+
description: description of the index
|
|
73
|
+
403:
|
|
74
|
+
description: Returns a "403 Forbidden" if the signed in user is not admin
|
|
75
|
+
content:
|
|
76
|
+
'application/json':
|
|
77
|
+
schema:
|
|
78
|
+
$ref: '#/components/schemas/Error'
|
|
79
|
+
500:
|
|
80
|
+
description: An unexpected error occurred
|
|
81
|
+
content:
|
|
82
|
+
'application/json':
|
|
83
|
+
schema:
|
|
84
|
+
$ref: '#/components/schemas/UnexpectedError'
|
|
@@ -1,166 +1,166 @@
|
|
|
1
|
-
/query/{dbname}/{path}:
|
|
2
|
-
post:
|
|
3
|
-
tags:
|
|
4
|
-
- data
|
|
5
|
-
- query
|
|
6
|
-
summary: Query an object collection
|
|
7
|
-
description: Query an object collection in the database
|
|
8
|
-
parameters:
|
|
9
|
-
- name: dbname
|
|
10
|
-
in: path
|
|
11
|
-
description: name of the database
|
|
12
|
-
required: true
|
|
13
|
-
schema:
|
|
14
|
-
type: string
|
|
15
|
-
example: mydb
|
|
16
|
-
- name: path
|
|
17
|
-
in: path
|
|
18
|
-
description: database path
|
|
19
|
-
required: true
|
|
20
|
-
schema:
|
|
21
|
-
type: string
|
|
22
|
-
example: books
|
|
23
|
-
requestBody:
|
|
24
|
-
description: serialized query object
|
|
25
|
-
content:
|
|
26
|
-
'application/json':
|
|
27
|
-
schema:
|
|
28
|
-
type: object
|
|
29
|
-
properties:
|
|
30
|
-
map:
|
|
31
|
-
description: Data type mappings for the value in _val_. See the _SerializedValue_ schema for more info
|
|
32
|
-
oneOf:
|
|
33
|
-
- type: string
|
|
34
|
-
- type: object
|
|
35
|
-
example: {}
|
|
36
|
-
val:
|
|
37
|
-
description: Information about the query to execute
|
|
38
|
-
type: object
|
|
39
|
-
properties:
|
|
40
|
-
query:
|
|
41
|
-
type: object
|
|
42
|
-
properties:
|
|
43
|
-
filters:
|
|
44
|
-
type: array
|
|
45
|
-
items:
|
|
46
|
-
type: object
|
|
47
|
-
properties:
|
|
48
|
-
key:
|
|
49
|
-
type: string
|
|
50
|
-
example: title
|
|
51
|
-
description: Key to apply filter on
|
|
52
|
-
op:
|
|
53
|
-
type: string
|
|
54
|
-
description: Comparison operator to use, such as `==`, `>`, 'like' etc
|
|
55
|
-
example: like
|
|
56
|
-
compare:
|
|
57
|
-
example: AceBase*
|
|
58
|
-
description: Value to compare with
|
|
59
|
-
oneOf:
|
|
60
|
-
- type: string
|
|
61
|
-
- type: number
|
|
62
|
-
- type: boolean
|
|
63
|
-
skip:
|
|
64
|
-
type: integer
|
|
65
|
-
example: 0
|
|
66
|
-
description: Number of results to skip, useful for paging
|
|
67
|
-
take:
|
|
68
|
-
type: integer
|
|
69
|
-
example: 10
|
|
70
|
-
description: Max number of results to return
|
|
71
|
-
order:
|
|
72
|
-
type: array
|
|
73
|
-
items:
|
|
74
|
-
type: object
|
|
75
|
-
properties:
|
|
76
|
-
key:
|
|
77
|
-
type: string
|
|
78
|
-
description: Name of the key to sort the results on
|
|
79
|
-
example: rating
|
|
80
|
-
ascending:
|
|
81
|
-
type: boolean
|
|
82
|
-
description: Whether to sort the results in ascending or descending order
|
|
83
|
-
example: false
|
|
84
|
-
query_id:
|
|
85
|
-
type: string
|
|
86
|
-
description: (realtime queries only) client's query id for realtime event notifications through the websocket
|
|
87
|
-
example: l27nswgz000009l58bo7gqhf
|
|
88
|
-
client_id:
|
|
89
|
-
type: string
|
|
90
|
-
description: (realtime queries only) client's socket id for realtime event notifications through websocket
|
|
91
|
-
example: l27mjf9k000209mhafylc3eo
|
|
92
|
-
options:
|
|
93
|
-
type: object
|
|
94
|
-
properties:
|
|
95
|
-
snapshots:
|
|
96
|
-
type: boolean
|
|
97
|
-
description: Whether to return snapshots of the data, or references to the results only (default)
|
|
98
|
-
example: true
|
|
99
|
-
monitor:
|
|
100
|
-
description: (optional, realtime queries only) which realtime events to monitor
|
|
101
|
-
oneOf:
|
|
102
|
-
- type: boolean
|
|
103
|
-
description: Whether to monitor all or none of the realtime events (add, change, remove)
|
|
104
|
-
- type: object
|
|
105
|
-
description: Which realtime events to monitor
|
|
106
|
-
properties:
|
|
107
|
-
add:
|
|
108
|
-
type: boolean
|
|
109
|
-
description: Monitors results that are added after initial query execution
|
|
110
|
-
change:
|
|
111
|
-
type: boolean
|
|
112
|
-
description: Monitors results that are changed after initial query execution
|
|
113
|
-
remove:
|
|
114
|
-
type: boolean
|
|
115
|
-
description: Monitors results that are removed after initial query execution
|
|
116
|
-
example: false
|
|
117
|
-
include:
|
|
118
|
-
type: array
|
|
119
|
-
items:
|
|
120
|
-
type: string
|
|
121
|
-
description: (optional) keys to include in the results set
|
|
122
|
-
example:
|
|
123
|
-
- title
|
|
124
|
-
- author
|
|
125
|
-
- rating
|
|
126
|
-
- reviews/*/author
|
|
127
|
-
- reviews/*/text
|
|
128
|
-
exclude:
|
|
129
|
-
type: array
|
|
130
|
-
items:
|
|
131
|
-
type: string
|
|
132
|
-
description: (optional) keys to exclude from the results set
|
|
133
|
-
example: []
|
|
134
|
-
child_objects:
|
|
135
|
-
type: boolean
|
|
136
|
-
description: (optional) whether to load child object values
|
|
137
|
-
example: true
|
|
138
|
-
responses:
|
|
139
|
-
200:
|
|
140
|
-
description: Returns the serialized count and list of query results
|
|
141
|
-
content:
|
|
142
|
-
'application/json':
|
|
143
|
-
schema:
|
|
144
|
-
required:
|
|
145
|
-
- val
|
|
146
|
-
allOf:
|
|
147
|
-
- $ref: '#/components/schemas/SerializedValue'
|
|
148
|
-
example:
|
|
149
|
-
val: { count: 1, list: [{ path: 'books/l27oxggz000009ml9ri26y2d', val: { title: 'AceBase is cool', author: 'Database guru', rating: 5.0, reviews: { 'cl27ozp2g000009lbfopcbkd2': { author: 'DB admin', text: 'The title says it all!' } } }}] }
|
|
150
|
-
map: { 'stats/created': 'date', 'stats/modified': 'date' }
|
|
151
|
-
403:
|
|
152
|
-
description: Returns a "403 Forbidden" if the signed in user is not allowed to read from the target path
|
|
153
|
-
content:
|
|
154
|
-
'application/json':
|
|
155
|
-
schema:
|
|
156
|
-
$ref: '#/components/schemas/Error'
|
|
157
|
-
500:
|
|
158
|
-
description: An unexpected error occurred
|
|
159
|
-
content:
|
|
160
|
-
'application/json':
|
|
161
|
-
schema:
|
|
162
|
-
$ref: '#/components/schemas/UnexpectedError'
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
1
|
+
/query/{dbname}/{path}:
|
|
2
|
+
post:
|
|
3
|
+
tags:
|
|
4
|
+
- data
|
|
5
|
+
- query
|
|
6
|
+
summary: Query an object collection
|
|
7
|
+
description: Query an object collection in the database
|
|
8
|
+
parameters:
|
|
9
|
+
- name: dbname
|
|
10
|
+
in: path
|
|
11
|
+
description: name of the database
|
|
12
|
+
required: true
|
|
13
|
+
schema:
|
|
14
|
+
type: string
|
|
15
|
+
example: mydb
|
|
16
|
+
- name: path
|
|
17
|
+
in: path
|
|
18
|
+
description: database path
|
|
19
|
+
required: true
|
|
20
|
+
schema:
|
|
21
|
+
type: string
|
|
22
|
+
example: books
|
|
23
|
+
requestBody:
|
|
24
|
+
description: serialized query object
|
|
25
|
+
content:
|
|
26
|
+
'application/json':
|
|
27
|
+
schema:
|
|
28
|
+
type: object
|
|
29
|
+
properties:
|
|
30
|
+
map:
|
|
31
|
+
description: Data type mappings for the value in _val_. See the _SerializedValue_ schema for more info
|
|
32
|
+
oneOf:
|
|
33
|
+
- type: string
|
|
34
|
+
- type: object
|
|
35
|
+
example: {}
|
|
36
|
+
val:
|
|
37
|
+
description: Information about the query to execute
|
|
38
|
+
type: object
|
|
39
|
+
properties:
|
|
40
|
+
query:
|
|
41
|
+
type: object
|
|
42
|
+
properties:
|
|
43
|
+
filters:
|
|
44
|
+
type: array
|
|
45
|
+
items:
|
|
46
|
+
type: object
|
|
47
|
+
properties:
|
|
48
|
+
key:
|
|
49
|
+
type: string
|
|
50
|
+
example: title
|
|
51
|
+
description: Key to apply filter on
|
|
52
|
+
op:
|
|
53
|
+
type: string
|
|
54
|
+
description: Comparison operator to use, such as `==`, `>`, 'like' etc
|
|
55
|
+
example: like
|
|
56
|
+
compare:
|
|
57
|
+
example: AceBase*
|
|
58
|
+
description: Value to compare with
|
|
59
|
+
oneOf:
|
|
60
|
+
- type: string
|
|
61
|
+
- type: number
|
|
62
|
+
- type: boolean
|
|
63
|
+
skip:
|
|
64
|
+
type: integer
|
|
65
|
+
example: 0
|
|
66
|
+
description: Number of results to skip, useful for paging
|
|
67
|
+
take:
|
|
68
|
+
type: integer
|
|
69
|
+
example: 10
|
|
70
|
+
description: Max number of results to return
|
|
71
|
+
order:
|
|
72
|
+
type: array
|
|
73
|
+
items:
|
|
74
|
+
type: object
|
|
75
|
+
properties:
|
|
76
|
+
key:
|
|
77
|
+
type: string
|
|
78
|
+
description: Name of the key to sort the results on
|
|
79
|
+
example: rating
|
|
80
|
+
ascending:
|
|
81
|
+
type: boolean
|
|
82
|
+
description: Whether to sort the results in ascending or descending order
|
|
83
|
+
example: false
|
|
84
|
+
query_id:
|
|
85
|
+
type: string
|
|
86
|
+
description: (realtime queries only) client's query id for realtime event notifications through the websocket
|
|
87
|
+
example: l27nswgz000009l58bo7gqhf
|
|
88
|
+
client_id:
|
|
89
|
+
type: string
|
|
90
|
+
description: (realtime queries only) client's socket id for realtime event notifications through websocket
|
|
91
|
+
example: l27mjf9k000209mhafylc3eo
|
|
92
|
+
options:
|
|
93
|
+
type: object
|
|
94
|
+
properties:
|
|
95
|
+
snapshots:
|
|
96
|
+
type: boolean
|
|
97
|
+
description: Whether to return snapshots of the data, or references to the results only (default)
|
|
98
|
+
example: true
|
|
99
|
+
monitor:
|
|
100
|
+
description: (optional, realtime queries only) which realtime events to monitor
|
|
101
|
+
oneOf:
|
|
102
|
+
- type: boolean
|
|
103
|
+
description: Whether to monitor all or none of the realtime events (add, change, remove)
|
|
104
|
+
- type: object
|
|
105
|
+
description: Which realtime events to monitor
|
|
106
|
+
properties:
|
|
107
|
+
add:
|
|
108
|
+
type: boolean
|
|
109
|
+
description: Monitors results that are added after initial query execution
|
|
110
|
+
change:
|
|
111
|
+
type: boolean
|
|
112
|
+
description: Monitors results that are changed after initial query execution
|
|
113
|
+
remove:
|
|
114
|
+
type: boolean
|
|
115
|
+
description: Monitors results that are removed after initial query execution
|
|
116
|
+
example: false
|
|
117
|
+
include:
|
|
118
|
+
type: array
|
|
119
|
+
items:
|
|
120
|
+
type: string
|
|
121
|
+
description: (optional) keys to include in the results set
|
|
122
|
+
example:
|
|
123
|
+
- title
|
|
124
|
+
- author
|
|
125
|
+
- rating
|
|
126
|
+
- reviews/*/author
|
|
127
|
+
- reviews/*/text
|
|
128
|
+
exclude:
|
|
129
|
+
type: array
|
|
130
|
+
items:
|
|
131
|
+
type: string
|
|
132
|
+
description: (optional) keys to exclude from the results set
|
|
133
|
+
example: []
|
|
134
|
+
child_objects:
|
|
135
|
+
type: boolean
|
|
136
|
+
description: (optional) whether to load child object values
|
|
137
|
+
example: true
|
|
138
|
+
responses:
|
|
139
|
+
200:
|
|
140
|
+
description: Returns the serialized count and list of query results
|
|
141
|
+
content:
|
|
142
|
+
'application/json':
|
|
143
|
+
schema:
|
|
144
|
+
required:
|
|
145
|
+
- val
|
|
146
|
+
allOf:
|
|
147
|
+
- $ref: '#/components/schemas/SerializedValue'
|
|
148
|
+
example:
|
|
149
|
+
val: { count: 1, list: [{ path: 'books/l27oxggz000009ml9ri26y2d', val: { title: 'AceBase is cool', author: 'Database guru', rating: 5.0, reviews: { 'cl27ozp2g000009lbfopcbkd2': { author: 'DB admin', text: 'The title says it all!' } } }}] }
|
|
150
|
+
map: { 'stats/created': 'date', 'stats/modified': 'date' }
|
|
151
|
+
403:
|
|
152
|
+
description: Returns a "403 Forbidden" if the signed in user is not allowed to read from the target path
|
|
153
|
+
content:
|
|
154
|
+
'application/json':
|
|
155
|
+
schema:
|
|
156
|
+
$ref: '#/components/schemas/Error'
|
|
157
|
+
500:
|
|
158
|
+
description: An unexpected error occurred
|
|
159
|
+
content:
|
|
160
|
+
'application/json':
|
|
161
|
+
schema:
|
|
162
|
+
$ref: '#/components/schemas/UnexpectedError'
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
166
|
|