@warp-drive-mirror/utilities 5.7.0 → 5.8.0-alpha.10

package/README.md

@@ -15,10 +15,13 @@
 
 ![NPM Stable Version](https://img.shields.io/npm/v/ember-data/latest?label=version&style=flat&color=FFC474)
 ![NPM Downloads](https://img.shields.io/npm/dm/ember-data.svg?style=flat&color=FFC474)
-![License](https://img.shields.io/github/license/emberjs/data.svg?style=flat&color=FFC474)
+![License](https://img.shields.io/github/license/warp-drive-data/warp-drive.svg?style=flat&color=FFC474)
 [![Docs](./logos/docs-badge.svg)](https://docs.warp-drive.io)
-[![Discord Community Server](https://img.shields.io/badge/Discord-grey?logo=discord&logoColor=FFC474)](https://discord.gg/zT3asNS
+[![EmberJS Discord Community Server](https://img.shields.io/badge/EmberJS-grey?logo=discord&logoColor=FFC474)](https://discord.gg/zT3asNS
 )
+[![WarpDrive Discord Server](https://img.shields.io/badge/WarpDrive-grey?logo=discord&logoColor=FFC474)](https://discord.gg/PHBbnWJx5S
+)
+
 
 <br>
 
@@ -45,7 +48,7 @@ pnpm add -E @warp-drive-mirror/utilities
 
 ## Code of Conduct
 
-Refer to the [Code of Conduct](https://github.com/emberjs/data/blob/main/CODE_OF_CONDUCT.md) for community guidelines and inclusivity.
+Refer to the [Code of Conduct](https://github.com/warp-drive-data/warp-drive/blob/main/CODE_OF_CONDUCT.md) for community guidelines and inclusivity.
 
 <br>
 

package/declarations/-private/active-record/find-record.d.ts

@@ -1,9 +1,6 @@
+import type { ReactiveDataDocument } from "@warp-drive-mirror/core/reactive";
 import type { TypeFromInstance } from "@warp-drive-mirror/core/types/record";
 import type { FindRecordOptions, FindRecordRequestOptions, RemotelyAccessibleIdentifier } from "@warp-drive-mirror/core/types/request";
-import type { SingleResourceDataDocument } from "@warp-drive-mirror/core/types/spec/document";
-export type FindRecordResultDocument<T> = Omit<SingleResourceDataDocument<T>, "data"> & {
-	data: T;
-};
 /**
 * Builds request options to fetch a single resource by a known id or identifier
 * configured for the url and header expectations of most ActiveRecord APIs.
@@ -59,7 +56,9 @@ export type FindRecordResultDocument<T> = Omit<SingleResourceDataDocument<T>, "d
 * @param identifier
 * @param options
 */
-export declare function findRecord<T>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
+export declare function findRecord<T>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions): FindRecordRequestOptions<ReactiveDataDocument<T>, T>;
 export declare function findRecord(identifier: RemotelyAccessibleIdentifier, options?: FindRecordOptions): FindRecordRequestOptions;
-export declare function findRecord<T>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
+export declare function findRecord<T>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions): FindRecordRequestOptions<ReactiveDataDocument<T>, T>;
 export declare function findRecord(type: string, id: string, options?: FindRecordOptions): FindRecordRequestOptions;
+/** @deprecated use {@link ReactiveDataDocument} instead */
+export type FindRecordResultDocument<T> = ReactiveDataDocument<T>;

package/declarations/-private/active-record/query.d.ts

@@ -1,7 +1,7 @@
+import type { ReactiveDataDocument } from "@warp-drive-mirror/core/reactive";
 import type { QueryParamsSource } from "@warp-drive-mirror/core/types/params";
 import type { TypeFromInstance } from "@warp-drive-mirror/core/types/record";
 import type { ConstrainedRequestOptions, QueryRequestOptions } from "@warp-drive-mirror/core/types/request";
-import type { CollectionResourceDataDocument } from "@warp-drive-mirror/core/types/spec/document";
 /**
 * Builds request options to query for resources, usually by a primary
 * type, configured for the url and header expectations of most ActiveRecord APIs.
@@ -49,5 +49,5 @@ import type { CollectionResourceDataDocument } from "@warp-drive-mirror/core/typ
 * @param query
 * @param options
 */
-export declare function query<T>(type: TypeFromInstance<T>, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions<CollectionResourceDataDocument<T>>;
+export declare function query<T>(type: TypeFromInstance<T>, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions<ReactiveDataDocument<T[]>>;
 export declare function query(type: string, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions;

package/declarations/-private/active-record/save-record.d.ts

@@ -1,6 +1,6 @@
+import type { ReactiveDataDocument } from "@warp-drive-mirror/core/reactive";
 import type { TypedRecordInstance } from "@warp-drive-mirror/core/types/record";
 import type { ConstrainedRequestOptions, CreateRequestOptions, DeleteRequestOptions, UpdateRequestOptions } from "@warp-drive-mirror/core/types/request";
-import type { SingleResourceDataDocument } from "@warp-drive-mirror/core/types/spec/document";
 /**
 * Builds request options to delete record for resources,
 * configured for the url, method and header expectations of ActiveRecord APIs.
@@ -140,7 +140,7 @@ export declare function updateRecord<
 	RT extends TypedRecordInstance = T
 >(record: T, options?: ConstrainedRequestOptions & {
 	patch?: boolean;
-}): UpdateRequestOptions<SingleResourceDataDocument<RT>, T>;
+}): UpdateRequestOptions<ReactiveDataDocument<RT>, T>;
 export declare function updateRecord(record: unknown, options?: ConstrainedRequestOptions & {
 	patch?: boolean;
 }): UpdateRequestOptions;

package/declarations/-private/handlers/meta-doc.d.ts

@@ -40,7 +40,7 @@ import type { Handler } from "@warp-drive-mirror/core/request";
 * ```
 *
 * Errors are not processed by this handler, so if the request fails and the error response
-* is not in {JSON:API} format additional processing may be needed.
+* is not in {json:api} format additional processing may be needed.
 *
 * @group Handlers
 */

package/declarations/-private/json-api/find-record.d.ts

@@ -1,6 +1,6 @@
+import type { ReactiveDataDocument } from "@warp-drive-mirror/core/reactive";
 import type { TypeFromInstance } from "@warp-drive-mirror/core/types/record";
 import type { FindRecordOptions, FindRecordRequestOptions, RemotelyAccessibleIdentifier } from "@warp-drive-mirror/core/types/request";
-import type { SingleResourceDataDocument } from "@warp-drive-mirror/core/types/spec/document";
 /**
 * Builds request options to fetch a single resource by a known id or identifier
 * configured for the url and header expectations of most JSON:API APIs.
@@ -53,13 +53,10 @@ import type { SingleResourceDataDocument } from "@warp-drive-mirror/core/types/s
 * ```
 *
 * @public
-* @param identifier
-* @param options
 */
-export type FindRecordResultDocument<T> = Omit<SingleResourceDataDocument<T>, "data"> & {
-	data: T;
-};
-export declare function findRecord<T>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
+export declare function findRecord<T>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions): FindRecordRequestOptions<ReactiveDataDocument<T>, T>;
 export declare function findRecord(identifier: RemotelyAccessibleIdentifier, options?: FindRecordOptions): FindRecordRequestOptions;
-export declare function findRecord<T>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
+export declare function findRecord<T>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions): FindRecordRequestOptions<ReactiveDataDocument<T>, T>;
 export declare function findRecord(type: string, id: string, options?: FindRecordOptions): FindRecordRequestOptions;
+/** @deprecated use {@link ReactiveDataDocument} */
+export type FindRecordResultDocument<T> = ReactiveDataDocument<T>;

package/declarations/-private/json-api/query.d.ts

@@ -1,7 +1,7 @@
+import type { ReactiveDataDocument } from "@warp-drive-mirror/core/reactive";
 import type { QueryParamsSource } from "@warp-drive-mirror/core/types/params";
 import type { TypedRecordInstance, TypeFromInstance } from "@warp-drive-mirror/core/types/record";
 import type { ConstrainedRequestOptions, PostQueryRequestOptions, QueryRequestOptions } from "@warp-drive-mirror/core/types/request";
-import type { CollectionResourceDataDocument } from "@warp-drive-mirror/core/types/spec/document";
 /**
 * Builds request options to query for resources, usually by a primary
 * type, configured for the url and header expectations of most JSON:API APIs.
@@ -49,11 +49,8 @@ import type { CollectionResourceDataDocument } from "@warp-drive-mirror/core/typ
 * ```
 *
 * @public
-* @param identifier
-* @param query
-* @param options
 */
-export declare function query<T extends TypedRecordInstance>(type: TypeFromInstance<T>, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions<CollectionResourceDataDocument<T>>;
+export declare function query<T extends TypedRecordInstance>(type: TypeFromInstance<T>, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions<ReactiveDataDocument<T[]>>;
 export declare function query(type: string, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions;
 /**
 * Builds request options to query for resources, usually by a primary
@@ -99,5 +96,5 @@ export declare function query(type: string, query?: QueryParamsSource, options?:
 * @param query
 * @param options
 */
-export declare function postQuery<T>(type: TypeFromInstance<T>, query?: QueryParamsSource, options?: ConstrainedRequestOptions): PostQueryRequestOptions<CollectionResourceDataDocument<T>>;
+export declare function postQuery<T>(type: TypeFromInstance<T>, query?: QueryParamsSource, options?: ConstrainedRequestOptions): PostQueryRequestOptions<ReactiveDataDocument<T[]>>;
 export declare function postQuery(type: string, query?: QueryParamsSource, options?: ConstrainedRequestOptions): PostQueryRequestOptions;

package/declarations/-private/json-api/save-record.d.ts

@@ -1,6 +1,6 @@
+import type { ReactiveDataDocument } from "@warp-drive-mirror/core/reactive.js";
 import type { TypedRecordInstance } from "@warp-drive-mirror/core/types/record";
 import type { ConstrainedRequestOptions, CreateRequestOptions, DeleteRequestOptions, UpdateRequestOptions } from "@warp-drive-mirror/core/types/request";
-import type { SingleResourceDataDocument } from "@warp-drive-mirror/core/types/spec/document";
 /**
 * Builds request options to delete record for resources,
 * configured for the url, method and header expectations of most JSON:API APIs.
@@ -140,7 +140,7 @@ export declare function updateRecord<
 	RT extends TypedRecordInstance = T
 >(record: T, options?: ConstrainedRequestOptions & {
 	patch?: boolean;
-}): UpdateRequestOptions<SingleResourceDataDocument<RT>, T>;
+}): UpdateRequestOptions<ReactiveDataDocument<RT>, T>;
 export declare function updateRecord(record: unknown, options?: ConstrainedRequestOptions & {
 	patch?: boolean;
 }): UpdateRequestOptions;

package/declarations/-private/rest/find-record.d.ts

@@ -1,6 +1,6 @@
+import type { ReactiveDataDocument } from "@warp-drive-mirror/core/reactive";
 import type { TypeFromInstance } from "@warp-drive-mirror/core/types/record";
 import type { FindRecordOptions, FindRecordRequestOptions, RemotelyAccessibleIdentifier } from "@warp-drive-mirror/core/types/request";
-import type { SingleResourceDataDocument } from "@warp-drive-mirror/core/types/spec/document";
 /**
 * Builds request options to fetch a single resource by a known id or identifier
 * configured for the url and header expectations of most REST APIs.
@@ -53,13 +53,10 @@ import type { SingleResourceDataDocument } from "@warp-drive-mirror/core/types/s
 * ```
 *
 * @public
-* @param identifier
-* @param options
 */
-export type FindRecordResultDocument<T> = Omit<SingleResourceDataDocument<T>, "data"> & {
-	data: T;
-};
-export declare function findRecord<T>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
+export declare function findRecord<T>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions): FindRecordRequestOptions<ReactiveDataDocument<T>, T>;
 export declare function findRecord(identifier: RemotelyAccessibleIdentifier, options?: FindRecordOptions): FindRecordRequestOptions;
-export declare function findRecord<T>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
+export declare function findRecord<T>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions): FindRecordRequestOptions<ReactiveDataDocument<T>, T>;
 export declare function findRecord(type: string, id: string, options?: FindRecordOptions): FindRecordRequestOptions;
+/** @deprecated use {@link ReactiveDataDocument} instead */
+export type FindRecordResultDocument<T> = ReactiveDataDocument<T>;

package/declarations/-private/rest/query.d.ts

@@ -1,7 +1,7 @@
+import type { ReactiveDataDocument } from "@warp-drive-mirror/core/reactive";
 import type { QueryParamsSource } from "@warp-drive-mirror/core/types/params";
 import type { TypeFromInstance } from "@warp-drive-mirror/core/types/record";
 import type { ConstrainedRequestOptions, QueryRequestOptions } from "@warp-drive-mirror/core/types/request";
-import type { CollectionResourceDataDocument } from "@warp-drive-mirror/core/types/spec/document";
 /**
 * Builds request options to query for resources, usually by a primary
 * type, configured for the url and header expectations of most REST APIs.
@@ -49,5 +49,5 @@ import type { CollectionResourceDataDocument } from "@warp-drive-mirror/core/typ
 * @param query
 * @param options
 */
-export declare function query<T>(type: TypeFromInstance<T>, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions<CollectionResourceDataDocument<T>>;
+export declare function query<T>(type: TypeFromInstance<T>, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions<ReactiveDataDocument<T[]>>;
 export declare function query(type: string, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions;

package/declarations/-private/rest/save-record.d.ts

@@ -1,6 +1,6 @@
+import type { ReactiveDataDocument } from "@warp-drive-mirror/core/reactive";
 import type { TypedRecordInstance } from "@warp-drive-mirror/core/types/record";
 import type { ConstrainedRequestOptions, CreateRequestOptions, DeleteRequestOptions, UpdateRequestOptions } from "@warp-drive-mirror/core/types/request";
-import type { SingleResourceDataDocument } from "@warp-drive-mirror/core/types/spec/document";
 /**
 * Builds request options to delete record for resources,
 * configured for the url, method and header expectations of REST APIs.
@@ -140,7 +140,7 @@ export declare function updateRecord<
 	RT extends TypedRecordInstance = T
 >(record: T, options?: ConstrainedRequestOptions & {
 	patch?: boolean;
-}): UpdateRequestOptions<SingleResourceDataDocument<RT>, T>;
+}): UpdateRequestOptions<ReactiveDataDocument<RT>, T>;
 export declare function updateRecord(record: unknown, options?: ConstrainedRequestOptions & {
 	patch?: boolean;
 }): UpdateRequestOptions;

package/dist/active-record.js

@@ -88,6 +88,8 @@ function findRecord(arg1, arg2, arg3) {
   };
 }
 
+/** @deprecated use {@link ReactiveDataDocument} instead */
+
 /**
  * Builds request options to query for resources, usually by a primary
  * type, configured for the url and header expectations of most ActiveRecord APIs.

package/dist/handlers.js

@@ -35,7 +35,7 @@ const DEFAULT_CONSTRAINTS = {
   DataView: 1000,
   String: 1000
 };
-const TypedArray = Object.getPrototypeOf(Uint8Array.prototype);
+const TypedArray = Object.getPrototypeOf(Uint8Array);
 
 /**
  * A request handler that automatically compresses the request body
@@ -84,7 +84,7 @@ class AutoCompress {
     const {
       body
     } = request;
-    const shouldCompress = isCompressibleMethod(request.method) && request.options?.compress !== false && (
+    const shouldCompress = !!body && isCompressibleMethod(request.method) && request.options?.compress !== false && (
     // prettier-ignore
     request.options?.compress ? true : typeof body === 'string' || body instanceof String ? canCompress('String', constraints, body.length) : body instanceof Blob ? canCompress('Blob', constraints, body.size) : body instanceof ArrayBuffer ? canCompress('ArrayBuffer', constraints, body.byteLength) : body instanceof DataView ? canCompress('DataView', constraints, body.byteLength) : body instanceof TypedArray ? canCompress('TypedArray', constraints, body.byteLength) : false);
     if (!shouldCompress) return next(request);
@@ -218,7 +218,7 @@ class Gate {
  * ```
  *
  * Errors are not processed by this handler, so if the request fails and the error response
- * is not in {JSON:API} format additional processing may be needed.
+ * is not in {json:api} format additional processing may be needed.
  *
  * @group Handlers
  */

package/dist/json-api.js

@@ -122,8 +122,6 @@ function setBuildURLConfig(config) {
  * ```
  *
  * @public
- * @param identifier
- * @param options
  */
 
 function findRecord(arg1, arg2, arg3) {
@@ -154,6 +152,8 @@ function findRecord(arg1, arg2, arg3) {
   };
 }
 
+/** @deprecated use {@link ReactiveDataDocument} */
+
 /**
  * Builds request options to query for resources, usually by a primary
  * type, configured for the url and header expectations of most JSON:API APIs.
@@ -201,9 +201,6 @@ function findRecord(arg1, arg2, arg3) {
  * ```
  *
  * @public
- * @param identifier
- * @param query
- * @param options
  */
 
 function query(type,

package/dist/rest.js

@@ -56,8 +56,6 @@ import { macroCondition, getGlobalConfig } from '@embroider/macros';
  * ```
  *
  * @public
- * @param identifier
- * @param options
  */
 
 function findRecord(arg1, arg2, arg3) {
@@ -88,6 +86,8 @@ function findRecord(arg1, arg2, arg3) {
   };
 }
 
+/** @deprecated use {@link ReactiveDataDocument} instead */
+
 /**
  * Builds request options to query for resources, usually by a primary
  * type, configured for the url and header expectations of most REST APIs.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@warp-drive-mirror/utilities",
-  "version": "5.7.0",
+  "version": "5.8.0-alpha.10",
   "description": "Utilities package for WarpDrive | Things your app might find useful",
   "keywords": [
     "ember-addon"
@@ -9,7 +9,7 @@
   "author": "Chris Thoburn <runspired@users.noreply.github.com>",
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com:emberjs/data.git",
+    "url": "git+ssh://git@github.com:warp-drive-data/warp-drive.git",
     "directory": "warp-drive-packages/utilities"
   },
   "files": [
@@ -36,7 +36,7 @@
     }
   },
   "peerDependencies": {
-    "@warp-drive-mirror/core": "5.7.0"
+    "@warp-drive-mirror/core": "5.8.0-alpha.10"
   },
   "dependencies": {
     "@embroider/macros": "^1.18.1"
@@ -45,8 +45,8 @@
     "@babel/core": "^7.28.3",
     "@babel/plugin-transform-typescript": "^7.28.0",
     "@babel/preset-typescript": "^7.27.1",
-    "@warp-drive/internal-config": "5.7.0",
-    "@warp-drive-mirror/core": "5.7.0",
+    "@warp-drive/internal-config": "5.8.0-alpha.10",
+    "@warp-drive-mirror/core": "5.8.0-alpha.10",
     "decorator-transforms": "^2.3.0",
     "expect-type": "^1.2.2",
     "typescript": "^5.9.2",