Skip to content

Add typed JSON output for store create dev - #8584

Merged
gonzaloriestra merged 2 commits into
gonzalo/json-store-bulkfrom
gonzalo/json-store-create-dev
Sep 21, 2026
Merged

gonzaloriestra merged 2 commits into
gonzalo/json-store-bulkfrom
gonzalo/json-store-create-dev

Conversation

@gonzaloriestra

@gonzaloriestra gonzaloriestra commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

The dev-store creation command supports JSON but does not expose or validate its output contract.

WHAT is this pull request doing?

Adds a discoverable schema for creation results and existing JSON errors. Reuses store and organization schemas from @shopify/organizations, which also serves app dev, and derives accepted plans from the existing plan definitions. Preserves text output and the creation service’s domain return value.

Example output

Illustrative sample data. Text excerpts omit terminal decoration and progress. JSON blocks show the final stdout result; progress and diagnostics go to stderr.

shopify store create dev --name "JSON schema test" --organization-id 1234 --plan basic --no-demo-data

Text

Dev store "JSON schema test" created successfully.

Domain     json-schema-test.myshopify.com
Admin      https://admin.shopify.com/store/json-schema-test
Plan       basic
Demo data  disabled

JSON (--json)

{
  "store": {
    "name": "JSON schema test",
    "domain": "json-schema-test.myshopify.com",
    "adminUrl": "https://admin.shopify.com/store/json-schema-test",
    "plan": "basic",
    "demoData": false
  },
  "organization": {
    "id": "1234",
    "name": "Acme"
  }
}

How to manually test your changes?

shopify store create dev --json-schema
shopify store create dev --name "JSON schema test" --organization-id 1234 --plan basic --no-demo-data
shopify store create dev --name "JSON schema test" --organization-id 1234 --plan basic --no-demo-data --json

Checklist

@gonzaloriestra
gonzaloriestra added this pull request to stack #8564 September 18, 2026 11:45
@github-actions github-actions Bot added the no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users. label Sep 18, 2026
@gonzaloriestra gonzaloriestra changed the title gonzalo/json store create dev Add typed JSON output for store create dev Sep 18, 2026

@gonzaloriestra gonzaloriestra Sep 18, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved from packages/store/src/cli/services/store/types.ts to be able to share it

@gonzaloriestra
gonzaloriestra marked this pull request as ready for review September 18, 2026 14:34
@gonzaloriestra
gonzaloriestra requested review from a team as code owners September 18, 2026 14:34
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-store-create-dev branch from 9d6d1c2 to 65ebbfc Compare September 21, 2026 16:49
@github-actions

Copy link
Copy Markdown
Contributor

Differences in type declarations

We detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:

  • Some seemingly private modules might be re-exported through public modules.
  • If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

We found no new type declarations in this PR

Existing type declarations

packages/cli-kit/dist/public/node/local-storage.d.ts
@@ -48,7 +48,6 @@ export declare class LocalStorage<T extends Record<string, any>> {
      *
      * @param error - The error that occurred.
      * @param operation - The operation that failed.
-     * @param configPath - The local storage configuration file path.
      * @throws AbortError if the error is permission-related.
      * @throws BugError if the error is not permission-related.
      */

@gonzaloriestra
gonzaloriestra added this pull request to the merge queue Sep 21, 2026
Merged via the queue into main with commit ae1cdd1 Sep 21, 2026
34 of 57 checks passed
@gonzaloriestra
gonzaloriestra deleted the gonzalo/json-store-create-dev branch September 21, 2026 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants