breeze-client 2.2.2 → 3.0.0

package/breeze.js

@@ -0,0 +1,141 @@
+import { AbstractDataServiceAdapter } from './adapters/abstract-data-service-adapter.js';
+import { assertParam, assertConfig, Param } from './core/assert-param.js';
+import { BreezeConfig } from './config/config.js';
+import { BreezeEnum } from './core/enum.js';
+import { BreezeEvent } from './core/event.js';
+import { DataService, JsonResultsAdapter } from './metadata/data-service.js';
+import { DataType } from './metadata/data-type.js';
+import { EntityAction } from './entity/entity-action.js';
+import { EntityAspect, ComplexAspect } from './entity/entity-aspect.js';
+import { EntityBase, ComplexObjectBase } from './entity/entity-base.js';
+import { EntityKey } from './entity/entity-key.js';
+import { EntityManager, ProblemTypes, isConcurrencyError } from './manager/entity-manager.js';
+import { EntityQuery, FilterQueryOp, BooleanQueryOp, OrderByClause, ExpandClause, SelectClause } from './query/entity-query.js';
+import { EntityState } from './entity/entity-state.js';
+import { InterfaceRegistry } from './config/interface-registry.js';
+import { KeyGenerator } from './entity/key-generator.js';
+import { LocalQueryComparisonOptions } from './metadata/local-query-comparison-options.js';
+import { MappingContext } from './query/mapping-context.js';
+import { MetadataStore, EntityType, ComplexType, DataProperty, NavigationProperty, AutoGeneratedKeyType, entityTypeForCtor } from './metadata/entity-metadata.js';
+import { NamingConvention } from './metadata/naming-convention.js';
+import { Predicate, UnaryPredicate, BinaryPredicate, AnyAllPredicate, AndOrPredicate, LitExpr, FnExpr, PropExpr } from './query/predicate.js';
+import { QueryOptions, FetchStrategy, MergeStrategy } from './query/query-options.js';
+import { SaveOptions } from './manager/save-options.js';
+import { ValidationError, Validator } from './validation/validate.js';
+import { ValidationOptions } from './validation/validation-options.js';
+import { config } from './config/config.js';
+import { configureBreeze } from './config/configure.js';
+import { core } from './core/core.js';
+import { makeRelationArray, makePrimitiveArray, makeComplexArray } from './entity/array.js';
+export { BreezeConfig };
+export { AbstractDataServiceAdapter, AndOrPredicate, AnyAllPredicate, assertConfig, assertParam, AutoGeneratedKeyType, BinaryPredicate, BreezeEnum, BreezeEvent, ComplexAspect, ComplexObjectBase, ComplexType, config, configureBreeze, core, DataProperty, DataService, DataType, EntityAction, EntityAspect, EntityBase, EntityKey, EntityManager, EntityQuery, EntityState, EntityType, entityTypeForCtor, ExpandClause, FetchStrategy, FilterQueryOp, FnExpr, InterfaceRegistry, JsonResultsAdapter, KeyGenerator, LitExpr, LocalQueryComparisonOptions, makeComplexArray, makePrimitiveArray, makeRelationArray, MappingContext, MergeStrategy, MetadataStore, NamingConvention, NavigationProperty, OrderByClause, Predicate, PropExpr, QueryOptions, SaveOptions, SelectClause, UnaryPredicate, ValidationError, ValidationOptions, Validator, ProblemTypes, isConcurrencyError, };
+/** Every class, enum and helper of the Breeze 2.x API in one object - the `breeze` that 2.x code
+    imports or finds as a global. Kept so that code written against 2.x runs unchanged. New code
+    imports what it uses by name, which lets a bundler leave out the rest. */
+export const breeze = {
+    /** The base class of Breeze's data service adapters, for anyone writing one. The same as the
+        `AbstractDataServiceAdapter` export. */
+    AbstractDataServiceAdapter: AbstractDataServiceAdapter,
+    /** Always `null`. Breeze 2.x exposed its argument-checking helpers here; Breeze 3 does not. */
+    assertConfig: null,
+    /** Always `null`. Breeze 2.x exposed its argument-checking helpers here; Breeze 3 does not. */
+    assertParam: null,
+    /** The same as the {@link AutoGeneratedKeyType} export. */
+    AutoGeneratedKeyType: AutoGeneratedKeyType,
+    /** The operators that combine predicates in a query - `and`, `or` and `not` - as an enum. The
+        same as the `BooleanQueryOp` export. */
+    BooleanQueryOp: BooleanQueryOp,
+    /** The same as the {@link ComplexAspect} export. */
+    ComplexAspect: ComplexAspect,
+    /** The same as the {@link ComplexType} export. */
+    ComplexType: ComplexType,
+    /** The same as the {@link config} export: the older adapter-registration API. New code calls
+        {@link configureBreeze} instead. */
+    config: config,
+    /** The same as the {@link core} export. */
+    core: core,
+    /** The same as the {@link DataProperty} export. */
+    DataProperty: DataProperty,
+    /** The same as the {@link DataService} export. */
+    DataService: DataService,
+    /** The same as the {@link DataType} export. */
+    DataType: DataType,
+    /** The same as the {@link EntityAction} export. */
+    EntityAction: EntityAction,
+    /** The same as the {@link EntityAspect} export. */
+    EntityAspect: EntityAspect,
+    /** The same as the {@link EntityKey} export. */
+    EntityKey: EntityKey,
+    /** The same as the {@link EntityManager} export. */
+    EntityManager: EntityManager,
+    /** The same as the {@link EntityQuery} export. */
+    EntityQuery: EntityQuery,
+    /** The same as the {@link EntityState} export. */
+    EntityState: EntityState,
+    /** The same as the {@link EntityType} export. */
+    EntityType: EntityType,
+    /** The same as the {@link BreezeEvent} export, under its 2.x name. */
+    Event: BreezeEvent,
+    /** The same as the {@link FetchStrategy} export. */
+    FetchStrategy: FetchStrategy,
+    /** The same as the {@link FilterQueryOp} export. */
+    FilterQueryOp: FilterQueryOp,
+    /** The same as the {@link InterfaceRegistry} export. */
+    InterfaceRegistry: InterfaceRegistry,
+    /** The same as the {@link JsonResultsAdapter} export. */
+    JsonResultsAdapter: JsonResultsAdapter,
+    /** The same as the {@link KeyGenerator} export. */
+    KeyGenerator: KeyGenerator,
+    /** The same as the {@link LocalQueryComparisonOptions} export. */
+    LocalQueryComparisonOptions: LocalQueryComparisonOptions,
+    /** Turns an array into the array behind a collection of complex objects. For model library
+        adapter authors; Breeze's own adapter calls it when it sets up an entity. */
+    makeComplexArray: makeComplexArray,
+    /** Turns an array into the array behind a collection of primitive values. For model library
+        adapter authors; Breeze's own adapter calls it when it sets up an entity. */
+    makePrimitiveArray: makePrimitiveArray,
+    /** Turns an array into the {@link RelationArray} behind a collection navigation property. For
+        model library adapter authors; Breeze's own adapter calls it when it sets up an entity. */
+    makeRelationArray: makeRelationArray,
+    /** The same as the {@link MergeStrategy} export. */
+    MergeStrategy: MergeStrategy,
+    /** The same as the {@link MetadataStore} export. */
+    MetadataStore: MetadataStore,
+    /** The same as the {@link NamingConvention} export. */
+    NamingConvention: NamingConvention,
+    /** The same as the {@link NavigationProperty} export. */
+    NavigationProperty: NavigationProperty,
+    /** The class that holds a query's `orderBy`. Exposed for Breeze's own tests; applications do not
+        need it. */
+    OrderByClause: OrderByClause, // for testing only
+    /** Breeze's internal argument-checking helper. Applications do not need it. */
+    Param,
+    /** The same as the {@link Predicate} export. */
+    Predicate: Predicate,
+    /** The same as the {@link QueryOptions} export. */
+    QueryOptions: QueryOptions,
+    /** The same as the {@link SaveOptions} export. */
+    SaveOptions: SaveOptions,
+    /** The same as the {@link ValidationError} export. */
+    ValidationError: ValidationError,
+    /** The same as the {@link ValidationOptions} export. */
+    ValidationOptions: ValidationOptions,
+    /** The same as the {@link Validator} export. */
+    Validator: Validator,
+    /** The version of `breeze-client`. A test keeps it equal to the one in package.json. */
+    version: "3.0.0"
+};
+// The 2.x global. Unbundled, this always runs. Under "sideEffects": false a bundler keeps it only
+// when the bundle uses the `breeze` object above - which holds every class, so keeping it for
+// every bundle would defeat tree-shaking. See CHANGES-DEV.md.
+/** @hidden @internal */
+let win;
+try {
+    win = window ? window : (global ? global.window : undefined);
+}
+catch (e) {
+}
+if (win) {
+    win.breeze = breeze;
+}
+//# sourceMappingURL=breeze.js.map

