@warp-drive/core 5.8.0-alpha.37 → 5.8.0-alpha.40

package/dist/unpkg/dev-deprecated/declarations/store/-private/managers/notification-manager.d.ts

@@ -1,83 +0,0 @@
-import type { RequestKey, ResourceKey } from "../../../types/identifier.js";
-import type { Store } from "../store-service.js";
-export type UnsubscribeToken = object;
-export type CacheOperation = "added" | "removed" | "updated" | "state";
-export type DocumentCacheOperation = "invalidated" | "added" | "removed" | "updated" | "state";
-export type NotificationType = "attributes" | "relationships" | "identity" | "errors" | "meta" | CacheOperation;
-export interface NotificationCallback {
-	(cacheKey: ResourceKey, notificationType: "attributes" | "relationships", key?: string): void;
-	(cacheKey: ResourceKey, notificationType: "errors" | "meta" | "identity" | "state"): void;
-	(cacheKey: ResourceKey, notificationType: CacheOperation): void;
-}
-export interface ResourceOperationCallback {
-	(cacheKey: ResourceKey, notificationType: CacheOperation): void;
-}
-export interface DocumentOperationCallback {
-	(cacheKey: RequestKey, notificationType: DocumentCacheOperation): void;
-}
-/**
-* The NotificationManager provides the ability to subscribe to
-* changes to Cache state.
-*
-* This Feature is what allows WarpDrive to create subscriptions that
-* work with any framework or change-notification system.
-*
-* @hideconstructor
-* @public
-*/
-export declare class NotificationManager {
-	constructor(store: Store);
-	/**
-	* Subscribe to changes for a given ResourceKey, RequestKey, or addition/removal of any resource
-	* or document.
-	*
-	* ```ts
-	* export type CacheOperation = 'added' | 'removed' | 'updated' | 'state';
-	*
-	* export interface NotificationCallback {
-	*   (cacheKey: ResourceKey, notificationType: 'attributes' | 'relationships', key?: string): void;
-	*   (cacheKey: ResourceKey, notificationType: 'errors' | 'meta' | 'identity' | 'state'): void;
-	*   (cacheKey: ResourceKey, notificationType: NotificationType, key?: string): void;
-	* }
-	* export interface ResourceOperationCallback {
-	*   // resource updates
-	*   (cacheKey: ResourceKey, notificationType: CacheOperation): void;
-	* }
-	* export interface DocumentOperationCallback {
-	*   // document updates
-	*   (cacheKey: RequestKey, notificationType: CacheOperation): void;
-	* }
-	* ```
-	*
-	* @public
-	* @return an opaque token to be used with unsubscribe
-	*/
-	subscribe(cacheKey: ResourceKey, callback: NotificationCallback): UnsubscribeToken;
-	subscribe(cacheKey: "resource", callback: ResourceOperationCallback): UnsubscribeToken;
-	subscribe(cacheKey: "document" | RequestKey, callback: DocumentOperationCallback): UnsubscribeToken;
-	/**
-	* remove a previous subscription
-	*
-	* @public
-	*/
-	unsubscribe(token: UnsubscribeToken): void;
-	/**
-	* Custom Caches and Application Code should not call this method directly.
-	*
-	* @private
-	*/
-	notify(cacheKey: ResourceKey, value: "attributes" | "relationships", key?: string | null): boolean;
-	notify(cacheKey: ResourceKey, value: "errors" | "meta" | "identity" | "state", key?: null): boolean;
-	notify(cacheKey: ResourceKey, value: CacheOperation, key?: null): boolean;
-	notify(cacheKey: RequestKey, value: DocumentCacheOperation, key?: null): boolean;
-}
-/**
-* This type exists for internal use only for
-* where intimate contracts still exist either for
-* the Test Suite or for Legacy code.
-*
-* @private
-*/
-export interface PrivateNotificationManager extends NotificationManager {
-	_flush(): void;
-}

package/dist/unpkg/dev-deprecated/declarations/store/-private/managers/record-array-manager.d.ts

@@ -1,100 +0,0 @@
-import type { LocalRelationshipOperation } from "../../../types/graph.js";
-import type { RequestKey, ResourceKey } from "../../../types/identifier.js";
-import type { ImmutableRequestInfo } from "../../../types/request.js";
-import type { CollectionResourceDocument } from "../../../types/spec/json-api-raw.js";
-import type { LegacyLiveArray } from "../record-arrays/legacy-live-array.js";
-import { type LegacyQueryArray } from "../record-arrays/legacy-query.js";
-import { type ReactiveResourceArray } from "../record-arrays/resource-array.js";
-import type { Store } from "../store-service.js";
-/**
-* This is a clever optimization.
-*
-* clever optimizations rarely stand the test of time, so if you're
-* ever curious or think something better is possible please benchmark
-* and discuss. The benchmark for this at the time of writing is in
-* `scripts/benchmark-push.js`
-*
-* This approach turns out to be 150x faster in Chrome and node than
-* simply using push or concat. It's highly susceptible to the specifics
-* of the batch size, and may require tuning.
-*
-* Clever optimizations should always come with a `why`. This optimization
-* exists for two reasons.
-*
-* 1) array.push(...objects) and Array.prototype.push.apply(arr, objects)
-*   are susceptible to stack overflows. The size of objects at which this
-*   occurs varies by environment, browser, and current stack depth and memory
-*   pressure; however, it occurs in all browsers in fairly pristine conditions
-*   somewhere around 125k to 200k elements. Since WarpDrive regularly encounters
-*   arrays larger than this in size, we cannot use push.
-*
-* 2) `array.concat` or simply setting the array to a new reference is often an
-*   easier approach; however, native Proxy to an array cannot swap it's target array
-*   and attempts at juggling multiple array sources have proven to be victim to a number
-*   of browser implementation bugs. Should these bugs be addressed then we could
-*   simplify to using `concat`, however, do note this is currently 150x faster
-*   than concat, and due to the overloaded signature of concat will likely always
-*   be faster.
-*
-* Sincerely,
-*   - runspired (Chris Thoburn) 08/21/2022
-*
-* @private
-* @param target the array to push into
-* @param source the items to push into target
-*/
-export declare function fastPush<T>(target: T[], source: T[]): void;
-interface LegacyQueryInit {
-	type: string;
-	query: ImmutableRequestInfo | Record<string, unknown>;
-}
-interface AnonymousRequestCollectionInit {
-	source: ResourceKey[];
-}
-interface RequestCollectionInit {
-	source: ResourceKey[];
-	requestKey: RequestKey;
-}
-type ChangeSet = Map<ResourceKey, "add" | "del">;
-/**
-@hideconstructor
-@private
-*/
-export declare class RecordArrayManager {
-	constructor(options: {
-		store: Store;
-	});
-	mutate(mutation: LocalRelationshipOperation): void;
-	/**
-	Get the `RecordArray` for a modelName, which contains all loaded records of
-	given modelName.
-	
-	@private
-	*/
-	liveArrayFor(type: string): LegacyLiveArray;
-	getCollection(config: LegacyQueryInit): LegacyQueryArray;
-	getCollection(config: AnonymousRequestCollectionInit): ReactiveResourceArray;
-	getCollection(config: RequestCollectionInit): ReactiveResourceArray;
-	/**
-	* @private
-	*/
-	populateManagedArray(array: ReactiveResourceArray, identifiers: ResourceKey[], payload: CollectionResourceDocument | null): void;
-	pause(): void;
-	resume(): void;
-	destroy(): void;
-}
-/**
-* This type exists for internal use only for
-* where intimate contracts still exist either for
-* the Test Suite or for Legacy code.
-*
-* @private
-*/
-export interface PrivateRecordArrayManager extends RecordArrayManager {
-	_live: Map<string, LegacyLiveArray>;
-	_pending: Map<ReactiveResourceArray, ChangeSet>;
-	_managed: Set<ReactiveResourceArray>;
-	clear(isClear?: boolean): void;
-}
-export declare function disassociateIdentifier(ArraysCache: Map<ResourceKey, Set<ReactiveResourceArray>>, array: ReactiveResourceArray, identifier: ResourceKey): void;
-export {};

