@warp-drive/core 5.7.0-alpha.10 → 5.7.0-alpha.12

package/declarations/graph/-private/-utils.d.ts

@@ -15,7 +15,7 @@ export declare function getStore(wrapper: CacheCapabilitiesManager | {
 export declare function expandingGet<T>(cache: Record<string, Record<string, T>>, key1: string, key2: string): T | undefined;
 export declare function expandingSet<T>(cache: Record<string, Record<string, T>>, key1: string, key2: string, value: T): void;
 export declare function assertValidRelationshipPayload(graph: Graph, op: UpdateRelationshipOperation | UpdateResourceRelationshipOperation): void;
-export declare function isNew(identifier: StableRecordIdentifier): boolean;
+export declare function checkIfNew(store: Store, identifier: StableRecordIdentifier): boolean;
 export declare function isBelongsTo(relationship: GraphEdge): relationship is ResourceEdge;
 export declare function isImplicit(relationship: GraphEdge): relationship is ImplicitEdge;
 export declare function isHasMany(relationship: GraphEdge): relationship is CollectionEdge;

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

@@ -1,3 +1,4 @@
+import type { Store } from "../../store/-private.js";
 import type { CacheCapabilitiesManager, StableRecordIdentifier } from "../../types.js";
 import type { RelationshipDiff } from "../../types/cache.js";
 import type { MergeOperation } from "../../types/cache/operations.js";
@@ -39,6 +40,7 @@ export declare class Graph {
 	_potentialPolymorphicTypes: Record<string, Record<string, boolean>>;
 	identifiers: Map<StableRecordIdentifier, Record<string, GraphEdge>>;
 	store: CacheCapabilitiesManager;
+	_realStore: Store;
 	isDestroyed: boolean;
 	_willSyncRemote: boolean;
 	_willSyncLocal: boolean;

package/declarations/reactive/-private/fields/managed-array.d.ts

@@ -4,15 +4,14 @@ import type { StableRecordIdentifier } from "../../../types/identifier.js";
 import type { ArrayField, SchemaArrayField } from "../../../types/schema/fields.js";
 import type { KindContext } from "../default-mode.js";
 import { ReactiveResource } from "../record.js";
-import { Editable, Legacy, SOURCE } from "../symbols.js";
+import { Context, SOURCE } from "../symbols.js";
 export interface ManagedArray extends Omit<Array<unknown>, "[]"> {
 	[SOURCE]: unknown[];
 	identifier: StableRecordIdentifier;
 	path: string | string[];
 	owner: ReactiveResource;
 	[ARRAY_SIGNAL]: WarpDriveSignal;
-	[Editable]: boolean;
-	[Legacy]: boolean;
+	[Context]: KindContext<SchemaArrayField | ArrayField>;
 }
 // eslint-disable-next-line @typescript-eslint/no-extraneous-class
 export declare class ManagedArray {

package/declarations/reactive/-private/fields/managed-object.d.ts

@@ -1,18 +1,14 @@
 import { OBJECT_SIGNAL, type WarpDriveSignal } from "../../../store/-private.js";
-import type { StableRecordIdentifier } from "../../../types/identifier.js";
 import type { ObjectField, SchemaObjectField } from "../../../types/schema/fields.js";
 import type { KindContext } from "../default-mode.js";
 import type { ReactiveResource } from "../record.js";
-import { Editable, EmbeddedPath, Legacy, Parent, SOURCE } from "../symbols.js";
+import { Context, SOURCE } from "../symbols.js";
 export declare function notifyObject(obj: ManagedObject): void;
 // const ignoredGlobalFields = new Set<string>(['setInterval', 'nodeType', 'nodeName', 'length', 'document', STRUCTURED]);
 export interface ManagedObject {
 	[SOURCE]: object;
-	[Parent]: StableRecordIdentifier;
-	[EmbeddedPath]: string[];
+	[Context]: KindContext<ObjectField>;
 	[OBJECT_SIGNAL]: WarpDriveSignal;
-	[Editable]: boolean;
-	[Legacy]: boolean;
 }
 // eslint-disable-next-line @typescript-eslint/no-extraneous-class
 export declare class ManagedObject {

package/declarations/reactive/-private/record.d.ts

@@ -1,26 +1,13 @@
-import type { Store } from "../../index.js";
-import type { StableRecordIdentifier } from "../../types/identifier.js";
-import type { SchemaArrayField, SchemaObjectField } from "../../types/schema/fields.js";
+import type { Store } from "../../store/-private.js";
 import { RecordStore } from "../../types/symbols.js";
 import type { ObjectContext, ResourceContext } from "./default-mode.js";
-import { Checkout, Destroy, Editable, EmbeddedField, EmbeddedPath, Identifier, Legacy, Parent } from "./symbols.js";
-export { Editable, Legacy, Checkout } from "./symbols.js";
+import { Checkout, Context, Destroy } from "./symbols.js";
 export interface ReactiveResource {
 	[Symbol.toStringTag]: `ReactiveResource<${string}>`;
 	/** @internal */
-	[RecordStore]: Store;
-	/** @internal */
-	[Identifier]: StableRecordIdentifier;
-	/** @internal */
-	[Parent]: StableRecordIdentifier;
-	/** @internal */
-	[EmbeddedField]: SchemaArrayField | SchemaObjectField | null;
+	[Context]: ObjectContext | ResourceContext;
 	/** @internal */
-	[EmbeddedPath]: string[] | null;
-	/** @internal */
-	[Editable]: boolean;
-	/** @internal */
-	[Legacy]: boolean;
+	[RecordStore]: Store;
 	/** @internal */
 	___notifications: object;
 	/** @internal */
@@ -60,3 +47,4 @@ export interface ReactiveResource {
 export declare class ReactiveResource {
 	constructor(context: ResourceContext | ObjectContext);
 }
+export declare function _CHECKOUT(record: ReactiveResource): ReactiveResource;

package/declarations/reactive/-private/symbols.d.ts

@@ -27,10 +27,5 @@
 export declare const SOURCE: "___(unique) Symbol(SOURCE)";
 export declare const MUTATE: "___(unique) Symbol(MUTATE)";
 export declare const Destroy: "___(unique) Symbol(Destroy)";
-export declare const Identifier: "___(unique) Symbol(Identifier)";
-export declare const Editable: "___(unique) Symbol(Editable)";
-export declare const Parent: "___(unique) Symbol(Parent)";
 export declare const Checkout: "___(unique) Symbol(Checkout)";
-export declare const Legacy: "___(unique) Symbol(Legacy)";
-export declare const EmbeddedPath: "___(unique) Symbol(EmbeddedPath)";
-export declare const EmbeddedField: "___(unique) Symbol(EmbeddedField)";
+export declare const Context: "___(unique) Symbol(Context)";

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

@@ -1 +1 @@
-export { Editable, Legacy } from "./-private/symbols.js";
+export { Context } from "./-private/symbols.js";

package/declarations/store/-private/caches/identifier-cache.d.ts

@@ -263,6 +263,7 @@ export declare class IdentifierCache {
 	createIdentifierForNewRecord(data: {
 		type: string;
 		id?: string | null;
+		lid?: string;
 	}): StableRecordIdentifier;
 	/**
 	Provides the opportunity to update secondary lookup tables for existing identifiers

package/declarations/store/-private/caches/instance-cache.d.ts

@@ -28,12 +28,13 @@ const { id, type, lid } = identifier;
 export declare function recordIdentifierFor<T extends TypedRecordInstance>(record: T): StableRecordIdentifier<TypeFromInstance<T>>;
 export declare function recordIdentifierFor(record: OpaqueRecordInstance): StableRecordIdentifier;
 export declare function setRecordIdentifier(record: OpaqueRecordInstance, identifier: StableRecordIdentifier): void;
+export declare function removeRecordIdentifier(record: OpaqueRecordInstance): void;
 export declare const StoreMap: Map<unknown, Store>;
 /**
 * We may eventually make this public, but its likely better for this to be killed off
 * @internal
 */
-export declare function storeFor(record: OpaqueRecordInstance): Store | undefined;
+export declare function storeFor(record: OpaqueRecordInstance, ignoreMissing: boolean): Store | null;
 export type Caches = {
 	record: Map<StableRecordIdentifier, OpaqueRecordInstance>;
 	document: Map<StableDocumentIdentifier, ReactiveDocument<OpaqueRecordInstance | OpaqueRecordInstance[] | null | undefined>>;
@@ -47,7 +48,7 @@ export declare class InstanceCache {
 	constructor(store: Store);
 	peek(identifier: StableRecordIdentifier): Cache | OpaqueRecordInstance | undefined;
 	getDocument<T>(identifier: StableDocumentIdentifier): ReactiveDocument<T>;
-	getRecord(identifier: StableRecordIdentifier, properties?: CreateRecordProperties): OpaqueRecordInstance;
+	getRecord(identifier: StableRecordIdentifier): OpaqueRecordInstance;
 	recordIsLoaded(identifier: StableRecordIdentifier, filterDeleted?: boolean): boolean;
 	disconnect(identifier: StableRecordIdentifier): void;
 	unloadRecord(identifier: StableRecordIdentifier): void;
@@ -55,4 +56,5 @@ export declare class InstanceCache {
 	// TODO this should move into something coordinating operations
 	setRecordId(identifier: StableRecordIdentifier, id: string): void;
 }
+export declare function getNewRecord(instances: InstanceCache, identifier: StableRecordIdentifier, properties: CreateRecordProperties): OpaqueRecordInstance;
 export declare function _clearCaches(): void;

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

@@ -45,6 +45,9 @@ type MaybeHasId = {
 *
 */
 export type CreateRecordProperties<T = MaybeHasId & Record<string, unknown>> = T extends TypedRecordInstance ? Partial<FilteredKeys<T>> : T extends MaybeHasId ? MaybeHasId & Partial<FilteredKeys<T>> : MaybeHasId & Record<string, unknown>;
+export interface CreateContext {
+	lid?: string;
+}
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type ConstructorFunction = new (...args: any[]) => any;
 // eslint-disable-next-line @typescript-eslint/no-extraneous-class
@@ -508,35 +511,75 @@ export declare class Store extends BaseClass {
 		T = unknown
 	>(requestConfig: StoreRequestInput<RT, T>): Future<RT>;
 	/**
-	Create a new record in the current store. The properties passed
-	to this method are set on the newly created record.
+	Creates a new record in the current store.
+	
+	> [!CAUTION]
+	> This should not be used to mock records or to create
+	> a record representing data that could be fetched from
+	> the API.
 	
-	To create a new instance of a `Post`:
+	The properties passed to this method are set on
+	the newly created record.
+	
+	For instance: to create a new `post`:
 	
 	```js
 	store.createRecord('post', {
-	title: 'Ember is awesome!'
+	title: 'WarpDrive is Stellar!'
 	});
 	```
 	
-	To create a new instance of a `Post` that has a relationship with a `User` record:
+	Relationships can be set during create. For instance,
+	to create a new `post` that has an existing user as
+	it's author:
 	
 	```js
-	let user = this.store.peekRecord('user', '1');
+	const user = store.peekRecord('user', '1');
+	
 	store.createRecord('post', {
-	title: 'Ember is awesome!',
+	title: 'WarpDrive is Stellar!',
 	user: user
 	});
 	```
 	
+	### lid handling
+	
+	All new records are assigned an `lid` that can be used to handle
+	transactional saves of multiple records, or to link the data to
+	other data in scenarios involving eventual-consistency or remote
+	syncing.
+	
+	```ts
+	const post = store.createRecord('post', {
+	title: 'WarpDrive is Stellar!'
+	});
+	const { lid } = recordIdentifierFor(post);
+	```
+	
+	The `lid` defaults to a uuidv4 string.
+	
+	In order to support receiving knowledge about unpersisted creates
+	from other sources (say a different tab in the same web-browser),
+	createRecord allows for the `lid` to be provided as part of an
+	optional third argument. **If this lid already exists in the store
+	an error will be thrown.**
+	
+	```ts
+	const post = store.createRecord(
+	'post',
+	{ title: 'WarpDrive is Stellar!' },
+	{ lid: '4d47bb88-931f-496e-986d-c4888cef7373' }
+	);
+	```
+	
 	@public
-	@param {String} type the name of the resource
-	@param {Object} inputProperties a hash of properties to set on the
+	@param type the name of the resource
+	@param inputProperties a hash of properties to set on the
 	newly created record.
-	@return {Model} record
+	@return a record in the "isNew" state
 	*/
-	createRecord<T>(type: TypeFromInstance<T>, inputProperties: CreateRecordProperties<T>): T;
-	createRecord(type: string, inputProperties: CreateRecordProperties): OpaqueRecordInstance;
+	createRecord<T>(type: TypeFromInstance<T>, inputProperties: CreateRecordProperties<T>, context?: CreateContext): T;
+	createRecord(type: string, inputProperties: CreateRecordProperties, context?: CreateContext): OpaqueRecordInstance;
 	/**
 	For symmetry, a record can be deleted via the store.
 	

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

@@ -16,10 +16,8 @@ export { IdentifierArray as LiveArray, Collection as CollectionRecordArray, SOUR
 export { RecordArrayManager, fastPush } from "./-private/managers/record-array-manager.js";
 // leaked for private use / test use, should investigate removing
 export { _clearCaches } from "./-private/caches/instance-cache.js";
-export { peekCache, removeRecordDataFor } from "./-private/caches/cache-utils.js";
 // @ember-data/model needs these temporarily
 export { setRecordIdentifier, StoreMap } from "./-private/caches/instance-cache.js";
-export { setCacheFor } from "./-private/caches/cache-utils.js";
 export { normalizeModelName as _deprecatingNormalize } from "./-private/utils/normalize-model-name.js";
 export type { StoreRequestInput } from "./-private/cache-handler/handler.js";
 export { RelatedCollection } from "./-private/record-arrays/many-array.js";

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

@@ -1,7 +1,7 @@
 type UniversalTransientKey = "REQ_ID";
 type UniversalKey = `(transient) ${UniversalTransientKey}` | "RequestMap" | "PromiseCache" | "RequestCache" | "SkipCache" | "EnableHydration" | "WarpDriveRuntimeConfig";
 type TransientKey = "transactionRef" | "configuredGenerationMethod" | "configuredUpdateMethod" | "configuredForgetMethod" | "configuredResetMethod" | "configuredKeyInfoMethod" | "signalHooks";
-type GlobalKey = `(transient) ${TransientKey}` | "AdapterError" | "InvalidError" | "TimeoutError" | "AbortError" | "UnauthorizedError" | "ForbiddenError" | "NotFoundError" | "ConflictError" | "ServerError" | "#{}" | "#[]" | "Signals" | "AvailableShims" | "FAKE_ARR" | "#source" | "#update" | "#notify" | "IS_COLLECTION" | "Touching" | "RequestPromise" | "SaveOp" | "LEGACY_SUPPORT" | "LegacySupport" | "Graphs" | "IS_FROZEN" | "IS_CACHE_HANDLER" | "CONFIG" | "DEBUG_MAP" | "IDENTIFIERS" | "DOCUMENTS" | "CacheForIdentifierCache" | "RecordCache" | "StoreMap" | "Store" | "$type" | "TransformName" | "RequestSignature" | "IS_FUTURE" | "DOC" | "ManagedArrayMap" | "ManagedObjectMap" | "Support" | "SOURCE" | "MUTATE" | "Destroy" | "Identifier" | "Editable" | "EmbeddedPath" | "EmbeddedField" | "Parent" | "Checkout" | "Legacy";
+type GlobalKey = `(transient) ${TransientKey}` | "AdapterError" | "InvalidError" | "TimeoutError" | "AbortError" | "UnauthorizedError" | "ForbiddenError" | "NotFoundError" | "ConflictError" | "ServerError" | "#{}" | "#[]" | "Signals" | "AvailableShims" | "FAKE_ARR" | "#source" | "#update" | "#notify" | "IS_COLLECTION" | "Touching" | "RequestPromise" | "SaveOp" | "LEGACY_SUPPORT" | "LegacySupport" | "Graphs" | "IS_FROZEN" | "IS_CACHE_HANDLER" | "CONFIG" | "DEBUG_MAP" | "IDENTIFIERS" | "DOCUMENTS" | "RecordCache" | "StoreMap" | "Store" | "$type" | "TransformName" | "RequestSignature" | "IS_FUTURE" | "DOC" | "ManagedArrayMap" | "ManagedObjectMap" | "Support" | "SOURCE" | "MUTATE" | "Destroy" | "Checkout" | "Context";
 type UniqueSymbol<T extends string> = `___(unique) Symbol(${T})`;
 type UniqueSymbolOr<
 	T,

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

@@ -1,5 +1,15 @@
 import type { ObjectValue, PrimitiveValue, Value } from "../json/raw.js";
 /**
+* Options signature for Legacy Attributes.
+*/
+export interface AttrOptions {
+	/**
+	* A primitive value or a function which produces a value.
+	*/
+	defaultValue?: PrimitiveValue | (() => Value);
+	[key: string]: Value | (() => Value) | undefined;
+}
+/**
 * A generic "field" that can be used to define
 * primitive value fields.
 *
@@ -52,7 +62,7 @@ export interface GenericField {
 	*/
 	sourceKey?: string;
 	/**
-	* the name of the transform to use, if any
+	* the name of the {@link Transformation} to use, if any
 	*
 	* @public
 	*/
@@ -545,6 +555,15 @@ export interface SchemaObjectField {
 	* @public
 	*/
 	options?: {
+		/**
+		* If true, if no value for this field exists in the cache,
+		* an empty `{}` will be used as the source for a new SchemaObject
+		* of the associated schema type, as opposed to the field's
+		* value being `null`.
+		*
+		* If `polymorphic` is `true`, defaultValue will be considered `false`.
+		*/
+		defaultValue?: boolean;
 		/**
 		* ::: warning ⚠️ Dangerous Feature Ahead
 		* :::
@@ -754,6 +773,13 @@ export interface SchemaArrayField {
 	* @public
 	*/
 	options?: {
+		/**
+		* If true, if no value for this field exists in the cache,
+		* an empty `[]` will be used as the value of the field,
+		* as opposed to the field's value being `null`.
+		*
+		*/
+		defaultValue?: boolean;
 		/**
 		* ::: warning ⚠️ Dangerous Feature Ahead
 		* :::
@@ -1172,8 +1198,9 @@ export interface LegacyAttributeField {
 	* Must comply to the specific transform's options
 	* schema.
 	*
+	* See {@link AttrOptions} for more info.
 	*/
-	options?: ObjectValue;
+	options?: AttrOptions;
 }
 /**
 * > [!CAUTION]

package/dist/graph/-private.js

@@ -1,9 +1,5 @@
 import { deprecate, warn } from '@ember/debug';
-import { p as peekCache } from "../request-state-CeN66aML.js";
-import '../types/request.js';
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
-import '../utils/string.js';
-import "../configure-B48bFHOl.js";
 import { getOrSetGlobal, peekTransient, setTransient } from '../types/-private.js';
 function coerceId(id) {
   if (macroCondition(getGlobalConfig().WarpDrive.deprecations.DEPRECATE_NON_STRICT_ID)) {
@@ -121,12 +117,11 @@ function inspect(value) {
   }
   return 'object';
 }
-function isNew(identifier) {
+function checkIfNew(store, identifier) {
   if (!identifier.id) {
     return true;
   }
-  const cache = peekCache(identifier);
-  return Boolean(cache?.isNew(identifier));
+  return store.cache.isNew(identifier);
 }
 function isBelongsTo(relationship) {
   return relationship.definition.kind === 'belongsTo';
@@ -1210,7 +1205,7 @@ function replaceRelatedRecordsRemote(graph, op, isRemote) {
           // we were not "committed" which means we are not present
           // in the remoteMembers. So we "remove" from the inverse.
           // however we only do this if we are not a "new" record.
-          if (!isNew(identifier)) {
+          if (!checkIfNew(graph._realStore, identifier)) {
             deprecationInfo.triggered = true;
             deprecationInfo.additions.push(identifier);
             relationship.isDirty = true;
@@ -1418,7 +1413,7 @@ function replaceRelatedRecord(graph, op, isRemote = false) {
         localState
       } = relationship;
       // don't sync if localState is a new record and our remoteState is null
-      if (localState && isNew(localState) && !existingState) {
+      if (localState && checkIfNew(graph._realStore, localState) && !existingState) {
         return;
       }
       if (existingState && localState === existingState) {
@@ -1479,7 +1474,7 @@ function replaceRelatedRecord(graph, op, isRemote = false) {
       localState,
       remoteState
     } = relationship;
-    if (localState && isNew(localState) && !remoteState) {
+    if (localState && checkIfNew(graph._realStore, localState) && !remoteState) {
       return;
     }
     // when localState does not match the new remoteState and
@@ -2616,6 +2611,7 @@ class Graph {
     this._potentialPolymorphicTypes = Object.create(null);
     this.identifiers = new Map();
     this.store = store;
+    this._realStore = store._store;
     this.isDestroyed = false;
     this._willSyncRemote = false;
     this._willSyncLocal = false;
@@ -2761,7 +2757,7 @@ class Graph {
           throw new Error(`Expected a relationship`);
         }
       })(relationship) : {};
-      if (relationship.definition.inverseIsAsync && !isNew(identifier)) {
+      if (relationship.definition.inverseIsAsync && !checkIfNew(this._realStore, identifier)) {
         if (macroCondition(getGlobalConfig().WarpDrive.activeLogging.LOG_GRAPH)) {
           if (getGlobalConfig().WarpDrive.debug.LOG_GRAPH || globalThis.getWarpDriveRuntimeConfig().debug.LOG_GRAPH) {
             // eslint-disable-next-line no-console
@@ -3214,7 +3210,7 @@ function clearRelationship(relationship) {
 function removeDematerializedInverse(graph, relationship, inverseIdentifier, silenceNotifications) {
   if (isBelongsTo(relationship)) {
     const localInverse = relationship.localState;
-    if (!relationship.definition.isAsync || localInverse && isNew(localInverse)) {
+    if (!relationship.definition.isAsync || localInverse && checkIfNew(graph._realStore, localInverse)) {
       // unloading inverse of a sync relationship is treated as a client-side
       // delete, so actually remove the models don't merely invalidate the cp
       // cache.
@@ -3227,7 +3223,7 @@ function removeDematerializedInverse(graph, relationship, inverseIdentifier, sil
         relationship.remoteState = null;
         relationship.state.hasReceivedData = true;
         relationship.state.isEmpty = true;
-        if (relationship.localState && !isNew(relationship.localState)) {
+        if (relationship.localState && !checkIfNew(graph._realStore, relationship.localState)) {
           relationship.localState = null;
         }
       }
@@ -3238,7 +3234,7 @@ function removeDematerializedInverse(graph, relationship, inverseIdentifier, sil
       notifyChange(graph, relationship);
     }
   } else {
-    if (!relationship.definition.isAsync || inverseIdentifier && isNew(inverseIdentifier)) {
+    if (!relationship.definition.isAsync || inverseIdentifier && checkIfNew(graph._realStore, inverseIdentifier)) {
       // unloading inverse of a sync relationship is treated as a client-side
       // delete, so actually remove the models don't merely invalidate the cp
       // cache.

package/dist/index.js

@@ -3,8 +3,7 @@ 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-CeN66aML.js";
-export { C as CacheHandler } from "./handler-SdXlte1w.js";
+export { C as CacheHandler, 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-BWYju5O9.js";
 import '@ember/debug';
 import './utils/string.js';
 

package/dist/reactive/-private.js

@@ -1 +1 @@
-export { E as Editable, L as Legacy } from "../symbols-SIstXMLI.js";
+export { C as Context } from "../symbols-BoONANuz.js";