@warp-drive/legacy 5.6.0-alpha.15 → 5.6.0-alpha.17

package/declarations/adapter/json-api.d.ts

@@ -1,234 +1,233 @@
-import type { Store } from '@warp-drive/core';
-import type { ModelSchema } from '@warp-drive/core/types';
-import type { HTTPMethod } from '@warp-drive/core/types/request';
-import type { AdapterPayload } from '../compat.ts';
-import type { Snapshot, SnapshotRecordArray } from '../compat/-private.ts';
-import type { FetchRequestInit, JQueryRequestInit, QueryState } from './rest.ts';
-import { RESTAdapter } from './rest.ts';
+import type { Store } from "@warp-drive/core";
+import type { ModelSchema } from "@warp-drive/core/types";
+import type { HTTPMethod } from "@warp-drive/core/types/request";
+import type { AdapterPayload } from "../compat.js";
+import type { Snapshot, SnapshotRecordArray } from "../compat/-private.js";
+import type { FetchRequestInit, JQueryRequestInit, QueryState } from "./rest.js";
+import { RESTAdapter } from "./rest.js";
 /**
-  ## Overview
+## Overview
 
-  <blockquote style="margin: 1em; padding: .1em 1em .1em 1em; border-left: solid 1em #E34C32; background: #e0e0e0;">
-  <p>
-    ⚠️ <strong>This is LEGACY documentation</strong> for a feature that is no longer encouraged to be used.
-    If starting a new app or thinking of implementing a new adapter, consider writing a
-    <a href="/ember-data/release/classes/%3CInterface%3E%20Handler">Handler</a> instead to be used with the <a href="https://github.com/emberjs/data/tree/main/packages/request#readme">RequestManager</a>
-  </p>
-  </blockquote>
+<blockquote style="margin: 1em; padding: .1em 1em .1em 1em; border-left: solid 1em #E34C32; background: #e0e0e0;">
+<p>
+⚠️ <strong>This is LEGACY documentation</strong> for a feature that is no longer encouraged to be used.
+If starting a new app or thinking of implementing a new adapter, consider writing a
+<a href="/ember-data/release/classes/%3CInterface%3E%20Handler">Handler</a> instead to be used with the <a href="https://github.com/emberjs/data/tree/main/packages/request#readme">RequestManager</a>
+</p>
+</blockquote>
 
-  The `JSONAPIAdapter` is an adapter whichtransforms the store's
-  requests into HTTP requests that follow the [JSON API format](http://jsonapi.org/format/).
+The `JSONAPIAdapter` is an adapter whichtransforms the store's
+requests into HTTP requests that follow the [JSON API format](http://jsonapi.org/format/).
 
-  ## JSON API Conventions
+## JSON API Conventions
 
-  The JSONAPIAdapter uses JSON API conventions for building the URL
-  for a record and selecting the HTTP verb to use with a request. The
-  actions you can take on a record map onto the following URLs in the
-  JSON API adapter:
+The JSONAPIAdapter uses JSON API conventions for building the URL
+for a record and selecting the HTTP verb to use with a request. The
+actions you can take on a record map onto the following URLs in the
+JSON API adapter:
 
 <table>
-  <tr>
-    <th>
-      Action
-    </th>
-    <th>
-      HTTP Verb
-    </th>
-    <th>
-      URL
-    </th>
-  </tr>
-  <tr>
-    <th>
-      `store.findRecord('post', 123)`
-    </th>
-    <td>
-      GET
-    </td>
-    <td>
-      /posts/123
-    </td>
-  </tr>
-  <tr>
-    <th>
-      `store.findAll('post')`
-    </th>
-    <td>
-      GET
-    </td>
-    <td>
-      /posts
-    </td>
-  </tr>
-  <tr>
-    <th>
-      Update `postRecord.save()`
-    </th>
-    <td>
-      PATCH
-    </td>
-    <td>
-      /posts/123
-    </td>
-  </tr>
-  <tr>
-    <th>
-      Create `store.createRecord('post').save()`
-    </th>
-    <td>
-      POST
-    </td>
-    <td>
-      /posts
-    </td>
-  </tr>
-  <tr>
-    <th>
-      Delete `postRecord.destroyRecord()`
-    </th>
-    <td>
-      DELETE
-    </td>
-    <td>
-      /posts/123
-    </td>
-  </tr>
+<tr>
+<th>
+Action
+</th>
+<th>
+HTTP Verb
+</th>
+<th>
+URL
+</th>
+</tr>
+<tr>
+<th>
+`store.findRecord('post', 123)`
+</th>
+<td>
+GET
+</td>
+<td>
+/posts/123
+</td>
+</tr>
+<tr>
+<th>
+`store.findAll('post')`
+</th>
+<td>
+GET
+</td>
+<td>
+/posts
+</td>
+</tr>
+<tr>
+<th>
+Update `postRecord.save()`
+</th>
+<td>
+PATCH
+</td>
+<td>
+/posts/123
+</td>
+</tr>
+<tr>
+<th>
+Create `store.createRecord('post').save()`
+</th>
+<td>
+POST
+</td>
+<td>
+/posts
+</td>
+</tr>
+<tr>
+<th>
+Delete `postRecord.destroyRecord()`
+</th>
+<td>
+DELETE
+</td>
+<td>
+/posts/123
+</td>
+</tr>
 </table>
 
-  ## Success and failure
+## Success and failure
 
-  The JSONAPIAdapter will consider a success any response with a
-  status code of the 2xx family ("Success"), as well as 304 ("Not
-  Modified"). Any other status code will be considered a failure.
+The JSONAPIAdapter will consider a success any response with a
+status code of the 2xx family ("Success"), as well as 304 ("Not
+Modified"). Any other status code will be considered a failure.
 
-  On success, the request promise will be resolved with the full
-  response payload.
+On success, the request promise will be resolved with the full
+response payload.
 
-  Failed responses with status code 422 ("Unprocessable Entity") will
-  be considered "invalid". The response will be discarded, except for
-  the `errors` key. The request promise will be rejected with a
-  `InvalidError`. This error object will encapsulate the saved
-  `errors` value.
+Failed responses with status code 422 ("Unprocessable Entity") will
+be considered "invalid". The response will be discarded, except for
+the `errors` key. The request promise will be rejected with a
+`InvalidError`. This error object will encapsulate the saved
+`errors` value.
 
-  Any other status codes will be treated as an adapter error. The
-  request promise will be rejected, similarly to the invalid case,
-  but with an instance of `AdapterError` instead.
+Any other status codes will be treated as an adapter error. The
+request promise will be rejected, similarly to the invalid case,
+but with an instance of `AdapterError` instead.
 
-  ### Endpoint path customization
+### Endpoint path customization
 
-  Endpoint paths can be prefixed with a `namespace` by setting the
-  namespace property on the adapter:
+Endpoint paths can be prefixed with a `namespace` by setting the
+namespace property on the adapter:
 
-  ```js [app/adapters/application.js]
-  import JSONAPIAdapter from '@ember-data/adapter/json-api';
+```js [app/adapters/application.js]
+import JSONAPIAdapter from '@ember-data/adapter/json-api';
 
-  export default class ApplicationAdapter extends JSONAPIAdapter {
-    namespace = 'api/1';
-  }
-  ```
-  Requests for the `person` model would now target `/api/1/people/1`.
+export default class ApplicationAdapter extends JSONAPIAdapter {
+namespace = 'api/1';
+}
+```
+Requests for the `person` model would now target `/api/1/people/1`.
 
-  ### Host customization
+### Host customization
 
-  An adapter can target other hosts by setting the `host` property.
+An adapter can target other hosts by setting the `host` property.
 
-  ```js [app/adapters/application.js]
-  import JSONAPIAdapter from '@ember-data/adapter/json-api';
+```js [app/adapters/application.js]
+import JSONAPIAdapter from '@ember-data/adapter/json-api';
 
-  export default class ApplicationAdapter extends JSONAPIAdapter {
-    host = 'https://api.example.com';
-  }
-  ```
+export default class ApplicationAdapter extends JSONAPIAdapter {
+host = 'https://api.example.com';
+}
+```
 
-  Requests for the `person` model would now target
-  `https://api.example.com/people/1`.
+Requests for the `person` model would now target
+`https://api.example.com/people/1`.
 
-  @since 1.13.0
-  @class JSONAPIAdapter
-  @public
-  @constructor
+@since 1.13.0
+@class JSONAPIAdapter
+@public
+@constructor
 */
 declare class JSONAPIAdapter extends RESTAdapter {
-    _defaultContentType: string;
-    /**
-      @private
-      @param {String} url
-      @param {String} type The request type GET, POST, PUT, DELETE etc.
-      @param {Object} options
-      @return {Object}
-    */
-    ajaxOptions(url: string, type: HTTPMethod, options?: JQueryAjaxSettings | RequestInit): JQueryRequestInit | FetchRequestInit;
-    /**
-      By default the JSONAPIAdapter will send each find request coming from a `store.find`
-      or from accessing a relationship separately to the server. If your server supports passing
-      ids as a query string, you can set coalesceFindRequests to true to coalesce all find requests
-      within a single runloop.
-  
-      For example, if you have an initial payload of:
-  
-      ```javascript
-      {
-        data: {
-          id: 1,
-          type: 'post',
-          relationship: {
-            comments: {
-              data: [
-                { id: 1, type: 'comment' },
-                { id: 2, type: 'comment' }
-              ]
-            }
-          }
-        }
-      }
-      ```
-  
-      By default calling `post.comments` will trigger the following requests(assuming the
-      comments haven't been loaded before):
-  
-      ```
-      GET /comments/1
-      GET /comments/2
-      ```
-  
-      If you set coalesceFindRequests to `true` it will instead trigger the following request:
-  
-      ```
-      GET /comments?filter[id]=1,2
-      ```
-  
-      Setting coalesceFindRequests to `true` also works for `store.find` requests and `belongsTo`
-      relationships accessed within the same runloop. If you set `coalesceFindRequests: true`
-  
-      ```javascript
-      store.findRecord('comment', 1);
-      store.findRecord('comment', 2);
-      ```
-  
-      will also send a request to: `GET /comments?filter[id]=1,2`
-  
-      Note: Requests coalescing rely on URL building strategy. So if you override `buildURL` in your app
-      `groupRecordsForFindMany` more likely should be overridden as well in order for coalescing to work.
-  
-      @property coalesceFindRequests
-      @public
-      @type {Boolean}
-    */
-    get coalesceFindRequests(): boolean;
-    set coalesceFindRequests(value: boolean);
-    findMany(store: Store, type: ModelSchema, ids: string[], snapshots: Snapshot[]): Promise<AdapterPayload>;
-    pathForType(modelName: string): string;
-    updateRecord(store: Store, schema: ModelSchema, snapshot: Snapshot): Promise<AdapterPayload>;
-    /**
-      Used by `findAll` and `findRecord` to build the query's `data` hash
-      supplied to the ajax method.
-  
-      @since 2.5.0
-      @public
-      @param  {Snapshot} snapshot
-      @return {Object}
-    */
-    buildQuery(snapshot: Snapshot | SnapshotRecordArray): QueryState;
+	_defaultContentType: string;
+	/**
+	@private
+	@param {String} url
+	@param {String} type The request type GET, POST, PUT, DELETE etc.
+	@param {Object} options
+	@return {Object}
+	*/
+	ajaxOptions(url: string, type: HTTPMethod, options?: JQueryAjaxSettings | RequestInit): JQueryRequestInit | FetchRequestInit;
+	/**
+	By default the JSONAPIAdapter will send each find request coming from a `store.find`
+	or from accessing a relationship separately to the server. If your server supports passing
+	ids as a query string, you can set coalesceFindRequests to true to coalesce all find requests
+	within a single runloop.
+	
+	For example, if you have an initial payload of:
+	
+	```javascript
+	{
+	data: {
+	id: 1,
+	type: 'post',
+	relationship: {
+	comments: {
+	data: [
+	{ id: 1, type: 'comment' },
+	{ id: 2, type: 'comment' }
+	]
+	}
+	}
+	}
+	}
+	```
+	
+	By default calling `post.comments` will trigger the following requests(assuming the
+	comments haven't been loaded before):
+	
+	```
+	GET /comments/1
+	GET /comments/2
+	```
+	
+	If you set coalesceFindRequests to `true` it will instead trigger the following request:
+	
+	```
+	GET /comments?filter[id]=1,2
+	```
+	
+	Setting coalesceFindRequests to `true` also works for `store.find` requests and `belongsTo`
+	relationships accessed within the same runloop. If you set `coalesceFindRequests: true`
+	
+	```javascript
+	store.findRecord('comment', 1);
+	store.findRecord('comment', 2);
+	```
+	
+	will also send a request to: `GET /comments?filter[id]=1,2`
+	
+	Note: Requests coalescing rely on URL building strategy. So if you override `buildURL` in your app
+	`groupRecordsForFindMany` more likely should be overridden as well in order for coalescing to work.
+	
+	@property coalesceFindRequests
+	@public
+	@type {Boolean}
+	*/
+	get coalesceFindRequests(): boolean;
+	set coalesceFindRequests(value: boolean);
+	findMany(store: Store, type: ModelSchema, ids: string[], snapshots: Snapshot[]): Promise<AdapterPayload>;
+	pathForType(modelName: string): string;
+	updateRecord(store: Store, schema: ModelSchema, snapshot: Snapshot): Promise<AdapterPayload>;
+	/**
+	Used by `findAll` and `findRecord` to build the query's `data` hash
+	supplied to the ajax method.
+	
+	@since 2.5.0
+	@public
+	@param  {Snapshot} snapshot
+	@return {Object}
+	*/
+	buildQuery(snapshot: Snapshot | SnapshotRecordArray): QueryState;
 }
 export { JSONAPIAdapter };
-//# sourceMappingURL=json-api.d.ts.map