pnp / pnp/cli-microsoft365

Enhancement: Add support for built-in Microsoft site designs (store 1) to spo sitedesign commands

Open
#7,460 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement needs discussion
Dominant language
TypeScript
Stars
1.5k
Forks
413
Avg merge
5d 6h
Merged PRs (30d)
21

Description

Description

spo sitedesign apply, spo sitedesign get and spo sitedesign list only reach tenant-registered custom site designs (store 0) via the SiteScriptUtility REST API. Microsoft's built-in site designs (e.g. Event, Department, Human Resources) live in a separate store ("store 1") and can currently only be reached by adding "store": 1 to the same REST calls, or by falling back to a raw m365 request call — there's no first-class way to list, get or apply them through the CLI today.

Proposal

  • spo sitedesign list --builtIn — lists the built-in Microsoft site designs.
  • spo sitedesign get --builtIn (--id|--title) — retrieves a single built-in design.
  • spo sitedesign apply (--id --builtIn | --template <name>) — applies a built-in design, either by id or by a friendly template name (e.g. Event, Department, HumanResources).

Prior art

PnP PowerShell already implemented the equivalent behaviour for Get-PnPSiteDesign -BuiltIn and Invoke-PnPSiteDesign -Template: https://github.com/pnp/powershell/pull/5358

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by examining the existing spo sitedesign apply, get, and list command entry points and their SiteScriptUtility REST calls. Compare the store 0 handling with the proposed store 1 behavior, then verify that built-in designs can be listed, retrieved by ID or title, and applied by ID or template name.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.