Add store delete command

Assisted-By: devx/921acb10-d127-42c8-8a9a-0314a325d188

Author: alfonso-noriega

.changeset/confirm-store-cancellation.md

@@ -0,0 +1,5 @@
+---
+'@shopify/store': patch
+---
+
+Wait for development store cancellation confirmation after deletion is requested.

packages/cli/oclif.manifest.json

@@ -6770,6 +6770,75 @@
       "strict": true,
       "summary": "Create a preview Shopify store."
     },
+    "store:delete": {
+      "aliases": [
+      ],
+      "args": {
+      },
+      "customPluginName": "@shopify/store",
+      "description": "Deletes a development store from your organization.",
+      "descriptionWithMarkdown": "Deletes a development store from your organization.",
+      "enableJsonFlag": false,
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --organization-id 1234567",
+        "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --organization-id 1234567 --json"
+      ],
+      "flags": {
+        "json": {
+          "allowNo": false,
+          "char": "j",
+          "description": "Output the result as JSON. Automatically disables color output.",
+          "env": "SHOPIFY_FLAG_JSON",
+          "hidden": false,
+          "name": "json",
+          "type": "boolean"
+        },
+        "no-color": {
+          "allowNo": false,
+          "description": "Disable color output.",
+          "env": "SHOPIFY_FLAG_NO_COLOR",
+          "hidden": false,
+          "name": "no-color",
+          "type": "boolean"
+        },
+        "organization-id": {
+          "description": "The numeric organization ID. Auto-selects if you belong to a single organization.",
+          "env": "SHOPIFY_FLAG_ORGANIZATION_ID",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "name": "organization-id",
+          "type": "option"
+        },
+        "store": {
+          "char": "s",
+          "description": "The myshopify.com domain of the store.",
+          "env": "SHOPIFY_FLAG_STORE",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "name": "store",
+          "required": true,
+          "type": "option"
+        },
+        "verbose": {
+          "allowNo": false,
+          "description": "Increase the verbosity of the output.",
+          "env": "SHOPIFY_FLAG_VERBOSE",
+          "hidden": false,
+          "name": "verbose",
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [
+      ],
+      "id": "store:delete",
+      "pluginAlias": "@shopify/cli",
+      "pluginName": "@shopify/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Delete a development store."
+    },
     "store:execute": {
       "aliases": [
       ],

packages/store/src/cli/api/graphql/business-platform-organizations/generated/delete_app_development_store.ts

@@ -0,0 +1,69 @@
+/* eslint-disable @typescript-eslint/consistent-type-definitions */
+import * as Types from './types.js'
+
+import {TypedDocumentNode as DocumentNode} from '@graphql-typed-document-node/core'
+
+export type DeleteAppDevelopmentStoreMutationVariables = Types.Exact<{
+  storeFqdn: Types.Scalars['String']['input']
+}>
+
+export type DeleteAppDevelopmentStoreMutation = {
+  deleteAppDevelopmentStore: {
+    success?: boolean | null
+    userErrors?: {code?: string | null; field: string[]; message: string}[] | null
+  }
+}
+
+export const DeleteAppDevelopmentStore = {
+  kind: 'Document',
+  definitions: [
+    {
+      kind: 'OperationDefinition',
+      operation: 'mutation',
+      name: {kind: 'Name', value: 'DeleteAppDevelopmentStore'},
+      variableDefinitions: [
+        {
+          kind: 'VariableDefinition',
+          variable: {kind: 'Variable', name: {kind: 'Name', value: 'storeFqdn'}},
+          type: {kind: 'NonNullType', type: {kind: 'NamedType', name: {kind: 'Name', value: 'String'}}},
+        },
+      ],
+      selectionSet: {
+        kind: 'SelectionSet',
+        selections: [
+          {
+            kind: 'Field',
+            name: {kind: 'Name', value: 'deleteAppDevelopmentStore'},
+            arguments: [
+              {
+                kind: 'Argument',
+                name: {kind: 'Name', value: 'storeFqdn'},
+                value: {kind: 'Variable', name: {kind: 'Name', value: 'storeFqdn'}},
+              },
+            ],
+            selectionSet: {
+              kind: 'SelectionSet',
+              selections: [
+                {kind: 'Field', name: {kind: 'Name', value: 'success'}},
+                {
+                  kind: 'Field',
+                  name: {kind: 'Name', value: 'userErrors'},
+                  selectionSet: {
+                    kind: 'SelectionSet',
+                    selections: [
+                      {kind: 'Field', name: {kind: 'Name', value: 'code'}},
+                      {kind: 'Field', name: {kind: 'Name', value: 'field'}},
+                      {kind: 'Field', name: {kind: 'Name', value: 'message'}},
+                      {kind: 'Field', name: {kind: 'Name', value: '__typename'}},
+                    ],
+                  },
+                },
+                {kind: 'Field', name: {kind: 'Name', value: '__typename'}},
+              ],
+            },
+          },
+        ],
+      },
+    },
+  ],
+} as unknown as DocumentNode<DeleteAppDevelopmentStoreMutation, DeleteAppDevelopmentStoreMutationVariables>

packages/store/src/cli/api/graphql/business-platform-organizations/generated/organization_accessible_shop.ts

@@ -0,0 +1,67 @@
+/* eslint-disable @typescript-eslint/consistent-type-definitions */
+import * as Types from './types.js'
+
+import {TypedDocumentNode as DocumentNode} from '@graphql-typed-document-node/core'
+
+export type OrganizationAccessibleShopQueryVariables = Types.Exact<{
+  id: Types.Scalars['ShopifyShopID']['input']
+}>
+
+export type OrganizationAccessibleShopQuery = {
+  organization?: {
+    accessibleShop?: {shopifyShopId?: string | null; planName?: string | null; storeType?: Types.Store | null} | null
+  } | null
+}
+
+export const OrganizationAccessibleShop = {
+  kind: 'Document',
+  definitions: [
+    {
+      kind: 'OperationDefinition',
+      operation: 'query',
+      name: {kind: 'Name', value: 'OrganizationAccessibleShop'},
+      variableDefinitions: [
+        {
+          kind: 'VariableDefinition',
+          variable: {kind: 'Variable', name: {kind: 'Name', value: 'id'}},
+          type: {kind: 'NonNullType', type: {kind: 'NamedType', name: {kind: 'Name', value: 'ShopifyShopID'}}},
+        },
+      ],
+      selectionSet: {
+        kind: 'SelectionSet',
+        selections: [
+          {
+            kind: 'Field',
+            name: {kind: 'Name', value: 'organization'},
+            selectionSet: {
+              kind: 'SelectionSet',
+              selections: [
+                {
+                  kind: 'Field',
+                  name: {kind: 'Name', value: 'accessibleShop'},
+                  arguments: [
+                    {
+                      kind: 'Argument',
+                      name: {kind: 'Name', value: 'id'},
+                      value: {kind: 'Variable', name: {kind: 'Name', value: 'id'}},
+                    },
+                  ],
+                  selectionSet: {
+                    kind: 'SelectionSet',
+                    selections: [
+                      {kind: 'Field', name: {kind: 'Name', value: 'shopifyShopId'}},
+                      {kind: 'Field', name: {kind: 'Name', value: 'planName'}},
+                      {kind: 'Field', name: {kind: 'Name', value: 'storeType'}},
+                      {kind: 'Field', name: {kind: 'Name', value: '__typename'}},
+                    ],
+                  },
+                },
+                {kind: 'Field', name: {kind: 'Name', value: '__typename'}},
+              ],
+            },
+          },
+        ],
+      },
+    },
+  ],
+} as unknown as DocumentNode<OrganizationAccessibleShopQuery, OrganizationAccessibleShopQueryVariables>

packages/store/src/cli/api/graphql/business-platform-organizations/mutations/delete_app_development_store.graphql

@@ -0,0 +1,10 @@
+mutation DeleteAppDevelopmentStore($storeFqdn: String!) {
+  deleteAppDevelopmentStore(storeFqdn: $storeFqdn) {
+    success
+    userErrors {
+      code
+      field
+      message
+    }
+  }
+}

packages/store/src/cli/api/graphql/business-platform-organizations/queries/organization_accessible_shop.graphql

@@ -0,0 +1,9 @@
+query OrganizationAccessibleShop($id: ShopifyShopID!) {
+  organization {
+    accessibleShop(id: $id) {
+      shopifyShopId
+      planName
+      storeType
+    }
+  }
+}

packages/store/src/cli/commands/store/delete.test.ts

@@ -0,0 +1,122 @@
+import StoreDelete from './delete.js'
+import {deleteDevStore} from '../../services/store/delete/dev.js'
+import {selectOrg} from '@shopify/organizations'
+import {AbortError} from '@shopify/cli-kit/node/error'
+import {outputResult} from '@shopify/cli-kit/node/output'
+import {terminalSupportsPrompting} from '@shopify/cli-kit/node/system'
+import {describe, expect, test, vi, beforeEach} from 'vitest'
+
+vi.mock('../../services/store/delete/dev.js')
+vi.mock('@shopify/cli-kit/node/system')
+
+vi.mock('@shopify/organizations', () => ({
+  selectOrg: vi.fn(),
+}))
+
+vi.mock('@shopify/cli-kit/node/output', async (importOriginal) => {
+  const actual: Record<string, unknown> = await importOriginal()
+  return {
+    ...actual,
+    outputResult: vi.fn(),
+  }
+})
+
+const defaultOrg = {id: '12345', businessName: 'Test Org'}
+
+beforeEach(() => {
+  vi.mocked(selectOrg).mockResolvedValue(defaultOrg)
+  vi.mocked(terminalSupportsPrompting).mockReturnValue(true)
+})
+
+describe('store delete command', () => {
+  test('resolves the organization and passes parsed flags through to the service', async () => {
+    await StoreDelete.run(['--store', 'my-store.myshopify.com', '--organization-id', '12345'])
+
+    expect(selectOrg).toHaveBeenCalledWith('12345')
+    expect(deleteDevStore).toHaveBeenCalledWith({
+      store: 'my-store.myshopify.com',
+      organization: defaultOrg,
+      json: false,
+    })
+  })
+
+  test('normalizes the store flag before passing it to the service', async () => {
+    await StoreDelete.run(['--store', 'my-store', '--organization-id', '12345'])
+
+    expect(deleteDevStore).toHaveBeenCalledWith(expect.objectContaining({store: 'my-store.myshopify.com'}))
+  })
+
+  test('passes json flag through to the service', async () => {
+    await StoreDelete.run(['--store', 'my-store.myshopify.com', '--json', '--organization-id', '12345'])
+
+    expect(deleteDevStore).toHaveBeenCalledWith({
+      store: 'my-store.myshopify.com',
+      organization: defaultOrg,
+      json: true,
+    })
+  })
+
+  test('prompts for the organization when --organization-id is omitted in an interactive environment', async () => {
+    await StoreDelete.run(['--store', 'my-store.myshopify.com'])
+
+    expect(selectOrg).toHaveBeenCalledWith(undefined)
+    expect(deleteDevStore).toHaveBeenCalledWith(expect.objectContaining({organization: defaultOrg}))
+  })
+
+  test('fails in a non-interactive environment when --organization-id is missing', async () => {
+    vi.mocked(terminalSupportsPrompting).mockReturnValue(false)
+    const mockExit = vi.spyOn(process, 'exit').mockImplementation((() => {
+      throw new Error('process.exit')
+    }) as never)
+
+    await expect(StoreDelete.run(['--store', 'my-store.myshopify.com'])).rejects.toThrow()
+    expect(deleteDevStore).not.toHaveBeenCalled()
+
+    mockExit.mockRestore()
+  })
+
+  test('defines the expected flags', () => {
+    expect(StoreDelete.flags.store).toBeDefined()
+    expect(StoreDelete.flags['organization-id']).toBeDefined()
+    expect(StoreDelete.flags.json).toBeDefined()
+  })
+
+  test('outputs structured JSON error when --json is active and service throws AbortError', async () => {
+    vi.mocked(deleteDevStore).mockRejectedValueOnce(new AbortError('Something went wrong'))
+    const mockExit = vi.spyOn(process, 'exit').mockImplementation((() => {
+      throw new Error('process.exit')
+    }) as never)
+
+    await expect(
+      StoreDelete.run(['--store', 'my-store.myshopify.com', '--organization-id', '12345', '--json']),
+    ).rejects.toThrow('process.exit')
+
+    const call = vi.mocked(outputResult).mock.calls[0]![0] as string
+    const parsed = JSON.parse(call)
+    expect(parsed).toEqual({
+      error: true,
+      message: 'Something went wrong',
+      nextSteps: [],
+      exitCode: 1,
+    })
+    expect(mockExit).toHaveBeenCalledWith(1)
+
+    mockExit.mockRestore()
+  })
+
+  test('does not output JSON for non-AbortError even when --json is active', async () => {
+    vi.mocked(deleteDevStore).mockRejectedValueOnce(new Error('unexpected'))
+
+    await expect(
+      StoreDelete.run(['--store', 'my-store.myshopify.com', '--organization-id', '12345', '--json']),
+    ).rejects.toThrow()
+    expect(vi.mocked(outputResult)).not.toHaveBeenCalled()
+  })
+
+  test('does not output JSON for AbortError when --json is not active', async () => {
+    vi.mocked(deleteDevStore).mockRejectedValueOnce(new AbortError('Something went wrong'))
+
+    await expect(StoreDelete.run(['--store', 'my-store.myshopify.com', '--organization-id', '12345'])).rejects.toThrow()
+    expect(vi.mocked(outputResult)).not.toHaveBeenCalled()
+  })
+})