@jigx/core-sdk 1.1.0 → 1.2.0-rc

package/docs/validation-patterns.md

@@ -0,0 +1,150 @@
+## Basic Validation
+
+```typescript
+const age = step.addNumber({
+ name: 'age',
+ label: 'Age',
+})
+age.with({
+ errorText: new JsonataBuilder('$age < 18 ? "Must be 18 or older" : null', {
+  age: age.state.value,
+ }),
+})
+```
+
+## Password Matching
+
+```typescript
+const password = step.addText({ name: 'password', label: 'Password' })
+const confirm = step.addText({
+ name: 'confirm-password',
+ label: 'Confirm Password',
+})
+confirm.with({
+ errorText: new JsonataBuilder('$confirm = $password ? null : "Passwords must match"', {
+  password: password.state.value,
+  confirm: confirm.state.value,
+ }),
+})
+```
+
+## Conditional Validation
+
+Validate based on other field values:
+
+```typescript
+const country = step.addDropdown({
+ name: 'country',
+ label: 'Country',
+ data: [
+  { label: 'USA', value: 'usa' },
+  { label: 'Canada', value: 'canada' },
+ ],
+})
+// Different validation per country
+const zipCode = step.addText({
+ name: 'zip',
+ label: 'ZIP/Postal Code',
+})
+zipCode.with({
+ errorText: new JsonataBuilder(
+  `
+ $country = "usa" and $length($zip) != 5 ? "US ZIP must be 5 digits" :
+ $country = "canada" and $length($zip) != 6 ? "Canadian postal code must be 6 characters" :
+ null
+`,
+  {
+   country: country.state.value,
+   zip: zipCode.state.value,
+  },
+ ),
+})
+```
+
+## Range Validation
+
+```typescript
+ const quantity = step.addNumber({
+  name: 'quantity',
+  label: 'Quantity',
+ })
+ quantity.with({
+  errorText: new JsonataBuilder(
+   `
+ $qty = null ? null :
+ $qty < 1 ? "Minimum quantity is 1" :
+ $qty > 100 ? "Maximum quantity is 100" :
+ null
+`,
+   { qty: quantity.state.value },
+  ),
+ })
+```
+
+## Format Validation
+
+```typescript
+const phone = step.addText({
+ name: 'phone',
+ label: 'Phone',
+})
+phone.with({
+ errorText: new JsonataBuilder(
+  `
+ $phone = null or $phone = "" ? null :
+ $length($phone) < 10 ? "Phone must be at least 10 digits" :
+ null
+`,
+  { phone: phone.state.value },
+ ),
+})
+```
+
+## Validation Expression Pattern
+
+```
+<condition> ? "<error message>" : null
+```
+
+**Multiple conditions:**
+
+```text
+<check1> ? "<error1>" :
+<check2> ? "<error2>" :
+<check3> ? "<error3>" :
+null
+```
+
+## Cross-Step Validation
+
+Validate against data from other steps:
+
+```typescript
+const step1 = form.addStep({ instanceId: 'dates', icon: 'calendar' }, (step) => {
+ step.addDate({ name: 'start-date', label: 'Start Date' })
+})
+form.addStep({ instanceId: 'end', title: 'End Date', icon: 'calendar' }, (step) => {
+ const endDate = step.addDate({
+  name: 'end-date',
+  label: 'End Date',
+ })
+ endDate.with({
+  errorText: new JsonataBuilder(
+   '$end < $start ? "End date must be after start date" : null',
+   {
+    start: step1.data.getFieldData('start-date'),
+    end: endDate.state.value,
+   },
+  ),
+ })
+})
+```
+
+## Useful JSONata Functions
+
+| Function | Purpose | Example |
+| --- | --- | --- |
+| `$length(str)` | String length | `$length($phone) < 10` |
+| `$contains(str, sub)` | Contains substring | `$contains($email, "@")` |
+| `$match(str, regex)` | Regex match | `$match($code, /^[A-Z]{3}$/)` |
+| `$number(str)` | Convert to number | `$number($age) >= 18` |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jigx/core-sdk",
-  "version": "1.1.0",
+  "version": "1.2.0-rc",
   "description": "Jigx Software Development Kit - SDK for building Jigx applications",
   "type": "module",
   "main": "dist/index.js",
@@ -25,7 +25,8 @@
   },
   "license": "ISC",
   "files": [
-    "dist"
+    "dist",
+    "docs"
   ],
   "keywords": [
     "jigx",