dsqlbase 0.0.1 → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,27 @@
+# dsqlbase
+
+## 0.1.1
+
+### Patch Changes
+
+- 57c5e9e: connector session factories
+- 4f4ecdd: internal packages restructure
+  - @dsqlbase/core@0.1.1
+
+## 0.1.0
+
+### Minor Changes
+
+- 66d5d93: **Query client and schema migration runner:**
+
+  Added:
+  - schema objects definition support for `namespace`, `table`, `domain`, and `sequence`;
+  - schema migrations runner via introspection -> reconcile;
+  - model client with crud operations factories for `create`, `findOne`, `findMany`, `update`, `delete`;
+  - sql tag with filter expressions, `sql.in, sql.eq, ...`;
+
+### Patch Changes
+
+- @dsqlbase/client@0.1.0
+- @dsqlbase/core@0.1.0
+- @dsqlbase/schema@0.1.0

package/README.md

@@ -0,0 +1,86 @@
+<div align="center">
+  <h3><strong>dsqlbase</strong></h3>
+  <p>Schema, query, and migration toolkit for AWS Aurora DSQL.</p>
+</div>
+
+---
+
+> [!CAUTION]
+> dsqlbase is in early-stage development and not suited for production environments.
+> Features may change at any time, without prior notice.
+
+dsqlbase is an ORM and migration toolkit purpose-built for [Aurora DSQL](https://aws.amazon.com/rds/aurora/dsql/). It treats DSQL's distributed-database constraints (no foreign keys, no in-place column changes, async-only index builds, etc.) as first-class — refusing unsupported DDL up front and emitting DSQL-shaped SQL by default. See the [project README](https://github.com/slsdotdev/dsqlbase#readme) for the longer motivation.
+
+## Install
+
+```bash
+npm install dsqlbase
+```
+
+## Quickstart
+
+```ts
+// schema.ts
+import { table, uuid, text, datetime, relations, hasMany, belongsTo } from "dsqlbase/schema";
+
+export const teams = table("teams", {
+  id: uuid("id").primaryKey().defaultRandom(),
+  name: text("name").notNull(),
+  createdAt: datetime("created_at").notNull().defaultNow(),
+});
+
+export const projects = table("projects", {
+  id: uuid("id").primaryKey().defaultRandom(),
+  teamId: uuid("team_id").notNull(),
+  name: text("name").notNull(),
+});
+
+export const teamRelations = relations(teams, {
+  projects: hasMany(projects, {
+    from: [teams.columns.id],
+    to: [projects.columns.teamId],
+  }),
+});
+
+export const projectRelations = relations(projects, {
+  team: belongsTo(teams, {
+    from: [projects.columns.teamId],
+    to: [teams.columns.id],
+  }),
+});
+```
+
+```ts
+// client.ts
+import { createClient, type Session, type SQLStatement } from "dsqlbase";
+import * as schema from "./schema";
+import { Pool } from "pg";
+
+const pool = new Pool({ connectionString: process.env.DATABASE_URL });
+
+const session: Session = {
+  async execute<T = unknown>(query: SQLStatement): Promise<T[]> {
+    const result = await pool.query(query.text, [...query.params]);
+    return result.rows as T[];
+  },
+};
+
+export const dsql = createClient({ schema, session });
+
+// Use it
+const recent = await dsql.projects.findMany({
+  orderBy: { name: "asc" },
+  limit: 10,
+  join: { team: true },
+});
+```
+
+## Links
+
+- [Repository & full docs](https://github.com/slsdotdev/dsqlbase#readme)
+- [Issues](https://github.com/slsdotdev/dsqlbase/issues)
+- [Contributing](https://github.com/slsdotdev/dsqlbase/blob/main/CONTRIBUTING.md)
+
+## License
+
+MIT.

package/dist/client/create.d.ts

@@ -0,0 +1,73 @@
+import { DefinitionSchema, Session } from "@dsqlbase/core";
+import { QueryClient } from "./database/index.js";
+export interface ClientOptions<TSchema extends DefinitionSchema> {
+    /**
+     * Definition schema for the database, including relations configuration.
+     */
+    schema: TSchema;
+    /**
+     * Session object for managing database connections and transactions.
+     */
+    session: Session;
+}
+/**
+ * Creates a new client instance for interacting with the database using the provided schema definition.
+ *
+ * @example
+ * ```ts
+ * // schema.ts
+ * import { table, text, uuid } from "@dsqlbase/schema";
+ *
+ * export const users = table("users", {
+ *   id: uuid("id").primaryKey().defaultRandom(),
+ *   firstName: text("first_name").notNull(),
+ *   lastName: text("last_name").notNull(),
+ *   emailAddress: text("email_address").notNull().unique(),
+ * });
+ *
+ * export const posts = table("posts", {
+ *   id: uuid("id").primaryKey().defaultRandom(),
+ *   title: text("title").notNull(),
+ *   description: text("description"),
+ *   content: text("content").notNull(),
+ * });
+ *
+ * export const userRelations = relations(users, {
+ *   posts: hasMany(posts, {
+ *     from: [users.columns.id],
+ *     to: [posts.columns.userId],
+ *   }),
+ * });
+ *
+ * export const postRelations = relations(posts, {
+ *   owner: belongsTo(users, {
+ *     from: [posts.columns.userId],
+ *     to: [users.columns.id],
+ *   }),
+ * });
+ *
+ * // client.ts
+ * import { createClient } from "dsqlbase";
+ * import * as schema from "./schema";
+ *
+ * export const dsql = createClient({ schema });
+ *
+ * // Example usage
+ * import { dsql } from "./client";
+ *
+ * const newUser = await dsql.users.create({
+ *   data: {
+ *     firstName: "John",
+ *     lastName: "Doe",
+ *     emailAddress: "john.doe@example.com",
+ *   },
+ * });
+ * ```
+ * @param options - Configuration options for the client, including the schema definition.
+ * @returns A new instance of the DSQL client configured with the provided schema.
+ * @throws Will throw an error if the schema definition is invalid or if there are issues initializing the client.
+ * @see {@link ClientOptions} for more details on the configuration options.
+ * @see {@link ModelClient} for information on the methods available for interacting with the database tables.
+ */
+export declare function createClient<TSchema extends DefinitionSchema>(options: ClientOptions<TSchema>): QueryClient<TSchema>;
+//# sourceMappingURL=create.d.ts.map

package/dist/client/create.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../src/client/create.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,gBAAgB,EAIhB,OAAO,EACR,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAkB,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElE,MAAM,WAAW,aAAa,CAAC,OAAO,SAAS,gBAAgB;IAC7D;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AAEH,wBAAgB,YAAY,CAAC,OAAO,SAAS,gBAAgB,EAC3D,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,GAC9B,WAAW,CAAC,OAAO,CAAC,CAuBtB"}

package/dist/client/create.js

@@ -0,0 +1,82 @@
+import { ExecutionContext, QueryBuilder, SchemaRegistry, } from "@dsqlbase/core";
+import { ModelClient } from "./model/client.js";
+import { DatabaseClient } from "./database/index.js";
+/**
+ * Creates a new client instance for interacting with the database using the provided schema definition.
+ *
+ * @example
+ * ```ts
+ * // schema.ts
+ * import { table, text, uuid } from "@dsqlbase/schema";
+ *
+ * export const users = table("users", {
+ *   id: uuid("id").primaryKey().defaultRandom(),
+ *   firstName: text("first_name").notNull(),
+ *   lastName: text("last_name").notNull(),
+ *   emailAddress: text("email_address").notNull().unique(),
+ * });
+ *
+ * export const posts = table("posts", {
+ *   id: uuid("id").primaryKey().defaultRandom(),
+ *   title: text("title").notNull(),
+ *   description: text("description"),
+ *   content: text("content").notNull(),
+ * });
+ *
+ * export const userRelations = relations(users, {
+ *   posts: hasMany(posts, {
+ *     from: [users.columns.id],
+ *     to: [posts.columns.userId],
+ *   }),
+ * });
+ *
+ * export const postRelations = relations(posts, {
+ *   owner: belongsTo(users, {
+ *     from: [posts.columns.userId],
+ *     to: [users.columns.id],
+ *   }),
+ * });
+ *
+ * // client.ts
+ * import { createClient } from "dsqlbase";
+ * import * as schema from "./schema";
+ *
+ * export const dsql = createClient({ schema });
+ *
+ * // Example usage
+ * import { dsql } from "./client";
+ *
+ * const newUser = await dsql.users.create({
+ *   data: {
+ *     firstName: "John",
+ *     lastName: "Doe",
+ *     emailAddress: "john.doe@example.com",
+ *   },
+ * });
+ * ```
+ * @param options - Configuration options for the client, including the schema definition.
+ * @returns A new instance of the DSQL client configured with the provided schema.
+ * @throws Will throw an error if the schema definition is invalid or if there are issues initializing the client.
+ * @see {@link ClientOptions} for more details on the configuration options.
+ * @see {@link ModelClient} for information on the methods available for interacting with the database tables.
+ */
+export function createClient(options) {
+    const schema = new SchemaRegistry(options.schema);
+    const dialect = new QueryBuilder();
+    const context = new ExecutionContext({
+        schema,
+        dialect,
+        session: options.session,
+    });
+    const dbClient = new DatabaseClient(context);
+    for (const [tableName, table] of Object.entries(schema.getTables())) {
+        const modelClient = new ModelClient(context, table);
+        Object.defineProperty(dbClient, tableName, {
+            value: modelClient,
+            writable: false,
+            enumerable: true,
+        });
+    }
+    return dbClient;
+}
+//# sourceMappingURL=create.js.map

package/dist/client/create.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.js","sourceRoot":"","sources":["../../src/client/create.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,gBAAgB,EAChB,YAAY,EACZ,cAAc,GAEf,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAe,MAAM,qBAAqB,CAAC;AAclE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AAEH,MAAM,UAAU,YAAY,CAC1B,OAA+B;IAE/B,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAClD,MAAM,OAAO,GAAG,IAAI,YAAY,EAAE,CAAC;IAEnC,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC;QACnC,MAAM;QACN,OAAO;QACP,OAAO,EAAE,OAAO,CAAC,OAAO;KACzB,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC;IAE7C,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAW,MAAM,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC;QAC9E,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAEpD,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,SAAS,EAAE;YACzC,KAAK,EAAE,WAAW;YAClB,QAAQ,EAAE,KAAK;YACf,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;IACL,CAAC;IAED,OAAO,QAAgC,CAAC;AAC1C,CAAC"}

package/dist/client/database/base.d.ts

@@ -0,0 +1,8 @@
+import { DefinitionSchema, ExecutionContext, SQLQuery, SQLStatement } from "@dsqlbase/core";
+export declare abstract class BaseClient<T extends DefinitionSchema> {
+    private readonly _ctx;
+    constructor(ctx: ExecutionContext<T>);
+    $query<T = unknown>(sql: SQLQuery): Promise<T[]>;
+    $execute<T = unknown>(query: SQLStatement): Promise<T[]>;
+}
+//# sourceMappingURL=base.d.ts.map

package/dist/client/database/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/client/database/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE5F,8BAAsB,UAAU,CAAC,CAAC,SAAS,gBAAgB;IACzD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAsB;gBAE/B,GAAG,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAI9B,MAAM,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAIhD,QAAQ,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;CAG/D"}

package/dist/client/database/base.js

@@ -0,0 +1,13 @@
+export class BaseClient {
+    _ctx;
+    constructor(ctx) {
+        this._ctx = ctx;
+    }
+    async $query(sql) {
+        return this.$execute(sql.toQuery());
+    }
+    async $execute(query) {
+        return this._ctx.session.execute(query);
+    }
+}
+//# sourceMappingURL=base.js.map

package/dist/client/database/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/client/database/base.ts"],"names":[],"mappings":"AAEA,MAAM,OAAgB,UAAU;IACb,IAAI,CAAsB;IAE3C,YAAY,GAAwB;QAClC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,MAAM,CAAc,GAAa;QACrC,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAc,KAAmB;QAC7C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAI,KAAK,CAAC,CAAC;IAC7C,CAAC;CACF"}

package/dist/client/database/client.d.ts

@@ -0,0 +1,5 @@
+import { DefinitionSchema } from "@dsqlbase/core";
+import { BaseClient } from "./base.js";
+export declare class DatabaseClient<TDefinition extends DefinitionSchema> extends BaseClient<TDefinition> {
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client/database/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/client/database/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvC,qBAAa,cAAc,CAAC,WAAW,SAAS,gBAAgB,CAAE,SAAQ,UAAU,CAAC,WAAW,CAAC;CAAG"}

package/dist/client/database/client.js

@@ -0,0 +1,4 @@
+import { BaseClient } from "./base.js";
+export class DatabaseClient extends BaseClient {
+}
+//# sourceMappingURL=client.js.map

package/dist/client/database/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/client/database/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvC,MAAM,OAAO,cAAqD,SAAQ,UAAuB;CAAG"}

package/dist/client/database/index.d.ts

@@ -0,0 +1,9 @@
+import { AnyTable, DefinitionSchema, RuntimeTables, Schema } from "@dsqlbase/core";
+import { ModelClient } from "../model/client.js";
+import { DatabaseClient } from "./client.js";
+export type Models<T extends DefinitionSchema> = {
+    readonly [K in keyof RuntimeTables<Schema<T>>]: RuntimeTables<Schema<T>>[K] extends infer TTable ? TTable extends AnyTable ? ModelClient<TTable, T> : never : never;
+};
+export type QueryClient<T extends DefinitionSchema> = DatabaseClient<T> & Models<T>;
+export { DatabaseClient };
+//# sourceMappingURL=index.d.ts.map

package/dist/client/database/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/database/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACnF,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,gBAAgB,IAAI;IAC/C,QAAQ,EAAE,CAAC,IAAI,MAAM,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,MAAM,GAC5F,MAAM,SAAS,QAAQ,GACrB,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,GACtB,KAAK,GACP,KAAK;CACV,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,gBAAgB,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;AAEpF,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/dist/client/database/index.js

@@ -0,0 +1,3 @@
+import { DatabaseClient } from "./client.js";
+export { DatabaseClient };
+//# sourceMappingURL=index.js.map

package/dist/client/database/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/database/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAY7C,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/dist/client/index.d.ts

@@ -0,0 +1,6 @@
+export type * from "./model/base.js";
+export { isFilterType } from "./model/base.js";
+export { ModelClient } from "./model/client.js";
+export { DatabaseClient, type QueryClient, type Models } from "./database/index.js";
+export { createClient, type ClientOptions } from "./create.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,iBAAiB,CAAC;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,KAAK,WAAW,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACpF,OAAO,EAAE,YAAY,EAAE,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC"}

package/dist/client/index.js

@@ -0,0 +1,5 @@
+export { isFilterType } from "./model/base.js";
+export { ModelClient } from "./model/client.js";
+export { DatabaseClient } from "./database/index.js";
+export { createClient } from "./create.js";
+//# sourceMappingURL=index.js.map

package/dist/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAiC,MAAM,qBAAqB,CAAC;AACpF,OAAO,EAAE,YAAY,EAAsB,MAAM,aAAa,CAAC"}