@mearie/core 0.5.1 → 0.6.0

package/dist/index.d.cts

@@ -195,6 +195,29 @@ declare module '@mearie/core' {
 declare const dedupExchange: () => Exchange;
 //#endregion
 //#region src/cache/types.d.ts
+/**
+ * Path into a denormalized query result tree.
+ */
+type PropertyPath = (string | number)[];
+/**
+ * Describes a targeted mutation to a denormalized query result.
+ */
+type Patch = {
+  type: 'set';
+  path: PropertyPath;
+  value: unknown;
+} | {
+  type: 'splice';
+  path: PropertyPath;
+  index: number;
+  deleteCount: number;
+  items: unknown[];
+} | {
+  type: 'swap';
+  path: PropertyPath;
+  i: number;
+  j: number;
+};
 type EntityTypes<TMeta extends SchemaMeta$1> = NonNullable<TMeta[' $entityTypes']>;
 type QueryFields<TMeta extends SchemaMeta$1> = NonNullable<TMeta[' $queryFields']>;
 type KeyFieldsOf<E> = E extends {
@@ -255,7 +278,8 @@ declare module '@mearie/core' {
   }
   interface OperationResultMetadataMap {
     cache?: {
-      stale: boolean;
+      stale?: boolean;
+      patches?: Patch[];
     };
   }
 }
@@ -264,6 +288,33 @@ type CacheOptions = {
 };
 declare const cacheExchange: (options?: CacheOptions) => Exchange<"cache">;
 //#endregion
+//#region src/cache/patch.d.ts
+/**
+ * Sets a value at a nested path within an object.
+ * @param obj - The object to modify.
+ * @param path - The path to the target location.
+ * @param value - The value to set.
+ */
+declare const setPath: (obj: unknown, path: PropertyPath, value: unknown) => void;
+/**
+ * Gets a value at a nested path within an object.
+ * @param obj - The object to read from.
+ * @param path - The path to the target location.
+ * @returns The value at the path, or the object itself if path is empty.
+ */
+declare const getPath: (obj: unknown, path: PropertyPath) => unknown;
+/**
+ * Applies cache patches to data immutably, shallow-copying only along changed paths.
+ */
+declare const applyPatchesImmutable: <T>(data: T, patches: Patch[]) => T;
+/**
+ * Applies cache patches to a mutable target object in place.
+ * @param target - The mutable object to apply patches to.
+ * @param patches - The patches to apply.
+ * @returns The new root value if a root-level set patch was applied, otherwise undefined.
+ */
+declare const applyPatchesMutable: (target: unknown, patches: Patch[]) => unknown;
+//#endregion
 //#region src/exchanges/retry.d.ts
 declare module '@mearie/core' {
   interface OperationMetadataMap {
@@ -362,4 +413,4 @@ declare class RequiredFieldError extends Error {
  */
 declare const stringify: (value: unknown) => string;
 //#endregion
-export { AggregatedError, type Artifact, type ArtifactKind, type CacheOperations, type CacheOptions, type CacheSnapshot, Client, type ClientOptions, type DataOf, type Exchange, ExchangeError, type ExchangeErrorExtensionsMap, type ExchangeExtensionMap, type ExchangeIO, type ExchangeResult, type FragmentOptions, type FragmentRefs, GraphQLError, type HttpOptions, type InvalidateTarget, type MutationOptions, type Operation, type OperationError, type OperationMetadata, type OperationMetadataMap, type OperationResult, type OperationResultMetadataMap, type QueryOptions, type RequiredAction, RequiredFieldError, type RetryOptions, type SchemaMeta, type SubscriptionClient, type SubscriptionExchangeOptions, type SubscriptionOptions, type VariablesOf, cacheExchange, createClient, dedupExchange, fragmentExchange, httpExchange, isAggregatedError, isExchangeError, isGraphQLError, requiredExchange, retryExchange, stringify, subscriptionExchange };
+export { AggregatedError, type Artifact, type ArtifactKind, type CacheOperations, type CacheOptions, type CacheSnapshot, Client, type ClientOptions, type DataOf, type Exchange, ExchangeError, type ExchangeErrorExtensionsMap, type ExchangeExtensionMap, type ExchangeIO, type ExchangeResult, type FragmentOptions, type FragmentRefs, GraphQLError, type HttpOptions, type InvalidateTarget, type MutationOptions, type Operation, type OperationError, type OperationMetadata, type OperationMetadataMap, type OperationResult, type OperationResultMetadataMap, type Patch, type PropertyPath, type QueryOptions, type RequiredAction, RequiredFieldError, type RetryOptions, type SchemaMeta, type SubscriptionClient, type SubscriptionExchangeOptions, type SubscriptionOptions, type VariablesOf, applyPatchesImmutable, applyPatchesMutable, cacheExchange, createClient, dedupExchange, fragmentExchange, getPath, httpExchange, isAggregatedError, isExchangeError, isGraphQLError, requiredExchange, retryExchange, setPath, stringify, subscriptionExchange };

package/dist/index.d.mts

@@ -195,6 +195,29 @@ declare module '@mearie/core' {
 declare const dedupExchange: () => Exchange;
 //#endregion
 //#region src/cache/types.d.ts
+/**
+ * Path into a denormalized query result tree.
+ */
+type PropertyPath = (string | number)[];
+/**
+ * Describes a targeted mutation to a denormalized query result.
+ */
+type Patch = {
+  type: 'set';
+  path: PropertyPath;
+  value: unknown;
+} | {
+  type: 'splice';
+  path: PropertyPath;
+  index: number;
+  deleteCount: number;
+  items: unknown[];
+} | {
+  type: 'swap';
+  path: PropertyPath;
+  i: number;
+  j: number;
+};
 type EntityTypes<TMeta extends SchemaMeta$1> = NonNullable<TMeta[' $entityTypes']>;
 type QueryFields<TMeta extends SchemaMeta$1> = NonNullable<TMeta[' $queryFields']>;
 type KeyFieldsOf<E> = E extends {
@@ -255,7 +278,8 @@ declare module '@mearie/core' {
   }
   interface OperationResultMetadataMap {
     cache?: {
-      stale: boolean;
+      stale?: boolean;
+      patches?: Patch[];
     };
   }
 }
@@ -264,6 +288,33 @@ type CacheOptions = {
 };
 declare const cacheExchange: (options?: CacheOptions) => Exchange<"cache">;
 //#endregion
+//#region src/cache/patch.d.ts
+/**
+ * Sets a value at a nested path within an object.
+ * @param obj - The object to modify.
+ * @param path - The path to the target location.
+ * @param value - The value to set.
+ */
+declare const setPath: (obj: unknown, path: PropertyPath, value: unknown) => void;
+/**
+ * Gets a value at a nested path within an object.
+ * @param obj - The object to read from.
+ * @param path - The path to the target location.
+ * @returns The value at the path, or the object itself if path is empty.
+ */
+declare const getPath: (obj: unknown, path: PropertyPath) => unknown;
+/**
+ * Applies cache patches to data immutably, shallow-copying only along changed paths.
+ */
+declare const applyPatchesImmutable: <T>(data: T, patches: Patch[]) => T;
+/**
+ * Applies cache patches to a mutable target object in place.
+ * @param target - The mutable object to apply patches to.
+ * @param patches - The patches to apply.
+ * @returns The new root value if a root-level set patch was applied, otherwise undefined.
+ */
+declare const applyPatchesMutable: (target: unknown, patches: Patch[]) => unknown;
+//#endregion
 //#region src/exchanges/retry.d.ts
 declare module '@mearie/core' {
   interface OperationMetadataMap {
@@ -362,4 +413,4 @@ declare class RequiredFieldError extends Error {
  */
 declare const stringify: (value: unknown) => string;
 //#endregion
-export { AggregatedError, type Artifact, type ArtifactKind, type CacheOperations, type CacheOptions, type CacheSnapshot, Client, type ClientOptions, type DataOf, type Exchange, ExchangeError, type ExchangeErrorExtensionsMap, type ExchangeExtensionMap, type ExchangeIO, type ExchangeResult, type FragmentOptions, type FragmentRefs, GraphQLError, type HttpOptions, type InvalidateTarget, type MutationOptions, type Operation, type OperationError, type OperationMetadata, type OperationMetadataMap, type OperationResult, type OperationResultMetadataMap, type QueryOptions, type RequiredAction, RequiredFieldError, type RetryOptions, type SchemaMeta, type SubscriptionClient, type SubscriptionExchangeOptions, type SubscriptionOptions, type VariablesOf, cacheExchange, createClient, dedupExchange, fragmentExchange, httpExchange, isAggregatedError, isExchangeError, isGraphQLError, requiredExchange, retryExchange, stringify, subscriptionExchange };
+export { AggregatedError, type Artifact, type ArtifactKind, type CacheOperations, type CacheOptions, type CacheSnapshot, Client, type ClientOptions, type DataOf, type Exchange, ExchangeError, type ExchangeErrorExtensionsMap, type ExchangeExtensionMap, type ExchangeIO, type ExchangeResult, type FragmentOptions, type FragmentRefs, GraphQLError, type HttpOptions, type InvalidateTarget, type MutationOptions, type Operation, type OperationError, type OperationMetadata, type OperationMetadataMap, type OperationResult, type OperationResultMetadataMap, type Patch, type PropertyPath, type QueryOptions, type RequiredAction, RequiredFieldError, type RetryOptions, type SchemaMeta, type SubscriptionClient, type SubscriptionExchangeOptions, type SubscriptionOptions, type VariablesOf, applyPatchesImmutable, applyPatchesMutable, cacheExchange, createClient, dedupExchange, fragmentExchange, getPath, httpExchange, isAggregatedError, isExchangeError, isGraphQLError, requiredExchange, retryExchange, setPath, stringify, subscriptionExchange };