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

package/operators/_ne.yaml

@@ -1,77 +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: _ne
-    pageTitle: _ne
-    filePath: operators/_ne.yaml
-    types: |
-      ```
-      ([value1: any, value2: any]): boolean
-      ```
-    description: |
-      The `_ne` operator tests if two values are not equal. It takes an array of two values to test.
-
-      > The `_ne` won't do a deep comparison.
-
-    arguments: |
-      ###### array
-      An array of two values to compare.
-    examples: |
-      ###### Two non-equal strings:
-
-      ```yaml
-      _ne:
-        - "Hello"
-        - "Hello you"
-      ```
-      Returns: `true`
-
-      ###### Two equal strings:
-
-      ```yaml
-      _ne:
-        - "Hello"
-        - "Hello"
-      ```
-      Returns: `false`
-
-      ###### Two numbers:
-      ```yaml
-      _ne:
-        - _sum:
-            - 3
-            - 4
-        - 8
-      ```
-      Returns: `true`
-
-      ###### Arrays are not compared deeply:
-      ```yaml
-      _ne:
-        - [1,2,3]
-        - [1,2,3]
-      ```
-      Returns: `true`
-
-      ###### Values from "getter" operators are copies and not equal:
-      ```yaml
-      _ne:
-        - _state: my_object
-        - _state: my_object
-      ```
-      Returns: `true`

package/operators/_not.yaml

@@ -1,47 +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: _not
-    pageTitle: _not
-    filePath: operators/_not.yaml
-    types: |
-      ```
-      (value: any): boolean
-      ```
-    description: |
-      The `_not` operator returns the logical negation of the input. If the value is not a boolean, it will be converted to a boolean using javascript [truthy](https://developer.mozilla.org/en-US/docs/Glossary/Truthy) and [falsy](https://developer.mozilla.org/en-US/docs/Glossary/Falsy) rules.
-    arguments: |
-      ###### any
-    examples: |
-      ###### Not `true` is `false`:
-      ```yaml
-      _not: true
-      ```
-      Returns: `false`
-
-      ###### Return `true` for a falsy value:
-      ```yaml
-      _not: null
-      ```
-      Returns: `true`
-
-      ###### Return `false` for a truthy value:
-      ```yaml
-      _not: 100
-      ```
-      Returns: `false`

package/operators/_number.yaml

@@ -1,157 +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: _number
-    pageTitle: _number
-    filePath: operators/_number.yaml
-    description: |
-      The `_number` operator can be used to run javascript [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) methods.
-    methods:
-      - name: EPSILON
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.EPSILON` property represents the smallest interval between two representable numbers.. [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/EPSILON) for more details and examples.
-      - name: MAX_SAFE_INTEGER
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.MAX_SAFE_INTEGER` property represents the maximum safe integer in JavaScript (2^53 - 1). [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER) for more details and examples.
-      - name: MAX_VALUE
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.MAX_VALUE` property represents the largest positive representable number. [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_VALUE) for more details and examples.
-      - name: MIN_SAFE_INTEGER
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.MIN_SAFE_INTEGER` property represents the minimum safe integer in JavaScript (-(2^53 - 1)). [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MIN_SAFE_INTEGER) for more details and examples.
-      - name: MIN_VALUE
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.MIN_VALUE` property represents the smallest positive representable number — that is, the positive number closest to zero (without actually being zero). [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MIN_VALUE) for more details and examples.
-      - name: NaN
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.NaN` property represents the special "Not a Number" value. [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/NaN) for more details and examples.
-      - name: NEGATIVE_INFINITY
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.NEGATIVE_INFINITY` property represents negative infinity. Returned on overflow. [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/NEGATIVE_INFINITY) for more details and examples.
-      - name: POSITIVE_INFINITY
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.POSITIVE_INFINITY` property represents positive infinity. [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/POSITIVE_INFINITY) for more details and examples.
-      - name: isFinite
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.isFinite` method is used to determine whether the passed value is a finite number. [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isFinite) for more details and examples.
-      - name: isInteger
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.isInteger` method is used to determine whether the passed value is an integer. [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isInteger) for more details and examples.
-      - name: isNaN
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.isNaN` method is used to determine whether the passed value is NaN. [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isNaN) for more details and examples.
-      - name: isSafeInteger
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.isSafeInteger` method is used to determine whether the passed value is a safe integer (number between -(2^53 - 1) and 2^53 - 1). [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isSafeInteger) for more details and examples.
-      - name: parseFloat
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.parseFloat` method parses an argument and returns a floating point number. If a number cannot be parsed from the argument, it returns NaN. [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/parseFloat) for more details and examples.
-      - name: parseInt
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.parseInt` method parses a string argument and returns an integer of the specified radix or base. If a number cannot be parsed from the argument, it returns NaN. [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/parseInt) for more details and examples.
-      - name: toExponential
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.toExponential` method returns a string representing the Number object in exponential notation. [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toExponential) for more details and examples.
-      - name: toFixed
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.toFixed` method formats a number using fixed-point notation. [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toFixed) for more details and examples.
-      - name: toLocaleString
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.toLocaleString` method returns a string with a language-sensitive representation of this number. [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toLocaleString) for more details and examples.
-      - name: toPrecision
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.toPrecision` method returns a string representing the Number object to the specified precision. [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toPrecision) for more details and examples.
-      - name: toString
-        types: |
-          ```
-          (void): number
-          ```
-        description: |
-          The `_number.toString` method returns a string representing the specified Number object. [See MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toString) for more details and examples.

package/operators/_nunjucks.yaml

@@ -1,73 +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: _nunjucks
-    pageTitle: _nunjucks
-    filePath: operators/_nunjucks.yaml
-    types: |
-      ```
-      (template: string): string
-      (arguments: {template: string, on: object}): string
-      ```
-    description: |
-      The `_nunjucks` hydrates a [Nunjucks](https://mozilla.github.io/nunjucks/) template.
-
-      If called with a string argument, the template variables are the values in `state`. Otherwise template variables can be specified using the `on` argument.
-    arguments: |
-      ###### string
-      The template to hydrate. The template variables used are the values in state
-
-      ###### object
-        - `template: string`: The template to hydrate.
-        - `on: object`: The template variables to use when hydrating the template.
-    examples: |
-      ###### Populate a template from values in `state`:
-      ```yaml
-      _nunjucks: Hello {{ name }}
-      ```
-      Returns: `"Hello Steven"` if the value of name in state is `"Steven"`.
-
-      ###### Populate a markdown template with different values:
-      Assuming `get_items` returns:
-      ```yaml
-      - name: Coca Cola
-        description: The original.
-      - name: Pepsi
-        description: The same but different.
-      ```
-
-      ```yaml
-      _nunjucks:
-        template: |
-          ### {{ title }}
-
-          {% for item in item_list %}
-          - {{ item.name }}: {{ item.description }}
-          {% endfor %}
-        on:
-          title: Soft drinks
-          items:
-            _request: get_items
-      ```
-      Returns:
-      ```markdown
-      ### Soft drinks
-
-      - Coca Cola: The original.
-      - Pepsi: The same but different.
-      ```

package/operators/_object.yaml

@@ -1,193 +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: _object
-    pageTitle: _object
-    filePath: operators/_object.yaml
-    description: |
-      The `_object` operator can be used to run javascript [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) methods.
-    methods:
-      - name: assign
-        types: |
-          ```
-          (objs: obj[]): object
-          ```
-        description: |
-          The `_object.assign` method copies the values of one ore more source objects to a target objects. The first object in the arguments array is the target object, and the rest are source objects. Keys in the target object are overwritten. The result of `_object.assign` can be seen as a "shallow-merge" of all the objects in the array, with the values in later objects taken preferentially.
-        arguments: |
-          ###### array
-          An array of objects.
-        examples: |
-          ###### Merge three objects:
-          ```yaml
-          _object.assign:
-            - firstName: Rachel
-              lastName: Green
-              series: Friends
-            - firstName: Monica
-              lastName: Geller
-              address:
-                street: 90 Bedford St
-                city: New York
-                zipCode: '10014'
-                country: US
-            - friends:
-                - Ross Geller
-                - Rachel Green
-                - Chandler Bing
-                - Phoebe Buffay
-                - Joey Tribbiani
-          ```
-          Returns:
-          ```yaml
-          firstName: Monica
-          lastName: Geller
-          series: Friends
-          address:
-            street: 90 Bedford St
-            city: New York
-            zipCode: '10014'
-            country: US
-          friends:
-            - Ross Geller
-            - Rachel Green
-            - Chandler Bing
-            - Phoebe Buffay
-            - Joey Tribbiani
-          ```
-      - name: defineProperty
-        types: |
-          ```
-          (arguments: {
-            on: object,
-            key: string,
-            descriptor: {
-              value: any,
-              configurable?: boolean,
-              enumerable?: boolean,
-              writable?: boolean
-            }
-          }): any
-          (arguments: [
-            on: object,
-            key: string,
-            descriptor: {
-              value: any,
-              configurable?: boolean,
-              enumerable?: boolean,
-              writable?: boolean
-            }
-          ]): any
-          ```
-        description: |
-          The `_object.defineProperty` method defines a new property directly on an object, or modifies an existing property on an object, and returns the object. The first object in the arguments array, or the `on` parameter, is the target object to which the property will be applied. The second argument, or the `key` parameter, is the property name or key which will be applied to the target object. The third and last object argument, or the `descriptor` parameter, has serval options to consider, however, for the most common application set the `value` object key to the value that should be applied to the target object key. See [Object.defineProperty](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperty) for a more detailed description.
-
-          > The `_object.defineProperty` method is handy when the `key` to set is variable.
-        examples: |
-          ###### Set a value to a object key:
-          ```yaml
-          _object.defineProperty:
-            - firstName: Rachel
-              series: Friends
-            - lastName
-            - descriptor:
-                value: Green
-          ```
-          Returns:
-          ```yaml
-          firstName: Rachel
-          lastName: Green
-          series: Friends
-          ```
-      - name: keys
-        types: |
-          ```
-          (obj: object): string[]
-          ```
-        description: |
-          The `_object.keys` method returns an array with the objects keys.
-        arguments: |
-          ###### object
-          The object to get keys from.
-        examples: |
-          ###### Get the keys of an object:
-          ```yaml
-          _object.keys:
-            firstName: Monica
-            lastName: Geller
-            address:
-              street: 90 Bedford St
-              city: New York
-              zipCode: '10014'
-              country: US
-            friends:
-              - Ross Geller
-              - Rachel Green
-              - Chandler Bing
-              - Phoebe Buffay
-              - Joey Tribbiani
-          ```
-          Returns:
-          ```yaml
-          - firstName
-          - lastName
-          - address
-          - friends
-          ```
-      - name: values
-        types: |
-          ```
-          (obj: object): any[]
-          ```
-        description: |
-          The `_object.keys` method returns an array with the values of all the fields in an object.
-        arguments: |
-          ###### object
-          The object to get keys from.
-        examples: |
-          ###### Get the values of an object:
-          ```yaml
-          _object.values:
-            firstName: Monica
-            lastName: Geller
-            address:
-              street: 90 Bedford St
-              city: New York
-              zipCode: '10014'
-              country: US
-            friends:
-              - Ross Geller
-              - Rachel Green
-              - Chandler Bing
-              - Phoebe Buffay
-              - Joey Tribbiani
-          ```
-          Returns:
-          ```yaml
-          - Monica
-          - Geller
-          - street: 90 Bedford St
-            city: New York
-            zipCode: '10014'
-            country: US
-          - - Ross Geller
-            - Rachel Green
-            - Chandler Bing
-            - Phoebe Buffay
-            - Joey Tribbiani
-          ```

package/operators/_operator.yaml

@@ -1,47 +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: _operator
-    pageTitle: _operator
-    filePath: operators/_operator.yaml
-    types: |
-      ```
-      (arguments: {operator: string, params: any): any
-      ```
-    description: |
-      The `_operator` operator evaluates an operator with the given params. This is useful if the operator needs to be chosen dynamically. The `_operator` cannot evaluate itself.
-    arguments: |
-      ###### object
-        - `operator: string`: The name of the operator to evaluate.
-        - `params: any`: The params to give to the operator.
-    examples: |
-      ###### Get a value from `urlQuery` if specified, else use the value in `state`:
-      ```yaml
-      _operator:
-        operator:
-          _if:
-            test:
-              _eq:
-                - _state: location_selector
-                - url_query
-            then: _url_query
-            else: _state
-        params:
-          key: field_to_get
-      ```
-      Returns: Value from `urlQuery` if `location_selector == url_query`, else the value from `state`.

package/operators/_or.yaml

@@ -1,81 +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: _or
-    pageTitle: _or
-    filePath: operators/_or.yaml
-    types: |
-      ```
-      (values: any[]): boolean
-      ```
-    description: |
-      The `_or` operator performs a logical `or` 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 returns true if any of the values in the array are truthy (not `false`, `0`, `null`, `undefined`, or the empty string `""`). If all the values are falsy, it returns `false`.
-    arguments: |
-      ###### array
-      An array of values over which to perform a logical or.
-    examples: |
-      ###### `true` and `false` values:
-      ```yaml
-      _or:
-        - true
-        - false
-      ```
-      Returns: `true`
-
-      ###### Array of `true` and `false` values:
-      ```yaml
-      _or:
-        - true
-        - false
-        - false
-        - false
-      ```
-      Returns: `true`
-
-      ###### Falsy values values:
-      ```yaml
-      _or:
-        - null
-        - 0
-        - ''
-      ```
-      Returns: `false`
-
-      ###### Truthy values:
-      ```yaml
-      _or:
-        - false
-        - "Hello"
-      ```
-      Returns: `true`
-
-      ```yaml
-      _or:
-        - false
-        - 99
-      ```
-      Returns: `true`
-
-      ```yaml
-      _or:
-        - false
-        - [1,2,3]
-      ```
-      Returns: `true`