@opra/mongodb 1.4.3 → 1.5.0

package/esm/services/mongo-service.js

@@ -1,6 +1,6 @@
 import { DATATYPE_METADATA } from '@opra/common';
 import { ServiceBase } from '@opra/core';
-import { ObjectId } from 'mongodb';
+import { ObjectId, } from 'mongodb';
 import { MongoAdapter } from '../adapter/mongo-adapter.js';
 const transactionKey = Symbol.for('transaction');
 /**
@@ -42,10 +42,12 @@ export class MongoService extends ServiceBase {
     for(context, overwriteProperties, overwriteContext) {
         if (overwriteProperties?.documentFilter && this.documentFilter) {
             overwriteProperties.documentFilter = [
-                ...(Array.isArray(this.documentFilter) ? this.documentFilter : [this.documentFilter]),
+                ...(Array.isArray(this.documentFilter)
+                    ? this.documentFilter
+                    : [this.documentFilter]),
                 ...(Array.isArray(overwriteProperties?.documentFilter)
-                    ? overwriteProperties?.documentFilter
-                    : [overwriteProperties?.documentFilter]),
+                    ? overwriteProperties.documentFilter
+                    : [overwriteProperties.documentFilter]),
             ];
         }
         return super.for(context, overwriteProperties, overwriteContext);
@@ -58,7 +60,9 @@ export class MongoService extends ServiceBase {
      * @throws {Error} If the collection name is not defined.
      */
     getCollectionName() {
-        const out = typeof this.collectionName === 'function' ? this.collectionName(this) : this.collectionName;
+        const out = typeof this.collectionName === 'function'
+            ? this.collectionName(this)
+            : this.collectionName;
         if (out)
             return out;
         throw new Error('collectionName is not defined');
@@ -71,7 +75,9 @@ export class MongoService extends ServiceBase {
      * @throws {Error} If the resource name is not defined.
      */
     getResourceName() {
-        const out = typeof this.resourceName === 'function' ? this.resourceName(this) : this.resourceName || this.getCollectionName();
+        const out = typeof this.resourceName === 'function'
+            ? this.resourceName(this)
+            : this.resourceName || this.getCollectionName();
         if (out)
             return out;
         throw new Error('resourceName is not defined');
@@ -82,8 +88,14 @@ export class MongoService extends ServiceBase {
      * @throws {NotAcceptableError} If the data type is not a ComplexType.
      */
     get dataType() {
+        if (this._dataType && this._dataTypeScope !== this.scopes)
+            this._dataType = undefined;
         if (!this._dataType)
             this._dataType = this.context.documentNode.getComplexType(this._dataType_);
+        this._dataTypeScope = this.scopes;
+        this._dataTypeScopes = this.scopes
+            ? this.scopes?.split(/\s*,\s*/)
+            : undefined;
         return this._dataType;
     }
     /**
@@ -181,7 +193,9 @@ export class MongoService extends ServiceBase {
      * @returns {MongoAdapter.AnyId} The generated ID.
      */
     _generateId(command) {
-        return typeof this.idGenerator === 'function' ? this.idGenerator(command, this) : new ObjectId();
+        return typeof this.idGenerator === 'function'
+            ? this.idGenerator(command, this)
+            : new ObjectId();
     }
     /**
      * Retrieves the common filter used for querying documents.
@@ -192,8 +206,10 @@ export class MongoService extends ServiceBase {
      * that resolves to the common filter, or undefined if not available.
      */
     _getDocumentFilter(command) {
-        const commonFilter = Array.isArray(this.documentFilter) ? this.documentFilter : [this.documentFilter];
-        const mapped = commonFilter.map(f => (typeof f === 'function' ? f(command, this) : f));
+        const commonFilter = Array.isArray(this.documentFilter)
+            ? this.documentFilter
+            : [this.documentFilter];
+        const mapped = commonFilter.map(f => typeof f === 'function' ? f(command, this) : f);
         return mapped.length > 1 ? MongoAdapter.prepareFilter(mapped) : mapped[0];
     }
     async _executeCommand(command, commandFn) {
@@ -201,7 +217,8 @@ export class MongoService extends ServiceBase {
         const next = async () => {
             proto = proto ? Object.getPrototypeOf(proto) : this;
             while (proto) {
-                if (proto.interceptor && Object.prototype.hasOwnProperty.call(proto, 'interceptor')) {
+                if (proto.interceptor &&
+                    Object.prototype.hasOwnProperty.call(proto, 'interceptor')) {
                     return await proto.interceptor.call(this, next, command, this);
                 }
                 proto = Object.getPrototypeOf(proto);
@@ -229,6 +246,7 @@ export class MongoService extends ServiceBase {
         if (validator)
             return validator;
         const options = { projection: '*' };
+        options.scope = this._dataTypeScopes;
         if (operation === 'update') {
             options.partial = 'deep';
             options.allowPatchOperators = true;
@@ -245,7 +263,11 @@ export class MongoService extends ServiceBase {
         let validator = this._outputCodecs[operation];
         if (validator)
             return validator;
-        const options = { projection: '*', partial: 'deep', ignoreHiddenFields: true };
+        const options = {
+            projection: '*',
+            partial: 'deep',
+            scope: this._dataTypeScopes,
+        };
         const dataType = this.dataType;
         validator = dataType.generateCodec('decode', options);
         this._outputCodecs[operation] = validator;

package/esm/services/mongo-singleton-service.js

@@ -91,7 +91,10 @@ export class MongoSingletonService extends MongoEntityService {
             options,
         };
         return this._executeCommand(command, async () => {
-            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(command), command.options?.filter]);
+            const filter = MongoAdapter.prepareFilter([
+                await this._getDocumentFilter(command),
+                command.options?.filter,
+            ]);
             command.options = { ...command.options, filter };
             return this._delete(command);
         });
@@ -112,7 +115,10 @@ export class MongoSingletonService extends MongoEntityService {
         };
         return this._executeCommand(command, async () => {
             const documentFilter = await this._getDocumentFilter(command);
-            const filter = MongoAdapter.prepareFilter([documentFilter, command.options?.filter]);
+            const filter = MongoAdapter.prepareFilter([
+                documentFilter,
+                command.options?.filter,
+            ]);
             const findCommand = command;
             findCommand.options = { ...command.options, filter, projection: ['_id'] };
             return !!(await this._findById(findCommand));
@@ -128,7 +134,10 @@ export class MongoSingletonService extends MongoEntityService {
         };
         return this._executeCommand(command, async () => {
             const documentFilter = await this._getDocumentFilter(command);
-            const filter = MongoAdapter.prepareFilter([documentFilter, command.options?.filter]);
+            const filter = MongoAdapter.prepareFilter([
+                documentFilter,
+                command.options?.filter,
+            ]);
             command.options = { ...command.options, filter };
             return this._findById(command);
         });
@@ -151,7 +160,10 @@ export class MongoSingletonService extends MongoEntityService {
             options,
         };
         return this._executeCommand(command, async () => {
-            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(command), command.options?.filter]);
+            const filter = MongoAdapter.prepareFilter([
+                await this._getDocumentFilter(command),
+                command.options?.filter,
+            ]);
             command.options = { ...command.options, filter };
             const matchCount = await this._updateOnly(command);
             if (matchCount) {
@@ -186,7 +198,10 @@ export class MongoSingletonService extends MongoEntityService {
             options,
         };
         return this._executeCommand(command, async () => {
-            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(command), command.options?.filter]);
+            const filter = MongoAdapter.prepareFilter([
+                await this._getDocumentFilter(command),
+                command.options?.filter,
+            ]);
             command.options = { ...command.options, filter };
             return this._updateOnly(command);
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/mongodb",
-  "version": "1.4.3",
+  "version": "1.5.0",
   "description": "Opra MongoDB adapter package",
   "author": "Panates",
   "license": "MIT",
@@ -10,9 +10,9 @@
     "valgen": "^5.12.0"
   },
   "peerDependencies": {
-    "@opra/common": "^1.4.3",
-    "@opra/core": "^1.4.3",
-    "@opra/http": "^1.4.3",
+    "@opra/common": "^1.5.0",
+    "@opra/core": "^1.5.0",
+    "@opra/http": "^1.5.0",
     "mongodb": ">= 6.0.0"
   },
   "type": "module",

package/types/adapter/prepare-projection.d.ts

@@ -1,4 +1,4 @@
 import { ComplexType, FieldsProjection } from '@opra/common';
 import mongodb, { type Document } from 'mongodb';
-export default function prepareProjection(dataType: ComplexType, projection?: string | string[] | Document | '*'): mongodb.Document | undefined;
-export declare function prepare(dataType: ComplexType, target: mongodb.Document, projection?: FieldsProjection): void;
+export default function prepareProjection(dataType: ComplexType, projection?: string | string[] | Document | '*', scopes?: string[]): mongodb.Document | undefined;
+export declare function prepare(dataType: ComplexType, target: mongodb.Document, projection?: FieldsProjection, scopes?: string[]): void;

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

@@ -152,10 +152,16 @@ export interface MongoService {
  * @template T - The type of the documents in the collection.
  */
 export declare class MongoService<T extends mongodb.Document = mongodb.Document> extends ServiceBase {
+    protected _dataTypeScope?: string;
+    protected _dataTypeScopes?: string[];
     protected _dataType_: Type | string;
     protected _dataType?: ComplexType;
     protected _inputCodecs: Record<string, IsObject.Validator<T>>;
     protected _outputCodecs: Record<string, IsObject.Validator<T>>;
+    /**
+     * Defines comma delimited scopes for api document
+     */
+    scopes?: string;
     /**
      * Represents the name of a collection in MongoDB
      */