@opra/common 1.5.3 → 1.5.5

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)[];
     }
     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;

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

@@ -90,7 +90,7 @@ export declare class DataTypeFactory {
      * @protected
      */
     protected static _importDataTypeArgs(context: DataTypeFactory.Context, owner: DocumentElement, thunk: string | Type | OpraSchema.DataType | object): Promise<DataTypeFactory.DataTypeInitArguments | string | void>;
-    protected static _prepareDataTypeArgs(context: DataTypeFactory.Context, initArgs: DataTypeFactory.DataTypeInitArguments, metadata: OpraSchema.DataTypeBase): Promise<void>;
+    protected static _prepareDataTypeArgs(context: DataTypeFactory.Context, initArgs: DataTypeFactory.DataTypeInitArguments, metadata: OpraSchema.DataTypeBase | DataType.Metadata): Promise<void>;
     protected static _prepareComplexTypeArgs(context: DataTypeFactory.Context, owner: DocumentElement, initArgs: DataTypeFactory.ComplexTypeInit, metadata: ComplexType.Metadata | OpraSchema.ComplexType): Promise<void>;
     protected static _prepareEnumTypeArgs(context: DataTypeFactory.Context, owner: DocumentElement, initArgs: DataTypeFactory.EnumTypeInit, metadata: EnumType.Metadata | OpraSchema.EnumType): Promise<void>;
     protected static _prepareSimpleTypeArgs(context: DataTypeFactory.Context, owner: DocumentElement, initArgs: DataTypeFactory.SimpleTypeInit, metadata: SimpleType.Metadata | OpraSchema.SimpleType): Promise<void>;

package/types/filter/filter-rules.d.ts

@@ -21,8 +21,8 @@ export declare class FilterRules {
     set(fieldName: string, options?: Partial<StrictOmit<FilterRules.Rule, 'operators'>> & {
         operators?: ComparisonOperator[] | string;
     }): void;
-    normalizeFilter(filter: OpraSchema.Field.QualifiedName | Expression, currentType?: ComplexType, scope?: any): Expression | undefined;
-    protected normalizeFilterAst(ast: Expression, stack: Expression[], currentType?: ComplexType, scope?: string): Expression | undefined;
+    normalizeFilter(filter: OpraSchema.Field.QualifiedName | Expression, currentType?: ComplexType, scope?: string | '*'): Expression | undefined;
+    protected normalizeFilterAst(ast: Expression, stack: Expression[], currentType?: ComplexType, scope?: string | '*'): Expression | undefined;
     toJSON(): Record<string, FilterRules.Rule>;
     [Symbol.iterator](): IterableIterator<[string, FilterRules.Rule]>;
 }