@warp-drive/core 5.6.0 → 5.7.0-alpha.1

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 } from "../../types/schema/fields.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 } from "../../types/symbols.js";
 import type { WithPartial } from "../../types/utils.js";
 import type { ReactiveResource } from "./record.js";
@@ -138,6 +138,7 @@ export declare const fromIdentity: FromIdentityDerivation;
 export declare function registerDerivations(schema: SchemaServiceInterface): void;
 interface InternalSchema {
 	original: ResourceSchema | ObjectSchema;
+	finalized: boolean;
 	traits: Set<string>;
 	fields: Map<string, FieldSchema>;
 	attributes: Record<string, LegacyAttributeField>;
@@ -172,6 +173,12 @@ export interface SchemaService {
 		type: string;
 	}): InternalSchema["relationships"];
 }
+interface InternalTrait {
+	name: string;
+	mode: "legacy" | "polaris";
+	fields: Map<string, FieldSchema>;
+	traits: string[];
+}
 /**
 * A SchemaService designed to work with dynamically registered schemas.
 *
@@ -189,7 +196,7 @@ export declare class SchemaService implements SchemaServiceInterface {
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	_derivations: Map<string, Derivation<any, any, any>>;
 	/** @internal */
-	_traits: Set<string>;
+	_traits: Map<string, InternalTrait>;
 	/** @internal */
 	_modes: Map<string, KindFns>;
 	/** @internal */
@@ -221,6 +228,35 @@ export declare class SchemaService implements SchemaServiceInterface {
 	}): ResourceSchema | ObjectSchema;
 	registerResources(schemas: Array<ResourceSchema | ObjectSchema>): void;
 	registerResource(schema: ResourceSchema | ObjectSchema): void;
+	/**
+	* Registers a {@link Trait} for use by resource schemas.
+	*
+	* Traits are re-usable collections of fields that can be composed to
+	* build up a resource schema. Often they represent polymorphic behaviors
+	* a resource should exhibit.
+	*
+	* When we finalize a resource, we walk its traits and apply their fields
+	* to the resource's fields. All specified traits must be registered by
+	* this time or an error will be thrown.
+	*
+	* Traits are applied left-to-right, with traits of traits being applied in the same
+	* way. Thus for the most part, application of traits is a post-order graph traversal
+	* problem.
+	*
+	* A trait is only ever processed once. If multiple traits (A, B, C) have the same
+	* trait (D) as a dependency, D will be included only once when first encountered by
+	* A.
+	*
+	* If a cycle exists such that trait A has trait B which has Trait A, trait A will
+	* be applied *after* trait B in production. In development a cycle error will be thrown.
+	*
+	* Fields are finalized on a "last wins principle". Thus traits appearing higher in
+	* the tree and further to the right of a traits array take precedence, with the
+	* resource's fields always being applied last and winning out.
+	*
+	* @public
+	*/
+	registerTrait(trait: Trait): void;
 	registerTransformation<
 		T extends Value = string,
 		PT = unknown
@@ -236,6 +272,10 @@ export declare class SchemaService implements SchemaServiceInterface {
 	}): null | ProcessedExtension["features"];
 	CAUTION_MEGA_DANGER_ZONE_objectExtensions(field: ExtensibleField): null | ProcessedExtension["features"];
 	CAUTION_MEGA_DANGER_ZONE_arrayExtensions(field: ExtensibleField): null | ProcessedExtension["features"];
+	CAUTION_MEGA_DANGER_ZONE_hasExtension(ext: {
+		kind: "object" | "array";
+		name: string;
+	}): boolean;
 	/**
 	* This is an internal method used to register behaviors for legacy mode.
 	* It is not intended for public use.

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

@@ -1,10 +1,8 @@
 import { ReactiveDocument } from "../../../reactive/-private/document.js";
 import type { Cache } from "../../../types/cache.js";
 import type { StableDocumentIdentifier, StableRecordIdentifier } from "../../../types/identifier.js";
-import type { Value } from "../../../types/json/raw.js";
 import type { TypedRecordInstance, TypeFromInstance } from "../../../types/record.js";
 import type { OpaqueRecordInstance } from "../../-types/q/record-instance.js";
-import RecordReference from "../legacy-model-support/record-reference.js";
 import { CacheCapabilitiesManager } from "../managers/cache-capabilities-manager.js";
 import type { CacheManager } from "../managers/cache-manager.js";
 import type { CreateRecordProperties, Store } from "../store-service.js";
@@ -36,9 +34,8 @@ export declare const StoreMap: Map<unknown, Store>;
 * @internal
 */
 export declare function storeFor(record: OpaqueRecordInstance): Store | undefined;
-type Caches = {
+export type Caches = {
 	record: Map<StableRecordIdentifier, OpaqueRecordInstance>;
-	reference: WeakMap<StableRecordIdentifier, RecordReference>;
 	document: Map<StableDocumentIdentifier, ReactiveDocument<OpaqueRecordInstance | OpaqueRecordInstance[] | null | undefined>>;
 };
 export declare class InstanceCache {
@@ -51,7 +48,6 @@ export declare class InstanceCache {
 	peek(identifier: StableRecordIdentifier): Cache | OpaqueRecordInstance | undefined;
 	getDocument<T>(identifier: StableDocumentIdentifier): ReactiveDocument<T>;
 	getRecord(identifier: StableRecordIdentifier, properties?: CreateRecordProperties): OpaqueRecordInstance;
-	getReference(identifier: StableRecordIdentifier): RecordReference;
 	recordIsLoaded(identifier: StableRecordIdentifier, filterDeleted?: boolean): boolean;
 	disconnect(identifier: StableRecordIdentifier): void;
 	unloadRecord(identifier: StableRecordIdentifier): void;
@@ -59,7 +55,4 @@ export declare class InstanceCache {
 	// TODO this should move into something coordinating operations
 	setRecordId(identifier: StableRecordIdentifier, id: string): void;
 }
-export declare function resourceIsFullyDeleted(instanceCache: InstanceCache, identifier: StableRecordIdentifier): boolean;
-export declare function preloadData(store: Store, identifier: StableRecordIdentifier, preload: Record<string, Value>): void;
 export declare function _clearCaches(): void;
-export {};