@opra/elastic 1.5.1 → 1.5.3

package/cjs/adapter-utils/prepare-projection.js

@@ -3,14 +3,14 @@ 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) {
     const out = {};
     const includes = [];
     const excludes = [];
     const projection_ = typeof projection === 'string' || Array.isArray(projection)
         ? (0, common_1.parseFieldsProjection)(projection)
         : projection;
-    prepare(dataType, includes, excludes, '', projection_);
+    prepare(dataType, includes, excludes, '', projection_, scope);
     if (includes.length)
         out.includes = includes;
     if (excludes.length)
@@ -20,7 +20,7 @@ function prepareProjection(dataType, projection) {
 function getNeedIncludes(projection) {
     return !!(projection && Object.values(projection).find(p => !p.sign));
 }
-function prepare(dataType, includes, excludes, curPath, projection) {
+function prepare(dataType, includes, excludes, curPath, projection, scope) {
     const needIncludes = getNeedIncludes(projection);
     const projectionKeys = projection && Object.keys(projection);
     const projectionKeysSet = new Set(projectionKeys);
@@ -29,7 +29,7 @@ function prepare(dataType, includes, excludes, curPath, projection) {
     let field;
     let k;
     /** Add fields from data type */
-    for (field of dataType.fields.values()) {
+    for (field of dataType.fields(scope)) {
         fieldName = field.name;
         fieldPath = curPath + (curPath ? '.' : '') + fieldName;
         k = fieldName.toLowerCase();

package/cjs/elastic-entity-service.js

@@ -72,8 +72,11 @@ class ElasticEntityService extends elastic_service_js_1.ElasticService {
      * @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;
     }
     /**
@@ -212,7 +215,7 @@ class ElasticEntityService extends elastic_service_js_1.ElasticService {
             sort: options?.sort
                 ? elastic_adapter_js_1.ElasticAdapter.prepareSort(options?.sort)
                 : undefined,
-            _source: elastic_adapter_js_1.ElasticAdapter.prepareProjection(this.dataType, options?.projection),
+            _source: elastic_adapter_js_1.ElasticAdapter.prepareProjection(this.dataType, options?.projection, this.scope),
             index: this.getIndexName(),
             ...options?.request,
             query,
@@ -299,7 +302,10 @@ class ElasticEntityService extends elastic_service_js_1.ElasticService {
         let validator = this._inputCodecs[operation];
         if (validator)
             return validator;
-        const options = { projection: '*' };
+        const options = {
+            projection: '*',
+            scope: this._dataTypeScope,
+        };
         if (operation === 'update')
             options.partial = 'deep';
         const dataType = this.dataType;
@@ -317,6 +323,7 @@ class ElasticEntityService extends elastic_service_js_1.ElasticService {
         const options = {
             projection: '*',
             partial: 'deep',
+            scope: this._dataTypeScope,
         };
         const dataType = this.dataType;
         validator = dataType.generateCodec('decode', options);

package/esm/adapter-utils/prepare-projection.js

@@ -1,12 +1,12 @@
 import { ComplexType, parseFieldsProjection, } from '@opra/common';
-export default function prepareProjection(dataType, projection) {
+export default function prepareProjection(dataType, projection, scope) {
     const out = {};
     const includes = [];
     const excludes = [];
     const projection_ = typeof projection === 'string' || Array.isArray(projection)
         ? parseFieldsProjection(projection)
         : projection;
-    prepare(dataType, includes, excludes, '', projection_);
+    prepare(dataType, includes, excludes, '', projection_, scope);
     if (includes.length)
         out.includes = includes;
     if (excludes.length)
@@ -16,7 +16,7 @@ export default function prepareProjection(dataType, projection) {
 function getNeedIncludes(projection) {
     return !!(projection && Object.values(projection).find(p => !p.sign));
 }
-export function prepare(dataType, includes, excludes, curPath, projection) {
+export function prepare(dataType, includes, excludes, curPath, projection, scope) {
     const needIncludes = getNeedIncludes(projection);
     const projectionKeys = projection && Object.keys(projection);
     const projectionKeysSet = new Set(projectionKeys);
@@ -25,7 +25,7 @@ export function prepare(dataType, includes, excludes, curPath, projection) {
     let field;
     let k;
     /** Add fields from data type */
-    for (field of dataType.fields.values()) {
+    for (field of dataType.fields(scope)) {
         fieldName = field.name;
         fieldPath = curPath + (curPath ? '.' : '') + fieldName;
         k = fieldName.toLowerCase();

package/esm/elastic-entity-service.js

@@ -69,8 +69,11 @@ export class ElasticEntityService extends ElasticService {
      * @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;
     }
     /**
@@ -209,7 +212,7 @@ export class ElasticEntityService extends ElasticService {
             sort: options?.sort
                 ? ElasticAdapter.prepareSort(options?.sort)
                 : undefined,
-            _source: ElasticAdapter.prepareProjection(this.dataType, options?.projection),
+            _source: ElasticAdapter.prepareProjection(this.dataType, options?.projection, this.scope),
             index: this.getIndexName(),
             ...options?.request,
             query,
@@ -296,7 +299,10 @@ export class ElasticEntityService extends ElasticService {
         let validator = this._inputCodecs[operation];
         if (validator)
             return validator;
-        const options = { projection: '*' };
+        const options = {
+            projection: '*',
+            scope: this._dataTypeScope,
+        };
         if (operation === 'update')
             options.partial = 'deep';
         const dataType = this.dataType;
@@ -314,6 +320,7 @@ export class ElasticEntityService extends ElasticService {
         const options = {
             projection: '*',
             partial: 'deep',
+            scope: this._dataTypeScope,
         };
         const dataType = this.dataType;
         validator = dataType.generateCodec('decode', options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/elastic",
-  "version": "1.5.1",
+  "version": "1.5.3",
   "description": "Opra Elastic Search adapter package",
   "author": "Panates",
   "license": "MIT",
@@ -11,8 +11,8 @@
   },
   "peerDependencies": {
     "@elastic/elasticsearch": ">=8.7.0",
-    "@opra/common": "^1.5.1",
-    "@opra/core": "^1.5.1"
+    "@opra/common": "^1.5.3",
+    "@opra/core": "^1.5.3"
   },
   "type": "module",
   "exports": {

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

@@ -3,5 +3,5 @@ export interface ElasticProjection {
     includes?: string[];
     excludes?: string[];
 }
-export default function prepareProjection(dataType: ComplexType, projection?: string | string[]): ElasticProjection | undefined;
-export declare function prepare(dataType: ComplexType, includes: string[], excludes: string[], curPath: string, projection?: FieldsProjection): void;
+export default function prepareProjection(dataType: ComplexType, projection?: string | string[], scope?: string): ElasticProjection | undefined;
+export declare function prepare(dataType: ComplexType, includes: string[], excludes: string[], curPath: string, projection?: FieldsProjection, scope?: string): void;

package/types/elastic-entity-service.d.ts

@@ -20,6 +20,7 @@ export declare namespace ElasticEntityService {
         indexName?: ElasticEntityService['indexName'];
         resourceName?: ElasticEntityService['resourceName'];
         idGenerator?: ElasticEntityService['idGenerator'];
+        scope?: ElasticEntityService['scope'];
     }
     interface CommandInfo extends ElasticService.CommandInfo {
     }
@@ -141,10 +142,15 @@ export declare namespace ElasticEntityService {
  * @template T - The type of the documents in the collection.
  */
 export declare class ElasticEntityService<T extends object = any> extends ElasticService {
+    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 index in ElasticDB
      */