@glitchproof/form-field-generator 1.0.0

package/dist/type.d.ts

@@ -0,0 +1,61 @@
+export type Context = {
+    path: string;
+};
+type FieldsGroup<Field extends Object.DICT_NESTED_VALUES, 
+/**
+ * The path of the deeply nested fields.
+ * Example: first layer name => name,
+ * second layer {city: { name: "nameOfCity" }} => city.nameOfCity ,
+ * third layer is a array version {country: { name: "nameOfCountry", cities: [{ name: "nameOfCity" }] }} => country.nameOfCountry.cities.${number}.nameOfCity as a function with deeply listed counted arguments
+ */
+Path extends string, 
+/**
+ * The name of the key of the field.
+ * Example: 'name' => 'NAME'
+ * Example: '{city: { name: "nameOfCity" }} => 'city'
+ * Example: '{cities: [{ name: "nameOfCity" }] }} => 'cities'
+ * Example: '{cities: [{ name: "nameOfCity", someProperty: { name: "nameOfProperty" } }] }} => nameOfProperty
+ */
+FieldName extends string> = {
+    /**
+     * The key of the object field to use it's parent object name.
+     * Example: '{city: { KEY: "city", name: "nameOfCity" }}
+     */
+    readonly KEY: FieldName;
+    /**
+     * The path of the deeply nested fields.
+     * If Path is listed it generate function for naming
+     * Example { country: { place: { name: "nameOfPlace" } } } => { $COUNTRY: { PATH: () => `country`, NAME: 'nameOfCountry', $PLACE: { PATH: 'country.place', NAME: 'nameOfPlace' } } }
+     * Example {country: { name: "nameOfCountry", city: { name: "nameOfCity" } }} to { $COUNTRY: { PATH: () => `country.${number}`, NAME: 'nameOfCountry', $CITIES: { PATH: () => `path.to.country.cities`, NAME: 'nameOfCity', $CITY: { PATH: () => `path.to.country.cities.${number}`, NAME: 'nameOfCity' } } } }
+     */
+    readonly PATH: Utils.PathGenerator<Path>;
+} & {
+    [KEY in keyof Field as Field[KEY] extends string ? Utils.TO_NAME<KEY> : never]: Field[KEY];
+} & {
+    [KEY in keyof Utils.SubArrayElement<Field> as Utils.ObjectFieldNameGenerator<KEY & string, 
+    /**
+     * The type of the sub array element for get inside object
+     */
+    Utils.SubArrayElement<Field>> /**
+     * If the sub array element is an object, generate the fields for the object.
+     * Otherwise generate the fields path for the array.
+     */]: Utils.SubArrayElement<Field>[KEY] extends Object.DICT_NESTED_VALUES ? FieldsGroup<Utils.SubArrayElement<Field>[KEY], `${Path}.${number}.${KEY & string}`, KEY & string> : Utils.ListFieldAccessor<`${Path}.${number}.${KEY & string}`>;
+} & {
+    [KEY in keyof Field as Field[KEY] extends Object.DICT_NESTED_VALUES ? Utils.ExceptNumber<KEY, Utils.TO_OBJECT_FIELD_NAME<KEY>> : never /**
+   * If the key is an object, generate the fields for the object.
+   */]: Field[KEY] extends Object.DICT_OBJECT_VALUE ? FieldsGroup<Field[KEY], `${Path}.${KEY & string}`, KEY & string> : Field[KEY] extends Object.DICT_ARRAY_VALUE ? FieldsGroup<Field[KEY], `${Path}.${KEY & string}`, KEY & string> : never;
+} & {
+    [KEY in keyof Field as Field[KEY] extends string ? Utils.TO_FIELD_NAME<KEY> : never /**
+   * If the path is listed before, generate the fields for the array.
+   * else generate the fields path for the object.
+   */]: Utils.IsListedBefore<Path> extends true ? Utils.ListFieldAccessor<`${Path}.${Field[KEY] & string}`> : `${Path}.${Field[KEY] & string}`;
+};
+export type GenerateFields<Fields extends Object.DICT> = {
+    [KEY in keyof Fields as Fields[KEY] extends string ? Utils.TO_FIELD_NAME<KEY> : never]: Fields[KEY];
+} & {
+    [KEY in keyof Fields as Fields[KEY] extends string ? Utils.TO_NAME<KEY> : never]: Fields[KEY];
+} & {
+    [KEY in keyof Fields as Fields[KEY] extends Object.DICT_NESTED_VALUES ? Utils.TO_OBJECT_FIELD_NAME<KEY> : never]: Fields[KEY] extends Object.DICT_NESTED_VALUES ? FieldsGroup<Fields[KEY], KEY & string, KEY & string> : never;
+};
+export {};
+//# sourceMappingURL=type.d.ts.map

