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

package/operators/_url_query.yaml

@@ -1,120 +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: _url_query
-    pageTitle: _url_query
-    filePath: operators/_url_query.yaml
-    env: Client Only
-    types: |
-      ```
-      (key: string): any
-      (all: boolean): any
-      (arguments: {
-        all?: boolean,
-        key?: string,
-        default?: any,
-        contextId?: string
-      }): any
-      ```
-    description: |
-      The `_url_query` operator gets a value from the [`urlQuery`](/context-and-state) object. The `urlQuery` is a data object that is set as the [`https://en.wikipedia.org/wiki/Query_string`] of the app URL. It can be set when linking to a new page using the [`Link`](/link) action, and can be used to set data like a `id` when switching to a new page. Unlike `input`, the `urlQuery` is visible to the user, and can be modified by the user.
-
-      > __DO NOT__ set any private or personal information to `urlQuery`; all data set to `urlQuery` are accessible publicly. Setting a `id` that can be guessed, like an incremental `id`, can lead to security issues, since users can easily guess and access data for other `ids`.
-
-      If the page is reloaded, the `urlQuery` is not lost. By using `urlQuery`, you can make links containing data that can be shared by users. By default, `_url_query` accesses the `url_query` object from the [`context`](/context-and-state) the operator is used in, but a different context can be specified.
-
-      `urlQuery` objects are serialized to JSON, allowing nested objects or arrays to be specified.
-
-    arguments: |
-      ###### string
-      If the `_url_query` operator is called with a string argument, the value of the key in the `urlQuery` object is returned. If the value is not found, `null` is returned. Dot notation and [block list indexes](/lists) are supported.
-
-      ###### boolean
-      If the `_url_query` operator is called with boolean argument `true`, the entire `urlQuery` object is returned.
-
-      ###### object
-        - `all: boolean`: If `all` is set to `true`, the entire `urlQuery` object is returned. One of `all` or `key` are required.
-        - `key: string`: The value of the key in the `urlQuery` 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 `urlQuery`. 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 `urlQuery` 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 `urlQuery`:
-      ```yaml
-      _url_query: my_key
-      ```
-      ```yaml
-      _url_query:
-        key: my_key
-      ```
-      Returns: The value of `my_key` in `urlQuery`.
-
-      ###### Get the entire `urlQuery` object:
-      ```yaml
-      _url_query: true
-      ```
-      ```yaml
-      _url_query:
-        all: true
-      ```
-      Returns: The entire `urlQuery` object.
-
-      ###### Dot notation:
-      Assuming urlQuery:
-      ```yaml
-      my_object:
-        subfield: 'Value'
-      ```
-      then:
-      ```yaml
-      _url_query: my_object.subfield
-      ```
-      ```yaml
-      _url_query:
-        key: my_object.subfield
-      ```
-      Returns: `"Value"`.
-
-      ###### Return a default value if the value is not found:
-      ```yaml
-      _url_query:
-        key: might_not_exist
-        default: Default value
-      ```
-      Returns: The value of `might_not_exist`, or `"Default value"`.
-
-      ###### Block list indices:
-      Assuming `urlQuery`:
-      ```yaml
-      my_array:
-        - value: 0
-        - value: 1
-        - value: 2
-      ```
-      then:
-      ```yaml
-      _url_query: my_array.$.value
-      ```
-      Returns: `0` when used from the first block (0th index) in a list.
-
-      ###### Get a value from another `context`:
-      ```yaml
-      _url_query:
-        key: my_key
-        contextId: 'pageId:contextId:{}'
-      ```
-      Returns: The value of `my_key` in `urlQuery` in context `contextId` on page `pageId`.

