drizzle-seed 0.3.2-b5a9650 → 0.4.0-08bb2d5

package/index.d.ts

@@ -1,25 +1,30 @@
-import { Relations } from 'drizzle-orm';
-import type { MySqlColumn, MySqlSchema } from 'drizzle-orm/mysql-core';
-import { MySqlDatabase, MySqlTable } from 'drizzle-orm/mysql-core';
-import type { PgColumn, PgSchema } from 'drizzle-orm/pg-core';
-import { PgDatabase, PgTable } from 'drizzle-orm/pg-core';
-import type { SQLiteColumn } from 'drizzle-orm/sqlite-core';
-import { BaseSQLiteDatabase, SQLiteTable } from 'drizzle-orm/sqlite-core';
-import type { LibSQLDatabase } from 'drizzle-orm/libsql';
-import { generatorsFuncs, generatorsFuncsV2 } from './services/GeneratorFuncs.js';
-import type { AbstractGenerator } from './services/Generators.js';
+import type { Relations } from 'drizzle-orm';
+import type { MySqlColumn, MySqlSchema, MySqlTable } from 'drizzle-orm/mysql-core';
+import { MySqlDatabase } from 'drizzle-orm/mysql-core';
+import type { PgColumn, PgSchema, PgTable } from 'drizzle-orm/pg-core';
+import { PgDatabase } from 'drizzle-orm/pg-core';
+import type { SQLiteColumn, SQLiteTable } from 'drizzle-orm/sqlite-core';
+import { BaseSQLiteDatabase } from 'drizzle-orm/sqlite-core';
+import type { MsSqlColumn, MsSqlSchema, MsSqlTable } from 'drizzle-orm/mssql-core';
+import { MsSqlDatabase } from 'drizzle-orm/mssql-core';
+import type { CockroachColumn, CockroachSchema, CockroachTable } from 'drizzle-orm/cockroach-core';
+import { CockroachDatabase } from 'drizzle-orm/cockroach-core';
+import type { SingleStoreColumn, SingleStoreSchema, SingleStoreTable } from 'drizzle-orm/singlestore-core';
+import { SingleStoreDatabase } from 'drizzle-orm/singlestore-core';
+import { generatorsFuncs, generatorsFuncsV2 } from './generators/GeneratorFuncs.js';
+import type { AbstractGenerator } from './generators/Generators.js';
 import type { DrizzleStudioObjectType, DrizzleStudioRelationType } from './types/drizzleStudio.js';
-import type { RefinementsType } from './types/seedService.js';
-export { AbstractGenerator } from './services/Generators.js';
-type InferCallbackType<DB extends PgDatabase<any, any> | MySqlDatabase<any, any> | BaseSQLiteDatabase<any, any> | LibSQLDatabase<any>, SCHEMA extends {
-    [key: string]: PgTable | PgSchema | MySqlTable | MySqlSchema | SQLiteTable | Relations;
+import type { DbType, RefinementsType } from './types/seedService.js';
+type SchemaValuesType = PgTable | PgSchema | MySqlTable | MySqlSchema | SQLiteTable | MsSqlTable | MsSqlSchema | CockroachTable | CockroachSchema | SingleStoreTable | SingleStoreSchema | Relations | any;
+type InferCallbackType<DB extends DbType, SCHEMA extends {
+    [key: string]: SchemaValuesType;
 }> = DB extends PgDatabase<any, any> ? SCHEMA extends {
-    [key: string]: PgTable | PgSchema | MySqlTable | MySqlSchema | SQLiteTable | Relations;
+    [key: string]: SchemaValuesType;
 } ? {
     [table in keyof SCHEMA as SCHEMA[table] extends PgTable ? table : never]?: {
         count?: number;
         columns?: {
-            [column in keyof SCHEMA[table] as SCHEMA[table][column] extends PgColumn ? column : never]?: AbstractGenerator<any> | false;
+            [column in keyof SCHEMA[table] as SCHEMA[table][column] extends PgColumn ? column : never]?: AbstractGenerator<any>;
         };
         with?: {
             [refTable in keyof SCHEMA as SCHEMA[refTable] extends PgTable ? refTable : never]?: number | {
@@ -29,7 +34,7 @@ type InferCallbackType<DB extends PgDatabase<any, any> | MySqlDatabase<any, any>
         };
     };
 } : {} : DB extends MySqlDatabase<any, any> ? SCHEMA extends {
-    [key: string]: PgTable | PgSchema | MySqlTable | MySqlSchema | SQLiteTable | Relations;
+    [key: string]: SchemaValuesType;
 } ? {
     [table in keyof SCHEMA as SCHEMA[table] extends MySqlTable ? table : never]?: {
         count?: number;
@@ -44,7 +49,7 @@ type InferCallbackType<DB extends PgDatabase<any, any> | MySqlDatabase<any, any>
         };
     };
 } : {} : DB extends BaseSQLiteDatabase<any, any> ? SCHEMA extends {
-    [key: string]: PgTable | PgSchema | MySqlTable | MySqlSchema | SQLiteTable | Relations;
+    [key: string]: SchemaValuesType;
 } ? {
     [table in keyof SCHEMA as SCHEMA[table] extends SQLiteTable ? table : never]?: {
         count?: number;
@@ -58,9 +63,54 @@ type InferCallbackType<DB extends PgDatabase<any, any> | MySqlDatabase<any, any>
             }[];
         };
     };
