@lowdefy/docs-content 0.0.0-experimental-20260710073520

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

package/README.md

@@ -0,0 +1,20 @@
+# @lowdefy/docs-content
+
+Lowdefy documentation extracted as markdown, for serving to AI coding agents via the dev server's `/docs` routes and MCP endpoint.
+
+## Contents
+
+- `content/<section>/<slug>.md` — one markdown file per docs page (concepts, tutorial, operators, actions, connections, blocks, ...).
+- `index.json` — manifest of all docs: `{ version, docs: [{ slug, title, section, path, kind?, typeName? }] }`. `kind`/`typeName` map a plugin type (e.g. operator `_get`) to its doc.
+
+## Regenerating content
+
+Content is generated from the `packages/docs` Lowdefy app during a docs build and committed to this package. To regenerate, run from the repo root:
+
+```bash
+pnpm docs:content
+```
+
+This runs the docs build with `LOWDEFY_EXTRACT_AGENT_DOCS=true`, which invokes `scripts/extractAgentDocs.js` from the docs build transformer (`packages/docs/templates/generateSiteAssets.js`) after all `_ref`s and template vars are resolved.
+
+Run this before releasing whenever docs change.

package/content/actions/callapi.md

@@ -0,0 +1,66 @@
+# CallAPI
+
+```
+(params: {
+  endpointId: string,
+  payload?: object,
+  holdValue?: boolean
+}): void
+```
+
+The `CallAPI` action invokes a server-side API endpoint defined in your Lowdefy application's configuration.
+It sends an optional payload to the API and returns the response data, making it a way to execute server-side logic and orchestrate database operations from your Lowdefy pages.
+
+> **Note:** `CallAPI` can only target endpoints with `type: Api`. Endpoints with `type: InternalApi` are server-only and cannot be called from client pages. See [Lowdefy APIs](/lowdefy-api) for details.
+
+#### Parameters
+
+###### object
+  - `endpointId: string`: __Required__ - The id of the API endpoint to call.
+  - `payload: object`: Used to pass data such as state values from the app client to the endpoint as required.
+  - `holdValue: boolean`: Optional. When `true`, the previous response is retained on `apiResponses[endpointId][0].response` while the new call is loading. UI bound to `_api: <endpointId>.response` continues to display the previous response instead of going to `null`. The previous response is also retained if the new call errors out — inspect `_api: <endpointId>.error` to detect failures. Defaults to `false`. `holdValue` is currently only settable on the action call.
+
+#### Examples
+
+###### Call an API endpoint:
+```yaml
+- id: call_my_api
+  type: CallAPI
+  params:
+    endpointId: my_api_endpoint
+```
+
+###### Call an API endpoint with a payload:
+```yaml
+- id: call_rating_api
+  type: CallAPI
+  params:
+    endpointId: review_product
+    payload:
+      product_id:
+        _url_query: product_id
+      rating:
+        _state: rating
+      comment:
+        _state: comment
+
+```
+
+###### Call an API endpoint with client state as the payload:
+```yaml
+- id: call_my_api
+  type: CallAPI
+  params:
+    endpointId: my_api_endpoint
+    payload:
+      _state: true
+```
+
+###### Refresh API data without flashing the previous response:
+```yaml
+- id: refresh_dashboard
+  type: CallAPI
+  params:
+    endpointId: dashboard_data
+    holdValue: true
+```

package/content/actions/callmethod.md

@@ -0,0 +1,41 @@
+# CallMethod
+
+```
+(params: {
+  blockId: string,
+  method: string,
+  args?: any[]
+}): void
+```
+
+The `CallMethod` action is used to call a method defined by another block.
+
+#### Parameters
+
+###### object
+  - `blockId: string`: __Required__ - The id of the block.
+  - `method: string`: __Required__ - The name of the method that should be called.
+  - `args: any[]`: The array of positional arguments with which the method should be called.
+
+#### Examples
+
+###### Open a modal:
+```yaml
+- id: toggle_modal
+  type: CallMethod
+  params:
+    blockId: my_modal
+    method: toggleOpen
+```
+
+###### Display a message with args:
+```yaml
+- id: display_message
+  type: CallMethod
+  params:
+    blockId: my_message
+    method: open
+    args:
+      - content: Hello
+        duration: 4
+```

