@aatulwork/customform-renderer 1.3.0 → 1.5.0

package/README.md

@@ -52,6 +52,27 @@ const { isReady } = useCKEditor({ autoLoad: true });
 
 See [CKEditor Setup Guide](#ckeditor-setup) for more details.
 
+### Using with Vite
+
+**You do not need any Vite config** to use this package. The package ships correct `module` and `exports` so Vite resolves it without aliases.
+
+- **Dependencies:** The package installs `@emotion/react`, `@emotion/styled`, and `@mui/system`; you only need to install the [peer dependencies](#peer-dependencies) (React, MUI, react-hook-form, etc.).
+
+If you use **SSR** or see module resolution / pre-bundling issues, add the optional plugin (one line):
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite';
+import react from '@vitejs/plugin-react';
+import { customformRendererVite } from '@aatulwork/customform-renderer/vite';
+
+export default defineConfig({
+  plugins: [react(), customformRendererVite()],
+});
+```
+
+The plugin applies `optimizeDeps.include`, `ssr.noExternal`, and excludes the package’s CKEditor script from pre-bundling. You can pass options: `customformRendererVite({ excludeCkeditorFromOptimize: false })` if you load CKEditor only via a script tag.
+
 ## Package Exports
 
 The package exports the following:
@@ -63,6 +84,7 @@ The package exports the following:
 - **Utils:** `getAllFields`, `normalizeInitialValues`, `transformFormValues`, `getDefaultValue`, `formatFileSize`, `validateFile`, `buildFieldRules`, `normalizeOptions`
 - **CKEditor:** `loadCKEditor`, `isCKEditorAvailable`, `waitForCKEditor`, `useCKEditor`
 - **Default services:** `defaultFileUploadService`, `defaultFormReferenceService`, `defaultApiReferenceService`, `defaultDateFormatterService` (throw if used without override; provide your own via `services`)
+- **Vite:** `customformRendererVite` from `@aatulwork/customform-renderer/vite` (optional plugin for SSR / optimizeDeps)
 
 ## Quick Start
 

package/dist/vite-plugin.js

@@ -0,0 +1,50 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+// src/vite-plugin.ts
+var PACKAGE_NAME = "@aatulwork/customform-renderer";
+function customformRendererVite(options = {}) {
+  const { excludeCkeditorFromOptimize = true } = options;
+  return {
+    name: "vite-plugin-customform-renderer",
+    config(config, _env) {
+      const optimizeDeps = config.optimizeDeps ?? {};
+      const include = Array.isArray(optimizeDeps.include) ? [...optimizeDeps.include] : [];
+      if (!include.includes(PACKAGE_NAME)) {
+        include.push(PACKAGE_NAME);
+      }
+      const exclude = Array.isArray(optimizeDeps.exclude) ? [...optimizeDeps.exclude] : [];
+      if (excludeCkeditorFromOptimize) {
+        const ckEditorPath = `${PACKAGE_NAME}/lib/ckeditor/ckeditor.js`;
+        if (!exclude.includes(ckEditorPath)) {
+          exclude.push(ckEditorPath);
+        }
+      }
+      const ssr = config.ssr ?? {};
+      const noExternal = ssr.noExternal;
+      const noExternalList = Array.isArray(noExternal) ? [...noExternal] : noExternal === true ? true : [PACKAGE_NAME];
+      if (Array.isArray(noExternalList) && !noExternalList.includes(PACKAGE_NAME)) {
+        noExternalList.push(PACKAGE_NAME);
+      }
+      return {
+        ...config,
+        optimizeDeps: {
+          ...optimizeDeps,
+          include,
+          ...exclude.length > 0 ? { exclude } : {}
+        },
+        ssr: {
+          ...ssr,
+          noExternal: noExternalList
+        }
+      };
+    }
+  };
+}
+var vite_plugin_default = customformRendererVite;
+
+exports.customformRendererVite = customformRendererVite;
+exports.default = vite_plugin_default;
+//# sourceMappingURL=vite-plugin.js.map
+//# sourceMappingURL=vite-plugin.js.map

package/dist/vite-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/vite-plugin.ts"],"names":[],"mappings":";;;;;AAOA,IAAM,YAAA,GAAe,gCAAA;AAmBd,SAAS,sBAAA,CAAuB,OAAA,GAA+C,EAAC,EAAW;AAChG,EAAA,MAAM,EAAE,2BAAA,GAA8B,IAAA,EAAK,GAAI,OAAA;AAE/C,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,iCAAA;AAAA,IACN,MAAA,CAAO,QAAoB,IAAA,EAAiB;AAC1C,MAAA,MAAM,YAAA,GAAe,MAAA,CAAO,YAAA,IAAgB,EAAC;AAC7C,MAAA,MAAM,OAAA,GAAU,KAAA,CAAM,OAAA,CAAQ,YAAA,CAAa,OAAO,CAAA,GAAI,CAAC,GAAG,YAAA,CAAa,OAAO,CAAA,GAAI,EAAC;AACnF,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAA,CAAS,YAAY,CAAA,EAAG;AACnC,QAAA,OAAA,CAAQ,KAAK,YAAY,CAAA;AAAA,MAC3B;AACA,MAAA,MAAM,OAAA,GAAU,KAAA,CAAM,OAAA,CAAQ,YAAA,CAAa,OAAO,CAAA,GAAI,CAAC,GAAG,YAAA,CAAa,OAAO,CAAA,GAAI,EAAC;AACnF,MAAA,IAAI,2BAAA,EAA6B;AAC/B,QAAA,MAAM,YAAA,GAAe,GAAG,YAAY,CAAA,yBAAA,CAAA;AACpC,QAAA,IAAI,CAAC,OAAA,CAAQ,QAAA,CAAS,YAAY,CAAA,EAAG;AACnC,UAAA,OAAA,CAAQ,KAAK,YAAY,CAAA;AAAA,QAC3B;AAAA,MACF;AACA,MAAA,MAAM,GAAA,GAAM,MAAA,CAAO,GAAA,IAAO,EAAC;AAC3B,MAAA,MAAM,aAAa,GAAA,CAAI,UAAA;AACvB,MAAA,MAAM,cAAA,GAAiB,KAAA,CAAM,OAAA,CAAQ,UAAU,CAAA,GAC3C,CAAC,GAAG,UAAU,CAAA,GACd,UAAA,KAAe,IAAA,GACb,IAAA,GACA,CAAC,YAAY,CAAA;AACnB,MAAA,IAAI,KAAA,CAAM,QAAQ,cAAc,CAAA,IAAK,CAAC,cAAA,CAAe,QAAA,CAAS,YAAY,CAAA,EAAG;AAC3E,QAAA,cAAA,CAAe,KAAK,YAAY,CAAA;AAAA,MAClC;AAEA,MAAA,OAAO;AAAA,QACL,GAAG,MAAA;AAAA,QACH,YAAA,EAAc;AAAA,UACZ,GAAG,YAAA;AAAA,UACH,OAAA;AAAA,UACA,GAAI,OAAA,CAAQ,MAAA,GAAS,IAAI,EAAE,OAAA,KAAY;AAAC,SAC1C;AAAA,QACA,GAAA,EAAK;AAAA,UACH,GAAG,GAAA;AAAA,UACH,UAAA,EAAY;AAAA;AACd,OACF;AAAA,IACF;AAAA,GACF;AACF;AAEA,IAAO,mBAAA,GAAQ","file":"vite-plugin.js","sourcesContent":["/**\r\n * Optional Vite plugin for @aatulwork/customform-renderer.\r\n * Use only if you need SSR or dependency optimization workarounds (e.g. \"module not found\" in SSR).\r\n * With the package's fixed exports, most Vite projects work with zero config.\r\n */\r\nimport type { Plugin, UserConfig, ConfigEnv } from 'vite';\r\n\r\nconst PACKAGE_NAME = '@aatulwork/customform-renderer';\r\n\r\nexport interface CustomFormRendererVitePluginOptions {\r\n  /** Exclude CKEditor script from pre-bundling (default: true). Set false if you load CKEditor via HTML only. */\r\n  excludeCkeditorFromOptimize?: boolean;\r\n}\r\n\r\n/**\r\n * Vite plugin that applies recommended settings for @aatulwork/customform-renderer:\r\n * - optimizeDeps.include: pre-bundle the package for faster dev startup\r\n * - ssr.noExternal: bundle the package in SSR instead of externalizing it\r\n * - optimizeDeps.exclude: optionally exclude the package's CKEditor build from pre-bundling\r\n *\r\n * Usage in vite.config.ts:\r\n *   import { customformRendererVite } from '@aatulwork/customform-renderer/vite';\r\n *   export default defineConfig({\r\n *     plugins: [react(), customformRendererVite()],\r\n *   });\r\n */\r\nexport function customformRendererVite(options: CustomFormRendererVitePluginOptions = {}): Plugin {\r\n  const { excludeCkeditorFromOptimize = true } = options;\r\n\r\n  return {\r\n    name: 'vite-plugin-customform-renderer',\r\n    config(config: UserConfig, _env: ConfigEnv) {\r\n      const optimizeDeps = config.optimizeDeps ?? {};\r\n      const include = Array.isArray(optimizeDeps.include) ? [...optimizeDeps.include] : [];\r\n      if (!include.includes(PACKAGE_NAME)) {\r\n        include.push(PACKAGE_NAME);\r\n      }\r\n      const exclude = Array.isArray(optimizeDeps.exclude) ? [...optimizeDeps.exclude] : [];\r\n      if (excludeCkeditorFromOptimize) {\r\n        const ckEditorPath = `${PACKAGE_NAME}/lib/ckeditor/ckeditor.js`;\r\n        if (!exclude.includes(ckEditorPath)) {\r\n          exclude.push(ckEditorPath);\r\n        }\r\n      }\r\n      const ssr = config.ssr ?? {};\r\n      const noExternal = ssr.noExternal;\r\n      const noExternalList = Array.isArray(noExternal)\r\n        ? [...noExternal]\r\n        : noExternal === true\r\n          ? true\r\n          : [PACKAGE_NAME];\r\n      if (Array.isArray(noExternalList) && !noExternalList.includes(PACKAGE_NAME)) {\r\n        noExternalList.push(PACKAGE_NAME);\r\n      }\r\n\r\n      return {\r\n        ...config,\r\n        optimizeDeps: {\r\n          ...optimizeDeps,\r\n          include,\r\n          ...(exclude.length > 0 ? { exclude } : {}),\r\n        },\r\n        ssr: {\r\n          ...ssr,\r\n          noExternal: noExternalList,\r\n        },\r\n      };\r\n    },\r\n  };\r\n}\r\n\r\nexport default customformRendererVite;\r\n"]}

package/dist/vite-plugin.mjs

@@ -0,0 +1,45 @@
+// src/vite-plugin.ts
+var PACKAGE_NAME = "@aatulwork/customform-renderer";
+function customformRendererVite(options = {}) {
+  const { excludeCkeditorFromOptimize = true } = options;
+  return {
+    name: "vite-plugin-customform-renderer",
+    config(config, _env) {
+      const optimizeDeps = config.optimizeDeps ?? {};
+      const include = Array.isArray(optimizeDeps.include) ? [...optimizeDeps.include] : [];
+      if (!include.includes(PACKAGE_NAME)) {
+        include.push(PACKAGE_NAME);
+      }
+      const exclude = Array.isArray(optimizeDeps.exclude) ? [...optimizeDeps.exclude] : [];
+      if (excludeCkeditorFromOptimize) {
+        const ckEditorPath = `${PACKAGE_NAME}/lib/ckeditor/ckeditor.js`;
+        if (!exclude.includes(ckEditorPath)) {
+          exclude.push(ckEditorPath);
+        }
+      }
+      const ssr = config.ssr ?? {};
+      const noExternal = ssr.noExternal;
+      const noExternalList = Array.isArray(noExternal) ? [...noExternal] : noExternal === true ? true : [PACKAGE_NAME];
+      if (Array.isArray(noExternalList) && !noExternalList.includes(PACKAGE_NAME)) {
+        noExternalList.push(PACKAGE_NAME);
+      }
+      return {
+        ...config,
+        optimizeDeps: {
+          ...optimizeDeps,
+          include,
+          ...exclude.length > 0 ? { exclude } : {}
+        },
+        ssr: {
+          ...ssr,
+          noExternal: noExternalList
+        }
+      };
+    }
+  };
+}
+var vite_plugin_default = customformRendererVite;
+
+export { customformRendererVite, vite_plugin_default as default };
+//# sourceMappingURL=vite-plugin.mjs.map
+//# sourceMappingURL=vite-plugin.mjs.map

package/dist/vite-plugin.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/vite-plugin.ts"],"names":[],"mappings":";AAOA,IAAM,YAAA,GAAe,gCAAA;AAmBd,SAAS,sBAAA,CAAuB,OAAA,GAA+C,EAAC,EAAW;AAChG,EAAA,MAAM,EAAE,2BAAA,GAA8B,IAAA,EAAK,GAAI,OAAA;AAE/C,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,iCAAA;AAAA,IACN,MAAA,CAAO,QAAoB,IAAA,EAAiB;AAC1C,MAAA,MAAM,YAAA,GAAe,MAAA,CAAO,YAAA,IAAgB,EAAC;AAC7C,MAAA,MAAM,OAAA,GAAU,KAAA,CAAM,OAAA,CAAQ,YAAA,CAAa,OAAO,CAAA,GAAI,CAAC,GAAG,YAAA,CAAa,OAAO,CAAA,GAAI,EAAC;AACnF,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAA,CAAS,YAAY,CAAA,EAAG;AACnC,QAAA,OAAA,CAAQ,KAAK,YAAY,CAAA;AAAA,MAC3B;AACA,MAAA,MAAM,OAAA,GAAU,KAAA,CAAM,OAAA,CAAQ,YAAA,CAAa,OAAO,CAAA,GAAI,CAAC,GAAG,YAAA,CAAa,OAAO,CAAA,GAAI,EAAC;AACnF,MAAA,IAAI,2BAAA,EAA6B;AAC/B,QAAA,MAAM,YAAA,GAAe,GAAG,YAAY,CAAA,yBAAA,CAAA;AACpC,QAAA,IAAI,CAAC,OAAA,CAAQ,QAAA,CAAS,YAAY,CAAA,EAAG;AACnC,UAAA,OAAA,CAAQ,KAAK,YAAY,CAAA;AAAA,QAC3B;AAAA,MACF;AACA,MAAA,MAAM,GAAA,GAAM,MAAA,CAAO,GAAA,IAAO,EAAC;AAC3B,MAAA,MAAM,aAAa,GAAA,CAAI,UAAA;AACvB,MAAA,MAAM,cAAA,GAAiB,KAAA,CAAM,OAAA,CAAQ,UAAU,CAAA,GAC3C,CAAC,GAAG,UAAU,CAAA,GACd,UAAA,KAAe,IAAA,GACb,IAAA,GACA,CAAC,YAAY,CAAA;AACnB,MAAA,IAAI,KAAA,CAAM,QAAQ,cAAc,CAAA,IAAK,CAAC,cAAA,CAAe,QAAA,CAAS,YAAY,CAAA,EAAG;AAC3E,QAAA,cAAA,CAAe,KAAK,YAAY,CAAA;AAAA,MAClC;AAEA,MAAA,OAAO;AAAA,QACL,GAAG,MAAA;AAAA,QACH,YAAA,EAAc;AAAA,UACZ,GAAG,YAAA;AAAA,UACH,OAAA;AAAA,UACA,GAAI,OAAA,CAAQ,MAAA,GAAS,IAAI,EAAE,OAAA,KAAY;AAAC,SAC1C;AAAA,QACA,GAAA,EAAK;AAAA,UACH,GAAG,GAAA;AAAA,UACH,UAAA,EAAY;AAAA;AACd,OACF;AAAA,IACF;AAAA,GACF;AACF;AAEA,IAAO,mBAAA,GAAQ","file":"vite-plugin.mjs","sourcesContent":["/**\r\n * Optional Vite plugin for @aatulwork/customform-renderer.\r\n * Use only if you need SSR or dependency optimization workarounds (e.g. \"module not found\" in SSR).\r\n * With the package's fixed exports, most Vite projects work with zero config.\r\n */\r\nimport type { Plugin, UserConfig, ConfigEnv } from 'vite';\r\n\r\nconst PACKAGE_NAME = '@aatulwork/customform-renderer';\r\n\r\nexport interface CustomFormRendererVitePluginOptions {\r\n  /** Exclude CKEditor script from pre-bundling (default: true). Set false if you load CKEditor via HTML only. */\r\n  excludeCkeditorFromOptimize?: boolean;\r\n}\r\n\r\n/**\r\n * Vite plugin that applies recommended settings for @aatulwork/customform-renderer:\r\n * - optimizeDeps.include: pre-bundle the package for faster dev startup\r\n * - ssr.noExternal: bundle the package in SSR instead of externalizing it\r\n * - optimizeDeps.exclude: optionally exclude the package's CKEditor build from pre-bundling\r\n *\r\n * Usage in vite.config.ts:\r\n *   import { customformRendererVite } from '@aatulwork/customform-renderer/vite';\r\n *   export default defineConfig({\r\n *     plugins: [react(), customformRendererVite()],\r\n *   });\r\n */\r\nexport function customformRendererVite(options: CustomFormRendererVitePluginOptions = {}): Plugin {\r\n  const { excludeCkeditorFromOptimize = true } = options;\r\n\r\n  return {\r\n    name: 'vite-plugin-customform-renderer',\r\n    config(config: UserConfig, _env: ConfigEnv) {\r\n      const optimizeDeps = config.optimizeDeps ?? {};\r\n      const include = Array.isArray(optimizeDeps.include) ? [...optimizeDeps.include] : [];\r\n      if (!include.includes(PACKAGE_NAME)) {\r\n        include.push(PACKAGE_NAME);\r\n      }\r\n      const exclude = Array.isArray(optimizeDeps.exclude) ? [...optimizeDeps.exclude] : [];\r\n      if (excludeCkeditorFromOptimize) {\r\n        const ckEditorPath = `${PACKAGE_NAME}/lib/ckeditor/ckeditor.js`;\r\n        if (!exclude.includes(ckEditorPath)) {\r\n          exclude.push(ckEditorPath);\r\n        }\r\n      }\r\n      const ssr = config.ssr ?? {};\r\n      const noExternal = ssr.noExternal;\r\n      const noExternalList = Array.isArray(noExternal)\r\n        ? [...noExternal]\r\n        : noExternal === true\r\n          ? true\r\n          : [PACKAGE_NAME];\r\n      if (Array.isArray(noExternalList) && !noExternalList.includes(PACKAGE_NAME)) {\r\n        noExternalList.push(PACKAGE_NAME);\r\n      }\r\n\r\n      return {\r\n        ...config,\r\n        optimizeDeps: {\r\n          ...optimizeDeps,\r\n          include,\r\n          ...(exclude.length > 0 ? { exclude } : {}),\r\n        },\r\n        ssr: {\r\n          ...ssr,\r\n          noExternal: noExternalList,\r\n        },\r\n      };\r\n    },\r\n  };\r\n}\r\n\r\nexport default customformRendererVite;\r\n"]}

package/package.json

@@ -1,10 +1,23 @@
 {
   "name": "@aatulwork/customform-renderer",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "A powerful, reusable form renderer component for React with Material-UI support",
   "main": "dist/index.js",
-  "module": "dist/index.esm.js",
+  "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./lib/ckeditor/ckeditor.js": "./lib/ckeditor/ckeditor.js",
+    "./vite": {
+      "types": "./dist/vite-plugin.d.ts",
+      "import": "./dist/vite-plugin.mjs",
+      "require": "./dist/vite-plugin.js"
+    }
+  },
   "files": [
     "dist",
     "lib",
@@ -38,10 +51,21 @@
     "material-ui",
     "react-hook-form",
     "dynamic-forms",
-    "form-builder"
+    "form-builder",
+    "json-schema",
+    "dynamic-form",
+    "mui"
   ],
   "author": "aatulwork",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aatulwork/custom-form-renderer"
+  },
+  "homepage": "https://github.com/aatulwork/custom-form-renderer#readme",
+  "bugs": {
+    "url": "https://github.com/aatulwork/custom-form-renderer/issues"
+  },
   "peerDependencies": {
     "react": "^18.0.0",
     "react-dom": "^18.0.0",
@@ -53,14 +77,19 @@
     "dayjs": "^1.11.0",
     "@ckeditor/ckeditor5-react": "^11.0.0"
   },
+  "optionalPeerDependencies": {
+    "vite": ">=4.0.0"
+  },
   "dependencies": {
     "@emotion/react": "^11.14.0",
-    "@emotion/styled": "^11.14.1"
+    "@emotion/styled": "^11.14.1",
+    "@mui/system": "^6.0.0"
   },
   "devDependencies": {
     "@types/react": "^18.2.0",
     "@types/react-dom": "^18.2.0",
     "typescript": "^5.2.0",
-    "tsup": "^8.0.0"
+    "tsup": "^8.0.0",
+    "vite": "^5.0.0"
   }
 }