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

package/operators/_actions.yaml

@@ -1,123 +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: _actions
-    pageTitle: _actions
-    filePath: operators/_actions.yaml
-    env: Client Only
-    types: |
-      ```
-      (key: string): any
-      (all: boolean): any
-      (arguments: {
-        all?: boolean,
-        key?: string,
-        default?: any,
-      }): any
-      ```
-    description: |
-      The `_actions` operator returns the response value for a preceding action in the same event list.
-
-      The action response object has the following structure:
-      ```yaml
-      error: Error,
-      index: number,
-      response: any,
-      skipped: boolean,
-      type: string,
-      ```
-    arguments: |
-      ###### string
-      If the `_actions` operator is called with a string equal to a preceding action id in the same event list, the action response object returned. If a string is passed which does not match preceding action id in the same event list, `null` is returned. Dot notation is supported.
-
-      ###### boolean
-      If the `_actions` operator is called with boolean argument `true`, an object with all the preceding action id responses in the same event list is returned.
-
-    examples: |
-      ##### Using a action response:
-      ```yaml
-      _actions: my_action.response
-      ```
-      Returns: The response returned by the action.
-
-      ##### Setting a action response to `state`:
-      ```yaml
-      id: refresh
-      type: Button
-      events:
-        onClick:
-          - id: get_fresh_data
-            type: Request
-            skip:
-              _state: should_not_fetch
-            params: get_data
-          - id: set_data
-            type: SetState
-            params:
-              did_not_fetch_data:
-                _actions: get_fresh_data.skipped
-      ```
-
-      ##### Setting a returned [`JsAction`](/JsAction) response to `state`:
-      First register a custom JavaScript action: `getNormalizedEigenvector`
-      ```yaml
-      # file: lowdefy.yaml
-      lowdefy: '3.23.2'
-      app:
-        html:
-          appendHead: |
-            <script type="text/javascript">
-              const getNormalizedEigenvector = (context, ...args) => {
-                const vectorLength = Math.sqrt(args.reduce((acc, curVal) => Math.pow(curVal, 2) + acc), 0);
-                return args.map(val => val / vectorLength );
-              }
-              window.lowdefy.registerJsAction('getNormalizedEigenvector', getNormalizedEigenvector);
-            </script>
-      ```
-      Then, calculate the vector and update state.
-      ```yaml
-      # onClick event on a block.
-      id: calculate
-      type: Button
-      events:
-        onClick:
-          - id: get_normalized_eigenvector
-            type: JsAction # TODO:
-            params:
-              name: getNormalizedEigenvector
-              args:
-                - 1
-                - 5
-                - -12
-                - 7
-                - 4
-          - id: update_state
-            type: SetState
-            params:
-              normal_eigenvector:
-                _actions: get_normalized_eigenvector.response
-      ```
-      In this example, state will now be equal to:
-      ```yaml
-      normal_eigenvector:
-        - 0.06523280730534423
-        - 0.3261640365267211
-        - -0.7827936876641306
-        - 0.45662965113740955
-        - 0.2609312292213769
-      ```

package/operators/_and.yaml