package/dist/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../src/type.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,KAAK,WAAW,CACd,KAAK,SAAS,MAAM,CAAC,kBAAkB;AACvC;;;;;GAKG;AACH,IAAI,SAAS,MAAM;AACnB;;;;;;GAMG;AACH,SAAS,SAAS,MAAM,IACtB;IACF;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC;IACxB;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;CAC1C,GAAG;KAMD,GAAG,IAAI,MAAM,KAAK,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,MAAM,GAC5C,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAClB,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC;CACvB,GAAG;KAMD,GAAG,IAAI,MAAM,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,wBAAwB,CAC1E,GAAG,GAAG,MAAM;IACZ;;OAEG;IACH,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,CAC7B,CAAC;;;OAGC,GAAG,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,kBAAkB,GACrE,WAAW,CACT,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,EACjC,GAAG,IAAI,IAAI,MAAM,IAAI,GAAG,GAAG,MAAM,EAAE,EACnC,GAAG,GAAG,MAAM,CACb,GACD,KAAK,CAAC,iBAAiB,CAAC,GAAG,IAAI,IAAI,MAAM,IAAI,GAAG,GAAG,MAAM,EAAE,CAAC;CACjE,GAAG;KAKD,GAAG,IAAI,MAAM,KAAK,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,kBAAkB,GAI/D,KAAK,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,GACxD,KAAK,CAAC;;KAEP,GAAG,KAAK,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,iBAAiB,GAI7C,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,IAAI,GAAG,GAAG,MAAM,EAAE,EAAE,GAAG,GAAG,MAAM,CAAC,GAIhE,KAAK,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,gBAAgB,GACxC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,IAAI,GAAG,GAAG,MAAM,EAAE,EAAE,GAAG,GAAG,MAAM,CAAC,GAChE,KAAK;CACZ,GAAG;KAOD,GAAG,IAAI,MAAM,KAAK,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,MAAM,GAC5C,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,GACxB,KAAK,CAAC;;;KAGP,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,IAAI,GACzC,KAAK,CAAC,iBAAiB,CAAC,GAAG,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,EAAE,CAAC,GACzD,GAAG,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,EAAE;CACrC,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,MAAM,SAAS,MAAM,CAAC,IAAI,IAAI;KAItD,GAAG,IAAI,MAAM,MAAM,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,GAC9C,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,GACxB,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC;CACxB,GAAG;KAID,GAAG,IAAI,MAAM,MAAM,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,GAC9C,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAClB,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC;CACxB,GAAG;KAID,GAAG,IAAI,MAAM,MAAM,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,kBAAkB,GACjE,KAAK,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAC/B,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,kBAAkB,GACrD,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,MAAM,EAAE,GAAG,GAAG,MAAM,CAAC,GACpD,KAAK;CACV,CAAC"}

package/dist/type.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type.js.map

package/dist/type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.js","sourceRoot":"","sources":["../src/type.ts"],"names":[],"mappings":""}

package/dist/utils/create-index-formatter.d.ts

@@ -0,0 +1,2 @@
+export declare const createIndexFormatter: (template: string) => ((...args: number[]) => string);
+//# sourceMappingURL=create-index-formatter.d.ts.map

package/dist/utils/create-index-formatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-index-formatter.d.ts","sourceRoot":"","sources":["../../src/utils/create-index-formatter.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,oBAAoB,GAC/B,UAAU,MAAM,KACf,CAAC,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,KAAK,MAAM,CAkBhC,CAAC"}

package/dist/utils/create-index-formatter.js

