@opra/mongodb 0.31.13 → 0.32.0

package/types/mongo-service.d.ts

@@ -1,4 +1,4 @@
-import mongodb, { UpdateFilter } from 'mongodb';
+import mongodb from 'mongodb';
 import { StrictOmit, Type } from 'ts-gems';
 import { ComplexType } from '@opra/common';
 import { ApiService, PartialOutput, RequestContext } from '@opra/core';
@@ -16,25 +16,105 @@ export declare class MongoService<T extends mongodb.Document> extends ApiService
     session?: mongodb.ClientSession;
     resourceName?: string;
     constructor(dataType: Type | string, options?: MongoService.Options);
+    getDataType(): ComplexType;
+    /**
+     * Creates a new instance for given context
+     *
+     * @param source
+     */
     forContext(source: ApiService): this;
     forContext(context: RequestContext, attributes?: {
         db?: mongodb.Db;
         session?: mongodb.ClientSession;
     }): this;
-    protected _rawInsertOne(doc: mongodb.OptionalUnlessRequiredId<T>, options?: mongodb.InsertOneOptions): Promise<mongodb.InsertOneResult<T>>;
-    protected _rawCountDocuments(filter?: mongodb.Filter<T>, options?: mongodb.CountOptions): Promise<number>;
-    protected _rawDeleteOne(filter?: mongodb.Filter<T>, options?: mongodb.DeleteOptions): Promise<mongodb.DeleteResult>;
-    protected _rawDeleteMany(filter?: mongodb.Filter<T>, options?: mongodb.DeleteOptions): Promise<mongodb.DeleteResult>;
-    protected _rawFindOne(filter: mongodb.Filter<T>, options?: mongodb.FindOptions): Promise<PartialOutput<T> | undefined>;
-    protected _rawFind(filter: mongodb.Filter<T>, options?: mongodb.FindOptions): Promise<mongodb.FindCursor<T>>;
-    protected _rawUpdateOne(filter: mongodb.Filter<T>, doc: UpdateFilter<T>, options?: mongodb.UpdateOptions): Promise<mongodb.UpdateResult<T>>;
-    protected _rawUpdateMany(filter: mongodb.Filter<T>, doc: UpdateFilter<T> | Partial<T>, options?: StrictOmit<mongodb.UpdateOptions, 'upsert'>): Promise<mongodb.UpdateResult<T>>;
+    /**
+     * Inserts a single document into MongoDB. If documents passed in do not contain the **_id** field,
+     * one will be added to each of the documents missing it by the driver, mutating the document. This behavior
+     * can be overridden by setting the **forceServerObjectId** flag.
+     *
+     * @param doc
+     * @param options
+     * @protected
+     */
+    protected __insertOne(doc: mongodb.OptionalUnlessRequiredId<T>, options?: mongodb.InsertOneOptions): Promise<mongodb.InsertOneResult<T>>;
+    /**
+     * Gets the number of documents matching the filter.
+     *
+     * @param filter
+     * @param options
+     * @protected
+     */
+    protected __countDocuments(filter?: mongodb.Filter<T>, options?: mongodb.CountOptions): Promise<number>;
+    /**
+     * Delete a document from a collection
+     *
+     * @param filter - The filter used to select the document to remove
+     * @param options - Optional settings for the command
+     */
+    protected __deleteOne(filter?: mongodb.Filter<T>, options?: mongodb.DeleteOptions): Promise<mongodb.DeleteResult>;
+    /**
+     * Delete multiple documents from a collection
+     *
+     * @param filter
+     * @param options
+     * @protected
+     */
+    protected __deleteMany(filter?: mongodb.Filter<T>, options?: mongodb.DeleteOptions): Promise<mongodb.DeleteResult>;
+    /**
+     * Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this collection.
+     *
+     * @param pipeline
+     * @param options
+     * @protected
+     */
+    protected __aggregate(pipeline?: mongodb.Document[], options?: mongodb.AggregateOptions): Promise<mongodb.AggregationCursor<T>>;
+    /**
+     * Fetches the first document that matches the filter
+     *
+     * @param filter
+     * @param options
+     * @protected
+     */
+    protected __findOne(filter: mongodb.Filter<T>, options?: mongodb.FindOptions): Promise<PartialOutput<T> | undefined>;
+    /**
+     * Creates a cursor for a filter that can be used to iterate over results from MongoDB
+     *
+     * @param filter
+     * @param options
+     * @protected
+     */
+    protected __find(filter: mongodb.Filter<T>, options?: mongodb.FindOptions): Promise<mongodb.FindCursor<T>>;
+    /**
+     * Update a single document in a collection
+     *
+     * @param filter
+     * @param update
+     * @param options
+     * @protected
+     */
+    protected __updateOne(filter: mongodb.Filter<T>, update: mongodb.UpdateFilter<T>, options?: mongodb.UpdateOptions): Promise<mongodb.UpdateResult<T>>;
+    /**
+     * Find a document and update it in one atomic operation. Requires a write lock for the duration of the operation.
+     *
+     * @param filter
+     * @param doc
+     * @param options
+     * @protected
+     */
+    protected __findOneAndUpdate(filter: mongodb.Filter<T>, doc: mongodb.UpdateFilter<T>, options?: mongodb.FindOneAndUpdateOptions): Promise<mongodb.WithId<T> | null>;
+    /**
+     * Update multiple documents in a collection
+     *
+     * @param filter
+     * @param doc
+     * @param options
+     * @protected
+     */
+    protected __updateMany(filter: mongodb.Filter<T>, doc: mongodb.UpdateFilter<T> | Partial<T>, options?: StrictOmit<mongodb.UpdateOptions, 'upsert'>): Promise<mongodb.UpdateResult<T>>;
     protected _onError(error: unknown): Promise<void>;
     protected getDatabase(): mongodb.Db | Promise<mongodb.Db>;
