@warp-drive/core 5.6.0-alpha.15 → 5.6.0-alpha.17

package/declarations/types/graph.d.ts

@@ -1,48 +1,47 @@
-import type { AddToResourceRelationshipMutation as AddResourceMutation, RemoveFromResourceRelationshipMutation as RemoveResourceMutation } from './cache/mutations.ts';
-import type { AddToResourceRelationshipOperation as AddResourceOperation, RemoveFromResourceRelationshipOperation as RemoveResourceOperation, UpdateResourceRelationshipOperation } from './cache/operations.ts';
-import type { StableRecordIdentifier } from './identifier.ts';
-import type { CollectionResourceRelationship, SingleResourceRelationship } from './spec/json-api-raw.ts';
+import type { AddToResourceRelationshipMutation as AddResourceMutation, RemoveFromResourceRelationshipMutation as RemoveResourceMutation } from "./cache/mutations.js";
+import type { AddToResourceRelationshipOperation as AddResourceOperation, RemoveFromResourceRelationshipOperation as RemoveResourceOperation, UpdateResourceRelationshipOperation } from "./cache/operations.js";
+import type { StableRecordIdentifier } from "./identifier.js";
+import type { CollectionResourceRelationship, SingleResourceRelationship } from "./spec/json-api-raw.js";
 export interface Operation {
-    op: string;
+	op: string;
 }
 export interface UpdateRelationshipOperation {
-    op: 'updateRelationship';
-    record: StableRecordIdentifier;
-    field: string;
-    value: SingleResourceRelationship | CollectionResourceRelationship;
+	op: "updateRelationship";
+	record: StableRecordIdentifier;
+	field: string;
+	value: SingleResourceRelationship | CollectionResourceRelationship;
 }
 export interface DeleteRecordOperation {
-    op: 'deleteRecord';
-    record: StableRecordIdentifier;
-    isNew: boolean;
+	op: "deleteRecord";
+	record: StableRecordIdentifier;
+	isNew: boolean;
 }
 export interface UnknownOperation {
-    op: 'never';
-    record: StableRecordIdentifier;
-    field: string;
+	op: "never";
+	record: StableRecordIdentifier;
+	field: string;
 }
 export interface ReplaceRelatedRecordOperation {
-    op: 'replaceRelatedRecord';
-    record: StableRecordIdentifier;
-    field: string;
-    value: StableRecordIdentifier | null;
-    prior?: StableRecordIdentifier;
-    index?: number;
+	op: "replaceRelatedRecord";
+	record: StableRecordIdentifier;
+	field: string;
+	value: StableRecordIdentifier | null;
+	prior?: StableRecordIdentifier;
+	index?: number;
 }
 export interface SortRelatedRecords {
-    op: 'sortRelatedRecords';
-    record: StableRecordIdentifier;
-    field: string;
-    value: StableRecordIdentifier[];
+	op: "sortRelatedRecords";
+	record: StableRecordIdentifier;
+	field: string;
+	value: StableRecordIdentifier[];
 }
 export interface ReplaceRelatedRecordsOperation {
-    op: 'replaceRelatedRecords';
-    record: StableRecordIdentifier;
-    field: string;
-    value: StableRecordIdentifier[];
-    prior?: StableRecordIdentifier[];
-    index?: number;
+	op: "replaceRelatedRecords";
+	record: StableRecordIdentifier;
+	field: string;
+	value: StableRecordIdentifier[];
+	prior?: StableRecordIdentifier[];
+	index?: number;
 }
 export type RemoteRelationshipOperation = UpdateResourceRelationshipOperation | UpdateRelationshipOperation | ReplaceRelatedRecordOperation | ReplaceRelatedRecordsOperation | RemoveResourceOperation | AddResourceOperation | DeleteRecordOperation | SortRelatedRecords;
 export type LocalRelationshipOperation = ReplaceRelatedRecordsOperation | ReplaceRelatedRecordOperation | AddResourceMutation | RemoveResourceMutation | SortRelatedRecords;
