@casekit/orm 0.0.1-alpha.12 → 0.0.1-alpha.13

package/package.json

@@ -1,10 +1,20 @@
 {
   "name": "@casekit/orm",
-  "version": "0.0.1-alpha.12",
+  "version": "0.0.1-alpha.13",
   "description": "A simple ORM",
   "type": "module",
   "main": "lib/index.js",
-  "types": "lib/index.d.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "files": [
+    "./lib/*",
+    "!./lib/**.test.js",
+    "!./lib/**.test.js.map",
+    "!./lib/**.test.d.ts",
+    "!./lib/**.test.d.ts.map"
+  ],
   "keywords": [],
   "author": "",
   "license": "ISC",
@@ -37,7 +47,7 @@
     "object-hash": "^3.0.0",
     "pg": "^8.11.5",
     "pg-format": "^1.0.4",
-    "pino": "^8.20.0",
+    "pino": "^9.0.0",
     "pluralize": "^8.0.0",
     "prettier": "^3.2.5",
     "ts-toolbelt": "^9.6.0",

package/.env

@@ -1,2 +0,0 @@
-PGDATABASE=orm
-PGPASSWORD=password

package/.eslintrc.cjs

@@ -1,69 +0,0 @@
-/** @type {import('eslint').Linter.Config} */
-module.exports = {
-    root: true,
-    parserOptions: {
-        ecmaVersion: "latest",
-        sourceType: "module",
-        ecmaFeatures: {
-            jsx: true,
-        },
-    },
-    env: {
-        browser: true,
-        commonjs: true,
-        es6: true,
-    },
-
-    // Base config
-    extends: ["eslint:recommended"],
-
-    ignorePatterns: ["vitest.config.ts"],
-
-    overrides: [
-        // Typescript
-        {
-            files: ["**/*.{ts,tsx}"],
-            plugins: ["@typescript-eslint", "import"],
-            parser: "@typescript-eslint/parser",
-            parserOptions: {
-                project: "./tsconfig.json",
-                tsconfigRootDir: "./",
-            },
-            settings: {
-                "import/internal-regex": "^~/",
-                "import/resolver": {
-                    node: {
-                        extensions: [".ts", ".tsx"],
-                    },
-                    typescript: {
-                        alwaysTryTypes: true,
-                    },
-                },
-            },
-            extends: [
-                "plugin:@typescript-eslint/recommended",
-                "plugin:import/recommended",
-                "plugin:import/typescript",
-            ],
-            rules: {
-                "@typescript-eslint/no-unused-vars": [
-                    "error",
-                    {
-                        argsIgnorePattern: "^_",
-                        varsIgnorePattern: "^_",
-                        caughtErrorsIgnorePattern: "^_",
-                    },
-                ],
-                "@typescript-eslint/no-floating-promises": "error",
-            },
-        },
-
-        // Node
-        {
-            files: [".eslintrc.cjs"],
-            env: {
-                node: true,
-            },
-        },
-    ],
-};

package/.github/actions/ci-setup/action.yml

@@ -1,19 +0,0 @@
-name: CI setup
-runs:
-    using: composite
-    steps:
-        - uses: pnpm/action-setup@v3
-          name: Install pnpm
-          with:
-              version: 8
-              run_install: false
-
-        - uses: actions/setup-node@v4
-          with:
-              node-version: 21
-              cache: pnpm
-              registry-url: "https://registry.npmjs.org"
-
-        - name: Install dependencies
-          run: pnpm install
-          shell: bash

package/.github/dependabot.yml

@@ -1,12 +0,0 @@
-version: 2
-updates:
-    - package-ecosystem: "npm"
-      directory: "/"
-      open-pull-requests-limit: 25
-      schedule:
-          interval: "daily"
-    - package-ecosystem: "github-actions"
-      directory: "/"
-      open-pull-requests-limit: 25
-      schedule:
-          interval: "daily"

package/.github/workflows/ci.yml