package/content/actions/copytoclipboard.md

@@ -0,0 +1,32 @@
+# CopyToClipboard
+
+```
+(params: {
+  copy: string
+}): void
+```
+
+The `CopyToClipboard` action is used to copy content to the clipboard. It implements the [`navigator.clipboard.writeText`](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard/writeText) web API.
+
+#### Parameters
+
+###### object
+  - `copy: string`: __Required__ - Text to be copied to the clipboard.
+
+#### Examples
+
+###### Copy text button:
+```yaml
+- id: copy_button
+  type: Button
+  properties:
+    title: Copy Text
+  events:
+    onClick:
+      - id: copy
+        type: CopyToClipboard
+        params:
+          copy: Lorem ipsum dolor sit amet
+        messages:
+          success: Copied!
+```

package/content/actions/displaymessage.md

@@ -0,0 +1,53 @@
+# DisplayMessage
+
+```
+(params: {
+  status?: enum,
+  duration?: number,
+  content?: string,
+}): void
+```
+
+The `DisplayMessage` action is used to display a message to a user.
+
+#### Parameters
+
+###### object
+  - `status: enum`: DisplayMessage status type. Defaults to `success`. One of:
+    - `success`
+    - `error`
+    - `info`
+    - `warning`
+    - `loading`.
+  - `duration: number`: Time in seconds before message disappears. The default is 5.
+  - `content: string`: The content of the message.
+
+#### Examples
+
+###### Display a success message:
+```yaml
+- id: success_message
+  type: DisplayMessage
+  params:
+    content: Success
+```
+
+###### Display an info message that remains visible for 10 seconds:
+```yaml
+- id: info_message
+  type: DisplayMessage
+  params:
+    content: Something happened
+    status: info
+    duration: 10
+```
+
+###### Display an error message that never disappears:
+```yaml
+- id: error_message
+  type: DisplayMessage
+  params:
+    content: Something bad happened
+    status: error
+    duration: 0
+```

package/content/actions/downloadcsv.md

@@ -0,0 +1,89 @@
+# DownloadCsv
+
+```
+(params: {
+  filename: string,
+  data: any[],
+  fields: string[]
+}): void
+```
+
+The `DownloadCsv` action is used to generate and download a CSV file from a set of data.
+
+#### Parameters
+
+###### object
+  - `filename: string`: __Required__ - The name for the generated CSV file.
+  - `data: any[]`: __Required__ - The set of data used to generate the CSV file.
+  - `fields: string[]`: __Required__ - The field definitions the set of data will be mapped to in the generated CSV file.
+
+#### Examples
+
+###### Generate a CSV using an array of data:
+```yaml
+- id: generate_csv
+  type: Button
+  properties:
+    size: large
+    title: Generate a CSV
+    color: '#1890ff'
+  events:
+    onClick:
+      - id: generate_csv
+        type: DownloadCsv
+        params:
+          filename: profiles.csv
+          data:
+            - Username: booker12 # an array of data, usually a request
+              Identifier: 9012
+              FirstName: Rachel
+              LastName: Booker
+            - Username: grey07
+              Identifier: 2070
+              FirstName: Laura
+              LastName: Grey
+            - Username: johnson81
+              Identifier: 4081
+              FirstName: Craig
+              LastName: Johnson
+            - Username: jenkins46
+              Identifier: 9346
+              FirstName: Mary
+              LastName: Jenkins
+            - Username: smith79
+              Identifier: 5079
+              FirstName: Jamie
+              LastName: Smith
+          fields:
+            - Username # an array of field definitions
+            - Identifier
+            - FirstName
+            - LastName
+```
+
+###### Generate a CSV using a request:
+```yaml
+- id: generate_csv
+  type: Button
+  properties:
+    size: large
+    title: Generate a CSV
+    color: '#1890ff'
+  events:
+    onClick:
+      - id: fetch_data
+        type: Request
+        params:
+          - get_data
+      - id: generate_csv
+        type: DownloadCsv
+        params:
+          filename: profiles.csv
+          data:
+            _request: get_data # an array of data, from a request
+          fields:
+            - Username # an array of field definitions
+            - Identifier
+            - FirstName
+            - LastName
+```

