@acp-autoform/core 3.0.0

package/README.md

@@ -0,0 +1,13 @@
+# AutoForm Core
+
+This package provides the core functionality for AutoForm. You'll most likely use UI-library specific packages like `@acp-autoform/mui` instead of this package - unless you want to create your own renderer.
+
+The core is agnostic to both the schema and the UI library used to render the form.
+
+## Installation
+
+```bash
+npm install @acp-autoform/core
+```
+
+For more information on how to use this package, see the [AutoForm documentation](https://autoform.vantezzen.io/docs/react/getting-started).

package/dist/index.d.mts

@@ -0,0 +1,117 @@
+type Renderable<AdditionalRenderable = null> = string | number | boolean | null | undefined | AdditionalRenderable;
+interface FieldConfig<AdditionalRenderable = null, FieldTypes = string, FieldWrapper = any, CustomData = Record<string, any>> {
+    /** Help text or supporting content rendered near the field. */
+    description?: Renderable<AdditionalRenderable>;
+    /** Props forwarded to the rendered input component. */
+    inputProps?: Record<string, any>;
+    /** Custom label content. Falls back to the schema field name when omitted. */
+    label?: Renderable<AdditionalRenderable>;
+    /** Override for the inferred field renderer key. */
+    fieldType?: FieldTypes;
+    /** Sort order for generated fields. Lower values render first. */
+    order?: number;
+    /** Wrapper component override for this field only. */
+    fieldWrapper?: FieldWrapper;
+    /** Integration or app-specific metadata for custom components. */
+    customData?: CustomData;
+}
+interface ParsedField<AdditionalRenderable = null, FieldTypes = string> {
+    /** Field key from the schema object. */
+    key: string;
+    /** Parsed field type used to select a form component. */
+    type: string;
+    /** Whether the schema marks this field as required. */
+    required: boolean;
+    /** Default value inferred from the schema provider, when available. */
+    default?: any;
+    /** Description inferred from schema metadata, when available. */
+    description?: Renderable;
+    /** AutoForm field configuration attached through the schema provider. */
+    fieldConfig?: FieldConfig<AdditionalRenderable, FieldTypes>;
+    /** Enum/select choices as value-label pairs. */
+    options?: [string, string][];
+    /** Child fields for object fields, or the item schema for array fields. */
+    schema?: ParsedField<AdditionalRenderable, FieldTypes>[];
+}
+interface ParsedSchema<AdditionalRenderable = null, FieldTypes = string> {
+    fields: ParsedField<AdditionalRenderable, FieldTypes>[];
+}
+type SuccessfulSchemaValidation = {
+    success: true;
+    data: any;
+};
+type SchemaValidationError = {
+    path: (string | number)[];
+    message: string;
+};
+type ErrorSchemaValidation = {
+    success: false;
+    errors: SchemaValidationError[];
+};
+type SchemaValidation = SuccessfulSchemaValidation | ErrorSchemaValidation;
+type SchemaType = "zod" | "yup" | "joi";
+
+/**
+ * Get the best label to use for a field.
+ * This will use user-provided labels, descriptions from the schema, or the field key.
+ *
+ * @param field Parsed field
+ * @returns Label for the field
+ */
+declare function getLabel(field: ParsedField): string | number | true;
+
+/**
+ * Schema provider interface
+ *
+ * Schema providers are responsible for converting schemas from different libraries into
+ * a format that AutoForm can use.
+ * They also handle validating the form value and returning error messages in a consistent format.
+ */
+interface SchemaProvider<T = any> {
+    /**
+     * Parse the schema into a format that AutoForm can use.
+     */
+    parseSchema(): ParsedSchema;
+    /**
+     * Validate the form values against the schema.
+     * This returns either the transformed result (e.g. with date coersion) or an array of errors.
+     *
+     * @param values - Form values to validate
+     */
+    validateSchema(_values: T): SchemaValidation;
+    /**
+     * Get the default values for the fields.
+     * This is used to populate the form with initial values.
+     *
+     * @returns Default values for the form
+     */
+    getDefaultValues(): Record<string, any>;
+    /**
+     * Schema library used by consumers that need library-specific integrations.
+     */
+    schemaType?: SchemaType;
+    /**
+     * Get the original schema instance.
+     */
+    getSchema?(): unknown;
+}
+
+declare function parseSchema(schemaProvider: SchemaProvider): ParsedSchema;
+declare function validateSchema(schemaProvider: SchemaProvider, values: any): SchemaValidation;
+declare function getDefaultValues(schemaProvider: SchemaProvider): Record<string, any>;
+/**
+ * Recursively remove empty values from an object (null, undefined, '', [], {})
+ * Used in AutoForm before calling the resolver to prevent empty values from being validated.
+ * This is necessary because zod's optional() allows undefined, but form fields default to
+ * empty strings, arrays, or objects even when untouched. These defaults bypass the optional
+ * check and cause validation issues in react-hook-form.
+ */
+declare function removeEmptyValues<T extends Record<string, any>>(values: T): Partial<T>;
+declare function replaceEmptyValue<T extends Record<string, any>>(values: T): T;
+/**
+ * Sort the fields by order.
+ * If no order is set, the field will be sorted based on the order in the schema.
+ */
+declare function sortFieldsByOrder(fields: ParsedField[] | undefined): ParsedField[];
+
+export { type ErrorSchemaValidation, type FieldConfig, type ParsedField, type ParsedSchema, type Renderable, type SchemaProvider, type SchemaType, type SchemaValidation, type SchemaValidationError, type SuccessfulSchemaValidation, getDefaultValues, getLabel, parseSchema, removeEmptyValues, replaceEmptyValue, sortFieldsByOrder, validateSchema };

package/dist/index.d.ts

@@ -0,0 +1,117 @@
+type Renderable<AdditionalRenderable = null> = string | number | boolean | null | undefined | AdditionalRenderable;
+interface FieldConfig<AdditionalRenderable = null, FieldTypes = string, FieldWrapper = any, CustomData = Record<string, any>> {
+    /** Help text or supporting content rendered near the field. */
+    description?: Renderable<AdditionalRenderable>;
+    /** Props forwarded to the rendered input component. */
+    inputProps?: Record<string, any>;
+    /** Custom label content. Falls back to the schema field name when omitted. */
+    label?: Renderable<AdditionalRenderable>;
+    /** Override for the inferred field renderer key. */
+    fieldType?: FieldTypes;
+    /** Sort order for generated fields. Lower values render first. */
+    order?: number;
+    /** Wrapper component override for this field only. */
+    fieldWrapper?: FieldWrapper;
+    /** Integration or app-specific metadata for custom components. */
+    customData?: CustomData;
+}
+interface ParsedField<AdditionalRenderable = null, FieldTypes = string> {
+    /** Field key from the schema object. */
+    key: string;
+    /** Parsed field type used to select a form component. */
+    type: string;
+    /** Whether the schema marks this field as required. */
+    required: boolean;
+    /** Default value inferred from the schema provider, when available. */
+    default?: any;
+    /** Description inferred from schema metadata, when available. */
+    description?: Renderable;
+    /** AutoForm field configuration attached through the schema provider. */
+    fieldConfig?: FieldConfig<AdditionalRenderable, FieldTypes>;
+    /** Enum/select choices as value-label pairs. */
+    options?: [string, string][];
+    /** Child fields for object fields, or the item schema for array fields. */
+    schema?: ParsedField<AdditionalRenderable, FieldTypes>[];
+}
+interface ParsedSchema<AdditionalRenderable = null, FieldTypes = string> {
+    fields: ParsedField<AdditionalRenderable, FieldTypes>[];
+}
+type SuccessfulSchemaValidation = {
+    success: true;
+    data: any;
+};
+type SchemaValidationError = {
+    path: (string | number)[];
+    message: string;
+};
+type ErrorSchemaValidation = {
+    success: false;
+    errors: SchemaValidationError[];
+};
+type SchemaValidation = SuccessfulSchemaValidation | ErrorSchemaValidation;
+type SchemaType = "zod" | "yup" | "joi";
+
+/**
+ * Get the best label to use for a field.
+ * This will use user-provided labels, descriptions from the schema, or the field key.
+ *
+ * @param field Parsed field
+ * @returns Label for the field
+ */
+declare function getLabel(field: ParsedField): string | number | true;
+
+/**
+ * Schema provider interface
+ *
+ * Schema providers are responsible for converting schemas from different libraries into
+ * a format that AutoForm can use.
+ * They also handle validating the form value and returning error messages in a consistent format.
+ */
+interface SchemaProvider<T = any> {
+    /**
+     * Parse the schema into a format that AutoForm can use.
+     */
+    parseSchema(): ParsedSchema;
+    /**
+     * Validate the form values against the schema.
+     * This returns either the transformed result (e.g. with date coersion) or an array of errors.
+     *
+     * @param values - Form values to validate
+     */
+    validateSchema(_values: T): SchemaValidation;
+    /**
+     * Get the default values for the fields.
+     * This is used to populate the form with initial values.
+     *
+     * @returns Default values for the form
+     */
+    getDefaultValues(): Record<string, any>;
+    /**
+     * Schema library used by consumers that need library-specific integrations.
+     */
+    schemaType?: SchemaType;
+    /**
+     * Get the original schema instance.
+     */
+    getSchema?(): unknown;
+}
+
+declare function parseSchema(schemaProvider: SchemaProvider): ParsedSchema;
+declare function validateSchema(schemaProvider: SchemaProvider, values: any): SchemaValidation;
+declare function getDefaultValues(schemaProvider: SchemaProvider): Record<string, any>;
+/**
+ * Recursively remove empty values from an object (null, undefined, '', [], {})
+ * Used in AutoForm before calling the resolver to prevent empty values from being validated.
+ * This is necessary because zod's optional() allows undefined, but form fields default to
+ * empty strings, arrays, or objects even when untouched. These defaults bypass the optional
+ * check and cause validation issues in react-hook-form.
+ */
+declare function removeEmptyValues<T extends Record<string, any>>(values: T): Partial<T>;
+declare function replaceEmptyValue<T extends Record<string, any>>(values: T): T;
+/**
+ * Sort the fields by order.
+ * If no order is set, the field will be sorted based on the order in the schema.
+ */
+declare function sortFieldsByOrder(fields: ParsedField[] | undefined): ParsedField[];
+
+export { type ErrorSchemaValidation, type FieldConfig, type ParsedField, type ParsedSchema, type Renderable, type SchemaProvider, type SchemaType, type SchemaValidation, type SchemaValidationError, type SuccessfulSchemaValidation, getDefaultValues, getLabel, parseSchema, removeEmptyValues, replaceEmptyValue, sortFieldsByOrder, validateSchema };

package/dist/index.js

@@ -0,0 +1,137 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  getDefaultValues: () => getDefaultValues,
+  getLabel: () => getLabel,
+  parseSchema: () => parseSchema,
+  removeEmptyValues: () => removeEmptyValues,
+  replaceEmptyValue: () => replaceEmptyValue,
+  sortFieldsByOrder: () => sortFieldsByOrder,
+  validateSchema: () => validateSchema
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/label.ts
+function getLabel(field) {
+  return field.fieldConfig?.label || field.description || beautifyLabel(field.key);
+}
+function beautifyLabel(label) {
+  if (!label) {
+    return "";
+  }
+  let output = label.replace(/([A-Z])/g, " $1");
+  output = output.charAt(0).toUpperCase() + output.slice(1);
+  if (!isNaN(Number(output))) {
+    return "";
+  }
+  if (output === "*") {
+    return "";
+  }
+  return output;
+}
+
+// src/logic.ts
+function parseSchema(schemaProvider) {
+  const schema = schemaProvider.parseSchema();
+  return {
+    ...schema,
+    fields: sortFieldsByOrder(schema.fields)
+  };
+}
+function validateSchema(schemaProvider, values) {
+  return schemaProvider.validateSchema(values);
+}
+function getDefaultValues(schemaProvider) {
+  return schemaProvider.getDefaultValues();
+}
+function removeEmptyValues(values) {
+  const result = {};
+  for (const key in values) {
+    const value = values[key];
+    if ([null, void 0, "", [], {}].includes(value)) {
+      continue;
+    }
+    if (Array.isArray(value)) {
+      const newArray = value.map((item) => {
+        if (typeof item === "object") {
+          return removeEmptyValues(item);
+        }
+        return item;
+      });
+      result[key] = newArray.filter((item) => item !== null);
+    } else if (typeof value === "object") {
+      result[key] = removeEmptyValues(value);
+    } else {
+      result[key] = value;
+    }
+  }
+  return result;
+}
+var isPlainObject = (value) => typeof value === "object" && Object.prototype.toString.call(value) === "[object Object]";
+var isEmpty = (value) => [null, void 0, ""].includes(value);
+function replaceEmptyValue(values) {
+  const result = { ...values };
+  for (const key in values) {
+    const value = values[key];
+    if (isEmpty(value)) {
+      result[key] = void 0;
+      continue;
+    }
+    if (Array.isArray(value)) {
+      const cleaned = Object.values(replaceEmptyValue({ ...value }));
+      result[key] = cleaned;
+    } else if (isPlainObject(value)) {
+      const cleaned = replaceEmptyValue(value);
+      result[key] = cleaned;
+    } else {
+      result[key] = value;
+    }
+  }
+  return result;
+}
+function sortFieldsByOrder(fields) {
+  if (!fields) return [];
+  const sortedFields = fields.map((field) => {
+    if (field.schema) {
+      return {
+        ...field,
+        schema: sortFieldsByOrder(field.schema)
+      };
+    }
+    return field;
+  }).sort((a, b) => {
+    const fieldA = a.fieldConfig?.order ?? 0;
+    const fieldB = b.fieldConfig?.order ?? 0;
+    return fieldA - fieldB;
+  });
+  return sortedFields;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getDefaultValues,
+  getLabel,
+  parseSchema,
+  removeEmptyValues,
+  replaceEmptyValue,
+  sortFieldsByOrder,
+  validateSchema
+});