@@ -0,0 +1,15 @@
+export const createIndexFormatter = (template) => {
+    const requiredCount = (template.match(/#/g) || []).length;
+    return (...args) => {
+        if (args.length !== requiredCount) {
+            throw new Error(`Formatter Mismatch: Template requires ${requiredCount} arguments, but received ${args.length}.`);
+        }
+        let argIndex = 0;
+        return template.replace(/#/g, () => {
+            const replacement = String(args[argIndex]);
+            argIndex++;
+            return replacement;
+        });
+    };
+};
+//# sourceMappingURL=create-index-formatter.js.map

package/dist/utils/create-index-formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-index-formatter.js","sourceRoot":"","sources":["../../src/utils/create-index-formatter.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,QAAgB,EACiB,EAAE;IACnC,MAAM,aAAa,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;IAE1D,OAAO,CAAC,GAAG,IAAc,EAAU,EAAE;QACnC,IAAI,IAAI,CAAC,MAAM,KAAK,aAAa,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CACb,yCAAyC,aAAa,4BAA4B,IAAI,CAAC,MAAM,GAAG,CACjG,CAAC;QACJ,CAAC;QAED,IAAI,QAAQ,GAAG,CAAC,CAAC;QAEjB,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE;YACjC,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC3C,QAAQ,EAAE,CAAC;YACX,OAAO,WAAW,CAAC;QACrB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC,CAAC"}

package/dist/utils/is-list.d.ts

@@ -0,0 +1,2 @@
+export declare const isListed: (path: string) => boolean;
+//# sourceMappingURL=is-list.d.ts.map

package/dist/utils/is-list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-list.d.ts","sourceRoot":"","sources":["../../src/utils/is-list.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ,GAAI,MAAM,MAAM,YAAyB,CAAC"}

package/dist/utils/is-list.js

@@ -0,0 +1,2 @@
+export const isListed = (path) => path.includes('.#.');
+//# sourceMappingURL=is-list.js.map

package/dist/utils/is-list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-list.js","sourceRoot":"","sources":["../../src/utils/is-list.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC"}

package/dist/utils/to-snake-case.d.ts

@@ -0,0 +1,2 @@
+export declare const toSnakeCase: (str: string) => string;
+//# sourceMappingURL=to-snake-case.d.ts.map

package/dist/utils/to-snake-case.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"to-snake-case.d.ts","sourceRoot":"","sources":["../../src/utils/to-snake-case.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,GAAI,KAAK,MAAM,WAStC,CAAC"}

package/dist/utils/to-snake-case.js

@@ -0,0 +1,10 @@
+export const toSnakeCase = (str) => {
+    if (!str || typeof str !== 'string') {
+        return '';
+    }
+    return str
+        .replace(/([a-z])([A-Z])/g, '$1_$2')
+        .replace(/([A-Z])([A-Z][a-z])/g, '$1_$2')
+        .toLowerCase();
+};
+//# sourceMappingURL=to-snake-case.js.map

package/dist/utils/to-snake-case.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"to-snake-case.js","sourceRoot":"","sources":["../../src/utils/to-snake-case.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,GAAW,EAAE,EAAE;IACzC,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QACpC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,GAAG;SACP,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC;SACnC,OAAO,CAAC,sBAAsB,EAAE,OAAO,CAAC;SACxC,WAAW,EAAE,CAAC;AACnB,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@glitchproof/form-field-generator",
+  "version": "1.0.0",
+  "description": "> Type-safe field path generation for nested objects and arrays",
+  "scripts": {
+    "build": "tsc",
+    "ci": "bun run build && bun format:check && bun test",
+    "format": "prettier --write .",
+    "format:src": "prettier --write src/**/*.ts",
+    "format:check": "prettier --write --check .",
+    "format:check:src": "prettier --check src/**/*.ts",
+    "test": "vitest run",
+    "local:release": "changeset version && changeset publish",
+    "prepublishOnly": "bun ci",
+    "changeset": "changeset",
+    "version-packages": "changeset version",
+    "release": "changeset publish"
+  },
+  "keywords": [
+    "react hook form",
+    "field-name-generator",
+    "fields generator"
+  ],
+  "author": "GlitchTruth",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/RashadNazarzade/generate-fields.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "dist/index.js",
+  "license": "MIT",
+  "devDependencies": {
+    "@changesets/cli": "^2.29.7",
+    "prettier": "^3.6.2",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.10"
+  },
+  "types": "./dist/index.d.ts",
+  "bugs": {
+    "url": "https://github.com/RashadNazarzade/generate-fields/issues"
+  },
+  "homepage": "https://github.com/RashadNazarzade/generate-fields#readme"
+}