breeze-client 2.2.2 → 3.0.0

package/config/interface-registry.d.ts

@@ -0,0 +1,191 @@
+import type { BaseAdapter } from './config.js';
+import { MappingContext } from '../query/mapping-context.js';
+import { EntityQuery } from '../query/entity-query.js';
+import { MetadataStore } from '../metadata/entity-metadata.js';
+import { JsonResultsAdapter, DataService } from '../metadata/data-service.js';
+import { Entity } from '../entity/entity-aspect.js';
+import { SaveContext, SaveBundle, QueryResult, SaveResult, HttpResponse } from '../manager/entity-manager.js';
+export { InterfaceRegistry } from './config.js';
+/** Adapter names for the deprecated `config.initializeAdapterInstances`. Each is the name of a previously registered adapter. */
+export interface InterfaceRegistryConfig {
+    /** e.g. `'fetch'` */
+    ajax?: string;
+    /** e.g. `'backingStore'` */
+    modelLibrary?: string;
+    /** e.g. `'webApi'` */
+    dataService?: string;
+    /** e.g. `'json'` */
+    uriBuilder?: string;
+}
+/** DataServiceAdapter Ajax request configuration */
+export interface AjaxConfig {
+    /** The request URL, without `params`: `{serviceName}/Metadata`, the save URL, or the query URL the {@link UriBuilderAdapter} built. */
+    url: string;
+    /** GET, POST, etc. */
+    type?: string;
+    /** json, etc. */
+    dataType?: string;
+    /** The `Content-Type` of the request body. The fetch transport sends it only for a request with a body (not GET or HEAD), defaulting to `application/json`. */
+    contentType?: string;
+    /** Not used by Breeze's own transport. Set to `true` for the deprecated `useJsonp` option, for a registered ajax adapter that acts on it. */
+    crossDomain?: string | boolean;
+    /** Additional request headers, merged over the `Content-Type` header. Breeze's own adapters do not set any. */
+    headers?: {};
+    /** The request body. A string is sent as it is; anything else is sent as `JSON.stringify(data)`. Ignored for GET and HEAD. */
+    data?: any;
+    /** Query-string parameters to append to `url`: the values given to {@link EntityQuery.withParameters}. A `Date` is sent as its ISO string. */
+    params?: {};
+    /** Called with the response when the request succeeds: a 2xx status and a body that parses as JSON. */
+    success: (res: HttpResponse) => void;
+    /** Called with the response when the request fails: a non-2xx status, a body that cannot be read, or no response at all (status 0). */
+    error: (res: (HttpResponse | Error)) => void;
+}
+/** Request sent by AjaxAdapter.
+    @deprecated Part of the ajax adapter contract, which Breeze 3 no longer needs. */
+export interface AjaxRequest {
+    /** AjaxAdapter that initiated the request */
+    adapter: AjaxAdapter;
+    /** Request configuration */
+    config: RequestInit;
+    /** config from the DataServiceAdapter that called the AjaxAdapter */
+    dsaConfig: AjaxConfig;
+    /** Function called on response error */
+    error: (status: number, statusText: string, body: string | null, response: Response | null, errorThrown: any) => void;
+    /** Function called on response success */
+    success: (data: any, statusText: string, response: Response) => void;
+}
+/**
+ * A fetch-compatible function. This is the seam for supplying your own transport:
+ * add auth headers, retry, request signing, route through a framework HTTP client
+ * (Angular's HttpClient, so requests pass through its interceptors), or stub it in
+ * tests. Defaults to `globalThis.fetch`.
+ */
+export type BreezeFetch = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
+/** Handles AJAX requests to server.
+    @deprecated Breeze 3 needs no ajax adapter: requests go through `config.fetch`. Set it with
+    `configureBreeze({ fetch })`. */
+export interface AjaxAdapter extends BaseAdapter {
+    /** Function that performs the ajax request and calls the success or error function */
+    ajax(config: AjaxConfig): void;
+    /** Container for headers to be added to each request */
+    defaultSettings: {
+        /** Headers to add to every request, by name. */
+        headers?: {
+            [name: string]: string;
+        };
+    };
+    /** Function to allow manipulating the request before sending */
+    requestInterceptor?: (req: AjaxRequest) => void;
+}
+/** Adapts breeze change-tracking to the UI framework */
+export interface ModelLibraryAdapter extends BaseAdapter {
+    /** Returns the names of the properties on an instance of an entity or complex type that the model library would track. Breeze calls it on a new instance of the type's constructor when it prepares the constructor, and adds any names the metadata does not know as unmapped properties. */
+    getTrackablePropertyNames: (entity: any) => string[];
+    /** Prepares the prototype of an entity or complex type constructor for tracking - for the backing store, adding `getProperty`, `setProperty` and a property accessor for each mapped property. Called when Breeze first sets up a type's constructor, and again when a property is added to a type whose prototype has already been prepared. */
+    initializeEntityPrototype(proto: Object): void;
+    /** Starts tracking one new entity or complex object - for the backing store, moving its initial values into the backing store and giving each unset property its default value. Called once per instance, when its `EntityAspect` or `ComplexAspect` is created. Despite the parameter's name, Breeze passes the constructor's prototype as the second argument. */
+    startTracking(entity: any, entityCtor: Function): void;
+    /** Optional. The stored value of a property, without creating anything that reading it would
+        create - the backing store builds a collection navigation's array on first read. Breeze
+        falls back to `getProperty` for an adapter that does not implement this, which simply
+        means the array is created as it always was. */
+    peekProperty?(entity: any, propertyName: string): any;
+    /** Optional. Called with the {@link EntityType} or {@link ComplexType} to create a constructor for a type that has none registered. Without it, Breeze creates an empty constructor. */
+    createCtor?: Function;
+}
+/** Reshapes data moving between breeze and server */
+export interface DataServiceAdapter extends BaseAdapter {
+    /**
+    Fetches the metadata for a service and imports it into the `MetadataStore`. Called by
+    `MetadataStore.fetchMetadata`, and before the first query to a service that has server metadata.
+    Resolves with the raw metadata, or with a string saying why there is none (for example, that
+    another request already fetched it). Rejects with the server error if the request fails.
+    */
+    fetchMetadata(metadataStore: MetadataStore, dataService: DataService): Promise<any>;
+    /**
+    Sends the query in `mappingContext` to the server. Resolves with the raw results, the inline count
+    if one was asked for, and the `httpResponse`; Breeze then merges the results into the cache
+    through the {@link JsonResultsAdapter}.
+    */
+    executeQuery(mappingContext: MappingContext): Promise<QueryResult>;
+    /**
+    Sends the entities in `saveBundle` to the server and resolves with the saved entities and any
+    key mappings. Called by `EntityManager.saveChanges`. Rejects with the server error, including
+    any per-entity errors, if the save fails.
+    */
+    saveChanges(saveContext: SaveContext, saveBundle: SaveBundle): Promise<SaveResult>;
+    /**
+    The constructor of the {@link ChangeRequestInterceptor} the adapter creates for each save, to let
+    an application change each entity's save request and the finished array of requests without
+    writing its own adapter. Defaults to a no-op interceptor.
+    */
+    changeRequestInterceptor: ChangeRequestInterceptorCtor;
+    /**
+    The {@link JsonResultsAdapter} used to read this adapter's query and save results, unless the
+    {@link DataService} names one of its own.
+    */
+    jsonResultsAdapter: JsonResultsAdapter;
+}
+/** Function called by AjaxAdapter before sending request.
+    @deprecated Wrap the fetch function instead - see `configureBreeze({ fetch })`. */
+export interface AjaxRequestInterceptor {
+    (req: AjaxRequest): void;
+    /** Whether to remove the interceptor after it is called */
+    oneTime: boolean;
+}
+/** Builds URI for performing queries.  Serializes the EntityQuery according to the URI syntax. */
+export interface UriBuilderAdapter extends BaseAdapter {
+    /** Returns the URL for the query, relative to the service: its resource name followed by the query in this adapter's syntax. Breeze qualifies it with the service name, and sends the query's `withParameters` values separately, as request params. */
+    buildUri(query: EntityQuery, metadataStore: MetadataStore): string;
+}
+/**
+The constructor a {@link DataServiceAdapter} calls to create a {@link ChangeRequestInterceptor}
+for one save. Assign your own to the adapter's `changeRequestInterceptor` property.
+*/
+export interface ChangeRequestInterceptorCtor {
+    /** Creates the interceptor for one save, given that save's context and the bundle about to be sent. */
+    new (saveContext: SaveContext, saveBundle: SaveBundle): ChangeRequestInterceptor;
+}
+/** Allows manipulating data in DataServiceAdapter before sending to server */
+export interface ChangeRequestInterceptor {
+    /** Whether to intercept only one save. If set, the adapter goes back to its no-op interceptor after creating this one. */
+    oneTime?: boolean;
+    /**
+     Prepare and return the save data for an entity change-set.
+  
+     The adapter calls this method for each entity in the change-set,
+     after it has prepared a "change request" for that object.
+  
+     The method can do anything to the request but it must return a valid, non-null request.
+     @example
+     this.getRequest = function (request, entity, index) {
+            // alter the request that the adapter prepared for this entity
+            // based on the entity, saveContext, and saveBundle
+            // e.g., add a custom header or prune the originalValuesMap
+            return request;
+        };
+     @param request {Object} The object representing the adapter's request to save this entity.
+     @param entity {Entity} The entity-to-be-save as it is in cache
+     @param index {Integer} The zero-based index of this entity in the change-set array
+     @returns {Function} The potentially revised request.
+     */
+    getRequest(request: any, entity: Entity, index: number): any;
+    /**
+     Last chance to change anything about the 'requests' array
+     after it has been built with requests for all of the entities-to-be-saved.
+  
+     The 'requests' array is the same as 'saveBundle.entities' in many implementations
+  
+     This method can do anything to the array including add and remove requests.
+     It's up to you to ensure that server will accept the requests array data as valid.
+  
+     Returned value is ignored.
+     @example
+     this.done = function (requests) {
+            // alter the array of requests representing the entire change-set
+            // based on the saveContext and saveBundle
+        };
+     @param requests {Array of Object} The adapter's array of request for this changeset.
+     */
+    done(requests: Object[]): void;
+}

