@opra/common 1.4.4 → 1.5.0

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

@@ -20,6 +20,7 @@ let BooleanType = class BooleanType {
 exports.BooleanType = BooleanType;
 exports.BooleanType = BooleanType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
+        name: 'boolean',
         description: 'Simple true/false value',
         nameMappings: {
             js: 'boolean',

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

@@ -27,6 +27,7 @@ let IntegerType = class IntegerType extends number_type_js_1.NumberType {
 exports.IntegerType = IntegerType;
 exports.IntegerType = IntegerType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
+        name: 'integer',
         description: 'An integer number',
         nameMappings: {
             js: 'number',

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

@@ -20,6 +20,7 @@ let NullType = class NullType {
 exports.NullType = NullType;
 exports.NullType = NullType = tslib_1.__decorate([
     (0, simple_type_js_1.SimpleType)({
+        name: 'null',
         description: 'A Null value',
         nameMappings: {
             js: 'null',

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

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

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

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

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

@@ -83,20 +83,27 @@ class SimpleTypeClass extends data_type_js_1.DataType {
         }
         return valgen_1.isAny;
     }
-    toJSON() {
+    toJSON(options) {
         const attributes = (0, objects_1.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 ? (0, index_js_1.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 = (0, objects_1.omitUndefined)({
             ...data_type_js_1.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/cjs/document/decorators/complex-type.decorator.js

@@ -14,7 +14,7 @@ function ComplexTypeDecorator(options) {
                 name = options.name;
             }
             else {
-                name = target.name.match(constants_js_1.EXTRACT_TYPENAME_PATTERN)?.[1] || target.name;
+                name = target.name;
             }
         }
         let metadata = Reflect.getOwnMetadata(constants_js_1.DATATYPE_METADATA, target);

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

@@ -18,7 +18,7 @@ function SimpleTypeDecoratorFactory(options) {
                 name = options.name;
             }
             else {
-                name = target.name.match(constants_js_1.EXTRACT_TYPENAME_PATTERN)?.[1] || target.name;
+                name = target.name;
                 name = name.toLowerCase();
             }
         }

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

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

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

@@ -23,7 +23,7 @@ class HttpApi extends api_base_js_1.ApiBase {
         const controller = this.findController(arg0);
         return controller?.operations.get(operationName);
     }
-    toJSON() {
+    toJSON(options) {
         const schema = super.toJSON();
         const out = {
             ...schema,
@@ -32,7 +32,7 @@ class HttpApi extends api_base_js_1.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/cjs/document/http/http-controller.js

@@ -115,7 +115,7 @@ class HttpControllerClass extends document_element_js_1.DocumentElement {
     /**
      *
      */
-    toJSON() {
+    toJSON(options) {
         const out = (0, objects_1.omitUndefined)({
             kind: this.kind,
             description: this.description,
@@ -124,25 +124,25 @@ class HttpControllerClass extends document_element_js_1.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/cjs/document/http/http-media-type.js

@@ -52,7 +52,7 @@ class HttpMediaTypeClass extends document_element_js_1.DocumentElement {
             }
         }
     }
-    toJSON() {
+    toJSON(options) {
         const typeName = this.type
             ? this.node.getDataTypeNameWithNs(this.type)
             : undefined;
@@ -60,7 +60,7 @@ class HttpMediaTypeClass extends document_element_js_1.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,
@@ -71,7 +71,7 @@ class HttpMediaTypeClass extends document_element_js_1.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/cjs/document/http/http-multipart-field.js

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

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

@@ -26,10 +26,10 @@ class HttpOperationResponse extends http_media_type_js_1.HttpMediaType {
             }
         }
     }
-    toJSON() {
+    toJSON(options) {
         const statusCode = this.statusCode.map(x => x.toJSON());
         const out = (0, objects_1.omitUndefined)({
-            ...super.toJSON(),
+            ...super.toJSON(options),
             statusCode: statusCode.length === 1 && typeof statusCode[0] === 'number'
                 ? statusCode[0]
                 : statusCode,
@@ -38,7 +38,7 @@ class HttpOperationResponse extends http_media_type_js_1.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/cjs/document/http/http-operation.js

@@ -71,7 +71,7 @@ class HttpOperationClass extends document_element_js_1.DocumentElement {
         }
         return this.path || '/';
     }
-    toJSON() {
+    toJSON(options) {
         const out = (0, objects_1.omitUndefined)({
             kind: index_js_2.OpraSchema.HttpOperation.Kind,
             description: this.description,
@@ -79,22 +79,22 @@ class HttpOperationClass extends document_element_js_1.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/cjs/document/http/http-parameter.js

@@ -33,9 +33,9 @@ exports.HttpParameter = function (owner, initArgs) {
  * @class HttpParameter
  */
 class HttpParameterClass extends value_js_1.Value {
-    toJSON() {
+    toJSON(options) {
         return (0, objects_1.omitUndefined)({
-            ...super.toJSON(),
+            ...super.toJSON(options),
             name: this.name,
             location: this.location,
             arraySeparator: this.arraySeparator,

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

@@ -11,12 +11,14 @@ class HttpRequestBody extends document_element_js_1.DocumentElement {
         super(owner);
         this.content = [];
     }
-    toJSON() {
+    toJSON(options) {
         return (0, objects_1.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,
         });

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);
@@ -128,9 +129,9 @@ class FilterRules {
                             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/esm/document/api-document.js

@@ -64,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 = {};
@@ -90,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)
@@ -122,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];
             }
@@ -144,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,7 +8,8 @@ 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,

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,12 +17,16 @@ export const Value = function (owner, initArgs) {
  * @class Value
  */
 class ValueClass extends DocumentElement {
-    toJSON() {
+    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,19 +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() {
+    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,

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

@@ -146,12 +146,21 @@ class ComplexTypeBaseClass extends 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] = vg.isUndefined({ coerce: true });
                 continue;
             }