breeze-client 2.2.2 → 3.0.0

package/manager/save-options.js

@@ -0,0 +1,51 @@
+import { core } from '../core/core.js';
+import { assertConfig } from '../core/assert-param.js';
+import { DataService } from '../metadata/data-service.js';
+/**
+A SaveOptions instance is used to specify the 'options' under which a save will occur.
+*/
+export class SaveOptions {
+    /** The default value whenever SaveOptions are not specified. */
+    static defaultInstance = new SaveOptions({ allowConcurrentSaves: false });
+    /** Creates save options from a {@link SaveOptionsConfig}. Passed to {@link EntityManager.saveChanges},
+    they are used for that save in place of the manager's {@link EntityManager.saveOptions} - as a
+    whole, not merged with them setting by setting.
+    ```ts
+    const so = new SaveOptions({ allowConcurrentSaves: true });
+    em.saveChanges(null, so);
+    ```
+    */
+    constructor(config) {
+        SaveOptions._updateWithConfig(this, config);
+    }
+    /**
+    Sets the 'defaultInstance' by creating a copy of the current 'defaultInstance' and then applying all of the properties of the current instance.
+    The current instance is returned unchanged.
+    */
+    setAsDefault() {
+        return core.setAsDefault(this, SaveOptions);
+    }
+    /**
+    Returns a copy of this SaveOptions with the specified config options applied.
+    ```ts
+    var saveOptions = em1.saveOptions.using( {resourceName: "anotherResource" });
+    ```
+    */
+    using(config) {
+        return SaveOptions._updateWithConfig(this, config);
+    }
+    /** @hidden @internal */
+    static _updateWithConfig(obj, config) {
+        if (config) {
+            assertConfig(config)
+                .whereParam("resourceName").isOptional().isString()
+                .whereParam("dataService").isOptional().isInstanceOf(DataService)
+                .whereParam("allowConcurrentSaves").isBoolean().isOptional()
+                .whereParam("tag").isOptional()
+                .applyAll(obj);
+        }
+        return obj;
+    }
+}
+SaveOptions.prototype._$typeName = "SaveOptions";
+//# sourceMappingURL=save-options.js.map

