@warp-drive-mirror/utilities 5.7.0-alpha.2 → 5.7.0-alpha.21

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

@@ -59,7 +59,7 @@ export type FindRecordResultDocument<T> = Omit<SingleResourceDataDocument<T>, "d
 * @param identifier
 * @param options
 */
-export declare function findRecord<T>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions<T>): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
+export declare function findRecord<T>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
 export declare function findRecord(identifier: RemotelyAccessibleIdentifier, options?: FindRecordOptions): FindRecordRequestOptions;
-export declare function findRecord<T>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions<T>): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
+export declare function findRecord<T>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
 export declare function findRecord(type: string, id: string, options?: FindRecordOptions): FindRecordRequestOptions;

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

@@ -59,7 +59,7 @@ import type { SingleResourceDataDocument } from "@warp-drive-mirror/core/types/s
 export type FindRecordResultDocument<T> = Omit<SingleResourceDataDocument<T>, "data"> & {
 	data: T;
 };
-export declare function findRecord<T>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions<T>): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
+export declare function findRecord<T>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
 export declare function findRecord(identifier: RemotelyAccessibleIdentifier, options?: FindRecordOptions): FindRecordRequestOptions;
-export declare function findRecord<T>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions<T>): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
+export declare function findRecord<T>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
 export declare function findRecord(type: string, id: string, options?: FindRecordOptions): FindRecordRequestOptions;

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

@@ -53,7 +53,7 @@ import type { CollectionResourceDataDocument } from "@warp-drive-mirror/core/typ
 * @param query
 * @param options
 */
