breeze-client 2.2.2 → 3.0.0

package/adapters/abstract-data-service-adapter.js

@@ -0,0 +1,395 @@
+import { core } from '../core/core.js';
+import { config } from '../config/config.js';
+import { builtinAjax } from './http.js';
+import { JsonResultsAdapter } from '../metadata/data-service.js';
+import { EntityType, MetadataStore } from '../metadata/entity-metadata.js';
+/** For use by breeze plugin authors only.  The class is used as the base class for most {@link DataServiceAdapter} implementations
+@adapter (see {@link DataServiceAdapter})
+@hidden
+*/
+export class AbstractDataServiceAdapter {
+    // TODO use interface
+    checkForRecomposition(interfaceInitializedArgs) {
+        if (interfaceInitializedArgs.interfaceName === "ajax" && interfaceInitializedArgs.isDefault) {
+            this.initialize();
+        }
+    }
+    initialize() {
+        // An ajax adapter is optional. A registered one (deprecated) is used if there is one;
+        // otherwise requests go through config.fetch, which defaults to globalThis.fetch. This
+        // is also why registration order no longer matters: there is nothing to resolve.
+        this.ajaxImpl = config.getAdapterInstance("ajax") || builtinAjax;
+    }
+    /**
+     * Sends one request. Resolves with the response, or rejects with a `ServerError`.
+     *
+     * Subclasses should make their requests through this method rather than through
+     * `ajaxImpl`, whose callback-shaped contract is kept only for compatibility. This is the
+     * only place in the class that deals in success/error callbacks.
+     */
+    _ajax(config, errorMessagePrefix, prepareResponse) {
+        return new Promise((resolve, reject) => {
+            this.ajaxImpl.ajax({
+                ...config,
+                // Each callback is guarded: a throw inside one would otherwise escape into the ajax
+                // adapter and leave this promise pending for ever.
+                success: (httpResponse) => {
+                    try {
+                        prepareResponse && prepareResponse(httpResponse);
+                        resolve(httpResponse);
+                    }
+                    catch (e) {
+                        reject(e);
+                    }
+                },
+                error: (httpResponse) => {
+                    try {
+                        // must run before makeHttpError: createError reads httpResponse.saveContext
+                        // to attach per-entity validation errors.
+                        prepareResponse && prepareResponse(httpResponse);
+                        reject(AbstractDataServiceAdapter.makeHttpError(httpResponse, errorMessagePrefix));
+                    }
+                    catch (e) {
+                        reject(e);
+                    }
+                },
+            });
+        });
+    }
+    async fetchMetadata(metadataStore, dataService) {
+        const serviceName = dataService.serviceName;
+        const url = dataService.qualifyUrl("Metadata");
+        const httpResponse = await this._ajax({ type: "GET", url: url, dataType: 'json' }, "Metadata query failed for: " + url);
+        // might have been fetched by another query
+        if (metadataStore.hasMetadataFor(serviceName)) {
+            return "already fetched";
+        }
+        const data = httpResponse.data;
+        let metadata;
+        try {
+            metadata = typeof (data) === "string" ? JSON.parse(data) : data;
+            metadataStore.importMetadata(metadata);
+        }
+        catch (e) {
+            const errMsg = "Unable to either parse or import metadata: " + e.message;
+            throw AbstractDataServiceAdapter.makeHttpError(httpResponse, "Metadata query failed for: " + url + ". " + errMsg);
+        }
+        // import may have brought in the service.
+        if (!metadataStore.hasMetadataFor(serviceName)) {
+            metadataStore.addDataService(dataService);
+        }
+        return metadata;
+    }
+    /** Execute the query in the mappingContext. */
+    async executeQuery(mappingContext) {
+        mappingContext.adapter = this;
+        const usePost = mappingContext.query.usePostEnabled;
+        const params = usePost ? this._makeQueryPostParams(mappingContext) : this._makeQueryGetParams(mappingContext);
+        const httpResponse = await this._ajax(params);
+        const data = httpResponse.data;
+        try {
+            const results = data && (data.results || data.Results);
+            if (results) {
+                return {
+                    results: results,
+                    inlineCount: data.inlineCount || data.InlineCount,
+                    httpResponse: httpResponse,
+                    query: mappingContext.query
+                };
+            }
+            return { results: data, httpResponse: httpResponse, query: mappingContext.query };
+        }
+        catch (e) {
+            if (e instanceof Error) {
+                throw e;
+            }
+            throw AbstractDataServiceAdapter.makeHttpError(httpResponse);
+        }
+    }
+    /** Set up ajax parameters for query GET.  This puts the query into the request querystring, in whatever syntax the UriBuilder produces. */
+    _makeQueryGetParams(mappingContext) {
+        const url = mappingContext.getUrl();
+        const params = {
+            type: "GET",
+            url: url,
+            params: mappingContext.query.parameters,
+            dataType: 'json',
+            crossDomain: false,
+        };
+        // useJsonp is deprecated. Breeze's own transport ignores dataType and crossDomain; this
+        // stays only because a registered (deprecated) ajax adapter could still act on them.
+        if (mappingContext.dataService.useJsonp) {
+            params.dataType = 'jsonp';
+            params.crossDomain = true;
+        }
+        return params;
+    }
+    /** Set up ajax parameters for query POST.  This put the query into the request body as JSON. */
+    _makeQueryPostParams(mappingContext) {
+        const entityQuery = mappingContext.query;
+        const metadataStore = mappingContext.entityManager.metadataStore;
+        const url = mappingContext.dataService.qualifyUrl(entityQuery.resourceName);
+        let entityType = entityQuery._getFromEntityType(metadataStore, false);
+        if (!entityType) {
+            entityType = new EntityType(metadataStore);
+        }
+        const json = entityQuery.toJSONExt({ entityType: entityType, toNameOnServer: true });
+        json.from = undefined;
+        json.queryOptions = undefined;
+        // withParameters values go in the query string (params, below), as for a GET.
+        json.parameters = undefined;
+        const params = {
+            type: "POST",
+            url: url,
+            params: mappingContext.query.parameters,
+            dataType: 'json',
+            processData: false, // don't form-encode the body
+            contentType: "application/json; charset=UTF-8",
+            data: JSON.stringify(json),
+            crossDomain: false,
+        };
+        return params;
+    }
+    async saveChanges(saveContext, saveBundle) {
+        let adapter = saveContext.adapter = this;
+        let saveBundleSer = adapter._prepareSaveBundle(saveContext, saveBundle);
+        let bundle = JSON.stringify(saveBundleSer);
+        const url = saveContext.dataService.qualifyUrl(saveContext.resourceName);
+        // saveContext must be on the response before any error is built from it
+        const httpResponse = await this._ajax({
+            type: "POST",
+            url: url,
+            dataType: 'json',
+            contentType: "application/json",
+            data: bundle,
+        }, undefined, (r) => { r.saveContext = saveContext; });
+        const data = httpResponse.data;
+        if (data == null || data === "") {
+            const err = AbstractDataServiceAdapter.makeHttpError(httpResponse);
+            err.message = "The response to the save request to " + url + " (HTTP status " + httpResponse.status +
+                ") had no body. Breeze needs the saved entities and any key mappings to complete the save.";
+            throw err;
+        }
+        if (data.Errors || data.errors) {
+            throw AbstractDataServiceAdapter.makeHttpError(httpResponse);
+        }
+        const saveResult = adapter._prepareSaveResult(saveContext, data);
+        saveResult.httpResponse = httpResponse;
+        return saveResult;
+    }
+    /** Abstract method that needs to be overwritten in any concrete DataServiceAdapter subclass.
+    The return value from this method should be a serializable object that will be sent to the server after calling JSON.stringify on it.
+    */
+    _prepareSaveBundle(saveContext, saveBundle) {
+        // The implementor should call _createChangeRequestInterceptor
+        throw new Error("Need a concrete implementation of _prepareSaveBundle");
+    }
+    /**
+    Returns a constructor function for a "ChangeRequestInterceptor"
+    that can tweak the saveBundle both as it is built and when it is completed
+    by a concrete DataServiceAdapater.
+  
+    Initialized with a default, no-op implementation that developers can replace with a
+    substantive implementation that changes the individual entity change requests
+    or aspects of the entire 'saveBundle' without having to write their own DataService adapters.
+    ```ts
+    let adapter = breeze.config.getAdapterInstance('dataService');
+    adapter.changeRequestInterceptor = function (saveContext, saveBundle) {
+        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;
+       };
+       this.done = function (requests) {
+           // alter the array of requests representing the entire change-set
+           // based on the saveContext and saveBundle
+       };
+    }
+    ```
+  
+    @param saveContext - The BreezeJS "context" for the save operation.
+    @param saveBundle - Contains the array of entities-to-be-saved (AKA, the entity change-set).
+    @returns Constructor for a "ChangeRequestInterceptor".
+    */
+    changeRequestInterceptor = DefaultChangeRequestInterceptor;
+    /**
+     * Creates the change request interceptor for one save, from `changeRequestInterceptor`.
+     * Call it at the start of `_prepareSaveBundle`, pass each entity's request through its
+     * `getRequest`, and pass the finished array to its `done`.
+     *
+     * Falls back to a no-op interceptor when `changeRequestInterceptor` is not set. If the
+     * interceptor it creates has `oneTime` set, the adapter goes back to the no-op
+     * interceptor afterwards, so only this save is intercepted.
+     * @throws if the interceptor has no `getRequest` or `done` method.
+     */
+    _createChangeRequestInterceptor(saveContext, saveBundle) {
+        let adapter = saveContext.adapter;
+        let cri = adapter.changeRequestInterceptor;
+        let isFn = core.isFunction;
+        if (isFn(cri)) {
+            let pre = adapter.name + " DataServiceAdapter's ChangeRequestInterceptor";
+            let post = " is missing or not a function.";
+            let interceptor = new cri(saveContext, saveBundle);
+            if (!isFn(interceptor.getRequest)) {
+                throw new Error(pre + '.getRequest' + post);
+            }
+            if (!isFn(interceptor.done)) {
+                throw new Error(pre + '.done' + post);
+            }
+            if (interceptor.oneTime) {
+                adapter.changeRequestInterceptor = DefaultChangeRequestInterceptor;
+            }
+            return interceptor;
+        }
+        else {
+            return new DefaultChangeRequestInterceptor(saveContext, saveBundle);
+        }
+    }
+    /** Abstract method that needs to be overwritten in any concrete DataServiceAdapter sublclass.
+    This method needs to take the result returned the server and convert it into an ISaveResult.
+    */
+    _prepareSaveResult(saveContext, data) {
+        throw new Error("Need a concrete implementation of _prepareSaveResult");
+    }
+    /** Utility method that may be used in any concrete DataServiceAdapter sublclass to handle any
+    http connection issues. For an error with status 0 - the request got no response - it says in
+    the message that the server could not be reached, keeping any message the transport gave.
+    An aborted request is left alone. `makeHttpError` already applies it.
+    */
+    // Put this at the bottom of your http error analysis
+    static _catchNoConnectionError(err) {
+        if (err.status !== 0)
+            return;
+        const cause = err.httpResponse && err.httpResponse.error;
+        if (cause && cause.name === "AbortError")
+            return; // the app cancelled it; the server is irrelevant
+        const hint = "Likely did not or could not reach server. Is the server running?";
+        if (err.message && err.message.includes(hint))
+            return; // already applied
+        err.message = err.message
+            ? "HTTP response status 0: " + err.message + ". " + hint
+            : "HTTP response status 0 and no message.  " + hint;
+    }
+    /**
+     * Builds the Breeze error for a failed HTTP response: an `Error` carrying `status`,
+     * `statusText`, `url`, `body` and `httpResponse`, whose message comes from the response
+     * body (a .NET exception, or `{ message, errors }`). For a save, it also carries the
+     * server's per-entity `entityErrors`, if `httpResponse.saveContext` is set.
+     *
+     * `_ajax` uses it for every failed request. Call it when your adapter makes a request some
+     * other way, then throw or reject with the result.
+     * @param httpResponse - The failed response.
+     * @param messagePrefix - Put at the start of the message, followed by "; ".
+     */
+    static makeHttpError(httpResponse, messagePrefix) {
+        const err = createError(httpResponse);
+        AbstractDataServiceAdapter._catchNoConnectionError(err);
+        if (messagePrefix) {
+            err.message = messagePrefix + "; " + err.message;
+        }
+        return err;
+    }
+    jsonResultsAdapter = new JsonResultsAdapter({
+        name: "noop",
+        visitNode: function ( /* node, mappingContext, nodeContext */) {
+            return {};
+        }
+    });
+}
+function createError(httpResponse) {
+    let err = new Error();
+    err.httpResponse = httpResponse;
+    err.status = httpResponse.status;
+    err.statusText = httpResponse.statusText;
+    err.body = httpResponse.data;
+    err.url = httpResponse.config && httpResponse.config.url;
+    let errObj = httpResponse.data;
+    if (!errObj) {
+        err.message = httpResponse.error && httpResponse.error.toString();
+        return err;
+    }
+    // some ajax providers convert an errant result into an object, others do not
+    // if not do it here.
+    if (typeof errObj === "string") {
+        try {
+            errObj = JSON.parse(errObj);
+        }
+        catch (e) {
+            // sometimes httpResponse.data is just the error message itself
+            err.message = errObj;
+            return err;
+        }
+    }
+    // The RFC 9457 `type` member, taken before the branch below because it is spelled the same
+    // whichever shape the rest of the document has: a Breeze server sends it alongside the
+    // capitalised pre-3.0 members as well as instead of them. This is what lets a caller tell a
+    // concurrency conflict from a duplicate key, which share a status code.
+    if (typeof errObj.type === "string")
+        err.problemType = errObj.type;
+    let saveContext = httpResponse.saveContext;
+    // if any of the follow properties exist the source is .NET
+    let tmp = errObj.Message || errObj.ExceptionMessage || errObj.EntityErrors || errObj.Errors;
+    let isDotNet = !!tmp;
+    let message, entityErrors;
+    if (!isDotNet) {
+        // RFC 9457 (Problem Details for HTTP APIs) calls the human-readable text `detail`, with
+        // `title` as the shorter summary of the problem *type*. A server that sends problem+json and
+        // nothing else would otherwise fall through to the generic message at the end of this
+        // function, which says entity errors were encountered whether or not any were - a confidently
+        // wrong message is harder to diagnose than a missing one.
+        message = errObj.message || errObj.detail || errObj.title;
+        // `entityErrors` is a Breeze extension member; RFC 9457 section 3.2 allows those, and the
+        // spec requires consumers to ignore members they do not recognize.
+        entityErrors = errObj.errors || errObj.entityErrors;
+        // Normalize the same way the .NET branch does. Without this a server sending the natural
+        // "Namespace.Type" spelling gets "Unable to locate a 'Type' by the name ..." from the entity
+        // lookup in processServerErrors, with nothing to connect it to the error format.
+        entityErrors = entityErrors && entityErrors.map(function (e) {
+            return e.entityTypeName
+                ? { ...e, entityTypeName: MetadataStore.normalizeTypeName(e.entityTypeName) }
+                : e;
+        });
+    }
+    else {
+        let tmp = errObj;
+        do {
+            // .NET exceptions can provide both ExceptionMessage and Message but ExceptionMethod if it
+            // exists has a more detailed message.
+            message = tmp.ExceptionMessage || tmp.Message;
+            tmp = tmp.InnerException;
+        } while (tmp);
+        // .EntityErrors will only occur as a result of an EntityErrorsException being deliberately thrown on the server
+        entityErrors = errObj.Errors || errObj.EntityErrors;
+        entityErrors = entityErrors && entityErrors.map(function (e) {
+            return {
+                errorName: e.ErrorName,
+                entityTypeName: MetadataStore.normalizeTypeName(e.EntityTypeName),
+                keyValues: e.KeyValues,
+                propertyName: e.PropertyName,
+                errorMessage: e.ErrorMessage,
+                custom: e.Custom
+            };
+        });
+    }
+    if (saveContext && entityErrors) {
+        let propNameFn = saveContext.entityManager.metadataStore.namingConvention.serverPropertyNameToClient;
+        entityErrors.forEach(function (e) {
+            e.propertyName = e.propertyName && propNameFn(e.propertyName);
+        });
+        err.entityErrors = entityErrors;
+    }
+    err.message = message || "Server side errors encountered - see the entityErrors collection on this object for more detail";
+    return err;
+}
+/** This is a default, no-op implementation that developers can replace. */
+class DefaultChangeRequestInterceptor {
+    constructor(saveContext, saveBundle) {
+    }
+    getRequest(request, entity, index) {
+        return request;
+    }
+    done(requests) {
+    }
+}
+//# sourceMappingURL=abstract-data-service-adapter.js.map

