@lowdefy/docs 3.23.2 → 4.0.0-alpha.10

package/operators/_gte.yaml

@@ -1,65 +0,0 @@
-# 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/operators.yaml.njk
-  transformer: templates/operatorsMethodTransformer.js
-  vars:
-    pageId: _gte
-    pageTitle: _gte
-    filePath: operators/_gte.yaml
-    types: |
-      ```
-      ([value1: any, value2: any]): boolean
-      ```
-    description: |
-      The `_gte` operator tests if the first value is greater than or equal to the second equal. It takes an array of two values to test.
-
-      > The `_gte` operator tests using the javascript greater than or equal operator. You can find a description of the algorithm used to compare two values [here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Less_than).
-
-    arguments: |
-      ###### array
-      An array of two values to compare.
-    examples: |
-      ###### Two numbers:
-      ```yaml
-      _gte:
-        - 4
-        - 3
-      ```
-      Returns: `true`
-
-      ```yaml
-      _gte:
-        - 1
-        - 1
-      ```
-      Returns: `true`
-
-      ```yaml
-      _gte:
-        - _sum:
-            - 3
-            - 4
-        - 8
-      ```
-      Returns: `false`
-
-      ###### Two strings:
-      ```yaml
-      _gte:
-        - "a"
-        - "b"
-      ```
-      Returns: `false`

package/operators/_hash.yaml