-//# sourceMappingURL=graph.d.ts.map

package/declarations/types/identifier.d.ts

@@ -1,111 +1,112 @@
+// provided for additional debuggability
 export declare const DEBUG_CLIENT_ORIGINATED: unique symbol;
 export declare const DEBUG_IDENTIFIER_BUCKET: unique symbol;
 export declare const DEBUG_STALE_CACHE_OWNER: unique symbol;
-export declare const CACHE_OWNER: '__$co';
-export type IdentifierBucket = 'record' | 'document';
+// also present in production
+export declare const CACHE_OWNER: "__$co";
+export type IdentifierBucket = "record" | "document";
 export interface Identifier {
-    lid: string;
-    clientId?: string;
+	lid: string;
+	clientId?: string;
 }
 export interface ExistingRecordIdentifier<T extends string = string> extends Identifier {
-    id: string;
-    type: T;
+	id: string;
+	type: T;
 }
 export interface NewRecordIdentifier<T extends string = string> extends Identifier {
-    id: string | null;
-    type: T;
+	id: string | null;
+	type: T;
 }
 export type StableDocumentIdentifier = {
-    lid: string;
+	lid: string;
 };
 export type RequestKey = StableDocumentIdentifier;
 /**
- * An Identifier specific to a record which may or may not
- * be present in the cache.
- *
- * The absence of an `id` DOES NOT indicate that this
- * Identifier is for a new client-created record as it
- * may also indicate that it was generated for a secondary
- * index and the primary `id` index is not yet known.
- *
- * @internal
- */
+* An Identifier specific to a record which may or may not
+* be present in the cache.
+*
+* The absence of an `id` DOES NOT indicate that this
+* Identifier is for a new client-created record as it
+* may also indicate that it was generated for a secondary
+* index and the primary `id` index is not yet known.
+*
+* @internal
+*/
 export type RecordIdentifier<T extends string = string> = ExistingRecordIdentifier<T> | NewRecordIdentifier<T>;
 /**
- * Used when an Identifier is known to be the stable version
- *
- * @internal
- */
+* Used when an Identifier is known to be the stable version
+*
+* @internal
+*/
 export interface StableIdentifier extends Identifier {
-    [DEBUG_IDENTIFIER_BUCKET]?: string;
+	[DEBUG_IDENTIFIER_BUCKET]?: string;
 }
 /**
- * Used when a StableRecordIdentifier was not created locally as part
- * of a call to store.createRecord
- *
- * Distinguishing between this Identifier and one for a client created
- * record that was created with an ID is generally speaking not possible
- * at runtime, so anything with an ID typically narrows to this.
- *
- * @internal
- */
+* Used when a StableRecordIdentifier was not created locally as part
+* of a call to store.createRecord
+*
+* Distinguishing between this Identifier and one for a client created
+* record that was created with an ID is generally speaking not possible
+* at runtime, so anything with an ID typically narrows to this.
+*
+* @internal
+*/
 export interface StableExistingRecordIdentifier<T extends string = string> extends StableIdentifier {
-    id: string;
-    type: T;
-    [DEBUG_CLIENT_ORIGINATED]?: boolean;
-    [CACHE_OWNER]: number | undefined;
-    [DEBUG_STALE_CACHE_OWNER]?: number | undefined;
+	id: string;
+	type: T;
+	[DEBUG_CLIENT_ORIGINATED]?: boolean;
+	[CACHE_OWNER]: number | undefined;
+	[DEBUG_STALE_CACHE_OWNER]?: number | undefined;
 }
 /**
- * Used when a StableRecordIdentifier was created locally
- * (by a call to store.createRecord).
- *
- * It is possible in rare circumstances to have a StableRecordIdentifier
- * that is not for a new record but does not have an ID. This would
- * happen if a user intentionally created one for use with a secondary-index
- * prior to the record having been fully loaded.
- *
- * @internal
- */
+* Used when a StableRecordIdentifier was created locally
+* (by a call to store.createRecord).
+*
+* It is possible in rare circumstances to have a StableRecordIdentifier
+* that is not for a new record but does not have an ID. This would
+* happen if a user intentionally created one for use with a secondary-index
+* prior to the record having been fully loaded.
+*
+* @internal
+*/
 export interface StableNewRecordIdentifier<T extends string = string> extends StableIdentifier {
-    id: string | null;
-    type: T;
-    [DEBUG_CLIENT_ORIGINATED]?: boolean;
-    [CACHE_OWNER]: number | undefined;
-    [DEBUG_STALE_CACHE_OWNER]?: number | undefined;
+	id: string | null;
+	type: T;
+	[DEBUG_CLIENT_ORIGINATED]?: boolean;
+	[CACHE_OWNER]: number | undefined;
+	[DEBUG_STALE_CACHE_OWNER]?: number | undefined;
 }
 /**
- * A referentially stable object with a unique string (lid) that can be used
- * as a reference to data in the cache.
- *
- * Every record instance has a unique identifier, and identifiers may refer
- * to data that has never been loaded (for instance, in an async relationship).
- *
- * @class StableRecordIdentifier
- * @public
- */
+* A referentially stable object with a unique string (lid) that can be used
+* as a reference to data in the cache.
+*
+* Every record instance has a unique identifier, and identifiers may refer
+* to data that has never been loaded (for instance, in an async relationship).
+*
+* @class StableRecordIdentifier
+* @public
+*/
 /**
- * A string representing a unique identity.
- *
- * @property lid
- * @type {String}
- * @public
- */
+* A string representing a unique identity.
+*
+* @property lid
+* @type {String}
+* @public
+*/
 /**
- * the primary resource `type` or `modelName` this identity belongs to.
- *
- * @property type
- * @type {String}
- * @public
- */
+* the primary resource `type` or `modelName` this identity belongs to.
+*
+* @property type
+* @type {String}
+* @public
+*/
 /**
- * the primary id for the record this identity belongs to. `null`
- * if not yet assigned an id.
- *
- * @property id
- * @type {String | null}
- * @public
- */
+* the primary id for the record this identity belongs to. `null`
+* if not yet assigned an id.
+*
+* @property id
+* @type {String | null}
+* @public
+*/
 export type StableRecordIdentifier<T extends string = string> = StableExistingRecordIdentifier<T> | StableNewRecordIdentifier<T>;
 export type ResourceKey<T extends string = string> = StableRecordIdentifier<T>;
