angular-odata 0.162.0 → 0.164.0

package/types/angular-odata.d.ts

@@ -1864,6 +1864,8 @@ type ODataOptions = {
     reportProgress?: boolean;
     withCredentials?: boolean;
     fetchPolicy?: FetchPolicy;
+    ignoreCacheControl?: boolean;
+    cacheInvalidation?: CacheInvalidation;
     maxAge?: number;
     parserOptions?: ParserOptions;
 };
@@ -1997,6 +1999,10 @@ declare class ODataApiOptions implements ODataApiConfigOptions {
      * Cache fetch policy
      */
     fetchPolicy: FetchPolicy;
+    /** Ignore response Cache-Control directives. Defaults to false. */
+    ignoreCacheControl: boolean;
+    /** Scope invalidated by successful writes. Defaults to entity-set. */
+    cacheInvalidation: CacheInvalidation;
     /**
      * Extra params to be sent in the request
      */
@@ -2092,15 +2098,15 @@ declare class ODataBatchResource extends ODataResource<any> {
     responses(): HttpResponseBase[] | null;
     static factory(api: ODataApi): ODataBatchResource;
     clone(): ODataBatchResource;
-    private storeRequester;
-    private restoreRequester;
     /**
      * Add to batch request
      * @param ctx The context for the request
      * @returns The result of execute the context
      */
     add<R>(ctx: (batch: this) => R): R;
+    /** Send collected requests, evaluating their cache policies when subscribed. */
     send(options?: ODataOptions): Observable<ODataResponse<any>>;
+    private sendRequests;
     private sendJson;
     private sendLegacy;
     /**
@@ -3151,15 +3157,19 @@ declare class CsdlRecord {
     toConfig(): ODataAnnotationValueConfig[];
 }
 declare class CsdlPropertyValue {
-    Name: string;
+    Property: string;
+    Bool?: boolean;
     String?: string;
     Date?: Date;
     EnumMember?: CsdlEnumMember[];
-    constructor({ Name, String, Date, EnumMember, }: {
-        Name: string;
+    TextContent?: string;
+    constructor({ Property, Bool, String, Date, EnumMember, TextContent, }: {
+        Property: string;
+        Bool?: boolean;
         String?: string;
         Date?: Date;
         EnumMember?: any[];
+        TextContent?: string;
     });
     toJson(): {
         [key: string]: any;
@@ -3311,13 +3321,7 @@ declare class CsdlParameter extends CsdlAnnotable {
         Annotation?: any[];
     });
     toJson(): {
-        Name: string;
-        Type: string;
-        Nullable: boolean | undefined;
-        MaxLength: number | undefined;
-        Precision: number | undefined;
-        Scale: number | undefined;
-        SRID: string | undefined;
+        [key: string]: any;
     };
     toConfig(): ODataParameterConfig;
 }
@@ -3338,17 +3342,9 @@ declare class CsdlReturnType {
         SRID?: string;
     });
     toJson(): {
-        Type: string;
-        Nullable: boolean | undefined;
-        MaxLength: number | undefined;
-        Precision: number | undefined;
-        Scale: number | undefined;
-        SRID: string | undefined;
+        [key: string]: any;
     };
-    toConfig(): {
-        type: string;
-        collection?: boolean | undefined;
-    } | undefined;
+    toConfig(): ODataReturnConfig;
 }
 
 declare class CsdlReference extends CsdlAnnotable {
@@ -3516,6 +3512,8 @@ declare class ODataRequest<T> {
     readonly withCredentials?: boolean;
     readonly bodyQueryOptions: QueryOption[];
     readonly fetchPolicy: FetchPolicy;
+    readonly ignoreCacheControl: boolean;
+    readonly cacheInvalidation: CacheInvalidation;
     readonly maxAge?: number;
     readonly resource: ODataResource<T>;
     private readonly _responseType?;
@@ -3541,6 +3539,8 @@ declare class ODataRequest<T> {
         };
         responseType?: 'arraybuffer' | 'blob' | 'json' | 'text' | 'value' | 'property' | 'entity' | 'entities';
         fetchPolicy?: FetchPolicy;
+        ignoreCacheControl?: boolean;
+        cacheInvalidation?: CacheInvalidation;
         maxAge?: number;
         parserOptions?: ParserOptions;
         withCredentials?: boolean;
@@ -3563,7 +3563,10 @@ declare class ODataRequest<T> {
     get pathWithParams(): string;
     get url(): string;
     get urlWithParams(): string;
+    /** A versioned response identity that includes the API and transport representation. */
     get cacheKey(): string;
+    /** The versioned response-cache partition belonging to this API. */
+    get cacheScope(): string[];
     isQueryBody(): boolean;
     isBatch(): boolean;
     isFetch(): boolean;
@@ -3627,6 +3630,8 @@ declare class ODataResponse<T> extends HttpResponse<T> {
     static fromHttpResponse<T>(req: ODataRequest<T>, res: HttpResponse<T>): ODataResponse<T>;
     static fromJson<T>(req: ODataRequest<T>, json: ODataResponseJson<T>): ODataResponse<T>;
     toJson(): ODataResponseJson<T>;
+    /** Whether the response can be reused without server validation. */
+    isCacheable(ignoreCacheControl?: boolean): boolean;
     private _options?;
     get options(): ODataResponseOptions;
     private _payload?;
@@ -4586,6 +4591,7 @@ declare class ODataReference extends ODataAnnotatable {
  */
 declare class ODataApi {
     requester?: (request: ODataRequest<any>) => Observable<any>;
+    private _requestCapture?;
     serviceRootUrl: string;
     metadataUrl: string;
     name?: string;
@@ -4672,9 +4678,16 @@ declare class ODataApi {
      * @returns
      */
     private handleRequest;
+    /** @internal Collect batch requests synchronously without executing their cache effects. */
+    captureRequests<R>(capture: (request: ODataRequest<any>) => Observable<any>, callback: () => R): R;
+    /** @internal Execute a collected or ordinary request with subscription-time cache semantics. */
+    executeRequest(req: ODataRequest<any>, requester?: ((request: ODataRequest<any>) => Observable<any>) | undefined, cacheReady?: boolean): Observable<any>;
+    /** @internal Whether the error is a `cache-only` miss rather than a cache failure. */
+    isCacheMiss(error: unknown): boolean;
     private handleRequester;
+    private cacheGeneration;
+    private invalidateCache;
     private handleCacheFetch;
-    private handleCacheMutate;
     private memo;
     createSchema(config: ODataSchemaConfig): ODataSchema;
     findSchema(type: string): ODataSchema | undefined;
@@ -4974,6 +4987,7 @@ type ODataVersion = '2.0' | '3.0' | '4.0';
 type FetchPolicy = 'cache-first' | 'cache-and-network' | 'network-only' | 'no-cache' | 'cache-only';
 type ODataMetadataType = 'minimal' | 'full' | 'none';
 type CacheCacheability = 'public' | 'private' | 'no-cache' | 'no-store';
+type CacheInvalidation = 'entity-set' | 'api';
 declare enum PathSegment {
     batch = "batch",
     metadata = "metadata",
@@ -5098,6 +5112,8 @@ interface FieldParser<T> extends Parser<T> {
 }
 declare const NONE_PARSER: Parser<any>;
 interface ODataCache {
+    /** Wait until persisted entries are available, or a reported memory fallback is ready. */
+    ready?(): Promise<void>;
     put<T>(key: string, payload: T, ...opts: any[]): void;
     get<T>(key: string, ...opts: any[]): T | undefined;
     getResponse(req: ODataRequest<any>): ODataResponse<any> | undefined;
@@ -5139,6 +5155,8 @@ interface ODataApiConfigOptions {
     };
     stripMetadata?: ODataMetadataType;
     fetchPolicy?: FetchPolicy;
+    ignoreCacheControl?: boolean;
+    cacheInvalidation?: CacheInvalidation;
     bodyQueryOptions?: QueryOption[];
     stringAsEnum?: boolean;
     deleteRefBy?: 'path' | 'id';
@@ -5174,10 +5192,12 @@ type ODataApiConfig = {
     };
 };
 type ODataAnnotationValueConfig = {
-    name?: string;
+    property?: string;
+    bool?: boolean;
     string?: string;
     date?: Date;
     enumMembers?: string[];
+    textContent?: string;
 };
 type ODataAnnotationConfig = {
     term: string;
@@ -5215,6 +5235,7 @@ type ODataEntityContainerConfig = {
     singletons?: ODataSingletonConfig[];
 };
 type ODataEnumTypeFieldConfig = {
+    name: string;
     value: number;
     annotations?: ODataAnnotationConfig[];
 };
@@ -5269,9 +5290,25 @@ type ODataStructuredTypeConfig = {
     };
 };
 type ODataParameterConfig = {
+    name: string;
     type: string;
     nullable?: boolean;
     collection?: boolean;
+    maxLength?: number;
+    precision?: number;
+    scale?: number | 'variable';
+    srid?: string;
+    annotations?: ODataAnnotationConfig[];
+};
+type ODataReturnConfig = {
+    type: string;
+    collection?: boolean;
+    nullable?: boolean;
+    maxLength?: number;
+    precision?: number;
+    scale?: number | 'variable';
+    srid?: string;
+    annotations?: ODataAnnotationConfig[];
 };
 type ODataCallableConfig = {
     name: string;
@@ -5281,10 +5318,7 @@ type ODataCallableConfig = {
     parameters?: {
         [name: string]: ODataParameterConfig;
     };
-    return?: {
-        type: string;
-        collection?: boolean;
-    };
+    return?: ODataReturnConfig;
 };
 type ODataEntitySetConfig = {
     name: string;
@@ -6329,6 +6363,16 @@ declare class ODataServiceFactory {
     static ɵprov: i0.ɵɵInjectableDeclaration<ODataServiceFactory>;
 }
 
+type ODataCacheOptions = {
+    maxAge?: number;
+    /** Opt into memory fallback on persistence failures; also told of discarded corrupt entries. */
+    onError?: (error: Error) => void;
+};
+type ODataCacheFilter = {
+    name?: string;
+    scope?: string[];
+    tags?: string[];
+};
 /**
  * A cache entry that holds a payload, a date when it was last read from the backend, and a maxAge for the entry.
  * @param payload The payload to cache.
@@ -6344,9 +6388,9 @@ interface ODataCacheEntry<T> {
 }
 declare abstract class ODataBaseCache implements ODataCache {
     maxAge: number;
-    constructor({ maxAge }: {
-        maxAge?: number;
-    });
+    private _onError?;
+    protected _error?: Error;
+    constructor({ maxAge, onError, }: ODataCacheOptions);
     /**
      * Check if the entry is expired
      * @param entry The cache entry
@@ -6382,6 +6426,19 @@ declare abstract class ODataBaseCache implements ODataCache {
      * @returns The key for the entry
      */
     buildKey(names: string[]): string;
+    protected validateMaxAge(maxAge: number): void;
+    protected reportError(message: string, cause?: unknown): void;
+    /** Report a discarded entry; corrupt entries are treated as cache misses. */
+    protected reportCorruption(message: string, cause?: unknown): void;
+    protected checkError(): void;
+    protected isEntry(value: unknown): value is ODataCacheEntry<unknown>;
+    protected matches(key: string, entry: ODataCacheEntry<unknown>, { name, scope, tags }: ODataCacheFilter): boolean;
+    protected isResponseJson(value: unknown): value is ODataResponseJson<unknown>;
+    protected snapshot(response: ODataResponseJson<unknown>): ODataResponseJson<unknown>;
+    /** Store a detached response snapshot, respecting server reuse restrictions. */
+    putResponse(req: ODataRequest<any>, res: ODataResponse<any>): void;
+    /** Restore a detached response using the current request's resource and parser. */
+    getResponse(req: ODataRequest<any>): ODataResponse<any> | undefined;
     abstract put<T>(name: string, payload: T, { maxAge, scope, tags }: {
         maxAge?: number;
         scope?: string[];
@@ -6390,8 +6447,6 @@ declare abstract class ODataBaseCache implements ODataCache {
     abstract get<T>(name: string, { scope }: {
         scope?: string[];
     }): T | undefined;
-    abstract getResponse(req: ODataRequest<any>): ODataResponse<any> | undefined;
-    abstract putResponse(req: ODataRequest<any>, res: ODataResponse<any>): void;
     abstract forget({ name, scope, tags, }: {
         name?: string;
         scope?: string[];
@@ -6403,9 +6458,13 @@ declare abstract class ODataBaseCache implements ODataCache {
 
 declare class ODataInMemoryCache extends ODataBaseCache {
     entries: Map<string, ODataCacheEntry<any>>;
-    constructor({ maxAge }?: {
-        maxAge?: number;
-    });
+    private _nextExpiry;
+    constructor(options?: ODataCacheOptions);
+    protected setEntry(key: string, entry: ODataCacheEntry<unknown>): void;
+    protected deleteEntry(key: string): void;
+    protected expireEntry(key: string): void;
+    protected clearEntries(): void;
+    protected prune(): void;
     /**
      * Put some payload in the cache
      * @param name The name for the entry
@@ -6428,107 +6487,79 @@ declare class ODataInMemoryCache extends ODataBaseCache {
     get<T>(name: string, { scope }?: {
         scope?: string[];
     }): T | undefined;
-    /**
-     * Store the response in the cache
-     * @param req The request with the resource to store the response
-     * @param res The response to store in the cache
-     */
-    putResponse(req: ODataRequest<any>, res: ODataResponse<any>): void;
-    /**
-     * Restore the response from the cache
-     * @param req The request with the resource to get the response
-     * @returns The response from the cache
-     */
-    getResponse(req: ODataRequest<any>): ODataResponse<any> | undefined;
     /**
      * Remove all cache entries that are matching with the given options
      * @param options The options to forget
      */
-    forget({ name, scope, tags, }?: {
-        name?: string;
-        scope?: string[];
-        tags?: string[];
-    }): void;
+    forget(options?: ODataCacheFilter): void;
     /**
      * Remove all cache entries
      */
     flush(): void;
+    /** Return the number of unexpired entries. */
     size(): number;
 }
 
-declare class ODataInStorageCache extends ODataBaseCache {
+declare class ODataInStorageCache extends ODataInMemoryCache {
     prefix: string;
-    storage: Storage;
-    constructor({ prefix, storage, maxAge, }: {
-        maxAge?: number;
+    private _storage?;
+    private _persistent;
+    private _memoryOnly;
+    constructor({ prefix, storage, ...options }: ODataCacheOptions & {
         prefix: string;
         storage?: Storage;
     });
+    /** The backing storage. Throws if the platform has no Web Storage implementation. */
+    get storage(): Storage;
+    set storage(storage: Storage);
     buildKey(names: string[]): string;
-    put<T>(name: string, payload: T, { maxAge, scope, tags }?: {
-        maxAge?: number;
-        scope?: string[];
-        tags?: string[];
-    }): void;
+    private disablePersistence;
+    private storageKeys;
+    private readEntry;
+    private loadFromStorage;
+    private removeStoredEntry;
+    protected setEntry(key: string, entry: ODataCacheEntry<unknown>): void;
+    protected deleteEntry(key: string): void;
+    protected expireEntry(key: string): void;
+    protected clearEntries(): void;
+    /** Read a persisted entry, or its in-memory fallback, without renewing its age. */
     get<T>(name: string, { scope }?: {
         scope?: string[];
     }): T | undefined;
-    forget({ name, scope, tags, }: {
-        name?: string;
-        scope?: string[];
-        tags?: string[];
-    }): void;
-    /**
-     * Flush the cache and clean the storage
-     */
-    flush(): void;
-    /**
-     * Store the response in the cache
-     * @param req The request with the resource to store the response
-     * @param res The response to store in the cache
-     */
-    putResponse(req: ODataRequest<any>, res: ODataResponse<any>): void;
-    /**
-     * Restore the response from the cache
-     * @param req The request with the resource to get the response
-     * @returns The response from the cache
-     */
-    getResponse(req: ODataRequest<any>): ODataResponse<any> | undefined;
+    /** Remove matching entries from both persistent storage and the memory fallback. */
+    forget(options?: ODataCacheFilter): void;
+    /** Count unexpired entries, including memory-only binary responses. */
     size(): number;
 }
 
-declare class ODataIndexedDBCache extends ODataBaseCache {
+declare class ODataIndexedDBCache extends ODataInMemoryCache {
     private name;
     private version;
     private store;
-    private entries;
-    private _db;
-    constructor({ name, store, version, maxAge, }?: {
+    private _database?;
+    private _persistent;
+    private _hydrated;
+    private _pending;
+    private _writes;
+    private _ready;
+    constructor({ name, store, version, ...options }?: ODataCacheOptions & {
         name?: string;
         store?: string;
         version?: number;
-        maxAge?: number;
     });
-    private initDb;
+    /** Wait for hydration and queued writes, or an explicitly reported memory-only fallback. */
+    ready(): Promise<void>;
+    protected reportError(message: string, cause?: unknown): void;
+    private disablePersistence;
+    private openDb;
     private loadFromDb;
-    private withDb;
-    put<T>(name: string, payload: T, { maxAge, scope, tags }?: {
-        maxAge?: number;
-        scope?: string[];
-        tags?: string[];
-    }): void;
-    get<T>(name: string, { scope }?: {
-        scope?: string[];
-    }): T | undefined;
-    putResponse(req: ODataRequest<any>, res: ODataResponse<any>): void;
-    getResponse(req: ODataRequest<any>): ODataResponse<any> | undefined;
-    forget({ name, scope, tags, }?: {
-        name?: string;
-        scope?: string[];
-        tags?: string[];
-    }): void;
-    flush(): void;
-    size(): number;
+    private initialize;
+    private persist;
+    protected setEntry(key: string, entry: ODataCacheEntry<unknown>): void;
+    protected deleteEntry(key: string): void;
+    protected clearEntries(): void;
+    /** Invalidate loaded entries and record filters that must also apply during hydration. */
+    forget(options?: ODataCacheFilter): void;
 }
 
 declare enum FieldType {
@@ -6641,4 +6672,4 @@ declare class ODataMetadataParser {
 }
 
 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, ODataAnnotationValueConfig, ODataApiConfig, ODataApiConfigOptions, ODataCache, ODataCacheEntry, ODataCallableConfig, ODataEntities, ODataEntitiesOptions, ODataEntity, ODataEntityContainerConfig, ODataEntityOptions, ODataEntitySetConfig, ODataEnumTypeConfig, ODataEnumTypeFieldConfig, ODataFunctionOptions, ODataMetadataType, ODataModelEntry, ODataModelFieldOptions, ODataOptions, ODataParameterConfig, ODataProperty, ODataPropertyOptions, ODataQueryArguments, ODataQueryableOptions, 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 };
+export type { AggregateMethod, AggregateType, ApplyExpressionBuilder, CacheCacheability, CacheInvalidation, 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, ODataAnnotationValueConfig, ODataApiConfig, ODataApiConfigOptions, ODataCache, ODataCacheEntry, ODataCacheFilter, ODataCacheOptions, ODataCallableConfig, ODataEntities, ODataEntitiesOptions, ODataEntity, ODataEntityContainerConfig, ODataEntityOptions, ODataEntitySetConfig, ODataEnumTypeConfig, ODataEnumTypeFieldConfig, ODataFunctionOptions, ODataMetadataType, ODataModelEntry, ODataModelFieldOptions, ODataOptions, ODataParameterConfig, ODataProperty, ODataPropertyOptions, ODataQueryArguments, ODataQueryableOptions, ODataReferenceConfig, ODataResponseJson, ODataReturnConfig, 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 };