form0-core 0.3.0 → 0.4.0

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

@@ -1,110 +0,0 @@
----
-title: "CHOICELABEL Builtin"
-description: "Retrieve the selected choice field label with type preservation"
-category: "choice"
-tags: ["choice", "label", "display"]
----
-
-# CHOICELABEL Function
-
-The `CHOICELABEL` builtin retrieves the currently selected choice field label, preserving the original data type. If the label is a number, it preserves the number type; otherwise, it returns a string.
-
-## Syntax
-
-```javascript
-CHOICELABEL(choiceField)
-```
-
-## Parameters
-
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `choiceField` | `Object` | The choice field object with choice and other arrays |
-
-## Return Value
-
-Returns the selected choice label with preserved type, or `null` if no selection is made.
-
-## Examples
-
-### Basic Usage
-
-```javascript
-// Get the selected city label
-CHOICELABEL($city)
-```
-
-### Display Logic
-
-```javascript
-// Use in display expressions
-"You selected: " + CHOICELABEL($city)
-```
-
-### Conditional Display
-
-```javascript
-// Show different content based on label
-IF(CHOICELABEL($membership) === "Premium", "Premium benefits apply", "Standard benefits")
-```
-
-### Form Feedback
-
-```javascript
-// Provide user feedback
-"Your choice: " + CHOICELABEL($preference)
-```
-
-## Type Preservation
-
-The function preserves the original data type of the choice label:
-
-```javascript
-// If choice label is "42" (string), returns 42 (number)
-// If choice label is "Premium" (string), returns "Premium" (string)
-// If choice label is 5 (number), returns 5 (number)
-```
-
-
-
-## Common Use Cases
-
-- **User feedback**: Display the human-readable label of selected choices
-- **Conditional display**: Show different content based on selected labels
-- **Form summaries**: Include readable choice labels in form summaries
-- **Reporting**: Use labels in reports and analytics
-
-## Best Practices
-
-1. **User-friendly display**: Use labels for user-facing content instead of values
-2. **Handle null values**: Always check for null when no selection is made
-3. **Internationalization**: Consider that labels might be translated
-
-## Related Functions
-
-- [`CHOICEVALUE`](./choicevalue.mdx) - Get the selected choice value
-- [`HASOTHER`](./hasother.mdx) - Check if other option is selected
-- [`OTHER`](./other.mdx) - Get the other option value
-
-## Examples by Use Case
-
-### User Confirmation
-
-```javascript
-// Confirm user selection
-"You have selected: " + CHOICELABEL($plan)
-```
-
-### Conditional Messaging
-
-```javascript
-// Show different messages based on selection
-IF(CHOICELABEL($support) === "Priority Support", "Priority support activated", "Standard support")
-```
-
-### Form Summary
-
-```javascript
-// Create form summary
-"Location: " + CHOICELABEL($location) + ", Plan: " + CHOICELABEL($plan)
-``` 

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

