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

package/connections/MySQL.yaml

@@ -1,92 +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: MySQL
-    pageTitle: MySQL
-    section: Connections
-    filePath: connections/MySQL.yaml
-    content:
-      - id: markdown_intro
-        type: Markdown
-        properties:
-          content: |
-            The [Knex](/Knex) connection can be used to connect to a [MySQL](https://www.mysql.com) database.
-
-      - id: markdown_connection
-        type: MarkdownWithCode
-        properties:
-          content: |
-            ## Connections
-
-            Connection types:
-              - Knex
-
-            ### Knex
-
-            #### Properties
-            - `client: enum`: __Required__ - Should be `mysql` to connect to MySQL.
-            - `connection: object | string `: __Required__ - Connection object or string to pass to the [`mysql`](https://www.npmjs.com/package/mysql) database client.
-            - `version: string`:  Set database version.
-            - `useNullAsDefault: boolean`: If true, undefined keys are replaced with NULL instead of DEFAULT.
-
-            #### Examples
-
-            ###### Connection Object:
-            ```yaml
-            connections:
-              - id: mysql
-                type: Knex
-                properties:
-                  client: mysql
-                  connection:
-                    host:
-                      _secret: MYSQL_HOST
-                    user:
-                      _secret: MYSQL_USER
-                    database:
-                      _secret: MYSQL_DB
-                    password:
-                      _secret: MYSQL_PASSWORD
-            ```
-            Environment variables:
-            ```
-            LOWDEFY_SECRET_MYSQL_HOST = database.server.com
-            LOWDEFY_SECRET_MYSQL_DB = db
-            LOWDEFY_SECRET_MYSQL_USER = user
-            LOWDEFY_SECRET_MYSQL_PASSWORD = password
-            ```
-
-            ###### Connection string:
-            ```yaml
-            connections:
-              - id: mysql
-                type: Knex
-                properties:
-                  client: mysql
-                  connection:
-                    _secret: MYSQL_CONNECTION_STRING
-            ```
-            Environment variables:
-            ```
-            LOWDEFY_SECRET_MYSQL_CONNECTION_STRING = mysql://user:password@database.server.com/db
-            ```
-
-      - id: markdown_requests
-        type: MarkdownWithCode
-        properties:
-          content:
-            _ref: connections/KnexRequests.md

package/connections/OracleDB.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/general.yaml.njk
-  vars:
-    pageId: OracleDB
-    pageTitle: Oracle Database
-    section: Connections
-    filePath: connections/OracleDB.yaml
-    content:
-      - id: markdown_intro
-        type: Markdown
-        properties:
-          content: |
-            The [Knex](/Knex) connection can be used to connect to a [Oracle Database](https://www.oracle.com/database/).
-
-      - id: markdown_connection
-        type: MarkdownWithCode
-        properties:
-          content: |
-            ## Connections
-
-            Connection types:
-              - Knex
-
-            ### Knex
-
-            #### Properties
-            - `client: enum`: __Required__ - Should be `oracledb` to connect to Oracle Database.
-            - `connection: object | string `: __Required__ - Connection object or string to pass to the [`oracledb`](https://www.npmjs.com/package/oracledb) database client.
-            - `useNullAsDefault: boolean`: If true, undefined keys are replaced with NULL instead of DEFAULT.
-
-            #### Examples
-
-            ###### Connection Object:
-            ```yaml
-            connections:
-              - id: oracledb
-                type: Knex
-                properties:
-                  client: oracledb
-                  connection:
-                    user:
-                      _secret: ORACLEDB_USER
-                    password:
-                      _secret:
-                    connectString:
-                      _secret: ORACLEDB_CONNECT_STRING
-            ```
-            Environment variables:
-            ```
-            LOWDEFY_SECRET_ORACLEDB_USER = user
-            LOWDEFY_SECRET_ORACLEDB_PASSWORD = password
-            LOWDEFY_SECRET_ORACLEDB_CONNECT_STRING = database.server.com/db
-            ```
-
-      - id: markdown_requests
-        type: MarkdownWithCode
-        properties:
-          content:
-            _ref: connections/KnexRequests.md

package/connections/PostgreSQL.yaml

@@ -1,99 +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: PostgreSQL
-    pageTitle: PostgreSQL
-    section: Connections
-    filePath: connections/PostgreSQL.yaml
-    content:
-      - id: markdown_intro
-        type: Markdown
-        properties:
-          content: |
-            The [Knex](/Knex) connection can be used to connect to a [PostgreSQL](https://www.postgresql.org) database.
-
-      - id: markdown_connection
-        type: MarkdownWithCode
-        properties:
-          content: |
-            ## Connections
-
-            Connection types:
-              - Knex
-
-            ### Knex
-
-            #### Properties
-            - `client: enum`: __Required__ - The database client to use. To connect to PostgreSQL, use one of:
-              - `postgres`
-              - `pg` (alias of `postgres`)
-              - `postgresql` (alias of `postgres`)
-            - `connection: object | string`: __Required__ - Connection string or object to pass to the [`pg`](https://www.npmjs.com/package/pg) database client.
-            - `searchPath: string`:  Set PostgreSQL search path.
-            - `version: string`:  Set database version.
-            - `useNullAsDefault: boolean`: If true, undefined keys are replaced with NULL instead of DEFAULT.
-
-            #### Examples
-
-            ###### Connection Object:
-            ```yaml
-            connections:
-              - id: postgres
-                type: Knex
-                properties:
-                  client: postgres
-                  connection:
-                    user:
-                      _secret: PG_USER
-                    host:
-                      _secret: PG_HOST
-                    database:
-                      _secret: PG_DB
-                    password:
-                      _secret: PG_PASSWORD
-            ```
-            Environment variables:
-            ```
-            LOWDEFY_SECRET_PG_HOST = database.server.com
-            LOWDEFY_SECRET_PG_DB = db
-            LOWDEFY_SECRET_PG_USER = user
-            LOWDEFY_SECRET_PG_PASSWORD = password
-            ```
-
-            ###### Secret connection string, with version and searchPath:
-            ```yaml
-            connections:
-              - id: postgres
-                type: Knex
-                properties:
-                  client: postgres
-                  connection:
-                    _secret: PG_CONNECTION_STRING
-                  version: '7.2'
-                  searchPath:
-                    - knex
-                    - public
-            ```
-            Environment variables:
-            ```
-            LOWDEFY_SECRET_PG_CONNECTION_STRING = postgresql://user:password@database.server.com:5432/db
-            ```
-      - id: markdown_requests
-        type: MarkdownWithCode
-        properties:
-          content:
-            _ref: connections/KnexRequests.md

package/connections/Redis.yaml

@@ -1,147 +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: Redis
-    pageTitle: Redis
-    section: Connections
-    filePath: connections/Redis.yaml
-    content:
-      - id: markdown_intro
-        type: MarkdownWithCode
-        properties:
-          content: |
-            [`Redis`](http://redis.io/) is an open-source, in-memory key-value data structure store. Redis offers a set of versatile in-memory data structures (strings, hashes, lists, sets, sorted sets with range queries, bitmaps, hyperloglogs, geospatial indexes, and streams) that allow the creation of many custom applications. Key use cases for Redis include database, caching, session management and message broker.
-
-            Lowdefy integrates with Redis using the one of the recommended [Node.js clients (node-redis)](https://github.com/redis/node-redis).
-
-      - id: markdown_connection
-        type: MarkdownWithCode
-        properties:
-          content: |
-            ## Connections
-
-            Connection types:
-              - Redis
-
-            ### Redis
-
-            #### Properties
-            - `connection: object | string `: __Required__ - Connection object or string to pass to the [`redis client`](https://github.com/redis/node-redis) redis client.
-
-            The connection object accepts will be passed to the redis client verbatim, so check out the [configuration instructions](https://github.com/redis/node-redis/blob/master/docs/client-configuration.md).
-
-            #### Examples
-
-            ###### Redis with connection object:
-            ```yaml
-            connections:
-              - id: redis
-                type: Redis
-                properties:
-                  connection:
-                    username: 
-                      _secret: REDIS_USERNAME
-                    password: 
-                      _secret: REDIS_PASSWORD
-                    database:
-                      _secret: REDIS_DATABASE
-                    socket:
-                      host:
-                        _secret: REDIS_HOST
-                      port:
-                        _secret: REDIS_PORT
-            ```
-            Environment variables:
-            ```
-            LOWDEFY_SECRET_REDIS_USERNAME = user
-            LOWDEFY_SECRET_REDIS_PASSWORD = password
-            LOWDEFY_SECRET_REDIS_DATABASE = 4
-            LOWDEFY_SECRET_REDIS_HOST = redis.server.com
-            LOWDEFY_SECRET_REDIS_PORT = 5000
-            ```
-
-            ###### Redis with connection string:
-            ```yaml
-            connections:
-              - id: redis
-                type: Redis
-                properties:
-                  connection:
-                    _secret: REDIS_CONNECTION_STRING
-            ```
-            Environment variables:
-            ```
-            LOWDEFY_SECRET_REDIS_CONNECTION_STRING = redis://user:password@redis:server.com:5000/4'
-            ```
-      - id: markdown_requests
-        type: MarkdownWithCode
-        properties:
-          content: |
-            ## Requests
-
-            Request types:
-              - Redis
-
-            ### Redis
-
-            #### Properties
-
-            - `command: string`: **Required** - Redis command to be executed, accepts all of the [out-of-the-box Redis commands](https://redis.io/commands).
-            - `parameters: array`: An array of parameters to be passed to the redis command.
-            - `modifiers: object`: The redis modififers to be passed to the redis command.
-
-            #### Examples
-
-            ###### Setting a key-value pair in redis:
-
-            ```yaml
-            id: redisRequest
-            type: Redis
-            connectionId: redis
-            properties:
-              command: set
-              parameters:
-                - key
-                - value
-            ```
-
-            ###### Getting a value from redis:
-
-            ```yaml
-            id: redisRequest
-            type: Redis
-            connectionId: redis
-            properties:
-              command: get
-              parameters:
-                - key
-            ```
-
-            ###### Setting a key-value pair only if key does not exist:
-
-            ````yaml
-            id: redisRequest
-            type: Redis
-            connectionId: redis
-            properties:
-              command: set
-              parameters:
-                - key
-                - value
-              modififers:
-                nx: true
-            ```

package/connections/SQLite.yaml

@@ -1,94 +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: SQLite
-    pageTitle: SQLite
-    section: Connections
-    filePath: connections/SQLite.yaml
-    content:
-      - id: markdown_intro
-        type: Markdown
-        properties:
-          content: |
-            The [Knex](/Knex) connection can be used to connect to a [SQLite](https://www.sqlite.org) database.
-      - id: warning
-        type: Alert
-        properties:
-          type: warning
-          showIcon: false
-          description: |
-            SQLite is best suited as a development database when used with Lowdefy. Using SQLite in a serverless environment is not recommended, and not supported by the current Lowdefy deployment options. See the example below on how to configure different database connections based on the environment.
-
-      - id: markdown_connection
-        type: MarkdownWithCode
-        properties:
-          content: |
-            ## Connections
-
-            Connection types:
-              - Knex
-
-            ### Knex
-
-            #### Properties
-            - `client: enum`: __Required__ - Should be `sqlite3` or `sqlite` to connect to SQLite.
-            - `connection: object`:
-              - `filename: string`:  __Required__ - The path to the SQLite file (relative to the project root).
-            - `useNullAsDefault: boolean`: If true, undefined keys are replaced with NULL instead of DEFAULT.
-
-
-            #### Examples
-
-            ##### Specify filename:
-            ```yaml
-            connections:
-              - id: sqlite
-                type: Knex
-                properties:
-                  client: sqlite
-                  connection:
-                    filename: ./mydb.sqlite
-            ```
-
-            ###### Different connections in deployment and production environments:
-            ```yaml
-            connections:
-              - id: knex
-                type: Knex
-                properties:
-                  client:
-                    _secret: KNEX_CLIENT
-                  connection:
-                    _json.parse:
-                      _secret: KNEX_CONNECTION
-            ```
-            Environment variables in development:
-            ```
-            LOWDEFY_SECRET_KNEX_CLIENT = sqlite
-            LOWDEFY_SECRET_KNEX_CONNECTION = {"filename": "./mydb.sqlite"}
-            ```
-            Environment variables in production:
-            ```
-            LOWDEFY_SECRET_KNEX_CLIENT = postgres
-            LOWDEFY_SECRET_KNEX_CONNECTION = {"user": "dbuser", "host": "database.server.com", "database": "mydb", "password": "secretpassword"}
-            ```
-
-      - id: markdown_requests
-        type: MarkdownWithCode
-        properties:
-          content:
-            _ref: connections/KnexRequests.md

package/connections/SendGridMail.yaml

@@ -1,113 +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: SendGridMail
-    pageTitle: SendGrid Email
-    section: Connections
-    filePath: connections/SendGridMail.yaml
-    content:
-      - id: markdown
-        type: MarkdownWithCode
-        properties:
-          content: |
-            [SendGrid](https://sendgrid.com/) is a popular email API provider which allows you to easily setup a email service. The `SendGridMail` connection can be used to connect to an existing SendGrid API account.
-
-            The `SendGridMail` connector uses the [@sendgrid/mail](https://github.com/@sendgrid/mail) library.
-
-            In order to use the `SendGridMail` connector, you first need to create a [SendGrid](https://sendgrid.com/) account and setup an API key.
-
-            > Secrets like API keys should be stored using the [`_secret`](operators/secret.md) operator.
-
-            In order to send from your custom domain your will need to [authenticate your domain](https://app.sendgrid.com/settings/sender_auth) through SendGrid. See the [SendGrid Docs](https://sendgrid.com/docs) for help on getting started with SendGrid.
-
-            ## Connections
-
-            Connection types:
-              - SendGridMail
-
-            ## Requests
-
-            Request types:
-              - SendGridMailSend
-
-            ### Types
-
-            - `email: string | object`:  SendGrid accepts emails as either a `string` or an `object`.
-              - `string`: Can be in the following format; `someone@example.org` or `Some One <someone@example.org>`.
-              - `object`: With `name' and `email` properties, for example: `{"name": "Some One", "email": "someone@example.org"}`.
-
-            ### SendGridMail
-
-            #### Properties
-
-            - `apiKey: string`: __Required__ - SendGrid API key.
-            - `from: email`: __Required__ - Email address to send email from.
-            - `mailSettings: object`: SendGrid mail settings. See [SendGrid API-Reference](https://sendgrid.com/docs/api-reference/)
-              - `sandboxMode: object`: SendGrid mail sandbox mode settings.
-                - `enable: boolean`: Sandbox mode enabled when `true`.
-            - `templateId: string`: SendGrid email template ID to render email when sending.
-
-            ### SendGridMailSend
-
-            #### Properties
-
-            ##### object
-            A `mail description`:
-            - `to: email | email[]`: __Required__ - Email address or addresses to send to.
-            - `cc: email | email[]`: Email address to cc in communication.
-            - `bcc: email | email[]`: Email address to bcc in communication.
-            - `replyTo: email | email[]`: Email address to reply to.
-            - `subject: string`: Email subject.
-            - `text: string`: Email message in plain text format.
-            - `html: string`: Email message in html format.
-            - `dynamicTemplateData: object`: SendGrid template data to render into email template.
-            - `sendAt: integer`: A unix timestamp allowing you to specify when you want your email to be delivered. You can't schedule more than 72 hours in advance.
-            - `attachments: object[]`: List of email attachments to include with email. See [SendGrid API-Reference](https://d2w67tjf43xwdp.cloudfront.net/Classroom/Build/Add_Content/attachments.html]).
-              - `content: string`: __Required__ - Base 64 encoded attachment content.
-              - `filename: string`: __Required__ - Name of the attachment file.
-              - `type: string`: The mime type of the content you are attaching. For example, `text/plain` or `text/html`.
-
-            ##### array
-            An array of `mail description` objects can also be provided.
-
-            ### Examples
-
-            ###### Send a reminder email
-            ```yaml
-            connections:
-              - id: my_sendgrid
-                type: SendGridMail
-                properties:
-                  apiKey:
-                    _secret: SENDGRID_API_KEY
-                  from: reminders@example.org
-            # ...
-            requests:
-              - id: send_reminder
-                type: SendGridMailSend
-                connectionId: my_sendgrid
-                properties:
-                  to: Harry Potter <harry@example.org>
-                  subject: Reminder for Mr. Potter to water the 🌱
-                  text: |
-                    Hi Harry
-
-                    Please remember to water the magic plants today :)
-
-                    Thank you
-            # ...
-            ```