@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.
Files changed (146) hide show
  1. package/CHANGELOG.md +75 -104
  2. package/actions/JsAction.yaml +6 -6
  3. package/blocks/container/Affix.yaml +1 -1
  4. package/blocks/container/Alert.yaml +2 -2
  5. package/blocks/container/Badge.yaml +1 -1
  6. package/blocks/container/Box.yaml +1 -1
  7. package/blocks/container/Card.yaml +1 -1
  8. package/blocks/container/Collapse.yaml +1 -1
  9. package/blocks/container/Comment.yaml +4 -4
  10. package/blocks/container/ConfirmModal.yaml +1 -1
  11. package/blocks/container/Descriptions.yaml +2 -2
  12. package/blocks/container/Drawer.yaml +1 -1
  13. package/blocks/container/Label.yaml +1 -2
  14. package/blocks/container/Modal.yaml +1 -1
  15. package/blocks/container/PageHCF.yaml +1 -1
  16. package/blocks/container/PageHCSF.yaml +1 -1
  17. package/blocks/container/PageHSCF.yaml +1 -1
  18. package/blocks/container/PageHeaderMenu.yaml +3 -3
  19. package/blocks/container/PageSHCF.yaml +1 -1
  20. package/blocks/container/PageSiderMenu.yaml +3 -3
  21. package/blocks/container/Result.yaml +2 -2
  22. package/blocks/container/Span.yaml +1 -1
  23. package/blocks/container/Spin.yaml +2 -2
  24. package/blocks/container/Tabs.yaml +2 -2
  25. package/blocks/container/Tooltip.yaml +1 -1
  26. package/blocks/display/Anchor.yaml +1 -2
  27. package/blocks/display/Avatar.yaml +1 -2
  28. package/blocks/display/Breadcrumb.yaml +2 -3
  29. package/blocks/display/Button.yaml +7 -7
  30. package/blocks/display/DangerousHtml.yaml +1 -1
  31. package/blocks/display/DangerousMarkdown.yaml +1 -1
  32. package/blocks/display/Divider.yaml +1 -3
  33. package/blocks/display/EChart.yaml +1 -1
  34. package/blocks/display/Html.yaml +2 -2
  35. package/blocks/display/Icon.yaml +1 -3
  36. package/blocks/display/Img.yaml +1 -1
  37. package/blocks/display/Markdown.yaml +5 -6
  38. package/blocks/display/MarkdownWithCode.yaml +3 -5
  39. package/blocks/display/Menu.yaml +3 -3
  40. package/blocks/display/Message.yaml +1 -1
  41. package/blocks/display/MobileMenu.yaml +3 -4
  42. package/blocks/display/Notification.yaml +2 -2
  43. package/blocks/display/Paragraph.yaml +2 -4
  44. package/blocks/display/Progress.yaml +8 -9
  45. package/blocks/display/Skeleton.yaml +1 -2
  46. package/blocks/display/Statistic.yaml +3 -5
  47. package/blocks/display/Title.yaml +1 -1
  48. package/blocks/input/AutoComplete.yaml +1 -2
  49. package/blocks/input/ButtonSelector.yaml +1 -2
  50. package/blocks/input/CheckboxSelector.yaml +1 -2
  51. package/blocks/input/CheckboxSwitch.yaml +1 -1
  52. package/blocks/input/ChromeColorSelector.yaml +1 -2
  53. package/blocks/input/CircleColorSelector.yaml +1 -2
  54. package/blocks/input/ColorSelector.yaml +1 -2
  55. package/blocks/input/CompactColorSelector.yaml +1 -2
  56. package/blocks/input/DateRangeSelector.yaml +1 -2
  57. package/blocks/input/DateSelector.yaml +1 -2
  58. package/blocks/input/DateTimeSelector.yaml +1 -2
  59. package/blocks/input/GithubColorSelector.yaml +1 -2
  60. package/blocks/input/MonthSelector.yaml +1 -2
  61. package/blocks/input/MultipleSelector.yaml +1 -1
  62. package/blocks/input/NumberInput.yaml +1 -1
  63. package/blocks/input/Pagination.yaml +3 -3
  64. package/blocks/input/ParagraphInput.yaml +1 -1
  65. package/blocks/input/PasswordInput.yaml +1 -1
  66. package/blocks/input/RadioSelector.yaml +1 -1
  67. package/blocks/input/RatingSlider.yaml +1 -1
  68. package/blocks/input/S3UploadButton.yaml +1 -1
  69. package/blocks/input/Selector.yaml +1 -1
  70. package/blocks/input/SliderColorSelector.yaml +1 -1
  71. package/blocks/input/SwatchesColorSelector.yaml +1 -1
  72. package/blocks/input/Switch.yaml +1 -1
  73. package/blocks/input/TextArea.yaml +1 -2
  74. package/blocks/input/TextInput.yaml +7 -7
  75. package/blocks/input/TitleInput.yaml +1 -1
  76. package/blocks/input/TwitterColorSelector.yaml +1 -1
  77. package/blocks/input/WeekSelector.yaml +1 -1
  78. package/blocks/list/ControlledList.yaml +18 -18
  79. package/blocks/list/List.yaml +16 -17
  80. package/blocks/list/TimelineList.yaml +23 -22
  81. package/concepts/cli.yaml +7 -7
  82. package/concepts/custom-blocks.yaml +16 -2
  83. package/concepts/custom-code.yaml +5 -4
  84. package/concepts/lowdefy-schema.yaml +5 -4
  85. package/connections/AxiosHttp.yaml +1 -1
  86. package/connections/Knex.yaml +7 -7
  87. package/connections/MongoDB.yaml +176 -47
  88. package/deployment/aws-lambda.yaml +3 -3
  89. package/deployment/docker.yaml +4 -4
  90. package/deployment/node-server.yaml +1 -1
  91. package/howto/generate-csv.yaml.njk +7 -6
  92. package/howto/generate-pdf.yaml.njk +21 -21
  93. package/howto/generateCsv/lowdefy.yaml +32 -31
  94. package/howto/generatePdf/lowdefy.yaml +10 -9
  95. package/introduction.yaml +1 -1
  96. package/lowdefy.yaml +1 -1
  97. package/menus.yaml +26 -29
  98. package/operators/_actions.yaml +2 -2
  99. package/operators/_get.yaml +6 -6
  100. package/operators/_js.yaml +2 -2
  101. package/operators/_ref.yaml +40 -6
  102. package/operators/_yaml.yaml +39 -15
  103. package/package.json +6 -7
  104. package/pages.yaml +8 -8
  105. package/public/sitemap.xml +204 -204
  106. package/templates/blocks/defaultValueTransformer.js +4 -2
  107. package/templates/blocks/exampleTransformer.js +1 -1
  108. package/templates/blocks/propertiesFormTransformer.js +3 -3
  109. package/templates/blocks/propertiesGetterTransformer.js +2 -2
  110. package/templates/blocks/schemaTransformer.js +1 -1
  111. package/templates/blocks/template.yaml.njk +3 -4
  112. package/templates/blog.yaml.njk +5 -5
  113. package/templates/cli_command.yaml.njk +2 -2
  114. package/templates/footer.yaml.njk +18 -18
  115. package/templates/general.yaml.njk +4 -4
  116. package/templates/generateSitemap.js +1 -2
  117. package/templates/header.yaml +2 -2
  118. package/templates/navigation_buttons.yaml +2 -2
  119. package/templates/operatorsMethodTransformer.js +2 -2
  120. package/templates/test/array.test.js +146 -166
  121. package/templates/test/boolean.test.js +13 -17
  122. package/templates/test/button.test.js +21 -25
  123. package/templates/test/color.test.js +21 -23
  124. package/templates/test/enum.test.js +15 -19
  125. package/templates/test/icon.test.js +17 -21
  126. package/templates/test/integer.test.js +13 -17
  127. package/templates/test/manual.test.js +66 -74
  128. package/templates/test/number.test.js +13 -17
  129. package/templates/test/object.test.js +90 -98
  130. package/templates/test/oneOf.test.js +108 -120
  131. package/templates/test/string.test.js +13 -17
  132. package/templates/test/yaml.test.js +96 -112
  133. package/tutorial/tutorial-actions-operators-config.yaml +4 -4
  134. package/tutorial/tutorial-actions-operators.yaml +6 -6
  135. package/tutorial/tutorial-add-blocks-config.yaml +4 -4
  136. package/tutorial/tutorial-add-blocks.yaml +4 -4
  137. package/tutorial/tutorial-create-page-config.yaml +2 -2
  138. package/tutorial/tutorial-create-page.yaml +4 -4
  139. package/tutorial/tutorial-deploy.yaml +2 -2
  140. package/tutorial/tutorial-requests-config.yaml +4 -4
  141. package/tutorial/tutorial-requests.yaml +2 -2
  142. package/tutorial/tutorial-start.yaml +6 -6
  143. package/users/login-and-logout.yaml +2 -2
  144. package/users/protected-pages.yaml +2 -2
  145. package/users/roles.yaml +2 -2
  146. package/users/users-introduction.yaml +2 -2
