@umbraco-deploy/backoffice

TypeScript type definitions for extending the Umbraco Deploy backoffice. Install this package as a devDependency to get typings for Deploy's extension manifests, base classes, context tokens, and referenced API models.

Installation

npm install -D @umbraco-deploy/backoffice

Usage

import type { ManifestDeployEntityActionRegistrar } from "@umbraco-deploy/backoffice";
import {
  DEPLOY_CONTEXT,
  DeployEntityActionBase,
  WorkStatusModel,
} from "@umbraco-deploy/backoffice";

Runtime resolution

This package ships only TypeScript declarations (.d.ts). The runtime values (classes, enums, context tokens) are provided by the Umbraco Deploy backoffice bundle that ships with the Umbraco Deploy NuGet package, and are resolved via the import map declared in Deploy's umbraco-package.json:

"importmap": {
  "imports": {
    "@umbraco-deploy/backoffice": "/App_Plugins/Deploy/umbraco-deploy.js"
  }
}

Your extension is loaded by the Umbraco backoffice at runtime, where this mapping resolves @umbraco-deploy/backoffice to the Deploy bundle. No additional runtime entry is shipped via npm.