@umbraco-cms/backoffice 17.0.2 → 17.1.0

package/examples/workspace-context-counter/counter-workspace-context.ts

@@ -4,7 +4,7 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
 import { UmbNumberState } from '@umbraco-cms/backoffice/observable-api';
 
 // The Example Workspace Context Controller:
-export class WorkspaceContextCounterElement extends UmbContextBase {
+export class ExampleWorkspaceContextCounterContext extends UmbContextBase {
 	// We always keep our states private, and expose the values as observables:
 	#counter = new UmbNumberState(0);
 	readonly counter = this.#counter.asObservable();
@@ -24,10 +24,10 @@ export class WorkspaceContextCounterElement extends UmbContextBase {
 }
 
 // Declare a api export, so Extension Registry can initialize this class:
-export const api = WorkspaceContextCounterElement;
+export const api = ExampleWorkspaceContextCounterContext;
 
 // Declare a Context Token that other elements can use to request the WorkspaceContextCounter:
-export const EXAMPLE_COUNTER_CONTEXT = new UmbContextToken<WorkspaceContextCounterElement>(
+export const EXAMPLE_COUNTER_CONTEXT = new UmbContextToken<ExampleWorkspaceContextCounterContext>(
 	'UmbWorkspaceContext',
 	'example.workspaceContext.counter',
 );

package/examples/workspace-context-counter/counter-workspace-view.ts

@@ -4,7 +4,7 @@ import { css, html, customElement, state, LitElement } from '@umbraco-cms/backof
 import { UmbElementMixin } from '@umbraco-cms/backoffice/element-api';
 
 @customElement('example-counter-workspace-view')
-export class ExampleCounterWorkspaceView extends UmbElementMixin(LitElement) {
+export class ExampleCounterWorkspaceViewElement extends UmbElementMixin(LitElement) {
 	#counterContext?: typeof EXAMPLE_COUNTER_CONTEXT.TYPE;
 
 	@state()
@@ -46,10 +46,10 @@ export class ExampleCounterWorkspaceView extends UmbElementMixin(LitElement) {
 	];
 }
 
-export default ExampleCounterWorkspaceView;
+export default ExampleCounterWorkspaceViewElement;
 
 declare global {
 	interface HTMLElementTagNameMap {
-		'example-counter-workspace-view': ExampleCounterWorkspaceView;
+		'example-counter-workspace-view': ExampleCounterWorkspaceViewElement;
 	}
 }

package/examples/workspace-context-initial-name/README.md

@@ -0,0 +1,3 @@
+# Workspace Context for setting an Initial Name
+
+This example of a Workspace Context demonstrates how to manipulate the name of the workspaces entity.

package/examples/workspace-context-initial-name/index.ts

@@ -0,0 +1,22 @@
+import {
+	UMB_WORKSPACE_CONDITION_ALIAS,
+	UMB_WORKSPACE_ENTITY_IS_NEW_CONDITION_ALIAS,
+} from '@umbraco-cms/backoffice/workspace';
+
+export const manifests: Array<UmbExtensionManifest> = [
+	{
+		type: 'workspaceContext',
+		name: 'Example Name Manipulation Workspace Context',
+		alias: 'example.workspaceContext.nameManipulation',
+		api: () => import('./workspace-context.js'),
+		conditions: [
+			{
+				alias: UMB_WORKSPACE_CONDITION_ALIAS,
+				match: 'Umb.Workspace.Document',
+			},
+			{
+				alias: UMB_WORKSPACE_ENTITY_IS_NEW_CONDITION_ALIAS,
+			},
+		],
+	},
+];

package/examples/workspace-context-initial-name/workspace-context.ts

@@ -0,0 +1,27 @@
+import { UmbControllerBase } from '@umbraco-cms/backoffice/class-api';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import { UMB_CONTENT_WORKSPACE_CONTEXT } from '@umbraco-cms/backoffice/content';
+import { UmbVariantId } from '@umbraco-cms/backoffice/variant';
+
+// The Example Workspace Context Controller:
+export class ExampleWorkspaceContextNameManipulation extends UmbControllerBase {
+	constructor(host: UmbControllerHost) {
+		super(host);
+
+		this.consumeContext(UMB_CONTENT_WORKSPACE_CONTEXT, async (workspace) => {
+			if (!workspace) return;
+			await workspace.isLoaded();
+			// Set the name if it's already empty (We do not want to overwrite if it's a Blueprint)
+			// Notice we need to provide a Variant-ID to getName, as Document names are variant specific. Here we get the Invariant name — this will need to be extended if you are looking to support multiple variants.
+			const variantId = UmbVariantId.CreateInvariant();
+			const name = workspace.getName(variantId);
+			if (name === undefined) {
+				const manipulatedName = `New Document - ${new Date().toLocaleDateString('en-GB')}`;
+				workspace.setName(manipulatedName, variantId);
+			}
+		});
+	}
+}
+
+// Declare a api export, so Extension Registry can initialize this class:
+export { ExampleWorkspaceContextNameManipulation as api };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@umbraco-cms/backoffice",
   "license": "MIT",
-  "version": "17.0.2",
+  "version": "17.1.0",
   "type": "module",
   "exports": {
     ".": null,
@@ -85,9 +85,11 @@
     "./picker-input": "./dist-cms/packages/core/picker-input/index.js",
     "./picker-data-source": "./dist-cms/packages/core/picker-data-source/index.js",
     "./picker": "./dist-cms/packages/core/picker/index.js",
+    "./preview": "./dist-cms/packages/preview/index.js",
     "./property-action": "./dist-cms/packages/core/property-action/index.js",
     "./property-editor-data-source": "./dist-cms/packages/core/property-editor-data-source/index.js",
     "./property-editor": "./dist-cms/packages/core/property-editor/index.js",
+    "./property-sort-mode": "./dist-cms/packages/core/property-sort-mode/index.js",
     "./property-type": "./dist-cms/packages/content/property-type/index.js",
     "./property": "./dist-cms/packages/core/property/index.js",
     "./recycle-bin": "./dist-cms/packages/core/recycle-bin/index.js",
@@ -216,18 +218,26 @@
   "msw": {
     "workerDirectory": "public"
   },
+  "keywords": [
+    "Umbraco",
+    "CMS",
+    "Backoffice",
+    "Content Management System",
+    "Web Components",
+    "Extensions"
+  ],
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
   "peerDependencies": {
     "element-internals-polyfill": "^3.0.2",
-    "dompurify": "^3.2.7",
+    "dompurify": "^3.3.0",
     "@heximal/expressions": "^0.1.5",
     "lit": "^3.3.1",
     "luxon": "^3.7.2",
     "marked": "^17.0.1",
-    "monaco-editor": "^0.54.0",
+    "monaco-editor": "^0.55.1",
     "rxjs": "^7.8.2",
     "@microsoft/signalr": "^10.0.0",
     "@umbraco-ui/uui": "^1.16.0",

package/dist-cms/apps/preview/apps/manifests.d.ts

@@ -1,2 +0,0 @@
-import type { ManifestPreviewAppProvider } from '../../../packages/core/extension-registry/index.js';
-export declare const manifests: Array<ManifestPreviewAppProvider>;

package/dist-cms/packages/block/block-grid/property-editors/block-grid-editor/property-actions/manifests.js

@@ -1,18 +0,0 @@
-import { UMB_BLOCK_GRID_PROPERTY_EDITOR_UI_ALIAS } from '../constants.js';
-import { UMB_WRITABLE_PROPERTY_CONDITION_ALIAS } from '../../../../../core/property/index.js';
-import { UMB_PROPERTY_ACTION_PASTE_FROM_CLIPBOARD_KIND_MANIFEST } from '../../../../../clipboard/index.js';
-export const manifests = [
-    {
-        ...UMB_PROPERTY_ACTION_PASTE_FROM_CLIPBOARD_KIND_MANIFEST.manifest,
-        type: 'propertyAction',
-        alias: 'Umb.PropertyAction.BlockGrid.Clipboard.Paste',
-        name: 'Block Grid Paste From Clipboard Property Action',
-        api: () => import('./block-grid-paste-from-clipboard.js'),
-        forPropertyEditorUis: [UMB_BLOCK_GRID_PROPERTY_EDITOR_UI_ALIAS],
-        conditions: [
-            {
-                alias: UMB_WRITABLE_PROPERTY_CONDITION_ALIAS,
-            },
-        ],
-    },
-];

package/dist-cms/packages/members/member-type/tree/member-type-tree.server.data-source.d.ts

@@ -1,17 +0,0 @@
-import type { UmbMemberTypeTreeItemModel } from './types.js';
-import { UmbTreeServerDataSourceBase } from '../../../core/tree/index.js';
-import type { MemberTypeTreeItemResponseModel } from '../../../core/backend-api/index.js';
-import type { UmbControllerHost } from '../../../../libs/controller-api/index.js';
-/**
- * A data source for the MemberType tree that fetches data from the server
- * @class UmbMemberTypeTreeServerDataSource
- * @implements {UmbTreeDataSource}
- */
-export declare class UmbMemberTypeTreeServerDataSource extends UmbTreeServerDataSourceBase<MemberTypeTreeItemResponseModel, UmbMemberTypeTreeItemModel> {
-    /**
-     * Creates an instance of UmbMemberTypeTreeServerDataSource.
-     * @param {UmbControllerHost} host - The controller host for this controller to be appended to
-     * @memberof UmbMemberTypeTreeServerDataSource
-     */
-    constructor(host: UmbControllerHost);
-}

package/dist-cms/packages/members/member-type/tree/member-type-tree.server.data-source.js

@@ -1,51 +0,0 @@
-import { UMB_MEMBER_TYPE_ENTITY_TYPE, UMB_MEMBER_TYPE_ROOT_ENTITY_TYPE } from '../entity.js';
-import { UmbTreeServerDataSourceBase } from '../../../core/tree/index.js';
-import { MemberTypeService } from '../../../core/backend-api/index.js';
-/**
- * A data source for the MemberType tree that fetches data from the server
- * @class UmbMemberTypeTreeServerDataSource
- * @implements {UmbTreeDataSource}
- */
-export class UmbMemberTypeTreeServerDataSource extends UmbTreeServerDataSourceBase {
-    /**
-     * Creates an instance of UmbMemberTypeTreeServerDataSource.
-     * @param {UmbControllerHost} host - The controller host for this controller to be appended to
-     * @memberof UmbMemberTypeTreeServerDataSource
-     */
-    constructor(host) {
-        super(host, {
-            getRootItems,
-            getChildrenOf,
-            getAncestorsOf,
-            mapper,
-        });
-    }
-}
-const getRootItems = (args) => 
-// eslint-disable-next-line local-rules/no-direct-api-import
-MemberTypeService.getTreeMemberTypeRoot({ query: { skip: args.skip, take: args.take } });
-const getChildrenOf = (args) => {
-    if (args.parent.unique === null) {
-        return getRootItems(args);
-    }
-    else {
-        throw new Error('Not supported for the member type tree');
-    }
-};
-const getAncestorsOf = () => {
-    throw new Error('Not supported for the member type tree');
-};
-const mapper = (item) => {
-    return {
-        unique: item.id,
-        parent: {
-            unique: item.parent ? item.parent.id : null,
-            entityType: item.parent ? UMB_MEMBER_TYPE_ENTITY_TYPE : UMB_MEMBER_TYPE_ROOT_ENTITY_TYPE,
-        },
-        name: item.name,
-        entityType: UMB_MEMBER_TYPE_ENTITY_TYPE,
-        hasChildren: item.hasChildren,
-        isFolder: false,
-        icon: item.icon,
-    };
-};

package/dist-cms/packages/members/member-type/tree/tree-item-children/reload-entity-action/manifests.js

@@ -1,10 +0,0 @@
-import { UMB_MEMBER_TYPE_ROOT_ENTITY_TYPE } from '../../../entity.js';
-export const manifests = [
-    {
-        type: 'entityAction',
-        kind: 'reloadTreeItemChildren',
-        alias: 'Umb.EntityAction.MemberType.Tree.ReloadChildrenOf',
-        name: 'Reload Member Type Tree Item Children Entity Action',
-        forEntityTypes: [UMB_MEMBER_TYPE_ROOT_ENTITY_TYPE],
-    },
-];

package/dist-cms/packages/sysinfo/components/new-version.element.d.ts

@@ -1,13 +0,0 @@
-import type { UmbNewVersionModalData } from '../modals/new-version-modal.token.js';
-import { UmbModalBaseElement } from '../../core/modal/index.js';
-export declare class UmbNewVersionElement extends UmbModalBaseElement<UmbNewVersionModalData> {
-    private _serverUpgradeCheck;
-    render(): import("lit-html").TemplateResult<1>;
-    static readonly styles: import("lit").CSSResult[];
-}
-export default UmbNewVersionElement;
-declare global {
-    interface HTMLElementTagNameMap {
-        'umb-new-version': UmbNewVersionElement;
-    }
-}

package/dist-cms/packages/sysinfo/components/new-version.element.js

@@ -1,59 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-import { css, customElement, html, state } from '../../../external/lit/index.js';
-import { UmbTextStyles } from '../../core/style/index.js';
-import { UmbModalBaseElement } from '../../core/modal/index.js';
-let UmbNewVersionElement = class UmbNewVersionElement extends UmbModalBaseElement {
-    constructor() {
-        super(...arguments);
-        this._serverUpgradeCheck = null;
-    }
-    render() {
-        return html `
-			<uui-dialog>
-				<uui-dialog-layout headline=${this.localize.term('general_newVersionAvailable')}>
-					${this.data?.comment}
-
-					<uui-button
-						@click=${this._submitModal}
-						slot="actions"
-						look="secondary"
-						label=${this.localize.term('general_close')}></uui-button>
-
-					${this.data?.downloadUrl
-            ? html ` <uui-button
-								.href=${this.data.downloadUrl}
-								target="_blank"
-								slot="actions"
-								look="primary"
-								color="positive"
-								label=${this.localize.term('general_readMore')}>
-								<umb-localize key="general_readMore">Read more</umb-localize>
-								<umb-icon slot="extra" name="icon-out"></umb-icon>
-							</uui-button>`
-            : ''}
-				</uui-dialog-layout>
-			</uui-dialog>
-		`;
-    }
-    static { this.styles = [
-        UmbTextStyles,
-        css `
-			umb-icon {
-				margin-left: var(--uui-size-2);
-			}
-		`,
-    ]; }
-};
-__decorate([
-    state()
-], UmbNewVersionElement.prototype, "_serverUpgradeCheck", void 0);
-UmbNewVersionElement = __decorate([
-    customElement('umb-new-version')
-], UmbNewVersionElement);
-export { UmbNewVersionElement };
-export default UmbNewVersionElement;

package/dist-cms/packages/sysinfo/modals/new-version-modal.token.d.ts

@@ -1,12 +0,0 @@
-import { UmbModalToken } from '../../core/modal/index.js';
-export interface UmbNewVersionModalData {
-    /**
-     * The release notes of the new version.
-     */
-    comment: string;
-    /**
-     * The download URL of the new version.
-     */
-    downloadUrl: string;
-}
-export declare const UMB_NEWVERSION_MODAL: UmbModalToken<UmbNewVersionModalData, unknown>;

package/dist-cms/packages/sysinfo/modals/new-version-modal.token.js

@@ -1,7 +0,0 @@
-import { UmbModalToken } from '../../core/modal/index.js';
-export const UMB_NEWVERSION_MODAL = new UmbModalToken('Umb.Modal.NewVersion', {
-    modal: {
-        type: 'dialog',
-        size: 'medium',
-    },
-});

package/examples/collection/collection/card-view/collection-view.element.ts

@@ -1,82 +0,0 @@
-import type { ExampleCollectionItemModel } from '../repository/types.js';
-import type { UmbDefaultCollectionContext } from '@umbraco-cms/backoffice/collection';
-import { UMB_COLLECTION_CONTEXT } from '@umbraco-cms/backoffice/collection';
-import { css, html, customElement, state, repeat } from '@umbraco-cms/backoffice/external/lit';
-import { UmbTextStyles } from '@umbraco-cms/backoffice/style';
-import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
-
-@customElement('example-card-collection-view')
-export class ExampleCardCollectionViewElement extends UmbLitElement {
-	@state()
-	private _items: Array<ExampleCollectionItemModel> = [];
-
-	#collectionContext?: UmbDefaultCollectionContext<ExampleCollectionItemModel>;
-
-	constructor() {
-		super();
-
-		this.consumeContext(UMB_COLLECTION_CONTEXT, (instance) => {
-			this.#collectionContext = instance;
-			this.#observeCollectionItems();
-		});
-	}
-
-	#observeCollectionItems() {
-		this.observe(this.#collectionContext?.items, (items) => (this._items = items || []), 'umbCollectionItemsObserver');
-	}
-
-	override render() {
-		return html`
-			<div id="card-grid">
-				${repeat(
-					this._items,
-					(item) => item.unique,
-					(item) =>
-						html` <uui-card>
-							<uui-icon name="icon-newspaper"></uui-icon>
-							<div>${item.name}</div>
-						</uui-card>`,
-				)}
-			</div>
-		`;
-	}
-
-	static override styles = [
-		UmbTextStyles,
-		css`
-			:host {
-				display: flex;
-				flex-direction: column;
-			}
-
-			#card-grid {
-				display: grid;
-				grid-template-columns: repeat(auto-fill, minmax(200px, 1fr));
-				grid-auto-rows: 200px;
-				gap: var(--uui-size-space-5);
-			}
-
-			uui-card {
-				display: flex;
-				flex-direction: column;
-				align-items: center;
-				justify-content: center;
-				text-align: center;
-				height: 100%;
-
-				uui-icon {
-					font-size: 2em;
-					margin-bottom: var(--uui-size-space-4);
-				}
-			}
-		`,
-	];
-}
-
-export { ExampleCardCollectionViewElement as element };
-
-declare global {
-	interface HTMLElementTagNameMap {
-		'example-card-collection-view': ExampleCardCollectionViewElement;
-	}
-}

package/examples/entity-content-type-condition/workspace-view.element.ts

@@ -1,19 +0,0 @@
-import { html, customElement } from '@umbraco-cms/backoffice/external/lit';
-import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
-
-@customElement('umb-example-entity-content-type-condition')
-export class UmbWorkspaceExampleViewElement extends UmbLitElement {
-	override render() {
-		return html`<p>
-			This is a conditional element that is only shown in workspaces based on it's entities content type.
-		</p>`;
-	}
-}
-
-export default UmbWorkspaceExampleViewElement;
-
-declare global {
-	interface HTMLElementTagNameMap {
-		'umb-example-entity-content-type-condition': UmbWorkspaceExampleViewElement;
-	}
-}