@lowdefy/docs 4.0.0-alpha.6 → 4.0.0-alpha.7
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/CHANGELOG.md +75 -104
- package/actions/JsAction.yaml +6 -6
- package/blocks/container/Affix.yaml +1 -1
- package/blocks/container/Alert.yaml +2 -2
- package/blocks/container/Badge.yaml +1 -1
- package/blocks/container/Box.yaml +1 -1
- package/blocks/container/Card.yaml +1 -1
- package/blocks/container/Collapse.yaml +1 -1
- package/blocks/container/Comment.yaml +4 -4
- package/blocks/container/ConfirmModal.yaml +1 -1
- package/blocks/container/Descriptions.yaml +2 -2
- package/blocks/container/Drawer.yaml +1 -1
- package/blocks/container/Label.yaml +1 -2
- package/blocks/container/Modal.yaml +1 -1
- package/blocks/container/PageHCF.yaml +1 -1
- package/blocks/container/PageHCSF.yaml +1 -1
- package/blocks/container/PageHSCF.yaml +1 -1
- package/blocks/container/PageHeaderMenu.yaml +3 -3
- package/blocks/container/PageSHCF.yaml +1 -1
- package/blocks/container/PageSiderMenu.yaml +3 -3
- package/blocks/container/Result.yaml +2 -2
- package/blocks/container/Span.yaml +1 -1
- package/blocks/container/Spin.yaml +2 -2
- package/blocks/container/Tabs.yaml +2 -2
- package/blocks/container/Tooltip.yaml +1 -1
- package/blocks/display/Anchor.yaml +1 -2
- package/blocks/display/Avatar.yaml +1 -2
- package/blocks/display/Breadcrumb.yaml +2 -3
- package/blocks/display/Button.yaml +7 -7
- package/blocks/display/DangerousHtml.yaml +1 -1
- package/blocks/display/DangerousMarkdown.yaml +1 -1
- package/blocks/display/Divider.yaml +1 -3
- package/blocks/display/EChart.yaml +1 -1
- package/blocks/display/Html.yaml +2 -2
- package/blocks/display/Icon.yaml +1 -3
- package/blocks/display/Img.yaml +1 -1
- package/blocks/display/Markdown.yaml +5 -6
- package/blocks/display/MarkdownWithCode.yaml +3 -5
- package/blocks/display/Menu.yaml +3 -3
- package/blocks/display/Message.yaml +1 -1
- package/blocks/display/MobileMenu.yaml +3 -4
- package/blocks/display/Notification.yaml +2 -2
- package/blocks/display/Paragraph.yaml +2 -4
- package/blocks/display/Progress.yaml +8 -9
- package/blocks/display/Skeleton.yaml +1 -2
- package/blocks/display/Statistic.yaml +3 -5
- package/blocks/display/Title.yaml +1 -1
- package/blocks/input/AutoComplete.yaml +1 -2
- package/blocks/input/ButtonSelector.yaml +1 -2
- package/blocks/input/CheckboxSelector.yaml +1 -2
- package/blocks/input/CheckboxSwitch.yaml +1 -1
- package/blocks/input/ChromeColorSelector.yaml +1 -2
- package/blocks/input/CircleColorSelector.yaml +1 -2
- package/blocks/input/ColorSelector.yaml +1 -2
- package/blocks/input/CompactColorSelector.yaml +1 -2
- package/blocks/input/DateRangeSelector.yaml +1 -2
- package/blocks/input/DateSelector.yaml +1 -2
- package/blocks/input/DateTimeSelector.yaml +1 -2
- package/blocks/input/GithubColorSelector.yaml +1 -2
- package/blocks/input/MonthSelector.yaml +1 -2
- package/blocks/input/MultipleSelector.yaml +1 -1
- package/blocks/input/NumberInput.yaml +1 -1
- package/blocks/input/Pagination.yaml +3 -3
- package/blocks/input/ParagraphInput.yaml +1 -1
- package/blocks/input/PasswordInput.yaml +1 -1
- package/blocks/input/RadioSelector.yaml +1 -1
- package/blocks/input/RatingSlider.yaml +1 -1
- package/blocks/input/S3UploadButton.yaml +1 -1
- package/blocks/input/Selector.yaml +1 -1
- package/blocks/input/SliderColorSelector.yaml +1 -1
- package/blocks/input/SwatchesColorSelector.yaml +1 -1
- package/blocks/input/Switch.yaml +1 -1
- package/blocks/input/TextArea.yaml +1 -2
- package/blocks/input/TextInput.yaml +7 -7
- package/blocks/input/TitleInput.yaml +1 -1
- package/blocks/input/TwitterColorSelector.yaml +1 -1
- package/blocks/input/WeekSelector.yaml +1 -1
- package/blocks/list/ControlledList.yaml +18 -18
- package/blocks/list/List.yaml +16 -17
- package/blocks/list/TimelineList.yaml +23 -22
- package/concepts/cli.yaml +7 -7
- package/concepts/custom-blocks.yaml +16 -2
- package/concepts/custom-code.yaml +5 -4
- package/concepts/lowdefy-schema.yaml +5 -4
- package/connections/AxiosHttp.yaml +1 -1
- package/connections/Knex.yaml +7 -7
- package/connections/MongoDB.yaml +176 -47
- package/deployment/aws-lambda.yaml +3 -3
- package/deployment/docker.yaml +4 -4
- package/deployment/node-server.yaml +1 -1
- package/howto/generate-csv.yaml.njk +7 -6
- package/howto/generate-pdf.yaml.njk +21 -21
- package/howto/generateCsv/lowdefy.yaml +32 -31
- package/howto/generatePdf/lowdefy.yaml +10 -9
- package/introduction.yaml +1 -1
- package/lowdefy.yaml +1 -1
- package/menus.yaml +26 -29
- package/operators/_actions.yaml +2 -2
- package/operators/_get.yaml +6 -6
- package/operators/_js.yaml +2 -2
- package/operators/_ref.yaml +40 -6
- package/operators/_yaml.yaml +39 -15
- package/package.json +6 -7
- package/pages.yaml +8 -8
- package/public/sitemap.xml +204 -204
- package/templates/blocks/defaultValueTransformer.js +4 -2
- package/templates/blocks/exampleTransformer.js +1 -1
- package/templates/blocks/propertiesFormTransformer.js +3 -3
- package/templates/blocks/propertiesGetterTransformer.js +2 -2
- package/templates/blocks/schemaTransformer.js +1 -1
- package/templates/blocks/template.yaml.njk +3 -4
- package/templates/blog.yaml.njk +5 -5
- package/templates/cli_command.yaml.njk +2 -2
- package/templates/footer.yaml.njk +18 -18
- package/templates/general.yaml.njk +4 -4
- package/templates/generateSitemap.js +1 -2
- package/templates/header.yaml +2 -2
- package/templates/navigation_buttons.yaml +2 -2
- package/templates/operatorsMethodTransformer.js +2 -2
- package/templates/test/array.test.js +146 -166
- package/templates/test/boolean.test.js +13 -17
- package/templates/test/button.test.js +21 -25
- package/templates/test/color.test.js +21 -23
- package/templates/test/enum.test.js +15 -19
- package/templates/test/icon.test.js +17 -21
- package/templates/test/integer.test.js +13 -17
- package/templates/test/manual.test.js +66 -74
- package/templates/test/number.test.js +13 -17
- package/templates/test/object.test.js +90 -98
- package/templates/test/oneOf.test.js +108 -120
- package/templates/test/string.test.js +13 -17
- package/templates/test/yaml.test.js +96 -112
- package/tutorial/tutorial-actions-operators-config.yaml +4 -4
- package/tutorial/tutorial-actions-operators.yaml +6 -6
- package/tutorial/tutorial-add-blocks-config.yaml +4 -4
- package/tutorial/tutorial-add-blocks.yaml +4 -4
- package/tutorial/tutorial-create-page-config.yaml +2 -2
- package/tutorial/tutorial-create-page.yaml +4 -4
- package/tutorial/tutorial-deploy.yaml +2 -2
- package/tutorial/tutorial-requests-config.yaml +4 -4
- package/tutorial/tutorial-requests.yaml +2 -2
- package/tutorial/tutorial-start.yaml +6 -6
- package/users/login-and-logout.yaml +2 -2
- package/users/protected-pages.yaml +2 -2
- package/users/roles.yaml +2 -2
- package/users/users-introduction.yaml +2 -2
|
@@ -42,6 +42,7 @@ _ref:
|
|
|
42
42
|
|
|
43
43
|
The config object has the following properties:
|
|
44
44
|
|
|
45
|
+
- `basePath: string`: Set the base path to serve the Lowdefy application from. This will route all pages under `https://example.com/<base-path>/<page-id>` instead of the default `https://example.com/<page-id>`. The basePath value must start with "/".
|
|
45
46
|
- `homePageId: string`: The pageId of the page that should be loaded when a user loads the app without a pageId in the url route. This is the page that is loaded when you navigate to `yourdomain.com`.
|
|
46
47
|
- `experimental_initPageId: string`: The pageId of the page that should be loaded when app is initialized. User is then redirected to requeted page. You can use onInit/onInitAsync/onEnter/onEnterAsync events to fetch and prepare global variables for other parts of the app.
|
|
47
48
|
|
|
@@ -105,11 +106,11 @@ _ref:
|
|
|
105
106
|
pageId: page1
|
|
106
107
|
properties:
|
|
107
108
|
title: Page 1
|
|
108
|
-
icon:
|
|
109
|
+
icon: AiOutlinedFile
|
|
109
110
|
- id: top-group
|
|
110
111
|
properties:
|
|
111
112
|
title: Group
|
|
112
|
-
icon:
|
|
113
|
+
icon: AiOutlinedGroup
|
|
113
114
|
links:
|
|
114
115
|
- id: page2
|
|
115
116
|
type: MenuLink
|
|
@@ -136,13 +137,13 @@ _ref:
|
|
|
136
137
|
pageId: page1
|
|
137
138
|
properties:
|
|
138
139
|
title: Page 1
|
|
139
|
-
icon:
|
|
140
|
+
icon: AiOutlinedFile
|
|
140
141
|
- id: page3
|
|
141
142
|
type: MenuLink
|
|
142
143
|
pageId: page3
|
|
143
144
|
properties:
|
|
144
145
|
title: Page 3
|
|
145
|
-
icon:
|
|
146
|
+
icon: AiOutlinedControl
|
|
146
147
|
```
|
|
147
148
|
|
|
148
149
|
# Pages
|
package/connections/Knex.yaml
CHANGED
|
@@ -33,7 +33,7 @@ _ref:
|
|
|
33
33
|
type: Anchor
|
|
34
34
|
properties:
|
|
35
35
|
title: Amazon Redshift
|
|
36
|
-
icon:
|
|
36
|
+
icon: AiOutlinedLink
|
|
37
37
|
events:
|
|
38
38
|
onClick:
|
|
39
39
|
- id: link,
|
|
@@ -44,7 +44,7 @@ _ref:
|
|
|
44
44
|
type: Anchor
|
|
45
45
|
properties:
|
|
46
46
|
title: MariaDB
|
|
47
|
-
icon:
|
|
47
|
+
icon: AiOutlinedLink
|
|
48
48
|
events:
|
|
49
49
|
onClick:
|
|
50
50
|
- id: link,
|
|
@@ -55,7 +55,7 @@ _ref:
|
|
|
55
55
|
type: Anchor
|
|
56
56
|
properties:
|
|
57
57
|
title: MS SQL Server
|
|
58
|
-
icon:
|
|
58
|
+
icon: AiOutlinedLink
|
|
59
59
|
events:
|
|
60
60
|
onClick:
|
|
61
61
|
- id: link,
|
|
@@ -66,7 +66,7 @@ _ref:
|
|
|
66
66
|
type: Anchor
|
|
67
67
|
properties:
|
|
68
68
|
title: MySQL
|
|
69
|
-
icon:
|
|
69
|
+
icon: AiOutlinedLink
|
|
70
70
|
events:
|
|
71
71
|
onClick:
|
|
72
72
|
- id: link,
|
|
@@ -77,7 +77,7 @@ _ref:
|
|
|
77
77
|
type: Anchor
|
|
78
78
|
properties:
|
|
79
79
|
title: Oracle Database
|
|
80
|
-
icon:
|
|
80
|
+
icon: AiOutlinedLink
|
|
81
81
|
events:
|
|
82
82
|
onClick:
|
|
83
83
|
- id: link,
|
|
@@ -88,7 +88,7 @@ _ref:
|
|
|
88
88
|
type: Anchor
|
|
89
89
|
properties:
|
|
90
90
|
title: PostgreSQL
|
|
91
|
-
icon:
|
|
91
|
+
icon: AiOutlinedLink
|
|
92
92
|
events:
|
|
93
93
|
onClick:
|
|
94
94
|
- id: link,
|
|
@@ -99,7 +99,7 @@ _ref:
|
|
|
99
99
|
type: Anchor
|
|
100
100
|
properties:
|
|
101
101
|
title: SQLite
|
|
102
|
-
icon:
|
|
102
|
+
icon: AiOutlinedLink
|
|
103
103
|
events:
|
|
104
104
|
onClick:
|
|
105
105
|
- id: link,
|
package/connections/MongoDB.yaml
CHANGED
|
@@ -106,14 +106,30 @@ _ref:
|
|
|
106
106
|
|
|
107
107
|
#### Properties
|
|
108
108
|
- `pipeline: object[]`: __Required__ - Array containing all the aggregation framework commands for the execution.
|
|
109
|
-
- `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/
|
|
110
|
-
- `readPreference: string | object`: The read preference.
|
|
109
|
+
- `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#aggregate) for more information. Supported settings are:
|
|
111
110
|
- `allowDiskUse: boolean`: Default: `false` - Allow disk use on the MongoDB server to store temporary results for the aggregation.
|
|
112
|
-
- `
|
|
111
|
+
- `authdb: string`: Specifies the authentication information to be used.
|
|
112
|
+
- `batchSize: number`: The number of documents to return per batch.
|
|
113
|
+
- `bsonRegExp: boolean`: Return the BSON regular expressions as BSONRegExp instances.
|
|
113
114
|
- `bypassDocumentValidation: boolean`: Default: `false` - Allow driver to bypass schema validation in MongoDB 3.2 or higher.
|
|
115
|
+
- `checkKeys: boolean`: The serializer will check if keys are valid.
|
|
114
116
|
- `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
|
|
115
117
|
- `comment: string`: Add a [comment](https://docs.mongodb.com/manual/reference/operator/query/comment/index.html) to the aggregation. These comments are visible in the MongoDB profile log, making them easier to interpret.
|
|
118
|
+
- `dbName: string`: The database name.
|
|
119
|
+
- `explain: boolean`: Specifies to return the information on the processing of the pipeline.
|
|
120
|
+
- `fullResponse: boolean`: Return the full server response for the command.
|
|
116
121
|
- `hint: string | object`: Add an index selection hint to an aggregation command.
|
|
122
|
+
- `ignoreUndefined: boolean`: Default: `true` - Serialize will not emit undefined fields.
|
|
123
|
+
- `let: object`: Specifies an object with a list of variables. This allows you to improve command readability by separating the variables from the query text.
|
|
124
|
+
- `maxAwaitTimeMS: number`: The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.
|
|
125
|
+
- `maxTimeMS: number`: Specifies a cumulative time limit in milliseconds for processing operations on the cursor.
|
|
126
|
+
- `noResponse: boolean`: Admin command option.
|
|
127
|
+
- `readConcern: object`: Specifies the level of isolation for read operations.
|
|
128
|
+
- `readPreference: string | object`: The read preference.
|
|
129
|
+
- `retryWrites: boolean`: Should retry failed writes.
|
|
130
|
+
- `serializeFunctions: boolean`: Default: `false` - Serialize the javascript functions.
|
|
131
|
+
- `willRetryWrites: boolean`: Option whether to retry writes.
|
|
132
|
+
- `writeConcern: object`: An object that expresses the write concern to use with the $out or $merge stage.
|
|
117
133
|
|
|
118
134
|
#### Examples
|
|
119
135
|
|
|
@@ -143,14 +159,27 @@ _ref:
|
|
|
143
159
|
|
|
144
160
|
#### Properties
|
|
145
161
|
- `filter: object`: __Required__ - The filter used to select the document to update.
|
|
146
|
-
- `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/
|
|
162
|
+
- `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#deletemany) for more information. Supported settings are:
|
|
163
|
+
- `authdb: string`: Specifies the authentication information to be used.
|
|
164
|
+
- `bsonRegExp: boolean`: Return the BSON regular expressions as BSONRegExp instances.
|
|
147
165
|
- `checkKeys: boolean`: Default: `false` - If true, will throw if bson documents start with $ or include a . in any key value.
|
|
148
166
|
- `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
|
|
149
|
-
- `
|
|
167
|
+
- `comment: string`: A user-provided comment to attach to this command.
|
|
168
|
+
- `dbName: string`: The database name.
|
|
169
|
+
- `explain: boolean`: Specifies the verbosity mode for the explain output.
|
|
170
|
+
- `fullResponse: boolean`: Return the full server response for the command.
|
|
171
|
+
- `hint: string | object`: An optional hint for query optimization.
|
|
150
172
|
- `ignoreUndefined: boolean`: Default: `false` - Specify if the BSON serializer should ignore undefined fields.
|
|
151
|
-
- `
|
|
152
|
-
- `
|
|
153
|
-
- `
|
|
173
|
+
- `let: object`: Map of parameter names and values that can be accessed using `$$var` (requires MongoDB 5.0).
|
|
174
|
+
- `maxTimeMS: number`: Specifies a cumulative time limit in milliseconds for processing operations on the cursor.
|
|
175
|
+
- `noResponse: boolean`: Admin command option.
|
|
176
|
+
- `ordered: boolean`: If true, when an insert fails, don't execute the remaining writes. If false, continue with remaining inserts when one fails.
|
|
177
|
+
- `readConcern: object`: Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported).
|
|
178
|
+
- `readPreference: string | object`: The read preference.
|
|
179
|
+
- `retryWrites: boolean`: Should retry failed writes.
|
|
180
|
+
- `serializeFunctions: boolean`: Default: `false` - Serialize the javascript functions.
|
|
181
|
+
- `willRetryWrites: boolean`: Option whether to retry writes.
|
|
182
|
+
- `writeConcern: object`: An object that expresses the write concern.
|
|
154
183
|
|
|
155
184
|
#### Examples
|
|
156
185
|
|
|
@@ -173,14 +202,27 @@ _ref:
|
|
|
173
202
|
|
|
174
203
|
#### Properties
|
|
175
204
|
- `filter: object`: __Required__ - The filter used to select the document to update.
|
|
176
|
-
- `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/
|
|
205
|
+
- `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#deleteone) for more information. Supported settings are:
|
|
206
|
+
- `authdb: string`: Specifies the authentication information to be used.
|
|
207
|
+
- `bsonRegExp: boolean`: Return the BSON regular expressions as BSONRegExp instances.
|
|
177
208
|
- `checkKeys: boolean`: Default: `false` - If true, will throw if bson documents start with $ or include a . in any key value.
|
|
178
209
|
- `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
|
|
179
|
-
- `
|
|
210
|
+
- `comment: string`: A user-provided comment to attach to this command.
|
|
211
|
+
- `dbName: string`: The database name.
|
|
212
|
+
- `explain: boolean`: Specifies the verbosity mode for the explain output.
|
|
213
|
+
- `fullResponse: boolean`: Return the full server response for the command.
|
|
214
|
+
- `hint: string | object`: An optional hint for query optimization.
|
|
180
215
|
- `ignoreUndefined: boolean`: Default: `false` - Specify if the BSON serializer should ignore undefined fields.
|
|
181
|
-
- `
|
|
182
|
-
- `
|
|
183
|
-
- `
|
|
216
|
+
- `let: object`: Map of parameter names and values that can be accessed using `$$var` (requires MongoDB 5.0).
|
|
217
|
+
- `maxTimeMS: number`: Specifies a cumulative time limit in milliseconds for processing operations on the cursor.
|
|
218
|
+
- `noResponse: boolean`: Admin command option.
|
|
219
|
+
- `ordered: boolean`: If true, when an insert fails, don't execute the remaining writes. If false, continue with remaining inserts when one fails.
|
|
220
|
+
- `readConcern: object`: Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported).
|
|
221
|
+
- `readPreference: string | object`: The read preference.
|
|
222
|
+
- `retryWrites: boolean`: Should retry failed writes.
|
|
223
|
+
- `serializeFunctions: boolean`: Default: `false` - Serialize the javascript functions.
|
|
224
|
+
- `willRetryWrites: boolean`: Option whether to retry writes.
|
|
225
|
+
- `writeConcern: object`: An object that expresses the write concern.
|
|
184
226
|
|
|
185
227
|
#### Examples
|
|
186
228
|
|
|
@@ -204,16 +246,43 @@ _ref:
|
|
|
204
246
|
|
|
205
247
|
#### Properties
|
|
206
248
|
- `query: object`: __Required__ - A MongoDB query object.
|
|
207
|
-
- `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/
|
|
249
|
+
- `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#find) for more information. Supported settings are:
|
|
250
|
+
- `allowDiskUse: boolean`: Allows disk use for blocking sort operations exceeding 100MB memory. (MongoDB 3.2 or higher)
|
|
251
|
+
- `allowPartialResults: boolean`: For queries against a sharded collection, allows the command (or subsequent getMore commands) to return partial results, rather than an error, if one or more queried shards are available.
|
|
252
|
+
- `authdb: string`: Specifies the authentication information to be used.
|
|
253
|
+
- `awaitData: boolean`: Specify if the cursor is a tailable-await cursor. Requires `tailable` to be true.
|
|
254
|
+
- `batchSize: number`: Set the batchSize for the getMoreCommand when iterating over the query results.
|
|
255
|
+
- `bsonRegExp: boolean`: Return the BSON regular expressions as BSONRegExp instances.
|
|
256
|
+
- `checkKeys: boolean`: The serializer will check if keys are valid.
|
|
257
|
+
- `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
|
|
258
|
+
- `comment: string | object`: Add a [comment](https://docs.mongodb.com/manual/reference/operator/query/comment/index.html) to the query. These comments are visible in the MongoDB profile log, making them easier to interpret.
|
|
259
|
+
- `dbName: string`: The database name.
|
|
260
|
+
- `explain: boolean`: Specifies the verbosity mode for the explain output.
|
|
261
|
+
- `fullResponse: boolean`: Return the full server response for the command.
|
|
262
|
+
- `hint: string | object`: Tell the query to use specific indexes in the query. Object of indexes to use, `{'_id':1}`.
|
|
263
|
+
- `ignoreUndefined: boolean`: Default: `true` - Serialize will not emit undefined fields.
|
|
264
|
+
- `let: object`: Map of parameter names and values that can be accessed using `$$var` (requires MongoDB 5.0).
|
|
208
265
|
- `limit: number`: Sets the limit of documents returned in the query.
|
|
209
|
-
- `
|
|
266
|
+
- `max: object`: The exclusive upper bound for a specific index.
|
|
267
|
+
- `maxAwaitTimeMS: number`: The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. Requires `tailable` and `awaitData` to be true.
|
|
268
|
+
- `maxTimeMS: number`: Number of milliseconds to wait before aborting the command.
|
|
269
|
+
- `min: object`: The inclusive lower bound for a specific index.
|
|
270
|
+
- `noCursorTimeout: boolean`: The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.
|
|
271
|
+
- `noResponse: boolean`: Admin command option.
|
|
210
272
|
- `projection: object`: The fields to return in the query. Object of fields to either include or exclude (one of, not both), `{'a':1, 'b': 1}` or `{'a': 0, 'b': 0}`.
|
|
211
|
-
- `
|
|
212
|
-
- `hint: object`: Tell the query to use specific indexes in the query. Object of indexes to use, `{'_id':1}`.
|
|
213
|
-
- `comment: string`: Add a [comment](https://docs.mongodb.com/manual/reference/operator/query/comment/index.html) to the query. These comments are visible in the MongoDB profile log, making them easier to interpret.
|
|
273
|
+
- `readConcern: object`: Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported).
|
|
214
274
|
- `readPreference: string | object`: The preferred read preference.
|
|
215
|
-
- `
|
|
216
|
-
- `
|
|
275
|
+
- `retryWrites: boolean`: Should retry failed writes.
|
|
276
|
+
- `returnKey: boolean`: If true, returns only the index keys in the resulting documents.
|
|
277
|
+
- `serializeFunctions: boolean`: Default: `false` - Serialize the javascript functions.
|
|
278
|
+
- `showRecordId: boolean`: Determine whether to return the record identifier for each document. If true, adds a field $recordId to the returned documents.
|
|
279
|
+
- `singleBatch: boolean`: Default: `false` - Determines whether to close the cursor after the first batch.
|
|
280
|
+
- `skip: number`: Set to skip N documents ahead in your query (useful for pagination).
|
|
281
|
+
- `sort: array | object`: Set to sort the documents coming back from the query.
|
|
282
|
+
- `tailable: boolean`: Specify if the cursor is tailable.
|
|
283
|
+
- `timeout: boolean`: Specify if the cursor can timeout.
|
|
284
|
+
- `willRetryWrites: boolean`: Option whether to retry writes.
|
|
285
|
+
- `writeConcern: object`: An object that expresses the write concern.
|
|
217
286
|
|
|
218
287
|
#### Examples
|
|
219
288
|
|
|
@@ -245,16 +314,43 @@ _ref:
|
|
|
245
314
|
|
|
246
315
|
#### Properties
|
|
247
316
|
- `query: object`: __Required__ - A MongoDB query object.
|
|
248
|
-
- `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/
|
|
317
|
+
- `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#findone) for more information. Supported settings are:
|
|
318
|
+
- `allowDiskUse: boolean`: Allows disk use for blocking sort operations exceeding 100MB memory. (MongoDB 3.2 or higher)
|
|
319
|
+
- `allowPartialResults: boolean`: For queries against a sharded collection, allows the command (or subsequent getMore commands) to return partial results, rather than an error, if one or more queried shards are available.
|
|
320
|
+
- `authdb: string`: Specifies the authentication information to be used.
|
|
321
|
+
- `awaitData: boolean`: Specify if the cursor is a tailable-await cursor. Requires `tailable` to be true.
|
|
322
|
+
- `batchSize: number`: Set the batchSize for the getMoreCommand when iterating over the query results.
|
|
323
|
+
- `bsonRegExp: boolean`: Return the BSON regular expressions as BSONRegExp instances.
|
|
324
|
+
- `checkKeys: boolean`: The serializer will check if keys are valid.
|
|
325
|
+
- `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
|
|
326
|
+
- `comment: string | object`: Add a [comment](https://docs.mongodb.com/manual/reference/operator/query/comment/index.html) to the query. These comments are visible in the MongoDB profile log, making them easier to interpret.
|
|
327
|
+
- `dbName: string`: The database name.
|
|
328
|
+
- `explain: boolean`: Specifies the verbosity mode for the explain output.
|
|
329
|
+
- `fullResponse: boolean`: Return the full server response for the command.
|
|
330
|
+
- `hint: string | object`: Tell the query to use specific indexes in the query. Object of indexes to use, `{'_id':1}`.
|
|
331
|
+
- `ignoreUndefined: boolean`: Default: `true` - Serialize will not emit undefined fields.
|
|
332
|
+
- `let: object`: Map of parameter names and values that can be accessed using `$$var` (requires MongoDB 5.0).
|
|
249
333
|
- `limit: number`: Sets the limit of documents returned in the query.
|
|
250
|
-
- `
|
|
334
|
+
- `max: object`: The exclusive upper bound for a specific index.
|
|
335
|
+
- `maxAwaitTimeMS: number`: The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. Requires `tailable` and `awaitData` to be true.
|
|
336
|
+
- `maxTimeMS: number`: Number of milliseconds to wait before aborting the command.
|
|
337
|
+
- `min: object`: The inclusive lower bound for a specific index.
|
|
338
|
+
- `noCursorTimeout: boolean`: The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.
|
|
339
|
+
- `noResponse: boolean`: Admin command option.
|
|
251
340
|
- `projection: object`: The fields to return in the query. Object of fields to either include or exclude (one of, not both), `{'a':1, 'b': 1}` or `{'a': 0, 'b': 0}`.
|
|
252
|
-
- `
|
|
253
|
-
- `hint: object`: Tell the query to use specific indexes in the query. Object of indexes to use, `{'_id':1}`.
|
|
254
|
-
- `comment: string`: Add a [comment](https://docs.mongodb.com/manual/reference/operator/query/comment/index.html) to the query. These comments are visible in the MongoDB profile log, making them easier to interpret.
|
|
341
|
+
- `readConcern: object`: Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported).
|
|
255
342
|
- `readPreference: string | object`: The preferred read preference.
|
|
256
|
-
- `
|
|
257
|
-
- `
|
|
343
|
+
- `retryWrites: boolean`: Should retry failed writes.
|
|
344
|
+
- `returnKey: boolean`: If true, returns only the index keys in the resulting documents.
|
|
345
|
+
- `serializeFunctions: boolean`: Default: `false` - Serialize the javascript functions.
|
|
346
|
+
- `showRecordId: boolean`: Determine whether to return the record identifier for each document. If true, adds a field $recordId to the returned documents.
|
|
347
|
+
- `singleBatch: boolean`: Default: `false` - Determines whether to close the cursor after the first batch.
|
|
348
|
+
- `skip: number`: Set to skip N documents ahead in your query (useful for pagination).
|
|
349
|
+
- `sort: array | object`: Set to sort the documents coming back from the query.
|
|
350
|
+
- `tailable: boolean`: Specify if the cursor is tailable.
|
|
351
|
+
- `timeout: boolean`: Specify if the cursor can timeout.
|
|
352
|
+
- `willRetryWrites: boolean`: Option whether to retry writes.
|
|
353
|
+
- `writeConcern: object`: An object that expresses the write concern.
|
|
258
354
|
|
|
259
355
|
#### Examples
|
|
260
356
|
|
|
@@ -276,15 +372,27 @@ _ref:
|
|
|
276
372
|
|
|
277
373
|
#### Properties
|
|
278
374
|
- `docs: object[]`: __Required__ - The array of documents to be inserted.
|
|
279
|
-
- `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/
|
|
375
|
+
- `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#insertmany) for more information. Supported settings are:
|
|
376
|
+
- `authdb: string`: Specifies the authentication information to be used.
|
|
377
|
+
- `bsonRegExp: boolean`: Return the BSON regular expressions as BSONRegExp instances.
|
|
280
378
|
- `bypassDocumentValidation: boolean`: Default: `false` - Allow driver to bypass schema validation in MongoDB 3.2 or higher
|
|
281
379
|
- `checkKeys: boolean`: Default: `true` - If true, will throw if bson documents start with $ or include a . in any key value.
|
|
282
|
-
- `
|
|
283
|
-
- `
|
|
380
|
+
- `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
|
|
381
|
+
- `comment: string | object`: Add a [comment](https://docs.mongodb.com/manual/reference/operator/query/comment/index.html) to the query. These comments are visible in the MongoDB profile log, making them easier to interpret.
|
|
382
|
+
- `dbName: string`: The database name.
|
|
383
|
+
- `explain: object`: Specifies the verbosity mode for the explain output.
|
|
384
|
+
- `forcesServerObjectId: boolean`: Default: `false` - Force server to assign _id values instead of driver.
|
|
385
|
+
- `fullResponse: boolean`: Return the full server response for the command.
|
|
284
386
|
- `ignoreUndefined: boolean`: Default: `false` - Specify if the BSON serializer should ignore undefined fields.
|
|
285
|
-
- `
|
|
286
|
-
- `
|
|
287
|
-
|
|
387
|
+
- `maxTimeMS: number`: Number of milliseconds to wait before aborting the command.
|
|
388
|
+
- `noResponse: boolean`: Admin command option.
|
|
389
|
+
- `ordered: boolean`: If true, when an insert fails, don't execute the remaining writes. If false, continue with remaining inserts when one fails.
|
|
390
|
+
- `readConcern: object`: Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported).
|
|
391
|
+
- `readPreference: object`: The preferred read preference.
|
|
392
|
+
- `retryWrites: boolean`: Should retry failed writes.
|
|
393
|
+
- `serializeFunctions: boolean`: Default: `false` - Serialize the javascript functions.
|
|
394
|
+
- `willRetryWrites: boolean`: Option whether to retry writes.
|
|
395
|
+
- `writeConcern: object`: An object that expresses the write concern.
|
|
288
396
|
|
|
289
397
|
#### Examples
|
|
290
398
|
|
|
@@ -311,14 +419,26 @@ _ref:
|
|
|
311
419
|
|
|
312
420
|
#### Properties
|
|
313
421
|
- `doc: object`: __Required__ - The document to be inserted.
|
|
314
|
-
- `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/
|
|
422
|
+
- `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#insertone) for more information. Supported settings are:
|
|
423
|
+
- `authdb: string`: Specifies the authentication information to be used.
|
|
424
|
+
- `bsonRegExp: boolean`: Return the BSON regular expressions as BSONRegExp instances.
|
|
315
425
|
- `bypassDocumentValidation: boolean`: Default: `false` - Allow driver to bypass schema validation in MongoDB 3.2 or higher
|
|
316
426
|
- `checkKeys: boolean`: Default: `true` - If true, will throw if bson documents start with $ or include a . in any key value.
|
|
317
|
-
- `
|
|
318
|
-
- `
|
|
427
|
+
- `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
|
|
428
|
+
- `comment: string | object`: Add a [comment](https://docs.mongodb.com/manual/reference/operator/query/comment/index.html) to the query. These comments are visible in the MongoDB profile log, making them easier to interpret.
|
|
429
|
+
- `dbName: string`: The database name.
|
|
430
|
+
- `explain: object`: Specifies the verbosity mode for the explain output.
|
|
431
|
+
- `forcesServerObjectId: boolean`: Default: `false` - Force server to assign _id values instead of driver.
|
|
432
|
+
- `fullResponse: boolean`: Return the full server response for the command.
|
|
319
433
|
- `ignoreUndefined: boolean`: Default: `false` - Specify if the BSON serializer should ignore undefined fields.
|
|
320
|
-
- `
|
|
321
|
-
- `
|
|
434
|
+
- `maxTimeMS: number`: Number of milliseconds to wait before aborting the command.
|
|
435
|
+
- `noResponse: boolean`: Admin command option.
|
|
436
|
+
- `readConcern: object`: Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported).
|
|
437
|
+
- `readPreference: object`: The preferred read preference.
|
|
438
|
+
- `retryWrites: boolean`: Should retry failed writes.
|
|
439
|
+
- `serializeFunctions: boolean`: Default: `false` - Serialize the javascript functions.
|
|
440
|
+
- `willRetryWrites: boolean`: Option whether to retry writes.
|
|
441
|
+
- `writeConcern: object`: An object that expresses the write concern.
|
|
322
442
|
|
|
323
443
|
#### Examples
|
|
324
444
|
|
|
@@ -382,7 +502,6 @@ _ref:
|
|
|
382
502
|
requests:
|
|
383
503
|
- id: set_resolved
|
|
384
504
|
type: MongoDBUpdateMany
|
|
385
|
-
connectionId: my_mongodb_collection_id
|
|
386
505
|
properties:
|
|
387
506
|
filter:
|
|
388
507
|
score:
|
|
@@ -399,19 +518,29 @@ _ref:
|
|
|
399
518
|
#### Properties
|
|
400
519
|
- `filter: object`: __Required__ - The filter used to select the document to update.
|
|
401
520
|
- `update: object | object[]`: __Required__ - The update operations to be applied to the document.
|
|
402
|
-
- `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/
|
|
403
|
-
- `arrayFilters:
|
|
521
|
+
- `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#updateone) for more information. Supported settings are:
|
|
522
|
+
- `arrayFilters: object[]`: _Array_ - Array filters for the [`$[<identifier>]`](https://docs.mongodb.com/manual/reference/operator/update/positional-filtered/) array update operator.
|
|
523
|
+
- `authdb: string`: Specifies the authentication information to be used.
|
|
524
|
+
- `bsonRegExp: boolean`: Return the BSON regular expressions as BSONRegExp instances.
|
|
404
525
|
- `bypassDocumentValidation: boolean`: Default: `false` - Allow driver to bypass schema validation in MongoDB 3.2 or higher.
|
|
405
526
|
- `checkKeys: boolean`: Default: `false` - If true, will throw if bson documents start with $ or include a . in any key value.
|
|
406
527
|
- `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
|
|
407
|
-
- `
|
|
408
|
-
- `
|
|
528
|
+
- `comment: string | object`: A user-provided comment to attach to this command.
|
|
529
|
+
- `dbName: string`: The database name.
|
|
530
|
+
- `explain: object`: Specifies the verbosity mode for the explain output.
|
|
531
|
+
- `fullResponse: boolean`: Return the full server response for the command.
|
|
532
|
+
- `hint: string | object`: An optional hint for query optimization.
|
|
409
533
|
- `ignoreUndefined: boolean`: Default: `false` - Specify if the BSON serializer should ignore undefined fields.
|
|
410
|
-
- `
|
|
534
|
+
- `let: object`: Map of parameter names and values that can be accessed using `$$var` (requires MongoDB 5.0).
|
|
535
|
+
- `maxTimeMS: number`: Number of milliseconds to wait before aborting the command.
|
|
536
|
+
- `noResponse: boolean`: Admin command option.
|
|
537
|
+
- `readConcern: object`: Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported).
|
|
538
|
+
- `readPreference: object`: The preferred read preference.
|
|
539
|
+
- `retryWrites: boolean`: Should retry failed writes.
|
|
540
|
+
- `serializeFunctions: boolean`: Default: `false` - Serialize the javascript functions.
|
|
411
541
|
- `upsert: boolean`: Default: `false` - Insert document if no match is found.
|
|
412
|
-
- `
|
|
413
|
-
- `
|
|
414
|
-
|
|
542
|
+
- `willRetryWrites: boolean`: Option whether to retry writes.
|
|
543
|
+
- `writeConcern: object`: An object that expresses the write concern.
|
|
415
544
|
|
|
416
545
|
#### Examples
|
|
417
546
|
|
|
@@ -55,10 +55,10 @@ _ref:
|
|
|
55
55
|
COPY --chown=node:node . .
|
|
56
56
|
|
|
57
57
|
# Build the Lowdefy config using the Lowdefy CLI
|
|
58
|
-
RUN npx lowdefy@3.23.
|
|
58
|
+
RUN npx lowdefy@3.23.2 build
|
|
59
59
|
|
|
60
60
|
# Use the correct Lowdefy base image
|
|
61
|
-
FROM lowdefy/lowdefy-aws-lambda:3.23.
|
|
61
|
+
FROM lowdefy/lowdefy-aws-lambda:3.23.2
|
|
62
62
|
|
|
63
63
|
# Copy build output from build stage
|
|
64
64
|
COPY --from=build /home/node/lowdefy/.lowdefy/build ./build
|
|
@@ -74,7 +74,7 @@ _ref:
|
|
|
74
74
|
type: Alert
|
|
75
75
|
properties:
|
|
76
76
|
type: warning
|
|
77
|
-
icon:
|
|
77
|
+
icon: AiFilledWarning
|
|
78
78
|
description: When updating your app to a new Lowdefy version, make sure to update the Lowdefy version in the Dockerfile
|
|
79
79
|
|
|
80
80
|
- id: md2
|
package/deployment/docker.yaml
CHANGED
|
@@ -32,7 +32,7 @@ _ref:
|
|
|
32
32
|
|
|
33
33
|
The Lowdefy server can be configured using the following environment variables:
|
|
34
34
|
|
|
35
|
-
- `
|
|
35
|
+
- `LOWDEFY_BASE_PATH`: Set the base path to serve the Lowdefy application from. This will serve the application under `https://example.com/<base-path>`instead of `https://example.com`, and all pages under `https://example.com/<base-path>/<page-id>` instead of the default `https://example.com/<page-id>`.
|
|
36
36
|
- `LOWDEFY_SERVER_BUILD_DIRECTORY`: The directory of the built Lowdefy configuration (The output of `lowdefy build`, usually found at `./.lowdefy/build` in your project repository). The default is `./build` (or `/home/node/lowdefy/build`).
|
|
37
37
|
- `LOWDEFY_SERVER_PUBLIC_DIRECTORY`: The directory of the public assets to be served. The default is `./public` (or `/home/node/lowdefy/public`).
|
|
38
38
|
- `LOWDEFY_SERVER_PORT`: The port (inside the container) at which to run the server. The default is `3000`.
|
|
@@ -41,7 +41,7 @@ _ref:
|
|
|
41
41
|
type: Alert
|
|
42
42
|
properties:
|
|
43
43
|
type: warning
|
|
44
|
-
icon:
|
|
44
|
+
icon: AiFilledWarning
|
|
45
45
|
description: When updating your app to a new Lowdefy version, make sure to update the Lowdefy version in the Dockerfile
|
|
46
46
|
|
|
47
47
|
- id: md2
|
|
@@ -65,10 +65,10 @@ _ref:
|
|
|
65
65
|
COPY --chown=node:node . .
|
|
66
66
|
|
|
67
67
|
# Build the Lowdefy config using the Lowdefy CLI
|
|
68
|
-
RUN npx lowdefy@3.23.
|
|
68
|
+
RUN npx lowdefy@3.23.2 build
|
|
69
69
|
|
|
70
70
|
# Use the correct Lowdefy base image
|
|
71
|
-
FROM lowdefy/lowdefy:3.23.
|
|
71
|
+
FROM lowdefy/lowdefy:3.23.2
|
|
72
72
|
|
|
73
73
|
# Copy build output from build stage
|
|
74
74
|
COPY --from=build --chown=node:node /home/node/lowdefy/.lowdefy/build ./build
|
|
@@ -105,7 +105,7 @@ _ref:
|
|
|
105
105
|
|
|
106
106
|
The following environment variables can be specified:
|
|
107
107
|
|
|
108
|
-
- `
|
|
108
|
+
- `LOWDEFY_BASE_PATH`: Set the base path to serve the Lowdefy application from. This will serve the application under `https://example.com/<base-path>`instead of `https://example.com`, and all pages under `https://example.com/<base-path>/<page-id>` instead of the default `https://example.com/<page-id>`.
|
|
109
109
|
- `LOWDEFY_SERVER_BUILD_DIRECTORY`: The directory of the built Lowdefy configuration (The output of `lowdefy build`, usually found at `./.lowdefy/build` in your project repository). The default is `./.lowdefy/build`.
|
|
110
110
|
- `LOWDEFY_SERVER_PORT`: The port at which to run the server. The default is `3000`.
|
|
111
111
|
- `LOWDEFY_SERVER_PUBLIC_DIRECTORY`: The directory of the public assets to be served. The default is `./public`.
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
# See the License for the specific language governing permissions and
|
|
13
13
|
# limitations under the License.
|
|
14
14
|
|
|
15
|
+
# TODO: Rewrite using pdf-make plugin.
|
|
15
16
|
_ref:
|
|
16
17
|
path: templates/blog.yaml.njk
|
|
17
18
|
vars:
|
|
@@ -46,9 +47,9 @@ _ref:
|
|
|
46
47
|
title: Generate a CSV
|
|
47
48
|
color: '#1890ff'
|
|
48
49
|
events:
|
|
49
|
-
onClick:
|
|
50
|
-
- id: generate_csv
|
|
51
|
-
type: JsAction
|
|
50
|
+
onClick: []
|
|
51
|
+
{# - id: generate_csv
|
|
52
|
+
type: JsAction # TODO:
|
|
52
53
|
params:
|
|
53
54
|
name: csvMake
|
|
54
55
|
args:
|
|
@@ -76,7 +77,7 @@ _ref:
|
|
|
76
77
|
- - Username # an array of field definitions
|
|
77
78
|
- Identifier
|
|
78
79
|
- FirstName
|
|
79
|
-
- LastName
|
|
80
|
+
- LastName #}
|
|
80
81
|
|
|
81
82
|
- id: md2
|
|
82
83
|
type: MarkdownWithCode
|
|
@@ -184,7 +185,7 @@ _ref:
|
|
|
184
185
|
|
|
185
186
|
###### /lowdefy.yaml
|
|
186
187
|
```yaml
|
|
187
|
-
lowdefy: 3.23.
|
|
188
|
+
lowdefy: 3.23.2
|
|
188
189
|
name: Generate PDF from data with Lowdefy
|
|
189
190
|
|
|
190
191
|
app:
|
|
@@ -210,7 +211,7 @@ _ref:
|
|
|
210
211
|
events:
|
|
211
212
|
onClick:
|
|
212
213
|
- id: generate_csv
|
|
213
|
-
type: JsAction
|
|
214
|
+
type: JsAction # TODO:
|
|
214
215
|
params:
|
|
215
216
|
name: csvMake
|
|
216
217
|
args:
|