package/operators/_user.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: _user
-    pageTitle: _user
-    filePath: operators/_user.yaml
-    types: |
-      ```
-      (key: string): any
-      (all: boolean): any
-      (arguments: {
-        all?: boolean,
-        key?: string,
-        default?: any,
-      }): any
-      ```
-    description: |
-      The `_user` operator gets a value from the [`user`](/user-object) object. The `user` object contains the data in the user idToken if OpenID Connect authentication is configured and a user is logged in.
-
-    arguments: |
-      ###### string
-      If the `_user` operator is called with a string argument, the value of the key in the `user` object is returned. If the value is not found, `null` is returned. Dot notation and [block list indexes](/lists) are supported.
-
-      ###### boolean
-      If the `_user` operator is called with boolean argument `true`, the entire `user` object is returned.
-
-      ###### object
-        - `all: boolean`: If `all` is set to `true`, the entire `user` object is returned. One of `all` or `key` are required.
-        - `key: string`: The value of the key in the `user` 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 `user`. By default, `null` is returned if a value is not found.
-    examples: |
-      ###### Get the value of `name` from `user`:
-      ```yaml
-      _user: name
-      ```
-      ```yaml
-      _user:
-        key: name
-      ```
-      Returns: The value of `name` in `user`.
-
-      ###### Get the entire `user` object:
-      ```yaml
-      _user: true
-      ```
-      ```yaml
-      _user:
-        all: true
-      ```
-      Returns: The entire `user` object.
-
-      ###### Dot notation:
-      Assuming user:
-      ```yaml
-      sub: abc123
-      name: User Name
-      my_object:
-        subfield: 'Value'
-      ```
-      then:
-      ```yaml
-      _user: my_object.subfield
-      ```
-      ```yaml
-      _user:
-        key: my_object.subfield
-      ```
-      Returns: `"Value"`.
-
-      ###### Return a default value if the value is not found:
-      ```yaml
-      _user:
-        key: might_not_exist
-        default: Default value
-      ```
-      Returns: The value of `might_not_exist`, or `"Default value"`.
-
-      ###### Block list indices:
-      Assuming `user`:
-      ```yaml
-      sub: abc123
-      name: User Name
-      my_array:
-        - value: 0
-        - value: 1
-        - value: 2
-      ```
-      then:
-      ```yaml
-      _user: my_array.$.value
-      ```
-      Returns: `0` when used from the first block (0th index) in a list.

