@types/relay-runtime - npm Package Compare versions

Comparing version 17.0.2 to 17.0.3

relay-runtime/index.d.ts

@@ -87,4 +87,4 @@ import ConnectionInterface from "./lib/handlers/connection/ConnectionInterface";
     RelayContext,
+    RelayFieldLogger,
     RequestDescriptor,
-    RequiredFieldLogger,
     SelectorData,
@@ -91,0 +91,0 @@ SelectorStoreUpdater,

relay-runtime/lib/multi-actor-environment/MultiActorEnvironment.d.ts

@@ -16,3 +16,3 @@ import { HandlerProvider } from "../handlers/RelayDefaultHandlerProvider";
     OptimisticUpdateFunction,
-    RequiredFieldLogger,
+    RelayFieldLogger,
     SelectorStoreUpdater,
@@ -43,3 +43,3 @@ SingularReaderSelector,
     operationLoader?: OperationLoader | null;
-    requiredFieldLogger?: RequiredFieldLogger | null;
+    relayFieldLogger?: RelayFieldLogger | null;
     scheduler?: TaskScheduler | null;
@@ -46,0 +46,0 @@ shouldProcessClientComponents?: boolean | null;

relay-runtime/lib/store/RelayModernEnvironment.d.ts

@@ -18,3 +18,3 @@ import { HandlerProvider } from "../handlers/RelayDefaultHandlerProvider";
     OptimisticUpdateFunction,
-    RequiredFieldLogger,
+    RelayFieldLogger,
     SelectorStoreUpdater,
@@ -42,3 +42,3 @@ SingularReaderSelector,
     readonly isServer?: boolean | undefined;
-    readonly requiredFieldLogger?: RequiredFieldLogger | null | undefined;
+    readonly relayFieldLogger?: RelayFieldLogger | null | undefined;
     readonly shouldProcessClientComponents?: boolean | null | undefined;
@@ -50,3 +50,3 @@ }
     configName: string | null | undefined;
-    requiredFieldLogger: RequiredFieldLogger;
+    relayFieldLogger: RelayFieldLogger;
     constructor(config: EnvironmentConfig);
@@ -53,0 +53,0 @@ getStore(): Store;

relay-runtime/lib/store/RelayStoreTypes.d.ts

@@ -703,3 +703,3 @@ import { MutationParameters } from "../mutations/commitMutation";
      * provided Query or Subscription operation responses, the result of which is
-     * then normalized and comitted to the publish queue.
+     * then normalized and committed to the publish queue.
      *
@@ -736,5 +736,5 @@ * Note: Observables are lazy, so calling this method will do nothing until
      * Called by Relay when it encounters a missing field that has been annotated
-     * with `@required(action: LOG)`.
+     * with `@required(action: LOG)` or `@required(action: THROW)`.
      */
-    requiredFieldLogger: RequiredFieldLogger;
+    relayFieldLogger: RelayFieldLogger;
 }
@@ -937,25 +937,31 @@
 
+export type RelayFieldLoggerEvent =
+    | Readonly<{
+        kind: "missing_field.log";
+        owner: string;
+        fieldPath: string;
+    }>
+    | Readonly<{
+        kind: "missing_field.throw";
+        owner: string;
+        fieldPath: string;
+    }>
+    | Readonly<{
+        kind: "relay_resolver.error";
+        owner: string;
+        fieldPath: string;
+        error: Error;
+    }>
+    | Readonly<{
+        kind: "relay_field_payload.error";
+        owner: string;
+        fieldPath: string;
+        error: Error;
+    }>;
+
 /**
- * A handler for events related to @required fields or Relay Resolvers. Currently reports missing
- * fields with either `action: LOG` or `action: THROW` or when a Relay Resolver throws.
+ * A handler for events related to `@required` fields. Currently reports missing
+ * fields with either `action: LOG` or `action: THROW`.
  */
-export type RequiredFieldLogger = (
-    arg:
-        | Readonly<{
-            kind: "missing_field.log";
-            owner: string;
-            fieldPath: string;
-        }>
-        | Readonly<{
-            kind: "missing_field.throw";
-            owner: string;
-            fieldPath: string;
-        }>
-        | Readonly<{
-            kind: "relay_resolver.error";
-            owner: string;
-            fieldPath: string;
-            error: Error;
-        }>,
-) => void;
+export type RelayFieldLogger = (event: RelayFieldLoggerEvent) => void;
 
@@ -962,0 +968,0 @@ /**

relay-runtime/package.json

 {
     "name": "@types/relay-runtime",
-    "version": "17.0.2",
+    "version": "17.0.3",
     "description": "TypeScript definitions for relay-runtime",
@@ -38,4 +38,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/relay-runtime",
     "dependencies": {},
-    "typesPublisherContentHash": "4bb32fdd8a871603fc80fc1eb30c5fdbc09c4451a9643cee67a65d7eec8bd147",
+    "typesPublisherContentHash": "e73b7397fb03baf6b0791bb08d8b11ec2d875663a09495b719a132378afa9685",
     "typeScriptVersion": "4.8"
 }

relay-runtime/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Tue, 23 Jul 2024 16:08:48 GMT
+ * Last updated: Mon, 29 Jul 2024 00:27:54 GMT
  * Dependencies: none
@@ -14,0 +14,0 @@

No alert changes

Improved metrics

Total package byte prevSize

141922

increased by0.05%

Lines of code

3505

increased by0.14%

No dependency changes