Adds previewOption extension-type

Author: leekelleher

src/Umbraco.Web.UI.Client/src/packages/documents/documents/manifests.ts

@@ -7,6 +7,7 @@ import { manifests as itemManifests } from './item/manifests.js';
 import { manifests as menuManifests } from './menu/manifests.js';
 import { manifests as modalManifests } from './modals/manifests.js';
 import { manifests as pickerManifests } from './picker/manifests.js';
+import { manifests as previewManifests } from './preview/manifests.js';
 import { manifests as propertyEditorManifests } from './property-editors/manifests.js';
 import { manifests as publishingManifests } from './publishing/manifests.js';
 import { manifests as recycleBinManifests } from './recycle-bin/manifests.js';
@@ -31,6 +32,7 @@ export const manifests: Array<UmbExtensionManifest | UmbExtensionManifestKind> =
 	...menuManifests,
 	...modalManifests,
 	...pickerManifests,
+	...previewManifests,
 	...propertyEditorManifests,
 	...publishingManifests,
 	...recycleBinManifests,

src/Umbraco.Web.UI.Client/src/packages/documents/documents/preview/manifests.ts

@@ -0,0 +1,5 @@
+import { manifests as previewOptionManifests } from './preview-option/manifests.js';
+import type { UmbExtensionManifestKind } from '@umbraco-cms/backoffice/extension-registry';
+export const manifests: Array<UmbExtensionManifest | UmbExtensionManifestKind> = [
+	...previewOptionManifests,
+];

src/Umbraco.Web.UI.Client/src/packages/documents/documents/preview/preview-option/index.ts

@@ -0,0 +1 @@
+export * from './preview-option-action-base.controller.js';

src/Umbraco.Web.UI.Client/src/packages/documents/documents/preview/preview-option/manifests.ts

@@ -0,0 +1,3 @@
+import type { UmbExtensionManifestKind } from '@umbraco-cms/backoffice/extension-registry';
+export const manifests: Array<UmbExtensionManifest | UmbExtensionManifestKind> = [
+];

src/Umbraco.Web.UI.Client/src/packages/documents/documents/preview/preview-option/preview-option-action-base.controller.ts

@@ -0,0 +1,19 @@
+import { UmbActionBase } from '@umbraco-cms/backoffice/action';
+import type { UmbAction } from '@umbraco-cms/backoffice/action';
+
+/**
+ * Base class for a preview option action.
+ * @abstract
+ * @class UmbPreviewOptionActionBase
+ * @augments {UmbActionBase}
+ */
+export abstract class UmbPreviewOptionActionBase<ArgsMetaType = never> extends UmbActionBase<UmbAction<ArgsMetaType>> {
+	/**
+	 * By specifying the `execute` method, the action will act as a button.
+	 * @abstract
+	 * @returns {Promise<void>}
+	 */
+	public execute(): Promise<void> {
+		return Promise.resolve();
+	}
+}

src/Umbraco.Web.UI.Client/src/packages/documents/documents/preview/preview-option/preview-option.extension.ts

@@ -0,0 +1,35 @@
+import type { UmbPreviewOptionActionBase } from './preview-option-action-base.controller.js';
+import type { ManifestElementAndApi, ManifestWithDynamicConditions } from '@umbraco-cms/backoffice/extension-api';
+import type { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller-api';
+import type { UUIInterfaceLook, UUIInterfaceColor } from '@umbraco-cms/backoffice/external/uui';
+
+export interface ManifestPreviewOption<MetaType extends MetaPreviewOption = MetaPreviewOption>
+	extends ManifestElementAndApi<UmbControllerHostElement, UmbPreviewOptionActionBase<MetaType>>,
+		ManifestWithDynamicConditions<UmbExtensionConditionConfig> {
+	type: 'previewOption';
+	meta: MetaPreviewOption;
+}
+
+export interface MetaPreviewOption {
+	icon?: string;
+	label?: string;
+	look?: UUIInterfaceLook;
+	color?: UUIInterfaceColor;
+}
+
+export interface ManifestPreviewOptionDefaultKind extends ManifestPreviewOption {
+	type: 'previewOption';
+	kind: 'default';
+}
+
+export interface ManifestPreviewOptionUrlProviderKind extends ManifestPreviewOption {
+	type: 'previewOption';
+	kind: 'urlProvider';
+	providerAlias: string;
+}
+
+declare global {
+	interface UmbExtensionManifestMap {
+		umbPreviewOption: ManifestPreviewOption | ManifestPreviewOptionDefaultKind | ManifestPreviewOptionUrlProviderKind;
+	}
+}

src/Umbraco.Web.UI.Client/src/packages/documents/documents/preview/preview-option/types.ts

@@ -0,0 +1 @@
+export type * from './preview-option.extension.js';

src/Umbraco.Web.UI.Client/src/packages/documents/documents/preview/types.ts

@@ -0,0 +1 @@
+export type * from './preview-option/types.js';

src/Umbraco.Web.UI.Client/src/packages/documents/documents/types.ts

@@ -14,6 +14,7 @@ export type * from './collection/types.js';
 export type * from './entity.js';
 export type * from './item/types.js';
 export type * from './modals/types.js';
+export type * from './preview/types.js';
 export type * from './publishing/types.js';
 export type * from './recycle-bin/types.js';
 export type * from './tree/types.js';