package/content/actions/fetch.md

@@ -0,0 +1,50 @@
+# Fetch
+
+```
+(params: {
+  url: string,
+  options: object,
+  responseFunction: string
+}): string | object
+```
+
+The `Fetch` implements the [fetch web API](https://developer.mozilla.org/en-US/docs/Web/API/fetch) and can be used to make HTTP requests directly from the web client.
+
+#### Parameters
+
+###### object
+- `url: string`: __Required__ - The URL of the resource you want to fetch..
+- `options: object`: The options object of the `fetch` global function. These include, but are not limited to:
+  - `method: string`: The request method, e.g., `"GET"`, `"POST"`. The default is `"GET"`.
+  - `headers: object`: An object with headers to add to the request.
+  - `body: string`: The request body. Use the [`_json.stringify`](/_json) operator to create a JSON body.
+- `responseFunction: enum`: If the `responseFunction` is specified, that function will be executed on the returned Response object. If specified this is equavalent to `await fetch(url, options).json()`. Should be one of of `'json'`, `'text'`, `'blob'`, `'arrayBuffer'`, or `'formData'`.
+
+#### Examples
+
+######  Call a JSON API endpoint:
+```yaml
+- id: fetch
+  type: Fetch
+  params:
+    url: https://example.com/api/products
+    options:
+      method: GET
+    responseFunction: json
+```
+
+######  Make a post request:
+```yaml
+- id: fetch
+  type: Fetch
+  params:
+    url: https://example.com/api/products/abc
+    options:
+      method: POST
+      headers:
+        Content-Type: application/json
+      body:
+        _json.stringify:
+          - _state: product
+    responseFunction: json
+```

package/content/actions/geolocationcurrentposition.md

@@ -0,0 +1,56 @@
+# GeolocationCurrentPosition
+
+```
+(params: {
+  enableHighAccuracy?: boolean,
+  maximumAge?: number,
+  timeout?: number,
+}) : object
+```
+
+The `GeolocationCurrentPosition` action is used to get the current position of the device.
+
+#### Parameters
+
+###### object
+  - `enableHighAccuracy: boolean`: Indicates that the most accurate possible position should be returned. Defaults to false.
+  - `maximumAge: number`: The maximum age in milliseconds of a possible cached position that is acceptable to return. The default is 0.
+  - `timeout: number`: The maximum length of time in milliseconds the device is allowed to take to return a position. The default is infinity.
+
+#### Response
+
+##### Successful:
+###### object
+  - `coords: object`: A GeolocationCoordinates object instance.
+      - `accuracy: float`: The accuracy of the latitude and longitude properties, expressed in meters.
+      - `altitude: float`: The position's altitude in meters, relative to sea level.
+      - `altitudeAccuracy: float`: The accuracy of the altitude expressed in meters.
+      - `heading: float`: The direction, in degrees clockwise from true North, towards which the device is facing.
+      - `latitude: float`: The position's latitude in decimal degrees.
+      - `longitude: float`: The position's longitude in decimal degrees.
+      - `speed: float`: The velocity of the device in meters per second.
+  - `timestamp: number`: A Unix time in milliseconds.
+
+##### Error:
+  Note that this error response does not break the action chain. The possible errors can be viewed [here](https://developer.mozilla.org/en-US/docs/Web/API/GeolocationPositionError).
+###### object
+  - `code: number`: The error code associated with the error.
+  - `error: string`: The constant associated with the error code.
+  - `message: string`: A string describing the details of the error.
+
+#### Examples
+
+###### Get geolocation with specified params:
+```yaml
+- id: get_geolocation
+  type: GeolocationCurrentPosition
+  params:
+    enableHighAccuracy: true
+    timeout: 5000
+    maximumAge: 0
+- id: set_data
+  type: SetState
+  params:
+    geolocation:
+      _actions: get_geolocation.response
+```