@casekit/orm 0.0.1-alpha.8 → 0.0.1-release-candidate

package/src/migrate/sql/createTableSql.test.ts

@@ -1,74 +0,0 @@
-import { unindent } from "@casekit/unindent";
-
-import { snakeCase, uniqueId } from "lodash-es";
-import pg from "pg";
-import { describe, expect, test } from "vitest";
-import { z } from "zod";
-
-import { ModelDefinition, orm } from "../..";
-import { sql } from "../../sql";
-import { db } from "../../test/db";
-import { createTableSql } from "./createTableSql";
-
-describe("createTableSql", () => {
-    test("it generates a CREATE TABLE command", () => {
-        expect(createTableSql(db.models.user).text).toEqual(unindent`
-            CREATE TABLE casekit."user" (
-                id uuid NOT NULL DEFAULT uuid_generate_v4(),
-                username text NOT NULL,
-                invited_by_id uuid,
-                created_at timestamp,
-                updated_at timestamp,
-                deleted_at timestamp,
-                PRIMARY KEY (id)
-            );
-        `);
-    });
-
-    test("the generated DDL successfully creates a table", async () => {
-        const table = uniqueId("table-");
-        const post = {
-            table,
-            columns: {
-                id: {
-                    zodSchema: z.string().uuid(),
-                    type: "uuid",
-                    default: sql`uuid_generate_v4()`,
-                },
-                title: {
-                    zodSchema: z.string(),
-                    type: "text",
-                    default: "My first post",
-                },
-                content: { zodSchema: z.string(), type: "text" },
-                publishedAt: {
-                    zodSchema: z.date(),
-                    type: "timestamp",
-                    nullable: true,
-                },
-            },
-        } as const satisfies ModelDefinition;
-        await orm({
-            models: { post },
-            relations: { post: {} },
-            naming: { column: snakeCase },
-            pool: new pg.Pool(),
-        }).transact(
-            async (db) => {
-                await db.connection.query(createTableSql(db.models.post));
-
-                const result = await db.connection.query(
-                    sql`select * from public.%I`.withIdentifiers(table),
-                );
-
-                expect(result.fields.map((f) => f.name)).toEqual([
-                    "id",
-                    "title",
-                    "content",
-                    "published_at",
-                ]);
-            },
-            { rollback: true },
-        );
-    });
-});

package/src/migrate/sql/createTableSql.ts

@@ -1,53 +0,0 @@
-import pgfmt from "pg-format";
-
-import { BaseModel } from "../../schema/types/base/BaseModel";
-import { SQLStatement } from "../../sql";
-import { interleave } from "../../util/interleave";
-
-export const createTableSql = (model: BaseModel): SQLStatement => {
-    const columns = Object.values(model.columns);
-    const primaryKey = model.primaryKey;
-
-    const statement = new SQLStatement();
-
-    statement.push(
-        pgfmt("CREATE TABLE %I.%I (\n", model.schema ?? "public", model.table),
-    );
-
-    statement.push(
-        ...interleave(
-            columns.map((column) => {
-                const definition = new SQLStatement(
-                    pgfmt(`    %I %s`, column.name, column.type),
-                );
-
-                if (!column.nullable) definition.push(pgfmt(" NOT NULL"));
-
-                if (column.default instanceof SQLStatement) {
-                    definition.push(" DEFAULT ");
-                    definition.push(column.default);
-                } else if (
-                    column.default !== null &&
-                    column.default !== undefined
-                ) {
-                    definition.push(pgfmt(" DEFAULT %L", column.default));
-                }
-                return definition;
-            }),
-            ",\n",
-        ),
-    );
-
-    if (primaryKey.length > 0) {
-        statement.push(
-            pgfmt(
-                `,\n    PRIMARY KEY (${primaryKey.map(() => "%I").join(", ")})`,
-                ...primaryKey,
-            ),
-        );
-    }
-
-    statement.push(pgfmt("\n);"));
-
-    return statement;
-};

package/src/migrate/sql/createUniqueConstraintSql.ts

@@ -1,27 +0,0 @@
-import pgfmt from "pg-format";
-
-import { SQLStatement } from "../..";
-import { BaseModel } from "../../schema/types/base/BaseModel";
-import { UniqueConstraint } from "../../schema/types/constraints/UniqueConstraint";
-
-export const createUniqueConstraintSql = (
-    model: BaseModel,
-    constraint: UniqueConstraint,
-) => {
-    const statement = new SQLStatement();
-    statement.push(
-        pgfmt(`CREATE UNIQUE INDEX ON %I.%I (`, model.schema, model.table),
-    );
-    statement.push(constraint.columns.map((c) => pgfmt("%I", c)).join(", "));
-    statement.push(")");
-    if (constraint.nullsNotDistinct) {
-        statement.push(" NULLS NOT DISTINCT");
-    }
-    if (constraint.where) {
-        statement.push(" WHERE (");
-        statement.push(constraint.where);
-        statement.push(")");
-    }
-    statement.push(";");
-    return statement;
-};