package/adapters/abstract-data-service-adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-data-service-adapter.js","sourceRoot":"","sources":["../../src/adapters/abstract-data-service-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAKxC,OAAO,EAAe,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAE9E,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAE3E;;;EAGE;AACF,MAAM,OAAgB,0BAA0B;IAa9C,qBAAqB;IACrB,qBAAqB,CAAC,wBAA6B;QACjD,IAAI,wBAAwB,CAAC,aAAa,KAAK,MAAM,IAAI,wBAAwB,CAAC,SAAS,EAAE,CAAC;YAC5F,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,CAAC;IACH,CAAC;IAED,UAAU;QACR,sFAAsF;QACtF,uFAAuF;QACvF,iFAAiF;QACjF,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,kBAAkB,CAAc,MAAM,CAAC,IAAI,WAAW,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CACX,MAA6C,EAC7C,kBAA2B,EAC3B,eAAsD;QACxD,OAAO,IAAI,OAAO,CAAe,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACjB,GAAG,MAAM;gBACT,oFAAoF;gBACpF,mDAAmD;gBACnD,OAAO,EAAE,CAAC,YAA0B,EAAE,EAAE;oBACtC,IAAI,CAAC;wBACH,eAAe,IAAI,eAAe,CAAC,YAAY,CAAC,CAAC;wBACjD,OAAO,CAAC,YAAY,CAAC,CAAC;oBACxB,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,MAAM,CAAC,CAAC,CAAC,CAAC;oBACZ,CAAC;gBACH,CAAC;gBACD,KAAK,EAAE,CAAC,YAA0B,EAAE,EAAE;oBACpC,IAAI,CAAC;wBACH,4EAA4E;wBAC5E,0CAA0C;wBAC1C,eAAe,IAAI,eAAe,CAAC,YAAY,CAAC,CAAC;wBACjD,MAAM,CAAC,0BAA0B,CAAC,aAAa,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC,CAAC;oBACrF,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,MAAM,CAAC,CAAC,CAAC,CAAC;oBACZ,CAAC;gBACH,CAAC;aACY,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,aAA4B,EAAE,WAAwB;QACxE,MAAM,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC;QAC5C,MAAM,GAAG,GAAG,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAE/C,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK,CACnC,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,EAC3C,6BAA6B,GAAG,GAAG,CAAC,CAAC;QAEvC,2CAA2C;QAC3C,IAAI,aAAa,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,CAAC;YAC9C,OAAO,iBAAiB,CAAC;QAC3B,CAAC;QAED,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;QAC/B,IAAI,QAAa,CAAC;QAClB,IAAI,CAAC;YACH,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAChE,aAAa,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,MAAM,GAAG,6CAA6C,GAAI,CAAW,CAAC,OAAO,CAAC;YACpF,MAAM,0BAA0B,CAAC,aAAa,CAAC,YAAY,EAAE,6BAA6B,GAAG,GAAG,GAAG,IAAI,GAAG,MAAM,CAAC,CAAC;QACpH,CAAC;QAED,0CAA0C;QAC1C,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/C,aAAa,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAC5C,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,+CAA+C;IAC/C,KAAK,CAAC,YAAY,CAAC,cAA8B;QAC/C,cAAc,CAAC,OAAO,GAAG,IAAI,CAAC;QAE9B,MAAM,OAAO,GAAI,cAAc,CAAC,KAAqB,CAAC,cAAc,CAAC;QACrE,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAQ,CAAC;QAErH,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAE9C,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;QAC/B,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;YACvD,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO;oBACL,OAAO,EAAE,OAAO;oBAChB,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW;oBACjD,YAAY,EAAE,YAAY;oBAC1B,KAAK,EAAE,cAAc,CAAC,KAAK;iBACb,CAAC;YACnB,CAAC;YACD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,cAAc,CAAC,KAAK,EAAiB,CAAC;QACnG,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;gBAAC,MAAM,CAAC,CAAC;YAAC,CAAC;YACpC,MAAM,0BAA0B,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAED,2IAA2I;IAC3I,mBAAmB,CAAC,cAA8B;QAChD,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC;QAEpC,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,KAAK;YACX,GAAG,EAAE,GAAG;YACR,MAAM,EAAG,cAAc,CAAC,KAAqB,CAAC,UAAU;YACxD,QAAQ,EAAE,MAAM;YAChB,WAAW,EAAE,KAAK;SACnB,CAAC;QACF,wFAAwF;QACxF,qFAAqF;QACrF,IAAI,cAAc,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;YACxC,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC;YAC1B,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;QAC5B,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,gGAAgG;IAChG,oBAAoB,CAAC,cAA8B;QACjD,MAAM,WAAW,GAAG,cAAc,CAAC,KAAoB,CAAC;QACxD,MAAM,aAAa,GAAG,cAAc,CAAC,aAAa,CAAC,aAAa,CAAC;QACjE,MAAM,GAAG,GAAG,cAAc,CAAC,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,YAAa,CAAC,CAAC;QAE7E,IAAI,UAAU,GAAG,WAAW,CAAC,kBAAkB,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QACtE,IAAI,CAAC,UAAU,EAAE,CAAC;YAAC,UAAU,GAAG,IAAI,UAAU,CAAC,aAAa,CAAC,CAAC;QAAC,CAAC;QAChE,MAAM,IAAI,GAAG,WAAW,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,EAAE,IAAI,EAAC,CAAQ,CAAC;QAC3F,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;QAC9B,8EAA8E;QAC9E,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,MAAM;YACZ,GAAG,EAAE,GAAG;YACR,MAAM,EAAG,cAAc,CAAC,KAAqB,CAAC,UAAU;YACxD,QAAQ,EAAE,MAAM;YAChB,WAAW,EAAE,KAAK,EAAE,6BAA6B;YACjD,WAAW,EAAE,iCAAiC;YAC9C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAC1B,WAAW,EAAE,KAAK;SACnB,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,WAAwB,EAAE,UAAsB;QAChE,IAAI,OAAO,GAAG,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC;QAEzC,IAAI,aAAa,GAAG,OAAO,CAAC,kBAAkB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QACxE,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAE3C,MAAM,GAAG,GAAG,WAAW,CAAC,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAEzE,wEAAwE;QACxE,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK,CACnC;YACE,IAAI,EAAE,MAAM;YACZ,GAAG,EAAE,GAAG;YACR,QAAQ,EAAE,MAAM;YAChB,WAAW,EAAE,kBAAkB;YAC/B,IAAI,EAAE,MAAM;SACb,EACD,SAAS,EACT,CAAC,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,WAAW,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3C,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;QAC/B,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;YAChC,MAAM,GAAG,GAAG,0BAA0B,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;YACnE,GAAG,CAAC,OAAO,GAAG,sCAAsC,GAAG,GAAG,GAAG,gBAAgB,GAAG,YAAY,CAAC,MAAM;gBACjG,2FAA2F,CAAC;YAC9F,MAAM,GAAG,CAAC;QACZ,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC/B,MAAM,0BAA0B,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,UAAU,GAAG,OAAO,CAAC,kBAAkB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACjE,UAAU,CAAC,YAAY,GAAG,YAAY,CAAC;QACvC,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;MAEE;IACF,kBAAkB,CAAC,WAAwB,EAAE,UAAsB;QACjE,8DAA8D;QAC9D,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;MA2BE;IACF,wBAAwB,GAAiC,+BAA+B,CAAC;IAEzF;;;;;;;;;OASG;IACO,+BAA+B,CAAC,WAAwB,EAAE,UAAsB;QACxF,IAAI,OAAO,GAAG,WAAW,CAAC,OAAQ,CAAC;QACnC,IAAI,GAAG,GAAG,OAAO,CAAC,wBAAwB,CAAC;QAC3C,IAAI,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC;QAE3B,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACd,IAAI,GAAG,GAAG,OAAO,CAAC,IAAI,GAAG,gDAAgD,CAAC;YAC1E,IAAI,IAAI,GAAG,gCAAgC,CAAC;YAC5C,IAAI,WAAW,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;YACnD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;gBAClC,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,aAAa,GAAG,IAAI,CAAC,CAAC;YAC9C,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;gBACxB,OAAO,CAAC,wBAAwB,GAAG,+BAA+B,CAAC;YACrE,CAAC;YACD,OAAO,WAAW,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,+BAA+B,CAAC,WAAW,EAAE,UAAU,CAA6B,CAAC;QAClG,CAAC;IACH,CAAC;IAED;;MAEE;IACF,kBAAkB,CAAC,WAAwB,EAAE,IAAS;QACpD,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IAC1E,CAAC;IAGD;;;;MAIE;IACF,qDAAqD;IACrD,MAAM,CAAC,uBAAuB,CAAC,GAAgB;QAC7C,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAC7B,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC,KAAK,CAAC;QACzD,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY;YAAE,OAAO,CAAC,iDAAiD;QACnG,MAAM,IAAI,GAAG,kEAAkE,CAAC;QAChF,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAO,CAAC,kBAAkB;QACzE,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO;YACvB,CAAC,CAAC,0BAA0B,GAAG,GAAG,CAAC,OAAO,GAAG,IAAI,GAAG,IAAI;YACxD,CAAC,CAAC,0CAA0C,GAAG,IAAI,CAAC;IACxD,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,aAAa,CAAC,YAA0B,EAAE,aAAsB;QACrE,MAAM,GAAG,GAAG,WAAW,CAAC,YAAY,CAAC,CAAC;QACtC,0BAA0B,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC;QACxD,IAAI,aAAa,EAAE,CAAC;YAClB,GAAG,CAAC,OAAO,GAAG,aAAa,GAAG,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC;QACnD,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED,kBAAkB,GAAG,IAAI,kBAAkB,CAAC;QAC1C,IAAI,EAAE,MAAM;QAEZ,SAAS,EAAE,WAAU,uCAAuC;YAC1D,OAAO,EAAE,CAAC;QACZ,CAAC;KACF,CAAC,CAAC;CACJ;AAED,SAAS,WAAW,CAAC,YAA0B;IAC7C,IAAI,GAAG,GAAG,IAAI,KAAK,EAAiB,CAAC;IACrC,GAAG,CAAC,YAAY,GAAG,YAAY,CAAC;IAChC,GAAG,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC;IACjC,GAAG,CAAC,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;IACzC,GAAG,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;IAC7B,GAAG,CAAC,GAAG,GAAG,YAAY,CAAC,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC;IAEzD,IAAI,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC;IAE/B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,GAAG,CAAC,OAAO,GAAG,YAAY,CAAC,KAAK,IAAI,YAAY,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;QAClE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,6EAA6E;IAC7E,qBAAqB;IACrB,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC;YACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC9B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,+DAA+D;YAC/D,GAAG,CAAC,OAAO,GAAG,MAAM,CAAC;YACrB,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;IAED,2FAA2F;IAC3F,uFAAuF;IACvF,4FAA4F;IAC5F,wEAAwE;IACxE,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ;QAAE,GAAG,CAAC,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC;IAEnE,IAAI,WAAW,GAAG,YAAY,CAAC,WAAW,CAAC;IAE3C,2DAA2D;IAC3D,IAAI,GAAG,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,gBAAgB,IAAI,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,CAAC;IAC5F,IAAI,QAAQ,GAAG,CAAC,CAAC,GAAG,CAAC;IACrB,IAAI,OAAe,EAAE,YAAmB,CAAC;IACzC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,wFAAwF;QACxF,6FAA6F;QAC7F,sFAAsF;QACtF,8FAA8F;QAC9F,0DAA0D;QAC1D,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,KAAK,CAAC;QAC1D,0FAA0F;QAC1F,mEAAmE;QACnE,YAAY,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC;QACpD,yFAAyF;QACzF,6FAA6F;QAC7F,iFAAiF;QACjF,YAAY,GAAG,YAAY,IAAI,YAAY,CAAC,GAAG,CAAC,UAAU,CAAM;YAC9D,OAAO,CAAC,CAAC,cAAc;gBACrB,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,cAAc,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAC,cAAc,CAAC,EAAE;gBAC7E,CAAC,CAAC,CAAC,CAAC;QACR,CAAC,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,IAAI,GAAG,GAAG,MAAM,CAAC;QACjB,GAAG,CAAC;YACF,0FAA0F;YAC1F,sCAAsC;YACtC,OAAO,GAAG,GAAG,CAAC,gBAAgB,IAAI,GAAG,CAAC,OAAO,CAAC;YAC9C,GAAG,GAAG,GAAG,CAAC,cAAc,CAAC;QAC3B,CAAC,QAAQ,GAAG,EAAE;QACd,gHAAgH;QAChH,YAAY,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC;QACpD,YAAY,GAAG,YAAY,IAAI,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC;YACzD,OAAO;gBACL,SAAS,EAAE,CAAC,CAAC,SAAS;gBACtB,cAAc,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAC,cAAc,CAAC;gBACjE,SAAS,EAAE,CAAC,CAAC,SAAS;gBACtB,YAAY,EAAE,CAAC,CAAC,YAAY;gBAC5B,YAAY,EAAE,CAAC,CAAC,YAAY;gBAC5B,MAAM,EAAE,CAAC,CAAC,MAAM;aACjB,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,WAAW,IAAI,YAAY,EAAE,CAAC;QAEhC,IAAI,UAAU,GAAG,WAAW,CAAC,aAAa,CAAC,aAAa,CAAC,gBAAgB,CAAC,0BAA0B,CAAC;QACrG,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC;YAC9B,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,YAAY,IAAI,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QACF,GAA2B,CAAC,YAAY,GAAG,YAAY,CAAC;IAC3D,CAAC;IAED,GAAG,CAAC,OAAO,GAAG,OAAO,IAAI,iGAAiG,CAAC;IAC3H,OAAO,GAAG,CAAC;AACb,CAAC;AAGD,2EAA2E;AAC3E,MAAM,+BAA+B;IACnC,YAAY,WAAwB,EAAE,UAAsB;IAE5D,CAAC;IAED,UAAU,CAAC,OAAY,EAAE,MAAc,EAAE,KAAa;QACpD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,IAAI,CAAC,QAAkB;IACvB,CAAC;CACF","sourcesContent":["import { core } from '../core/core.js';\r\nimport { config } from '../config/config.js';\r\nimport { builtinAjax } from './http.js';\r\nimport { EntityQuery } from '../query/entity-query.js';\r\nimport { DataServiceAdapter, AjaxAdapter, AjaxConfig, ChangeRequestInterceptorCtor, ChangeRequestInterceptor } from '../config/interface-registry.js';\r\nimport { Entity } from '../entity/entity-aspect.js';\r\nimport { MappingContext } from '../query/mapping-context.js';\r\nimport { DataService, JsonResultsAdapter } from '../metadata/data-service.js';\r\nimport { HttpResponse, SaveContext, SaveBundle, ServerError, SaveResult, SaveErrorFromServer, QueryResult } from '../manager/entity-manager.js';\r\nimport { EntityType, MetadataStore } from '../metadata/entity-metadata.js';\r\n\r\n/** For use by breeze plugin authors only.  The class is used as the base class for most {@link DataServiceAdapter} implementations\r\n@adapter (see {@link DataServiceAdapter})    \r\n@hidden\r\n*/\r\nexport abstract class AbstractDataServiceAdapter implements DataServiceAdapter {\r\n  /** @hidden @internal */\r\n  declare _$impl?: any;\r\n  /** The name of this adapter. */\r\n  declare name: string;\r\n  /**\r\n   * The ajax adapter requests go through: the registered default if there is one, otherwise\r\n   * a built-in one that uses `config.fetch`.\r\n   * @deprecated Make requests with `_ajax`, and supply the transport with\r\n   * `configureBreeze({ fetch })`.\r\n   */\r\n  declare ajaxImpl: AjaxAdapter;\r\n\r\n  // TODO use interface\r\n  checkForRecomposition(interfaceInitializedArgs: any) {\r\n    if (interfaceInitializedArgs.interfaceName === \"ajax\" && interfaceInitializedArgs.isDefault) {\r\n      this.initialize();\r\n    }\r\n  }\r\n\r\n  initialize() {\r\n    // An ajax adapter is optional. A registered one (deprecated) is used if there is one;\r\n    // otherwise requests go through config.fetch, which defaults to globalThis.fetch. This\r\n    // is also why registration order no longer matters: there is nothing to resolve.\r\n    this.ajaxImpl = config.getAdapterInstance<AjaxAdapter>(\"ajax\") || builtinAjax;\r\n  }\r\n\r\n  /**\r\n   * Sends one request. Resolves with the response, or rejects with a `ServerError`.\r\n   *\r\n   * Subclasses should make their requests through this method rather than through\r\n   * `ajaxImpl`, whose callback-shaped contract is kept only for compatibility. This is the\r\n   * only place in the class that deals in success/error callbacks.\r\n   */\r\n  protected _ajax(\r\n      config: Omit<AjaxConfig, 'success' | 'error'>,\r\n      errorMessagePrefix?: string,\r\n      prepareResponse?: (httpResponse: HttpResponse) => void): Promise<HttpResponse> {\r\n    return new Promise<HttpResponse>((resolve, reject) => {\r\n      this.ajaxImpl.ajax({\r\n        ...config,\r\n        // Each callback is guarded: a throw inside one would otherwise escape into the ajax\r\n        // adapter and leave this promise pending for ever.\r\n        success: (httpResponse: HttpResponse) => {\r\n          try {\r\n            prepareResponse && prepareResponse(httpResponse);\r\n            resolve(httpResponse);\r\n          } catch (e) {\r\n            reject(e);\r\n          }\r\n        },\r\n        error: (httpResponse: HttpResponse) => {\r\n          try {\r\n            // must run before makeHttpError: createError reads httpResponse.saveContext\r\n            // to attach per-entity validation errors.\r\n            prepareResponse && prepareResponse(httpResponse);\r\n            reject(AbstractDataServiceAdapter.makeHttpError(httpResponse, errorMessagePrefix));\r\n          } catch (e) {\r\n            reject(e);\r\n          }\r\n        },\r\n      } as AjaxConfig);\r\n    });\r\n  }\r\n\r\n  async fetchMetadata(metadataStore: MetadataStore, dataService: DataService) {\r\n    const serviceName = dataService.serviceName;\r\n    const url = dataService.qualifyUrl(\"Metadata\");\r\n\r\n    const httpResponse = await this._ajax(\r\n      { type: \"GET\", url: url, dataType: 'json' },\r\n      \"Metadata query failed for: \" + url);\r\n\r\n    // might have been fetched by another query\r\n    if (metadataStore.hasMetadataFor(serviceName)) {\r\n      return \"already fetched\";\r\n    }\r\n\r\n    const data = httpResponse.data;\r\n    let metadata: any;\r\n    try {\r\n      metadata = typeof (data) === \"string\" ? JSON.parse(data) : data;\r\n      metadataStore.importMetadata(metadata);\r\n    } catch (e) {\r\n      const errMsg = \"Unable to either parse or import metadata: \" + (e as Error).message;\r\n      throw AbstractDataServiceAdapter.makeHttpError(httpResponse, \"Metadata query failed for: \" + url + \". \" + errMsg);\r\n    }\r\n\r\n    // import may have brought in the service.\r\n    if (!metadataStore.hasMetadataFor(serviceName)) {\r\n      metadataStore.addDataService(dataService);\r\n    }\r\n\r\n    return metadata;\r\n  }\r\n\r\n  /** Execute the query in the mappingContext. */\r\n  async executeQuery(mappingContext: MappingContext): Promise<QueryResult> {\r\n    mappingContext.adapter = this;\r\n\r\n    const usePost = (mappingContext.query as EntityQuery).usePostEnabled;\r\n    const params = usePost ? this._makeQueryPostParams(mappingContext) : this._makeQueryGetParams(mappingContext) as any;\r\n\r\n    const httpResponse = await this._ajax(params);\r\n\r\n    const data = httpResponse.data;\r\n    try {\r\n      const results = data && (data.results || data.Results);\r\n      if (results) {\r\n        return {\r\n          results: results,\r\n          inlineCount: data.inlineCount || data.InlineCount,\r\n          httpResponse: httpResponse,\r\n          query: mappingContext.query\r\n        } as QueryResult;\r\n      }\r\n      return { results: data, httpResponse: httpResponse, query: mappingContext.query } as QueryResult;\r\n    } catch (e) {\r\n      if (e instanceof Error) { throw e; }\r\n      throw AbstractDataServiceAdapter.makeHttpError(httpResponse);\r\n    }\r\n  }\r\n\r\n  /** Set up ajax parameters for query GET.  This puts the query into the request querystring, in whatever syntax the UriBuilder produces. */\r\n  _makeQueryGetParams(mappingContext: MappingContext) {\r\n    const url = mappingContext.getUrl();\r\n\r\n    const params = {\r\n      type: \"GET\",\r\n      url: url,\r\n      params: (mappingContext.query as EntityQuery).parameters,\r\n      dataType: 'json',\r\n      crossDomain: false,\r\n    };\r\n    // useJsonp is deprecated. Breeze's own transport ignores dataType and crossDomain; this\r\n    // stays only because a registered (deprecated) ajax adapter could still act on them.\r\n    if (mappingContext.dataService.useJsonp) {\r\n      params.dataType = 'jsonp';\r\n      params.crossDomain = true;\r\n    }\r\n    return params;\r\n  }\r\n\r\n  /** Set up ajax parameters for query POST.  This put the query into the request body as JSON. */\r\n  _makeQueryPostParams(mappingContext: MappingContext) {\r\n    const entityQuery = mappingContext.query as EntityQuery;\r\n    const metadataStore = mappingContext.entityManager.metadataStore;\r\n    const url = mappingContext.dataService.qualifyUrl(entityQuery.resourceName!);\r\n\r\n    let entityType = entityQuery._getFromEntityType(metadataStore, false);\r\n    if (!entityType) { entityType = new EntityType(metadataStore); }\r\n    const json = entityQuery.toJSONExt({ entityType: entityType, toNameOnServer: true}) as any;\r\n    json.from = undefined;\r\n    json.queryOptions = undefined;\r\n    // withParameters values go in the query string (params, below), as for a GET.\r\n    json.parameters = undefined;\r\n\r\n    const params = {\r\n      type: \"POST\",\r\n      url: url,\r\n      params: (mappingContext.query as EntityQuery).parameters,\r\n      dataType: 'json',\r\n      processData: false, // don't form-encode the body\r\n      contentType: \"application/json; charset=UTF-8\",\r\n      data: JSON.stringify(json),\r\n      crossDomain: false,\r\n    };\r\n    return params;\r\n  }\r\n\r\n  async saveChanges(saveContext: SaveContext, saveBundle: SaveBundle): Promise<SaveResult> {\r\n    let adapter = saveContext.adapter = this;\r\n\r\n    let saveBundleSer = adapter._prepareSaveBundle(saveContext, saveBundle);\r\n    let bundle = JSON.stringify(saveBundleSer);\r\n\r\n    const url = saveContext.dataService.qualifyUrl(saveContext.resourceName);\r\n\r\n    // saveContext must be on the response before any error is built from it\r\n    const httpResponse = await this._ajax(\r\n      {\r\n        type: \"POST\",\r\n        url: url,\r\n        dataType: 'json',\r\n        contentType: \"application/json\",\r\n        data: bundle,\r\n      },\r\n      undefined,\r\n      (r) => { r.saveContext = saveContext; });\r\n\r\n    const data = httpResponse.data;\r\n    if (data == null || data === \"\") {\r\n      const err = AbstractDataServiceAdapter.makeHttpError(httpResponse);\r\n      err.message = \"The response to the save request to \" + url + \" (HTTP status \" + httpResponse.status +\r\n        \") had no body. Breeze needs the saved entities and any key mappings to complete the save.\";\r\n      throw err;\r\n    }\r\n    if (data.Errors || data.errors) {\r\n      throw AbstractDataServiceAdapter.makeHttpError(httpResponse);\r\n    }\r\n\r\n    const saveResult = adapter._prepareSaveResult(saveContext, data);\r\n    saveResult.httpResponse = httpResponse;\r\n    return saveResult;\r\n  }\r\n\r\n  /** Abstract method that needs to be overwritten in any concrete DataServiceAdapter subclass. \r\n  The return value from this method should be a serializable object that will be sent to the server after calling JSON.stringify on it.\r\n  */\r\n  _prepareSaveBundle(saveContext: SaveContext, saveBundle: SaveBundle): any {\r\n    // The implementor should call _createChangeRequestInterceptor\r\n    throw new Error(\"Need a concrete implementation of _prepareSaveBundle\");\r\n  }\r\n\r\n  /**\r\n  Returns a constructor function for a \"ChangeRequestInterceptor\"\r\n  that can tweak the saveBundle both as it is built and when it is completed\r\n  by a concrete DataServiceAdapater.\r\n\r\n  Initialized with a default, no-op implementation that developers can replace with a\r\n  substantive implementation that changes the individual entity change requests\r\n  or aspects of the entire 'saveBundle' without having to write their own DataService adapters.\r\n  ```ts\r\n  let adapter = breeze.config.getAdapterInstance('dataService');\r\n  adapter.changeRequestInterceptor = function (saveContext, saveBundle) {\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     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  }\r\n  ```\r\n\r\n  @param saveContext - The BreezeJS \"context\" for the save operation.\r\n  @param saveBundle - Contains the array of entities-to-be-saved (AKA, the entity change-set).\r\n  @returns Constructor for a \"ChangeRequestInterceptor\".\r\n  */\r\n  changeRequestInterceptor: ChangeRequestInterceptorCtor = DefaultChangeRequestInterceptor;\r\n\r\n  /**\r\n   * Creates the change request interceptor for one save, from `changeRequestInterceptor`.\r\n   * Call it at the start of `_prepareSaveBundle`, pass each entity's request through its\r\n   * `getRequest`, and pass the finished array to its `done`.\r\n   *\r\n   * Falls back to a no-op interceptor when `changeRequestInterceptor` is not set. If the\r\n   * interceptor it creates has `oneTime` set, the adapter goes back to the no-op\r\n   * interceptor afterwards, so only this save is intercepted.\r\n   * @throws if the interceptor has no `getRequest` or `done` method.\r\n   */\r\n  protected _createChangeRequestInterceptor(saveContext: SaveContext, saveBundle: SaveBundle): ChangeRequestInterceptor {\r\n    let adapter = saveContext.adapter!;\r\n    let cri = adapter.changeRequestInterceptor;\r\n    let isFn = core.isFunction;\r\n\r\n    if (isFn(cri)) {\r\n      let pre = adapter.name + \" DataServiceAdapter's ChangeRequestInterceptor\";\r\n      let post = \" is missing or not a function.\";\r\n      let interceptor = new cri(saveContext, saveBundle);\r\n      if (!isFn(interceptor.getRequest)) {\r\n        throw new Error(pre + '.getRequest' + post);\r\n      }\r\n      if (!isFn(interceptor.done)) {\r\n        throw new Error(pre + '.done' + post);\r\n      }\r\n      if (interceptor.oneTime) {\r\n        adapter.changeRequestInterceptor = DefaultChangeRequestInterceptor;\r\n      }\r\n      return interceptor;\r\n    } else {\r\n      return new DefaultChangeRequestInterceptor(saveContext, saveBundle) as ChangeRequestInterceptor;\r\n    }\r\n  }\r\n\r\n  /** Abstract method that needs to be overwritten in any concrete DataServiceAdapter sublclass. \r\n  This method needs to take the result returned the server and convert it into an ISaveResult. \r\n  */\r\n  _prepareSaveResult(saveContext: SaveContext, data: any): SaveResult {\r\n    throw new Error(\"Need a concrete implementation of _prepareSaveResult\");\r\n  }\r\n\r\n\r\n  /** Utility method that may be used in any concrete DataServiceAdapter sublclass to handle any \r\n  http connection issues. For an error with status 0 - the request got no response - it says in\r\n  the message that the server could not be reached, keeping any message the transport gave.\r\n  An aborted request is left alone. `makeHttpError` already applies it.\r\n  */\r\n  // Put this at the bottom of your http error analysis\r\n  static _catchNoConnectionError(err: ServerError) {\r\n    if (err.status !== 0) return;\r\n    const cause = err.httpResponse && err.httpResponse.error;\r\n    if (cause && cause.name === \"AbortError\") return; // the app cancelled it; the server is irrelevant\r\n    const hint = \"Likely did not or could not reach server. Is the server running?\";\r\n    if (err.message && err.message.includes(hint)) return; // already applied\r\n    err.message = err.message\r\n      ? \"HTTP response status 0: \" + err.message + \". \" + hint\r\n      : \"HTTP response status 0 and no message.  \" + hint;\r\n  }\r\n\r\n  /**\r\n   * Builds the Breeze error for a failed HTTP response: an `Error` carrying `status`,\r\n   * `statusText`, `url`, `body` and `httpResponse`, whose message comes from the response\r\n   * body (a .NET exception, or `{ message, errors }`). For a save, it also carries the\r\n   * server's per-entity `entityErrors`, if `httpResponse.saveContext` is set.\r\n   *\r\n   * `_ajax` uses it for every failed request. Call it when your adapter makes a request some\r\n   * other way, then throw or reject with the result.\r\n   * @param httpResponse - The failed response.\r\n   * @param messagePrefix - Put at the start of the message, followed by \"; \".\r\n   */\r\n  static makeHttpError(httpResponse: HttpResponse, messagePrefix?: string): ServerError {\r\n    const err = createError(httpResponse);\r\n    AbstractDataServiceAdapter._catchNoConnectionError(err);\r\n    if (messagePrefix) {\r\n      err.message = messagePrefix + \"; \" + err.message;\r\n    }\r\n    return err;\r\n  }\r\n\r\n  jsonResultsAdapter = new JsonResultsAdapter({\r\n    name: \"noop\",\r\n\r\n    visitNode: function (/* node, mappingContext, nodeContext */) {\r\n      return {};\r\n    }\r\n  });\r\n}\r\n\r\nfunction createError(httpResponse: HttpResponse) {\r\n  let err = new Error() as ServerError;\r\n  err.httpResponse = httpResponse;\r\n  err.status = httpResponse.status;\r\n  err.statusText = httpResponse.statusText;\r\n  err.body = httpResponse.data;\r\n  err.url = httpResponse.config && httpResponse.config.url;\r\n\r\n  let errObj = httpResponse.data;\r\n\r\n  if (!errObj) {\r\n    err.message = httpResponse.error && httpResponse.error.toString();\r\n    return err;\r\n  }\r\n\r\n  // some ajax providers convert an errant result into an object, others do not\r\n  // if not do it here.\r\n  if (typeof errObj === \"string\") {\r\n    try {\r\n      errObj = JSON.parse(errObj);\r\n    } catch (e) {\r\n      // sometimes httpResponse.data is just the error message itself\r\n      err.message = errObj;\r\n      return err;\r\n    }\r\n  }\r\n\r\n  // The RFC 9457 `type` member, taken before the branch below because it is spelled the same\r\n  // whichever shape the rest of the document has: a Breeze server sends it alongside the\r\n  // capitalised pre-3.0 members as well as instead of them. This is what lets a caller tell a\r\n  // concurrency conflict from a duplicate key, which share a status code.\r\n  if (typeof errObj.type === \"string\") err.problemType = errObj.type;\r\n\r\n  let saveContext = httpResponse.saveContext;\r\n\r\n  // if any of the follow properties exist the source is .NET\r\n  let tmp = errObj.Message || errObj.ExceptionMessage || errObj.EntityErrors || errObj.Errors;\r\n  let isDotNet = !!tmp;\r\n  let message: string, entityErrors: any[];\r\n  if (!isDotNet) {\r\n    // RFC 9457 (Problem Details for HTTP APIs) calls the human-readable text `detail`, with\r\n    // `title` as the shorter summary of the problem *type*. A server that sends problem+json and\r\n    // nothing else would otherwise fall through to the generic message at the end of this\r\n    // function, which says entity errors were encountered whether or not any were - a confidently\r\n    // wrong message is harder to diagnose than a missing one.\r\n    message = errObj.message || errObj.detail || errObj.title;\r\n    // `entityErrors` is a Breeze extension member; RFC 9457 section 3.2 allows those, and the\r\n    // spec requires consumers to ignore members they do not recognize.\r\n    entityErrors = errObj.errors || errObj.entityErrors;\r\n    // Normalize the same way the .NET branch does. Without this a server sending the natural\r\n    // \"Namespace.Type\" spelling gets \"Unable to locate a 'Type' by the name ...\" from the entity\r\n    // lookup in processServerErrors, with nothing to connect it to the error format.\r\n    entityErrors = entityErrors && entityErrors.map(function (e: any) {\r\n      return e.entityTypeName\r\n        ? { ...e, entityTypeName: MetadataStore.normalizeTypeName(e.entityTypeName) }\r\n        : e;\r\n    });\r\n  } else {\r\n    let tmp = errObj;\r\n    do {\r\n      // .NET exceptions can provide both ExceptionMessage and Message but ExceptionMethod if it\r\n      // exists has a more detailed message.\r\n      message = tmp.ExceptionMessage || tmp.Message;\r\n      tmp = tmp.InnerException;\r\n    } while (tmp);\r\n    // .EntityErrors will only occur as a result of an EntityErrorsException being deliberately thrown on the server\r\n    entityErrors = errObj.Errors || errObj.EntityErrors;\r\n    entityErrors = entityErrors && entityErrors.map(function (e) {\r\n      return {\r\n        errorName: e.ErrorName,\r\n        entityTypeName: MetadataStore.normalizeTypeName(e.EntityTypeName),\r\n        keyValues: e.KeyValues,\r\n        propertyName: e.PropertyName,\r\n        errorMessage: e.ErrorMessage,\r\n        custom: e.Custom\r\n      };\r\n    });\r\n  }\r\n\r\n  if (saveContext && entityErrors) {\r\n\r\n    let propNameFn = saveContext.entityManager.metadataStore.namingConvention.serverPropertyNameToClient;\r\n    entityErrors.forEach(function (e) {\r\n      e.propertyName = e.propertyName && propNameFn(e.propertyName);\r\n    });\r\n    (err as SaveErrorFromServer).entityErrors = entityErrors;\r\n  }\r\n\r\n  err.message = message || \"Server side errors encountered - see the entityErrors collection on this object for more detail\";\r\n  return err;\r\n}\r\n\r\n\r\n/** This is a default, no-op implementation that developers can replace. */\r\nclass DefaultChangeRequestInterceptor {\r\n  constructor(saveContext: SaveContext, saveBundle: SaveBundle) {\r\n\r\n  }\r\n\r\n  getRequest(request: any, entity: Entity, index: number) {\r\n    return request;\r\n  }\r\n\r\n  done(requests: Object[]) {\r\n  }\r\n}\r\n"]}

package/adapters/adapter-ajax-fetch.d.ts

@@ -0,0 +1,12 @@
+/**
+ * `AjaxFetchAdapter` - deprecated.
+ *
+ * Breeze 3 does not need an ajax adapter. Requests go through `config.fetch`, which you set
+ * with `configureBreeze({ fetch })` and which defaults to `globalThis.fetch`.
+ *
+ * This entry point is kept so that 2.x startup code - `AjaxFetchAdapter.register()`,
+ * `configureBreeze({ ajax: AjaxFetchAdapter })`, `config.initializeAdapterInstance('ajax',
+ * 'fetch')` - and code that uses the adapter's `defaultSettings` or `requestInterceptor`
+ * keeps working. The implementation now lives in the core, shared with the default path.
+ */
+export { AjaxFetchAdapter } from './http.js';

package/adapters/adapter-ajax-fetch.js

@@ -0,0 +1,13 @@
+/**
+ * `AjaxFetchAdapter` - deprecated.
+ *
+ * Breeze 3 does not need an ajax adapter. Requests go through `config.fetch`, which you set
+ * with `configureBreeze({ fetch })` and which defaults to `globalThis.fetch`.
+ *
+ * This entry point is kept so that 2.x startup code - `AjaxFetchAdapter.register()`,
+ * `configureBreeze({ ajax: AjaxFetchAdapter })`, `config.initializeAdapterInstance('ajax',
+ * 'fetch')` - and code that uses the adapter's `defaultSettings` or `requestInterceptor`
+ * keeps working. The implementation now lives in the core, shared with the default path.
+ */
+export { AjaxFetchAdapter } from './http.js';
+//# sourceMappingURL=adapter-ajax-fetch.js.map

package/adapters/adapter-ajax-fetch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter-ajax-fetch.js","sourceRoot":"","sources":["../../src/adapters/adapter-ajax-fetch.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC","sourcesContent":["/**\n * `AjaxFetchAdapter` - deprecated.\n *\n * Breeze 3 does not need an ajax adapter. Requests go through `config.fetch`, which you set\n * with `configureBreeze({ fetch })` and which defaults to `globalThis.fetch`.\n *\n * This entry point is kept so that 2.x startup code - `AjaxFetchAdapter.register()`,\n * `configureBreeze({ ajax: AjaxFetchAdapter })`, `config.initializeAdapterInstance('ajax',\n * 'fetch')` - and code that uses the adapter's `defaultSettings` or `requestInterceptor`\n * keeps working. The implementation now lives in the core, shared with the default path.\n */\nexport { AjaxFetchAdapter } from './http.js';\n"]}

package/{adapter-ajax-post → adapters}/adapter-ajax-post.d.ts

@@ -1,36 +1,40 @@
-import * as breeze from 'breeze-client';
-/**
- *  Functions to enable Breeze to use POST for queries when
- *  special parameters are passed using the .withParameters function.
- *
- * Copyright 2015-2021 IdeaBlade, Inc.  All Rights Reserved.
- * Use, reproduction, distribution, and modification of this code is subject to the terms and
- * conditions of the IdeaBlade Breeze license, available at http://www.breezejs.com/license
- *
- * Author: Steve Schmitt
- * Version:
- *  1.2.0 - Moved into breeze-client repo and npm package
- *  1.1.0 - revised: eliminated return object, configAjaxAdapter method; add ajaxPostEnabled flag
- *  1.0.6 - original
- *
- * Special parameters:
- *  $method: ‘POST’ or ‘GET’ (the default)
- *  $encoding: ‘JSON’ or x-www-form-urlencoded (the default)
- *  $data: contains the data to be sent to the server
- *
- * Installation:
- *    var ajaxAdapter = config.initializeAdapterInstance('ajax', adapterName, true);
- *    AjaxPostWrapper.wrapAjax(ajaxAdapter);
- *
- * Example:
- *   var query = breeze.EntityQuery.from('SimilarCustomersPOST')
- *            .withParameters({
- *                $method: 'POST',
- *                $encoding: 'JSON',
- *               $data: { CompanyName: 'Hilo Hattie', ContactName: 'Donald', City: 'Duck', Country: 'USA', Phone: '808-234-5678' }
- *           });
- *
- **/
-export declare class AjaxPostWrapper {
-    static wrapAjax(ajaxAdapter: breeze.AjaxAdapter): void;
-}
+import * as breeze from '../breeze.js';
+/**
+ *  Functions to enable Breeze to use POST for queries when
+ *  special parameters are passed using the .withParameters function.
+ *
+ * Copyright 2015-2026 IdeaBlade, Inc.  All Rights Reserved.
+ * Use, reproduction, distribution, and modification of this code is subject to the terms and
+ * conditions of the IdeaBlade Breeze license, available at http://www.breezejs.com/license
+ *
+ * Author: Steve Schmitt
+ * Version:
+ *  1.2.0 - Moved into breeze-client repo and npm package
+ *  1.1.0 - revised: eliminated return object, configAjaxAdapter method; add ajaxPostEnabled flag
+ *  1.0.6 - original
+ *
+ * Special parameters:
+ *  $method: ‘POST’ or ‘GET’ (the default)
+ *  $encoding: ‘JSON’ or x-www-form-urlencoded (the default)
+ *  $data: contains the data to be sent to the server
+ *
+ * Installation:
+ *    const ajaxAdapter = config.getAdapterInstance<AjaxAdapter>('ajax');
+ *    AjaxPostWrapper.wrapAjax(ajaxAdapter);
+ *
+ *  Breeze 3 needs no ajax adapter, so there is one to wrap only if you registered one with
+ *  configureBreeze({ ajax: MyAdapter }). Otherwise wrap your own fetch function instead.
+ *
+ * Example:
+ *   const query = EntityQuery.from('SimilarCustomersPOST')
+ *     .toType(Customer)
+ *     .withParameters({
+ *       $method: 'POST',
+ *       $encoding: 'JSON',
+ *       $data: { companyName: 'Hilo Hattie', contactName: 'Donald', city: 'Duck', country: 'USA', phone: '808-234-5678' }
+ *     });
+ *
+ */
+export declare class AjaxPostWrapper {
+    static wrapAjax(ajaxAdapter: breeze.AjaxAdapter): void;
+}