@lowdefy/docs 4.0.0-alpha.6 → 4.0.0-alpha.7

package/howto/generate-pdf.yaml.njk

@@ -46,7 +46,7 @@ _ref:
           textAlign: center
         properties:
           title: Generate & Download PDF
-          icon: DownloadOutlined
+          icon: AiOutlinedDownload
           color: '#6293F8'
         events:
           onMount:
@@ -90,13 +90,13 @@ _ref:
                       qty: 2
                       price: 60.667
                       code: X12-49A
-          onClick:
-            - id: generate_pdf
-              type: JsAction
+          onClick: []
+            {# - id: generate_pdf
+              type: JsAction # TODO:
               params:
                 name: pdfMake
                 args:
-                  _ref: howto/generatePdf/inv_template.yaml
+                  _ref: howto/generatePdf/inv_template.yaml #}
 
       - id: md2
         type: MarkdownWithCode
@@ -109,7 +109,7 @@ _ref:
           textAlign: center
         properties:
           title: Share this post
-          icon: UploadOutlined
+          icon: AiOutlinedUpload
           color: '#6293F8'
         events:
           onClick:
@@ -237,7 +237,7 @@ _ref:
             ###### /lowdefy.yaml
             ```yaml
             name: Generate a PDF
-            lowdefy: 3.23.1
+            lowdefy: 3.23.2
 
             app:
               html:
@@ -252,11 +252,11 @@ _ref:
                     type: Button
                     properties:
                       title: Download PDF
-                      icon: DownloadOutlined
+                      icon: AiOutlinedDownload
                     events:
                       onClick:
                         - id: make_pdf
-                          type: JsAction
+                          type: JsAction # TODO:
                           params:
                             name: pdfMake
                             args:
@@ -277,11 +277,11 @@ _ref:
           textAlign: center
         properties:
           title: Download PDF
-          icon: DownloadOutlined
+          icon: AiOutlinedDownload
         events:
-          onClick:
-            - id: make_pdf
-              type: JsAction
+          onClick: []
+            {# - id: make_pdf
+              type: JsAction # TODO:
               params:
                 name: pdfMake
                 args:
@@ -291,7 +291,7 @@ _ref:
                       fontSize: 10
                     content:
                       - text: This pdf has been generated with Lowdefy and pdfMake.
-                        bold: true
+                        bold: true #}
       - id: md4
         type: MarkdownWithCode
         properties:
@@ -302,7 +302,7 @@ _ref:
 
             ###### /lowdefy.yaml
             ```yaml
-            lowdefy: 3.23.1
+            lowdefy: 3.23.2
             name: Generate PDF from data with Lowdefy
 
             app:
@@ -370,7 +370,7 @@ _ref:
                         events:
                           onClick:
                             - id: make_pdf
-                              type: JsAction
+                              type: JsAction # TODO:
                               params:
                                 name: pdfMake
                                 args:
@@ -591,7 +591,7 @@ _ref:
           textAlign: center
         properties:
           title: Generate Invoice
-          icon: DownloadOutlined
+          icon: AiOutlinedDownload
           color: '#6293F8'
         events:
           onMount:
@@ -635,13 +635,13 @@ _ref:
                       qty: 2
                       price: 60.667
                       code: X12-49A
-          onClick:
-            - id: generate_pdf
-              type: JsAction
+          onClick: []
+            {# - id: generate_pdf
+              type: JsAction # TODO:
               params:
                 name: pdfMake
                 args:
-                  _ref: howto/generatePdf/inv_template.yaml
+                  _ref: howto/generatePdf/inv_template.yaml #}
       - id: md5
         type: MarkdownWithCode
         properties:

package/howto/generateCsv/lowdefy.yaml

@@ -1,4 +1,4 @@
-lowdefy: 3.23.1
+lowdefy: 3.23.2
 name: Generate PDF from data with Lowdefy
 
 app:
@@ -23,36 +23,37 @@ pages:
               color: '#1890ff'
             events:
               onClick:
-                - id: generate_csv
-                  type: JsAction
-                  params:
-                    name: csvMake
-                    args:
-                      - profiles.csv # csv filename
-                      - - Username: booker12 # an array of data, usually a reference
-                          Identifier: 9012
-                          FirstName: Rachel
-                          LastName: Booker
-                        - Username: grey07
-                          Identifier: 2070
-                          FirstName: Laura
-                          LastName: Grey
-                        - Username: johnson81
-                          Identifier: 4081
-                          FirstName: Craig
-                          LastName: Johnson
-                        - Username: jenkins46
-                          Identifier: 9346
-                          FirstName: Mary
-                          LastName: Jenkins
-                        - Username: smith79
-                          Identifier: 5079
-                          FirstName: Jamie
-                          LastName: Smith
-                      - - Username # an array of field definitions
-                        - Identifier
-                        - FirstName
-                        - LastName
+                []
+                # - id: generate_csv
+                #   type: JsAction # TODO:
+                #   params:
+                #     name: csvMake
+                #     args:
+                #       - profiles.csv # csv filename
+                #       - - Username: booker12 # an array of data, usually a reference
+                #           Identifier: 9012
+                #           FirstName: Rachel
+                #           LastName: Booker
+                #         - Username: grey07
+                #           Identifier: 2070
+                #           FirstName: Laura
+                #           LastName: Grey
+                #         - Username: johnson81
+                #           Identifier: 4081
+                #           FirstName: Craig
+                #           LastName: Johnson
+                #         - Username: jenkins46
+                #           Identifier: 9346
+                #           FirstName: Mary
+                #           LastName: Jenkins
+                #         - Username: smith79
+                #           Identifier: 5079
+                #           FirstName: Jamie
+                #           LastName: Smith
+                #       - - Username # an array of field definitions
+                #         - Identifier
+                #         - FirstName
+                #         - LastName
       footer:
         blocks:
           - id: footer

package/howto/generatePdf/lowdefy.yaml

@@ -1,4 +1,4 @@
-lowdefy: 3.23.1
+lowdefy: 3.23.2
 name: Generate PDF from data with Lowdefy
 
 app:
@@ -68,7 +68,7 @@ pages:
                   title: Generate PDF from data with Lowdefy
                   subTitle: <a href="https://docs.lowdefy.com/generate-pdf-document-from-data">Read the full how to guide</a>
                   icon:
-                    name: PrinterTwoTone
+                    name: AiTwoTonePrinter
                     color: '#ff0000'
                 areas:
                   extra:
@@ -99,13 +99,14 @@ pages:
                           color: '#1890ff'
                         events:
                           onClick:
-                            - id: make_pdf
-                              type: JsAction
-                              params:
-                                name: pdfMake
-                                args:
-                                  _ref:
-                                    path: inv_template.yaml
+                            []
+                            # - id: make_pdf
+                            #   type: JsAction # TODO:
+                            #   params:
+                            #     name: pdfMake
+                            #     args:
+                            #       _ref:
+                            #         path: inv_template.yaml
       footer:
         blocks:
           - id: footer

package/introduction.yaml

@@ -84,7 +84,7 @@ _ref:
         properties:
           block: true
           hideActionLoading: true
-          icon: RocketOutlined
+          icon: AiOutlinedRocket
           size: large
           title: Start the tutorial
           type: primary

package/lowdefy.yaml

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 name: '@lowdefy/docs'
-lowdefy: 3.23.1
+lowdefy: 4.0.0-alpha.7
 licence: Apache-2.0
 
 cli:

package/menus.yaml

@@ -5,12 +5,12 @@
       pageId: introduction
       properties:
         title: Introduction
-        icon: CoffeeOutlined
+        icon: AiOutlinedCoffee
     - id: tutorial
       type: MenuGroup
       properties:
         title: Tutorial
-        icon: RocketOutlined
+        icon: AiOutlinedRocket
       links:
         - id: tutorial-start
           type: MenuLink
@@ -51,7 +51,7 @@
       type: MenuGroup
       properties:
         title: How To
-        icon: QuestionOutlined
+        icon: AiOutlinedQuestion
       links:
         - id: generate-csv
           type: MenuLink
@@ -67,7 +67,7 @@
       type: MenuGroup
       properties:
         title: Concepts
-        icon: BulbOutlined
+        icon: AiOutlinedBulb
       links:
         - id: overview
           type: MenuLink
@@ -143,7 +143,7 @@
       type: MenuGroup
       properties:
         title: Deployment
-        icon: CloudUploadOutlined
+        icon: AiOutlinedCloudUpload
       links:
         - id: aws-lambda
           type: MenuLink
@@ -169,7 +169,7 @@
       type: MenuGroup
       properties:
         title: User Authentication
-        icon: TeamOutlined
+        icon: AiOutlinedTeam
       links:
         - id: users
           type: MenuLink
@@ -206,7 +206,7 @@
       type: MenuGroup
       properties:
         title: Input Blocks
-        icon: FormOutlined
+        icon: AiOutlinedForm
       links:
         - id: AutoComplete
           type: MenuLink
@@ -268,9 +268,9 @@
         - id: RatingSlider
           type: MenuLink
           pageId: RatingSlider
-        - id: S3UploadButton
-          type: MenuLink
-          pageId: S3UploadButton
+        # - id: S3UploadButton
+        #   type: MenuLink
+        #   pageId: S3UploadButton
         - id: Selector
           type: MenuLink
           pageId: Selector
@@ -302,7 +302,7 @@
       type: MenuGroup
       properties:
         title: Display Blocks
-        icon: PictureOutlined
+        icon: AiOutlinedPicture
       links:
         - id: Alert
           type: MenuLink
@@ -381,7 +381,7 @@
       type: MenuGroup
       properties:
         title: Container Blocks
-        icon: ContainerOutlined
+        icon: AiOutlinedContainer
       links:
         - id: Affix
           type: MenuLink
@@ -437,9 +437,9 @@
         - id: Span
           type: MenuLink
           pageId: Span
-        - id: Spin
-          type: MenuLink
-          pageId: Spin
+        # - id: Spin
+        #   type: MenuLink
+        #   pageId: Spin
         - id: Tabs
           type: MenuLink
           pageId: Tabs
@@ -451,7 +451,7 @@
       type: MenuGroup
       properties:
         title: List Blocks
-        icon: OrderedListOutlined
+        icon: AiOutlinedOrderedList
       links:
         - id: ControlledList
           type: MenuLink
@@ -463,7 +463,7 @@
       type: MenuGroup
       properties:
         title: Connections
-        icon: ApiOutlined
+        icon: AiOutlinedApi
       links:
         - id: AmazonRedshift
           type: MenuLink
@@ -533,14 +533,11 @@
       type: MenuGroup
       properties:
         title: Actions
-        icon: ThunderboltOutlined
+        icon: AiOutlinedThunderbolt
       links:
         - id: CallMethod
           type: MenuLink
           pageId: CallMethod
-        - id: JsAction
-          type: MenuLink
-          pageId: JsAction
         - id: Link
           type: MenuLink
           pageId: Link
@@ -587,11 +584,11 @@
         - id: Wait
           type: MenuLink
           pageId: Wait
-    - id: operators
+    - id: operators-menu-group
       type: MenuGroup
       properties:
         title: Operators
-        icon: ToolOutlined
+        icon: AiOutlinedTool
       links:
         - id: _actions
           type: MenuLink
@@ -659,9 +656,9 @@
         - id: _input
           type: MenuLink
           pageId: _input
-        - id: _js
-          type: MenuLink
-          pageId: _js
+        # - id: _js
+        #   type: MenuLink
+        #   pageId: _js
         - id: _json
           type: MenuLink
           pageId: _json
@@ -771,13 +768,13 @@
       type: MenuGroup
       properties:
         title: Lowdefy Versions
-        icon: BranchesOutlined
+        icon: AiOutlinedBranches
       links:
-        - id: v3.23.1
+        - id: v3.23.2
           type: MenuLink
           url: https://docs.lowdefy.com
           properties:
-            title: v3.23.1
+            title: v3.23.2
         - id: v3.22.0
           type: MenuLink
           url: https://61519bcb8b8ed4412aae3057--lowdefy-docs.netlify.app

package/operators/_actions.yaml

@@ -77,7 +77,7 @@ _ref:
       First register a custom JavaScript action: `getNormalizedEigenvector`
       ```yaml
       # file: lowdefy.yaml
-      lowdefy: '3.23.1'
+      lowdefy: '3.23.2'
       app:
         html:
           appendHead: |
@@ -97,7 +97,7 @@ _ref:
       events:
         onClick:
           - id: get_normalized_eigenvector
-            type: JsAction
+            type: JsAction # TODO:
             params:
               name: getNormalizedEigenvector
               args:

package/operators/_get.yaml

@@ -53,12 +53,12 @@ _ref:
         key:
           _state: status
         from:
-          new: PlusCircleTwoTone
-          escalated: ExclamationCircleOutlined
-          investigation_started: ToolTwoTone
-          client_contacted: SoundTwoTone
-          awaiting_confirmation: LikeOutlined
-          closed: StopOutlined
+          new: AiTwoTonePlusCircle
+          escalated: AiOutlinedExclamationCircle
+          investigation_started: AiTwoToneTool
+          client_contacted: AiTwoToneSound
+          awaiting_confirmation: AiOutlinedLike
+          closed: AiOutlinedStop
       ```
       Returns: The icon corresponding to the status in state.
 

package/operators/_js.yaml

@@ -51,7 +51,7 @@ _ref:
           ```yaml
           # lowdefy.yaml
           name: make-me-primes
-          lowdefy: '3.23.1'
+          lowdefy: '3.23.2'
           app:
             html:
               # This HTML will be appended to the head HTML tag in the Lowdefy app
@@ -119,7 +119,7 @@ _ref:
           ```yaml
           # file: lowdefy.yaml
           name: my-chart
-          lowdefy: '3.23.1'
+          lowdefy: '3.23.2'
           app:
             html:
               appendHead:

package/operators/_ref.yaml

@@ -59,6 +59,12 @@ _ref:
 
       A transformer is a JavaScript function that receives the result of the `_ref` operator, and its `vars` as arguments. The value returned by this function will be included in the configuration as the final result of the `_ref` operator. The `transformer` argument should be the file path (relative to the root of the project) to a JavaScript file that exports a transformer function.
 
+      ###### CommonJS and ES Modules
+
+      Both [CommonJS](https://nodejs.org/api/modules.html) and [ES Modules](https://nodejs.org/api/esm.html) are supported for in resolver and transformer functions. By default the functions are imported as CommonJs modules, and the function should be exported as a default export (`module.exports = transformer`). Files can also use the `.cjs` file extension to indicate they are CommonJs modules.
+
+      To use ES Modules, either use files with `.mjs` file extension, or add a `package.json` in the project directory file with `"type": "module"` set. When using ES Modules, the functions should also be a default export (`export default transformer;`)
+
     arguments: |
       ###### string
       The file path to the referenced file, from the root of the project directory.
@@ -73,7 +79,7 @@ _ref:
       ###### Reference pages:
       ```yaml
       # lowdefy.yaml
-      lowdefy: '3.23.1'
+      lowdefy: '3.23.2'
       pages:
         - _ref: pages/page1.yaml
         - _ref: pages/page2.yaml
@@ -94,7 +100,7 @@ _ref:
       ```
       Returns:
       ```
-      lowdefy: '3.23.1'
+      lowdefy: '3.23.2'
       pages:
         - id: page1
           type: PageHeaderMenu
@@ -170,8 +176,8 @@ _ref:
 
       ```js
       // resolvers/useLocalOrSharedConfig.js
-      const fs = require('fs')
-      const path = require('path')
+      const fs = require('fs');
+      const path = require('path');
       const { promisify } = require('util');
 
       const readFilePromise = promisify(fs.readFile);
@@ -197,7 +203,7 @@ _ref:
 
       ```yaml
       // lowdefy.yaml
-      lowdefy: 3.23.1
+      lowdefy: 3.23.2
 
       cli:
         refResolver: resolvers/useLocalOrSharedConfig.js
@@ -223,10 +229,38 @@ _ref:
       ```
       ```yaml
       // lowdefy.yaml
-      lowdefy: 3.23.1
+      lowdefy: 3.23.2
 
       pages:
         - _ref:
             path: pages/page1.yaml
             transformer: transformers/addFooter.js
       ```
+      ###### Using ES Modules with `.mjs` file extension:
+
+      ```js
+      // resolvers/useLocalOrSharedConfig.mjs
+      import fs from 'fs';
+      import path from 'path';
+      import { promisify } from 'util';
+
+      const readFilePromise = promisify(fs.readFile);
+
+      async function useLocalOrSharedConfig(refPath, vars, context) {
+        let fileContent
+        try {
+          fileContent =  await readFilePromise(path.resolve(refPath), 'utf8');
+          return fileContent;
+        } catch (error) {
+          if (error.code === 'ENOENT') {
+            fileContent = readFilePromise(path.resolve('../shared', refPath), 'utf8');
+            return fileContent;
+          }
+          throw error;
+        }
+
+
+      }
+
+      export default useLocalOrSharedConfig;
+      ```

package/operators/_yaml.yaml

@@ -25,22 +25,36 @@ _ref:
       - name: parse
         types: |
           ```
-          (value: string): any
+          ({on: string, options?: object}): object
+          ([on: string, options?: object]): object
           ```
         description: |
           The `_yaml.parse` method parses a YAML string into an object.
         arguments: |
-          ###### string
-          The string to parse.
+          ###### object
+            - `on: string`: String to parse.
+            - `options?: object`: Optional settings. See the [YAML.parse: method here](https://eemeli.org/yaml/#parse-options) for supported settings.
+
         examples: |
           ###### Parse a YAML string:
           ```yaml
-          _yaml.parse: |
-            key: Value
-            boolean: true
-            array:
-              - 1
-              - 2
+          _yaml.parse:
+            on: |
+              key: Value
+              boolean: true
+              array:
+                - 1
+                - 2
+          ```
+          or:
+          ```yaml
+          _yaml.parse:
+            - |
+              key: Value
+              boolean: true
+              array:
+                - 1
+                - 2
           ```
           Returns:
           ```
@@ -61,17 +75,27 @@ _ref:
         arguments: |
           ###### object
             - `on: any`: The object to stringify.
-            - `options: object`: Optional settings. See the [YAML.dump method here](https://www.npmjs.com/package/js-yaml) for supported settings.
+            - `options?: object`: Optional settings. See the [YAML.stringify: method here](https://eemeli.org/yaml/#tostring-options) for supported settings.
 
         examples: |
           ###### Stringify an object as YAML:
           ```yaml
           _yaml.stringify:
-            key: Value
-            boolean: true
-            array:
-              - 1
-              - 2
+            on:
+              key: Value
+              boolean: true
+              array:
+                - 1
+                - 2
+          ```
+          or:
+          ```yaml
+          _yaml.stringify:
+            - key: Value
+              boolean: true
+              array:
+                - 1
+                - 2
           ```
           Returns (as a string):
           ```text