@opra/common 1.7.3 → 1.8.0

package/esm/filter/antlr/OpraFilterVisitor.js

@@ -1,4 +1,4 @@
-// Generated from ./src/filter/antlr/OpraFilter.g4 by ANTLR 4.12.0
+// Generated from ./src/filter/antlr/OpraFilter.g4 by ANTLR 4.13.2
 import { ParseTreeVisitor } from '@browsery/antlr4';
 /**
  * This interface defines a complete generic visitor for a parse tree produced

package/esm/filter/ast/index.js

@@ -10,6 +10,7 @@ export * from './expressions/negative-expression.js';
 export * from './expressions/parenthesized-expression.js';
 export * from './terms/boolean-literal.js';
 export * from './terms/date-literal.js';
+export * from './terms/date-time-literal.js';
 export * from './terms/null-literal.js';
 export * from './terms/number-literal.js';
 export * from './terms/qualified-identifier.js';

package/esm/filter/ast/terms/date-time-literal.js

@@ -0,0 +1,23 @@
+import { toDateDef } from 'putil-varhelpers';
+import { FilterValidationError } from '../../errors.js';
+import { quoteFilterString } from '../../utils.js';
+import { Literal } from '../abstract/literal.js';
+const NullDate = new Date(0);
+export class DateTimeLiteral extends Literal {
+    constructor(value) {
+        super('');
+        if (value instanceof Date) {
+            this.value = value.toISOString();
+            return;
+        }
+        // noinspection SuspiciousTypeOfGuard
+        if (typeof value === 'string' && toDateDef(value, NullDate) !== NullDate) {
+            this.value = value;
+            return;
+        }
+        throw new FilterValidationError(`Invalid date-time value "${value}"`);
+    }
+    toString() {
+        return quoteFilterString(this.value);
+    }
+}

package/esm/filter/build.js

@@ -81,7 +81,9 @@ export function $arithmetic(n) {
     return exp;
 }
 function comparisonExpression(op, left, right) {
-    const lex = wrapEntryValue(left);
+    const lex = typeof left === 'string'
+        ? new QualifiedIdentifier(left)
+        : wrapEntryValue(left);
     const rex = wrapEntryValue(right);
     return new ComparisonExpression({ op, left: lex, right: rex });
 }

package/esm/filter/filter-tree-visitor.js

@@ -1,6 +1,6 @@
 import { ParseTreeVisitor } from '@browsery/antlr4';
 import { LogicalExpressionContext, } from './antlr/OpraFilterParser.js';
-import { ArrayExpression, BooleanLiteral, ComparisonExpression, DateLiteral, LogicalExpression, NegativeExpression, NullLiteral, NumberLiteral, ParenthesizedExpression, QualifiedIdentifier, StringLiteral, TimeLiteral, } from './ast/index.js';
+import { ArrayExpression, BooleanLiteral, ComparisonExpression, DateLiteral, DateTimeLiteral, LogicalExpression, NegativeExpression, NullLiteral, NumberLiteral, ParenthesizedExpression, QualifiedIdentifier, StringLiteral, TimeLiteral, } from './ast/index.js';
 import { ExternalConstant } from './ast/terms/external-constant.js';
 import { unquoteFilterString } from './utils.js';
 export class FilterTreeVisitor extends ParseTreeVisitor {
@@ -82,7 +82,7 @@ export class FilterTreeVisitor extends ParseTreeVisitor {
         return new DateLiteral(unquoteFilterString(ctx.getText()));
     }
     visitDateTimeLiteral(ctx) {
-        return new DateLiteral(unquoteFilterString(ctx.getText()));
+        return new DateTimeLiteral(unquoteFilterString(ctx.getText()));
     }
     visitTimeLiteral(ctx) {
         return new TimeLiteral(unquoteFilterString(ctx.getText()));

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@opra/common",
-  "version": "1.7.3",
+  "version": "1.8.0",
   "description": "Opra common package",
   "author": "Panates",
   "license": "MIT",
   "dependencies": {
-    "@browsery/antlr4": "^4.13.3-r1",
-    "@browsery/highland": "^2.13.6-r2",
-    "@browsery/http-parser": "^0.5.9-r1",
-    "@browsery/i18next": "^23.12.3-r1",
-    "@browsery/type-is": "^1.6.18-r5",
+    "@browsery/antlr4": "^4.13.3-r4",
+    "@browsery/highland": "^2.13.6-r4",
+    "@browsery/http-parser": "^0.5.9-r4",
+    "@browsery/i18next": "^24.2.1-r1",
+    "@browsery/type-is": "^1.6.18-r8",
     "@jsopen/objects": "^1.5.0",
     "fast-tokenizer": "^1.7.0",
     "putil-promisify": "^1.10.1",

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

@@ -43,6 +43,7 @@ declare class ApiFieldClass extends DocumentElement {
     readonly type: DataType;
     readonly description?: string;
     readonly isArray?: boolean;
+    readonly isNestedEntity?: boolean;
     readonly default?: any;
     readonly fixed?: any;
     readonly required?: boolean;
@@ -66,7 +67,7 @@ export declare namespace ApiField {
         type?: string | OpraSchema.DataType | TypeThunkAsync | EnumType.EnumObject | EnumType.EnumArray | object;
     }, OpraSchema.Field> {
         scopePattern?: (string | RegExp) | (string | RegExp)[];
-        override?: StrictOmit<Metadata, 'override' | 'type' | 'isArray'>[];
+        override?: StrictOmit<Metadata, 'override' | 'type' | 'isArray' | 'isNestedEntity'>[];
     }
     interface Options extends Partial<StrictOmit<Metadata, 'override' | 'scopePattern'>> {
         /**

package/types/document/decorators/api-field-decorator.d.ts

@@ -6,11 +6,11 @@ export interface ApiFieldDecorator extends PropertyDecorator {
      *
      * @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
+     * @param {StrictOmit<ApiField.Options, 'isArray' | 'isNestedEntity' | '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;
+    Override(scopePattern: (string | RegExp) | (string | RegExp)[], options: StrictOmit<ApiField.Options, 'isArray' | 'isNestedEntity' | 'type' | 'scopePattern'>): ApiFieldDecorator;
 }
 export interface ApiFieldDecoratorFactory {
     (options?: ApiField.Options): ApiFieldDecorator;

package/types/filter/antlr/OpraFilterLexer.d.ts

@@ -1,4 +1,4 @@
-import { ATN, CharStream, DFA, Lexer } from '@browsery/antlr4';
+import { ATN, CharStream, DFA, Lexer } from "@browsery/antlr4";
 export default class OpraFilterLexer extends Lexer {
     static readonly T__0 = 1;
     static readonly T__1 = 2;

package/types/filter/antlr/OpraFilterListener.d.ts

@@ -1,5 +1,31 @@
-import { ParseTreeListener } from '@browsery/antlr4';
-import { ArithmeticOperatorContext, ArrayValueContext, BooleanContext, BooleanLiteralContext, ComparisonExpressionContext, ComparisonLeftContext, ComparisonOperatorContext, ComparisonRightContext, DateLiteralContext, DateTimeLiteralContext, ExternalConstantContext, IdentifierContext, InfinityContext, InfinityLiteralContext, LogicalExpressionContext, LogicalOperatorContext, NegativeExpressionContext, NullContext, NullLiteralContext, NumberLiteralContext, ParenthesizedExpressionContext, ParenthesizedItemContext, PolarityOperatorContext, QualifiedIdentifierContext, RootContext, StringLiteralContext, TimeLiteralContext } from './OpraFilterParser.js';
+import { ParseTreeListener } from "@browsery/antlr4";
+import type { RootContext } from "./OpraFilterParser.js";
+import type { ParenthesizedExpressionContext } from "./OpraFilterParser.js";
+import type { NegativeExpressionContext } from "./OpraFilterParser.js";
+import type { ComparisonExpressionContext } from "./OpraFilterParser.js";
+import type { LogicalExpressionContext } from "./OpraFilterParser.js";
+import type { ComparisonLeftContext } from "./OpraFilterParser.js";
+import type { ComparisonRightContext } from "./OpraFilterParser.js";
+import type { ParenthesizedItemContext } from "./OpraFilterParser.js";
+import type { NumberLiteralContext } from "./OpraFilterParser.js";
+import type { InfinityLiteralContext } from "./OpraFilterParser.js";
+import type { BooleanLiteralContext } from "./OpraFilterParser.js";
+import type { NullLiteralContext } from "./OpraFilterParser.js";
+import type { DateTimeLiteralContext } from "./OpraFilterParser.js";
+import type { DateLiteralContext } from "./OpraFilterParser.js";
+import type { TimeLiteralContext } from "./OpraFilterParser.js";
+import { type StringLiteralContext } from "./OpraFilterParser.js";
+import type { QualifiedIdentifierContext } from "./OpraFilterParser.js";
+import type { ExternalConstantContext } from "./OpraFilterParser.js";
+import type { IdentifierContext } from "./OpraFilterParser.js";
+import type { ArrayValueContext } from "./OpraFilterParser.js";
+import type { BooleanContext } from "./OpraFilterParser.js";
+import type { NullContext } from "./OpraFilterParser.js";
+import type { InfinityContext } from "./OpraFilterParser.js";
+import type { ArithmeticOperatorContext } from "./OpraFilterParser.js";
+import type { ComparisonOperatorContext } from "./OpraFilterParser.js";
+import type { LogicalOperatorContext } from "./OpraFilterParser.js";
+import type { PolarityOperatorContext } from "./OpraFilterParser.js";
 /**
  * This interface defines a complete listener for a parse tree produced by
  * `OpraFilterParser`.
@@ -142,29 +168,29 @@ export default class OpraFilterListener extends ParseTreeListener {
      */
     exitNullLiteral?: (ctx: NullLiteralContext) => void;
     /**
-     * Enter a parse tree produced by the `dateLiteral`
+     * Enter a parse tree produced by the `dateTimeLiteral`
      * labeled alternative in `OpraFilterParser.value`.
      * @param ctx the parse tree
      */
