@opra/common 1.5.1 → 1.5.3

package/cjs/document/api-document.js

@@ -93,7 +93,7 @@ class ApiDocument extends document_element_js_1.DocumentElement {
         if (this.types.size) {
             out.types = {};
             for (const v of this.types.values()) {
-                if (options?.scope && !v.inScope(options?.scope))
+                if (!v.inScope(options?.scope))
                     continue;
                 out.types[v.name] = v.toJSON(options);
             }
@@ -112,7 +112,7 @@ class ApiDocument extends document_element_js_1.DocumentElement {
     }
     _findDataType(nameOrCtor, scope, visitedRefs) {
         let result = this.types.get(nameOrCtor);
-        if (result && (!scope || result.inScope(scope)))
+        if (result && result.inScope(scope))
             return result;
         if (!this.references.size)
             return;

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

@@ -26,7 +26,7 @@ class DocumentNode {
     }
     findDataType(nameOrCtor, scope) {
         const dt = this[constants_js_1.kDataTypeMap]?.get(nameOrCtor);
-        if (dt && (!scope || dt.inScope(scope)))
+        if (dt && dt.inScope(scope))
             return dt;
         return this.parent
             ? this.parent.findDataType(nameOrCtor, scope)
@@ -37,7 +37,7 @@ class DocumentNode {
      */
     getDataType(nameOrCtor, scope) {
         const dt = this.findDataType(nameOrCtor);
-        if (dt && (!scope || dt.inScope(scope)))
+        if (dt && dt.inScope(scope))
             return dt;
         let name = '';
         if (typeof nameOrCtor === 'function') {

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

@@ -17,12 +17,88 @@ exports.ComplexTypeBase = function (...args) {
     const [owner, initArgs, context] = args;
     data_type_js_1.DataType.call(this, owner, initArgs, context);
     const _this = (0, ts_gems_1.asMutable)(this);
-    _this.fields = new index_js_1.ResponsiveMap();
+    _this._fields = new index_js_1.ResponsiveMap();
 };
 /**
  *
  */
 class ComplexTypeBaseClass extends data_type_js_1.DataType {
+    fieldCount(scope) {
+        if (!scope)
+            return this._fields.size;
+        let count = 0;
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        for (const i of this.fields(scope))
+            count++;
+        return count;
+    }
+    fieldEntries(scope) {
+        let iterator = this._fields.entries();
+        if (!scope)
+            return iterator;
+        let r;
+        return {
+            next() {
+                while (iterator) {
+                    r = iterator.next();
+                    if (r.done)
+                        break;
+                    if (r.value && r.value[1].inScope(scope))
+                        break;
+                }
+                return r;
+            },
+            return(value) {
+                iterator = undefined;
+                return { done: true, value };
+            },
+            [Symbol.iterator]() {
+                return this;
+            },
+        };
+    }
+    fields(scope) {
+        if (!scope)
+            return this._fields.values();
+        let iterator = this.fieldEntries(scope);
+        let r;
+        return {
+            next() {
+                if (!iterator)
+                    return { done: true, value: undefined };
+                r = iterator.next();
+                return { done: r.done, value: r.value[1] };
+            },
+            return(value) {
+                iterator = undefined;
+                return { done: true, value };
+            },
+            [Symbol.iterator]() {
+                return this;
+            },
+        };
+    }
+    fieldNames(scope) {
+        if (!scope)
+            return this._fields.keys();
+        let iterator = this.fieldEntries(scope);
+        let r;
+        return {
+            next() {
+                if (!iterator)
+                    return { done: true, value: undefined };
+                r = iterator.next();
+                return { done: r.done, value: r.value[0] };
+            },
+            return(value) {
+                iterator = undefined;
+                return { done: true, value };
+            },
+            [Symbol.iterator]() {
+                return this;
+            },
+        };
+    }
     /**
      *
      */
@@ -34,18 +110,17 @@ class ComplexTypeBaseClass extends data_type_js_1.DataType {
             const lastItem = fieldPath.pop();
             return lastItem?.field;
         }
-        const field = this.fields.get(nameOrPath);
-        if (field && scope && !field.inScope(scope))
-            return;
-        return field;
+        const field = this._fields.get(nameOrPath);
+        if (field && field.inScope(scope))
+            return field;
     }
     /**
      *
      */
     getField(nameOrPath, scope) {
         const field = this.findField(nameOrPath);
-        if (field && scope && !field.inScope(scope))
-            throw new Error(`Field "${nameOrPath}" does not exist in scope "${scope}"`);
+        if (field && !field.inScope(scope))
+            throw new Error(`Field "${nameOrPath}" does not exist in scope "${scope || 'null'}"`);
         if (!field) {
             throw new Error(`Field (${nameOrPath}) does not exist`);
         }
@@ -158,10 +233,10 @@ class ComplexTypeBaseClass extends data_type_js_1.DataType {
         const pickList = !!(projection && Object.values(projection).find(p => !p.sign));
         // Process fields
         let fieldName;
-        for (const field of this.fields.values()) {
+        for (const field of this._fields.values()) {
             if (
             /** Ignore field if required scope(s) do not match field scopes */
-            (context.scope && !field.inScope(context.scope)) ||
+            !field.inScope(context.scope) ||
                 /** Ignore field if readonly and ignoreReadonlyFields option true */
                 (context.ignoreReadonlyFields && field.readonly) ||
                 /** Ignore field if writeonly and ignoreWriteonlyFields option true */

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

@@ -34,8 +34,8 @@ exports.ComplexType = function (...args) {
             _this.additionalFields = _this.base.additionalFields;
             _this.keyField = _this.base.keyField;
             /** Copy fields from base */
-            for (const v of _this.base.fields.values()) {
-                this.fields.set(v.name, new api_field_js_1.ApiField(this, v));
+            for (const v of _this.base.fields()) {
+                _this._fields.set(v.name, new api_field_js_1.ApiField(this, v));
             }
         });
     }
@@ -52,7 +52,7 @@ exports.ComplexType = function (...args) {
                     ...v,
                     name: k,
                 });
-                this.fields.set(field.name, field);
+                this._fields.set(field.name, field);
             }
         });
     }
@@ -95,12 +95,11 @@ class ComplexTypeClass extends complex_type_base_js_1.ComplexTypeBase {
             else
                 out.additionalFields = this.additionalFields;
         }
-        if (this.fields.size) {
+        if (this._fields.size) {
             const fields = {};
             let i = 0;
-            for (const field of this.fields.values()) {
-                if (field.origin === this &&
-                    (!options?.scope || field.inScope(options?.scope))) {
+            for (const field of this._fields.values()) {
+                if (field.origin === this && field.inScope(options?.scope)) {
                     fields[field.name] = field.toJSON(options);
                     i++;
                 }

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

@@ -39,13 +39,11 @@ class DataTypeClass extends document_element_js_1.DocumentElement {
         return (0, test_scope_match_js_1.testScopeMatch)(scope, this.scopePattern);
     }
     toJSON(options) {
-        if (options?.scope) {
-            /** Locate base model which is not available for given scope */
-            const outOfScope = this._locateBase(dt => !dt.inScope(options.scope));
-            if (outOfScope) {
-                const baseName = this.node.getDataTypeNameWithNs(outOfScope);
-                throw new TypeError(`"${baseName}" model is not available for "${options.scope}" scope`);
-            }
+        /** Locate base model which is not available for given scope */
+        const outOfScope = this._locateBase(dt => !dt.inScope(options?.scope));
+        if (outOfScope) {
+            const baseName = this.node.getDataTypeNameWithNs(outOfScope);
+            throw new TypeError(`"${baseName}" model is not available for "${options?.scope || 'null'}" scope`);
         }
         return (0, objects_1.omitUndefined)({
             kind: this.kind,

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

@@ -49,7 +49,7 @@ exports.MappedType = function (...args) {
         const required = Array.isArray(_this.required)
             ? _this.required.map(x => x.toLowerCase())
             : _this.required;
-        for (const [k, v] of _this.base.fields.entries()) {
+        for (const [k, v] of _this.base.fieldEntries()) {
             if (!isInheritedPredicate(k))
                 continue;
             const meta = { ...v };
@@ -62,7 +62,7 @@ exports.MappedType = function (...args) {
                 meta.required = true;
             }
             const field = new api_field_js_1.ApiField(this, meta);
-            _this.fields.set(field.name, field);
+            _this._fields.set(field.name, field);
         }
         if (!_this.pick ||
             _this.base.additionalFields === false ||

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

@@ -30,9 +30,9 @@ exports.MixinType = function (...args) {
             else if (!_this.additionalFields)
                 _this.additionalFields = base.additionalFields;
         }
-        for (const v of base.fields.values()) {
+        for (const v of base.fields()) {
             const field = new api_field_js_1.ApiField(this, v);
-            _this.fields.set(field.name, field);
+            _this._fields.set(field.name, field);
         }
         _this.types.push(base);
         if (base.keyField)

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

@@ -106,6 +106,14 @@ class SimpleTypeClass extends data_type_js_1.DataType {
             out.nameMappings = { ...this.ownNameMappings };
         return (0, objects_1.omitUndefined)(out, true);
     }
+    _locateBase(callback) {
+        if (!this.base)
+            return;
+        if (callback(this.base))
+            return this.base;
+        if (this.base._locateBase)
+            return this.base._locateBase(callback);
+    }
 }
 exports.SimpleType.prototype = SimpleTypeClass.prototype;
 Object.assign(exports.SimpleType, simple_type_decorator_js_1.SimpleTypeDecoratorFactory);

package/cjs/document/utils/test-scope-match.js

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

package/esm/document/api-document.js

@@ -90,7 +90,7 @@ export class ApiDocument extends DocumentElement {
         if (this.types.size) {
             out.types = {};
             for (const v of this.types.values()) {
-                if (options?.scope && !v.inScope(options?.scope))
+                if (!v.inScope(options?.scope))
                     continue;
                 out.types[v.name] = v.toJSON(options);
             }
@@ -109,7 +109,7 @@ export class ApiDocument extends DocumentElement {
     }
     _findDataType(nameOrCtor, scope, visitedRefs) {
         let result = this.types.get(nameOrCtor);
-        if (result && (!scope || result.inScope(scope)))
+        if (result && result.inScope(scope))
             return result;
         if (!this.references.size)
             return;

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

@@ -23,7 +23,7 @@ export class DocumentNode {
     }
     findDataType(nameOrCtor, scope) {
         const dt = this[kDataTypeMap]?.get(nameOrCtor);
-        if (dt && (!scope || dt.inScope(scope)))
+        if (dt && dt.inScope(scope))
             return dt;
         return this.parent
             ? this.parent.findDataType(nameOrCtor, scope)
@@ -34,7 +34,7 @@ export class DocumentNode {
      */
     getDataType(nameOrCtor, scope) {
         const dt = this.findDataType(nameOrCtor);
-        if (dt && (!scope || dt.inScope(scope)))
+        if (dt && dt.inScope(scope))
             return dt;
         let name = '';
         if (typeof nameOrCtor === 'function') {

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

@@ -14,12 +14,88 @@ export const ComplexTypeBase = function (...args) {
     const [owner, initArgs, context] = args;
     DataType.call(this, owner, initArgs, context);
     const _this = asMutable(this);
-    _this.fields = new ResponsiveMap();
+    _this._fields = new ResponsiveMap();
 };
 /**
  *
  */
 class ComplexTypeBaseClass extends DataType {
+    fieldCount(scope) {
+        if (!scope)
+            return this._fields.size;
+        let count = 0;
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        for (const i of this.fields(scope))
+            count++;
+        return count;
+    }
+    fieldEntries(scope) {
+        let iterator = this._fields.entries();
+        if (!scope)
+            return iterator;
+        let r;
+        return {
+            next() {
+                while (iterator) {
+                    r = iterator.next();
+                    if (r.done)
+                        break;
+                    if (r.value && r.value[1].inScope(scope))
+                        break;
+                }
+                return r;
+            },
+            return(value) {
+                iterator = undefined;
+                return { done: true, value };
+            },
+            [Symbol.iterator]() {
+                return this;
+            },
+        };
+    }
+    fields(scope) {
+        if (!scope)
+            return this._fields.values();
+        let iterator = this.fieldEntries(scope);
+        let r;
+        return {
+            next() {
+                if (!iterator)
+                    return { done: true, value: undefined };
+                r = iterator.next();
+                return { done: r.done, value: r.value[1] };
+            },
+            return(value) {
+                iterator = undefined;
+                return { done: true, value };
+            },
+            [Symbol.iterator]() {
+                return this;
+            },
+        };
+    }
+    fieldNames(scope) {
+        if (!scope)
+            return this._fields.keys();
+        let iterator = this.fieldEntries(scope);
+        let r;
+        return {
+            next() {
+                if (!iterator)
+                    return { done: true, value: undefined };
+                r = iterator.next();
+                return { done: r.done, value: r.value[0] };
+            },
+            return(value) {
+                iterator = undefined;
+                return { done: true, value };
+            },
+            [Symbol.iterator]() {
+                return this;
+            },
+        };
+    }
     /**
      *
      */
@@ -31,18 +107,17 @@ class ComplexTypeBaseClass extends DataType {
             const lastItem = fieldPath.pop();
             return lastItem?.field;
         }
-        const field = this.fields.get(nameOrPath);
-        if (field && scope && !field.inScope(scope))
-            return;
-        return field;
+        const field = this._fields.get(nameOrPath);
+        if (field && field.inScope(scope))
+            return field;
     }
     /**
      *
      */
     getField(nameOrPath, scope) {
         const field = this.findField(nameOrPath);
-        if (field && scope && !field.inScope(scope))
-            throw new Error(`Field "${nameOrPath}" does not exist in scope "${scope}"`);
+        if (field && !field.inScope(scope))
+            throw new Error(`Field "${nameOrPath}" does not exist in scope "${scope || 'null'}"`);
         if (!field) {
             throw new Error(`Field (${nameOrPath}) does not exist`);
         }
@@ -155,10 +230,10 @@ class ComplexTypeBaseClass extends DataType {
         const pickList = !!(projection && Object.values(projection).find(p => !p.sign));
         // Process fields
         let fieldName;
-        for (const field of this.fields.values()) {
+        for (const field of this._fields.values()) {
             if (
             /** Ignore field if required scope(s) do not match field scopes */
-            (context.scope && !field.inScope(context.scope)) ||
+            !field.inScope(context.scope) ||
                 /** Ignore field if readonly and ignoreReadonlyFields option true */
                 (context.ignoreReadonlyFields && field.readonly) ||
                 /** Ignore field if writeonly and ignoreWriteonlyFields option true */

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

@@ -31,8 +31,8 @@ export const ComplexType = function (...args) {
             _this.additionalFields = _this.base.additionalFields;
             _this.keyField = _this.base.keyField;
             /** Copy fields from base */
-            for (const v of _this.base.fields.values()) {
-                this.fields.set(v.name, new ApiField(this, v));
+            for (const v of _this.base.fields()) {
+                _this._fields.set(v.name, new ApiField(this, v));
             }
         });
     }
@@ -49,7 +49,7 @@ export const ComplexType = function (...args) {
                     ...v,
                     name: k,
                 });
-                this.fields.set(field.name, field);
+                this._fields.set(field.name, field);
             }
         });
     }
@@ -92,12 +92,11 @@ class ComplexTypeClass extends ComplexTypeBase {
             else
                 out.additionalFields = this.additionalFields;
         }
-        if (this.fields.size) {
+        if (this._fields.size) {
             const fields = {};
             let i = 0;
-            for (const field of this.fields.values()) {
-                if (field.origin === this &&
-                    (!options?.scope || field.inScope(options?.scope))) {
+            for (const field of this._fields.values()) {
+                if (field.origin === this && field.inScope(options?.scope)) {
                     fields[field.name] = field.toJSON(options);
                     i++;
                 }

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

@@ -36,13 +36,11 @@ class DataTypeClass extends DocumentElement {
         return testScopeMatch(scope, this.scopePattern);
     }
     toJSON(options) {
-        if (options?.scope) {
-            /** Locate base model which is not available for given scope */
-            const outOfScope = this._locateBase(dt => !dt.inScope(options.scope));
-            if (outOfScope) {
-                const baseName = this.node.getDataTypeNameWithNs(outOfScope);
-                throw new TypeError(`"${baseName}" model is not available for "${options.scope}" scope`);
-            }
+        /** Locate base model which is not available for given scope */
+        const outOfScope = this._locateBase(dt => !dt.inScope(options?.scope));
+        if (outOfScope) {
+            const baseName = this.node.getDataTypeNameWithNs(outOfScope);
+            throw new TypeError(`"${baseName}" model is not available for "${options?.scope || 'null'}" scope`);
         }
         return omitUndefined({
             kind: this.kind,

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

@@ -46,7 +46,7 @@ export const MappedType = function (...args) {
         const required = Array.isArray(_this.required)
             ? _this.required.map(x => x.toLowerCase())
             : _this.required;
-        for (const [k, v] of _this.base.fields.entries()) {
+        for (const [k, v] of _this.base.fieldEntries()) {
             if (!isInheritedPredicate(k))
                 continue;
             const meta = { ...v };
@@ -59,7 +59,7 @@ export const MappedType = function (...args) {
                 meta.required = true;
             }
             const field = new ApiField(this, meta);
-            _this.fields.set(field.name, field);
+            _this._fields.set(field.name, field);
         }
         if (!_this.pick ||
             _this.base.additionalFields === false ||

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

@@ -27,9 +27,9 @@ export const MixinType = function (...args) {
             else if (!_this.additionalFields)
                 _this.additionalFields = base.additionalFields;
         }
-        for (const v of base.fields.values()) {
+        for (const v of base.fields()) {
             const field = new ApiField(this, v);
-            _this.fields.set(field.name, field);
+            _this._fields.set(field.name, field);
         }
         _this.types.push(base);
         if (base.keyField)

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

@@ -103,6 +103,14 @@ class SimpleTypeClass extends DataType {
             out.nameMappings = { ...this.ownNameMappings };
         return omitUndefined(out, true);
     }
+    _locateBase(callback) {
+        if (!this.base)
+            return;
+        if (callback(this.base))
+            return this.base;
+        if (this.base._locateBase)
+            return this.base._locateBase(callback);
+    }
 }
 SimpleType.prototype = SimpleTypeClass.prototype;
 Object.assign(SimpleType, SimpleTypeDecoratorFactory);

package/esm/document/utils/test-scope-match.js

@@ -1,6 +1,8 @@
 export function testScopeMatch(scope, pattern) {
-    if (!(scope && pattern))
+    if (!pattern)
         return true;
+    if (!scope)
+        return false;
     if (Array.isArray(pattern)) {
         return pattern.some(x => {
             return typeof x === 'string' ? scope === x : x.test(scope);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/common",
-  "version": "1.5.1",
+  "version": "1.5.3",
   "description": "Opra common package",
   "author": "Panates",
   "license": "MIT",

package/types/document/data-type/api-field.d.ts

@@ -52,7 +52,7 @@ declare class ApiFieldClass extends DocumentElement {
     readonly readonly?: boolean;
     readonly writeonly?: boolean;
     readonly examples?: any[] | Record<string, any>;
-    inScope(scope: string): boolean;
+    inScope(scope?: string): boolean;
     toJSON(options?: ApiDocument.ExportOptions): OpraSchema.Field;
 }
 /**

package/types/document/data-type/complex-type-base.d.ts

@@ -40,9 +40,13 @@ export declare const ComplexTypeBase: ComplexTypeBaseStatic;
  */
 declare abstract class ComplexTypeBaseClass extends DataType {
     readonly ctor?: Type;
-    readonly fields: ResponsiveMap<ApiField>;
+    protected _fields: ResponsiveMap<ApiField>;
     readonly additionalFields?: boolean | DataType | ['error'] | ['error', string];
     readonly keyField?: OpraSchema.Field.Name;
+    fieldCount(scope?: string): number;
+    fieldEntries(scope?: string): IterableIterator<[string, ApiField]>;
+    fields(scope?: string): IterableIterator<ApiField>;
+    fieldNames(scope?: string): IterableIterator<string>;
     /**
      *
      */

package/types/document/data-type/data-type.d.ts

@@ -61,7 +61,7 @@ declare abstract class DataTypeClass extends DocumentElement {
     abstract generateCodec(codec: 'encode' | 'decode', options?: DataType.GenerateCodecOptions): Validator;
     get embedded(): any;
     abstract extendsFrom(baseType: DataType | string | Type | object): boolean;
-    inScope(scope: string): boolean;
+    inScope(scope?: string): boolean;
     toJSON(options?: ApiDocument.ExportOptions): OpraSchema.DataType;
     toString(): string;
     protected abstract _locateBase(callback: (base: DataType) => boolean): DataType | undefined;

package/types/document/data-type/simple-type.d.ts

@@ -74,5 +74,6 @@ declare abstract class SimpleTypeClass extends DataType {
     extendsFrom(baseType: DataType | string | Type | object): boolean;
     generateCodec<T extends Record<string, any> | object = object>(codec: 'encode' | 'decode', options?: DataType.GenerateCodecOptions | null, properties?: Partial<T>): Validator;
     toJSON(options?: ApiDocument.ExportOptions): OpraSchema.SimpleType;
+    protected _locateBase(callback: (base: SimpleType) => boolean): SimpleType | undefined;
 }
 export {};

package/types/document/factory/api-document.factory.d.ts

@@ -10,7 +10,6 @@ export declare namespace ApiDocumentFactory {
         references?: Record<string, ReferenceThunk>;
         types?: DataTypeInitSources;
         api?: StrictOmit<HttpApiFactory.InitArguments, 'owner'> | StrictOmit<RpcApiFactory.InitArguments, 'owner'>;
-        scopes?: string | string[];
     }
     type ReferenceSource = string | OpraSchema.ApiDocument | InitArguments | ApiDocument;
     type ReferenceThunk = ThunkAsync<ReferenceSource>;

package/types/document/utils/test-scope-match.d.ts

@@ -1 +1 @@
-export declare function testScopeMatch(scope: string, pattern?: (string | RegExp) | (string | RegExp)[]): boolean;
+export declare function testScopeMatch(scope?: string, pattern?: (string | RegExp) | (string | RegExp)[]): boolean;