@@ -73,7 +73,7 @@ _ref:
73
73
  title: Reset
74
74
  block: true
75
75
  type: default
76
- icon: ClearOutlined
76
+ icon: AiOutlinedClear
77
77
  ################ -------- Copy from here -------- ################
78
78
  events:
79
79
  onClick:
@@ -143,7 +143,7 @@ _ref:
143
143
  title: Submit
144
144
  block: true
145
145
  type: primary
146
- icon: SaveOutlined
146
+ icon: AiOutlinedSave
147
147
  ################ -------- Copy from here -------- ################
148
148
  events:
149
149
  onClick:
@@ -199,7 +199,7 @@ _ref:
199
199
  title: Reset
200
200
  block: true
201
201
  type: default
202
- icon: ClearOutlined
202
+ icon: AiOutlinedClear
203
203
  events:
204
204
  onClick:
205
205
  - id: reset
@@ -212,7 +212,7 @@ _ref:
212
212
  title: Submit
213
213
  block: true
214
214
  type: primary
215
- icon: SaveOutlined
215
+ icon: AiOutlinedSave
216
216
  events:
217
217
  onClick:
218
218
  - id: validate
@@ -399,7 +399,7 @@ _ref:
399
399
  title: Reset
400
400
  block: true # Make the button fill all the space available to it
