@warp-drive/core 5.8.0-alpha.3 → 5.8.0-alpha.5

package/declarations/store/deprecated/store.d.ts

@@ -248,13 +248,13 @@ declare module "../-private/store-service" {
 		}
 		```
 		
-		See [peekRecord](../methods/peekRecord?anchor=peekRecord) to get the cached version of a record.
+		See {@link Store.peekRecord | peekRecord} to get the cached version of a record.
 		
 		### Retrieving Related Model Records
 		
-		If you use an adapter such as Ember's default
-		[`JSONAPIAdapter`](/ember-data/release/classes/JSONAPIAdapter)
-		that supports the [JSON API specification](http://jsonapi.org/) and if your server
+		If you use an adapter such as the
+		[JSONAPIAdapter](/api/@warp-drive/legacy/adapter/json-api/classes/JSONAPIAdapter)
+		which supports the [{JSON:API} specification](http://jsonapi.org/) and if your server
 		endpoint supports the use of an
 		['include' query parameter](http://jsonapi.org/format/#fetching-includes),
 		you can use `findRecord()` or `findAll()` to automatically retrieve additional records related to
@@ -421,7 +421,7 @@ declare module "../-private/store-service" {
 		records in the store:
 		
 		```js [app/adapters/application.js]
-		import Adapter from '@ember-data/adapter';
+		import { Adapter } from '@warp-drive/legacy/adapter';
 		
 		export default class ApplicationAdapter extends Adapter {
 		shouldReloadAll(store, snapshotsArray) {
@@ -503,8 +503,8 @@ declare module "../-private/store-service" {
 		
 		### Retrieving Related Model Records
 		
-		If you use an adapter such as Ember's default
-		[`JSONAPIAdapter`](/ember-data/release/classes/JSONAPIAdapter)
+		If you use an adapter such as the default
+		[JSONAPIAdapter](/api/@warp-drive/legacy/adapter/json-api/classes/JSONAPIAdapter)
 		that supports the [JSON API specification](http://jsonapi.org/) and if your server
 		endpoint supports the use of an
 		['include' query parameter](http://jsonapi.org/format/#fetching-includes),
@@ -535,7 +535,7 @@ declare module "../-private/store-service" {
 		}
 		```
 		
-		See [query](../methods/query?anchor=query) to only get a subset of records from the server.
+		See {@link Store.query | query} to only get a subset of records from the server.
 		
 		@public
 		@deprecated use {@link Store.request} instead
@@ -575,7 +575,7 @@ declare module "../-private/store-service" {
 		
 		If you do something like this:
 		
-		```javascript
+		```js
 		store.query('person', { ids: ['1', '2', '3'] });
 		```
 		
@@ -602,7 +602,7 @@ declare module "../-private/store-service" {
 		query(type: string, query: LegacyResourceQuery, options?: QueryOptions): Promise<LegacyQueryArray>;
 		/**
 		This method makes a request for one record, where the `id` is not known
-		beforehand (if the `id` is known, use [`findRecord`](../methods/findRecord?anchor=findRecord)
+		beforehand (if the `id` is known, use {@link Store.findRecord | findRecord}
 		instead).
 		
 		This method can be used when it is certain that the server will return a
@@ -611,37 +611,40 @@ declare module "../-private/store-service" {
 		Each time this method is called a new request is made through the adapter.
 		
 		Let's assume our API provides an endpoint for the currently logged in user
-		via:
 		
-		```
-		// GET /api/current_user
+		```ts
+		// GET /api/user/me
 		{
-		user: {
-		id: 1234,
+		data: {
+		type: 'user',
+		id: '1234',
+		attributes: {
 		username: 'admin'
 		}
 		}
+		}
 		```
 		
 		Since the specific `id` of the `user` is not known beforehand, we can use
 		`queryRecord` to get the user:
 		
-		```javascript
-		store.queryRecord('user', {}).then(function(user) {
-		let username = user.username;
-		// do thing
-		});
+		```ts
+		const user = await store.queryRecord('user', { me: true });
+		user.username; // admin
 		```
 		
 		The request is made through the adapters' `queryRecord`:
 		
-		```js [app/adapters/user.js]
-		import Adapter from '@ember-data/adapter';
-		import $ from 'jquery';
+		```ts [app/adapters/user.ts]
+		import Adapter from '@warp-drive/legacy/adapter';
 		
 		export default class UserAdapter extends Adapter {
-		queryRecord(modelName, query) {
-		return $.getJSON('/api/current_user');
+		async queryRecord(modelName, query) {
+		if (query.me) {
+		const response = await fetch('/api/me');
+		return await response.json();
+		}
+		throw new Error('Unsupported query');
 		}
 		}
 		```
@@ -664,7 +667,7 @@ declare module "../-private/store-service" {
 		}
 		```
 		
-		```javascript
+		```js
 		store.query('user', { username: 'unique' }).then(function(users) {
 		return users.firstObject;
 		}).then(function(user) {
@@ -684,7 +687,7 @@ declare module "../-private/store-service" {
 		}
 		```
 		
-		```javascript
+		```js
 		store.queryRecord('user', { username: 'unique' }).then(function(user) {
 		// user is null
 		});
@@ -744,7 +747,7 @@ declare module "../-private/store-service" {
 		/**
 		Returns the schema for a particular resource type (modelName).
 		
-		When used with Model from @ember-data/model the return is the model class,
+		When used with [Model](/api/@warp-drive/legacy/model/classes/Model) the return is the model class,
 		but this is not guaranteed.
 		
 		If looking to query attribute or relationship information it is
@@ -754,9 +757,7 @@ declare module "../-private/store-service" {
 		signatures.
 		
 		The class of a model might be useful if you want to get a list of all the
-		relationship names of the model, see
-		[`relationshipNames`](/ember-data/release/classes/Model?anchor=relationshipNames)
-		for example.
+		relationship names of the model.
 		
 		@public
 		@deprecated use {@link Store.schema} instead

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.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";