@opra/common 1.4.4 → 1.5.1

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

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

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

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

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

@@ -88,13 +88,14 @@ class MappedTypeClass extends complex_type_base_js_1.ComplexTypeBase {
             return true;
         return !!this.base?.extendsFrom(baseType);
     }
-    toJSON() {
+    toJSON(options) {
+        const superJson = super.toJSON(options);
         const baseName = this.base
             ? this.node.getDataTypeNameWithNs(this.base)
             : undefined;
         return (0, objects_1.omitUndefined)({
-            ...complex_type_base_js_1.ComplexTypeBase.prototype.toJSON.call(this),
-            base: baseName ? baseName : this.base.toJSON(),
+            ...superJson,
+            base: baseName ? baseName : this.base.toJSON(options),
             kind: this.kind,
             pick: this.pick,
             omit: this.omit,
@@ -102,6 +103,14 @@ class MappedTypeClass extends complex_type_base_js_1.ComplexTypeBase {
             required: this.required,
         });
     }
+    _locateBase(callback) {
+        if (!this.base)
+            return;
+        if (callback(this.base))
+            return this.base;
+        if (this.base._locateBase)
+            return this.base._locateBase(callback);
+    }
 }
 exports.MappedType.prototype = MappedTypeClass.prototype;
 exports.MappedType._applyMixin = () => undefined;

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

@@ -57,16 +57,28 @@ class MixinTypeClass extends complex_type_base_js_1.ComplexTypeBase {
         }
         return false;
     }
-    toJSON() {
+    toJSON(options) {
+        const superJson = super.toJSON(options);
         return (0, objects_1.omitUndefined)({
-            ...complex_type_base_js_1.ComplexTypeBase.prototype.toJSON.call(this),
+            ...superJson,
             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);
+                return baseName ? baseName : base.toJSON(options);
             }),
         });
     }
+    _locateBase(callback) {
+        for (const t of this.types) {
+            if (callback(t))
+                return t;
+            if (t._locateBase) {
+                const x = t._locateBase(callback);
+                if (x)
+                    return x;
+            }
+        }
+    }
 }
 exports.MixinType.prototype = MixinTypeClass.prototype;
 exports.MixinType[constants_js_1.DECORATOR] = MixinTypeFactory;

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

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

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

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

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