401
401
  type: default # Make the button a plain button
402
- icon: ClearOutlined
402
+ icon: AiOutlinedClear
403
403
  events:
404
404
  onClick:
405
405
  - id: reset
@@ -412,7 +412,7 @@ _ref:
412
412
  title: Submit
413
413
  block: true
414
414
  type: primary # Make the button a primary button with color
415
- icon: SaveOutlined
415
+ icon: AiOutlinedSave
416
416
  events:
417
417
  onClick:
418
418
  - id: validate
@@ -35,13 +35,13 @@ _ref:
35
35
  - id: new-ticket
36
36
  type: MenuLink
37
37
  properties:
38
- icon: AlertOutlined
38
+ icon: AiOutlinedAlert
39
39
  title: New ticket
40
40
  pageId: new-ticket
41
41
  - id: welcome
42
42
  type: MenuLink
43
43
  properties:
44
- icon: HomeOutlined
44
+ icon: AiOutlinedHome
45
45
  title: Home
46
46
  pageId: welcome
47
47
 
@@ -96,7 +96,7 @@ _ref:
96
96
  title: Reset
97
97
  block: true # Make the button fill all the space available to it
98
98
  type: default # Make the button a plain button
99
- icon: ClearOutlined
99
+ icon: AiOutlinedClear
100
100
  - id: submit_button
