@lowdefy/docs 3.21.2-alpha.0 → 3.22.0

package/CHANGELOG.md

@@ -3,6 +3,64 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.22.0](https://github.com/lowdefy/lowdefy/compare/v3.22.0-alpha.1...v3.22.0) (2021-09-27)
+
+
+### Bug Fixes
+
+* **cli:** Use renderer served from blocks server url if configured. ([69d14b4](https://github.com/lowdefy/lowdefy/commit/69d14b4a862827beac955a5039df225af689f297)), closes [#840](https://github.com/lowdefy/lowdefy/issues/840)
+* **docs:** Fix AxiosHttp connection type spelling in docs. ([d9b53a0](https://github.com/lowdefy/lowdefy/commit/d9b53a034111bc65813d81c036376d05274ff6c7))
+
+
+### Features
+
+* Add `_array.reduce` examples. ([c9a6b50](https://github.com/lowdefy/lowdefy/commit/c9a6b50017c05774654388244b06076646449ce9))
+
+
+
+
+
+# [3.22.0-alpha.1](https://github.com/lowdefy/lowdefy/compare/v3.22.0-alpha.0...v3.22.0-alpha.1) (2021-09-20)
+
+
+### Bug Fixes
+
+* **docs:** Added CheckboxSwitch examples and CheckboxSelector note. ([9cf56bf](https://github.com/lowdefy/lowdefy/commit/9cf56bfbaa5c7a75c55d24d2f965ec351c1672e0))
+* **docs:** Added copyable and ellipsis config to Title block. ([9f8632e](https://github.com/lowdefy/lowdefy/commit/9f8632ec577196ea45471470a9dd13d3dbc09446))
+* **docs:** Change npx commands to specific versions for deployments. ([f2c380b](https://github.com/lowdefy/lowdefy/commit/f2c380b07a78defff79281d5c07c61a718bfe750))
+* **docs:** Convert CLI commands to npx commands. ([c9cd643](https://github.com/lowdefy/lowdefy/commit/c9cd643f3809fdc0cde7ba47e17e392b3236c17b))
+* **docs:** Update CLI npm install docs. ([98a8b71](https://github.com/lowdefy/lowdefy/commit/98a8b71ff2ef961ccfcb8b94e115b4162881dd38))
+
+
+### Features
+
+* **docs:** Add _get operator switch example. ([b727b9e](https://github.com/lowdefy/lowdefy/commit/b727b9edd0f37d3d10d5add32cbd9411fa4b6f98))
+* **docs:** Added CheckboxSwitch docs. ([81752aa](https://github.com/lowdefy/lowdefy/commit/81752aa927f1d6050a290440ca15a87c05f3ea51))
+
+
+
+
+
+# [3.22.0-alpha.0](https://github.com/lowdefy/lowdefy/compare/v3.21.2...v3.22.0-alpha.0) (2021-09-08)
+
+
+### Features
+
+* **docs:** Add Stripe documentation. ([ed963ec](https://github.com/lowdefy/lowdefy/commit/ed963ec823ef19e88ed8320d71b83a7eef2e6cfe))
+* **docs:** Added Password Input block docs. ([ee8bda4](https://github.com/lowdefy/lowdefy/commit/ee8bda4a5bd6248c03433a720652d72c3b9ddbae))
+
+
+
+
+
+## [3.21.2](https://github.com/lowdefy/lowdefy/compare/v3.21.2-alpha.0...v3.21.2) (2021-08-31)
+
+**Note:** Version bump only for package @lowdefy/docs
+
+
+
+
+
 ## [3.21.2-alpha.0](https://github.com/lowdefy/lowdefy/compare/v3.21.1...v3.21.2-alpha.0) (2021-08-31)
 
 

package/actions/JsAction.yaml

@@ -66,7 +66,7 @@ _ref:
       ```yaml
       # lowdefy.yaml
       name: intercom-example
-      lowdefy: '3.21.1'
+      lowdefy: '3.22.0'
       app:
         html:
           appendBody: |
@@ -137,7 +137,7 @@ _ref:
       ```yaml
       # file: lowdefy.yaml
       name: text-highlight-example
-      lowdefy: '3.21.1'
+      lowdefy: '3.22.0'
       app:
         html:
           # Load the custom modules into the index.html head tag.

package/blocks/display/Title.yaml

@@ -20,11 +20,13 @@ _ref:
     schema: ../blocks/blocksAntd/src/blocks/Title/Title.json
     filePath: blocks/display/Title.yaml
     init_state_values:
+      __type_block.properties.copyable: boolean
+      __type_block.properties.ellipsis: boolean
+      __boolean_block.properties.copyable: false
+      __boolean_block.properties.ellipsis: false
       __type_block.properties.value: number
       __number_block.properties.value: 33.3
     init_property_values:
       content: A title block.
     description_content: |
       A title component. Corresponds to html h1, h2, h3 and h4 elements.
-
-      

package/blocks/input/CheckboxSwitch.yaml

@@ -0,0 +1,56 @@
+# Copyright 2020-2021 Lowdefy, Inc
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+_ref:
+  path: templates/blocks/template.yaml.njk
+  vars:
+    block_type: CheckboxSwitch
+    value_type: any[]
+    category: input
+    schema: ../blocks/blocksAntd/src/blocks/CheckboxSwitch/CheckboxSwitch.json
+    filePath: blocks/input/CheckboxSwitch.yaml
+    description_content: |
+      The `CheckboxSwitch` block allows a user to select a boolean value between (true/false).
+
+      > A similar switch block is `Switch`. Alternatively the `CheckboxSelector` can be used to list multiple options.
+    examples:
+      - title: Checkbox only
+        block:
+          id: checkbox_example
+          type: CheckboxSwitch
+          properties:
+            label:
+              disabled: true
+      - title: Description only
+        block:
+          id: description_example
+          type: CheckboxSwitch
+          properties:
+            description: Option
+      - title: Description and label
+        block:
+          id: description_label_example
+          type: CheckboxSwitch
+          properties:
+            description: Option
+            label:
+              title: Label
+      - title: Agree to terms and conditions
+        block:
+          id: terms_example
+          type: CheckboxSwitch
+          properties:
+            description: I agree to the terms and conditions and privacy policy as found on the website.... Thoroughly I agree to the terms and conditions and privacy policy as found on the website....
+            label:
+              disabled: true

package/blocks/input/PasswordInput.yaml

@@ -0,0 +1,48 @@
+# Copyright 2020-2021 Lowdefy, Inc
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+_ref:
+  path: templates/blocks/template.yaml.njk
+  vars:
+    block_type: PasswordInput
+    value_type: string
+    category: input
+    schema: ../blocks/blocksAntd/src/blocks/PasswordInput/PasswordInput.json
+    filePath: blocks/input/PasswordInput.yaml
+    description_content: |
+      The `PasswordInput` block is a single line password input.
+
+    examples:
+      - title: Required password input
+        block:
+          id: required_example
+          type: PasswordInput
+          required: true
+          properties:
+            title: Required password input
+      - title: Placeholder
+        block:
+          id: placeholder_example
+          type: PasswordInput
+          properties:
+            placeholder: Placeholder
+      - title: Password
+        block:
+          id: password
+          type: PasswordInput
+          properties:
+            title: Password
+            placeholder: Your password
+            label:
+              span: 6

package/concepts/cli.yaml

@@ -38,7 +38,15 @@ _ref:
             npx lowdefy@version <command>
             ```
 
-            Alternative, you can install the CLI globally or to a npm project (with a `package.json` file) via npm. The CLI can then be used using `lowdefy` as the executable name:
+            Alternative, you can install the CLI globally or to a npm project (with a `package.json` file) via npm or yarn.
+
+            To install the CLI globally run:
+
+            ```
+            npm install lowdefy -g
+            ```
+
+            The CLI can then be run using `lowdefy` as the executable name:
 
             ```
             lowdefy <command>
@@ -90,12 +98,12 @@ _ref:
 
             Run the dev server, watching a relative directory for file changes:
             ```txt
-            lowdefy dev --watch ../other-project
+            npx lowdefy@latest dev --watch ../other-project
             ```
 
             Run the dev server, ignoring the public directory:
             ```txt
-            lowdefy dev --watch-ignore public/**
+            npx lowdefy@latest dev --watch-ignore public/**
             ```
 
             # Configuration
@@ -154,6 +162,8 @@ _ref:
               - `@lowdefy/blocks-markdown` to be hosted at `{BLOCK_SERVER_URL}/blocks-markdown/`.
               - `@lowdefy/blocks-echarts` to be hosted at `{BLOCK_SERVER_URL}/blocks-echarts/`.
 
+            If you wish to run the CLI dev server, the `@lowdefy/renderer` package build artifacts (located in the `dist` directory) should also be served from `{BLOCK_SERVER_URL}/renderer/`.
+
       - _ref:
           path: templates/navigation_buttons.yaml
           vars:

package/concepts/custom-blocks.yaml

@@ -45,7 +45,7 @@ _ref:
 
             ```yaml
             name: dashboard-app
-            lowdefy: 3.21.1
+            lowdefy: 3.22.0
             types:
               AmChartsXY:
                 url: https://blocks-cdn.lowdefy.com/v3.10.1/blocks-amcharts/meta/AmChartsXY.json
@@ -95,7 +95,7 @@ _ref:
 
             ```yaml
             name: dashboard-app
-            lowdefy: 3.21.1
+            lowdefy: 3.22.0
             types:
               MyCustomBlock:
                 url: http://localhost:3002/meta/MyCustomBlock.json

package/concepts/custom-code.yaml

@@ -53,7 +53,7 @@ _ref:
 
             ```yaml
             name: google-analytics-example
-            lowdefy: 3.21.1
+            lowdefy: 3.22.0
             # ...
             app:
               html:
@@ -98,7 +98,7 @@ _ref:
             ```yaml
             # /lowdefy.yaml
             name: json-todos
-            lowdefy: 3.21.1
+            lowdefy: 3.22.0
             app:
               html:
                 appendHead:
@@ -156,7 +156,7 @@ _ref:
             ```yaml
             # /lowdefy.yaml
             name: operator-example
-            lowdefy: 3.21.1
+            lowdefy: 3.22.0
             app:
               html:
                 appendHead:

package/connections/AxiosHttp.yaml

@@ -24,7 +24,7 @@ _ref:
         type: MarkdownWithCode
         properties:
           content: |
-            The `AxiosHTTP` connection is used to connect to APIs and web servers using HTTP or HTTPS.
+            The `AxiosHttp` connection is used to connect to APIs and web servers using HTTP or HTTPS.
 
             It uses the [axios](https://github.com/axios/axios) library.
 
@@ -35,14 +35,14 @@ _ref:
             ## Connections
 
             Connection types:
-              - AxiosHTTP
+              - AxiosHttp
 
             ## Requests
 
             Request types:
-              - AxiosHTTP
+              - AxiosHttp
 
-            ### AxiosHTTP
+            ### AxiosHttp
 
             #### Properties
 
@@ -88,7 +88,7 @@ _ref:
             ###### A basic full example requesting data from https://jsonplaceholder.typicode.com
 
             ```yaml
-            lowdefy: 3.21.1
+            lowdefy: 3.22.0
             name: Lowdefy starter
             connections:
               - id: my_api

package/connections/Stripe.yaml

@@ -0,0 +1,139 @@
+# Copyright 2020-2021 Lowdefy, Inc
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+_ref:
+  path: templates/general.yaml.njk
+  vars:
+    pageId: Stripe
+    pageTitle: Stripe
+    section: Connections
+    filePath: connections/Stripe.yaml
+    content:
+      - id: markdown
+        type: MarkdownWithCode
+        properties:
+          content: |
+            ## Connections
+
+            Connection types:
+              - Stripe
+
+            ### Stripe
+
+            [Stripe](https://stripe.com/) is a popular payment provider which allows you to accept payments, send payouts, and manage your business online.
+            The `Stripe` connector uses the official [Node.js client from Stripe](https://github.com/stripe/stripe-node).
+            In order to use the `Stripe` connection, you first need to create a [Stripe](https://stripe.com/) account and setup an API key.
+
+            > Secrets like API keys should be stored using the [`_secret`](operators/secret.md) operator.
+
+            #### Properties
+            - `secretKey: string`: __Required__ - Stripe [secret key](https://stripe.com/docs/keys).
+            - `apiVersion: string`: Stripe API version to use. Defaults to the account-wide version.
+            - `timeout: number`: Timeout for requests to the Stripe API.
+            - `maxNetworkRetries: number`: Maximum number of times failed requests are repeated before throwing an error.
+            - `telemetry: boolean`: Whether to send telemetry data to Stripe (this is forwarded to the Stripe client library. Lowdefy does not receive any telemetry data from your Stripe connection.)
+
+            #### Examples
+
+            ###### Simple connection:
+            ```yaml
+            connections:
+              - id: stripe
+                type: Stripe
+                properties:
+                  secretKey:
+                    _secret: STRIPE_SECRET_KEY
+            ```
+            Environment variables:
+            ```
+            LOWDEFY_SECRET_STRIPE_SECRET_KEY = sk_test_KyvNyie...
+            ```
+
+            ###### Using an older API version:
+            ```yaml
+            connections:
+              - id: stripe
+                type: Stripe
+                properties:
+                  secretKey:
+                    _secret: STRIPE_SECRET_KEY
+                  apiVersion: 2017-12-14
+            ```
+            Environment variables:
+            ```
+            LOWDEFY_SECRET_STRIPE_SECRET_KEY = sk_test_KyvNyie...
+            ```
+
+            ## Requests
+
+            Request types:
+              - StripeRequest
+
+            ### StripeRequest
+
+            The `StripeRequest` request allows calls to all modules supported by the [Stripe API client](https://stripe.com/docs/api?lang=node) by nesting the resource and method calls:
+            ```yaml
+            resource:
+              method:
+                - parameter1
+                - parameter2
+            ```
+
+            #### Properties
+            - `{{ apiResource }}: object`: A Stripe API resource, eg. `customers`.
+              - `{{ method }}: array | null`: A resource method, eg. `create`. The arguments array will be passed on to the client method.
+
+            The Stripe client exposes all resources as objects, with the API methods being available as function properties on those resource objects.
+            In Lowdefy, you may access these properties by nesting them.
+
+            ### Examples
+
+            ###### List the 30 most recent customers
+            ```yaml
+            requests:
+              - id: list_customers
+                type: StripeRequest
+                connectionId: stripe
+                properties:
+                  customers:
+                    list:
+                      limit: 30
+            ```
+
+            ###### Create a payment intent
+            ```yaml
+            requests:
+              - id: create_payment_intent
+                type: StripeRequest
+                connectionId: stripe
+                properties:
+                  paymentIntents:
+                    create:
+                      - amount: 2000
+                        currency: eur
+                        payment_method_types: [ card ]
+            ```
+
+            ###### Retrieve a checkout session by ID
+            ```yaml
+            requests:
+              - id: retrieve_checkout_session
+                type: StripeRequest
+                connectionId: stripe
+                properties:
+                  checkout:
+                    sessions:
+                      retrieve:
+                        - cs_test_onpT2icY2lrSU0IgDGXEhhcOHcWeJS5BpLcQGMx0uI9TZHLMBdzvWpvx
+            ```

package/deployment/aws-lambda.yaml

@@ -55,10 +55,10 @@ _ref:
             COPY  --chown=node:node  . .
 
             # Build the Lowdefy config using the Lowdefy CLI
-            RUN npx lowdefy@latest build
+            RUN npx lowdefy@3.22.0 build
 
             # Use the correct Lowdefy base image
-            FROM lowdefy/lowdefy-aws-lambda:3.21.1
+            FROM lowdefy/lowdefy-aws-lambda:3.22.0
 
             # Copy build output from build stage
             COPY --from=build /home/node/lowdefy/.lowdefy/build ./build

package/deployment/docker.yaml

@@ -65,10 +65,10 @@ _ref:
             COPY  --chown=node:node  . .
 
             # Build the Lowdefy config using the Lowdefy CLI
-            RUN npx lowdefy@latest build
+            RUN npx lowdefy@3.22.0 build
 
             # Use the correct Lowdefy base image
-            FROM lowdefy/lowdefy:3.21.1
+            FROM lowdefy/lowdefy:3.22.0
 
             # Copy build output from build stage
             COPY --from=build --chown=node:node /home/node/lowdefy/.lowdefy/build ./build

package/deployment/netlify.yaml

@@ -46,7 +46,7 @@ _ref:
 
             Configure your Netlify deployment.
 
-            - Set your build command to `npx lowdefy@latest build-netlify`.
+            - Set your build command to `npx lowdefy@3 build-netlify`.
             - Set your publish directory to `.lowdefy/publish`.
 
             #### Step 4

package/lowdefy.yaml

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

package/menus.yaml

@@ -201,6 +201,9 @@
         - id: CheckboxSelector
           type: MenuLink
           pageId: CheckboxSelector
+        - id: CheckboxSwitch
+          type: MenuLink
+          pageId: CheckboxSwitch
         - id: ChromeColorSelector
           type: MenuLink
           pageId: ChromeColorSelector
@@ -240,6 +243,9 @@
         - id: ParagraphInput
           type: MenuLink
           pageId: ParagraphInput
+        - id: PasswordInput
+          type: MenuLink
+          pageId: PasswordInput
         - id: RadioSelector
           type: MenuLink
           pageId: RadioSelector
@@ -510,6 +516,9 @@
         - id: SQLite
           type: MenuLink
           pageId: SQLite
+        - id: Stripe
+          type: MenuLink
+          pageId: Stripe
     - id: actions
       type: MenuGroup
       properties:
@@ -751,11 +760,16 @@
         title: Lowdefy Versions
         icon: BranchesOutlined
       links:
-        - id: v3.21.1
+        - id: v3.22.0
           type: MenuLink
           url: https://docs.lowdefy.com
           properties:
-            title: v3.21.1
+            title: v3.22.0
+        - id: v3.21.2
+          type: MenuLink
+          url: https://612e10d3dc02710008646251--lowdefy-docs.netlify.app/introduction
+          properties:
+            title: v3.21.2
         - id: v3.20.4
           type: MenuLink
           url: https://6121f02416ea332ef213ab7d--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.21.1'
+      lowdefy: '3.22.0'
       app:
         html:
           appendHead: |

package/operators/_array.yaml

@@ -198,6 +198,54 @@ _ref:
           ```
         description: |
           The `_array.reduce` method [executes a reducer function on each element of the array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/Reduce), resulting in single output value.
+        examples: |
+          The simplest example would probably be adding all the elements in an array:
+          ```yaml
+          sum:
+            _array.reduce:
+              on: [1, 2, 3, 4]
+              callback:
+                _function:
+                  __sum:
+                    - __args: 0
+                    - __args: 1
+          ```
+          This will return `sum: 10`
+
+          You can start off by counting from 10 by specifying an `initialValue` for the reducer:
+          ```yaml
+          sum:
+            _array.reduce:
+              on: [1, 2, 3, 4]
+              callback:
+                _function:
+                  __sum:
+                    - __args: 0
+                    - __args: 1
+              initialValue: 10
+          ```
+          This will return `sum: 20`
+
+          You can use the index of the array element to add some logic to your `callback`. For instance, when you reach index 2 of your array (the 3rd entry), add 100 instead of the current element value:
+          ```yaml
+          sum:
+            _array.reduce:
+              on: [1, 2, 3, 4]
+              callback:
+                _function:
+                  __sum:
+                    - __args: 0
+                    - __if:
+                        test:
+                          __eq:
+                            - __args: 2
+                            - 2
+                        then: 100
+                        else:
+                          __args: 1
+          ```
+          This will return `sum: 107`
+
       - name: reduceRight
         types: |
           ```

package/operators/_get.yaml

@@ -47,6 +47,21 @@ _ref:
       ```
       Returns: `"George"`.
 
+      ###### Use _get to as a switch statement to choose an Icon name:
+      ```yaml
+      _get:
+        key:
+          _state: status
+        from:
+          new: PlusCircleTwoTone
+          escalated: ExclamationCircleOutlined
+          investigation_started: ToolTwoTone
+          client_contacted: SoundTwoTone
+          awaiting_confirmation: LikeOutlined
+          closed: StopOutlined
+      ```
+      Returns: The icon corresponding to the status in state.
+
       ###### Get from an array (arrays are `0` indexed):
       ```yaml
       _get:

package/operators/_js.yaml

@@ -51,7 +51,7 @@ _ref:
           ```yaml
           # lowdefy.yaml
           name: make-me-primes
-          lowdefy: '3.21.1'
+          lowdefy: '3.22.0'
           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.21.1'
+          lowdefy: '3.22.0'
           app:
             html:
               appendHead: