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

package/connections/AWSS3.yaml

@@ -1,228 +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/general.yaml.njk
-  vars:
-    pageId: AWSS3
-    pageTitle: Amazon S3
-    section: Connections
-    filePath: connections/AWSS3.yaml
-    content:
-      - id: markdown
-        type: MarkdownWithCode
-        properties:
-          content: |
-            AWS S3 is a file or data storage solution, provided by Amazon Web Services. S3 does not work like a traditional file system, data is stored as objects in a collection of objects called a bucket.
-            Objects can be read from S3 and stored in S3 using web requests. These objects can be public or private. You can read more [here](https://docs.aws.amazon.com/AmazonS3/latest/dev/Welcome.html).
-
-            Lowdefy integrates with AWS S3 using presigned links. These are links that are authorized to give access to private objects, or that allow you to create new objects, and that expire after a certain amount of time. This allows you to upload or download directly from S3 from the browser.
-
-            A guide to creating and connecting to an S3 bucket is given at the bottom of this page.
-
-            ## Connections
-
-            Connection types:
-              - AwsS3Bucket
-
-            ### AwsS3Bucket
-
-            The `AwsS3Bucket` connection is used to connect to a AWS S3 bucket. AWS S3 is the file storage solution provided by Amazon Web services.
-
-            #### Properties
-            - `accessKeyId: string`: __Required__ - AWS IAM access key id with s3 access.
-            - `secretAccessKey: string`: __Required__ - AWS IAM secret access key with s3 access.
-            - `region: string`: __Required__ - AWS region bucket is located in.
-            - `bucket: string`: __Required__ - S3 bucket name.
-            - `read: boolean`: Default: `true` - Allow reads from the bucket.
-            - `write: boolean`: Default: `false` - Allow writes to the bucket.
-
-            #### Examples
-
-            ###### Read and writes on a bucket:
-            ```yaml
-            connections:
-              - id: my_bucket
-                type: AwsS3Bucket
-                properties:
-                  accessKeyId:
-                    _secret: S3_ACCESS_KEY_ID
-                  secretAccessKey:
-                    _secret: S3_SECRET_ACCESS_KEY
-                  region: eu-west-1
-                  bucket: my-bucket-name
-                  write: true
-            ```
-            Environment variables:
-            ```
-            LOWDEFY_SECRET_S3_ACCESS_KEY_ID = AKIAIOSFODNN7EXAMPLE
-            LOWDEFY_SECRET_S3_SECRET_ACCESS_KEY = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
-            ```
-
-            ## Requests
-
-            Request types:
-              - AwsS3PresignedGetObject
-              - AwsS3PresignedPostPolicy
-
-            ### AwsS3PresignedGetObject
-
-            The `AwsS3PresignedGetObject` request is used to get a download link for an object in AWS S3. The link provided by this request can be opened using the `Link` action.
-
-            #### Properties
-            - `versionId: string`: VersionId used to reference a specific version of the object.
-            - `expires: number`: Number of seconds for which the policy should be valid.
-            - `key: string`: __Required__ - Key (or filename) under which object will be stored. If another file is saved with the same key, that file will be overwritten, so a random string in this field is probably needed.
-            - `responseContentType: string`: Sets the Content-Type header of the response.
-            - `responseContentDisposition: string`: Sets the Content-Disposition header of the response.
-
-            #### Examples
-
-            ###### Download a pdf and open in a new tab:
-            ```yaml
-            requests:
-              - id: my_file_link
-                type: AwsS3PresignedGetObject
-                connectionId: my_bucket_connection
-                properties:
-                  key: pdf-filename-as4dacd.pdf
-                  responseContentType: application/pdf
-
-                    ...
-                    blocks:
-                      - id: getFileButton
-                        type: Button
-                        events:
-                          onClick:
-                            - id: open_file
-                              type: Link
-                              params:
-                                url:
-                                  _request: my_file_link
-                                newTab: true
-            ```
-
-            ### AwsS3PresignedPostPolicy
-
-            The `AwsS3PresignedPostPolicy` request is used to create a policy that allows a file to be uploaded to AWS S3. This is used by a block like the `S3Uploadbutton` to upload a file.
-
-            #### Properties
-            - `acl: enum`: Access control lists used to grant read and write access.
-              - private
-              - public-read
-              - public-read-write
-              - aws-exec-read
-              - authenticated-read
-              - bucket-owner-read
-              - bucket-owner-full-control
-            - `conditions: object[] | string[][]`: Conditions to be enforced on the request. An array of objects, or condition arrays. See [here](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-HTTPPOSTConstructPolicy.html).
-            - `expires: number`: Number of seconds for which the policy should be valid.
-            - `key: string`: __Required__ - Key (or filename) under which object will be stored. If another file is saved with the same key, that file will be overwritten, so a random string in this field is probably needed.
-
-
-            #### Examples
-
-            ###### Upload a file with user filename and random id:
-            ```yaml
-            - id: my_post_policy
-              type: AwsS3PresignedPostPolicy
-              connectionId: my_bucket_connection
-              properties:
-                key:
-                  _nunjucks:
-                    template: uploads/{{filename}}-{{uid}}
-                    on:
-                      filename:
-                        _args: filename
-                      uid:
-                        _args: filename
-            ```
-
-            ## Creating a bucket
-
-            ###### Step 1 - Create an AWS account
-
-            Go to the [AWS homepage](https://aws.amazon.com/) and create an account if you don't already have one. you can find more information [here](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account/).
-
-            ###### Step 2 - Create an S3 bucket
-
-            1. Once logged in, search for S3 in the search box.
-            2. Click 'Create Bucket'
-            3. Choose a name and AWS region for your bucket
-            4. Continue creating the bucket with any extra settings is needed.
-            5. Make sure the 'Block all public access' box is ticked if you don't want to allow public access.
-            6. Click 'Create Bucket'
-
-            ###### Step 3 - Set the CORS settings for your bucket
-
-            CORS, or Cross-Origin Resource Sharing is a security feature that is used to restrict web applications from accessing resources from different origins, or domain names. To allow your Lowdefy app to access the contents of the bucket, you need to add a CORS rule on the bucket that authorizes your app
-
-            1. Click on you bucket.
-            2. Click on the 'Permissions' tab.
-            3. Click on the 'CORS Configuration' tab.
-            4. Paste this configuration and save (Fill in your own Lowdefy domain name).
-
-            ```json
-            [
-                {
-                    "AllowedHeaders": [
-                        "*"
-                    ],
-                    "AllowedMethods": [
-                        "GET", "PUT", "POST", "DELETE", "HEAD"
-                    ],
-                    "AllowedOrigins": [
-                        "https://YOUR_LOWDEFY_DOMAIN_HERE"
-                    ],
-                    "ExposeHeaders": []
-                },
-            ]
-            ```
-
-            ###### Step 4 - Create an IAM user
-
-            IAM is the AWS identity and access management system. This can be used to give very granular access permissions. We will create a programmatic user that has the rights to read and write objects in the Bucket.
-
-            1. In the 'Services' dropdown in the header, search for 'IAM'.
-            2. Click on 'Users' in the menu on the left.
-            3. Click 'Add User'
-            4. Choose a descriptive name for the user.
-            5. Choose programmatic access and click next.
-            6. Choose 'Attach existing policies directly'.
-            7. Choose 'Create Policy'.
-            8. Choose the JSON tab and paste the following (Fill in your own bucket name):
-            ```JSON
-            {
-                "Version": "2012-10-17",
-                "Statement": [
-                    {
-                        "Sid": "ListObjectsInBucket",
-                        "Effect": "Allow",
-                        "Action": ["s3:ListBucket"],
-                        "Resource": ["arn:aws:s3:::YOUR_BUCKET_NAME_HERE"]
-                    },
-                    {
-                        "Sid": "AllObjectActions",
-                        "Effect": "Allow",
-                        "Action": "s3:*Object",
-                        "Resource": ["arn:aws:s3:::YOUR_BUCKET_NAME_HERE/*"]
-                    }
-                ]
-            }
-            ```
-
-            9. Choose review policy and save.
-            10. In your previous tab, refresh and search for the policy you just created. Attach it to the user.
-            11. Click next, review and create the user.
-            12. Set the access key id and secret access key in your Lowdefy secrets store.

package/connections/AmazonRedshift.yaml

@@ -1,75 +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/general.yaml.njk
-  vars:
-    pageId: AmazonRedshift
-    pageTitle: Amazon Redshift
-    section: Connections
-    filePath: connections/AmazonRedshift.yaml
-    content:
-      - id: markdown_intro
-        type: Markdown
-        properties:
-          content: |
-            The [Knex](/Knex) connection can be used to connect to a [Amazon Redshift](https://aws.amazon.com/redshift) database.
-
-      - id: markdown_connection
-        type: MarkdownWithCode
-        properties:
-          content: |
-            ## Connections
-
-            Connection types:
-              - Knex
-
-            ### Knex
-
-            #### Properties
-            - `client: enum`: __Required__ - Should be `redshift` to connect to Amazon Redshift.
-            - `connection: object | string`: __Required__ - Connection string or object to pass to the [`pg`](https://www.npmjs.com/package/pg) database client.
-            - `useNullAsDefault: boolean`: If true, undefined keys are replaced with NULL instead of DEFAULT.
-
-            #### Examples
-
-            ###### Connection object:
-            ```yaml
-            connections:
-              - id: redshift
-                type: Knex
-                properties:
-                  client: redshift
-                  connection:
-                    host:
-                      _secret: REDSHIFT_HOST
-                    database:
-                      _secret: REDSHIFT_DB
-                    user:
-                      _secret: REDSHIFT_USER
-                    password:
-                      _secret: REDSHIFT_PASSWORD
-            ```
-            Environment variables:
-            ```
-            LOWDEFY_SECRET_REDSHIFT_HOST = examplecluster.XXXXXXXXXXXX.us-west-2.redshift.amazonaws.com
-            LOWDEFY_SECRET_REDSHIFT_REDSHIFT_DB = db
-            LOWDEFY_SECRET_REDSHIFT_USER = user
-            LOWDEFY_SECRET_REDSHIFT_PASSWORD = password
-            ```
-      - id: markdown_requests
-        type: MarkdownWithCode
-        properties:
-          content:
-            _ref: connections/KnexRequests.md

package/connections/AxiosHttp.yaml

@@ -1,194 +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/general.yaml.njk
-  vars:
-    pageId: AxiosHttp
-    pageTitle: AxiosHttp
-    section: Connections
-    filePath: connections/AxiosHttp.yaml
-    content:
-      - id: markdown
-        type: MarkdownWithCode
-        properties:
-          content: |
-            The `AxiosHttp` connection is used to connect to APIs and web servers using HTTP or HTTPS.
-
-            It uses the [axios](https://github.com/axios/axios) library.
-
-            The same properties can be set on both connections and requests. The properties will be merged, with the request properties overwriting connection properties. This allows properties like authentication headers and the baseURL to be set on the connection, with request specific properties like the request.
-
-            >Secrets like authentication headers and API keys should be stored using the [`_secret`](operators/secret.md) operator.
-
-            ## Connections
-
-            Connection types:
-              - AxiosHttp
-
-            ## Requests
-
-            Request types:
-              - AxiosHttp
-
-            ### AxiosHttp
-
-            #### Properties
-
-            - `url: string`: The server URL that will be used for the request.
-            - `method: enum`: Default: `'get'` - The request method to be used when making the request. Options are:
-              - `'get'`
-              - `'delete'`
-              - `'head'`
-              - `'options'`
-              - `'post'`
-              - `'put'`
-              - `'patch'`
-            - `baseURL: string`: `baseURL` will be prepended to `url` unless `url` is absolute. It can be convenient to set `baseURL` for an axios connection to pass relative URLs to requests or mutations using that connection.
-            - `headers: object`: An object with custom headers to be sent sent with the request. The object keys should be header names, and the values should be the string header values.
-            - `params: object`: An object with URL parameters to be sent with the request.
-            - `data: string | object`: The data to be sent as the request body. Only applicable for request methods `'put'`, `'post'`, and `'patch'`. Can be an object or a string in the format `'Country=Brasil&City=Belo Horizonte'`.
-            - `auth: object`: Indicates that HTTP Basic authorization should be used, and supplies credentials. This will set an `Authorization` header, overwriting any existing `Authorization` custom headers you have set using `headers`. Only HTTP Basic auth is configurable through this parameter, for Bearer tokens and such, use `Authorization` custom headers instead. The `auth` object should have the following fields:
-              - `username: string`
-              - `password: string`
-            - `httpAgentOptions: object`: Options to pass to the Node.js [`http.Agent`](https://nodejs.org/api/http.html#http_class_http_agent) class.
-            - `httpsAgentOptions: object`: Options to pass to the Node.js [`https.Agent`](https://nodejs.org/api/http.html#http_class_http_agent) class.
-            - `maxContentLength: number`: Defines the max size of the http response content allowed in bytes.
-            - `maxRedirects: number`: Defines the maximum number of redirects to follow. If set to 0, no redirects will be followed.
-            - `proxy: object`: Defines the hostname and port of the proxy server. The `proxy` object should have the following fields:
-              - `host: string`: Host IP address (eg. `'127.0.0.1'`).
-              - `port: number`: Port number.
-              - `auth: object`: Object with username and password.
-            - `responseType: enum`: Default: `'json'` - The type of data that the server will respond with. Options are:
-              - `'document'`
-              - `'json'`
-              - `'text'`
-            - `responseEncoding: string`: Default: `'utf8'` - Indicates encoding to use for decoding responses.
-            - `timeout: number`: Default: `0` (no timeout) - The number of milliseconds before the request times out. If the request takes longer than `timeout`, the request will be aborted. Set to `0` for no timeout.
-            - `transformRequest: function`: A function to transform the request data before it is sent. Receives `data` and `headers` as arguments and should return the data to be sent.
-            - `transformResponse: function`: A function to transform the received data. Receives `data` as an argument and should return the transformed data.
-            - `validateStatus: function`: A function to validate whether the response should complete successfully given a status code. Receives `status` as an argument and should `true` if the status code is valid.
-
-
-            #### Examples
-
-            Properties for a AxiosHttp can be set on either the connection, the request, or both. However, both a connection and request need to be defined.
-
-            ###### A basic full example requesting data from https://jsonplaceholder.typicode.com
-
-            ```yaml
-            lowdefy: 3.23.2
-            name: Lowdefy starter
-            connections:
-              - id: my_api
-                type: AxiosHttp
-                properties:
-                  baseURL: https://jsonplaceholder.typicode.com
-            pages:
-              - id: welcome
-                type: PageHeaderMenu
-                requests:
-                  - id: get_posts
-                    type: AxiosHttp
-                    connectionId: my_api
-                    properties:
-                      url: /posts
-                events:
-                  onEnter:
-                    - id: fetch_get_posts
-                      type: Request
-                      params: get_posts
-                blocks:
-                  - id: rest_data
-                    type: Markdown
-                    properties:
-                      content:
-                        _string.concat:
-                          - |
-                            ```yaml
-                          - _yaml.stringify:
-                              - _log:
-                                  _request: get_posts
-                          - |
-                            ```
-            ```
-
-            ###### Using the connection to set baseURL and authorization, and handle specific requests as requests.
-            ```yaml
-            connections:
-              - id: app_api
-                type: AxiosHttp
-                properties:
-                  baseURL: app.com/api
-                  auth:
-                    username: api_user
-                    password:
-                      _secret: API_PASSWORD
-            # ...
-            requests:
-              - id: get_orders
-                type: AxiosHttp
-                connectionId: app_api
-                properties:
-                  url: /orders
-              - id: update_order
-                type: AxiosHttp
-                connectionId: app_api
-                properties:
-                  url:
-                    _nunjucks: /orders/{{ order_id }}
-                  method: post
-                  data:
-                    _state: true
-            ```
-
-
-            ###### Setting properties on only the connection:
-            ```yaml
-            connections:
-              - id: get_count
-                type: AxiosHttp
-                properties:
-                  url: myapp.com/api/count
-                headers:
-                  X-Api-Key:
-                    _secret: API_KEY
-            # ...
-            requests:
-              - id: get_count
-                type: AxiosHttp
-                connectionId: get_count
-            ```
-
-            ###### Setting properties on only the request, and using a generic connection:
-            ```yaml
-            connections:
-              - id: axios
-                type: AxiosHttp
-            # ...
-            requests:
-              - id: get_api_1
-                type: AxiosHttp
-                connectionId: axios
-                properties:
-                  url: app1.com/api/things
-              - id: post_to_api_2
-                type: AxiosHttp
-                connectionId: axios
-                properties:
-                  url: api.otherapp.org/other/thing
-                  method: post
-                  data:
-                    _state: true
-            ```