101
101
  type: Button
102
102
  layout:
@@ -105,5 +105,5 @@ _ref:
105
105
  title: Submit
106
106
  block: true
107
107
  type: primary # Make the button a primary button with color
108
- icon: SaveOutlined
108
+ icon: AiOutlinedSave
109
109
  ```
@@ -93,7 +93,7 @@ _ref:
93
93
  title: Reset
94
94
  block: true # Make the button fill all the space available to it
95
95
  type: default # Make the button a plain button
96
- icon: ClearOutlined
96
+ icon: AiOutlinedClear
97
97
  - id: submit_button
98
98
  type: Button
99
99
  layout:
@@ -102,7 +102,7 @@ _ref:
102
102
  title: Submit
103
103
  block: true
104
104
  type: primary # Make the button a primary button with color
105
- icon: SaveOutlined
105
+ icon: AiOutlinedSave
106
106
  ################ -------- Copy to here ---------- ################
107
107
  ```
108
108
 
@@ -154,7 +154,7 @@ _ref:
154
154
  title: Reset
155
155
  block: true
156
156
  type: default
157
- icon: ClearOutlined
157
+ icon: AiOutlinedClear
158
158
  - id: submit_button
159
159
  type: Button
160
160
  layout:
@@ -163,7 +163,7 @@ _ref:
163
163
  title: Submit
164
164
  block: true
165
165
  type: primary
166
- icon: SaveOutlined
166
+ icon: AiOutlinedSave
167
167
  - id: body_what_happened
168
168
  type: MarkdownWithCode
169
169
  properties:
@@ -36,13 +36,13 @@ _ref:
36
36
  - id: new-ticket
37
37
  type: MenuLink
38
38
  properties:
39
- icon: AlertOutlined
39
+ icon: AiOutlinedAlert
40
40
  title: New ticket
41
41
  pageId: new-ticket
42
42
  - id: welcome
43
43
  type: MenuLink
44
44
  properties:
45
- icon: HomeOutlined
45
+ icon: AiOutlinedHome
46
46
  title: Home
47
47
  pageId: welcome
48
48
 
@@ -76,7 +76,7 @@ _ref:
76
76
 
