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

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

@@ -1,9 +1,9 @@
-import type { CAUTION_MEGA_DANGER_ZONE_Extension, ProcessedExtension } from "../../../reactive.js";
-import type { ExtensibleField } from "../../../reactive/-private/schema.js";
-import type { ResourceKey } 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, CacheableFieldSchema, DerivedField, FieldSchema, GenericField, HashField, IdentityField, LegacyAttributeField, LegacyRelationshipField, ObjectField, Schema, Trait } from "../../../types/schema/fields.js";
+import type { CAUTION_MEGA_DANGER_ZONE_Extension, ProcessedExtension } from "../../reactive.js";
+import type { ExtensibleField } from "../../reactive/-private/schema.js";
+import type { ResourceKey } from "../identifier.js";
+import type { ObjectValue } from "../json/raw.js";
+import type { Derivation, HashFn, Transformation } from "./concepts.js";
+import type { ArrayField, CacheableFieldSchema, DerivedField, FieldSchema, GenericField, HashField, IdentityField, LegacyAttributeField, LegacyRelationshipField, ObjectField, Schema, Trait } from "./fields.js";
 export type AttributesSchema = Record<string, LegacyAttributeField>;
 export type RelationshipsSchema = Record<string, LegacyRelationshipField>;
 interface ObjectWithStringTypeProperty {
@@ -66,7 +66,7 @@ export interface SchemaService {
 	* Queries whether the SchemaService recognizes `type` as a resource type
 	*
 	* @public
-	* @deprecated
+	* @deprecated - use {@link SchemaService.hasResource | hasResource}
 	*/
 	doesTypeExist?(type: string): boolean;
 	/**
@@ -251,7 +251,7 @@ export interface SchemaService {
 	* ```
 	*
 	* @public
-	* @deprecated
+	* @deprecated - use {@link SchemaService.fields | fields}
 	*/
 	attributesDefinitionFor?(key: ResourceKey | ObjectWithStringTypeProperty): AttributesSchema;
 	/**
@@ -330,7 +330,7 @@ export interface SchemaService {
 	* ```
 	*
 	* @public
-	* @deprecated
+	* @deprecated - use {@link SchemaService.fields | fields}
 	*/
 	relationshipsDefinitionFor?(key: ResourceKey | ObjectWithStringTypeProperty): RelationshipsSchema;
 	/**
@@ -342,6 +342,8 @@ export interface SchemaService {
 	/**
 	* Register an extension for either objects or arrays
 	*
+	* See also {@link CAUTION_MEGA_DANGER_ZONE_Extension}
+	*
 	* @public
 	*/
 	CAUTION_MEGA_DANGER_ZONE_registerExtension?(extension: CAUTION_MEGA_DANGER_ZONE_Extension): void;

package/declarations/types/spec/document.d.ts

@@ -1,11 +1,21 @@
 import type { PersistedResourceKey } from "../identifier.js";
 import type { ApiError } from "./error.js";
 import type { Links, Meta, PaginationLinks } from "./json-api-raw.js";
+/**
+* This type represents a raw {json:api} document for a meta-only
+* document returned by a request intended to be inserted into the cache.
+*/
 export interface ResourceMetaDocument {
 	lid?: string;
 	meta: Meta;
 	links?: Links | PaginationLinks;
 }
+/**
+* This type represents a raw {json:api} document for a single resource
+* returned by a request intended to be inserted into the cache.
+*
+* For the Reactive value returned by a request using the store, use {@link ReactiveDataDocument} instead.
+*/
 export interface SingleResourceDataDocument<
 	T = PersistedResourceKey,
 	R = PersistedResourceKey
@@ -16,6 +26,12 @@ export interface SingleResourceDataDocument<
 	data: T | null;
 	included?: R[];
 }
+/**
+* This type represents a raw {json:api} document for a resource collection
+* returned by a request intended to be inserted into the cache.
+*
+* For the Reactive value returned by a request using the store, use {@link ReactiveDataDocument} instead.
+*/
 export interface CollectionResourceDataDocument<T = PersistedResourceKey> {
 	lid?: string;
 	links?: Links | PaginationLinks;
@@ -23,11 +39,29 @@ export interface CollectionResourceDataDocument<T = PersistedResourceKey> {
 	data: T[];
 	included?: T[];
 }
+/**
+* A type useful for representing the raw {json:api} documents that
+* the cache may use.
+*
+* For the Reactive value returned by a request using the store, use {@link ReactiveDataDocument} instead.
+*/
 export type ResourceDataDocument<T = PersistedResourceKey> = SingleResourceDataDocument<T> | CollectionResourceDataDocument<T>;
+/**
+* A type useful for representing the raw {json:api} Error documents that
+* the cache may use.
+*
+* For the Reactive value returned by a request using the store, use {@link ReactiveErrorDocument} instead.
+*/
 export interface ResourceErrorDocument {
 	lid?: string;
 	links?: Links | PaginationLinks;
 	meta?: Meta;
 	errors: ApiError[];
 }
+/**
+* A type useful for representing the raw {json:api} documents that
+* the cache may use.
+*
+* For the Reactive value returned by a request using the store, use {@link ReactiveDocument} instead.
+*/
 export type ResourceDocument<T = PersistedResourceKey> = ResourceMetaDocument | SingleResourceDataDocument<T> | CollectionResourceDataDocument<T> | ResourceErrorDocument;

package/declarations/types/symbols.d.ts

@@ -9,7 +9,7 @@ export declare const RecordStore: "___(unique) Symbol(Store)";
 * record implementations to provide a typescript
 * hint for the type of the resource.
 *
-* When used, EmberData/WarpDrive APIs can
+* When used, WarpDrive APIs can
 * take advantage of this to provide better type
 * safety and intellisense.
 *
@@ -45,7 +45,7 @@ export declare const Type: "___(unique) Symbol($type)";
 * record implementations to provide a typescript
 * hint for the type of the resource.
 *
-* When used, EmberData/WarpDrive APIs can
+* When used, WarpDrive APIs can
 * take advantage of this to provide better type
 * safety and intellisense.
 *

package/declarations/types.d.ts

@@ -7,5 +7,5 @@
 export type { StableRecordIdentifier, ResourceKey } from "./types/identifier.js";
 export type { CacheCapabilitiesManager } from "./store/-types/q/cache-capabilities-manager.js";
 export type { ModelSchema } from "./store/deprecated/-private.js";
-export type { SchemaService } from "./store/-types/q/schema-service.js";
+export type { SchemaService } from "./types/schema/schema-service.js";
 export type { BaseFinderOptions, FindRecordOptions, LegacyResourceQuery, QueryOptions, FindAllOptions } from "./store/-types/q/store.js";

package/dist/build-config.js

@@ -1 +1 @@
-export { setConfig } from '@warp-drive/build-config';
+export { babelPlugin, setConfig } from '@warp-drive/build-config';