@simplysm/orm-common 13.0.69 → 13.0.70

package/tests/ddl/table-builder.spec.ts

@@ -0,0 +1,433 @@
+import { describe, expect, it } from "vitest";
+import { createTestDb } from "../setup/TestDbContext";
+import { Table } from "../../src/schema/table-builder";
+import { createQueryBuilder } from "../../src/query-builder/query-builder";
+import { dialects } from "../setup/test-utils";
+import "../setup/test-utils"; // toMatchSql matcher
+import * as expected from "./table-builder.expected";
+
+describe("DDL - Table Builder", () => {
+  describe("basic table (name only)", () => {
+    const table = Table("User");
+
+    it("should validate metadata", () => {
+      expect(table.meta).toEqual({
+        name: "User",
+        description: undefined,
+        database: undefined,
+        schema: undefined,
+        columns: undefined,
+        primaryKey: undefined,
+        relations: undefined,
+        indexes: undefined,
+      });
+    });
+  });
+
+  describe("description specified", () => {
+    const table = Table("User").description("User table");
+
+    it("should validate metadata", () => {
+      expect(table.meta).toEqual({
+        name: "User",
+        description: "User table",
+        database: undefined,
+        schema: undefined,
+        columns: undefined,
+        primaryKey: undefined,
+        relations: undefined,
+        indexes: undefined,
+      });
+    });
+  });
+
+  describe("database specified", () => {
+    const table = Table("User").database("CustomDb");
+
+    it("should validate metadata", () => {
+      expect(table.meta).toEqual({
+        name: "User",
+        description: undefined,
+        database: "CustomDb",
+        schema: undefined,
+        columns: undefined,
+        primaryKey: undefined,
+        relations: undefined,
+        indexes: undefined,
+      });
+    });
+  });
+
+  describe("schema specified", () => {
+    const table = Table("User").schema("CustomSchema");
+
+    it("should validate metadata", () => {
+      expect(table.meta).toEqual({
+        name: "User",
+        description: undefined,
+        database: undefined,
+        schema: "CustomSchema",
+        columns: undefined,
+        primaryKey: undefined,
+        relations: undefined,
+        indexes: undefined,
+      });
+    });
+  });
+
+  describe("columns specified (single column)", () => {
+    const table = Table("User").columns((c) => ({ id: c.bigint() }));
+
+    it("should validate metadata", () => {
+      expect(table.meta.name).toBe("User");
+      expect(table.meta.columns).toBeDefined();
+      expect(Object.keys(table.meta.columns!)).toEqual(["id"]);
+      expect(table.meta.columns!.id.meta.dataType).toEqual({ type: "bigint" });
+    });
+  });
+
+  describe("columns specified (multiple columns)", () => {
+    const table = Table("User").columns((c) => ({
+      id: c.bigint(),
+      name: c.varchar(100),
+      email: c.varchar(200),
+    }));
+
+    it("should validate metadata", () => {
+      expect(table.meta.name).toBe("User");
+      expect(table.meta.columns).toBeDefined();
+      expect(Object.keys(table.meta.columns!)).toEqual(["id", "name", "email"]);
+      expect(table.meta.columns!.id.meta.dataType).toEqual({ type: "bigint" });
+      expect(table.meta.columns!.name.meta.dataType).toEqual({ type: "varchar", length: 100 });
+      expect(table.meta.columns!.email.meta.dataType).toEqual({ type: "varchar", length: 200 });
+    });
+  });
+
+  describe("primaryKey specified (single key)", () => {
+    const User = Table("User")
+      .database("TestDb")
+      .schema("TestSchema")
+      .columns((c) => ({ id: c.bigint() }))
+      .primaryKey("id");
+
+    const db = createTestDb();
+    const def = db.getCreateTableQueryDef(User);
+
+    it("should validate QueryDef", () => {
+      expect(def).toEqual({
+        type: "createTable",
+        table: { database: "TestDb", schema: "TestSchema", name: "User" },
+        columns: [
+          {
+            name: "id",
+            dataType: { type: "bigint" },
+            autoIncrement: undefined,
+            nullable: undefined,
+            default: undefined,
+          },
+        ],
+        primaryKey: ["id"],
+      });
+    });
+
+    it.each(dialects)("[%s] should validate SQL", (dialect) => {
+      const builder = createQueryBuilder(dialect);
+      expect(builder.build(def)).toMatchSql(expected.singlePrimaryKey[dialect]);
+    });
+  });
+
+  describe("primaryKey specified (composite key)", () => {
+    const Order = Table("Order")
+      .database("TestDb")
+      .schema("TestSchema")
+      .columns((c) => ({
+        userId: c.bigint(),
+        productId: c.bigint(),
+        quantity: c.int(),
+      }))
+      .primaryKey("userId", "productId");
+
+    const db = createTestDb();
+    const def = db.getCreateTableQueryDef(Order);
+
+    it("should validate QueryDef", () => {
+      expect(def).toEqual({
+        type: "createTable",
+        table: { database: "TestDb", schema: "TestSchema", name: "Order" },
+        columns: [
+          {
+            name: "userId",
+            dataType: { type: "bigint" },
+            autoIncrement: undefined,
+            nullable: undefined,
+            default: undefined,
+          },
+          {
+            name: "productId",
+            dataType: { type: "bigint" },
+            autoIncrement: undefined,
+            nullable: undefined,
+            default: undefined,
+          },
+          {
+            name: "quantity",
+            dataType: { type: "int" },
+            autoIncrement: undefined,
+            nullable: undefined,
+            default: undefined,
+          },
+        ],
+        primaryKey: ["userId", "productId"],
+      });
+    });
+
+    it.each(dialects)("[%s] should validate SQL", (dialect) => {
+      const builder = createQueryBuilder(dialect);
+      expect(builder.build(def)).toMatchSql(expected.compositePrimaryKey[dialect]);
+    });
+  });
+
+  describe("indexes specified (single index)", () => {
+    const User = Table("User")
+      .columns((c) => ({
+        id: c.bigint(),
+        email: c.varchar(200),
+      }))
+      .primaryKey("id")
+      .indexes((i) => [i.index("email")]);
+
+    it("should validate metadata", () => {
+      expect(User.meta.indexes).toBeDefined();
+      expect(User.meta.indexes!.length).toBe(1);
+      expect(User.meta.indexes![0].meta.columns).toEqual(["email"]);
+    });
+  });
+
+  describe("indexes specified (multiple indexes)", () => {
+    const User = Table("User")
+      .columns((c) => ({
+        id: c.bigint(),
+        email: c.varchar(200),
+        name: c.varchar(100),
+        age: c.int(),
+      }))
+      .primaryKey("id")
+      .indexes((i) => [i.index("email"), i.index("name", "age")]);
+
+    it("should validate metadata", () => {
+      expect(User.meta.indexes).toBeDefined();
+      expect(User.meta.indexes!.length).toBe(2);
+      expect(User.meta.indexes![0].meta.columns).toEqual(["email"]);
+      expect(User.meta.indexes![1].meta.columns).toEqual(["name", "age"]);
+    });
+  });
+
+  describe("indexes specified (unique index)", () => {
+    const User = Table("User")
+      .columns((c) => ({
+        id: c.bigint(),
+        email: c.varchar(200),
+      }))
+      .primaryKey("id")
+      .indexes((i) => [i.index("email").unique()]);
+
+    it("should validate metadata", () => {
+      expect(User.meta.indexes).toBeDefined();
+      expect(User.meta.indexes!.length).toBe(1);
+      expect(User.meta.indexes![0].meta.columns).toEqual(["email"]);
+      expect(User.meta.indexes![0].meta.unique).toBe(true);
+    });
+  });
+
+  describe("relations specified (foreignKey)", () => {
+    const Company = Table("Company")
+      .columns((c) => ({ id: c.bigint() }))
+      .primaryKey("id");
+
+    const User = Table("User")
+      .columns((c) => ({
+        id: c.bigint(),
+        companyId: c.bigint(),
+      }))
+      .primaryKey("id")
+      .relations((r) => ({
+        company: r.foreignKey(["companyId"], () => Company),
+      }));
+
+    it("should validate metadata", () => {
+      expect(User.meta.relations).toBeDefined();
+      expect(Object.keys(User.meta.relations!)).toEqual(["company"]);
+      expect(User.meta.relations!.company.meta.columns).toEqual(["companyId"]);
+      expect(User.meta.relations!.company.meta.targetFn).toBeDefined();
+    });
+  });
+
+  describe("combined options 1 (database + schema + description)", () => {
+    const User = Table("User")
+      .database("TestDb")
+      .schema("TestSchema")
+      .description("User table")
+      .columns((c) => ({
+        id: c.bigint(),
+        name: c.varchar(100),
+      }))
+      .primaryKey("id");
+
+    const db = createTestDb();
+    const def = db.getCreateTableQueryDef(User);
+
+    it("should validate QueryDef", () => {
+      expect(def).toEqual({
+        type: "createTable",
+        table: { database: "TestDb", schema: "TestSchema", name: "User" },
+        columns: [
+          {
+            name: "id",
+            dataType: { type: "bigint" },
+            autoIncrement: undefined,
+            nullable: undefined,
+            default: undefined,
+          },
+          {
+            name: "name",
+            dataType: { type: "varchar", length: 100 },
+            autoIncrement: undefined,
+            nullable: undefined,
+            default: undefined,
+          },
+        ],
+        primaryKey: ["id"],
+      });
+    });
+
+    it.each(dialects)("[%s] should validate SQL", (dialect) => {
+      const builder = createQueryBuilder(dialect);
+      expect(builder.build(def)).toMatchSql(expected.complexOptions1[dialect]);
+    });
+  });
+
+  describe("combined options 2 (columns + PK + indexes)", () => {
+    const User = Table("User")
+      .database("TestDb")
+      .schema("TestSchema")
+      .columns((c) => ({
+        id: c.bigint(),
+        email: c.varchar(200),
+        name: c.varchar(100),
+      }))
+      .primaryKey("id")
+      .indexes((i) => [i.index("email").unique()]);
+
+    it("should validate metadata", () => {
+      expect(User.meta.database).toBe("TestDb");
+      expect(User.meta.schema).toBe("TestSchema");
+      expect(Object.keys(User.meta.columns!)).toEqual(["id", "email", "name"]);
+      expect(User.meta.primaryKey).toEqual(["id"]);
+      expect(User.meta.indexes!.length).toBe(1);
+      expect(User.meta.indexes![0].meta.unique).toBe(true);
+    });
+  });
+
+  describe("combined options 3 (various column types)", () => {
+    const Product = Table("Product")
+      .database("TestDb")
+      .schema("TestSchema")
+      .description("Product table")
+      .columns((c) => ({
+        id: c.bigint().autoIncrement(),
+        name: c.varchar(200),
+        price: c.decimal(10, 2),
+        stock: c.int().default(0),
+        isActive: c.boolean().default(true),
+        description: c.text().nullable(),
+        createdAt: c.datetime(),
+      }))
+      .primaryKey("id");
+
+    const db = createTestDb();
+    const def = db.getCreateTableQueryDef(Product);
+
+    it("should validate QueryDef", () => {
+      expect(def).toEqual({
+        type: "createTable",
+        table: { database: "TestDb", schema: "TestSchema", name: "Product" },
+        columns: [
+          {
+            name: "id",
+            dataType: { type: "bigint" },
+            autoIncrement: true,
+            nullable: undefined,
+            default: undefined,
+          },
+          {
+            name: "name",
+            dataType: { type: "varchar", length: 200 },
+            autoIncrement: undefined,
+            nullable: undefined,
+            default: undefined,
+          },
+          {
+            name: "price",
+            dataType: { type: "decimal", precision: 10, scale: 2 },
+            autoIncrement: undefined,
+            nullable: undefined,
+            default: undefined,
+          },
+          {
+            name: "stock",
+            dataType: { type: "int" },
+            autoIncrement: undefined,
+            nullable: undefined,
+            default: 0,
+          },
+          {
+            name: "isActive",
+            dataType: { type: "boolean" },
+            autoIncrement: undefined,
+            nullable: undefined,
+            default: true,
+          },
+          {
+            name: "description",
+            dataType: { type: "text" },
+            autoIncrement: undefined,
+            nullable: true,
+            default: undefined,
+          },
+          {
+            name: "createdAt",
+            dataType: { type: "datetime" },
+            autoIncrement: undefined,
+            nullable: undefined,
+            default: undefined,
+          },
+        ],
+        primaryKey: ["id"],
+      });
+    });
+
+    it.each(dialects)("[%s] should validate SQL", (dialect) => {
+      const builder = createQueryBuilder(dialect);
+      expect(builder.build(def)).toMatchSql(expected.complexOptions3[dialect]);
+    });
+  });
+
+  describe("method chaining order", () => {
+    // Same result even with different method chaining order
+    const table1 = Table("User")
+      .columns((c) => ({ id: c.bigint() }))
+      .database("TestDb")
+      .schema("TestSchema")
+      .primaryKey("id");
+
+    const table2 = Table("User")
+      .database("TestDb")
+      .schema("TestSchema")
+      .columns((c) => ({ id: c.bigint() }))
+      .primaryKey("id");
+
+    it("should validate metadata consistency", () => {
+      expect(table1.meta).toEqual(table2.meta);
+    });
+  });
+});