package/src/migrate/sql/dropSchemasSql.ts

@@ -1,15 +0,0 @@
-import { uniq } from "lodash-es";
-import pgfmt from "pg-format";
-
-import { BaseOrm } from "../../schema/types/base/BaseOrm";
-import { SQLStatement } from "../../sql";
-
-export const dropSchemasSql = (db: BaseOrm): SQLStatement => {
-    const schemas = uniq(Object.values(db.models).map((m) => m.schema));
-
-    return new SQLStatement(
-        schemas
-            .map((s) => pgfmt("DROP SCHEMA IF EXISTS %I CASCADE;", s))
-            .join("\n"),
-    );
-};

package/src/migrate/sql/dropTableSql.ts

@@ -1,13 +0,0 @@
-import pgfmt from "pg-format";
-
-import { BaseModel } from "../../schema/types/base/BaseModel";
-import { SQLStatement } from "../../sql";
-
-export const dropTableSql = (model: BaseModel): SQLStatement => {
-    const statement = pgfmt(
-        "DROP TABLE IF EXISTS %I.%I CASCADE;",
-        model.schema ?? "public",
-        model.table,
-    );
-    return new SQLStatement(statement);
-};

package/src/orm.query.test.ts

@@ -1,28 +0,0 @@
-import { describe, expect, test } from "vitest";
-
-import { db } from "./test/db";
-import { seed } from "./test/seed";
-
-describe("orm.query", () => {
-    test("allows arbitrary sql queries to be run against the database", async () => {
-        await db.transact(
-            async (db) => {
-                await seed(db, {
-                    users: [
-                        {
-                            username: "Russell",
-                            tenants: [{ name: "Popova Park", posts: 6 }],
-                        },
-                    ],
-                });
-
-                const result = await db.query<{ total: number }>`
-                    select count(1)::int as total from casekit.post;
-                `;
-
-                expect(result[0]).toEqual({ total: 6 });
-            },
-            { rollback: true },
-        );
-    });
-});

package/src/orm.ts

