durcno 1.0.0-alpha.0

package/dist/src/functions/index.mjs

@@ -0,0 +1,29 @@
+import { sql } from "../sql.mjs";
+//#region src/functions/index.ts
+/**
+* Returns a Sql object that represents the SQL function `now()`.
+* @returns Sql
+*/
+function now() {
+	return sql`now()`;
+}
+/**
+* Returns a Sql object that represents the SQL function `gen_random_uuid()` (UUID v4).
+*
+* Note: Requires the pgcrypto extension in PostgreSQL.
+* @returns Sql
+*/
+function uuidv4() {
+	return sql`gen_random_uuid()`;
+}
+/**
+* Returns a Sql object that represents the SQL function `uuid_generate_v7()` (UUID v7).
+*
+* Note: Requires the uuid-ossp extension in PostgreSQL.
+* @returns Sql
+*/
+function uuidv7() {
+	return sql`uuid_generate_v7()`;
+}
+//#endregion
+export { now, uuidv4, uuidv7 };

package/dist/src/index.d.mts

@@ -0,0 +1,129 @@
+import { Query } from "./query-builders/query.mjs";
+import { asc, desc } from "./query-builders/orderby-clause.mjs";
+import { Sql, sql } from "./sql.mjs";
+import { Filter } from "./filters/custom.mjs";
+import { and, eq, gt, gte, isIn, isNotNull, isNull, lt, lte, ne, or } from "./filters/index.mjs";
+import { database } from "./db.mjs";
+import { Arg, prequery } from "./query-builders/pre.mjs";
+import { Column, ColumnConfig, notNull, primaryKey, unique } from "./columns/common.mjs";
+import { PrimaryKeyConstraint, primaryKeyConstraint } from "./constraints/primary-key.mjs";
+import { UniqueConstraint, uniqueConstraint } from "./constraints/unique.mjs";
+import { index, uniqueIndex } from "./indexes.mjs";
+import { AnyColumn, AnyTableColumn, Table, TableColumn, fk, many, one, relations, table } from "./table.mjs";
+import { Sequence, SequenceOptions, sequence } from "./sequence.mjs";
+import { bigint } from "./columns/bigint.mjs";
+import { bigserial } from "./columns/bigserial.mjs";
+import { boolean } from "./columns/boolean.mjs";
+import { bytea } from "./columns/bytea.mjs";
+import { char } from "./columns/char.mjs";
+import { cidr } from "./columns/cidr.mjs";
+import { date } from "./columns/date.mjs";
+import { Enum, enumtype } from "./enumtype.mjs";
+import { enumed } from "./columns/enum.mjs";
+import { inet } from "./columns/inet.mjs";
+import { integer } from "./columns/integer.mjs";
+import { json } from "./columns/json.mjs";
+import { jsonb } from "./columns/jsonb.mjs";
+import { macaddr } from "./columns/macaddr.mjs";
+import { numeric } from "./columns/numeric.mjs";
+import { geography } from "./columns/postgis/geography/index.mjs";
+import { serial } from "./columns/serial.mjs";
+import { smallint } from "./columns/smallint.mjs";
+import { smallserial } from "./columns/smallserial.mjs";
+import { text } from "./columns/text.mjs";
+import { time } from "./columns/time.mjs";
+import { timestamp } from "./columns/timestamp.mjs";
+import { UuidVersion, uuid } from "./columns/uuid.mjs";
+import { varchar } from "./columns/varchar.mjs";
+import { arrayAll, arrayContainedBy, arrayContains, arrayHas, arrayOverlaps } from "./filters/array.mjs";
+import { now, uuidv4, uuidv7 } from "./functions/index.mjs";
+import { Migrations, pk } from "./models.mjs";
+import { Connector } from "./connectors/common.mjs";
+import { ConnectionOptions } from "node:tls";
+
+//#region src/index.d.ts
+declare const $: {
+  isTable: (value: unknown) => value is Table<string, string, Record<string, AnyColumn>>;
+  isEnum: (value: unknown) => value is Enum<string, readonly [string, ...string[]]>;
+  isSequence: (value: unknown) => value is Sequence<SequenceOptions>;
+};
+/**
+ * A Durcno setup object containing the connector instance and configuration.
+ *
+ * Returned by `defineConfig()` and consumed by the `database()` function
+ * and CLI commands.
+ */
+type DurcnoSetup<T extends Connector = Connector> = {
+  /** The connector instance for database operations. */connector: T; /** The configuration options passed to `defineConfig`. */
+  config: Config;
+};
+/**
+ * Define a Durcno configuration.
+ *
+ * This is the recommended way to create your `durcno.config.ts` file.
+ * Pass the connector class for your database driver and the configuration options.
+ *
+ * @param Connector - The connector class to use (e.g., `PgConnector`, `PostgresConnector`, `BunConnector`, `PgLiteConnector`).
+ * @param config - The database configuration including connection credentials and pool settings.
+ * @returns A setup object containing the connector instance and the config options.
+ *
+ * @example
+ * ```typescript
+ * import { defineConfig } from "durcno";
+ * import { PgConnector } from "durcno/connectors/pg";
+ *
+ * export default defineConfig(PgConnector, {
+ *   schema: "db/schema.ts",
+ *   out: "migrations",
+ *   dbCredentials: {
+ *     url: process.env.DATABASE_URL!,
+ *   },
+ * });
+ * ```
+ */
+declare function defineConfig<T extends Connector>(ConnectorClass: new (config: Config) => T, config: Config): DurcnoSetup<T>;
+type Config = {
+  /**
+   * The relative path to the database schema file.
+   */
+  schema: string;
+  /**
+   * The relative path to the output directory for generated migrations.
+   * @default "migrations"
+   */
+  out?: string;
+  /**
+   * Database connection credentials.
+   */
+  dbCredentials: ({
+    host: string;
+    port?: number;
+    user: string;
+    password?: string;
+    database: string;
+    ssl?: boolean | "require" | "allow" | "prefer" | "verify-full" | ConnectionOptions;
+  } & {}) | {
+    url: string;
+  };
+  /**
+   * Connection pool configuration.
+   */
+  pool?: {
+    /**
+     * Maximum number of connections in the `db` pool.
+     * @default 10
+     */
+    max?: number;
+  };
+};
+declare global {
+  type Key = string | number | symbol;
+  type Valueof<T> = T extends any ? T[keyof T] : never;
+  type SelfOrArray<T> = T | T[];
+  type SelfOrReadonly<T> = T | Readonly<T>;
+  type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;
+  type Is<T, U> = T extends U ? true : false;
+  type Prettify<T> = { [K in keyof T]: T[K] } & {};
+}
+//#endregion
+export { $, type AnyColumn, type AnyTableColumn, Arg, Column, type ColumnConfig, Config, DurcnoSetup, Filter, Migrations, PrimaryKeyConstraint, type Query, Sql, type TableColumn, UniqueConstraint, type UuidVersion, and, arrayAll, arrayContainedBy, arrayContains, arrayHas, arrayOverlaps, asc, bigint, bigserial, boolean, bytea, char, cidr, database, date, defineConfig, desc, enumed, enumtype, eq, fk, geography, gt, gte, index, inet, integer, isIn, isNotNull, isNull, json, jsonb, lt, lte, macaddr, many, ne, notNull, now, numeric, one, or, pk, prequery, primaryKey, primaryKeyConstraint, relations, sequence, serial, smallint, smallserial, sql, table, text, time, timestamp, unique, uniqueConstraint, uniqueIndex, uuid, uuidv4, uuidv7, varchar };

