@warp-drive/core 5.6.0-alpha.5 → 5.6.0-beta.0

package/declarations/types/schema/fields.type-test.d.ts

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=fields.type-test.d.ts.map

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

@@ -1,31 +1,37 @@
-import type { StableExistingRecordIdentifier } from '../identifier.ts';
-import type { ApiError } from './error.ts';
-import type { Links, Meta, PaginationLinks } from './json-api-raw.ts';
+import type { StableExistingRecordIdentifier } from "../identifier.js";
+import type { ApiError } from "./error.js";
+import type { Links, Meta, PaginationLinks } from "./json-api-raw.js";
 export interface ResourceMetaDocument {
-    lid?: string;
-    meta: Meta;
-    links?: Links | PaginationLinks;
+	// the url or cache-key associated with the structured document
+	lid?: string;
+	meta: Meta;
+	links?: Links | PaginationLinks;
 }
-export interface SingleResourceDataDocument<T = StableExistingRecordIdentifier, R = StableExistingRecordIdentifier> {
-    lid?: string;
-    links?: Links | PaginationLinks;
-    meta?: Meta;
-    data: T | null;
-    included?: R[];
+export interface SingleResourceDataDocument<
+	T = StableExistingRecordIdentifier,
+	R = StableExistingRecordIdentifier
+> {
+	// the url or cache-key associated with the structured document
+	lid?: string;
+	links?: Links | PaginationLinks;
+	meta?: Meta;
+	data: T | null;
+	included?: R[];
 }
 export interface CollectionResourceDataDocument<T = StableExistingRecordIdentifier> {
-    lid?: string;
-    links?: Links | PaginationLinks;
-    meta?: Meta;
-    data: T[];
-    included?: T[];
+	// the url or cache-key associated with the structured document
+	lid?: string;
+	links?: Links | PaginationLinks;
+	meta?: Meta;
+	data: T[];
+	included?: T[];
 }
 export type ResourceDataDocument<T = StableExistingRecordIdentifier> = SingleResourceDataDocument<T> | CollectionResourceDataDocument<T>;
 export interface ResourceErrorDocument {
-    lid?: string;
-    links?: Links | PaginationLinks;
-    meta?: Meta;
-    errors: ApiError[];
+	// the url or cache-key associated with the structured document
+	lid?: string;
+	links?: Links | PaginationLinks;
+	meta?: Meta;
+	errors: ApiError[];
 }
 export type ResourceDocument<T = StableExistingRecordIdentifier> = ResourceMetaDocument | SingleResourceDataDocument<T> | CollectionResourceDataDocument<T> | ResourceErrorDocument;
-//# sourceMappingURL=document.d.ts.map

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

@@ -1,19 +1,18 @@
-import type { Link, Meta } from './json-api-raw.ts';
+import type { Link, Meta } from "./json-api-raw.js";
 export interface ApiError {
-    id?: string;
-    title?: string;
-    detail?: string;
-    links?: {
-        about?: Link;
-        type?: Link;
-    };
-    status?: string;
-    code?: string;
-    source?: {
-        pointer: string;
-        parameter?: string;
-        header?: string;
-    };
-    meta?: Meta;
+	id?: string;
+	title?: string;
+	detail?: string;
+	links?: {
+		about?: Link;
+		type?: Link;
+	};
+	status?: string;
+	code?: string;
+	source?: {
+		pointer: string;
+		parameter?: string;
+		header?: string;
+	};
+	meta?: Meta;
 }
-//# sourceMappingURL=error.d.ts.map

package/declarations/types/spec/json-api-raw.d.ts

@@ -1,142 +1,142 @@
-import type { ArrayValue, ObjectValue } from '../json/raw.ts';
+import type { ArrayValue, ObjectValue } from "../json/raw.js";
 export type Meta = ObjectValue;
 export type LinkObject = {
-    href: string;
-    meta?: Meta;
+	href: string;
+	meta?: Meta;
 };
 export type Link = string | LinkObject;
 export interface Links {
-    related?: Link | null;
-    self?: Link | null;
+	related?: Link | null;
+	self?: Link | null;
 }
 export interface PaginationLinks extends Links {
-    first?: Link | null;
-    last?: Link | null;
-    prev?: Link | null;
-    next?: Link | null;
+	first?: Link | null;
+	last?: Link | null;
+	prev?: Link | null;
+	next?: Link | null;
 }
 /**
- * Serves as a reference to a `Resource` but does not contain
- * any data itself.
- *
- * Used to establish relationship linkages between `Resources` and
- * to address data that may not be available synchronously.
- *
- * [JSON:API Spec](https://jsonapi.org/format/#document-resource-identifier-objects)
- * @internal
- */
+* Serves as a reference to a `Resource` but does not contain
+* any data itself.
+*
+* Used to establish relationship linkages between `Resources` and
+* to address data that may not be available synchronously.
+*
+* [JSON:API Spec](https://jsonapi.org/format/#document-resource-identifier-objects)
+* @internal
+*/
 export interface ExistingResourceIdentifierObject<T extends string = string> {
-    id: string;
-    type: T;
-    /**
-     * While not officially part of the `JSON:API` spec,
-     * `ember-data` allows the use of `lid` as a local
-     * identifier for a `Resource`.
-     *
-     * @recommended It is best to include the lid used when creating
-     *   a new resource if this is the response to a new resource creation,
-     *   also recommended if this resource type uses secondary indexes.
-     *
-     * Once a `ResourceIdentifierObject` has been seen by the cache, `lid`
-     * should always be present. Only when inbound from the an `API` response
-     * is `lid` considered optional.
-     *
-     * [Identifiers RFC](https://github.com/emberjs/rfcs/blob/main/text/0403-ember-data-identifiers.md#ember-data--identifiers)
-     * @internal
-     */
-    lid?: string;
-    /**
-     * While valid in the `JSON:API` spec,
-     * `ember-data` ignores `meta` on `ResourceIdentifierObjects`
-     *
-     * @ignored this property goes un-utilized and will be lost
-     * @internal
-     */
-    meta?: Meta;
+	id: string;
+	type: T;
+	/**
+	* While not officially part of the `JSON:API` spec,
+	* `ember-data` allows the use of `lid` as a local
+	* identifier for a `Resource`.
+	*
+	* @recommended It is best to include the lid used when creating
+	*   a new resource if this is the response to a new resource creation,
+	*   also recommended if this resource type uses secondary indexes.
+	*
+	* Once a `ResourceIdentifierObject` has been seen by the cache, `lid`
+	* should always be present. Only when inbound from the an `API` response
+	* is `lid` considered optional.
+	*
+	* [Identifiers RFC](https://github.com/emberjs/rfcs/blob/main/text/0403-ember-data-identifiers.md#ember-data--identifiers)
+	* @internal
+	*/
+	lid?: string;
+	/**
+	* While valid in the `JSON:API` spec,
+	* `ember-data` ignores `meta` on `ResourceIdentifierObjects`
+	*
+	* @ignored this property goes un-utilized and will be lost
+	* @internal
+	*/
+	meta?: Meta;
 }
 /**
- * Serves as a reference to a resource created on the client
- * but not yet persisted.
- *
- * @internal
- */
+* Serves as a reference to a resource created on the client
+* but not yet persisted.
+*
+* @internal
+*/
 export interface NewResourceIdentifierObject<T extends string = string> {
-    /**
-     * Resources newly created on the client _may_
-     * not have an `id` available to them prior
-     * to completion of their first successful `save`.
-     *
-     * `id` will be `null` in this case.
-     *
-     * @internal
-     */
-    id: string | null;
-    type: T;
-    /**
-     * Resources newly created on the client _will always_
-     * have an `lid` assigned immediately and available.
-     * @internal
-     */
-    lid: string;
+	/**
+	* Resources newly created on the client _may_
+	* not have an `id` available to them prior
+	* to completion of their first successful `save`.
+	*
+	* `id` will be `null` in this case.
+	*
+	* @internal
+	*/
+	id: string | null;
+	type: T;
+	/**
+	* Resources newly created on the client _will always_
+	* have an `lid` assigned immediately and available.
+	* @internal
+	*/
+	lid: string;
 }
 export interface ResourceIdentifier {
-    lid: string;
+	lid: string;
 }
 export type ResourceIdentifierObject<T extends string = string> = ResourceIdentifier | ExistingResourceIdentifierObject<T> | NewResourceIdentifierObject<T>;
+// TODO disallow NewResource, make narrowable
 export interface SingleResourceRelationship<T = ExistingResourceIdentifierObject | NewResourceIdentifierObject> {
-    data?: T | null;
-    meta?: Meta;
-    links?: Links;
+	data?: T | null;
+	meta?: Meta;
+	links?: Links;
 }
 export interface CollectionResourceRelationship<T = ExistingResourceIdentifierObject | NewResourceIdentifierObject> {
-    data?: T[];
-    meta?: Meta;
-    links?: PaginationLinks;
+	data?: T[];
+	meta?: Meta;
+	links?: PaginationLinks;
 }
 export type InnerRelationshipDocument<T = ExistingResourceIdentifierObject | NewResourceIdentifierObject> = SingleResourceRelationship<T> | CollectionResourceRelationship<T>;
 export type ResourceRelationshipsObject<T = ExistingResourceIdentifierObject | NewResourceIdentifierObject> = Record<string, InnerRelationshipDocument<T>>;
 /**
- * Contains the data for an existing resource in JSON:API format
- * @internal
- */
+* Contains the data for an existing resource in JSON:API format
+* @internal
+*/
 export interface ExistingResourceObject<T extends string = string> extends ExistingResourceIdentifierObject<T> {
-    meta?: Meta;
-    attributes?: ObjectValue;
-    relationships?: ResourceRelationshipsObject<ExistingResourceIdentifierObject>;
-    links?: Links;
+	meta?: Meta;
+	attributes?: ObjectValue;
+	relationships?: ResourceRelationshipsObject<ExistingResourceIdentifierObject>;
+	links?: Links;
 }
 export type NewResourceObject<T extends string = string> = NewResourceIdentifierObject<T> & {
-    meta?: Meta;
-    attributes?: ObjectValue;
-    relationships?: ResourceRelationshipsObject;
-    links?: Links;
+	meta?: Meta;
+	attributes?: ObjectValue;
+	relationships?: ResourceRelationshipsObject;
+	links?: Links;
 };
 export type ResourceObject<T extends string = string> = ExistingResourceObject<T> | NewResourceObject<T>;
 type Document = {
-    lid?: string;
-    meta?: Meta;
-    included?: ExistingResourceObject[];
-    jsonapi?: ObjectValue;
-    links?: Links | PaginationLinks;
-    errors?: ArrayValue;
+	lid?: string;
+	meta?: Meta;
+	included?: ExistingResourceObject[];
+	jsonapi?: ObjectValue;
+	links?: Links | PaginationLinks;
+	errors?: ArrayValue;
 };
 export type EmptyResourceDocument = Document & {
-    data: null;
+	data: null;
 };
 export type SingleResourceDocument<T extends string = string> = Document & {
-    data: ExistingResourceObject<T>;
+	data: ExistingResourceObject<T>;
 };
 export type CollectionResourceDocument<T extends string = string> = Document & {
-    data: ExistingResourceObject<T>[];
+	data: ExistingResourceObject<T>[];
 };
 /**
- * A (RAW) JSON:API Formatted Document.
- *
- * These documents should follow the JSON:API spec but do not
- * have the same level of guarantees as their `spec` counterparts.
- *
- * @internal
- */
+* A (RAW) JSON:API Formatted Document.
+*
+* These documents should follow the JSON:API spec but do not
+* have the same level of guarantees as their `spec` counterparts.
+*
+* @internal
+*/
 export type JsonApiDocument<T extends string = string> = EmptyResourceDocument | SingleResourceDocument<T> | CollectionResourceDocument<T>;
 export {};
-//# sourceMappingURL=json-api-raw.d.ts.map

package/declarations/types/symbols.d.ts

@@ -1,79 +1,78 @@
-export declare const RecordStore: '___(unique) Symbol(Store)';
+export declare const RecordStore: "___(unique) Symbol(Store)";
 /**
- * Symbol for the name of a resource, transformation
- * or derivation.
- *
- * ### With Resources
- *
- * 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, EmberData and WarpDrive APIs can
- * take advantage of this to provide better type
- * safety and intellisense.
- *
- * ### With Derivations
- *
- * Required for derivations registered with
- * `store.registerDerivation(derivation)`.
- *
- * ```ts
- * function concat(record: object, options: ObjectValue | null, prop: string): string {}
- * concat[Name] = 'concat';
- * ```
- *
- * ### With Transforms
- *
- * Required for new-style transformations registered
- * with `store.registerTransform(transform)`.
- *
- * For legacy transforms, if not used,
- * `attr<Transform>('name')` will allow any string name.
- * `attr('name')` will always allow any string name.
- *
- * If used, `attr<Transform>('name')` will enforce
- * that the name is the same as the transform name.
- *
- * @type {Symbol}
- */
-export declare const Type: '___(unique) Symbol($type)';
+* Symbol for the name of a resource, transformation
+* or derivation.
+*
+* ### With Resources
+*
+* 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, EmberData/WarpDrive APIs can
+* take advantage of this to provide better type
+* safety and intellisense.
+*
+* ### With Derivations
+*
+* Required for derivations registered with
+* `store.registerDerivation(derivation)`.
+*
+* ```ts
+* function concat(record: object, options: ObjectValue | null, prop: string): string {}
+* concat[Name] = 'concat';
+* ```
+*
+* ### With Transforms
+*
+* Required for new-style transformations registered
+* with `store.registerTransform(transform)`.
+*
+* For legacy transforms, if not used,
+* `attr<Transform>('name')` will allow any string name.
+* `attr('name')` will always allow any string name.
+*
+* If used, `attr<Transform>('name')` will enforce
+* that the name is the same as the transform name.
+*
+* @type {Symbol}
+*/
+export declare const Type: "___(unique) Symbol($type)";
 /**
- * Symbol for the type of a 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, EmberData and WarpDrive APIs can
- * take advantage of this to provide better type
- * safety and intellisense.
- *
- * @type {Symbol}
- */
-export declare const ResourceType: '___(unique) Symbol($type)';
+* Symbol for the type of a 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, EmberData/WarpDrive APIs can
+* take advantage of this to provide better type
+* safety and intellisense.
+*
+* @type {Symbol}
+*/
+export declare const ResourceType: "___(unique) Symbol($type)";
 /**
- * Symbol for the name of a transform.
- *
- * This is an optional feature that can be used by
- * transform implementations to provide a typescript
- * hint for the name of the transform.
- *
- * If not used, `attr<Transform>('name')` will
- * allow any string name. `attr('name')` will always
- * allow any string name.
- *
- * If used, `attr<Transform>('name')` will enforce
- * that the name is the same as the transform name.
- *
- * @type {Symbol}
- */
-export declare const TransformName: '___(unique) Symbol($type)';
+* Symbol for the name of a transform.
+*
+* This is an optional feature that can be used by
+* transform implementations to provide a typescript
+* hint for the name of the transform.
+*
+* If not used, `attr<Transform>('name')` will
+* allow any string name. `attr('name')` will always
+* allow any string name.
+*
+* If used, `attr<Transform>('name')` will enforce
+* that the name is the same as the transform name.
+*
+* @type {Symbol}
+*/
+export declare const TransformName: "___(unique) Symbol($type)";
 /**
- * Symbol for use by builders to indicate the return type
- * generic to use for store.request()
- *
- * @type {Symbol}
- */
-export declare const RequestSignature: '___(unique) Symbol(RequestSignature)';
-//# sourceMappingURL=symbols.d.ts.map
+* Symbol for use by builders to indicate the return type
+* generic to use for store.request()
+*
+* @type {Symbol}
+*/
+export declare const RequestSignature: "___(unique) Symbol(RequestSignature)";

package/declarations/types/utils.d.ts

@@ -1,5 +1,5 @@
-export type WithPartial<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-export type Mutable<T> = {
-    -readonly [P in keyof T]: T[P];
-};
-//# sourceMappingURL=utils.d.ts.map
+export type WithPartial<
+	T,
+	K extends keyof T
+> = Omit<T, K> & Partial<Pick<T, K>>;
+export type Mutable<T> = { -readonly [P in keyof T] : T[P] };

package/declarations/types.d.ts

@@ -1,8 +1,11 @@
 /**
- * This package provides core types, type-utilities, symbols
- * and constants used across the WarpDrive ecosystem.
- *
- * @module
- */
-export type { StableRecordIdentifier, ResourceKey } from './types/identifier.ts';
-//# sourceMappingURL=types.d.ts.map
+* This package provides core types, type-utilities, symbols
+* and constants used across the WarpDrive ecosystem.
+*
+* @module
+*/
+export type { StableRecordIdentifier, ResourceKey } from "./types/identifier.js";
+export type { CacheCapabilitiesManager } from "./store/-types/q/cache-capabilities-manager.js";
+export type { ModelSchema } from "./store/-types/q/ds-model.js";
+export type { SchemaService } from "./store/-types/q/schema-service.js";
+export type { BaseFinderOptions, FindRecordOptions, LegacyResourceQuery, QueryOptions, FindAllOptions } from "./store/-types/q/store.js";

package/declarations/utils/string.d.ts

@@ -0,0 +1,48 @@
+/**
+* An LRUCache implementation with upsert semantics.
+*
+* This implementation is *not* generic, but focuses on
+* performance tuning for the string transformation cases
+* where the key maps to the value very simply.
+*
+* It takes a work function that should generate a new value
+* for a given key when called. It will be called when the key
+* is not found in the cache.
+*
+* It keeps track of the number of hits, misses, and ejections
+* in DEBUG envs, which is useful for tuning the cache size.
+*
+* This is an internal utility class for use by this module
+* and by `@warp-drive/utilities/string`. It is not intended
+* for use outside of these modules at this time.
+*
+* @internal
+*/
+export declare class LRUCache<
+	T,
+	V
+> {
+	size: number;
+	state: Map<T, V>;
+	doWork: (k: T) => V;
+	// debug stats
+	_hits: number;
+	_misses: number;
+	_ejected: number;
+	constructor(doWork: (k: T) => V, size?: number);
+	get(key: T): V;
+	set(key: T, value: V): void;
+	clear(): void;
+}
+export declare const STRING_DASHERIZE_CACHE: LRUCache<string, string>;
+/**
+* This is an internal utility function that converts a string
+* to a dasherized format. Library consumers should use the
+* re-exported version from `@warp-drive/utilities/string` instead.
+*
+* This version is only in this location to support a deprecated
+* behavior in the core package and will be removed in a future.
+*
+* @internal
+*/
+export declare function dasherize(str: string): string;

package/dist/build-config/babel-macros.js

@@ -0,0 +1 @@
+export { macros } from '@warp-drive/build-config/babel-macros';

package/dist/build-config/canary-features.js

@@ -0,0 +1 @@
+export * from '@warp-drive/build-config/canary-features';

package/dist/build-config/debugging.js

@@ -0,0 +1 @@
+export * from '@warp-drive/build-config/debugging';

package/dist/build-config/deprecations.js

@@ -0,0 +1 @@
+export * from '@warp-drive/build-config/deprecations';

package/dist/build-config/env.js

@@ -0,0 +1 @@
+export { DEBUG, IS_CI, IS_RECORDING, PRODUCTION, SHOULD_RECORD, TESTING } from '@warp-drive/build-config/env';

package/dist/build-config/macros.js

@@ -0,0 +1 @@
+export { assert } from '@warp-drive/build-config/macros';

package/dist/build-config.js

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