@opra/common 1.4.3 → 1.5.0

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

@@ -10,6 +10,7 @@ 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>;
@@ -23,7 +24,7 @@ export declare class ApiDocumentFactory {
     /**
      * Creates ApiDocument instance from given schema object
      */
-    static createDocument(schemaOrUrl: string | PartialSome<OpraSchema.ApiDocument, 'spec'> | ApiDocumentFactory.InitArguments, options?: Partial<Pick<DocumentInitContext, 'maxErrors' | 'showErrorDetails'>> | DocumentInitContext): Promise<ApiDocument>;
+    static createDocument(schemaOrUrl: string | PartialSome<OpraSchema.ApiDocument, 'spec'> | ApiDocumentFactory.InitArguments, options?: Partial<Pick<DocumentInitContext, 'maxErrors' | 'showErrorDetails' | 'scopes'>> | DocumentInitContext): Promise<ApiDocument>;
     /**
      * Downloads schema from the given URL and creates the document instance   * @param url
      */

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

@@ -24,5 +24,5 @@ export declare class HttpApi extends ApiBase {
     findController(resourcePath: string): HttpController | undefined;
     findOperation(controller: Type, operationName: string): HttpOperation | undefined;
     findOperation(resourcePath: string, operationName: string): HttpOperation | undefined;
-    toJSON(): OpraSchema.HttpApi;
+    toJSON(options: ApiDocument.ExportOptions): OpraSchema.HttpApi;
 }

package/types/document/http/http-controller.d.ts

@@ -1,6 +1,7 @@
 import type { Combine, ThunkAsync, Type } from 'ts-gems';
 import { ResponsiveMap } from '../../helpers/index.js';
 import { OpraSchema } from '../../schema/index.js';
+import type { ApiDocument } from '../api-document.js';
 import { DataTypeMap } from '../common/data-type-map.js';
 import { DocumentElement } from '../common/document-element.js';
 import type { EnumType } from '../data-type/enum-type.js';
@@ -84,7 +85,7 @@ declare class HttpControllerClass extends DocumentElement {
     /**
      *
      */
-    toJSON(): OpraSchema.HttpController;
+    toJSON(options?: ApiDocument.ExportOptions): OpraSchema.HttpController;
     /**
      *
      */

package/types/document/http/http-media-type.d.ts

@@ -1,6 +1,7 @@
 import type { Combine, StrictOmit, Type } from 'ts-gems';
 import { type Validator } from 'valgen';
 import { OpraSchema } from '../../schema/index.js';
+import type { ApiDocument } from '../api-document.js';
 import { DocumentElement } from '../common/document-element.js';
 import { DataType } from '../data-type/data-type.js';
 import type { HttpMultipartField } from './http-multipart-field.js';
@@ -54,7 +55,7 @@ declare class HttpMediaTypeClass extends DocumentElement {
     maxFileSize?: number;
     maxTotalFileSize?: number;
     findMultipartField(fieldName: string, fieldType?: OpraSchema.HttpMultipartFieldType): HttpMultipartField | undefined;
-    toJSON(): OpraSchema.HttpMediaType;
+    toJSON(options?: ApiDocument.ExportOptions): OpraSchema.HttpMediaType;
     generateCodec(codec: 'encode' | 'decode', options?: DataType.GenerateCodecOptions): Validator;
 }
 export {};

package/types/document/http/http-multipart-field.d.ts

@@ -1,5 +1,6 @@
 import type { Combine } from 'ts-gems';
 import { OpraSchema } from '../../schema/index.js';
+import type { ApiDocument } from '../api-document';
 import { HttpMediaType } from './http-media-type.js';
 /**
  * @namespace HttpMultipartField
@@ -21,5 +22,5 @@ export declare class HttpMultipartField extends HttpMediaType {
     fieldType: OpraSchema.HttpMultipartFieldType;
     required?: boolean;
     constructor(owner: HttpMediaType | HttpMultipartField, initArgs: HttpMultipartField.InitArguments);
-    toJSON(): OpraSchema.HttpMultipartField;
+    toJSON(options?: ApiDocument.ExportOptions): OpraSchema.HttpMultipartField;
 }

package/types/document/http/http-operation-response.d.ts

@@ -1,5 +1,6 @@
 import type { Combine, StrictOmit } from 'ts-gems';
 import { OpraSchema } from '../../schema/index.js';
+import type { ApiDocument } from '../api-document';
 import { HttpMediaType } from './http-media-type.js';
 import { HttpOperation } from './http-operation.js';
 import type { HttpParameter } from './http-parameter.js';
@@ -32,5 +33,5 @@ export declare class HttpOperationResponse extends HttpMediaType {
     partial?: boolean | 'deep';
     constructor(owner: HttpOperation, init: HttpOperationResponse.InitArguments);
     findParameter(paramName: string, location?: OpraSchema.HttpParameterLocation): HttpParameter | undefined;
-    toJSON(): OpraSchema.HttpOperationResponse;
+    toJSON(options?: ApiDocument.ExportOptions): OpraSchema.HttpOperationResponse;
 }

package/types/document/http/http-operation.d.ts

@@ -1,5 +1,6 @@
 import type { Combine, StrictOmit, ThunkAsync, Type } from 'ts-gems';
 import { OpraSchema } from '../../schema/index.js';
+import type { ApiDocument } from '../api-document';
 import { DataTypeMap } from '../common/data-type-map.js';
 import { DocumentElement } from '../common/document-element.js';
 import type { DataType } from '../data-type/data-type.js';
@@ -82,6 +83,6 @@ declare class HttpOperationClass extends DocumentElement {
     compositionOptions?: Record<string, any>;
     findParameter(paramName: string, location?: OpraSchema.HttpParameterLocation): HttpParameter | undefined;
     getFullUrl(): string;
-    toJSON(): OpraSchema.HttpOperation;
+    toJSON(options?: ApiDocument.ExportOptions): OpraSchema.HttpOperation;
 }
 export {};

package/types/document/http/http-parameter.d.ts

@@ -1,5 +1,6 @@
 import { type Combine, type StrictOmit, type TypeThunkAsync } from 'ts-gems';
 import type { OpraSchema } from '../../schema/index.js';
+import type { ApiDocument } from '../api-document';
 import { DocumentElement } from '../common/document-element.js';
 import { Value } from '../common/value.js';
 import { DataType } from '../data-type/data-type.js';
@@ -46,6 +47,6 @@ declare class HttpParameterClass extends Value {
     deprecated?: boolean | string;
     required?: boolean;
     arraySeparator?: string;
-    toJSON(): OpraSchema.HttpParameter;
+    toJSON(options?: ApiDocument.ExportOptions): OpraSchema.HttpParameter;
 }
 export {};

package/types/document/http/http-request-body.d.ts

@@ -1,5 +1,6 @@
 import type { StrictOmit } from 'ts-gems';
 import { OpraSchema } from '../../schema/index.js';
+import type { ApiDocument } from '../api-document';
 import { DocumentElement } from '../common/document-element.js';
 import { HttpMediaType } from './http-media-type.js';
 import type { HttpOperation } from './http-operation';
@@ -30,5 +31,5 @@ export declare class HttpRequestBody extends DocumentElement {
     partial?: boolean | 'deep';
     allowPatchOperators?: boolean;
     constructor(owner: HttpOperation);
-    toJSON(): OpraSchema.HttpRequestBody;
+    toJSON(options?: ApiDocument.ExportOptions): OpraSchema.HttpRequestBody;
 }

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

@@ -1,7 +1,7 @@
 import '../polifils/array-find-last.js';
 import type { StrictOmit } from 'ts-gems';
 import { Validator } from 'valgen';
-import type { ComplexType } from '../document/index.js';
+import type { ComplexType, DocumentElement } from '../document/index.js';
 import { ResponsiveMap } from '../helpers/index.js';
 import { OpraSchema } from '../schema/index.js';
 import { type ComparisonOperator, Expression } from './ast/index.js';
@@ -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): Expression | undefined;
-    protected normalizeFilterAst(ast: Expression, stack: Expression[], currentType?: ComplexType): Expression | undefined;
+    normalizeFilter(filter: OpraSchema.Field.QualifiedName | Expression, currentType?: ComplexType, element?: DocumentElement): Expression | undefined;
+    protected normalizeFilterAst(ast: Expression, stack: Expression[], currentType?: ComplexType, scopes?: string[]): Expression | undefined;
     toJSON(): Record<string, FilterRules.Rule>;
     [Symbol.iterator](): IterableIterator<[string, FilterRules.Rule]>;
 }