Lets go

Author: ardatan

.changeset/social-camels-mate.md

@@ -7,7 +7,7 @@ Support polling in an interval by milliseconds
 
 ```yaml
 plugins:
-  - live-query:
+  - liveQuery:
       invalidations:
         - pollingInterval: 10000 # Polling interval in milliseconds
           invalidate:

packages/legacy/types/src/config-schema.json

@@ -2461,18 +2461,10 @@
         "invalidations": {
           "type": "array",
           "items": {
-            "description": "Any of: LiveQueryInvalidationByMutation, LiveQueryInvalidationByPolling",
-            "anyOf": [
-              {
-                "$ref": "#/definitions/LiveQueryInvalidationByMutation"
-              },
-              {
-                "$ref": "#/definitions/LiveQueryInvalidationByPolling"
-              }
-            ]
+            "$ref": "#/definitions/LiveQueryInvalidation"
           },
           "additionalItems": false,
-          "description": "Invalidate a query or queries when a specific operation is done without an error (Any of: LiveQueryInvalidationByMutation, LiveQueryInvalidationByPolling)"
+          "description": "Invalidate a query or queries when a specific operation is done without an error"
         },
         "resourceIdentifier": {
           "type": "string",
@@ -2496,30 +2488,15 @@
         }
       }
     },
-    "LiveQueryInvalidationByMutation": {
+    "LiveQueryInvalidation": {
       "additionalProperties": false,
       "type": "object",
-      "title": "LiveQueryInvalidationByMutation",
+      "title": "LiveQueryInvalidation",
       "properties": {
         "field": {
           "type": "string",
           "description": "Path to the operation that could effect it. In a form: Mutation.something. Note that wildcard is not supported in this field."
         },
-        "invalidate": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "additionalItems": false
-        }
-      },
-      "required": ["field", "invalidate"]
-    },
-    "LiveQueryInvalidationByPolling": {
-      "additionalProperties": false,
-      "type": "object",
-      "title": "LiveQueryInvalidationByPolling",
-      "properties": {
         "pollingInterval": {
           "type": "integer",
           "description": "Polling interval in milliseconds"
@@ -2529,11 +2506,10 @@
           "items": {
             "type": "string"
           },
-          "additionalItems": false,
-          "description": "Schema coordinate of the query to be polled"
+          "additionalItems": false
         }
       },
-      "required": ["pollingInterval", "invalidate"]
+      "required": ["invalidate"]
     },
     "LiveQueryIndexBy": {
       "additionalProperties": false,

packages/legacy/types/src/config.ts

@@ -2153,9 +2153,9 @@ export interface HTTPDetailsExtensionsConfig {
 }
 export interface LiveQueryConfig {
   /**
-   * Invalidate a query or queries when a specific operation is done without an error (Any of: LiveQueryInvalidationByMutation, LiveQueryInvalidationByPolling)
+   * Invalidate a query or queries when a specific operation is done without an error
    */
-  invalidations?: (LiveQueryInvalidationByMutation | LiveQueryInvalidationByPolling)[];
+  invalidations?: LiveQueryInvalidation[];
   /**
    * Custom strategy for building resources identifiers
    * By default resource identifiers are built by concatenating the Typename with the id separated by a color (`User:1`).
@@ -2184,21 +2184,15 @@ export interface LiveQueryConfig {
    */
   indexBy?: LiveQueryIndexBy[];
 }
-export interface LiveQueryInvalidationByMutation {
+export interface LiveQueryInvalidation {
   /**
    * Path to the operation that could effect it. In a form: Mutation.something. Note that wildcard is not supported in this field.
    */
-  field: string;
-  invalidate: string[];
-}
-export interface LiveQueryInvalidationByPolling {
+  field?: string;
   /**
    * Polling interval in milliseconds
    */
-  pollingInterval: number;
-  /**
-   * Schema coordinate of the query to be polled
-   */
+  pollingInterval?: number;
   invalidate: string[];
 }
 export interface LiveQueryIndexBy {

packages/plugins/live-query/src/useInvalidateByResult.ts

@@ -11,15 +11,9 @@ import {
 } from '@graphql-mesh/types';
 import { DisposableSymbols } from '@whatwg-node/disposablestack';
 
-// Hybrid type that supports both polling and mutation-based invalidation
-type LiveQueryInvalidationHybrid = (
-  | YamlConfig.LiveQueryInvalidationByMutation
-  | YamlConfig.LiveQueryInvalidationByPolling
-) & Partial<YamlConfig.LiveQueryInvalidationByMutation> & Partial<YamlConfig.LiveQueryInvalidationByPolling>;
-
 interface InvalidateByResultParams {
   pubsub: MeshPubSub | HivePubSub;
-  invalidations: LiveQueryInvalidationHybrid[];
+  invalidations: YamlConfig.LiveQueryInvalidation[];
   logger: Logger;
 }
 
@@ -34,7 +28,7 @@ export function useInvalidateByResult(params: InvalidateByResultParams): Plugin
     );
 
     // Set up polling-based invalidation if pollingInterval is provided
-    if ('pollingInterval' in liveQueryInvalidation && liveQueryInvalidation.pollingInterval) {
+    if (liveQueryInvalidation.pollingInterval != null) {
       timers.add(
         setInterval(() => {
           pubsub.publish('live-query:invalidate', liveQueryInvalidation.invalidate);
@@ -43,7 +37,7 @@ export function useInvalidateByResult(params: InvalidateByResultParams): Plugin
     }
 
     // Set up mutation-based invalidation if field is provided
-    if ('field' in liveQueryInvalidation && liveQueryInvalidation.field) {
+    if (liveQueryInvalidation.field != null) {
       liveQueryInvalidationFactoryMap.set(liveQueryInvalidation.field, factories);
     }
   });

packages/plugins/live-query/yaml-config.graphql

@@ -38,24 +38,15 @@ type LiveQueryConfig {
   indexBy: [LiveQueryIndexBy]
 }
 
-union LiveQueryInvalidation @md = LiveQueryInvalidationByMutation | LiveQueryInvalidationByPolling
-
-type LiveQueryInvalidationByMutation @md {
+type LiveQueryInvalidation @md {
   """
   Path to the operation that could effect it. In a form: Mutation.something. Note that wildcard is not supported in this field.
   """
-  field: String!
-  invalidate: [String!]!
-}
-
-type LiveQueryInvalidationByPolling @md {
+  field: String
   """
   Polling interval in milliseconds
   """
-  pollingInterval: Int!
-  """
-  Schema coordinate of the query to be polled
-  """
+  pollingInterval: Int
   invalidate: [String!]!
 }
 

website/src/generated-markdown/LiveQueryInvalidation.generated.md

@@ -0,0 +1,4 @@
+
+* `field` (type: `String`) - Path to the operation that could effect it. In a form: Mutation.something. Note that wildcard is not supported in this field.
+* `pollingInterval` (type: `Int`) - Polling interval in milliseconds
+* `invalidate` (type: `Array of String`, required)

website/src/pages/docs/plugins/live-queries.mdx

@@ -99,7 +99,7 @@ query to be polled.
 
 ```yaml filename=".meshrc.yaml"
 plugins:
-  - live-query:
+  - liveQuery:
       invalidations:
         - pollingInterval: 10000 # Polling interval in milliseconds
           invalidate: