Merge pull request #930 from gadget-inc/add-shopid-to-background

Add Shop ID support to background actions

Author: infiton

packages/core/src/types.ts

@@ -934,6 +934,21 @@ export type EnqueueBackgroundActionOptions<Action extends AnyActionFunction> = {
    * startAt: new Date(new Date().getTime() + 60 * 1000)
    */
   startAt?: Date | string;
+
+  /**
+   * The Shopify shop ID to associate with this background action for intelligent rate limiting.
+   *
+   * When provided, Gadget will automatically manage the execution of enqueued background actions based on your app's
+   * available Shopify API rate limit capacity. If your app is being rate limited by Shopify, Gadget will defer
+   * execution and only process actions when there is sufficient rate limit headroom to complete them successfully.
+   *
+   * If not provided, the action will be executed immediately without any rate limit awareness, which may result
+   * in Shopify API errors if your app is under heavy load.
+   *
+   * @example
+   * shopifyShop: "82277368081"
+   */
+  shopifyShop?: string;
 } & Partial<OperationContext>;
 
 export type BackgroundActionResultData<