package/manager/save-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"save-options.js","sourceRoot":"","sources":["../../src/manager/save-options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAc1D;;EAEE;AACF,MAAM,OAAO,WAAW;IAYtB,gEAAgE;IAChE,MAAM,CAAC,eAAe,GAAG,IAAI,WAAW,CAAC,EAAE,oBAAoB,EAAE,KAAK,EAAC,CAAC,CAAC;IAEzE;;;;;;;MAOE;IACF,YAAY,MAA0B;QACpC,WAAW,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;IAGD;;;MAGE;IACF,YAAY;QACV,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;MAKE;IACF,KAAK,CAAC,MAAyB;QAC7B,OAAO,WAAW,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,wBAAwB;IAChB,MAAM,CAAC,iBAAiB,CAAC,GAAgB,EAAE,MAA0B;QAC3E,IAAI,MAAM,EAAE,CAAC;YACX,YAAY,CAAC,MAAM,CAAC;iBACf,UAAU,CAAC,cAAc,CAAC,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE;iBAClD,UAAU,CAAC,aAAa,CAAC,CAAC,UAAU,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC;iBAChE,UAAU,CAAC,sBAAsB,CAAC,CAAC,SAAS,EAAE,CAAC,UAAU,EAAE;iBAC3D,UAAU,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE;iBAC9B,QAAQ,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;;AAGH,WAAW,CAAC,SAAS,CAAC,UAAU,GAAG,aAAa,CAAC","sourcesContent":["import { core } from '../core/core.js';\r\nimport { assertConfig } from '../core/assert-param.js';\r\nimport { DataService } from '../metadata/data-service.js';\r\n\r\n/** Configuration info to be passed to the {@link SaveOptions} constructor */\r\nexport interface SaveOptionsConfig {\r\n  /** Resource name to be used during the save - this defaults to \"SaveChanges\" */\r\n  resourceName?: string;\r\n  /** The DataService to be used for this save. */\r\n  dataService?: DataService;\r\n  /** Whether multiple saves can be in-flight at the same time. The default is false. */\r\n  allowConcurrentSaves?: boolean;\r\n  /** Free form value that will be sent to the server during the save. */\r\n  tag?: any;\r\n}\r\n\r\n/**\r\nA SaveOptions instance is used to specify the 'options' under which a save will occur.\r\n*/\r\nexport class SaveOptions {\r\n  /** @hidden @internal */\r\n  declare _$typeName: string; // on proto\r\n  /** Resource name to be used during the save - this defaults to \"SaveChanges\". __Read Only__ */\r\n  declare resourceName: string;\r\n  /** The DataService to be used for this save. __Read Only__ */\r\n  declare dataService: DataService;\r\n  /** Whether multiple saves can be in-flight at the same time. The default is false. __Read Only__ */\r\n  declare allowConcurrentSaves: boolean;\r\n  /** Free form value that will be sent to the server during the save. __Read Only__ */\r\n  declare tag: any;\r\n\r\n  /** The default value whenever SaveOptions are not specified. */\r\n  static defaultInstance = new SaveOptions({ allowConcurrentSaves: false});\r\n\r\n  /** Creates save options from a {@link SaveOptionsConfig}. Passed to {@link EntityManager.saveChanges},\r\n  they are used for that save in place of the manager's {@link EntityManager.saveOptions} - as a\r\n  whole, not merged with them setting by setting.\r\n  ```ts\r\n  const so = new SaveOptions({ allowConcurrentSaves: true });\r\n  em.saveChanges(null, so);\r\n  ```\r\n  */\r\n  constructor(config?: SaveOptionsConfig) {\r\n    SaveOptions._updateWithConfig(this, config);\r\n  }\r\n\r\n\r\n  /**\r\n  Sets the 'defaultInstance' by creating a copy of the current 'defaultInstance' and then applying all of the properties of the current instance.\r\n  The current instance is returned unchanged.\r\n  */\r\n  setAsDefault() {\r\n    return core.setAsDefault(this, SaveOptions);\r\n  }\r\n\r\n  /**\r\n  Returns a copy of this SaveOptions with the specified config options applied.\r\n  ```ts\r\n  var saveOptions = em1.saveOptions.using( {resourceName: \"anotherResource\" });\r\n  ```\r\n  */\r\n  using(config: SaveOptionsConfig) {\r\n    return SaveOptions._updateWithConfig(this, config);\r\n  }\r\n\r\n  /** @hidden @internal */\r\n  private static _updateWithConfig(obj: SaveOptions, config?: SaveOptionsConfig) {\r\n    if (config) {\r\n      assertConfig(config)\r\n          .whereParam(\"resourceName\").isOptional().isString()\r\n          .whereParam(\"dataService\").isOptional().isInstanceOf(DataService)\r\n          .whereParam(\"allowConcurrentSaves\").isBoolean().isOptional()\r\n          .whereParam(\"tag\").isOptional()\r\n          .applyAll(obj);\r\n    }\r\n    return obj;\r\n  }\r\n\r\n}\r\nSaveOptions.prototype._$typeName = \"SaveOptions\";\r\n\r\n\r\n\r\n"]}

package/{src → metadata}/data-service.d.ts