-export declare function query<T extends TypedRecordInstance>(type: TypeFromInstance<T>, query?: QueryParamsSource<T>, options?: ConstrainedRequestOptions): QueryRequestOptions<CollectionResourceDataDocument<T>, T>;
+export declare function query<T extends TypedRecordInstance>(type: TypeFromInstance<T>, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions<CollectionResourceDataDocument<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 +99,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>, T>;
+export declare function postQuery<T>(type: TypeFromInstance<T>, query?: QueryParamsSource, options?: ConstrainedRequestOptions): PostQueryRequestOptions<CollectionResourceDataDocument<T>>;
 export declare function postQuery(type: string, query?: QueryParamsSource, options?: ConstrainedRequestOptions): PostQueryRequestOptions;

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

@@ -1,5 +1,5 @@
 import type { Cache } from "@warp-drive-mirror/core/types/cache";
-import type { StableRecordIdentifier } from "@warp-drive-mirror/core/types/identifier";
+import type { ResourceKey } from "@warp-drive-mirror/core/types/identifier";
 import type { Value } from "@warp-drive-mirror/core/types/json/raw";
 import type { InnerRelationshipDocument, ResourceObject } from "@warp-drive-mirror/core/types/spec/json-api-raw";
 type ChangedRelationshipData = InnerRelationshipDocument;
@@ -20,13 +20,13 @@ export type JsonApiResourcePatch = {
 *
 * @public
 * @param {Cache} cache}
-* @param {StableRecordIdentifier} identifier
+* @param {ResourceKey} identifier
 * @return {Object} An object with a `data` property containing the serialized resource patch
 */
-export declare function serializeResources(cache: Cache, identifiers: StableRecordIdentifier): {
+export declare function serializeResources(cache: Cache, identifiers: ResourceKey): {
 	data: ResourceObject;
 };
-export declare function serializeResources(cache: Cache, identifiers: StableRecordIdentifier[]): {
+export declare function serializeResources(cache: Cache, identifiers: ResourceKey[]): {
 	data: ResourceObject[];
 };
 /**
@@ -47,10 +47,10 @@ export declare function serializeResources(cache: Cache, identifiers: StableReco
 *
 * @public
 * @param {Cache} cache}
-* @param {StableRecordIdentifier} identifier
+* @param {ResourceKey} identifier
 * @return {Object} An object with a `data` property containing the serialized resource patch
 */
-export declare function serializePatch(cache: Cache, identifier: StableRecordIdentifier): {
+export declare function serializePatch(cache: Cache, identifier: ResourceKey): {
 	data: JsonApiResourcePatch;
 };
 export {};

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

@@ -59,7 +59,7 @@ import type { SingleResourceDataDocument } from "@warp-drive-mirror/core/types/s
 export type FindRecordResultDocument<T> = Omit<SingleResourceDataDocument<T>, "data"> & {
 	data: T;
 };
-export declare function findRecord<T>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions<T>): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
+export declare function findRecord<T>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
 export declare function findRecord(identifier: RemotelyAccessibleIdentifier, options?: FindRecordOptions): FindRecordRequestOptions;
-export declare function findRecord<T>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions<T>): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
+export declare function findRecord<T>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
 export declare function findRecord(type: string, id: string, options?: FindRecordOptions): FindRecordRequestOptions;

package/declarations/derivations.d.ts

@@ -0,0 +1,27 @@
+import type { ReactiveResource } from "@warp-drive-mirror/core/reactive";
+import { Type } from "@warp-drive-mirror/core/types/symbols";
+interface ConcatDerivation {
+	(record: ReactiveResource & {
+		[key: string]: unknown;
+	}, options: Record<string, unknown> | null, _prop: string): string;
+	[Type]: "concat";
+}
+/**
+* A derivation for use by {@link ReactiveResource} that joins the given fields
+* with the optional separator (or '' if no separator is provided).
+*
+* Generally you should not need to import and use this function directly.
+*
+* @example
+* {
+*   name: 'fullName',
+*   kind: 'derived',
+*   type: 'concat',
+*   options: {
+*     fields: ['firstName', 'lastName'],
+*     separator: ' ',
+*   },
+* }
+*/
+export declare const concat: ConcatDerivation;
+export {};

package/dist/derivations.js

@@ -0,0 +1,30 @@
+import { Type } from '@warp-drive-mirror/core/types/symbols';
+
+/**
+ * A derivation for use by {@link ReactiveResource} that joins the given fields
+ * with the optional separator (or '' if no separator is provided).
+ *
+ * Generally you should not need to import and use this function directly.
+ *
+ * @example
+ * {
+ *   name: 'fullName',
+ *   kind: 'derived',
+ *   type: 'concat',
+ *   options: {
+ *     fields: ['firstName', 'lastName'],
+ *     separator: ' ',
+ *   },
+ * }
+ */
+const concat = (record, options, _prop) => {
+  if (!options) {
+    throw new Error(`options is required`);
+  }
+  // SAFETY: we cast internally to a more specific type, for our own use
+  // SAFETY: but provide the more general signature to the schema service
+  const opts = options;
+  return opts.fields.map(field => record[field]).join(opts.separator ?? '');
+};
+concat[Type] = 'concat';
+export { concat };

package/dist/json-api.js

@@ -538,7 +538,7 @@ function updateRecord(record, options = {}) {
  *
  * @public
  * @param {Cache} cache}
- * @param {StableRecordIdentifier} identifier
+ * @param {ResourceKey} identifier
  * @return {Object} An object with a `data` property containing the serialized resource patch
  */
 function serializeResources(cache, identifiers) {
@@ -623,7 +623,7 @@ function _serializeResource(cache, identifier) {
  *
  * @public
  * @param {Cache} cache}
- * @param {StableRecordIdentifier} identifier
+ * @param {ResourceKey} identifier
  * @return {Object} An object with a `data` property containing the serialized resource patch
  */
 function serializePatch(cache, identifier) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@warp-drive-mirror/utilities",
-  "version": "5.7.0-alpha.2",
+  "version": "5.7.0-alpha.21",
   "description": "Utilities package for WarpDrive | Things your app might find useful",
   "keywords": [
     "ember-addon"
@@ -36,7 +36,7 @@
     }
   },
   "peerDependencies": {
-    "@warp-drive-mirror/core": "5.7.0-alpha.2"
+    "@warp-drive-mirror/core": "5.7.0-alpha.21"
   },
   "dependencies": {
     "@embroider/macros": "^1.16.12"
@@ -45,8 +45,8 @@
     "@babel/core": "^7.26.10",
     "@babel/plugin-transform-typescript": "^7.27.0",
     "@babel/preset-typescript": "^7.27.0",
-    "@warp-drive/internal-config": "5.7.0-alpha.2",
-    "@warp-drive-mirror/core": "5.7.0-alpha.2",
+    "@warp-drive/internal-config": "5.7.0-alpha.21",
+    "@warp-drive-mirror/core": "5.7.0-alpha.21",
     "decorator-transforms": "^2.3.0",
     "expect-type": "^1.2.1",
     "typescript": "^5.8.3",