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

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 */

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/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" | "CacheForIdentifierCache" | "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/reactive/-private.js

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

package/dist/reactive.js

@@ -6,7 +6,7 @@ import { warn, deprecate } from '@ember/debug';
 import './utils/string.js';
 import { A as ARRAY_SIGNAL, O as OBJECT_SIGNAL, c as createMemo } from "./configure-B48bFHOl.js";
 import { RecordStore, Type } from './types/symbols.js';
-import { S as SOURCE, E as Editable, L as Legacy, D as Destroy, I as Identifier, P as Parent, a as EmbeddedPath, C as Checkout, b as EmbeddedField } from "./symbols-SIstXMLI.js";
+import { S as SOURCE, C as Context, D as Destroy, a as Checkout } from "./symbols-BoONANuz.js";
 import { getOrSetGlobal } from './types/-private.js';
 import './index.js';
 function getAliasField(context) {
@@ -74,8 +74,8 @@ class ManagedArray {
     // eslint-disable-next-line @typescript-eslint/no-this-alias
     const self = this;
     this[SOURCE] = data?.slice();
-    const IS_EDITABLE = this[Editable] = context.editable ?? false;
-    this[Legacy] = context.legacy;
+    const IS_EDITABLE = context.editable ?? false;
+    this[Context] = context;
     const schema = context.store.schema;
     const cache = context.store.cache;
     const {
@@ -407,12 +407,16 @@ function getArrayField(context) {
     const {
       store,
       resourceKey,
-      path
+      path,
+      field
     } = context;
     const {
       cache
     } = store;
-    const rawValue = context.editable ? cache.getAttr(resourceKey, path) : cache.getRemoteAttr(resourceKey, path);
+    let rawValue = context.editable ? cache.getAttr(resourceKey, path) : cache.getRemoteAttr(resourceKey, path);
+    if (!rawValue && field.kind === 'schema-array' && field.options?.defaultValue) {
+      rawValue = [];
+    }
     if (!rawValue) {
       return null;
     }
@@ -579,9 +583,10 @@ function setGenericField(context) {
 }
 class ManyArrayManager {
   constructor(record, editable) {
+    const context = record[Context];
     this.record = record;
-    this.store = record[RecordStore];
-    this.identifier = record[Identifier];
+    this.store = context.store;
+    this.identifier = context.resourceKey;
     this.editable = editable;
   }
   _syncArray(array) {
@@ -809,7 +814,7 @@ function setLocalField(context) {
   }
   return true;
 }
-const ObjectSymbols = new Set([OBJECT_SIGNAL, Parent, SOURCE, Editable, EmbeddedPath]);
+const ObjectSymbols = new Set([OBJECT_SIGNAL, Context, SOURCE]);
 
 // const ignoredGlobalFields = new Set<string>(['setInterval', 'nodeType', 'nodeName', 'length', 'document', STRUCTURED]);
 
@@ -825,10 +830,7 @@ class ManagedObject {
     this[SOURCE] = Object.assign({}, context.value);
     const signals = withSignalStore(this);
     const _SIGNAL = this[OBJECT_SIGNAL] = entangleSignal(signals, this, OBJECT_SIGNAL, undefined);
-    this[Editable] = context.editable;
-    this[Legacy] = context.legacy;
-    this[Parent] = context.resourceKey;
-    this[EmbeddedPath] = path;
+    this[Context] = context;
     const identifier = context.resourceKey;
     const {
       cache,
@@ -1058,19 +1060,18 @@ class ResourceRelationship {
       this.links = rawValue.links ?? {};
       this.meta = rawValue.meta ?? {};
     }
-    this[RecordStore] = store;
-    this[Parent] = context.record;
+    this[Context] = context;
   }
   fetch(options) {
     const url = options?.url ?? getHref(this.links.related) ?? getHref(this.links.self) ?? null;
     if (!url) {
-      throw new Error(`Cannot ${options?.method ?? 'fetch'} ${this[Parent][Identifier].type}.${String(this.name)} because it has no related link`);
+      throw new Error(`Cannot ${options?.method ?? 'fetch'} ${this[Context].resourceKey.type}.${String(this.name)} because it has no related link`);
     }
     const request = Object.assign({
       url,
       method: 'GET'
     }, options);
-    return this[RecordStore].request(request);
+    return this[Context].store.request(request);
   }
 }
 defineSignal(ResourceRelationship.prototype, 'data', null);
@@ -1121,12 +1122,16 @@ function getSchemaObjectField(context) {
   const {
     store,
     resourceKey,
-    path
+    path,
+    field
   } = context;
   const {
     cache
   } = store;
-  const rawValue = context.editable ? cache.getAttr(resourceKey, path) : cache.getRemoteAttr(resourceKey, path);
+  let rawValue = context.editable ? cache.getAttr(resourceKey, path) : cache.getRemoteAttr(resourceKey, path);
+  if (!rawValue && !field.options?.polymorphic && field.options?.defaultValue) {
+    rawValue = {};
+  }
   if (!rawValue) {
     if (signal.value) {
       const value = signal.value;
@@ -1138,9 +1143,6 @@ function getSchemaObjectField(context) {
     }
     return null;
   }
-  const {
-    field
-  } = context;
   const {
     schema
   } = store;
@@ -1353,7 +1355,7 @@ const DefaultMode = {
   }
 };
 const IgnoredGlobalFields = new Set(['length', 'nodeType', 'then', 'setInterval', 'document', STRUCTURED]);
-const symbolList = [Destroy, RecordStore, Identifier, Editable, Parent, Checkout, Legacy, EmbeddedPath, EmbeddedField];
+const symbolList = [Context, Destroy, RecordStore, Checkout];
 const RecordSymbols = new Set(symbolList);
 function isPathMatch(a, b) {
   return a.length === b.length && a.every((v, i) => v === b[i]);
@@ -1384,15 +1386,8 @@ class ReactiveResource {
     const embeddedField = context.field;
     const embeddedPath = context.path;
     const isEmbedded = context.field !== null;
-    this[RecordStore] = store;
-    if (isEmbedded) {
-      this[Parent] = identifier;
-    } else {
-      this[Identifier] = identifier;
-    }
-    const IS_EDITABLE = this[Editable] = context.editable ?? false;
+    const IS_EDITABLE = context.editable ?? false;
     const schema = store.schema;
-    this[Legacy] = context.legacy ?? false;
     const objectType = isEmbedded ? context.value : identifier.type;
     const ResourceSchema = schema.resource(isEmbedded ? {
       type: objectType
@@ -1402,8 +1397,8 @@ class ReactiveResource {
 
     // prettier-ignore
     const extensions = !context.legacy ? null : isEmbedded ? schema.CAUTION_MEGA_DANGER_ZONE_objectExtensions(embeddedField, objectType) : schema.CAUTION_MEGA_DANGER_ZONE_resourceExtensions(identifier);
-    this[EmbeddedField] = embeddedField;
-    this[EmbeddedPath] = embeddedPath;
+    this[Context] = context;
+    this[RecordStore] = context.store;
     const fields = isEmbedded ? schema.fields({
       type: objectType
     }) : schema.fields(identifier);
@@ -1874,26 +1869,25 @@ class ReactiveResource {
   }
 }
 function _CHECKOUT(record) {
+  const context = record[Context];
+
   // IF we are already the editable record, throw an error
-  if (record[Editable]) {
+  if (context.editable) {
     throw new Error(`Cannot checkout an already editable record`);
   }
   const editable = Editables.get(record);
   if (editable) {
     return Promise.resolve(editable);
   }
-  const embeddedType = record[EmbeddedField];
-  const embeddedPath = record[EmbeddedPath];
-  const isEmbedded = embeddedType !== null && embeddedPath !== null;
+  const isEmbedded = context.field !== null && context.path !== null;
   if (isEmbedded) {
     throw new Error(`Cannot checkout an embedded record (yet)`);
   }
-  const legacy = record[Legacy];
   const editableRecord = new ReactiveResource({
-    store: record[RecordStore],
-    resourceKey: record[Identifier],
-    modeName: legacy ? 'legacy' : 'polaris',
-    legacy: legacy,
+    store: context.store,
+    resourceKey: context.resourceKey,
+    modeName: context.legacy ? 'legacy' : 'polaris',
+    legacy: context.legacy,
     editable: true,
     path: null,
     field: null,
@@ -1903,13 +1897,13 @@ function _CHECKOUT(record) {
   return Promise.resolve(editableRecord);
 }
 function _DESTROY(record) {
-  if (record[Legacy]) {
+  if (record[Context].legacy) {
     // @ts-expect-error
     record.isDestroying = true;
     // @ts-expect-error
     record.isDestroyed = true;
   }
-  record[RecordStore].notifications.unsubscribe(record.___notifications);
+  record[Context].store.notifications.unsubscribe(record.___notifications);
 
   // FIXME we need a way to also unsubscribe all SchemaObjects when the primary
   // resource is destroyed.
@@ -2181,7 +2175,8 @@ function withDefaults(schema) {
  * @public
  */
 const fromIdentity = (record, options, key) => {
-  const identifier = record[Identifier];
+  const context = record[Context];
+  const identifier = context.resourceKey;
   macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
     if (!test) {
       throw new Error(`Cannot compute @identity for a record without an identifier`);

package/dist/{symbols-SIstXMLI.js → symbols-BoONANuz.js}

@@ -34,11 +34,6 @@ import { getOrSetGlobal } from './types/-private.js';
 const SOURCE = getOrSetGlobal('SOURCE', Symbol('#source'));
 getOrSetGlobal('MUTATE', Symbol('#update'));
 const Destroy = getOrSetGlobal('Destroy', Symbol.dispose || Symbol.for('Dispose'));
-const Identifier = getOrSetGlobal('Identifier', Symbol('Identifier'));
-const Editable = getOrSetGlobal('Editable', Symbol('Editable'));
-const Parent = getOrSetGlobal('Parent', Symbol('Parent'));
 const Checkout = getOrSetGlobal('Checkout', Symbol('Checkout'));
-const Legacy = getOrSetGlobal('Legacy', Symbol('Legacy'));
-const EmbeddedPath = getOrSetGlobal('EmbeddedPath', Symbol('EmbeddedPath'));
-const EmbeddedField = getOrSetGlobal('EmbeddedField', Symbol('EmbeddedField'));
-export { Checkout as C, Destroy as D, Editable as E, Identifier as I, Legacy as L, Parent as P, SOURCE as S, EmbeddedPath as a, EmbeddedField as b };
+const Context = getOrSetGlobal('Context', Symbol('Context'));
+export { Context as C, Destroy as D, SOURCE as S, Checkout as a };

package/dist/types/-private.js

@@ -1,6 +1,6 @@
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 const name = "@warp-drive/core";
-const version = "5.7.0-alpha.10";
+const version = "5.7.0-alpha.11";
 
 // in testing mode, we utilize globals to ensure only one copy exists of
 // these maps, due to bugs in ember-auto-import

package/dist/types/schema/fields.js

@@ -1,5 +1,9 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 
+/**
+ * Options signature for Legacy Attributes.
+ */
+
 /**
  * A generic "field" that can be used to define
  * primitive value fields.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@warp-drive/core",
-  "version": "5.7.0-alpha.10",
+  "version": "5.7.0-alpha.11",
   "description": "Core package for WarpDrive | All the Universal Basics",
   "keywords": [
     "ember-addon"
@@ -37,13 +37,13 @@
   },
   "dependencies": {
     "@embroider/macros": "^1.16.12",
-    "@warp-drive/build-config": "5.7.0-alpha.10"
+    "@warp-drive/build-config": "5.7.0-alpha.11"
   },
   "devDependencies": {
     "@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.10",
+    "@warp-drive/internal-config": "5.7.0-alpha.11",
     "decorator-transforms": "^2.3.0",
     "ember-source": "~6.3.0",
     "expect-type": "^1.2.1",