package/dist/src/index.mjs

@@ -0,0 +1,78 @@
+import { Arg, prequery } from "./query-builders/pre.mjs";
+import { Column, notNull, primaryKey, unique } from "./columns/common.mjs";
+import { is } from "./entity.mjs";
+import { Sql, sql } from "./sql.mjs";
+import { bigint } from "./columns/bigint.mjs";
+import { bigserial } from "./columns/bigserial.mjs";
+import { boolean } from "./columns/boolean.mjs";
+import { bytea } from "./columns/bytea.mjs";
+import { char } from "./columns/char.mjs";
+import { cidr } from "./columns/cidr.mjs";
+import { date } from "./columns/date.mjs";
+import { enumed } from "./columns/enum.mjs";
+import { inet } from "./columns/inet.mjs";
+import { integer } from "./columns/integer.mjs";
+import { json } from "./columns/json.mjs";
+import { jsonb } from "./columns/jsonb.mjs";
+import { macaddr } from "./columns/macaddr.mjs";
+import { numeric } from "./columns/numeric.mjs";
+import { geography } from "./columns/postgis/geography/index.mjs";
+import { serial } from "./columns/serial.mjs";
+import { smallint } from "./columns/smallint.mjs";
+import { smallserial } from "./columns/smallserial.mjs";
+import { text } from "./columns/text.mjs";
+import { time } from "./columns/time.mjs";
+import { timestamp } from "./columns/timestamp.mjs";
+import { uuid } from "./columns/uuid.mjs";
+import { varchar } from "./columns/varchar.mjs";
+import { PrimaryKeyConstraint, primaryKeyConstraint } from "./constraints/primary-key.mjs";
+import { UniqueConstraint, uniqueConstraint } from "./constraints/unique.mjs";
+import { Table, fk, many, one, relations, table } from "./table.mjs";
+import { database } from "./db.mjs";
+import { Enum, enumtype } from "./enumtype.mjs";
+import { Filter } from "./filters/custom.mjs";
+import { arrayAll, arrayContainedBy, arrayContains, arrayHas, arrayOverlaps } from "./filters/array.mjs";
+import { and, eq, gt, gte, isIn, isNotNull, isNull, lt, lte, ne, or } from "./filters/index.mjs";
+import { now, uuidv4, uuidv7 } from "./functions/index.mjs";
+import { index, uniqueIndex } from "./indexes.mjs";
+import { Migrations, pk } from "./models.mjs";
+import { asc, desc } from "./query-builders/orderby-clause.mjs";
+import { Sequence, sequence } from "./sequence.mjs";
+//#region src/index.ts
+const $ = {
+	isTable: (value) => is(value, Table),
+	isEnum: (value) => is(value, Enum),
+	isSequence: (value) => is(value, Sequence)
+};
+/**
+* Define a Durcno configuration.
+*
+* This is the recommended way to create your `durcno.config.ts` file.
+* Pass the connector class for your database driver and the configuration options.
+*
+* @param Connector - The connector class to use (e.g., `PgConnector`, `PostgresConnector`, `BunConnector`, `PgLiteConnector`).
+* @param config - The database configuration including connection credentials and pool settings.
+* @returns A setup object containing the connector instance and the config options.
+*
+* @example
+* ```typescript
+* import { defineConfig } from "durcno";
+* import { PgConnector } from "durcno/connectors/pg";
+*
+* export default defineConfig(PgConnector, {
+*   schema: "db/schema.ts",
+*   out: "migrations",
+*   dbCredentials: {
+*     url: process.env.DATABASE_URL!,
+*   },
+* });
+* ```
+*/
+function defineConfig(ConnectorClass, config) {
+	return {
+		connector: new ConnectorClass(config),
+		config
+	};
+}
+//#endregion
+export { $, Arg, Column, Filter, Migrations, PrimaryKeyConstraint, Sql, UniqueConstraint, and, arrayAll, arrayContainedBy, arrayContains, arrayHas, arrayOverlaps, asc, bigint, bigserial, boolean, bytea, char, cidr, database, date, defineConfig, desc, enumed, enumtype, eq, fk, geography, gt, gte, index, inet, integer, isIn, isNotNull, isNull, json, jsonb, lt, lte, macaddr, many, ne, notNull, now, numeric, one, or, pk, prequery, primaryKey, primaryKeyConstraint, relations, sequence, serial, smallint, smallserial, sql, table, text, time, timestamp, unique, uniqueConstraint, uniqueIndex, uuid, uuidv4, uuidv7, varchar };

