form0-core 0.3.0 → 0.4.0

package/src/builtins/docs/choice/hasother.mdx

@@ -1,133 +0,0 @@
----
-title: "HASOTHER Builtin"
-description: "Check if user entered an other option in choice field (SingleChoiceField or MultiChoiceField)"
-category: "choice"
-tags: ["choice", "other", "validation", "multichoice"]
----
-
-# HASOTHER Function
-
-The `HASOTHER` builtin checks if the user has entered an "other" option in a choice field, returning `true` if an other option is present, `false` otherwise. Works with both SingleChoiceField (single selection) and MultiChoiceField (multiple selections).
-
-## Syntax
-
-```javascript
-HASOTHER(choiceField)
-```
-
-## Parameters
-
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `choiceField` | `Object` | The choice field object (SingleChoiceField with choice array or MultiChoiceField with choices array) and other array |
-
-## Return Value
-
-Returns `true` if user entered an other option, `false` otherwise.
-
-## Examples
-
-### Basic Usage - SingleChoiceField
-
-```javascript
-// Check if user entered other option in single choice field
-HASOTHER($city)
-```
-
-### Basic Usage - MultiChoiceField
-
-```javascript
-// Check if user entered other option in multi choice field
-HASOTHER($colors)
-```
-
-### Conditional Logic
-
-```javascript
-// Show different content based on other option in single choice
-IF(HASOTHER($city), "Custom city: " + OTHER($city), "Selected city: " + CHOICELABEL($city))
-
-// Show different content based on other option in multi choice
-IF(HASOTHER($colors), "Custom color: " + OTHER($colors), "Selected colors: " + CHOICELABELS($colors).join(", "))
-```
-
-### Validation
-
-```javascript
-// Require additional validation when other is selected
-IF(HASOTHER($category), OTHER($category).length > 0, true)
-```
-
-### Form Behavior
-
-```javascript
-// Show additional fields when other is selected
-IF(HASOTHER($reason), "Please specify: " + OTHER($reason), "")
-```
-
-## Use Cases
-
-- **Conditional display**: Show additional fields or content when other options are selected
-- **Validation**: Apply different validation rules when other options are present
-- **Data processing**: Handle other options differently in calculations or logic
-- **User experience**: Provide context-aware feedback based on other selections
-- **Multi-choice support**: Works seamlessly with both single and multiple choice fields
-
-## Best Practices
-
-1. **Combine with OTHER**: Use together with `OTHER()` function to get the actual other value
-2. **Validation**: Always validate other inputs when `HASOTHER` returns true
-3. **User feedback**: Provide clear feedback when other options are selected
-4. **Field dependencies**: Use to show/hide related fields
-5. **Multi-choice compatibility**: Works with both SingleChoiceField and MultiChoiceField
-
-## Related Functions
-
-- [`OTHER`](./other.mdx) - Get the other option value
-- [`CHOICEVALUE`](./choicevalue.mdx) - Get the selected choice value (SingleChoiceField)
-- [`CHOICELABEL`](./choicelabel.mdx) - Get the selected choice label (SingleChoiceField)
-- [`CHOICEVALUES`](./choicevalues.mdx) - Get all selected choice values (MultiChoiceField)
-- [`CHOICELABELS`](./choicelabels.mdx) - Get all selected choice labels (MultiChoiceField)
-
-## Examples by Use Case
-
-### Dynamic Field Display
-
-```javascript
-// Show additional input field when other is selected
-IF(HASOTHER($industry), "Specify industry: " + OTHER($industry), "")
-```
-
-### Validation Rules
-
-```javascript
-// Require other field to be non-empty when selected
-AND(HASOTHER($reason), OTHER($reason).length > 3)
-```
-
-### Conditional Processing - SingleChoiceField
-
-```javascript
-// Different processing based on other selection
-IF(HASOTHER($payment_method), "Custom payment: " + OTHER($payment_method), "Standard payment")
-```
-
-### Conditional Processing - MultiChoiceField
-
-```javascript
-// Different processing based on other selection in multi-choice
-IF(HASOTHER($skills), "Custom skill: " + OTHER($skills), "Standard skills: " + CHOICELABELS($skills).join(", "))
-```
-
-### Form Completion
-
-```javascript
-// Check if form is complete including other fields
-AND(CHOICEVALUE($category) !== null, IF(HASOTHER($category), OTHER($category).length > 0, true))
-```
-
-## Field Type Compatibility
-
-- **SingleChoiceField**: Single selection with optional other input
-- **MultiChoiceField**: Multiple selections with optional other input
-- **Note**: User can only add 1 other option regardless of field type 

package/src/builtins/docs/choice/other.mdx

