angular-odata 0.146.1 → 0.147.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-odata",
-  "version": "0.146.1",
+  "version": "0.147.0",
   "license": "MIT",
   "description": "Client side OData typescript library for Angular",
   "repository": {

package/types/angular-odata.d.ts

@@ -1,7 +1,7 @@
 import * as json_schema from 'json-schema';
 import { JSONSchema7 } from 'json-schema';
 import { Observable, Subject, Subscription } from 'rxjs';
-import { HttpContext, HttpHeaders, HttpParams, HttpResponseBase, HttpErrorResponse, HttpResponse, HttpClient, HttpEvent } from '@angular/common/http';
+import { HttpContext, HttpHeaders, HttpParams, HttpResponseBase, HttpErrorResponse, HttpResponse, HttpEvent, HttpClient } from '@angular/common/http';
 import * as angular_odata from 'angular-odata';
 import * as i0 from '@angular/core';
 import { EventEmitter, Provider, InjectionToken, EnvironmentProviders, ModuleWithProviders } from '@angular/core';
@@ -3804,8 +3804,8 @@ declare class ODataModel<T> {
     asEntity<R>(ctx: (model: this) => R): R;
     callFunction<P, R>(name: string, params: P | null, responseType: 'property' | 'model' | 'collection' | 'none' | 'blob' | 'arraybuffer', options?: ODataFunctionOptions<R>): Observable<R | ODataModel<R> | ODataCollection<R, ODataModel<R>> | null | Blob | ArrayBuffer>;
     callAction<P, R>(name: string, params: P | null, responseType?: 'property' | 'model' | 'collection' | 'none' | 'blob' | 'arraybuffer', { ...options }?: {} & ODataActionOptions<R>): Observable<R | ODataModel<R> | ODataCollection<R, ODataModel<R>> | null | Blob | ArrayBuffer>;
-    cast<S>(type: string, ModelType?: typeof ODataModel): ODataModel<T> & ModelInterface<T>;
-    cast<S, M extends ODataModel<S>>(type: string, ModelType?: typeof ODataModel): M;
+    cast<S>(type: string, ModelType?: typeof ODataModel<S>): ODataModel<S> & ModelInterface<S>;
+    cast<S, M extends ODataModel<S>>(type: string, ModelType?: typeof ODataModel<S>): M;
     fetchNavigationProperty<S>(name: keyof T | string, responseType: 'model' | 'collection', options?: ODataQueryArgumentsOptions<S>): Observable<ODataModel<S> | ODataCollection<S, ODataModel<S>> | null>;
     fetchAttribute<P>(name: keyof T, options?: ODataQueryArgumentsOptions<P>): Observable<P | ODataModel<P> | ODataCollection<P, ODataModel<P>> | null>;
     getAttribute<P>(name: keyof T | string): P | ODataModel<P> | ODataCollection<P, ODataModel<P>> | null;
@@ -4047,13 +4047,13 @@ declare class ODataStructuredType<T> extends ODataParserSchemaElement<T, ODataSt
      * @returns The schema that matches the predicate.
      */
     findParentSchema(predicate: (p: ODataStructuredType<any>) => boolean): ODataStructuredType<any> | undefined;
-    findChildSchema(predicate: (p: ODataStructuredType<any>) => boolean): ODataStructuredType<any> | undefined;
     /**
      * Find a parent schema of the structured type for the given field.
      * @param field Field that belongs to the structured type
      * @returns The schema of the field
      */
     findParentSchemaForField<E>(field: ODataStructuredTypeFieldParser<any>): ODataStructuredType<E>;
+    findChildSchema(predicate: (p: ODataStructuredType<any>) => boolean): ODataStructuredType<any> | undefined;
     /**
      * Picks the fields from attributes.
      * @param attrs
@@ -4284,11 +4284,6 @@ declare class ODataModelField<F> {
     field: string;
     parser: ODataStructuredTypeFieldParser<F>;
     options: ODataModelOptions<any>;
-    optionsForType?: (type: string) => ODataModelOptions<any> | undefined;
-    modelForType?: (t: string) => typeof ODataModel<any> | undefined;
-    collectionForType?: (t: string) => typeof ODataCollection<any, ODataModel<any>> | undefined;
-    enumForType?: (t: string) => ODataEnumType<F> | undefined;
-    structuredForType?: (t: string) => ODataStructuredType<F> | undefined;
     default?: any;
     required: boolean;
     concurrency: boolean;
@@ -4303,12 +4298,7 @@ declare class ODataModelField<F> {
     get navigation(): boolean;
     get collection(): boolean;
     annotatedValue<T>(term: string | RegExp): T | undefined;
-    configure({ optionsForType, modelForType, collectionForType, enumForType, structuredForType, concurrency, options, }: {
-        optionsForType: (type: string) => ODataModelOptions<any> | undefined;
-        modelForType: (t: string) => typeof ODataModel<any> | undefined;
-        collectionForType: (t: string) => typeof ODataCollection<any, any> | undefined;
-        enumForType: (t: string) => ODataEnumType<any> | undefined;
-        structuredForType: (t: string) => ODataStructuredType<any> | undefined;
+    configure({ concurrency, options, }: {
         concurrency: boolean;
         options: ParserOptions;
     }): void;
@@ -4316,10 +4306,10 @@ declare class ODataModelField<F> {
     hasReferentials(): boolean;
     get referentials(): angular_odata.ODataReferential[];
     isStructuredType(): boolean;
-    structuredType(): ODataStructuredType<F>;
+    structuredType(): ODataStructuredType<any> | ODataStructuredType<unknown>;
     isEnumType(): boolean;
     isEdmType(): boolean;
-    enumType(): ODataEnumType<F>;
+    enumType(): ODataEnumType<any> | ODataEnumType<unknown>;
     validate(value: any, { method, navigation, }?: {
         method?: 'create' | 'update' | 'modify';
         navigation?: boolean;
@@ -4545,6 +4535,43 @@ declare class ODataModelOptions<T> {
     private _link;
 }
 
+declare class ODataInclude {
+    namespace: string;
+    alias?: string;
+    reference: ODataReference;
+    constructor(config: {
+        namespace: string;
+        alias?: string;
+    }, reference: ODataReference);
+    configure({ options }: {
+        options: ParserOptions;
+    }): void;
+}
+declare class ODataIncludeAnnotation {
+    termNamespace: string;
+    qualifier?: string;
+    targetNamespace?: string;
+    reference: ODataReference;
+    constructor(config: {
+        termNamespace: string;
+        qualifier?: string;
+        targetNamespace?: string;
+    }, reference: ODataReference);
+    configure({ options }: {
+        options: ParserOptions;
+    }): void;
+}
+declare class ODataReference extends ODataAnnotatable {
+    api: ODataApi;
+    uri: string;
+    includes: ODataInclude[];
+    includeAnnotations: ODataIncludeAnnotation[];
+    constructor(config: ODataReferenceConfig, api: ODataApi);
+    configure({ options }: {
+        options: ParserOptions;
+    }): void;
+}
+
 /**
  * Api abstraction for consuming OData services.
  */
@@ -4560,7 +4587,9 @@ declare class ODataApi {
     cache?: ODataCache;
     errorHandler?: (error: any, caught: Observable<any>) => Observable<never>;
     parsers: Map<string, Parser<any>>;
+    populateFromMetadata: boolean;
     schemas: ODataSchema[];
+    references: ODataReference[];
     models: {
         [type: string]: typeof ODataModel<any>;
     };
@@ -4568,10 +4597,8 @@ declare class ODataApi {
         [type: string]: typeof ODataCollection<any, ODataModel<any>>;
     };
     constructor(config: ODataApiConfig);
-    configure(settings?: {
-        requester?: (request: ODataRequest<any>) => Observable<any>;
-    }): void;
-    populate(metadata: ODataMetadata): void;
+    initialize(requester: (request: ODataRequest<any>) => Observable<any>): Promise<boolean>;
+    populate(metadata: ODataMetadata): boolean;
     fromJson<P, R>(json: {
         segments: ODataSegment[];
         options: {
@@ -4632,12 +4659,12 @@ declare class ODataApi {
     /**
      * Using the request, handle the fetching of the response
      * @param req The request to fetch
-     * @param res$ Observable of the response
      * @returns
      */
     private handleRequest;
-    private handleFetch;
-    private handleMutate;
+    private handleRequester;
+    private handleCacheFetch;
+    private handleCacheMutate;
     private memo;
     createSchema(config: ODataSchemaConfig): ODataSchema;
     findSchema(type: string): ODataSchema | undefined;
@@ -4793,6 +4820,7 @@ declare class ODataResource<T> {
         escape?: boolean;
     }): string;
     clone(): ODataResource<T>;
+    cast<C>(type: string): ODataResource<C>;
     private __parser;
     deserialize(value: any, options?: ParserOptions): any;
     serialize(value: any, options?: ParserOptions): any;
@@ -5120,6 +5148,7 @@ type ODataApiConfig = {
     parsers?: {
         [type: string]: Parser<any>;
     };
+    populateFromMetadata?: boolean;
     schemas?: ODataSchemaConfig[];
     references?: ODataReferenceConfig[];
     models?: {
@@ -5143,12 +5172,16 @@ type ODataAnnotationConfig = {
 };
 type ODataReferenceConfig = {
     uri: string;
-    includes?: string;
     annotations?: ODataAnnotationConfig[];
-    enums?: ODataEnumTypeConfig[];
-    entities?: ODataStructuredTypeConfig[];
-    callables?: ODataCallableConfig[];
-    containers?: ODataEntityContainerConfig[];
+    includes?: {
+        namespace: string;
+        alias?: string;
+    }[];
+    includeAnnotations?: {
+        termNamespace: string;
+        qualifier?: string;
+        targetNamespace?: string;
+    }[];
 };
 type ODataSchemaConfig = {
     namespace: string;
@@ -5257,9 +5290,7 @@ type ODataSingletonConfig = {
 declare class ODataSettings {
     apis: ODataApi[];
     constructor(configs: ODataApiConfig[]);
-    configure(settings: {
-        requester?: (request: ODataRequest<any>) => Observable<any>;
-    }): void;
+    initialize(requester: (request: ODataRequest<any>) => Observable<any>): Promise<boolean[]>;
     defaultApi(): ODataApi;
     findApiByName(name: string): ODataApi | undefined;
     apiByName(name: string): ODataApi;
@@ -5275,31 +5306,46 @@ declare class ODataSettings {
     collectionForType(type: string): typeof ODataCollection;
 }
 
-declare abstract class ODataConfigLoader {
-    abstract loadConfigs(): Observable<ODataApiConfig[]>;
+declare abstract class ODataLoader {
+    abstract load(): Promise<{
+        configs: ODataApiConfig[];
+        requester: (req: ODataRequest<any>) => Observable<any>;
+    }>;
 }
-declare class ODataConfigSyncLoader implements ODataConfigLoader {
+declare class ODataSyncLoader implements ODataLoader {
     private readonly passedConfigs;
-    constructor(passedConfigs: ODataApiConfig | ODataApiConfig[]);
-    loadConfigs(): Observable<ODataApiConfig[]>;
+    private readonly requester;
+    constructor(passedConfigs: ODataApiConfig | ODataApiConfig[], requester: (req: ODataRequest<any>) => Observable<any>);
+    load(): Promise<{
+        configs: ODataApiConfig[];
+        requester: (req: ODataRequest<any>) => Observable<any>;
+    }>;
 }
-declare class ODataConfigAsyncLoader implements ODataConfigLoader {
+declare class ODataAsyncLoader implements ODataLoader {
     private readonly configs$;
-    constructor(configs$: Observable<ODataApiConfig>[] | Observable<ODataApiConfig | ODataApiConfig[]>);
-    loadConfigs(): Observable<ODataApiConfig[]>;
+    private readonly requester;
+    constructor(configs$: Observable<ODataApiConfig>[] | Observable<ODataApiConfig | ODataApiConfig[]>, requester: (req: ODataRequest<any>) => Observable<any>);
+    load(): Promise<{
+        configs: ODataApiConfig[];
+        requester: (req: ODataRequest<any>) => Observable<any>;
+    }>;
 }
-declare class ODataMetadataLoader implements ODataConfigLoader {
+declare class ODataMetadataLoader implements ODataLoader {
     private readonly sources$;
     private readonly baseConfigs;
-    constructor(sources$: Observable<string | string[]>, baseConfigs: ODataApiConfig | ODataApiConfig[]);
-    loadConfigs(): Observable<ODataApiConfig[]>;
+    private readonly requester;
+    constructor(sources$: Observable<string | string[]>, baseConfigs: ODataApiConfig | ODataApiConfig[], requester: (req: ODataRequest<any>) => Observable<any>);
+    load(): Promise<{
+        configs: ODataApiConfig[];
+        requester: (req: ODataRequest<any>) => Observable<any>;
+    }>;
 }
 
 declare class ODataClient {
-    private http;
     private loader;
     settings?: ODataSettings;
-    constructor(http: HttpClient, loader: ODataConfigLoader);
+    constructor(loader: ODataLoader);
+    initialize(): Promise<boolean>;
     /**
      * Resolve the api for the given value.
      * Where value is: string type or an string name or an instance of resource.
@@ -5905,8 +5951,8 @@ interface PassedInitialConfig {
     config?: ODataApiConfig | ODataApiConfig[];
     loader?: Provider;
 }
-declare const ODATA_CONFIG: InjectionToken<ODataApiConfig>;
-declare function createSyncLoader(passedConfig: PassedInitialConfig): ODataConfigSyncLoader;
+declare const ODATA_CONFIG: InjectionToken<ODataApiConfig | ODataApiConfig[]>;
+declare function defaultHttpSyncLoader(config: ODataApiConfig | ODataApiConfig[], http: HttpClient): ODataSyncLoader;
 declare function provideODataClient(passedConfig: PassedInitialConfig): EnvironmentProviders;
 declare class ODataModule {
     static forRoot(passedConfig: PassedInitialConfig): ModuleWithProviders<ODataModule>;
@@ -6574,5 +6620,5 @@ declare class ODataMetadataParser {
     protected propertyValueToDate(attributeValue?: string): Date | undefined;
 }
 
-export { Aggregate, ApplyExpression, ArithmeticFunctions, ArithmeticOperators, BUBBLES, Casting, CastingOperators, CollectionFunctions, ComputeExpression, ConditionalFunctions, DateAndTimeFunctions, Dates, Durations, EDM_PARSERS, EdmType, Enums, ExpandExpression, ExpandField, Expression, FieldFactory, FilterExpression, Function, GeoFunctions, GroupBy, GroupByTransformations, Grouping, GroupingOperators, Http, INCLUDE_DEEP, INCLUDE_SHALLOW, ITEM_ROOT, JsonSchemaType, Lambda, LambdaOperators, LogicalOperators, Model, ModelField, NONE_PARSER, ODATA_CONFIG, OData, ODataActionResource, ODataAnnotations, ODataApi, ODataBaseCache, ODataBaseService, ODataBatchRequest, ODataBatchResource, ODataCallable, ODataCallableParser, ODataClient, ODataCollection, ODataConfigAsyncLoader, ODataConfigLoader, ODataConfigSyncLoader, ODataCountResource, ODataEntitiesAnnotations, ODataEntityAnnotations, ODataEntityContainer, ODataEntityResource, ODataEntitySet, ODataEntitySetResource, ODataEntitySetService, ODataEntityTypeKey, ODataEnumType, ODataEnumTypeFieldParser, ODataEnumTypeParser, ODataFunctionResource, ODataFunctions, ODataInMemoryCache, ODataInStorageCache, ODataIndexedDBCache, ODataMediaResource, ODataMetadata, ODataMetadataLoader, ODataMetadataParser, ODataMetadataResource, ODataModel, ODataModelAttribute, ODataModelEvent, ODataModelEventEmitter, ODataModelEventType, ODataModelField, ODataModelOptions, ODataModelState, ODataModule, ODataNavigationPropertyResource, ODataOperators, ODataParameterParser, ODataPathSegments, ODataPathSegmentsHandler, ODataPropertyAnnotations, ODataPropertyResource, ODataQueryOptionHandler, ODataQueryOptions, ODataQueryOptionsHandler, ODataReferenceResource, ODataReferential, ODataRequest, ODataResource, ODataResponse, ODataSchema, ODataServiceFactory, ODataSettings, ODataSingleton, ODataSingletonResource, ODataSingletonService, ODataStructuredType, ODataStructuredTypeFieldParser, ODataStructuredTypeParser, ODataTransformations, ODataValueResource, Objects, Operator, OrderByExpression, OrderByField, PathSegment, QueryCustomTypes, QueryOption, RenderableFactory, SearchExpression, SearchTerm, SegmentHandler, SelectExpression, StandardAggregateMethods, StringAndCollectionFunctions, StringFunctions, Strings, Transformations, Type, TypeFunctions, Types, Urls, alias, binary, buildPathAndQuery, createSyncLoader, duration, encode, functions, isQueryCustomType, isRawType, normalizeValue, operators, pathAndParamsFromQueryOptions, pathAndParamsFromSegments, provideODataClient, raw, render, resolve, transformations };
+export { Aggregate, ApplyExpression, ArithmeticFunctions, ArithmeticOperators, BUBBLES, Casting, CastingOperators, CollectionFunctions, ComputeExpression, ConditionalFunctions, DateAndTimeFunctions, Dates, Durations, EDM_PARSERS, EdmType, Enums, ExpandExpression, ExpandField, Expression, FieldFactory, FilterExpression, Function, GeoFunctions, GroupBy, GroupByTransformations, Grouping, GroupingOperators, Http, INCLUDE_DEEP, INCLUDE_SHALLOW, ITEM_ROOT, JsonSchemaType, Lambda, LambdaOperators, LogicalOperators, Model, ModelField, NONE_PARSER, ODATA_CONFIG, OData, ODataActionResource, ODataAnnotations, ODataApi, ODataAsyncLoader, ODataBaseCache, ODataBaseService, ODataBatchRequest, ODataBatchResource, ODataCallable, ODataCallableParser, ODataClient, ODataCollection, ODataCountResource, ODataEntitiesAnnotations, ODataEntityAnnotations, ODataEntityContainer, ODataEntityResource, ODataEntitySet, ODataEntitySetResource, ODataEntitySetService, ODataEntityTypeKey, ODataEnumType, ODataEnumTypeFieldParser, ODataEnumTypeParser, ODataFunctionResource, ODataFunctions, ODataInMemoryCache, ODataInStorageCache, ODataIndexedDBCache, ODataLoader, ODataMediaResource, ODataMetadata, ODataMetadataLoader, ODataMetadataParser, ODataMetadataResource, ODataModel, ODataModelAttribute, ODataModelEvent, ODataModelEventEmitter, ODataModelEventType, ODataModelField, ODataModelOptions, ODataModelState, ODataModule, ODataNavigationPropertyResource, ODataOperators, ODataParameterParser, ODataPathSegments, ODataPathSegmentsHandler, ODataPropertyAnnotations, ODataPropertyResource, ODataQueryOptionHandler, ODataQueryOptions, ODataQueryOptionsHandler, ODataReferenceResource, ODataReferential, ODataRequest, ODataResource, ODataResponse, ODataSchema, ODataServiceFactory, ODataSettings, ODataSingleton, ODataSingletonResource, ODataSingletonService, ODataStructuredType, ODataStructuredTypeFieldParser, ODataStructuredTypeParser, ODataSyncLoader, ODataTransformations, ODataValueResource, Objects, Operator, OrderByExpression, OrderByField, PathSegment, QueryCustomTypes, QueryOption, RenderableFactory, SearchExpression, SearchTerm, SegmentHandler, SelectExpression, StandardAggregateMethods, StringAndCollectionFunctions, StringFunctions, Strings, Transformations, Type, TypeFunctions, Types, Urls, alias, binary, buildPathAndQuery, defaultHttpSyncLoader, duration, encode, functions, isQueryCustomType, isRawType, normalizeValue, operators, pathAndParamsFromQueryOptions, pathAndParamsFromSegments, provideODataClient, raw, render, resolve, transformations };
 export type { AggregateMethod, AggregateType, ApplyExpressionBuilder, CacheCacheability, ComputeExpressionBuilder, Duration, EntityKey, Expand, ExpandExpressionBuilder, ExpandObject, ExpandOptions, ExpandType, FetchPolicy, FieldParser, Filter, FilterConnector, FilterExpressionBuilder, FilterType, GroupByType, JsonSchemaCustom, JsonSchemaExpand, JsonSchemaFieldOptions, JsonSchemaOptions, JsonSchemaRequired, JsonSchemaSelect, LooseUnion, ModelFieldOptions, ModelInterface, ModelOptions, NestedExpandOptions, NestedOrderBy, Normalize, ODataActionOptions, ODataAnnotationConfig, ODataApiConfig, ODataApiConfigOptions, ODataCache, ODataCacheEntry, ODataCallableConfig, ODataEntities, ODataEntitiesOptions, ODataEntity, ODataEntityContainerConfig, ODataEntityOptions, ODataEntitySetConfig, ODataEnumTypeConfig, ODataEnumTypeFieldConfig, ODataFunctionOptions, ODataMetadataType, ODataModelEntry, ODataModelFieldOptions, ODataOptions, ODataParameterConfig, ODataProperty, ODataPropertyOptions, ODataQueryArguments, ODataQueryArgumentsOptions, ODataReferenceConfig, ODataResponseJson, ODataSchemaConfig, ODataSegment, ODataSingletonConfig, ODataStructuredTypeConfig, ODataStructuredTypeFieldConfig, ODataVersion, ObjectValues, OrderAttribute, OrderBy, OrderByExpressionBuilder, OrderByObject, OrderByType, Parser, ParserOptions, PassedInitialConfig, QueryCustomType, QueryOptions, Renderable, ResponseOptions, SearchConnector, SearchExpressionBuilder, Select, SelectExpressionBuilder, SelectType, StructuredTypeFieldOptions, Transform, Unpacked, Value };