@lowdefy/docs-content 0.0.0-experimental-20260710073520

package/content/connections/sqlite.md

@@ -0,0 +1,187 @@
+# SQLite
+
+The [Knex](/Knex) connection can be used to connect to a [SQLite](https://www.sqlite.org) database.
+
+## Connections
+
+Connection types:
+  - Knex
+
+### Knex
+
+#### Properties
+- `client: enum`: __Required__ - Should be `better-sqlite3` or `sqlite` (alias of `better-sqlite3`) to connect to SQLite. SQLite uses the [`better-sqlite3`](https://github.com/WiseLibs/better-sqlite3) driver.
+- `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: better-sqlite3
+      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 = better-sqlite3
+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"}
+```
+
+## Requests
+
+Request types:
+
+- KnexBuilder
+- KnexRaw
+
+### KnexBuilder
+
+#### Properties
+
+- `query: object[]`: **Required** - SQL query builder array. An array of objects, with a single key which is the name of the knex builder function. The value should be an array of arguments to pass to the builder function.
+- `tableName: string | object`: The name of the table to query from.
+
+#### Examples
+
+###### Build a query:
+
+```yaml
+id: knexBuilder
+type: KnexBuilder
+connectionId: knex
+payload:
+  name:
+    _state: name
+properties:
+  query:
+    - select:
+        - '*'
+    - from:
+        - users
+    - where:
+        - name
+        - _payload: name
+```
+
+###### Using `tableName`:
+
+```yaml
+id: knexBuilder
+type: KnexBuilder
+connectionId: knex
+payload:
+  name:
+    _state: name
+properties:
+  tableName: users
+  query:
+    - select:
+        - '*'
+    - where:
+        - name
+        - _payload: name
+```
+
+###### Aliases:
+
+```yaml
+id: knexBuilder
+type: KnexBuilder
+connectionId: knex
+properties:
+  tableName:
+    a: tableA
+    b: tableB
+  query:
+    - select:
+        - aField: 'a.field'
+        - bField: 'b.field'
+    - limit:
+        - 1
+```
+
+### KnexRaw
+
+#### Properties
+
+- `query: string`: **Required** - SQL query string.
+- `parameters: string | number | array | object`: SQL query parameters.
+
+#### Examples
+
+###### Simple raw query:
+
+```yaml
+id: knexRaw
+type: KnexRaw
+connectionId: knex
+properties:
+  query: SELECT * FROM "my_table";
+```
+
+###### Query with named parameters:
+
+```yaml
+id: knexRaw
+type: KnexRaw
+connectionId: knex
+payload:
+  selected_name:
+    _state: selected_name
+properties:
+  query: select * from users where name = :name
+  parameters:
+    name:
+      _payload: selected_name
+```
+
+###### Query with positional parameters:
+
+```yaml
+id: knexRaw
+type: KnexRaw
+connectionId: knex
+payload:
+  selected_name:
+    _state: selected_name
+properties:
+  query: select * from users where name = ?
+  parameters:
+    - _payload: selected_name
+```
+
+###### Reference a `.sql` file:
+
+```yaml
+id: knexRaw
+type: KnexRaw
+connectionId: knex
+properties:
+  query:
+    _ref: my_query.sql
+```

package/content/connections/stripe.md

@@ -0,0 +1,115 @@
+# Stripe
+
+## Connections
+
+Connection types:
+  - Stripe
+
+### Stripe
+
+[Stripe](https://stripe.com/) is a popular payment provider which allows you to accept payments, send payouts, and manage your business online.
+The `Stripe` connector uses the official [Node.js client from Stripe](https://github.com/stripe/stripe-node).
+In order to use the `Stripe` connection, you first need to create a [Stripe](https://stripe.com/) account and setup an API key.
+
+> Secrets like API keys should be stored using the [`_secret`](operators/secret.md) operator.
+
+#### Properties
+- `secretKey: string`: __Required__ - Stripe [secret key](https://stripe.com/docs/keys).
+- `apiVersion: string`: Stripe API version to use. Defaults to the account-wide version.
+- `timeout: number`: Timeout for requests to the Stripe API.
+- `maxNetworkRetries: number`: Maximum number of times failed requests are repeated before throwing an error.
+- `telemetry: boolean`: Whether to send telemetry data to Stripe (this is forwarded to the Stripe client library. Lowdefy does not receive any telemetry data from your Stripe connection.)
+
+#### Examples
+
+###### Simple connection:
+```yaml
+connections:
+  - id: stripe
+    type: Stripe
+    properties:
+      secretKey:
+        _secret: STRIPE_SECRET_KEY
+```
+Environment variables:
+```
+LOWDEFY_SECRET_STRIPE_SECRET_KEY = sk_test_KyvNyie...
+```
+
+###### Using an older API version:
+```yaml
+connections:
+  - id: stripe
+    type: Stripe
+    properties:
+      secretKey:
+        _secret: STRIPE_SECRET_KEY
+      apiVersion: 2017-12-14
+```
+Environment variables:
+```
+LOWDEFY_SECRET_STRIPE_SECRET_KEY = sk_test_KyvNyie...
+```
+
+## Requests
+
+Request types:
+  - StripeRequest
+
+### StripeRequest
+
+The `StripeRequest` request allows calls to all modules supported by the [Stripe API client](https://stripe.com/docs/api?lang=node) by nesting the resource and method calls:
+```yaml
+resource:
+  method:
+    - parameter1
+    - parameter2
+```
+
+#### Properties
+- `{{ apiResource }}: object`: A Stripe API resource, eg. `customers`.
+  - `{{ method }}: array | null`: A resource method, eg. `create`. The arguments array will be passed on to the client method.
+
+The Stripe client exposes all resources as objects, with the API methods being available as function properties on those resource objects.
+In Lowdefy, you may access these properties by nesting them.
+
+### Examples
+
+###### List the 30 most recent customers
+```yaml
+requests:
+  - id: list_customers
+    type: StripeRequest
+    connectionId: stripe
+    properties:
+      customers:
+        list:
+          limit: 30
+```
+
+###### Create a payment intent
+```yaml
+requests:
+  - id: create_payment_intent
+    type: StripeRequest
+    connectionId: stripe
+    properties:
+      paymentIntents:
+        create:
+          - amount: 2000
+            currency: eur
+            payment_method_types: [ card ]
+```
+
+###### Retrieve a checkout session by ID
+```yaml
+requests:
+  - id: retrieve_checkout_session
+    type: StripeRequest
+    connectionId: stripe
+    properties:
+      checkout:
+        sessions:
+          retrieve:
+            - cs_test_onpT2icY2lrSU0IgDGXEhhcOHcWeJS5BpLcQGMx0uI9TZHLMBdzvWpvx
+```

package/content/container-blocks/affix.md

@@ -0,0 +1,413 @@
+# Affix
+
+An Affix block makes its content stick to the viewport when scrolling.
+
+```yaml
+- id: affix_basic_top
+  type: Affix
+  properties:
+    offsetTop: 10
+  blocks:
+    - id: affix_basic_top_btn
+      type: Button
+      properties:
+        title: Affix Top (10px)
+        color: primary
+        variant: solid
+```
+
+```yaml
+- id: affix_offset_top_0
+  type: Affix
+  layout:
+    flex: 0 0 auto
+  properties:
+    offsetTop: 0
+  blocks:
+    - id: affix_offset_top_0_btn
+      type: Button
+      layout:
+        flex: 0 0 auto
+      properties:
+        title: Offset 0px
+        color: primary
+        variant: solid
+        size: small
+- id: affix_offset_top_20
+  type: Affix
+  layout:
+    flex: 0 0 auto
+  properties:
+    offsetTop: 20
+  blocks:
+    - id: affix_offset_top_20_btn
+      type: Button
+      layout:
+        flex: 0 0 auto
+      properties:
+        title: Offset 20px
+        color: primary
+        variant: outlined
+        size: small
+- id: affix_offset_top_80
+  type: Affix
+  layout:
+    flex: 0 0 auto
+  properties:
+    offsetTop: 80
+  blocks:
+    - id: affix_offset_top_80_btn
+      type: Button
+      layout:
+        flex: 0 0 auto
+      properties:
+        title: Offset 80px
+        color: primary
+        variant: dashed
+        size: small
+```
+
+```yaml
+- id: affix_offset_bottom_0
+  type: Affix
+  layout:
+    flex: 0 0 auto
+  properties:
+    offsetBottom: 0
+  blocks:
+    - id: affix_offset_bottom_0_btn
+      type: Button
+      layout:
+        flex: 0 0 auto
+      properties:
+        title: Bottom 0px
+        color: primary
+        variant: solid
+        size: small
+- id: affix_offset_bottom_30
+  type: Affix
+  layout:
+    flex: 0 0 auto
+  properties:
+    offsetBottom: 30
+  blocks:
+    - id: affix_offset_bottom_30_btn
+      type: Button
+      layout:
+        flex: 0 0 auto
+      properties:
+        title: Bottom 30px
+        color: primary
+        variant: outlined
+        size: small
+- id: affix_offset_bottom_60
+  type: Affix
+  layout:
+    flex: 0 0 auto
+  properties:
+    offsetBottom: 60
+  blocks:
+    - id: affix_offset_bottom_60_btn
+      type: Button
+      layout:
+        flex: 0 0 auto
+      properties:
+        title: Bottom 60px
+        color: primary
+        variant: dashed
+        size: small
+```
+
+```yaml
+- id: affix_on_change
+  type: Affix
+  properties:
+    offsetTop: 10
+  events:
+    onChange:
+      - id: affix_on_change_message
+        type: DisplayMessage
+        params:
+          content:
+            _if:
+              test:
+                _eq:
+                  - _event: affixed
+                  - true
+              then: Affix is now fixed to the viewport.
+              else: Affix returned to its original position.
+          duration: 3
+  blocks:
+    - id: affix_on_change_btn
+      type: Button
+      properties:
+        title: Scroll to trigger onChange
+        color: primary
+        variant: solid
+```
+
+```yaml
+- id: affix_theme_default_z
+  type: Affix
+  layout:
+    flex: 0 0 auto
+  properties:
+    offsetTop: 10
+    theme:
+      zIndexPopup: 10
+  blocks:
+    - id: affix_theme_default_z_btn
+      type: Button
+      layout:
+        flex: 0 0 auto
+      properties:
+        title: Default z-index (10)
+        color: default
+        variant: outlined
+        size: small
+- id: affix_theme_high_z
+  type: Affix
+  layout:
+    flex: 0 0 auto
+  properties:
+    offsetTop: 10
+    theme:
+      zIndexPopup: 100
+  blocks:
+    - id: affix_theme_high_z_btn
+      type: Button
+      layout:
+        flex: 0 0 auto
+      properties:
+        title: High z-index (100)
+        color: primary
+        variant: solid
+        size: small
+- id: affix_theme_low_z
+  type: Affix
+  layout:
+    flex: 0 0 auto
+  properties:
+    offsetTop: 10
+    theme:
+      zIndexPopup: 1
+  blocks:
+    - id: affix_theme_low_z_btn
+      type: Button
+      layout:
+        flex: 0 0 auto
+      properties:
+        title: Low z-index (1)
+        color: default
+        variant: dashed
+        size: small
+```
+
+```yaml
+- id: affix_css_shadow
+  type: Affix
+  layout:
+    flex: 0 0 auto
+  class:
+    element: shadow-lg rounded-lg
+  properties:
+    offsetTop: 10
+  blocks:
+    - id: affix_css_shadow_btn
+      type: Button
+      layout:
+        flex: 0 0 auto
+      properties:
+        title: Shadow + Rounded
+        color: primary
+        variant: solid
+        size: small
+- id: affix_css_ring
+  type: Affix
+  layout:
+    flex: 0 0 auto
+  class:
+    element: ring-2 ring-green-400 rounded-lg
+  properties:
+    offsetTop: 10
+  blocks:
+    - id: affix_css_ring_btn
+      type: Button
+      layout:
+        flex: 0 0 auto
+      properties:
+        title: Ring Border
+        color: default
+        variant: outlined
+        size: small
+```
+
+```yaml
+- id: affix_style_zindex
+  type: Affix
+  properties:
+    offsetTop: 10
+  style:
+    .element:
+      zIndex: 200
+      boxShadow: 0 4px 12px rgba(0, 0, 0, 0.15)
+  blocks:
+    - id: affix_style_zindex_btn
+      type: Button
+      properties:
+        title: Custom z-index (200) + Shadow
+        color: primary
+        variant: solid
+```
+
+Edit Employee Record
+
+```yaml
+- id: affix_form_toolbar
+  type: Affix
+  properties:
+    offsetTop: 0
+  blocks:
+    - id: affix_form_toolbar_card
+      type: Card
+      properties:
+        size: small
+        bordered: true
+      blocks:
+        - id: affix_form_toolbar_row
+          type: Box
+          layout:
+            gap: 8
+            justify: space-between
+            align: center
+          blocks:
+            - id: affix_form_toolbar_title
+              type: Title
+              layout:
+                flex: 0 0 auto
+              properties:
+                content: Edit Employee Record
+                level: 5
+            - id: affix_form_toolbar_actions
+              type: Box
+              layout:
+                flex: 0 0 auto
+                gap: 8
+              blocks:
+                - id: affix_form_toolbar_discard
+                  type: Button
+                  layout:
+                    flex: 0 0 auto
+                  properties:
+                    title: Discard
+                    color: default
+                    variant: outlined
+                    size: small
+                  events:
+                    onClick:
+                      - id: affix_form_toolbar_discard_msg
+                        type: DisplayMessage
+                        params:
+                          content: Changes discarded.
+                          status: warning
+                - id: affix_form_toolbar_save
+                  type: Button
+                  layout:
+                    flex: 0 0 auto
+                  properties:
+                    title: Save Changes
+                    icon: AiOutlineSave
+                    color: primary
+                    variant: solid
+                    size: small
+                  events:
+                    onClick:
+                      - id: affix_form_toolbar_save_msg
+                        type: DisplayMessage
+                        params:
+                          content: Employee record saved successfully.
+                          status: success
+```
+
+3 items selected
+
+```yaml
+- id: affix_bottom_bar
+  type: Affix
+  properties:
+    offsetBottom: 0
+  blocks:
+    - id: affix_bottom_bar_card
+      type: Card
+      class: shadow-lg
+      properties:
+        size: small
+      blocks:
+        - id: affix_bottom_bar_row
+          type: Box
+          layout:
+            gap: 12
+            justify: flex-end
+            align: center
+          blocks:
+            - id: affix_bottom_bar_status
+              type: Paragraph
+              layout:
+                flex: 1 1 0
+              properties:
+                content: 3 items selected
+            - id: affix_bottom_bar_delete
+              type: Button
+              layout:
+                flex: 0 0 auto
+              properties:
+                title: Delete
+                icon: AiOutlineDelete
+                color: danger
+                variant: outlined
+                size: small
+              events:
+                onClick:
+                  - id: affix_bottom_bar_delete_msg
+                    type: DisplayMessage
+                    params:
+                      content: Items deleted.
+                      status: error
+            - id: affix_bottom_bar_export
+              type: Button
+              layout:
+                flex: 0 0 auto
+              properties:
+                title: Export
+                icon: AiOutlineDownload
+                color: primary
+                variant: solid
+                size: small
+              events:
+                onClick:
+                  - id: affix_bottom_bar_export_msg
+                    type: DisplayMessage
+                    params:
+                      content: Export started.
+                      status: success
+```
+
+| Property | Type | Default | Description |
+| --- | --- | --- | --- |
+| `offsetBottom` | number | - | Offset from the bottom of the viewport (in pixels). |
+| `offsetTop` | number | - | Offset from the top of the viewport (in pixels). |
+| `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design affix tokens](https://ant.design/components/affix#design-token). |
+| `theme.zIndexPopup` | number | `10` | Z-index of the affix element when fixed. |
+
+| Event | Event Data | Description |
+| --- | --- | --- |
+| `onChange` | \- | Triggered when container affix status changes. |
+
+| Key | Target |
+| --- | --- |
+| `/block` | Outer block wrapper (always available). |
+| `/element` | The Affix element. |
+
+| Slot | Description |
+| --- | --- |
+| `content` | Child blocks wrapped by the Affix. |