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

package/operators/_state.yaml

@@ -1,114 +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: _state
-    pageTitle: _state
-    filePath: operators/_state.yaml
-    env: Client Only
-    types: |
-      ```
-      (key: string): any
-      (all: boolean): any
-      (arguments: {
-        all?: boolean,
-        key?: string,
-        default?: any,
-        contextId?: string
-      }): any
-      ```
-    description: |
-      The `_state` operator gets a value from the [`state`](/context-and-state) object. The `state` is a data object specific to the context it is in. The value of `input` blocks are available in `state`, with their `blockId` as key. By default, `_state` accesses the `state` object from the [`context`](/context-and-state) the operator is used in, but a different context can be specified.
-
-    arguments: |
-      ###### string
-      If the `_state` operator is called with a string argument, the value of the key in the `state` object is returned. If the value is not found, `null` is returned. Dot notation and [block list indexes](/lists) are supported.
-
-      ###### boolean
-      If the `_state` operator is called with boolean argument `true`, the entire `state` object is returned.
-
-      ###### object
-        - `all: boolean`: If `all` is set to `true`, the entire `state` object is returned. One of `all` or `key` are required.
-        - `key: string`: The value of the key in the `state` 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 `state`. 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 `state` 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 `state`:
-      ```yaml
-      _state: my_key
-      ```
-      ```yaml
-      _state:
-        key: my_key
-      ```
-      Returns: The value of `my_key` in `state`.
-
-      ###### Get the entire `state` object:
-      ```yaml
-      _state: true
-      ```
-      ```yaml
-      _state:
-        all: true
-      ```
-      Returns: The entire `state` object.
-
-      ###### Dot notation:
-      Assuming state:
-      ```yaml
-      my_object:
-        subfield: 'Value'
-      ```
-      then:
-      ```yaml
-      _state: my_object.subfield
-      ```
-      ```yaml
-      _state:
-        key: my_object.subfield
-      ```
-      Returns: `"Value"`.
-
-      ###### Return a default value if the value is not found:
-      ```yaml
-      _state:
-        key: might_not_exist
-        default: Default value
-      ```
-      Returns: The value of `might_not_exist`, or `"Default value"`.
-
-      ###### Block list indices:
-      Assuming `state`:
-      ```yaml
-      my_array:
-        - value: 0
-        - value: 1
-        - value: 2
-      ```
-      then:
-      ```yaml
-      _state: my_array.$.value
-      ```
-      Returns: `0` when used from the first block (0th index) in a list.
-
-      ###### Get a value from another `context`:
-      ```yaml
-      _state:
-        key: my_key
-        contextId: 'pageId:contextId:{}'
-      ```
-      Returns: The value of `my_key` in `state` in context `contextId` on page `pageId`.

package/operators/_string.yaml

@@ -1,283 +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: _string
-    pageTitle: _string
-    filePath: operators/_string.yaml
-    description: |
-      The `_string` operator can be used to run javascript [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) methods.
-    methods:
-      - name: charAt
-        types: |
-          ```
-          (arguments: {on: string, index: number}): string
-          (arguments: [on: string, index: number]): string
-          ```
-        description: |
-          The `_string.charAt` method returns a string consisting of [the single UTF-16 code (character) unit located at the specified offset](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/charAt) into the string.
-      - name: concat
-        types: |
-          ```
-          (strings: string[]): string
-          ```
-        description: |
-          The `_string.concat` method [concatenates](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/concat) strings.
-      - name: endsWith
-        types: |
-          ```
-          (arguments: {
-            on: string,
-            searchString: string,
-            length?: number
-          }): boolean
-          (arguments: [
-            on: string,
-            searchString: string,
-            length?: number
-          ]): boolean
-          ```
-        description: |
-          The `_string.endsWith` method determines whether a string [ends with the characters of a specified string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/endsWith), returning `true` or `false` as appropriate.
-      - name: includes
-        types: |
-          ```
-          (arguments: {
-            on: string,
-            searchString: string,
-            position?: number
-          }): boolean
-          (arguments: [
-            on: string,
-            searchString: string,
-            position?: number
-          ]): boolean
-          ```
-        description: |
-          The `_string.includes` method determines whether [one string may be found within another string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/includes), returning `true` or `false` as appropriate.
-      - name: indexOf
-        types: |
-          ```
-          (arguments: {
-            on: string,
-            searchValue: string,
-            fromIndex?: number
-          }): number
-          (arguments: [
-            on: string,
-            searchValue: string,
-            fromIndex?: number
-          ]): number
-          ```
-        description: |
-          The `_string.indexOf` method returns the index within string of the [first occurrence of the specified value](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf), starting the search at `fromIndex`. Returns `-1` if the value is not found.
-      - name: length
-        types: |
-          ```
-          (string: string): number
-          ```
-        description: |
-          The `_string.length` method returns the [length](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/length) of a string.
-      - name: lastIndexOf
-        types: |
-          ```
-          (arguments: {
-            on: string,
-            searchValue: string,
-            fromIndex?: number
-          }): number
-          (arguments: [
-            on: string,
-            searchValue: string,
-            fromIndex?: number
-          ]): number
-          ```
-        description: |
-          The `_string.lastIndexOf` method returns the index within string of the [last  occurrence of the specified value](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/lastIndexOf), searching backwards from `fromIndex`. Returns `-1` if the value is not found.
-      - name: match
-        types: |
-          ```
-          (arguments: {
-            on: string,
-            regex: string,
-            regexFlags?: string
-          }): string[]
-          ```
-        description: |
-          The `_string.match` method returns the [result of matching a string against a regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/match).
-      - name: normalize
-        types: |
-          ```
-          (arguments: {on: string, form?: enum}): string
-          (arguments: [on: string, form?: enum]): string
-          ```
-        description: |
-          The `_string.normalize` method returns the [Unicode Normalization Form](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize) of the string.
-      - name: padEnd
-        types: |
-          ```
-          (arguments: {
-            on: string,
-            targetLength: number,
-            padString?: string
-          }): string
-          (arguments: [
-            on: string,
-            targetLength: number,
-            padString?: string
-          ]): string
-          ```
-        description: |
-          The `_string.padEnd` method [pads the string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/padEnd) with a given string (repeated, if needed) so that the resulting string reaches a given length. The padding is applied from the end of the string.
-      - name: padStart
-        types: |
-          ```
-          (arguments: {
-            on: string,
-            targetLength: number,
-            padString?: string
-          }): string
-          (arguments: [
-            on: string,
-            targetLength: number,
-            padString?: string
-          ]): string
-          ```
-        description: |
-          The `_string.padStart` method [pads the string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/padEnd) with a given string (repeated, if needed) so that the resulting string reaches a given length. The padding is applied from the start of the string.
-      - name: repeat
-        types: |
-          ```
-          (arguments: {on: string, count: number}): string
-          (arguments: [on: string, count: number]): string
-          ```
-        description: |
-          The `_string.repeat` method returns a string which contains [the specified number of copies of the string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/repeat) on which it was called, concatenated together.
-      - name: replace
-        types: |
-          ```
-          (arguments: {
-            on: string,
-            regex: string,
-            newSubstr: string,
-            regexFlags?: string
-          }): string
-          ```
-        description: |
-          The `_string.replace` method returns a string with [some or all matches of a pattern replaced by a replacement](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace).
-      - name: search
-        types: |
-          ```
-          (arguments: {
-            on: string,
-            regex: string,
-            regexFlags?: string
-          }): number
-          ```
-        description: |
-          The `_string.search` method executes a [search for a match between a regular expression and a string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/search). It returns the index of the first match between the regular expression and the given string, or `-1` if no match was found.
-      - name: slice
-        types: |
-          ```
-          (arguments: {
-            on: string,
-            start: number,
-            end?: number
-          }): string
-          (arguments: [
-            on: string,
-            start: number,
-            end?: number
-          ]): string
-          ```
-        description: |
-          The `_string.slice` method [extracts a section](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/slice) of a string.
-      - name: split
-        types: |
-          ```
-          (arguments: {on: string, separator?: string}): string[]
-          (arguments: [on: string, separator?: string]): string[]
-          ```
-        description: |
-          The `_string.split` method [divides a string into an array of substrings](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/split), splitting on the provided separator.
-      - name: startsWith
-        types: |
-          ```
-          (arguments: {
-            on: string,
-            searchString: string,
-            position?: number
-          }): boolean
-          (arguments: [
-            on: string,
-            searchString: string,
-            position?: number
-          ]): boolean
-          ```
-        description: |
-          The `_string.startsWith` method determines whether a string [starts with the characters of a specified string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/endsWith), returning `true` or `false` as appropriate.
-      - name: substring
-        types: |
-          ```
-          (arguments: {
-            on: string,
-            start: number,
-            end?: number
-          }): string
-          (arguments: [
-            on: string,
-            start: number,
-            end?: number
-          ]): string
-          ```
-        description: |
-          The `_string.startsWith` method returns [the part of the string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substring) between the `start` and `end` indexes, or to the end of the string.
-      - name: toLowerCase
-        types: |
-          ```
-          (string: string): string
-          ```
-        description: |
-          The `_string.toLowerCase` method converts the string to [lower case](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/toLowerCase).
-      - name: toUpperCase
-        types: |
-          ```
-          (string: string): string
-          ```
-        description: |
-          The `_string.toUpperCase` method converts the string to [upper case](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/toUpperCase).
-      - name: trim
-        types: |
-          ```
-          (string: string): string
-          ```
-        description: |
-          The `_string.trim` method [removes whitespace from both ends](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/Trim) of a string.
-      - name: trimEnd
-        types: |
-          ```
-          (string: string): string
-          ```
-        description: |
-          The `_string.trimEnd` method [removes whitespace from the end](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/trimEnd) of a string.
-      - name: trimStart
-        types: |
-          ```
-          (string: string): string
-          ```
-        description: |
-          The `_string.trimStart` method [removes whitespace from the start](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/trimStart) of a string.

package/operators/_subtract.yaml

@@ -1,38 +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: _subtract
-    pageTitle: _subtract
-    filePath: operators/_subtract.yaml
-    types: |
-      ```
-      ([minuend: number, subtrahend: number]): number
-      ```
-    description: |
-      The `_subtract` operator takes an array of two numbers as input and returns the second number subtracted from the first.
-    arguments: |
-      ###### array
-      An array of two numbers.
-    examples: |
-      ###### Subtract a number:
-      ```yaml
-      _subtract:
-        - 12
-        - 4
-      ```
-      Returns: `8`

package/operators/_sum.yaml

@@ -1,59 +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: _sum
-    pageTitle: _sum
-    filePath: operators/_sum.yaml
-    types: |
-      ```
-      (values: any[]): number
-      ```
-    description: |
-      The `_sum` operator takes the sum of the values given as input. If a value is not a number, the value is skipped.
-    arguments: |
-      #### array
-      An array of values to add.
-    examples: |
-      ###### Two numbers:
-      ```yaml
-      _sum:
-        - 3
-        - 4
-      ```
-      Returns: `7`
-
-      ###### Array of numbers:
-      ```yaml
-      _sum:
-        - 1
-        - 2
-        - 3
-        - 4
-      ```
-      Returns: `10`
-
-      ###### Non-numbers are skipped:
-      ```yaml
-      _sum:
-        - 1
-        - null
-        - 3
-        - "four"
-        - 5
-      ```
-      Returns: `9`

package/operators/_switch.yaml

@@ -1,51 +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: _switch
-    pageTitle: _switch
-    filePath: operators/_switch.yaml
-    types: |
-      ```
-      (arguments: {branches: {if: boolean, then: any}[], default: any}): any
-      ```
-    description: |
-      The `_switch` operator evaluates an array of conditions and returns the `then` argument of the first item for which the `if` argument evaluates to `true`. If no condition evaluates to `true`, the value of the `default` argument is returned.
-    arguments: |
-      ###### object
-        - `branches:`
-            `if: boolean`: The boolean result of a test.
-            `then: any`: The value to return if the test is `true`.
-        - `default: any`: The value to return if all the `if` tests are `false`.
-    examples: |
-      ###### Return a value based on a series of conditions:
-      ```yaml
-      _switch:
-        branches:
-          - if:
-              _eq:
-                - x
-                - y
-            then: A
-          - if:
-              _eq:
-                - x
-                - z
-            then: B
-        default: C
-      ```
-      Returns: `"C"` since both of the `if` tests are `false`.

package/operators/_type.yaml

@@ -1,92 +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: _type
-    pageTitle: _type
-    filePath: operators/_type.yaml
-    types: |
-      ```
-      (type: enum): boolean
-      (arguments: {
-        type: string,
-        on?: any,
-        key?: string
-      }): boolean
-      ```
-    description: |
-      The `_type` operator performs a type test on an object, and returns true if the object is of the specified type.
-
-      The regex operator has shorthand argument definitions that can be used on web client.
-    arguments: |
-      ###### object
-        - `type: enum`: __Required__ - The type to test. Can be one of:
-          - `string`
-          - `array`
-          - `date`
-          - `object`
-          - `boolean`
-          - `number`
-          - `integer`
-          - `null`
-          - `undefined`
-          - `none` (`null` or `undefined`)
-          - `primitive` (`undefined`, `null`, `string`, `number`, `boolean`, or `date`)
-        - `on: any`: The value to test. One of `on` or `key` must be specified unless the operator is used in an input block.
-        - `key: string`: The key of a value in `state` to test. One of `on` or `key` must be specified unless the operator is used in an input block.
-
-      ###### string
-      The type to test. The string shorthand can only be used in an input block, and the tested value will be the block's value.
-    examples: |
-      ###### Check if a value is a number:
-      ```yaml
-      _type:
-        type: number
-        on:
-          _state: input
-      ```
-      Returns: `true` if a number.
-
-      ###### Using the key of the value in `state`:
-      ```yaml
-      _type:
-        type: number
-        key: input
-      ```
-      Returns: `true` if a number.
-
-      ###### Using the value of the block in which the operator is evaluated:
-      ```yaml
-      id: input
-      type: TextInput
-      validate:
-        - message: This field id required.
-          status: error
-          pass:
-            _not:
-              _type: none
-      ```
-      Returns: `true` if the input is none.
-
-      ###### Test if an id in the `urlQuery` is undefined or null:
-      ```yaml
-      _type:
-        type: none
-        on:
-          _url_query: id
-      ```
-      Returns: `true` if the id is none,

package/operators/_uri.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: _uri
-    pageTitle: _uri
-    filePath: operators/_uri.yaml
-    description: |
-      The `_uri` operator [encodes and decodes](https://en.wikipedia.org/wiki/Percent-encoding) Uniform Resource Identifiers (URI). It encodes characters that are not in the limited US-ASCII characters legal within a URI.
-    methods:
-      - name: decode
-        types: |
-          ```
-          (value: string): string
-          ```
-        description: |
-          The `_uri.decode` method decodes a string that has been uri-encoded. It uses [`decodeURIComponent`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent).
-        arguments: |
-          ###### string
-          The string to decode.
-        examples: |
-          ###### Decode a base64 string:
-          ```yaml
-          _uri.decode: http%3A%2F%2Fusername%3Apassword%40www.example.com%3A80%2Fpath%2Fto%2Ffile.php%3Ffoo%3D316%26bar%3Dthis%2Bhas%2Bspaces%23anchor
-          ```
-          Returns: `"http://username:password@www.example.com:80/path/to/file.php?foo=316&bar=this+has+spaces#anchor"`.
-      - name: encode
-        types: |
-          ```
-          (value: string): string
-          ```
-        description: |
-          The `_uri.encode` uri-encodes a string. It uses [`encodeURIComponent`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent).
-        arguments: |
-          ###### string
-          The string to encode.
-        examples: |
-          ###### Encode a string as base64:
-          ```yaml
-          _uri.encode: http://username:password@www.example.com:80/path/to/file.php?foo=316&bar=this+has+spaces#anchor
-          ```
-          Returns: `"http%3A%2F%2Fusername%3Apassword%40www.example.com%3A80%2Fpath%2Fto%2Ffile.php%3Ffoo%3D316%26bar%3Dthis%2Bhas%2Bspaces%23anchor"`.