feat(compositions): add interactive mode to compositions commands

[ben-kalmus]

Summary

• Adds an --interactive/-i flag to the compositions commands that build a request body, so users can construct the body through prompts instead of hand-writing JSON.

• Covered commands:

  • compositions upsert (Composition),
  • compositions rules upsert (CompositionRule),
  • compositions search (search RequestBody).

• Stacked on the interactive engine PR feat(interactive): add reflection-driven interactive prompt engine #249 (merge that first).

Demos

Upsert

Upsert Rule

Search

Stacked PRs

• feat(interactive): add reflection-driven interactive prompt engine #249 <- this PR

  • Introduces the generic interactive package

• feat(compositions): add interactive mode to compositions commands #252

  • Includes interactive as option to Compositions API commands

Usage

# Build a composition interactively
algolia compositions upsert my-comp --interactive

# Build a composition rule interactively
algolia compositions rules upsert my-comp rule-1 --interactive

# Build a search request interactively (query becomes optional under -i)
algolia compositions search my-comp --interactive

# Still supported: from a file or stdin
algolia compositions upsert my-comp --file body.json
cat rule.json | algolia compositions rules upsert my-comp rule-1 --file -

Design notes

• The Prompter is provided by cmdutil.Factory (defaulted to a survey-backed prompter in factory.New), so each command receives it as a dependency and tests inject a fake. No test-only seam on the command signatures.

• For the write commands, --file and --interactive are mutually exclusive and exactly one is required. For search, --interactive makes the positional <query> optional (the request is built from prompts). --interactive always requires a TTY and errors otherwise.

• Identifiers from positional args are pre-populated (composition objectID, rule objectID), so they are not prompted.

• Non-interactive (--file / positional query) behavior is unchanged.

Changes

• pkg/cmdutil/factory.go: add a Prompter field to Factory.
• pkg/cmd/factory/default.go: default Prompter to a survey-backed prompter built from the IO streams.
• pkg/cmd/compositions/upsert/upsert.go: --interactive/-i, flag validation, interactive build path.
• pkg/cmd/compositions/rules/upsert/upsert.go: same for composition rules (CompositionRule).
• pkg/cmd/compositions/search/search.go: --interactive/-i building the search RequestBody; query argument made optional under -i (RangeArgs(1,2)).
• Test files for each command plus a group-level integration test (pkg/cmd/compositions/compositions_test.go).

Tests

• Interactive happy paths for upsert (full PUT body via JSONEq at the command-group level), rules upsert, and search, all driven by a scripted prompter on the factory.
• Guards per command: --file + --interactive conflict, and --interactive without a TTY.
• Existing --file / positional-query behavior covered by the unchanged tests.

[codacy-production]

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity · 18 duplication

Metric	Results
Complexity	0
Duplication	18

View in Codacy

_{TIP This summary will be updated as you push new changes.}