@warp-drive/legacy 5.7.0-alpha.1 → 5.7.0-alpha.3

package/declarations/adapter/error.d.ts

@@ -1,8 +1,8 @@
-import type { JsonApiError } from "@warp-drive/core/store/-types/q/record-data-json-api";
+import type { ApiError } from "@warp-drive/core/types/spec/error";
 export interface AdapterRequestError<T extends string = string> extends Error {
 	isAdapterError: true;
 	code: T;
-	errors: JsonApiError[];
+	errors: ApiError[];
 }
 export interface AdapterRequestErrorConstructor<Instance extends AdapterRequestError = AdapterRequestError> {
 	new (errors?: unknown[], message?: string): Instance;

package/dist/adapter/error.js

@@ -4,6 +4,72 @@ import { macroCondition, getGlobalConfig } from '@embroider/macros';
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 
+/**
+  ## 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>
+
+  An `AdapterError` is used by an adapter to signal that an error occurred
+  during a request to an external API. It indicates a generic error, and
+  subclasses are used to indicate specific error states.
+
+  To create a custom error to signal a specific error state in communicating
+  with an external API, extend the `AdapterError`. For example, if the
+  external API exclusively used HTTP `503 Service Unavailable` to indicate
+  it was closed for maintenance:
+
+  ```js [app/adapters/maintenance-error.js]
+  import AdapterError from '@ember-data/adapter/error';
+
+  export default AdapterError.extend({ message: "Down for maintenance." });
+  ```
+
+  This error would then be returned by an adapter's `handleResponse` method:
+
+  ```js [app/adapters/application.js]
+  import JSONAPIAdapter from '@ember-data/adapter/json-api';
+  import MaintenanceError from './maintenance-error';
+
+  export default class ApplicationAdapter extends JSONAPIAdapter {
+    handleResponse(status) {
+      if (503 === status) {
+        return new MaintenanceError();
+      }
+
+      return super.handleResponse(...arguments);
+    }
+  }
+  ```
+
+  And can then be detected in an application and used to send the user to an
+  `under-maintenance` route:
+
+  ```js [app/routes/application.js]
+  import MaintenanceError from '../adapters/maintenance-error';
+
+  export default class ApplicationRoute extends Route {
+    actions: {
+      error(error, transition) {
+        if (error instanceof MaintenanceError) {
+          this.transitionTo('under-maintenance');
+          return;
+        }
+
+        // ...other error handling logic
+      }
+    }
+  }
+  ```
+
+  @class AdapterError
+  @public
+*/
 function _AdapterError(errors, message = 'Adapter operation failed') {
   this.isAdapterError = true;
   const error = Error.call(this, message);

package/dist/adapter/rest.js

@@ -776,7 +776,7 @@ class RESTAdapter extends AdapterWithBuildURLMixin {
     if (this.isSuccess(status, headers, payload)) {
       return payload;
     } else if (this.isInvalid(status, headers, payload)) {
-      // @ts-expect-error needs cast to JsonApiError
+      // @ts-expect-error needs cast to ApiError
       return new InvalidError(typeof payload === 'object' && 'errors' in payload ? payload.errors : undefined);
     }
     const errors = this.normalizeErrorResponse(status, headers, payload);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@warp-drive/legacy",
-  "version": "5.7.0-alpha.1",
+  "version": "5.7.0-alpha.3",
   "description": "Decommissioned Packages for WarpDrive | Things your app might still want to maintain use of for a little longer.",
   "keywords": [
     "ember-addon"
@@ -32,8 +32,8 @@
     }
   },
   "peerDependencies": {
-    "@warp-drive/core": "5.7.0-alpha.1",
-    "@warp-drive/utilities": "5.7.0-alpha.1"
+    "@warp-drive/core": "5.7.0-alpha.3",
+    "@warp-drive/utilities": "5.7.0-alpha.3"
   },
   "dependencies": {
     "@embroider/macros": "^1.16.12"
@@ -43,9 +43,9 @@
     "@babel/plugin-transform-typescript": "^7.27.0",
     "@babel/preset-typescript": "^7.27.0",
     "@types/jquery": "^3.5.32",
-    "@warp-drive/internal-config": "5.7.0-alpha.1",
-    "@warp-drive/core": "5.7.0-alpha.1",
-    "@warp-drive/utilities": "5.7.0-alpha.1",
+    "@warp-drive/internal-config": "5.7.0-alpha.3",
+    "@warp-drive/core": "5.7.0-alpha.3",
+    "@warp-drive/utilities": "5.7.0-alpha.3",
     "ember-source": "~6.3.0",
     "decorator-transforms": "^2.3.0",
     "expect-type": "^1.2.1",