-    protected getDataType(): ComplexType;
     protected getCollection(db: mongodb.Db): Promise<mongodb.Collection<T>>;
     protected getCollectionName(): string;
     protected _cacheMatch(service: MongoService<any>, context: RequestContext, attributes?: any): boolean;
     protected onError?(error: unknown): void | Promise<void>;
-    protected transformData?(row: PartialOutput<T>): PartialOutput<T>;
 }

package/types/mongo-singleton-service.d.ts

@@ -9,13 +9,47 @@ import { MongoService } from './mongo-service.js';
  */
 export declare class MongoSingletonService<T extends mongodb.Document> extends MongoService<T> {
     protected _id: any;
+    collectionKey: string;
     constructor(dataType: Type | string, options?: MongoSingletonService.Options);
-    protected get resource(): OpraCommon.Singleton;
-    protected create(doc: mongodb.OptionalUnlessRequiredId<T>, options?: MongoSingletonService.CreateOptions): Promise<PartialOutput<T>>;
-    protected delete(options?: MongoSingletonService.DeleteOptions<T>): Promise<number>;
-    protected get(options?: MongoSingletonService.GetOptions<T>): Promise<PartialOutput<T>>;
-    protected find(options?: MongoSingletonService.GetOptions<T>): Promise<PartialOutput<T> | undefined>;
-    protected update(doc: PartialInput<T>, options?: MongoSingletonService.UpdateOptions<T>): Promise<PartialOutput<T> | undefined>;
+    /**
+     * Fetches the Document. Throws error undefined if not found.
+     *
+     * @param options
+     */
+    assert(options?: MongoSingletonService.GetOptions<T>): Promise<PartialOutput<any>>;
+    /**
+     * Inserts the document into MongoDB
+     *
+     * @param doc
+     * @param options
+     */
+    create(doc: mongodb.OptionalUnlessRequiredId<T>, options?: MongoSingletonService.CreateOptions): Promise<PartialOutput<T>>;
+    /**
+     * Delete the document from a collection
+     *
+     * @param options
+     */
+    delete(options?: MongoSingletonService.DeleteOptions<T>): Promise<number>;
+    /**
+     * Checks if the document exists.
+     * Returns true if document exists, false otherwise
+     *
+     */
+    exists(): Promise<boolean>;
+    /**
+     * Fetches the document
+     *
+     * @param options
+     */
+    get(options?: MongoSingletonService.GetOptions<T>): Promise<PartialOutput<T> | undefined>;
+    /**
+     * Updates a single document.
+     * Returns updated document
+     *
+     * @param doc
+     * @param options
+     */
+    update(doc: PartialInput<T>, options?: MongoSingletonService.UpdateOptions<T>): Promise<PartialOutput<T> | undefined>;
 }
 /**
  *
@@ -23,6 +57,7 @@ export declare class MongoSingletonService<T extends mongodb.Document> extends M
  */
 export declare namespace MongoSingletonService {
     interface Options extends MongoService.Options {
+        collectionKey?: string;
         _id?: any;
     }
     interface CreateOptions extends mongodb.InsertOneOptions {
@@ -39,7 +74,7 @@ export declare namespace MongoSingletonService {
         include?: string[];
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
     }
-    interface UpdateOptions<T> extends mongodb.UpdateOptions {
+    interface UpdateOptions<T> extends mongodb.FindOneAndUpdateOptions {
         pick?: string[];
         omit?: string[];
         include?: string[];

package/types/types.d.ts

@@ -0,0 +1,2 @@
+import { ObjectId } from 'mongodb';
+export type AnyId = string | number | ObjectId;