@@ -70,7 +70,7 @@ class SimpleTypeClass extends data_type_js_1.DataType {
             let t = this;
             while (t) {
                 if (t._generateDecoder)
-                    return t._generateDecoder(prop, options?.documentElement || this.owner);
+                    return t._generateDecoder(prop, options?.documentElement || this.owner, options?.scope);
                 t = this.base;
             }
             return valgen_1.isAny;
@@ -78,28 +78,30 @@ class SimpleTypeClass extends data_type_js_1.DataType {
         let t = this;
         while (t) {
             if (t._generateEncoder)
-                return t._generateEncoder(prop, options?.documentElement || this.owner);
+                return t._generateEncoder(prop, options?.documentElement || this.owner, options?.scope);
             t = this.base;
         }
         return valgen_1.isAny;
     }
-    toJSON() {
+    toJSON(options) {
+        const superJson = super.toJSON(options);
+        const baseName = this.base
+            ? this.node.getDataTypeNameWithNs(this.base)
+            : undefined;
         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;
-        const out = (0, objects_1.omitUndefined)({
-            ...data_type_js_1.DataType.prototype.toJSON.apply(this),
-            base: this.base ? (baseName ? baseName : this.base.toJSON()) : undefined,
+        const out = {
+            ...superJson,
+            kind: this.kind,
+            base: baseName,
             attributes: attributes && Object.keys(attributes).length ? attributes : undefined,
             properties: Object.keys(properties).length ? properties : undefined,
-        });
+        };
         if (Object.keys(this.ownNameMappings).length)
             out.nameMappings = { ...this.ownNameMappings };
         return (0, objects_1.omitUndefined)(out, true);

package/cjs/document/decorators/api-field-decorator.js

@@ -1,10 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiFieldDecorator = ApiFieldDecorator;
+exports.ApiFieldDecoratorFactory = ApiFieldDecoratorFactory;
+// import { omitUndefined } from '@jsopen/objects';
+// import { StrictOmit } from 'ts-gems';
 const index_js_1 = require("../../schema/index.js");
 const constants_js_1 = require("../constants.js");
-function ApiFieldDecorator(options) {
-    return function (target, propertyKey) {
+function ApiFieldDecoratorFactory(options) {
+    const decoratorChain = [];
+    /**
+     *
+     */
+    const decorator = function (target, propertyKey) {
         if (typeof propertyKey !== 'string')
             throw new TypeError(`Symbol properties can't be used as a field`);
         const metadata = Reflect.getOwnMetadata(constants_js_1.DATATYPE_METADATA, target.constructor) ||
@@ -14,6 +20,11 @@ function ApiFieldDecorator(options) {
         const designType = Reflect.getMetadata('design:type', target, propertyKey);
         const elemMeta = (metadata.fields[propertyKey] = {
             ...options,
+            scopePattern: options?.scopePattern
+                ? Array.isArray(options.scopePattern)
+                    ? options.scopePattern
+                    : [options.scopePattern]
+                : undefined,
         });
         if (designType === Array) {
             elemMeta.isArray = true;
@@ -21,5 +32,28 @@ function ApiFieldDecorator(options) {
         else
             elemMeta.type = elemMeta.type || designType;
         Reflect.defineMetadata(constants_js_1.DATATYPE_METADATA, metadata, target.constructor);
+        for (const fn of decoratorChain)
+            fn(metadata, target);
     };
+    // /**
+    //  *
+    //  */
+    // decorator.Override = (
+    //   scopes: (string | RegExp) | (string | RegExp)[],
+    //   opts: StrictOmit<ApiField.Options, 'isArray' | 'type' | 'scopePattern'>,
+    // ): any => {
+    //   decoratorChain.push((meta: ApiField.Metadata): void => {
+    //     meta.overrides = meta.overrides || [];
+    //     meta.overrides.push(
+    //       omitUndefined({
+    //         ...opts,
+    //         scopes: Array.isArray(scopes) ? scopes : [scopes],
+    //         type: undefined,
+    //         isArray: undefined,
+    //       }),
+    //     );
+    //   });
+    //   return decorator;
+    // };
+    return decorator;
 }

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();
             }
         }
@@ -28,6 +28,8 @@ function SimpleTypeDecoratorFactory(options) {
         metadata.kind = index_js_1.OpraSchema.SimpleType.Kind;
         metadata.name = name;
         Reflect.defineMetadata(constants_js_1.DATATYPE_METADATA, metadata, target);
+        for (const fn of decoratorChain)
+            fn(metadata, target);
     };
     decorator.Example = (value, description) => {
         decoratorChain.push((meta) => {

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/document/utils/test-scope-match.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testScopeMatch = testScopeMatch;
+function testScopeMatch(scope, pattern) {
+    if (!(scope && pattern))
+        return true;
+    if (Array.isArray(pattern)) {
+        return pattern.some(x => {
+            return typeof x === 'string' ? scope === x : x.test(scope);
+        });
+    }
+    return typeof pattern === 'string' ? scope === pattern : pattern.test(scope);
+}

package/cjs/filter/filter-rules.js

@@ -32,11 +32,11 @@ class FilterRules {
             operators,
         }));
     }
-    normalizeFilter(filter, currentType) {
+    normalizeFilter(filter, currentType, scope) {
         const ast = typeof filter === 'string' ? (0, parse_js_1.parse)(filter) : filter;
-        return this.normalizeFilterAst(ast, [], currentType);
+        return this.normalizeFilterAst(ast, [], currentType, scope);
     }
-    normalizeFilterAst(ast, stack, currentType) {
+    normalizeFilterAst(ast, stack, currentType, scope) {
         if (ast instanceof index_js_4.ComparisonExpression) {
             stack.push(ast);
             this.normalizeFilterAst(ast.left, stack, currentType);
@@ -99,8 +99,8 @@ class FilterRules {
             return ast;
         }
         if (ast instanceof index_js_4.QualifiedIdentifier && currentType) {
-            ast.value = currentType.normalizeFieldPath(ast.value);
-            ast.field = currentType.getField(ast.value);
+            ast.value = currentType.normalizeFieldPath(ast.value, { scope });
+            ast.field = currentType.getField(ast.value, scope);
             ast.dataType = ast.field.type;
             return ast;
         }
@@ -128,9 +128,9 @@ class FilterRules {
                             decoder = this._decoderCache.get(comp.left.field);
                         if (!decoder) {
                             decoder = comp.left.field.type.generateCodec('decode', {
+                                scope,
                                 projection: '*',
                                 ignoreWriteonlyFields: true,
-                                ignoreHiddenFields: true,
                                 coerce: true,
                             });
                             this._decoderCache.set(comp.left.field, decoder);

package/esm/document/api-document.js

@@ -64,7 +64,7 @@ export class ApiDocument extends DocumentElement {
     /**
      * Export as Opra schema definition object
      */
-    export() {
+    export(options) {
         const out = omitUndefined({
             spec: OpraSchema.SpecVersion,
             id: this.id,
@@ -90,25 +90,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 (options?.scope && !v.inScope(options?.scope))
+                    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 && (!scope || 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 +126,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 +148,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,