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.
Files changed (57) hide show
  1. package/.eslintrc.json +49 -49
  2. package/.github/workflows/publish.yml +125 -0
  3. package/Dockerfile +26 -26
  4. package/LICENSE +21 -21
  5. package/bin/acebase-server.js +8 -8
  6. package/create-package-files.sh +25 -0
  7. package/dist/cjs/routes/data-exists.js +2 -2
  8. package/dist/cjs/routes/data-export.js +2 -2
  9. package/dist/cjs/routes/data-get.js +2 -2
  10. package/dist/cjs/routes/data-reflect.js +2 -2
  11. package/dist/cjs/routes/docs.js +1 -1
  12. package/dist/cjs/routes/meta-info.js +1 -1
  13. package/dist/esm/routes/data-exists.js +1 -2
  14. package/dist/esm/routes/data-export.js +1 -2
  15. package/dist/esm/routes/data-get.js +1 -1
  16. package/dist/esm/routes/data-reflect.js +1 -2
  17. package/dist/esm/routes/docs.js +1 -1
  18. package/dist/esm/routes/meta-info.js +1 -1
  19. package/package.json +6 -7
  20. package/release_notes.md +2 -0
  21. package/src/routes/auth-change-password.yaml +73 -73
  22. package/src/routes/auth-delete.yaml +77 -77
  23. package/src/routes/auth-forgot-password.yaml +49 -49
  24. package/src/routes/auth-reset-password.yaml +53 -53
  25. package/src/routes/auth-signin.yaml +129 -129
  26. package/src/routes/auth-signout.yaml +46 -46
  27. package/src/routes/auth-signup.yaml +135 -135
  28. package/src/routes/auth-state.yaml +28 -28
  29. package/src/routes/auth-update.yaml +151 -151
  30. package/src/routes/auth-verify-email.yaml +52 -52
  31. package/src/routes/data-exists.yaml +44 -44
  32. package/src/routes/data-export.yaml +63 -63
  33. package/src/routes/data-import.yaml +74 -74
  34. package/src/routes/data-index-create.yaml +105 -105
  35. package/src/routes/data-index-delete.yaml +51 -51
  36. package/src/routes/data-index-list.yaml +84 -84
  37. package/src/routes/data-query.yaml +165 -165
  38. package/src/routes/data-reflect.yaml +124 -124
  39. package/src/routes/data-schema-get.yaml +53 -53
  40. package/src/routes/data-schema-set.yaml +64 -64
  41. package/src/routes/data-schema-test.yaml +66 -66
  42. package/src/routes/data-schemas-list.yaml +41 -41
  43. package/src/routes/data-set.yaml +77 -77
  44. package/src/routes/data-sync-changes.yaml +66 -66
  45. package/src/routes/data-sync-mutations.yaml +66 -66
  46. package/src/routes/data-transaction-finish.yaml +82 -82
  47. package/src/routes/data-transaction-start.yaml +58 -58
  48. package/src/routes/data-update.yaml +77 -77
  49. package/src/routes/meta-info.yaml +40 -40
  50. package/src/routes/meta-ping.yaml +22 -22
  51. package/src/routes/meta-stats.yaml +40 -40
  52. package/src/routes/oauth2-init.yaml +62 -62
  53. package/src/routes/oauth2-refresh.yaml +64 -64
  54. package/src/routes/oauth2-signin.yaml +65 -65
  55. package/webmanager/acebase-client-browser.min.js +12 -12
  56. package/webmanager/index.html +271 -271
  57. package/webmanager/index.js +437 -437
