Search: document the @umbraco-cms/search npm types package

[iOvergaard]

📋 Description

Adds a new Installing the TypeScript types section to 17/umbraco-search/extending/backoffice-extensions.md. Every other section on that page already imports from @umbraco-cms/search/global and @umbraco-cms/search/settings without telling readers where the types come from — this fills the gap.

The section covers:

• Installing @umbraco-cms/search as a development dependency
• The next dist-tag for the current prerelease line
• The two subpath entry points (/global and /settings) and what each contains
• The fact that the package is types-only and runtime resolves through the backoffice's importmap
• The peer-dependency requirement on @umbraco-cms/backoffice

Content was ported from the "Docs to port to UmbracoDocs" snippet drafted in umbraco/Umbraco.Cms.Search#133.

AI disclosure

This PR is AI-assisted. Claude helped restructure the original PR snippet to match the GitBook conventions used in the file ({% hint %}, {% code title %}), tighten passive constructions, and remove vague pronouns per the style guide. The AI-generated label is applied on this PR.

📎 Related Issues (if applicable)

• Source snippet: Publish @umbraco-cms/search types-only npm package Umbraco.Cms.Search#133
• Package README + metadata: Client: add README, LICENSE and npm package metadata Umbraco.Cms.Search#136

✅ Contributor Checklist

I've followed the Umbraco Documentation Style Guide and can confirm that:

• Code blocks are correctly formatted.
• Sentences are short and clear (preferably under 25 words).
• Passive voice and first-person language ("we", "I") are avoided.
• Relevant pages are linked.
• All links work and point to the correct resources.
• Screenshots or diagrams are included if useful. (not applicable — text-only addition)
• Any code examples or instructions have been tested. The import example was verified against the published package's exports (UmbSearchIndex re-exported via settings/index.ts; constants present in global/).
• Typos, broken links, and broken images are fixed.

Product & Version (if relevant)

Umbraco Search — v17 (only documented version).

Deadline (if relevant)

Not urgent, but ideally lands before the next @umbraco-cms/search prerelease so users landing on the docs page from npmjs.com find the install instructions.

📚 Helpful Resources

• 🧾 Umbraco Contribution Guidelines
• ✍️ Umbraco Documentation Style Guide

[github-actions]

Thanks for opening this PR! 🎉

Quick question: Does this PR include any AI-generated content?

AI tools are absolutely welcome here! We only ask that you follow our AI contribution guidelines to help keep the documentation consistent and trustworthy.

Drop a quick comment to let us know!

[Copilot]

Pull request overview

Adds missing installation guidance for the @umbraco-cms/search TypeScript types package to the Umbraco Search v17 backoffice extension developer docs, aligning the page with its existing usage of @umbraco-cms/search/global and @umbraco-cms/search/settings.

Changes:

• Adds a new “Installing the TypeScript types” section with npm install instructions (including next dist-tag guidance).
• Documents the two subpath entry points (/global and /settings) and clarifies that runtime JS is resolved via the backoffice importmap.
• Notes the @umbraco-cms/backoffice peer dependency and includes a minimal import example.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[sofietoft]

Thanks @iOvergaard !

Do we know when the next prerelease of Umbraco Search lands?
I'm happy to merge it now, but not sure if it's too early. Let me know 🙏

[iOvergaard]

@sofietoft it's out now, so feel free to merge whenever :-)