@objectstack/driver-mongodb 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute
+          must include a readable copy of the attribution notices
+          contained within such NOTICE file, excluding those notices
+          that do not pertain to any part of the Derivative Works,
+          in at least one of the following places: within a NOTICE
+          text file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with
+          the Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or as an addendum to
+          the NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the
+          License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 ObjectStack
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,168 @@
+# @objectstack/driver-mongodb
+
+MongoDB driver for ObjectStack — native document database support via the official MongoDB Node.js driver.
+
+## Installation
+
+```bash
+pnpm add @objectstack/driver-mongodb mongodb
+```
+
+## Configuration
+
+### Option A — Env vars (recommended for `objectstack dev` / `objectstack serve`)
+
+```bash
+export OS_DATABASE_URL=mongodb://localhost:27017/myapp
+pnpm dev
+```
+
+The ObjectStack CLI auto-registers this driver when `OS_DATABASE_URL` starts with
+`mongodb://` or `mongodb+srv://`. You do **not** need to set
+`OS_DATABASE_DRIVER` separately — the URL scheme is enough. Set it only as an
+explicit override (recognised values: `mongodb`, `mongo`).
+
+### Option B — Programmatic via `defineStack`
+
+```typescript
+import { defineStack } from '@objectstack/spec';
+import { MongoDBDriver } from '@objectstack/driver-mongodb';
+
+export default defineStack({
+  driver: new MongoDBDriver({
+    url: 'mongodb://localhost:27017/myapp',
+    database: 'myapp',        // Optional: overrides URI database
+    maxPoolSize: 10,          // Optional: connection pool size (default: 10)
+    minPoolSize: 1,           // Optional: minimum pool (default: 1)
+    connectTimeoutMS: 10000,  // Optional: connection timeout
+  }),
+});
+```
+
+### Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `url` | `string` | **required** | MongoDB connection URI |
+| `database` | `string` | from URI | Database name |
+| `maxPoolSize` | `number` | `10` | Max connection pool size |
+| `minPoolSize` | `number` | `1` | Min connection pool size |
+| `connectTimeoutMS` | `number` | `10000` | Connection timeout (ms) |
+| `serverSelectionTimeoutMS` | `number` | `5000` | Server selection timeout (ms) |
+| `options` | `MongoClientOptions` | `{}` | Additional MongoClient options |
+
+## Features
+
+### Capabilities
+
+| Category | Capability | Supported |
+|----------|-----------|-----------|
+| **CRUD** | create, read, update, delete | ✅ |
+| **Bulk** | bulkCreate, bulkUpdate, bulkDelete | ✅ |
+| **Query** | filters, sorting, pagination, aggregations | ✅ |
+| **Transactions** | Multi-document transactions | ✅ (requires replica set) |
+| **Streaming** | Cursor-based async iteration | ✅ |
+| **Schema** | Collection + index sync | ✅ |
+| **Advanced** | Full-text search, JSON queries, geospatial | ✅ |
+| **Joins** | Cross-collection joins ($lookup) | ❌ |
+| **Window Functions** | ROW_NUMBER, RANK, etc. | ❌ |
+
+### ID Handling
+
+ObjectStack uses string IDs (nanoid). The driver:
+- Stores `id` as a regular string field with a unique index
+- Auto-generates `id` via nanoid if not provided
+- **Never exposes** MongoDB's internal `_id` field in results
+
+### Filter Operators
+
+All ObjectStack filter operators are supported:
+
+```typescript
+// MongoDB-style filters (pass-through)
+await driver.find('task', {
+  where: {
+    status: { $in: ['active', 'pending'] },
+    priority: { $gte: 3 },
+    title: { $contains: 'urgent' },
+    deleted_at: { $null: true },
+  }
+});
+
+// Legacy array-style filters
+await driver.find('task', {
+  where: [['status', '=', 'active'], 'or', ['priority', '>=', 5]]
+});
+```
+
+### Transactions
+
+Transactions require a MongoDB **replica set** (including single-node replica sets for development).
+
+```typescript
+const session = await driver.beginTransaction();
+try {
+  await driver.create('order', { total: 100 }, { transaction: session });
+  await driver.update('inventory', itemId, { stock: newStock }, { transaction: session });
+  await driver.commit(session);
+} catch (error) {
+  await driver.rollback(session);
+  throw error;
+}
+```
+
+### Schema Sync
+
+Schema sync creates collections and indexes:
+
+```typescript
+await driver.syncSchema('account', {
+  name: 'account',
+  fields: {
+    name: { type: 'string', unique: true },
+    email: { type: 'email', indexed: true },
+    company_id: { type: 'lookup', reference_to: 'company' },
+  },
+});
+// Creates: idx_id_unique, idx_name_unique, idx_email, idx_company_id_lookup
+```
+
+### Aggregation
+
+```typescript
+const results = await driver.aggregate('order', {
+  where: { status: 'completed' },
+  aggregations: [
+    { function: 'sum', field: 'amount', alias: 'total_revenue' },
+    { function: 'count', alias: 'order_count' },
+  ],
+  groupBy: ['region'],
+});
+```
+
+## Plugin Usage
+
+Register as an ObjectStack plugin:
+
+```typescript
+import mongodbPlugin from '@objectstack/driver-mongodb';
+
+// The plugin registers automatically via onEnable
+kernel.use(mongodbPlugin, {
+  url: 'mongodb://localhost:27017/myapp',
+});
+```
+
+## Development
+
+```bash
+# Run tests
+pnpm test
+
+# Build
+pnpm build
+```
+
+## License
+
+Apache-2.0

