@xano/developer-mcp 1.0.20 → 1.0.22

package/dist/xanoscript_docs_auto/integrations.md

@@ -0,0 +1,657 @@
+---
+applyTo: "functions/**/*.xs,apis/**/*.xs,tasks/*.xs"
+---
+
+# Integrations
+
+Cloud storage, Redis, external APIs, and security functions.
+
+## Quick Reference
+
+| Domain | Functions |
+|--------|-----------|
+| API | `api.request`, `api.call`, `api.stream` |
+| Redis | `redis.get`, `redis.set`, `redis.del`, `redis.ratelimit` |
+| AWS S3 | `cloud.aws.s3.*` |
+| Google Cloud | `cloud.google.storage.*` |
+| Azure | `cloud.azure.storage.*` |
+| Security | `security.encrypt`, `security.decrypt`, `security.create_auth_token` |
+| Email | `util.send_email` |
+| Storage | `storage.create_file_resource`, `storage.read_file` |
+
+---
+
+## External API Requests
+
+### Basic Request
+
+```xs
+api.request {
+  url = "https://api.example.com/data"
+  method = "GET"
+} as $response
+```
+
+### With Headers and Body
+
+```xs
+api.request {
+  url = "https://api.example.com/users"
+  method = "POST"
+  headers = {
+    "Content-Type": "application/json",
+    "Authorization": "Bearer " ~ $env.API_KEY
+  }
+  body = {
+    name: $input.name,
+    email: $input.email
+  }
+} as $response
+```
+
+### Query Parameters
+
+```xs
+api.request {
+  url = "https://api.example.com/search"
+  method = "GET"
+  params = {
+    q: $input.query,
+    limit: 10,
+    page: $input.page
+  }
+} as $response
+```
+
+### Form Data
+
+```xs
+api.request {
+  url = "https://api.example.com/upload"
+  method = "POST"
+  headers = {
+    "Content-Type": "application/x-www-form-urlencoded"
+  }
+  form = {
+    field1: "value1",
+    field2: "value2"
+  }
+} as $response
+```
+
+### Error Handling
+
+```xs
+try_catch {
+  try {
+    api.request {
+      url = $external_api_url
+      method = "GET"
+      timeout = 5000
+    } as $response
+  }
+  catch {
+    debug.log { value = "API request failed: " ~ $error.message }
+    var $response { value = null }
+  }
+}
+```
+
+---
+
+## Internal API Calls
+
+Call other Xano API endpoints:
+
+```xs
+api.call {
+  path = "/api/users/validate"
+  method = "POST"
+  body = {
+    email: $input.email
+  }
+} as $validation_result
+```
+
+---
+
+## Redis
+
+### Get/Set Values
+
+```xs
+// Set value with TTL (seconds)
+redis.set {
+  key = "user:" ~ $user.id
+  value = $user|json_encode
+  ttl = 3600  // 1 hour
+}
+
+// Get value
+redis.get {
+  key = "user:" ~ $input.user_id
+} as $cached_user
+```
+
+### Delete Key
+
+```xs
+redis.del {
+  key = "user:" ~ $input.user_id
+}
+```
+
+### Check Existence
+
+```xs
+redis.has {
+  key = "session:" ~ $input.token
+} as $exists
+```
+
+### Increment/Decrement
+
+```xs
+redis.incr {
+  key = "counter:" ~ $input.id
+} as $new_count
+
+redis.decr {
+  key = "stock:" ~ $product.id
+} as $remaining
+```
+
+### List Operations
+
+```xs
+// Add to list
+redis.push {
+  key = "queue:jobs"
+  value = $job|json_encode
+}
+
+// Get from list
+redis.pop {
+  key = "queue:jobs"
+} as $next_job
+
+// Get range
+redis.range {
+  key = "recent:items"
+  start = 0
+  stop = 9
+} as $recent_items
+```
+
+### Rate Limiting
+
+```xs
+redis.ratelimit {
+  key = "rate:" ~ $env.$remote_ip
+  limit = 100
+  window = 60  // 100 requests per minute
+} as $rate_check
+
+conditional {
+  if (!$rate_check.allowed) {
+    throw {
+      name = "RateLimitExceeded"
+      value = "Too many requests"
+      code = 429
+    }
+  }
+}
+```
+
+### Find Keys
+
+```xs
+redis.keys {
+  pattern = "user:*"
+} as $user_keys
+```
+
+---
+
+## AWS S3
+
+### Upload File
+
+```xs
+cloud.aws.s3.upload_file {
+  bucket = $env.S3_BUCKET
+  key = "uploads/" ~ $input.filename
+  content = $input.file
+  acl = "private"
+} as $upload_result
+```
+
+### Read File
+
+```xs
+cloud.aws.s3.read_file {
+  bucket = $env.S3_BUCKET
+  key = $input.file_path
+} as $file_content
+```
+
+### Delete File
+
+```xs
+cloud.aws.s3.delete_file {
+  bucket = $env.S3_BUCKET
+  key = $input.file_path
+}
+```
+
+### List Files
+
+```xs
+cloud.aws.s3.list_directory {
+  bucket = $env.S3_BUCKET
+  prefix = "uploads/"
+} as $files
+```
+
+### Generate Signed URL
+
+```xs
+cloud.aws.s3.sign_url {
+  bucket = $env.S3_BUCKET
+  key = $input.file_path
+  expires = 3600  // 1 hour
+} as $signed_url
+```
+
+---
+
+## Google Cloud Storage
+
+### Upload File
+
+```xs
+cloud.google.storage.upload_file {
+  bucket = $env.GCS_BUCKET
+  path = "uploads/" ~ $input.filename
+  content = $input.file
+} as $upload_result
+```
+
+### Read File
+
+```xs
+cloud.google.storage.read_file {
+  bucket = $env.GCS_BUCKET
+  path = $input.file_path
+} as $content
+```
+
+### Delete File
+
+```xs
+cloud.google.storage.delete_file {
+  bucket = $env.GCS_BUCKET
+  path = $input.file_path
+}
+```
+
+### List Directory
+
+```xs
+cloud.google.storage.list_directory {
+  bucket = $env.GCS_BUCKET
+  prefix = "uploads/"
+} as $files
+```
+
+---
+
+## Azure Blob Storage
+
+### Upload File
+
+```xs
+cloud.azure.storage.upload_file {
+  container = $env.AZURE_CONTAINER
+  path = "uploads/" ~ $input.filename
+  content = $input.file
+} as $result
+```
+
+### Read File
+
+```xs
+cloud.azure.storage.read_file {
+  container = $env.AZURE_CONTAINER
+  path = $input.file_path
+} as $content
+```
+
+---
+
+## Security Functions
+
+### Encryption
+
+```xs
+// Encrypt data
+security.encrypt {
+  algorithm = "aes-256-cbc"
+  data = $sensitive_data
+  key = $env.ENCRYPTION_KEY
+} as $encrypted
+
+// Decrypt data
+security.decrypt {
+  algorithm = "aes-256-cbc"
+  data = $encrypted
+  key = $env.ENCRYPTION_KEY
+} as $decrypted
+```
+
+### Password Hashing
+
+```xs
+// Hash password
+security.create_password {
+  password = $input.password
+} as $hashed
+
+// Verify password
+security.check_password {
+  password = $input.password
+  hash = $user.password_hash
+} as $valid
+```
+
+### Auth Tokens
+
+```xs
+// Create JWT token
+security.create_auth_token {
+  payload = {
+    user_id: $user.id,
+    role: $user.role
+  }
+  expires = 86400  // 24 hours
+} as $token
+```
+
+### UUID Generation
+
+```xs
+security.create_uuid {} as $uuid
+security.generate_uuid {} as $uuid
+```
+
+### Random Values
+
+```xs
+security.random_bytes {
+  length = 32
+} as $random_bytes
+
+security.random_number {
+  min = 1
+  max = 100
+} as $random_num
+```
+
+### Key Generation
+
+```xs
+// RSA key pair
+security.create_rsa_key {
+  bits = 2048
+} as $rsa_key
+
+// Elliptic curve key
+security.create_curve_key {
+  curve = "secp256k1"
+} as $ec_key
+
+// Secret key
+security.create_secret_key {
+  length = 32
+} as $secret
+```
+
+### JWS/JWE
+
+```xs
+// Sign with JWS
+security.jws_encode {
+  payload = $data
+  algorithm = "HS256"
+  secret = $env.JWT_SECRET
+} as $signed
+
+// Verify JWS
+security.jws_decode {
+  token = $input.token
+  secret = $env.JWT_SECRET
+} as $payload
+
+// Encrypt with JWE
+security.jwe_encode {
+  payload = $data
+  algorithm = "A256GCM"
+  key = $env.ENCRYPTION_KEY
+} as $encrypted
+
+// Decrypt JWE
+security.jwe_decode {
+  token = $encrypted
+  key = $env.ENCRYPTION_KEY
+} as $decrypted
+```
+
+---
+
+## Email
+
+### Send Email
+
+```xs
+util.send_email {
+  to = $user.email
+  subject = "Welcome!"
+  body = "Thank you for signing up."
+}
+```
+
+### With HTML
+
+```xs
+util.send_email {
+  to = $user.email
+  subject = "Your Order Confirmation"
+  html = "<h1>Order Confirmed</h1><p>Order #" ~ $order.id ~ "</p>"
+}
+```
+
+### With Attachments
+
+```xs
+util.send_email {
+  to = $user.email
+  subject = "Your Invoice"
+  body = "Please find your invoice attached."
+  attachments = [
+    {
+      filename: "invoice.pdf",
+      content: $pdf_content
+    }
+  ]
+}
+```
+
+---
+
+## File Storage
+
+### Create File
+
+```xs
+storage.create_file_resource {
+  name = "document.pdf"
+  content = $file_content
+} as $file
+
+storage.create_image {
+  name = "photo.jpg"
+  content = $image_data
+} as $image
+
+storage.create_attachment {
+  name = "report.xlsx"
+  content = $excel_data
+} as $attachment
+```
+
+### Read File
+
+```xs
+storage.read_file_resource {
+  path = $input.file_path
+} as $content
+
+storage.read_file {
+  path = $input.file_path
+} as $content
+```
+
+### Delete File
+
+```xs
+storage.delete_file {
+  path = $file.path
+}
+```
+
+### Signed URLs
+
+```xs
+storage.sign_private_url {
+  path = $file.path
+  expires = 3600
+} as $signed_url
+```
+
+---
+
+## Zip Operations
+
+### Create Archive
+
+```xs
+zip.create_archive {
+  files = [
+    {name: "doc1.txt", content: $content1},
+    {name: "doc2.txt", content: $content2}
+  ]
+} as $zip_file
+```
+
+### Extract Archive
+
+```xs
+zip.extract {
+  archive = $input.zip_file
+} as $files
+```
+
+### View Contents
+
+```xs
+zip.view_contents {
+  archive = $input.zip_file
+} as $file_list
+```
+
+---
+
+## Streaming
+
+### Stream from CSV
+
+```xs
+stream.from_csv {
+  file = $input.csv_file
+  run {
+    foreach ($this.rows) {
+      each as $row {
+        db.add import_data { data = $row }
+      }
+    }
+  }
+}
+```
+
+### Stream from Request
+
+```xs
+stream.from_request {
+  url = "https://api.example.com/large-data"
+  run {
+    foreach ($this.chunks) {
+      each as $chunk {
+        // Process chunk
+      }
+    }
+  }
+}
+```
+
+---
+
+## Utilities
+
+### Sleep
+
+```xs
+util.sleep {
+  duration = 1000  // Milliseconds
+}
+```
+
+### IP Lookup
+
+```xs
+util.ip_lookup {
+  ip = $env.$remote_ip
+} as $location
+```
+
+### Geo Distance
+
+```xs
+util.geo_distance {
+  from = {lat: 40.7128, lng: -74.0060}
+  to = {lat: 34.0522, lng: -118.2437}
+} as $distance_km
+```
+
+### Template Engine
+
+```xs
+util.template_engine {
+  template = "Hello {{name}}, you have {{count}} messages."
+  data = {name: "John", count: 5}
+} as $message
+```
+
+### Environment Variables
+
+```xs
+util.get_env {} as $all_env_vars
+```
+
+### Set Response Headers
+
+```xs
+util.set_header {
+  name = "X-Custom-Header"
+  value = "custom-value"
+}
+```