effect-mongodb 0.0.3 → 0.0.5

package/src/DocumentCollection.ts

@@ -10,16 +10,23 @@ import type {
   AggregateOptions,
   BulkWriteOptions,
   Collection as MongoCollection,
+  CountDocumentsOptions,
   CreateIndexesOptions,
   DeleteOptions,
   DeleteResult,
   Document,
+  DropCollectionOptions,
+  DropIndexesOptions,
+  EstimatedDocumentCountOptions,
   Filter,
+  FindOneAndReplaceOptions,
   FindOptions,
   IndexDescription,
+  IndexSpecification,
   InsertManyResult,
   InsertOneOptions,
   InsertOneResult,
+  ModifyResult as MongoModifyResult,
   OptionalUnlessRequiredId,
   RenameOptions,
   ReplaceOptions,
@@ -31,6 +38,7 @@ import type {
 import * as Collection from "./Collection.js"
 import * as DocumentAggregationCursor from "./DocumentAggregationCursor.js"
 import * as DocumentFindCursor from "./DocumentFindCursor.js"
+import type { ModifyResult } from "./internal/modify-result.js"
 import * as MongoError from "./MongoError.js"
 
 export class DocumentCollection extends Data.TaggedClass("DocumentCollection")<{
@@ -39,26 +47,27 @@ export class DocumentCollection extends Data.TaggedClass("DocumentCollection")<{
 }
 
 export const find: {
-  (options?: FindOptions): (collection: DocumentCollection) => DocumentFindCursor.DocumentFindCursor
+  (
+    filter?: Filter<Document>,
+    options?: FindOptions
+  ): (collection: DocumentCollection) => DocumentFindCursor.DocumentFindCursor
   (
     collection: DocumentCollection,
+    filter?: Filter<Document>,
     options?: FindOptions
   ): DocumentFindCursor.DocumentFindCursor
 } = F.dual(
   (args) => isDocumentCollection(args[0]),
-  (collection: DocumentCollection, options?: FindOptions) =>
+  (collection: DocumentCollection, filter?: Filter<Document>, options?: FindOptions) =>
     new DocumentFindCursor.DocumentFindCursor(
       {
-        cursor: collection.collection.find({}, options)
+        cursor: collection.collection.find(filter ?? {}, options)
       }
     )
 )
 
 export const findOne: {
-  (
-    filter: Filter<Document>,
-    options?: FindOptions
-  ): (
+  (filter: Filter<Document>, options?: FindOptions): (
     collection: DocumentCollection
   ) => Effect.Effect<O.Option<Document>, MongoError.MongoError>
   (
@@ -81,10 +90,7 @@ export const findOne: {
 )
 
 export const insertOne: {
-  (
-    doc: OptionalUnlessRequiredId<Document>,
-    options?: InsertOneOptions
-  ): (
+  (doc: OptionalUnlessRequiredId<Document>, options?: InsertOneOptions): (
     collection: DocumentCollection
   ) => Effect.Effect<InsertOneResult, MongoError.MongoError>
   (
@@ -125,10 +131,7 @@ export const insertMany: {
   ))
 
 export const deleteOne: {
-  (
-    filter: Filter<Document>,
-    options?: DeleteOptions
-  ): (
+  (filter: Filter<Document>, options?: DeleteOptions): (
     collection: DocumentCollection
   ) => Effect.Effect<DeleteResult, MongoError.MongoError>
   (
@@ -150,10 +153,7 @@ export const deleteOne: {
 )
 
 export const deleteMany: {
-  (
-    filter: Filter<Document>,
-    options?: DeleteOptions
-  ): (
+  (filter: Filter<Document>, options?: DeleteOptions): (
     collection: DocumentCollection
   ) => Effect.Effect<DeleteResult, MongoError.MongoError>
   (
@@ -230,12 +230,80 @@ export const replaceOne: {
     )
 )
 
-export const rename: {
+export const findOneAndReplace: {
   (
-    newName: string,
-    options?: RenameOptions
+    filter: Filter<Document>,
+    replacement: WithoutId<Document>,
+    options: FindOneAndReplaceOptions & { includeResultMetadata: true }
+  ): (
+    collection: DocumentCollection
+  ) => Effect.Effect<ModifyResult<Document>, MongoError.MongoError>
+  (
+    filter: Filter<Document>,
+    replacement: WithoutId<Document>,
+    options: FindOneAndReplaceOptions & { includeResultMetadata: false }
   ): (
     collection: DocumentCollection
+  ) => Effect.Effect<O.Option<Document>, MongoError.MongoError>
+  (
+    filter: Filter<Document>,
+    replacement: WithoutId<Document>,
+    options: FindOneAndReplaceOptions
+  ): (
+    collection: DocumentCollection
+  ) => Effect.Effect<O.Option<Document>, MongoError.MongoError>
+  (filter: Filter<Document>, replacement: WithoutId<Document>): (
+    collection: DocumentCollection
+  ) => Effect.Effect<O.Option<Document>, MongoError.MongoError>
+  (
+    collection: DocumentCollection,
+    filter: Filter<Document>,
+    replacement: WithoutId<Document>,
+    options: FindOneAndReplaceOptions & { includeResultMetadata: true }
+  ): Effect.Effect<ModifyResult<Document>, MongoError.MongoError>
+  (
+    collection: DocumentCollection,
+    filter: Filter<Document>,
+    replacement: WithoutId<Document>,
+    options: FindOneAndReplaceOptions & { includeResultMetadata: false }
+  ): Effect.Effect<O.Option<Document>, MongoError.MongoError>
+  (
+    collection: DocumentCollection,
+    filter: Filter<Document>,
+    replacement: WithoutId<Document>,
+    options: FindOneAndReplaceOptions
+  ): Effect.Effect<O.Option<Document>, MongoError.MongoError>
+  (
+    collection: DocumentCollection,
+    filter: Filter<Document>,
+    replacement: WithoutId<Document>
+  ): Effect.Effect<O.Option<Document>, MongoError.MongoError>
+} = F.dual(
+  (args) => isDocumentCollection(args[0]),
+  (
+    collection: DocumentCollection,
+    filter: Filter<Document>,
+    replacement: WithoutId<Document>,
+    options?: FindOneAndReplaceOptions
+  ): Effect.Effect<O.Option<Document> | ModifyResult<Document>, MongoError.MongoError> =>
+    F.pipe(
+      Effect.promise(() => collection.collection.findOneAndReplace(filter, replacement, options ?? {})),
+      Effect.map((value) => {
+        if (options?.includeResultMetadata && !!value) {
+          const result = value as unknown as MongoModifyResult<Document>
+          return { ...result, value: O.fromNullable(result.value) }
+        }
+        return O.fromNullable(value)
+      }),
+      Effect.catchAllDefect(
+        MongoError.mongoErrorDie<O.Option<Document> | ModifyResult<Document>>("findOneAndReplace error")
+      )
+    )
+)
+
+export const rename: {
+  (newName: string, options?: RenameOptions): (
+    collection: DocumentCollection
   ) => Effect.Effect<MongoCollection, MongoError.MongoError>
   (
     collection: DocumentCollection,
@@ -255,11 +323,23 @@ export const rename: {
     )
 )
 
-export const createIndexes: {
+export const drop: {
+  (options?: DropCollectionOptions): (collection: DocumentCollection) => Effect.Effect<boolean, MongoError.MongoError>
+  (collection: DocumentCollection, options?: DropCollectionOptions): Effect.Effect<boolean, MongoError.MongoError>
+} = F.dual(
+  (args) => isDocumentCollection(args[0]),
   (
-    indexSpecs: Array<IndexDescription>,
-    options?: CreateIndexesOptions
-  ): (
+    collection: DocumentCollection,
+    options?: DropCollectionOptions
+  ): Effect.Effect<boolean, MongoError.MongoError> =>
+    F.pipe(
+      Effect.promise(() => collection.collection.drop(options)),
+      Effect.catchAllDefect(MongoError.mongoErrorDie<boolean>("drop error"))
+    )
+)
+
+export const createIndexes: {
+  (indexSpecs: Array<IndexDescription>, options?: CreateIndexesOptions): (
     collection: DocumentCollection
   ) => Effect.Effect<Array<string>, MongoError.MongoError>
   (
@@ -280,11 +360,54 @@ export const createIndexes: {
     )
 )
 
-export const aggregate: {
+export const createIndex: {
   (
-    pipeline?: Array<Document>,
-    options?: AggregateOptions
-  ): (
+    indexSpec: IndexSpecification,
+    options?: CreateIndexesOptions
+  ): (collection: DocumentCollection) => Effect.Effect<string, MongoError.MongoError>
+  (
+    collection: DocumentCollection,
+    indexSpec: IndexSpecification,
+    options?: CreateIndexesOptions
+  ): Effect.Effect<string, MongoError.MongoError>
+} = F.dual(
+  (args) => isDocumentCollection(args[0]),
+  (
+    collection: DocumentCollection,
+    indexSpec: IndexSpecification,
+    options?: CreateIndexesOptions
+  ): Effect.Effect<string, MongoError.MongoError> =>
+    F.pipe(
+      Effect.promise(() => collection.collection.createIndex(indexSpec, options)),
+      Effect.catchAllDefect(MongoError.mongoErrorDie<string>("createIndex error"))
+    )
+)
+
+export const dropIndex: {
+  (
+    indexName: string,
+    options?: DropIndexesOptions
+  ): (collection: DocumentCollection) => Effect.Effect<Document, MongoError.MongoError>
+  (
+    collection: DocumentCollection,
+    indexName: string,
+    options?: DropIndexesOptions
+  ): Effect.Effect<Document, MongoError.MongoError>
+} = F.dual(
+  (args) => isDocumentCollection(args[0]),
+  (
+    collection: DocumentCollection,
+    indexName: string,
+    options?: DropIndexesOptions
+  ): Effect.Effect<Document, MongoError.MongoError> =>
+    F.pipe(
+      Effect.promise(() => collection.collection.dropIndex(indexName, options)),
+      Effect.catchAllDefect(MongoError.mongoErrorDie<Document>("dropIndex error"))
+    )
+)
+
+export const aggregate: {
+  (pipeline?: Array<Document>, options?: AggregateOptions): (
     collection: DocumentCollection
   ) => DocumentAggregationCursor.DocumentAggregationCursor
   (
@@ -304,6 +427,48 @@ export const aggregate: {
     })
 )
 
+export const estimatedDocumentCount: {
+  (options?: EstimatedDocumentCountOptions): (
+    collection: DocumentCollection
+  ) => Effect.Effect<number, MongoError.MongoError>
+  (
+    collection: DocumentCollection,
+    options?: EstimatedDocumentCountOptions
+  ): Effect.Effect<number, MongoError.MongoError>
+} = F.dual(
+  (args) => isDocumentCollection(args[0]),
+  (
+    collection: DocumentCollection,
+    options?: EstimatedDocumentCountOptions
+  ): Effect.Effect<number, MongoError.MongoError> =>
+    F.pipe(
+      Effect.promise(() => collection.collection.estimatedDocumentCount(options)),
+      Effect.catchAllDefect(MongoError.mongoErrorDie<number>("estimatedDocumentCount error"))
+    )
+)
+
+export const countDocuments: {
+  (filter?: Filter<Document>, options?: CountDocumentsOptions): (
+    collection: DocumentCollection
+  ) => Effect.Effect<number, MongoError.MongoError>
+  (
+    collection: DocumentCollection,
+    filter?: Filter<Document>,
+    options?: CountDocumentsOptions
+  ): Effect.Effect<number, MongoError.MongoError>
+} = F.dual(
+  (args) => isDocumentCollection(args[0]),
+  (
+    collection: DocumentCollection,
+    filter?: Filter<Document>,
+    options?: CountDocumentsOptions
+  ): Effect.Effect<number, MongoError.MongoError> =>
+    F.pipe(
+      Effect.promise(() => collection.collection.countDocuments(filter, options)),
+      Effect.catchAllDefect(MongoError.mongoErrorDie<number>("countDocuments error"))
+    )
+)
+
 export const typed: {
   <A extends Document, I extends Document = A, R = never>(
     schema: Schema.Schema<A, I, R>

package/src/DocumentFindCursor.ts

@@ -6,7 +6,7 @@ import * as Effect from "effect/Effect"
 import * as F from "effect/Function"
 import type * as Schema from "effect/Schema"
 import * as Stream from "effect/Stream"
-import type { Document, FindCursor as MongoFindCursor, Sort, SortDirection } from "mongodb"
+import type { Document, Filter, FindCursor as MongoFindCursor, Sort, SortDirection } from "mongodb"
 import * as FindCursor from "./FindCursor.js"
 import * as MongoError from "./MongoError.js"
 
@@ -16,20 +16,16 @@ export class DocumentFindCursor extends Data.TaggedClass("DocumentFindCursor")<{
 }
 
 export const filter: {
-  (
-    filter: Document
-  ): (cursor: DocumentFindCursor) => DocumentFindCursor
-  (cursor: DocumentFindCursor, filter: Document): DocumentFindCursor
+  (filter: Filter<Document>): (cursor: DocumentFindCursor) => DocumentFindCursor
+  (cursor: DocumentFindCursor, filter: Filter<Document>): DocumentFindCursor
 } = F.dual(
   (args) => isDocumentFindCursor(args[0]),
-  (cursor: DocumentFindCursor, filter: Document): DocumentFindCursor =>
+  (cursor: DocumentFindCursor, filter: Filter<Document>): DocumentFindCursor =>
     new DocumentFindCursor({ cursor: cursor.cursor.filter(filter) })
 )
 
 export const project: {
-  (
-    value: Document
-  ): (cursor: DocumentFindCursor) => DocumentFindCursor
+  (value: Document): (cursor: DocumentFindCursor) => DocumentFindCursor
   (cursor: DocumentFindCursor, value: Document): DocumentFindCursor
 } = F.dual(
   (args) => isDocumentFindCursor(args[0]),
@@ -38,10 +34,7 @@ export const project: {
 )
 
 export const sort: {
-  (
-    sort: Sort | string,
-    direction?: SortDirection
-  ): (cursor: DocumentFindCursor) => DocumentFindCursor
+  (sort: Sort | string, direction?: SortDirection): (cursor: DocumentFindCursor) => DocumentFindCursor
   (cursor: DocumentFindCursor, sort: Sort | string, direction?: SortDirection): DocumentFindCursor
 } = F.dual(
   (args) => isDocumentFindCursor(args[0]),
@@ -50,9 +43,7 @@ export const sort: {
 )
 
 export const limit: {
-  (
-    value: number
-  ): (cursor: DocumentFindCursor) => DocumentFindCursor
+  (value: number): (cursor: DocumentFindCursor) => DocumentFindCursor
   (cursor: DocumentFindCursor, value: number): DocumentFindCursor
 } = F.dual(
   (args) => isDocumentFindCursor(args[0]),
@@ -75,13 +66,8 @@ export const toStream = (
   )
 
 export const typed: {
-  <A, I = A, R = never>(
-    schema: Schema.Schema<A, I, R>
-  ): (cursor: DocumentFindCursor) => FindCursor.FindCursor<A, I, R>
-  <A, I = A, R = never>(
-    cursor: DocumentFindCursor,
-    schema: Schema.Schema<A, I, R>
-  ): FindCursor.FindCursor<A, I, R>
+  <A, I = A, R = never>(schema: Schema.Schema<A, I, R>): (cursor: DocumentFindCursor) => FindCursor.FindCursor<A, I, R>
+  <A, I = A, R = never>(cursor: DocumentFindCursor, schema: Schema.Schema<A, I, R>): FindCursor.FindCursor<A, I, R>
 } = F.dual((args) => isDocumentFindCursor(args[0]), <A, I = A, R = never>(
   cursor: DocumentFindCursor,
   schema: Schema.Schema<A, I, R>

package/src/FindCursor.ts

@@ -10,26 +10,23 @@ import * as Schema from "effect/Schema"
 import * as Stream from "effect/Stream"
 import * as Tuple from "effect/Tuple"
 import type { Document, FindCursor as FindCursor_, Sort, SortDirection } from "mongodb"
+import type { Filter } from "./internal/filter.js"
 import * as MongoError from "./MongoError.js"
 
 export class FindCursor<A, I = A, R = never> extends Data.TaggedClass("FindCursor")<{
   cursor: FindCursor_<unknown>
   schema: Schema.Schema<A, I, R>
-}> {}
+}> {
+}
 
 export const filter: {
-  <T extends Document = Document>(
-    filter: T
-  ): <A, I, R>(cursor: FindCursor<A, I, R>) => FindCursor<A, I, R>
-  <A, I, R, T extends Document = Document>(
-    cursor: FindCursor<A, I, R>,
-    filter: T
-  ): FindCursor<A, I, R>
+  <I extends Document>(filter: Filter<I>): <A, R>(cursor: FindCursor<A, I, R>) => FindCursor<A, I, R>
+  <A, I extends Document, R>(cursor: FindCursor<A, I, R>, filter: Filter<I>): FindCursor<A, I, R>
 } = F.dual(
   (args) => isFindCursor(args[0]),
-  <A, I, R, T extends Document = Document>(
+  <A, I extends Document, R>(
     cursor: FindCursor<A, I, R>,
-    filter: T
+    filter: Filter<I>
   ): FindCursor<A, I, R> => new FindCursor({ cursor: cursor.cursor.filter(filter), schema: cursor.schema })
 )
 
@@ -53,10 +50,7 @@ export const project: {
 )
 
 export const sort: {
-  (
-    sort: Sort | string,
-    direction?: SortDirection
-  ): <A, I, R>(cursor: FindCursor<A, I, R>) => FindCursor<A, I, R>
+  (sort: Sort | string, direction?: SortDirection): <A, I, R>(cursor: FindCursor<A, I, R>) => FindCursor<A, I, R>
   <A, I, R>(
     cursor: FindCursor<A, I, R>,
     sort: Sort | string,
@@ -72,9 +66,7 @@ export const sort: {
 )
 
 export const limit: {
-  (
-    value: number
-  ): <A, I, R>(cursor: FindCursor<A, I, R>) => FindCursor<A, I, R>
+  (value: number): <A, I, R>(cursor: FindCursor<A, I, R>) => FindCursor<A, I, R>
   <A, I, R>(cursor: FindCursor<A, I, R>, value: number): FindCursor<A, I, R>
 } = F.dual(
   (args) => isFindCursor(args[0]),
@@ -82,8 +74,9 @@ export const limit: {
     new FindCursor({ cursor: cursor.cursor.limit(value), schema: cursor.schema })
 )
 
-// TODO: add explicit return type for public API
-export const toArray = <A, I, R>(cursor: FindCursor<A, I, R>) => {
+export const toArray = <A, I, R>(
+  cursor: FindCursor<A, I, R>
+): Effect.Effect<Array<A>, MongoError.MongoError | ParseResult.ParseError, R> => {
   const decode = Schema.decodeUnknown(cursor.schema)
   return Effect.tryPromise({ try: () => cursor.cursor.toArray(), catch: F.identity }).pipe(
     Effect.catchAll(MongoError.mongoErrorDie<ReadonlyArray<A>>("Unable to get array from mongodb cursor")),
@@ -91,14 +84,14 @@ export const toArray = <A, I, R>(cursor: FindCursor<A, I, R>) => {
   )
 }
 
-// TODO: add explicit return type for public API
-export const toArrayEither = <A, I, R>(cursor: FindCursor<A, I, R>) => {
+export const toArrayEither = <A, I, R>(
+  cursor: FindCursor<A, I, R>
+): Effect.Effect<Array<E.Either<A, [document: unknown, error: ParseResult.ParseError]>>, MongoError.MongoError, R> => {
   const decode = Schema.decodeUnknown(cursor.schema)
   return Effect.tryPromise({ try: () => cursor.cursor.toArray(), catch: F.identity }).pipe(
     Effect.catchAll(MongoError.mongoErrorDie<ReadonlyArray<A>>("Unable to get array from mongodb cursor")),
     Effect.flatMap(Effect.forEach((x) =>
       F.pipe(
-        // keep new line
         decode(x),
         Effect.mapError((error) => Tuple.make(x, error)),
         Effect.either

package/src/MongoClient.ts

@@ -1,18 +1,18 @@
 /**
  * @since 0.0.1
  */
-import type * as Brand from "effect/Brand"
 import * as Effect from "effect/Effect"
 import * as F from "effect/Function"
 import type { Db, DbOptions, MongoClientOptions } from "mongodb"
 import { MongoClient as MongoClient_ } from "mongodb"
 import * as MongoError from "./MongoError.js"
 
-import * as Context from "effect/Context"
-
 export type MongoClient = MongoClient_
 
-export const connect = (url: string, options?: MongoClientOptions) =>
+export const connect = (
+  url: string,
+  options?: MongoClientOptions
+): Effect.Effect<MongoClient, MongoError.MongoError> =>
   Effect.promise(() => MongoClient_.connect(url, options)).pipe(
     Effect.catchAll(MongoError.mongoErrorDie<MongoClient_>("connect error"))
   )
@@ -22,14 +22,7 @@ export const db: {
   (client: MongoClient, dbName?: string, options?: DbOptions): Db
 } = F.dual(
   (args) => isMongoClient(args[0]),
-  (client: MongoClient, dbName?: string, options?: DbOptions) => client.db(dbName, options)
+  (client: MongoClient, dbName?: string, options?: DbOptions): Db => client.db(dbName, options)
 )
 
 const isMongoClient = (x: unknown) => x instanceof MongoClient_
-
-export type MongoClientService<K extends string> = {
-  client: Effect.Effect<MongoClient, MongoError.MongoError>
-} & Brand.Brand<K>
-
-export const Tag = <K extends string>(key: K) => Context.GenericTag<MongoClientService<K>>(key)
-export type TagType<K extends string> = ReturnType<typeof Tag<K>>

package/src/internal/modify-result.ts

@@ -0,0 +1,6 @@
+import type * as O from "effect/Option"
+import type { ModifyResult as MongoModifyResult } from "mongodb"
+
+export type ModifyResult<TSchema> = Omit<MongoModifyResult<TSchema>, "value"> & {
+  value: O.Option<TSchema>
+}

package/src/internal/schema.ts

@@ -0,0 +1,12 @@
+import * as Effect from "effect/Effect"
+import * as O from "effect/Option"
+import * as Schema from "effect/Schema"
+import type { Document } from "mongodb"
+
+// TODO: there is probably a Schema to do this decode or using typeclass package for traverse
+export const decodeNullableDocument = <A, I, R>(schema: Schema.Schema<A, I, R>, value: Document | null) =>
+  Effect.gen(function*(_) {
+    if (value === null) return O.none()
+    const decoded = yield* _(Schema.decodeUnknown(schema)(value))
+    return O.some(decoded)
+  })

package/src/internal/version.ts

@@ -1,4 +1,4 @@
-let moduleVersion = "0.0.3"
+let moduleVersion = "0.0.5"
 
 export const getCurrentVersion = () => moduleVersion