@opra/mongodb 1.4.4 → 1.5.1

package/cjs/adapter/mongo-patch-generator.js

@@ -6,7 +6,7 @@ const FIELD_NAME_PATTERN = /^([-><*:])?(.+)$/;
 class MongoPatchGenerator {
     generatePatch(dataType, doc, options) {
         const ctx = {};
-        this._processComplexType(ctx, dataType, options?.currentPath || '', doc);
+        this._processComplexType(ctx, dataType, options?.currentPath || '', doc, options?.scope);
         const update = {};
         if (ctx.$pull)
             update.$pull = ctx.$pull;
@@ -21,12 +21,12 @@ class MongoPatchGenerator {
             arrayFilters: ctx.arrayFilters,
         };
     }
-    _processComplexType(ctx, dataType, path, input) {
+    _processComplexType(ctx, dataType, path, input, scope) {
         if (input._$push) {
-            this._processPush(ctx, dataType, path, input._$push);
+            this._processPush(ctx, dataType, path, input._$push, scope);
         }
         if (input._$pull) {
-            this._processPull(ctx, dataType, path, input._$pull);
+            this._processPull(ctx, dataType, path, input._$pull, scope);
         }
         const keys = Object.keys(input);
         const pathDot = path + (path ? '.' : '');
@@ -42,8 +42,10 @@ class MongoPatchGenerator {
             if (!m)
                 continue;
             key = m[2];
+            if (key === '_$push' || key === '_$pull')
+                continue;
             value = input[key];
-            field = dataType.fields.get(key);
+            field = dataType.getField(key, scope);
             if (!field) {
                 if (dataType.additionalFields) {
                     if (value === null) {
@@ -54,7 +56,7 @@ class MongoPatchGenerator {
                         ctx.$set = ctx.$set || {};
                         if (dataType.additionalFields instanceof common_1.ComplexType) {
                             /** Process nested object */
-                            this._processComplexType(ctx, dataType.additionalFields, pathDot + key, value);
+                            this._processComplexType(ctx, dataType.additionalFields, pathDot + key, value, scope);
                             continue;
                         }
                         ctx.$set[pathDot + key] = value;
@@ -92,7 +94,7 @@ class MongoPatchGenerator {
                                 [`${arrayFilterName}.${keyField}`]: keyValue,
                             });
                             /** Process each object in array */
-                            this._processComplexType(ctx, field.type, pathDot + field.name + `.$[${arrayFilterName}]`, v);
+                            this._processComplexType(ctx, field.type, pathDot + field.name + `.$[${arrayFilterName}]`, v, scope);
                         }
                         continue;
                     }
@@ -100,14 +102,14 @@ class MongoPatchGenerator {
                 if (!(typeof value === 'object'))
                     continue;
                 /** Process nested object */
-                this._processComplexType(ctx, field.type, pathDot + field.name, value);
+                this._processComplexType(ctx, field.type, pathDot + field.name, value, scope);
                 continue;
             }
             ctx.$set = ctx.$set || {};
             ctx.$set[pathDot + field.name] = value;
         }
     }
-    _processPush(ctx, dataType, path, input) {
+    _processPush(ctx, dataType, path, input, scope) {
         let field;
         let key;
         let value;
@@ -116,7 +118,7 @@ class MongoPatchGenerator {
         let keyField;
         for (key of keys) {
             value = input[key];
-            field = dataType.fields.get(key);
+            field = dataType.getField(key, scope);
             if (!(field && field.isArray))
                 continue;
             ctx.$push = ctx.$push || {};
@@ -145,7 +147,7 @@ class MongoPatchGenerator {
                 : value;
         }
     }
-    _processPull(ctx, dataType, path, input) {
+    _processPull(ctx, dataType, path, input, scope) {
         let field;
         let key;
         let value;
@@ -154,7 +156,7 @@ class MongoPatchGenerator {
         let keyField;
         for (key of keys) {
             value = input[key];
-            field = dataType.fields.get(key);
+            field = dataType.getField(key, scope);
             if (!(field && field.isArray))
                 continue;
             ctx.$pull = ctx.$pull || {};

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, scope) {
     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_, scope);
     return Object.keys(out).length ? out : undefined;
 }
-function prepare(dataType, target, projection) {
+function prepare(dataType, target, projection, scope) {
     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 (scope && !field.inScope(scope))
+            continue;
         const p = projection?.[k];
         if (
         /** Ignore if field is omitted */

package/cjs/services/mongo-entity-service.js

@@ -406,7 +406,9 @@ class MongoEntityService extends mongo_service_js_1.MongoService {
     }
     _generatePatch(command, doc) {
         const patchGenerator = new mongo_patch_generator_js_1.MongoPatchGenerator();
-        const { update, arrayFilters } = patchGenerator.generatePatch(this.dataType, doc);
+        const { update, arrayFilters } = patchGenerator.generatePatch(this.dataType, doc, {
+            scope: this._dataTypeScope,
+        });
         command.options = command.options || {};
         if (arrayFilters) {
             command.options.arrayFilters = command.options.arrayFilters || [];

package/cjs/services/mongo-nested-service.js

@@ -35,7 +35,7 @@ class MongoNestedService extends mongo_service_js_1.MongoService {
      * @throws {NotAcceptableError} If the data type is not a ComplexType.
      */
     get dataType() {
-        const t = super.dataType.getField(this.fieldName).type;
+        const t = super.dataType.getField(this.fieldName, this.scope).type;
         if (!(t instanceof common_1.ComplexType))
             throw new common_1.NotAcceptableError(`Data type "${t.name}" is not a ComplexType`);
         return t;

package/cjs/services/mongo-service.js

@@ -91,8 +91,11 @@ class MongoService extends core_1.ServiceBase {
      * @throws {NotAcceptableError} If the data type is not a ComplexType.
      */
     get dataType() {
+        if (this._dataType && this._dataTypeScope !== this.scope)
+            this._dataType = undefined;
         if (!this._dataType)
             this._dataType = this.context.documentNode.getComplexType(this._dataType_);
+        this._dataTypeScope = this.scope;
         return this._dataType;
     }
     /**
@@ -243,6 +246,7 @@ class MongoService extends core_1.ServiceBase {
         if (validator)
             return validator;
         const options = { projection: '*' };
+        options.scope = this._dataTypeScope;
         if (operation === 'update') {
             options.partial = 'deep';
             options.allowPatchOperators = true;
@@ -262,7 +266,7 @@ class MongoService extends core_1.ServiceBase {
         const options = {
             projection: '*',
             partial: 'deep',
-            ignoreHiddenFields: true,
+            scope: this._dataTypeScope,
         };
         const dataType = this.dataType;
         validator = dataType.generateCodec('decode', options);

package/esm/adapter/mongo-patch-generator.js

@@ -3,7 +3,7 @@ const FIELD_NAME_PATTERN = /^([-><*:])?(.+)$/;
 export class MongoPatchGenerator {
     generatePatch(dataType, doc, options) {
         const ctx = {};
-        this._processComplexType(ctx, dataType, options?.currentPath || '', doc);
+        this._processComplexType(ctx, dataType, options?.currentPath || '', doc, options?.scope);
         const update = {};
         if (ctx.$pull)
             update.$pull = ctx.$pull;
@@ -18,12 +18,12 @@ export class MongoPatchGenerator {
             arrayFilters: ctx.arrayFilters,
         };
     }
-    _processComplexType(ctx, dataType, path, input) {
+    _processComplexType(ctx, dataType, path, input, scope) {
         if (input._$push) {
-            this._processPush(ctx, dataType, path, input._$push);
+            this._processPush(ctx, dataType, path, input._$push, scope);
         }
         if (input._$pull) {
-            this._processPull(ctx, dataType, path, input._$pull);
+            this._processPull(ctx, dataType, path, input._$pull, scope);
         }
         const keys = Object.keys(input);
         const pathDot = path + (path ? '.' : '');
@@ -39,8 +39,10 @@ export class MongoPatchGenerator {
             if (!m)
                 continue;
             key = m[2];
+            if (key === '_$push' || key === '_$pull')
+                continue;
             value = input[key];
-            field = dataType.fields.get(key);
+            field = dataType.getField(key, scope);
             if (!field) {
                 if (dataType.additionalFields) {
                     if (value === null) {
@@ -51,7 +53,7 @@ export class MongoPatchGenerator {
                         ctx.$set = ctx.$set || {};
                         if (dataType.additionalFields instanceof ComplexType) {
                             /** Process nested object */
-                            this._processComplexType(ctx, dataType.additionalFields, pathDot + key, value);
+                            this._processComplexType(ctx, dataType.additionalFields, pathDot + key, value, scope);
                             continue;
                         }
                         ctx.$set[pathDot + key] = value;
@@ -89,7 +91,7 @@ export class MongoPatchGenerator {
                                 [`${arrayFilterName}.${keyField}`]: keyValue,
                             });
                             /** Process each object in array */
-                            this._processComplexType(ctx, field.type, pathDot + field.name + `.$[${arrayFilterName}]`, v);
+                            this._processComplexType(ctx, field.type, pathDot + field.name + `.$[${arrayFilterName}]`, v, scope);
                         }
                         continue;
                     }
@@ -97,14 +99,14 @@ export class MongoPatchGenerator {
                 if (!(typeof value === 'object'))
                     continue;
                 /** Process nested object */
-                this._processComplexType(ctx, field.type, pathDot + field.name, value);
+                this._processComplexType(ctx, field.type, pathDot + field.name, value, scope);
                 continue;
             }
             ctx.$set = ctx.$set || {};
             ctx.$set[pathDot + field.name] = value;
         }
     }
-    _processPush(ctx, dataType, path, input) {
+    _processPush(ctx, dataType, path, input, scope) {
         let field;
         let key;
         let value;
@@ -113,7 +115,7 @@ export class MongoPatchGenerator {
         let keyField;
         for (key of keys) {
             value = input[key];
-            field = dataType.fields.get(key);
+            field = dataType.getField(key, scope);
             if (!(field && field.isArray))
                 continue;
             ctx.$push = ctx.$push || {};
@@ -142,7 +144,7 @@ export class MongoPatchGenerator {
                 : value;
         }
     }
-    _processPull(ctx, dataType, path, input) {
+    _processPull(ctx, dataType, path, input, scope) {
         let field;
         let key;
         let value;
@@ -151,7 +153,7 @@ export class MongoPatchGenerator {
         let keyField;
         for (key of keys) {
             value = input[key];
-            field = dataType.fields.get(key);
+            field = dataType.getField(key, scope);
             if (!(field && field.isArray))
                 continue;
             ctx.$pull = ctx.$pull || {};

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, scope) {
     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_, scope);
     return Object.keys(out).length ? out : undefined;
 }
-export function prepare(dataType, target, projection) {
+export function prepare(dataType, target, projection, scope) {
     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 (scope && !field.inScope(scope))
+            continue;
         const p = projection?.[k];
         if (
         /** Ignore if field is omitted */

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

@@ -403,7 +403,9 @@ export class MongoEntityService extends MongoService {
     }
     _generatePatch(command, doc) {
         const patchGenerator = new MongoPatchGenerator();
-        const { update, arrayFilters } = patchGenerator.generatePatch(this.dataType, doc);
+        const { update, arrayFilters } = patchGenerator.generatePatch(this.dataType, doc, {
+            scope: this._dataTypeScope,
+        });
         command.options = command.options || {};
         if (arrayFilters) {
             command.options.arrayFilters = command.options.arrayFilters || [];

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

@@ -32,7 +32,7 @@ export class MongoNestedService extends MongoService {
      * @throws {NotAcceptableError} If the data type is not a ComplexType.
      */
     get dataType() {
-        const t = super.dataType.getField(this.fieldName).type;
+        const t = super.dataType.getField(this.fieldName, this.scope).type;
         if (!(t instanceof ComplexType))
             throw new NotAcceptableError(`Data type "${t.name}" is not a ComplexType`);
         return t;

package/esm/services/mongo-service.js

@@ -88,8 +88,11 @@ export class MongoService extends ServiceBase {
      * @throws {NotAcceptableError} If the data type is not a ComplexType.
      */
     get dataType() {
+        if (this._dataType && this._dataTypeScope !== this.scope)
+            this._dataType = undefined;
         if (!this._dataType)
             this._dataType = this.context.documentNode.getComplexType(this._dataType_);
+        this._dataTypeScope = this.scope;
         return this._dataType;
     }
     /**
@@ -240,6 +243,7 @@ export class MongoService extends ServiceBase {
         if (validator)
             return validator;
         const options = { projection: '*' };
+        options.scope = this._dataTypeScope;
         if (operation === 'update') {
             options.partial = 'deep';
             options.allowPatchOperators = true;
@@ -259,7 +263,7 @@ export class MongoService extends ServiceBase {
         const options = {
             projection: '*',
             partial: 'deep',
-            ignoreHiddenFields: true,
+            scope: this._dataTypeScope,
         };
         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.1",
   "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.1",
+    "@opra/core": "^1.5.1",
+    "@opra/http": "^1.5.1",
     "mongodb": ">= 6.0.0"
   },
   "type": "module",

package/types/adapter/mongo-patch-generator.d.ts

@@ -13,13 +13,14 @@ export declare class MongoPatchGenerator {
         update: UpdateFilter<T>;
         arrayFilters?: Record<string, any>[];
     };
-    protected _processComplexType(ctx: Context, dataType: ComplexType, path: string, input: any): void;
-    protected _processPush(ctx: Context, dataType: ComplexType, path: string, input: any): void;
-    protected _processPull(ctx: Context, dataType: ComplexType, path: string, input: any): void;
+    protected _processComplexType(ctx: Context, dataType: ComplexType, path: string, input: any, scope?: string): void;
+    protected _processPush(ctx: Context, dataType: ComplexType, path: string, input: any, scope?: string): void;
+    protected _processPull(ctx: Context, dataType: ComplexType, path: string, input: any, scope?: string): void;
 }
 export declare namespace MongoPatchGenerator {
     interface Options {
         currentPath?: string;
+        scope?: string;
     }
 }
 export {};

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 | '*', scope?: string): mongodb.Document | undefined;
+export declare function prepare(dataType: ComplexType, target: mongodb.Document, projection?: FieldsProjection, scope?: string): void;

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

@@ -152,10 +152,15 @@ 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 _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
+     */
+    scope?: string;
     /**
      * Represents the name of a collection in MongoDB
      */