form-craft-package 1.7.9-dev.1 → 1.7.9

package/AJV_JSON_Schema_Guide.md

@@ -1,409 +1,409 @@
-# AJV JSON Schema Documentation
-
-## 1. `$schema`
-
-Defines the JSON Schema version.
-
-```json
-{
-  "$schema": "http://json-schema.org/draft-07/schema#"
-}
-```
-
-## 2. `type`
-
-Specifies the data type: `object`, `array`, `string`, `number`, `integer`, or `boolean`.
-
-```json
-{
-  "type": "string"
-}
-```
-
-## 3. `properties`
-
-Defines the properties of an object and their types.
-
-```json
-{
-  "type": "object",
-  "properties": {
-    "name": { "type": "string" },
-    "age": { "type": "integer" }
-  }
-}
-```
-
-## 4. `required`
-
-Lists mandatory fields in an object.
-
-```json
-{
-  "type": "object",
-  "properties": {
-    "name": { "type": "string" },
-    "age": { "type": "integer" }
-  },
-  "required": ["name"]
-}
-```
-
-- **`name`** is required.
-- **`age`** is optional.
-
----
-
-## 5. `items`
-
-If the `type` is `array`, the `items` property defines the schema for the array elements.
-
-### a. Single Type for All Items
-
-```json
-{
-  "type": "array",
-  "items": { "type": "string" }
-}
-```
-
-- Valid: `["apple", "banana"]`
-- Invalid: `[1, "apple"]`
-
-### b. Different Types for Items (Tuple Validation)
-
-```json
-{
-  "type": "array",
-  "items": [{ "type": "string" }, { "type": "integer" }]
-}
-```
-
-- Valid: `["apple", 5]`
-- Invalid: `["apple", "banana"]`
-
-### c. Additional Items
-
-Control extra items beyond those specified.
-
-```json
-{
-  "type": "array",
-  "items": [{ "type": "string" }, { "type": "integer" }],
-  "additionalItems": false
-}
-```
-
-- Valid: `["apple", 5]`
-- Invalid: `["apple", 5, "extra"]`
-
----
-
-## 6. `enum`
-
-Restricts a field to specific values.
-
-```json
-{
-  "type": "string",
-  "enum": ["red", "green", "blue"]
-}
-```
-- Allows only these three values.
-
-## 7. `minimum` and `maximum`
-
-Sets the range for numbers.
-
-```json
-{
-  "type": "number",
-  "minimum": 10,
-  "maximum": 100
-}
-```
-
-## 8. `minLength` and `maxLength`
-
-Sets the length constraints for strings.
-
-```json
-{
-  "type": "string",
-  "minLength": 3,
-  "maxLength": 10
-}
-```
-
-## 9. `pattern`
-
-Validates strings against a regex pattern.
-
-```json
-{
-  "type": "string",
-  "pattern": "^[A-Z][a-z]+$"
-}
-```
-- The string should start with an uppercase letter.
-
-## 10. `format`
-
-AJV supports several predefined string formats:
-
-| **Format**     | **Description**                                       |
-| -------------- | ----------------------------------------------------- |
-| `email`        | Valid email address (e.g., `user@domain.com`)         |
-| `uri`          | Uniform Resource Identifier (URI)                     |
-| `url`          | Web address (HTTP/HTTPS)                              |
-| `date`         | Date in `YYYY-MM-DD` format                           |
-| `time`         | Time in `HH:MM:SS` format                             |
-| `date-time`    | Combined date and time (e.g., `2023-10-12T10:15:30Z`) |
-| `ipv4`         | IPv4 address (e.g., `192.168.1.1`)                    |
-| `ipv6`         | IPv6 address (e.g., `::1`)                            |
-| `uuid`         | UUID (e.g., `550e8400-e29b-41d4-a716-446655440000`)   |
-| `hostname`     | Valid DNS hostname                                    |
-| `regex`        | Regular expression                                    |
-| `json-pointer` | JSON Pointer (e.g., `/path/to/data`)                  |
-
-Custom formats can be defined using `ajv.addFormat`.
-
-```json
-{
-  "type": "string",
-  "format": "email"
-}
-```
-
-## 11. `default`
-
-Provides a default value for a property.
-
-```json
-{
-  "type": "object",
-  "properties": {
-    "isActive": { "type": "boolean", "default": true }
-  }
-}
-```
-
-## 12. `oneOf`
-
-Specifies multiple valid schemas (OR).
-
-```json
-{
-  "oneOf": [{ "type": "string" }, { "type": "integer" }]
-}
-```
-- Allows either a string or an integer, but not both.
-
-## 13. `allOf`
-
-Requires the data to match all schemas.
-
-```json
-{
-  "allOf": [
-    { "type": "object", "properties": { "name": { "type": "string" } } },
-    { "type": "object", "properties": { "age": { "type": "integer" } } }
-  ]
-}
-```
-- Allows either a string or a boolean.
-
-## 14. `anyOf`
-
-Requires the data to match at least one schema.
-
-```json
-{
-  "anyOf": [{ "type": "string" }, { "type": "boolean" }]
-}
-```
-
-## 15. `not`
-
-Specifies that data must not match a schema.
-
-```json
-{
-  "not": { "type": "null" }
-}
-```
-- Disallows null values.
-
-## 16. `additionalProperties`
-
-Allows or disallows extra properties in an object.
-
-```json
-{
-  "type": "object",
-  "properties": {
-    "name": { "type": "string" }
-  },
-  "additionalProperties": false
-}
-```
-- Disallows extra fields.
-
-## 17. `patternProperties`
-
-Validates object keys using a regex.
-
-```json
-{
-  "type": "object",
-  "patternProperties": {
-    "^user_": { "type": "string" }
-  }
-}
-```
-
-- All keys starting with `user_` (e.g., `user_1`, `user_123`) must have string values.
-
-## 18. `dependencies`
-
-Dependencies specify logical relationships between properties.
-
-### Property Dependencies
-
-This means the presence of one property requires another property.
-
-#### Example
-
-```json
-{
-  "type": "object",
-  "properties": {
-    "creditCard": { "type": "string" },
-    "billingAddress": { "type": "string" }
-  },
-  "dependencies": {
-    "creditCard": ["billingAddress"]
-  }
-}
-```
-
-- If `creditCard` is present, `billingAddress` **must** also be present.
-- If `creditCard` is not present, `billingAddress` can be omitted.
-
-### Schema Dependencies
-
-Schema dependencies apply different schemas based on the presence of a field.
-
-#### Example
-
-```json
-{
-  "type": "object",
-  "properties": {
-    "country": { "type": "string" },
-    "postalCode": { "type": "string" }
-  },
-  "dependencies": {
-    "country": {
-      "oneOf": [
-        {
-          "properties": { "country": { "const": "US" }, "postalCode": { "pattern": "^[0-9]{5}$" } },
-          "required": ["postalCode"]
-        },
-        {
-          "properties": {
-            "country": { "const": "CA" },
-            "postalCode": { "pattern": "^[A-Z][0-9][A-Z] [0-9][A-Z][0-9]$" }
-          },
-          "required": ["postalCode"]
-        }
-      ]
-    }
-  }
-}
-```
-
-- If `country` is `"US"`, `postalCode` must match the US zip code format.
-- If `country` is `"CA"`, `postalCode` must match the Canadian postal code format.
-
----
-
-## 19. `const`
-
-Requires a field to have a specific value.
-
-```json
-{
-  "type": "object",
-  "properties": {
-    "status": { "const": "active" }
-  }
-}
-```
-- Ensures the field always equals "active".
-
-## 20. `if`, `then`, `else`
-
-Conditional validation.
-
-```json
-{
-  "if": { "properties": { "role": { "const": "admin" } } },
-  "then": { "required": ["adminCode"] },
-  "else": { "required": ["userCode"] }
-}
-```
-
-## 21. `uniqueItems`
-
-Ensures all items in an array are unique.
-
-```json
-{
-  "type": "array",
-  "items": { "type": "integer" },
-  "uniqueItems": true
-}
-```
-- Ensures [1, 2, 3] is valid, but [1, 2, 2] is not.
-
-## 22. `minItems` and `maxItems`
-
-Limits the number of items in an array.
-
-```json
-{
-  "type": "array",
-  "items": { "type": "string" },
-  "minItems": 1,
-  "maxItems": 5
-}
-```
-
-## 23. `contains`
-
-Requires at least one item in an array to match a schema.
-
-```json
-{
-  "type": "array",
-  "items": { "type": "integer" },
-  "contains": { "const": 10 }
-}
-```
-
-## 24. `$ref`
-
-References reusable schemas.
-
-```json
-{
-  "$ref": "#/definitions/person",
-  "definitions": {
-    "person": {
-      "type": "object",
-      "properties": { "name": { "type": "string" } }
-    }
-  }
-}
+# AJV JSON Schema Documentation
+
+## 1. `$schema`
+
+Defines the JSON Schema version.
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}
+```
+
+## 2. `type`
+
+Specifies the data type: `object`, `array`, `string`, `number`, `integer`, or `boolean`.
+
+```json
+{
+  "type": "string"
+}
+```
+
+## 3. `properties`
+
+Defines the properties of an object and their types.
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "name": { "type": "string" },
+    "age": { "type": "integer" }
+  }
+}
+```
+
+## 4. `required`
+
+Lists mandatory fields in an object.
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "name": { "type": "string" },
+    "age": { "type": "integer" }
+  },
+  "required": ["name"]
+}
+```
+
+- **`name`** is required.
+- **`age`** is optional.
+
+---
+
+## 5. `items`
+
+If the `type` is `array`, the `items` property defines the schema for the array elements.
+
+### a. Single Type for All Items
+
+```json
+{
+  "type": "array",
+  "items": { "type": "string" }
+}
+```
+
+- Valid: `["apple", "banana"]`
+- Invalid: `[1, "apple"]`
+
+### b. Different Types for Items (Tuple Validation)
+
+```json
+{
+  "type": "array",
+  "items": [{ "type": "string" }, { "type": "integer" }]
+}
+```
+
+- Valid: `["apple", 5]`
+- Invalid: `["apple", "banana"]`
+
+### c. Additional Items
+
+Control extra items beyond those specified.
+
+```json
+{
+  "type": "array",
+  "items": [{ "type": "string" }, { "type": "integer" }],
+  "additionalItems": false
+}
+```
+
+- Valid: `["apple", 5]`
+- Invalid: `["apple", 5, "extra"]`
+
+---
+
+## 6. `enum`
+
+Restricts a field to specific values.
+
+```json
+{
+  "type": "string",
+  "enum": ["red", "green", "blue"]
+}
+```
+- Allows only these three values.
+
+## 7. `minimum` and `maximum`
+
+Sets the range for numbers.
+
+```json
+{
+  "type": "number",
+  "minimum": 10,
+  "maximum": 100
+}
+```
+
+## 8. `minLength` and `maxLength`
+
+Sets the length constraints for strings.
+
+```json
+{
+  "type": "string",
+  "minLength": 3,
+  "maxLength": 10
+}
+```
+
+## 9. `pattern`
+
+Validates strings against a regex pattern.
+
+```json
+{
+  "type": "string",
+  "pattern": "^[A-Z][a-z]+$"
+}
+```
+- The string should start with an uppercase letter.
+
+## 10. `format`
+
+AJV supports several predefined string formats:
+
+| **Format**     | **Description**                                       |
+| -------------- | ----------------------------------------------------- |
+| `email`        | Valid email address (e.g., `user@domain.com`)         |
+| `uri`          | Uniform Resource Identifier (URI)                     |
+| `url`          | Web address (HTTP/HTTPS)                              |
+| `date`         | Date in `YYYY-MM-DD` format                           |
+| `time`         | Time in `HH:MM:SS` format                             |
+| `date-time`    | Combined date and time (e.g., `2023-10-12T10:15:30Z`) |
+| `ipv4`         | IPv4 address (e.g., `192.168.1.1`)                    |
+| `ipv6`         | IPv6 address (e.g., `::1`)                            |
+| `uuid`         | UUID (e.g., `550e8400-e29b-41d4-a716-446655440000`)   |
+| `hostname`     | Valid DNS hostname                                    |
+| `regex`        | Regular expression                                    |
+| `json-pointer` | JSON Pointer (e.g., `/path/to/data`)                  |
+
+Custom formats can be defined using `ajv.addFormat`.
+
+```json
+{
+  "type": "string",
+  "format": "email"
+}
+```
+
+## 11. `default`
+
+Provides a default value for a property.
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "isActive": { "type": "boolean", "default": true }
+  }
+}
+```
+
+## 12. `oneOf`
+
+Specifies multiple valid schemas (OR).
+
+```json
+{
+  "oneOf": [{ "type": "string" }, { "type": "integer" }]
+}
+```
+- Allows either a string or an integer, but not both.
+
+## 13. `allOf`
+
+Requires the data to match all schemas.
+
+```json
+{
+  "allOf": [
+    { "type": "object", "properties": { "name": { "type": "string" } } },
+    { "type": "object", "properties": { "age": { "type": "integer" } } }
+  ]
+}
+```
+- Allows either a string or a boolean.
+
+## 14. `anyOf`
+
+Requires the data to match at least one schema.
+
+```json
+{
+  "anyOf": [{ "type": "string" }, { "type": "boolean" }]
+}
+```
+
+## 15. `not`
+
+Specifies that data must not match a schema.
+
+```json
+{
+  "not": { "type": "null" }
+}
+```
+- Disallows null values.
+
+## 16. `additionalProperties`
+
+Allows or disallows extra properties in an object.
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "name": { "type": "string" }
+  },
+  "additionalProperties": false
+}
+```
+- Disallows extra fields.
+
+## 17. `patternProperties`
+
+Validates object keys using a regex.
+
+```json
+{
+  "type": "object",
+  "patternProperties": {
+    "^user_": { "type": "string" }
+  }
+}
+```
+
+- All keys starting with `user_` (e.g., `user_1`, `user_123`) must have string values.
+
+## 18. `dependencies`
+
+Dependencies specify logical relationships between properties.
+
+### Property Dependencies
+
+This means the presence of one property requires another property.
+
+#### Example
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "creditCard": { "type": "string" },
+    "billingAddress": { "type": "string" }
+  },
+  "dependencies": {
+    "creditCard": ["billingAddress"]
+  }
+}
+```
+
+- If `creditCard` is present, `billingAddress` **must** also be present.
+- If `creditCard` is not present, `billingAddress` can be omitted.
+
+### Schema Dependencies
+
+Schema dependencies apply different schemas based on the presence of a field.
+
+#### Example
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "country": { "type": "string" },
+    "postalCode": { "type": "string" }
+  },
+  "dependencies": {
+    "country": {
+      "oneOf": [
+        {
+          "properties": { "country": { "const": "US" }, "postalCode": { "pattern": "^[0-9]{5}$" } },
+          "required": ["postalCode"]
+        },
+        {
+          "properties": {
+            "country": { "const": "CA" },
+            "postalCode": { "pattern": "^[A-Z][0-9][A-Z] [0-9][A-Z][0-9]$" }
+          },
+          "required": ["postalCode"]
+        }
+      ]
+    }
+  }
+}
+```
+
+- If `country` is `"US"`, `postalCode` must match the US zip code format.
+- If `country` is `"CA"`, `postalCode` must match the Canadian postal code format.
+
+---
+
+## 19. `const`
+
+Requires a field to have a specific value.
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "status": { "const": "active" }
+  }
+}
+```
+- Ensures the field always equals "active".
+
+## 20. `if`, `then`, `else`
+
+Conditional validation.
+
+```json
+{
+  "if": { "properties": { "role": { "const": "admin" } } },
+  "then": { "required": ["adminCode"] },
+  "else": { "required": ["userCode"] }
+}
+```
+
+## 21. `uniqueItems`
+
+Ensures all items in an array are unique.
+
+```json
+{
+  "type": "array",
+  "items": { "type": "integer" },
+  "uniqueItems": true
+}
+```
+- Ensures [1, 2, 3] is valid, but [1, 2, 2] is not.
+
+## 22. `minItems` and `maxItems`
+
+Limits the number of items in an array.
+
+```json
+{
+  "type": "array",
+  "items": { "type": "string" },
+  "minItems": 1,
+  "maxItems": 5
+}
+```
+
+## 23. `contains`
+
+Requires at least one item in an array to match a schema.
+
+```json
+{
+  "type": "array",
+  "items": { "type": "integer" },
+  "contains": { "const": 10 }
+}
+```
+
+## 24. `$ref`
+
+References reusable schemas.
+
+```json
+{
+  "$ref": "#/definitions/person",
+  "definitions": {
+    "person": {
+      "type": "object",
+      "properties": { "name": { "type": "string" } }
+    }
+  }
+}
 ```