77
77
  ```yaml
78
78
  name: lowdefy-project-template
79
- lowdefy: 3.23.1
79
+ lowdefy: 3.23.2
80
80
 
81
81
  pages:
82
82
  ################ -------- Copy from here -------- ################
@@ -93,7 +93,7 @@ _ref:
93
93
  type: Alert
94
94
  properties:
95
95
  type: warning
96
- icon: WarningFilled
96
+ icon: AiFilledWarning
97
97
  message: Indentation is important
98
98
  description: YAML files use indentation to determine the data structure represented. If you are having any problems, make sure the indentation is the same as in the instructions.
99
99
 
@@ -164,13 +164,13 @@ _ref:
164
164
  - id: new-ticket
165
165
  type: MenuLink
166
166
  properties:
167
- icon: AlertOutlined
167
+ icon: AiOutlinedAlert
168
168
  title: New ticket
169
169
  pageId: new-ticket
170
170
  - id: welcome
171
171
  type: MenuLink
172
172
  properties:
173
- icon: HomeOutlined
173
+ icon: AiOutlinedHome
174
174
  title: Home
175
175
  pageId: welcome
176
176
  ################ -------- Copy to here ---------- ################
@@ -82,7 +82,7 @@ _ref:
82
82
  type: Alert
83
83
  properties:
84
84
  type: info
85
- icon: InfoCircleFilled
85
+ icon: AiFilledInfoCircle
86
86
  description: If your repository isn't found, click "Configure Netlify on Github", and give Netlify access to your repository.
87
87
 
88
88
  - id: body_configure_netlify
@@ -99,7 +99,7 @@ _ref:
99
99
  type: Alert
100
100
  properties:
101
101
  type: warning
102
- icon: WarningFilled
102
+ icon: AiFilledWarning
103
103
  description: Your site won't work yet. You first need to configure the Lowdefy server in the next step.
104
104
 
105
105
  - id: body_configure_functions
@@ -54,13 +54,13 @@ _ref:
54
54
  - id: new-ticket
55
55
  type: MenuLink
56
56
  properties:
57
- icon: AlertOutlined
57
+ icon: AiOutlinedAlert
58
58
  title: New ticket
59
59
  pageId: new-ticket
60
60
  - id: welcome
61
61
  type: MenuLink
62
62
  properties:
63
- icon: HomeOutlined
63
+ icon: AiOutlinedHome
64
64
  title: Home
65
65
  pageId: welcome
66
66
 
@@ -160,7 +160,7 @@ _ref:
160
160
  title: Reset
161
161
  block: true # Make the button fill all the space available to it
162
162
  type: default # Make the button a plain button
163
- icon: ClearOutlined
163
+ icon: AiOutlinedClear
164
164
  events:
165
165
  onClick:
166
166
  - id: reset
@@ -173,7 +173,7 @@ _ref:
173
173
  title: Submit
174
174
  block: true
175
175
  type: primary # Make the button a primary button with color
176
- icon: SaveOutlined
176
+ icon: AiOutlinedSave
177
177
  events:
178
178
  onClick:
179
179
  - id: validate
@@ -143,7 +143,7 @@ _ref:
143
143
  type: Alert
144
144
  properties:
145
145
  type: warning
146
- icon: WarningFilled
146
+ icon: AiFilledWarning
147
147
  description: By base64 encoding your credentials you have not encrypted them. They are still just as sensitive as before.
148
148
 
149
149
  - id: body_env
@@ -166,7 +166,7 @@ _ref:
166
166
  type: Alert
167
167
  properties:
168
168
  type: warning
169
- icon: WarningFilled
169
+ icon: AiFilledWarning
170
170
  description: The .env file contains your credentials. Do not commit this file to git. It should be listed in your .gitignore file if you used the CLI init command.
171
171
 
172
172
  - id: body_use_connection
@@ -81,14 +81,14 @@ _ref:
81
81
  type: Alert
82
82
  properties:
83
83
  type: info
84
- icon: InfoCircleFilled
84
+ icon: AiFilledInfoCircle
85
85
  description: To paste into the Windows Command Prompt, you can right-click and select paste.
86
86
 
87
87
  - id: error_already_exists
88
88
  type: Alert
89
89
  properties:
90
90
  type: error
91
- icon: FireOutlined
91
+ icon: AiOutlinedFire
92
92
  message: A "lowdefy.yaml" file already exists
93
93
  description: If you get a 'A "lowdefy.yaml" file already exists' error, delete the "lowdefy.yaml" file in your current working directory or run the command in a new directory.
94
94
 
@@ -137,7 +137,7 @@ _ref:
137
137
  subTitle: We are excited to see what you are going to build
138
138
  status: success
139
139
  icon:
140
- name: HeartTwoTone
140
+ name: AiTwoToneHeart
141
141
  color: '#f00'
142
142
  areas:
143
143
  extra:
@@ -167,7 +167,7 @@ _ref:
167
167
  type: Alert
168
168
  properties:
169
169
  type: error
170
- icon: FireOutlined
170
+ icon: AiOutlinedFire
171
171
  message: Could not find "lowdefy.yaml"
172
172
  description: If you get a 'Could not find "lowdefy.yaml"' error, make sure your current working directory contains the "lowdefy.yaml" file. You can verify this by running the "dir" (Windows) or "ls" (MacOS) command.
173
173
 
@@ -180,7 +180,7 @@ _ref:
180
180
  Open the `lowdefy.yaml` file using a text editor like [VS Code](https://code.visualstudio.com/download). The content of the file should look like this:
181
181
 
182
182
  ```yaml