-//# sourceMappingURL=identifier.d.ts.map

package/declarations/types/json/raw.d.ts

@@ -1,7 +1,6 @@
 export type PrimitiveValue = string | number | boolean | null;
 export interface ObjectValue {
-    [key: string]: Value;
+	[key: string]: Value;
 }
 export type ArrayValue = Value[];
 export type Value = PrimitiveValue | ArrayValue | ObjectValue;
-//# sourceMappingURL=raw.d.ts.map

package/declarations/types/params.d.ts

@@ -1,10 +1,9 @@
-import type { Includes, TypedRecordInstance } from './record.ts';
+import type { Includes, TypedRecordInstance } from "./record.js";
 export type SerializablePrimitive = string | number | boolean | null;
 export type Serializable = SerializablePrimitive | SerializablePrimitive[];
 export type QueryParamsSerializationOptions = {
-    arrayFormat?: 'bracket' | 'indices' | 'repeat' | 'comma';
+	arrayFormat?: "bracket" | "indices" | "repeat" | "comma";
 };
 export type QueryParamsSource<T = unknown> = ({
-    include?: T extends TypedRecordInstance ? Includes<T>[] : string | string[];
-} & Record<Exclude<string, 'include'>, Serializable>) | URLSearchParams;
-//# sourceMappingURL=params.d.ts.map
+	include?: T extends TypedRecordInstance ? Includes<T>[] : string | string[];
+} & Record<Exclude<string, "include">, Serializable>) | URLSearchParams;