package/tests/ddl/view-builder.expected.ts

@@ -0,0 +1,38 @@
+import { mysql, pgsql, tsql } from "@simplysm/core-common";
+import type { ExpectedSql } from "../setup/test-utils";
+
+export const queryBasic: ExpectedSql = {
+  mysql: mysql`
+    CREATE OR REPLACE VIEW \`TestDb\`.\`TestView\` AS
+    SELECT \`T1\`.\`id\` AS \`id\`, \`T1\`.\`name\` AS \`name\`
+    FROM \`TestDb\`.\`User\` AS \`T1\`
+  `,
+  mssql: tsql`
+    CREATE OR ALTER VIEW [TestDb].[TestSchema].[TestView] AS
+    SELECT [T1].[id] AS [id], [T1].[name] AS [name]
+    FROM [TestDb].[TestSchema].[User] AS [T1]
+  `,
+  postgresql: pgsql`
+    CREATE OR REPLACE VIEW "TestSchema"."TestView" AS
+    SELECT "T1"."id" AS "id", "T1"."name" AS "name"
+    FROM "TestSchema"."User" AS "T1"
+  `,
+};
+
+export const combined: ExpectedSql = {
+  mysql: mysql`
+    CREATE OR REPLACE VIEW \`CustomDb\`.\`TestView\` AS
+    SELECT \`T1\`.\`id\` AS \`id\`, \`T1\`.\`email\` AS \`email\`
+    FROM \`TestDb\`.\`User\` AS \`T1\`
+  `,
+  mssql: tsql`
+    CREATE OR ALTER VIEW [CustomDb].[CustomSchema].[TestView] AS
+    SELECT [T1].[id] AS [id], [T1].[email] AS [email]
+    FROM [TestDb].[TestSchema].[User] AS [T1]
+  `,
+  postgresql: pgsql`
+    CREATE OR REPLACE VIEW "CustomSchema"."TestView" AS
+    SELECT "T1"."id" AS "id", "T1"."email" AS "email"
+    FROM "TestSchema"."User" AS "T1"
+  `,
+};