@@ -1,119 +0,0 @@
-name: CI
-on:
-    push:
-        branches: [main]
-    pull_request:
-        branches: [main]
-permissions:
-    contents: write
-
-jobs:
-    test:
-        name: "🧪 Run tests"
-        timeout-minutes: 10
-        runs-on: ubuntu-latest
-        env:
-            PGUSER: casekit
-            PGPASSWORD: password
-            PGDATABASE: orm
-        services:
-            postgres:
-                image: postgres
-                env:
-                    POSTGRES_USER: ${{ env.PGUSER }}
-                    POSTGRES_PASSWORD: ${{ env.PGPASSWORD }}
-                    POSTGRES_DB: ${{ env.PGDATABASE }}
-                options: >-
-                    --health-cmd pg_isready
-                    --health-interval 10s
-                    --health-timeout 5s
-                    --health-retries 5
-                ports:
-                    - 5432:5432
-        steps:
-            - uses: actions/checkout@v4
-            - uses: ./.github/actions/ci-setup
-
-            - name: Run tests
-              run: pnpm test:coverage
-
-            - name: Upload coverage reports to Codecov
-              uses: codecov/codecov-action@v4.3.0
-              if: ${{ github.actor != 'dependabot[bot]' }}
-              with:
-                  token: ${{ secrets.CODECOV_TOKEN }}
-                  slug: casekit/orm
-
-    typecheck:
-        name: "📐 Typecheck"
-        timeout-minutes: 10
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v4
-            - uses: ./.github/actions/ci-setup
-            - name: Typecheck
-              run: pnpm typecheck
-
-    lint:
-        name: "🧹 Run eslint"
-        timeout-minutes: 10
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v4
-            - uses: ./.github/actions/ci-setup
-            - name: Lint
-              run: pnpm lint
-
-    prettier:
-        name: "💅 Run prettier"
-        timeout-minutes: 10
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v4
-            - uses: ./.github/actions/ci-setup
-            - name: Prettier
-              run: pnpm prettier
-
-    publish:
-        name: "🔥 Publish"
-        needs: [test, typecheck, lint, prettier]
-        runs-on: ubuntu-latest
-        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
-        steps:
-            - uses: actions/checkout@v4
-            - name: Set up Git config
-              run: |
-                  git config user.name "$(git log -n 1 --pretty=format:%an)"
-                  git config user.email "$(git log -n 1 --pretty=format:%ae)"
-            - uses: ./.github/actions/ci-setup
-            - name: Build
-              run: pnpm build
-            - name: Version
-              run: pnpm version prerelease --preid=alpha
-            - name: Publish
-              run: pnpm publish
-              env:
-                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-            - name: Push
-              run: git push
-            - name: Push tag
-              run: git push --tags
-
-    dependabot:
-        name: "🤖 Dependabot"
-        needs: [test, typecheck, lint, prettier]
-        runs-on: ubuntu-latest
-        if: ${{ github.actor == 'dependabot[bot]' && github.event_name == 'pull_request'}}
-        steps:
-            - name: Fetch Dependabot metadata
-              id: dependabot-metadata
-              uses: dependabot/fetch-metadata@v2
-              with:
-                  alert-lookup: true
-                  github-token: ${{ secrets.DEPENDABOT_METADATA_PAT }}
-            - name: Enable auto-merge for Dependabot Security Updates
-              run: gh pr merge --auto --squash "$PR_URL"
-              env:
-                  PR_URL: ${{ github.event.pull_request.html_url }}
-                  GITHUB_TOKEN: ${{ secrets.DEPENDABOT_MERGE_PAT }}
-              if: ${{ steps.dependabot-metadata.outputs.cvss != 0 }}

package/.github/workflows/dependabot.yml

@@ -1,26 +0,0 @@
-name: Dependabot
-on:
-    workflow_dispatch: {}
-    schedule:
-        # random HH:MM to avoid a load spike on GitHub Actions at 00:00
-        - cron: 34 2 * * *
-permissions:
-    contents: write
-    statuses: read
-    checks: read
-jobs:
-    merge_prs:
-        name: "Merge PRs > 1 week old"
-        runs-on: ubuntu-latest
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Merge PRs
-              run: |
-                  set -e
-                  # Merge all Dependabot PRs that were created more than a week ago and have all checks passing
-                  for pr in `gh pr list --json number,author,createdAt --search "created:<=$(date -d "2 days ago" +"%Y-%m-%d") author:app/dependabot status:success" --jq '.[].number'`; do
-                      gh pr merge --squash "$pr"
-                  done
-              env:
-                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/semgrep.yml

