@lowdefy/docs 4.0.0-alpha.1 → 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 (148) hide show
  1. package/CHANGELOG.md +92 -73
  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/connections/Redis.yaml +147 -0
  89. package/deployment/aws-lambda.yaml +3 -3
  90. package/deployment/docker.yaml +4 -4
  91. package/deployment/node-server.yaml +1 -1
  92. package/howto/generate-csv.yaml.njk +7 -6
  93. package/howto/generate-pdf.yaml.njk +21 -21
  94. package/howto/generateCsv/lowdefy.yaml +32 -31
  95. package/howto/generatePdf/lowdefy.yaml +10 -9
  96. package/introduction.yaml +1 -1
  97. package/lowdefy.yaml +1 -1
  98. package/menus.yaml +29 -29
  99. package/operators/_actions.yaml +2 -2
  100. package/operators/_diff.yaml +0 -1
  101. package/operators/_get.yaml +6 -6
  102. package/operators/_js.yaml +2 -2
  103. package/operators/_ref.yaml +40 -6
  104. package/operators/_yaml.yaml +39 -15
  105. package/package.json +6 -7
  106. package/pages.yaml +9 -8
  107. package/public/sitemap.xml +204 -204
  108. package/templates/blocks/defaultValueTransformer.js +4 -2
  109. package/templates/blocks/exampleTransformer.js +1 -1
  110. package/templates/blocks/propertiesFormTransformer.js +3 -3
  111. package/templates/blocks/propertiesGetterTransformer.js +2 -2
  112. package/templates/blocks/schemaTransformer.js +1 -1
  113. package/templates/blocks/template.yaml.njk +3 -4
  114. package/templates/blog.yaml.njk +5 -5
  115. package/templates/cli_command.yaml.njk +2 -2
  116. package/templates/footer.yaml.njk +18 -18
  117. package/templates/general.yaml.njk +4 -4
  118. package/templates/generateSitemap.js +1 -2
  119. package/templates/header.yaml +2 -2
  120. package/templates/navigation_buttons.yaml +2 -2
  121. package/templates/operatorsMethodTransformer.js +2 -2
  122. package/templates/test/array.test.js +146 -166
  123. package/templates/test/boolean.test.js +13 -17
  124. package/templates/test/button.test.js +21 -25
  125. package/templates/test/color.test.js +21 -23
  126. package/templates/test/enum.test.js +15 -19
  127. package/templates/test/icon.test.js +17 -21
  128. package/templates/test/integer.test.js +13 -17
  129. package/templates/test/manual.test.js +66 -74
  130. package/templates/test/number.test.js +13 -17
  131. package/templates/test/object.test.js +90 -98
  132. package/templates/test/oneOf.test.js +108 -120
  133. package/templates/test/string.test.js +13 -17
  134. package/templates/test/yaml.test.js +96 -112
  135. package/tutorial/tutorial-actions-operators-config.yaml +4 -4
  136. package/tutorial/tutorial-actions-operators.yaml +6 -6
  137. package/tutorial/tutorial-add-blocks-config.yaml +4 -4
  138. package/tutorial/tutorial-add-blocks.yaml +4 -4
  139. package/tutorial/tutorial-create-page-config.yaml +2 -2
  140. package/tutorial/tutorial-create-page.yaml +4 -4
  141. package/tutorial/tutorial-deploy.yaml +2 -2
  142. package/tutorial/tutorial-requests-config.yaml +4 -4
  143. package/tutorial/tutorial-requests.yaml +2 -2
  144. package/tutorial/tutorial-start.yaml +6 -6
  145. package/users/login-and-logout.yaml +2 -2
  146. package/users/protected-pages.yaml +2 -2
  147. package/users/roles.yaml +2 -2
  148. package/users/users-introduction.yaml +2 -2
@@ -25,22 +25,36 @@ _ref:
25
25
  - name: parse
26
26
  types: |
27
27
  ```
28
- (value: string): any
28
+ ({on: string, options?: object}): object
29
+ ([on: string, options?: object]): object
29
30
  ```
30
31
  description: |
31
32
  The `_yaml.parse` method parses a YAML string into an object.
32
33
  arguments: |
33
- ###### string
34
- The string to parse.
34
+ ###### object
35
+ - `on: string`: String to parse.
36
+ - `options?: object`: Optional settings. See the [YAML.parse: method here](https://eemeli.org/yaml/#parse-options) for supported settings.
37
+
35
38
  examples: |
36
39
  ###### Parse a YAML string:
37
40
  ```yaml
38
- _yaml.parse: |
39
- key: Value
40
- boolean: true
41
- array:
42
- - 1
43
- - 2
41
+ _yaml.parse:
42
+ on: |
43
+ key: Value
44
+ boolean: true
45
+ array:
46
+ - 1
47
+ - 2
48
+ ```
49
+ or:
50
+ ```yaml
51
+ _yaml.parse:
52
+ - |
53
+ key: Value
54
+ boolean: true
55
+ array:
56
+ - 1
57
+ - 2
44
58
  ```
45
59
  Returns:
46
60
  ```
@@ -61,17 +75,27 @@ _ref:
61
75
  arguments: |
62
76
  ###### object
63
77
  - `on: any`: The object to stringify.
64
- - `options: object`: Optional settings. See the [YAML.dump method here](https://www.npmjs.com/package/js-yaml) for supported settings.
78
+ - `options?: object`: Optional settings. See the [YAML.stringify: method here](https://eemeli.org/yaml/#tostring-options) for supported settings.
65
79
 
66
80
  examples: |
67
81
  ###### Stringify an object as YAML:
68
82
  ```yaml
69
83
  _yaml.stringify:
70
- key: Value
71
- boolean: true
72
- array:
73
- - 1
74
- - 2
84
+ on:
85
+ key: Value
86
+ boolean: true
87
+ array:
88
+ - 1
89
+ - 2
90
+ ```
91
+ or:
92
+ ```yaml
93
+ _yaml.stringify:
94
+ - key: Value
95
+ boolean: true
96
+ array:
97
+ - 1
98
+ - 2
75
99
  ```
76
100
  Returns (as a string):
77
101
  ```text
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lowdefy/docs",
3
- "version": "4.0.0-alpha.1",
3
+ "version": "4.0.0-alpha.7",
4
4
  "license": "Apache-2.0",
5
5
  "description": "",
6
6
  "homepage": "https://lowdefy.com",
@@ -26,19 +26,18 @@
26
26
  "type": "git",
27
27
  "url": "https://github.com/lowdefy/lowdefy.git"
28
28
  },
29
+ "type": "module",
29
30
  "scripts": {
30
31
  "clean": "rm -rf .lowdefy",
31
32
  "test": "jest --coverage"
32
33
  },
33
34
  "devDependencies": {
34
- "@babel/cli": "7.15.7",
35
- "@babel/core": "7.15.8",
36
- "@babel/preset-env": "7.15.8",
37
- "babel-jest": "27.3.1",
38
- "jest": "27.3.1"
35
+ "@swc/core": "1.2.135",
36
+ "@swc/jest": "0.2.17",
37
+ "jest": "27.5.1"
39
38
  },
40
39
  "publishConfig": {
41
40
  "access": "public"
42
41
  },
43
- "gitHead": "c97a8fa6b5a641e7d50df09f5601a9c586eeb65a"
42
+ "gitHead": "52ec14639d00de910cf9b8ab25bf933ca891cff5"
44
43
  }
package/pages.yaml CHANGED
@@ -69,7 +69,7 @@
69
69
  - _ref: blocks/input/PasswordInput.yaml
70
70
  - _ref: blocks/input/RadioSelector.yaml
71
71
  - _ref: blocks/input/RatingSlider.yaml
72
- - _ref: blocks/input/S3UploadButton.yaml
72
+ # - _ref: blocks/input/S3UploadButton.yaml # TODO: Add with custom plugin
73
73
  - _ref: blocks/input/Selector.yaml
74
74
  - _ref: blocks/input/SliderColorSelector.yaml
75
75
  - _ref: blocks/input/SwatchesColorSelector.yaml
@@ -80,14 +80,12 @@
80
80
  - _ref: blocks/input/TwitterColorSelector.yaml
