@xano/developer-mcp 1.0.25 → 1.0.27

package/dist/xanoscript_docs_auto/functions.md

@@ -1,431 +0,0 @@
----
-applyTo: "functions/**/*.xs"
----
-
-# Functions
-
-Reusable function stacks with inputs, processing logic, and responses.
-
-## Quick Reference
-
-```xs
-function "<name>" {
-  input {
-    text name
-    int? age
-  }
-  stack {
-    // Processing logic
-    var $result { value = $input.name|to_upper }
-  }
-  response = $result
-}
-```
-
-### Function Invocation
-```xs
-function.run "<name>" {
-  input = { name: "John", age: 25 }
-} as $result
-```
-
----
-
-## Function Definition
-
-### Basic Function
-
-```xs
-function "greet" {
-  input {
-    text name filters=trim
-  }
-  stack {
-    var $greeting {
-      value = "Hello, " ~ $input.name ~ "!"
-    }
-  }
-  response = $greeting
-}
-```
-
-### Function with Optional Inputs
-
-```xs
-function "calculate_total" {
-  input {
-    decimal price
-    int quantity default=1
-    decimal? discount
-  }
-  stack {
-    var $subtotal {
-      value = $input.price * $input.quantity
-    }
-    var $total {
-      value = $input.discount != null
-            ? $subtotal - $input.discount
-            : $subtotal
-    }
-  }
-  response = $total
-}
-```
-
-### Function with Complex Response
-
-```xs
-function "get_user_summary" {
-  input {
-    int user_id
-  }
-  stack {
-    db.get user {
-      field_name = "id"
-      field_value = $input.user_id
-    } as $user
-
-    db.query order {
-      where = $db.order.user_id == $input.user_id
-      return = {type: "count"}
-    } as $order_count
-  }
-  response = {
-    user: $user,
-    total_orders: $order_count
-  }
-}
-```
-
----
-
-## Calling Functions
-
-### Basic Call
-
-```xs
-function.run "greet" {
-  input = {name: "Alice"}
-} as $greeting
-```
-
-### With Dynamic Input
-
-```xs
-function.run "calculate_total" {
-  input = {
-    price: $input.price,
-    quantity: $input.qty,
-    discount: $input.coupon_value
-  }
-} as $total
-```
-
-### Error Handling
-
-```xs
-try_catch {
-  try {
-    function.run "risky_operation" {
-      input = {data: $input.data}
-    } as $result
-  }
-  catch {
-    var $result { value = null }
-    debug.log { value = "Operation failed: " ~ $error.message }
-  }
-}
-```
-
----
-
-## Function Blocks
-
-### Input Block
-
-Define typed parameters with validation:
-
-```xs
-input {
-  // Required parameters
-  text name filters=trim|min:1|max:100
-  email user_email filters=trim|lower
-  int quantity filters=min:1
-
-  // Optional parameters
-  text? notes
-  int? priority default=1
-
-  // Complex types
-  json metadata
-  array<text> tags
-  file attachment
-}
-```
-
-### Stack Block
-
-Container for sequential operations:
-
-```xs
-stack {
-  // Variables
-  var $count { value = 0 }
-
-  // Database operations
-  db.query user {} as $users
-
-  // Control flow
-  conditional {
-    if ($users|count > 0) {
-      var.update $count { value = $users|count }
-    }
-  }
-
-  // Function calls
-  function.run "helper" {
-    input = {data: $users}
-  } as $processed
-}
-```
-
-### Response Block
-
-Define the return value:
-
-```xs
-// Simple response
-response = $result
-
-// Object response
-response = {
-  data: $users,
-  count: $total,
-  page: $input.page
-}
-
-// Conditional response
-response = $success ? $data : null
-```
-
----
-
-## Async Operations
-
-### Sequential Execution
-
-```xs
-stack {
-  // These run in sequence
-  function.run "step1" { input = {} } as $r1
-  function.run "step2" { input = {prev: $r1} } as $r2
-  function.run "step3" { input = {prev: $r2} } as $r3
-}
-```
-
-### Parallel Execution
-
-Use array operations for parallel processing:
-
-```xs
-stack {
-  var $ids { value = [1, 2, 3, 4, 5] }
-
-  array.map {
-    array = $ids
-    run {
-      function.run "process_item" {
-        input = {id: $this}
-      } as $result
-    }
-  } as $results
-}
-```
-
----
-
-## Loops in Functions
-
-### For Loop (Fixed Count)
-
-```xs
-for (10) {
-  each as $index {
-    var.update $total { value = $total + $index }
-  }
-}
-```
-
-### Foreach Loop (Array Iteration)
-
-```xs
-foreach ($input.items) {
-  each as $item {
-    function.run "process" {
-      input = {item: $item}
-    } as $processed
-
-    array.push {
-      array = $results
-      value = $processed
-    }
-  }
-}
-```
-
-### While Loop (Condition)
-
-```xs
-var $counter { value = 0 }
-var $max { value = 10 }
-
-while ($counter < $max) {
-  each {
-    var.update $counter { value = $counter + 1 }
-    // Process iteration
-  }
-}
-```
-
----
-
-## Testing Functions
-
-### Test Block
-
-```xs
-function "add_numbers" {
-  input {
-    int a
-    int b
-  }
-  stack {
-    var $sum { value = $input.a + $input.b }
-  }
-  response = $sum
-
-  test "adds positive numbers" {
-    function.call {
-      input = {a: 2, b: 3}
-    } as $result
-
-    expect.to_equal {
-      input = $result
-      value = 5
-    }
-  }
-
-  test "handles zero" {
-    function.call {
-      input = {a: 5, b: 0}
-    } as $result
-
-    expect.to_equal {
-      input = $result
-      value = 5
-    }
-  }
-}
-```
-
-### Assertions
-
-```xs
-expect.to_be_true { input = $value }
-expect.to_be_false { input = $value }
-expect.to_equal { input = $a, value = $b }
-expect.to_not_equal { input = $a, value = $b }
-expect.to_be_null { input = $value }
-expect.to_not_be_null { input = $value }
-expect.to_contain { input = $array, value = $item }
-expect.to_be_greater_than { input = $a, value = $b }
-expect.to_be_less_than { input = $a, value = $b }
-```
-
----
-
-## Function Best Practices
-
-### Keep Functions Focused
-
-```xs
-// Good: Single responsibility
-function "validate_email" {
-  input { email value }
-  stack {
-    var $valid {
-      value = $input.value|regex_matches:"^[^@]+@[^@]+\.[^@]+$"
-    }
-  }
-  response = $valid
-}
-
-// Good: Compose small functions
-function "process_user" {
-  input { json user_data }
-  stack {
-    function.run "validate_email" {
-      input = {value: $input.user_data.email}
-    } as $email_valid
-
-    function.run "validate_name" {
-      input = {value: $input.user_data.name}
-    } as $name_valid
-  }
-  response = {
-    valid: $email_valid && $name_valid
-  }
-}
-```
-
-### Use Descriptive Names
-
-```xs
-// Good naming
-function "calculate_order_total" { ... }
-function "send_welcome_email" { ... }
-function "generate_invoice_pdf" { ... }
-```
-
-### Handle Errors Gracefully
-
-```xs
-function "fetch_user" {
-  input { int user_id }
-  stack {
-    db.get user {
-      field_name = "id"
-      field_value = $input.user_id
-    } as $user
-
-    precondition ($user != null) {
-      error_type = "notfound"
-      error = "User not found"
-    }
-  }
-  response = $user
-}
-```
-
----
-
-## Function Documentation
-
-Add descriptions to your functions:
-
-```xs
-function "create_invoice" {
-  description = "Creates an invoice for an order and sends email notification"
-
-  input {
-    int order_id description="The order to invoice"
-    bool? send_email description="Whether to send email" default=true
-  }
-
-  stack {
-    // Implementation
-  }
-
-  response = $invoice
-}
-```