package/breeze.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"breeze.js","sourceRoot":"","sources":["../src/breeze.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,0BAA0B,EAAE,MAAM,6CAA6C,CAAC;AACzF,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAE7E,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAExE,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAE9F,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAChI,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAEnE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,2BAA2B,EAAE,MAAM,8CAA8C,CAAC;AAC3F,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAElK,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,eAAe,EAAE,eAAe,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAE9I,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACtF,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAEvE,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAEtC,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAK5F,OAAO,EAAE,YAAY,EAAE,CAAC;AAGxB,OAAO,EACL,0BAA0B,EAC1B,cAAc,EACd,eAAe,EACf,YAAY,EACZ,WAAW,EACX,oBAAoB,EACpB,eAAe,EACf,UAAU,EACV,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,WAAW,EACX,MAAM,EACN,eAAe,EACf,IAAI,EACJ,YAAY,EACZ,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,YAAY,EACZ,UAAU,EACV,SAAS,EACT,aAAa,EACb,WAAW,EACX,WAAW,EACX,UAAU,EACV,iBAAiB,EACjB,YAAY,EACZ,aAAa,EACb,aAAa,EACb,MAAM,EACN,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,EACZ,OAAO,EACP,2BAA2B,EAC3B,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,SAAS,EACT,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,cAAc,EACd,eAAe,EACf,iBAAiB,EACjB,SAAS,EACT,YAAY,EACZ,kBAAkB,GACnB,CAAC;AAoDF;;6EAE6E;AAC7E,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB;+CAC2C;IAC3C,0BAA0B,EAAE,0BAA0B;IACtD,+FAA+F;IAC/F,YAAY,EAAE,IAAW;IACzB,+FAA+F;IAC/F,WAAW,EAAE,IAAW;IACxB,2DAA2D;IAC3D,oBAAoB,EAAE,oBAAoB;IAC1C;+CAC2C;IAC3C,cAAc,EAAE,cAAc;IAC9B,oDAAoD;IACpD,aAAa,EAAE,aAAa;IAC5B,kDAAkD;IAClD,WAAW,EAAE,WAAW;IACxB;2CACuC;IACvC,MAAM,EAAE,MAAM;IACd,2CAA2C;IAC3C,IAAI,EAAE,IAAI;IACV,mDAAmD;IACnD,YAAY,EAAE,YAAY;IAC1B,kDAAkD;IAClD,WAAW,EAAE,WAAW;IACxB,+CAA+C;IAC/C,QAAQ,EAAE,QAAQ;IAClB,mDAAmD;IACnD,YAAY,EAAE,YAAY;IAC1B,mDAAmD;IACnD,YAAY,EAAE,YAAY;IAC1B,gDAAgD;IAChD,SAAS,EAAE,SAAS;IACpB,oDAAoD;IACpD,aAAa,EAAE,aAAa;IAC5B,kDAAkD;IAClD,WAAW,EAAE,WAAW;IACxB,kDAAkD;IAClD,WAAW,EAAE,WAAW;IACxB,iDAAiD;IACjD,UAAU,EAAE,UAAU;IACtB,sEAAsE;IACtE,KAAK,EAAE,WAAW;IAClB,oDAAoD;IACpD,aAAa,EAAE,aAAa;IAC5B,oDAAoD;IACpD,aAAa,EAAE,aAAa;IAC5B,wDAAwD;IACxD,iBAAiB,EAAE,iBAAiB;IACpC,yDAAyD;IACzD,kBAAkB,EAAE,kBAAkB;IACtC,mDAAmD;IACnD,YAAY,EAAE,YAAY;IAC1B,kEAAkE;IAClE,2BAA2B,EAAE,2BAA2B;IACxD;oFACgF;IAChF,gBAAgB,EAAE,gBAAgB;IAClC;oFACgF;IAChF,kBAAkB,EAAE,kBAAkB;IACtC;kGAC8F;IAC9F,iBAAiB,EAAE,iBAAiB;IACpC,oDAAoD;IACpD,aAAa,EAAE,aAAa;IAC5B,oDAAoD;IACpD,aAAa,EAAE,aAAa;IAC5B,uDAAuD;IACvD,gBAAgB,EAAE,gBAAgB;IAClC,yDAAyD;IACzD,kBAAkB,EAAE,kBAAkB;IACtC;mBACe;IACf,aAAa,EAAE,aAAa,EAAE,mBAAmB;IACjD,+EAA+E;IAC/E,KAAK;IACL,gDAAgD;IAChD,SAAS,EAAE,SAAS;IACpB,mDAAmD;IACnD,YAAY,EAAE,YAAY;IAC1B,kDAAkD;IAClD,WAAW,EAAE,WAAW;IACxB,sDAAsD;IACtD,eAAe,EAAE,eAAe;IAChC,wDAAwD;IACxD,iBAAiB,EAAE,iBAAiB;IACpC,gDAAgD;IAChD,SAAS,EAAE,SAAS;IACpB,wFAAwF;IACxF,OAAO,EAAE,OAAO;CACjB,CAAC;AA6CF,kGAAkG;AAClG,8FAA8F;AAC9F,8DAA8D;AAC9D,wBAAwB;AACxB,IAAI,GAAQ,CAAC;AACb,IAAI,CAAC;IACH,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAC/D,CAAC;AAAC,OAAO,CAAC,EAAE,CAAC;AAEb,CAAC;AACD,IAAI,GAAG,EAAE,CAAC;IACR,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;AACtB,CAAC","sourcesContent":["\r\nimport { AbstractDataServiceAdapter } from './adapters/abstract-data-service-adapter.js';\r\nimport { assertParam, assertConfig, Param } from './core/assert-param.js';\r\nimport { BreezeConfig } from './config/config.js';\r\nimport { BreezeEnum } from './core/enum.js';\r\nimport { BreezeEvent } from './core/event.js';\r\nimport type { ComplexArray } from './entity/complex-array.js';\r\nimport { DataService, JsonResultsAdapter } from './metadata/data-service.js';\r\nimport type { DataServiceConfig, JsonResultsAdapterConfig, NodeContext, NodeMeta } from './metadata/data-service.js';\r\nimport { DataType } from './metadata/data-type.js';\r\nimport { EntityAction } from './entity/entity-action.js';\r\nimport { EntityAspect, ComplexAspect } from './entity/entity-aspect.js';\r\nimport { EntityBase, ComplexObjectBase } from './entity/entity-base.js';\r\nimport type { Entity, ComplexObject, StructuralObject, PropertyChangedEventArgs, QueriedAs, EntityAspectOf, ComplexAspectOf } from './entity/entity-aspect.js';\r\nimport { EntityKey } from './entity/entity-key.js';\r\nimport { EntityManager, ProblemTypes, isConcurrencyError } from './manager/entity-manager.js';\r\nimport type { EntityManagerConfig, EntityError, EntityChangedEventArgs, SaveContext, SaveBundle, HttpResponse, KeyMapping, ServerError, SaveResult, QueryResult, ValidationErrorsChangedEventArgs, HasChangesChangedEventArgs } from './manager/entity-manager.js';\r\nimport { EntityQuery, FilterQueryOp, BooleanQueryOp, OrderByClause, ExpandClause, SelectClause } from './query/entity-query.js';\r\nimport { EntityState } from './entity/entity-state.js';\r\nimport { InterfaceRegistry } from './config/interface-registry.js';\r\nimport type { AjaxAdapter, AjaxConfig, BreezeFetch, DataServiceAdapter, ModelLibraryAdapter, ChangeRequestInterceptor, UriBuilderAdapter, InterfaceRegistryConfig, AjaxRequestInterceptor } from './config/interface-registry.js';\r\nimport { KeyGenerator } from './entity/key-generator.js';\r\nimport { LocalQueryComparisonOptions } from './metadata/local-query-comparison-options.js';\r\nimport { MappingContext } from './query/mapping-context.js';\r\nimport { MetadataStore, EntityType, ComplexType, DataProperty, NavigationProperty, AutoGeneratedKeyType, entityTypeForCtor } from './metadata/entity-metadata.js';\r\nimport type { StructuralType, EntityProperty } from './metadata/entity-metadata.js';\r\nimport { NamingConvention } from './metadata/naming-convention.js';\r\nimport { Predicate, UnaryPredicate, BinaryPredicate, AnyAllPredicate, AndOrPredicate, LitExpr, FnExpr, PropExpr } from './query/predicate.js';\r\nimport type { VisitContext, Visitor, ExpressionContext } from './query/predicate.js';\r\nimport { QueryOptions, FetchStrategy, MergeStrategy } from './query/query-options.js';\r\nimport { SaveOptions } from './manager/save-options.js';\r\nimport { ValidationError, Validator } from './validation/validate.js';\r\nimport { ValidationOptions } from './validation/validation-options.js';\r\n\r\nimport { config } from './config/config.js';\r\nimport type { BaseAdapter } from './config/config.js';\r\nimport { configureBreeze } from './config/configure.js';\r\nimport type { BreezeSetupOptions, AdapterRegistration, AjaxAdapterRegistration } from './config/configure.js';\r\nimport { core } from './core/core.js';\r\nimport type { Callback, ErrorCallback } from './core/core.js';\r\nimport { makeRelationArray, makePrimitiveArray, makeComplexArray } from './entity/array.js';\r\n\r\nimport type { RelationArray } from './entity/relation-array.js';\r\nimport type { ArrayChangedArgs } from './entity/observable-array.js';\r\n\r\nexport { BreezeConfig };\r\nexport type { ComplexArray, RelationArray };\r\n\r\nexport {\r\n  AbstractDataServiceAdapter,\r\n  AndOrPredicate,\r\n  AnyAllPredicate,\r\n  assertConfig,\r\n  assertParam,\r\n  AutoGeneratedKeyType,\r\n  BinaryPredicate,\r\n  BreezeEnum,\r\n  BreezeEvent,\r\n  ComplexAspect,\r\n  ComplexObjectBase,\r\n  ComplexType,\r\n  config,\r\n  configureBreeze,\r\n  core,\r\n  DataProperty,\r\n  DataService,\r\n  DataType,\r\n  EntityAction,\r\n  EntityAspect,\r\n  EntityBase,\r\n  EntityKey,\r\n  EntityManager,\r\n  EntityQuery,\r\n  EntityState,\r\n  EntityType,\r\n  entityTypeForCtor,\r\n  ExpandClause,\r\n  FetchStrategy,\r\n  FilterQueryOp,\r\n  FnExpr,\r\n  InterfaceRegistry,\r\n  JsonResultsAdapter,\r\n  KeyGenerator,\r\n  LitExpr,\r\n  LocalQueryComparisonOptions,\r\n  makeComplexArray,\r\n  makePrimitiveArray,\r\n  makeRelationArray,\r\n  MappingContext,\r\n  MergeStrategy,\r\n  MetadataStore,\r\n  NamingConvention,\r\n  NavigationProperty,\r\n  OrderByClause,\r\n  Predicate,\r\n  PropExpr,\r\n  QueryOptions,\r\n  SaveOptions,\r\n  SelectClause,\r\n  UnaryPredicate,\r\n  ValidationError,\r\n  ValidationOptions,\r\n  Validator,\r\n  ProblemTypes,\r\n  isConcurrencyError,\r\n};\r\n\r\n// Type-only exports. These are erased at runtime, so they must be re-exported\r\n// with `export type`: a bundler transpiling file-by-file cannot tell otherwise,\r\n// and emits a runtime export that does not exist. Browser ESM rejects that.\r\nexport type {\r\n  AjaxAdapter,\r\n  AjaxConfig,\r\n  AjaxRequestInterceptor,\r\n  ArrayChangedArgs,\r\n  BaseAdapter,\r\n  BreezeFetch,\r\n  Callback,\r\n  ChangeRequestInterceptor,\r\n  ComplexObject,\r\n  BreezeSetupOptions,\r\n  AdapterRegistration,\r\n  AjaxAdapterRegistration,\r\n  DataServiceAdapter,\r\n  DataServiceConfig,\r\n  Entity,\r\n  EntityChangedEventArgs,\r\n  EntityError,\r\n  EntityManagerConfig,\r\n  EntityProperty,\r\n  ErrorCallback,\r\n  ExpressionContext,\r\n  HasChangesChangedEventArgs,\r\n  HttpResponse,\r\n  InterfaceRegistryConfig,\r\n  JsonResultsAdapterConfig,\r\n  KeyMapping,\r\n  ModelLibraryAdapter,\r\n  NodeContext,\r\n  NodeMeta,\r\n  PropertyChangedEventArgs,\r\n  QueriedAs,\r\n  EntityAspectOf,\r\n  ComplexAspectOf,\r\n  QueryResult,\r\n  SaveBundle,\r\n  SaveContext,\r\n  SaveResult,\r\n  ServerError,\r\n  StructuralObject,\r\n  StructuralType,\r\n  UriBuilderAdapter,\r\n  ValidationErrorsChangedEventArgs,\r\n  VisitContext,\r\n  Visitor,\r\n};\r\n\r\n/** Every class, enum and helper of the Breeze 2.x API in one object - the `breeze` that 2.x code\r\n    imports or finds as a global. Kept so that code written against 2.x runs unchanged. New code\r\n    imports what it uses by name, which lets a bundler leave out the rest. */\r\nexport const breeze = {\r\n  /** The base class of Breeze's data service adapters, for anyone writing one. The same as the\r\n      `AbstractDataServiceAdapter` export. */\r\n  AbstractDataServiceAdapter: AbstractDataServiceAdapter,\r\n  /** Always `null`. Breeze 2.x exposed its argument-checking helpers here; Breeze 3 does not. */\r\n  assertConfig: null as any,\r\n  /** Always `null`. Breeze 2.x exposed its argument-checking helpers here; Breeze 3 does not. */\r\n  assertParam: null as any,\r\n  /** The same as the {@link AutoGeneratedKeyType} export. */\r\n  AutoGeneratedKeyType: AutoGeneratedKeyType,\r\n  /** The operators that combine predicates in a query - `and`, `or` and `not` - as an enum. The\r\n      same as the `BooleanQueryOp` export. */\r\n  BooleanQueryOp: BooleanQueryOp,\r\n  /** The same as the {@link ComplexAspect} export. */\r\n  ComplexAspect: ComplexAspect,\r\n  /** The same as the {@link ComplexType} export. */\r\n  ComplexType: ComplexType,\r\n  /** The same as the {@link config} export: the older adapter-registration API. New code calls\r\n      {@link configureBreeze} instead. */\r\n  config: config,\r\n  /** The same as the {@link core} export. */\r\n  core: core,\r\n  /** The same as the {@link DataProperty} export. */\r\n  DataProperty: DataProperty,\r\n  /** The same as the {@link DataService} export. */\r\n  DataService: DataService,\r\n  /** The same as the {@link DataType} export. */\r\n  DataType: DataType,\r\n  /** The same as the {@link EntityAction} export. */\r\n  EntityAction: EntityAction,\r\n  /** The same as the {@link EntityAspect} export. */\r\n  EntityAspect: EntityAspect,\r\n  /** The same as the {@link EntityKey} export. */\r\n  EntityKey: EntityKey,\r\n  /** The same as the {@link EntityManager} export. */\r\n  EntityManager: EntityManager,\r\n  /** The same as the {@link EntityQuery} export. */\r\n  EntityQuery: EntityQuery,\r\n  /** The same as the {@link EntityState} export. */\r\n  EntityState: EntityState,\r\n  /** The same as the {@link EntityType} export. */\r\n  EntityType: EntityType,\r\n  /** The same as the {@link BreezeEvent} export, under its 2.x name. */\r\n  Event: BreezeEvent,\r\n  /** The same as the {@link FetchStrategy} export. */\r\n  FetchStrategy: FetchStrategy,\r\n  /** The same as the {@link FilterQueryOp} export. */\r\n  FilterQueryOp: FilterQueryOp,\r\n  /** The same as the {@link InterfaceRegistry} export. */\r\n  InterfaceRegistry: InterfaceRegistry,\r\n  /** The same as the {@link JsonResultsAdapter} export. */\r\n  JsonResultsAdapter: JsonResultsAdapter,\r\n  /** The same as the {@link KeyGenerator} export. */\r\n  KeyGenerator: KeyGenerator,\r\n  /** The same as the {@link LocalQueryComparisonOptions} export. */\r\n  LocalQueryComparisonOptions: LocalQueryComparisonOptions,\r\n  /** Turns an array into the array behind a collection of complex objects. For model library\r\n      adapter authors; Breeze's own adapter calls it when it sets up an entity. */\r\n  makeComplexArray: makeComplexArray,\r\n  /** Turns an array into the array behind a collection of primitive values. For model library\r\n      adapter authors; Breeze's own adapter calls it when it sets up an entity. */\r\n  makePrimitiveArray: makePrimitiveArray,\r\n  /** Turns an array into the {@link RelationArray} behind a collection navigation property. For\r\n      model library adapter authors; Breeze's own adapter calls it when it sets up an entity. */\r\n  makeRelationArray: makeRelationArray,\r\n  /** The same as the {@link MergeStrategy} export. */\r\n  MergeStrategy: MergeStrategy,\r\n  /** The same as the {@link MetadataStore} export. */\r\n  MetadataStore: MetadataStore,\r\n  /** The same as the {@link NamingConvention} export. */\r\n  NamingConvention: NamingConvention,\r\n  /** The same as the {@link NavigationProperty} export. */\r\n  NavigationProperty: NavigationProperty,\r\n  /** The class that holds a query's `orderBy`. Exposed for Breeze's own tests; applications do not\r\n      need it. */\r\n  OrderByClause: OrderByClause, // for testing only\r\n  /** Breeze's internal argument-checking helper. Applications do not need it. */\r\n  Param,\r\n  /** The same as the {@link Predicate} export. */\r\n  Predicate: Predicate,\r\n  /** The same as the {@link QueryOptions} export. */\r\n  QueryOptions: QueryOptions,\r\n  /** The same as the {@link SaveOptions} export. */\r\n  SaveOptions: SaveOptions,\r\n  /** The same as the {@link ValidationError} export. */\r\n  ValidationError: ValidationError,\r\n  /** The same as the {@link ValidationOptions} export. */\r\n  ValidationOptions: ValidationOptions,\r\n  /** The same as the {@link Validator} export. */\r\n  Validator: Validator,\r\n  /** The version of `breeze-client`. A test keeps it equal to the one in package.json. */\r\n  version: \"3.0.0\"\r\n};\r\n\r\n// breeze.assertConfig = assertConfig as any;\r\n// breeze.assertParam = assertParam as any;\r\n\r\n// Shapes that public signatures accept or return: constructor config objects, event args,\r\n// callbacks, and what adapter authors implement against. Type-only, so no runtime cost -\r\n// exported so applications can name them.\r\nexport type { AdapterCtor, AdapterType } from './config/config.js';\r\nexport type { AjaxRequest, ChangeRequestInterceptorCtor } from './config/interface-registry.js';\r\nexport type {\r\n  ComplexTypeConfig, DataPropertyConfig, EntityTypeConfig, EntityTypeSetConfig,\r\n  MetadataFetchedEventArgs, MetadataStoreConfig, NavigationPropertyConfig,\r\n} from './metadata/entity-metadata.js';\r\nexport type {\r\n  EntityByKeyResult, EntityTypeArg, ExportEntitiesArg, IEntityByKeyResult, ImportConfig, ImportResult, InitialValues, ITempKeyMap,\r\n  QueryErrorCallback, QuerySuccessCallback, SaveError,\r\n} from './manager/entity-manager.js';\r\nexport type { LocalQueryComparisonOptionsConfig } from './metadata/local-query-comparison-options.js';\r\nexport type { NamingConventionConfig } from './metadata/naming-convention.js';\r\nexport type {\r\n  CollectionElement, CollectionPath, FilterOpFor, FilterValueExpression, FilterValueFor, FunctionExpressionPath,\r\n  FilterClause, FilterOpsObject, FilterOpNameFor, NavigationPath, OrderByPath,\r\n  KeyValues, OriginalValues, PropertyPath, PropertyValue, QuantifierOp, SelectPath, WhereObject,\r\n} from './query/property-path.js';\r\nexport type { TypedPredicateFactory } from './query/predicate.js';\r\nexport type { QueryOptionsConfig } from './query/query-options.js';\r\nexport type { SaveOptionsConfig } from './manager/save-options.js';\r\nexport type { ValidationContext, ValidationFn, ValidationMessageContext } from './validation/validate.js';\r\nexport type { ValidationOptionsConfig } from './validation/validation-options.js';\r\n\r\n/** Kept for code written against Breeze 2.x and `breeze-bridge2-angular`. Breeze 3 uses native\r\n    promises and has nothing to configure here. */\r\nexport namespace promises {\r\n  /** An empty interface, kept so that code written for `breeze-bridge2-angular`, which named it,\r\n      still compiles. Breeze 3 uses native promises. */\r\n  export interface IPromiseService {}\r\n}\r\n\r\n/** @hidden @internal */\r\ndeclare var window: any;\r\n\r\n/** @hidden @internal */\r\ndeclare var global: any;\r\n\r\n// The 2.x global. Unbundled, this always runs. Under \"sideEffects\": false a bundler keeps it only\r\n// when the bundle uses the `breeze` object above - which holds every class, so keeping it for\r\n// every bundle would defeat tree-shaking. See CHANGES-DEV.md.\r\n/** @hidden @internal */\r\nlet win: any;\r\ntry {\r\n  win = window ? window : (global ? global.window : undefined);\r\n} catch (e) {\r\n\r\n}\r\nif (win) {\r\n  win.breeze = breeze;\r\n}\r\n"]}

