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

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

package/operators/_random.yaml

@@ -1,104 +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: _random
-    pageTitle: _random
-    filePath: operators/_random.yaml
-    types: |
-      ```
-      (type: string): string | number
-      (arguments: {
-        type: string,
-        length?: number,
-        max?: number,
-        min?: number
-      }): string | number
-      ```
-    description: |
-      The `_random` operator returns a random string or number. The types it accepts are `string`, `integer`, or `float`.
-    arguments: |
-      ###### string
-      The type to generate. One of `string`, `integer`, or `float`.
-
-      ###### object
-        - `type: string`: __Required__ - The type to generate. One of `string`, `integer`, or `float`.
-        - `length: string`: The length of the string to generate if type is `string`. Default is `8`.
-        - `max: number`: The maximum possible number if type is one of `integer` or `float`. Default is `100` if `integer` or `1` if `float`.
-        - `min: number`: The minimum possible number if type is one of `integer` or `float`. Default is `0`.
-    examples: |
-      ###### Random string:
-      ```yaml
-      _random: string
-      ```
-      Returns: Random string of length 8.
-
-      ```yaml
-      _random:
-        type: string
-      ```
-      Returns: Random string of length 8.
-
-      ###### Random integer:
-      ```yaml
-      _random: integer
-      ```
-      Returns: Random integer between 0 and 100 inclusive.
-
-      ```yaml
-      _random:
-        type: integer
-      ```
-      Returns: Random integer between 0 and 100 inclusive.
-
-      ###### Random float:
-      ```yaml
-      _random: float
-      ```
-      Returns: Random float between 0 and 1 inclusive.
-
-      ```yaml
-      _random:
-        type: float
-      ```
-      Returns: Random float between 0 and 1 inclusive.
-
-      ###### Random string of length 12:
-      ```yaml
-      _random:
-        type: string
-        length: 12
-      ```
-      Returns: Random string of length 12.
-
-      ###### Random integer between 1 and 6 (Dice roll):
-      ```yaml
-      _random:
-        type: integer
-        min: 1
-        max: 6
-      ```
-      Returns: Random integer between 1 and 6 inclusive.
-
-      ###### Random float between 34.2 and 42.89:
-      ```yaml
-      _random:
-        type: float
-        min: 34.2
-        max: 42.89
-      ```
-      Returns: Random float between 34.2 and 42.89 inclusive.

package/operators/_ref.yaml

