@warp-drive/core 5.7.0-alpha.2 → 5.7.0-alpha.4

package/declarations/types/schema/fields.d.ts

@@ -29,6 +29,29 @@ export interface GenericField {
 	*/
 	name: string;
 	/**
+	* The name of the field as returned by the API
+	* and inserted into the {@link Cache} if it differs
+	* from {@link GenericField.name}
+	*
+	* For instance, if the API returns:
+	*
+	* ```ts
+	* {
+	*   attributes: {
+	*     'first-name': 'Chris'
+	*   }
+	* }
+	* ```
+	*
+	* But the app desires to use `record.firstName; // 'Chris'`
+	*
+	* Then `name` would be set to `'firstName'` and
+	* `sourceKey` would be set to `'first-name'`.
+	*
+	* This option is only needed when the value differs from name.
+	*/
+	sourceKey?: string;
+	/**
 	* the name of the transform to use, if any
 	*
 	* @public
@@ -234,6 +257,27 @@ export interface IdentityField {
 	* @public
 	*/
 	name: string;
+	/**
+	* The name of the field as returned by the API
+	* and inserted into the {@link Cache} if it differs
+	* from {@link IdentityField.name}
+	*
+	* For instance, if the API returns:
+	*
+	* ```ts
+	* {
+	*   entityUrn: '324523-sadf34-345'
+	* }
+	* ```
+	*
+	* But the app desires to use `record.id; // '324523-sadf34-345'`
+	*
+	* Then `name` would be set to `'id'` and
+	* `sourceKey` would be set to `'entityUrn'`.
+	*
+	* This option is only needed when the value differs from name.
+	*/
+	sourceKey?: string;
 }
 /**
 * Represents a specialized field whose computed value
@@ -374,6 +418,29 @@ export interface ObjectField {
 	*/
 	name: string;
 	/**
+	* The name of the field as returned by the API
+	* and inserted into the {@link Cache} if it differs
+	* from {@link ObjectField.name}
+	*
+	* For instance, if the API returns:
+	*
+	* ```ts
+	* {
+	*   attributes: {
+	*     'first-name': 'Chris'
+	*   }
+	* }
+	* ```
+	*
+	* But the app desires to use `record.firstName; // 'Chris'`
+	*
+	* Then `name` would be set to `'firstName'` and
+	* `sourceKey` would be set to `'first-name'`.
+	*
+	* This option is only needed when the value differs from name.
+	*/
+	sourceKey?: string;
+	/**
 	* The name of a transform to pass the entire object
 	* through before displaying or serializing it.
 	*
@@ -430,6 +497,29 @@ export interface SchemaObjectField {
 	*/
 	name: string;
 	/**
+	* The name of the field as returned by the API
+	* and inserted into the {@link Cache} if it differs
+	* from {@link SchemaObjectField.name}
+	*
+	* For instance, if the API returns:
+	*
+	* ```ts
+	* {
+	*   attributes: {
+	*     'first-name': 'Chris'
+	*   }
+	* }
+	* ```
+	*
+	* But the app desires to use `record.firstName; // 'Chris'`
+	*
+	* Then `name` would be set to `'firstName'` and
+	* `sourceKey` would be set to `'first-name'`.
+	*
+	* This option is only needed when the value differs from name.
+	*/
+	sourceKey?: string;
+	/**
 	* The name of the ObjectSchema that describes the
 	* structure of the object.
 	*
@@ -502,6 +592,29 @@ export interface ArrayField {
 	*/
 	name: string;
 	/**
+	* The name of the field as returned by the API
+	* and inserted into the {@link Cache} if it differs
+	* from {@link ArrayField.name}
+	*
+	* For instance, if the API returns:
+	*
+	* ```ts
+	* {
+	*   attributes: {
+	*     'first-name': 'Chris'
+	*   }
+	* }
+	* ```
+	*
+	* But the app desires to use `record.firstName; // 'Chris'`
+	*
+	* Then `name` would be set to `'firstName'` and
+	* `sourceKey` would be set to `'first-name'`.
+	*
+	* This option is only needed when the value differs from name.
+	*/
+	sourceKey?: string;
+	/**
 	* The name of a transform to pass each item
 	* in the array through before displaying or
 	* or serializing it.
@@ -558,6 +671,29 @@ export interface SchemaArrayField {
 	*/
 	name: string;
 	/**
+	* The name of the field as returned by the API
+	* and inserted into the {@link Cache} if it differs
+	* from {@link SchemaArrayField.name}
+	*
+	* For instance, if the API returns:
+	*
+	* ```ts
+	* {
+	*   attributes: {
+	*     'first-name': 'Chris'
+	*   }
+	* }
+	* ```
+	*
+	* But the app desires to use `record.firstName; // 'Chris'`
+	*
+	* Then `name` would be set to `'firstName'` and
+	* `sourceKey` would be set to `'first-name'`.
+	*
+	* This option is only needed when the value differs from name.
+	*/
+	sourceKey?: string;
+	/**
 	* The name of the ObjectSchema that describes the
 	* structure of the objects in the array.
 	*
@@ -743,6 +879,29 @@ export interface ResourceField {
 	*/
 	name: string;
 	/**
+	* The name of the field as returned by the API
+	* and inserted into the {@link Cache} if it differs
+	* from {@link ResourceField.name}
+	*
+	* For instance, if the API returns:
+	*
+	* ```ts
+	* {
+	*   attributes: {
+	*     'first-name': 'Chris'
+	*   }
+	* }
+	* ```
+	*
+	* But the app desires to use `record.firstName; // 'Chris'`
+	*
+	* Then `name` would be set to `'firstName'` and
+	* `sourceKey` would be set to `'first-name'`.
+	*
+	* This option is only needed when the value differs from name.
+	*/
+	sourceKey?: string;
+	/**
 	* The name of the resource that this field
 	* refers to. In the case of a polymorphic
 	* relationship, this should be the trait
@@ -825,6 +984,29 @@ export interface CollectionField {
 	*/
 	name: string;
 	/**
+	* The name of the field as returned by the API
+	* and inserted into the {@link Cache} if it differs
+	* from {@link CollectionField.name}
+	*
+	* For instance, if the API returns:
+	*
+	* ```ts
+	* {
+	*   attributes: {
+	*     'first-name': 'Chris'
+	*   }
+	* }
+	* ```
+	*
+	* But the app desires to use `record.firstName; // 'Chris'`
+	*
+	* Then `name` would be set to `'firstName'` and
+	* `sourceKey` would be set to `'first-name'`.
+	*
+	* This option is only needed when the value differs from name.
+	*/
+	sourceKey?: string;
+	/**
 	* The name of the resource that this field
 	* refers to. In the case of a polymorphic
 	* relationship, this should be the trait
@@ -925,6 +1107,29 @@ export interface LegacyAttributeField {
 	*/
 	name: string;
 	/**
+	* The name of the field as returned by the API
+	* and inserted into the {@link Cache} if it differs
+	* from {@link LegacyAttributeField.name}
+	*
+	* For instance, if the API returns:
+	*
+	* ```ts
+	* {
+	*   attributes: {
+	*     'first-name': 'Chris'
+	*   }
+	* }
+	* ```
+	*
+	* But the app desires to use `record.firstName; // 'Chris'`
+	*
+	* Then `name` would be set to `'firstName'` and
+	* `sourceKey` would be set to `'first-name'`.
+	*
+	* This option is only needed when the value differs from name.
+	*/
+	sourceKey?: string;
+	/**
 	* The name of the transform to use, if any
 	*
 	* @public
@@ -964,6 +1169,29 @@ export interface LegacyBelongsToField {
 	*/
 	name: string;
 	/**
+	* The name of the field as returned by the API
+	* and inserted into the {@link Cache} if it differs
+	* from {@link LegacyBelongsToField.name}
+	*
+	* For instance, if the API returns:
+	*
+	* ```ts
+	* {
+	*   attributes: {
+	*     'first-name': 'Chris'
+	*   }
+	* }
+	* ```
+	*
+	* But the app desires to use `record.firstName; // 'Chris'`
+	*
+	* Then `name` would be set to `'firstName'` and
+	* `sourceKey` would be set to `'first-name'`.
+	*
+	* This option is only needed when the value differs from name.
+	*/
+	sourceKey?: string;
+	/**
 	* The name of the resource that this field
 	* refers to. In the case of a polymorphic
 	* relationship, this should be the trait
@@ -1094,6 +1322,29 @@ export interface LinksModeBelongsToField {
 	*/
 	name: string;
 	/**
+	* The name of the field as returned by the API
+	* and inserted into the {@link Cache} if it differs
+	* from {@link LinksModeBelongsToField.name}
+	*
+	* For instance, if the API returns:
+	*
+	* ```ts
+	* {
+	*   attributes: {
+	*     'first-name': 'Chris'
+	*   }
+	* }
+	* ```
+	*
+	* But the app desires to use `record.firstName; // 'Chris'`
+	*
+	* Then `name` would be set to `'firstName'` and
+	* `sourceKey` would be set to `'first-name'`.
+	*
+	* This option is only needed when the value differs from name.
+	*/
+	sourceKey?: string;
+	/**
 	* The name of the resource that this field
 	* refers to. In the case of a polymorphic
 	* relationship, this should be the trait
@@ -1219,6 +1470,29 @@ export interface LegacyHasManyField {
 	*/
 	name: string;
 	/**
+	* The name of the field as returned by the API
+	* and inserted into the {@link Cache} if it differs
+	* from {@link LegacyHasManyField.name}
+	*
+	* For instance, if the API returns:
+	*
+	* ```ts
+	* {
+	*   attributes: {
+	*     'first-name': 'Chris'
+	*   }
+	* }
+	* ```
+	*
+	* But the app desires to use `record.firstName; // 'Chris'`
+	*
+	* Then `name` would be set to `'firstName'` and
+	* `sourceKey` would be set to `'first-name'`.
+	*
+	* This option is only needed when the value differs from name.
+	*/
+	sourceKey?: string;
+	/**
 	* the name of the resource that this field
 	* refers to. In the case of a polymorphic
 	* relationship, this should be the trait
@@ -1367,6 +1641,29 @@ export interface LinksModeHasManyField {
 	*/
 	name: string;
 	/**
+	* The name of the field as returned by the API
+	* and inserted into the {@link Cache} if it differs
+	* from {@link LinksModeHasManyField.name}
+	*
+	* For instance, if the API returns:
+	*
+	* ```ts
+	* {
+	*   attributes: {
+	*     'first-name': 'Chris'
+	*   }
+	* }
+	* ```
+	*
+	* But the app desires to use `record.firstName; // 'Chris'`
+	*
+	* Then `name` would be set to `'firstName'` and
+	* `sourceKey` would be set to `'first-name'`.
+	*
+	* This option is only needed when the value differs from name.
+	*/
+	sourceKey?: string;
+	/**
 	* the name of the resource that this field
 	* refers to. In the case of a polymorphic
 	* relationship, this should be the trait
@@ -1548,12 +1845,23 @@ export type PolarisModeFieldSchema = GenericField | PolarisAliasField | LocalFie
 */
 export type FieldSchema = GenericField | LegacyAliasField | PolarisAliasField | LocalField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | DerivedField | ResourceField | CollectionField | LegacyAttributeField | LegacyBelongsToField | LegacyHasManyField | LinksModeBelongsToField | LinksModeHasManyField;
 /**
+* A union of all possible LegacyMode and PolarisMode
+* field schemas that represent data that could be in
+* the cache.
+*
+* In other words this will not include types like alias
+* fields, local fields, or derived fields.
+*
+* @public
+*/
+export type CacheableFieldSchema = IdentityField | GenericField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | ResourceField | CollectionField | LegacyAttributeField | LegacyBelongsToField | LegacyHasManyField | LinksModeBelongsToField | LinksModeHasManyField;
+/**
 * A union of all possible field schemas that can be
 * used in an ObjectSchema.
 *
 * @public
 */