@@ -1,64 +1,64 @@
1
- /export/{dbname}/{path}:
2
- get:
3
- tags:
4
- - data
5
- summary: Export (stream) the value of a path
6
- description: Exports the value of a path in the database by streaming its content in a serialized format
7
- parameters:
8
- - name: dbname
9
- in: path
10
- description: name of the database
11
- required: true
12
- schema:
13
- type: string
14
- example: mydb
15
- - name: path
16
- in: path
17
- description: database path
18
- required: true
19
- schema:
20
- type: string
21
- example: collection
22
- - name: format
23
- in: query
24
- description: desired output format. Only `json` is currently supported
25
- schema:
26
- type: string
27
- enum:
28
- - json
29
- example: json
30
- - name: type_safe
31
- in: query
32
- description: Whether to add type information for data that has no native JSON representation (such as dates, binary data etc)
33
- schema:
34
- type: string
35
- enum:
36
- - 0
37
- - 1
38
- example: 1
39
- responses:
40
- 200:
41
- description: Streams the data of requested path in the requested format. In the browser, this will trigger a file download.
42
- headers:
43
- 'Content-Disposition':
44
- description: Tells the browser to download the data as a file
45
- schema:
46
- type: string
47
- example: attachment; filename=[target_key].json
48
- content:
49
- 'text/plain':
50
- schema:
51
- type: object
52
- example: {"l27mgh8r000009mhh84jdp9c":{"name":"My todo list","stats":{"size":216,"created":{".type":"date",".val":"2022-04-07T15:11:42.000Z"},"modified":{".type":"date",".val":"2022-03-08T12:24:05.000Z"}}},"l27mhwz2000109mh11yi7rbo":{"name":"Another child"},"l27mjf9k000209mhafylc3eo":{"name":"And another.."}}
53
- 403:
54
- description: Returns a "403 Forbidden" if the signed in user is not allowed to read from the target path
55
- content:
56
- 'application/json':
57
- schema:
58
- $ref: '#/components/schemas/Error'
59
- 500:
60
- description: An unexpected error occurred
61
- content:
62
- 'application/json':
63
- schema:
1
+ /export/{dbname}/{path}:
2
+ get:
3
+ tags:
4
+ - data
5
+ summary: Export (stream) the value of a path
6
+ description: Exports the value of a path in the database by streaming its content in a serialized format
7
+ parameters:
8
+ - name: dbname
9
+ in: path
10
+ description: name of the database
11
+ required: true
12
+ schema:
13
+ type: string
14
+ example: mydb
15
+ - name: path
16
+ in: path
17
+ description: database path
18
+ required: true
19
+ schema:
20
+ type: string
21
+ example: collection
22
+ - name: format
23
+ in: query
24
+ description: desired output format. Only `json` is currently supported
25
+ schema:
26
+ type: string
27
+ enum:
28
+ - json
29
+ example: json
30
+ - name: type_safe
31
+ in: query
32
+ description: Whether to add type information for data that has no native JSON representation (such as dates, binary data etc)
33
+ schema:
34
+ type: string
35
+ enum:
36
+ - 0
37
+ - 1
38
+ example: 1
39
+ responses:
40
+ 200:
41
+ description: Streams the data of requested path in the requested format. In the browser, this will trigger a file download.
42
+ headers:
43
+ 'Content-Disposition':
44
+ description: Tells the browser to download the data as a file
45
+ schema:
46
+ type: string
47
+ example: attachment; filename=[target_key].json
48
+ content:
49
+ 'text/plain':
50
+ schema:
51
+ type: object
52
+ example: {"l27mgh8r000009mhh84jdp9c":{"name":"My todo list","stats":{"size":216,"created":{".type":"date",".val":"2022-04-07T15:11:42.000Z"},"modified":{".type":"date",".val":"2022-03-08T12:24:05.000Z"}}},"l27mhwz2000109mh11yi7rbo":{"name":"Another child"},"l27mjf9k000209mhafylc3eo":{"name":"And another.."}}
53
+ 403:
54
+ description: Returns a "403 Forbidden" if the signed in user is not allowed to read from the target path
55
+ content:
56
+ 'application/json':
57
+ schema:
58
+ $ref: '#/components/schemas/Error'
59
+ 500:
60
+ description: An unexpected error occurred
61
+ content:
62
+ 'application/json':
63
+ schema:
64
64
  $ref: '#/components/schemas/UnexpectedError'
