drizzle-orm 0.12.0-beta.20 → 0.12.0-beta.21

package/README.md

@@ -0,0 +1,30 @@
+## Drizzle ORM
+DrizzleORM is a TypeScript ORM library with a [drizzle-kit](#migrations) CLI companion for automatic SQL migrations generation. 
+It's meant to be a library, not a framework, stay as an opt-in solution all the time at any levels. 
+We try to follow SQL-like syntax whenever possible, be strongly typed ground top and fail in compile time, not in runtime. 
+We implemented best in class `joins` and second to none `migrations generation`. 
+Library has almost zero dependencies and being battle tested on production projects by multiple teams 🚀
+
+| database    | support |            |
+|:--          |  :---:  | :--        |
+| PostgreSQL  | ✅      |[Docs](https://github.com/drizzle-team/drizzle-orm/tree/main/drizzle-orm-pg)|
+| MySQL       | ✅      |[Docs](https://github.com/drizzle-team/drizzle-orm/tree/main/drizzle-orm-mysql)|            
+| SQLite      | ✅      |[Docs](https://github.com/drizzle-team/drizzle-orm/tree/main/drizzle-orm-sqlite)|  
+| DynamoDB    | ⏳      |            |
+| MS SQL      | ⏳      |            |
+| CockroachDB | ⏳      |            |
+
+### Installation
+```bash
+// postgresql
+npm install drizzle-orm drizzle-orm-pg
+npm install -D drizzle-kit
+
+// mysql
+npm install drizzle-orm drizzle-orm-mysql
+npm install -D drizzle-kit
+
+// sqlite
+npm install drizzle-orm drizzle-orm-sqlite
+npm install -D drizzle-kit
+```

package/brands/column.js

@@ -0,0 +1,5 @@
+"use strict";
+// import { Brand } from './common';
+// export class ColumnData<T = unknown> extends Brand<'ColumnData', T> {}
+// export class ColumnDriverParam<T = unknown> extends Brand<'ColumnDriverParam', T> {}
+//# sourceMappingURL=column.js.map

package/brands/column.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"column.js","sourceRoot":"","sources":["../../src/brands/column.ts"],"names":[],"mappings":";AAAA,oCAAoC;AAEpC,yEAAyE;AAEzE,uFAAuF"}

package/brands/common.js

@@ -0,0 +1,15 @@
+"use strict";
+// export abstract class Brand<T extends string, TValue> {
+// 	declare $brand: T;
+// 	declare value: TValue;
+// 	constructor(value?: TValue) {
+// 		if (value !== undefined) {
+// 			this.value = value;
+// 		}
+// 	}
+// 	toString(): string {
+// 		return `${this.value}`;
+// 	}
+// }
+// export type Unwrap<T extends Brand<any, any>> = T['value'];
+//# sourceMappingURL=common.js.map

package/brands/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/brands/common.ts"],"names":[],"mappings":";AAAA,0DAA0D;AAC1D,sBAAsB;AACtB,0BAA0B;AAE1B,iCAAiC;AACjC,+BAA+B;AAC/B,yBAAyB;AACzB,MAAM;AACN,KAAK;AAEL,wBAAwB;AACxB,4BAA4B;AAC5B,KAAK;AACL,IAAI;AAEJ,8DAA8D"}

package/brands/index.js

@@ -0,0 +1,5 @@
+"use strict";
+// export * from './common';
+// export * from './table';
+// export * from './column';
+//# sourceMappingURL=index.js.map

package/brands/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/brands/index.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,2BAA2B;AAC3B,4BAA4B"}

package/brands/table.js

@@ -0,0 +1,8 @@
+"use strict";
+// import { Brand } from './common';
+// export class TableName<T extends string = string> extends Brand<'TableName', T> {
+// 	constructor(readonly name: T) {
+// 		super(name);
+// 	}
+// }
+//# sourceMappingURL=table.js.map

package/brands/table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.js","sourceRoot":"","sources":["../../src/brands/table.ts"],"names":[],"mappings":";AAAA,oCAAoC;AAEpC,oFAAoF;AACpF,mCAAmC;AACnC,iBAAiB;AACjB,KAAK;AACL,IAAI"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "drizzle-orm",
-  "version": "0.12.0-beta.20",
+  "version": "0.12.0-beta.21",
   "description": "Drizzle ORM package for SQL databases",
   "main": "index.js",
   "types": "index.d.ts",

package/.turbo/turbo-build:int.log

@@ -1,13 +0,0 @@
-
-> drizzle-orm@0.12.0-beta.17 build:int /Users/alexblokh/Development/drizzle-orm-new/drizzle-orm
-> pnpm build && pnpm run pack
-
-
-> drizzle-orm@0.12.0-beta.17 build /Users/alexblokh/Development/drizzle-orm-new/drizzle-orm
-> tsc -p tsconfig.build.json
-
-
-> drizzle-orm@0.12.0-beta.17 pack /Users/alexblokh/Development/drizzle-orm-new/drizzle-orm
-> cp ../README.md package.json dist/ && (cd dist && pnpm pack --pack-destination ..) && rm -f package.tgz && mv *.tgz package.tgz
-
-drizzle-orm-0.12.0-beta.17.tgz

package/.turbo/turbo-test:types.log

@@ -1,5 +0,0 @@
-
-> drizzle-orm@0.12.0-beta.17 test:types /Users/alexblokh/Development/drizzle-orm-new/drizzle-orm
-> echo WARN: No tests defined!
-
-WARN: No tests defined!

package/dist/package.json

@@ -1,58 +0,0 @@
-{
-	"name": "drizzle-orm",
-	"version": "0.12.0-beta.17",
-	"description": "Drizzle ORM package for SQL databases",
-	"main": "index.js",
-	"types": "index.d.ts",
-	"scripts": {
-		"build": "tsc -p tsconfig.build.json",
-		"test:types": "echo WARN: No tests defined!",
-		"pack": "cp ../README.md package.json dist/ && (cd dist && pnpm pack --pack-destination ..) && rm -f package.tgz && mv *.tgz package.tgz",
-		"publish": "npm publish package.tgz",
-		"publish:beta": "npm publish package.tgz --tag beta",
-		"release:beta": "pnpm build && pnpm version prerelease && pnpm run pack && pnpm publish:beta",
-		"build:int": "pnpm build && pnpm run pack"
-	},
-	"publishConfig": {
-		"access": "public"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/drizzle-team/drizzle-orm.git"
-	},
-	"keywords": [
-		"orm",
-		"pg",
-		"mysql",
-		"postgresql",
-		"postgres",
-		"database",
-		"sql",
-		"typescript"
-	],
-	"author": "",
-	"license": "Apache-2.0",
-	"bugs": {
-		"url": "https://github.com/drizzle-team/drizzle-orm/issues"
-	},
-	"homepage": "https://github.com/drizzle-team/drizzle-orm#readme",
-	"peerDependencies": {
-		"drizzle-orm-mysql": ">=0.12.0 <0.13.0 || >=0.12.0-beta.0 <0.13.0-beta.0",
-		"drizzle-orm-pg": ">=0.12.0 <0.13.0 || >=0.12.0-beta.0 <0.13.0-beta.0",
-		"drizzle-orm-sqlite": ">=0.12.0 <0.13.0 || >=0.12.0-beta.0 <0.13.0-beta.0"
-	},
-	"peerDependenciesMeta": {
-		"drizzle-orm-mysql": {
-			"optional": true
-		},
-		"drizzle-orm-pg": {
-			"optional": true
-		},
-		"drizzle-orm-sqlite": {
-			"optional": true
-		}
-	},
-	"devDependencies": {
-		"@types/node": "^18.11.9"
-	}
-}

package/dist/readme.md

@@ -1,30 +0,0 @@
-## DrizzleORM
-DrizzleORM is a TypeScript ORM library with a [drizzle-kit](#migrations) CLI companion for automatic SQL migrations generation. 
-It's meant to be a library, not a framework, stay as an opt-in solution all the time at any levels. 
-We try to follow SQL-like syntax whenever possible, be strongly typed ground top and fail in compile time, not in runtime. 
-We implemented best in class `joins` and second to none `migrations generation`. 
-Library has almost zero dependencies and being battle tested on production projects by multiple teams 🚀
-
-| database    | support |            |
-|:--          |  :---:  | :--        |
-| PostgreSQL  | ✅      |[Docs](https://github.com/drizzle-team/drizzle-orm/tree/main/drizzle-orm-pg)|
-| MySQL       | ✅      |[Docs](https://github.com/drizzle-team/drizzle-orm/tree/main/drizzle-orm-mysql)|            |
-| SQLite      | ⏳      |            |  
-| DynamoDB    | ⏳      |            |
-| MS SQL      | ⏳      |            |
-| CockroachDB | ⏳      |            |
-
-### Installation
-```bash
-// postgresql
-npm install drizzle-orm drizzle-orm-pg
-npm install -D drizzle-kit
-
-// mysql
-npm install drizzle-orm drizzle-orm-mysql
-npm install -D drizzle-kit
-
-// sqlite
-npm install drizzle-orm drizzle-orm-sqlite
-npm install -D drizzle-kit
-```

package/src/alias.ts

@@ -1,47 +0,0 @@
-import { AnyColumn, Column } from './column';
-import { Table } from './table';
-
-export class ColumnAliasProxyHandler<TColumn extends AnyColumn> implements ProxyHandler<TColumn> {
-	constructor(private table: Table) {}
-
-	get(columnObj: TColumn, prop: string | symbol, receiver: any): any {
-		if (prop === 'table') {
-			return this.table;
-		}
-		return columnObj[prop as keyof TColumn];
-	}
-}
-
-export class TableAliasProxyHandler implements ProxyHandler<Table> {
-	constructor(private alias: string) {}
-
-	get(tableObj: Table, prop: string | symbol, receiver: any): any {
-		if (prop === Table.Symbol.Name) {
-			return this.alias;
-		}
-		if (prop === Table.Symbol.Columns) {
-			const columns = tableObj[Table.Symbol.Columns];
-			if (!columns) {
-				return columns;
-			}
-
-			const proxiedColumns: { [key: string]: any } = {};
-
-			Object.keys(columns).map((key) => {
-				proxiedColumns[key] = new Proxy(
-					columns[key]!,
-					new ColumnAliasProxyHandler(new Proxy(tableObj, this)),
-				);
-			});
-
-			return proxiedColumns;
-		}
-
-		const value = tableObj[prop as keyof Table];
-		if (value instanceof Column) {
-			return new Proxy(value, new ColumnAliasProxyHandler(new Proxy(tableObj, this)));
-		}
-
-		return value;
-	}
-}

package/src/column-builder.ts

@@ -1,69 +0,0 @@
-import { SQL } from './sql';
-import { Update } from './utils';
-
-export interface ColumnBuilderBaseConfig {
-	data: unknown;
-	driverParam: unknown;
-	notNull: boolean;
-	hasDefault: boolean;
-}
-
-export type ColumnBuilderConfig<TPartial extends Partial<ColumnBuilderBaseConfig> = {}> = Update<
-	ColumnBuilderBaseConfig & {
-		notNull: false;
-		hasDefault: false;
-	},
-	TPartial
->;
-
-// To understand how to use `ColumnBuilder` and `AnyColumnBuilder`, see `Column` and `AnyColumn` documentation.
-export abstract class ColumnBuilder<T extends Partial<ColumnBuilderBaseConfig>> {
-	declare protected $brand: {
-		type: 'ColumnBuilder';
-		subtype: string;
-	};
-	declare protected $config: T;
-	declare protected $data: T['data'];
-	declare protected $driverParam: T['driverParam'];
-	declare protected $notNull: T['notNull'];
-	declare protected $hasDefault: T['hasDefault'];
-
-	/** @internal */
-	config: {
-		name: string;
-		notNull: boolean;
-		default: T['data'] | SQL | undefined;
-		primaryKey: boolean;
-	};
-
-	constructor(name: string) {
-		this.config = {
-			name,
-			notNull: false,
-			default: undefined,
-			primaryKey: false,
-		};
-	}
-
-	notNull(): ColumnBuilder<UpdateCBConfig<T, { notNull: true }>> {
-		this.config.notNull = true;
-		return this as ReturnType<this['notNull']>;
-	}
-
-	default(
-		value: T['data'] | SQL,
-	): ColumnBuilder<UpdateCBConfig<T, { hasDefault: true }>> {
-		this.config.default = value;
-		return this as ReturnType<this['default']>;
-	}
-
-	primaryKey(): ColumnBuilder<UpdateCBConfig<T, { notNull: true }>> {
-		this.config.primaryKey = true;
-		return this as ReturnType<this['primaryKey']>;
-	}
-}
-
-export type UpdateCBConfig<
-	T extends Partial<ColumnBuilderBaseConfig>,
-	TUpdate extends Partial<ColumnBuilderBaseConfig>,
-> = Update<T, TUpdate>;

package/src/column.ts

@@ -1,86 +0,0 @@
-import { ColumnBuilder, ColumnBuilderBaseConfig, ColumnBuilderConfig } from './column-builder';
-import { DriverValueMapper, SQL } from './sql';
-import { Table } from './table';
-import { Update } from './utils';
-
-export interface ColumnBaseConfig extends ColumnBuilderBaseConfig {
-	tableName: string;
-}
-
-export type ColumnConfig<TPartial extends Partial<ColumnBaseConfig> = {}> = Update<
-	ColumnBuilderConfig & { tableName: string },
-	TPartial
->;
-
-// export type UpdateColumnConfig<
-// 	T extends ColumnBaseConfig,
-// 	TUpdate extends Partial<ColumnBaseConfig>,
-// > = Update<T, TUpdate, keyof ColumnBaseConfig>;
-
-/*
-	`Column` only accepts a full `ColumnConfig` as its generic.
-	To infer parts of the config, use `AnyColumn` that accepts a partial config.
-	See `GetColumnData` for example usage of inferring.
-*/
-export abstract class Column<T extends Partial<ColumnBaseConfig>>
-	implements DriverValueMapper<T['data'], T['driverParam']>
-{
-	declare protected $brand: 'Column';
-	declare protected $config: T;
-	declare protected $data: T['data'];
-	declare protected $driverParam: T['driverParam'];
-	declare protected $notNull: T['notNull'];
-	declare protected $hasDefault: T['hasDefault'];
-
-	readonly name: string;
-	readonly primary: boolean;
-	readonly notNull: boolean;
-	readonly default: T['data'] | SQL | undefined;
-
-	constructor(readonly table: Table<T['tableName']>, builder: ColumnBuilder<Omit<T, 'tableName'>>) {
-		this.name = builder.config.name;
-		this.notNull = builder.config.notNull;
-		this.default = builder.config.default;
-		this.primary = builder.config.primaryKey;
-	}
-
-	abstract getSQLType(): string;
-
-	mapFromDriverValue(value: T['driverParam']): T['data'] {
-		return value as any;
-	}
-
-	mapToDriverValue(value: T['data']): T['driverParam'] {
-		return value as any;
-	}
-}
-
-export type UpdateColConfig<T extends Partial<ColumnBaseConfig>, TUpdate extends Partial<ColumnBaseConfig>> = Update<
-	T,
-	TUpdate
->;
-
-export type AnyColumn<TPartial extends Partial<ColumnBaseConfig> = {}> = Column<Update<ColumnBaseConfig, TPartial>>;
-
-export type GetColumnData<TColumn extends AnyColumn, TInferMode extends 'query' | 'raw' = 'query'> =
-	// dprint-ignore
-	TColumn extends AnyColumn<{ data: infer TData; notNull: infer TNotNull extends boolean }>
-		? TInferMode extends 'raw' // Raw mode
-			? TData // Just return the underlying type
-			: TNotNull extends true // Query mode
-			? TData // Query mode, not null
-			: TData | null // Query mode, nullable
-		: never;
-
-/**
-	`GetColumnConfig` can be used to infer either the full config of the column or a single parameter.
-	@example
-	type TConfig = GetColumnConfig<typeof column>;
-	type TNotNull = GetColumnConfig<typeof column, 'notNull'>;
-*/
-export type GetColumnConfig<TColumn extends AnyColumn, TParam extends keyof ColumnBaseConfig | undefined = undefined> =
-	TColumn extends Column<infer TConfig> ? TParam extends keyof ColumnBaseConfig ? TConfig[TParam] : TConfig : never;
-
-export type InferColumnsDataTypes<TColumns extends Record<string, AnyColumn>> = {
-	[Key in keyof TColumns]: GetColumnData<TColumns[Key], 'query'>;
-};

package/src/connection.ts

@@ -1,99 +0,0 @@
-export type MigrationMeta = { sql: string; folderMillis: number; hash: string };
-
-export interface Logger {
-	logQuery(query: string, params: unknown[]): void;
-}
-
-export interface LogWriter {
-	write(message: string): void;
-}
-
-export class ConsoleLogWriter implements LogWriter {
-	write(message: string) {
-		console.log(message);
-	}
-}
-
-export class DefaultLogger implements Logger {
-	readonly writer: LogWriter;
-
-	constructor(config: { writer: LogWriter } = { writer: new ConsoleLogWriter() }) {
-		this.writer = config.writer;
-	}
-
-	logQuery(query: string, params: unknown[]): void {
-		const stringifiedParams = params.map((p) => {
-			try {
-				return JSON.stringify(p);
-			} catch (e) {
-				return String(p);
-			}
-		});
-		const paramsStr = stringifiedParams.length ? ` -- params: [${stringifiedParams.join(', ')}]` : '';
-		this.writer.write(`Query: ${query}${paramsStr}`);
-	}
-}
-
-export class NoopLogger implements Logger {
-	logQuery(): void {}
-}
-
-export interface KitConfig {
-	out: string;
-	schema: string;
-}
-
-export interface MigrationConfig {
-	migrationsFolder: string;
-}
-
-export function readMigrationFiles(config: string | MigrationConfig): MigrationMeta[] {
-	const fs = require('fs') as typeof import('fs');
-	const crypto = require('crypto') as typeof import('crypto');
-	const path = require('path') as typeof import('path');
-
-	let migrationFolderTo: string | undefined;
-	if (typeof config === 'string') {
-		const configAsString = fs.readFileSync(path.resolve('.', config), 'utf8');
-		const jsonConfig = JSON.parse(configAsString) as KitConfig;
-		migrationFolderTo = jsonConfig.out;
-	} else {
-		migrationFolderTo = config.migrationsFolder;
-	}
-
-	if (!migrationFolderTo) {
-		throw Error('no migration folder defined');
-	}
-
-	const files = fs.readdirSync(migrationFolderTo);
-	const migrationQueries: MigrationMeta[] = [];
-	for (const migrationFolder of files) {
-		if (migrationFolder === '.DS_Store') {
-			continue;
-		}
-		const migrationFiles = fs.readdirSync(`${migrationFolderTo}/${migrationFolder}`);
-		const migrationFile = migrationFiles.filter((file) => file === 'migration.sql')[0];
-
-		const query = fs
-			.readFileSync(`${migrationFolderTo}/${migrationFolder}/${migrationFile}`)
-			.toString();
-
-		const year = Number(migrationFolder.slice(0, 4));
-		// second param for Date() is month index, that started from 0, so we need
-		// to decrement a value for month
-		const month = Number(migrationFolder.slice(4, 6)) - 1;
-		const day = Number(migrationFolder.slice(6, 8));
-		const hour = Number(migrationFolder.slice(8, 10));
-		const min = Number(migrationFolder.slice(10, 12));
-		const sec = Number(migrationFolder.slice(12, 14));
-
-		const folderAsMillis = Date.UTC(year, month, day, hour, min, sec);
-		migrationQueries.push({
-			sql: query,
-			folderMillis: folderAsMillis,
-			hash: crypto.createHash('sha256').update(query).digest('hex'),
-		});
-	}
-
-	return migrationQueries;
-}

package/src/expressions.ts

@@ -1 +0,0 @@
-export * from './sql/expressions';

package/src/index.ts

@@ -1,4 +0,0 @@
-export * from './column';
-export * from './connection';
-export { param, sql } from './sql';
-export { Table } from './table';