package/declarations/types/record.d.ts

@@ -1,96 +1,137 @@
-import type { Type } from './symbols.ts';
+import type { Type } from "./symbols.js";
 /**
- * Records may be anything, They don't even
- * have to be objects.
- *
- * Whatever they are, if they have a Type
- * property, that property will be used by WarpDrive
- * and WarpDrive to provide better type safety and
- * intellisense.
- *
- * @class TypedRecordInstance
- */
+* Records may be anything, They don't even
+* have to be objects.
+*
+* Whatever they are, if they have a Type
+* property, that property will be used by WarpDrive
+* and WarpDrive to provide better type safety and
+* intellisense.
+*
+* @class TypedRecordInstance
+*/
 export interface TypedRecordInstance {
-    /**
-     * The type of the resource.
-     *
-     * This is an optional feature that can be used by
-     * record implementations to provide a typescript
-     * hint for the type of the resource.
-     *
-     * When used, WarpDrive APIs can
-     * take advantage of this to provide better type
-     * safety and intellisense.
-     *
-     * @property [Type]
-     * @type {Type}
-     * @type {String}
-     */
-    [Type]: string;
+	/**
+	* The type of the resource.
+	*
+	* This is an optional feature that can be used by
+	* record implementations to provide a typescript
+	* hint for the type of the resource.
+	*
+	* When used, WarpDrive APIs can
+	* take advantage of this to provide better type
+	* safety and intellisense.
+	*
+	* @property [Type]
+	* @type {Type}
+	* @type {String}
+	*/
+	[Type]: string;
 }
 /**
- * A type utility that extracts the Type if available,
- * otherwise it returns never.
- *
- */
+* A type utility that extracts the Type if available,
+* otherwise it returns never.
+*
+*/
 export type TypeFromInstance<T> = T extends TypedRecordInstance ? T[typeof Type] : never;
 /**
- * A type utility that extracts the Type if available,
- * otherwise it returns string
- *
- */
+* A type utility that extracts the Type if available,
+* otherwise it returns string
+*
+*/
 export type TypeFromInstanceOrString<T> = T extends TypedRecordInstance ? T[typeof Type] : string;
 type IsUniqueSymbol<T> = T extends `___(unique) Symbol(${string})` ? true : false;
 type Unpacked<T> = T extends (infer U)[] ? U : T;
 type NONE = {
-    __NONE: never;
+	__NONE: never;
 };
