Merge pull request #160 from hemedani/main

✨ add createIndex to new model

src/odm/mod.ts

@@ -1,48 +1,44 @@
-import { Database } from "../deps.ts";
-import {
- IPureFields,
- IRelationsFileds,
- TRelation,
- TSchemas,
-} from "../models/mod.ts";
+import { Db } from "../npmDeps.ts";
+import { IPureFields, IRelationsFileds, TSchemas } from "../models/mod.ts";
 import { schemaFns } from "../models/mod.ts";
 import { assert, enums } from "../npmDeps.ts";
 import { throwError } from "../utils/throwError.ts";
-import { newModel } from "./newModel/mod.ts";
+import { newModel, OptionType } from "./newModel/mod.ts";
 
 export const odm = (schemasObj: TSchemas) => {
- let mongoDb: Database;
+ let mongoDb: Db;
 
- const setDb = (db: Database) => (mongoDb = db);
+ const setDb = (db: Db) => (mongoDb = db);
 
- const getDbClient = () => mongoDb;
+ const getDbClient = () => mongoDb;
 
- const getCollection = (collection: string) => {
- const db = getDbClient();
- const getSchemas = enums(schemaFns(schemasObj).getSchemasKeys());
- assert(collection, getSchemas);
- return db
- ? db.collection(collection)
- : throwError("No database connection");
- };
+ const getCollection = (collection: string) => {
+ const db = getDbClient();
+ const getSchemas = enums(schemaFns(schemasObj).getSchemasKeys());
+ assert(collection, getSchemas);
+ return db
+ ? db.collection(collection)
+ : throwError("No database connection");
+ };
 
- return {
- setDb,
- getCollection,
- newModel: <PF extends IPureFields, TR extends IRelationsFileds>(
- name: string,
- pureFields: PF,
- relations: TR,
- options?: { excludes?: Partial<(keyof PF)>[] },
- ) => newModel<PF, TR>(
- mongoDb,
- schemasObj,
- name,
- pureFields,
- relations,
- options,
- ),
- };
+ return {
+ setDb,
+ getCollection,
+ newModel: <PF extends IPureFields, TR extends IRelationsFileds>(
+ name: string,
+ pureFields: PF,
+ relations: TR,
+ options?: OptionType<PF>,
+ ) =>
+ newModel<PF, TR>(
+ mongoDb,
+ schemasObj,
+ name,
+ pureFields,
+ relations,
+ options,
+ ),
+ };
 };
 
 export * from "./utils/mod.ts";

src/odm/newModel/mod.ts

@@ -12,10 +12,12 @@ import { IPureFields, schemaFns, TSchemas } from "../../models/mod.ts";
 import {
  BulkWriteOptions,
  CountDocumentsOptions,
+ CreateIndexesOptions,
  Db,
  DeleteOptions,
  Document,
  FindOneAndUpdateOptions,
+ IndexSpecification,
  Infer,
  InsertOneOptions,
  OptionalUnlessRequiredId,
@@ -31,6 +33,14 @@ import { insertMany } from "../insert/insertMany.ts";
 import { removeRelation } from "../relation/removeRelation.ts";
 import { findOneAndUpdate } from "../update/findOneAndUpdate.ts";
 
+export type OptionType<PF extends IPureFields> = {
+ createIndex?: {
+ indexSpec: IndexSpecification;
+ options?: CreateIndexesOptions;
+ };
+ excludes?: Partial<(keyof PF)>[];
+};
+
 export const newModel = <
  PF extends IPureFields,
  TR extends IRelationsFileds,
@@ -40,7 +50,7 @@ export const newModel = <
  name: string,
  pureFields: PF,
  relations: TR,
- options?: { excludes?: Partial<(keyof PF)>[] },
+ options?: OptionType<PF>,
 ) => {
  type InferPureFieldsType = {
  [key in keyof PF]?: Infer<PF[key]>;
@@ -89,6 +99,13 @@ export const newModel = <
  options: (options as { excludes?: (string | number)[] }),
  };
 
+ if (options && options.createIndex) {
+ db.collection(name).createIndex(
+ options.createIndex.indexSpec,
+ options.createIndex.options,
+ );
+ }
+
  interface IFindModelInputs {
  filters: Filter<Document>;
  projection?: Projection;