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

package/operators/_event.yaml

@@ -1,103 +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: _event
-    pageTitle: _event
-    filePath: operators/_event.yaml
-    env: Client Only
-    types: |
-      ```
-      (key: string): any
-      (all: boolean): any
-      (arguments: {
-        all?: boolean,
-        key?: string,
-        default?: any
-      }): any
-      ```
-    description: |
-      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/operators/_format.yaml

@@ -1,209 +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: _format
-    pageTitle: _format
-    env: Client Only
-    description: |
-      The `_format` operator converts objects to strings, using a specified format. It can only be used on the web-client (not in requests or connections).
-    methods:
-      - name: intlDateTimeFormat
-        types: |
-          ```
-          (arguments: {
-            on: date,
-            params?: {
-              locale?: string,
-              options?: object
-            },
-          })
-          ```
-        description: |
-          The `_format.intlDateTimeFormat` provides language-sensitive date and time formatting, based on [`Intl.DateTimeFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat). If no locale is provide, the users default locale will be used.
-        arguments: |
-          ###### object
-            - `on: date`: The date object to format.
-            - `params: object`:
-              - `locale: string`: A string with a BCP 47 language tag, or an array of such strings.
-              - `options: object`: [`Intl.DateTimeFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat) options.
-        examples: |
-          ###### Format a date:
-          ```yaml
-          _format.intlDateTimeFormat:
-            on:
-              _date: 2019-06-13
-            params:
-              locale: en
-              options:
-                weekday: long
-                year: numeric
-                month: long
-                day: numeric
-          ```
-          Returns: `"Thursday, June 13, 2019"`.
-      - name: intlListFormat
-        types: |
-          ```
-          (arguments: {
-            on: any[],
-            params?: {
-              locale?: string,
-              options?: object
-            },
-          })
-          ```
-        description: |
-          The `_format.intlListFormat` provides language-sensitive list formatting, based on [`Intl.ListFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat/ListFormat). If no locale is provide, the users default locale will be used.
-        arguments: |
-          ###### object
-            - `on: any[]`: The array to format.
-            - `params: object`:
-              - `locale: string`: A string with a BCP 47 language tag, or an array of such strings.
-              - `options: object`: [`Intl.ListFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat/ListFormat) options.
-        examples: |
-          ###### Format a list:
-          ```yaml
-          _format.intlListFormat:
-            on:
-              - Motorcycle
-              - Bus
-              - Car
-            params:
-              locale: fr
-          ```
-          Returns: `"Motorcycle, Bus et Car"`.
-      - name: intlNumberFormat
-        types: |
-          ```
-          (arguments: {
-            on: number,
-            params?: {
-              locale?: string,
-              options?: object
-            },
-          })
-          ```
-        description: |
-          The `_format.intlNumberFormat` provides language-sensitive number formatting, based on [`Intl.NumberFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat). If no locale is provide, the users default locale will be used.
-        arguments: |
-          ###### object
-            - `on: number`: The number to format.
-            - `params: object`:
-              - `locale: string`: A string with a BCP 47 language tag, or an array of such strings.
-              - `options: object`: [`Intl.NumberFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat) options.
-        examples: |
-          ###### Format a number:
-          ```yaml
-          _format.intlNumberFormat:
-            on: 13182375813.47422
-            params:
-              locale: de
-          ```
-          Returns: `"13,18,23,75,813.474"`.
-      - name: intlRelativeTimeFormat
-        types: |
-          ```
-          (arguments: {
-            on: any,
-            params: {
-              locale?: string,
-              unit: enum,
-              options?: object
-            },
-          })
-          ```
-        description: |
-          The `_format.intlRelativeTimeFormat` provides language-sensitive relative time  formatting, based on [`Intl.RelativeTimeFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat/RelativeTimeFormat). If no locale is provide, the users default locale will be used.
-        arguments: |
-          ###### object
-            - `on: number`: The number to format.
-            - `params: object`:
-              - `locale: string`: A string with a BCP 47 language tag, or an array of such strings.
-              - `unit: enum`: Unit to use in the relative time internationalized message. Possible values are: `year`, `quarter`, `month`, `week`, `day`, `hour`, `minute`, `second`. Plural forms are also permitted.
-              - `options: object`: [`Intl.RelativeTimeFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat/RelativeTimeFormat) options.
-        examples: |
-          ###### Format a number:
-          ```yaml
-          _format.intlRelativeTimeFormat:
-            on: 4
-            params:
-              unit: 'days'
-              locale: fr
-          ```
-          Returns: `"dans 4 jours"`.
-      - name: momentFormat
-        types: |
-          ```
-          (arguments: {
-            on: date | string,
-            params?: {
-              locale?: string,
-              format?: string
-            },
-          })
-          ```
-        description: |
-          The `_format.momentFormat` formats dates using the [moment.js](https://momentjs.com/docs/#/displaying/format/) library.
-        arguments: |
-          ###### object
-            - `on: date | string`: The date to format.
-            - `params: object`:
-              - `locale: string`: A string with a locale name.
-              - `format: string`: A date [format string](https://momentjs.com/docs/#/displaying/format/).
-
-        examples: |
-          ###### Format a date:
-          ```yaml
-          _format.momentFormat:
-            on:
-              _date: 2019-06-04
-            params:
-              format: 'd MMM YYYY'
-          ```
-          Returns: `"4 Jun 2019"`.
-      - name: momentHumanizeDuration
-        types: |
-          ```
-          (arguments: {
-            on: number,
-            params?: {
-              locale?: string,
-              thresholds?: string,
-              withSuffix?: boolean
-            },
-          })
-          ```
-        description: |
-          The `_format.momentHumanizeDuration` formats durations in milliseconds using the [moment.js](https://momentjs.com/docs/#/durations/humanize/)
-        arguments: |
-          ###### object
-            - `on: number`: The duration in milliseconds to format.
-            - `params: object`:
-              - `locale: string`: A string with a locale name.
-              - `thresholds: object`: Thresholds define when a unit is considered a minute, an hour and so on. For example, by default more than 45 seconds is considered a minute, more than 22 hours is considered a day and so on. See [here](https://momentjs.com/docs/#/customization/relative-time-threshold/)
-              - `withSuffix: boolean`: By default, the return string is describing a duration `a month` (suffix-less). If you want an oriented duration `in a month`, `a month ago` (with suffix), pass in true.
-
-        examples: |
-          ###### Format a date:
-          ```yaml
-          _format.momentHumanizeDuration:
-            on: 245923000
-            params:
-              withSuffix: true
-          ```
-          Returns: `"in 3 days"`.

package/operators/_function.yaml

@@ -1,66 +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: _function
-    pageTitle: _function
-    filePath: operators/_function.yaml
-    types: |
-      ```
-      (definition: any): function
-      ```
-    description: |
-      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.
-    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/operators/_get.yaml

@@ -1,108 +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: _get
-    pageTitle: _get
-    filePath: operators/_get.yaml
-    types: |
-      ```
-      (arguments: {
-        from: any[] | object,
-        key: string | integer,
-        default?: any,
-      }): any
-      ```
-    description: |
-      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.
-
-    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: AiOutlinedExclamationCircle
-          investigation_started: AiTwoToneTool
-          client_contacted: AiTwoToneSound
-          awaiting_confirmation: AiOutlinedLike
-          closed: AiOutlinedStop
-      ```
-      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/operators/_global.yaml

@@ -1,107 +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: _global
-    pageTitle: _global
-    filePath: operators/_global.yaml
-    env: Client Only
-    types: |
-      ```
-      (key: string): any
-      (all: boolean): any
-      (arguments: {
-        all?: boolean,
-        key?: string,
-        default?: any,
-        contextId?: string
-      }): any
-      ```
-    description: |
-      The `_global` operator gets a value from the [`global`](/context-and-state) object. The `global` object is a shared data object that can be accessed from any `context` 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.
-        - `contextId: string`: The id of a `context`. Setting this will get the value from the `context` of the specified context. A list of `contexts` that exist are returned by the [`_list_contexts`](/_list_contexts) operator.  The value of `global` is the same for all `contexts`. Cannot be used in `connections` or `requests`.
-
-    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/operators/_gt.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: _gt
-    pageTitle: _gt
-    filePath: operators/_gt.yaml
-    types: |
-      ```
-      ([value1: any, value2: any]): boolean
-      ```
-    description: |
-      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).
-
-    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`