@wxn0brp/db-core 0.12.4-alpha.1 → 0.12.4-alpha.2

package/dist/base/actions.d.ts

@@ -25,6 +25,7 @@ export declare abstract class ActionsBase implements ActionsBaseInterface {
     beginTransaction(id: Id): Promise<TransactionHandle>;
     commitTransaction(handle: TransactionHandle): Promise<void>;
     rollbackTransaction(handle: TransactionHandle): Promise<void>;
+    createIndex(config: VQueryT.CreateIndex): Promise<void>;
     updateOneOrAdd(config: VQueryT.UpdateOneOrAdd): Promise<VQueryT.UpdateOneOrAddResult<DataInternal>>;
     toggleOne(config: VQueryT.ToggleOne): Promise<VQueryT.ToggleOneResult<DataInternal>>;
 }

package/dist/base/actions.js

@@ -19,6 +19,9 @@ export class ActionsBase {
     async rollbackTransaction(handle) {
         throw new Error("Transactions are not supported for ActionsBase");
     }
+    async createIndex(config) {
+        // No-op: adapter does not use indexes internally
+    }
     async updateOneOrAdd(config) {
         const res = await this.updateOne(config);
         if (res)

package/dist/db/valthera.d.ts

@@ -3,6 +3,7 @@ import { ActionsBase } from "../base/actions.js";
 import { Collection } from "../helpers/collection.js";
 import { ExecutorInterface } from "../helpers/executor.js";
 import { Data } from "../types/data.js";
+import { IndexOpts } from "../types/idx.js";
 import { DbOpts } from "../types/options.js";
 import { ValtheraPlugin } from "../types/plugin.js";
 import { VQuery, VQueryT } from "../types/query.js";
@@ -86,6 +87,10 @@ export declare class ValtheraClass implements ValtheraCompatible {
      * Removes a database collection from the database.
      */
     removeCollection(collection: string): Promise<boolean>;
+    /**
+     * Create an index on a collection.
+     */
+    createIndex(collection: string, fields: string[], opts?: IndexOpts): Promise<void>;
     /**
      * @experimental
      *

package/dist/db/valthera.js

@@ -195,6 +195,20 @@ export class ValtheraClass {
         this._collections.delete(collection);
         return this.execute("removeCollection", collection);
     }
+    /**
+     * Create an index on a collection.
+     */
+    async createIndex(collection, fields, opts) {
+        const index = {
+            collection,
+            fields,
+            opts,
+        };
+        await this.execute("createIndex", {
+            collection,
+            index,
+        });
+    }
     /**
      * @experimental
      *

package/dist/helpers/addId.js

@@ -11,7 +11,11 @@ export async function addId(query, actions, defaultGen = true) {
         data[idKey] = genId();
         return;
     }
-    const txOpts = query.transaction ? { transaction: query.transaction } : {};
+    const txOpts = query.transaction
+        ? {
+            transaction: query.transaction,
+        }
+        : {};
     const find = (await actions.findOne({
         collection: "__vdb_id",
         search: {

package/dist/helpers/collection.d.ts

@@ -1,6 +1,7 @@
 import { Arg, Search, Updater } from "../types/arg.js";
 import { UpdateOneOrAdd } from "../types/collection.js";
 import { Data } from "../types/data.js";
+import { IndexOpts } from "../types/idx.js";
 import { DbFindOpts, FindOpts } from "../types/options.js";
 import { VQueryT } from "../types/query.js";
 import { VContext } from "../types/types.js";
@@ -48,4 +49,8 @@ export declare class Collection<D = Data> {
      * Asynchronously removes one entry in a database or adds a new one if it doesn't exist. Usage e.g. for toggling a flag.
      */
     toggleOne(search: Search<D>, data?: Arg<D>, context?: VContext): Promise<VQueryT.ToggleOneResult<D>>;
+    /**
+     * Create an index on this collection.
+     */
+    createIndex(fields: string[], opts?: IndexOpts): Promise<void>;
 }

package/dist/helpers/collection.js

@@ -101,4 +101,10 @@ export class Collection {
             context,
         });
     }
+    /**
+     * Create an index on this collection.
+     */
+    createIndex(fields, opts) {
+        return this.db.createIndex(this.collection, fields, opts);
+    }
 }

package/dist/types/action.d.ts

@@ -25,4 +25,5 @@ export interface ActionsBaseInterface {
     beginTransaction(id: Id): Promise<TransactionHandle>;
     commitTransaction(handle: TransactionHandle): Promise<void>;
     rollbackTransaction(handle: TransactionHandle): Promise<void>;
+    createIndex(config: VQueryT.CreateIndex): Promise<void>;
 }

package/dist/types/idx.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Index options - adapter-dependent, should not be relied upon
+ */
+export interface IndexOpts {
+    unique?: boolean;
+    name?: string;
+}
+export interface IndexDefinition {
+    collection: string;
+    fields: string[];
+    opts?: IndexOpts;
+}

package/dist/types/idx.js

@@ -0,0 +1 @@
+export {};

package/dist/types/query.d.ts

@@ -1,5 +1,6 @@
 import { Arg, Search, Updater } from "./arg.js";
 import { Data } from "./data.js";
+import { IndexDefinition } from "./idx.js";
 import { DbFindOpts, FindOpts } from "./options.js";
 import { TransactionHandle } from "./transaction.js";
 import { VContext } from "./types.js";
@@ -27,6 +28,7 @@ export interface VQuery<T = Data, AllowFn extends boolean = true> {
     updater?: Updater<T, AllowFn>;
     control?: VQuery_Control;
     transaction?: TransactionHandle;
+    index?: IndexDefinition;
 }
 export declare namespace VQueryT {
     type QueryBase<T = Data> = {
@@ -78,4 +80,7 @@ export declare namespace VQueryT {
         data: T;
         type: "added" | "removed";
     }
+    type CreateIndex<T = Data> = QueryBase<T> & {
+        index: IndexDefinition;
+    };
 }

package/dist/types/valthera.d.ts

@@ -1,5 +1,6 @@
 import { Collection } from "../helpers/collection.js";
 import { Data } from "./data.js";
+import { IndexOpts } from "./idx.js";
 import { VQueryT } from "./query.js";
 export interface ValtheraCompatible {
     c<T = Data>(collection: string): Collection<T>;
@@ -16,4 +17,5 @@ export interface ValtheraCompatible {
     removeCollection(collection: string): Promise<boolean>;
     updateOneOrAdd<T = Data>(query: VQueryT.UpdateOneOrAdd<T>): Promise<VQueryT.UpdateOneOrAddResult<T>>;
     toggleOne<T = Data>(query: VQueryT.ToggleOne<T>): Promise<VQueryT.ToggleOneResult<T>>;
+    createIndex(collection: string, fields: string[], opts?: IndexOpts): Promise<void>;
 }

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "0.12.4-alpha.1";
+export declare const version = "0.12.4-alpha.2";

package/dist/version.js

@@ -1 +1 @@
-export const version = "0.12.4-alpha.1";
+export const version = "0.12.4-alpha.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/db-core",
-  "version": "0.12.4-alpha.1",
+  "version": "0.12.4-alpha.2",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "author": "wxn0brP",
@@ -13,7 +13,7 @@
   },
   "homepage": "https://github.com/wxn0brP/ValtheraDB",
   "dependencies": {
-    "@wxn0brp/event-emitter": "0.0.6"
+    "@wxn0brp/event-emitter": "0.0.7"
   },
   "devDependencies": {
     "@types/bun": "*",