form-craft-package 1.0.0

package/.prettierrc

@@ -0,0 +1,9 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "endOfLine": "lf",
+  "printWidth": 120,
+  "semi": false
+}

package/AJV_JSON_Schema_Guide.md

@@ -0,0 +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" } }
+    }
+  }
+}
+```

package/README.md

@@ -0,0 +1,108 @@
+
+# Using Submodules in Your Project
+
+This guide provides instructions for adding, updating, and managing a submodule in your project. Submodules allow you to include shared code, like helper functions, from another repository.
+
+---
+
+## 1. How to Add this Submodule to a Project
+
+To add this submodule to your project, follow these steps:
+
+1. Navigate to your project directory:
+   ```bash
+   cd /path/to/your/project
+   ```
+
+2. Add the submodule in the `submodule-name` folder:
+   ```bash
+   git submodule add <submodule-repo-url> submodule-name
+   ```
+
+3. Commit the changes to your main repository (simply committing the changes):
+   ```bash
+   git add .gitmodules submodule-name
+   git commit -m "Added submodule: submodule-name"
+   ```
+
+### **Note: Submodule Configuration**
+- The submodule (`submodule-name`) is configured to be updated **only in its own repository**. Changes cannot be made directly from the projects that use this submodule.
+
+---
+
+## 2. How to Update the Submodule in a Project
+
+To pull the latest updates from the submodule repository:
+
+1. Navigate to the submodule directory:
+   ```bash
+   cd submodule-name
+   ```
+
+2. Pull the latest changes:
+   ```bash
+   git pull origin main
+   ```
+
+3. Navigate back to your main project directory:
+   ```bash
+   cd ../../
+   ```
+
+4. Stage and commit the updated submodule reference:
+   ```bash
+   git add submodule-name
+   git commit -m "Updated submodule: submodule-name to latest version"
+   ```
+
+5. Push your changes to the main repository:
+   ```bash
+   git push origin main
+   ```
+
+---
+
+## 3. Add Submodules to `.gitignore`
+
+Since the submodule is not editable directly, add its parent folder (`submodule-name/`) to your `.gitignore` file to prevent tracking unintended changes.
+
+Add the following line to your `.gitignore`:
+```
+submodule-name/
+```
+
+---
+
+## 4. Prevent Accidental Editing in the IDE
+
+To avoid accidental edits, make the submodule folder read-only in your IDE by adding the following to `.vscode/settings.json`:
+
+```json
+{
+    "files.readonlyInclude": {
+        "submodule-name/**": true
+    },
+    "git.ignoreSubmodules": true
+}
+```
+
+This configuration ensures that the submodule files are treated as read-only by your IDE.
+
+---
+
+## 5. Ignore git changes of submodules
+
+To stop seeing the git changes of the submodules when pulling the updates, add the following command to the .gitmodules file. By default, this file contains path and url.
+
+```
+  ignore = all
+```
+
+--- 
+---
+---
+
+# Peer Dependencies
+
+This submodule relies on certain **peer dependencies** to ensure compatibility and prevent version conflicts. These dependencies must be installed in the consuming project. Failing to install or using incompatible versions of these dependencies can lead to unexpected behavior.
+

package/index.ts

@@ -0,0 +1,8 @@
+export * from './src/enums'
+export * from './src/types'
+export * from './src/constants'
+export * from './src/functions'
+export * from './src/functions/json-handlers'
+export * from './src/functions/form-schema-validator'
+export * from './src/functions/get-element-props'
+export * from './src/components'

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "form-craft-package",
+  "version": "1.0.0",
+  "main": "index.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "dependencies": {
+    "ajv": "^8.17.1"
+  },
+  "peerDependencies": {
+    "antd": ">=5.21.6",
+    "axios": ">=1.7.7",
+    "dayjs": ">=1.11.13",
+    "js-cookie": ">=3.0.5",
+    "quill": ">=2.0.3",
+    "react": ">=18.0.0 <19.0.0",
+    "react-dom": ">=18.0.0 <19.0.0",
+    "react-icons": ">=5.3.0",
+    "react-quill": ">=2.0.0",
+    "react-router-dom": ">=6.27.0"
+  },
+  "devDependencies": {
+    "@types/js-cookie": "^3.0.6",
+    "@types/react": "^18.3.18",
+    "@types/react-dom": "^18.3.5",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "ts-node": "^10.9.2",
+    "vite": "^6.0.7"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/ajv/form/form.schema.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "form.schema",
+  "type": "object",
+  "properties": {
+    "layout": { "$ref": "layout.schema" },
+    "migrationRules": { "$ref": "migration-rules.schema" }
+  },
+  "required": ["layout", "migrationRules"]
+}

package/src/ajv/form/layout.schema.json

@@ -0,0 +1,97 @@
+{
+  "$id": "layout.schema",
+  "type": "array",
+  "items": { "$ref": "#/definitions/IFormLayoutRow" },
+  "definitions": {
+    "IFormLayoutRow": {
+      "type": "object",
+      "required": ["nodeType", "id", "children"],
+      "properties": {
+        "nodeType": { "type": "string", "enum": ["Row"] },
+        "id": { "type": "string" },
+        "children": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/IFormLayoutCol" }
+        },
+        "isTemplate": { "type": ["boolean", "null"] },
+        "path": { "type": ["string", "null"] }
+      }
+    },
+    "IFormLayoutCol": {
+      "type": "object",
+      "required": ["nodeType", "id", "children"],
+      "properties": {
+        "nodeType": { "type": "string", "enum": ["Col"] },
+        "id": { "type": "string" },
+        "children": {
+          "type": "array",
+          "items": {
+            "oneOf": [{ "$ref": "#/definitions/IFormLayoutRow" }, { "$ref": "#/definitions/IFormLayoutField" }]
+          }
+        }
+      }
+    },
+    "IFormLayoutField": {
+      "type": "object",
+      "required": ["nodeType", "id", "key", "fieldType", "props", "validations"],
+      "properties": {
+        "nodeType": {
+          "type": "string",
+          "enum": ["Field"]
+        },
+        "id": { "type": "string" },
+        "path": { "type": ["string", "null"] },
+        "key": { "type": "string", "minLength": 2 },
+        "fieldType": { "type": "string" },
+        "props": {
+          "type": "object",
+          "properties": {
+            "label": { "type": ["string", "null"] },
+            "placeholder": { "type": ["string", "null"] },
+            "description": { "type": ["string", "null"] },
+            "allowClear": { "type": ["boolean", "null"] },
+            "isMultiValue": { "type": ["boolean", "null"] },
+            "hasNoLabel": { "type": ["boolean", "null"] },
+            "options": {
+              "type": "array",
+              "minItems": 1,
+              "items": { "$ref": "#/definitions/IFormLayoutFieldOption" }
+            }
+          }
+        },
+        "validations": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["key", "message"],
+            "properties": {
+              "key": { "type": "string" },
+              "message": { "type": "string" },
+              "value": {}
+            }
+          }
+        },
+        "conditions": {
+          "type": "object",
+          "properties": {
+            "showIf": {
+              "type": "object",
+              "required": ["field", "value"],
+              "properties": {
+                "field": { "type": "string" },
+                "value": { "type": "string" }
+              }
+            }
+          }
+        }
+      }
+    },
+    "IFormLayoutFieldOption": {
+      "type": "object",
+      "required": ["value"],
+      "properties": {
+        "value": { "type": "string" }
+      }
+    }
+  }
+}