angular-odata 0.110.0 → 0.115.0

package/lib/constants.d.ts

@@ -10,20 +10,21 @@ export declare const $INLINECOUNT = "$inlinecount";
 export declare const IF_MATCH_HEADER = "If-Match";
 export declare const IF_NONE_MATCH_HEADER = "If-None-Match";
 export declare const CONTENT_TYPE = "Content-Type";
-export declare const CACHE_CONTROL = "Cache-Control";
 export declare const HTTP11 = "HTTP/1.1";
 export declare const ACCEPT = "Accept";
 export declare const PREFER = "Prefer";
+export declare const CACHE_CONTROL = "Cache-Control";
+export declare const CACHE_CONTROL_HEADERS: string[];
 export declare const ODATA_VERSION = "OData-Version";
 export declare const ODATA_VERSION_HEADERS: string[];
-export declare const ETAG_HEADER = "ETag";
-export declare const ETAG_HEADERS: string[];
 export declare const LOCATION_HEADER = "Location";
 export declare const LOCATION_HEADERS: string[];
 export declare const ODATA_ENTITYID = "OData-EntityId";
 export declare const ODATA_ENTITYID_HEADERS: string[];
 export declare const PREFERENCE_APPLIED = "Preference-Applied";
 export declare const PREFERENCE_APPLIED_HEADERS: string[];
+export declare const ETAG_HEADER = "ETag";
+export declare const ETAG_HEADERS: string[];
 export declare const RETRY_AFTER = "Retry-After";
 export declare const RETRY_AFTER_HEADERS: string[];
 export declare const APPLICATION_JSON = "application/json";
@@ -62,3 +63,4 @@ export declare const COMPUTED: RegExp;
 export declare const OPTIMISTIC_CONCURRENCY: RegExp;
 export declare const DESCRIPTION: RegExp;
 export declare const LONG_DESCRIPTION: RegExp;
+export declare const OPTIONARL_PARAMETER: RegExp;

package/lib/models/collection.d.ts

@@ -11,6 +11,13 @@ export declare class ODataCollection<T, M extends ODataModel<T>> implements Iter
         ODataModelField<any> | null
     ] | null;
     _resource: ODataEntitySetResource<T> | ODataNavigationPropertyResource<T> | ODataPropertyResource<T> | null;
+    _resources: {
+        parent: [
+            ODataModel<any> | ODataCollection<any, ODataModel<any>>,
+            ODataModelField<any> | null
+        ] | null;
+        resource: ODataEntitySetResource<T> | ODataNavigationPropertyResource<T> | ODataPropertyResource<T> | null;
+    }[];
     _annotations: ODataEntitiesAnnotations<T>;
     _entries: ODataModelEntry<T, M>[];
     _model: typeof ODataModel;
@@ -28,6 +35,11 @@ export declare class ODataCollection<T, M extends ODataModel<T>> implements Iter
     });
     isParentOf(child: ODataModel<any> | ODataCollection<any, ODataModel<any>>): boolean;
     resource(): ODataEntitySetResource<T> | ODataNavigationPropertyResource<T> | ODataPropertyResource<T>;
+    pushResource(resource: ODataEntitySetResource<T> | ODataNavigationPropertyResource<T> | ODataPropertyResource<T>): void;
+    popResource(): {
+        parent: [ODataModel<any> | ODataCollection<any, ODataModel<any>>, ODataModelField<any> | null] | null;
+        resource: ODataEntitySetResource<T> | ODataNavigationPropertyResource<T> | ODataPropertyResource<T> | null;
+    } | undefined;
     attach(resource: ODataEntitySetResource<T> | ODataNavigationPropertyResource<T> | ODataPropertyResource<T>): void;
     asEntitySet<R>(func: (collection: this) => R): R;
     annots(): ODataEntitiesAnnotations<T>;
@@ -56,12 +68,15 @@ export declare class ODataCollection<T, M extends ODataModel<T>> implements Iter
     fetch({ withCount, ...options }?: ODataOptions & {
         withCount?: boolean;
     }): Observable<this>;