@@ -1,184 +1,229 @@
-import { EntityType, NavigationProperty } from './entity-metadata';
-import { DataServiceAdapter, UriBuilderAdapter } from './interface-registry';
-import { KeyMapping } from './entity-manager';
-import { MappingContext } from './mapping-context';
-/** Configuration info to be passed to the [[DataService]] constructor */
-export interface DataServiceConfig {
-    /** The serviceName for this DataService.  **/
-    serviceName?: string;
-    /** The adapter name for the [[IDataServiceAdapter]] to be used with this service.  **/
-    adapterName?: string;
-    /** The adapter name for the [[IUriBuilderAdapter]] to be used with this service.  **/
-    uriBuilderName?: string;
-    /** Whether the server can provide metadata for this service.  **/
-    hasServerMetadata?: boolean;
-    /** The [[JsonResultsAdapter]] used to process the results of any query against this DataService.  **/
-    jsonResultsAdapter?: JsonResultsAdapter;
-    /** Whether to use JSONP when performing a 'GET' request against this service.  **/
-    useJsonp?: boolean;
-}
-/**
-A DataService instance is used to encapsulate the details of a single 'service'; this includes a serviceName, a dataService adapterInstance,
-and whether the service has server side metadata.
-
-You can construct an EntityManager with either a serviceName or a DataService instance, if you use a serviceName then a DataService
-is constructed for you.  (It can also be set via the EntityManager.setProperties method).
-
-The same applies to the MetadataStore.fetchMetadata method, i.e. it takes either a serviceName or a DataService instance.
-
-Each metadataStore contains a list of DataServices, each accessible via its ‘serviceName’.
-( see MetadataStore.getDataService and MetadataStore.addDataService).  The ‘addDataService’ method is called internally
-anytime a MetadataStore.fetchMetadata call occurs with a new dataService ( or service name).
-
-**/
-export declare class DataService {
-    /** @hidden @internal */
-    _$typeName: string;
-    /** The serviceName for this DataService. __Read Only__ **/
-    serviceName: string;
-    /** The adapter name for the [[IDataServiceAdapter]] to be used with this service. __Read Only__  **/
-    adapterName: string;
-    /**  The [[IDataServiceAdapter]] implementation instance associated with this EntityManager. __Read Only__  **/
-    adapterInstance?: DataServiceAdapter;
-    /** The adapter name for the [[IUriBuilderAdapter]] to be used with this service. __Read Only__  **/
-    uriBuilderName: string;
-    /**  The [[IUriBuilderAdapter]] implementation instance associated with this EntityManager. __Read Only__  **/
-    uriBuilder?: UriBuilderAdapter;
-    /** Whether the server can provide metadata for this service. __Read Only__   **/
-    hasServerMetadata: boolean;
-    /** The [[JsonResultsAdapter]] used to process the results of any query against this DataService. __Read Only__ **/
-    jsonResultsAdapter: JsonResultsAdapter;
-    /** Whether to use JSONP when performing a 'GET' request against this service. __Read Only__  **/
-    useJsonp: boolean;
-    /**   DataService constructor
-    >     var dataService = new DataService({
-    >         serviceName: altServiceName,
-    >         hasServerMetadata: false
-    >     });
-  
-    >     var metadataStore = new MetadataStore({
-    >         namingConvention: NamingConvention.camelCase
-    >     });
-  
-    >     return new EntityManager({
-    >         dataService: dataService,
-    >         metadataStore: metadataStore
-    >     });
-    @param config - A configuration object.
-    **/
-    constructor(config?: DataServiceConfig);
-    /**
-    Returns a copy of this DataService with the specified properties applied.
-    @param config - The configuration object to apply to create a new DataService.
-    **/
-    using(config: DataServiceConfig): DataService;
-    static resolve(dataServices: DataService[]): DataService;
-    /** @hidden @internal */
-    static _normalizeServiceName(serviceName: string): string;
-    /**  */
-    toJSON(): Object;
-    static fromJSON(json: any): DataService;
-    /**
-     Returns a url for this dataService with the specified suffix. This method handles dataService names either
-     with or without trailing '/'s.  If the suffix starts with "http" then it will be returned as-is.
-     @method qualifyUrl
-     @param suffix {String} The resulting url.
-     @return {a Url string}
-     **/
-    qualifyUrl(suffix: string): string;
-}
-export interface NodeMeta {
-    entityType?: EntityType;
-    nodeId?: string;
-    nodeRefId?: string;
-    ignore?: boolean;
-    passThru?: boolean;
-    extraMetadata?: any;
-}
-export interface NodeContext {
-    nodeType: string;
-    propertyName?: string;
-    navigationProperty?: NavigationProperty;
-}
-/** Configuration info to be passed to the [[JsonResultsAdapter]] constructor */
-export interface JsonResultsAdapterConfig {
-    /** The name of this adapter.  This name is used to uniquely identify and locate this instance when an 'exported' JsonResultsAdapter is later imported. */
-    name: string;
-    /** A Function that is called once per query operation to extract the 'payload' from any json received over the wire.
-    This method has a default implementation which to simply return the "results" property from any json returned as a result of executing the query.
-    */
-    extractResults?: Function;
-    /** A function that is called once per save operation to extract the entities from any json received over the wire.  Must return an array.
-    This method has a default implementation which simply returns the "entities" property from any json returned as a result of executing the save. */
-    extractSaveResults?: Function;
-    /** A function that is called once per save operation to extract the key mappings from any json received over the wire.  Must return an array.
-    This method has a default implementation which simply returns the "keyMappings" property from any json returned as a result of executing the save. */
-    extractKeyMappings?: (data: {}) => KeyMapping[];
-    /** A function that is called once per save operation to extract any deleted keys from any json received over the wire.  Must return an array.
-    This method has a default implementation which simply returns an empty array. */
-    extractDeletedKeys?: (data: {}) => any[];
-    /** A visitor method that will be called on each node of the returned payload. */
-    visitNode?: (v: any, mc?: MappingContext, nodeContext?: NodeContext) => NodeMeta;
-}
-/**
-A JsonResultsAdapter instance is used to provide custom extraction and parsing logic on the json results returned by any web service.
-This facility makes it possible for breeze to talk to virtually any web service and return objects that will be first class 'breeze' citizens.
-**/
-export declare class JsonResultsAdapter {
-    /** @hidden @internal */
-    _$typeName: string;
-    /** The name of this adapter.  This name is used to uniquely identify and locate this instance when an 'exported' JsonResultsAdapter is later imported. */
-    name: string;
-    /** A Function that is called once per query operation to extract the 'payload' from any json received over the wire.
-    This method has a default implementation which simply returns the "results" property from any json returned as a result of executing the query. */
-    extractResults: Function;
-    /** A function that is called once per save operation to extract the entities from any json received over the wire.  Must return an array.
-    This method has a default implementation which simply returns the "entities" property from any json returned as a result of executing the save. */
-    extractSaveResults: Function;
-    /** A function that is called once per save operation to extract the key mappings from any json received over the wire.  Must return an array.
-  This method has a default implementation which simply returns the "keyMappings" property from any json returned as a result of executing the save. */
-    extractKeyMappings: (data: {}) => KeyMapping[];
-    /** A function that is called once per save operation to extract any deleted keys from any json received over the wire.  Must return an array.
-    This method has a default implementation which is to simply returns the "deletedKeys" property from any json returned as a result of executing the save. */
-    extractDeletedKeys?: (data: {}) => any[];
-    /** A visitor method that will be called on each node of the returned payload. */
-    visitNode: Function;
-    /**
-    JsonResultsAdapter constructor
-  
-    @example
-        //
-        var jsonResultsAdapter = new JsonResultsAdapter({
-            name: "test1e",
-            extractResults: function(json) {
-                return json.results;
-            },
-            visitNode: function(node, mappingContext, nodeContext) {
-                var entityType = normalizeTypeName(node.$type);
-                var propertyName = nodeContext.propertyName;
-                var ignore = propertyName && propertyName.substr(0, 1) === "$";
-  
-                return {
-                    entityType: entityType,
-                    nodeId: node.$id,
-                    nodeRefId: node.$ref,
-                    ignore: ignore,
-                    passThru: false // default
-                };
-            }
-        });
-  
-        var dataService = new DataService( {
-                serviceName: "breeze/foo",
-                jsonResultsAdapter: jsonResultsAdapter
-        });
-  
-        var entityManager = new EntityManager( {
-            dataService: dataService
-        });
-  
-    @param config - A configuration object.
-  
-    **/
-    constructor(jsConfig: JsonResultsAdapterConfig);
-}
+import { EntityType, NavigationProperty } from './entity-metadata.js';
+import { DataServiceAdapter, UriBuilderAdapter } from '../config/interface-registry.js';
+import { KeyMapping } from '../manager/entity-manager.js';
+import { MappingContext } from '../query/mapping-context.js';
+/** Configuration info to be passed to the {@link DataService} constructor */
+export interface DataServiceConfig {
+    /** The serviceName for this DataService.  */
+    serviceName?: string;
+    /** The adapter name for the {@link DataServiceAdapter} to be used with this service.  */
+    adapterName?: string;
+    /** The adapter name for the {@link UriBuilderAdapter} to be used with this service.  */
+    uriBuilderName?: string;
+    /** Whether the server can provide metadata for this service.  */
+    hasServerMetadata?: boolean;
+    /** The {@link JsonResultsAdapter} used to process the results of any query against this DataService.  */
+    jsonResultsAdapter?: JsonResultsAdapter;
+    /** Whether to use JSONP when performing a 'GET' request against this service.
+    @deprecated No effect on Breeze's own transport, which has no JSONP support. Kept because it is
+    part of a serialized DataService, and because a registered (deprecated) ajax adapter can still
+    act on the dataType and crossDomain settings it produces. */
+    useJsonp?: boolean;
+}
+/**
+A DataService instance is used to encapsulate the details of a single 'service'; this includes a serviceName, a dataService adapterInstance,
+and whether the service has server side metadata.
+
+You can construct an EntityManager with either a serviceName or a DataService instance, if you use a serviceName then a DataService
+is constructed for you.  (It can also be set via the EntityManager.setProperties method).
+
+The same applies to the MetadataStore.fetchMetadata method, i.e. it takes either a serviceName or a DataService instance.
+
+Each metadataStore contains a list of DataServices, each accessible via its ‘serviceName’.
+( see MetadataStore.getDataService and MetadataStore.addDataService).  The ‘addDataService’ method is called internally
+anytime a MetadataStore.fetchMetadata call occurs with a new dataService ( or service name).
+
+*/
+export declare class DataService {
+    /** The serviceName for this DataService. __Read Only__ */
+    serviceName: string;
+    /** The adapter name for the {@link DataServiceAdapter} to be used with this service. __Read Only__  */
+    adapterName: string;
+    /**  The {@link DataServiceAdapter} implementation instance associated with this EntityManager. __Read Only__  */
+    adapterInstance?: DataServiceAdapter;
+    /** The adapter name for the {@link UriBuilderAdapter} to be used with this service. __Read Only__  */
+    uriBuilderName: string;
+    /**  The {@link UriBuilderAdapter} implementation instance associated with this EntityManager. __Read Only__  */
+    uriBuilder?: UriBuilderAdapter;
+    /** Whether the server can provide metadata for this service. __Read Only__   */
+    hasServerMetadata: boolean;
+    /** The {@link JsonResultsAdapter} used to process the results of any query against this DataService. __Read Only__ */
+    jsonResultsAdapter: JsonResultsAdapter;
+    /** Whether to use JSONP when performing a 'GET' request against this service. __Read Only__
+    @deprecated No effect on Breeze's own transport, which has no JSONP support. Kept because it is
+    part of a serialized DataService, and because a registered (deprecated) ajax adapter can still
+    act on the dataType and crossDomain settings it produces. */
+    useJsonp: boolean;
+    /**   DataService constructor
+    ```ts
+    var dataService = new DataService({
+        serviceName: altServiceName,
+        hasServerMetadata: false
+    });
+    ```
+  
+    ```ts
+    var metadataStore = new MetadataStore({
+        namingConvention: NamingConvention.camelCase
+    });
+    ```
+  
+    ```ts
+    return new EntityManager({
+        dataService: dataService,
+        metadataStore: metadataStore
+    });
+    ```
+    @param config - A configuration object.
+    */
+    constructor(config?: DataServiceConfig);
+    /**
+    Returns a copy of this DataService with the specified properties applied.
+    @param config - The configuration object to apply to create a new DataService.
+    */
+    using(config: DataServiceConfig): DataService;
+    /**
+    Combines several DataServices into one, taking each property from the first of them that has it
+    set, and filling in the adapters: the named ones, or the defaults. Breeze uses it to combine a
+    query's or save's own DataService with the EntityManager's before each request; applications do
+    not normally need it.
+    @param dataServices - The DataServices to combine, most specific first. Entries may be null or
+    undefined. The array is modified.
+    @throws if none of them has a `serviceName`.
+    */
+    static resolve(dataServices: DataService[]): DataService;
+    /**
+    Returns the serializable form of this DataService: `serviceName`, `adapterName`,
+    `uriBuilderName`, `hasServerMetadata`, `useJsonp` and the `name` of its `jsonResultsAdapter`,
+    leaving out any that are not set. `JSON.stringify` calls it when `MetadataStore.exportMetadata`
+    and `EntityManager.exportEntities` serialize their DataServices; {@link DataService.fromJSON}
+    reads it back.
+    */
+    toJSON(): Object;
+    /**
+    Creates a DataService from the output of {@link DataService.toJSON}. Used when importing metadata
+    and exported entities. The `jsonResultsAdapter` name is looked up among the
+    {@link JsonResultsAdapter}s created so far, so create a custom one before importing.
+    @param json - A serialized DataService. Its `jsonResultsAdapter` property is replaced.
+    @throws if the named `jsonResultsAdapter` does not exist.
+    */
+    static fromJSON(json: any): DataService;
+    /**
+     Returns a url for this dataService with the specified suffix. This method handles dataService names either
+     with or without trailing '/'s.  If the suffix starts with "http" then it will be returned as-is.
+     @param suffix {String} The resulting url.
+     @returns {a Url string}
+     */
+    qualifyUrl(suffix: string): string;
+}
+/**
+What a {@link JsonResultsAdapter}'s `visitNode` returns for one node of a query or save result,
+telling Breeze how to treat it. Every property is optional; returning `{}` (or nothing) treats the
+node as plain data.
+*/
+export interface NodeMeta {
+    /** The type of entity or complex object this node is, or its name. When set, Breeze materializes the node as an entity of that type and merges it into the cache (unless the query is `noTracking`); a complex type is mapped without merging. For a top-level query result with no type, Breeze uses the query's result type. */
+    entityType?: EntityType;
+    /** An id for this node, such as a Json.NET `$id`, that other nodes can refer to with `nodeRefId`. */
+    nodeId?: string;
+    /** The `nodeId` of another node that this node stands for, such as a Json.NET `$ref`. Breeze returns the entity or object read from that node in its place. */
+    nodeRefId?: string;
+    /** Whether to skip this node. A skipped property is left off the object that holds it; a skipped top-level node is dropped from the results (or is `null` there, when the query includes deleted entities). */
+    ignore?: boolean;
+    /** Whether to keep the node exactly as the server sent it, without mapping its property names to the client's or visiting what it contains. Ignored for a top-level node that has an `entityType`, which is merged as an entity. */
+    passThru?: boolean;
+    /** Anything else about the node to keep. Breeze stores it on the entity's `entityAspect.extraMetadata`. */
+    extraMetadata?: any;
+    /** Use this object in place of the node that was visited. */
+    node?: any;
+}
+/** Where a node passed to a {@link JsonResultsAdapter}'s `visitNode` sits in the result. */
+export interface NodeContext {
+    /** `"root"` for a top-level result, `"navProp"` or `"navPropItem"` for the value or an item of a navigation property, and `"anonProp"` or `"anonPropItem"` for the value or an item of a property of a plain (non-entity) object. */
+    nodeType: string;
+    /** For an `"anonProp"` or `"anonPropItem"` node, the client name of the property that holds it. */
+    propertyName?: string;
+    /** For a `"navProp"` or `"navPropItem"` node, the navigation property that holds it. */
+    navigationProperty?: NavigationProperty;
+}
+/** Configuration info to be passed to the {@link JsonResultsAdapter} constructor */
+export interface JsonResultsAdapterConfig {
+    /** The name of this adapter.  This name is used to uniquely identify and locate this instance when an 'exported' JsonResultsAdapter is later imported. */
+    name: string;
+    /** A Function that is called once per query operation to extract the 'payload' from any json received over the wire.
+    This method has a default implementation which to simply return the "results" property from any json returned as a result of executing the query.
+    */
+    extractResults?: Function;
+    /** A function that is called once per save operation to extract the entities from any json received over the wire.  Must return an array.
+    This method has a default implementation which simply returns the "entities" property from any json returned as a result of executing the save. */
+    extractSaveResults?: Function;
+    /** A function that is called once per save operation to extract the key mappings from any json received over the wire.  Must return an array.
+    This method has a default implementation which simply returns the "keyMappings" property from any json returned as a result of executing the save. */
+    extractKeyMappings?: (data: {}) => KeyMapping[];
+    /** A function that is called once per save operation to extract any deleted keys from any json received over the wire.  Must return an array.
+    This method has a default implementation which simply returns an empty array. */
+    extractDeletedKeys?: (data: {}) => any[];
+    /** A visitor method that will be called on each node of the returned payload. Required.
+    Breeze always passes all three arguments. Returning nothing is the same as returning `{}`. */
+    visitNode: (node: any, mappingContext: MappingContext, nodeContext: NodeContext) => NodeMeta | null | void;
+}
+/**
+A JsonResultsAdapter instance is used to provide custom extraction and parsing logic on the json results returned by any web service.
+This facility makes it possible for breeze to talk to virtually any web service and return objects that will be first class 'breeze' citizens.
+*/
+export declare class JsonResultsAdapter {
+    /** The name of this adapter.  This name is used to uniquely identify and locate this instance when an 'exported' JsonResultsAdapter is later imported. */
+    name: string;
+    /** A Function that is called once per query operation to extract the 'payload' from any json received over the wire.
+    This method has a default implementation which simply returns the "results" property from any json returned as a result of executing the query. */
+    extractResults: Function;
+    /** A function that is called once per save operation to extract the entities from any json received over the wire.  Must return an array.
+    This method has a default implementation which simply returns the "entities" property from any json returned as a result of executing the save. */
+    extractSaveResults: Function;
+    /** A function that is called once per save operation to extract the key mappings from any json received over the wire.  Must return an array.
+  This method has a default implementation which simply returns the "keyMappings" property from any json returned as a result of executing the save. */
+    extractKeyMappings: (data: {}) => KeyMapping[];
+    /** A function that is called once per save operation to extract any deleted keys from any json received over the wire.  Must return an array.
+    This method has a default implementation which is to simply returns the "deletedKeys" property from any json returned as a result of executing the save. */
+    extractDeletedKeys?: (data: {}) => any[];
+    /** A visitor method that will be called on each node of the returned payload. */
+    visitNode: Function;
+    /**
+    JsonResultsAdapter constructor
+  
+    @example
+        //
+        var jsonResultsAdapter = new JsonResultsAdapter({
+            name: "test1e",
+            extractResults: function(json) {
+                return json.results;
+            },
+            visitNode: function(node, mappingContext, nodeContext) {
+                var entityType = normalizeTypeName(node.$type);
+                var propertyName = nodeContext.propertyName;
+                var ignore = propertyName && propertyName.substr(0, 1) === "$";
+  
+                return {
+                    entityType: entityType,
+                    nodeId: node.$id,
+                    nodeRefId: node.$ref,
+                    ignore: ignore,
+                    passThru: false // default
+                };
+            }
+        });
+  
+        var dataService = new DataService( {
+                serviceName: "breeze/foo",
+                jsonResultsAdapter: jsonResultsAdapter
+        });
+  
+        var entityManager = new EntityManager( {
+            dataService: dataService
+        });
+  
+    @param jsConfig - A configuration object.
+  
+    */
+    constructor(jsConfig: JsonResultsAdapterConfig);
+}