+} : {} : DB extends MsSqlDatabase<any, any> ? SCHEMA extends {
+    [key: string]: SchemaValuesType;
+} ? {
+    [table in keyof SCHEMA as SCHEMA[table] extends MsSqlTable ? table : never]?: {
+        count?: number;
+        columns?: {
+            [column in keyof SCHEMA[table] as SCHEMA[table][column] extends MsSqlColumn ? column : never]?: AbstractGenerator<any>;
+        };
+        with?: {
+            [refTable in keyof SCHEMA as SCHEMA[refTable] extends MsSqlTable ? refTable : never]?: number | {
+                weight: number;
+                count: number | number[];
+            }[];
+        };
+    };
+} : {} : DB extends CockroachDatabase<any, any> ? SCHEMA extends {
+    [key: string]: SchemaValuesType;
+} ? {
+    [table in keyof SCHEMA as SCHEMA[table] extends CockroachTable ? table : never]?: {
+        count?: number;
+        columns?: {
+            [column in keyof SCHEMA[table] as SCHEMA[table][column] extends CockroachColumn ? column : never]?: AbstractGenerator<any>;
+        };
+        with?: {
+            [refTable in keyof SCHEMA as SCHEMA[refTable] extends CockroachTable ? refTable : never]?: number | {
+                weight: number;
+                count: number | number[];
+            }[];
+        };
+    };
+} : {} : DB extends SingleStoreDatabase<any, any> ? SCHEMA extends {
+    [key: string]: SchemaValuesType;
+} ? {
+    [table in keyof SCHEMA as SCHEMA[table] extends SingleStoreTable ? table : never]?: {
+        count?: number;
+        columns?: {
+            [column in keyof SCHEMA[table] as SCHEMA[table][column] extends SingleStoreColumn ? column : never]?: AbstractGenerator<any>;
+        };
+        with?: {
+            [refTable in keyof SCHEMA as SCHEMA[refTable] extends SingleStoreTable ? refTable : never]?: number | {
+                weight: number;
+                count: number | number[];
+            }[];
+        };
+    };
 } : {} : {};