@@ -1,370 +0,0 @@
-import { QueryResultRow } from "pg";
-import { z } from "zod";
-
-import { Connection } from "./Connection";
-import { OrmError } from "./errors";
-import { count } from "./queries/count";
-import { BaseCountParams } from "./queries/count/types/BaseCountParams";
-import { CountParams } from "./queries/count/types/CountParams";
-import { createResultSchema } from "./queries/create/createResultSchema";
-import { BaseCreateManyParams } from "./queries/create/types/BaseCreateManyParams";
-import { BaseCreateOneParams } from "./queries/create/types/BaseCreateOneParams";
-import { CreateManyParams } from "./queries/create/types/CreateManyParams";
-import { CreateManyResult } from "./queries/create/types/CreateManyResult";
-import { CreateOneParams } from "./queries/create/types/CreateOneParams";
-import { CreateOneResult } from "./queries/create/types/CreateOneResult";
-import { createMany } from "./queries/createMany";
-import { createOne } from "./queries/createOne";
-import { deleteResultSchema } from "./queries/delete/deleteResultSchema";
-import { BaseDeleteParams } from "./queries/delete/types/BaseDeleteParams";
-import { DeleteManyResult } from "./queries/delete/types/DeleteManyResult";
-import { DeleteOneResult } from "./queries/delete/types/DeleteOneResult";
-import { DeleteParams } from "./queries/delete/types/DeleteParams";
-import { deleteMany } from "./queries/deleteMany";
-import { deleteOne } from "./queries/deleteOne";
-import { findResultSchema } from "./queries/find/findResultSchema";
-import { FindManyParams } from "./queries/find/types/FindManyParams";
-import { FindManyResult } from "./queries/find/types/FindManyResult";
-import { FindOneResult } from "./queries/find/types/FindOneResult";
-import { findMany } from "./queries/findMany";
-import { findOne } from "./queries/findOne";
-import { BaseUpdateParams } from "./queries/update/types/BaseUpdateParams";
-import { UpdateManyResult } from "./queries/update/types/UpdateManyResult";
-import { UpdateOneResult } from "./queries/update/types/UpdateOneResult";
-import { UpdateParams } from "./queries/update/types/UpdateParams";
-import { updateResultSchema } from "./queries/update/updateResultSchema";
-import { updateMany } from "./queries/updateMany";
-import { updateOne } from "./queries/updateOne";
-import { populateConfiguration } from "./schema/populate/populateConfiguration";
-import { BaseConfiguration } from "./schema/types/base/BaseConfiguration";
-import { BaseModel } from "./schema/types/base/BaseModel";
-import { ModelName } from "./schema/types/helpers/ModelName";
-import { LooseModelDefinitions } from "./schema/types/loose/LooseModelDefinitions";
-import { LooseRelationsDefinitions } from "./schema/types/loose/LooseRelationsDefinitions";
-import { validateConfiguration } from "./schema/validate/validateConfiguration";
-import { sql } from "./sql";
-import { Configuration } from "./types/Configuration";
-import { DisallowExtraKeys } from "./types/util/DisallowExtraKeys";
-
-export class Orm<
-    Models extends LooseModelDefinitions,
-    Relations extends LooseRelationsDefinitions<Models>,
-> {
-    public config: BaseConfiguration;
-
-    /**
-     * As a nicety, we expose the models directly on the Orm instance with literal keys
-     * for the models. The deeper values are not literally typed however.
-     */
-    public get models(): {
-        [M in ModelName<Models>]: BaseModel;
-    } {
-        return this.config.models as {
-            [M in ModelName<Models>]: BaseModel;
-        };
-    }
-
-    public get connection(): Connection {
-        return this.config.connection;
-    }
-
-    constructor(config: BaseConfiguration) {
-        this.config = config;
-    }
-
-    public async transact<T>(
-        cb: (db: Orm<Models, Relations>) => Promise<T>,
-        opts = { rollback: false },
-    ): Promise<T> {
-        return await this.connection.transact(async (conn) => {
-            return await cb(
-                new Orm<Models, Relations>({
-                    ...this.config,
-                    connection: conn,
-                }),
-            );
-        }, opts);
-    }
-
-    public async findMany<
-        M extends ModelName<Models>,
-        Q extends FindManyParams<Models, Relations, M>,
-    >(
-        m: M,
-        query: DisallowExtraKeys<FindManyParams<Models, Relations, M>, Q>,
-    ): Promise<FindManyResult<Models, Relations, M, Q>> {
-        const results = await findMany(this.connection, this.config, m, query);
-        const parser = z.array(findResultSchema(this.config, m, query));
-        return parser.parse(results) as FindManyResult<Models, Relations, M, Q>;
-    }
-
-    public async findOne<
-        M extends ModelName<Models>,
-        Q extends FindManyParams<Models, Relations, M>,
-    >(
-        m: M,
-        query: DisallowExtraKeys<FindManyParams<Models, Relations, M>, Q>,
-    ): Promise<FindOneResult<Models, Relations, M, Q>> {
-        const result = await findOne(this.connection, this.config, m, query);
-        const parser = findResultSchema(this.config, m, query);
-        return parser.parse(result) as FindOneResult<Models, Relations, M, Q>;
-    }
-
-    public async createOne<
-        M extends ModelName<Models>,
-        P extends CreateOneParams<Models, M>,
-    >(
-        m: M,
-        params: DisallowExtraKeys<CreateOneParams<Models, M>, P>,
-    ): Promise<CreateOneResult<Models, M, P>> {
-        const result = await createOne(
-            this.connection,
-            this.config,
-            m,
-            params as BaseCreateOneParams,
-        );
-        const parser = createResultSchema(
-            this.config,
-            m,
-            params as BaseCreateOneParams,
-        );
-        return parser.parse(result) as CreateOneResult<Models, M, P>;
-    }
-
-    public async createMany<
-        M extends ModelName<Models>,
-        P extends CreateManyParams<Models, M>,
-    >(
-        m: M,
-        params: DisallowExtraKeys<CreateManyParams<Models, M>, P>,
-    ): Promise<CreateManyResult<Models, M, P>> {
-        const result = await createMany(
-            this.connection,
-            this.config,
-            m,
-            params as BaseCreateManyParams,
-        );
-        if (typeof result === "number")
-            return result as CreateManyResult<Models, M, P>;
-
-        const parser = z.array(
-            createResultSchema(this.config, m, params as BaseCreateManyParams),
-        );
-        return parser.parse(result) as CreateManyResult<Models, M, P>;
-    }
-
-    public async updateOne<
-        M extends ModelName<Models>,
-        P extends UpdateParams<Models, M>,
-    >(
-        m: M,
-        params: DisallowExtraKeys<UpdateParams<Models, M>, P>,
-    ): Promise<UpdateOneResult<Models, M, P>> {
-        const result = await updateOne(
-            this.connection,
-            this.config,
-            m,
-            params as BaseUpdateParams,
-        );
-        const parser = updateResultSchema(
-            this.config,
-            m,
-            params as BaseUpdateParams,
-        );
-        return parser.parse(result) as UpdateOneResult<Models, M, P>;
-    }
-
-    public async updateMany<
-        M extends ModelName<Models>,
-        P extends UpdateParams<Models, M>,
-    >(
-        m: M,
-        params: DisallowExtraKeys<UpdateParams<Models, M>, P>,
-    ): Promise<UpdateManyResult<Models, M, P>> {
-        const result = await updateMany(
-            this.connection,
-            this.config,
-            m,
-            params as BaseUpdateParams,
-        );
-
-        if (typeof result === "number")
-            return result as UpdateManyResult<Models, M, P>;
-
-        const parser = z.array(
-            updateResultSchema(this.config, m, params as BaseUpdateParams),
-        );
-        return parser.parse(result) as UpdateManyResult<Models, M, P>;
-    }
-
-    public async deleteOne<
-        M extends ModelName<Models>,
-        P extends DeleteParams<Models, M>,
-    >(
-        m: M,
-        params: DisallowExtraKeys<DeleteParams<Models, M>, P>,
-    ): Promise<DeleteOneResult<Models, M, P>> {
-        const parser = deleteResultSchema(
-            this.config,
-            m,
-            params as BaseDeleteParams,
-        );
-
-        if (this.config.middleware.delete?.deleteOne) {
-            const result = await this.config.middleware.delete.deleteOne(
-                params,
-                {
-                    model: m,
-                    config: this.config,
-                    deleteOne: (params) => {
-                        return deleteOne(
-                            this.connection,
-                            this.config,
-                            m,
-                            params,
-                            // TODO figure out a better way to type this
-                            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                        ) as any;
-                    },
-                    updateOne: (params) => {
-                        return updateOne(
-                            this.connection,
-                            this.config,
-                            m,
-                            params,
-                            // TODO figure out a better way to type this
-                            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                        ) as any;
-                    },
-                },
-            );
-
-            return parser.parse(result) as DeleteOneResult<Models, M, P>;
-        } else {
-            const result = await deleteOne(
-                this.connection,
-                this.config,
-                m,
-                params as BaseDeleteParams,
-            );
-
-            return parser.parse(result) as DeleteOneResult<Models, M, P>;
-        }
-    }
-
-    public async deleteMany<
-        M extends ModelName<Models>,
-        P extends DeleteParams<Models, M>,
-    >(
-        m: M,
-        params: DisallowExtraKeys<DeleteParams<Models, M>, P>,
-    ): Promise<DeleteManyResult<Models, M, P>> {
-        const parser = z.array(
-            deleteResultSchema(this.config, m, params as BaseDeleteParams),
-        );
-
-        if (this.config.middleware.delete?.deleteMany) {
-            const result = await this.config.middleware.delete.deleteMany(
-                params,
-                {
-                    model: m,
-                    config: this.config,
-                    deleteMany: (params) => {
-                        return deleteMany(
-                            this.connection,
-                            this.config,
-                            m,
-                            params,
-                            // TODO figure out a better way to type this
-                            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                        ) as any;
-                    },
-                    updateMany: (params) => {
-                        return updateMany(
-                            this.connection,
-                            this.config,
-                            m,
-                            params,
-                            // TODO figure out a better way to type this
-                            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                        ) as any;
-                    },
-                },
-            );
-
-            return (
-                typeof result === "number" ? result : parser.parse(result)
-            ) as DeleteManyResult<Models, M, P>;
-        } else {
-            const result = await deleteMany(
-                this.connection,
-                this.config,
-                m,
-                params as BaseDeleteParams,
-            );
-
-            return (
-                typeof result === "number" ? result : parser.parse(result)
-            ) as DeleteManyResult<Models, M, P>;
-        }
-    }
-
-    public async count<
-        M extends ModelName<Models>,
-        P extends CountParams<Models, Relations, M>,
-    >(
-        m: M,
-        params: DisallowExtraKeys<CountParams<Models, Relations, M>, P>,
-    ): Promise<number> {
-        const result = await count(
-            this.connection,
-            this.config,
-            m,
-            params as BaseCountParams,
-        );
-        return z.coerce.number().parse(result);
-    }
-
-    public async query<T extends QueryResultRow>(
-        fragments: TemplateStringsArray,
-        ...variables: readonly unknown[]
-    ): Promise<T[]> {
-        const query = sql(fragments, ...variables);
-        if (process.env.ORM_VERBOSE_LOGGING) {
-            console.log(query.text);
-            console.log(query.values);
-        }
-        const result = await this.connection.query<T>(query);
-        return result.rows;
-    }
-
-    public async queryOne<T extends QueryResultRow>(
-        fragments: TemplateStringsArray,
-        ...variables: readonly unknown[]
-    ): Promise<T> {
-        const query = sql(fragments, ...variables);
-        if (process.env.ORM_VERBOSE_LOGGING) {
-            console.log(query.text);
-            console.log(query.values);
-        }
-        const result = await this.connection.query<T>(query);
-        if (result.rowCount === 0 || result.rowCount === null)
-            throw new OrmError("No rows returned from query");
-
-        if (result.rowCount > 1)
-            throw new OrmError("More than one row returned from query");
-
-        return result.rows[0];
-    }
-}
-
-export const orm = <
-    Models extends LooseModelDefinitions,
-    Relations extends LooseRelationsDefinitions<Models>,
->(
-    config: Configuration<Models, Relations>,
-): Orm<Models, Relations> => {
-    const populatedSchema = populateConfiguration(config);
-    validateConfiguration(populatedSchema);
-    return new Orm<Models, Relations>(populatedSchema);
-};

