@lowdefy/docs-content 0.0.0-experimental-20260710073520

package/content/operators/_uri.md

@@ -0,0 +1,49 @@
+# _uri
+
+The `_uri` operator [encodes and decodes](https://en.wikipedia.org/wiki/Percent-encoding) Uniform Resource Identifiers (URI). It encodes characters that are not in the limited US-ASCII characters legal within a URI.
+
+> This operator can be used as a [`_build`](/_build) operator method.
+
+# Operator methods:
+
+## _uri.decode
+
+```
+(value: string): string
+```
+
+The `_uri.decode` method decodes a string that has been uri-encoded. It uses [`decodeURIComponent`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent).
+
+#### Arguments
+
+###### string
+The string to decode.
+
+#### Examples
+
+###### Decode a base64 string:
+```yaml
+_uri.decode: http%3A%2F%2Fusername%3Apassword%40www.example.com%3A80%2Fpath%2Fto%2Ffile.php%3Ffoo%3D316%26bar%3Dthis%2Bhas%2Bspaces%23anchor
+```
+Returns: `"http://username:password@www.example.com:80/path/to/file.php?foo=316&bar=this+has+spaces#anchor"`.
+
+## _uri.encode
+
+```
+(value: string): string
+```
+
+The `_uri.encode` uri-encodes a string. It uses [`encodeURIComponent`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent).
+
+#### Arguments
+
+###### string
+The string to encode.
+
+#### Examples
+
+###### Encode a string as base64:
+```yaml
+_uri.encode: http://username:password@www.example.com:80/path/to/file.php?foo=316&bar=this+has+spaces#anchor
+```
+Returns: `"http%3A%2F%2Fusername%3Apassword%40www.example.com%3A80%2Fpath%2Fto%2Ffile.php%3Ffoo%3D316%26bar%3Dthis%2Bhas%2Bspaces%23anchor"`.

package/content/operators/_url_query.md

@@ -0,0 +1,92 @@
+# _url_query
+
+```
+(key: string): any
+(all: boolean): any
+(arguments: {
+  all?: boolean,
+  key?: string,
+  default?: any,
+}): any
+```
+
+The `_url_query` operator gets a value from the [`urlQuery`](/page-and-app-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 [page](/page-and-app-state) the operator is used in.
+
+`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.
+
+#### 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.

package/content/operators/_user.md

@@ -0,0 +1,154 @@
+# _user
+
+```
+(key: string): any
+(all: boolean): any
+(arguments: {
+  all?: boolean,
+  key?: string,
+  default?: any,
+}): any
+```
+
+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.
+
+# Operator methods:
+
+## _user.hasRole
+
+```
+(role: string): boolean
+```
+
+The `_user.hasRole` method returns `true` if the `user.roles` array contains the given role. It returns `false` when the user is not logged in, when `user.roles` is missing, or when the role is not present.
+
+The `user.roles` value is read directly from the `user` object and must be an array of strings. An error is thrown if `user.roles` is defined but is not an array, or if the argument is not a string.
+
+#### Examples
+
+###### Check for a single role:
+```yaml
+_user.hasRole: admin
+```
+Returns: `true` if `user.roles` includes `"admin"`.
+
+## _user.hasSomeRoles
+
+```
+(roles: string[]): boolean
+```
+
+The `_user.hasSomeRoles` method returns `true` if the `user.roles` array contains at least one of the given roles. It returns `false` when the user is not logged in, when `user.roles` is missing, or when none of the roles match.
+
+The `user.roles` value is read directly from the `user` object and must be an array of strings. An error is thrown if `user.roles` is defined but is not an array, or if the argument is not an array of strings.
+
+For checking a single role, use [`_user.hasRole`](#hasRole).
+
+#### Examples
+
+###### Check for any of several roles:
+```yaml
+_user.hasSomeRoles:
+  - admin
+  - support
+```
+Returns: `true` if `user.roles` includes `"admin"` or `"support"`.
+
+## _user.hasAllRoles
+
+```
+(roles: string[]): boolean
+```
+
+The `_user.hasAllRoles` method returns `true` if the `user.roles` array contains every one of the given roles. It returns `false` when the user is not logged in, when `user.roles` is missing, or when any required role is not present.
+
+The `user.roles` value is read directly from the `user` object and must be an array of strings. An error is thrown if `user.roles` is defined but is not an array, or if the argument is not an array of strings.
+
+For checking a single role, use [`_user.hasRole`](#hasRole).
+
+#### Examples
+
+###### Require all of several roles:
+```yaml
+_user.hasAllRoles:
+  - admin
+  - support
+```
+Returns: `true` only if `user.roles` includes both `"admin"` and `"support"`.

package/content/operators/_uuid.md

@@ -0,0 +1,118 @@
+# _uuid
+
+```
+(void): string
+```
+
+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
+```
+
+#### 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.
+
+# Operator methods:
+
+## _uuid.v1
+
+```
+(void): string
+```
+
+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.
+
+## _uuid.v3
+
+```
+({name: string | string[], namespace: string | string[]}): string
+([name: string | string[], namespace: string | string[]]): string
+```
+
+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.
+
+## _uuid.v4
+
+```
+(void): string
+```
+
+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.
+
+## _uuid.v5
+
+```
+({name: string | string[], namespace: string | string[]}): string
+([name: string | string[], namespace: string | string[]]): string
+```
+
+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/content/operators/_var.md

@@ -0,0 +1,88 @@
+# _var
+
+```
+(key: string): any
+(arguments: {
+  key: string,
+  default?: any,
+}): any
+```
+
+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.
+
+> For module-level variables (passed by the app developer in `lowdefy.yaml` `modules[].vars`), use [`_module.var`](/_module) instead. `_module.var` works at any depth within module files without threading vars through each `_ref`.
+
+#### 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
+  - `key: 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 `key` 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:
+      key: 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/content/operators/_yaml.md

@@ -0,0 +1,96 @@
+# _yaml
+
+The `_yaml` parses and writes YAML strings.
+
+# Operator methods:
+
+## _yaml.parse
+
+```
+({on: string, options?: object}): object
+([on: string, options?: object]): object
+```
+
+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
+```
+
+## _yaml.stringify
+
+```
+({on: any, options?: object}): string
+([on: any, options?: object]): string
+```
+
+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
+```

package/content/other/introduction.md

@@ -0,0 +1,39 @@
+# Introduction
+
+Lowdefy makes it really easy to build web apps. With Lowdefy you can build CRUD apps, admin panels, internal tools, BI dashboards, workflow apps, websites, blogs, webforms or even documentation pages such as this one.
+
+Lowdefy apps are defined in YAML config that follows a structured schema - this makes Lowdefy apps easy to read, write and understand.
+
+## Quickstart
+
+Run the following command to initialize a new Lowdefy app in your current working directory.
+
+$
+
+pnpx lowdefy@5 init && pnpx lowdefy@5 dev
+
+This will create a file called `lowdefy.yaml` in the current working directory that contains the configuration for a Lowdefy app (as well as a `.gitignore`) and launch a local development server at http://localhost:3000. Make changes in the `lowdefy.yaml` file to see them reflect in the app.
+
+> You need Node v22 or newer and pnpm installed to run Lowdefy. For more details see [the tutorial](/tutorial-start).
+
+## Why create web apps using a YAML schema?
+
+The Lowdefy schema is a simple definition of a web app which primarily makes use of block, action, operator and request definitions.
+
+Some advantages of writing web apps in YAML are:
+  - All apps use the same schema. This makes it easy to debug large apps or pick up where others left off.
+  - Nothing is hidden in a GUI. This allows you to do basic stuff, like copy, paste, find, replace etc. which makes developing apps more productive.
+  - App config is just data, thus you can develop scripts to create and manage your apps.
+  - YAML files work with your favorite developer and source control tools.
+
+> If you aren't a fan of YAML, you can also build your app using JSON files.
+
+## Build future proof web apps on an source available platform
+
+To date, more than 25 000 apps have been built by the Lowdefy community. We hope to see many community Lowdefy apps and plugins in the future and actively nurture the Lowdefy community on [Github](https://github.com/lowdefy/lowdefy/discussions) and [Discord](https://discord.gg/QQY9eJ7A2D) to help other developers to get started with Lowdefy and grow the ecosystem.
+
+We've built Lowdefy to scale our own ability to develop and maintain web apps and internal tools for customers. Currently, we also provide Custom Software as a Service for larger customers, as well as support plans for those who need some extra help. Using Lowdefy we've built ticketing systems, call center solutions, advanced CRMs, custom MRPs, surveys and BI dashboard solutions and more for startup to enterprise customers. If you are looking for a Custom Software as a Service partner, please [reach out to us](http://lowdefy.com/contact-us).
+
+## Tutorial
+
+The easiest way to get started with Lowdefy is to follow the tutorial. In this tutorial we will be building a simple Lowdefy app to get you started.

package/content/other/next-auth-providers.md

@@ -0,0 +1,3 @@
+# next-auth-providers
+
+This page has moved to [Auth.js Providers](/auth-js-providers).

package/content/other/updatesession.md

@@ -0,0 +1,26 @@
+# UpdateSession
+
+```
+(void): void
+```
+
+The `UpdateSession` action is used to update the user session. If a adapter is used, any new user data in the database will be added to the user object.
+
+#### Parameters
+
+The `UpdateSession` action does not take any parameters.
+
+#### Examples
+
+###### Update session after user updates their profile:
+```yaml
+id: update_profile
+type: Button
+events:
+  onClick:
+    - id: update_profile_in_db
+      type: Request
+      params: update_user
+    - id: update_session
+      type: UpdateSession
+```