@@ -1,90 +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: _and
-    pageTitle: _and
-    filePath: operators/_and.yaml
-    types: |
-      ```
-      (values: any[]): boolean
-      ```
-    description: |
-      The `_and` operator performs a logical `and` over an array of inputs, using javascript [truthy](https://developer.mozilla.org/en-US/docs/Glossary/Truthy) and [falsy](https://developer.mozilla.org/en-US/docs/Glossary/Falsy) rules.
-
-      It only returns true if all the values in the array are truthy (not `false`, `0`, `null`, `undefined`, or the empty string `""`). Else it returns false.
-    arguments: |
-      ###### array
-      An array of values over which to perform a logical and.
-    examples: |
-      ###### Two `true` values:
-      ```yaml
-      _and:
-        - true
-        - true
-      ```
-      Returns: `true`
-
-      ###### Array of `true` and `false` values:
-      ```yaml
-      _and:
-        - true
-        - true
-        - true
-        - false
-      ```
-      Returns: `false`
-
-      ###### Check if two boolean inputs are true:
-      ```yaml
-      _and:
-        - _state: confirm_accept_terms
-        - _state: confirm_accept_privacy_policy
-      ```
-      Returns: `true` if both inputs are `true`
-
-      ###### Truthy values:
-      ```yaml
-      _and:
-        - "Hello"
-        - 42
-        - []
-        - key: value
-      ```
-      Returns: `true`
-
-      ###### Falsy values:
-      ```yaml
-      _and:
-        - true
-        - null
-      ```
-      Returns: `false`
-
-      ```yaml
-      _and:
-        - true
-        - 0
-      ```
-      Returns: `false`
-
-      ```yaml
-      _and:
-        - true
-        - ""
-      ```
-      Returns: `false`

package/operators/_args.yaml

@@ -1,79 +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: _args
-    pageTitle: _args
-    filePath: operators/_args.yaml
-    types: |
-      ```
-      (key: string): any
-      (key: integer): any
-      (all: boolean): any
-      (arguments: {
-        all?: boolean,
-        key?: string | integer,
-        default?: any
-      }): any
-      ```
-    description: |
-      The `_args` operator gets a value from the `arguments` array passed to a function operator. The `arguments` array is an array of all the positional arguments passed to the function.
-    arguments: |
-      ###### string
-      If the `_args` operator is called with a string argument, the value of the key in the `arguments` array is returned. If the value is not found, `null` is returned. Dot notation and [block list indexes](/lists) are supported.
-
-      ###### integer
-      If the `_args` operator is called with a integer argument, the value at that index in the `arguments` array is returned. If the value is not found, `null` is returned. Dot notation and [block list indexes](/lists) are supported.
-
-      ###### boolean
-      If the `_args` operator is called with boolean argument `true`, the entire `arguments` array is returned.
-
-      ###### object
-        - `all: boolean`: If `all` is set to `true`, the entire `arguments` array is returned. One of `all` or `key` are required.
-        - `key: string | integer`: The value of the key or index in the `arguments` array 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 `arguments`. By default, `null` is returned if a value is not found.
-    examples: |
-      ###### Map over an array:
-
-      ```yaml
-      _array.map:
-        on:
-          - firstName: Ted
-            lastName: Mosby
-          - firstName: Robin
-            lastName: Scherbatsky
-          - firstName: Marshall
-            lastName: Eriksen
-          - firstName: Lily
-            lastName: Aldrin
-          - firstName: Barney
-            lastName: Stinson
-        callback:
-          _function:
-            __string.concat:
-              - __args: 0.firstName
-              - ' '
-              - __args: 0.lastName
-      ```
-      Returns:
-      ```yaml
-      - Ted Mosby
-      - Robin Scherbatsky
-      - Marshall Eriksen
-      - Lily Aldrin
-      - Barney Stinson
-      ```

package/operators/_array.yaml

@@ -1,326 +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: _array
-    pageTitle: _array
-    filePath: operators/_array.yaml
-    description: |
-      The `_array` operator can be used to run javascript [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) methods.
-    methods:
-      - name: concat
-        types: |
-          ```
-          (arrays: any[][]): any[]
-          ```
-        description: |
-          The `_array.concat` method [concatenates](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/concat) arrays.
-      - name: copyWithin
-        types: |
-          ```
-          (arguments: {
-            on: any[],
-            target: number,
-            start?: number,
-            end?: number
-          }): any[]
-          (arguments: [
-            on: any[],
-            target: number,
-            start?: number,
-            end?: number
-          ]): any[]
-          ```
-        description: |
-          The `_array.copyWithin` method [copies part of an array to another location in the same array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/copyWithin) without modifying its length.
-      - name: every
-        types: |
-          ```
-          (arguments: {
-            on: any[],
-            callback: function,
-          }): boolean
-          (arguments: [
-            on: any[],
-            callback: function,
-          ]): boolean
-          ```
-        description: |
-          The `_array.every` method  tests whether [all elements in the array pass](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every) the test implemented by the provided function. It returns a Boolean value.
-      - name: fill
-        types: |
-          ```
-          (arguments: {
-            on: any[],
-            value: any,
-            start?: number,
-            end?: number
-          }): any[]
-          (arguments: [
-            on: any[],
-            value: number,
-            start?: number,
-            end?: number
-          ]): any[]
-          ```
-        description: |
-          The `_array.fill` method [changes all elements in an array to a static value](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/fill), from a `start` index to an `end` index.
-      - name: filter
-        types: |
-          ```
-          (arguments: {
-            on: any[],
-            callback: function,
-          }): any[]
-          (arguments: [
-            on: any[],
-            callback: function,
-          ]): any[]
-          ```
-        description: |
-          The `_array.filter` method returns [an array with all elements that pass the test](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter) implemented by the provided function.
-      - name: find
-        types: |
-          ```
-          (arguments: {
-            on: any[],
-            callback: function,
-          }): any
-          (arguments: [
-            on: any[],
-            callback: function,
-          ]): any
-          ```
-        description: |
-          The `_array.find` method returns the value of the [first element in the provided array that satisfies the provided testing function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find). If no values satisfies the testing function, undefined is returned.
-      - name: findIndex
-        types: |
-          ```
-          (arguments: {
-            on: any[],
-            callback: function,
-          }): number
-          (arguments: [
-            on: any[],
-            callback: function,
-          ]): number
-          ```
-        description: |
-          The `_array.findIndex` method returns [the index of the first element in the array that satisfies the provided testing function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/findIndex). Otherwise, it returns -1, indicating that no element passed the test.
-      - name: flat
-        types: |
-          ```
-          (arguments: {on: any[], depth?: number}): any[]
-          (arguments: [on: any[], depth?: number]): any[]
-          ```
-        description: |
-          The `_array.flat` method returns a array with all [sub-array elements concatenated into it recursively](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/flat) up to the specified `depth`.
-      - name: includes
-        types: |
-          ```
-          (arguments: {on: any[], value: any}): boolean
-          (arguments: [on: any[], value: any]): boolean
-          ```
-        description: |
-          The `_array.includes` method determines whether an array [includes a certain value among its entries](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/includes), returning `true` or `false` as appropriate.
-      - name: indexOf
-        types: |
-          ```
-          (arguments: {on: any[], value: any}): number
-          (arguments: [on: any[], value: any]): number
-          ```
-        description: |
-          The `_array.indexOf` method returns the [first index at which a given element can be found](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf) in the array, or `-1` if it is not present.
-      - name: join
-        types: |
-          ```
-          (arguments: {on: any[], separator?: string}): string
-          (arguments: [on: any[], separator?: string]): string
-          ```
-        description: |
-          The `_array.join` method returns [a string by concatenating all of the elements in an array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/join), separated by commas or a specified `separator` string. If the array has only one item, then that item will be returned without using the separator.
-      - name: lastIndexOf
-        types: |
-          ```
-          (arguments: {on: any[], value: any}): number
-          (arguments: [on: any[], value: any]): number
-          ```
-        description: |
-          The `_array.lastIndexOf` method returns the [last index at which a given element can be found](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/lastIndexOf) in the array, or -1 if it is not present.
-      - name: length
-        types: |
-          ```
-          (array: any[]}): number
-          ```
-        description: |
-          The `_array.length` method returns the [number of elements](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/length) in the array.
-      - name: map
-        types: |
-          ```
-          (arguments: {
-            on: any[],
-            callback: function,
-          }): any[]
-          (arguments: [
-            on: any[],
-            callback: function,
-          ]): any[]
-          ```
-        description: |
-          The `_array.map` method returns an array populated with the results of [calling a provided function on every element](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map) in the provided array.
-      - name: reduce
-        types: |
-          ```
-          (arguments: {
-            on: any[],
-            callback: function,
-            initialValue?: any
-          }): any
-          (arguments: [
-            on: any[],
-            callback: function,
-            initialValue?: any
-          ]): any
-          ```
-        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: |
-          ```
-          (arguments: {
-            on: any[],
-            callback: function,
-            initialValue?: any
-          }): any
-          (arguments: [
-            on: any[],
-            callback: function,
-            initialValue?: any
-          ]): any
-          ```
-        description: |
-          The `_array.reduceRight` method [applies a function against an accumulator and each value of the array (from right-to-left)](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/ReduceRight) to reduce it to a single value.
-      - name: reverse
-        types: |
-          ```
-          (array: any[]}): any[]
-          ```
-        description: |
-          The `_array.reverse` method [reverses](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reverse) an array.
-      - name: slice
-        types: |
-          ```
-          (arguments: {
-            on: any[],
-            start?: number,
-            end?: number
-          }): number
-          (arguments: [
-            on: any[],
-            start?: number,
-            end?: number
-          ]): number
-          ```
-        description: |
-          The `_array.slice` method returns [a portion of an array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice) selected from `start` to `end` (end not included) where `start` and `end` represent the index of items in that array.
-      - name: some
-        types: |
-          ```
-          (arguments: {
-            on: any[],
-            callback: function,
-          }): boolean
-          (arguments: [
-            on: any[],
-            callback: function,
-          ]): boolean
-          ```
-        description: |
-          The `_array.some` method tests whether [at least one element in the array passes the test](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some) implemented by the provided function. It returns a Boolean value.
-      - name: sort
-        types: |
-          ```
-          (arguments: {on: any[]}): number
-          ```
-        description: |
-          The `_array.sort` method [sorts](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) the elements of an array. The sort order is ascending, built upon converting the elements into strings, then comparing their sequences of UTF-16 code units values.
-      - name: splice
-        types: |
-          ```
-          (arguments: {
-            on: any[],
-            start: number,
-            deleteCount?: number
-            insert: any[]
-          }): number
-          (arguments: {
-            on: any[],
-            start: number,
-            deleteCount?: number,
-            insert: any[]
-          }): number
-          ```
-        description: |
-          The `_array.slice` method [changes the contents of an array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/splice) by removing or replacing existing elements and/or adding new elements.

package/operators/_base64.yaml

@@ -1,56 +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: _base64
-    pageTitle: _base64
-    filePath: operators/_base64.yaml
-    description: |
-      The `_base64` operator converts strings to and from [base64](https://en.wikipedia.org/wiki/Base64) format.
-    methods:
-      - name: decode
-        types: |
-          ```
-          (value: string): string
-          ```
-        description: |
-          The `_base64.decode` method decodes base64 encoded content into an ASCII string.
-        arguments: |
-          ###### string
-          The string to decode.
-        examples: |
-          ###### Decode a base64 string:
-          ```yaml
-          _base64.decode: SGVsbG8=
-          ```
-          Returns: `"Hello"`.
-      - name: encode
-        types: |
-          ```
-          (value: string): string
-          ```
-        description: |
-          The `_base64.encode` method base64 encodes a ASCII string.
-        arguments: |
-          ###### string
-          The string to encode.
-        examples: |
-          ###### Encode a string as base64:
-          ```yaml
-          _base64.encode: Hello
-          ```
-          Returns: `"SGVsbG8="`.