-    enterDateLiteral?: (ctx: DateLiteralContext) => void;
+    enterDateTimeLiteral?: (ctx: DateTimeLiteralContext) => void;
     /**
-     * Exit a parse tree produced by the `dateLiteral`
+     * Exit a parse tree produced by the `dateTimeLiteral`
      * labeled alternative in `OpraFilterParser.value`.
      * @param ctx the parse tree
      */
-    exitDateLiteral?: (ctx: DateLiteralContext) => void;
+    exitDateTimeLiteral?: (ctx: DateTimeLiteralContext) => void;
     /**
-     * Enter a parse tree produced by the `dateTimeLiteral`
+     * Enter a parse tree produced by the `dateLiteral`
      * labeled alternative in `OpraFilterParser.value`.
      * @param ctx the parse tree
      */
-    enterDateTimeLiteral?: (ctx: DateTimeLiteralContext) => void;
+    enterDateLiteral?: (ctx: DateLiteralContext) => void;
     /**
-     * Exit a parse tree produced by the `dateTimeLiteral`
+     * Exit a parse tree produced by the `dateLiteral`
      * labeled alternative in `OpraFilterParser.value`.
      * @param ctx the parse tree
      */
-    exitDateTimeLiteral?: (ctx: DateTimeLiteralContext) => void;
+    exitDateLiteral?: (ctx: DateLiteralContext) => void;
     /**
      * Enter a parse tree produced by the `timeLiteral`
      * labeled alternative in `OpraFilterParser.value`.

package/types/filter/antlr/OpraFilterParser.d.ts

@@ -1,4 +1,4 @@
-import { ATN, DFA, FailedPredicateException, Parser, ParserRuleContext, type RuleContext, type TerminalNode, type TokenStream } from '@browsery/antlr4';
+import { ATN, DFA, FailedPredicateException, Parser, ParserRuleContext, RuleContext, TerminalNode, TokenStream } from '@browsery/antlr4';
 import type OpraFilterListener from './OpraFilterListener.js';
 import type OpraFilterVisitor from './OpraFilterVisitor.js';
 export default class OpraFilterParser extends Parser {

package/types/filter/antlr/OpraFilterVisitor.d.ts

@@ -1,5 +1,31 @@
 import { ParseTreeVisitor } from '@browsery/antlr4';
-import { ArithmeticOperatorContext, ArrayValueContext, BooleanContext, BooleanLiteralContext, ComparisonExpressionContext, ComparisonLeftContext, ComparisonOperatorContext, ComparisonRightContext, DateLiteralContext, DateTimeLiteralContext, ExternalConstantContext, IdentifierContext, InfinityContext, InfinityLiteralContext, LogicalExpressionContext, LogicalOperatorContext, NegativeExpressionContext, NullContext, NullLiteralContext, NumberLiteralContext, ParenthesizedExpressionContext, ParenthesizedItemContext, PolarityOperatorContext, QualifiedIdentifierContext, RootContext, StringLiteralContext, TimeLiteralContext } from './OpraFilterParser.js';
+import type { RootContext } from "./OpraFilterParser.js";
+import type { ParenthesizedExpressionContext } from "./OpraFilterParser.js";
+import type { NegativeExpressionContext } from "./OpraFilterParser.js";
+import type { ComparisonExpressionContext } from "./OpraFilterParser.js";
+import type { LogicalExpressionContext } from "./OpraFilterParser.js";
+import type { ComparisonLeftContext } from "./OpraFilterParser.js";
+import type { ComparisonRightContext } from "./OpraFilterParser.js";
+import type { ParenthesizedItemContext } from "./OpraFilterParser.js";
+import type { NumberLiteralContext } from "./OpraFilterParser.js";
+import type { InfinityLiteralContext } from "./OpraFilterParser.js";
+import type { BooleanLiteralContext } from "./OpraFilterParser.js";
+import type { NullLiteralContext } from "./OpraFilterParser.js";
+import type { DateTimeLiteralContext } from "./OpraFilterParser.js";
+import type { DateLiteralContext } from "./OpraFilterParser.js";
+import type { TimeLiteralContext } from "./OpraFilterParser.js";
+import type { StringLiteralContext } from "./OpraFilterParser.js";
+import type { QualifiedIdentifierContext } from "./OpraFilterParser.js";
+import type { ExternalConstantContext } from "./OpraFilterParser.js";
+import type { IdentifierContext } from "./OpraFilterParser.js";
+import type { ArrayValueContext } from "./OpraFilterParser.js";
+import type { BooleanContext } from "./OpraFilterParser.js";
+import type { NullContext } from "./OpraFilterParser.js";
+import type { InfinityContext } from "./OpraFilterParser.js";
+import type { ArithmeticOperatorContext } from "./OpraFilterParser.js";
+import type { ComparisonOperatorContext } from "./OpraFilterParser.js";
+import type { LogicalOperatorContext } from "./OpraFilterParser.js";
+import type { PolarityOperatorContext } from "./OpraFilterParser.js";
 /**
  * This interface defines a complete generic visitor for a parse tree produced
  * by `OpraFilterParser`.
@@ -89,19 +115,19 @@ export default class OpraFilterVisitor<Result> extends ParseTreeVisitor<Result>
      */
     visitNullLiteral?: (ctx: NullLiteralContext) => Result;
     /**
-     * Visit a parse tree produced by the `dateLiteral`
+     * Visit a parse tree produced by the `dateTimeLiteral`
      * labeled alternative in `OpraFilterParser.value`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitDateLiteral?: (ctx: DateLiteralContext) => Result;
+    visitDateTimeLiteral?: (ctx: DateTimeLiteralContext) => Result;
     /**
-     * Visit a parse tree produced by the `dateTimeLiteral`
+     * Visit a parse tree produced by the `dateLiteral`
      * labeled alternative in `OpraFilterParser.value`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitDateTimeLiteral?: (ctx: DateTimeLiteralContext) => Result;
+    visitDateLiteral?: (ctx: DateLiteralContext) => Result;
     /**
      * Visit a parse tree produced by the `timeLiteral`
      * labeled alternative in `OpraFilterParser.value`.

package/types/filter/ast/index.d.ts

@@ -10,6 +10,7 @@ export * from './expressions/negative-expression.js';
 export * from './expressions/parenthesized-expression.js';
 export * from './terms/boolean-literal.js';
 export * from './terms/date-literal.js';
+export * from './terms/date-time-literal.js';
 export * from './terms/null-literal.js';
 export * from './terms/number-literal.js';
 export * from './terms/qualified-identifier.js';

package/types/filter/ast/terms/date-time-literal.d.ts

@@ -0,0 +1,6 @@
+import { Literal } from '../abstract/literal.js';
+export declare class DateTimeLiteral extends Literal {
+    value: string;
+    constructor(value: string | Date);
+    toString(): string;
+}

package/types/filter/filter-tree-visitor.d.ts

@@ -1,7 +1,7 @@
 import { ParseTreeVisitor, type RuleNode } from '@browsery/antlr4';
 import { ArrayValueContext, BooleanLiteralContext, ComparisonExpressionContext, DateLiteralContext, DateTimeLiteralContext, ExternalConstantContext, LogicalExpressionContext, NegativeExpressionContext, NumberLiteralContext, ParenthesizedExpressionContext, ParenthesizedItemContext, QualifiedIdentifierContext, RootContext, StringLiteralContext, TimeLiteralContext } from './antlr/OpraFilterParser.js';
 import OpraFilterVisitor from './antlr/OpraFilterVisitor.js';
-import { ArrayExpression, BooleanLiteral, DateLiteral, LogicalExpression, NegativeExpression, NullLiteral, NumberLiteral, ParenthesizedExpression, QualifiedIdentifier, StringLiteral, TimeLiteral } from './ast/index.js';
+import { ArrayExpression, BooleanLiteral, DateLiteral, DateTimeLiteral, LogicalExpression, NegativeExpression, NullLiteral, NumberLiteral, ParenthesizedExpression, QualifiedIdentifier, StringLiteral, TimeLiteral } from './ast/index.js';
 import { ExternalConstant } from './ast/terms/external-constant.js';
 export declare class FilterTreeVisitor extends ParseTreeVisitor<any> implements OpraFilterVisitor<any> {
     private _timeZone?;
@@ -24,7 +24,7 @@ export declare class FilterTreeVisitor extends ParseTreeVisitor<any> implements
     visitStringLiteral(ctx: StringLiteralContext): StringLiteral;
     visitInfinityLiteral(): NumberLiteral;
     visitDateLiteral(ctx: DateLiteralContext): DateLiteral;
-    visitDateTimeLiteral(ctx: DateTimeLiteralContext): DateLiteral;
+    visitDateTimeLiteral(ctx: DateTimeLiteralContext): DateTimeLiteral;
     visitTimeLiteral(ctx: TimeLiteralContext): TimeLiteral;
     visitArrayValue(ctx: ArrayValueContext): ArrayExpression;
 }

package/types/schema/data-type/field.interface.d.ts

@@ -3,6 +3,11 @@ export declare namespace Field {
     type Name = string;
     type QualifiedName = string;
 }
+/**
+ * Represents a Field type used to define properties and behaviors of a data structure.
+ *
+ * The `Field` type allows describing the characteristics, constraints, and metadata of a field within an entity or data type.
+ */
 export type Field = {
     type?: DataType.Name | DataType;
     /**
@@ -35,9 +40,19 @@ export type Field = {
      */
     exclusive?: boolean;
     /**
-     * Indicates if the field value is an array
+     * A boolean variable that indicates whether the value represents an array or not.
+     * If true, the value is recognized as an array.
+     * If false, the value is not an array.
+     * This property is optional and may be undefined.
      */
     isArray?: boolean;
+    /**
+     * Determines whether the field is a nested entity within a parent structure.
+     * If set to true, the field is considered to be part of a hierarchical or
+     * composite structure. If false or undefined, the field is considered
+     * standalone or root-level.
+     */
+    isNestedEntity?: boolean;
     /**
      * Indicates key field when this field is a ComplexType array
      */