@@ -1,109 +0,0 @@
-# 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/operators.yaml.njk
-  transformer: templates/operatorsMethodTransformer.js
-  vars:
-    pageId: _hash
-    pageTitle: _hash
-    filePath: operators/_hash.yaml
-    env: Server Only
-    description: |
-      The `_hash` operator generates hashes using various algorithms.
-    methods:
-      - name: md5
-        types: |
-          ```
-          (value: string): string
-          ```
-        description: |
-          The `_hash.md5` method generates the [MD5](https://en.wikipedia.org/wiki/MD5) hash of the input value.
-        arguments: |
-          ###### string
-          The string to hash.
-        examples: |
-          ###### Hash a string:
-          ```yaml
-          _hash.md5: Hello World!
-          ```
-          Returns: `"ed076287532e86365e841e92bfc50d8c"`.
-
-      - name: sha1
-        types: |
-          ```
-          (value: string): string
-          ```
-        description: |
-          The `_hash.sha1` method generates the [SHA1](https://en.wikipedia.org/wiki/SHA1) hash of the input value.
-        arguments: |
-          ###### string
-          The string to hash.
-        examples: |
-          ###### Hash a string:
-          ```yaml
-          _hash.sha1: Hello World!
-          ```
-          Returns: `"2ef7bde608ce5404e97d5f042f95f89f1c232871"`.
-
-      - name: sha256
-        types: |
-          ```
-          (value: string): string
-          ```
-        description: |
-          The `_hash.sha256` method generates the [SHA256](https://en.wikipedia.org/wiki/SHA256) hash of the input value.
-        arguments: |
-          ###### string
-          The string to hash.
-        examples: |
-          ###### Hash a string:
-          ```yaml
-          _hash.sha256: Hello World!
-          ```
-          Returns: `"7f83b1657ff1fc53b92dc18148a1d65dfc2d4b1fa3d677284addd200126d9069"`.
-
-      - name: sha512
-        types: |
-          ```
-          (value: string): string
-          ```
-        description: |
-          The `_hash.sha512` method generates the [SHA512](https://en.wikipedia.org/wiki/SHA512) hash of the input value.
-        arguments: |
-          ###### string
-          The string to hash.
-        examples: |
-          ###### Hash a string:
-          ```yaml
-          _hash.sha512: Hello World!
-          ```
-          Returns: `"861844d6704e8573fec34d967e20bcfef3d424cf48be04e6dc08f2bd58c729743371015ead891cc3cf1c9d34b49264b510751b1ff9e537937bc46b5d6ff4ecc8"`.
-
-      - name: ripemd160
-        types: |
-          ```
-          (value: string): string
-          ```
-        description: |
-          The `_hash.ripemd160` method generates the [RIPEMD-160](https://en.wikipedia.org/wiki/RIPEMD160) hash of the input value.
-        arguments: |
-          ###### string
-          The string to hash.
-        examples: |
-          ###### Hash a string:
-          ```yaml
-          _hash.ripemd160: Hello World!
-          ```
-          Returns: `"8476ee4631b9b30ac2754b0ee0c47e161d3f724c"`.

package/operators/_if.yaml

@@ -1,44 +0,0 @@
-# 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/operators.yaml.njk
-  transformer: templates/operatorsMethodTransformer.js
-  vars:
-    pageId: _if
-    pageTitle: _if
-    filePath: operators/_if.yaml
-    types: |
-      ```
-      (arguments: {test: boolean, then: any, else: any}): any
-      ```
-    description: |
-      The `_if` operator returns the `then` argument if it's `test` argument is `true`, and it's `else` argument if it is `false`. Generally other operators are used to evaluate the `test` argument.
-    arguments: |
-      ###### object
-        - `test: boolean`: The boolean result of a test.
-        - `then: any`: The value to return if the test is `true`.
-        - `else: any`: The value to return if the test is `false`.
-    examples: |
-      ###### Return a value based on a user input:
-      ```yaml
-      _if:
-        test:
-          _eq:
-            - _state: text_input
-            - The password
-        then: The user entered the password
-        else: Access denied
-      ```
-      Returns: `"The user entered the password"` if the text input's value is `"The password"`, else `"Access denied"`

package/operators/_if_none.yaml

@@ -1,61 +0,0 @@
-# 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/operators.yaml.njk
-  transformer: templates/operatorsMethodTransformer.js
-  vars:
-    pageId: _if_none
-    pageTitle: _if_none
-    filePath: operators/_if_none.yaml
-    types: |
-      ```
-      ([value: any, replacement: any]): any
-      ```
-    description: |
-      The `_if_none` operator replaces the input value with an alternative if the value is of a "none-type" like `null` or `undefined`.
-    arguments: |
-      ###### array
-      - First value: The value to test.
-      - Second value: The replacement.
-    examples: |
-      ###### The value is not replaced if it is not of a none-type:
-      ```yaml
-      _if_none:
-        - Value
-        - Replacement
-      ```
-      Returns: `Value`
-
-      ###### The value is replaced if it is of a none-type:
-      ```yaml
-      _if_none:
-        - null
-        - "Replacement"
-      ```
-      Returns: `"Replacement"`
-
-      ```yaml
-      _if_none:
-        - _state: does_not_exist # Value in state that does not exist
-        - "Replacement"
-      ```
-      Returns: `"Replacement"`
-
-       ```yaml
-      _if_none:
-        - _request: still_loading # _request returns null if the request is loading
-        - []
-      ```
-      Returns: `[]`

package/operators/_index.yaml

@@ -1,64 +0,0 @@
-# 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/operators.yaml.njk
-  transformer: templates/operatorsMethodTransformer.js
-  vars:
-    pageId: _index
-    pageTitle: _index
-    filePath: operators/_index.yaml
-    types: |
-      ```
-      (key: string): any
-      (key: integer): any
-      (all: boolean): any
-      (arguments: {
-        all?: boolean,
-        key?: string | integer,
-        default?: any
-      }): any
-      ```
-    description: |
-      The `_index` operator gets a value from the `list indices` array of a block. The `list indices` array is an array of the indices of all [`list`](/lists) block areas which the block is a part of.
-    arguments: |
-      ###### integer
-      If the `_index` operator is called with a integer argument, the value at that index in the `indices` array is returned. If the value is not found, `null` is returned..
-
-      ###### string
-      If the `_args` operator is called with a string argument, the value at that index in the `indices` array is returned. If the value is not found, `null` is returned.
-
-      ###### boolean
-      If the `_index` operator is called with boolean argument `true`, the entire `indices` array is returned.
-
-      ###### object
-        - `all: boolean`: If `all` is set to `true`, the entire `indices` array is returned. One of `all` or `key` are required.
-        - `key: string | integer`: The value of the index in the `indices` array is returned. If the value is not found, `null`, or the specified default value is returned. One of `all` or `key` are required.
-        - `default: any`: A value to return if the `key` is not found in `arguments`. By default, `null` is returned if a value is not found.
-    examples: |
-      ###### Get a index:
-
-      Assuming the block is in the fourth content area of a `list` block.
-      ```yaml
-      _index: 0
-      ```
-      Returns: `3`
-
-      ###### Get all indices:
-
-      Assuming two nested list blocks, with the block in the fourth content area of the first `list` block, and the first content area of the nested `list` block.
-      ```yaml
-      _index: true
-      ```
-      Returns: `[3, 0]`

package/operators/_input.yaml

@@ -1,113 +0,0 @@
-# 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/operators.yaml.njk
-  transformer: templates/operatorsMethodTransformer.js
-  vars:
-    pageId: _input
-    pageTitle: _input
-    filePath: operators/_input.yaml
-    types: |
-      ```
-      (key: string): any
-      (all: boolean): any
-      (arguments: {
-        all?: boolean,
-        key?: string,
-        default?: any,
-        contextId?: string
-      }): any
-      ```
-    description: |
-      The `_input` operator gets a value from the [`input`](/context-and-state) object. The `input` is a data object that can be set when linking to a new page using the [`Link`](/link) action, and can be used to set data like a `id` when switching to a new page. Unlike `urlQuery`, the `input` is not visible, and cannot be changed by the user, but if the page is reloaded, the `input` is lost. By default, `_input` accesses the `input` object from the [`context`](/context-and-state) the operator is used in, but a different context can be specified.
-
-    arguments: |
-      ###### string
-      If the `_input` operator is called with a string argument, the value of the key in the `input` object is returned. If the value is not found, `null` is returned. Dot notation and [block list indexes](/lists) are supported.
-
-      ###### boolean
-      If the `_input` operator is called with boolean argument `true`, the entire `input` object is returned.
-
-      ###### object
-        - `all: boolean`: If `all` is set to `true`, the entire `input` object is returned. One of `all` or `key` are required.
-        - `key: string`: The value of the key in the `input` object is returned. If the value is not found, `null`, or the specified default value is returned. Dot notation and [block list indexes](/lists) are supported. One of `all` or `key` are required.
-        - `default: any`: A value to return if the `key` is not found in `input`. By default, `null` is returned if a value is not found.
-        - `contextId: string`: The id of a `context`. Setting this will get the value from the `input` of the specified context. A list of `contexts` that exist are returned by the [`_list_contexts`](/_list_contexts) operator. Cannot be used in `connections` or `requests`.
-    examples: |
-      ###### Get the value of `my_key` from `input`:
-      ```yaml
-      _input: my_key
-      ```
-      ```yaml
-      _input:
-        key: my_key
-      ```
-      Returns: The value of `my_key` in `input`.
-
-      ###### Get the entire `input` object:
-      ```yaml
-      _input: true
-      ```
-      ```yaml
-      _input:
-        all: true
-      ```
-      Returns: The entire `input` object.
-
-      ###### Dot notation:
-      Assuming input:
-      ```yaml
-      my_object:
-        subfield: 'Value'
-      ```
-      then:
-      ```yaml
-      _input: my_object.subfield
-      ```
-      ```yaml
-      _input:
-        key: my_object.subfield
-      ```
-      Returns: `"Value"`.
-
-      ###### Return a default value if the value is not found:
-      ```yaml
-      _input:
-        key: might_not_exist
-        default: Default value
-      ```
-      Returns: The value of `might_not_exist`, or `"Default value"`.
-
-      ###### Block list indices:
-      Assuming `input`:
-      ```yaml
-      my_array:
-        - value: 0
-        - value: 1
-        - value: 2
-      ```
-      then:
-      ```yaml
-      _input: my_array.$.value
-      ```
-      Returns: `0` when used from the first block (0th index) in a list.
-
-      ###### Get a value from another `context`:
-      ```yaml
-      _input:
-        key: my_key
-        contextId: 'pageId:contextId:{}'
-      ```
-      Returns: The value of `my_key` in `input` in context `contextId` on page `pageId`.

package/operators/_js.yaml

@@ -1,189 +0,0 @@
-# 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/operators.yaml.njk
-  transformer: templates/operatorsMethodTransformer.js
-  vars:
-    pageId: _js
-    pageTitle: _js
-    filePath: operators/_js.yaml
-    env: Client Only
-    warning: |
-      SECURITY WARNING: The _js operator executes JavaScript inside your Lowdefy app. Insecure code can expose your app or data. Since Lowdefy doesn't validate your JavaScript, make sure that you only load trusted code.
-    types: |
-      ```
-      (args: any[]): any
-      ```
-    description: |
-      The `_js` operator executes a JavaScript function when the operator is evaluated. If used in a block, this function is called every time the Lowdefy engine checks if any block on the page should be updated. This function must be synchronous, and it is highly recommended that it is a pure function (it always returns the same result for the same input, and does not have side effects). Since it is called often it should also execute quickly, a slow operator will slow down the entire app. The [`JsAction`](/JsAction) action can be used to execute asynchronous code when an event is triggered.
-
-      To use the `_js` operator the following is needed:
-
-      - Load the custom JavaScript into the app `head` tag. See the [Custom Code](/custom-code) section for more details.
-      - In the custom JavaScript, pass the JavaScript operator function to the app using the `window.lowdefy.registerJsOperator(name: string, operatorFunction: function)` method.
-      - A list of arguments can be passed to the JavaScript function which will be spread as function parameters.
-      - The returned value of the custom JavaScript function will be the operator result.
-
-    methods:
-      - name: '{{ method_name }}'
-        types: |
-          ```
-          (args?: any[]): any
-          ```
-        description: |
-          The `_js.{{ method_name }}` method evaluates the JavaScript function as registered using `window.lowdefy.registerJsOperator(method_name: string, method: function)`. When passing a list of arguments to the JavaScript function, then list of arguments will be spread as function parameters.
-
-          The loaded JavaScript function must be a synchronous pure function. See the [Custom JavaScript](/custom-javascript) section for more detail on how to load custom JavaScript operators.
-        examples: |
-          ##### A custom JavaScript operator to calculate primes:
-          ```yaml
-          # lowdefy.yaml
-          name: make-me-primes
-          lowdefy: '3.23.2'
-          app:
-            html:
-              # This HTML will be appended to the head HTML tag in the Lowdefy app
-              appendHead: |
-                <script type="text/javascript">
-                  // Define the JavaScript function.
-                  function makePrimes(to) {
-                    return [...Array((to || 1)-1).keys()].map(i=>i+2).filter(n =>
-                    [...Array(n-2).keys()].map(i=>i+2).reduce((acc,x)=> acc && n % x !== 0, true));
-                  }
-                  // Register the JavaScript operator function.
-                  window.lowdefy.registerJsOperator('makePrimes', makePrimes);
-                </script>
-          pages:
-            - id: home
-              type: PageHeaderMenu
-              blocks:
-                - id: num_of_primes
-                  type: NumberInput
-                  properties:
-                    title: Give me all the primes below?
-                - id: primes
-                  type: Markdown
-                  properties:
-                    content:
-                      _nunjucks:
-                        template: |
-                          All primes below {{ num_of_primes }} is: {{ primes }}
-                        on:
-                          num_of_primes:
-                            _state: num_of_primes
-                          primes:
-                            # Use the custom JavaScript operator.
-                            _js.makePrimes:
-                              - _state: num_of_primes
-          ````
-
-          ##### _js.function to create a label.formatter function for an EChart block:
-
-          Create a JavaScript file which are hosted publicly. The `public` folder in your Lowdefy app makes this easy. Also check to register the custom operator using `window.lowdefy.registerJsOperator`.
-          ```js
-          // file: /public/getLabel.js
-          const getLabel = (levelTwo, levelThree, levelFour) => (param) => {
-            var depth = param.treePathInfo.length;
-            if (depth === 2) {
-                return levelTwo;
-            }
-            else if (depth === 3) {
-                return levelThree;
-            }
-            else if (depth === 4) {
-                return levelFour;
-            }
-          }
-          window.lowdefy.registerJsOperator('getLabel', getLabel);
-          ```
-
-          Load the JavaScript by referencing it into the Lowdefy application HTML `head` tag.
-          ```html
-          // file: imports.html
-          <script type="text/javascript" src="/public/getLabel.js"></script>
-          ```
-
-          Use the `_js.getLabel` operator
-          ```yaml
-          # file: lowdefy.yaml
-          name: my-chart
-          lowdefy: '3.23.2'
-          app:
-            html:
-              appendHead:
-                _ref: imports.html # Loading html content into the application head tag.
-          pages:
-            - id: home
-              type: PageHeaderMenu
-              blocks:
-                - id: chart
-                  type: EChart
-                  properties:
-                    height: 600
-                    option:
-                      series:
-                        - radius:
-                            - '15%'
-                            - '80%'
-                          type: 'sunburst'
-                          sort: null
-                          emphasis:
-                            focus: 'ancestor'
-                          data:
-                            - value: 8,
-                              children:
-                                - value: 4,
-                                  children:
-                                    - value: 2
-                                    - value: 1
-                                    - value: 1
-                                    - value: 0.5
-                                - value: 2
-                            - value: 4
-                              children:
-                                - children:
-                                    - value: 2
-                            - value: 4
-                              children:
-                                - children:
-                                    - value: 2
-                            - value: 3
-                              children:
-                                - children:
-                                    - value: 1
-                          label:
-                            color: '#000'
-                            textBorderColor: '#fff'
-                            textBorderWidth: 2
-                            formatter:
-                              _js.getLabel: # Use the getLabel function
-                                - 'radial'
-                                - 'tangential'
-                                - 'other'
-                          levels:
-                            - {}
-                            - itemStyle:
-                                color: '#CD4949'
-                              label:
-                                rotate: 'radial'
-                            - itemStyle:
-                                color: '#F47251'
-                              label:
-                                rotate: 'tangential'
-                            - itemStyle:
-                                color: '#FFC75F'
-                              label:
-                                rotate: 0
-          ````