package/dist/unpkg/dev-deprecated/declarations/store/-private/network/request-cache.d.ts

@@ -1,103 +0,0 @@
-import type { ResourceKey } from "../../../types/identifier.js";
-import type { FindRecordOptions } from "../../-types/q/store.js";
-import type { Store } from "../store-service.js";
-declare const Touching: "___(unique) Symbol(Touching)";
-export declare const RequestPromise: "___(unique) Symbol(RequestPromise)";
-export interface Operation {
-	op: string;
-	options: FindRecordOptions | undefined;
-	recordIdentifier: ResourceKey;
-}
-export interface FindRecordQuery extends Operation {
-	op: "findRecord";
-}
-export interface SaveRecordMutation extends Operation {
-	op: "saveRecord";
-}
-export interface Request {
-	data: Operation[];
-	options?: Record<string, unknown>;
-}
-export type RequestStates = "pending" | "fulfilled" | "rejected";
-export interface RequestCacheRequestState {
-	state: RequestStates;
-	type: "query" | "mutation";
-	request: Request;
-	response?: Response;
-}
-export interface Response {
-	data: unknown;
-}
-interface InternalRequest extends RequestCacheRequestState {
-	[Touching]: ResourceKey[];
-	[RequestPromise]?: Promise<unknown>;
-}
-export type RequestSubscription = (requestState: RequestCacheRequestState) => void;
-/**
-* The RequestStateService is used to track the state of requests
-* for fetching or updating known resource identifies that are inflight.
-*
-* @hideconstructor
-* @public
-*/
-export declare class RequestStateService {
-	constructor(store: Store);
-	/**
-	* Subscribe to requests for a given resource identity.
-	*
-	* The callback will receive the current state of the request.
-	*
-	* ```ts
-	* interface RequestState {
-	*   state: 'pending' | 'fulfilled' | 'rejected';
-	*   type: 'query' | 'mutation';
-	*   request: Request;
-	*   response?: { data: unknown };
-	* }
-	* ```
-	*
-	* Note: It should be considered dangerous to use this API for more than simple
-	* state derivation or debugging. The `request` and `response` properties are poorly
-	* spec'd and may change unexpectedly when shifting what Handlers are in use or how
-	* requests are issued from the Store.
-	*
-	* We expect to revisit this API in the near future as we continue to refine the
-	* RequestManager ergonomics, as a simpler but more powerful direct integration
-	* with the RequestManager for these purposes is likely to be a better long-term
-	* design.
-	*
-	* @public
-	* @param {ResourceKey} identifier
-	* @param {(state: RequestCacheRequestState) => void} callback
-	*/
-	subscribeForRecord(identifier: ResourceKey, callback: RequestSubscription): void;
-	/**
-	* Retrieve all active requests for a given resource identity.
-	*
-	* @public
-	* @param {ResourceKey} identifier
-	* @return {RequestCacheRequestState[]} an array of request states for any pending requests for the given identifier
-	*/
-	getPendingRequestsForRecord(identifier: ResourceKey): RequestCacheRequestState[];
-	/**
-	* Retrieve the last completed request for a given resource identity.
-	*
-	* @public
-	* @param {ResourceKey} identifier
-	* @return {RequestCacheRequestState | null} the state of the most recent request for the given identifier
-	*/
-	getLastRequestForRecord(identifier: ResourceKey): RequestCacheRequestState | null;
-}
-/**
-* This type exists for internal use only for
-* where intimate contracts still exist either for
-* the Test Suite or for Legacy code.
-*
-* @private
-*/
-export interface PrivateRequestStateService extends RequestStateService {
-	_pending: Map<ResourceKey, InternalRequest[]>;
-	_clearEntries(identifier: ResourceKey): void;
-	_enqueue<T>(promise: Promise<T>, queryRequest: Request): Promise<T>;
-}
-export {};

package/dist/unpkg/dev-deprecated/declarations/store/-private/new-core-tmp/expensive-subscription.d.ts

@@ -1,24 +0,0 @@
-import type { RequestKey } from "../../../types/identifier.js";
-import type { Store } from "../store-service.js";
-/**
-* Creates an {@link ExpensiveSubscription} for the {@link RequestKey}
-* if one does not already exist and adds a watcher to it.
-*
-* Returns a cleanup function. This should be called on-mount by a component
-* that wants to subscribe to a request and cleanup should be called on dismount.
-*
-* ::: warning ⚠️ Avoid Using If Your App Supports Fine-grained Reactivity
-* This mechanism should never be used by frameworks or libraries
-* that support fine-grained reactivity.
-* :::
-*
-* `ExpensiveSubscription` is a mechanism for non-reactive
-* frameworks such as `react` to integrate with WarpDrive, for instance
-* by treating a request as an [external store](https://react.dev/reference/react/useSyncExternalStore)
-*
-* `ExpensiveSubscription` is expensive *because* it doubles the number
-* of notification callbacks required for each resource contained in
-* the request being subscribed to. The more requests in-use, the more
-* this cost adds up.
-*/
-export declare function getExpensiveRequestSubscription(store: Store, requestKey: RequestKey, callback: () => void): () => void;

package/dist/unpkg/dev-deprecated/declarations/store/-private/new-core-tmp/promise-state.d.ts

@@ -1,264 +0,0 @@
-import type { Awaitable } from "../../../request.js";
-/**
-* The state of a promise in the "pending"
-* state. This is the default initial state.
-*
-*/
-export interface PendingPromise {
-	/**
-	* The status of the promise.
-	*
-	*/
-	status: "pending";
-	/**
-	* Whether the promise is pending.
-	*
-	*/
-	isPending: true;
-	/**
-	* Whether the promise is pending.
-	*
-	* @deprecated use `isPending` instead
-	*/
-	isLoading: true;
-	/**
-	* Whether the promise has resolved
-	* successfully.
-	*
-	*/
-	isSuccess: false;
-	/**
-	* Whether the promise has rejected
-	* with an error.
-	*
-	*/
-	isError: false;
-	/**
-	* Once the promise has resolved, this will
-	* be the value the promise resolved to.
-	*
-	*/
-	value: null;
-	/**
-	* Once the promise has resolved, this will
-	* be the value the promise resolved to.
-	*
-	* @deprecated use `value` instead
-	*/
-	result: null;
-	/**
-	* Once the promise has rejected, this will
-	* be the error the promise rejected with.
-	*
-	*
-	* @deprecated use `reason` instead
-	*/
-	error: null;
-	/**
-	* Once the promise has rejected, this will
-	* be the error the promise rejected with.
-	*
-	*/
-	reason: null;
-}
-/**
-* The state of a promise in the "fulfilled" state.
-* This is the state of a promise that has resolved
-* successfully.
-*
-*/
-export interface ResolvedPromise<T> {
-	/**
-	* The status of the promise.
-	*
-	*/
-	status: "fulfilled";
-	/**
-	* Whether the promise is pending.
-	*
-	*/
-	isPending: false;
-	/**
-	* Whether the promise is pending.
-	*
-	* @deprecated use `isPending` instead
-	*/
-	isLoading: false;
-	/**
-	* Whether the promise has resolved
-	* successfully.
-	*
-	*/
-	isSuccess: true;
-	/**
-	* Whether the promise has rejected
-	* with an error.
-	*
-	*/
-	isError: false;
-	/**
-	* Once the promise has resolved, this will
-	* be the value the promise resolved to.
-	*
-	*/
-	value: T;
-	/**
-	* Once the promise has resolved, this will
-	* be the value the promise resolved to.
-	*
-	* @deprecated use `value` instead
-	*/
-	result: T;
-	/**
-	* Once the promise has rejected, this will
-	* be the error the promise rejected with.
-	*
-	*
-	* @deprecated use `reason` instead
-	*/
-	error: null;
-	/**
-	* Once the promise has rejected, this will
-	* be the error the promise rejected with.
-	*
-	*/
-	reason: null;
-}
-/**
-* The state of a promise in the "rejected" state.
-* This is the state of a promise that has rejected
-* with an error.
-*
-*/
-export interface RejectedPromise<E> {
-	/**
-	* The status of the promise.
-	*
-	*/
-	status: "rejected";
-	/**
-	* Whether the promise is pending.
-	*
-	*/
-	isPending: false;
-	/**
-	* Whether the promise is pending.
-	*
-	* @deprecated use `isPending` instead
-	*/
-	isLoading: false;
-	/**
-	* Whether the promise has resolved
-	* successfully.
-	*
-	*/
-	isSuccess: false;
-	/**
-	* Whether the promise has rejected
-	* with an error.
-	*
-	*/
-	isError: true;
-	/**
-	* Once the promise has resolved, this will
-	* be the value the promise resolved to.
-	*
-	*/
-	value: null;
-	/**
-	* Once the promise has resolved, this will
-	* be the value the promise resolved to.
-	*
-	* @deprecated use `value` instead
-	*/
-	result: null;
-	/**
-	* Once the promise has rejected, this will
-	* be the error the promise rejected with.
-	*
-	*
-	* @deprecated use `reason` instead
-	*/
-	error: E;
-	/**
-	* Once the promise has rejected, this will
-	* be the error the promise rejected with.
-	*
-	*/
-	reason: E;
-}
-/**
-* The state of a promise. This is the type that is returned
-* from `getPromiseState`.
-*
-* See also:
-* - {@link PendingPromise}
-* - {@link ResolvedPromise}
-* - {@link RejectedPromise}
-*
-*/
-export type PromiseState<
-	T = unknown,
-	E = unknown
-> = PendingPromise | ResolvedPromise<T> | RejectedPromise<E>;
-export declare function createPromiseState<
-	T,
-	E
->(promise: Promise<T> | Awaitable<T, E>): Readonly<PromiseState<T, E>>;
-/**
-* Returns a reactive state-machine for the provided promise or awaitable.
-*
-* Repeat calls to `getPromiseState` with the same promise will return the same state object
-* making is safe and easy to use in templates and JavaScript code to produce reactive
-* behaviors around promises.
-*
-* `getPromiseState` can be used in both JavaScript and Template contexts.
-*
-* ```ts
-* import { getPromiseState } from '@warp-drive/ember';
-*
-* const state = getPromiseState(promise);
-* ```
-*
-* For instance, we could write a getter on a component that updates whenever
-* the promise state advances or the promise changes, by combining the function
-* with the use of `@cached`
-*
-* ```ts
-* class Component {
-*   @cached
-*   get title() {
-*     const state = getPromiseState(this.args.request);
-*     if (state.isPending) {
-*       return 'loading...';
-*     }
-*     if (state.isError) { return null; }
-*     return state.result.title;
-*   }
-* }
-* ```
-*
-* Or in a template as a helper:
-*
-* ```gjs
-* import { getPromiseState } from '@warp-drive/ember';
-*
-* <template>
-*   {{#let (getPromiseState @request) as |state|}}
-*     {{#if state.isPending}} <Spinner />
-*     {{else if state.isError}} <ErrorForm @error={{state.error}} />
-*     {{else}}
-*       <h1>{{state.result.title}}</h1>
-*     {{/if}}
-*   {{/let}}
-* </template>
-* ```
-*
-* If looking to use in a template, consider also the `<Await />` component.
-*
-* See also {@link PromiseState}
-*/
-export declare function getPromiseState<
-	T = unknown,
-	E = unknown
->(promise: Promise<T> | Awaitable<T, E>): Readonly<PromiseState<T, E>>;