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

package/declarations/types/cache/aliases.d.ts

@@ -1,2 +1,12 @@
+// The ResourceBlob is an opaque type that must
+// satisfy two constraints.
+// (1) it should be possible for the IdentifierCache
+// to be able to generate a RecordIdentifier for it
+// whether by default or due to configuration.
+// (2) it should be in a format expected by the Cache.
+// This format is Cache declared.
+//
+// this Opaqueness allows arbitrary storage of any
+// serializable / transferable state including such things
+// as Buffers and Strings.
 export type ResourceBlob = unknown;
-//# sourceMappingURL=aliases.d.ts.map

package/declarations/types/cache/change.d.ts

@@ -1,7 +1,6 @@
-import type { StableDocumentIdentifier, StableRecordIdentifier } from '../identifier.ts';
+import type { StableDocumentIdentifier, StableRecordIdentifier } from "../identifier.js";
 export interface Change {
-    identifier: StableRecordIdentifier | StableDocumentIdentifier;
-    op: 'upsert' | 'remove';
-    patch?: unknown;
+	identifier: StableRecordIdentifier | StableDocumentIdentifier;
+	op: "upsert" | "remove";
+	patch?: unknown;
 }
-//# sourceMappingURL=change.d.ts.map

package/declarations/types/cache/mutations.d.ts

@@ -1,39 +1,62 @@
-import type { StableRecordIdentifier } from '../identifier.ts';
+import type { StableRecordIdentifier } from "../identifier.js";
 export interface AddToResourceRelationshipMutation {
-    op: 'add';
-    record: StableRecordIdentifier;
-    field: string;
-    value: StableRecordIdentifier | StableRecordIdentifier[];
-    index?: number;
+	op: "add";
+	record: StableRecordIdentifier;
+	field: string;
+	value: StableRecordIdentifier | StableRecordIdentifier[];
+	index?: number;
 }
 export interface RemoveFromResourceRelationshipMutation {
-    op: 'remove';
-    record: StableRecordIdentifier;
-    field: string;
-    value: StableRecordIdentifier | StableRecordIdentifier[];
-    index?: number;
+	op: "remove";
+	record: StableRecordIdentifier;
+	field: string;
+	value: StableRecordIdentifier | StableRecordIdentifier[];
+	index?: number;
 }
 export interface ReplaceRelatedRecordMutation {
-    op: 'replaceRelatedRecord';
-    record: StableRecordIdentifier;
-    field: string;
-    value: StableRecordIdentifier | null;
-    prior?: StableRecordIdentifier;
-    index?: number;
+	op: "replaceRelatedRecord";
+	record: StableRecordIdentifier;
+	field: string;
+	// never null if field is a collection
+	value: StableRecordIdentifier | null;
+	// if field is a collection,
+	//  the value we are swapping with
+	prior?: StableRecordIdentifier;
+	index?: number;
 }
 export interface ReplaceRelatedRecordsMutation {
-    op: 'replaceRelatedRecords';
-    record: StableRecordIdentifier;
-    field: string;
-    value: StableRecordIdentifier[];
-    prior?: StableRecordIdentifier[];
-    index?: number;
+	op: "replaceRelatedRecords";
+	record: StableRecordIdentifier;
+	field: string;
+	// the records to add. If no prior/index
+	//  specified all existing should be removed
+	value: StableRecordIdentifier[];
+	// if this is a "splice" the
+	//  records we expect to be removed
+	prior?: StableRecordIdentifier[];
+	// if this is a "splice" the
+	//   index to start from
+	index?: number;
 }
 export interface SortRelatedRecordsMutation {
-    op: 'sortRelatedRecords';
-    record: StableRecordIdentifier;
-    field: string;
-    value: StableRecordIdentifier[];
+	op: "sortRelatedRecords";
+	record: StableRecordIdentifier;
+	field: string;
+	value: StableRecordIdentifier[];
 }
+// A Mutation is an action that updates
+// the local state of the Cache in some
+// manner.
+// Most Mutations are in theory also
+// Operations; with the difference being
+// that the change should be applied as
+// "local" or "dirty" state instead of
+// as "remote" or "clean" state.
+//
+// Note: this RFC does not publicly surface
+// any of the mutations listed here as
+// "operations", though the (private) Graph
+// already expects and utilizes these.
+// and we look forward to an RFC that makes
+// the Graph a fully public API.
 export type Mutation = ReplaceRelatedRecordsMutation | ReplaceRelatedRecordMutation | RemoveFromResourceRelationshipMutation | AddToResourceRelationshipMutation | SortRelatedRecordsMutation;
-//# sourceMappingURL=mutations.d.ts.map

package/declarations/types/cache/operations.d.ts

@@ -1,72 +1,85 @@
-import type { StableDocumentIdentifier, StableExistingRecordIdentifier, StableRecordIdentifier } from '../identifier.ts';
-import type { Value } from '../json/raw.ts';
-import type { ExistingResourceObject } from '../spec/json-api-raw.ts';
-import type { Relationship } from './relationship.ts';
+import type { StableDocumentIdentifier, StableExistingRecordIdentifier, StableRecordIdentifier } from "../identifier.js";
+import type { Value } from "../json/raw.js";
+import type { ExistingResourceObject } from "../spec/json-api-raw.js";
+import type { Relationship } from "./relationship.js";
 export interface Op {
-    op: string;
+	op: string;
 }