-type __InternalExtract<MAX_DEPTH extends _DEPTHCOUNT, T extends TypedRecordInstance, V extends TypedRecordInstance, IncludePrefix extends boolean, Ignore, Pre extends string, DEPTH extends _DEPTHCOUNT> = V extends T ? IncludePrefix extends false ? V[typeof Type] : Pre : V extends Ignore ? IncludePrefix extends false ? V[typeof Type] : Pre : IS_MAX_DEPTH<DEPTH, MAX_DEPTH> extends true ? Pre : ExtractUnion<MAX_DEPTH, V, IncludePrefix, Ignore | T, Pre, INC_DEPTH<DEPTH>>;
-type __ExtractIfRecord<MAX_DEPTH extends _DEPTHCOUNT, T extends TypedRecordInstance, V, IncludePrefix extends boolean, Ignore, Pre extends string, DEPTH extends _DEPTHCOUNT> = V extends TypedRecordInstance ? __InternalExtract<MAX_DEPTH, T, V, IncludePrefix, Ignore, Pre, DEPTH> : never;
-type _ExtractUnion<MAX_DEPTH extends _DEPTHCOUNT, T extends TypedRecordInstance, IncludePrefix extends boolean, Ignore, Pre, DEPTH extends _DEPTHCOUNT> = {
-    [K in keyof T]: IsUniqueSymbol<K> extends true ? never : K extends string ? __ExtractIfRecord<MAX_DEPTH, T, Unpacked<Awaited<T[K]>>, IncludePrefix, Ignore, Pre extends string ? `${Pre}.${K}` : K, DEPTH> : never;
-}[keyof T];
+type __InternalExtract<
+	MAX_DEPTH extends _DEPTHCOUNT,
+	T extends TypedRecordInstance,
+	V extends TypedRecordInstance,
+	IncludePrefix extends boolean,
+	Ignore,
+	Pre extends string,
+	DEPTH extends _DEPTHCOUNT
+> = V extends T ? IncludePrefix extends false ? V[typeof Type] : Pre : V extends Ignore ? IncludePrefix extends false ? V[typeof Type] : Pre : IS_MAX_DEPTH<DEPTH, MAX_DEPTH> extends true ? Pre : ExtractUnion<MAX_DEPTH, V, IncludePrefix, Ignore | T, Pre, INC_DEPTH<DEPTH>>;
+type __ExtractIfRecord<
+	MAX_DEPTH extends _DEPTHCOUNT,
+	T extends TypedRecordInstance,
+	V,
+	IncludePrefix extends boolean,
+	Ignore,
+	Pre extends string,
+	DEPTH extends _DEPTHCOUNT
+> = V extends TypedRecordInstance ? __InternalExtract<MAX_DEPTH, T, V, IncludePrefix, Ignore, Pre, DEPTH> : never;
+type _ExtractUnion<
+	MAX_DEPTH extends _DEPTHCOUNT,
+	T extends TypedRecordInstance,
+	IncludePrefix extends boolean,
+	Ignore,
+	Pre,
+	DEPTH extends _DEPTHCOUNT
+> = { [K in keyof T] : IsUniqueSymbol<K> extends true ? never : K extends string ? __ExtractIfRecord<MAX_DEPTH, T, Unpacked<Awaited<T[K]>>, IncludePrefix, Ignore, Pre extends string ? `${Pre}.${K}` : K, DEPTH> : never }[keyof T];
 /**
- * A Utility that extracts either resource types or resource paths from a TypedRecordInstance.
- *
- * Its limitations are mostly around its intentional non-recursiveness. It presumes that APIs which
- * implement includes will not allow cyclical include paths, and will collapse includes by type.
- *
- * This follows closer to the JSON:API fields spec than to the includes spec in nature, but in
- * practice it is so impracticle for an API to allow z-algo include paths that this is probably
- * reasonable.
- *
- * We may need to revisit this in the future, opting to either make this restriction optional or
- * to allow for other strategies.
- *
- * There's a 90% chance this particular implementation belongs being in the JSON:API package instead
- * of core-types, but it's here for now.
- *
- */
-type ExtractUnion<MAX_DEPTH extends _DEPTHCOUNT, T extends TypedRecordInstance, IncludePrefix extends boolean = false, Ignore = NONE, Pre = NONE, DEPTH extends _DEPTHCOUNT = 1> = Exclude<IncludePrefix extends true ? // if we want to include prefix, we union with the prefix. Outer Exclude will filter any "NONE" types
-_ExtractUnion<MAX_DEPTH, T, IncludePrefix, Ignore, Pre, DEPTH> | Pre : // Else we just union the types.
-_ExtractUnion<MAX_DEPTH, T, IncludePrefix, Ignore, Pre, DEPTH> | T[typeof Type], NONE>;
+* A Utility that extracts either resource types or resource paths from a TypedRecordInstance.
+*
+* Its limitations are mostly around its intentional non-recursiveness. It presumes that APIs which
+* implement includes will not allow cyclical include paths, and will collapse includes by type.
+*
+* This follows closer to the JSON:API fields spec than to the includes spec in nature, but in
+* practice it is so impracticle for an API to allow z-algo include paths that this is probably
+* reasonable.
+*
+* We may need to revisit this in the future, opting to either make this restriction optional or
+* to allow for other strategies.
+*
+* There's a 90% chance this particular implementation belongs being in the JSON:API package instead
+* of core-types, but it's here for now.
+*
+*/
+type ExtractUnion<
+	MAX_DEPTH extends _DEPTHCOUNT,
+	T extends TypedRecordInstance,
+	IncludePrefix extends boolean = false,
+	Ignore = NONE,
+	Pre = NONE,
+	DEPTH extends _DEPTHCOUNT = 1
+> = Exclude<IncludePrefix extends true ? _ExtractUnion<MAX_DEPTH, T, IncludePrefix, Ignore, Pre, DEPTH> | Pre : _ExtractUnion<MAX_DEPTH, T, IncludePrefix, Ignore, Pre, DEPTH> | T[typeof Type], NONE>;
 type _DEPTHCOUNT = 1 | 2 | 3 | 4 | 5;
 type INC_DEPTH<START extends _DEPTHCOUNT> = START extends 1 ? 2 : START extends 2 ? 3 : START extends 3 ? 4 : 5;
-type IS_MAX_DEPTH<DEPTH extends _DEPTHCOUNT, MAX_DEPTH extends _DEPTHCOUNT = DEFAULT_MAX_DEPTH> = DEPTH extends MAX_DEPTH ? true : false;
+type IS_MAX_DEPTH<
+	DEPTH extends _DEPTHCOUNT,
+	MAX_DEPTH extends _DEPTHCOUNT = DEFAULT_MAX_DEPTH
+> = DEPTH extends MAX_DEPTH ? true : false;
 type DEFAULT_MAX_DEPTH = 3;
 /**
- * A utility that provides the union of all ResourceName for all potential
- * includes for the given TypedRecordInstance.
- *
- */
-export type ExtractSuggestedCacheTypes<T extends TypedRecordInstance, MAX_DEPTH extends _DEPTHCOUNT = DEFAULT_MAX_DEPTH> = ExtractUnion<MAX_DEPTH, T>;
+* A utility that provides the union of all ResourceName for all potential
+* includes for the given TypedRecordInstance.
+*
+*/
+export type ExtractSuggestedCacheTypes<
+	T extends TypedRecordInstance,
+	MAX_DEPTH extends _DEPTHCOUNT = DEFAULT_MAX_DEPTH
+> = ExtractUnion<MAX_DEPTH, T>;
 /**
- * A utility that provides the union type of all valid include paths for the given
- * TypedRecordInstance.
- *
- * Cyclical paths are filtered out.
- *
- */
-export type Includes<T extends TypedRecordInstance, MAX_DEPTH extends _DEPTHCOUNT = DEFAULT_MAX_DEPTH> = ExtractUnion<MAX_DEPTH, T, true>;
+* A utility that provides the union type of all valid include paths for the given
+* TypedRecordInstance.
+*
+* Cyclical paths are filtered out.
+*
+*/
+export type Includes<
+	T extends TypedRecordInstance,
+	MAX_DEPTH extends _DEPTHCOUNT = DEFAULT_MAX_DEPTH
+> = ExtractUnion<MAX_DEPTH, T, true>;
 export type OpaqueRecordInstance = unknown;
-export type _StringSatisfiesIncludes<T extends string, SET extends string, FT extends string> = T extends SET ? FT : T extends `${infer U},${infer V}` ? U extends SET ? _StringSatisfiesIncludes<V, Exclude<SET, U>, FT> : never : never;
-export type StringSatisfiesIncludes<T extends string, SET extends string> = _StringSatisfiesIncludes<T, SET, T>;
+export type _StringSatisfiesIncludes<
+	T extends string,
+	SET extends string,
+	FT extends string
+> = T extends SET ? FT : T extends `${infer U},${infer V}` ? U extends SET ? _StringSatisfiesIncludes<V, Exclude<SET, U>, FT> : never : never;
+export type StringSatisfiesIncludes<
+	T extends string,
+	SET extends string
+> = _StringSatisfiesIncludes<T, SET, T>;
 export declare function createIncludeValidator<T extends TypedRecordInstance>(): <U extends string>(includes: StringSatisfiesIncludes<U, Includes<T>>) => U;
 export {};
-//# sourceMappingURL=record.d.ts.map