@opra/common 1.5.4 → 1.5.6

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

@@ -36,8 +36,8 @@ class DocumentNode {
      * Returns DataType instance by name or Constructor. Returns undefined if not found
      */
     getDataType(nameOrCtor, scope) {
-        const dt = this.findDataType(nameOrCtor);
-        if (dt && dt.inScope(scope))
+        const dt = this.findDataType(nameOrCtor, scope);
+        if (dt)
             return dt;
         let name = '';
         if (typeof nameOrCtor === 'function') {

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

@@ -46,6 +46,7 @@ exports.ApiField = function (...args) {
     _this.readonly = initArgs.readonly;
     _this.writeonly = initArgs.writeonly;
     _this.examples = initArgs.examples;
+    _this.override = initArgs.override;
 };
 /**
  * The ApiFieldClass represents a descriptive metadata structure for API fields,
@@ -56,6 +57,37 @@ class ApiFieldClass extends document_element_js_1.DocumentElement {
     inScope(scope) {
         return (0, test_scope_match_js_1.testScopeMatch)(scope, this.scopePattern);
     }
+    forScope(scope) {
+        if (!(scope && this.override))
+            return this;
+        this._overrideCache = this._overrideCache || {};
+        let field = this._overrideCache[scope];
+        if (field)
+            return field;
+        if (scope !== '*') {
+            for (const o of this.override) {
+                if ((0, test_scope_match_js_1.testScopeMatch)(scope, o.scopePattern)) {
+                    field = (0, objects_1.omitUndefined)({
+                        ...o,
+                        id: undefined,
+                        owner: undefined,
+                        node: undefined,
+                        origin: undefined,
+                        name: undefined,
+                        type: undefined,
+                        override: undefined,
+                        _overrideCache: undefined,
+                        scopePattern: o.scopePattern,
+                    });
+                    Object.setPrototypeOf(field, this);
+                    break;
+                }
+            }
+        }
+        field = field || this;
+        this._overrideCache[scope] = field;
+        return field;
+    }
     toJSON(options) {
         const typeName = this.type
             ? this.node.getDataTypeNameWithNs(this.type)

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

@@ -24,7 +24,7 @@ exports.ComplexTypeBase = function (...args) {
  */
 class ComplexTypeBaseClass extends data_type_js_1.DataType {
     fieldCount(scope) {
-        if (!scope)
+        if (scope === '*')
             return this._fields.size;
         let count = 0;
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -34,7 +34,7 @@ class ComplexTypeBaseClass extends data_type_js_1.DataType {
     }
     fieldEntries(scope) {
         let iterator = this._fields.entries();
-        if (!scope)
+        if (scope === '*')
             return iterator;
         let r;
         return {
@@ -46,7 +46,12 @@ class ComplexTypeBaseClass extends data_type_js_1.DataType {
                     if (r.value && r.value[1].inScope(scope))
                         break;
                 }
-                return r;
+                if (r.done)
+                    return { done: r.done, value: undefined };
+                return {
+                    done: r.done,
+                    value: [r.value[0], r.value[1].forScope(scope)],
+                };
             },
             return(value) {
                 iterator = undefined;
@@ -58,8 +63,6 @@ class ComplexTypeBaseClass extends data_type_js_1.DataType {
         };
     }
     fields(scope) {
-        if (!scope)
-            return this._fields.values();
         let iterator = this.fieldEntries(scope);
         let r;
         return {
@@ -67,7 +70,7 @@ class ComplexTypeBaseClass extends data_type_js_1.DataType {
                 if (!iterator)
                     return { done: true, value: undefined };
                 r = iterator.next();
-                return { done: r.done, value: r.value[1] };
+                return { done: r.done, value: r.value?.[1] };
             },
             return(value) {
                 iterator = undefined;
@@ -79,7 +82,7 @@ class ComplexTypeBaseClass extends data_type_js_1.DataType {
         };
     }
     fieldNames(scope) {
-        if (!scope)
+        if (scope === '*')
             return this._fields.keys();
         let iterator = this.fieldEntries(scope);
         let r;
@@ -88,7 +91,7 @@ class ComplexTypeBaseClass extends data_type_js_1.DataType {
                 if (!iterator)
                     return { done: true, value: undefined };
                 r = iterator.next();
-                return { done: r.done, value: r.value[0] };
+                return { done: r.done, value: r.value?.[0] };
             },
             return(value) {
                 iterator = undefined;
@@ -112,19 +115,19 @@ class ComplexTypeBaseClass extends data_type_js_1.DataType {
         }
         const field = this._fields.get(nameOrPath);
         if (field && field.inScope(scope))
-            return field;
+            return field.forScope(scope);
     }
     /**
      *
      */
     getField(nameOrPath, scope) {
-        const field = this.findField(nameOrPath);
+        const field = this.findField(nameOrPath, '*');
         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`);
         }
-        return field;
+        return field.forScope(scope);
     }
     /**
      *
@@ -154,7 +157,7 @@ class ComplexTypeBaseClass extends data_type_js_1.DataType {
             }
             if (dataType) {
                 if (dataType instanceof exports.ComplexTypeBase) {
-                    field = dataType.getField(item.fieldName, options?.scope);
+                    field = dataType.findField(item.fieldName, options?.scope);
                     if (field) {
                         item.fieldName = field.name;
                         item.field = field;
@@ -233,7 +236,7 @@ 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('*')) {
             if (
             /** Ignore field if required scope(s) do not match field scopes */
             !field.inScope(context.scope) ||

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

@@ -34,7 +34,7 @@ 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()) {
+            for (const v of _this.base.fields('*')) {
                 _this._fields.set(v.name, new api_field_js_1.ApiField(this, v));
             }
         });

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

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

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

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiFieldDecoratorFactory = ApiFieldDecoratorFactory;
-// import { omitUndefined } from '@jsopen/objects';
-// import { StrictOmit } from 'ts-gems';
+const objects_1 = require("@jsopen/objects");
 const index_js_1 = require("../../schema/index.js");
 const constants_js_1 = require("../constants.js");
 function ApiFieldDecoratorFactory(options) {
@@ -28,27 +27,22 @@ function ApiFieldDecoratorFactory(options) {
             elemMeta.type = elemMeta.type || designType;
         Reflect.defineMetadata(constants_js_1.DATATYPE_METADATA, metadata, target.constructor);
         for (const fn of decoratorChain)
-            fn(metadata, target);
+            fn(elemMeta);
+    };
+    /**
+     *
+     */
+    decorator.Override = (scopes, opts) => {
+        decoratorChain.push((meta) => {
+            meta.override = meta.override || [];
+            meta.override.push((0, objects_1.omitUndefined)({
+                ...opts,
+                scopePattern: Array.isArray(scopes) ? scopes : [scopes],
+                type: undefined,
+                isArray: undefined,
+            }));
+        });
+        return decorator;
     };
-    // /**
-    //  *
-    //  */
-    // 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/factory/data-type.factory.js

@@ -283,6 +283,7 @@ class DataTypeFactory {
         initArgs.description = metadata.description;
         initArgs.abstract = metadata.abstract;
         initArgs.examples = metadata.examples;
+        initArgs.scopePattern = metadata.scopePattern;
     }
     static async _prepareComplexTypeArgs(context, owner, initArgs, metadata) {
         await this._prepareDataTypeArgs(context, initArgs, metadata);

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

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.testScopeMatch = testScopeMatch;
 function testScopeMatch(scope, pattern) {
-    if (!pattern)
+    if (!pattern || scope === '*')
         return true;
     if (!scope)
         return false;

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

@@ -33,8 +33,8 @@ export class DocumentNode {
      * Returns DataType instance by name or Constructor. Returns undefined if not found
      */
     getDataType(nameOrCtor, scope) {
-        const dt = this.findDataType(nameOrCtor);
-        if (dt && dt.inScope(scope))
+        const dt = this.findDataType(nameOrCtor, scope);
+        if (dt)
             return dt;
         let name = '';
         if (typeof nameOrCtor === 'function') {

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

@@ -43,6 +43,7 @@ export const ApiField = function (...args) {
     _this.readonly = initArgs.readonly;
     _this.writeonly = initArgs.writeonly;
     _this.examples = initArgs.examples;
+    _this.override = initArgs.override;
 };
 /**
  * The ApiFieldClass represents a descriptive metadata structure for API fields,
@@ -53,6 +54,37 @@ class ApiFieldClass extends DocumentElement {
     inScope(scope) {
         return testScopeMatch(scope, this.scopePattern);
     }
+    forScope(scope) {
+        if (!(scope && this.override))
+            return this;
+        this._overrideCache = this._overrideCache || {};
+        let field = this._overrideCache[scope];
+        if (field)
+            return field;
+        if (scope !== '*') {
+            for (const o of this.override) {
+                if (testScopeMatch(scope, o.scopePattern)) {
+                    field = omitUndefined({
+                        ...o,
+                        id: undefined,
+                        owner: undefined,
+                        node: undefined,
+                        origin: undefined,
+                        name: undefined,
+                        type: undefined,
+                        override: undefined,
+                        _overrideCache: undefined,
+                        scopePattern: o.scopePattern,
+                    });
+                    Object.setPrototypeOf(field, this);
+                    break;
+                }
+            }
+        }
+        field = field || this;
+        this._overrideCache[scope] = field;
+        return field;
+    }
     toJSON(options) {
         const typeName = this.type
             ? this.node.getDataTypeNameWithNs(this.type)

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

@@ -21,7 +21,7 @@ export const ComplexTypeBase = function (...args) {
  */
 class ComplexTypeBaseClass extends DataType {
     fieldCount(scope) {
-        if (!scope)
+        if (scope === '*')
             return this._fields.size;
         let count = 0;
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -31,7 +31,7 @@ class ComplexTypeBaseClass extends DataType {
     }
     fieldEntries(scope) {
         let iterator = this._fields.entries();
-        if (!scope)
+        if (scope === '*')
             return iterator;
         let r;
         return {
@@ -43,7 +43,12 @@ class ComplexTypeBaseClass extends DataType {
                     if (r.value && r.value[1].inScope(scope))
                         break;
                 }
-                return r;
+                if (r.done)
+                    return { done: r.done, value: undefined };
+                return {
+                    done: r.done,
+                    value: [r.value[0], r.value[1].forScope(scope)],
+                };
             },
             return(value) {
                 iterator = undefined;
@@ -55,8 +60,6 @@ class ComplexTypeBaseClass extends DataType {
         };
     }
     fields(scope) {
-        if (!scope)
-            return this._fields.values();
         let iterator = this.fieldEntries(scope);
         let r;
         return {
@@ -64,7 +67,7 @@ class ComplexTypeBaseClass extends DataType {
                 if (!iterator)
                     return { done: true, value: undefined };
                 r = iterator.next();
-                return { done: r.done, value: r.value[1] };
+                return { done: r.done, value: r.value?.[1] };
             },
             return(value) {
                 iterator = undefined;
@@ -76,7 +79,7 @@ class ComplexTypeBaseClass extends DataType {
         };
     }
     fieldNames(scope) {
-        if (!scope)
+        if (scope === '*')
             return this._fields.keys();
         let iterator = this.fieldEntries(scope);
         let r;
@@ -85,7 +88,7 @@ class ComplexTypeBaseClass extends DataType {
                 if (!iterator)
                     return { done: true, value: undefined };
                 r = iterator.next();
-                return { done: r.done, value: r.value[0] };
+                return { done: r.done, value: r.value?.[0] };
             },
             return(value) {
                 iterator = undefined;
@@ -109,19 +112,19 @@ class ComplexTypeBaseClass extends DataType {
         }
         const field = this._fields.get(nameOrPath);
         if (field && field.inScope(scope))
-            return field;
+            return field.forScope(scope);
     }
     /**
      *
      */
     getField(nameOrPath, scope) {
-        const field = this.findField(nameOrPath);
+        const field = this.findField(nameOrPath, '*');
         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`);
         }
-        return field;
+        return field.forScope(scope);
     }
     /**
      *
@@ -151,7 +154,7 @@ class ComplexTypeBaseClass extends DataType {
             }
             if (dataType) {
                 if (dataType instanceof ComplexTypeBase) {
-                    field = dataType.getField(item.fieldName, options?.scope);
+                    field = dataType.findField(item.fieldName, options?.scope);
                     if (field) {
                         item.fieldName = field.name;
                         item.field = field;
@@ -230,7 +233,7 @@ 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('*')) {
             if (
             /** Ignore field if required scope(s) do not match field scopes */
             !field.inScope(context.scope) ||

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

@@ -31,7 +31,7 @@ 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()) {
+            for (const v of _this.base.fields('*')) {
                 _this._fields.set(v.name, new ApiField(this, v));
             }
         });

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

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

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

@@ -1,5 +1,4 @@
-// import { omitUndefined } from '@jsopen/objects';
-// import { StrictOmit } from 'ts-gems';
+import { omitUndefined } from '@jsopen/objects';
 import { OpraSchema } from '../../schema/index.js';
 import { DATATYPE_METADATA } from '../constants.js';
 export function ApiFieldDecoratorFactory(options) {
@@ -25,27 +24,22 @@ export function ApiFieldDecoratorFactory(options) {
             elemMeta.type = elemMeta.type || designType;
         Reflect.defineMetadata(DATATYPE_METADATA, metadata, target.constructor);
         for (const fn of decoratorChain)
-            fn(metadata, target);
+            fn(elemMeta);
+    };
+    /**
+     *
+     */
+    decorator.Override = (scopes, opts) => {
+        decoratorChain.push((meta) => {
+            meta.override = meta.override || [];
+            meta.override.push(omitUndefined({
+                ...opts,
+                scopePattern: Array.isArray(scopes) ? scopes : [scopes],
+                type: undefined,
+                isArray: undefined,
+            }));
+        });
+        return decorator;
     };
-    // /**
-    //  *
-    //  */
-    // 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/esm/document/factory/data-type.factory.js

@@ -280,6 +280,7 @@ export class DataTypeFactory {
         initArgs.description = metadata.description;
         initArgs.abstract = metadata.abstract;
         initArgs.examples = metadata.examples;
+        initArgs.scopePattern = metadata.scopePattern;
     }
     static async _prepareComplexTypeArgs(context, owner, initArgs, metadata) {
         await this._prepareDataTypeArgs(context, initArgs, metadata);

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

@@ -1,5 +1,5 @@
 export function testScopeMatch(scope, pattern) {
-    if (!pattern)
+    if (!pattern || scope === '*')
         return true;
     if (!scope)
         return false;

package/package.json

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

package/types/document/common/document-node.d.ts

@@ -19,41 +19,41 @@ export declare class DocumentNode {
     readonly element: DocumentElement;
     constructor(element: DocumentElement, parent?: DocumentNode);
     getDocument(): ApiDocument;
-    hasDataType(nameOrCtor: string | Type | Function | object | any[], scope?: string): boolean;
-    findDataType(nameOrCtor: string | Type | Function | object | any[], scope?: string): DataType | undefined;
+    hasDataType(nameOrCtor: string | Type | Function | object | any[], scope?: string | '*'): boolean;
+    findDataType(nameOrCtor: string | Type | Function | object | any[], scope?: string | '*'): DataType | undefined;
     /**
      * Returns DataType instance by name or Constructor. Returns undefined if not found
      */
-    getDataType(nameOrCtor: string | Type | Function | object | any[], scope?: string): DataType;
+    getDataType(nameOrCtor: string | Type | Function | object | any[], scope?: string | '*'): DataType;
     getDataTypeNameWithNs(dataType: DataType): string | undefined;
     /**
      * Returns ComplexType instance by name or Constructor.
      * Returns undefined if not found
      * Throws error if data type is not a ComplexType
      */
-    getComplexType(nameOrCtor: string | Type | Function, scope?: string): ComplexType;
+    getComplexType(nameOrCtor: string | Type | Function, scope?: string | '*'): ComplexType;
     /**
      * Returns SimpleType instance by name or Constructor.
      * Returns undefined if not found
      * Throws error if data type is not a SimpleType
      */
-    getSimpleType(nameOrCtor: string | Type, scope?: string): SimpleType;
+    getSimpleType(nameOrCtor: string | Type, scope?: string | '*'): SimpleType;
     /**
      * Returns EnumType instance by name or Constructor.
      * Returns undefined if not found
      * Throws error if data type is not a EnumType
      */
-    getEnumType(nameOrCtor: string | object | any[], scope?: string): EnumType;
+    getEnumType(nameOrCtor: string | object | any[], scope?: string | '*'): EnumType;
     /**
      * Returns EnumType instance by name or Constructor.
      * Returns undefined if not found
      * Throws error if data type is not a MappedType
      */
-    getMappedType(nameOrCtor: string | object | any[], scope?: string): MappedType;
+    getMappedType(nameOrCtor: string | object | any[], scope?: string | '*'): MappedType;
     /**
      * Returns EnumType instance by name or Constructor.
      * Returns undefined if not found
      * Throws error if data type is not a MixinType
      */
-    getMixinType(nameOrCtor: string | object | any[], scope?: string): MixinType;
+    getMixinType(nameOrCtor: string | object | any[], scope?: string | '*'): MixinType;
 }

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

@@ -35,6 +35,7 @@ export declare const ApiField: ApiFieldConstructor;
  * This class extends DocumentElement, inheriting base document structure capabilities.
  */
 declare class ApiFieldClass extends DocumentElement {
+    protected _overrideCache?: Record<string, this>;
     readonly owner: ComplexType | MappedType | MixinType;
     readonly origin?: ComplexType | MappedType | MixinType;
     readonly scopePattern?: (string | RegExp)[];
@@ -52,7 +53,9 @@ declare class ApiFieldClass extends DocumentElement {
     readonly readonly?: boolean;
     readonly writeonly?: boolean;
     readonly examples?: any[] | Record<string, any>;
-    inScope(scope?: string): boolean;
+    readonly override: ApiField.InitArguments['override'];
+    inScope(scope?: string | '*'): boolean;
+    forScope(scope?: string): this;
     toJSON(options?: ApiDocument.ExportOptions): OpraSchema.Field;
 }
 /**
@@ -63,9 +66,9 @@ export declare namespace ApiField {
         type?: string | OpraSchema.DataType | TypeThunkAsync | EnumType.EnumObject | EnumType.EnumArray | object;
     }, OpraSchema.Field> {
         scopePattern?: (string | RegExp) | (string | RegExp)[];
-        overrides?: StrictOmit<Metadata, 'overrides' | 'type' | 'isArray'>[];
+        override?: StrictOmit<Metadata, 'override' | 'type' | 'isArray'>[];
     }
-    interface Options extends Partial<StrictOmit<Metadata, 'overrides' | 'scopePattern'>> {
+    interface Options extends Partial<StrictOmit<Metadata, 'override' | 'scopePattern'>> {
         /**
          * A variable that defines the pattern or patterns used to determine scope.
          * This can either be a single string or regular expression, or an array containing multiple strings or regular expressions.

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

@@ -50,7 +50,7 @@ declare abstract class ComplexTypeBaseClass extends DataType {
     /**
      *
      */
-    findField(nameOrPath: string, scope?: string): ApiField | undefined;
+    findField(nameOrPath: string, scope?: string | '*'): ApiField | undefined;
     /**
      *
      */
@@ -60,7 +60,7 @@ declare abstract class ComplexTypeBaseClass extends DataType {
      */
     parseFieldPath(fieldPath: string, options?: {
         allowSigns?: 'first' | 'each';
-        scope?: string;
+        scope?: string | '*';
     }): ComplexType.ParsedFieldPath[];
     /**
      *

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

@@ -13,13 +13,12 @@ import { nodeInspectCustom } from '../utils/inspect.util.js';
 export declare namespace DataType {
     interface Metadata extends DataTypeBase {
         name?: string;
+        scopePattern?: (string | RegExp) | (string | RegExp)[];
     }
     interface Options extends Partial<StrictOmit<Metadata, 'kind' | 'examples'>> {
         embedded?: boolean;
-        scopePattern?: (string | RegExp) | (string | RegExp)[];
     }
     interface InitArguments extends DataType.Metadata {
-        scopePattern?: (string | RegExp) | (string | RegExp)[];
     }
     interface GenerateCodecOptions extends ValidationOptions {
         documentElement?: DocumentElement;
@@ -61,7 +60,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/decorators/api-field-decorator.d.ts

@@ -1,5 +1,16 @@
+import { StrictOmit } from 'ts-gems';
 import type { ApiField } from '../data-type/api-field.js';
 export interface ApiFieldDecorator extends PropertyDecorator {
+    /**
+     * Overrides the default settings of an API field with specified options.
+     *
+     * @param {string | RegExp | (string | RegExp)[]} scopePattern - A pattern or array of patterns that defines the scope
+     *        within which the override applies. Patterns can be strings or regular expressions.
+     * @param {StrictOmit<ApiField.Options, 'isArray' | 'type' | 'scopePattern'>} options - Configuration options to override
+     *        the default API field behavior, excluding the properties 'isArray', 'type', and 'scopePattern'.
+     * @return {ApiFieldDecorator} The decorated API field after applying the override configuration.
+     */
+    Override(scopePattern: (string | RegExp) | (string | RegExp)[], options: StrictOmit<ApiField.Options, 'isArray' | 'type' | 'scopePattern'>): ApiFieldDecorator;
 }
 export interface ApiFieldDecoratorFactory {
     (options?: ApiField.Options): ApiFieldDecorator;