@@ -1,266 +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: _ref
-    pageTitle: _ref
-    filePath: operators/_ref.yaml
-    env: Build Only
-    types: |
-      ```
-      (path: string): any
-      (arguments: {
-        path?: string,
-        resolver?: string,
-        transformer?: string,
-        vars?: object,
-      }): any
-      ```
-    description: |
-      The `_ref` operator can be used to reference a configuration file, in order to split the Lowdefy configuration into multiple files. More information on references and the Lowdefy configuration schema can be found [here](/lowdefy-schema).
-
-      > The `_ref` 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.
-
-      The `_ref` operator requires a file path to the file to be referenced, relative to the root directory of the project.
-
-      If this file is a YAML or JSON file, and has file extension `.yaml`, `.yml`, or `.json`, the file is parsed as YAML/JSON, and the parsed result is included in the configuration.
-
-      If this file is a Nunjucks template file, with file extension `.njk`, the file is parsed as a Nunjucks template, using any variables provided in the `vars` argument. If the file extension is `.yaml.njk`, `.yml.njk` or `.json.njk`, the template output is also parsed as YAML/JSON.
-
-      If the file is not parsed (for example has an extension like `.txt`, `.md`, or `.html`), the file contents are included in the configuration as a string.
-
-      ###### Variables
-
-      Variables defined in the `vars` argument can be accessed in the referenced file using the [`_var`](/_var), and as template variables in Nunjucks files.
-
-      ###### Resolver
-
-      A resolver is a JavaScript function that overwrites the default way configuration files are read from the filesystem. It does not need to read from the filesystem, it could generate a value to return programmatically, or it could fetch the configuration using HTTP (from Github for example). The `resolver` argument should be the file path (relative to the root of the project) to a JavaScript file that exports a resolver function.
-
-      The resolver function receives the `path`, `vars`, and a `context` object as arguments. If a resolver function is specified, the `path` argument to the `_ref` operator is optional, and does not need to correspond to a path to a file. If `path` ends with `.yaml`, `.yml`, `.json`, `.njk`, `.yaml.njk`, `.yml.njk`, or `.json.njk`, the returned result will be parsed as YAML/JSON/Nunjucks template.
-
-      A default `_ref` resolver can be specified in the `lowdefy.yaml` `cli` section (as `refResolver`), or as a command-line option when running the CLI (as `--ref-resolver`). This resolver will then be used for all references in the app, unless another resolver is specified.
-
-      ###### Transformer
-
-      A transformer is a JavaScript function that receives the result of the `_ref` operator, and its `vars` as arguments. The value returned by this function will be included in the configuration as the final result of the `_ref` operator. The `transformer` argument should be the file path (relative to the root of the project) to a JavaScript file that exports a transformer function.
-
-      ###### CommonJS and ES Modules
-
-      Both [CommonJS](https://nodejs.org/api/modules.html) and [ES Modules](https://nodejs.org/api/esm.html) are supported for in resolver and transformer functions. By default the functions are imported as CommonJs modules, and the function should be exported as a default export (`module.exports = transformer`). Files can also use the `.cjs` file extension to indicate they are CommonJs modules.
-
-      To use ES Modules, either use files with `.mjs` file extension, or add a `package.json` in the project directory file with `"type": "module"` set. When using ES Modules, the functions should also be a default export (`export default transformer;`)
-
-    arguments: |
-      ###### string
-      The file path to the referenced file, from the root of the project directory.
-
-      ###### object
-        - `path: string`:  The file path to the referenced file, from the root of the project directory. If no `resolver` is specified, `path` is required.
-        - `resolver: string`: The file path to a JavaScript file, from the root of the project directory, that exports a resolver function.
-        - `transformer: string`: The file path to a JavaScript file, from the root of the project directory, that exports a transformer function.
-        - `vars: object`: An object to be used as variables for the `_var` operator in the referenced file, and as template variables in Nunjucks template files.
-
-    examples: |
-      ###### Reference pages:
-      ```yaml
-      # lowdefy.yaml
-      lowdefy: '3.23.2'
-      pages:
-        - _ref: pages/page1.yaml
-        - _ref: pages/page2.yaml
-      ```
-      ```yaml
-      # pages/page1.yaml
-      id: page1
-      type: PageHeaderMenu
-      blocks:
-        # ...
-      ```
-      ```yaml
-      # pages/page2.yaml
-      id: page2
-      type: PageHeaderMenu
-      blocks:
-        # ...
-      ```
-      Returns:
-      ```
-      lowdefy: '3.23.2'
-      pages:
-        - id: page1
-          type: PageHeaderMenu
-          blocks:
-            # ...
-        - id: page2
-          type: PageHeaderMenu
-          blocks:
-            # ...
-      ```
-
-      ###### 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.
-        - 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: '#546358'
-      ```
-      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: '#546358'
-      ```
-
-      ###### Local or shared resolver:
-
-      This resolver function will first look for the configuration file in the current working directory, but if the file is not found it will be read from an adjacent "shared" directory. This pattern can be used to build apps that mostly use a shared configuration, with a few components that are customised per app.
-
-      ```js
-      // resolvers/useLocalOrSharedConfig.js
-      const fs = require('fs');
-      const path = require('path');
-      const { promisify } = require('util');
-
-      const readFilePromise = promisify(fs.readFile);
-
-      async function useLocalOrSharedConfig(refPath, vars, context) {
-        let fileContent
-        try {
-          fileContent =  await readFilePromise(path.resolve(refPath), 'utf8');
-          return fileContent;
-        } catch (error) {
-          if (error.code === 'ENOENT') {
-            fileContent = readFilePromise(path.resolve('../shared', refPath), 'utf8');
-            return fileContent;
-          }
-          throw error;
-        }
-
-
-      }
-
-      module.exports = useLocalOrSharedConfig;
-      ```
-
-      ```yaml
-      // lowdefy.yaml
-      lowdefy: 3.23.2
-
-      cli:
-        refResolver: resolvers/useLocalOrSharedConfig.js
-
-      pages:
-        - _ref: pages/local-page.yaml
-        - _ref: pages/shared-page.yaml
-      ```
-
-      ###### This transformer adds a standard footer to each page:
-
-      ```js
-      //  transformers/addFooter.js
-
-      function addFooter(page, vars) {
-        const footer = {
-          // ...
-        };
-        page.areas.footer = footer;
-        return page;
-      }
-      module.exports = addFooter;
-      ```
-      ```yaml
-      // lowdefy.yaml
-      lowdefy: 3.23.2
-
-      pages:
-        - _ref:
-            path: pages/page1.yaml
-            transformer: transformers/addFooter.js
-      ```
-      ###### Using ES Modules with `.mjs` file extension:
-
-      ```js
-      // resolvers/useLocalOrSharedConfig.mjs
-      import fs from 'fs';
-      import path from 'path';
-      import { promisify } from 'util';
-
-      const readFilePromise = promisify(fs.readFile);
-
-      async function useLocalOrSharedConfig(refPath, vars, context) {
-        let fileContent
-        try {
-          fileContent =  await readFilePromise(path.resolve(refPath), 'utf8');
-          return fileContent;
-        } catch (error) {
-          if (error.code === 'ENOENT') {
-            fileContent = readFilePromise(path.resolve('../shared', refPath), 'utf8');
-            return fileContent;
-          }
-          throw error;
-        }
-
-
-      }
-
-      export default useLocalOrSharedConfig;
-      ```

package/operators/_regex.yaml

@@ -1,83 +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: _regex
-    pageTitle: _regex
-    filePath: operators/_regex.yaml
-    types: |
-      ```
-      (pattern: string): boolean
-      (arguments: {
-        pattern: string,
-        on?: string,
-        key?: string,
-        flags?: string
-      }): boolean
-      ```
-    description: |
-      The `_regex` operator performs a regex test on a string, and returns `true` if there is a match.
-
-      The regex operator has shorthand argument definitions that can be used on web client.
-    arguments: |
-      ###### object
-        - `pattern: string`: __Required__ - The regular expression pattern to test.
-        - `on: string`: The string to test the value on. 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.
-        - `flags: string`: The regex flags to use. The default value is `"gm"`.
-
-      ###### string
-      The regular expression pattern 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 username is valid (Alphanumeric string that may include _ and – having a length of 3 to 16 characters):
-      ```yaml
-      _regex:
-        pattern: ^[a-z0-9_-]{3,16}$
-        on:
-          _state: username_input
-      ```
-      Returns: `true` if matched else `false`.
-
-      ###### Using the key of the value in `state`:
-      ```yaml
-      _regex:
-        pattern: ^[a-z0-9_-]{3,16}$
-        key: username_input
-      ```
-      Returns: `true` if matched else `false`.
-
-      ###### Using the value of the block in which the operator is evaluated:
-      ```yaml
-      id: username_input
-      type: TextInput
-      validate:
-        - message: Invalid username.
-          status: error
-          pass:
-            _regex: ^[a-z0-9_-]{3,16}$
-      ```
-      Returns: `true` if matched else `false`.
-
-      ###### Case insensitive match:
-      ```yaml
-      _regex:
-        pattern: ^[a-z0-9_-]{3,16}$
-        on:
-          _state: username_input
-        flags: 'gmi'
-      ```
-      Returns: `true` if matched else `false`.

package/operators/_request.yaml

@@ -1,50 +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: _request
-    pageTitle: _request
-    filePath: operators/_request.yaml
-    env: Client Only
-    types: |
-      ```
-      (requestId: string): any
-      ```
-    description: |
-      The `_request` operator returns the response value of a request. If the request has not yet been call, or is still executing, the returned value is `null`. Dot notation and [block list indexes](/lists) are supported.
-    arguments: |
-      ###### string
-      The id of the request.
-    examples: |
-      ###### Using a request response:
-      ```yaml
-      _request: my_request
-      ```
-      Returns: The response returned by the request.
-
-      ###### Using dot notation to get the data object from the response:
-      ```yaml
-      _request: my_request.data
-      ```
-      ###### Using dot notation to get the first element of an array response:
-      ```yaml
-      _request: array_request.0
-      ```
-      ###### Using dot notation and block list indexes to get the name field from the element corresponding to the block index of an array response:
-      ```yaml
-      _request: array_request.$.name
-      ```

package/operators/_secret.yaml

@@ -1,74 +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: _secret
-    pageTitle: _secret
-    filePath: operators/_secret.yaml
-    env: Server Only
-    types: |
-      ```
-      (key: string): any
-      (all: boolean): any
-      (arguments: {
-        all?: boolean,
-        key?: string,
-        default?: any
-      }): any
-      ```
-    description: |
-      The `_secret` operator gets a value from the [`secret`](/context-and-secret) object. The `secrets` is a data object that contains sensitive information like passwords or API keys. The `_secret` operator can only be used in `connections` and `requests`. Secrets are read from environment variables on the server that start with `LOWDEFY_SECRET_`, (i.e. `LOWDEFY_SECRET_SECRET_NAME`). The name of the secret is the part after `LOWDEFY_SECRET_`. Since environment variables can only be strings, secrets can be JSON encoded, and parsed using the [`_json.parse`](/_json) method.
-
-    arguments: |
-      ###### string
-      If the `_secret` operator is called with a string argument, the value of the key in the `secrets` object is returned. If the value is not found, `null` is returned.
-
-      ###### boolean
-      If the `_secret` operator is called with boolean argument `true`, the entire `secrets` object is returned.
-
-      ###### object
-        - `all: boolean`: If `all` is set to `true`, the entire `secrets` object is returned. One of `all` or `key` are required.
-        - `key: string`: The value of the key in the `secrets` object 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 `secrets`. By default, `null` is returned if a value is not found.
-    examples: |
-      ###### Get the value of `MY_SECRET` from `secrets`:
-      ```yaml
-      _secret: MY_SECRET
-      ```
-      ```yaml
-      _secret:
-        key: MY_SECRET
-      ```
-      Returns: The value of `MY_SECRET` in `secrets`.
-
-      ###### Get the entire `secret` object:
-      ```yaml
-      _secret: true
-      ```
-      ```yaml
-      _secret:
-        all: true
-      ```
-      Returns: The entire `secrets` object.
-
-      ###### Return a default value if the value is not found:
-      ```yaml
-      _secret:
-        key: MY_SECRET
-        default: Not so secret
-      ```
-      Returns: The value of `MY_SECRET`, or `"Not so secret"`.