@@ -1,230 +0,0 @@
----
-title: "CHOICELABELS Builtin"
-description: "Retrieve all selected choice labels from MultiChoiceField"
-category: "choice"
-tags: ["choice", "multichoice", "labels", "array"]
----
-
-# CHOICELABELS Function
-
-The `CHOICELABELS` builtin retrieves an array of all selected choice field labels from a MultiChoiceField, preserving the type of each label. Returns an empty array if no selections are made.
-
-## Syntax
-
-```javascript
-CHOICELABELS(multiChoiceField)
-```
-
-## Parameters
-
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `multiChoiceField` | `Object` | The multi choice field object with choices and other arrays |
-
-## Return Value
-
-Returns an array of selected choice labels with preserved types. Returns an empty array if no selections are made.
-
-## Examples
-
-### Basic Usage
-
-```javascript
-// Get all selected color labels
-CHOICELABELS($colors)
-```
-
-### Display Logic
-
-```javascript
-// Display selected labels in a sentence
-"Selected colors: " + CHOICELABELS($colors).join(", ")
-
-// Show count with labels
-CHOICELABELS($skills).length + " skills selected: " + CHOICELABELS($skills).join(" • ")
-```
-
-### Array Operations
-
-```javascript
-// Check if specific label is selected
-CHOICELABELS($categories).includes("Technology")
-
-// Get number of selected items
-CHOICELABELS($preferences).length
-
-// Join labels with custom separator
-CHOICELABELS($tags).join(" | ")
-```
-
-### Conditional Logic
-
-```javascript
-// Check if multiple items are selected
-CHOICELABELS($options).length > 1
-
-// Check if specific label is selected
-CHOICELABELS($features).includes("Premium Plan")
-```
-
-### Validation
-
-```javascript
-// Ensure at least 2 items are selected
-CHOICELABELS($skills).length >= 2
-
-// Validate maximum selections
-CHOICELABELS($interests).length <= 3
-```
-
-### User-Friendly Display
-
-```javascript
-// Create user-friendly summaries
-"Your interests: " + CHOICELABELS($interests).join(", ")
-
-// Display with proper grammar
-IF(CHOICELABELS($items).length === 1, 
-   "You selected: " + CHOICELABELS($items)[0], 
-   "You selected: " + CHOICELABELS($items).join(", "))
-```
-
-## Common Use Cases
-
-- **User interface**: Display human-readable labels to users
-- **Form summaries**: Show selected options in confirmation screens
-- **Validation**: Check selection counts and specific labels
-- **Reports**: Generate user-friendly reports with readable labels
-- **Email templates**: Include selected options in notifications
-
-## Best Practices
-
-1. **User-friendly display**: Use labels for showing selections to users (more readable than values)
-2. **Type preservation**: The function preserves the original type of each label (string, number, etc.)
-3. **Empty array handling**: Always check for empty arrays when no selections are made
-4. **Array methods**: Use JavaScript array methods for processing (includes, join, filter, etc.)
-5. **Internationalization**: Labels can be localized while values remain consistent
-
-## Related Functions
-
-- [`CHOICEVALUES`](./choicevalues.mdx) - Get all selected choice values (MultiChoiceField)
-- [`CHOICEVALUE`](./choicevalue.mdx) - Get the selected choice value (SingleChoiceField)
-- [`CHOICELABEL`](./choicelabel.mdx) - Get the selected choice label (SingleChoiceField)
-- [`HASOTHER`](./hasother.mdx) - Check if other option is selected
-- [`OTHER`](./other.mdx) - Get the other option value
-
-## Examples by Use Case
-
-### Form Summaries
-
-```javascript
-// Create a comprehensive form summary
-"Selected preferences: " + CHOICELABELS($preferences).join(", ")
-
-// Show selection count with labels
-"You have selected " + CHOICELABELS($courses).length + " courses: " + CHOICELABELS($courses).join(", ")
-```
-
-### Conditional Display
-
-```javascript
-// Show different content based on selections
-IF(CHOICELABELS($membership).includes("Premium"), "Premium features available", "Upgrade to access premium features")
-
-// Display based on selection count
-IF(CHOICELABELS($skills).length >= 3, "Expert level detected", "Beginner level")
-```
-
-### Email Templates
-
-```javascript
-// Generate email content with selected options
-"Dear user, you have selected the following services: " + CHOICELABELS($services).join(", ")
-
-// Confirmation messages
-"Your subscription includes: " + CHOICELABELS($subscription_features).join(" • ")
-```
-
-### Validation Messages
-
-```javascript
-// User-friendly validation messages
-IF(CHOICELABELS($required_skills).length < 2, 
-   "Please select at least 2 skills", 
-   "Skills selected: " + CHOICELABELS($required_skills).join(", "))
-```
-
-### Report Generation
-
-```javascript
-// Generate user-friendly reports
-"Popular choices: " + CHOICELABELS($popular_items).join(", ")
-
-// Statistical summaries
-CHOICELABELS($survey_responses).length + " responses recorded"
-```
-
-### Dynamic Content
-
-```javascript
-// Show content based on selected labels
-IF(CHOICELABELS($interests).includes("Sports"), "Check out our sports section!", "")
-
-// Personalized recommendations
-"Based on your selection of " + CHOICELABELS($preferences).join(" and ") + ", we recommend..."
-```
-
-## Type Preservation
-
-The function automatically preserves the original type of each label:
-
-```javascript
-// String labels remain strings
-CHOICELABELS($colors) // ["Red", "Blue", "Green"]
-
-// Numeric labels remain numbers
-CHOICELABELS($ratings) // [4, 5, 3]
-
-// Mixed types are preserved
-CHOICELABELS($mixed) // ["Text Label", 42, "Another Label"]
-```
-
-## Array Methods
-
-Use standard JavaScript array methods for processing:
-
-```javascript
-// Check if array contains label
-CHOICELABELS($skills).includes("JavaScript")
-
-// Get array length
-CHOICELABELS($items).length
-
-// Join with separator
-CHOICELABELS($tags).join(", ")
-
-// Filter labels
-CHOICELABELS($categories).filter(label => label.startsWith("Tech"))
-
-// Map labels
-CHOICELABELS($codes).map(label => label.toUpperCase())
-```
-
-## Labels vs Values
-
-Understanding when to use labels vs values:
-
-```javascript
-// Use CHOICELABELS for user display
-"You selected: " + CHOICELABELS($colors).join(", ") // "Red, Blue, Green"
-
-// Use CHOICEVALUES for logic/processing
-IF(CHOICEVALUES($colors).includes("red"), "Red color processing", "") // uses value "red"
-```
-
-## Field Type Compatibility
-
-- **MultiChoiceField**: Primary use case - returns array of selected labels
-- **SingleChoiceField**: Not applicable - use `CHOICELABEL()` instead
-- **Note**: Always returns an array, even if empty
-- **Localization**: Labels can be localized while maintaining consistent values 

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

