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

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

@@ -0,0 +1,71 @@
+import type { Store } from "../../store/-private.js";
+import type { SignalStore } from "../../store/-private/new-core-tmp/reactivity/internal.js";
+import type { StableRecordIdentifier } from "../../types.js";
+import type { FieldSchema, HashField, IdentityField, SchemaArrayField, SchemaObjectField } from "../../types/schema/fields.js";
+import type { ReactiveResource } from "./record.js";
+export type PathLike = string | symbol | Array<string | symbol>;
+export type ModeName = "polaris" | "legacy";
+export interface ModeInfo {
+	name: ModeName;
+	legacy: boolean;
+	editable: boolean;
+}
+export interface BaseContext {
+	store: Store;
+	resourceKey: StableRecordIdentifier;
+	modeName: ModeName;
+	legacy: boolean;
+	editable: boolean;
+}
+export interface ResourceContext extends BaseContext {
+	path: null;
+	field: null;
+}
+export interface ObjectContext extends BaseContext {
+	path: string[];
+	field: SchemaObjectField | SchemaArrayField;
+}
+export interface KindContext<T extends FieldSchema | IdentityField | HashField> extends BaseContext {
+	path: string[];
+	field: T;
+	record: ReactiveResource;
+	signals: SignalStore;
+	value: unknown;
+}
+export interface KindImpl<T extends FieldSchema | IdentityField | HashField> {
+	/**
+	* A function which produces the value for the field when invoked.
+	*/
+	get: (context: KindContext<T>) => unknown;
+	/**
+	* A function which updates the value for the field when invoked.
+	*
+	* This will never be invoked when the record is in a non-editable mode.
+	*
+	* This should assert in dev and return false if mutation is not allowed.
+	*/
+	set: (context: KindContext<T>) => boolean;
+	/**
+	* Whether this field is ever mutable (writable). This should be
+	* if there is ever a scenario in which the field can be written
+	* and false only if the field can never be written to.
+	*/
+	mutable: boolean;
+	/**
+	* Whether this field's of this kind should be included in the
+	* enumerated (iterable) keys of the record/object instance.
+	*
+	* This should generally be true except for fields that are not
+	* producing a value backed by the cache. For instance, locals
+	* should not be enumerable, as their value is not tied to the
+	* cache at all.
+	*/
+	enumerable: boolean;
+	/**
+	*
+	*/
+	serializable: boolean;
+}
+type Mode = { [Field in FieldSchema | IdentityField | HashField as Field["kind"]] : KindImpl<Field> };
+export declare const DefaultMode: Mode;
+export {};

package/declarations/reactive/-private/fields/get-field-key.d.ts

@@ -0,0 +1,8 @@
+import type { CacheableFieldSchema, FieldSchema, HashField, IdentityField } from "../../../types/schema/fields.js";
+type InvalidKind = "alias" | "derived" | "@local";
+export declare function isInvalidKind(kind: string): kind is InvalidKind;
+export declare function isNonIdentityCacheableField(field: FieldSchema | IdentityField | HashField): field is Exclude<CacheableFieldSchema, IdentityField>;
+export declare function getFieldCacheKeyStrict(field: CacheableFieldSchema): string;
+export declare function getFieldCacheKey(field: FieldSchema | IdentityField | HashField): string | null;
+export declare function assertIsCacheField(field: FieldSchema | IdentityField): asserts field is CacheableFieldSchema;
+export {};

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

@@ -1,16 +1,14 @@
-import type { Store } from "../../../index.js";
 import type { WarpDriveSignal } from "../../../store/-private.js";
 import { ARRAY_SIGNAL } from "../../../store/-private.js";