81
81
  - _ref: blocks/input/WeekSelector.yaml
82
82
 
83
- - _ref: blocks/display/Alert.yaml
84
83
  - _ref: blocks/display/Anchor.yaml
85
84
  - _ref: blocks/display/Avatar.yaml
86
85
  - _ref: blocks/display/Breadcrumb.yaml
87
86
  - _ref: blocks/display/Button.yaml
88
87
  - _ref: blocks/display/DangerousHtml.yaml
89
88
  - _ref: blocks/display/DangerousMarkdown.yaml
90
- - _ref: blocks/display/Descriptions.yaml
91
89
  - _ref: blocks/display/Divider.yaml
92
90
  - _ref: blocks/display/EChart.yaml
93
91
  - _ref: blocks/display/Html.yaml
@@ -101,10 +99,11 @@
101
99
  - _ref: blocks/display/Notification.yaml
102
100
  - _ref: blocks/display/Paragraph.yaml
103
101
  - _ref: blocks/display/Progress.yaml
104
- # - _ref: blocks/display/Skeleton.yaml
102
+ # - _ref: blocks/display/Skeleton.yaml # TODO:
105
103
  - _ref: blocks/display/Statistic.yaml
106
104
  - _ref: blocks/display/Title.yaml
107
105
 
106
+ - _ref: blocks/container/Alert.yaml
108
107
  - _ref: blocks/container/Affix.yaml
109
108
  - _ref: blocks/container/Badge.yaml
110
109
  - _ref: blocks/container/Box.yaml
@@ -112,6 +111,7 @@
112
111
  - _ref: blocks/container/Collapse.yaml
113
112
  - _ref: blocks/container/Comment.yaml
114
113
  - _ref: blocks/container/ConfirmModal.yaml
114
+ - _ref: blocks/container/Descriptions.yaml
115
115
  - _ref: blocks/container/Drawer.yaml
116
116
  - _ref: blocks/container/Label.yaml
117
117
  - _ref: blocks/container/Modal.yaml
@@ -123,13 +123,13 @@
123
123
  - _ref: blocks/container/PageSiderMenu.yaml
124
124
  - _ref: blocks/container/Result.yaml
125
125
  - _ref: blocks/container/Span.yaml
126
- - _ref: blocks/container/Spin.yaml
126
+ # - _ref: blocks/container/Spin.yaml # TODO:
127
127
  - _ref: blocks/container/Tabs.yaml
128
128
  - _ref: blocks/container/Tooltip.yaml
129
129
 
130
130
  - _ref: blocks/list/ControlledList.yaml
131
131
  - _ref: blocks/list/List.yaml
132
- # - _ref: blocks/list/TimelineList.yaml
132
+ # - _ref: blocks/list/TimelineList.yaml # TODO:
133
133
 
134
134
  - _ref: connections/AmazonRedshift.yaml
135
135
  - _ref: connections/AWSS3.yaml
@@ -143,12 +143,13 @@
143
143
  - _ref: connections/MySQL.yaml
144
144
  # - _ref: connections/OracleDB.yaml
145
145
  - _ref: connections/PostgreSQL.yaml
146
+ - _ref: connections/Redis.yaml
146
147
  - _ref: connections/SendGridMail.yaml
147
148
  - _ref: connections/SQLite.yaml
148
149
  - _ref: connections/Stripe.yaml
149
150
 
150
151
  - _ref: actions/CallMethod.yaml
151
- - _ref: actions/JsAction.yaml
152
+ # - _ref: actions/JsAction.yaml
152
153
  - _ref: actions/Link.yaml
153
154
  - _ref: actions/Login.yaml
154
155
  - _ref: actions/Logout.yaml
@@ -186,7 +187,7 @@
186
187
  - _ref: operators/_if_none.yaml
187
188
  - _ref: operators/_index.yaml
188
189
  - _ref: operators/_input.yaml
189
- - _ref: operators/_js.yaml
190
+ # - _ref: operators/_js.yaml
190
191
  - _ref: operators/_json.yaml
191
192
  - _ref: operators/_list_contexts.yaml
192
193
  - _ref: operators/_location.yaml