@opra/common 1.4.4 → 1.5.0

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

@@ -68,21 +68,28 @@ class ComplexTypeClass extends ComplexTypeBase {
             return true;
         return !!this.base?.extendsFrom(baseType);
     }
-    toJSON() {
+    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 = omitUndefined({
             ...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 DataType) {
                 const typeName = this.node.getDataTypeNameWithNs(this.additionalFields);
                 out.additionalFields = typeName
                     ? typeName
-                    : this.additionalFields.toJSON();
+                    : this.additionalFields.toJSON(options);
             }
             else
                 out.additionalFields = this.additionalFields;
@@ -91,8 +98,8 @@ class ComplexTypeClass extends 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/esm/document/data-type/data-type.js

@@ -17,6 +17,7 @@ context) {
     DocumentElement.call(this, owner);
     const _this = asMutable(this);
     _this.kind = initArgs.kind;
+    _this.scopes = initArgs.scopes;
     _this.name = initArgs.name;
     _this.description = initArgs.description;
     _this.abstract = initArgs.abstract;
@@ -30,7 +31,21 @@ class DataTypeClass extends 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 omitUndefined({
             kind: this.kind,
             description: this.description,

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

@@ -48,13 +48,20 @@ class EnumTypeClass extends DataType {
     generateCodec() {
         return vg.isEnum(Object.keys(this.attributes));
     }
-    toJSON() {
+    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 omitUndefined({
             ...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: cloneObject(this.ownAttributes),
         });
     }

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

@@ -16,6 +16,7 @@ let Base64Type = class Base64Type {
 };
 Base64Type = __decorate([
     SimpleType({
+        name: 'base64',
         description: 'A stream of bytes, base64 encoded',
         nameMappings: {
             js: 'string',

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

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

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

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

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

@@ -52,6 +52,7 @@ __decorate([
 ], DateTimeType.prototype, "maxValue", void 0);
 DateTimeType = __decorate([
     (SimpleType({
+        name: 'datetime',
         description: 'A full datetime value',
         nameMappings: {
             js: 'string',

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

@@ -52,6 +52,7 @@ __decorate([
 ], DateType.prototype, "maxValue", void 0);
 DateType = __decorate([
     (SimpleType({
+        name: 'date',
         description: 'A date without time',
         nameMappings: {
             js: 'Date',

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

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

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

@@ -18,15 +18,18 @@ let FieldPathType = class FieldPathType {
     [ENCODER](properties, element) {
         return this[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;
+        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,
         };
     }
@@ -47,6 +50,7 @@ __decorate([
 ], FieldPathType.prototype, "allowSigns", void 0);
 FieldPathType = __decorate([
     SimpleType({
+        name: 'fieldpath',
         description: 'Field path',
         nameMappings: {
             js: 'string',

package/esm/document/data-type/extended-types/filter.type.js

@@ -21,12 +21,18 @@ let FilterType = class FilterType {
     [ENCODER]() {
         return encodeFilter;
     }
-    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;
+        if (options?.scopes && !dataType.inScope(options?.scopes))
+            throw new TypeError(`Data type ${typeName ? '(' + typeName + ')' : ''} ` +
+                `is not in required scope(s) [${options.scopes}`);
         return {
-            dataType: dataType.name ? dataType.name : dataType.toJSON(),
+            dataType: typeName ? typeName : dataType.toJSON(options),
             rules: properties.rules,
         };
     }
@@ -46,6 +52,7 @@ __decorate([
 ], FilterType.prototype, "rules", void 0);
 FilterType = __decorate([
     SimpleType({
+        name: 'filter',
         description: 'A query filter',
         nameMappings: {
             js: 'object',
@@ -55,12 +62,12 @@ FilterType = __decorate([
     __metadata("design:paramtypes", [Object])
 ], FilterType);
 export { FilterType };
-const decodeFilter = (dataType, rules) => validator('decodeFilter', (input, context, _this) => {
+const decodeFilter = (dataType, rules, element) => validator('decodeFilter', (input, context, _this) => {
     if (typeof input === 'string') {
         try {
             const filter = OpraFilter.parse(input);
             if (rules)
-                return rules.normalizeFilter(filter, dataType);
+                return rules.normalizeFilter(filter, dataType, element);
             return filter;
         }
         catch (e) {

package/esm/document/data-type/extended-types/object-id.type.js

@@ -16,6 +16,7 @@ let ObjectIdType = class ObjectIdType {
 };
 ObjectIdType = __decorate([
     SimpleType({
+        name: 'ObjectId',
         description: 'A MongoDB ObjectID value',
         nameMappings: {
             js: 'object',

package/esm/document/data-type/extended-types/operation-result.type.js

@@ -37,6 +37,7 @@ __decorate([
 ], OperationResult.prototype, "errors", void 0);
 OperationResult = __decorate([
     ComplexType({
+        name: 'OperationResult',
         description: 'Operation result',
     }),
     __metadata("design:paramtypes", [Object])

package/esm/document/data-type/extended-types/time.type.js

@@ -38,6 +38,7 @@ __decorate([
 ], TimeType.prototype, "maxValue", void 0);
 TimeType = __decorate([
     (SimpleType({
+        name: 'time',
         description: 'Time string in 24h format',
         nameMappings: {
             js: 'string',

package/esm/document/data-type/extended-types/url.type.js

@@ -16,6 +16,7 @@ let UrlType = class UrlType {
 };
 UrlType = __decorate([
     (SimpleType({
+        name: 'url',
         description: 'A Uniform Resource Identifier Reference (RFC 3986 icon) value',
         nameMappings: {
             js: 'string',

package/esm/document/data-type/extended-types/uuid.type.js

@@ -22,6 +22,7 @@ __decorate([
 ], UuidType.prototype, "version", void 0);
 UuidType = __decorate([
     SimpleType({
+        name: 'uuid',
         description: 'A Universal Unique Identifier (UUID) value',
         nameMappings: {
             js: 'string',

package/esm/document/data-type/mapped-type.js

@@ -85,13 +85,16 @@ class MappedTypeClass extends ComplexTypeBase {
             return true;
         return !!this.base?.extendsFrom(baseType);
     }
-    toJSON() {
+    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 omitUndefined({
-            ...ComplexTypeBase.prototype.toJSON.call(this),
-            base: baseName ? baseName : this.base.toJSON(),
+            ...ComplexTypeBase.prototype.toJSON.call(this, options),
+            base: baseName ? baseName : this.base.toJSON(options),
             kind: this.kind,
             pick: this.pick,
             omit: this.omit,

package/esm/document/data-type/mixin-type.js

@@ -54,13 +54,16 @@ class MixinTypeClass extends ComplexTypeBase {
         }
         return false;
     }
-    toJSON() {
+    toJSON(options) {
         return omitUndefined({
             ...ComplexTypeBase.prototype.toJSON.call(this),
             kind: this.kind,
-            types: this.types.map(t => {
-                const baseName = this.node.getDataTypeNameWithNs(t);
-                return baseName ? baseName : t.toJSON();
+            types: this.types.map(base => {
+                const baseName = this.node.getDataTypeNameWithNs(base);
+                if (options?.scopes && !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 baseName ? baseName : base.toJSON(options);
             }),
         });
     }

package/esm/document/data-type/primitive-types/any.type.js

@@ -16,6 +16,7 @@ let AnyType = class AnyType {
 };
 AnyType = __decorate([
     SimpleType({
+        name: 'any',
         description: 'Represents any value',
     }),
     __metadata("design:paramtypes", [Object])

package/esm/document/data-type/primitive-types/bigint.type.js

@@ -23,6 +23,7 @@ let BigintType = class BigintType extends NumberType {
 };
 BigintType = __decorate([
     SimpleType({
+        name: 'bigint',
         description: 'BigInt number',
         nameMappings: {
             js: 'bigint',

package/esm/document/data-type/primitive-types/boolean.type.js

@@ -16,6 +16,7 @@ let BooleanType = class BooleanType {
 };
 BooleanType = __decorate([
     SimpleType({
+        name: 'boolean',
         description: 'Simple true/false value',
         nameMappings: {
             js: 'boolean',

package/esm/document/data-type/primitive-types/integer.type.js

@@ -23,6 +23,7 @@ let IntegerType = class IntegerType extends NumberType {
 };
 IntegerType = __decorate([
     SimpleType({
+        name: 'integer',
         description: 'An integer number',
         nameMappings: {
             js: 'number',

package/esm/document/data-type/primitive-types/null.type.js

@@ -16,6 +16,7 @@ let NullType = class NullType {
 };
 NullType = __decorate([
     SimpleType({
+        name: 'null',
         description: 'A Null value',
         nameMappings: {
             js: 'null',

package/esm/document/data-type/primitive-types/number.type.js

@@ -35,6 +35,7 @@ __decorate([
 ], NumberType.prototype, "maxValue", void 0);
 NumberType = __decorate([
     SimpleType({
+        name: 'number',
         description: 'Both Integer as well as Floating-Point numbers',
         nameMappings: {
             js: 'number',

package/esm/document/data-type/primitive-types/string.type.js

@@ -55,6 +55,7 @@ __decorate([
 ], StringType.prototype, "maxLength", void 0);
 StringType = __decorate([
     SimpleType({
+        name: 'string',
         description: 'A sequence of characters',
         nameMappings: {
             js: 'string',

package/esm/document/data-type/simple-type.js

@@ -80,20 +80,27 @@ class SimpleTypeClass extends DataType {
         }
         return isAny;
     }
-    toJSON() {
+    toJSON(options) {
         const attributes = omitUndefined(this.ownAttributes);
         let properties;
         if (this.properties && typeof this.properties.toJSON === 'function') {
-            properties = this.properties.toJSON(this.properties, this.owner);
+            properties = this.properties.toJSON(this.properties, this.owner, options);
         }
         else
             properties = this.properties ? cloneObject(this.properties) : {};
         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 = omitUndefined({
             ...DataType.prototype.toJSON.apply(this),
-            base: this.base ? (baseName ? baseName : this.base.toJSON()) : undefined,
+            base: this.base
+                ? baseName
+                    ? baseName
+                    : this.base.toJSON(options)
+                : undefined,
             attributes: attributes && Object.keys(attributes).length ? attributes : undefined,
             properties: Object.keys(properties).length ? properties : undefined,
         });

package/esm/document/decorators/complex-type.decorator.js

@@ -1,6 +1,6 @@
 import { omit } from '@jsopen/objects';
 import { OpraSchema } from '../../schema/index.js';
-import { CLASS_NAME_PATTERN, DATATYPE_METADATA, EXTRACT_TYPENAME_PATTERN, } from '../constants.js';
+import { CLASS_NAME_PATTERN, DATATYPE_METADATA } from '../constants.js';
 export function ComplexTypeDecorator(options) {
     return function (target) {
         let name;
@@ -11,7 +11,7 @@ export function ComplexTypeDecorator(options) {
                 name = options.name;
             }
             else {
-                name = target.name.match(EXTRACT_TYPENAME_PATTERN)?.[1] || target.name;
+                name = target.name;
             }
         }
         let metadata = Reflect.getOwnMetadata(DATATYPE_METADATA, target);

package/esm/document/decorators/simple-type.decorator.js

@@ -1,5 +1,5 @@
 import { OpraSchema } from '../../schema/index.js';
-import { CLASS_NAME_PATTERN, DATATYPE_METADATA, EXTRACT_TYPENAME_PATTERN, } from '../constants.js';
+import { CLASS_NAME_PATTERN, DATATYPE_METADATA } from '../constants.js';
 export function SimpleTypeDecoratorFactory(options) {
     const decoratorChain = [];
     /**
@@ -14,7 +14,7 @@ export function SimpleTypeDecoratorFactory(options) {
                 name = options.name;
             }
             else {
-                name = target.name.match(EXTRACT_TYPENAME_PATTERN)?.[1] || target.name;
+                name = target.name;
                 name = name.toLowerCase();
             }
         }

package/esm/document/factory/api-document.factory.js

@@ -27,6 +27,7 @@ export class ApiDocumentFactory {
             : new DocumentInitContext(options);
         try {
             const document = new ApiDocument();
+            document.scopes = context.scopes;
             await factory.initDocument(document, context, schemaOrUrl);
             if (context.error.details.length)
                 throw context.error;

package/esm/document/http/http-api.js

@@ -20,7 +20,7 @@ export class HttpApi extends ApiBase {
         const controller = this.findController(arg0);
         return controller?.operations.get(operationName);
     }
-    toJSON() {
+    toJSON(options) {
         const schema = super.toJSON();
         const out = {
             ...schema,
@@ -29,7 +29,7 @@ export class HttpApi extends ApiBase {
             controllers: {},
         };
         for (const v of this.controllers.values()) {
-            out.controllers[v.name] = v.toJSON();
+            out.controllers[v.name] = v.toJSON(options);
         }
         return out;
     }

package/esm/document/http/http-controller.js

@@ -111,7 +111,7 @@ class HttpControllerClass extends DocumentElement {
     /**
      *
      */
-    toJSON() {
+    toJSON(options) {
         const out = omitUndefined({
             kind: this.kind,
             description: this.description,
@@ -120,25 +120,25 @@ class HttpControllerClass extends DocumentElement {
         if (this.operations.size) {
             out.operations = {};
             for (const v of this.operations.values()) {
-                out.operations[v.name] = v.toJSON();
+                out.operations[v.name] = v.toJSON(options);
             }
         }
         if (this.controllers.size) {
             out.controllers = {};
             for (const v of this.controllers.values()) {
-                out.controllers[v.name] = v.toJSON();
+                out.controllers[v.name] = v.toJSON(options);
             }
         }
         if (this.types.size) {
             out.types = {};
             for (const v of this.types.values()) {
-                out.types[v.name] = v.toJSON();
+                out.types[v.name] = v.toJSON(options);
             }
         }
         if (this.parameters.length) {
             out.parameters = [];
             for (const prm of this.parameters) {
-                out.parameters.push(prm.toJSON());
+                out.parameters.push(prm.toJSON(options));
             }
         }
         return out;

package/esm/document/http/http-media-type.js

@@ -48,7 +48,7 @@ class HttpMediaTypeClass extends DocumentElement {
             }
         }
     }
-    toJSON() {
+    toJSON(options) {
         const typeName = this.type
             ? this.node.getDataTypeNameWithNs(this.type)
             : undefined;
@@ -56,7 +56,7 @@ class HttpMediaTypeClass extends DocumentElement {
             description: this.description,
             contentType: this.contentType,
             contentEncoding: this.contentEncoding,
-            type: typeName ? typeName : this.type?.toJSON(),
+            type: typeName ? typeName : this.type?.toJSON(options),
             isArray: this.isArray,
             example: this.example,
             examples: this.examples,
@@ -67,7 +67,7 @@ class HttpMediaTypeClass extends DocumentElement {
             maxTotalFileSize: this.maxTotalFileSize,
         });
         if (this.multipartFields?.length) {
-            out.multipartFields = this.multipartFields.map(x => x.toJSON());
+            out.multipartFields = this.multipartFields.map(x => x.toJSON(options));
         }
         return out;
     }

package/esm/document/http/http-multipart-field.js

@@ -17,12 +17,12 @@ export class HttpMultipartField extends HttpMediaType {
         this.fieldType = initArgs.fieldType;
         this.required = initArgs.required;
     }
-    toJSON() {
+    toJSON(options) {
         return omitUndefined({
             fieldName: this.fieldName,
             fieldType: this.fieldType,
             required: this.required,
-            ...super.toJSON(),
+            ...super.toJSON(options),
         });
     }
 }

package/esm/document/http/http-operation-response.js

@@ -23,10 +23,10 @@ export class HttpOperationResponse extends HttpMediaType {
             }
         }
     }
-    toJSON() {
+    toJSON(options) {
         const statusCode = this.statusCode.map(x => x.toJSON());
         const out = omitUndefined({
-            ...super.toJSON(),
+            ...super.toJSON(options),
             statusCode: statusCode.length === 1 && typeof statusCode[0] === 'number'
                 ? statusCode[0]
                 : statusCode,
@@ -35,7 +35,7 @@ export class HttpOperationResponse extends HttpMediaType {
         if (this.parameters.length) {
             out.parameters = [];
             for (const prm of this.parameters) {
-                out.parameters.push(prm.toJSON());
+                out.parameters.push(prm.toJSON(options));
             }
         }
         return out;

package/esm/document/http/http-operation.js

@@ -67,7 +67,7 @@ class HttpOperationClass extends DocumentElement {
         }
         return this.path || '/';
     }
-    toJSON() {
+    toJSON(options) {
         const out = omitUndefined({
             kind: OpraSchema.HttpOperation.Kind,
             description: this.description,
@@ -75,22 +75,22 @@ class HttpOperationClass extends DocumentElement {
             path: this.path,
             mergePath: this.mergePath,
             composition: this.composition,
-            requestBody: this.requestBody?.toJSON(),
+            requestBody: this.requestBody?.toJSON(options),
         });
         if (this.types.size) {
             out.types = {};
             for (const v of this.types.values()) {
-                out.types[v.name] = v.toJSON();
+                out.types[v.name] = v.toJSON(options);
             }
         }
         if (this.parameters.length) {
             out.parameters = [];
             for (const prm of this.parameters) {
-                out.parameters.push(prm.toJSON());
+                out.parameters.push(prm.toJSON(options));
             }
         }
         if (this.responses.length)
-            out.responses = this.responses.map(r => r.toJSON());
+            out.responses = this.responses.map(r => r.toJSON(options));
         return out;
     }
 }

package/esm/document/http/http-parameter.js

@@ -30,9 +30,9 @@ export const HttpParameter = function (owner, initArgs) {
  * @class HttpParameter
  */
 class HttpParameterClass extends Value {
-    toJSON() {
+    toJSON(options) {
         return omitUndefined({
-            ...super.toJSON(),
+            ...super.toJSON(options),
             name: this.name,
             location: this.location,
             arraySeparator: this.arraySeparator,

package/esm/document/http/http-request-body.js

@@ -8,12 +8,14 @@ export class HttpRequestBody extends DocumentElement {
         super(owner);
         this.content = [];
     }
-    toJSON() {
+    toJSON(options) {
         return omitUndefined({
             description: this.description,
             required: this.required,
             maxContentSize: this.maxContentSize,
-            content: this.content.length ? this.content.map(x => x.toJSON()) : [],
+            content: this.content.length
+                ? this.content.map(x => x.toJSON(options))
+                : [],
             partial: this.partial,
             allowPatchOperators: this.allowPatchOperators,
         });