-    fetchMany(top: number, { withCount, ...options }?: ODataOptions & {
+    fetchAll({ withCount, ...options }?: ODataOptions & {
         withCount?: boolean;
     }): Observable<this>;
-    fetchAll({ withCount, ...options }?: ODataOptions & {
+    fetchMany(top: number, { withCount, ...options }?: ODataOptions & {
         withCount?: boolean;
     }): Observable<this>;
+    fetchOne({ withCount, ...options }?: ODataOptions & {
+        withCount?: boolean;
+    }): Observable<M | null>;
     /**
      * Save all models in the collection
      * @param relModel The model is relationship

package/lib/models/model.d.ts

@@ -15,10 +15,17 @@ export declare class ODataModel<T> {
         ODataModel<any> | ODataCollection<any, ODataModel<any>>,
         ODataModelField<any> | null
     ] | null;
+    _resource: ODataResource<T> | null;
+    _resources: {
+        parent: [
+            ODataModel<any> | ODataCollection<any, ODataModel<any>>,
+            ODataModelField<any> | null
+        ] | null;
+        resource: ODataResource<T> | null;
+    }[];
     _attributes: Map<string, any>;
     _changes: Map<string, any>;
     _relations: Map<string, ODataModelRelation<any>>;
-    _resource: ODataResource<T> | null;
     _annotations: ODataEntityAnnotations<T> | null;
     _reset: boolean;
     _reparent: boolean;
@@ -37,6 +44,11 @@ export declare class ODataModel<T> {
         reset?: boolean;
     });
     resource(): ODataEntityResource<T> | ODataNavigationPropertyResource<T> | ODataPropertyResource<T> | ODataSingletonResource<T>;
+    pushResource(resource: ODataEntityResource<T> | ODataNavigationPropertyResource<T> | ODataPropertyResource<T> | ODataSingletonResource<T>): void;
+    popResource(): {
+        parent: [ODataModel<any> | ODataCollection<any, ODataModel<any>>, ODataModelField<any> | null] | null;
+        resource: ODataResource<T> | null;
+    } | undefined;
     navigationProperty<N>(name: keyof T | string): ODataNavigationPropertyResource<N>;
     property<N>(name: string): ODataPropertyResource<N>;
     attach(resource: ODataEntityResource<T> | ODataNavigationPropertyResource<T> | ODataPropertyResource<T> | ODataSingletonResource<T>): void;
@@ -48,7 +60,6 @@ export declare class ODataModel<T> {
     }): EntityKey<T> | {
         [name: string]: any;
     } | undefined;
-    isNew(): boolean;
     isParentOf(child: ODataModel<any> | ODataCollection<any, ODataModel<any>>): boolean;
     referential(field: ODataModelField<any>, { field_mapping, resolve, }?: {
         field_mapping?: boolean;
@@ -144,6 +155,7 @@ export declare class ODataModel<T> {
     hasChanged({ include_navigation, }?: {
         include_navigation?: boolean;
     }): boolean;
+    isNew(): boolean;
     /**
      * Create an execution context for a given function, where the model is bound to its entity endpoint
      * @param ctx Context function

package/lib/models/options.d.ts

@@ -242,6 +242,7 @@ export declare class ODataModelOptions<T> {
     hasChanged(self: ODataModel<T>, { include_navigation }?: {
         include_navigation?: boolean;
     }): boolean;
+    hasKey(self: ODataModel<T>): boolean;
     asEntity<R, M extends ODataModel<T>>(self: M, func: (model: M) => R): R;
     toEntity(self: ODataModel<T>, { client_id, include_navigation, include_concurrency, include_computed, include_key, include_non_field, changes_only, field_mapping, chain, }?: {
         client_id?: boolean;

package/lib/options.d.ts

@@ -81,6 +81,10 @@ export declare class ODataApiOptions implements ApiOptions {
          * @link http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part1-protocol/odata-v4.0-errata02-os-part1-protocol-complete.html#_Toc406398237
          */
         includeAnnotations?: string;
+        /**
+         * @link https://devblogs.microsoft.com/odata/extension-omit-null-value-properties-in-asp-net-core-odata/
+         */
+        omitNullValues?: boolean;
     };
     constructor(config: ApiOptions);
     get parserOptions(): ParserOptions;

package/lib/resources/query/expressions/count.d.ts

@@ -0,0 +1,44 @@
+import type { QueryCustomType } from '../builder';
+import { Expression } from './base';
+import { FilterExpression, FilterExpressionBuilder } from './filter';
+import { Renderable } from './syntax';
+export declare class CountField<T extends object> implements Renderable {
+    protected field: any;
+    private values;
+    constructor(field: any, values?: {
+        [name: string]: any;
+    });
+    get [Symbol.toStringTag](): string;
+    toJSON(): {
+        field: any;
+    };
+    render({ aliases, escape, prefix, }: {
+        aliases?: QueryCustomType[];
+        escape?: boolean;
+        prefix?: string;
+    }): string;
+    filter(opts: (builder: FilterExpressionBuilder<T>, current?: FilterExpression<T>) => FilterExpression<T>): any;
+    clone(): CountField<object>;
+    private option;
+}
+export declare type CountExpressionBuilder<T> = {
+    t: Readonly<Required<T>>;
+    e: () => CountExpression<T>;
+};
+export declare class CountExpression<T> extends Expression<T> {
+    constructor({ children, }?: {
+        children?: Renderable[];
+    });
+    static count<T extends object>(opts: (builder: CountExpressionBuilder<T>, current?: CountExpression<T>) => CountExpression<T>, current?: CountExpression<T>): CountExpression<T>;
+    private _add;
+    render({ aliases, escape, prefix, }?: {
+        aliases?: QueryCustomType[] | undefined;
+        escape?: boolean | undefined;
+        prefix?: string | undefined;
+    }): string;
+    clone(): CountExpression<unknown>;
+    field<F extends Object>(field: F[], opts?: (e: {
+        t: F;
+        f: CountField<F>;
+    }) => CountExpression<F>): CountExpression<F>;
+}

package/lib/resources/query/expressions/filter.d.ts

@@ -1,5 +1,6 @@
 import type { QueryCustomType } from '../builder';
 import { Expression } from './base';
+import { CountExpression, CountField } from './count';
 import { ODataFunctions, ODataOperators, Renderable } from './syntax';
 export declare type FilterConnector = 'and' | 'or';
 export declare type FilterExpressionBuilder<T> = {
@@ -53,6 +54,10 @@ export declare class FilterExpression<F> extends Expression<F> {
         t: N;
         e: (connector?: FilterConnector) => FilterExpression<N>;
     }) => FilterExpression<N>, alias?: string): FilterExpression<F>;
+    count<N extends object>(left: N[], opts?: (e: {
+        t: N;
+        f: CountField<N>;
+    }) => CountExpression<N>): FilterExpression<F>;
     isof(type: string): FilterExpression<F>;
     isof(left: F, type: string): FilterExpression<F>;
 }

package/lib/resources/resource.d.ts

@@ -41,7 +41,7 @@ export declare class ODataResource<T> {
     clearKey(): void | undefined;
     asModel<M extends ODataModel<T>>(entity?: Partial<T> | {
         [name: string]: any;
-    }, { annots, reset }?: {
+    }, { annots, reset, }?: {
         annots?: ODataEntityAnnotations<T>;
         reset?: boolean;
     }): M;

package/lib/resources/responses/options.d.ts

@@ -13,5 +13,6 @@ export declare class ODataResponseOptions implements ResponseOptions {
     setFeatures(features: string): void;
     setVersion(version: string): void;
     setLocation(location: string): void;
+    setPreferenceApplied(preference: string): void;
     setCache(cacheControl: string): void;
 }

package/lib/resources/types/entity-set.d.ts

@@ -33,10 +33,11 @@ export declare class ODataEntitySetResource<T> extends ODataResource<T> {
         withCount?: boolean;
         bodyQueryOptions?: QueryOptionNames[];
     }): Observable<ODataEntities<T>>;
-    fetchOne(options?: ODataOptions & {
+    fetchAll(options?: ODataOptions & {
+        withCount?: boolean;
         bodyQueryOptions?: QueryOptionNames[];
     }): Observable<{
-        entity: T | null;
+        entities: T[];
         annots: ODataEntitiesAnnotations<T>;
     }>;
     fetchMany(top: number, options?: ODataOptions & {
@@ -46,11 +47,11 @@ export declare class ODataEntitySetResource<T> extends ODataResource<T> {
         entities: T[];
         annots: ODataEntitiesAnnotations<T>;
     }>;
-    fetchAll(options?: ODataOptions & {
+    fetchOne(options?: ODataOptions & {
         withCount?: boolean;
         bodyQueryOptions?: QueryOptionNames[];
     }): Observable<{
-        entities: T[];
+        entity: T | null;
         annots: ODataEntitiesAnnotations<T>;
     }>;
     fetchEntities(options?: ODataOptions & {

package/lib/resources/types/navigation-property.d.ts

@@ -113,11 +113,16 @@ export declare class ODataNavigationPropertyResource<T> extends ODataResource<T>
         withCount?: boolean;
         bodyQueryOptions?: QueryOptionNames[];
     }): Observable<C | null>;
-    fetchOne(options?: ODataOptions & {
+    /**
+     * Fetch all entities
+     * @param options Options for the request
+     * @returns All entities
+     */
+    fetchAll(options?: ODataOptions & {
         withCount?: boolean;
         bodyQueryOptions?: QueryOptionNames[];
     }): Observable<{
-        entity: T | null;
+        entities: T[];
         annots: ODataEntitiesAnnotations<T>;
     }>;
     fetchMany(top: number, options?: ODataOptions & {
@@ -127,16 +132,11 @@ export declare class ODataNavigationPropertyResource<T> extends ODataResource<T>
         entities: T[];
         annots: ODataEntitiesAnnotations<T>;
     }>;
-    /**
-     * Fetch all entities
-     * @param options Options for the request
-     * @returns All entities
-     */
-    fetchAll(options?: ODataOptions & {
+    fetchOne(options?: ODataOptions & {
         withCount?: boolean;
         bodyQueryOptions?: QueryOptionNames[];
     }): Observable<{
-        entities: T[];
+        entity: T | null;
         annots: ODataEntitiesAnnotations<T>;
     }>;
 }

package/lib/services/entity-set.d.ts

@@ -28,7 +28,12 @@ export declare class ODataEntitySetService<T> extends ODataEntityService<T> {
      * @param options The options for the request.
      */
     fetchAll(options?: ODataOptions): Observable<{
-        entities: T[];
+        entities: T[]; /**
+         * Delete an entity in the entity set.
+         * @param key The entity key.
+         * @param etag The etag for the entity.
+         * @param options The options for the request.
+         */
         annots: import("../resources").ODataEntitiesAnnotations<T>;
     }>;
     /**

package/package.json

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