@umbraco-deploy/backoffice 17.1.0-rc1

package/README.md

@@ -0,0 +1,41 @@
+# @umbraco-deploy/backoffice
+
+TypeScript type definitions for extending the [Umbraco Deploy](https://umbraco.com/products/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
+
+```bash
+npm install -D @umbraco-deploy/backoffice
+```
+
+## Usage
+
+```ts
+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`:
+
+```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.

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@umbraco-deploy/backoffice",
+  "version": "17.1.0-rc1",
+  "type": "module",
+  "author": {
+    "name": "Umbraco A/S",
+    "email": "dxp@umbraco.com",
+    "url": "https://umbraco.com"
+  },
+  "bugs": {
+    "url": "https://github.com/umbraco/Umbraco.Deploy.Issues/issues"
+  },
+  "types": "./types/umbraco-deploy-public.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/umbraco-deploy-public.d.ts"
+    }
+  },
+  "peerDependencies": {
+    "@umbraco-cms/backoffice": "17.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/types/umbraco-deploy-public.d.ts

@@ -0,0 +1,386 @@
+import type { ManifestBase } from '@umbraco-cms/backoffice/extension-api';
+import { Observable } from 'rxjs';
+import { UMB_MODAL_MANAGER_CONTEXT } from '@umbraco-cms/backoffice/modal';
+import type { UmbApiError } from '@umbraco-cms/backoffice/resources';
+import type { UmbConditionConfigBase } from '@umbraco-cms/backoffice/extension-api';
+import { UmbContextBase } from '@umbraco-cms/backoffice/class-api';
+import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
+import { UmbControllerBase } from '@umbraco-cms/backoffice/class-api';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import { UmbEntityActionBase } from '@umbraco-cms/backoffice/entity-action';
+import { UmbLocalizationController } from '@umbraco-cms/backoffice/localization-api';
+import { UmbLocalizationSet } from '@umbraco-cms/backoffice/localization-api';
+
+export declare type AddToQueueModel = {
+    id: string;
+    entityType: string;
+    culture?: string | null;
+    includeDescendants: boolean;
+    releaseDate?: string | null;
+};
+
+declare type ClientConfigurationInfoModel = {
+    currentWorkspaceType: string;
+    currentWorkspace: string;
+    target?: WorkspaceInfoModel | null;
+    allowRestoreOptions: boolean;
+    allowRestoreIgnoreDependencies: boolean;
+    allowDeployOptions: boolean;
+    allowDeployIgnoreDependencies: boolean;
+    debugEnabled: boolean;
+    isLocalWorkspace: boolean;
+    restoreWorkspaces: Array<WorkspaceInfoModel>;
+    workspaces: Array<WorkspaceInfoModel>;
+};
+
+export declare type ClientConfigurationModel = {
+    restoreHubUrl: string;
+    deployHubUrl: string;
+    clientConfiguration: ClientConfigurationInfoModel | UmbracoCloudClientConfigurationInfoModel;
+    registeredEntityOptions: {
+        [key: string]: DeployRegisteredEntityTypeDetailOptionsModel;
+    };
+};
+
+export declare type ConfigurationModel = {
+    excludedEntityTypes: Array<string>;
+    allowIgnoreDependenciesOperations: string;
+    ignoreBrokenDependenciesBehavior: string;
+    transferDictionaryAsContent: boolean;
+    ignoreMissingLanguagesForDictionaryItems: boolean;
+    exportMemberGroups: boolean;
+    allowMembersDeploymentOperations: string;
+    exportUserGroups: boolean;
+    transferMemberGroupsAsContent: boolean;
+    sessionTimeout: string;
+    httpClientTimeout: string;
+    databaseCommandTimeout: string;
+    sourceDeployTimeout: string;
+    diskOperationsTimeout: string;
+    allowDomainsDeploymentOperations: string;
+    allowPublicAccessDeploymentOperations: string;
+    allowWebhooksDeploymentOperations: string;
+    trashedContentDeploymentOperations: string;
+    postDeploySchemaOperation: string;
+    reloadMemoryCacheFollowingDiskReadOperation: boolean;
+    sourceDeployBatchSize?: number | null;
+    packageBatchSize?: number | null;
+    mediaFileChecksumCalculationMethod: string;
+    numberOfSignaturesToUseAllRelationCache: number;
+    continueOnMediaFilePathTooLongException: boolean;
+    suppressCacheRefresherNotifications: boolean;
+    hideVersionDetails: boolean;
+    hideConfigurationDetails: boolean;
+    resolveUserInTargetEnvironment: boolean;
+    setEmptyDictionaryItemsOnTransfer: boolean;
+    suspensions: SuspensionsConfigurationModel;
+    validateDependenciesOnImport: boolean;
+    importOnStartup: ImportOnStartupConfigurationModel;
+};
+
+declare interface DependencyModel {
+    Name?: string;
+    NodeId?: number;
+    Dependent?: DependencyModel;
+    Udi?: string;
+    Type?: string;
+    Reason?: string;
+    DependsOn?: Array<DependencyModel>;
+}
+
+export declare const DEPLOY_CONTEXT: UmbContextToken<DeployContext, DeployContext>;
+
+export declare const DEPLOY_ENTITYTYPE_CONDITION_ALIAS = "Deploy.Condition.EntityType";
+
+export declare const DEPLOY_SIGNALR_CONTEXT: UmbContextToken<DeploySignalRContext, DeploySignalRContext>;
+
+export declare const DEPLOY_TRANSFER_QUEUE_MANAGER: UmbContextToken<DeployTransferQueueManagerContext, DeployTransferQueueManagerContext>;
+
+export declare class DeployContext extends UmbControllerBase {
+    #private;
+    config: Observable<ConfigurationModel | undefined>;
+    clientConfig: Observable<ClientConfigurationModel | undefined>;
+    license: Observable<LicenseStatusResponseModel | undefined>;
+    hostConnected(): Promise<void>;
+    environments(): Array<EnvironmentInfoModel>;
+    restoreEnvironments(): WorkspaceInfoModel[];
+    getRegisteredEntity(value: string): DeployRegisteredEntity | undefined;
+    showProgress(workItemPromise: Promise<WorkItemDetailModel | UmbApiError | undefined>, progressModel: WorkDescriptionModel, completeModel: WorkDescriptionModel): Promise<void>;
+}
+
+export declare class DeployEntityActionBase extends UmbEntityActionBase<never> {
+    modalManager?: typeof UMB_MODAL_MANAGER_CONTEXT.TYPE;
+    deployContext?: typeof DEPLOY_CONTEXT.TYPE;
+    protected localize: UmbLocalizationController<UmbLocalizationSet>;
+    hostConnected(): void;
+    protected showProgress(workItemPromise: Promise<WorkItemDetailModel | UmbApiError | undefined>, progress: WorkDescriptionModel, complete: WorkDescriptionModel): Promise<void>;
+    protected requestReload(): Promise<void>;
+}
+
+export declare type DeployEntityTypeConditionConfig = UmbConditionConfigBase<typeof DEPLOY_ENTITYTYPE_CONDITION_ALIAS> & {
+    forEntityTypes?: {
+        [key: string]: Array<"default" | UmbExtensionConditionConfigMap[keyof UmbExtensionConditionConfigMap]>;
+    };
+    default: Array<UmbExtensionConditionConfigMap[keyof UmbExtensionConditionConfigMap]>;
+};
+
+export declare interface DeployErrorModel {
+    hasError: boolean;
+    comment?: string;
+    log?: string;
+    exception?: DeployExceptionModel;
+    exceptionMessage?: string;
+}
+
+export declare interface DeployExceptionModel {
+    hasError?: boolean;
+    EnvironmentName?: string;
+    Type?: DeployExceptionType;
+    Detail?: string;
+    Message?: string;
+    ExceptionMessage?: string;
+    HasMeaningForUi?: boolean;
+    InnerException?: DeployExceptionModel;
+    InnerExceptions?: Array<DeployExceptionModel>;
+    Error?: DeployExceptionModel;
+    FileName?: string;
+    Udi?: string;
+    ExceptionType?: string;
+    Mismatches?: Array<MismatchModel>;
+    IgnoredEntityTypes?: Array<string>;
+    NumberOfItemsAffected?: number;
+    NumberOfDependentItems?: number;
+    Dependencies?: Array<DependencyModel>;
+    Extensions?: {
+        UserName?: string;
+        UserEmail?: string;
+    };
+}
+
+export declare type DeployExceptionType = "ArtifactCollisionException" | "DeploySchemaMismatchException" | "RestoreSchemaMismatchException" | "ImportArtifactsException" | "ImportArtifactsUnhandledException" | "UnauthorizedClientException" | "ContentTypeChangedException" | "AggregateDependencyException" | "EnvironmentBusyException" | "ChunkedEncodingException" | "WebException" | "InvalidPathException" | "MergeConflictException" | "RemoteApiTimeoutException" | "RemoteApiException";
+
+export declare class DeployExportBaseEntityAction extends DeployEntityActionBase implements EntityActionWithWorkDescription {
+    readonly _progressModel: WorkDescriptionModel;
+    readonly _completeModel: WorkDescriptionModel;
+}
+
+export declare type DeployItemModel = {
+    name: string;
+    culture?: string | null;
+    udi: UdiModel;
+    includeDescendants: boolean;
+    releaseDate?: string | null;
+};
+
+export declare interface DeployRegisteredEntity extends DeployRegisteredEntityTypeDetailOptionsModel {
+    entityType: string;
+    isRoot: boolean;
+}
+
+export declare type DeployRegisteredEntityTypeDetailOptionsModel = {
+    supportsQueueForTransfer: boolean;
+    supportsQueueForTransferOfDescendents: boolean;
+    supportsRestore: boolean;
+    supportsPartialRestore: boolean;
+    supportsImportExport: boolean;
+    supportsExportOfDescendants: boolean;
+    permittedToRestore: boolean;
+};
+
+export declare class DeployRestoreBaseEntityAction extends DeployEntityActionBase implements EntityActionWithWorkDescription {
+    protected _restoreModel?: void | DeployRestoreModalValue;
+    readonly _progressModel: WorkDescriptionModel;
+    readonly _completeModel: WorkDescriptionModel;
+}
+
+declare interface DeployRestoreModalValue {
+    restoreNodes?: [
+        {
+        unique: string;
+        id: string;
+        entityType: string;
+        includeDescendants: boolean;
+        selector: string;
+    }
+    ];
+    environment?: EnvironmentInfoModel;
+    ignoreDependencies?: boolean;
+}
+
+export declare class DeploySignalRContext extends UmbControllerBase {
+    #private;
+    readonly deploySessionUpdate: Observable<SessionUpdatedModel | null>;
+    readonly deployHeartbeat: Observable<HeartbeatModel | null>;
+    readonly restoreHeartbeat: Observable<HeartbeatModel | null>;
+    readonly restoreSessionUpdate: Observable<SessionUpdatedModel | null>;
+    readonly diskReadSessionUpdate: Observable<SessionUpdatedModel | null>;
+    sessionId?: string;
+    hostConnected(): void;
+    hostDisconnected(): void;
+    getDeployClientId(): string | null;
+}
+
+export declare class DeployTransferQueueManagerContext extends UmbContextBase {
+    #private;
+    queue: Observable<DeployItemModel[]>;
+    isInitialized: Observable<boolean>;
+    constructor(host: UmbControllerHost);
+    destroy(): void;
+    add(item: AddToQueueModel): Promise<DeployItemModel[]>;
+    clear(): Promise<void>;
+    remove(item: DeployItemModel): Promise<void>;
+    refresh(item?: AddToQueueModel): Promise<void>;
+    get allowDeployOptions(): boolean;
+}
+
+declare type DifferenceModel = {
+    title: string;
+    text?: string | null;
+    category?: string | null;
+};
+
+export declare type EntityActionType = "Deploy.EntityAction.EnvironmentRestore" | "Deploy.EntityAction.TreeRestore" | "Deploy.EntityAction.PartialRestore" | "Deploy.EntityAction.Queue" | "Deploy.EntityAction.Compare" | "Deploy.EntityAction.EnvironmentExport" | "Deploy.EntityAction.Export" | "Deploy.EntityAction.Import";
+
+export declare interface EntityActionWithWorkDescription {
+    _progressModel: WorkDescriptionModel;
+    _completeModel: WorkDescriptionModel;
+}
+
+export declare type EnvironmentInfoModel = WorkspaceInfoModel;
+
+declare type HeartbeatModel = {
+    sessionId: string;
+    serverTimeStamp: string;
+    workItem: string;
+};
+
+declare type ImportOnStartupConfigurationModel = {
+    enabled: boolean;
+    files: Array<string>;
+    fileAction: string;
+    warningsAsErrors: boolean;
+    entityTypes: Array<string>;
+    cultures: Array<string>;
+    username?: string | null;
+};
+
+export declare type LicenseStatusResponseModel = {
+    valid: boolean;
+    message?: string | null;
+};
+
+export declare interface ManifestDeployEntityActionRegistrar extends ManifestBase {
+    type: "deployEntityActionRegistrar";
+    actionAlias: EntityActionType;
+    forEntityTypes: Array<string | {
+        entityTypes: Array<string>;
+        conditions: Array<"default" | UmbExtensionConditionConfigMap[keyof UmbExtensionConditionConfigMap]>;
+    }>;
+}
+
+export declare interface ManifestDeployEntityTypeMapping extends ManifestBase {
+    type: "deployEntityTypeMapping";
+    entityTypes: Record<string, string>;
+}
+
+export declare type MismatchDetailsModel = {
+    udi: UdiModel;
+    name: string;
+    alias: string;
+    differences: Array<DifferenceModel>;
+};
+
+declare interface MismatchDiffModel {
+    Title: string;
+    Category?: string;
+    Text: string;
+}
+
+declare interface MismatchModel {
+    Udi: string;
+    Name: string;
+    Alias?: string;
+    Differences: Array<MismatchDiffModel>;
+}
+
+export declare interface ProgressModel {
+    status: WorkStatusModel;
+    message?: string;
+    progress?: number;
+    activity?: string;
+    timestamp?: string;
+    serverTimestamp?: string;
+    trace?: string;
+    showDebug?: boolean;
+    mismatches?: Array<MismatchDetailsModel>;
+    error?: DeployErrorModel;
+}
+
+declare type SessionUpdatedModel = {
+    sessionId: string;
+    serverTimeStamp: string;
+    workItem: string;
+    status: WorkStatusModel;
+    comment: string;
+    log: string;
+    exceptionJson: string;
+    percent: number;
+    mismatchList: Array<MismatchDetailsModel>;
+};
+
+declare type SuspensionsConfigurationModel = {
+    diskRead: string;
+    partialRestore: string;
+    restore: string;
+    deploy: string;
+    import: string;
+    export: string;
+};
+
+declare type UdiModel = {
+    readonly uriValue: string;
+    readonly entityType: string;
+    readonly isRoot: boolean;
+};
+
+declare type UmbracoCloudClientConfigurationInfoModel = ClientConfigurationInfoModel & {
+    isTrial: boolean;
+    trialExpireInDays: number;
+    projectName: string;
+    projectId: string;
+    projectAlias: string;
+    projectUrl: string;
+};
+
+export declare interface WorkDescriptionModel {
+    heading?: string;
+    description?: string;
+    elementName?: string;
+}
+
+export declare type WorkItemDetailModel = {
+    sessionId: string;
+};
+
+export declare type WorkspaceInfoModel = {
+    name: string;
+    type: string;
+    url: string;
+    umbracoUrl: string;
+    git: string;
+    current: boolean;
+    deployUrl: string;
+};
+
+export declare enum WorkStatusModel {
+    UNKNOWN = "Unknown",
+    NEW = "New",
+    EXECUTING = "Executing",
+    COMPLETED = "Completed",
+    FAILED = "Failed",
+    CANCELLED = "Cancelled",
+    TIMED_OUT = "TimedOut",
+    MISMATCH = "Mismatch"
+}
+
+export { }