package/operators/_uuid.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: _uuid
-    pageTitle: _uuid
-    filePath: operators/_uuid.yaml
-    description: |
-      The `_uuid` operator creates [UUIDs](https://en.wikipedia.org/wiki/Universally_unique_identifier). A UUID is a random identifier that is, for all practical purposes, unique. It looks like:
-
-      ```
-      123e4567-e89b-12d3-a456-426614174000
-      ```
-    types: |
-      ```
-      (void): string
-      ```
-    arguments: |
-      ###### default:
-      `_uuid: true`, `_uuid: null` or `_uuid: undefined` returns a version 4 UUID.
-
-    examples: |
-      ###### Generate a v4 uuid:
-      ```yaml
-      _uuid: null
-      ```
-      Returns: A version 4 UUID.
-    methods:
-      - name: v1
-        types: |
-          ```
-          (void): string
-          ```
-        description: |
-          Create a version 1 (timestamp) UUID.
-        arguments: |
-          The `_uuid.v1` method does not take any arguments.
-        examples: |
-          ###### Generate a version 1 UUID:
-          ```yaml
-          _uuid.v1: null
-          ```
-          Returns: A version 1 UUID.
-      - name: v3
-        types: |
-          ```
-          ({name: string | string[], namespace: string | string[]}): string
-          ([name: string | string[], namespace: string | string[]]): string
-          ```
-        description: |
-          Create a version 3 (namespace w/ MD5) UUID.
-        arguments: |
-          ###### object:
-          If the `_uuid` operator is called with arguments, it can be one of the following:
-            - `name: string | string[]`: A string or an array.
-            - `namespace: string | string[]`: A string or an Array[16] - Namespace UUID.
-        examples: |
-          ###### Generate a version 3 UUID:
-          ```yaml
-          _uuid.v3:
-            name: hello
-            namespace: world
-          ```
-          Returns: A version 3 UUID.
-      - name: v4
-        types: |
-          ```
-          (void): string
-          ```
-        description: |
-          Create a version 4 (random) UUID.
-        arguments: |
-          The `_uuid.v4` method does not take any arguments.
-        examples: |
-          ###### Generate a version 4 UUID:
-          ```yaml
-          _uuid.v4: null
-          ```
-          Returns: A version 4 UUID.
-      - name: v5
-        types: |
-          ```
-          ({name: string | string[], namespace: string | string[]}): string
-          ([name: string | string[], namespace: string | string[]]): string
-          ```
-        description: |
-          Create a version 5 (namespace w/ SHA-1) UUID.
-        arguments: |
-          ###### object:
-          If the `_uuid` operator is called with arguments, it can be one of the following:
-            - `name: string | string[]`: A string or an array.
-            - `namespace: string | string[]`: A string or an Array[16] - Namespace UUID.
-        examples: |
-          ###### Generate a version 5 UUID:
-          ```yaml
-          _uuid.v5:
-            name: hello
-            namespace: world
-          ```
-          Returns: A version 5 UUID.

package/operators/_var.yaml

@@ -1,105 +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: _var
-    pageTitle: _var
-    filePath: operators/_var.yaml
-    env: Build Only
-    types: |
-      ```
-      (name: string): any
-      (arguments: {
-        name: string,
-        default?: any,
-      }): any
-      ```
-    description: |
-      The `_var` operator gets a value from the `vars` object, specified by a [`_ref`](/ref) operator when referencing a file.
-
-      > The `_var` operator is a build time operator: it is evaluated when the app configuration is being built. This means it is not evaluated dynamically as the app is running, and can be used anywhere in the configuration as long as the resulting configuration files are valid YAML.
-
-    arguments: |
-      ###### string
-      If the `_var` operator is called with a string argument, the value of the key in the `vars` object is returned. If the value is not found, `null` is returned. Dot notation is supported.
-
-      ###### object
-        - `name: string`: The value of the key in the `vars` object is returned. If the value is not found, `null`, or the specified default value is returned. Dot notation is supported.
-        - `default: any`: A value to return if the `name` is not found in `vars`. By default, `null` is returned if a value is not found.
-
-    examples: |
-      ###### Using a standardized input label template:
-      ```yaml
-      blocks:
-        - id: name
-          type: TextInput
-          properties:
-            label:
-              _ref:
-                path: label.yaml
-                vars:
-                  title: Name
-                  description: Your name and surname.
-                  descriptionTextColor: '#546358'
-        - id: age
-          type: NumberInput
-          properties:
-            label:
-              _ref:
-                path: label.yaml
-                vars:
-                  title: Age
-                  description: Your age.
-      ```
-      ```yaml
-      # label.yaml
-      title:
-        _var: title
-      extra:
-        _var: description
-      span: 8
-      colon: false
-      extraStyle:
-        color:
-          _var:
-            name: descriptionTextColor
-            default: '#333333'
-      ```
-      Returns:
-      ```yaml
-      blocks:
-        - id: name
-          type: TextInput
-          properties:
-            label:
-              title: Name
-              extra: Your name and surname.
-              span: 8
-              colon: false
-              extraStyle:
-                color: '#546358'
-        - id: age
-          type: NumberInput
-          properties:
-            label:
-              title: Age
-              extra: Your age.
-              span: 8
-              colon: false
-              extraStyle:
-                color: '#333333'
-      ```

package/operators/_yaml.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: _yaml
-    pageTitle: _yaml
-    filePath: operators/_yaml.yaml
-    description: |
-      The `_yaml` parses and writes YAML strings.
-    methods:
-      - name: parse
-        types: |
-          ```
-          ({on: string, options?: object}): object
-          ([on: string, options?: object]): object
-          ```
-        description: |
-          The `_yaml.parse` method parses a YAML string into an object.
-        arguments: |
-          ###### object
-            - `on: string`: String to parse.
-            - `options?: object`: Optional settings. See the [YAML.parse: method here](https://eemeli.org/yaml/#parse-options) for supported settings.
-
-        examples: |
-          ###### Parse a YAML string:
-          ```yaml
-          _yaml.parse:
-            on: |
-              key: Value
-              boolean: true
-              array:
-                - 1
-                - 2
-          ```
-          or:
-          ```yaml
-          _yaml.parse:
-            - |
-              key: Value
-              boolean: true
-              array:
-                - 1
-                - 2
-          ```
-          Returns:
-          ```
-          key: Value
-          boolean: true
-          array:
-            - 1
-            - 2
-          ```
-      - name: stringify
-        types: |
-          ```
-          ({on: any, options?: object}): string
-          ([on: any, options?: object]): string
-          ```
-        description: |
-          The `_yaml.stringify` method creates a YAML string from an object.
-        arguments: |
-          ###### object
-            - `on: any`: The object to stringify.
-            - `options?: object`: Optional settings. See the [YAML.stringify: method here](https://eemeli.org/yaml/#tostring-options) for supported settings.
-
-        examples: |
-          ###### Stringify an object as YAML:
-          ```yaml
-          _yaml.stringify:
-            on:
-              key: Value
-              boolean: true
-              array:
-                - 1
-                - 2
-          ```
-          or:
-          ```yaml
-          _yaml.stringify:
-            - key: Value
-              boolean: true
-              array:
-                - 1
-                - 2
-          ```
-          Returns (as a string):
-          ```text
-          key: Value
-          boolean: true
-          array:
-            - 1
-            - 2
-          ```