-import type { Cache } from "../../../types/cache.js";
 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 type { SchemaService } from "../schema.js";
 import { Editable, Legacy, SOURCE } from "../symbols.js";
 export interface ManagedArray extends Omit<Array<unknown>, "[]"> {
 	[SOURCE]: unknown[];
 	identifier: StableRecordIdentifier;
-	path: string[];
+	path: string | string[];
 	owner: ReactiveResource;
 	[ARRAY_SIGNAL]: WarpDriveSignal;
 	[Editable]: boolean;
@@ -18,5 +16,5 @@ export interface ManagedArray extends Omit<Array<unknown>, "[]"> {
 }
 // eslint-disable-next-line @typescript-eslint/no-extraneous-class
 export declare class ManagedArray {
-	constructor(store: Store, schema: SchemaService, cache: Cache, field: ArrayField | SchemaArrayField, data: unknown[], identifier: StableRecordIdentifier, path: string[], owner: ReactiveResource, isSchemaArray: boolean, editable: boolean, legacy: boolean);
+	constructor(context: KindContext<SchemaArrayField | ArrayField>, owner: ReactiveResource, data: unknown[]);
 }

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

@@ -1,9 +1,8 @@
 import { OBJECT_SIGNAL, type WarpDriveSignal } from "../../../store/-private.js";
-import type { Cache } from "../../../types/cache.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 type { SchemaService } from "../schema.js";
 import { Editable, EmbeddedPath, Legacy, Parent, SOURCE } from "../symbols.js";
 export declare function notifyObject(obj: ManagedObject): void;
 // const ignoredGlobalFields = new Set<string>(['setInterval', 'nodeType', 'nodeName', 'length', 'document', STRUCTURED]);
@@ -17,5 +16,8 @@ export interface ManagedObject {
 }
 // eslint-disable-next-line @typescript-eslint/no-extraneous-class
 export declare class ManagedObject {
-	constructor(schema: SchemaService, cache: Cache, field: ObjectField | SchemaObjectField, data: object, identifier: StableRecordIdentifier, path: string[], owner: ReactiveResource, editable: boolean, legacy: boolean);
+	constructor(context: KindContext<ObjectField>);
 }
+export declare const ManagedObjectMap: Map<ReactiveResource, Map<string, ManagedObject | ReactiveResource>>;
+export declare function peekManagedObject(record: ReactiveResource, field: ObjectField): ManagedObject | undefined;
+export declare function peekManagedObject(record: ReactiveResource, field: SchemaObjectField): ReactiveResource | undefined;

package/declarations/reactive/-private/kind/alias-field.d.ts

@@ -0,0 +1,4 @@
+import type { LegacyAliasField, ObjectAliasField, PolarisAliasField } from "../../../types/schema/fields.js";
+import type { KindContext } from "../default-mode.js";
+export declare function getAliasField(context: KindContext<LegacyAliasField | ObjectAliasField | PolarisAliasField>): unknown;
+export declare function setAliasField(context: KindContext<LegacyAliasField | ObjectAliasField | PolarisAliasField>): boolean;

package/declarations/reactive/-private/kind/array-field.d.ts

@@ -0,0 +1,9 @@
+import type { RelatedCollection as ManyArray } from "../../../store/-private.js";
+import type { ArrayField, FieldSchema, SchemaArrayField } from "../../../types/schema/fields.js";
+import type { KindContext } from "../default-mode.js";
+import { ManagedArray } from "../fields/managed-array.js";
+import type { ReactiveResource } from "../record.js";
+export declare const ManagedArrayMap: Map<ReactiveResource, Map<string, ManagedArray | ManyArray>>;
+export declare function peekManagedArray(record: ReactiveResource, field: FieldSchema): ManyArray | ManagedArray | undefined;
+export declare function getArrayField(context: KindContext<ArrayField | SchemaArrayField>): unknown;
+export declare function setArrayField(context: KindContext<ArrayField | SchemaArrayField>): boolean;

package/declarations/reactive/-private/kind/attribute-field.d.ts

@@ -0,0 +1,4 @@
+import type { LegacyAttributeField } from "../../../types/schema/fields.js";
+import type { KindContext } from "../default-mode.js";
+export declare function getAttributeField(context: KindContext<LegacyAttributeField>): unknown;
+export declare function setAttributeField(context: KindContext<LegacyAttributeField>): boolean;

package/declarations/reactive/-private/kind/belongs-to-field.d.ts

@@ -0,0 +1,4 @@
+import type { LegacyBelongsToField } from "../../../types/schema/fields.js";
+import type { KindContext } from "../default-mode.js";
+export declare function getBelongsToField(context: KindContext<LegacyBelongsToField>): unknown;
+export declare function setBelongsToField(context: KindContext<LegacyBelongsToField>): boolean;

package/declarations/reactive/-private/kind/collection-field.d.ts

@@ -0,0 +1,4 @@
+import type { CollectionField } from "../../../types/schema/fields.js";
+import type { KindContext } from "../default-mode.js";
+export declare function getCollectionField(context: KindContext<CollectionField>): unknown;
+export declare function setCollectionField(context: KindContext<CollectionField>): boolean;

package/declarations/reactive/-private/kind/derived-field.d.ts

@@ -0,0 +1,4 @@
+import type { DerivedField } from "../../../types/schema/fields.js";
+import type { KindContext } from "../default-mode.js";
+export declare function getDerivedField(context: KindContext<DerivedField>): unknown;
+export declare function setDerivedField(context: KindContext<DerivedField>): boolean;

package/declarations/reactive/-private/kind/generic-field.d.ts

@@ -0,0 +1,4 @@
+import type { GenericField } from "../../../types/schema/fields.js";
+import type { KindContext } from "../default-mode.js";
+export declare function getGenericField(context: KindContext<GenericField>): unknown;
+export declare function setGenericField(context: KindContext<GenericField>): boolean;

package/declarations/reactive/-private/kind/has-many-field.d.ts

@@ -0,0 +1,4 @@
+import type { LegacyHasManyField } from "../../../types/schema/fields.js";
+import type { KindContext } from "../default-mode.js";
+export declare function getHasManyField(context: KindContext<LegacyHasManyField>): unknown;
+export declare function setHasManyField(context: KindContext<LegacyHasManyField>): boolean;

package/declarations/reactive/-private/kind/hash-field.d.ts

@@ -0,0 +1,4 @@
+import type { HashField } from "../../../types/schema/fields.js";
+import type { KindContext } from "../default-mode.js";
+export declare function getHashField(context: KindContext<HashField>): unknown;
+export declare function setHashField(context: KindContext<HashField>): boolean;

package/declarations/reactive/-private/kind/identity-field.d.ts

@@ -0,0 +1,4 @@
+import type { IdentityField } from "../../../types/schema/fields.js";
+import type { KindContext } from "../default-mode.js";
+export declare function getIdentityField(context: KindContext<IdentityField>): unknown;
+export declare function setIdentityField(context: KindContext<IdentityField>): boolean;

package/declarations/reactive/-private/kind/local-field.d.ts

@@ -0,0 +1,4 @@
+import type { LocalField } from "../../../types/schema/fields.js";
+import type { KindContext } from "../default-mode.js";
+export declare function getLocalField(context: KindContext<LocalField>): unknown;
+export declare function setLocalField(context: KindContext<LocalField>): boolean;

package/declarations/reactive/-private/kind/object-field.d.ts

@@ -0,0 +1,4 @@
+import type { ObjectField } from "../../../types/schema/fields.js";
+import type { KindContext } from "../default-mode.js";
+export declare function getObjectField(context: KindContext<ObjectField>): unknown;
+export declare function setObjectField(context: KindContext<ObjectField>): boolean;

package/declarations/reactive/-private/kind/resource-field.d.ts

@@ -0,0 +1,4 @@
+import type { ResourceField } from "../../../types/schema/fields.js";
+import type { KindContext } from "../default-mode.js";
+export declare function getResourceField(context: KindContext<ResourceField>): unknown;
+export declare function setResourceField(context: KindContext<ResourceField>): boolean;

package/declarations/reactive/-private/kind/schema-array-field.d.ts

@@ -0,0 +1,4 @@
+import type { SchemaArrayField } from "../../../types/schema/fields.js";
+import type { KindContext } from "../default-mode.js";
+export { getArrayField as getSchemaArrayField } from "./array-field.js";
+export declare function setSchemaArrayField(context: KindContext<SchemaArrayField>): boolean;

package/declarations/reactive/-private/kind/schema-object-field.d.ts

@@ -0,0 +1,4 @@
+import type { SchemaObjectField } from "../../../types/schema/fields.js";
+import type { KindContext } from "../default-mode.js";
+export declare function getSchemaObjectField(context: KindContext<SchemaObjectField>): unknown;
+export declare function setSchemaObjectField(context: KindContext<SchemaObjectField>): boolean;

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

@@ -2,6 +2,7 @@ import type { Store } from "../../index.js";
 import type { StableRecordIdentifier } from "../../types/identifier.js";
 import type { SchemaArrayField, SchemaObjectField } from "../../types/schema/fields.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";
 export interface ReactiveResource {
@@ -57,8 +58,5 @@ export interface ReactiveResource {
 */
 // eslint-disable-next-line @typescript-eslint/no-extraneous-class
 export declare class ReactiveResource {
-	constructor(store: Store, identifier: StableRecordIdentifier, Mode: {
-		[Editable]: boolean;
-		[Legacy]: boolean;
-	}, isEmbedded?: boolean, embeddedField?: SchemaArrayField | SchemaObjectField | null, embeddedPath?: string[] | null);
+	constructor(context: ResourceContext | ObjectContext);
 }

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

@@ -3,7 +3,7 @@ import type { SchemaService as SchemaServiceInterface } from "../../types.js";
 import type { StableRecordIdentifier } from "../../types/identifier.js";
 import type { ObjectValue, Value } from "../../types/json/raw.js";
 import type { Derivation, HashFn } from "../../types/schema/concepts.js";
-import { type ArrayField, type DerivedField, type FieldSchema, type GenericField, type HashField, type LegacyAttributeField, type LegacyBelongsToField, type LegacyHasManyField, type LegacyRelationshipField, type ObjectField, type ObjectSchema, type PolarisResourceSchema, type ResourceSchema, type Trait } from "../../types/schema/fields.js";
+import { type ArrayField, type CacheableFieldSchema, type DerivedField, type FieldSchema, type GenericField, type HashField, type IdentityField, type LegacyAttributeField, type LegacyBelongsToField, type LegacyHasManyField, type LegacyRelationshipField, type ObjectField, type ObjectSchema, type PolarisResourceSchema, type ResourceSchema, type Trait } from "../../types/schema/fields.js";
 import { Type } from "../../types/symbols.js";
 import type { WithPartial } from "../../types/utils.js";
 import type { ReactiveResource } from "./record.js";
@@ -141,6 +141,7 @@ interface InternalSchema {
 	finalized: boolean;
 	traits: Set<string>;
 	fields: Map<string, FieldSchema>;
+	cacheFields: Map<string, Exclude<CacheableFieldSchema, IdentityField>>;
 	attributes: Record<string, LegacyAttributeField>;
 	relationships: Record<string, LegacyRelationshipField>;
 }
@@ -304,6 +305,9 @@ export declare class SchemaService implements SchemaServiceInterface {
 	fields({ type }: {
 		type: string;
 	}): InternalSchema["fields"];
+	cacheFields({ type }: {
+		type: string;
+	}): InternalSchema["cacheFields"];
 	hasResource(resource: {
 		type: string;
 	}): boolean;

package/declarations/store/-types/q/schema-service.d.ts

@@ -3,7 +3,7 @@ import type { ExtensibleField } from "../../../reactive/-private/schema.js";
 import type { RecordIdentifier, StableRecordIdentifier } from "../../../types/identifier.js";
 import type { ObjectValue } from "../../../types/json/raw.js";
 import type { Derivation, HashFn, Transformation } from "../../../types/schema/concepts.js";
-import type { ArrayField, DerivedField, FieldSchema, GenericField, HashField, LegacyAttributeField, LegacyRelationshipField, ObjectField, Schema, Trait } from "../../../types/schema/fields.js";
+import type { ArrayField, CacheableFieldSchema, DerivedField, FieldSchema, GenericField, HashField, IdentityField, LegacyAttributeField, LegacyRelationshipField, ObjectField, Schema, Trait } from "../../../types/schema/fields.js";
 export type AttributesSchema = Record<string, LegacyAttributeField>;
 export type RelationshipsSchema = Record<string, LegacyRelationshipField>;
 interface ObjectWithStringTypeProperty {
@@ -57,7 +57,6 @@ interface ObjectWithStringTypeProperty {
 * }
 * ```
 *
-* @class (Interface) SchemaService
 * @public
 */
 export interface SchemaService {
@@ -68,33 +67,24 @@ export interface SchemaService {
 	*
 	* @public
 	* @deprecated
-	* @param {String} type
-	* @return {Boolean}
 	*/
 	doesTypeExist?(type: string): boolean;
 	/**
 	* Queries whether the SchemaService recognizes `type` as a resource type
 	*
 	* @public
-	* @param {StableRecordIdentifier|ObjectWithStringTypeProperty} resource
-	* @return {Boolean}
 	*/
 	hasResource(resource: ObjectWithStringTypeProperty | StableRecordIdentifier): boolean;
 	/**
 	* Queries whether the SchemaService recognizes `type` as a resource trait
 	*
 	* @public
-	* @param {String} type
-	* @return {Boolean}
 	*/
 	hasTrait(type: string): boolean;
 	/**
 	* Queries whether the given resource has the given trait
 	*
 	* @public
-	* @param {StableRecordIdentifier|ObjectWithStringTypeProperty} resource
-	* @param {String} trait
-	* @return {Boolean}
 	*/
 	resourceHasTrait(resource: ObjectWithStringTypeProperty | StableRecordIdentifier, trait: string): boolean;
 	/**
@@ -103,17 +93,21 @@ export interface SchemaService {
 	* Should error if the resource type is not recognized.
 	*
 	* @public
-	* @param {StableRecordIdentifier|ObjectWithStringTypeProperty} resource
-	* @return {Map<string, FieldSchema>}
 	*/
 	fields(resource: ObjectWithStringTypeProperty | StableRecordIdentifier): Map<string, FieldSchema>;
 	/**
+	* Queries for the fields of a given resource type or resource identity.
+	*
+	* Should error if the resource type is not recognized.
+	*
+	* @public
+	*/
+	cacheFields?(resource: ObjectWithStringTypeProperty | StableRecordIdentifier): Map<string, Exclude<CacheableFieldSchema, IdentityField>>;
+	/**
 	* Returns the transformation registered with the name provided
 	* by `field.type`. Validates that the field is a valid transformable.
 	*
 	* @public
-	* @param {TransformableField|ObjectWithStringTypeProperty} field
-	* @return {Transformation}
 	*/
 	transformation(field: GenericField | ObjectField | ArrayField | ObjectWithStringTypeProperty): Transformation;
 	/**
@@ -121,8 +115,6 @@ export interface SchemaService {
 	* by `field.type`. Validates that the field is a valid HashField.
 	*
 	* @public
-	* @param {HashField|ObjectWithStringTypeProperty} field
-	* @return {HashFn}
 	*/
 	hashFn(field: HashField | ObjectWithStringTypeProperty): HashFn;
 	/**
@@ -130,16 +122,12 @@ export interface SchemaService {
 	* by `field.type`. Validates that the field is a valid DerivedField.
 	*
 	* @public
-	* @param {DerivedField|ObjectWithStringTypeProperty} field
-	* @return {Derivation}
 	*/
 	derivation(field: DerivedField | ObjectWithStringTypeProperty): Derivation;
 	/**
 	* Returns the schema for the provided resource type.
 	*
 	* @public
-	* @param {StableRecordIdentifier|ObjectWithStringTypeProperty} resource
-	* @return {ResourceSchema}
 	*/
 	resource(resource: ObjectWithStringTypeProperty | StableRecordIdentifier): Schema;
 	/**
@@ -150,7 +138,6 @@ export interface SchemaService {
 	* or other sources just-in-time.
 	*
 	* @public
-	* @param {Schema[]} schemas
 	*/
 	registerResources(schemas: Schema[]): void;
 	/**
@@ -163,7 +150,6 @@ export interface SchemaService {
 	* or other sources just-in-time.
 	*
 	* @public
-	* @param {Schema} schema
 	*/
 	registerResource(schema: Schema): void;
 	/**
@@ -173,7 +159,6 @@ export interface SchemaService {
 	* attached to it's `[Type]` property.
 	*
 	* @public
-	* @param {Transformation} transform
 	*/
 	registerTransformation(transform: Transformation): void;
 	/**
@@ -183,7 +168,6 @@ export interface SchemaService {
 	* attached to it's `[Type]` property.
 	*
 	* @public
-	* @param {Derivation} derivation
 	*/
 	registerDerivation<
 		R,
@@ -197,7 +181,6 @@ export interface SchemaService {
 	* attached to it's `[Type]` property.
 	*
 	* @public
-	* @param {HashFn} hashfn
 	*/
 	registerHashFn(hashFn: HashFn): void;
 	/**
@@ -269,8 +252,6 @@ export interface SchemaService {
 	*
 	* @public
 	* @deprecated
-	* @param {RecordIdentifier|ObjectWithStringTypeProperty} identifier
-	* @return {AttributesSchema}
 	*/
 	attributesDefinitionFor?(identifier: RecordIdentifier | ObjectWithStringTypeProperty): AttributesSchema;
 	/**
@@ -350,37 +331,44 @@ export interface SchemaService {
 	*
 	* @public
 	* @deprecated
-	* @param {RecordIdentifier|ObjectWithStringTypeProperty} identifier
-	* @return {RelationshipsSchema}
 	*/
 	relationshipsDefinitionFor?(identifier: RecordIdentifier | ObjectWithStringTypeProperty): RelationshipsSchema;
 	/**
 	* Returns all known resource types
 	*
 	* @public
-	* @return {String[]}
 	*/
 	resourceTypes(): Readonly<string[]>;
 	/**
 	* Register an extension for either objects or arrays
+	*
+	* @public
 	*/
 	CAUTION_MEGA_DANGER_ZONE_registerExtension?(extension: CAUTION_MEGA_DANGER_ZONE_Extension): void;
 	/**
 	* Retrieve the extension map for a resource
+	*
+	* @public
 	*/
 	CAUTION_MEGA_DANGER_ZONE_resourceExtensions?(resource: StableRecordIdentifier | {
 		type: string;
 	}): null | ProcessedExtension["features"];
 	/**
 	* Retrieve the extension map for an object field
+	*
+	* @public
 	*/
 	CAUTION_MEGA_DANGER_ZONE_objectExtensions?(field: ExtensibleField): null | ProcessedExtension["features"];
 	/**
 	* Retrieve the extension map for an array field
+	*
+	* @public
 	*/
 	CAUTION_MEGA_DANGER_ZONE_arrayExtensions?(field: ExtensibleField): null | ProcessedExtension["features"];
 	/**
 	* Check if a specific extension has been registered previously
+	*
+	* @public
 	*/
 	CAUTION_MEGA_DANGER_ZONE_hasExtension?(ext: {
 		kind: "object" | "array";