@opra/mongodb 1.4.4 → 1.5.0

package/cjs/adapter/prepare-projection.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = prepareProjection;
 exports.prepare = prepare;
 const common_1 = require("@opra/common");
-function prepareProjection(dataType, projection) {
+function prepareProjection(dataType, projection, scopes) {
     if (projection === '*')
         return undefined;
     if (projection &&
@@ -14,11 +14,10 @@ function prepareProjection(dataType, projection) {
     const projection_ = typeof projection === 'string' || Array.isArray(projection)
         ? (0, common_1.parseFieldsProjection)(projection)
         : projection;
-    // const exclusionProjection = !pick && !!omit;
-    prepare(dataType, out, projection_);
+    prepare(dataType, out, projection_, scopes);
     return Object.keys(out).length ? out : undefined;
 }
-function prepare(dataType, target, projection) {
+function prepare(dataType, target, projection, scopes) {
     const defaultFields = !projection || !Object.values(projection).find(p => !p.sign);
     const projectionKeys = projection && Object.keys(projection);
     const projectionKeysSet = new Set(projectionKeys);
@@ -30,6 +29,9 @@ function prepare(dataType, target, projection) {
         fieldName = field.name;
         k = fieldName.toLowerCase();
         projectionKeysSet.delete(k);
+        /** Ignore if field is not in scope */
+        if (!field.inScope(scopes))
+            continue;
         const p = projection?.[k];
         if (
         /** Ignore if field is omitted */

package/cjs/services/mongo-service.js

@@ -91,8 +91,14 @@ class MongoService extends core_1.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;
     }
     /**
@@ -243,6 +249,7 @@ class MongoService extends core_1.ServiceBase {
         if (validator)
             return validator;
         const options = { projection: '*' };
+        options.scope = this._dataTypeScopes;
         if (operation === 'update') {
             options.partial = 'deep';
             options.allowPatchOperators = true;
@@ -262,7 +269,7 @@ class MongoService extends core_1.ServiceBase {
         const options = {
             projection: '*',
             partial: 'deep',
-            ignoreHiddenFields: true,
+            scope: this._dataTypeScopes,
         };
         const dataType = this.dataType;
         validator = dataType.generateCodec('decode', options);

package/esm/adapter/prepare-projection.js

@@ -1,5 +1,5 @@
 import { ComplexType, parseFieldsProjection, } from '@opra/common';
-export default function prepareProjection(dataType, projection) {
+export default function prepareProjection(dataType, projection, scopes) {
     if (projection === '*')
         return undefined;
     if (projection &&
@@ -10,11 +10,10 @@ export default function prepareProjection(dataType, projection) {
     const projection_ = typeof projection === 'string' || Array.isArray(projection)
         ? parseFieldsProjection(projection)
         : projection;
-    // const exclusionProjection = !pick && !!omit;
-    prepare(dataType, out, projection_);
+    prepare(dataType, out, projection_, scopes);
     return Object.keys(out).length ? out : undefined;
 }
-export function prepare(dataType, target, projection) {
+export function prepare(dataType, target, projection, scopes) {
     const defaultFields = !projection || !Object.values(projection).find(p => !p.sign);
     const projectionKeys = projection && Object.keys(projection);
     const projectionKeysSet = new Set(projectionKeys);
@@ -26,6 +25,9 @@ export function prepare(dataType, target, projection) {
         fieldName = field.name;
         k = fieldName.toLowerCase();
         projectionKeysSet.delete(k);
+        /** Ignore if field is not in scope */
+        if (!field.inScope(scopes))
+            continue;
         const p = projection?.[k];
         if (
         /** Ignore if field is omitted */

package/esm/services/mongo-service.js

@@ -88,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;
     }
     /**
@@ -240,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;
@@ -259,7 +266,7 @@ export class MongoService extends ServiceBase {
         const options = {
             projection: '*',
             partial: 'deep',
-            ignoreHiddenFields: true,
+            scope: this._dataTypeScopes,
         };
         const dataType = this.dataType;
         validator = dataType.generateCodec('decode', options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/mongodb",
-  "version": "1.4.4",
+  "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.4",
-    "@opra/core": "^1.4.4",
-    "@opra/http": "^1.4.4",
+    "@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
      */