drizzle-seed 0.3.2-f8a2f3c → 0.4.0-08e4e66

package/{services → generators}/GeneratorFuncs.d.cts

@@ -1,5 +1,5 @@
 import type { AbstractGenerator } from './Generators.js';
-import { GenerateArray, GenerateBoolean, GenerateCity, GenerateCompanyName, GenerateCountry, GenerateDate, GenerateDatetime, GenerateDefault, GenerateEmail, GenerateEnum, GenerateFirstName, GenerateFullName, GenerateInt, GenerateInterval, GenerateIntPrimaryKey, GenerateJobTitle, GenerateJson, GenerateLastName, GenerateLine, GenerateLoremIpsum, GenerateNumber, GeneratePhoneNumber, GeneratePoint, GeneratePostcode, GenerateSelfRelationsValuesFromArray, GenerateState, GenerateStreetAddress, GenerateString, GenerateTime, GenerateTimestamp, GenerateUniqueCity, GenerateUniqueCompanyName, GenerateUniqueCountry, GenerateUniqueFirstName, GenerateUniqueFullName, GenerateUniqueInt, GenerateUniqueInterval, GenerateUniqueLastName, GenerateUniqueLine, GenerateUniqueNumber, GenerateUniquePoint, GenerateUniquePostcode, GenerateUniqueStreetAddress, GenerateUniqueString, GenerateUUID, GenerateValuesFromArray, GenerateWeightedCount, GenerateYear, HollowGenerator, WeightedRandomGenerator } from './Generators.js';
+import { GenerateArray, GenerateBitString, GenerateBoolean, GenerateCity, GenerateCompanyName, GenerateCompositeUniqueKey, GenerateCountry, GenerateDate, GenerateDatetime, GenerateDefault, GenerateEmail, GenerateEnum, GenerateFirstName, GenerateFullName, GenerateGeometry, GenerateInet, GenerateInt, GenerateInterval, GenerateIntPrimaryKey, GenerateJobTitle, GenerateJson, GenerateLastName, GenerateLine, GenerateLoremIpsum, GenerateNumber, GeneratePhoneNumber, GeneratePoint, GeneratePostcode, GenerateSelfRelationsValuesFromArray, GenerateState, GenerateStreetAddress, GenerateString, GenerateTime, GenerateTimestamp, GenerateUniqueBitString, GenerateUniqueCity, GenerateUniqueCompanyName, GenerateUniqueCountry, GenerateUniqueFirstName, GenerateUniqueFullName, GenerateUniqueGeometry, GenerateUniqueInet, GenerateUniqueInt, GenerateUniqueInterval, GenerateUniqueLastName, GenerateUniqueLine, GenerateUniqueNumber, GenerateUniquePoint, GenerateUniquePostcode, GenerateUniqueStreetAddress, GenerateUniqueString, GenerateUniqueVector, GenerateUUID, GenerateValuesFromArray, GenerateVector, GenerateWeightedCount, GenerateYear, HollowGenerator, WeightedRandomGenerator } from './Generators.js';
 import { GenerateStringV2, GenerateUniqueIntervalV2, GenerateUniqueStringV2 } from './versioning/v2.js';
 export declare const generatorsFuncs: {
     /**
@@ -62,14 +62,7 @@ export declare const generatorsFuncs: {
      *
      * ```
      */
-    valuesFromArray: (args_0: {
-        values: (number | string | boolean | undefined)[] | {
-            weight: number;
-            values: (number | string | boolean | undefined)[];
-        }[];
-        isUnique?: boolean;
-        arraySize?: number;
-    }) => GenerateValuesFromArray;
+    valuesFromArray: (args_0: import("./Generators.js").GenerateValuesFromArrayT) => GenerateValuesFromArray;
     /**
      * generates sequential integers starting with 1.
      * @example
@@ -183,8 +176,6 @@ export declare const generatorsFuncs: {
     }]) => GenerateDate;
     /**
      * generates time in 24 hours style.
-     * @param minTime - lower border of range.
-     * @param maxTime - upper border of range.
      * @param arraySize - number of elements in each one-dimensional array. (If specified, arrays will be generated.)
      *
      * @example
@@ -192,7 +183,7 @@ export declare const generatorsFuncs: {
      *  await seed(db, schema, { count: 1000 }).refine((funcs) => ({
      *    users: {
      *      columns: {
-     *        birthTime: funcs.time({ minTime: "11:12:13.141", maxTime: "15:16:17.181" })
+     *        birthTime: funcs.time()
      *      },
      *    },
      *  }));
@@ -200,14 +191,10 @@ export declare const generatorsFuncs: {
      * ```
      */
     time: (...args: [] | [{
-        minTime?: string | Date;
-        maxTime?: string | Date;
         arraySize?: number;
     }]) => GenerateTime;
     /**
      * generates timestamps.
-     * @param minTimestamp - lower border of range.
-     * @param maxTimestamp - upper border of range.
      * @param arraySize - number of elements in each one-dimensional array. (If specified, arrays will be generated.)
      *
      * @example
@@ -215,7 +202,7 @@ export declare const generatorsFuncs: {
      *  await seed(db, schema, { count: 1000 }).refine((funcs) => ({
      *    orders: {
      *      columns: {
-     *        shippedDate: funcs.timestamp({ minTimestamp: "2025-03-07T11:12:13.141", maxTimestamp: "2025-03-08T15:16:17.181" })
+     *        shippedDate: funcs.timestamp()
      *      },
      *    },
      *  }));
@@ -223,14 +210,10 @@ export declare const generatorsFuncs: {
      * ```
      */
     timestamp: (...args: [] | [{
-        minTimestamp?: string | Date;
-        maxTimestamp?: string | Date;
         arraySize?: number;
     }]) => GenerateTimestamp;
     /**
      * generates datetime objects.
-     * @param minDatetime - lower border of range.
-     * @param maxDatetime - upper border of range.
      * @param arraySize - number of elements in each one-dimensional array. (If specified, arrays will be generated.)
      *
      * @example
@@ -238,7 +221,7 @@ export declare const generatorsFuncs: {
      *  await seed(db, schema, { count: 1000 }).refine((funcs) => ({
      *    orders: {
      *      columns: {
-     *        shippedDate: funcs.datetime({ minDatetime: "2025-03-07T11:12:13.141", maxDatetime: "2025-03-08T15:16:17.181" })
+     *        shippedDate: funcs.datetime()
      *      },
      *    },
      *  }));
@@ -246,8 +229,6 @@ export declare const generatorsFuncs: {
      * ```
      */
     datetime: (...args: [] | [{
-        minDatetime?: string | Date;
-        maxDatetime?: string | Date;
         arraySize?: number;
     }]) => GenerateDatetime;
     /**
@@ -491,12 +472,7 @@ export declare const generatorsFuncs: {
      *
      * ```
      */
-    phoneNumber: (...args: [] | [{
-        template?: string;
-        prefixes?: string[];
-        generatedDigitsNumbers?: number | number[];
-        arraySize?: number;
-    }]) => GeneratePhoneNumber;
+    phoneNumber: (...args: [] | [import("./Generators.js").GeneratePhoneNumberT]) => GeneratePhoneNumber;
     /**
      * generates country's names.
      * @param isUnique - property that controls if generated values gonna be unique or not.
@@ -759,6 +735,152 @@ export declare const generatorsFuncs: {
         weight: number;
         value: AbstractGenerator<any>;
     }[]) => WeightedRandomGenerator;
+    /**
+     * generates bit strings based on specified parameters
+     *
+     * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array (If specified, arrays will be generated).
+     * @param dimensions - desired length of each bit string (e.g., `dimensions = 3` produces values like `'010'`).
+     *
+     * Defaults to the value of the database column bit-length.
+     *
+     * @example
+     * ```ts
+     *  await seed(db, { bitStringTable: schema.bitStringTable }).refine((funcs) => ({
+     * 		bitStringTable: {
+     * 			count,
+     * 			columns: {
+     * 				bit: funcs.bitString({
+     * 					dimensions: 12,
+     * 					isUnique: true
+     * 				}),
+     * 			},
+     * 		},
+     * 	}));
+     * ```
+     */
+    bitString: (...args: [] | [{
+        dimensions?: number;
+        isUnique?: boolean;
+        arraySize?: number;
+    }]) => GenerateBitString;
+    /**
+     * generates ip addresses based on specified parameters
+     *
+     * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array (If specified, arrays will be generated).
+     * @param ipAddress - type of IP address to generate — either "ipv4" or "ipv6".
+     *
+     * Defaults to `'ipv4'`.
+     * @param includeCidr - determines whether generated IPs include a CIDR suffix.
+     *
+     * Defaults to `true`.
+     *
+     * @example
+     * ```ts
+     *  await seed(db, { inetTable: schema.inetTable }).refine((funcs) => ({
+     * 		inetTable: {
+     * 			count,
+     * 			columns: {
+     * 				inet: funcs.inet({
+     * 					ipAddress: 'ipv4',
+     * 					includeCidr: true,
+     * 					isUnique: true
+     * 				}),
+     * 			},
+     * 		},
+     * 	}));
+     * ```
+     */
+    inet: (...args: [] | [{
+        ipAddress?: "ipv4" | "ipv6";
+        includeCidr?: boolean;
+        isUnique?: boolean;
+        arraySize?: number;
+    }]) => GenerateInet;
+    /**
+     * generates PostGIS geometry objects based on the given parameters.
+     *
+     * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array (If specified, arrays will be generated).
+     * @param type - geometry type to generate; currently only `'point'` is supported.
+     *
+     * Defaults to `'point'`.
+     * @param srid - Spatial Reference System Identifier: determines what type of point will be generated - either `4326` or `3857`.
+     *
+     * Defaults to `4326`.
+     * @param decimalPlaces - number of decimal places for points when `srid` is `4326` (e.g., `decimalPlaces = 3` produces values like `'point(30.723 46.482)'`).
+     *
+     * Defaults to `6`.
+     *
+     * @example
+     * ```ts
+     *  await seed(db, { geometryTable: schema.geometryTable }).refine((funcs) => ({
+     * 		geometryTable: {
+     * 			count,
+     * 			columns: {
+     * 				geometryPointTuple: funcs.geometry({
+     * 					type: 'point',
+     * 					srid: 4326,
+     * 					decimalPlaces: 5,
+     * 					isUnique: true
+     * 				})
+     * 			},
+     * 		},
+     * 	}));
+     * ```
+     */
+    geometry: (...args: [] | [{
+        type?: "point";
+        srid?: 4326 | 3857;
+        decimalPlaces?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
+        isUnique?: boolean;
+        arraySize?: number;
+    }]) => GenerateGeometry;
+    /**
+     * generates vectors based on the provided parameters.
+     *
+     * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array (If specified, arrays will be generated).
+     * @param decimalPlaces - number of decimal places for each vector element (e.g., `decimalPlaces = 3` produces values like `1.123`).
+     *
+     * Defaults to `2`.
+     * @param dimensions - number of elements in each generated vector (e.g., `dimensions = 3` produces values like `[1,2,3]`).
+     *
+     * Defaults to the value of the database column’s dimensions.
+     * @param minValue - minimum allowed value for each vector element.
+     *
+     * Defaults to `-1000`.
+     * @param maxValue - maximum allowed value for each vector element.
+     *
+     * Defaults to `1000`.
+     *
+     * @example
+     * ```ts
+     *  await seed(db, { vectorTable: schema.vectorTable }).refine((funcs) => ({
+     * 		vectorTable: {
+     * 			count,
+     * 			columns: {
+     * 				vector: funcs.vector({
+     * 					decimalPlaces: 5,
+     * 					dimensions: 12,
+     * 					minValue: -100,
+     * 					maxValue: 100,
+     * 					isUnique: true
+     * 				}),
+     * 			},
+     * 		},
+     * 	}));
+     * ```
+     */
+    vector: (...args: [] | [{
+        dimensions?: number;
+        minValue?: number;
+        maxValue?: number;
+        decimalPlaces?: number;
+        isUnique?: boolean;
+        arraySize?: number;
+    }]) => GenerateVector;
 };
 export declare const generatorsFuncsV2: {
     /**
@@ -821,14 +943,7 @@ export declare const generatorsFuncsV2: {
      *
      * ```
      */
-    valuesFromArray: (args_0: {
-        values: (number | string | boolean | undefined)[] | {
-            weight: number;
-            values: (number | string | boolean | undefined)[];
-        }[];
-        isUnique?: boolean;
-        arraySize?: number;
-    }) => GenerateValuesFromArray;
+    valuesFromArray: (args_0: import("./Generators.js").GenerateValuesFromArrayT) => GenerateValuesFromArray;
     /**
      * generates sequential integers starting with 1.
      * @example
@@ -942,8 +1057,6 @@ export declare const generatorsFuncsV2: {
     }]) => GenerateDate;
     /**
      * generates time in 24 hours style.
-     * @param minTime - lower border of range.
-     * @param maxTime - upper border of range.
      * @param arraySize - number of elements in each one-dimensional array. (If specified, arrays will be generated.)
      *
      * @example
@@ -951,7 +1064,7 @@ export declare const generatorsFuncsV2: {
      *  await seed(db, schema, { count: 1000 }).refine((funcs) => ({
      *    users: {
      *      columns: {
-     *        birthTime: funcs.time({ minTime: "11:12:13.141", maxTime: "15:16:17.181" })
+     *        birthTime: funcs.time()
      *      },
      *    },
      *  }));
@@ -959,14 +1072,10 @@ export declare const generatorsFuncsV2: {
      * ```
      */
     time: (...args: [] | [{
-        minTime?: string | Date;
-        maxTime?: string | Date;
         arraySize?: number;
     }]) => GenerateTime;
     /**
      * generates timestamps.
-     * @param minTimestamp - lower border of range.
-     * @param maxTimestamp - upper border of range.
      * @param arraySize - number of elements in each one-dimensional array. (If specified, arrays will be generated.)
      *
      * @example
@@ -974,7 +1083,7 @@ export declare const generatorsFuncsV2: {
      *  await seed(db, schema, { count: 1000 }).refine((funcs) => ({
      *    orders: {
      *      columns: {
-     *        shippedDate: funcs.timestamp({ minTimestamp: "2025-03-07T11:12:13.141", maxTimestamp: "2025-03-08T15:16:17.181" })
+     *        shippedDate: funcs.timestamp()
      *      },
      *    },
      *  }));
@@ -982,14 +1091,10 @@ export declare const generatorsFuncsV2: {
      * ```
      */
     timestamp: (...args: [] | [{
-        minTimestamp?: string | Date;
-        maxTimestamp?: string | Date;
         arraySize?: number;
     }]) => GenerateTimestamp;
     /**
      * generates datetime objects.
-     * @param minDatetime - lower border of range.
-     * @param maxDatetime - upper border of range.
      * @param arraySize - number of elements in each one-dimensional array. (If specified, arrays will be generated.)
      *
      * @example
@@ -997,7 +1102,7 @@ export declare const generatorsFuncsV2: {
      *  await seed(db, schema, { count: 1000 }).refine((funcs) => ({
      *    orders: {
      *      columns: {
-     *        shippedDate: funcs.datetime({ minDatetime: "2025-03-07T11:12:13.141", maxDatetime: "2025-03-08T15:16:17.181" })
+     *        shippedDate: funcs.datetime()
      *      },
      *    },
      *  }));
@@ -1005,8 +1110,6 @@ export declare const generatorsFuncsV2: {
      * ```
      */
     datetime: (...args: [] | [{
-        minDatetime?: string | Date;
-        maxDatetime?: string | Date;
         arraySize?: number;
     }]) => GenerateDatetime;
     /**
@@ -1250,12 +1353,7 @@ export declare const generatorsFuncsV2: {
      *
      * ```
      */
-    phoneNumber: (...args: [] | [{
-        template?: string;
-        prefixes?: string[];
-        generatedDigitsNumbers?: number | number[];
-        arraySize?: number;
-    }]) => GeneratePhoneNumber;
+    phoneNumber: (...args: [] | [import("./Generators.js").GeneratePhoneNumberT]) => GeneratePhoneNumber;
     /**
      * generates country's names.
      * @param isUnique - property that controls if generated values gonna be unique or not.
@@ -1518,6 +1616,152 @@ export declare const generatorsFuncsV2: {
         weight: number;
         value: AbstractGenerator<any>;
     }[]) => WeightedRandomGenerator;
+    /**
+     * generates bit strings based on specified parameters
+     *
+     * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array (If specified, arrays will be generated).
+     * @param dimensions - desired length of each bit string (e.g., `dimensions = 3` produces values like `'010'`).
+     *
+     * Defaults to the value of the database column bit-length.
+     *
+     * @example
+     * ```ts
+     *  await seed(db, { bitStringTable: schema.bitStringTable }).refine((funcs) => ({
+     * 		bitStringTable: {
+     * 			count,
+     * 			columns: {
+     * 				bit: funcs.bitString({
+     * 					dimensions: 12,
+     * 					isUnique: true
+     * 				}),
+     * 			},
+     * 		},
+     * 	}));
+     * ```
+     */
+    bitString: (...args: [] | [{
+        dimensions?: number;
+        isUnique?: boolean;
+        arraySize?: number;
+    }]) => GenerateBitString;
+    /**
+     * generates ip addresses based on specified parameters
+     *
+     * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array (If specified, arrays will be generated).
+     * @param ipAddress - type of IP address to generate — either "ipv4" or "ipv6".
+     *
+     * Defaults to `'ipv4'`.
+     * @param includeCidr - determines whether generated IPs include a CIDR suffix.
+     *
+     * Defaults to `true`.
+     *
+     * @example
+     * ```ts
+     *  await seed(db, { inetTable: schema.inetTable }).refine((funcs) => ({
+     * 		inetTable: {
+     * 			count,
+     * 			columns: {
+     * 				inet: funcs.inet({
+     * 					ipAddress: 'ipv4',
+     * 					includeCidr: true,
+     * 					isUnique: true
+     * 				}),
+     * 			},
+     * 		},
+     * 	}));
+     * ```
+     */
+    inet: (...args: [] | [{
+        ipAddress?: "ipv4" | "ipv6";
+        includeCidr?: boolean;
+        isUnique?: boolean;
+        arraySize?: number;
+    }]) => GenerateInet;
+    /**
+     * generates PostGIS geometry objects based on the given parameters.
+     *
+     * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array (If specified, arrays will be generated).
+     * @param type - geometry type to generate; currently only `'point'` is supported.
+     *
+     * Defaults to `'point'`.
+     * @param srid - Spatial Reference System Identifier: determines what type of point will be generated - either `4326` or `3857`.
+     *
+     * Defaults to `4326`.
+     * @param decimalPlaces - number of decimal places for points when `srid` is `4326` (e.g., `decimalPlaces = 3` produces values like `'point(30.723 46.482)'`).
+     *
+     * Defaults to `6`.
+     *
+     * @example
+     * ```ts
+     *  await seed(db, { geometryTable: schema.geometryTable }).refine((funcs) => ({
+     * 		geometryTable: {
+     * 			count,
+     * 			columns: {
+     * 				geometryPointTuple: funcs.geometry({
+     * 					type: 'point',
+     * 					srid: 4326,
+     * 					decimalPlaces: 5,
+     * 					isUnique: true
+     * 				})
+     * 			},
+     * 		},
+     * 	}));
+     * ```
+     */
+    geometry: (...args: [] | [{
+        type?: "point";
+        srid?: 4326 | 3857;
+        decimalPlaces?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
+        isUnique?: boolean;
+        arraySize?: number;
+    }]) => GenerateGeometry;
+    /**
+     * generates vectors based on the provided parameters.
+     *
+     * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array (If specified, arrays will be generated).
+     * @param decimalPlaces - number of decimal places for each vector element (e.g., `decimalPlaces = 3` produces values like `1.123`).
+     *
+     * Defaults to `2`.
+     * @param dimensions - number of elements in each generated vector (e.g., `dimensions = 3` produces values like `[1,2,3]`).
+     *
+     * Defaults to the value of the database column’s dimensions.
+     * @param minValue - minimum allowed value for each vector element.
+     *
+     * Defaults to `-1000`.
+     * @param maxValue - maximum allowed value for each vector element.
+     *
+     * Defaults to `1000`.
+     *
+     * @example
+     * ```ts
+     *  await seed(db, { vectorTable: schema.vectorTable }).refine((funcs) => ({
+     * 		vectorTable: {
+     * 			count,
+     * 			columns: {
+     * 				vector: funcs.vector({
+     * 					decimalPlaces: 5,
+     * 					dimensions: 12,
+     * 					minValue: -100,
+     * 					maxValue: 100,
+     * 					isUnique: true
+     * 				}),
+     * 			},
+     * 		},
+     * 	}));
+     * ```
+     */
+    vector: (...args: [] | [{
+        dimensions?: number;
+        minValue?: number;
+        maxValue?: number;
+        decimalPlaces?: number;
+        isUnique?: boolean;
+        arraySize?: number;
+    }]) => GenerateVector;
 };
 export declare const generatorsMap: {
     readonly HollowGenerator: readonly [typeof HollowGenerator];
@@ -1570,4 +1814,13 @@ export declare const generatorsMap: {
     readonly WeightedRandomGenerator: readonly [typeof WeightedRandomGenerator];
     readonly GenerateArray: readonly [typeof GenerateArray];
     readonly GenerateWeightedCount: readonly [typeof GenerateWeightedCount];
+    readonly GenerateBitString: readonly [typeof GenerateBitString];
+    readonly GenerateUniqueBitString: readonly [typeof GenerateUniqueBitString];
+    readonly GenerateInet: readonly [typeof GenerateInet];
+    readonly GenerateUniqueInet: readonly [typeof GenerateUniqueInet];
+    readonly GenerateGeometry: readonly [typeof GenerateGeometry];
+    readonly GenerateUniqueGeometry: readonly [typeof GenerateUniqueGeometry];
+    readonly GenerateVector: readonly [typeof GenerateVector];
+    readonly GenerateUniqueVector: readonly [typeof GenerateUniqueVector];
+    readonly GenerateCompositeUniqueKey: readonly [typeof GenerateCompositeUniqueKey];
 };