@@ -1,24 +0,0 @@
-on:
-  workflow_dispatch: {}
-  pull_request: {}
-  push:
-    branches:
-    - main
-    - master
-    paths:
-    - .github/workflows/semgrep.yml
-  schedule:
-  # random HH:MM to avoid a load spike on GitHub Actions at 00:00
-  - cron: 53 8 * * *
-name: Semgrep
-jobs:
-  semgrep:
-    name: semgrep/ci
-    runs-on: ubuntu-20.04
-    env:
-      SEMGREP_APP_TOKEN: ${{ secrets.SEMGREP_APP_TOKEN }}
-    container:
-      image: returntocorp/semgrep
-    steps:
-    - uses: actions/checkout@v4
-    - run: semgrep ci

package/.prettierrc.cjs

@@ -1,11 +0,0 @@
-module.exports = {
-    printWidth: 80,
-    tabWidth: 4,
-    trailingComma: "all",
-    singleQuote: false,
-    semi: true,
-    importOrder: ["^@casekit/(.*)$", "^[^.](.*)$", "^[./]"],
-    importOrderSeparation: true,
-    importOrderSortSpecifiers: true,
-    plugins: ["@trivago/prettier-plugin-sort-imports"],
-};

package/.vscode/tasks.json

@@ -1,28 +0,0 @@
-{
-    "version": "2.0.0",
-    "tasks": [
-        {
-            "type": "npm",
-            "script": "build",
-            "group": "build",
-            "problemMatcher": [],
-            "label": "npm: build",
-            "detail": "rm -rf lib && tsc"
-        },
-        {
-            "type": "npm",
-            "script": "check:all",
-            "problemMatcher": [],
-            "label": "npm: check:all",
-            "detail": "CI=true pnpm test && CI=true pnpm lint && CI=true pnpm prettier && CI=true pnpm typecheck"
-        },
-        {
-            "type": "npm",
-            "script": "build",
-            "group": "build",
-            "problemMatcher": [],
-            "label": "npm: build",
-            "detail": "rm -rf lib && tsc"
-        }
-    ]
-}

package/codecov.yml

@@ -1,7 +0,0 @@
-coverage:
-  status:
-    changes: off
-    patch: off
-    project:
-      default:
-        informational: true

package/lib/orm.query.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=orm.query.test.d.ts.map

package/lib/orm.query.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"orm.query.test.d.ts","sourceRoot":"","sources":["../src/orm.query.test.ts"],"names":[],"mappings":""}

package/lib/orm.query.test.js

@@ -1,22 +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 `
-                    select count(1)::int as total from casekit.post;
-                `;
-            expect(result[0]).toEqual({ total: 6 });
-        }, { rollback: true });
-    });
-});
-//# sourceMappingURL=orm.query.test.js.map