package/config/config.d.ts

@@ -0,0 +1,212 @@
+import type { AjaxAdapter, BreezeFetch, DataServiceAdapter, ModelLibraryAdapter, UriBuilderAdapter } from './interface-registry.js';
+import { BreezeEvent } from '../core/event.js';
+/** @hidden */
+export interface AdapterCtor<T extends BaseAdapter> {
+    new (...args: any[]): T;
+}
+/** @hidden */
+export interface IDef<T extends BaseAdapter> {
+    ctor: AdapterCtor<T>;
+    defaultInstance?: T;
+}
+/**
+The names of the adapter interfaces, as passed to the 2.x-style methods on {@link BreezeConfig}
+such as `registerAdapter` and `initializeAdapterInstance`. With {@link configureBreeze} you pass
+the adapter classes instead and never need these names.
+*/
+export type AdapterType = 'dataService' | 'modelLibrary' | 'ajax' | 'uriBuilder';
+export declare class InterfaceDef<T extends BaseAdapter> {
+    name: string;
+    defaultInstance?: T;
+    constructor(name: string);
+    /** Define an implementation of the given adaptername */
+    registerCtor(adapterName: string, ctor: AdapterCtor<T>): void;
+    /** Return the definition for the given adapterName */
+    getImpl(adapterName: string): IDef<T>;
+    /** Return the first implementation for this InterfaceDef */
+    getFirstImpl(): IDef<T>;
+    getDefaultInstance(): T;
+}
+/** Registers adapters used by Breeze */
+export declare class InterfaceRegistry {
+    /** Creates a registry with no adapters in it. {@link config} holds the one Breeze uses;
+    applications do not create their own. */
+    constructor();
+    /** The registered {@link AjaxAdapter}s, and the default one if any. Deprecated: Breeze 3 sends requests through `config.fetch` and needs no ajax adapter. */
+    ajax: InterfaceDef<AjaxAdapter>;
+    /** The registered {@link ModelLibraryAdapter}s, and the default one. */
+    modelLibrary: InterfaceDef<ModelLibraryAdapter>;
+    /** The registered {@link DataServiceAdapter}s, and the default one. */
+    dataService: InterfaceDef<DataServiceAdapter>;
+    /** The registered {@link UriBuilderAdapter}s, and the default one. */
+    uriBuilder: InterfaceDef<UriBuilderAdapter>;
+}
+/**
+What every Breeze adapter implements: the model library, data service, URI builder and
+(deprecated) ajax adapters all extend this interface.
+*/
+export interface BaseAdapter {
+    /**
+    The name the adapter is registered under, such as `'webApi'` or `'backingStore'`. Names are
+    matched without regard to case. `registerAdapter` reads it from a throwaway instance and throws
+    if it is empty.
+    */
+    name: string;
+    /**
+    Called by Breeze each time the adapter is initialized: when it is first created, and again
+    whenever it is initialized by name or registered again, for example by {@link configureBreeze}.
+    Resolve anything the adapter depends on here, not in the constructor.
+    */
+    initialize(): void;
+    /**
+    Optional. Called each time any adapter is initialized after this one first was, with
+    `{ interfaceName, instance, isDefault }`, so that this adapter can pick up a new dependency. The data service adapters use
+    it to re-resolve their ajax adapter when a new default ajax adapter is initialized.
+    */
+    checkForRecomposition?: (context: any) => void;
+}
+/**
+An adapter Breeze falls back to for an interface when nothing has been registered for it.
+@hidden
+*/
+export interface DefaultAdapter {
+    ctor: AdapterCtor<any>;
+    /** Use only when asked for by name, never as the unnamed default. */
+    namedOnly?: boolean;
+}
+/**
+Breeze's global configuration: the adapter registry, the `fetch` transport, and registries Breeze
+uses to find functions and objects by name when it deserializes metadata. The single instance is
+{@link config}.
+
+To configure Breeze, use {@link configureBreeze}. The adapter methods here (`registerAdapter`,
+`initializeAdapterInstance`, `getAdapterInstance` and the rest) are the 2.x API. They still
+work, and adapters' own static `register()` methods use them, but an application does not
+normally need to call them.
+*/
+export declare class BreezeConfig {
+    /**
+    Functions registered by name with {@link BreezeConfig.registerFunction}. Breeze looks up
+    validator factories here, under `"Validator." + name`, when it imports metadata. Applications do
+    not normally need it; use {@link Validator.register} and {@link Validator.registerFactory}.
+    */
+    functionRegistry: Record<string, Function>;
+    /**
+    Constructors registered by name with {@link BreezeConfig.registerType}. Nothing in Breeze 3
+    reads it; applications do not normally need it.
+    */
+    typeRegistry: Record<string, Function>;
+    /**
+    Named instances Breeze can find again by name, keyed `"<TypeName>.<name>"`: every
+    {@link JsonResultsAdapter}, {@link NamingConvention} and {@link LocalQueryComparisonOptions}
+    registers itself here when created. Breeze uses it to resolve the names in exported metadata and
+    exported entities. Applications do not normally need it.
+    */
+    objectRegistry: Record<string, any>;
+    /**
+    Published each time an adapter is initialized, with the interface name, the adapter instance
+    and whether it became the default for its interface. Breeze uses it to let adapters that depend
+    on each other recompose (see {@link BaseAdapter.checkForRecomposition}); applications do not
+    normally need it.
+    */
+    interfaceInitialized: BreezeEvent<{
+        /** The interface the adapter implements: `"ajax"`, `"dataService"`, `"modelLibrary"` or `"uriBuilder"`. */
+        interfaceName: string;
+        /** The adapter that was initialized. */
+        instance: BaseAdapter;
+        /** Whether it became the default adapter for its interface. */
+        isDefault: boolean;
+    }>;
+    /**
+    The indentation Breeze passes to `JSON.stringify` when it serializes exported entities
+    (`EntityManager.exportEntities`) and exported metadata (`MetadataStore.exportMetadata`).
+    The default, `''`, produces compact JSON; set it to, say, `'  '` for readable output.
+    */
+    stringifyPad: string;
+    /**
+     * The function Breeze makes HTTP requests with, unless a (deprecated) ajax adapter is
+     * registered. Set it with `configureBreeze({ fetch })`. When unset, `globalThis.fetch`.
+     */
+    fetch?: BreezeFetch;
+    /** Creates a configuration with nothing registered. Breeze creates the one instance there is,
+    {@link config}; applications do not create their own. */
+    constructor();
+    /**
+    Method use to register implementations of standard breeze interfaces.  Calls to this method are usually
+    made as the last step within an adapter implementation.
+    @param interfaceName {String} - one of the following interface names: "ajax", "dataService", "modelLibrary", "uriBuilder"
+    @param adapterCtor {Function} - an ctor function that returns an instance of the specified interface.
+
+    @deprecated For configuring an application, use `configureBreeze({ ajax: MyAdapter, ... })`
+    instead: the adapter classes are passed directly, so a misspelled name is a compile error
+    rather than a runtime one. An adapter's own static `register()` still calls this - that is
+    how an adapter registers itself, and is not deprecated. Not scheduled for removal.
+    */
+    registerAdapter<T extends BaseAdapter>(interfaceName: AdapterType, adapterCtor: AdapterCtor<T>): void;
+    /**
+    Returns the ctor function used to implement a specific interface with a specific adapter name.
+    @param interfaceName {String} One of the following interface names: "ajax", "dataService", "modelLibrary", "uriBuilder"
+    @param [adapterName] {String} The name of any previously registered adapter. If this parameter is omitted then
+    this method returns the "default" adapter for this interface. If there is no default adapter, then a null is returned.
+    @returns {Function|null} Returns either a ctor function or null.
+    */
+    getAdapter(interfaceName: AdapterType, adapterName: string): any;
+    /**
+    Initializes a single adapter implementation. Initialization means either newing a instance of the
+    specified interface and then calling "initialize" on it or simply calling "initialize" on the instance
+    if it already exists.
+    @param interfaceName {String} The name of the interface to which the adapter to initialize belongs.
+    @param adapterName {String} - The name of a previously registered adapter to initialize.
+    @param [isDefault=true] {Boolean} - Whether to make this the default "adapter" for this interface.
+    @returns {an instance of the specified adapter}
+
+    @deprecated For configuring an application, use `configureBreeze({ ajax: MyAdapter, ... })`
+    instead: the adapter classes are passed directly, so a misspelled name is a compile error
+    rather than a runtime one. An adapter's own static `register()` still calls this - that is
+    how an adapter registers itself, and is not deprecated. Not scheduled for removal.
+    */
+    initializeAdapterInstance(interfaceName: AdapterType, adapterName: string, isDefault?: boolean): BaseAdapter;
+    /**
+    Returns the adapter instance corresponding to the specified interface and adapter names.
+    @param interfaceName {String} The name of the interface.
+    @param [adapterName] {String} - The name of a previously registered adapter.  If this parameter is
+    omitted then the default implementation of the specified interface is returned. If there is
+    no defaultInstance of this interface, then the first registered instance of this interface is returned.
+    @returns {an instance of the specified adapter}
+    */
+    getAdapterInstance<T extends BaseAdapter>(interfaceName: AdapterType, adapterName?: string): T | undefined;
+    /** this is needed for reflection purposes when deserializing an object that needs a fn or ctor.
+        Used to register validators. */
+    registerFunction(fn: Function, fnName: string): void;
+    /**
+    Registers a constructor under a type name: stamps the name on its prototype as `_$typeName` and
+    adds it to {@link BreezeConfig.typeRegistry}. Breeze registers `KeyGenerator` this way;
+    applications do not normally need it.
+    @param ctor - The constructor to register.
+    @param typeName - The name to register it under.
+    */
+    registerType(ctor: Function, typeName: string): void;
+    /**
+    Returns the function registered under the given name with {@link BreezeConfig.registerFunction},
+    or `undefined` if there is none. Validators are registered as `"Validator." + name`, so
+    `config.getRegisteredFunction('Validator.maxLength')` returns the `maxLength` factory.
+    @param fnName - The name the function was registered under.
+    */
+    getRegisteredFunction(fnName: string): Function;
+    /**
+    Returns the registry entry for one adapter interface, which holds its registered adapters and
+    its default instance. The name is matched without regard to case.
+    Used by the adapter registration methods; applications do not normally need it.
+    @param interfaceName - `'ajax'`, `'dataService'`, `'modelLibrary'` or `'uriBuilder'`.
+    @throws if there is no interface with that name.
+    */
+    getInterfaceDef<T extends BaseAdapter>(interfaceName: string): InterfaceDef<T>;
+}
+/**
+The global {@link BreezeConfig}, used by every `EntityManager`, `MetadataStore` and `DataService`.
+
+To configure Breeze, use {@link configureBreeze}, which sets this object's adapters and `fetch`.
+The 2.x calls on it, such as `config.registerAdapter(...)` and
+`config.initializeAdapterInstance(...)`, still work and are not scheduled for removal.
+*/
+export declare const config: BreezeConfig;