package/tests/ddl/view-builder.spec.ts

@@ -0,0 +1,176 @@
+import { describe, expect, it } from "vitest";
+import { createTestDb, type TestDbContext } from "../setup/TestDbContext";
+import { View } from "../../src/schema/view-builder";
+import { createQueryBuilder } from "../../src/query-builder/query-builder";
+import { dialects } from "../setup/test-utils";
+import "../setup/test-utils"; // toMatchSql matcher
+import * as expected from "./view-builder.expected";
+
+describe("DDL - View Builder", () => {
+  describe("basic view (name only)", () => {
+    const view = View("TestView");
+
+    it("should validate metadata", () => {
+      expect(view.meta).toEqual({
+        name: "TestView",
+        description: undefined,
+        database: undefined,
+        schema: undefined,
+        viewFn: undefined,
+        relations: undefined,
+      });
+    });
+  });
+
+  describe("description specified", () => {
+    const view = View("TestView").description("This is a test view");
+
+    it("should validate metadata", () => {
+      expect(view.meta).toEqual({
+        name: "TestView",
+        description: "This is a test view",
+        database: undefined,
+        schema: undefined,
+        viewFn: undefined,
+        relations: undefined,
+      });
+    });
+  });
+
+  describe("database specified", () => {
+    const view = View("TestView").database("CustomDb");
+
+    it("should validate metadata", () => {
+      expect(view.meta).toEqual({
+        name: "TestView",
+        description: undefined,
+        database: "CustomDb",
+        schema: undefined,
+        viewFn: undefined,
+        relations: undefined,
+      });
+    });
+  });
+
+  describe("schema specified", () => {
+    const view = View("TestView").schema("CustomSchema");
+
+    it("should validate metadata", () => {
+      expect(view.meta).toEqual({
+        name: "TestView",
+        description: undefined,
+        database: undefined,
+        schema: "CustomSchema",
+        viewFn: undefined,
+        relations: undefined,
+      });
+    });
+  });
+
+  describe("query specified (basic SELECT)", () => {
+    const view = View("TestView").query((db: TestDbContext) =>
+      db.user().select((u) => ({
+        id: u.id,
+        name: u.name,
+      })),
+    );
+
+    it("should validate metadata", () => {
+      expect(view.meta.name).toBe("TestView");
+      expect(view.meta.viewFn).toBeTypeOf("function");
+    });
+
+    const db = createTestDb();
+    const def = db.getCreateViewQueryDef(view);
+
+    it("should validate QueryDef", () => {
+      expect(def).toEqual({
+        type: "createView",
+        view: { database: "TestDb", schema: "TestSchema", name: "TestView" },
+        queryDef: {
+          type: "select",
+          from: { database: "TestDb", schema: "TestSchema", name: "User" },
+          as: "T1",
+          select: {
+            id: { type: "column", path: ["T1", "id"] },
+            name: { type: "column", path: ["T1", "name"] },
+          },
+        },
+      });
+    });
+
+    it.each(dialects)("[%s] should validate SQL", (dialect) => {
+      const builder = createQueryBuilder(dialect);
+      expect(builder.build(def)).toMatchSql(expected.queryBasic[dialect]);
+    });
+  });
+
+  describe("combined options (database + schema + description + query)", () => {
+    const view = View("TestView")
+      .database("CustomDb")
+      .schema("CustomSchema")
+      .description("Combined options view")
+      .query((db: TestDbContext) =>
+        db.user().select((u) => ({
+          id: u.id,
+          email: u.email,
+        })),
+      );
+
+    it("should validate metadata", () => {
+      expect(view.meta.name).toBe("TestView");
+      expect(view.meta.database).toBe("CustomDb");
+      expect(view.meta.schema).toBe("CustomSchema");
+      expect(view.meta.description).toBe("Combined options view");
+      expect(view.meta.viewFn).toBeTypeOf("function");
+    });
+
+    const db = createTestDb();
+    const def = db.getCreateViewQueryDef(view);
+
+    it("should validate QueryDef", () => {
+      expect(def).toEqual({
+        type: "createView",
+        view: { database: "CustomDb", schema: "CustomSchema", name: "TestView" },
+        queryDef: {
+          type: "select",
+          from: { database: "TestDb", schema: "TestSchema", name: "User" },
+          as: "T1",
+          select: {
+            id: { type: "column", path: ["T1", "id"] },
+            email: { type: "column", path: ["T1", "email"] },
+          },
+        },
+      });
+    });
+
+    it.each(dialects)("[%s] should validate SQL", (dialect) => {
+      const builder = createQueryBuilder(dialect);
+      expect(builder.build(def)).toMatchSql(expected.combined[dialect]);
+    });
+  });
+
+  describe("relations specified", () => {
+    const Company = View("Company").query((db: TestDbContext) =>
+      db.company().select((c) => ({ id: c.id })),
+    );
+
+    const view = View("TestView")
+      .query((db: TestDbContext) =>
+        db.user().select((u) => ({
+          id: u.id,
+          name: u.name,
+          companyId: u.companyId,
+        })),
+      )
+      .relations((r) => ({
+        company: r.relationKey(["companyId"], () => Company),
+      }));
+
+    it("should validate metadata", () => {
+      expect(view.meta.name).toBe("TestView");
+      expect(view.meta.relations).toBeDefined();
+      expect(view.meta.relations?.["company"]).toBeDefined();
+    });
+  });
+});