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

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/declarations/compat/builders/find-all.d.ts

@@ -13,7 +13,7 @@ type FindAllRequestInput<
 	};
 	[RequestSignature]?: RT;
 };
-type FindAllBuilderOptions<T = unknown> = FindAllOptions<T>;
+type FindAllBuilderOptions = FindAllOptions;
 /**
 This function builds a request config to perform a `findAll` request for the given type.
 When passed to `store.request`, this config will result in the same behavior as a `store.findAll` request.
@@ -30,6 +30,6 @@ To that end, these builders are deprecated and will be removed in a future versi
 @param {FindAllBuilderOptions} [options] optional, may include `adapterOptions` hash which will be passed to adapter.findAll
 @return {FindAllRequestInput} request config
 */
-export declare function findAllBuilder<T extends TypedRecordInstance>(type: TypeFromInstance<T>, options?: FindAllBuilderOptions<T>): FindAllRequestInput<TypeFromInstance<T>, T[]>;
+export declare function findAllBuilder<T extends TypedRecordInstance>(type: TypeFromInstance<T>, options?: FindAllBuilderOptions): FindAllRequestInput<TypeFromInstance<T>, T[]>;
 export declare function findAllBuilder(type: string, options?: FindAllBuilderOptions): FindAllRequestInput;
 export {};

package/declarations/compat/builders/query.d.ts

@@ -31,7 +31,7 @@ To that end, these builders are deprecated and will be removed in a future versi
 @param {QueryBuilderOptions} [options] optional, may include `adapterOptions` hash which will be passed to adapter.query
 @return {QueryRequestInput} request config
 */
-export declare function queryBuilder<T extends TypedRecordInstance>(type: TypeFromInstance<T>, query: LegacyResourceQuery<T>, options?: QueryBuilderOptions): QueryRequestInput<TypeFromInstance<T>, T[]>;
+export declare function queryBuilder<T extends TypedRecordInstance>(type: TypeFromInstance<T>, query: LegacyResourceQuery, options?: QueryBuilderOptions): QueryRequestInput<TypeFromInstance<T>, T[]>;
 export declare function queryBuilder(type: string, query: LegacyResourceQuery, options?: QueryBuilderOptions): QueryRequestInput;
 type QueryRecordRequestInput<
 	T extends string = string,
@@ -61,6 +61,6 @@ To that end, these builders are deprecated and will be removed in a future versi
 @param {QueryBuilderOptions} [options] optional, may include `adapterOptions` hash which will be passed to adapter.query
 @return {QueryRecordRequestInput} request config
 */
-export declare function queryRecordBuilder<T extends TypedRecordInstance>(type: TypeFromInstance<T>, query: LegacyResourceQuery<T>, options?: QueryBuilderOptions): QueryRecordRequestInput<TypeFromInstance<T>, T | null>;
+export declare function queryRecordBuilder<T extends TypedRecordInstance>(type: TypeFromInstance<T>, query: LegacyResourceQuery, options?: QueryBuilderOptions): QueryRecordRequestInput<TypeFromInstance<T>, T | null>;
 export declare function queryRecordBuilder(type: string, query: LegacyResourceQuery, options?: QueryBuilderOptions): QueryRecordRequestInput;
 export {};

package/declarations/model/-private.d.ts

@@ -6,3 +6,4 @@ export { PromiseBelongsTo } from "./-private/promise-belongs-to.js";
 export { PromiseManyArray } from "./-private/promise-many-array.js";
 // // Used by tests, migration support
 export { lookupLegacySupport, LEGACY_SUPPORT } from "./-private/legacy-relationships-support.js";
+export type { MaybeHasManyFields, MaybeBelongsToFields, MaybeRelationshipFields } from "./-private/type-utils.js";

package/declarations/model/migration-support.d.ts