@@ -1,75 +1,75 @@
1
- /import/{dbname}/{path}:
2
- post:
3
- tags:
4
- - data
5
- summary: Import (stream) a new value for a path
6
- description: Imports (streams) the sent data for a path into the database (beta functionality, currently not very fast)
7
- parameters:
8
- - name: dbname
9
- in: path
10
- description: name of the database
11
- required: true
12
- schema:
13
- type: string
14
- example: mydb
15
- - name: path
16
- in: path
17
- description: database path
18
- required: true
19
- schema:
20
- type: string
21
- example: collection
22
- - name: format
23
- in: query
24
- description: used data format. Only `json` is currently supported
25
- schema:
26
- type: string
27
- enum:
28
- - json
29
- example: json
30
- - name: suppress_events
31
- in: query
32
- description: Whether to suppress firing data change events during the import
33
- schema:
34
- type: string
35
- enum:
36
- - 0
37
- - 1
38
- example: 0
39
- requestBody:
40
- description: value to store in the database, can use typesafe values as exported by the _export_ endpoint
41
- content:
42
- 'text/plain':
43
- schema:
44
- type: object
45
- example: {"l27mgh8r000009mhh84jdp9c":{"name":"My todo list","stats":{"size":216,"created":{".type":"date",".val":"2022-04-07T15:11:42.000Z"},"modified":{".type":"date",".val":"2022-03-08T12:24:05.000Z"}}},"l27mhwz2000109mh11yi7rbo":{"name":"Another child"},"l27mjf9k000209mhafylc3eo":{"name":"And another.."}}
46
- responses:
47
- 200:
48
- description: Returns "200 OK" when the database operation succeeded
49
- content:
50
- 'application/json':
51
- schema:
52
- type: object
53
- properties:
54
- success:
55
- type: boolean
56
- example: true
57
- 403:
58
- description: Returns "403 Forbidden" if the signed in user is not allowed to write to the target path
59
- content:
60
- 'application/json':
61
- schema:
62
- $ref: '#/components/schemas/Error'
63
- 500:
64
- description: An error occurred
65
- content:
66
- 'application/json':
67
- schema:
68
- type: object
69
- properties:
70
- success:
71
- type: boolean
72
- example: false
73
- reason:
74
- type: string
1
+ /import/{dbname}/{path}:
2
+ post:
3
+ tags:
4
+ - data
5
+ summary: Import (stream) a new value for a path
6
+ description: Imports (streams) the sent data for a path into the database (beta functionality, currently not very fast)
7
+ parameters:
8
+ - name: dbname
9
+ in: path
10
+ description: name of the database
11
+ required: true
12
+ schema:
13
+ type: string
14
+ example: mydb
15
+ - name: path
16
+ in: path
17
+ description: database path
18
+ required: true
19
+ schema:
20
+ type: string
21
+ example: collection
22
+ - name: format
23
+ in: query
24
+ description: used data format. Only `json` is currently supported
25
+ schema:
26
+ type: string
27
+ enum:
28
+ - json
29
+ example: json
30
+ - name: suppress_events
31
+ in: query
32
+ description: Whether to suppress firing data change events during the import
33
+ schema:
34
+ type: string
35
+ enum:
36
+ - 0
37
+ - 1
38
+ example: 0
39
+ requestBody:
40
+ description: value to store in the database, can use typesafe values as exported by the _export_ endpoint
41
+ content:
42
+ 'text/plain':
43
+ schema:
44
+ type: object
45
+ example: {"l27mgh8r000009mhh84jdp9c":{"name":"My todo list","stats":{"size":216,"created":{".type":"date",".val":"2022-04-07T15:11:42.000Z"},"modified":{".type":"date",".val":"2022-03-08T12:24:05.000Z"}}},"l27mhwz2000109mh11yi7rbo":{"name":"Another child"},"l27mjf9k000209mhafylc3eo":{"name":"And another.."}}
46
+ responses:
47
+ 200:
48
+ description: Returns "200 OK" when the database operation succeeded
49
+ content:
50
+ 'application/json':
51
+ schema:
52
+ type: object
53
+ properties:
54
+ success:
55
+ type: boolean
56
+ example: true
57
+ 403:
58
+ description: Returns "403 Forbidden" if the signed in user is not allowed to write to the target path
59
+ content:
60
+ 'application/json':
61
+ schema:
62
+ $ref: '#/components/schemas/Error'
63
+ 500:
64
+ description: An error occurred
65
+ content:
66
+ 'application/json':
67
+ schema:
68
+ type: object
69
+ properties:
70
+ success:
71
+ type: boolean
72
+ example: false
73
+ reason:
74
+ type: string
75
75
  example: Something went wrong