@@ -1,109 +0,0 @@
----
-title: "CHOICEVALUE Builtin"
-description: "Retrieve the selected choice field value with type preservation"
-category: "choice"
-tags: ["choice", "value", "selection"]
----
-
-# CHOICEVALUE Function
-
-The `CHOICEVALUE` builtin retrieves the currently selected choice field value, preserving the original data type. If the value is a number, it preserves the number type; otherwise, it returns a string.
-
-## Syntax
-
-```javascript
-CHOICEVALUE(choiceField)
-```
-
-## Parameters
-
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `choiceField` | `Object` | The choice field object with choice and other arrays |
-
-## Return Value
-
-Returns the selected choice value with preserved type, or `null` if no selection is made.
-
-## Examples
-
-### Basic Usage
-
-```javascript
-// Get the selected city value
-CHOICEVALUE($city)
-```
-
-### Conditional Logic
-
-```javascript
-// Use in conditional expressions
-IF(CHOICEVALUE($city) === "bogota", "Welcome to Bogotá!", "Welcome!")
-```
-
-### Calculations
-
-```javascript
-// Use numeric choice values in calculations
-CHOICEVALUE($priority) * 10
-```
-
-### Comparison Operations
-
-```javascript
-// Compare with other values
-CHOICEVALUE($status) === "active"
-```
-
-## Type Preservation
-
-The function preserves the original data type of the choice value:
-
-```javascript
-// If choice value is "42" (string), returns 42 (number)
-// If choice value is "hello" (string), returns "hello" (string)
-// If choice value is 3.14 (number), returns 3.14 (number)
-```
-
-
-
-## Common Use Cases
-
-- **Conditional logic**: Make decisions based on selected values
-- **Calculations**: Use numeric choice values in mathematical operations
-- **Data processing**: Extract choice values for further processing
-- **Validation**: Check if specific values are selected
-
-## Best Practices
-
-1. **Handle null values**: Always check for null when no selection is made
-2. **Type awareness**: Be aware of type preservation when using in calculations
-
-## Related Functions
-
-- [`CHOICELABEL`](./choicelabel.mdx) - Get the selected choice label
-- [`HASOTHER`](./hasother.mdx) - Check if other option is selected
-- [`OTHER`](./other.mdx) - Get the other option value
-
-## Examples by Use Case
-
-### E-commerce Priority
-
-```javascript
-// Calculate priority score based on selected priority level
-CHOICEVALUE($priority) * 100
-```
-
-### Status-Based Logic
-
-```javascript
-// Show different messages based on status
-IF(CHOICEVALUE($status) === "premium", "Premium features enabled", "Standard features")
-```
-
-### Numeric Calculations
-
-```javascript
-// Use numeric choice values in calculations
-CHOICEVALUE($quantity) * CHOICEVALUE($price)
-``` 

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

