[DNM] Release bulk operations CLI commands

.changeset/smart-squids-warn.md

@@ -0,0 +1,5 @@
+---
+'@shopify/app': minor
+---
+
+Introduce `app execute` and `app bulk execute` commands to run queries and mutations

docs-shopify.dev/commands/app-bulk-execute.doc.ts

@@ -0,0 +1,38 @@
+// This is an autogenerated file. Don't edit this file manually.
+import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
+
+const data: ReferenceEntityTemplateSchema = {
+  name: 'app bulk execute',
+  description: `Executes an Admin API GraphQL query or mutation on the specified store, as a bulk operation. Mutations are only allowed on dev stores.
+
+  Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](/docs/api/usage/bulk-operations/imports).
+
+  Use [\`bulk status\`](/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk operations.`,
+  overviewPreviewDescription: `Execute bulk operations.`,
+  type: 'command',
+  isVisualComponent: false,
+  defaultExample: {
+    codeblock: {
+      tabs: [
+        {
+          title: 'app bulk execute',
+          code: './examples/app-bulk-execute.example.sh',
+          language: 'bash',
+        },
+      ],
+      title: 'app bulk execute',
+    },
+  },
+  definitions: [
+  {
+    title: 'Flags',
+    description: 'The following flags are available for the `app bulk execute` command:',
+    type: 'appbulkexecute',
+  },
+  ],
+  category: 'app',
+  related: [
+  ],
+}
+
+export default data

docs-shopify.dev/commands/app-bulk-status.doc.ts

@@ -0,0 +1,38 @@
+// This is an autogenerated file. Don't edit this file manually.
+import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
+
+const data: ReferenceEntityTemplateSchema = {
+  name: 'app bulk status',
+  description: `Check the status of a specific bulk operation by ID, or list all bulk operations belonging to this app on this store in the last 7 days.
+
+  Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](/docs/api/usage/bulk-operations/imports).
+
+  Use [\`bulk execute\`](/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.`,
+  overviewPreviewDescription: `Check the status of bulk operations.`,
+  type: 'command',
+  isVisualComponent: false,
+  defaultExample: {
+    codeblock: {
+      tabs: [
+        {
+          title: 'app bulk status',
+          code: './examples/app-bulk-status.example.sh',
+          language: 'bash',
+        },
+      ],
+      title: 'app bulk status',
+    },
+  },
+  definitions: [
+  {
+    title: 'Flags',
+    description: 'The following flags are available for the `app bulk status` command:',
+    type: 'appbulkstatus',
+  },
+  ],
+  category: 'app',
+  related: [
+  ],
+}
+
+export default data

docs-shopify.dev/commands/app-execute.doc.ts

@@ -0,0 +1,36 @@
+// This is an autogenerated file. Don't edit this file manually.
+import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
+
+const data: ReferenceEntityTemplateSchema = {
+  name: 'app execute',
+  description: `Executes an Admin API GraphQL query or mutation on the specified store. Mutations are only allowed on dev stores.
+
+  For operations that process large amounts of data, use [\`bulk execute\`](/docs/api/shopify-cli/app/app-bulk-execute) instead.`,
+  overviewPreviewDescription: `Execute GraphQL queries and mutations.`,
+  type: 'command',
+  isVisualComponent: false,
+  defaultExample: {
+    codeblock: {
+      tabs: [
+        {
+          title: 'app execute',
+          code: './examples/app-execute.example.sh',
+          language: 'bash',
+        },
+      ],
+      title: 'app execute',
+    },
+  },
+  definitions: [
+  {
+    title: 'Flags',
+    description: 'The following flags are available for the `app execute` command:',
+    type: 'appexecute',
+  },
+  ],
+  category: 'app',
+  related: [
+  ],
+}
+
+export default data

docs-shopify.dev/commands/examples/app-bulk-execute.example.sh

@@ -0,0 +1 @@
+shopify app bulk execute [flags]

docs-shopify.dev/commands/examples/app-bulk-status.example.sh

@@ -0,0 +1 @@
+shopify app bulk status [flags]

docs-shopify.dev/commands/examples/app-execute.example.sh

@@ -0,0 +1 @@
+shopify app execute [flags]

docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts

@@ -0,0 +1,86 @@
+// This is an autogenerated file. Don't edit this file manually.
+export interface appbulkexecute {
+  /**
+   * The Client ID of your app.
+   * @environment SHOPIFY_FLAG_CLIENT_ID
+   */
+  '--client-id <value>'?: string
+
+  /**
+   * The name of the app configuration.
+   * @environment SHOPIFY_FLAG_APP_CONFIG
+   */
+  '-c, --config <value>'?: string
+
+  /**
+   * Disable color output.
+   * @environment SHOPIFY_FLAG_NO_COLOR
+   */
+  '--no-color'?: ''
+
+  /**
+   * The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.
+   * @environment SHOPIFY_FLAG_OUTPUT_FILE
+   */
+  '--output-file <value>'?: string
+
+  /**
+   * The path to your app directory.
+   * @environment SHOPIFY_FLAG_PATH
+   */
+  '--path <value>'?: string
+
+  /**
+   * The GraphQL query or mutation to run as a bulk operation.
+   * @environment SHOPIFY_FLAG_QUERY
+   */
+  '-q, --query <value>'?: string
+
+  /**
+   * Path to a file containing the GraphQL query or mutation. Can't be used with --query.
+   * @environment SHOPIFY_FLAG_QUERY_FILE
+   */
+  '--query-file <value>'?: string
+
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
+  /**
+   * The store domain. Must be an existing dev store.
+   * @environment SHOPIFY_FLAG_STORE
+   */
+  '-s, --store <value>'?: string
+
+  /**
+   * Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables.
+   * @environment SHOPIFY_FLAG_VARIABLE_FILE
+   */
+  '--variable-file <value>'?: string
+
+  /**
+   * The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times.
+   * @environment SHOPIFY_FLAG_VARIABLES
+   */
+  '-v, --variables <value>'?: string
+
+  /**
+   * Increase the verbosity of the output.
+   * @environment SHOPIFY_FLAG_VERBOSE
+   */
+  '--verbose'?: ''
+
+  /**
+   * The API version to use for the bulk operation. If not specified, uses the latest stable version.
+   * @environment SHOPIFY_FLAG_VERSION
+   */
+  '--version <value>'?: string
+
+  /**
+   * Wait for bulk operation results before exiting. Defaults to false.
+   * @environment SHOPIFY_FLAG_WATCH
+   */
+  '--watch'?: ''
+}

docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts

@@ -0,0 +1,50 @@
+// This is an autogenerated file. Don't edit this file manually.
+export interface appbulkstatus {
+  /**
+   * The Client ID of your app.
+   * @environment SHOPIFY_FLAG_CLIENT_ID
+   */
+  '--client-id <value>'?: string
+
+  /**
+   * The name of the app configuration.
+   * @environment SHOPIFY_FLAG_APP_CONFIG
+   */
+  '-c, --config <value>'?: string
+
+  /**
+   * The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations belonging to this app on this store in the last 7 days.
+   * @environment SHOPIFY_FLAG_ID
+   */
+  '--id <value>'?: string
+
+  /**
+   * Disable color output.
+   * @environment SHOPIFY_FLAG_NO_COLOR
+   */
+  '--no-color'?: ''
+
+  /**
+   * The path to your app directory.
+   * @environment SHOPIFY_FLAG_PATH
+   */
+  '--path <value>'?: string
+
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
+  /**
+   * The store domain. Must be an existing dev store.
+   * @environment SHOPIFY_FLAG_STORE
+   */
+  '-s, --store <value>'?: string
+
+  /**
+   * Increase the verbosity of the output.
+   * @environment SHOPIFY_FLAG_VERBOSE
+   */
+  '--verbose'?: ''
+}

docs-shopify.dev/commands/interfaces/app-execute.interface.ts

@@ -0,0 +1,80 @@
+// This is an autogenerated file. Don't edit this file manually.
+export interface appexecute {
+  /**
+   * The Client ID of your app.
+   * @environment SHOPIFY_FLAG_CLIENT_ID
+   */
+  '--client-id <value>'?: string
+
+  /**
+   * The name of the app configuration.
+   * @environment SHOPIFY_FLAG_APP_CONFIG
+   */
+  '-c, --config <value>'?: string
+
+  /**
+   * Disable color output.
+   * @environment SHOPIFY_FLAG_NO_COLOR
+   */
+  '--no-color'?: ''
+
+  /**
+   * The file name where results should be written, instead of STDOUT.
+   * @environment SHOPIFY_FLAG_OUTPUT_FILE
+   */
+  '--output-file <value>'?: string
+
+  /**
+   * The path to your app directory.
+   * @environment SHOPIFY_FLAG_PATH
+   */
+  '--path <value>'?: string
+
+  /**
+   * The GraphQL query or mutation, as a string.
+   * @environment SHOPIFY_FLAG_QUERY
+   */
+  '-q, --query <value>'?: string
+
+  /**
+   * Path to a file containing the GraphQL query or mutation. Can't be used with --query.
+   * @environment SHOPIFY_FLAG_QUERY_FILE
+   */
+  '--query-file <value>'?: string
+
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
+  /**
+   * The myshopify.com domain of the store to execute against. The app must be installed on the store. If not specified, you will be prompted to select a store.
+   * @environment SHOPIFY_FLAG_STORE
+   */
+  '-s, --store <value>'?: string
+
+  /**
+   * Path to a file containing GraphQL variables in JSON format. Can't be used with --variables.
+   * @environment SHOPIFY_FLAG_VARIABLE_FILE
+   */
+  '--variable-file <value>'?: string
+
+  /**
+   * The values for any GraphQL variables in your query or mutation, in JSON format.
+   * @environment SHOPIFY_FLAG_VARIABLES
+   */
+  '-v, --variables <value>'?: string
+
+  /**
+   * Increase the verbosity of the output.
+   * @environment SHOPIFY_FLAG_VERBOSE
+   */
+  '--verbose'?: ''
+
+  /**
+   * The API version to use for the query or mutation. Defaults to the latest stable version.
+   * @environment SHOPIFY_FLAG_VERSION
+   */
+  '--version <value>'?: string
+}