@@ -249,7 +249,7 @@ export declare class DelegatingSchemaService implements SchemaService {
 	CAUTION_MEGA_DANGER_ZONE_resourceExtensions(resource: StableRecordIdentifier | {
 		type: string;
 	}): null | ProcessedExtension["features"];
-	CAUTION_MEGA_DANGER_ZONE_objectExtensions(field: ExtensibleField): null | ProcessedExtension["features"];
+	CAUTION_MEGA_DANGER_ZONE_objectExtensions(field: ExtensibleField, resolvedType: string | null): null | ProcessedExtension["features"];
 	CAUTION_MEGA_DANGER_ZONE_arrayExtensions(field: ExtensibleField): null | ProcessedExtension["features"];
 	/**
 	* This is an internal method used to register behaviors for legacy mode.

package/declarations/store/-private.d.ts

@@ -1,18 +1,18 @@
 import { type InstanceCache } from "@warp-drive/core/store/-private";
 import type { StableNewRecordIdentifier, StableRecordIdentifier } from "@warp-drive/core/types/identifier";
 import type { Value } from "@warp-drive/core/types/json/raw";
-import type { Includes, OpaqueRecordInstance, TypedRecordInstance, TypeFromInstance } from "@warp-drive/core/types/record";
+import type { OpaqueRecordInstance, TypedRecordInstance, TypeFromInstance } from "@warp-drive/core/types/record";
 import type { LegacyAttributeField, LegacyRelationshipField } from "@warp-drive/core/types/schema/fields";
 import type { SingleResourceDocument } from "@warp-drive/core/types/spec/json-api-raw";
 import type { Store } from "../store.js";
 export declare function preloadData(store: Store, identifier: StableNewRecordIdentifier, preload: Record<string, Value>): void;
-export interface BaseFinderOptions<T = unknown> {
+export interface BaseFinderOptions {
 	reload?: boolean;
 	backgroundReload?: boolean;
-	include?: T extends TypedRecordInstance ? Includes<T>[] : string | string[];
+	include?: string | string[];
 	adapterOptions?: Record<string, unknown>;
 }
-export interface FindRecordOptions<T = unknown> extends BaseFinderOptions<T> {
+export interface FindRecordOptions extends BaseFinderOptions {
 	/**
 	* Data to preload into the store before the request is made.
 	* This feature is *highly* discouraged and has no corresponding
@@ -31,9 +31,9 @@ export interface FindRecordOptions<T = unknown> extends BaseFinderOptions<T> {
 	preload?: Record<string, Value>;
 }
 export type QueryOptions = { [K in string | "adapterOptions"]? : K extends "adapterOptions" ? Record<string, unknown> : unknown };
-export type FindAllOptions<T = unknown> = BaseFinderOptions<T>;
-export type LegacyResourceQuery<T = unknown> = {
-	include?: T extends TypedRecordInstance ? Includes<T>[] : string | string[];
+export type FindAllOptions = BaseFinderOptions;
+export type LegacyResourceQuery = {
+	include?: string | string[];
 	[key: string]: Value | undefined;
 };
 export type KeyOrString<T> = keyof T & string extends never ? string : keyof T & string;

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/dist/model/migration-support.js

@@ -310,27 +310,32 @@ function registerDerivations(schema) {
   schema._registerMode('@legacy', {
     belongsTo: {
       get(store, record, cacheKey, field) {
+        // FIXME field.name here should likely be field.sourceKey || field.name
         return lookupLegacySupport(record).getBelongsTo(field.name);
       },
       set(store, record, cacheKey, field, value) {
         store._join(() => {
+          // FIXME field.name here should likely be field.sourceKey || field.name
           lookupLegacySupport(record).setDirtyBelongsTo(field.name, value);
         });
       }
     },
     hasMany: {
       get(store, record, cacheKey, field) {
+        // FIXME field.name here should likely be field.sourceKey || field.name
         return lookupLegacySupport(record).getHasMany(field.name);
       },
       set(store, record, cacheKey, field, value) {
         store._join(() => {
           const support = lookupLegacySupport(record);
+          // FIXME field.name here should likely be field.sourceKey || field.name
           const manyArray = support.getManyArray(field.name);
           manyArray.splice(0, manyArray.length, ...value);
         });
       },
       notify(store, record, cacheKey, field) {
         const support = lookupLegacySupport(record);
+        // FIXME field.name here should likely be field.sourceKey || field.name
         const manyArray = support && support._manyArrayCache[field.name];
         const hasPromise = support && support._relationshipPromisesCache[field.name];
         if (manyArray && hasPromise) {
@@ -480,8 +485,8 @@ class DelegatingSchemaService {
   CAUTION_MEGA_DANGER_ZONE_resourceExtensions(resource) {
     return this._preferred.CAUTION_MEGA_DANGER_ZONE_resourceExtensions(resource);
   }
-  CAUTION_MEGA_DANGER_ZONE_objectExtensions(field) {
-    return this._preferred.CAUTION_MEGA_DANGER_ZONE_objectExtensions(field);
+  CAUTION_MEGA_DANGER_ZONE_objectExtensions(field, resolvedType) {
+    return this._preferred.CAUTION_MEGA_DANGER_ZONE_objectExtensions(field, resolvedType);
   }
   CAUTION_MEGA_DANGER_ZONE_arrayExtensions(field) {
     return this._preferred.CAUTION_MEGA_DANGER_ZONE_arrayExtensions(field);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@warp-drive/legacy",
-  "version": "5.7.0-alpha.1",
+  "version": "5.7.0-alpha.11",
   "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.11",
+    "@warp-drive/utilities": "5.7.0-alpha.11"
   },
   "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.11",
+    "@warp-drive/core": "5.7.0-alpha.11",
+    "@warp-drive/utilities": "5.7.0-alpha.11",
     "ember-source": "~6.3.0",
     "decorator-transforms": "^2.3.0",
     "expect-type": "^1.2.1",