@ember-data-mirror/request 5.4.0-alpha.64 → 5.4.0-alpha.71

package/addon/index.js

@@ -1,240 +0,0 @@
-import { _ as _classPrivateFieldBase, I as IS_CACHE_HANDLER, a as assertValidRequest, e as executeNextHandler, g as getRequestResult, u as upgradePromise, s as setPromiseResult, b as clearRequestResult, d as _classPrivateFieldKey } from "./context-DMaVGooY";
-export { f as createDeferred, h as getPromiseResult } from "./context-DMaVGooY";
-import { macroCondition, getOwnConfig, importSync } from '@embroider/macros';
-let REQ_ID = 0;
-/**
- * ```js
- * import RequestManager from '@ember-data-mirror/request';
- * ```
- *
- * A RequestManager provides a request/response flow in which configured
- * handlers are successively given the opportunity to handle, modify, or
- * pass-along a request.
- *
- * ```ts
- * interface RequestManager {
- *   request<T>(req: RequestInfo): Future<T>;
- * }
- * ```
- *
- * For example:
- *
- * ```ts
- * import RequestManager from '@ember-data-mirror/request';
- * import Fetch from '@ember-data-mirror/request/fetch';
- * import Auth from 'ember-simple-auth/ember-data-handler';
- * import Config from './config';
- *
- * const { apiUrl } = Config;
- *
- * // ... create manager
- * const manager = new RequestManager();
- * manager.use([Auth, Fetch]);
- *
- * // ... execute a request
- * const response = await manager.request({
- *   url: `${apiUrl}/users`
- * });
- * ```
- *
- * ### Futures
- *
- * The return value of `manager.request` is a `Future`, which allows
- * access to limited information about the request while it is still
- * pending and fulfills with the final state when the request completes.
- *
- * A `Future` is cancellable via `abort`.
- *
- * Handlers may optionally expose a `ReadableStream` to the `Future` for
- * streaming data; however, when doing so the future should not resolve
- * until the response stream is fully read.
- *
- * ```ts
- * interface Future<T> extends Promise<StructuredDocument<T>> {
- *   abort(): void;
- *
- *   async getStream(): ReadableStream | null;
- * }
- * ```
- *
- * ### StructuredDocuments
- *
- * A Future resolves with a `StructuredDataDocument` or rejects with a `StructuredErrorDocument`.
- *
- * ```ts
- * interface StructuredDataDocument<T> {
- *   request: ImmutableRequestInfo;
- *   response: ImmutableResponseInfo;
- *   content: T;
- * }
- * interface StructuredErrorDocument extends Error {
- *   request: ImmutableRequestInfo;
- *   response: ImmutableResponseInfo;
- *   error: string | object;
- * }
- * type StructuredDocument<T> = StructuredDataDocument<T> | StructuredErrorDocument;
- * ```
- *
- * @class RequestManager
- * @public
- */
-var _handlers = /*#__PURE__*/_classPrivateFieldKey("handlers");
-class RequestManager {
-  constructor(options) {
-    Object.defineProperty(this, _handlers, {
-      writable: true,
-      value: []
-    });
-    Object.assign(this, options);
-    this._pending = new Map();
-  }
-
-  /**
-   * Register a handler to use for primary cache intercept.
-   *
-   * Only one such handler may exist. If using the same
-   * RequestManager as the Store instance the Store
-   * registers itself as a Cache handler.
-   *
-   * @method useCache
-   * @public
-   * @param {Handler[]} cacheHandler
-   * @return {void}
-   */
-  useCache(cacheHandler) {
-    if (macroCondition(getOwnConfig().env.DEBUG)) {
-      if (this._hasCacheHandler) {
-        throw new Error(`\`RequestManager.useCache(<handler>)\` May only be invoked once.`);
-      }
-      if (Object.isFrozen(_classPrivateFieldBase(this, _handlers)[_handlers])) {
-        throw new Error(`\`RequestManager.useCache(<handler>)\` May only be invoked prior to any request having been made.`);
-      }
-      this._hasCacheHandler = true;
-    }
-    cacheHandler[IS_CACHE_HANDLER] = true;
-    _classPrivateFieldBase(this, _handlers)[_handlers].unshift(cacheHandler);
-  }
-
-  /**
-   * Register handler(s) to use when a request is issued.
-   *
-   * Handlers will be invoked in the order they are registered.
-   * Each Handler is given the opportunity to handle the request,
-   * curry the request, or pass along a modified request.
-   *
-   * @method use
-   * @public
-   * @param {Handler[]} newHandlers
-   * @return {void}
-   */
-  use(newHandlers) {
-    const handlers = _classPrivateFieldBase(this, _handlers)[_handlers];
-    if (macroCondition(getOwnConfig().env.DEBUG)) {
-      if (Object.isFrozen(handlers)) {
-        throw new Error(`Cannot add a Handler to a RequestManager after a request has been made`);
-      }
-      if (!Array.isArray(newHandlers)) {
-        throw new Error(`\`RequestManager.use(<Handler[]>)\` expects an array of handlers, but was called with \`${typeof newHandlers}\``);
-      }
-      newHandlers.forEach((handler, index) => {
-        if (!handler || typeof handler !== 'object' || typeof handler.request !== 'function') {
-          throw new Error(`\`RequestManager.use(<Handler[]>)\` expected to receive an array of handler objects with request methods, by the handler at index ${index} does not conform.`);
-        }
-      });
-    }
-    handlers.push(...newHandlers);
-  }
-
-  /**
-   * Issue a Request.
-   *
-   * Returns a Future that fulfills with a StructuredDocument
-   *
-   * @method request
-   * @public
-   * @param {RequestInfo} request
-   * @return {Future}
-   */
-  request(request) {
-    const handlers = _classPrivateFieldBase(this, _handlers)[_handlers];
-    if (macroCondition(getOwnConfig().env.DEBUG)) {
-      if (!Object.isFrozen(handlers)) {
-        Object.freeze(handlers);
-      }
-      assertValidRequest(request, true);
-    }
-    const controller = request.controller || new AbortController();
-    if (request.controller) {
-      delete request.controller;
-    }
-    const requestId = REQ_ID++;
-    const promise = executeNextHandler(handlers, request, 0, {
-      controller,
-      response: null,
-      stream: null,
-      hasRequestedStream: false,
-      id: requestId
-    });
-
-    // the cache handler will set the result of the request synchronously
-    // if it is able to fulfill the request from the cache
-    const cacheResult = getRequestResult(requestId);
-    if (macroCondition(getOwnConfig().env.TESTING)) {
-      if (!request.disableTestWaiter) {
-        const {
-          waitForPromise
-        } = importSync('@ember/test-waiters');
-        const newPromise = waitForPromise(promise);
-        const finalPromise = upgradePromise(newPromise.then(result => {
-          setPromiseResult(finalPromise, {
-            isError: false,
-            result
-          });
-          clearRequestResult(requestId);
-          return result;
-        }, error => {
-          setPromiseResult(finalPromise, {
-            isError: true,
-            result: error
-          });
-          clearRequestResult(requestId);
-          throw error;
-        }), promise);
-        if (cacheResult) {
-          setPromiseResult(finalPromise, cacheResult);
-        }
-        return finalPromise;
-      }
-    }
-
-    // const promise1 = store.request(myRequest);
-    // const promise2 = store.request(myRequest);
-    // promise1 === promise2; // false
-    // either we need to make promise1 === promise2, or we need to make sure that
-    // we need to have a way to key from request to result
-    // such that we can lookup the result here and return it if it exists
-    const finalPromise = upgradePromise(promise.then(result => {
-      setPromiseResult(finalPromise, {
-        isError: false,
-        result
-      });
-      clearRequestResult(requestId);
-      return result;
-    }, error => {
-      setPromiseResult(finalPromise, {
-        isError: true,
-        result: error
-      });
-      clearRequestResult(requestId);
-      throw error;
-    }), promise);
-    if (cacheResult) {
-      setPromiseResult(finalPromise, cacheResult);
-    }
-    return finalPromise;
-  }
-  static create(options) {
-    return new this(options);
-  }
-}
-export { RequestManager as default, setPromiseResult };