package/src/pull/index.ts

@@ -1 +0,0 @@
-export { pull } from "./pull";

package/src/pull/introspect/getForeignKeys.ts

@@ -1,64 +0,0 @@
-import { groupBy } from "lodash-es";
-import pg from "pg";
-
-import { ForeignKey } from "../types/ForeignKey";
-
-export const getForeignKeys = async (
-    client: pg.Client,
-    schema: string,
-): Promise<Record<string, ForeignKey[]>> => {
-    const result = await client.query<ForeignKey>(
-        `
-        SELECT
-        	conname "constraintName",
-        	table_from as "tableFrom",
-        	array_agg(columns_from::text) AS "columnsFrom",
-        	table_to AS "tableTo",
-        	array_agg(columns_to::text) AS "columnsTo"
-        FROM (
-        	SELECT
-        		conname,
-        		conrelid::regclass AS table_from,
-        		a.attname AS columns_from,
-        		confrelid::regclass AS table_to,
-        		af.attname AS columns_to
-        	FROM
-        		pg_attribute AS af,
-        		pg_attribute AS a,
-        		pg_class c,
-        		pg_namespace n,
-        		(
-        			SELECT
-        				conname,
-        				conrelid,
-        				confrelid,
-        				conkey[i] AS conkey,
-        				confkey[i] AS confkey
-        			FROM (
-        				SELECT
-        					conname,
-        					conrelid,
-        					confrelid,
-        					conkey,
-        					confkey,
-        					generate_series(1, array_upper(conkey, 1)) AS i
-        				FROM
-        					pg_constraint
-        				WHERE
-        					contype = 'f') AS ss) AS ss2
-        		WHERE
-        			af.attnum = confkey
-        			AND af.attrelid = confrelid
-        			AND a.attnum = conkey
-        			AND a.attrelid = conrelid
-        			AND af.attrelid = c.oid
-        			AND c.relnamespace = n.oid
-        			AND n.nspname = $1) AS ss3
-        GROUP BY
-        	conname,
-        	table_to,
-        	table_from;`,
-        [schema],
-    );
-    return groupBy(result.rows, "tableFrom");
-};

package/src/pull/introspect/getPrimaryKeys.ts

@@ -1,26 +0,0 @@
-import { groupBy, mapValues, sortBy } from "lodash-es";
-import pg from "pg";
-
-import { sql } from "../../sql";
-import { PrimaryKey } from "../types/PrimaryKey";
-
-export const getPrimaryKeys = async (
-    client: pg.Client,
-    schema: string,
-): Promise<Record<string, string[]>> => {
-    const results = await client.query<PrimaryKey>(
-        sql`select
-             cc.table_name as table,
-             cc.constraint_name as name,
-             cc.column_name as column,
-             cc.ordinal_position as ordinal
-             from information_schema.table_constraints c
-             join information_schema.key_column_usage cc on c.constraint_name = cc.constraint_name and c.constraint_schema = cc.constraint_schema and c.table_name = cc.table_name
-             where c.constraint_type = 'PRIMARY KEY'
-             and c.constraint_schema = ${schema}`,
-    );
-
-    return mapValues(groupBy(results.rows, "table"), (columns) =>
-        sortBy(columns, "ordinal").map((c) => c.column),
-    );
-};