package/dist/src/indexes.d.mts

@@ -0,0 +1,31 @@
+import { AnyColumn, StdTable, TableColumn } from "./table.mjs";
+
+//#region src/indexes.d.ts
+type IndexType = "btree" | "hash" | "gist" | "spgist" | "gin" | "brin" | "hnsw" | "ivfflat" | (string & {});
+declare class Index<Col extends AnyColumn> {
+  #private;
+  constructor(columns: TableColumn<string, string, Key, Col>[], using: IndexType, unique: boolean);
+  _: {
+    getColumns: () => TableColumn<string, string, Key, Col>[];
+    getUsing: () => IndexType;
+    getUnique: () => boolean;
+    getName: (table: StdTable) => string;
+  };
+  /**
+   * Change the index type to use.
+   *
+   * SQL equivalent: `USING <index_type>`
+   * ```sql
+   * CREATE INDEX ON table_name (column)
+   *   USING gist;
+   * ```
+   *
+   * @param using - the index method to use (gin, gist, etc.)
+   * @returns the current `Index` instance for chaining
+   */
+  using(using: IndexType): this;
+}
+declare function index<Col extends AnyColumn>(columns: TableColumn<string, string, Key, Col>[], using?: IndexType): Index<Col>;
+declare function uniqueIndex<Col extends AnyColumn>(columns: TableColumn<string, string, Key, Col>[], using?: IndexType): Index<Col>;
+//#endregion
+export { Index, IndexType, index, uniqueIndex };

