@opra/common 1.4.3 → 1.5.0

package/cjs/document/api-document.js

@@ -32,7 +32,9 @@ class ApiDocument extends document_element_js_1.DocumentElement {
      * @param nameOrCtor
      */
     getDataTypeNs(nameOrCtor) {
-        const dt = nameOrCtor instanceof data_type_js_1.DataType ? this._findDataType(nameOrCtor.name || '') : this._findDataType(nameOrCtor);
+        const dt = nameOrCtor instanceof data_type_js_1.DataType
+            ? this._findDataType(nameOrCtor.name || '')
+            : this._findDataType(nameOrCtor);
         if (dt)
             return this[constants_js_1.kTypeNSMap].get(dt);
     }
@@ -65,13 +67,14 @@ class ApiDocument extends document_element_js_1.DocumentElement {
     /**
      * Export as Opra schema definition object
      */
-    export() {
+    export(options) {
         const out = (0, objects_1.omitUndefined)({
             spec: index_js_2.OpraSchema.SpecVersion,
             id: this.id,
             url: this.url,
             info: (0, index_js_1.cloneObject)(this.info, true),
         });
+        options = options || { scopes: this.scopes };
         if (this.references.size) {
             let i = 0;
             const references = {};
@@ -91,25 +94,29 @@ class ApiDocument extends document_element_js_1.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 = (0, super_fast_md5_1.md5)(JSON.stringify(x));
         /** Clear [kTypeNSMap] */
         this[constants_js_1.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)
@@ -123,7 +130,7 @@ class ApiDocument extends document_element_js_1.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];
             }
@@ -145,7 +152,7 @@ class ApiDocument extends document_element_js_1.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[constants_js_1.kTypeNSMap].set(result, ref?.[constants_js_1.BUILTIN] ? '' : refNs);
                 return result;

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

@@ -11,15 +11,17 @@ class ApiBase extends document_element_js_1.DocumentElement {
         this.name = init.name;
         this.description = init.description;
     }
-    toJSON() {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    toJSON(options) {
         return (0, objects_1.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 (!constants_js_1.CLASS_NAME_PATTERN.test(init.name))
             throw new TypeError(`Invalid api name (${init.name})`);
         this.name = init.name;

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

@@ -22,7 +22,9 @@ 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(constants_js_1.DATATYPE_METADATA, nameOrCtor);
             name = metadata?.name;
@@ -31,7 +33,14 @@ class DataTypeMap {
             const metadata = nameOrCtor[constants_js_1.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);
@@ -43,7 +52,9 @@ class DataTypeMap {
     has(nameOrCtor) {
         if (nameOrCtor instanceof data_type_js_1.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/cjs/document/common/document-init-context.js

@@ -9,6 +9,11 @@ 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/cjs/document/common/document-node.js

@@ -21,25 +21,24 @@ class DocumentNode {
         // istanbul ignore next
         throw new Error('ApiDocument not found in document tree');
     }
-    hasDataType(nameOrCtor) {
-        const result = this[constants_js_1.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[constants_js_1.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[constants_js_1.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') {
@@ -56,7 +55,9 @@ 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)
@@ -68,10 +69,9 @@ 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 === index_js_1.OpraSchema.ComplexType.Kind)
             return t;
         throw new TypeError(`Data type "${t.name}" is not a ComplexType`);
@@ -80,10 +80,9 @@ 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 === index_js_1.OpraSchema.SimpleType.Kind)
             return t;
         throw new TypeError(`Data type "${t.name || t}" is not a SimpleType`);
@@ -92,10 +91,9 @@ 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 === index_js_1.OpraSchema.EnumType.Kind)
             return t;
         throw new TypeError(`Data type "${t.name || t}" is not a EnumType`);
@@ -104,10 +102,9 @@ 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 === index_js_1.OpraSchema.MappedType.Kind)
             return t;
         throw new TypeError(`Data type "${t.name || t}" is not a MappedType`);
@@ -116,10 +113,9 @@ 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 === index_js_1.OpraSchema.MixinType.Kind)
             return t;
         throw new TypeError(`Data type "${t.name || t}" is not a MixinType`);

package/cjs/document/common/value.js

@@ -20,10 +20,16 @@ exports.Value = function (owner, initArgs) {
  * @class Value
  */
 class ValueClass extends document_element_js_1.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 (0, objects_1.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/cjs/document/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.kTypeNSMap = exports.kCtorMap = exports.kDataTypeMap = exports.EXTRACT_TYPENAME_PATTERN = exports.CLASS_NAME_PATTERN = exports.NAMESPACE_PATTERN = exports.BUILTIN = exports.DECORATOR = exports.ENCODER = exports.DECODER = exports.RPC_CONTROLLER_METADATA = exports.HTTP_CONTROLLER_METADATA = exports.DATATYPE_METADATA = void 0;
+exports.kTypeNSMap = exports.kCtorMap = exports.kDataTypeMap = exports.CLASS_NAME_PATTERN = exports.NAMESPACE_PATTERN = exports.BUILTIN = exports.DECORATOR = exports.ENCODER = exports.DECODER = exports.RPC_CONTROLLER_METADATA = exports.HTTP_CONTROLLER_METADATA = exports.DATATYPE_METADATA = void 0;
 exports.DATATYPE_METADATA = Symbol.for('opra.type.metadata');
 exports.HTTP_CONTROLLER_METADATA = Symbol('opra.http-controller.metadata');
 exports.RPC_CONTROLLER_METADATA = Symbol('opra.rpc-controller.metadata');
@@ -10,7 +10,6 @@ exports.DECORATOR = Symbol.for('DECORATOR');
 exports.BUILTIN = Symbol.for('BUILTIN');
 exports.NAMESPACE_PATTERN = /([a-z$_]\w+):(.+)/i;
 exports.CLASS_NAME_PATTERN = /^[a-z][\w_]*$/i;
-exports.EXTRACT_TYPENAME_PATTERN = /^(.*)Type(\d*)$/;
 exports.kDataTypeMap = Symbol.for('kDataTypeMap');
 exports.kCtorMap = Symbol.for('kCtorMap');
 exports.kTypeNSMap = Symbol.for('kTypeNSMap');

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

@@ -28,6 +28,7 @@ exports.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;
@@ -41,17 +42,31 @@ exports.ApiField = function (...args) {
     _this.readonly = initArgs.readonly;
     _this.writeonly = initArgs.writeonly;
     _this.examples = initArgs.examples;
-    _this.hidden = initArgs.hidden;
 };
 /**
  *
  * @class ApiField
  */
 class ApiFieldClass extends document_element_js_1.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 (0, objects_1.omitUndefined)({
-            type: typeName ? typeName : this.type?.toJSON(),
+            type: typeName ? typeName : this.type?.toJSON(options),
             description: this.description,
             isArray: this.isArray || undefined,
             default: this.default,

package/cjs/document/data-type/complex-type-base.js

@@ -86,7 +86,8 @@ class ComplexTypeBaseClass extends data_type_js_1.DataType {
                         dataType = undefined;
                         continue;
                     }
-                    if (dataType.additionalFields?.[0] === 'type' && dataType.additionalFields?.[1] instanceof data_type_js_1.DataType) {
+                    if (dataType.additionalFields?.[0] === 'type' &&
+                        dataType.additionalFields?.[1] instanceof data_type_js_1.DataType) {
                         item.additionalField = true;
                         item.dataType = dataType.additionalFields[1];
                         dataType = dataType.additionalFields[1];
@@ -116,7 +117,11 @@ class ComplexTypeBaseClass extends data_type_js_1.DataType {
         const projection = Array.isArray(options?.projection)
             ? (0, index_js_1.parseFieldsProjection)(options.projection)
             : options?.projection;
-        const schema = this._generateSchema(codec, { ...options, projection, currentPath: '' });
+        const schema = this._generateSchema(codec, {
+            ...options,
+            projection,
+            currentPath: '',
+        });
         let additionalFields;
         if (this.additionalFields instanceof data_type_js_1.DataType) {
             additionalFields = this.additionalFields.generateCodec(codec, options);
@@ -144,12 +149,21 @@ class ComplexTypeBaseClass extends data_type_js_1.DataType {
         const schema = {};
         const { currentPath, projection } = context;
         const pickList = !!(projection && Object.values(projection).find(p => !p.sign));
+        const scope = context.scope
+            ? Array.isArray(context.scope)
+                ? context.scope
+                : [context.scope]
+            : undefined;
         // Process fields
         let fieldName;
         for (const field of this.fields.values()) {
-            if ((context.ignoreReadonlyFields && field.readonly) ||
-                (context.ignoreWriteonlyFields && field.writeonly) ||
-                (context.ignoreHiddenFields && field.hidden)) {
+            if (
+            /** Ignore field if required scope(s) do not match field scopes */
+            (scope && !field.inScope(scope)) ||
+                /** Ignore field if readonly and ignoreReadonlyFields option true */
+                (context.ignoreReadonlyFields && field.readonly) ||
+                /** Ignore field if writeonly and ignoreWriteonlyFields option true */
+                (context.ignoreWriteonlyFields && field.writeonly)) {
                 schema[field.name] = valgen_1.vg.isUndefined({ coerce: true });
                 continue;
             }
@@ -171,10 +185,13 @@ class ComplexTypeBaseClass extends data_type_js_1.DataType {
             const fn = this._generateFieldCodec(codec, field, {
                 ...context,
                 partial: context.partial === 'deep' ? context.partial : undefined,
-                projection: typeof projection === 'object' ? projection[fieldName]?.projection || '*' : projection,
+                projection: typeof projection === 'object'
+                    ? projection[fieldName]?.projection || '*'
+                    : projection,
                 currentPath: currentPath + (currentPath ? '.' : '') + fieldName,
             });
-            schema[fieldName] = context.partial || !field.required ? valgen_1.vg.optional(fn) : valgen_1.vg.required(fn);
+            schema[fieldName] =
+                context.partial || !field.required ? valgen_1.vg.optional(fn) : valgen_1.vg.required(fn);
         }
         if (context.allowPatchOperators) {
             schema._$pull = valgen_1.vg.optional(valgen_1.vg.isAny());

package/cjs/document/data-type/complex-type.js

@@ -71,17 +71,28 @@ class ComplexTypeClass extends complex_type_base_js_1.ComplexTypeBase {
             return true;
         return !!this.base?.extendsFrom(baseType);
     }
-    toJSON() {
-        const baseName = this.base ? this.node.getDataTypeNameWithNs(this.base) : undefined;
+    toJSON(options) {
+        const baseName = this.base
+            ? this.node.getDataTypeNameWithNs(this.base)
+            : undefined;
+        if (options?.scopes && !this.base?.inScope(options?.scopes))
+            throw new TypeError(`Base type ${baseName ? '(' + baseName + ')' : ''} of ${this.name ? +this.name : 'embedded'} type ` +
+                `is not in required scope(s) [${options.scopes}`);
         const out = (0, objects_1.omitUndefined)({
             ...complex_type_base_js_1.ComplexTypeBase.prototype.toJSON.call(this),
             kind: this.kind,
-            base: this.base ? (baseName ? baseName : this.base.toJSON()) : undefined,
+            base: this.base
+                ? baseName
+                    ? baseName
+                    : this.base.toJSON(options)
+                : undefined,
         });
         if (this.additionalFields) {
             if (this.additionalFields instanceof data_type_js_1.DataType) {
                 const typeName = this.node.getDataTypeNameWithNs(this.additionalFields);
-                out.additionalFields = typeName ? typeName : this.additionalFields.toJSON();
+                out.additionalFields = typeName
+                    ? typeName
+                    : this.additionalFields.toJSON(options);
             }
             else
                 out.additionalFields = this.additionalFields;
@@ -90,8 +101,8 @@ class ComplexTypeClass extends complex_type_base_js_1.ComplexTypeBase {
             const fields = {};
             let i = 0;
             for (const field of this.fields.values()) {
-                if (field.origin === this) {
-                    fields[field.name] = field.toJSON();
+                if (field.origin === this && field.inScope(options?.scopes)) {
+                    fields[field.name] = field.toJSON(options);
                     i++;
                 }
             }

package/cjs/document/data-type/data-type.js

@@ -20,6 +20,7 @@ context) {
     document_element_js_1.DocumentElement.call(this, owner);
     const _this = (0, ts_gems_1.asMutable)(this);
     _this.kind = initArgs.kind;
+    _this.scopes = initArgs.scopes;
     _this.name = initArgs.name;
     _this.description = initArgs.description;
     _this.abstract = initArgs.abstract;
@@ -33,7 +34,21 @@ class DataTypeClass extends document_element_js_1.DocumentElement {
     get embedded() {
         return !this.name;
     }
-    toJSON() {
+    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;
+    }
+    // eslint-disable-next-line
+    toJSON(options) {
         return (0, objects_1.omitUndefined)({
             kind: this.kind,
             description: this.description,

package/cjs/document/data-type/enum-type.js

@@ -51,11 +51,20 @@ class EnumTypeClass extends data_type_js_1.DataType {
     generateCodec() {
         return valgen_1.vg.isEnum(Object.keys(this.attributes));
     }
-    toJSON() {
-        const baseName = this.base ? this.node.getDataTypeNameWithNs(this.base) : undefined;
+    toJSON(options) {
+        const baseName = this.base
+            ? this.node.getDataTypeNameWithNs(this.base)
+            : undefined;
+        if (options?.scopes && !this.base?.inScope(options?.scopes))
+            throw new TypeError(`Base type ${baseName ? '(' + baseName + ')' : ''} of ${this.name ? +this.name : 'embedded'} type ` +
+                `is not in required scope(s) [${options.scopes}`);
         return (0, objects_1.omitUndefined)({
             ...data_type_js_1.DataType.prototype.toJSON.call(this),
-            base: this.base ? (baseName ? baseName : this.base.toJSON()) : undefined,
+            base: this.base
+                ? baseName
+                    ? baseName
+                    : this.base.toJSON(options)
+                : undefined,
             attributes: (0, index_js_1.cloneObject)(this.ownAttributes),
         });
     }

package/cjs/document/data-type/extended-types/base64.type.js

@@ -20,6 +20,7 @@ let Base64Type = class Base64Type {
 exports.Base64Type = Base64Type;
 exports.Base64Type = Base64Type = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
+        name: 'base64',
         description: 'A stream of bytes, base64 encoded',
         nameMappings: {
             js: 'string',

package/cjs/document/data-type/extended-types/date-string.type.js

@@ -38,6 +38,7 @@ tslib_1.__decorate([
 ], DateStringType.prototype, "maxValue", void 0);
 exports.DateStringType = DateStringType = tslib_1.__decorate([
     ((0, simple_type_js_1.SimpleType)({
+        name: 'datestring',
         description: 'Date string value',
         nameMappings: {
             js: 'string',

package/cjs/document/data-type/extended-types/date-time-string.type.js

@@ -38,6 +38,7 @@ tslib_1.__decorate([
 ], DateTimeStringType.prototype, "maxValue", void 0);
 exports.DateTimeStringType = DateTimeStringType = tslib_1.__decorate([
     ((0, simple_type_js_1.SimpleType)({
+        name: 'datetimestring',
         description: 'DateTime string value',
         nameMappings: {
             js: 'string',

package/cjs/document/data-type/extended-types/date-time.type.js

@@ -24,7 +24,11 @@ let DateTimeType = class DateTimeType {
         return x.length > 0 ? valgen_1.vg.pipe([fn, ...x], { returnIndex: 0 }) : fn;
     }
     [constants_js_1.ENCODER](properties) {
-        const fn = valgen_1.vg.isDateString({ precision: 'time', trim: 'time', coerce: true });
+        const fn = valgen_1.vg.isDateString({
+            precision: 'time',
+            trim: 'time',
+            coerce: true,
+        });
         const x = [];
         if (properties.minValue) {
             (0, valgen_1.isDateString)(properties.minValue);
@@ -52,6 +56,7 @@ tslib_1.__decorate([
 ], DateTimeType.prototype, "maxValue", void 0);
 exports.DateTimeType = DateTimeType = tslib_1.__decorate([
     ((0, simple_type_js_1.SimpleType)({
+        name: 'datetime',
         description: 'A full datetime value',
         nameMappings: {
             js: 'string',

package/cjs/document/data-type/extended-types/date.type.js

@@ -24,7 +24,11 @@ let DateType = class DateType {
         return x.length > 0 ? valgen_1.vg.pipe([fn, ...x], { returnIndex: 0 }) : fn;
     }
     [constants_js_1.ENCODER](properties) {
-        const fn = valgen_1.vg.isDateString({ precision: 'date', trim: 'date', coerce: true });
+        const fn = valgen_1.vg.isDateString({
+            precision: 'date',
+            trim: 'date',
+            coerce: true,
+        });
         const x = [];
         if (properties.minValue) {
             (0, valgen_1.isDateString)(properties.minValue);
@@ -52,6 +56,7 @@ tslib_1.__decorate([
 ], DateType.prototype, "maxValue", void 0);
 exports.DateType = DateType = tslib_1.__decorate([
     ((0, simple_type_js_1.SimpleType)({
+        name: 'date',
         description: 'A date without time',
         nameMappings: {
             js: 'Date',

package/cjs/document/data-type/extended-types/email.type.js

@@ -84,6 +84,7 @@ tslib_1.__decorate([
 ], EmailType.prototype, "blacklistedChars", void 0);
 exports.EmailType = EmailType = tslib_1.__decorate([
     ((0, simple_type_js_1.SimpleType)({
+        name: 'email',
         description: 'An email value',
         nameMappings: {
             js: 'string',

package/cjs/document/data-type/extended-types/field-path.type.js

@@ -21,13 +21,18 @@ let FieldPathType = class FieldPathType {
     [constants_js_1.ENCODER](properties, element) {
         return this[constants_js_1.DECODER](properties, element);
     }
-    toJSON(properties, element) {
+    toJSON(properties, element, options) {
         const dataType = properties.dataType
             ? element.node.getComplexType(properties.dataType)
             : element.node.getComplexType('object');
-        const typeName = dataType ? element.node.getDataTypeNameWithNs(dataType) : undefined;
+        const typeName = dataType
+            ? element.node.getDataTypeNameWithNs(dataType)
+            : undefined;
+        if (options?.scopes && !dataType.inScope(options?.scopes))
+            throw new TypeError(`Data type ${typeName ? '(' + typeName + ')' : ''} ` +
+                `is not in required scope(s) [${options.scopes}`);
         return {
-            dataType: typeName ? typeName : dataType.toJSON(),
+            dataType: typeName ? typeName : dataType.toJSON(options),
             allowSigns: properties.allowSigns,
         };
     }
@@ -49,6 +54,7 @@ tslib_1.__decorate([
 ], FieldPathType.prototype, "allowSigns", void 0);
 exports.FieldPathType = FieldPathType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
+        name: 'fieldpath',
         description: 'Field path',
         nameMappings: {
             js: 'string',