More type changes

- simplify readme type instruction
- drop redundant async in ajax.ts
- add credentials to FetchOptions type
- add FetchAdapter interface for our object literal and better support
Mixin.create typing

Author: xg-wang

README.md

@@ -36,10 +36,19 @@ import fetch, { Headers, Request, Response, AbortController } from 'fetch';
 ```
 
 ### Use with TypeScript
-To use `ember-fetch` with TypeScript or enable editor's type support, add `"fetch": "ember-cli/ember-fetch"` to your app's `devDependencies`.
-This will get the current state of `ember-fetch` from this GitHub repo as a dependency.
-
-You can also add `"fetch": ["node_modules/ember-fetch"]` to your `tsconfig.json`.
+To use `ember-fetch` with TypeScript or enable editor's type support, You can add `"fetch": ["node_modules/ember-fetch"]` to your `tsconfig.json`.
+
+```json
+{
+  "compilerOptions": {
+    "paths": {
+      "fetch": [
+        "node_modules/ember-fetch"
+      ]
+    }
+  }
+}
+```
 
 ### Use with Ember Data
 To have Ember Data utilize `fetch` instead of jQuery.ajax to make calls to your backend, extend your project's `application` adapter with the `adapter-fetch` mixin.
@@ -112,7 +121,8 @@ The way you do import remains same.
 
 ## Q & A
 ### Does it work with pretender?
-Yes, [pretender v2.1](https://github.com/pretenderjs/pretender/tree/v2.1.0) comes with `fetch` support.
+
+* Yes, [pretender v2.1](https://github.com/pretenderjs/pretender/tree/v2.1.0) comes with `fetch` support.
 
 ### Does this replace ic-ajax?
 

addon/ajax.ts

@@ -1,7 +1,7 @@
 
 import fetch from 'fetch';
 
-export default async function ajax(
+export default function ajax(
   input: RequestInfo,
   init?: RequestInit
 ): Promise<Response> {

addon/mixins/adapter-fetch.ts

@@ -15,13 +15,14 @@ import {
   Nullable,
   AjaxOptions
 } from 'ember-fetch/types';
+import { Fix } from '@ember/object/-private/types';
 
 /**
  * Helper function to create a plain object from the response's Headers.
  * Consumed by the adapter's `handleResponse`.
  */
-export function headersToObject(headers: Headers): PlainObject {
-  let headersObject: PlainObject = {};
+export function headersToObject(headers: Headers) {
+  let headersObject: PlainObject<string> = {};
 
   if (headers) {
     headers.forEach((value, key) => (headersObject[key] = value));
@@ -30,8 +31,35 @@ export function headersToObject(headers: Headers): PlainObject {
   return headersObject;
 }
 
-export default Mixin.create({
-  headers: undefined as undefined | PlainHeaders,
+export interface FetchAdapter {
+  headers: undefined | PlainHeaders;
+  ajaxOptions(url: string, type: Method, options: object): FetchOptions;
+  ajax(url: string, type: Method, options: object): RSVP.Promise<void>;
+  _ajaxRequest(
+    options: Mix<RequestInit, { url: string }>
+  ): RSVP.Promise<Response>;
+  _fetchRequest(url: string, options: RequestInit): RSVP.Promise<Response>;
+  ajaxSuccess(
+    adapter: DS.RESTAdapter,
+    response: Response,
+    payload: Nullable<string | object>,
+    requestData: { url: string; method: string }
+  ): object | DS.AdapterError | RSVP.Promise<void>;
+  parseFetchResponseForError(
+    response: Response,
+    payload: Nullable<object | string>
+  ): object | string;
+  ajaxError(
+    adapter: any,
+    response: Response,
+    payload: Nullable<string | object>,
+    requestData: object,
+    error?: Error
+  ): Error | object | DS.AdapterError;
+}
+
+export default Mixin.create<FetchAdapter, DS.RESTAdapter>({
+  headers: undefined,
   /**
    * @override
    */
@@ -129,18 +157,22 @@ export default Mixin.create({
    * @override
    */
   ajaxSuccess(
-    adapter: any,
+    adapter: DS.RESTAdapter,
     response: Response,
     payload: Nullable<string | object>,
     requestData: { url: string; method: string }
-  ): object | DS.AdapterError | RSVP.Promise<never> {
+  ): object | DS.AdapterError | RSVP.Promise<void> {
     const returnResponse = adapter.handleResponse(
       response.status,
       headersToObject(response.headers),
+      // TODO: DS.RESTAdapter annotates payload: {}
+      // @ts-ignore
       payload,
       requestData
     );
 
+    // TODO: DS.RESTAdapter annotates response: {}
+    // @ts-ignore
     if (returnResponse && returnResponse.isAdapterError) {
       return reject(returnResponse);
     } else {
@@ -154,7 +186,7 @@ export default Mixin.create({
    */
   parseFetchResponseForError(
     response: Response,
-    payload: object | string
+    payload: Nullable<object | string>
   ): object | string {
     return payload || response.statusText;
   },
@@ -163,7 +195,7 @@ export default Mixin.create({
    * @override
    */
   ajaxError(
-    adapter: any,
+    adapter: Fix<FetchAdapter & DS.RESTAdapter>,
     response: Response,
     payload: Nullable<string | object>,
     requestData: object,
@@ -179,6 +211,8 @@ export default Mixin.create({
       return adapter.handleResponse(
         response.status,
         headersToObject(response.headers),
+        // TODO: parseErrorResponse is DS.RESTAdapter private API
+        // @ts-ignore
         adapter.parseErrorResponse(parsedResponse) || payload,
         requestData
       );

addon/types.ts

@@ -2,12 +2,12 @@ import Mix from '@ember/polyfills/types';
 
 export type Nullable<T> = T | null | undefined;
 
-export interface PlainObject {
-  [key: string]: string | PlainObject | PlainObject[];
+export type PlainObject<T = string | number | boolean> = {
+  [key: string]: T | PlainObject<T> | PlainObject<T>[];
 }
 
-export interface PlainHeaders {
-  [key: string]: string | undefined | null;
+export type PlainHeaders = {
+  [key: string]: string;
 }
 
 export type Method =
@@ -22,13 +22,15 @@ export type Method =
 export type AjaxOptions = {
   url: string;
   type: Method;
-  data?: PlainObject | BodyInit;
+  data?: PlainObject<string> | BodyInit;
   headers?: PlainHeaders;
 };
 
+export type Credentials = 'omit' | 'same-origin' | 'include';
+
 export type FetchOptions = Mix<
   AjaxOptions,
-  { body?: BodyInit | null; method?: Method }
+  { body?: BodyInit | null; method?: Method, credentials: Credentials }
 >;
 
 export function isPlainObject(obj: any): obj is PlainObject {

types/dummy/index.d.ts

@@ -1 +0,0 @@
-