package/addon-main.js

@@ -1,94 +0,0 @@
-const requireModule = require('@ember-data-mirror/private-build-infra/src/utilities/require-module');
-const getEnv = require('@ember-data-mirror/private-build-infra/src/utilities/get-env');
-const detectModule = require('@ember-data-mirror/private-build-infra/src/utilities/detect-module');
-
-const pkg = require('./package.json');
-
-module.exports = {
-  name: pkg.name,
-
-  options: {
-    '@embroider/macros': {
-      setOwnConfig: {},
-    },
-  },
-
-  _emberDataConfig: null,
-  configureEmberData() {
-    if (this._emberDataConfig) {
-      return this._emberDataConfig;
-    }
-    const app = this._findHost();
-    const isProd = /production/.test(process.env.EMBER_ENV);
-    const hostOptions = app.options?.emberData || {};
-    const debugOptions = Object.assign(
-      {
-        LOG_PAYLOADS: false,
-        LOG_OPERATIONS: false,
-        LOG_MUTATIONS: false,
-        LOG_NOTIFICATIONS: false,
-        LOG_REQUESTS: false,
-        LOG_REQUEST_STATUS: false,
-        LOG_IDENTIFIERS: false,
-        LOG_GRAPH: false,
-        LOG_INSTANCE_CACHE: false,
-      },
-      hostOptions.debug || {}
-    );
-
-    const HAS_DEBUG_PACKAGE = detectModule(require, '@ember-data-mirror/debug', __dirname, pkg);
-    const HAS_META_PACKAGE = detectModule(require, 'ember-data-mirror', __dirname, pkg);
-
-    const includeDataAdapterInProduction =
-      typeof hostOptions.includeDataAdapterInProduction === 'boolean'
-        ? hostOptions.includeDataAdapterInProduction
-        : HAS_META_PACKAGE;
-
-    const includeDataAdapter = HAS_DEBUG_PACKAGE ? (isProd ? includeDataAdapterInProduction : true) : false;
-    const DEPRECATIONS = require('@ember-data-mirror/private-build-infra/src/deprecations')(hostOptions.compatWith || null);
-    const FEATURES = require('@ember-data-mirror/private-build-infra/src/features')(isProd);
-
-    const ALL_PACKAGES = requireModule('@ember-data-mirror/private-build-infra/virtual-packages/packages.js');
-    const MACRO_PACKAGE_FLAGS = Object.assign({}, ALL_PACKAGES.default);
-    delete MACRO_PACKAGE_FLAGS['HAS_DEBUG_PACKAGE'];
-
-    Object.keys(MACRO_PACKAGE_FLAGS).forEach((key) => {
-      MACRO_PACKAGE_FLAGS[key] = detectModule(require, MACRO_PACKAGE_FLAGS[key], __dirname, pkg);
-    });
-
-    // copy configs forward
-    const ownConfig = this.options['@embroider/macros'].setOwnConfig;
-    ownConfig.polyfillUUID = hostOptions.polyfillUUID ?? false;
-    ownConfig.compatWith = hostOptions.compatWith || null;
-    ownConfig.debug = debugOptions;
-    ownConfig.deprecations = Object.assign(DEPRECATIONS, ownConfig.deprecations || {}, hostOptions.deprecations || {});
-    ownConfig.features = Object.assign({}, FEATURES);
-    ownConfig.includeDataAdapter = includeDataAdapter;
-    ownConfig.packages = MACRO_PACKAGE_FLAGS;
-    ownConfig.env = getEnv(ownConfig);
-
-    this._emberDataConfig = ownConfig;
-    return ownConfig;
-  },
-
-  included() {
-    this.configureEmberData();
-    return this._super.included.call(this, ...arguments);
-  },
-
-  treeForVendor() {
-    return;
-  },
-  treeForPublic() {
-    return;
-  },
-  treeForStyles() {
-    return;
-  },
-  treeForAddonStyles() {
-    return;
-  },
-  treeForApp() {
-    return;
-  },
-};