form0-core 0.3.1 → 0.4.0

package/src/builtins/docs/index.mdx

@@ -1,234 +0,0 @@
----
-title: "form0 Builtins Documentation"
-description: "Complete reference for all form0 builtin functions"
-category: "index"
-tags: ["documentation", "reference", "builtins"]
----
-
-# form0 Builtins Documentation
-
-Welcome to the complete reference for form0 builtin functions. This documentation covers all available functions, their usage, and practical examples.
-
-## Getting Started
-
-- **[Overview](./overview.mdx)** - Introduction to the builtins system
-- **[Quick Reference](#quick-reference)** - Function summary table
-- **[Common Patterns](#common-patterns)** - Frequently used combinations
-
-## Logical Functions
-
-Essential functions for conditional logic and boolean operations:
-
-| Function | Description | Use Cases |
-|----------|-------------|-----------|
-| **[IF](../logical/if.mdx)** | Conditional logic and branching | Field visibility, dynamic values, validation messages |
-| **[AND](../logical/and.mdx)** | Logical AND operations | Multi-condition validation, permission checks |
-| **[OR](../logical/or.mdx)** | Logical OR operations | Alternative requirements, fallback logic |
-
-## Control Functions
-
-Functions for managing calculation flow and results:
-
-| Function | Description | Use Cases |
-|----------|-------------|-----------|
-| **[SETRESULT](../control/setresult.mdx)** | Set calculation results | Price calculations, score computations, field aggregations |
-
-## Quick Reference
-
-### IF Function
-
-```javascript
-IF(condition, trueValue, falseValue)
-```
-
-**Common Usage:**
-- Field visibility: `IF(user.isPremium, true, false)`
-- Dynamic pricing: `IF(quantity > 10, price * 0.9, price)`
-- Validation messages: `IF(age < 18, "Must be 18+", "")`
-
-### AND Function
-
-```javascript
-AND(...conditions)
-```
-
-**Common Usage:**
-- Form validation: `AND(email.isValid, phone.isValid, name.length > 0)`
-- Permission checks: `AND(user.isLoggedIn, user.hasPermission)`
-- Business rules: `AND(inStock, paymentValid, addressComplete)`
-
-### OR Function
-
-```javascript
-OR(...conditions)
-```
-
-**Common Usage:**
-- Alternative requirements: `OR(email.length > 0, phone.length > 0)`
-- Feature detection: `OR(user.isPremium, user.isVip, user.hasSubscription)`
-- Fallback logic: `OR(user.preferredName, user.firstName, "Guest")`
-
-### SETRESULT Function
-
-```javascript
-SETRESULT(value)
-```
-
-**Common Usage:**
-- Price calculations: `SETRESULT(price * quantity * (1 + taxRate))`
-- Score computations: `SETRESULT((score1 + score2 + score3) / 3)`
-- Conditional results: `SETRESULT(IF(eligible, amount, 0))`
-
-## Common Patterns
-
-### Complex Conditional Logic
-
-```javascript
-// Multi-level pricing
-IF(user.type === "premium",
-  IF(order.value > 100, "free-shipping", "discounted-shipping"),
-  IF(order.value > 50, "reduced-shipping", "standard-shipping")
-)
-```
-
-### Validation Chains
-
-```javascript
-// Comprehensive form validation
-AND(
-  email.includes("@"),
-  phone.length >= 10,
-  age >= 18,
-  OR(hasLicense, hasAlternateId),
-  agreedToTerms === true
-)
-```
-
-### Calculation Pipelines
-
-```javascript
-// Complex business calculation
-SETRESULT(
-  (basePrice * quantity) * 
-  IF(user.isPremium, 0.9, 1.0) * 
-  IF(location === "remote", 1.1, 1.0) + 
-  IF(AND(urgent, businessHours), 25, 0)
-)
-```
-
-### Dynamic Field Behavior
-
-```javascript
-// Show field based on multiple conditions
-IF(AND(user.role === "admin", feature.enabled, environment === "production"),
-  "visible",
-  "hidden"
-)
-```
-
-## Function Combinations
-
-### IF + AND
-
-```javascript
-// Show premium features only when all conditions are met
-IF(AND(user.isPremium, feature.enabled, user.region === "US"),
-  premiumContent,
-  standardContent
-)
-```
-
-### IF + OR
-
-```javascript
-// Apply discount if user has any qualifying status
-IF(OR(user.isStudent, user.isSenior, user.isMilitary),
-  discountedPrice,
-  regularPrice
-)
-```
-
-### AND + OR
-
-```javascript
-// Complex eligibility check
-AND(
-  age >= 18,
-  OR(hasDriversLicense, hasStateId, hasPassport),
-  OR(hasProofOfIncome, hasGuarantor)
-)
-```
-
-### Nested Functions
-
-```javascript
-// Sophisticated business logic
-SETRESULT(
-  IF(AND(user.isVip, order.value > 500),
-    IF(OR(user.country === "US", user.country === "CA"),
-      0,  // Free shipping for VIP in North America
-      10  // Reduced shipping for VIP elsewhere
-    ),
-    IF(order.value > 100,
-      5,  // Standard reduced shipping
-      15  // Regular shipping
-    )
-  )
-)
-```
-
-## Best Practices
-
-1. **Keep expressions readable** - Break complex logic into smaller parts
-2. **Use descriptive field names** - Make your conditions self-documenting
-3. **Handle edge cases** - Consider null/undefined values
-4. **Test thoroughly** - Verify all code paths work as expected
-5. **Document complex logic** - Add comments for maintainability
-
-## Performance Tips
-
-- **Order conditions by likelihood** - Put most likely conditions first
-- **Use short-circuit evaluation** - `AND` and `OR` stop early when possible
-- **Avoid deeply nested expressions** - Consider splitting complex logic
-- **Cache expensive operations** - Don't repeat the same calculations
-
-## Troubleshooting
-
-### Common Issues
-
-1. **Undefined values** - Use `OR` for fallbacks: `OR(user.name, "Unknown")`
-2. **Type mismatches** - Ensure consistent data types in comparisons
-3. **Logic errors** - Test all branches of conditional statements
-4. **Performance** - Avoid excessive nesting and complex expressions
-
-### Debugging Tips
-
-- Use simple test cases to verify function behavior
-- Break complex expressions into smaller parts
-- Check that all required fields are available
-- Verify data types match expectations
-
-## Examples by Domain
-
-### E-commerce
-- [Product pricing](../examples/ecommerce.mdx#pricing)
-- [Shipping calculations](../examples/ecommerce.mdx#shipping)
-- [Discount logic](../examples/ecommerce.mdx#discounts)
-
-### User Management
-- [Registration validation](../examples/user-management.mdx#registration)
-- [Permission checks](../examples/user-management.mdx#permissions)
-- [Profile completion](../examples/user-management.mdx#profiles)
-
-### Financial Services
-- [Loan eligibility](../examples/financial.mdx#loans)
-- [Risk assessment](../examples/financial.mdx#risk)
-- [Fee calculations](../examples/financial.mdx#fees)
-
-## Support
-
-For questions or issues:
-- Check the [form0 documentation](https://form0.dev/docs)
-- Review [common patterns](#common-patterns) above
-- See [troubleshooting](#troubleshooting) section
-- Visit the [form0 GitHub repository](https://github.com/form0-dev/form0-core) 

package/src/builtins/docs/logical/and.mdx

@@ -1,141 +0,0 @@
----
-title: "AND Builtin"
-description: "Logical AND operation for form0 expressions"
-category: "logical"
-tags: ["logical", "boolean", "validation"]
----
-
-# AND Function
-
-The `AND` builtin performs logical AND operations, returning `true` only when all provided arguments are truthy.
-
-## Syntax
-
-```javascript
-AND(...args)
-```
-
-## Parameters
-
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `...args` | `any` | Any number of arguments to evaluate |
-
-## Return Value
-
-Returns `true` if all arguments are truthy, `false` otherwise.
-
-## Examples
-
-### Basic Usage
-
-```javascript
-// Check if user meets multiple criteria
-AND(user.age >= 18, user.hasEmail, user.agreedToTerms)
-```
-
-### Form Validation
-
-```javascript
-// Validate required fields
-AND(name.length > 0, email.includes("@"), phone.length >= 10)
-```
-
-### Complex Conditions
-
-```javascript
-// Check multiple business rules
-AND(
-  order.amount > 0,
-  inventory.stock >= order.quantity,
-  customer.creditScore > 600,
-  customer.accountStatus === "active"
-)
-```
-
-### Field Dependencies
-
-```javascript
-// Show field only when multiple conditions are met
-AND(showAdvanced, user.role === "admin", feature.enabled)
-```
-
-### Nested with Other Functions
-
-```javascript
-// Combine with IF for complex logic
-IF(AND(user.isPremium, order.value > 100), "Free shipping", "Standard shipping")
-```
-
-## Truthiness Rules
-
-The `AND` function uses JavaScript's standard truthiness evaluation:
-
-**Falsy values:**
-- `false`
-- `0`
-- `""` (empty string)
-- `null`
-- `undefined`
-- `NaN`
-
-**Truthy values:**
-- `true`
-- Any non-zero number
-- Any non-empty string
-- Objects and arrays
-- Functions
-
-## Common Use Cases
-
-- **Form validation**: Ensure multiple fields are properly filled
-- **User permissions**: Check if user has multiple required permissions
-- **Business rules**: Validate complex business logic conditions
-- **Feature flags**: Enable features when multiple conditions are met
-- **Data integrity**: Ensure data meets multiple criteria
-
-## Best Practices
-
-1. **Order by likelihood**: Put most likely-to-fail conditions first for better performance
-2. **Use descriptive expressions**: Make conditions self-documenting
-3. **Limit complexity**: Too many conditions can be hard to debug
-4. **Consider short-circuiting**: `AND` stops evaluating once it finds a falsy value
-
-## Performance Notes
-
-- **Short-circuit evaluation**: Stops checking as soon as a falsy value is found
-- **Evaluation order**: Arguments are evaluated left to right
-- **Lazy evaluation**: Later arguments won't be evaluated if earlier ones are falsy
-
-## Related Functions
-
-- [`OR`](./or.mdx) - Logical OR operations
-- [`IF`](./if.mdx) - Conditional logic
-
-## Examples by Use Case
-
-### User Authentication
-
-```javascript
-// Check if user is authenticated and authorized
-AND(user.isLoggedIn, user.permissions.includes("read"), user.sessionValid)
-```
-
-### E-commerce Validation
-
-```javascript
-// Validate order can be processed
-AND(
-  product.inStock,
-  customer.paymentMethodValid,
-  shippingAddress.isComplete,
-  order.total > 0
-)
-```
-
-### Feature Gating
-
-```javascript
-// Enable beta feature
-AND(user.betaOptIn, feature.betaEnabled, environment === "production")
-``` 

package/src/builtins/docs/logical/if.mdx

@@ -1,94 +0,0 @@
----
-title: "IF Builtin"
-description: "Conditional logic function for form0 expressions"
-category: "logical"
-tags: ["conditional", "logic", "branching"]
----
-
-# IF Function
-
-The `IF` builtin provides conditional logic within form0 expressions, allowing you to return different values based on a condition.
-
-## Syntax
-
-```javascript
-IF(condition, trueValue, falseValue)
-```
-
-## Parameters
-
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `condition` | `boolean` | The condition to evaluate |
-| `trueValue` | `any` | Value returned when condition is true |
-| `falseValue` | `any` | Value returned when condition is false |
-
-## Return Value
-
-Returns `trueValue` if the condition is truthy, otherwise returns `falseValue`.
-
-## Examples
-
-### Basic Usage
-
-```javascript
-// Show discount message based on user status
-IF(user.isPremium, "20% off", "No discount")
-```
-
-### Numeric Calculations
-
-```javascript
-// Apply different tax rates
-IF(country === "US", price * 0.08, price * 0.20)
-```
-
-### Nested Conditions
-
-```javascript
-// Determine shipping cost based on location and order value
-IF(country === "US", 
-  IF(orderValue > 50, 0, 5.99), 
-  IF(orderValue > 100, 10, 15.99)
-)
-```
-
-### Field Visibility
-
-```javascript
-// Show additional fields for premium users
-IF(user.type === "premium", true, false)
-```
-
-### Dynamic Form Validation
-
-```javascript
-// Conditional validation messages
-IF(age < 18, "Must be 18 or older", "")
-```
-
-## Common Use Cases
-
-- **Conditional pricing**: Different prices based on user type or location
-- **Dynamic field visibility**: Show/hide fields based on other field values
-- **Validation messages**: Display different error messages based on conditions
-- **User experience**: Personalize content based on user preferences
-- **Business logic**: Implement complex conditional rules
-
-## Best Practices
-
-1. **Keep conditions simple**: Complex conditions can be hard to read and debug
-2. **Use descriptive variable names**: Make your conditions self-documenting
-3. **Consider nested IFs carefully**: Too many levels can become difficult to maintain
-4. **Test edge cases**: Ensure your conditions handle all possible scenarios
-
-## Related Functions
-
-- [`AND`](./and.mdx) - Logical AND operations
-- [`OR`](./or.mdx) - Logical OR operations
-
-## Notes
-
-- The condition is evaluated using JavaScript's truthiness rules
-- Both `trueValue` and `falseValue` can be of any type
-- The function is lazy-evaluated - only the returned branch is computed 

package/src/builtins/docs/logical/or.mdx

@@ -1,191 +0,0 @@
----
-title: "OR Builtin"
-description: "Logical OR operation for form0 expressions"
-category: "logical"
-tags: ["logical", "boolean", "validation"]
----
-
-# OR Function
-
-The `OR` builtin performs logical OR operations, returning `true` if at least one of the provided arguments is truthy.
-
-## Syntax
-
-```javascript
-OR(...args)
-```
-
-## Parameters
-
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `...args` | `any` | Any number of arguments to evaluate |
-
-## Return Value
-
-Returns `true` if at least one argument is truthy, `false` if all arguments are falsy.
-
-## Examples
-
-### Basic Usage
-
-```javascript
-// Check if user has any premium feature
-OR(user.isPremium, user.isVip, user.hasSubscription)
-```
-
-### Form Validation
-
-```javascript
-// Require either email or phone
-OR(email.length > 0, phone.length > 0)
-```
-
-### Multiple Authentication Methods
-
-```javascript
-// Check if user is authenticated via any method
-OR(user.googleAuth, user.facebookAuth, user.localAuth)
-```
-
-### Field Visibility
-
-```javascript
-// Show field if any condition is met
-OR(user.isAdmin, user.isOwner, feature.showToAll)
-```
-
-### Fallback Values
-
-```javascript
-// Use first available contact method
-OR(user.email, user.phone, user.address)
-```
-
-## Truthiness Rules
-
-The `OR` function uses JavaScript's standard truthiness evaluation:
-
-**Falsy values:**
-- `false`
-- `0`
-- `""` (empty string)
-- `null`
-- `undefined`
-- `NaN`
-
-**Truthy values:**
-- `true`
-- Any non-zero number
-- Any non-empty string
-- Objects and arrays
-- Functions
-
-## Common Use Cases
-
-- **Alternative requirements**: Accept multiple ways to satisfy a condition
-- **Feature detection**: Check if any of several features are available
-- **Fallback logic**: Provide alternatives when primary options fail
-- **Flexible validation**: Allow multiple valid formats or values
-- **Permission systems**: Grant access if user has any qualifying permission
-
-## Best Practices
-
-1. **Order by likelihood**: Put most likely-to-succeed conditions first
-2. **Use for alternatives**: Perfect for "either/or" scenarios
-3. **Combine with AND**: Create complex logical expressions
-4. **Keep conditions related**: All arguments should be logical alternatives
-
-## Performance Notes
-
-- **Short-circuit evaluation**: Stops checking as soon as a truthy value is found
-- **Evaluation order**: Arguments are evaluated left to right
-- **Lazy evaluation**: Later arguments won't be evaluated if earlier ones are truthy
-
-## Related Functions
-
-- [`AND`](./and.mdx) - Logical AND operations
-- [`IF`](./if.mdx) - Conditional logic
-
-## Examples by Use Case
-
-### Contact Information Validation
-
-```javascript
-// Require at least one contact method
-OR(
-  email.includes("@"),
-  phone.length >= 10,
-  address.length > 0
-)
-```
-
-### User Permissions
-
-```javascript
-// Check if user has any admin permission
-OR(
-  user.role === "admin", 
-  user.permissions.includes("admin"),
-  user.isSuperUser
-)
-```
-
-### Payment Methods
-
-```javascript
-// Check if any payment method is available
-OR(
-  creditCard.isValid,
-  paypal.isConnected,
-  bankAccount.isVerified,
-  wallet.hasBalance
-)
-```
-
-### Feature Flags
-
-```javascript
-// Enable feature if any condition is met
-OR(
-  user.betaOptIn,
-  user.isDeveloper,
-  feature.enabledForAll,
-  environment === "staging"
-)
-```
-
-### Emergency Contacts
-
-```javascript
-// Show emergency contact section if any contact exists
-OR(
-  emergencyContact.phone,
-  emergencyContact.email,
-  emergencyContact.relationship
-)
-```
-
-## Complex Examples
-
-### Nested Logic
-
-```javascript
-// Complex user eligibility check
-OR(
-  AND(user.isPremium, user.accountAge > 30),
-  AND(user.referrals >= 5, user.isActive),
-  user.specialStatus === "founder"
-)
-```
-
-### Multi-step Form Logic
-
-```javascript
-// Show next step if user completed any path
-OR(
-  AND(step1.email, step1.verified),
-  AND(step1.phone, step1.smsVerified),
-  step1.socialLogin
-)
-```