@lowdefy/docs-content 0.0.0-experimental-20260710073520

package/content/operators/_jsonata.md

@@ -0,0 +1,152 @@
+# _jsonata
+
+```
+(arguments: {on: any, expr: string, bindings?: object}): any
+```
+
+The `_jsonata` operator provides a powerful query and transformation language for JSON data using the [JSONata](https://jsonata.org) library. JSONata is a lightweight query and transformation language that allows you to navigate, query, and transform JSON structures with simple and intuitive expressions.
+
+#### Arguments
+
+###### object
+  - `on: any`: The input data to evaluate the expression against.
+  - `expr: string`: A JSONata expression string.
+  - `bindings?: object`: Optional bindings object to provide additional variables to the expression.
+
+#### Examples
+
+###### Basic arithmetic:
+```yaml
+_jsonata:
+  on:
+    a: 5
+    b: 3
+  expr: a + b
+```
+Returns: `8`
+
+###### String concatenation:
+```yaml
+_jsonata:
+  on:
+    firstName: John
+    lastName: Doe
+  expr: firstName & " " & lastName
+```
+Returns: `"John Doe"`
+
+###### Array filtering:
+```yaml
+_jsonata:
+  on:
+    items: [1, 2, 3, 4, 5]
+  expr: items[$ > 3]
+```
+Returns: `[4, 5]`
+
+###### Array mapping:
+```yaml
+_jsonata:
+  on:
+    users:
+      - name: Alice
+        age: 30
+      - name: Bob
+        age: 25
+  expr: users.name
+```
+Returns: `["Alice", "Bob"]`
+
+###### Using bindings for external variables:
+```yaml
+_jsonata:
+  on:
+    price: 100
+  expr: price * taxRate
+  bindings:
+    taxRate: 1.2
+```
+Returns: `120`
+
+###### Aggregation with built-in functions:
+```yaml
+_jsonata:
+  on:
+    items: [1, 2, 3, 4, 5]
+  expr: $sum(items)
+```
+Returns: `15`
+
+###### Conditional expression:
+```yaml
+_jsonata:
+  on:
+    temperature: 25
+  expr: temperature > 20 ? "warm" : "cold"
+```
+Returns: `"warm"`
+
+###### Object transformation:
+```yaml
+_jsonata:
+  on:
+    user:
+      firstName: Jane
+      lastName: Smith
+      email: jane@example.com
+  expr: |
+    {
+      "fullName": user.firstName & " " & user.lastName,
+      "contact": user.email
+    }
+```
+Returns:
+```json
+{
+  "fullName": "Jane Smith",
+  "contact": "jane@example.com"
+}
+```
+
+###### Array transformation:
+```yaml
+_jsonata:
+  on:
+    orders:
+      - id: 1
+        amount: 100
+      - id: 2
+        amount: 200
+  expr: orders.{ "orderId": id, "total": amount * 1.1 }
+```
+Returns:
+```json
+[
+  { "orderId": 1, "total": 110 },
+  { "orderId": 2, "total": 220 }
+]
+```
+
+###### Complex transformation with aggregation:
+```yaml
+_jsonata:
+  on:
+    user:
+      firstName: Jane
+      lastName: Smith
+    orders:
+      - total: 100
+      - total: 200
+  expr: |
+    {
+      "customer": user.firstName & " " & user.lastName,
+      "totalSpent": $sum(orders.total)
+    }
+```
+Returns:
+```json
+{
+  "customer": "Jane Smith",
+  "totalSpent": 300
+}
+```

package/content/operators/_locale.md

@@ -0,0 +1,65 @@
+# _locale
+
+```
+(key: 'active' | 'default' | 'fallback' | 'supported'): string | object[]
+```
+
+The `_locale` operator reads the current locale state. Use it to render language pickers, conditional content per locale, or to display the active locale.
+
+The view exposes:
+
+- `active: string` — the resolved active locale (e.g. `'de-DE'`).
+- `default: string` — the configured `config.i18n.defaultLocale`.
+- `fallback: string` — always `'en-US'`. Lowdefy uses `en-US` as a fixed fallback when a key is missing in the active locale, so plugin and module authors should always ship `en-US` translations.
+- `supported: object[]` — the list of locales declared in `config.i18n.locales`. Each item has `{ code, label, antd, dayjs }`.
+
+Pair with the [`SetLocale`](/SetLocale) action to build a language picker.
+
+#### Arguments
+
+###### string
+One of `active`, `default`, `fallback`, or `supported`.
+
+#### Examples
+
+###### Read the active locale:
+```yaml
+_locale: active
+```
+Returns: e.g. `"de-DE"`.
+
+###### Render a language picker:
+
+`_locale: supported` returns `[{ code, label, antd, dayjs }, ...]`. Selector options must be an array of `{ value, label }` pairs — project each descriptor onto that shape with `_array.map`:
+```yaml
+- id: lang_picker
+  type: Selector
+  properties:
+    options:
+      _array.map:
+        on:
+          _locale: supported
+        callback:
+          _function:
+            value:
+              __args: 0.code
+            label:
+              __args: 0.label
+    value:
+      _locale: active
+  events:
+    onChange:
+      - id: set_locale
+        type: SetLocale
+        params:
+          locale:
+            _state: lang_picker
+```
+
+###### Show only when a specific locale is active:
+```yaml
+visible:
+  _eq:
+    - _locale: active
+    - de-DE
+```

package/content/operators/_location.md

@@ -0,0 +1,40 @@
+# _location
+
+```
+(key: string): any
+```
+
+The `_location` operator gets a value from the browser [Location](https://developer.mozilla.org/en-US/docs/Web/API/Location) interface. The Location interface represents the location (URL) of the window object it is linked to, thus can return the URL elements of the current window. It can only be used on the web-client (Not in `requests` or `connections`).
+
+The following location properties are available.
+- `basePath: string`: The application base path setting.
+- `hash: string`: A string containing a '#' followed by the fragment identifier of the URL.
+- `host: string`: A string containing the host, that is the hostname, a `:`, and the port of the URL.
+- `hostname: string`: The domain of the URL.
+- `homePageId: string`: The home page id.
+- `href: string`: The entire URL string.
+- `origin: string`: The canonical form of the origin of the specific location.
+- `pageId: string`: The current page id.
+- `pathname: string`: A string containing an initial `/`` followed by the path of the URL, not including the query string or fragment.
+- `port: string`: The port number of the URL
+- `protocol: string`: The protocol scheme of the URL, mostly `http:` or `https:`.
+- `search: string`: A string containing a '?' followed by the parameters or "querystring" of the URL.
+
+#### Arguments
+
+###### string
+If called with a string argument, the value of the key in the `location` object is returned. If the value is defined, `null` is returned.
+
+#### Examples
+
+###### Get the `origin` from `location`:
+```yaml
+_location: origin
+```
+Returns: The current `window.location.origin`, in this case 'https://docs.lowdefy.com'.
+
+###### Get the `pathname` from `location`:
+```yaml
+_location: pathname
+```
+Returns: The current `window.location.pathname`, in this case '/_location'.

package/content/operators/_log.md

@@ -0,0 +1,22 @@
+# _log
+
+```
+(value: any): any
+```
+
+The `_log` operator logs it input to the console, and returns the value it received. Since it returns the value it received, it can be used to debug without affecting the rest of the configuration.
+
+> This operator can be used as a [`_build`](/_build) operator method.
+
+#### Arguments
+
+###### any
+
+#### Examples
+
+###### Log the results of a request to the console:
+```yaml
+_log:
+  _request: my_request
+```
+Returns: The value of the request

package/content/operators/_lt.md

@@ -0,0 +1,50 @@
+# _lt
+
+```
+([value1: any, value2: any]): boolean
+```
+
+The `_lt` operator tests if the first value is less than the second equal. It takes an array of two values to test.
+
+> The `_lt` operator tests using the javascript less than operator. You can find a description of the algorithm used to compare two values [here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Less_than).
+
+> This operator can be used as a [`_build`](/_build) operator method.
+
+#### Arguments
+
+###### array
+An array of two values to compare.
+
+#### Examples
+
+###### Two numbers:
+```yaml
+_lt:
+  - 4
+  - 3
+```
+Returns: `false`
+
+```yaml
+_lt:
+  - 1
+  - 1
+```
+Returns: `false`
+
+```yaml
+_lt:
+  - _sum:
+      - 3
+      - 4
+  - 8
+```
+Returns: `true`
+
+#### Two strings:
+```yaml
+_lt:
+  - "a"
+  - "b"
+```
+Returns: `true`

package/content/operators/_lte.md

@@ -0,0 +1,50 @@
+# _lte
+
+```
+([value1: any, value2: any]): boolean
+```
+
+The `_lte` operator tests if the first value is less than or equal to the second equal. It takes an array of two values to test.
+
+> The `_lte` operator tests using the javascript less than or equal to operator. You can find a description of the algorithm used to compare two values [here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Less_than).
+
+> This operator can be used as a [`_build`](/_build) operator method.
+
+#### Arguments
+
+###### array
+An array of two values to compare.
+
+#### Examples
+
+###### Two numbers:
+```yaml
+_lte:
+  - 4
+  - 3
+```
+Returns: `false`
+
+```yaml
+_lte:
+  - 1
+  - 1
+```
+Returns: `true`
+
+```yaml
+_lte:
+  - _sum:
+      - 3
+      - 4
+  - 8
+```
+Returns: `true`
+
+###### Two strings:
+```yaml
+_lte:
+  - "a"
+  - "b"
+```
+Returns: `true`