+// Occasionally the IdentifierCache
+// discovers that two previously thought
+// to be distinct Identifiers refer to
+// the same ResourceBlob. This Operation
+// will be performed giving the Cache the
+// change to cleanup and merge internal
+// state as desired when this discovery
+// is made.
 export interface MergeOperation extends Op {
-    op: 'mergeIdentifiers';
-    record: StableRecordIdentifier;
-    value: StableRecordIdentifier;
+	op: "mergeIdentifiers";
+	// existing
+	record: StableRecordIdentifier;
+	// new
+	value: StableRecordIdentifier;
 }
 export interface RemoveDocumentOperation extends Op {
-    op: 'remove';
-    record: StableDocumentIdentifier;
+	op: "remove";
+	record: StableDocumentIdentifier;
 }
 export interface RemoveResourceOperation extends Op {
-    op: 'remove';
-    record: StableExistingRecordIdentifier;
+	op: "remove";
+	record: StableExistingRecordIdentifier;
 }
 export interface AddResourceOperation extends Op {
-    op: 'add';
-    record: StableExistingRecordIdentifier;
-    value: ExistingResourceObject;
+	op: "add";
+	record: StableExistingRecordIdentifier;
+	value: ExistingResourceObject;
 }
 export interface UpdateResourceOperation extends Op {
-    op: 'update';
-    record: StableExistingRecordIdentifier;
-    value: ExistingResourceObject;
+	op: "update";
+	record: StableExistingRecordIdentifier;
+	value: ExistingResourceObject;
 }
 export interface UpdateResourceFieldOperation extends Op {
-    op: 'update';
-    record: StableExistingRecordIdentifier;
-    field: string;
-    value: Value;
+	op: "update";
+	record: StableExistingRecordIdentifier;
+	field: string;
+	value: Value;
 }
 export interface UpdateResourceRelationshipOperation extends Op {
-    op: 'update';
-    record: StableExistingRecordIdentifier;
-    field: string;
-    value: Relationship<StableExistingRecordIdentifier>;
+	op: "update";
+	record: StableExistingRecordIdentifier;
+	field: string;
+	value: Relationship<StableExistingRecordIdentifier>;
 }
 export interface AddToDocumentOperation extends Op {
-    op: 'add';
-    record: StableDocumentIdentifier;
-    field: 'data' | 'included';
-    value: StableExistingRecordIdentifier | StableExistingRecordIdentifier[];
-    index?: number;
+	op: "add";
+	record: StableDocumentIdentifier;
+	field: "data" | "included";
+	value: StableExistingRecordIdentifier | StableExistingRecordIdentifier[];
+	index?: number;
 }
 export interface AddToResourceRelationshipOperation extends Op {
-    op: 'add';
-    record: StableExistingRecordIdentifier;
-    field: string;
-    value: StableExistingRecordIdentifier | StableExistingRecordIdentifier[];
-    index?: number;
+	op: "add";
+	record: StableExistingRecordIdentifier;
+	field: string;
+	value: StableExistingRecordIdentifier | StableExistingRecordIdentifier[];
+	index?: number;
 }
 export interface RemoveFromResourceRelationshipOperation extends Op {
-    op: 'remove';
-    record: StableExistingRecordIdentifier;
-    field: string;
-    value: StableExistingRecordIdentifier | StableExistingRecordIdentifier[];
-    index?: number;
+	op: "remove";
+	record: StableExistingRecordIdentifier;
+	field: string;
+	value: StableExistingRecordIdentifier | StableExistingRecordIdentifier[];
+	index?: number;
 }
 export interface RemoveFromDocumentOperation extends Op {
-    op: 'remove';
-    record: StableDocumentIdentifier;
-    field: 'data' | 'included';
-    value: StableExistingRecordIdentifier | StableExistingRecordIdentifier[];
-    index?: number;
+	op: "remove";
+	record: StableDocumentIdentifier;
+	field: "data" | "included";
+	value: StableExistingRecordIdentifier | StableExistingRecordIdentifier[];
+	index?: number;
 }
+// An Operation is an action that updates
+// the remote state of the Cache in some
+// manner. Additional Operations will be
+// added in the future.
 export type Operation = MergeOperation | RemoveResourceOperation | RemoveDocumentOperation | AddResourceOperation | UpdateResourceOperation | UpdateResourceFieldOperation | AddToResourceRelationshipOperation | RemoveFromResourceRelationshipOperation | AddToDocumentOperation | RemoveFromDocumentOperation;
-//# sourceMappingURL=operations.d.ts.map

package/declarations/types/cache/relationship.d.ts

@@ -1,14 +1,16 @@
-import type { StableRecordIdentifier } from '../identifier.ts';
-import type { Links, Meta, PaginationLinks } from '../spec/json-api-raw.ts';
+import type { StableRecordIdentifier } from "../identifier.js";
+import type { Links, Meta, PaginationLinks } from "../spec/json-api-raw.js";
+// we request that it be in the stable form already.
 export interface ResourceRelationship<T = StableRecordIdentifier> {
-    data?: T | null;
-    meta?: Meta;
-    links?: Links;
+	data?: T | null;
+	meta?: Meta;
+	links?: Links;
 }
+// Note: in v1 data could be a ResourceIdentifier, now
+// we request that it be in the stable form already.
 export interface CollectionRelationship<T = StableRecordIdentifier> {
-    data?: T[];
-    meta?: Meta;
-    links?: PaginationLinks;
+	data?: T[];
+	meta?: Meta;
+	links?: PaginationLinks;
 }
 export type Relationship<T = StableRecordIdentifier> = ResourceRelationship<T> | CollectionRelationship<T>;
-//# sourceMappingURL=relationship.d.ts.map