-declare class SeedPromise<DB extends PgDatabase<any, any> | MySqlDatabase<any, any> | BaseSQLiteDatabase<any, any> | LibSQLDatabase<any>, SCHEMA extends {
-    [key: string]: PgTable | PgSchema | MySqlTable | MySqlSchema | SQLiteTable | Relations;
+declare class SeedPromise<DB extends DbType, SCHEMA extends {
+    [key: string]: SchemaValuesType;
 }, VERSION extends string | undefined> implements Promise<void> {
     private db;
     private schema;
@@ -82,121 +132,115 @@ export declare function getGeneratorsFunctions(): {
     default: (args_0: {
         defaultValue: unknown;
         arraySize?: number;
-    }) => import("./services/Generators.js").GenerateDefault;
+    }) => import("./generators/Generators.js").GenerateDefault;
     valuesFromArray: (args_0: {
-        values: (number | string | boolean | undefined)[] | {
+        values: import("./types/seedService.js").GeneratedValueType[] | {
             weight: number;
-            values: (number | string | boolean | undefined)[];
+            values: import("./types/seedService.js").GeneratedValueType[];
         }[];
         isUnique?: boolean;
         arraySize?: number;
-    }) => import("./services/Generators.js").GenerateValuesFromArray;
-    intPrimaryKey: (...args: [] | [{}]) => import("./services/Generators.js").GenerateIntPrimaryKey;
+    }) => import("./generators/Generators.js").GenerateValuesFromArray;
+    intPrimaryKey: (...args: [] | [{}]) => import("./generators/Generators.js").GenerateIntPrimaryKey;
     number: (...args: [] | [{
         minValue?: number;
         maxValue?: number;
         precision?: number;
         isUnique?: boolean;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateNumber;
+    }]) => import("./generators/Generators.js").GenerateNumber;
     int: (...args: [] | [{
         minValue?: number | bigint;
         maxValue?: number | bigint;
         isUnique?: boolean;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateInt;
+    }]) => import("./generators/Generators.js").GenerateInt;
     boolean: (...args: [] | [{
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateBoolean;
+    }]) => import("./generators/Generators.js").GenerateBoolean;
     date: (...args: [] | [{
         minDate?: string | Date;
         maxDate?: string | Date;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateDate;
+    }]) => import("./generators/Generators.js").GenerateDate;
     time: (...args: [] | [{
-        minTime?: string | Date;
-        maxTime?: string | Date;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateTime;
+    }]) => import("./generators/Generators.js").GenerateTime;
     timestamp: (...args: [] | [{
-        minTimestamp?: string | Date;
-        maxTimestamp?: string | Date;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateTimestamp;
+    }]) => import("./generators/Generators.js").GenerateTimestamp;
     datetime: (...args: [] | [{
-        minDatetime?: string | Date;
-        maxDatetime?: string | Date;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateDatetime;
+    }]) => import("./generators/Generators.js").GenerateDatetime;
     year: (...args: [] | [{
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateYear;
+    }]) => import("./generators/Generators.js").GenerateYear;
     json: (...args: [] | [{
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateJson;
+    }]) => import("./generators/Generators.js").GenerateJson;
     interval: (...args: [] | [{
         fields?: "year" | "month" | "day" | "hour" | "minute" | "second" | "year to month" | "day to hour" | "day to minute" | "day to second" | "hour to minute" | "hour to second" | "minute to second";
         isUnique?: boolean;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateInterval;
+    }]) => import("./generators/Generators.js").GenerateInterval;
     string: (...args: [] | [{
         isUnique?: boolean;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateString;
+    }]) => import("./generators/Generators.js").GenerateString;
     uuid: (...args: [] | [{
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateUUID;
+    }]) => import("./generators/Generators.js").GenerateUUID;
     firstName: (...args: [] | [{
         isUnique?: boolean;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateFirstName;
+    }]) => import("./generators/Generators.js").GenerateFirstName;
     lastName: (...args: [] | [{
         isUnique?: boolean;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateLastName;
+    }]) => import("./generators/Generators.js").GenerateLastName;
     fullName: (...args: [] | [{
         isUnique?: boolean;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateFullName;
+    }]) => import("./generators/Generators.js").GenerateFullName;
     email: (...args: [] | [{
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateEmail;
+    }]) => import("./generators/Generators.js").GenerateEmail;
     phoneNumber: (...args: [] | [{
         template?: string;
         prefixes?: string[];
         generatedDigitsNumbers?: number | number[];
         arraySize?: number;
-    }]) => import("./services/Generators.js").GeneratePhoneNumber;
+    }]) => import("./generators/Generators.js").GeneratePhoneNumber;
     country: (...args: [] | [{
         isUnique?: boolean;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateCountry;
+    }]) => import("./generators/Generators.js").GenerateCountry;
     city: (...args: [] | [{
         isUnique?: boolean;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateCity;
+    }]) => import("./generators/Generators.js").GenerateCity;
     streetAddress: (...args: [] | [{
         isUnique?: boolean;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateStreetAddress;
+    }]) => import("./generators/Generators.js").GenerateStreetAddress;
     jobTitle: (...args: [] | [{
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateJobTitle;
+    }]) => import("./generators/Generators.js").GenerateJobTitle;
     postcode: (...args: [] | [{
         isUnique?: boolean;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GeneratePostcode;
+    }]) => import("./generators/Generators.js").GeneratePostcode;
     state: (...args: [] | [{
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateState;
+    }]) => import("./generators/Generators.js").GenerateState;
     companyName: (...args: [] | [{
         isUnique?: boolean;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateCompanyName;
+    }]) => import("./generators/Generators.js").GenerateCompanyName;
     loremIpsum: (...args: [] | [{
         sentencesCount?: number;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateLoremIpsum;
+    }]) => import("./generators/Generators.js").GenerateLoremIpsum;
     point: (...args: [] | [{
         isUnique?: boolean;
         minXValue?: number;
@@ -204,7 +248,7 @@ export declare function getGeneratorsFunctions(): {
         minYValue?: number;
         maxYValue?: number;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GeneratePoint;
+    }]) => import("./generators/Generators.js").GeneratePoint;
     line: (...args: [] | [{
         isUnique?: boolean;
         minAValue?: number;
@@ -214,14 +258,40 @@ export declare function getGeneratorsFunctions(): {
         minCValue?: number;
         maxCValue?: number;
         arraySize?: number;
-    }]) => import("./services/Generators.js").GenerateLine;
+    }]) => import("./generators/Generators.js").GenerateLine;
     weightedRandom: (args_0: {
         weight: number;
         value: AbstractGenerator<any>;
-    }[]) => import("./services/Generators.js").WeightedRandomGenerator;
+    }[]) => import("./generators/Generators.js").WeightedRandomGenerator;
+    bitString: (...args: [] | [{
+        dimensions?: number;
+        isUnique?: boolean;
+        arraySize?: number;
+    }]) => import("./generators/Generators.js").GenerateBitString;
+    inet: (...args: [] | [{
+        ipAddress?: "ipv4" | "ipv6";
+        includeCidr?: boolean;
+        isUnique?: boolean;
+        arraySize?: number;
+    }]) => import("./generators/Generators.js").GenerateInet;
+    geometry: (...args: [] | [{
+        type?: "point";
+        srid?: 4326 | 3857;
+        decimalPlaces?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
+        isUnique?: boolean;
+        arraySize?: number;
+    }]) => import("./generators/Generators.js").GenerateGeometry;
+    vector: (...args: [] | [{
+        dimensions?: number;
+        minValue?: number;
+        maxValue?: number;
+        decimalPlaces?: number;
+        isUnique?: boolean;
+        arraySize?: number;
+    }]) => import("./generators/Generators.js").GenerateVector;
 };
 export declare function seedForDrizzleStudio({ sqlDialect, drizzleStudioObject, drizzleStudioRelations, schemasRefinements, options }: {
-    sqlDialect: 'postgresql' | 'mysql' | 'sqlite';
+    sqlDialect: 'postgresql' | 'mysql' | 'sqlite' | 'mssql' | 'cockroach' | 'singlestore';
     drizzleStudioObject: DrizzleStudioObjectType;
     drizzleStudioRelations: DrizzleStudioRelationType[];
     schemasRefinements?: {
@@ -263,7 +333,7 @@ export declare function seedForDrizzleStudio({ sqlDialect, drizzleStudioObject,
  * // seeding with count and seed specified
  * await seed(db, schema, { count: 100000, seed: 1 });
  *
- * // seeding using refine
+ * //seeding using refine
  * await seed(db, schema, { count: 1000 }).refine((funcs) => ({
  *   users: {
  *     columns: {
@@ -284,21 +354,10 @@ export declare function seedForDrizzleStudio({ sqlDialect, drizzleStudioObject,
  *   },
  * }));
  *
- * // seeding while ignoring column
- * await seed(db, schema).refine((funcs) => ({
- *   users: {
- *     count: 5,
- *     columns: {
- *       name: funcs.fullName(),
- *       photo: false, // the photo column will not be seeded, allowing the database to use its default value.
- *     },
- *   },
- * }));
- *
  * ```
  */
-export declare function seed<DB extends PgDatabase<any, any> | MySqlDatabase<any, any, any, any> | BaseSQLiteDatabase<any, any> | LibSQLDatabase<any>, SCHEMA extends {
-    [key: string]: PgTable | PgSchema | MySqlTable | MySqlSchema | SQLiteTable | Relations | any;
+export declare function seed<DB extends DbType, SCHEMA extends {
+    [key: string]: SchemaValuesType;
 }, VERSION extends '2' | '1' | undefined>(db: DB, schema: SCHEMA, options?: {
     count?: number;
     seed?: number;
@@ -342,17 +401,13 @@ export declare function seed<DB extends PgDatabase<any, any> | MySqlDatabase<any
  * @example
  * ```ts
  * await reset(db, schema);
- *
- * // Alternatively, you can provide an object containing your tables
- * // as the `schema` parameter when calling `reset`.
- * await reset(db, { users });
  * ```
  */
-export declare function reset<DB extends PgDatabase<any, any> | MySqlDatabase<any, any, any, any> | BaseSQLiteDatabase<any, any> | LibSQLDatabase<any>, SCHEMA extends {
-    [key: string]: PgTable | PgSchema | MySqlTable | MySqlSchema | SQLiteTable | any;
+export declare function reset<DB extends DbType, SCHEMA extends {
+    [key: string]: SchemaValuesType;
 }>(db: DB, schema: SCHEMA): Promise<void>;
 export { default as cities } from './datasets/cityNames.js';
 export { default as countries } from './datasets/countries.js';
 export { default as firstNames } from './datasets/firstNames.js';
 export { default as lastNames } from './datasets/lastNames.js';
-export { SeedService } from './services/SeedService.js';
+export { SeedService } from './SeedService.js';