package/dist/src/indexes.mjs

@@ -0,0 +1,43 @@
+//#region src/indexes.ts
+var Index = class {
+	#columns;
+	#using;
+	#unique;
+	constructor(columns, using, unique) {
+		this.#columns = columns;
+		this.#using = using;
+		this.#unique = unique;
+	}
+	_ = {
+		getColumns: () => this.#columns,
+		getUsing: () => this.#using,
+		getUnique: () => this.#unique,
+		getName: (table) => {
+			return `${table._.name}_${this.#columns.map((col) => col.nameSnake).join("_")}_index`;
+		}
+	};
+	/**
+	* Change the index type to use.
+	*
+	* SQL equivalent: `USING <index_type>`
+	* ```sql
+	* CREATE INDEX ON table_name (column)
+	*   USING gist;
+	* ```
+	*
+	* @param using - the index method to use (gin, gist, etc.)
+	* @returns the current `Index` instance for chaining
+	*/
+	using(using) {
+		this.#using = using;
+		return this;
+	}
+};
+function index(columns, using) {
+	return new Index(columns, using ?? "btree", false);
+}
+function uniqueIndex(columns, using) {
+	return new Index(columns, using ?? "btree", true);
+}
+//#endregion
+export { index, uniqueIndex };

package/dist/src/migration/consts.d.mts

@@ -0,0 +1,8 @@
+//#region src/migration/consts.d.ts
+/**
+ * Regex for ISO timestamp like format with Windows-compatible separators
+ * (e.g., 2024-01-15T10-30-45.123Z ; uses `-` instead of `:` for time)
+ */
+declare const MIGRATION_NAME_REGEX: RegExp;
+//#endregion
+export { MIGRATION_NAME_REGEX };

package/dist/src/migration/consts.mjs

@@ -0,0 +1,8 @@
+//#region src/migration/consts.ts
+/**
+* Regex for ISO timestamp like format with Windows-compatible separators
+* (e.g., 2024-01-15T10-30-45.123Z ; uses `-` instead of `:` for time)
+*/
+const MIGRATION_NAME_REGEX = /^\d{4}-\d{2}-\d{2}T\d{2}-\d{2}-\d{2}\.\d{3}Z$/;
+//#endregion
+export { MIGRATION_NAME_REGEX };