183
- lowdefy: 3.23.1
183
+ lowdefy: 3.23.2
184
184
  name: Lowdefy starter
185
185
 
186
186
  pages:
@@ -203,7 +203,7 @@ _ref:
203
203
  title: Welcome to your Lowdefy app
204
204
  subTitle: We are excited to see what you are going to build
205
205
  icon:
206
- name: HeartTwoTone
206
+ name: AiTwoToneHeart
207
207
  color: '#f00'
208
208
  areas:
209
209
  extra:
@@ -132,7 +132,7 @@ _ref:
132
132
 
133
133
  ###### Redirect to the Auth0 logout URL and return to the `logged-out` page in the app after logout:
134
134
  ```yaml
135
- lowdefy: 3.23.1
135
+ lowdefy: 3.23.2
136
136
  config:
137
137
  auth:
138
138
  openId:
@@ -144,7 +144,7 @@ _ref:
144
144
 
145
145
  ###### Redirect to the Keycloak logout URL and return to the `logged-out` page in the app after logout:
146
146
  ```yaml
147
- lowdefy: 3.23.1
147
+ lowdefy: 3.23.2
148
148
  config:
149
149
  auth:
150
150
  openId:
@@ -36,7 +36,7 @@ _ref:
36
36
 
37
37
  ###### List specific public pages:
38
38
  ```yaml
39
- lowdefy: 3.23.1
39
+ lowdefy: 3.23.2
40
40
  config:
41
41
  auth:
42
42
  pages:
@@ -48,7 +48,7 @@ _ref:
48
48
  ````
49
49
  ###### List specific protected pages:
50
50
  ```yaml
51
- lowdefy: 3.23.1
51
+ lowdefy: 3.23.2
52
52
  config:
53
53
  auth:
54
54
  pages:
package/users/roles.yaml CHANGED
@@ -29,7 +29,7 @@ _ref:
29
29
  Roles can be read from a custom claim on the OpenID Connect `idToken`. This should be an array of strings which are the role names. This needs to be configured at the OpenID Connect provider. The field that contains the roles array is configured in the `config.auth.openId` field in the Lowdefy configuration.
30
30
 
31
31
  ```yaml
32
- lowdefy: 3.23.1
32
+ lowdefy: 3.23.2
33
33
  config:
34
34
  auth:
35
35
  openId:
@@ -43,7 +43,7 @@ _ref:
43
43
 
44
44
  ###### Protect pages using roles:
45
45
  ```yaml
46
- lowdefy: 3.23.1
46
+ lowdefy: 3.23.2
47
47
  config:
48
48
  auth:
49
49
  openId:
@@ -38,7 +38,7 @@ _ref:
38
38
  type: Alert
39
39
  properties:
40
40
  type: warning
41
- icon: WarningFilled
41
+ icon: AiFilledWarning
42
42
  message: Stateful JSON Web Tokens are used for authentication
43
43
  description: Lowdefy uses stateful JSON Web Tokens for user authentication, since the Lowdefy server is stateless and does not maintain a database of user sessions. This means that once a token is issued, it is valid until the token expires. Any changes to the user's access will only reflect after the token has expired, and the user obtains (or fails to obtain) a new token from the OpenID Connect provider. We recommend making sure tokens have a relatively short expiry time (the default is 4 hours), and evaluating if the security provided by this system is appropriate for your use case.
44
44
 
@@ -48,7 +48,7 @@ _ref:
48
48
  content: |
49
49
  Most authorization and authentication settings are configured in the `config.auth` object in the Lowdefy configuration. The following config can be set:
50
50
  ```yaml
51
- lowdefy: 3.23.1
51
+ lowdefy: 3.23.2
52
52
  config:
53
53
  auth:
54
54
  openId: