@lowdefy/docs-content 0.0.0-experimental-20260710073520

package/content/operators/_event.md

@@ -0,0 +1,86 @@
+# _event
+
+```
+(key: string): any
+(all: boolean): any
+(arguments: {
+  all?: boolean,
+  key?: string,
+  default?: any
+}): any
+```
+
+The `_event` operator gets a value from the `event` object. The `event` object is a data object provided to an [`action`](/events-and-actions) by an [`event`](/events-and-actions). This object is also available to a [`request or connection`](/connections-and-requests) called by the [`Request`](/Request) action.
+
+#### Arguments
+
+###### string
+If the `_event` operator is called with a string argument, the value of the key in the `event` object is returned. If the value is not found, `null` is returned. Dot notation and [block list indexes](/lists) are supported.
+
+###### boolean
+If the `_event` operator is called with boolean argument `true`, the entire `event` object is returned.
+
+###### object
+  - `all: boolean`: If `all` is set to `true`, the entire `event` object is returned. One of `all` or `key` are required.
+  - `key: string`: The value of the key in the `event` 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 `event`. By default, `null` is returned if a value is not found.
+
+#### Examples
+
+###### Get the value of `my_key` from `event`:
+```yaml
+_event: my_key
+```
+```yaml
+_event:
+  key: my_key
+```
+Returns: The value of `my_key` in `event`.
+
+###### Get the entire `event` object:
+```yaml
+_event: true
+```
+```yaml
+_event:
+  all: true
+```
+Returns: The entire `event` object.
+
+###### Dot notation:
+Assuming args:
+```yaml
+my_object:
+  subfield: 'Value'
+```
+then:
+```yaml
+_event: my_object.subfield
+```
+```yaml
+_event:
+  key: my_object.subfield
+```
+Returns: `"Value"`.
+
+###### Return a default value if the value is not found:
+```yaml
+_event:
+  key: might_not_exist
+  default: Default value
+```
+Returns: The value of `might_not_exist`, or `"Default value"`.
+
+###### Block list indices:
+Assuming `event`:
+```yaml
+my_array:
+  - value: 0
+  - value: 1
+  - value: 2
+```
+then:
+```yaml
+_event: my_array.$.value
+```
+Returns: `0` when used from the first block (0th index) in a list.

package/content/operators/_function.md

@@ -0,0 +1,52 @@
+# _function
+
+```
+(definition: any): function
+```
+
+The `_function` operator returns a function that evaluates the given operator definition when called. The resulting function can then be used by other operators like `_array.map`, or by blocks (for example as a formatter function).
+
+To use a operator in a function definition, the operator name should start with a double underscore, `__`, instead of a single underscore. Operators that start with a single underscore will be evaluated when the function is created, and those that start with a double underscore are evaluated when the function is executed.
+
+The arguments passed to the function when it is executed can be accessed with the [`_args`](/_args) operator.
+
+> This operator can be used as a [`_build`](/_build) operator method.
+
+#### Arguments
+
+###### any
+
+The function definition. To use operators here, the operator names should start with a double underscore.
+
+#### 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/content/operators/_get.md

@@ -0,0 +1,92 @@
+# _get
+
+```
+(arguments: {
+  from: any[] | object,
+  key: string | integer,
+  default?: any,
+}): any
+```
+
+The `_get` operator gets a value from the object or array specified in `from`. If the `key` is not found, the provided `default`, or `null` if not specified, are returned.
+
+> This operator can be used as a [`_build`](/_build) operator method.
+
+#### Arguments
+
+###### object
+  - `from: any[] | object`: __Required__ - The object to get the value from.
+  - `key: string`: __Required__ - The value of the key or array index to get from the `from` object or array. If the value is not found, `null`, or the specified default value is returned. Dot notation and [block list indexes](/lists) are supported.
+  - `default: any`: A value to return if the `key` is not found in `from`. By default, `null` is returned if a value is not found.
+
+#### Examples
+
+###### Get the value of a key from an object:
+```yaml
+_get:
+  from:
+    name: George
+    age: 22
+  key: name
+```
+Returns: `"George"`.
+
+###### Use _get to as a switch statement to choose an Icon name:
+```yaml
+_get:
+  key:
+    _state: status
+  from:
+    new: AiTwoTonePlusCircle
+    escalated: AiOutlineExclamationCircle
+    investigation_started: AiTwoToneTool
+    client_contacted: AiTwoToneSound
+    awaiting_confirmation: AiOutlineLike
+    closed: AiOutlineStop
+```
+Returns: The icon corresponding to the status in state.
+
+###### Get from an array (arrays are `0` indexed):
+```yaml
+_get:
+  from:
+    - id: 1
+      name: Joe
+    - id: 2
+      Name: Dave
+  key: 0.name
+```
+Returns: `1`.
+
+###### Dot notation:
+```yaml
+_get:
+  from:
+    my_object:
+      subfield: 'Value'
+  key: my_object.subfield
+```
+Returns: `"Value"`.
+
+###### Return a default value if the value is not found:
+```yaml
+_get:
+  from:
+    value1: 1
+  key: value2
+  default: 99
+```
+Returns: `99`.
+
+###### Block list indices:
+Assuming `state`:
+```yaml
+ _get:
+  from:
+    my_array:
+      - value: 0
+      - value: 1
+      - value: 2
+  key: my_array.$.value
+```
+Returns: `0` when used from the first block (0th index) in a list.

package/content/operators/_global.md

@@ -0,0 +1,86 @@
+# _global
+
+```
+(key: string): any
+(all: boolean): any
+(arguments: {
+  all?: boolean,
+  key?: string,
+  default?: any,
+}): any
+```
+
+The `_global` operator gets a value from the [`global`](/page-and-app-state) object. The `global` object is a shared data object that can be accessed from any page in the app.
+
+#### Arguments
+
+###### string
+If the `_global` operator is called with a string argument, the value of the key in the `global` object is returned. If the value is not found, `null` is returned. Dot notation and [block list indexes](/lists) are supported.
+
+###### boolean
+If the `_global` operator is called with boolean argument `true`, the entire `global` object is returned.
+
+###### object
+  - `all: boolean`: If `all` is set to `true`, the entire `global` object is returned. One of `all` or `key` are required.
+  - `key: string`: The value of the key in the `global` 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 `global`. By default, `null` is returned if a value is not found.
+
+#### Examples
+
+###### Get the value of `my_key` from `global`:
+```yaml
+_global: my_key
+```
+```yaml
+_global:
+  key: my_key
+```
+Returns: The value of `my_key` in `global`.
+
+###### Get the entire `global` object:
+```yaml
+_global: true
+```
+```yaml
+_global:
+  all: true
+```
+Returns: The entire `global` object.
+
+###### Dot notation:
+Assuming global:
+```yaml
+my_object:
+  subfield: 'Value'
+```
+then:
+```yaml
+_global: my_object.subfield
+```
+```yaml
+_global:
+  key: my_object.subfield
+```
+Returns: `"Value"`.
+
+###### Return a default value if the value is not found:
+```yaml
+_global:
+  key: might_not_exist
+  default: Default value
+```
+Returns: The value of `might_not_exist`, or `"Default value"`.
+
+###### Block list indices:
+Assuming `global`:
+```yaml
+my_array:
+  - value: 0
+  - value: 1
+  - value: 2
+```
+then:
+```yaml
+_global: my_array.$.value
+```
+Returns: `0` when used from the first block (0th index) in a list.

package/content/operators/_gt.md

@@ -0,0 +1,50 @@
+# _gt
+
+```
+([value1: any, value2: any]): boolean
+```
+
+The `_gt` operator tests if the first value is greater than the second equal. It takes an array of two values to test.
+
+> The `_gt` operator tests using the javascript greater than 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).
+
+> This operator can be used as a [`_build`](/_build) operator method.
+
+#### Arguments
+
+###### array
+An array of two values to compare.
+
+#### Examples
+
+###### Two numbers:
+```yaml
+_gt:
+  - 4
+  - 3
+```
+Returns: `true`
+
+```yaml
+_gt:
+  - 1
+  - 1
+```
+Returns: `false`
+
+```yaml
+_gt:
+  - _sum:
+      - 3
+      - 4
+  - 8
+```
+Returns: `false`
+
+###### Two strings:
+```yaml
+_gt:
+  - "a"
+  - "b"
+```
+Returns: `false`

package/content/operators/_gte.md

@@ -0,0 +1,50 @@
+# _gte
+
+```
+([value1: any, value2: any]): boolean
+```
+
+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).
+
+> This operator can be used as a [`_build`](/_build) operator method.
+
+#### 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/content/operators/_hash.md

@@ -0,0 +1,112 @@
+# _hash
+
+The `_hash` operator generates hashes using various algorithms.
+
+> This operator can be used as a [`_build`](/_build) operator method.
+
+# Operator methods:
+
+## _hash.md5
+
+```
+(value: string): string
+```
+
+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"`.
+
+## _hash.sha1
+
+```
+(value: string): string
+```
+
+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"`.
+
+## _hash.sha256
+
+```
+(value: string): string
+```
+
+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"`.
+
+## _hash.sha512
+
+```
+(value: string): string
+```
+
+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"`.
+
+## _hash.ripemd160
+
+```
+(value: string): string
+```
+
+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/content/operators/_if.md

@@ -0,0 +1,30 @@
+# _if
+
+```
+(arguments: {test: boolean, then: any, else: any}): any
+```
+
+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.
+
+> This operator can be used as a [`_build`](/_build) operator method.
+
+#### 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/content/operators/_if_none.md

@@ -0,0 +1,47 @@
+# _if_none
+
+```
+([value: any, replacement: any]): any
+```
+
+The `_if_none` operator replaces the input value with an alternative if the value is of a "none-type" like `null` or `undefined`.
+
+> This operator can be used as a [`_build`](/_build) operator method.
+
+#### 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/content/operators/_index.md

@@ -0,0 +1,48 @@
+# _index
+
+```
+(key: string): any
+(key: integer): any
+(all: boolean): any
+(arguments: {
+  all?: boolean,
+  key?: string | integer,
+  default?: any
+}): any
+```
+
+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]`