package/config/interface-registry.js

@@ -0,0 +1,5 @@
+// InterfaceRegistry - and config.interfaceRegistry and config.initializeAdapterInstances with it -
+// is defined in config.ts: every adapter lookup needs it, and a bundler may drop this module,
+// which holds only types. See "sideEffects" in CHANGES-DEV.md.
+export { InterfaceRegistry } from './config.js';
+//# sourceMappingURL=interface-registry.js.map

package/config/interface-registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface-registry.js","sourceRoot":"","sources":["../../src/config/interface-registry.ts"],"names":[],"mappings":"AAQA,mGAAmG;AACnG,8FAA8F;AAC9F,+DAA+D;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC","sourcesContent":["import type { BaseAdapter } from './config.js';\r\nimport { MappingContext } from '../query/mapping-context.js';\r\nimport { EntityQuery } from '../query/entity-query.js';\r\nimport { MetadataStore } from '../metadata/entity-metadata.js';\r\nimport { JsonResultsAdapter, DataService } from '../metadata/data-service.js';\r\nimport { Entity } from '../entity/entity-aspect.js';\r\nimport { SaveContext, SaveBundle, QueryResult, SaveResult, HttpResponse } from '../manager/entity-manager.js';\r\n\r\n// InterfaceRegistry - and config.interfaceRegistry and config.initializeAdapterInstances with it -\r\n// is defined in config.ts: every adapter lookup needs it, and a bundler may drop this module,\r\n// which holds only types. See \"sideEffects\" in CHANGES-DEV.md.\r\nexport { InterfaceRegistry } from './config.js';\r\n\r\n/** Adapter names for the deprecated `config.initializeAdapterInstances`. Each is the name of a previously registered adapter. */\r\nexport interface InterfaceRegistryConfig {\r\n    /** e.g. `'fetch'` */\r\n    ajax?: string;\r\n    /** e.g. `'backingStore'` */\r\n    modelLibrary?: string;\r\n    /** e.g. `'webApi'` */\r\n    dataService?: string;\r\n    /** e.g. `'json'` */\r\n    uriBuilder?: string;\r\n}\r\n\r\n/** DataServiceAdapter Ajax request configuration */\r\nexport interface AjaxConfig {\r\n    /** The request URL, without `params`: `{serviceName}/Metadata`, the save URL, or the query URL the {@link UriBuilderAdapter} built. */\r\n    url: string;\r\n    /** GET, POST, etc. */\r\n    type?: string;\r\n    /** json, etc. */\r\n    dataType?: string;\r\n    /** The `Content-Type` of the request body. The fetch transport sends it only for a request with a body (not GET or HEAD), defaulting to `application/json`. */\r\n    contentType?: string;\r\n    /** Not used by Breeze's own transport. Set to `true` for the deprecated `useJsonp` option, for a registered ajax adapter that acts on it. */\r\n    crossDomain?: string | boolean;\r\n    /** Additional request headers, merged over the `Content-Type` header. Breeze's own adapters do not set any. */\r\n    headers?: {};\r\n    /** The request body. A string is sent as it is; anything else is sent as `JSON.stringify(data)`. Ignored for GET and HEAD. */\r\n    data?: any;\r\n    /** Query-string parameters to append to `url`: the values given to {@link EntityQuery.withParameters}. A `Date` is sent as its ISO string. */\r\n    params?: {};\r\n    /** Called with the response when the request succeeds: a 2xx status and a body that parses as JSON. */\r\n    success: (res: HttpResponse) => void;\r\n    /** Called with the response when the request fails: a non-2xx status, a body that cannot be read, or no response at all (status 0). */\r\n    error: (res: (HttpResponse | Error)) => void;\r\n}\r\n\r\n/** Request sent by AjaxAdapter.\r\n    @deprecated Part of the ajax adapter contract, which Breeze 3 no longer needs. */\r\nexport interface AjaxRequest {\r\n    /** AjaxAdapter that initiated the request */\r\n    adapter: AjaxAdapter;\r\n    /** Request configuration */\r\n    config: RequestInit;\r\n    /** config from the DataServiceAdapter that called the AjaxAdapter */\r\n    dsaConfig: AjaxConfig;\r\n    /** Function called on response error */\r\n    error: (status: number, statusText: string, body: string | null, response: Response | null, errorThrown: any) => void;\r\n    /** Function called on response success */\r\n    success: (data: any, statusText: string, response: Response) => void;\r\n}\r\n\r\n/**\r\n * A fetch-compatible function. This is the seam for supplying your own transport:\r\n * add auth headers, retry, request signing, route through a framework HTTP client\r\n * (Angular's HttpClient, so requests pass through its interceptors), or stub it in\r\n * tests. Defaults to `globalThis.fetch`.\r\n */\r\nexport type BreezeFetch = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;\r\n\r\n/** Handles AJAX requests to server.\r\n    @deprecated Breeze 3 needs no ajax adapter: requests go through `config.fetch`. Set it with\r\n    `configureBreeze({ fetch })`. */\r\nexport interface AjaxAdapter extends BaseAdapter {\r\n    /** Function that performs the ajax request and calls the success or error function */\r\n    ajax(config: AjaxConfig): void;\r\n    /** Container for headers to be added to each request */\r\n    defaultSettings: {\r\n        /** Headers to add to every request, by name. */\r\n        headers?: { [name: string]: string }\r\n    };\r\n    /** Function to allow manipulating the request before sending */\r\n    requestInterceptor?: (req: AjaxRequest) => void;\r\n}\r\n\r\n/** Adapts breeze change-tracking to the UI framework */\r\nexport interface ModelLibraryAdapter extends BaseAdapter {\r\n    /** Returns the names of the properties on an instance of an entity or complex type that the model library would track. Breeze calls it on a new instance of the type's constructor when it prepares the constructor, and adds any names the metadata does not know as unmapped properties. */\r\n    getTrackablePropertyNames: (entity: any) => string[];\r\n    /** Prepares the prototype of an entity or complex type constructor for tracking - for the backing store, adding `getProperty`, `setProperty` and a property accessor for each mapped property. Called when Breeze first sets up a type's constructor, and again when a property is added to a type whose prototype has already been prepared. */\r\n    initializeEntityPrototype(proto: Object): void;\r\n    /** Starts tracking one new entity or complex object - for the backing store, moving its initial values into the backing store and giving each unset property its default value. Called once per instance, when its `EntityAspect` or `ComplexAspect` is created. Despite the parameter's name, Breeze passes the constructor's prototype as the second argument. */\r\n    startTracking(entity: any, entityCtor: Function): void;\r\n    /** Optional. The stored value of a property, without creating anything that reading it would\r\n        create - the backing store builds a collection navigation's array on first read. Breeze\r\n        falls back to `getProperty` for an adapter that does not implement this, which simply\r\n        means the array is created as it always was. */\r\n    peekProperty?(entity: any, propertyName: string): any;\r\n    /** Optional. Called with the {@link EntityType} or {@link ComplexType} to create a constructor for a type that has none registered. Without it, Breeze creates an empty constructor. */\r\n    createCtor?: Function;\r\n}\r\n\r\n/** Reshapes data moving between breeze and server */\r\nexport interface DataServiceAdapter extends BaseAdapter {\r\n    /**\r\n    Fetches the metadata for a service and imports it into the `MetadataStore`. Called by\r\n    `MetadataStore.fetchMetadata`, and before the first query to a service that has server metadata.\r\n    Resolves with the raw metadata, or with a string saying why there is none (for example, that\r\n    another request already fetched it). Rejects with the server error if the request fails.\r\n    */\r\n    fetchMetadata(metadataStore: MetadataStore, dataService: DataService): Promise<any>;  // result of Promise is either rawMetadata or a string explaining why not.\r\n    /**\r\n    Sends the query in `mappingContext` to the server. Resolves with the raw results, the inline count\r\n    if one was asked for, and the `httpResponse`; Breeze then merges the results into the cache\r\n    through the {@link JsonResultsAdapter}.\r\n    */\r\n    executeQuery(mappingContext: MappingContext): Promise<QueryResult>;   // result of executeQuery will get passed to JsonResultsAdapter extractResults method\r\n    /**\r\n    Sends the entities in `saveBundle` to the server and resolves with the saved entities and any\r\n    key mappings. Called by `EntityManager.saveChanges`. Rejects with the server error, including\r\n    any per-entity errors, if the save fails.\r\n    */\r\n    saveChanges(saveContext: SaveContext, saveBundle: SaveBundle): Promise<SaveResult>;\r\n    /**\r\n    The constructor of the {@link ChangeRequestInterceptor} the adapter creates for each save, to let\r\n    an application change each entity's save request and the finished array of requests without\r\n    writing its own adapter. Defaults to a no-op interceptor.\r\n    */\r\n    changeRequestInterceptor: ChangeRequestInterceptorCtor;\r\n    /**\r\n    The {@link JsonResultsAdapter} used to read this adapter's query and save results, unless the\r\n    {@link DataService} names one of its own.\r\n    */\r\n    jsonResultsAdapter: JsonResultsAdapter;\r\n}\r\n\r\n/** Function called by AjaxAdapter before sending request.\r\n    @deprecated Wrap the fetch function instead - see `configureBreeze({ fetch })`. */\r\nexport interface AjaxRequestInterceptor {\r\n    (req: AjaxRequest) : void;\r\n    /** Whether to remove the interceptor after it is called */\r\n    oneTime: boolean;\r\n}\r\n\r\n/** Builds URI for performing queries.  Serializes the EntityQuery according to the URI syntax. */\r\nexport interface UriBuilderAdapter extends BaseAdapter {\r\n    /** Returns the URL for the query, relative to the service: its resource name followed by the query in this adapter's syntax. Breeze qualifies it with the service name, and sends the query's `withParameters` values separately, as request params. */\r\n    buildUri(query: EntityQuery, metadataStore: MetadataStore): string;\r\n}\r\n\r\n// -----------------------------------\r\n\r\n/**\r\nThe constructor a {@link DataServiceAdapter} calls to create a {@link ChangeRequestInterceptor}\r\nfor one save. Assign your own to the adapter's `changeRequestInterceptor` property.\r\n*/\r\nexport interface ChangeRequestInterceptorCtor {\r\n    /** Creates the interceptor for one save, given that save's context and the bundle about to be sent. */\r\n    new (saveContext: SaveContext, saveBundle: SaveBundle): ChangeRequestInterceptor;\r\n}\r\n\r\n/** Allows manipulating data in DataServiceAdapter before sending to server */\r\nexport interface ChangeRequestInterceptor {\r\n    /** Whether to intercept only one save. If set, the adapter goes back to its no-op interceptor after creating this one. */\r\n    oneTime?: boolean;\r\n    /**\r\n     Prepare and return the save data for an entity change-set.\r\n  \r\n     The adapter calls this method for each entity in the change-set,\r\n     after it has prepared a \"change request\" for that object.\r\n  \r\n     The method can do anything to the request but it must return a valid, non-null request.\r\n     @example\r\n     this.getRequest = function (request, entity, index) {\r\n            // alter the request that the adapter prepared for this entity\r\n            // based on the entity, saveContext, and saveBundle\r\n            // e.g., add a custom header or prune the originalValuesMap\r\n            return request;\r\n        };\r\n     @param request {Object} The object representing the adapter's request to save this entity.\r\n     @param entity {Entity} The entity-to-be-save as it is in cache\r\n     @param index {Integer} The zero-based index of this entity in the change-set array\r\n     @returns {Function} The potentially revised request.\r\n     */\r\n    getRequest(request: any, entity: Entity, index: number): any;\r\n\r\n    /**\r\n     Last chance to change anything about the 'requests' array\r\n     after it has been built with requests for all of the entities-to-be-saved.\r\n  \r\n     The 'requests' array is the same as 'saveBundle.entities' in many implementations\r\n  \r\n     This method can do anything to the array including add and remove requests.\r\n     It's up to you to ensure that server will accept the requests array data as valid.\r\n  \r\n     Returned value is ignored.\r\n     @example\r\n     this.done = function (requests) {\r\n            // alter the array of requests representing the entire change-set\r\n            // based on the saveContext and saveBundle\r\n        };\r\n     @param requests {Array of Object} The adapter's array of request for this changeset.\r\n     */\r\n    done(requests: Object[]): void;\r\n}"]}

