Skip to content

Commit

Permalink
chore: update imports to support RFC tweaks (#8501)
Browse files Browse the repository at this point in the history
* chore: update imports to support RFC tweaks

* fix lint

* fix lint
  • Loading branch information
runspired authored Mar 27, 2023
1 parent 295598e commit 59eb2b6
Show file tree
Hide file tree
Showing 27 changed files with 75 additions and 56 deletions.
4 changes: 2 additions & 2 deletions packages/-ember-data/addon/-private/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import PromiseProxyMixin from '@ember/object/promise-proxy-mixin';
import ObjectProxy from '@ember/object/proxy';

import { LegacyNetworkHandler } from '@ember-data/legacy-compat';
import { RequestManager } from '@ember-data/request';
import { Fetch } from '@ember-data/request/fetch';
import RequestManager from '@ember-data/request';
import Fetch from '@ember-data/request/fetch';
import BaseStore from '@ember-data/store';

export class Store extends BaseStore {
Expand Down
2 changes: 1 addition & 1 deletion packages/json-api/src/-private/cache.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ function makeCache(): CachedResource {
This is the cache implementation used by `ember-data`.
```js
import { Cache } from '@ember-data/json-api';
import Cache from '@ember-data/json-api';
import Store from '@ember-data/store';
export default class extends Store {
Expand Down
2 changes: 1 addition & 1 deletion packages/json-api/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export { default as Cache } from './-private/cache';
export { default } from './-private/cache';

/**
This package provides the default cache implementation used
Expand Down
18 changes: 9 additions & 9 deletions packages/request/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ A `RequestManager` provides a request/response flow in which configured handlers
The RequestManager on its own does not know how to fulfill requests. For this we must register at least one handler. A basic `Fetch` handler is provided that will take the request options provided and execute `fetch`.

```ts
import { RequestManager } from '@ember-data/request';
import { Fetch } from '@ember-data/request/fetch';
import RequestManager from '@ember-data/request';
import Fetch from '@ember-data/request/fetch';
import { apiUrl } from './config';

// ... create manager and add our Fetch handler
Expand Down Expand Up @@ -311,8 +311,8 @@ Most applications will desire to have a single `RequestManager` instance, which

*services/request.ts*
```ts
import { RequestManager } from '@ember-data/request';
import { Fetch } from '@ember-data/request/fetch';
import RequestManager from '@ember-data/request';
import Fetch from '@ember-data/request/fetch';
import Auth from 'ember-simple-auth/ember-data-handler';

export default class extends RequestManager {
Expand All @@ -329,8 +329,8 @@ To have a request service unique to a Store:

```ts
import Store from '@ember-data/store';
import { RequestManager } from '@ember-data/request';
import { Fetch } from '@ember-data/request/fetch';
import RequestManager from '@ember-data/request';
import Fetch from '@ember-data/request/fetch';

class extends Store {
requestManager = new RequestManager();
Expand All @@ -348,15 +348,15 @@ If using the package [ember-data](https://github.com/emberjs/data/tree/main/pack

```ts
import Store from '@ember-data/store';
import { RequestManager } from '@ember-data/request';
import { LegacyHandler } from '@ember-data/legacy-network-handler';
import RequestManager from '@ember-data/request';
import { LegacyNetworkHandler } from '@ember-data/legacy-compat';

export default class extends Store {
requestManager = new RequestManager();

constructor(args) {
super(args);
this.requestManager.use([LegacyHandler]);
this.requestManager.use([LegacyNetworkHandler]);
}
}
```
Expand Down
24 changes: 12 additions & 12 deletions packages/request/src/-private/manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ A `RequestManager` provides a request/response flow in which configured handlers
The RequestManager on its own does not know how to fulfill requests. For this we must register at least one handler. A basic `Fetch` handler is provided that will take the request options provided and execute `fetch`.
```ts
import { RequestManager } from '@ember-data/request';
import { Fetch } from '@ember-data/request/fetch';
import RequestManager from '@ember-data/request';
import Fetch from '@ember-data/request/fetch';
import { apiUrl } from './config';
// ... create manager and add our Fetch handler
Expand Down Expand Up @@ -258,8 +258,8 @@ Most applications will desire to have a single `RequestManager` instance, which
*services/request.ts*
```ts
import { RequestManager } from '@ember-data/request';
import { Fetch } from '@ember-data/request/fetch';
import RequestManager from '@ember-data/request';
import Fetch from '@ember-data/request/fetch';
import Auth from 'ember-simple-auth/ember-data-handler';
export default class extends RequestManager {
Expand All @@ -276,8 +276,8 @@ To have a request service unique to a Store:
```ts
import Store from '@ember-data/store';
import { RequestManager } from '@ember-data/request';
import { Fetch } from '@ember-data/request/fetch';
import RequestManager from '@ember-data/request';
import Fetch from '@ember-data/request/fetch';
class extends Store {
requestManager = new RequestManager();
Expand All @@ -295,15 +295,15 @@ If using the package [ember-data](https://github.com/emberjs/data/tree/main/pack
```ts
import Store from '@ember-data/store';
import { RequestManager } from '@ember-data/request';
import { LegacyHandler } from '@ember-data/legacy-network-handler';
import RequestManager from '@ember-data/request';
import { LegacyNetworkHandler } from '@ember-data/legacy-compat';
export default class extends Store {
requestManager = new RequestManager();
constructor(args) {
super(args);
this.requestManager.use([LegacyHandler]);
this.requestManager.use([LegacyNetworkHandler]);
}
}
```
Expand All @@ -326,7 +326,7 @@ import { Future, GenericCreateArgs, Handler, RequestInfo } from './types';
import { executeNextHandler } from './utils';
/**
* ```js
* import { RequestManager } from '@ember-data/request';
* import RequestManager from '@ember-data/request';
* ```
*
* A RequestManager provides a request/response flow in which configured
Expand All @@ -342,8 +342,8 @@ import { executeNextHandler } from './utils';
* For example:
*
* ```ts
* import { RequestManager } from '@ember-data/request';
* import { Fetch } from '@ember-data/request/fetch';
* import RequestManager from '@ember-data/request';
* import Fetch from '@ember-data/request/fetch';
* import Auth from 'ember-simple-auth/ember-data-handler';
* import Config from './config';
*
Expand Down
20 changes: 17 additions & 3 deletions packages/request/src/-private/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,27 +56,41 @@ export type Deferred<T> = {
};

/**
* A Future is a Promise which resolves to a StructuredDocument
* while providing the ability to `abort` the underlying request,
* `getStream` the response before the outer promise resolves;
*
* @class Future
* @internal
* @extends Promise
* @public
*/
export type Future<T> = Promise<StructuredDataDocument<T>> & {
/**
* Cancel this request by firing the AbortController's signal.
*
* @method abort
* @internal
* @public
* @returns {void}
*/
abort(): void;
/**
* Get the response stream, if any, once made available.
*
* @method getStream
* @internal
* @public
* @returns {Promise<ReadableStream | null>}
*/
getStream(): Promise<ReadableStream | null>;

/**
* Run a callback when this request completes. Use sparingly,
* mostly useful for instrumentation and infrastructure.
*
* @method onFinalize
* @param cb the callback to run
* @public
* @returns void
*/
onFinalize(cb: () => void): void;
};

Expand Down
6 changes: 4 additions & 2 deletions packages/request/src/fetch.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,21 @@ const _fetch: typeof fetch =
* `fetch` call presuming the response to be `json`.
*
* ```ts
* import { Fetch } from '@ember-data/request/fetch';
* import Fetch from '@ember-data/request/fetch';
*
* manager.use([Fetch]);
* ```
*
* @class Fetch
* @public
*/
export const Fetch = {
const Fetch = {
async request(context: Context) {
const response = await _fetch(context.request.url!, context.request);
context.setResponse(response);

return response.json();
},
};

export default Fetch;
2 changes: 1 addition & 1 deletion packages/request/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
export { RequestManager } from './-private/manager';
export { RequestManager as default } from './-private/manager';
export { createDeferred } from './-private/future';
2 changes: 1 addition & 1 deletion packages/store/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The package `@ember-data/json-api` provides a `JSON:API` cache we can use. After

```js
import Store from '@ember-data/store';
import { Cache } from '@ember-data/json-api';
import Cache from '@ember-data/json-api';

class extends Store {
createCache(storeWrapper) {
Expand Down
10 changes: 5 additions & 5 deletions packages/store/src/-private/store-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { _backburner as emberBackburner } from '@ember/runloop';
import { importSync } from '@embroider/macros';

import { DEBUG, TESTING } from '@ember-data/env';
import type { Cache as CacheClass } from '@ember-data/json-api';
import type CacheClass from '@ember-data/json-api';
import type FetchManager from '@ember-data/legacy-compat/legacy-network-handler/fetch-manager';
import type DSModelClass from '@ember-data/model';
import {
Expand All @@ -25,7 +25,7 @@ import {
DEPRECATE_STORE_FIND,
DEPRECATE_V1_RECORD_DATA,
} from '@ember-data/private-build-infra/deprecations';
import type { RequestManager } from '@ember-data/request';
import type RequestManager from '@ember-data/request';
import type { Future } from '@ember-data/request/-private/types';
import type { Cache, CacheV1 } from '@ember-data/types/q/cache';
import type { CacheStoreWrapper } from '@ember-data/types/q/cache-store-wrapper';
Expand Down Expand Up @@ -200,8 +200,8 @@ class Store {
*
* ```ts
* import Store from '@ember-data/store';
* import { RequestManager } from '@ember-data/request';
* import { Fetch } from '@ember/data/request/fetch';
* import RequestManager from '@ember-data/request';
* import Fetch from '@ember/data/request/fetch';
*
* class extends Store {
* constructor() {
Expand Down Expand Up @@ -2361,7 +2361,7 @@ class Store {
createCache(storeWrapper: CacheStoreWrapper): Cache {
if (HAS_JSON_API_PACKAGE) {
if (_Cache === undefined) {
_Cache = (importSync('@ember-data/json-api') as typeof import('@ember-data/json-api')).Cache;
_Cache = (importSync('@ember-data/json-api') as typeof import('@ember-data/json-api')).default;
}

return new _Cache(storeWrapper);
Expand Down
2 changes: 1 addition & 1 deletion packages/store/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
*
* ```js
* import Store from '@ember-data/store';
* import { Cache } from '@ember-data/json-api';
* import Cache from '@ember-data/json-api';
*
* class extends Store {
* createCache(storeWrapper) {
Expand Down
4 changes: 2 additions & 2 deletions tests/adapter-encapsulation/app/services/store.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Cache } from '@ember-data/json-api';
import Cache from '@ember-data/json-api';
import { LegacyNetworkHandler } from '@ember-data/legacy-compat';
import { RequestManager } from '@ember-data/request';
import RequestManager from '@ember-data/request';
import Store from '@ember-data/store';

export default class DefaultStore extends Store {
Expand Down
3 changes: 3 additions & 0 deletions tests/docs/fixtures/expected.js
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,9 @@ module.exports = {
'(public) @ember-data/request RequestManager#request',
'(public) @ember-data/request RequestManager#use',
'(public) @ember-data/request RequestManager#useCache',
'(public) @ember-data/request Future#abort',
'(public) @ember-data/request Future#getStream',
'(public) @ember-data/request Future#onFinalize',
'(public) @ember-data/serializer Serializer#normalize',
'(public) @ember-data/serializer Serializer#normalizeResponse',
'(public) @ember-data/serializer Serializer#serialize',
Expand Down
4 changes: 2 additions & 2 deletions tests/graph/app/services/store.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { LegacyNetworkHandler } from '@ember-data/legacy-compat';
import { RequestManager } from '@ember-data/request';
import { Fetch } from '@ember-data/request/fetch';
import RequestManager from '@ember-data/request';
import Fetch from '@ember-data/request/fetch';
import BaseStore from '@ember-data/store';

export default class Store extends BaseStore {
Expand Down
2 changes: 1 addition & 1 deletion tests/json-api/tests/integration/cache/documents-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { module, test } from 'qunit';

import { setupTest } from 'ember-qunit';

import { Cache } from '@ember-data/json-api';
import Cache from '@ember-data/json-api';
import Store from '@ember-data/store';
import type { NotificationType } from '@ember-data/store/-private/managers/notification-manager';
import type {
Expand Down
2 changes: 1 addition & 1 deletion tests/request/tests/integration/abort-test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { module, test } from 'qunit';

import { RequestManager } from '@ember-data/request';
import RequestManager from '@ember-data/request';
import type { Context } from '@ember-data/request/-private/context';
import type { Future, Handler, NextFn, RequestInfo } from '@ember-data/request/-private/types';

Expand Down
2 changes: 1 addition & 1 deletion tests/request/tests/integration/custom-abort-test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { module, test } from 'qunit';

import { RequestManager } from '@ember-data/request';
import RequestManager from '@ember-data/request';
import type { Context } from '@ember-data/request/-private/context';
import type { Future, Handler, NextFn, RequestInfo } from '@ember-data/request/-private/types';

Expand Down
2 changes: 1 addition & 1 deletion tests/request/tests/integration/error-propagation-test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { module, test } from 'qunit';

import { RequestManager } from '@ember-data/request';
import RequestManager from '@ember-data/request';
import type { Context } from '@ember-data/request/-private/context';
import type { Future, Handler, NextFn, StructuredErrorDocument } from '@ember-data/request/-private/types';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

import { module, test } from 'qunit';

import { RequestManager } from '@ember-data/request';
import RequestManager from '@ember-data/request';
import type { Context } from '@ember-data/request/-private/context';
import type { Handler, NextFn } from '@ember-data/request/-private/types';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

import { module, test } from 'qunit';

import { RequestManager } from '@ember-data/request';
import RequestManager from '@ember-data/request';
import type { Context } from '@ember-data/request/-private/context';
import type { Handler, NextFn } from '@ember-data/request/-private/types';

Expand Down
2 changes: 1 addition & 1 deletion tests/request/tests/integration/immutability-test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { module, test } from 'qunit';

import { RequestManager } from '@ember-data/request';
import RequestManager from '@ember-data/request';
import type { Context } from '@ember-data/request/-private/context';
import type { Handler, NextFn } from '@ember-data/request/-private/types';

Expand Down
2 changes: 1 addition & 1 deletion tests/request/tests/integration/response-currying-test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { module, test } from 'qunit';

import { RequestManager } from '@ember-data/request';
import RequestManager from '@ember-data/request';
import type { Context } from '@ember-data/request/-private/context';
import type { Handler, NextFn } from '@ember-data/request/-private/types';

Expand Down
2 changes: 1 addition & 1 deletion tests/request/tests/integration/response-test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { module, test } from 'qunit';

import { RequestManager } from '@ember-data/request';
import RequestManager from '@ember-data/request';
import type { Context } from '@ember-data/request/-private/context';
import type { Handler, NextFn } from '@ember-data/request/-private/types';

Expand Down
2 changes: 1 addition & 1 deletion tests/request/tests/integration/service-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { module, test } from 'qunit';

import { setupTest } from 'ember-qunit';

import { RequestManager } from '@ember-data/request';
import RequestManager from '@ember-data/request';

module('RequestManager | Ember Service Setup', function (hooks: NestedHooks) {
setupTest(hooks);
Expand Down
2 changes: 1 addition & 1 deletion tests/request/tests/integration/setup-test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { module, test } from 'qunit';

import { RequestManager } from '@ember-data/request';
import RequestManager from '@ember-data/request';
import type { Context as HandlerRequestContext } from '@ember-data/request/-private/context';
import type { NextFn } from '@ember-data/request/-private/types';

Expand Down
Loading

0 comments on commit 59eb2b6

Please sign in to comment.