@@ -1,150 +0,0 @@
----
-title: "OTHER Builtin"
-description: "Retrieve the other option value from choice field (SingleChoiceField or MultiChoiceField)"
-category: "choice"
-tags: ["choice", "other", "custom", "multichoice"]
----
-
-# OTHER Function
-
-The `OTHER` builtin retrieves the other label if the user entered an other option in a choice field, returning `null` if no other option is present. Works with both SingleChoiceField (single selection) and MultiChoiceField (multiple selections).
-
-## Syntax
-
-```javascript
-OTHER(choiceField)
-```
-
-## Parameters
-
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `choiceField` | `Object` | The choice field object (SingleChoiceField with choice array or MultiChoiceField with choices array) and other array |
-
-## Return Value
-
-Returns the other label as a string if user entered an other option, `null` otherwise.
-
-## Examples
-
-### Basic Usage - SingleChoiceField
-
-```javascript
-// Get the other value from single choice field
-OTHER($city)
-```
-
-### Basic Usage - MultiChoiceField
-
-```javascript
-// Get the other value from multi choice field
-OTHER($colors)
-```
-
-### Conditional Logic
-
-```javascript
-// Use in conditional expressions for single choice
-IF(HASOTHER($city), "Custom city: " + OTHER($city), "No custom city entered")
-
-// Use in conditional expressions for multi choice
-IF(HASOTHER($colors), "Custom color: " + OTHER($colors), "No custom color entered")
-```
-
-### Display Logic
-
-```javascript
-// Show other value in display
-"Additional info: " + OTHER($comments)
-```
-
-### Validation
-
-```javascript
-// Validate other input length
-OTHER($reason).length > 10
-```
-
-## Common Use Cases
-
-- **Custom input display**: Show user-entered custom values
-- **Conditional logic**: Make decisions based on other option content
-- **Validation**: Validate the content of other options
-- **Data processing**: Extract custom values for further processing
-- **Multi-choice support**: Works seamlessly with both single and multiple choice fields
-
-## Best Practices
-
-1. **Check with HASOTHER**: Always use `HASOTHER()` to check if other option exists before using `OTHER()`
-2. **Handle null values**: Always handle the case where `OTHER()` returns null
-3. **Validation**: Validate other inputs for length, format, etc.
-4. **User feedback**: Provide clear feedback about other option values
-5. **Multi-choice compatibility**: Works with both SingleChoiceField and MultiChoiceField
-
-## Related Functions
-
-- [`HASOTHER`](./hasother.mdx) - Check if other option is selected
-- [`CHOICEVALUE`](./choicevalue.mdx) - Get the selected choice value (SingleChoiceField)
-- [`CHOICELABEL`](./choicelabel.mdx) - Get the selected choice label (SingleChoiceField)
-- [`CHOICEVALUES`](./choicevalues.mdx) - Get all selected choice values (MultiChoiceField)
-- [`CHOICELABELS`](./choicelabels.mdx) - Get all selected choice labels (MultiChoiceField)
-
-## Examples by Use Case
-
-### Custom Input Display - SingleChoiceField
-
-```javascript
-// Display custom input with fallback
-IF(HASOTHER($industry), "Industry: " + OTHER($industry), "Industry: " + CHOICELABEL($industry))
-```
-
-### Custom Input Display - MultiChoiceField
-
-```javascript
-// Display custom input with fallback for multi-choice
-IF(HASOTHER($skills), "Custom skill: " + OTHER($skills), "Skills: " + CHOICELABELS($skills).join(", "))
-```
-
-### Validation Rules
-
-```javascript
-// Ensure other input meets requirements
-IF(HASOTHER($reason), OTHER($reason).length >= 5, true)
-```
-
-### Data Processing - SingleChoiceField
-
-```javascript
-// Process other values differently
-IF(HASOTHER($category), "CUSTOM: " + OTHER($category), "STANDARD: " + CHOICEVALUE($category))
-```
-
-### Data Processing - MultiChoiceField
-
-```javascript
-// Process other values differently for multi-choice
-IF(HASOTHER($categories), "CUSTOM: " + OTHER($categories), "STANDARD: " + CHOICEVALUES($categories).join(", "))
-```
-
-### Form Summary
-
-```javascript
-// Include other values in form summary
-"Additional comments: " + (HASOTHER($comments) ? OTHER($comments) : "None")
-```
-
-## Null Handling
-
-Always handle the null case when using `OTHER()`:
-
-```javascript
-// Safe usage with null check
-IF(HASOTHER($field), OTHER($field) || "No value", "Standard selection")
-```
-
-## Field Type Compatibility
-
-- **SingleChoiceField**: Single selection with optional other input
-- **MultiChoiceField**: Multiple selections with optional other input
-- **Note**: User can only add 1 other option regardless of field type
-- **Return value**: Always returns a single string (the other label) or null 

package/src/builtins/docs/control/setresult.mdx