package/{src → core}/assert-param.d.ts

@@ -1,60 +1,52 @@
-import { BreezeEnum } from './enum';
-/** @hidden @internal */
-export interface IParamContext {
-    typeName?: string;
-    type?: Function;
-    prevContext?: IParamContext;
-    msg?: string | ((context: IParamContext, v: any) => string);
-    mustNotBeEmpty?: boolean;
-    enumType?: BreezeEnum;
-    propertyName?: string;
-    allowNull?: boolean;
-    fn?(context: IParamContext, v: any): boolean;
-}
-/** @hidden @internal */
-export interface IConfigParam {
-    config: any;
-    params: Param[];
-    whereParam: (propName: string) => Param;
-}
-/** @hidden @internal */
-export declare class Param {
-    v: any;
-    name: string;
-    defaultValue: any;
-    parent: IConfigParam;
-    /** @hidden @internal */
-    _context: IParamContext;
-    /** @hidden @internal */
-    _contexts: IParamContext[];
-    constructor(v: any, name: string);
-    isObject(): Param;
-    isBoolean(): Param;
-    isString(): Param;
-    isNumber(): Param;
-    isFunction(): Param;
-    isNonEmptyString(): Param;
-    isTypeOf(typeName: string): Param;
-    isInstanceOf(type: Function, typeName?: string): Param;
-    hasProperty(propertyName: string): Param;
-    isEnumOf(enumType: any): Param;
-    isRequired(allowNull?: boolean): Param;
-    isOptional(): Param;
-    isNonEmptyArray(): Param;
-    isArray(mustNotBeEmpty?: boolean): Param;
-    or(): this;
-    check(defaultValue?: any): any;
-    /** @hidden @internal */
-    _addContext(context: IParamContext): Param;
-    getMessage(): string;
-    withDefault(defaultValue: any): this;
-    whereParam(propName: string): Param;
-    applyAll(instance: any, checkOnly?: boolean): void;
-    /** @hidden @internal */
-    _applyOne: (this: Param, instance: any) => void;
-    MESSAGE_PREFIX: string;
-}
-/** @hidden @internal */
-export declare let assertParam: (v: any, name: string) => Param;
-/** @hidden @internal */
-export declare let assertConfig: (config: Object) => IConfigParam;
+import { BreezeEnum } from './enum.js';
+/** @hidden */
+export interface IParamContext {
+    typeName?: string;
+    type?: Function;
+    prevContext?: IParamContext;
+    msg?: string | ((context: IParamContext, v: any) => string);
+    mustNotBeEmpty?: boolean;
+    enumType?: BreezeEnum;
+    propertyName?: string;
+    allowNull?: boolean;
+    fn?(context: IParamContext, v: any): boolean;
+}
+/** @hidden */
+export interface IConfigParam {
+    config: any;
+    params: Param[];
+    whereParam: (propName: string) => Param;
+}
+/** @hidden */
+export declare class Param {
+    v: any;
+    name: string;
+    defaultValue: any;
+    parent: IConfigParam;
+    constructor(v: any, name: string);
+    isObject(): Param;
+    isBoolean(): Param;
+    isString(): Param;
+    isNumber(): Param;
+    isFunction(): Param;
+    isNonEmptyString(): Param;
+    isTypeOf(typeName: string): Param;
+    isInstanceOf(type: Function, typeName?: string): Param;
+    hasProperty(propertyName: string): Param;
+    isEnumOf(enumType: any): Param;
+    isRequired(allowNull?: boolean): Param;
+    isOptional(): Param;
+    isNonEmptyArray(): Param;
+    isArray(mustNotBeEmpty?: boolean): Param;
+    or(): this;
+    check(defaultValue?: any): any;
+    getMessage(): string;
+    withDefault(defaultValue: any): this;
+    whereParam(propName: string): Param;
+    applyAll(instance: any, checkOnly?: boolean): void;
+    MESSAGE_PREFIX: string;
+}
+/** @hidden */
+export declare let assertParam: (v: any, name: string) => Param;
+/** @hidden */
+export declare let assertConfig: (config: Object) => IConfigParam;