package/dist/index.d.mts

@@ -0,0 +1,201 @@
+import { DriverOptions, QueryAST } from '@objectstack/spec/data';
+import { IDataDriver } from '@objectstack/spec/contracts';
+import { MongoClientOptions, ClientSession, Db, MongoClient, Filter, Document } from 'mongodb';
+
+/**
+ * MongoDB Driver for ObjectStack
+ *
+ * Implements the IDataDriver contract using the official MongoDB Node.js driver.
+ * Provides native document database operations with full support for
+ * ObjectStack's query protocol, aggregations, transactions, and streaming.
+ */
+
+/**
+ * MongoDB driver configuration.
+ */
+interface MongoDBDriverConfig {
+    /** MongoDB connection URI (e.g., 'mongodb://localhost:27017/mydb') */
+    url: string;
+    /** Database name (overrides the database in the URI) */
+    database?: string;
+    /** Maximum connection pool size */
+    maxPoolSize?: number;
+    /** Minimum connection pool size */
+    minPoolSize?: number;
+    /** Connection timeout in milliseconds */
+    connectTimeoutMS?: number;
+    /** Server selection timeout in milliseconds */
+    serverSelectionTimeoutMS?: number;
+    /** Additional MongoClient options */
+    options?: MongoClientOptions;
+}
+/**
+ * MongoDB Driver for ObjectStack.
+ *
+ * Implements the IDataDriver contract via the official MongoDB driver.
+ * Uses native MongoDB queries, aggregation pipelines, and transactions.
+ */
+declare class MongoDBDriver implements IDataDriver {
+    readonly name: string;
+    readonly version: string;
+    readonly supports: {
+        create: boolean;
+        read: boolean;
+        update: boolean;
+        delete: boolean;
+        bulkCreate: boolean;
+        bulkUpdate: boolean;
+        bulkDelete: boolean;
+        transactions: boolean;
+        savepoints: boolean;
+        queryFilters: boolean;
+        queryAggregations: boolean;
+        querySorting: boolean;
+        queryPagination: boolean;
+        queryWindowFunctions: boolean;
+        querySubqueries: boolean;
+        queryCTE: boolean;
+        joins: boolean;
+        fullTextSearch: boolean;
+        jsonQuery: boolean;
+        geospatialQuery: boolean;
+        streaming: boolean;
+        jsonFields: boolean;
+        arrayFields: boolean;
+        vectorSearch: boolean;
+        schemaSync: boolean;
+        batchSchemaSync: boolean;
+        migrations: boolean;
+        indexes: boolean;
+        connectionPooling: boolean;
+        preparedStatements: boolean;
+        queryCache: boolean;
+    };
+    private client;
+    private db;
+    private config;
+    constructor(config: MongoDBDriverConfig);
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    checkHealth(): Promise<boolean>;
+    getPoolStats(): undefined;
+    execute(command: unknown, _parameters?: unknown[], options?: DriverOptions): Promise<unknown>;
+    find(object: string, query: QueryAST, options?: DriverOptions): Promise<Record<string, unknown>[]>;
+    findOne(object: string, query: QueryAST, options?: DriverOptions): Promise<Record<string, unknown> | null>;
+    findStream(object: string, query: QueryAST, options?: DriverOptions): AsyncGenerator<Record<string, unknown>>;
+    private _findStream;
+    create(object: string, data: Record<string, unknown>, options?: DriverOptions): Promise<Record<string, unknown>>;
+    update(object: string, id: string | number, data: Record<string, unknown>, options?: DriverOptions): Promise<Record<string, unknown>>;
+    upsert(object: string, data: Record<string, unknown>, conflictKeys?: string[], options?: DriverOptions): Promise<Record<string, unknown>>;
+    delete(object: string, id: string | number, options?: DriverOptions): Promise<boolean>;
+    count(object: string, query?: QueryAST, options?: DriverOptions): Promise<number>;
+    bulkCreate(object: string, dataArray: Record<string, unknown>[], options?: DriverOptions): Promise<Record<string, unknown>[]>;
+    bulkUpdate(object: string, updates: Array<{
+        id: string | number;
+        data: Record<string, unknown>;
+    }>, options?: DriverOptions): Promise<Record<string, unknown>[]>;
+    bulkDelete(object: string, ids: Array<string | number>, options?: DriverOptions): Promise<void>;
+    updateMany(object: string, query: QueryAST, data: Record<string, unknown>, options?: DriverOptions): Promise<number>;
+    deleteMany(object: string, query: QueryAST, options?: DriverOptions): Promise<number>;
+    aggregate(object: string, query: QueryAST, options?: DriverOptions): Promise<Record<string, unknown>[]>;
+    beginTransaction(_options?: {
+        isolationLevel?: string;
+    }): Promise<ClientSession>;
+    commit(transaction: unknown): Promise<void>;
+    rollback(transaction: unknown): Promise<void>;
+    syncSchema(object: string, schema: unknown, _options?: DriverOptions): Promise<void>;
+    syncSchemasBatch(schemas: Array<{
+        object: string;
+        schema: unknown;
+    }>, options?: DriverOptions): Promise<void>;
+    dropTable(object: string, _options?: DriverOptions): Promise<void>;
+    explain(object: string, query: QueryAST, _options?: DriverOptions): Promise<unknown>;
+    /** Get the underlying Db instance for advanced usage. */
+    getDb(): Db;
+    /** Get the underlying MongoClient for advanced usage. */
+    getClient(): MongoClient;
+    private getCollection;
+    private getSession;
+    private mapFieldName;
+    private extractDatabaseName;
+}
+
+/**
+ * MongoDB Filter Translator
+ *
+ * Converts ObjectStack FilterCondition / AST-style `where` clauses into
+ * native MongoDB filter documents.
+ *
+ * Supports:
+ * - Implicit equality: `{ field: value }`
+ * - Explicit operators: `{ field: { $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin } }`
+ * - String operators: `{ field: { $contains, $startsWith, $endsWith, $notContains } }`
+ * - Special: `{ field: { $null, $exists } }`
+ * - Logical: `{ $and, $or, $not }`
+ * - Range: `{ field: { $between: [min, max] } }`
+ * - Legacy array-style: `[field, op, value]`
+ */
+
+/**
+ * Translate an ObjectStack `where` clause into a MongoDB filter document.
+ *
+ * The `where` clause can be:
+ * 1. A FilterCondition object (MongoDB-style with `$` operators)
+ * 2. A legacy array-style filter `[[field, op, value], 'or', [field, op, value]]`
+ * 3. A plain key-value object for implicit equality
+ */
+declare function translateFilter(where: unknown): Filter<any>;
+
+/**
+ * MongoDB Aggregation Pipeline Builder
+ *
+ * Translates ObjectStack QueryAST aggregations + groupBy into
+ * MongoDB aggregation pipeline stages ($match, $group, $sort, $project).
+ */
+
+/**
+ * Aggregation function descriptor from QueryAST.
+ */
+interface AggregationInput {
+    function: string;
+    field?: string;
+    alias: string;
+    distinct?: boolean;
+    filter?: unknown;
+}
+/**
+ * Build a MongoDB aggregation pipeline from QueryAST components.
+ *
+ * @param where - Filter condition (translated to $match)
+ * @param aggregations - Array of aggregation descriptors
+ * @param groupBy - Fields to group by
+ * @param orderBy - Sort specification
+ * @param limit - Max results
+ * @param offset - Skip results
+ */
+declare function buildAggregationPipeline(opts: {
+    where?: unknown;
+    aggregations?: AggregationInput[];
+    groupBy?: string[];
+    orderBy?: Array<{
+        field: string;
+        order?: string;
+    }>;
+    limit?: number;
+    offset?: number;
+}): Document[];
+/**
+ * Post-process aggregation results.
+ *
+ * Handles count_distinct conversion ($addToSet → count) and
+ * string_agg conversion ($push → joined string).
+ */
+declare function postProcessAggregation(results: Document[], aggregations: AggregationInput[]): Document[];
+
+declare const _default: {
+    id: string;
+    version: string;
+    onEnable: (context: any) => Promise<void>;
+};
+
+export { type AggregationInput, MongoDBDriver, type MongoDBDriverConfig, buildAggregationPipeline, _default as default, postProcessAggregation, translateFilter };