package/lib/orm.query.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"orm.query.test.js","sourceRoot":"","sources":["../src/orm.query.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEhD,OAAO,EAAE,EAAE,EAAE,MAAM,WAAW,CAAC;AAC/B,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAEnC,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACvB,IAAI,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,EAAE,CAAC,QAAQ,CACb,KAAK,EAAE,EAAE,EAAE,EAAE;YACT,MAAM,IAAI,CAAC,EAAE,EAAE;gBACX,KAAK,EAAE;oBACH;wBACI,QAAQ,EAAE,SAAS;wBACnB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;qBAC/C;iBACJ;aACJ,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,KAAK,CAAmB;;iBAE/C,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAC5C,CAAC,EACD,EAAE,QAAQ,EAAE,IAAI,EAAE,CACrB,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/src/Connection.ts

@@ -1,65 +0,0 @@
-import pg, { QueryResultRow } from "pg";
-import pgfmt from "pg-format";
-import * as uuid from "uuid";
-
-import { SQLStatement } from "./sql";
-
-export class Connection {
-    constructor(
-        private pool: pg.Pool,
-        private client?: pg.PoolClient,
-    ) {}
-
-    public query = async <T extends QueryResultRow>(query: SQLStatement) => {
-        if (this.client) {
-            return this.client.query<T>(query);
-        } else {
-            return this.pool.query(query);
-        }
-    };
-
-    public transact = async <T>(
-        fn: (conn: Connection) => Promise<T>,
-        { rollback = false }: { rollback?: boolean } = {},
-    ) => {
-        if (this.client) {
-            const savepoint = uuid.v4();
-            try {
-                await this.client.query(pgfmt("SAVEPOINT %I", savepoint));
-                const result = await fn(this);
-                if (rollback) {
-                    await this.client.query(
-                        pgfmt("ROLLBACK TO SAVEPOINT %I", savepoint),
-                    );
-                } else {
-                    await this.client.query(
-                        pgfmt("RELEASE SAVEPOINT %I", savepoint),
-                    );
-                }
-                return result;
-            } catch (e) {
-                await this.client.query(
-                    pgfmt("ROLLBACK TO SAVEPOINT %I", savepoint),
-                );
-                throw e;
-            }
-        } else {
-            const client = await this.pool.connect();
-            try {
-                await client.query("BEGIN");
-                const result = await fn(new Connection(this.pool, client));
-                if (rollback) {
-                    await client.query("ROLLBACK");
-                } else {
-                    await client.query("COMMIT");
-                }
-                return result;
-            } catch (e) {
-                await client.query("ROLLBACK");
-                throw e;
-            } finally {
-                client.release();
-            }
-        }
-    };
-}

package/src/errors.ts

@@ -1,18 +0,0 @@
-import { BaseModel } from "./schema/types/base/BaseModel";
-
-type OrmErrorMeta = {
-    model?: [string, BaseModel];
-    data?: Record<string, unknown>;
-};
-
-export class OrmError extends Error {
-    meta: OrmErrorMeta | undefined;
-
-    constructor(message: string, meta?: OrmErrorMeta) {
-        super();
-        this.message = message;
-        this.meta = meta;
-    }
-}
-
-export class InvalidModelDefinitionError extends OrmError {}

package/src/index.ts

@@ -1,16 +0,0 @@
-export { OrmError } from "./errors";
-export { migrator, type Migrator } from "./migrate";
-export { Orm, orm } from "./orm";
-export { pull } from "./pull";
-export * from "./queries/clauses/where/operators";
-export { type Middleware } from "./queries/middleware/Middleware";
-/**
- * TODO find a way to use the strict definitions here
- * without destroying VS Code autocomplete performance
- */
-export { type LooseModelDefinition as ModelDefinition } from "./schema/types/loose/LooseModelDefinition";
-export { type LooseRelationsDefinition as RelationsDefinition } from "./schema/types/loose/LooseRelationsDefinition";
-export { SQLStatement, sql } from "./sql";
-export type { ColumnName } from "./types/ColumnName";
-export type { ColumnType } from "./types/ColumnType";
-export type { ModelType } from "./types/ModelType";

package/src/logger.ts

@@ -1,3 +0,0 @@
-import pino from "pino";
-
-export const logger = pino({ enabled: process.env.NODE_ENV !== "test" });

package/src/migrate/commands/implode.ts

@@ -1,46 +0,0 @@
-import { BaseOrm } from "../../schema/types/base/BaseOrm";
-import { SQLStatement } from "../../sql";
-import { createExtensionsSql } from "../sql/createExtensionsSql";
-import { createForeignKeyConstraintSql } from "../sql/createForeignKeyConstraintSql";
-import { createSchemasSql } from "../sql/createSchemasSql";
-import { createTableSql } from "../sql/createTableSql";
-import { createUniqueConstraintSql } from "../sql/createUniqueConstraintSql";
-import { dropSchemasSql } from "../sql/dropSchemasSql";
-
-export const implode = async (
-    db: BaseOrm,
-    { dryRun, output }: { dryRun: boolean; output: boolean },
-) => {
-    const statement = new SQLStatement();
-
-    statement.push(dropSchemasSql(db), "\n");
-    statement.push(createSchemasSql(db), "\n");
-    statement.push(createExtensionsSql(db), "\n");
-
-    for (const model of Object.values(db.models)) {
-        statement.push(createTableSql(model), "\n");
-        for (const constraint of model.uniqueConstraints) {
-            statement.push(createUniqueConstraintSql(model, constraint), "\n");
-        }
-    }
-
-    for (const model of Object.values(db.models)) {
-        for (const foreignKey of model.foreignKeys) {
-            statement.push(
-                createForeignKeyConstraintSql(model, foreignKey),
-                "\n",
-            );
-        }
-    }
-
-    if (output || process.env.ORM_VERBOSE_LOGGING) console.log(statement.text);
-
-    if (!dryRun) {
-        try {
-            await db.connection.query(statement);
-        } catch (e) {
-            console.log(e);
-            throw e;
-        }
-    }
-};

package/src/migrate/index.ts

@@ -1 +0,0 @@
-export { type Migrator, migrator } from "./migrator";

package/src/migrate/migrator.ts

@@ -1,24 +0,0 @@
-import { Orm } from "..";
-import { BaseOrm } from "../schema/types/base/BaseOrm";
-import { LooseModelDefinitions } from "../schema/types/loose/LooseModelDefinitions";
-import { LooseRelationsDefinitions } from "../schema/types/loose/LooseRelationsDefinitions";
-import { implode } from "./commands/implode";
-
-export class Migrator {
-    public db: BaseOrm;
-
-    constructor(db: BaseOrm) {
-        this.db = db;
-    }
-
-    public async implode(opts = { dryRun: true, output: true }) {
-        await implode(this.db, opts);
-    }
-}
-
-export const migrator = <
-    Models extends LooseModelDefinitions,
-    Relations extends LooseRelationsDefinitions<Models>,
->(
-    db: Orm<Models, Relations>,
-) => new Migrator(db as BaseOrm);

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

@@ -1,26 +0,0 @@
-import { unindent } from "@casekit/unindent";
-
-import pg from "pg";
-import { describe, expect, test } from "vitest";
-
-import { orm } from "../../orm";
-import { createExtensionsSql } from "./createExtensionsSql";
-
-describe("createExtensionsSql", () => {
-    test("it generates a CREATE EXTENSION command for each extension", () => {
-        const db = orm({
-            extensions: ["uuid-ossp", "postgis"],
-            models: {},
-            pool: new pg.Pool(),
-        });
-        expect(createExtensionsSql(db)?.text).toEqual(unindent`
-            CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
-            CREATE EXTENSION IF NOT EXISTS postgis;
-        `);
-    });
-
-    test("if no extensions are specified, it returns null", () => {
-        const db = orm({ models: {}, pool: new pg.Pool() });
-        expect(createExtensionsSql(db)).toEqual(null);
-    });
-});

package/src/migrate/sql/createExtensionsSql.ts

@@ -1,16 +0,0 @@
-import pgfmt from "pg-format";
-
-import { BaseOrm } from "../../schema/types/base/BaseOrm";
-import { SQLStatement } from "../../sql";
-
-export const createExtensionsSql = (db: BaseOrm): SQLStatement | null => {
-    if (db.config.extensions?.length === 0) return null;
-
-    return (
-        new SQLStatement(
-            db.config.extensions
-                ?.map((e) => pgfmt("CREATE EXTENSION IF NOT EXISTS %I;", e))
-                .join("\n"),
-        ) ?? null
-    );
-};

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

@@ -1,50 +0,0 @@
-import { unindent } from "@casekit/unindent";
-
-import pg from "pg";
-import { describe, expect, test } from "vitest";
-
-import { ModelDefinition, orm, sql } from "../../";
-import { createForeignKeyConstraintSql } from "./createForeignKeyConstraintSql";
-
-describe("createForeignKeyConstraintSql", () => {
-    test("it generates an ALTER TABLE command for the specified foreign key constraint", () => {
-        const foo = {
-            schema: "casekit",
-            columns: {
-                id: { type: "uuid" },
-                barId: {
-                    name: "bar_id",
-                    type: "uuid",
-                    references: { table: "bar", column: "id" },
-                },
-                bazId: {
-                    name: "baz_id",
-                    type: "uuid",
-                    references: { table: "baz", column: "id" },
-                },
-            },
-            foreignKeys: [
-                {
-                    columns: ["bar_id", "baz_id"],
-                    references: {
-                        table: "quux",
-                        columns: ["bar_id", "baz_id"],
-                    },
-                    onUpdate: sql`CASCADE`,
-                },
-            ],
-        } as const satisfies ModelDefinition;
-
-        const db = orm({ models: { foo }, pool: new pg.Pool() });
-
-        const result = db.models.foo.foreignKeys
-            .map((fk) => createForeignKeyConstraintSql(db.models.foo, fk).text)
-            .join("\n");
-
-        expect(result).toEqual(unindent`
-             ALTER TABLE casekit.foo ADD CONSTRAINT foo_bar_id_baz_id_fkey FOREIGN KEY (bar_id, baz_id) REFERENCES casekit.quux (bar_id, baz_id) ON UPDATE CASCADE;
-             ALTER TABLE casekit.foo ADD CONSTRAINT foo_bar_id_fkey FOREIGN KEY (bar_id) REFERENCES casekit.bar (id);
-             ALTER TABLE casekit.foo ADD CONSTRAINT foo_baz_id_fkey FOREIGN KEY (baz_id) REFERENCES casekit.baz (id);
-        `);
-    });
-});