@opra/common 1.4.3 → 1.5.0

package/cjs/filter/filter-rules.js

@@ -32,11 +32,12 @@ class FilterRules {
             operators,
         }));
     }
-    normalizeFilter(filter, currentType) {
+    normalizeFilter(filter, currentType, element) {
         const ast = typeof filter === 'string' ? (0, parse_js_1.parse)(filter) : filter;
-        return this.normalizeFilterAst(ast, [], currentType);
+        const doc = element?.node.getDocument();
+        return this.normalizeFilterAst(ast, [], currentType, doc?.scopes);
     }
-    normalizeFilterAst(ast, stack, currentType) {
+    normalizeFilterAst(ast, stack, currentType, scopes) {
         if (ast instanceof index_js_4.ComparisonExpression) {
             stack.push(ast);
             this.normalizeFilterAst(ast.left, stack, currentType);
@@ -48,7 +49,9 @@ class FilterRules {
             const rule = this._rules.get(ast.left.value);
             if (!rule) {
                 throw new index_js_1.OpraException({
-                    message: (0, index_js_3.translate)('error:UNACCEPTED_FILTER_FIELD', { field: ast.left.value }),
+                    message: (0, index_js_3.translate)('error:UNACCEPTED_FILTER_FIELD', {
+                        field: ast.left.value,
+                    }),
                     code: 'UNACCEPTED_FILTER_FIELD',
                     details: {
                         field: ast.left.value,
@@ -58,7 +61,9 @@ class FilterRules {
             // Check if filtering endpoint accepted for given field
             if (rule.operators && !rule.operators.includes(ast.op)) {
                 throw new index_js_1.OpraException({
-                    message: (0, index_js_3.translate)('error:UNACCEPTED_FILTER_OPERATION', { field: ast.left.value }),
+                    message: (0, index_js_3.translate)('error:UNACCEPTED_FILTER_OPERATION', {
+                        field: ast.left.value,
+                    }),
                     code: 'UNACCEPTED_FILTER_OPERATION',
                     details: {
                         field: ast.left.value,
@@ -108,20 +113,25 @@ class FilterRules {
                 /** If calling for right side of comparison */
                 if (ast === comp.right || stack[compIdx + 1] === comp.right) {
                     /** Check if comparison expression left side is a field */
-                    if (comp && comp.left instanceof index_js_4.QualifiedIdentifier && comp.left.field) {
+                    if (comp &&
+                        comp.left instanceof index_js_4.QualifiedIdentifier &&
+                        comp.left.field) {
                         if (ast.value == null && !comp.left.field.required)
                             return ast.value;
                         let decoder;
-                        if (comp.op === 'like' || comp.op === '!like' || comp.op === 'ilike' || comp.op === '!ilike') {
+                        if (comp.op === 'like' ||
+                            comp.op === '!like' ||
+                            comp.op === 'ilike' ||
+                            comp.op === '!ilike') {
                             decoder = valgen_1.isString;
                         }
                         else
                             decoder = this._decoderCache.get(comp.left.field);
                         if (!decoder) {
                             decoder = comp.left.field.type.generateCodec('decode', {
+                                scope: scopes,
                                 projection: '*',
                                 ignoreWriteonlyFields: true,
-                                ignoreHiddenFields: true,
                                 coerce: true,
                             });
                             this._decoderCache.set(comp.left.field, decoder);

package/cjs/filter/filter-tree-visitor.js

@@ -45,7 +45,8 @@ class FilterTreeVisitor extends antlr4_1.ParseTreeVisitor {
         const items = [];
         const wrapChildren = (arr, op) => {
             for (const c of arr) {
-                if (c instanceof OpraFilterParser_js_1.LogicalExpressionContext && c.logicalOperator().getText() === op) {
+                if (c instanceof OpraFilterParser_js_1.LogicalExpressionContext &&
+                    c.logicalOperator().getText() === op) {
                     wrapChildren(c.expression_list(), c.logicalOperator().getText());
                     continue;
                 }

package/cjs/filter/opra-error-listener.js

@@ -9,7 +9,13 @@ class OpraErrorListener extends antlr4_1.ErrorListener {
         this.errors = errors;
     }
     syntaxError(recognizer, offendingSymbol, line, column, msg, e) {
-        this.errors.push(new errors_js_1.FilterParseError(msg, { recognizer, offendingSymbol, line, column, e }));
+        this.errors.push(new errors_js_1.FilterParseError(msg, {
+            recognizer,
+            offendingSymbol,
+            line,
+            column,
+            e,
+        }));
     }
 }
 exports.OpraErrorListener = OpraErrorListener;

package/cjs/filter/parse.js

@@ -25,7 +25,9 @@ function parse(text, visitor) {
         const errMsgs = [];
         for (const err of errors) {
             errMsgs.push(err.message +
-                (text.includes('\n') ? ' at line: ' + err.line + ' column: ' + err.column : ' at column: ' + err.column));
+                (text.includes('\n')
+                    ? ' at line: ' + err.line + ' column: ' + err.column
+                    : ' at column: ' + err.column));
         }
         const e = new errors_js_1.SyntaxError(errMsgs.join('\n'));
         e.errors = errors;

package/cjs/filter/utils.js

@@ -15,7 +15,9 @@ function quoteFilterString(s) {
     return "'" + escapeString(s).replace(quotesRegEx, "\\'") + "'";
 }
 function unquoteFilterString(s) {
-    if (s && (s.startsWith("'") || s.startsWith('"')) && s.endsWith(s.charAt(0))) {
+    if (s &&
+        (s.startsWith("'") || s.startsWith('"')) &&
+        s.endsWith(s.charAt(0))) {
         return unescapeString(s.substring(1, s.length - 1));
     }
     /* istanbul ignore next */

package/cjs/helpers/get-stack-filename.js

@@ -18,7 +18,9 @@ function getStackFileName(position = 1) {
     if (stack !== null && typeof stack === 'object') {
         // stack[0] holds this file
         // stack[1] holds where this function was called
-        const s = stack[position] ? stack[position].getFileName() : undefined;
+        const s = stack[position]
+            ? stack[position].getFileName()
+            : undefined;
         const m = s ? PATH_PATTERN.exec(s) : undefined;
         return m ? m[1] : '';
     }
@@ -39,7 +41,9 @@ function getErrorStack(position = 1) {
     if (stack !== null && typeof stack === 'object') {
         // stack[0] holds this file
         // stack[1] holds where this function was called
-        const s = stack[position] ? stack[position].getFileName() : undefined;
+        const s = stack[position]
+            ? stack[position].getFileName()
+            : undefined;
         const m = s ? PATH_PATTERN.exec(s) : undefined;
         return m ? m[1] : '';
     }

package/cjs/helpers/mixin-utils.js

@@ -4,7 +4,11 @@ exports.mergePrototype = mergePrototype;
 exports.inheritPropertyInitializers = inheritPropertyInitializers;
 function mergePrototype(targetProto, baseProto, filter) {
     for (const k of Object.getOwnPropertyNames(baseProto)) {
-        if (k === 'constructor' || k === '__proto__' || k === 'toJSON' || k === 'toString' || (filter && !filter(k))) {
+        if (k === 'constructor' ||
+            k === '__proto__' ||
+            k === 'toJSON' ||
+            k === 'toString' ||
+            (filter && !filter(k))) {
             continue;
         }
         Object.defineProperty(targetProto, k, Object.getOwnPropertyDescriptor(baseProto, k) || Object.create(null));
@@ -18,7 +22,8 @@ isPropertyInherited = (key) => true) {
         const tempInstance = new clazz();
         const propertyNames = Object.getOwnPropertyNames(tempInstance);
         propertyNames
-            .filter(propertyName => typeof tempInstance[propertyName] !== 'undefined' && typeof target[propertyName] === 'undefined')
+            .filter(propertyName => typeof tempInstance[propertyName] !== 'undefined' &&
+            typeof target[propertyName] === 'undefined')
             .filter(propertyName => isPropertyInherited(propertyName))
             .forEach(propertyName => {
             target[propertyName] = tempInstance[propertyName];

package/cjs/helpers/object-utils.js

@@ -10,7 +10,9 @@ function cloneObject(obj, jsonOnly) {
         ignoreUndefined: true,
         filter(key, source) {
             const v = source[key];
-            return !jsonOnly || (typeof v !== 'function' && (typeof v !== 'object' || (0, objects_1.isPlainObject)(v) || Array.isArray(v)));
+            return (!jsonOnly ||
+                (typeof v !== 'function' &&
+                    (typeof v !== 'object' || (0, objects_1.isPlainObject)(v) || Array.isArray(v))));
         },
     });
 }

package/cjs/helpers/parse-fields-projection.js

@@ -52,14 +52,16 @@ function parse(input, target) {
         if (!m)
             throw new TypeError(`Invalid field path (${input})`);
         const fieldName = m[2];
-        const treeItem = (target[fieldName] = target[fieldName] || new FieldsProjection.Item());
+        const treeItem = (target[fieldName] =
+            target[fieldName] || new FieldsProjection.Item());
         if (m[1])
             treeItem.sign = m[1];
         if (i === fields.length - 1) {
             delete treeItem.projection;
         }
         else {
-            target = treeItem.projection = treeItem.projection || new FieldsProjection();
+            target = treeItem.projection =
+                treeItem.projection || new FieldsProjection();
         }
     }
 }

package/cjs/helpers/type-guards.js

@@ -11,7 +11,9 @@ function isStream(x) {
     return x !== null && typeof x === 'object' && typeof x.pipe === 'function';
 }
 function isReadable(x) {
-    return isStream(x) && typeof x._read === 'function' && typeof x._readableState === 'object';
+    return (isStream(x) &&
+        typeof x._read === 'function' &&
+        typeof x._readableState === 'object');
 }
 function isWritable(x) {
     return isStream(x) && typeof x._write === 'function';
@@ -37,5 +39,8 @@ function isFormData(x) {
         typeof x.getAll === 'function');
 }
 function isURL(x) {
-    return x !== null && typeof x == 'object' && typeof x.host === 'string' && typeof x.href === 'string';
+    return (x !== null &&
+        typeof x == 'object' &&
+        typeof x.host === 'string' &&
+        typeof x.href === 'string');
 }

package/cjs/i18n/i18n.js

@@ -5,7 +5,9 @@ const tslib_1 = require("tslib");
 const i18next_1 = tslib_1.__importDefault(require("@browsery/i18next"));
 const fast_tokenizer_1 = require("fast-tokenizer");
 const string_utils_js_1 = require("./string-utils.js");
-exports.BaseI18n = Object.getPrototypeOf(i18next_1.default.createInstance()).constructor;
+// eslint-disable-next-line import-x/no-named-as-default-member
+exports.BaseI18n = Object.getPrototypeOf(i18next_1.default.createInstance())
+    .constructor;
 class I18n extends exports.BaseI18n {
     async init(arg0, arg1) {
         const options = typeof arg0 === 'object' ? arg0 : {};
@@ -66,12 +68,20 @@ class I18n extends exports.BaseI18n {
             })) {
                 if (token.startsWith('$t(') && token.endsWith(')')) {
                     token = token.substring(3, token.length - 1);
-                    const a = (0, fast_tokenizer_1.splitString)(token, { delimiters: '?', quotes: true, brackets: { '{': '}' } });
+                    const a = (0, fast_tokenizer_1.splitString)(token, {
+                        delimiters: '?',
+                        quotes: true,
+                        brackets: { '{': '}' },
+                    });
                     const fallback = (0, string_utils_js_1.unescapeString)(token.substring((a[0] || '').length + 1));
                     token = a[0] || '';
                     const keys = [];
                     let opts = null;
-                    for (const token2 of (0, fast_tokenizer_1.tokenize)(token, { delimiters: ',', quotes: true, brackets: { '{': '}' } })) {
+                    for (const token2 of (0, fast_tokenizer_1.tokenize)(token, {
+                        delimiters: ',',
+                        quotes: true,
+                        brackets: { '{': '}' },
+                    })) {
                         if (token2.startsWith('{')) {
                             opts = JSON.parse(token2);
                             continue;

package/cjs/i18n/translate.js

@@ -9,6 +9,8 @@ function translate(key, arg0, arg1) {
     return ('$t(' +
         key +
         (options ? ',' + JSON.stringify(options) : '') +
-        (fallback ? '?' + (0, string_utils_js_1.escapeString)(fallback).replace(bracketRegEx, '\\$1') : '') +
+        (fallback
+            ? '?' + (0, string_utils_js_1.escapeString)(fallback).replace(bracketRegEx, '\\$1')
+            : '') +
         ')');
 }

package/cjs/polifils/array-find-last.js

@@ -1,12 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 if (!Array.prototype.findLast) {
-    // eslint-disable-next-line no-extend-native
     Array.prototype.findLast = function (predicate, thisArg) {
         const i = this.findLastIndex(predicate, thisArg);
         return i >= 0 ? this[i] : undefined;
     };
-    // eslint-disable-next-line no-extend-native
     Array.prototype.findLastIndex = function (predicate, thisArg) {
         if (this == null) {
             throw new TypeError('this is null or not defined');

package/esm/document/api-document.js

@@ -5,7 +5,7 @@ import { cloneObject, ResponsiveMap } from '../helpers/index.js';
 import { OpraSchema } from '../schema/index.js';
 import { DataTypeMap } from './common/data-type-map.js';
 import { DocumentElement } from './common/document-element.js';
-import { BUILTIN, kDataTypeMap, kTypeNSMap, NAMESPACE_PATTERN } from './constants.js';
+import { BUILTIN, kDataTypeMap, kTypeNSMap, NAMESPACE_PATTERN, } from './constants.js';
 import { DataType } from './data-type/data-type.js';
 import { HttpApi } from './http/http-api.js';
 import { RpcApi } from './rpc/rpc-api.js';
@@ -29,7 +29,9 @@ export class ApiDocument extends DocumentElement {
      * @param nameOrCtor
      */
     getDataTypeNs(nameOrCtor) {
-        const dt = nameOrCtor instanceof DataType ? this._findDataType(nameOrCtor.name || '') : this._findDataType(nameOrCtor);
+        const dt = nameOrCtor instanceof DataType
+            ? this._findDataType(nameOrCtor.name || '')
+            : this._findDataType(nameOrCtor);
         if (dt)
             return this[kTypeNSMap].get(dt);
     }
@@ -62,13 +64,14 @@ export class ApiDocument extends DocumentElement {
     /**
      * Export as Opra schema definition object
      */
-    export() {
+    export(options) {
         const out = omitUndefined({
             spec: OpraSchema.SpecVersion,
             id: this.id,
             url: this.url,
             info: cloneObject(this.info, true),
         });
+        options = options || { scopes: this.scopes };
         if (this.references.size) {
             let i = 0;
             const references = {};
@@ -88,25 +91,29 @@ export class ApiDocument extends DocumentElement {
         if (this.types.size) {
             out.types = {};
             for (const v of this.types.values()) {
-                out.types[v.name] = v.toJSON();
+                if (!v.inScope(options.scopes))
+                    continue;
+                out.types[v.name] = v.toJSON(options);
             }
         }
         if (this.api)
-            out.api = this.api.toJSON();
+            out.api = this.api.toJSON(options);
         return out;
     }
     invalidate() {
         /** Generate id */
-        const x = this.export();
+        const x = this.export({});
         delete x.id;
         this.id = md5(JSON.stringify(x));
         /** Clear [kTypeNSMap] */
         this[kTypeNSMap] = new WeakMap();
     }
-    _findDataType(nameOrCtor, visitedRefs) {
+    _findDataType(nameOrCtor, scope, visitedRefs) {
         let result = this.types.get(nameOrCtor);
-        if (result || !this.references.size)
+        if (result && result.inScope(scope))
             return result;
+        if (!this.references.size)
+            return;
         // Lookup for references
         if (typeof nameOrCtor === 'string') {
             // If given string has namespace pattern (ns:type_name)
@@ -120,7 +127,7 @@ export class ApiDocument extends DocumentElement {
                     visitedRefs = visitedRefs || new WeakMap();
                     visitedRefs.set(this, true);
                     visitedRefs.set(ref, true);
-                    return ref._findDataType(m[2], visitedRefs);
+                    return ref._findDataType(m[2], scope, visitedRefs);
                 }
                 nameOrCtor = m[2];
             }
@@ -142,7 +149,7 @@ export class ApiDocument extends DocumentElement {
         for (const refNs of references) {
             const ref = this.references.get(refNs);
             visitedRefs.set(ref, true);
-            result = ref._findDataType(nameOrCtor, visitedRefs);
+            result = ref._findDataType(nameOrCtor, scope, visitedRefs);
             if (result) {
                 this[kTypeNSMap].set(result, ref?.[BUILTIN] ? '' : refNs);
                 return result;

package/esm/document/common/api-base.js

@@ -8,15 +8,17 @@ export class ApiBase extends DocumentElement {
         this.name = init.name;
         this.description = init.description;
     }
-    toJSON() {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    toJSON(options) {
         return omitUndefined({
             transport: this.transport,
             name: this.name,
             description: this.description,
         });
     }
+    async _initialize(init, 
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    async _initialize(init, context) {
+    context) {
         if (!CLASS_NAME_PATTERN.test(init.name))
             throw new TypeError(`Invalid api name (${init.name})`);
         this.name = init.name;

package/esm/document/common/data-type-map.js

@@ -19,7 +19,9 @@ export class DataTypeMap {
         this[kMap].forEach(callbackFn, thisArg);
     }
     get(nameOrCtor) {
-        let name = typeof nameOrCtor === 'string' ? nameOrCtor : this[kCtorMap].get(nameOrCtor);
+        let name = typeof nameOrCtor === 'string'
+            ? nameOrCtor
+            : this[kCtorMap].get(nameOrCtor);
         if (!name && typeof nameOrCtor === 'function') {
             const metadata = Reflect.getMetadata(DATATYPE_METADATA, nameOrCtor);
             name = metadata?.name;
@@ -28,7 +30,14 @@ export class DataTypeMap {
             const metadata = nameOrCtor[DATATYPE_METADATA];
             name = metadata?.name;
         }
-        return name ? this[kMap].get(name) : undefined;
+        if (!name)
+            return;
+        const out = this[kMap].get(name);
+        if (!out)
+            return;
+        if (typeof nameOrCtor === 'function' && out.kind === 'ComplexType')
+            return out.ctor === nameOrCtor ? out : undefined;
+        return out;
     }
     set(name, dataType) {
         this[kMap].set(name, dataType);
@@ -40,7 +49,9 @@ export class DataTypeMap {
     has(nameOrCtor) {
         if (nameOrCtor instanceof DataType)
             return !!nameOrCtor.name && this[kMap].has(nameOrCtor.name);
-        const name = typeof nameOrCtor === 'string' ? nameOrCtor : this[kCtorMap].get(nameOrCtor);
+        const name = typeof nameOrCtor === 'string'
+            ? nameOrCtor
+            : this[kCtorMap].get(nameOrCtor);
         return name ? this[kMap].has(name) : false;
     }
     keys() {

package/esm/document/common/document-init-context.js

@@ -6,6 +6,11 @@ export class DocumentInitContext {
         this.showErrorDetails = true;
         this.maxErrors = options?.maxErrors || 0;
         this.error.message = '';
+        this.scopes = options?.scopes
+            ? Array.isArray(options.scopes)
+                ? options?.scopes
+                : [options?.scopes]
+            : undefined;
     }
     addError(error) {
         if (!this.error.details.length) {

package/esm/document/common/document-node.js

@@ -18,25 +18,24 @@ export class DocumentNode {
         // istanbul ignore next
         throw new Error('ApiDocument not found in document tree');
     }
-    hasDataType(nameOrCtor) {
-        const result = this[kDataTypeMap]?.has(nameOrCtor);
-        if (result)
-            return result;
-        return this.parent ? this.parent.hasDataType(nameOrCtor) : false;
+    hasDataType(nameOrCtor, scope) {
+        return !!this.findDataType(nameOrCtor, scope);
     }
-    findDataType(nameOrCtor) {
-        const result = this[kDataTypeMap]?.get(nameOrCtor);
-        if (result)
-            return result;
-        return this.parent ? this.parent.findDataType(nameOrCtor) : undefined;
+    findDataType(nameOrCtor, scope) {
+        scope = scope || this.getDocument().scopes;
+        const dt = this[kDataTypeMap]?.get(nameOrCtor);
+        if (dt && dt.inScope(scope))
+            return dt;
+        return this.parent
+            ? this.parent.findDataType(nameOrCtor, scope)
+            : undefined;
     }
     /**
      * Returns DataType instance by name or Constructor. Returns undefined if not found
-     * @param nameOrCtor
      */
-    getDataType(nameOrCtor) {
+    getDataType(nameOrCtor, scope) {
         const dt = this.findDataType(nameOrCtor);
-        if (dt)
+        if (dt && dt.inScope(scope))
             return dt;
         let name = '';
         if (typeof nameOrCtor === 'function') {
@@ -53,7 +52,9 @@ export class DocumentNode {
             else if (typeof nameOrCtor === 'function')
                 name = nameOrCtor.name;
         }
-        throw new TypeError(`Unknown data type` + (name ? ' (' + name + ')' : ''));
+        if (dt)
+            throw new TypeError(`Data type${name ? ' (' + name + ')' : ''} is not in requested scope (${scope})`);
+        throw new TypeError(`Unknown data type${name ? ' (' + name + ')' : ''}`);
     }
     getDataTypeNameWithNs(dataType) {
         if (!dataType.name)
@@ -65,10 +66,9 @@ export class DocumentNode {
      * Returns ComplexType instance by name or Constructor.
      * Returns undefined if not found
      * Throws error if data type is not a ComplexType
-     * @param nameOrCtor
      */
-    getComplexType(nameOrCtor) {
-        const t = this.getDataType(nameOrCtor);
+    getComplexType(nameOrCtor, scope) {
+        const t = this.getDataType(nameOrCtor, scope);
         if (t.kind === OpraSchema.ComplexType.Kind)
             return t;
         throw new TypeError(`Data type "${t.name}" is not a ComplexType`);
@@ -77,10 +77,9 @@ export class DocumentNode {
      * Returns SimpleType instance by name or Constructor.
      * Returns undefined if not found
      * Throws error if data type is not a SimpleType
-     * @param nameOrCtor
      */
-    getSimpleType(nameOrCtor) {
-        const t = this.getDataType(nameOrCtor);
+    getSimpleType(nameOrCtor, scope) {
+        const t = this.getDataType(nameOrCtor, scope);
         if (t.kind === OpraSchema.SimpleType.Kind)
             return t;
         throw new TypeError(`Data type "${t.name || t}" is not a SimpleType`);
@@ -89,10 +88,9 @@ export class DocumentNode {
      * Returns EnumType instance by name or Constructor.
      * Returns undefined if not found
      * Throws error if data type is not a EnumType
-     * @param nameOrCtor
      */
-    getEnumType(nameOrCtor) {
-        const t = this.getDataType(nameOrCtor);
+    getEnumType(nameOrCtor, scope) {
+        const t = this.getDataType(nameOrCtor, scope);
         if (t.kind === OpraSchema.EnumType.Kind)
             return t;
         throw new TypeError(`Data type "${t.name || t}" is not a EnumType`);
@@ -101,10 +99,9 @@ export class DocumentNode {
      * Returns EnumType instance by name or Constructor.
      * Returns undefined if not found
      * Throws error if data type is not a MappedType
-     * @param nameOrCtor
      */
-    getMappedType(nameOrCtor) {
-        const t = this.getDataType(nameOrCtor);
+    getMappedType(nameOrCtor, scope) {
+        const t = this.getDataType(nameOrCtor, scope);
         if (t.kind === OpraSchema.MappedType.Kind)
             return t;
         throw new TypeError(`Data type "${t.name || t}" is not a MappedType`);
@@ -113,10 +110,9 @@ export class DocumentNode {
      * Returns EnumType instance by name or Constructor.
      * Returns undefined if not found
      * Throws error if data type is not a MixinType
-     * @param nameOrCtor
      */
-    getMixinType(nameOrCtor) {
-        const t = this.getDataType(nameOrCtor);
+    getMixinType(nameOrCtor, scope) {
+        const t = this.getDataType(nameOrCtor, scope);
         if (t.kind === OpraSchema.MixinType.Kind)
             return t;
         throw new TypeError(`Data type "${t.name || t}" is not a MixinType`);

package/esm/document/common/value.js

@@ -17,10 +17,16 @@ export const Value = function (owner, initArgs) {
  * @class Value
  */
 class ValueClass extends DocumentElement {
-    toJSON() {
-        const typeName = this.type ? this.node.getDataTypeNameWithNs(this.type) : undefined;
+    toJSON(options) {
+        const typeName = this.type
+            ? this.node.getDataTypeNameWithNs(this.type)
+            : undefined;
         return omitUndefined({
-            type: this.type ? (typeName ? typeName : this.type.toJSON()) : 'any',
+            type: this.type
+                ? typeName
+                    ? typeName
+                    : this.type.toJSON(options)
+                : 'any',
             description: this.description,
             isArray: this.isArray,
             examples: this.examples,

package/esm/document/constants.js

@@ -7,7 +7,6 @@ export const DECORATOR = Symbol.for('DECORATOR');
 export const BUILTIN = Symbol.for('BUILTIN');
 export const NAMESPACE_PATTERN = /([a-z$_]\w+):(.+)/i;
 export const CLASS_NAME_PATTERN = /^[a-z][\w_]*$/i;
-export const EXTRACT_TYPENAME_PATTERN = /^(.*)Type(\d*)$/;
 export const kDataTypeMap = Symbol.for('kDataTypeMap');
 export const kCtorMap = Symbol.for('kCtorMap');
 export const kTypeNSMap = Symbol.for('kTypeNSMap');

package/esm/document/data-type/api-field.js

@@ -25,6 +25,7 @@ export const ApiField = function (...args) {
         throw new Error('Field origin should be one of ComplexType, MappedType or MixinType');
     }
     _this.origin = origin;
+    _this.scopes = initArgs.scopes;
     _this.type = initArgs.type || owner.node.getDataType('any');
     _this.description = initArgs.description;
     _this.isArray = initArgs.isArray;
@@ -38,17 +39,31 @@ export const ApiField = function (...args) {
     _this.readonly = initArgs.readonly;
     _this.writeonly = initArgs.writeonly;
     _this.examples = initArgs.examples;
-    _this.hidden = initArgs.hidden;
 };
 /**
  *
  * @class ApiField
  */
 class ApiFieldClass extends DocumentElement {
-    toJSON() {
-        const typeName = this.type ? this.node.getDataTypeNameWithNs(this.type) : undefined;
+    inScope(scopes) {
+        if (!this.scopes?.length || !scopes)
+            return true;
+        /** this.scope should match all required scopes */
+        scopes = Array.isArray(scopes) ? scopes : [scopes];
+        for (const scope of scopes) {
+            if (!this.scopes.some(s => {
+                return typeof s === 'string' ? scope === s : s.test(scope);
+            }))
+                return false;
+        }
+        return true;
+    }
+    toJSON(options) {
+        const typeName = this.type
+            ? this.node.getDataTypeNameWithNs(this.type)
+            : undefined;
         return omitUndefined({
-            type: typeName ? typeName : this.type?.toJSON(),
+            type: typeName ? typeName : this.type?.toJSON(options),
             description: this.description,
             isArray: this.isArray || undefined,
             default: this.default,