-export type ObjectFieldSchema = GenericField | ObjectAliasField | LocalField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | DerivedField;
+export type ObjectFieldSchema = LegacyAttributeField | GenericField | ObjectAliasField | LocalField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | DerivedField;
 /**
 * Represents a schema for a primary resource in PolarisMode.
 *
@@ -1570,8 +1878,6 @@ export interface PolarisResourceSchema {
 	*
 	* for schema-objects, this should be either a HashField or null
 	*
-	* @property identity
-	* @type {IdentityField}
 	* @public
 	*/
 	identity: IdentityField;

package/dist/graph/-private.js

@@ -1,5 +1,5 @@
 import { deprecate, warn } from '@ember/debug';
-import { p as peekCache } from "../request-state-CejVJgdj.js";
+import { p as peekCache } from "../request-state-Bj0zUw2r.js";
 import '../types/request.js';
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 import '../utils/string.js';

package/dist/{handler-D2jjnIA-.js → handler-Gm-q2q05.js}

@@ -1,4 +1,4 @@
-import { K as ReactiveDocument } from "./request-state-CejVJgdj.js";
+import { K as ReactiveDocument } from "./request-state-Bj0zUw2r.js";
 import { SkipCache, EnableHydration } from './types/request.js';
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 const MUTATION_OPS = new Set(['createRecord', 'updateRecord', 'deleteRecord']);

package/dist/index.js

@@ -3,8 +3,8 @@ import { a as cloneResponseProperties, I as IS_CACHE_HANDLER, b as assertValidRe
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 import { w as waitFor } from "./configure-B48bFHOl.js";
 import { peekUniversalTransient, setUniversalTransient } from './types/-private.js';
-export { S as Store, r as recordIdentifierFor, O as setIdentifierForgetMethod, L as setIdentifierGenerationMethod, P as setIdentifierResetMethod, N as setIdentifierUpdateMethod, Q as setKeyInfoForResource, s as storeFor } from "./request-state-CejVJgdj.js";
-export { C as CacheHandler } from "./handler-D2jjnIA-.js";
+export { S as Store, r as recordIdentifierFor, O as setIdentifierForgetMethod, L as setIdentifierGenerationMethod, P as setIdentifierResetMethod, N as setIdentifierUpdateMethod, Q as setKeyInfoForResource, s as storeFor } from "./request-state-Bj0zUw2r.js";
+export { C as CacheHandler } from "./handler-Gm-q2q05.js";
 import '@ember/debug';
 import './utils/string.js';