@@ -1,196 +0,0 @@
----
-title: "CHOICEVALUES Builtin"
-description: "Retrieve all selected choice values from MultiChoiceField"
-category: "choice"
-tags: ["choice", "multichoice", "values", "array"]
----
-
-# CHOICEVALUES Function
-
-The `CHOICEVALUES` builtin retrieves an array of all selected choice field values from a MultiChoiceField, preserving the type of each value. Returns an empty array if no selections are made.
-
-## Syntax
-
-```javascript
-CHOICEVALUES(multiChoiceField)
-```
-
-## Parameters
-
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `multiChoiceField` | `Object` | The multi choice field object with choices and other arrays |
-
-## Return Value
-
-Returns an array of selected choice values with preserved types. Returns an empty array if no selections are made.
-
-## Examples
-
-### Basic Usage
-
-```javascript
-// Get all selected color values
-CHOICEVALUES($colors)
-```
-
-### Array Operations
-
-```javascript
-// Check if "red" is selected
-CHOICEVALUES($colors).includes("red")
-
-// Get number of selected items
-CHOICEVALUES($skills).length
-
-// Join values with separator
-CHOICEVALUES($categories).join(", ")
-```
-
-### Conditional Logic
-
-```javascript
-// Check if multiple items are selected
-CHOICEVALUES($preferences).length > 1
-
-// Check if specific value is selected
-CHOICEVALUES($features).includes("premium")
-```
-
-### Validation
-
-```javascript
-// Ensure at least 2 items are selected
-CHOICEVALUES($skills).length >= 2
-
-// Validate maximum selections
-CHOICEVALUES($options).length <= 5
-```
-
-### Data Processing
-
-```javascript
-// Process selected values
-"Selected: " + CHOICEVALUES($items).join(" | ")
-
-// Count selections
-"You selected " + CHOICEVALUES($choices).length + " items"
-```
-
-## Common Use Cases
-
-- **Data extraction**: Get all selected values for processing
-- **Validation**: Check selection counts and specific values
-- **Display logic**: Show selected values in custom format
-- **Conditional behavior**: Make decisions based on selected values
-- **Form calculations**: Use selected values in calculations
-
-## Best Practices
-
-1. **Type preservation**: The function preserves the original type of each value (string, number, etc.)
-2. **Empty array handling**: Always check for empty arrays when no selections are made
-3. **Array methods**: Use JavaScript array methods for processing (includes, join, filter, etc.)
-4. **Performance**: Efficient for checking multiple values at once
-5. **Validation**: Use for enforcing selection limits and requirements
-
-## Related Functions
-
-- [`CHOICELABELS`](./choicelabels.mdx) - Get all selected choice labels (MultiChoiceField)
-- [`CHOICEVALUE`](./choicevalue.mdx) - Get the selected choice value (SingleChoiceField)
-- [`CHOICELABEL`](./choicelabel.mdx) - Get the selected choice label (SingleChoiceField)
-- [`HASOTHER`](./hasother.mdx) - Check if other option is selected
-- [`OTHER`](./other.mdx) - Get the other option value
-
-## Examples by Use Case
-
-### Selection Validation
-
-```javascript
-// Require at least 2 skills
-CHOICEVALUES($skills).length >= 2
-
-// Ensure premium feature is selected if advanced is selected
-IF(CHOICEVALUES($features).includes("advanced"), CHOICEVALUES($features).includes("premium"), true)
-```
-
-### Display Logic
-
-```javascript
-// Show selected values in a custom format
-"Your selections: " + CHOICEVALUES($preferences).join(" • ")
-
-// Display count with proper pluralization
-CHOICEVALUES($items).length + (CHOICEVALUES($items).length === 1 ? " item" : " items") + " selected"
-```
-
-### Conditional Processing
-
-```javascript
-// Different logic based on selections
-IF(CHOICEVALUES($payment_methods).includes("credit_card"), "Credit card processing enabled", "Standard payment only")
-
-// Check for conflicting selections
-IF(AND(CHOICEVALUES($options).includes("basic"), CHOICEVALUES($options).includes("premium")), "Conflicting options selected", "Valid selection")
-```
-
-### Data Analysis
-
-```javascript
-// Calculate total based on selected values
-CHOICEVALUES($services).reduce((sum, value) => sum + (value === "premium" ? 100 : 50), 0)
-
-// Filter numeric values
-CHOICEVALUES($quantities).filter(val => typeof val === 'number').reduce((sum, val) => sum + val, 0)
-```
-
-### Form Behavior
-
-```javascript
-// Show additional fields based on selections
-IF(CHOICEVALUES($interests).includes("technology"), "Show tech-related questions", "")
-
-// Enable features based on selections
-IF(CHOICEVALUES($subscriptions).includes("pro"), "Pro features enabled", "Basic features only")
-```
-
-## Type Preservation
-
-The function automatically preserves the original type of each value:
-
-```javascript
-// String values remain strings
-CHOICEVALUES($colors) // ["red", "blue", "green"]
-
-// Numeric values remain numbers
-CHOICEVALUES($ratings) // [4, 5, 3]
-
-// Mixed types are preserved
-CHOICEVALUES($mixed) // ["text", 42, "another"]
-```
-
-## Array Methods
-
-Use standard JavaScript array methods for processing:
-
-```javascript
-// Check if array contains value
-CHOICEVALUES($skills).includes("javascript")
-
-// Get array length
-CHOICEVALUES($items).length
-
-// Join with separator
-CHOICEVALUES($tags).join(", ")
-
-// Filter values
-CHOICEVALUES($numbers).filter(n => n > 5)
-
-// Map values
-CHOICEVALUES($codes).map(code => code.toUpperCase())
-```
-
-## Field Type Compatibility
-
-- **MultiChoiceField**: Primary use case - returns array of selected values
-- **SingleChoiceField**: Not applicable - use `CHOICEVALUE()` instead
-- **Note**: Always returns an array, even if empty