@@ -1,105 +1,105 @@
1
- /index/{dbname}/create:
2
- post:
3
- tags:
4
- - data
5
- - indexes
6
- summary: Creates an index
7
- description: Creates a new index in the database if it does not exist already. (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
- requestBody:
17
- description: request
18
- content:
19
- 'application/json':
20
- schema:
21
- type: object
22
- properties:
23
- path:
24
- type: string
25
- description: path of the collection to index, can contain wildcards and variables such as * and $name
26
- example: books
27
- examples:
28
- simple:
29
- summary: Simple path
30
- value: books
31
- wildcard:
32
- summary: path with a wildcard to index scattered data
33
- value: users/*/reservations
34
- variable:
35
- summary: path with a variable (same as *) to index scattered data
36
- value: hotels/$id/reviews
37
- required: true
38
- key:
39
- type: string
40
- description: key (property) to index for each item in the collection, can contain a nested target path
41
- example: title
42
- examples:
43
- - title
44
- - text
45
- - content/title
46
- - content/stats/size
47
- required: true
48
- options:
49
- type: object
50
- description: Additional options
51
- properties:
52
- 'type':
53
- type: string
54
- enum:
55
- - normal
56
- - array
57
- - fulltext
58
- - geo
59
- description: type of index to create
60
- include:
61
- type: array
62
- items:
63
- type: string
64
- example:
65
- - year
66
- - rating
67
- description: Additional keys to include in the index. Speeds up sorting on these columns when the index is used (and dramatically increases query speed when .take(n) is used in addition)
68
- rebuild:
69
- type: boolean
70
- example: false
71
- description: Whether to rebuild the index if it exists already
72
- textLocale:
73
- type: string
74
- example: en-us
75
- description: If the indexed values are strings, which default locale to use
76
- config:
77
- type: object
78
- description: additional configuration for special indexes, see documentation
79
- properties:
80
- see_docs:
81
- description: See documentation for config options. Note that you can't create fulltext indexes with custom callack functions through the API; those need to be created in your code at the server.
82
- example: (See documentation for config options, many require server-side execution)
83
- responses:
84
- 200:
85
- description: returned when the index was created successfully
86
- content:
87
- 'application/json':
88
- schema:
89
- type: object
90
- properties:
91
- success:
92
- type: boolean
93
- example: true
94
- 403:
95
- description: Returns "403 Forbidden" if the signed in user is not admin
96
- content:
97
- 'application/json':
98
- schema:
99
- $ref: '#/components/schemas/Error'
100
- 500:
101
- description: An unexpected error occurred
102
- content:
103
- 'application/json':
104
- schema:
105
- $ref: '#/components/schemas/UnexpectedError'
1
+ /index/{dbname}/create:
2
+ post:
3
+ tags:
4
+ - data
5
+ - indexes
6
+ summary: Creates an index
7
+ description: Creates a new index in the database if it does not exist already. (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
+ requestBody:
17
+ description: request
18
+ content:
19
+ 'application/json':
20
+ schema:
21
+ type: object
22
+ properties:
23
+ path:
24
+ type: string
25
+ description: path of the collection to index, can contain wildcards and variables such as * and $name
26
+ example: books
27
+ examples:
28
+ simple:
29
+ summary: Simple path
30
+ value: books
31
+ wildcard:
32
+ summary: path with a wildcard to index scattered data
33
+ value: users/*/reservations
34
+ variable:
35
+ summary: path with a variable (same as *) to index scattered data
36
+ value: hotels/$id/reviews
37
+ required: true
38
+ key:
39
+ type: string
40
+ description: key (property) to index for each item in the collection, can contain a nested target path
41
+ example: title
42
+ examples:
43
+ - title
44
+ - text
45
+ - content/title
46
+ - content/stats/size
47
+ required: true
48
+ options:
49
+ type: object
50
+ description: Additional options
51
+ properties:
52
+ 'type':
53
+ type: string
54
+ enum:
55
+ - normal
56
+ - array
57
+ - fulltext
58
+ - geo
59
+ description: type of index to create
60
+ include:
61
+ type: array
62
+ items:
63
+ type: string
64
+ example:
65
+ - year
66
+ - rating
67
+ description: Additional keys to include in the index. Speeds up sorting on these columns when the index is used (and dramatically increases query speed when .take(n) is used in addition)
68
+ rebuild:
69
+ type: boolean
70
+ example: false
71
+ description: Whether to rebuild the index if it exists already
72
+ textLocale:
73
+ type: string
74
+ example: en-us
75
+ description: If the indexed values are strings, which default locale to use
76
+ config:
77
+ type: object
78
+ description: additional configuration for special indexes, see documentation
79
+ properties:
80
+ see_docs:
81
+ description: See documentation for config options. Note that you can't create fulltext indexes with custom callack functions through the API; those need to be created in your code at the server.
82
+ example: (See documentation for config options, many require server-side execution)
83
+ responses:
84
+ 200:
85
+ description: returned when the index was created successfully
86
+ content:
87
+ 'application/json':
88
+ schema:
89
+ type: object
90
+ properties:
91
+ success:
92
+ type: boolean
93
+ example: true
94
+ 403:
95
+ description: Returns "403 Forbidden" if the signed in user is not admin
96
+ content:
97
+ 'application/json':
98
+ schema:
99
+ $ref: '#/components/schemas/Error'
100
+ 500:
101
+ description: An unexpected error occurred
102
+ content:
103
+ 'application/json':
104
+ schema:
105
+ $ref: '#/components/schemas/UnexpectedError'
@@ -1,51 +1,51 @@
1
- /index/{dbname}/delete:
2
- post:
3
- tags:
4
- - data
5
- - indexes
6
- summary: Removes an index
7
- description: Removes an index from 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
- requestBody:
17
- description: request
18
- content:
19
- 'application/json':
20
- schema:
21
- type: object
22
- properties:
23
- fileName:
24
- type: string
25
- description: The name of the target index file to delete
26
- required:
27
- - action
28
- - filePath
29
- responses:
30
- 200:
31
- description: Returned when the index is deleted successfully
32
- content:
33
- 'application/json':
34
- schema:
35
- type: object
36
- properties:
37
- success:
38
- type: boolean
39
- example: true
40
- 403:
41
- description: Returns "403 Forbidden" if the signed in user is not admin
42
- content:
43
- 'application/json':
44
- schema:
45
- $ref: '#/components/schemas/Error'
46
- 500:
47
- description: An unexpected error occurred
48
- content:
49
- 'application/json':
50
- schema:
51
- $ref: '#/components/schemas/UnexpectedError'
1
+ /index/{dbname}/delete:
2
+ post:
3
+ tags:
4
+ - data
5
+ - indexes
6
+ summary: Removes an index
7
+ description: Removes an index from 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
+ requestBody:
17
+ description: request
18
+ content:
19
+ 'application/json':
20
+ schema:
21
+ type: object
22
+ properties:
23
+ fileName:
24
+ type: string
25
+ description: The name of the target index file to delete
26
+ required:
27
+ - action
28
+ - filePath
29
+ responses:
30
+ 200:
31
+ description: Returned when the index is deleted successfully
32
+ content:
33
+ 'application/json':
34
+ schema:
35
+ type: object
36
+ properties:
37
+ success:
38
+ type: boolean
39
+ example: true
40
+ 403:
41
+ description: Returns "403 Forbidden" if the signed in user is not admin
42
+ content:
43
+ 'application/json':
44
+ schema:
45
+ $ref: '#/components/schemas/Error'
46
+ 500:
47
+ description: An unexpected error occurred
48
+ content:
49
+ 'application/json':
50
+ schema:
51
+ $ref: '#/components/schemas/UnexpectedError'