package/dist/index.mjs

@@ -0,0 +1,104 @@
+// src/label.ts
+function getLabel(field) {
+  return field.fieldConfig?.label || field.description || beautifyLabel(field.key);
+}
+function beautifyLabel(label) {
+  if (!label) {
+    return "";
+  }
+  let output = label.replace(/([A-Z])/g, " $1");
+  output = output.charAt(0).toUpperCase() + output.slice(1);
+  if (!isNaN(Number(output))) {
+    return "";
+  }
+  if (output === "*") {
+    return "";
+  }
+  return output;
+}
+
+// src/logic.ts
+function parseSchema(schemaProvider) {
+  const schema = schemaProvider.parseSchema();
+  return {
+    ...schema,
+    fields: sortFieldsByOrder(schema.fields)
+  };
+}
+function validateSchema(schemaProvider, values) {
+  return schemaProvider.validateSchema(values);
+}
+function getDefaultValues(schemaProvider) {
+  return schemaProvider.getDefaultValues();
+}
+function removeEmptyValues(values) {
+  const result = {};
+  for (const key in values) {
+    const value = values[key];
+    if ([null, void 0, "", [], {}].includes(value)) {
+      continue;
+    }
+    if (Array.isArray(value)) {
+      const newArray = value.map((item) => {
+        if (typeof item === "object") {
+          return removeEmptyValues(item);
+        }
+        return item;
+      });
+      result[key] = newArray.filter((item) => item !== null);
+    } else if (typeof value === "object") {
+      result[key] = removeEmptyValues(value);
+    } else {
+      result[key] = value;
+    }
+  }
+  return result;
+}
+var isPlainObject = (value) => typeof value === "object" && Object.prototype.toString.call(value) === "[object Object]";
+var isEmpty = (value) => [null, void 0, ""].includes(value);
+function replaceEmptyValue(values) {
+  const result = { ...values };
+  for (const key in values) {
+    const value = values[key];
+    if (isEmpty(value)) {
+      result[key] = void 0;
+      continue;
+    }
+    if (Array.isArray(value)) {
+      const cleaned = Object.values(replaceEmptyValue({ ...value }));
+      result[key] = cleaned;
+    } else if (isPlainObject(value)) {
+      const cleaned = replaceEmptyValue(value);
+      result[key] = cleaned;
+    } else {
+      result[key] = value;
+    }
+  }
+  return result;
+}
+function sortFieldsByOrder(fields) {
+  if (!fields) return [];
+  const sortedFields = fields.map((field) => {
+    if (field.schema) {
+      return {
+        ...field,
+        schema: sortFieldsByOrder(field.schema)
+      };
+    }
+    return field;
+  }).sort((a, b) => {
+    const fieldA = a.fieldConfig?.order ?? 0;
+    const fieldB = b.fieldConfig?.order ?? 0;
+    return fieldA - fieldB;
+  });
+  return sortedFields;
+}
+export {
+  getDefaultValues,
+  getLabel,
+  parseSchema,
+  removeEmptyValues,
+  replaceEmptyValue,
+  sortFieldsByOrder,
+  validateSchema
+};

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@acp-autoform/core",
+  "version": "3.0.0",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/adityacodepublic/autoform.git"
+  },
+  "scripts": {
+    "lint": "eslint . --max-warnings 0",
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch"
+  },
+  "devDependencies": {
+    "@acp-autoform/eslint-config": "*",
+    "@acp-autoform/typescript-config": "*",
+    "@turbo/gen": "^1.12.4",
+    "@types/eslint": "^8.56.5",
+    "@types/node": "^20.11.24",
+    "@types/react": "^19.1.8",
+    "@types/react-dom": "^19.1.6",
+    "eslint": "^8.57.0",
+    "tsup": "^8.3.0",
+    "typescript": "^5.3.3"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}