@@ -1,203 +0,0 @@
----
-title: "SETRESULT Builtin"
-description: "Set calculation results in form0 expressions"
-category: "control"
-tags: ["calculation", "result", "output"]
----
-
-# SETRESULT Function
-
-The `SETRESULT` builtin sets a result value that can be consumed by the form0 engine, typically used in calculations to define the final output value.
-
-## Syntax
-
-```javascript
-SETRESULT(value)
-```
-
-## Parameters
-
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `value` | `any` | The value to set as the result |
-
-## Return Value
-
-Returns the same value that was passed in, while internally storing it as the calculation result.
-
-## Examples
-
-### Basic Calculation
-
-```javascript
-// Calculate total price with tax
-SETRESULT(price * quantity * (1 + taxRate))
-```
-
-### Conditional Results
-
-```javascript
-// Set discount amount based on user type
-SETRESULT(IF(user.isPremium, price * 0.2, price * 0.05))
-```
-
-### Complex Business Logic
-
-```javascript
-// Calculate shipping cost with multiple factors
-SETRESULT(
-  IF(country === "US",
-    IF(orderValue > 50, 0, 5.99),
-    IF(orderValue > 100, 10, 15.99)
-  )
-)
-```
-
-### Score Calculations
-
-```javascript
-// Calculate user credit score
-SETRESULT(
-  (creditHistory * 0.35) + 
-  (paymentHistory * 0.35) + 
-  (creditUtilization * 0.30)
-)
-```
-
-### Dynamic Field Values
-
-```javascript
-// Set field value based on other fields
-SETRESULT(
-  IF(AND(firstName.length > 0, lastName.length > 0),
-    firstName + " " + lastName,
-    "Anonymous User"
-  )
-)
-```
-
-## How It Works
-
-1. **Calculation Execution**: The form0 engine executes your calculation expression
-2. **Result Storage**: `SETRESULT` stores the value internally
-3. **Result Consumption**: The engine retrieves the stored result
-4. **Value Return**: The function also returns the value for use in expressions
-
-## Common Use Cases
-
-- **Price calculations**: Total cost, discounts, taxes
-- **Score computations**: Credit scores, ratings, assessments
-- **Field aggregations**: Combining multiple fields into one result
-- **Conditional outputs**: Different results based on conditions
-- **Business rule results**: Complex logic outcomes
-
-## Best Practices
-
-1. **Single result per calculation**: Use only one `SETRESULT` per expression
-2. **Clear value types**: Ensure the result type matches expectations
-3. **Handle edge cases**: Consider null/undefined values
-4. **Document complex logic**: Add comments for complex calculations
-
-## Important Notes
-
-- **Single use**: Only one `SETRESULT` should be called per calculation
-- **Last wins**: If called multiple times, the last value is used
-- **Pass-through**: The function returns the value, so it can be used in expressions
-- **Type preservation**: The result maintains its original type
-
-## Related Functions
-
-- [`IF`](../logical/if.mdx) - Conditional logic for result selection
-- [`AND`](../logical/and.mdx) - Multiple condition checks
-- [`OR`](../logical/or.mdx) - Alternative condition checks
-
-## Examples by Use Case
-
-### E-commerce Pricing
-
-```javascript
-// Calculate final price with all factors
-SETRESULT(
-  (basePrice * quantity) + 
-  shippingCost + 
-  (taxableAmount * taxRate) - 
-  discountAmount
-)
-```
-
-### User Scoring
-
-```javascript
-// Calculate engagement score
-SETRESULT(
-  (loginFrequency * 0.3) +
-  (activityLevel * 0.4) +
-  (socialSharing * 0.3)
-)
-```
-
-### Form Validation Results
-
-```javascript
-// Set validation status
-SETRESULT(
-  IF(AND(email.isValid, phone.isValid, name.length > 0),
-    "valid",
-    "invalid"
-  )
-)
-```
-
-### Financial Calculations
-
-```javascript
-// Calculate loan eligibility
-SETRESULT(
-  IF(AND(creditScore > 650, income > 50000, debtRatio < 0.4),
-    "approved",
-    "denied"
-  )
-)
-```
-
-### Progress Tracking
-
-```javascript
-// Calculate completion percentage
-SETRESULT(
-  Math.round(
-    (completedSteps / totalSteps) * 100
-  )
-)
-```
-
-## Advanced Examples
-
-### Multi-step Calculation
-
-```javascript
-// Calculate insurance premium
-SETRESULT(
-  IF(age < 25, 
-    basePremium * 1.5,
-    IF(age > 65,
-      basePremium * 1.2,
-      basePremium
-    )
-  ) * 
-  IF(hasAccidents, 1.3, 1.0) *
-  IF(location === "urban", 1.1, 0.9)
-)
-```
-
-### Data Aggregation
-
-```javascript
-// Calculate average rating
-SETRESULT(
-  IF(reviewCount > 0,
-    (rating1 + rating2 + rating3 + rating4 + rating5) / reviewCount,
-    0
-  )
-)
-```