breeze-client 2.1.5 → 2.1.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "breeze-client",
-  "version": "2.1.5",
+  "version": "2.1.6",
   "private": false,
   "description": "Breeze data management for JavaScript clients",
   "repository": "https://github.com/Breeze/breeze-client.git",

package/src/abstract-data-service-adapter.d.ts

@@ -14,7 +14,6 @@ export declare abstract class AbstractDataServiceAdapter implements DataServiceA
     name: string;
     /** The [[IAjaxAdapter]] used by this [[IDataServiceAdapter]]. */
     ajaxImpl: AjaxAdapter;
-    constructor();
     checkForRecomposition(interfaceInitializedArgs: any): void;
     initialize(): void;
     fetchMetadata(metadataStore: MetadataStore, dataService: DataService): Promise<unknown>;

package/src/data-type.d.ts

@@ -62,6 +62,7 @@ export declare class DataType extends BreezeEnum {
     static Decimal: DataType;
     static Double: DataType;
     static Single: DataType;
+    static DateOnly: DataType;
     static DateTime: DataType;
     static DateTimeOffset: DataType;
     static Time: DataType;
@@ -77,6 +78,10 @@ export declare class DataType extends BreezeEnum {
     static fromValue(val: any): DataType;
     static parseTimeFromServer(source: any): any;
     static parseDateAsUTC(source: any): any;
+    /** Parse as UTC then shift to local time */
+    static parseDateAsLocal(source: string): any;
+    /** if val is a Date, return a date-only string e.g. '2023-12-31' */
+    static toDateOnlyString(val: any): any;
     /** Returns a raw value converted to the specified DataType */
     static parseRawValue(val: any, dataType?: DataType): any;
     /** @hidden @internal */

package/src/entity-aspect.d.ts

@@ -8,9 +8,9 @@ import { ValidationError } from './validate';
 export interface Entity {
     entityAspect: EntityAspect;
     entityType: EntityType;
-    /** @internal */
+    /** Get the property with the given name */
     getProperty?(prop: string): any;
-    /** @internal */
+    /** Set the property with the given name */
     setProperty?(prop: any, value: any): void;
     /** @hidden @internal */
     prototype?: {
@@ -70,7 +70,7 @@ export declare class EntityAspect {
     isBeingSaved: boolean;
     /** The 'original values' of this entity where they are different from the 'current values'.
     This is a map where the key is a property name and the value is the 'original value' of the property. */
-    originalValues: {};
+    originalValues: Record<string, any>;
     /**  Whether this entity has any validation errors. __Read Only__ */
     hasValidationErrors: boolean;
     /** Whether this entity has a temporary [[EntityKey]]. */
@@ -208,7 +208,7 @@ export declare class EntityAspect {
     setModified: () => any;
     /**
     Sets the entity to an EntityState of 'Deleted'.  This both marks the entity as being scheduled for deletion during the next 'Save' call
-    but also removes the entity from all of its related entities.
+    but also removes the entity from all of its related entities.  If the current entityState is 'Added', then `setDeleted()` will mark it 'Detached'
     The same operation can be performed by calling [[EntityAspect.setEntityState]].
     >      // assume order is an order entity attached to an EntityManager.
     >      order.entityAspect.setDeleted();
@@ -315,7 +315,7 @@ export declare class ComplexAspect {
     /** The 'original values' of this complex object where they are different from the 'current values'.
     This is a map where the key is a property name and the value is the 'original value' of the property.
     __Read Only__ */
-    originalValues: {};
+    originalValues: Record<string, any>;
     /** The parent object that to which this aspect belongs; this will either be an entity or another complex object. __Read Only__ */
     parent?: StructuralObject;
     /** The [[DataProperty]] on the 'parent' that contains this complex object. __Read Only__ */

package/src/entity-manager.d.ts

@@ -72,7 +72,7 @@ export interface EntityError {
 }
 /** The shape of the Promise returned by an [[EntityManager.executeQuery]] call. */
 export interface QueryResult {
-    /** Top level entities returned */
+    /** Top level entities returned.  Excludes entities that are Deleted. */
     results: any[];
     /** Query that was executed */
     query: EntityQuery | string;
@@ -80,7 +80,7 @@ export interface QueryResult {
     entityManager?: EntityManager;
     /** Total number of results available on the server */
     inlineCount?: number;
-    /** All entities returned by the query.  Differs from results when an expand is used. */
+    /** All entities returned by the query.  Differs from `results` when an expand is used.  Includes entities that are Deleted. */
     retrievedEntities?: Entity[];
     /** Raw response from the server */
     httpResponse?: HttpResponse;
@@ -675,6 +675,6 @@ export interface IEntityByKeyResult {
     fromCache: boolean;
 }
 declare function unwrapInstance(structObj: StructuralObject, transformFn?: (dp: DataProperty, val: any) => any): any;
-declare function unwrapOriginalValues(target: StructuralObject, metadataStore: MetadataStore, transformFn?: (dp: DataProperty, val: any) => any): {};
-declare function unwrapChangedValues(entity: Entity, metadataStore: MetadataStore, transformFn: (dp: DataProperty, val: any) => any): {};
+declare function unwrapOriginalValues(target: StructuralObject, metadataStore: MetadataStore, transformFn?: (dp: DataProperty, val: any) => any): Record<string, any>;
+declare function unwrapChangedValues(entity: Entity, metadataStore: MetadataStore, transformFn: (dp: DataProperty, val: any) => any): Record<string, any>;
 export {};

package/src/entity-metadata.d.ts

@@ -14,6 +14,14 @@ export declare type StructuralType = EntityType | ComplexType;
 export interface IStructuralTypeMap {
     [index: string]: StructuralType;
 }
+/** Keep track of constructors and initializers for StructuralTypes */
+interface CtorRecord {
+    ctor: {
+        new (): StructuralObject;
+    };
+    initFn?: Function | string;
+    noTrackingFn?: Function;
+}
 /** @hidden @internal */
 export interface IMetadataJson {
     metadataVersion: string;
@@ -77,21 +85,21 @@ export declare class MetadataStore {
     **/
     metadataFetched: BreezeEvent<MetadataFetchedEventArgs>;
     /** @hidden @internal */
-    _resourceEntityTypeMap: {};
-    /** @hidden @internal */
-    _entityTypeResourceMap: {};
+    _resourceEntityTypeMap: Record<string, string>;
     /** @hidden @internal */
+    _entityTypeResourceMap: Record<string, string>;
+    /** @hidden @internal key is qualified structuraltype name - value is structuralType. ( structural = entityType or complexType). */
     _structuralTypeMap: IStructuralTypeMap;
+    /** @hidden @internal key is shortName, value is qualified name - does not need to be serialized. **/
+    _shortNameMap: Record<string, string>;
+    /** @hidden @internal key is either short or qual type name - value is ctor; **/
+    _ctorRegistry: Record<string, CtorRecord>;
+    /** @hidden @internal key is entityTypeName; value is array of nav props **/
+    _incompleteTypeMap: Record<string, NavigationProperty[]>;
     /** @hidden @internal **/
-    _shortNameMap: {};
-    /** @hidden @internal **/
-    _ctorRegistry: {};
-    /** @hidden @internal **/
-    _incompleteTypeMap: {};
-    /** @hidden @internal **/
-    _incompleteComplexTypeMap: {};
-    /** @hidden @internal **/
-    _deferredTypes: {};
+    _incompleteComplexTypeMap: Record<string, DataProperty[]>;
+    /** @hidden @internal { json: any, stype: StructuralType }[] | { entityType: EntityType, csdlEntityType: any }[] **/
+    _deferredTypes: Record<string, any>;
     /** @hidden @internal **/
     _id: number;
     /**
@@ -330,7 +338,7 @@ export declare class MetadataStore {
     Returns a fully qualified entityTypeName for a specified resource name.  The reverse of this operation
     can be obtained via the  [[EntityType.defaultResourceName]] property
     **/
-    getEntityTypeNameForResourceName(resourceName: string): any;
+    getEntityTypeNameForResourceName(resourceName: string): string;
     /**
     Associates a resourceName with an entityType.
   
@@ -368,14 +376,14 @@ export interface EntityTypeConfig {
     dataProperties?: DataProperty[] | Object[] | Object;
     navigationProperties?: NavigationProperty[] | Object[] | Object;
     serializerFn?: (prop: EntityProperty, val: any) => any;
-    custom?: Object;
+    custom?: any;
 }
 /** Configuration info to be passed to the [[EntityType.setProperties]] method */
 export interface EntityTypeSetConfig {
     autoGeneratedKeyType?: AutoGeneratedKeyType;
     defaultResourceName?: string;
     serializerFn?: (prop: EntityProperty, val: any) => any;
-    custom?: Object;
+    custom?: any;
 }
 /** Container for all of the metadata about a specific type of Entity.
 **/
@@ -433,7 +441,7 @@ export declare class EntityType {
     /** A function that is used to customize the serialization of any EntityProperties of this type. */
     serializerFn?: (prop: EntityProperty, val: any) => any;
     /**  A free form object that can be used to define any custom metadata for this EntityType. __Read Only__  **/
-    custom?: Object;
+    custom?: any;
     /** The entity level validators associated with this EntityType. Validators can be added and
     removed from this collection. __Read Only__.   **/
     validators: Validator[];
@@ -626,7 +634,7 @@ export interface ComplexTypeConfig {
     namespace?: string;
     dataProperties?: DataProperty[] | Object[] | Object;
     isComplexType?: boolean;
-    custom?: Object;
+    custom?: any;
 }
 /**  Container for all of the metadata about a specific type of Complex object.
 >     let complexType = new ComplexType( {
@@ -705,7 +713,7 @@ export declare class ComplexType {
     @param config.custom - {Object}
     **/
     setProperties(config: {
-        custom?: Object;
+        custom?: any;
     }): void;
     getAllValidators(): Validator[];
     /** @hidden @internal */
@@ -729,9 +737,9 @@ export interface DataPropertyConfig {
     maxLength?: number;
     validators?: Validator[];
     displayName?: string;
-    enumType?: any;
+    enumType?: string;
     rawTypeName?: string;
-    custom?: Object;
+    custom?: any;
 }
 /**
 A DataProperty describes the metadata for a single property of an  [[EntityType]] that contains simple data.
@@ -778,11 +786,12 @@ export declare class DataProperty {
     validators: Validator[];
     /** The display name of this property. __Read Only__ */
     displayName: string;
-    enumType?: any;
+    /** The full name of the enum type */
+    enumType?: string;
     /** The raw type name of this property. will only be defined for properties with a DataType of 'Undefined' */
     rawTypeName?: string;
     /**  A free form object that can be used to define any custom metadata for this DataProperty. __Read Only__ */
-    custom?: Object;
+    custom?: any;
     inverseNavigationProperty?: NavigationProperty;
     /**
     The navigation property related to this property.  Will only be set if this is a foreign key property. __Read Only__ */
@@ -803,8 +812,8 @@ export declare class DataProperty {
     @param config - A configuration Object or a DataProperty
     */
     constructor(config: DataPropertyConfig | DataProperty);
-    static getRawValueFromServer(rawEntity: Object, dp: DataProperty): any;
-    static getRawValueFromClient(rawEntity: Object, dp: DataProperty): any;
+    static getRawValueFromServer(rawEntity: Object & Record<string, any>, dp: DataProperty): any;
+    static getRawValueFromClient(rawEntity: Object & Record<string, any>, dp: DataProperty): any;
     resolveProperty(propName: string): any;
     formatName(): string;
     /**
@@ -836,7 +845,7 @@ export interface NavigationPropertyConfig {
     invForeignKeyNamesOnServer?: string[];
     validators?: Validator[];
     displayName?: string;
-    custom?: Object;
+    custom?: any;
 }
 /**   A NavigationProperty describes the metadata for a single property of an [[EntityType]] that return instances of other EntityTypes.
 
@@ -898,7 +907,7 @@ export declare class NavigationProperty {
     displayName: string;
     isUnmapped: boolean;
     /** A free form object that can be used to define any custom metadata for this NavigationProperty.   **/
-    custom: Object;
+    custom: any;
     /** NavigationProperty constructor
     >      let homeAddressProp = new NavigationProperty( {
     >          name: "homeAddress",
@@ -931,7 +940,7 @@ export declare class NavigationProperty {
         foreignKeyNames?: string[];
         invForeignKeyNames?: string[];
         inverse?: NavigationProperty | string;
-        custom?: Object;
+        custom?: any;
     }): void;
     /*The inverse of this NavigationProperty.  The NavigationProperty that represents a navigation in the opposite direction
     to this NavigationProperty. May be undefined for a undirectional NavigationProperty. __Read Only__ */
@@ -974,3 +983,4 @@ declare module "./assert-param" {
     }
 }
 export declare function qualifyTypeName(shortName: string, ns?: string): string;
+export {};

package/src/entity-state.d.ts

@@ -60,6 +60,8 @@ export declare class EntityState extends BreezeEnum {
     >     return es === EntityState.Detached;
     **/
     isDetached(): boolean;
+    /** Return true if EntityState is Deleted or Detached */
+    isDeletedOrDetached(): boolean;
     /**
     Returns whether an entityState instance is EntityState.Unchanged or EntityState.Modified.
     >     var es = anEntity.entityAspect.entityState;
@@ -69,6 +71,8 @@ export declare class EntityState extends BreezeEnum {
     >     return es === EntityState.Unchanged || es === EntityState.Modified
     **/
     isUnchangedOrModified(): boolean;
+    /** Return true if EntityStatis is Added or Modified */
+    isAddedOrModified(): boolean;
     /** Returns whether an entityState instance is EntityState.Added or EntityState.Modified or EntityState.Deleted.
     >     var es = anEntity.entityAspect.entityState;
     >     return es.isAddedModifiedOrDeleted();

package/src/mapping-context.d.ts

@@ -35,7 +35,7 @@ export declare class MappingContext {
     entityManager: EntityManager;
     mergeOptions: MergeOptions;
     adapter: DataServiceAdapter;
-    refMap: Object;
+    refMap: Record<string, any>;
     deferredFns: Function[];
     jsonResultsAdapter: JsonResultsAdapter;
     metadataStore: MetadataStore;

package/src/predicate.d.ts

@@ -215,7 +215,6 @@ export declare class Predicate {
 @hidden
 */
 export declare class UnaryPredicate extends Predicate {
-    op: Op;
     pred: Predicate;
     constructor(op: string | QueryOp, ...args: any[]);
     _validate(entityType: EntityType, usesNameOnServer?: boolean): void;
@@ -225,7 +224,6 @@ export declare class UnaryPredicate extends Predicate {
 @hidden
 */
 export declare class BinaryPredicate extends Predicate {
-    op: Op;
     expr1Source: any;
     expr2Source: any;
     expr1?: PredicateExpression;
@@ -238,7 +236,6 @@ export declare class BinaryPredicate extends Predicate {
 @hidden
 */
 export declare class AndOrPredicate extends Predicate {
-    op: Op;
     preds: Predicate[];
     constructor(op: string | QueryOp, preds: any[]);
     _validate(entityType: EntityType, usesNameOnServer?: boolean): void;
@@ -248,7 +245,6 @@ export declare class AndOrPredicate extends Predicate {
 @hidden
 */
 export declare class AnyAllPredicate extends Predicate {
-    op: Op;
     /** @internal */
     expr: PredicateExpression;
     exprSource: string;
@@ -270,7 +266,6 @@ export declare class PredicateExpression {
 */
 export declare class LitExpr extends PredicateExpression {
     value: any;
-    dataType: DataType;
     hasExplicitDataType: boolean;
     constructor(value: any, dataType: string | DataType | undefined, hasExplicitDataType?: boolean);
     toString(): string;
@@ -281,7 +276,6 @@ export declare class LitExpr extends PredicateExpression {
 */
 export declare class PropExpr extends PredicateExpression {
     propertyPath: string;
-    dataType: DataType | StructuralType;
     constructor(propertyPath: string);
     toString(): string;
     _validate(entityType: EntityType | undefined, usesNameOnServer?: boolean): void;
@@ -294,7 +288,6 @@ export declare class FnExpr extends PredicateExpression {
     fnName: string;
     exprs: PredicateExpression[];
     localFn: any;
-    dataType: DataType;
     constructor(fnName: string, exprs: PredicateExpression[]);
     toString(): string;
     _validate(entityType: EntityType | undefined, usesNameOnServer?: boolean): void;
@@ -363,6 +356,10 @@ export declare class FnExpr extends PredicateExpression {
             fn: (source: Date) => number;
             dataType: DataType;
         };
+        hour: {
+            fn: (source: Date) => number;
+            dataType: DataType;
+        };
         day: {
             fn: (source: Date) => number;
             dataType: DataType;