@warp-drive/core 5.7.0-alpha.8 → 5.7.0-beta.0

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

@@ -1,12 +1,12 @@
 import type { Store } from "../../store/-private/store-service.js";
-import type { StableDocumentIdentifier } from "../../types/identifier.js";
+import type { RequestKey } from "../../types/identifier.js";
 import type { ImmutableRequestInfo, RequestInfo } from "../../types/request.js";
 import type { ResourceDocument } from "../../types/spec/document.js";
 import type { Meta, PaginationLinks } from "../../types/spec/json-api-raw.js";
 /**
 * A Document is a class that wraps the response content from a request to the API
-* returned by `Cache.put` or `Cache.peek`, converting resource-identifiers into
-* record instances.
+* returned by `Cache.put` or `Cache.peek`, converting ResourceKeys into
+* ReactiveResource instances.
 *
 * It is not directly instantiated by the user, and its properties should not
 * be directly modified. Whether individual properties are mutable or not is
@@ -16,7 +16,6 @@ import type { Meta, PaginationLinks } from "../../types/spec/json-api-raw.js";
 * @hideconstructor
 */
 export declare class ReactiveDocument<T> {
-	#private;
 	/**
 	* The links object for this document, if any
 	*
@@ -28,8 +27,6 @@ export declare class ReactiveDocument<T> {
 	* }
 	* ```
 	*
-	* @property links
-	* @type {Object|undefined} - a links object
 	* @public
 	*/
 	readonly links?: PaginationLinks;
@@ -42,41 +39,28 @@ export declare class ReactiveDocument<T> {
 	* For collections this will be an array of record instances,
 	* for single resource requests it will be a single record instance or null.
 	*
-	* @property data
 	* @public
-	* @type {Object|Array<object>|null|undefined} - a data object
 	*/
 	readonly data?: T;
 	/**
 	* The errors returned by the API for this request, if any
 	*
-	* @property errors
 	* @public
-	* @type {Object|undefined} - an errors object
 	*/
 	readonly errors?: object[];
 	/**
 	* The meta object for this document, if any
 	*
-	* @property meta
 	* @public
-	* @type {Object|undefined} - a meta object
 	*/
 	readonly meta?: Meta;
 	/**
-	* The identifier associated with this document, if any
+	* The RequestKey associated with this document, if any
 	*
-	* @property identifier
 	* @public
-	* @type {StableDocumentIdentifier|null}
 	*/
-	readonly identifier: StableDocumentIdentifier | null;
-	protected readonly _store: Store;
-	protected readonly _localCache: {
-		document: ResourceDocument;
-		request: ImmutableRequestInfo;
-	} | null;
-	constructor(store: Store, identifier: StableDocumentIdentifier | null, localCache: {
+	readonly identifier: RequestKey | null;
+	constructor(store: Store, cacheKey: RequestKey | null, localCache: {
 		document: ResourceDocument;
 		request: ImmutableRequestInfo;
 	} | null);
@@ -89,7 +73,7 @@ export declare class ReactiveDocument<T> {
 	* @param {Object} options
 	* @return {Promise<Document>}
 	*/
-	fetch(options?: RequestInfo<ReactiveDocument<T>, T>): Promise<ReactiveDocument<T>>;
+	fetch(options?: RequestInfo<ReactiveDocument<T>>): Promise<ReactiveDocument<T>>;
 	/**
 	* Fetches the next link for this document, returning a promise that resolves
 	* with the new document when the request completes, or null  if there is no
@@ -99,7 +83,7 @@ export declare class ReactiveDocument<T> {
 	* @param {Object} options
 	* @return {Promise<Document | null>}
 	*/
-	next(options?: RequestInfo<ReactiveDocument<T>, T>): Promise<ReactiveDocument<T> | null>;
+	next(options?: RequestInfo<ReactiveDocument<T>>): Promise<ReactiveDocument<T> | null>;
 	/**
 	* Fetches the prev link for this document, returning a promise that resolves
 	* with the new document when the request completes, or null if there is no
@@ -109,7 +93,7 @@ export declare class ReactiveDocument<T> {
 	* @param {Object} options
 	* @return {Promise<Document | null>}
 	*/
-	prev(options: RequestInfo<ReactiveDocument<T>, T>): Promise<ReactiveDocument<T> | null>;
+	prev(options: RequestInfo<ReactiveDocument<T>>): Promise<ReactiveDocument<T> | null>;
 	/**
 	* Fetches the first link for this document, returning a promise that resolves
 	* with the new document when the request completes, or null if there is no
@@ -119,7 +103,7 @@ export declare class ReactiveDocument<T> {
 	* @param {Object} options
 	* @return {Promise<Document | null>}
 	*/
-	first(options: RequestInfo<ReactiveDocument<T>, T>): Promise<ReactiveDocument<T> | null>;
+	first(options: RequestInfo<ReactiveDocument<T>>): Promise<ReactiveDocument<T> | null>;
 	/**
 	* Fetches the last link for this document, returning a promise that resolves
 	* with the new document when the request completes, or null if there is no
@@ -129,7 +113,7 @@ export declare class ReactiveDocument<T> {
 	* @param {Object} options
 	* @return {Promise<Document | null>}
 	*/
-	last(options: RequestInfo<ReactiveDocument<T>, T>): Promise<ReactiveDocument<T> | null>;
+	last(options: RequestInfo<ReactiveDocument<T>>): Promise<ReactiveDocument<T> | null>;
 	/**
 	* Implemented for `JSON.stringify` support.
 	*

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

@@ -1,20 +1,18 @@
 import type { WarpDriveSignal } from "../../../store/-private.js";
 import { ARRAY_SIGNAL } from "../../../store/-private.js";
-import type { StableRecordIdentifier } from "../../../types/identifier.js";
+import type { ResourceKey } 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;
+	identifier: ResourceKey;
 	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 {
 	constructor(context: KindContext<SchemaArrayField | ArrayField>, owner: ReactiveResource, data: unknown[]);
 }

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

@@ -1,20 +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 {
 	constructor(context: KindContext<ObjectField>);
 }

package/declarations/reactive/-private/fields/many-array-manager.d.ts

@@ -1,7 +1,7 @@
 import type { Store } from "../../../index.js";
 import type { RelatedCollection as ManyArray } from "../../../store/-private.js";
 import type { LocalRelationshipOperation } from "../../../types/graph.js";
-import type { StableRecordIdentifier } from "../../../types/identifier.js";
+import type { ResourceKey } from "../../../types/identifier.js";
 import type { ReactiveResource } from "../record.js";
 export interface FindHasManyOptions {
 	reload?: boolean;
@@ -10,7 +10,7 @@ export interface FindHasManyOptions {
 export declare class ManyArrayManager {
 	record: ReactiveResource;
 	store: Store;
-	identifier: StableRecordIdentifier;
+	identifier: ResourceKey;
 	editable: boolean;
 	constructor(record: ReactiveResource, editable: boolean);
 	_syncArray(array: ManyArray): void;

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

@@ -1,5 +1,5 @@
 import type { Store } from "../../index.js";
-import type { StableRecordIdentifier } from "../../types.js";
+import type { ResourceKey } from "../../types.js";
 import { ReactiveResource } from "./record.js";
-export declare function instantiateRecord(store: Store, identifier: StableRecordIdentifier, createArgs?: Record<string, unknown>): ReactiveResource;
+export declare function instantiateRecord(store: Store, identifier: ResourceKey, createArgs?: Record<string, unknown>): ReactiveResource;
 export declare function teardownRecord(record: unknown): void;

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

@@ -1,38 +1,14 @@
-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";
+import { Checkout } from "./symbols.js";
 export interface ReactiveResource {
-	[Symbol.toStringTag]: `ReactiveResource<${string}>`;
-	/** @internal */
-	[RecordStore]: Store;
-	/** @internal */
-	[Identifier]: StableRecordIdentifier;
-	/** @internal */
-	[Parent]: StableRecordIdentifier;
-	/** @internal */
-	[EmbeddedField]: SchemaArrayField | SchemaObjectField | null;
-	/** @internal */
-	[EmbeddedPath]: string[] | null;
-	/** @internal */
-	[Editable]: boolean;
-	/** @internal */
-	[Legacy]: boolean;
-	/** @internal */
-	___notifications: object;
-	/** @internal */
-	[Destroy](): void;
 	/**
 	* Create an editable copy of the record
 	*
 	* ReactiveResource instances are not editable by default. This method creates an editable copy of the record. To use,
-	* import the `Checkout` symbol from `@warp-drive/schema-record` and call it on the record.
+	* import the `Checkout` symbol from `@warp-drive/core/reactive` and call it on the record.
 	*
 	* ```ts
-	* import { Checkout } from '@warp-drive/schema-record';
+	* import { Checkout } from '@warp-drive/core/reactive';
 	*
 	* const record = store.peekRecord('user', '1');
 	* const editableRecord = await record[Checkout]();
@@ -40,13 +16,13 @@ export interface ReactiveResource {
 	*
 	* @returns a promise that resolves to the editable record
 	* @throws if the record is already editable or if the record is embedded
-	*
+	* @private
 	*/
 	[Checkout]<T>(): Promise<T>;
 }
 /**
 * A class that uses a the ResourceSchema for a ResourceType
-* and a ResouceKey to transform data from the cache into a rich, reactive
+* and a ResourceKey to transform data from the cache into a rich, reactive
 * object.
 *
 * This class is not directly instantiable. To use it, you should
@@ -56,7 +32,43 @@ export interface ReactiveResource {
 * @hideconstructor
 * @public
 */
-// eslint-disable-next-line @typescript-eslint/no-extraneous-class
 export declare class ReactiveResource {
 	constructor(context: ResourceContext | ObjectContext);
 }
+export declare function _CHECKOUT(record: ReactiveResource): ReactiveResource;
+/**
+* Checkout an immutable resource for editing.
+*
+* {@link ReactiveResource | ReactiveResources} are not editable by default. This method
+* creates an editable copy of the resource.
+*
+* This returns a promise which resolves with the editable
+* version of the resource.
+*
+* ```ts
+* import { checkout } from '@warp-drive/core/reactive';
+*
+* const immutable = store.peekRecord('user', '1');
+* const editable = await checkout(immutable);
+* ```
+*
+* Edits to editable resources will be automatically committed if a new
+* payload from the cache matches their existing value.
+*
+* @public
+*
+* @returns a promise that resolves to the editable resource
+* @throws if the resource is already editable or if resource is an embedded object
+*/
+export declare function checkout<T>(resource: unknown): Promise<T & ReactiveResource>;
+/**
+* Forcibly commit all local changes on an editable resource to
+* the remote (immutable) version.
+*
+* This API should only be used cautiously. Typically a better
+* approach is for either the API or a Handler to reflect saved
+* changes back to update the cache.
+*
+* @public
+*/
+export declare function commit(record: ReactiveResource): Promise<void>;

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

@@ -1,9 +1,8 @@
-import type { Store } from "../../store/-private.js";
 import type { SchemaService as SchemaServiceInterface } from "../../types.js";
-import type { StableRecordIdentifier } from "../../types/identifier.js";
+import type { ResourceKey } 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 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 ArrayField, type CacheableFieldSchema, type DerivedField, type FieldSchema, type GenericField, type HashField, type IdentityField, type LegacyAttributeField, 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";
@@ -31,12 +30,10 @@ export interface CAUTION_MEGA_DANGER_ZONE_Extension {
 	* A constructable such as a Function or Class whose prototype
 	* will be iterated with getOwnPropertyNames.
 	*/
-	// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
 	features: Record<string | symbol, unknown> | Function;
 }
 export type ExtensionDef = {
 	kind: "method";
-	// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
 	fn: Function;
 } | {
 	kind: "readonly-value";
@@ -95,11 +92,11 @@ interface FromIdentityDerivation {
 	}, key: string): string | null;
 	(record: ReactiveResource, options: {
 		key: "^";
-	}, key: string): StableRecordIdentifier;
+	}, key: string): ResourceKey;
 	(record: ReactiveResource, options: null, key: string): asserts options;
 	(record: ReactiveResource, options: {
 		key: "id" | "lid" | "type" | "^";
-	} | null, key: string): StableRecordIdentifier | string | null;
+	} | null, key: string): ResourceKey | string | null;
 	[Type]: "@identity";
 }
 /**
@@ -133,7 +130,6 @@ export declare const fromIdentity: FromIdentityDerivation;
 * ```
 *
 * @public
-* @param {SchemaService} schema
 */
 export declare function registerDerivations(schema: SchemaServiceInterface): void;
 interface InternalSchema {
@@ -151,20 +147,9 @@ export type Transformation<
 > = {
 	serialize(value: PT, options: Record<string, unknown> | null, record: ReactiveResource): T;
 	hydrate(value: T | undefined, options: Record<string, unknown> | null, record: ReactiveResource): PT;
-	defaultValue?(options: Record<string, unknown> | null, identifier: StableRecordIdentifier): T;
+	defaultValue?(options: Record<string, unknown> | null, identifier: ResourceKey): T;
 	[Type]: string;
 };
-interface KindFns {
-	belongsTo: {
-		get: (store: Store, record: object, resourceKey: StableRecordIdentifier, field: LegacyBelongsToField) => unknown;
-		set: (store: Store, record: object, cacheKey: StableRecordIdentifier, field: LegacyBelongsToField, value: unknown) => void;
-	};
-	hasMany: {
-		get: (store: Store, record: object, resourceKey: StableRecordIdentifier, field: LegacyHasManyField) => unknown;
-		set: (store: Store, record: object, cacheKey: StableRecordIdentifier, field: LegacyHasManyField, value: unknown) => void;
-		notify: (store: Store, record: object, cacheKey: StableRecordIdentifier, field: LegacyHasManyField) => boolean;
-	};
-}
 export interface SchemaService {
 	doesTypeExist(type: string): boolean;
 	attributesDefinitionFor(identifier: {
@@ -174,45 +159,16 @@ 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.
 *
-* @class SchemaService
 * @public
 */
 export declare class SchemaService implements SchemaServiceInterface {
-	/** @internal */
-	_schemas: Map<string, InternalSchema>;
-	/** @internal */
-	_transforms: Map<string, Transformation>;
-	/** @internal */
-	_hashFns: Map<string, HashFn>;
-	/** @internal */
-	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	_derivations: Map<string, Derivation<any, any, any>>;
-	/** @internal */
-	_traits: Map<string, InternalTrait>;
-	/** @internal */
-	_modes: Map<string, KindFns>;
-	/** @internal */
-	_extensions: {
-		object: Map<string, ProcessedExtension>;
-		array: Map<string, ProcessedExtension>;
-	};
-	_cachedFieldExtensionsByField: {
-		object: Map<object, ProcessedExtension["features"] | null>;
-		array: Map<object, ProcessedExtension["features"] | null>;
-	};
 	constructor();
 	resourceTypes(): Readonly<string[]>;
 	hasTrait(type: string): boolean;
-	resourceHasTrait(resource: StableRecordIdentifier | {
+	resourceHasTrait(resource: ResourceKey | {
 		type: string;
 	}, trait: string): boolean;
 	transformation(field: GenericField | ObjectField | ArrayField | {
@@ -224,7 +180,7 @@ export declare class SchemaService implements SchemaServiceInterface {
 	hashFn(field: HashField | {
 		type: string;
 	}): HashFn;
-	resource(resource: StableRecordIdentifier | {
+	resource(resource: ResourceKey | {
 		type: string;
 	}): ResourceSchema | ObjectSchema;
 	registerResources(schemas: Array<ResourceSchema | ObjectSchema>): void;
@@ -268,7 +224,7 @@ export declare class SchemaService implements SchemaServiceInterface {
 		FM extends ObjectValue | null
 	>(derivation: Derivation<R, T, FM>): void;
 	CAUTION_MEGA_DANGER_ZONE_registerExtension(extension: CAUTION_MEGA_DANGER_ZONE_Extension): void;
-	CAUTION_MEGA_DANGER_ZONE_resourceExtensions(resource: StableRecordIdentifier | {
+	CAUTION_MEGA_DANGER_ZONE_resourceExtensions(resource: ResourceKey | {
 		type: string;
 	}): null | ProcessedExtension["features"];
 	CAUTION_MEGA_DANGER_ZONE_objectExtensions(field: ExtensibleField, resolvedType: string | null): null | ProcessedExtension["features"];
@@ -278,29 +234,11 @@ export declare class SchemaService implements SchemaServiceInterface {
 		name: string;
 	}): boolean;
 	/**
-	* This is an internal method used to register behaviors for legacy mode.
-	* It is not intended for public use.
+	* Registers a {@link HashFn} for use with a {@link HashField} for
+	* either {@link ObjectSchema} identity or polymorphic type calculation.
 	*
-	* We do think a generalized `kind` registration system would be useful,
-	* but we have not yet designed it.
-	*
-	* See https://github.com/emberjs/data/issues/9534
-	*
-	* @internal
-	*/
-	_registerMode(mode: string, kinds: KindFns): void;
-	/**
-	* This is an internal method used to enable legacy behaviors for legacy mode.
-	* It is not intended for public use.
-	*
-	* We do think a generalized `kind` registration system would be useful,
-	* but we have not yet designed it.
-	*
-	* See https://github.com/emberjs/data/issues/9534
-	*
-	* @internal
+	* @public
 	*/
-	_kind<T extends keyof KindFns>(mode: string, kind: T): KindFns[T];
 	registerHashFn<T extends object>(hashFn: HashFn<T>): void;
 	fields({ type }: {
 		type: string;

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

@@ -1,36 +1,5 @@
-// Great, got your attention with that warning didn't we?
-// Good. Here's the deal: typescript treats symbols as unique types.
-// If by accident a module creating a symbol is processed more than
-// once, the symbol will be different in each processing. This will
-// cause a type error.
-// It could also cause a runtime error if the symbol is used innapropriately.
-// However, this case is extremely hard to hit and would require other things
-// to go wrong first.
-//
-// So, why do the warning? And why do we lie about the types of the symbols?
-//
-// Because we intentionally create multiple copies of them within the types
-// at build time. This is because we rollup our d.ts files in order to give
-// our consumers a better experience.
-//
-// However, no tool today supports rolling up d.ts files with multiple entry
-// points correctly. The tool we use currently (vite-plugin-dts) uses @microsoft/api-extractor
-// which creates a fully unique stand-alone types file per-entry-point. Thus
-// every entry point that uses one of these symbols somewhere will have accidentally
-// created a new symbol type.
-//
-// This cast allows us to rollup these types using this tool while not encountering
-// the unique symbol type issue.
-//
-// Note that none of these symbols are part of the public API, these are used for
-// debugging DX and as a safe way to provide an intimate contract on public objects.
 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 Commit: "___(unique) Symbol(Commit)";
+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";