From 31481c9bca14750b79e414b08414cd454227444e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niels=20Lyngs=C3=B8?= Date: Fri, 2 Aug 2024 14:44:20 +0200 Subject: [PATCH 01/16] poc custom view guide --- .../src/assets/lang/en-us.ts | 1 + .../src/assets/lang/en.ts | 1 + ...id-type-workspace-view-advanced.element.ts | 10 ++ .../block-type-custom-view-guide.element.ts | 103 ++++++++++++++++++ .../block/block-type/components/index.ts | 1 + .../src/packages/block/block-type/index.ts | 1 + .../packages/block/block-type/manifests.ts | 3 +- .../manifests.ts | 13 --- ...-block-type-group-configuration.element.ts | 34 ------ ...-block-type-group-configuration.stories.ts | 19 ---- ...-ui-block-type-group-configuration.test.ts | 23 ---- .../block-type/property-editors/manifests.ts | 4 - .../block/block-type/workspace/index.ts | 1 + 13 files changed, 119 insertions(+), 95 deletions(-) create mode 100644 src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts delete mode 100644 src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/block-type-group-configuration/manifests.ts delete mode 100644 src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/block-type-group-configuration/property-editor-ui-block-type-group-configuration.element.ts delete mode 100644 src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/block-type-group-configuration/property-editor-ui-block-type-group-configuration.stories.ts delete mode 100644 src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/block-type-group-configuration/property-editor-ui-block-type-group-configuration.test.ts delete mode 100644 src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/manifests.ts create mode 100644 src/Umbraco.Web.UI.Client/src/packages/block/block-type/workspace/index.ts diff --git a/src/Umbraco.Web.UI.Client/src/assets/lang/en-us.ts b/src/Umbraco.Web.UI.Client/src/assets/lang/en-us.ts index c74158ac83..a6468f4f6c 100644 --- a/src/Umbraco.Web.UI.Client/src/assets/lang/en-us.ts +++ b/src/Umbraco.Web.UI.Client/src/assets/lang/en-us.ts @@ -2403,6 +2403,7 @@ export default { tabClipboard: 'Clipboard', tabBlockSettings: 'Settings', headlineAdvanced: 'Advanced', + headlineCustomView: 'Custom View', forceHideContentEditor: 'Hide content editor', forceHideContentEditorHelp: 'Hide the content edit button and the content editor from the Block Editor overlay', gridInlineEditing: 'Inline editing', diff --git a/src/Umbraco.Web.UI.Client/src/assets/lang/en.ts b/src/Umbraco.Web.UI.Client/src/assets/lang/en.ts index 7e0e77d5cd..f1b6833566 100644 --- a/src/Umbraco.Web.UI.Client/src/assets/lang/en.ts +++ b/src/Umbraco.Web.UI.Client/src/assets/lang/en.ts @@ -2470,6 +2470,7 @@ export default { tabClipboard: 'Clipboard', tabBlockSettings: 'Settings', headlineAdvanced: 'Advanced', + headlineCustomView: 'Custom View', forceHideContentEditor: 'Hide content editor', forceHideContentEditorHelp: 'Hide the content edit button and the content editor from the Block Editor overlay.', gridInlineEditing: 'Inline editing', diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/workspace/views/block-grid-type-workspace-view-advanced.element.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/workspace/views/block-grid-type-workspace-view-advanced.element.ts index d34cf5d569..b107595f8e 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/workspace/views/block-grid-type-workspace-view-advanced.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/workspace/views/block-grid-type-workspace-view-advanced.element.ts @@ -1,7 +1,10 @@ +import { UMB_BLOCK_GRID } from '../../types.js'; import { css, html, customElement } from '@umbraco-cms/backoffice/external/lit'; import { UmbTextStyles } from '@umbraco-cms/backoffice/style'; import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element'; import type { UmbWorkspaceViewElement } from '@umbraco-cms/backoffice/extension-registry'; +// Getting umb-block-type-custom-view-guide element +import '@umbraco-cms/backoffice/block-type'; @customElement('umb-block-grid-type-workspace-view-advanced') export class UmbBlockGridTypeWorkspaceViewAdvancedElement extends UmbLitElement implements UmbWorkspaceViewElement { @@ -21,6 +24,13 @@ export class UmbBlockGridTypeWorkspaceViewAdvancedElement extends UmbLitElement alias="hideContentEditor" property-editor-ui-alias="Umb.PropertyEditorUi.Toggle"> + + + + + ; + + #repository = new UmbDocumentTypeDetailRepository(this); + + constructor() { + super(); + + this.consumeContext(UMB_PROPERTY_DATASET_CONTEXT, async (context) => { + this.observe( + await context.propertyValueByAlias('contentElementTypeKey'), + async (value) => { + if (!value) return; + const { asObservable } = await this.#repository.requestByUnique(value); + this.observe( + asObservable(), + (model) => { + this.#contentTypeAlias = model?.alias; + this.#loadManifests(); + }, + 'observeContentType', + ); + }, + 'observeContentElementTypeKey', + ); + }); + } + + #loadManifests() { + console.log('this.#blockEditorType', this.#blockEditorType, 'this.#contentTypeAlias', this.#contentTypeAlias); + if (!this.#blockEditorType || !this.#contentTypeAlias) return; + new UmbExtensionsManifestInitializer( + this, + umbExtensionsRegistry, + 'blockEditorCustomView', + this.#extensionFilterMethod, + async (customViews) => { + this._manifests = customViews.map((x) => x.manifest); + }, + 'manifestInitializer', + ); + } + + #extensionFilterMethod = (manifest: ManifestBlockEditorCustomView) => { + if (!this.#blockEditorType || !this.#contentTypeAlias) return false; + if ( + manifest.forContentTypeAlias && + !stringOrStringArrayContains(manifest.forContentTypeAlias, this.#contentTypeAlias!) + ) { + return false; + } + if (manifest.forBlockEditor && !stringOrStringArrayContains(manifest.forBlockEditor, this.#blockEditorType)) { + return false; + } + return true; + }; + + override render() { + return this._manifests && this._manifests.length > 0 + ? html`
+ ${repeat( + this._manifests, + (x) => x.alias, + (x) => html` + + + `, + )} +
` + : html`No custom view matches the current block editor type and content type.`; + } +} + +export default UmbBlockTypeCustomViewGuideElement; + +declare global { + interface HTMLElementTagNameMap { + 'umb-block-type-custom-view-guide': UmbBlockTypeCustomViewGuideElement; + } +} diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/index.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/index.ts index 2ce6e9bff7..f04aaabb29 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/index.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/index.ts @@ -1,2 +1,3 @@ export * from './block-type-card/index.js'; export * from './input-block-type/index.js'; +export * from './block-type-custom-view-guide/block-type-custom-view-guide.element.js'; diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/index.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/index.ts index d07544f196..814adba5f3 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/index.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/index.ts @@ -1,2 +1,3 @@ export * from './components/index.js'; export * from './types.js'; +export * from './workspace/index.js'; diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/manifests.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/manifests.ts index c3415bb2c0..71c165c901 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/manifests.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/manifests.ts @@ -1,5 +1,4 @@ import { manifests as workspaceManifests } from './workspace/manifests.js'; -import { manifests as propertyEditorManifests } from './property-editors/manifests.js'; import type { ManifestTypes } from '@umbraco-cms/backoffice/extension-registry'; -export const manifests: Array = [...workspaceManifests, ...propertyEditorManifests]; +export const manifests: Array = [...workspaceManifests]; diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/block-type-group-configuration/manifests.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/block-type-group-configuration/manifests.ts deleted file mode 100644 index 8160246fa7..0000000000 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/block-type-group-configuration/manifests.ts +++ /dev/null @@ -1,13 +0,0 @@ -import type { ManifestPropertyEditorUi } from '@umbraco-cms/backoffice/extension-registry'; - -export const manifest: ManifestPropertyEditorUi = { - type: 'propertyEditorUi', - alias: 'BlockTypeGroupConfiguration', - name: 'Block Group Configuration Property Editor UI', - js: () => import('./property-editor-ui-block-type-group-configuration.element.js'), - meta: { - label: 'Block Grid Group Configuration', - icon: 'icon-autofill', - group: 'blocks', - }, -}; diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/block-type-group-configuration/property-editor-ui-block-type-group-configuration.element.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/block-type-group-configuration/property-editor-ui-block-type-group-configuration.element.ts deleted file mode 100644 index 29b6c04770..0000000000 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/block-type-group-configuration/property-editor-ui-block-type-group-configuration.element.ts +++ /dev/null @@ -1,34 +0,0 @@ -import type { UmbPropertyEditorUiElement } from '@umbraco-cms/backoffice/extension-registry'; -import { html, customElement, property } from '@umbraco-cms/backoffice/external/lit'; -import type { UmbPropertyEditorConfigCollection } from '@umbraco-cms/backoffice/property-editor'; -import { UmbTextStyles } from '@umbraco-cms/backoffice/style'; -import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element'; - -/** - * @element umb-property-editor-ui-block-type-group-configuration - */ -@customElement('umb-property-editor-ui-block-type-group-configuration') -export class UmbPropertyEditorUIBlockGridGroupConfigurationElement - extends UmbLitElement - implements UmbPropertyEditorUiElement -{ - @property() - value = ''; - - @property({ type: Object, attribute: false }) - public config?: UmbPropertyEditorConfigCollection; - - override render() { - return html`
umb-property-editor-ui-block-type-group-configuration
`; - } - - static override styles = [UmbTextStyles]; -} - -export default UmbPropertyEditorUIBlockGridGroupConfigurationElement; - -declare global { - interface HTMLElementTagNameMap { - 'umb-property-editor-ui-block-type-group-configuration': UmbPropertyEditorUIBlockGridGroupConfigurationElement; - } -} diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/block-type-group-configuration/property-editor-ui-block-type-group-configuration.stories.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/block-type-group-configuration/property-editor-ui-block-type-group-configuration.stories.ts deleted file mode 100644 index 97b1de48e0..0000000000 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/block-type-group-configuration/property-editor-ui-block-type-group-configuration.stories.ts +++ /dev/null @@ -1,19 +0,0 @@ -import type { UmbPropertyEditorUIBlockGridGroupConfigurationElement } from './property-editor-ui-block-type-group-configuration.element.js'; -import type { Meta, StoryObj } from '@storybook/web-components'; -import { html } from '@umbraco-cms/backoffice/external/lit'; - -import './property-editor-ui-block-type-group-configuration.element.js'; - -const meta: Meta = { - title: 'Property Editor UIs/Block Grid Group Configuration', - component: 'umb-property-editor-ui-block-type-group-configuration', - id: 'umb-property-editor-ui-block-type-group-configuration', -}; - -export default meta; -type Story = StoryObj; - -export const Overview: Story = { - render: () => - html``, -}; diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/block-type-group-configuration/property-editor-ui-block-type-group-configuration.test.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/block-type-group-configuration/property-editor-ui-block-type-group-configuration.test.ts deleted file mode 100644 index ba1f28624b..0000000000 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/block-type-group-configuration/property-editor-ui-block-type-group-configuration.test.ts +++ /dev/null @@ -1,23 +0,0 @@ -import { UmbPropertyEditorUIBlockGridGroupConfigurationElement } from './property-editor-ui-block-type-group-configuration.element.js'; -import { expect, fixture, html } from '@open-wc/testing'; -import { type UmbTestRunnerWindow, defaultA11yConfig } from '@umbraco-cms/internal/test-utils'; - -describe('UmbPropertyEditorUIBlockGridGroupConfigurationElement', () => { - let element: UmbPropertyEditorUIBlockGridGroupConfigurationElement; - - beforeEach(async () => { - element = await fixture(html` - - `); - }); - - it('is defined with its own instance', () => { - expect(element).to.be.instanceOf(UmbPropertyEditorUIBlockGridGroupConfigurationElement); - }); - - if ((window as UmbTestRunnerWindow).__UMBRACO_TEST_RUN_A11Y_TEST) { - it('passes the a11y audit', async () => { - await expect(element).shadowDom.to.be.accessible(defaultA11yConfig); - }); - } -}); diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/manifests.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/manifests.ts deleted file mode 100644 index 971433dd0d..0000000000 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/property-editors/manifests.ts +++ /dev/null @@ -1,4 +0,0 @@ -import { manifest as blockTypeGroupManifest } from './block-type-group-configuration/manifests.js'; -import type { ManifestTypes } from '@umbraco-cms/backoffice/extension-registry'; - -export const manifests: Array = [blockTypeGroupManifest]; diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/workspace/index.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/workspace/index.ts new file mode 100644 index 0000000000..04228760c1 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/workspace/index.ts @@ -0,0 +1 @@ +export * from './block-type-workspace.context-token.js'; From ec773bca7d0115317e0adcf45eb9c6b332a37c94 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niels=20Lyngs=C3=B8?= Date: Fri, 2 Aug 2024 22:05:42 +0200 Subject: [PATCH 02/16] umb-ref-manifest + icons --- src/Umbraco.Web.UI.Client/package-lock.json | 8 +-- src/Umbraco.Web.UI.Client/package.json | 2 +- .../block-type-custom-view-guide.element.ts | 6 +-- .../extension-registry/components/index.ts | 1 + .../ref-manifest/ref-manifest.element.ts | 52 +++++++++++++++++++ .../core/icon-registry/icon-dictionary.json | 16 +++--- .../src/packages/core/icon-registry/icons.ts | 4 ++ .../core/icon-registry/icons/icon-activity.ts | 2 +- .../core/icon-registry/icons/icon-add.ts | 2 +- .../icon-registry/icons/icon-addressbook.ts | 2 +- .../icon-registry/icons/icon-alarm-clock.ts | 2 +- .../icon-registry/icons/icon-alert-alt.ts | 2 +- .../core/icon-registry/icons/icon-alert.ts | 2 +- .../core/icon-registry/icons/icon-alt.ts | 2 +- .../core/icon-registry/icons/icon-anchor.ts | 2 +- .../core/icon-registry/icons/icon-app.ts | 2 +- .../icons/icon-application-error.ts | 2 +- .../icons/icon-application-window-alt.ts | 2 +- .../icons/icon-application-window.ts | 2 +- .../core/icon-registry/icons/icon-arrivals.ts | 2 +- .../icon-registry/icons/icon-arrow-down.ts | 2 +- .../icon-registry/icons/icon-arrow-left.ts | 2 +- .../icon-registry/icons/icon-arrow-right.ts | 2 +- .../core/icon-registry/icons/icon-arrow-up.ts | 2 +- .../icon-registry/icons/icon-attachment.ts | 2 +- .../core/icon-registry/icons/icon-autofill.ts | 2 +- .../core/icon-registry/icons/icon-award.ts | 2 +- .../icons/icon-axis-rotation-2.ts | 2 +- .../icons/icon-axis-rotation-3.ts | 2 +- .../icon-registry/icons/icon-axis-rotation.ts | 2 +- .../icon-registry/icons/icon-backspace.ts | 2 +- .../icon-registry/icons/icon-badge-add.ts | 2 +- .../icon-registry/icons/icon-badge-remove.ts | 2 +- .../icons/icon-badge-restricted.ts | 2 +- .../core/icon-registry/icons/icon-ball.ts | 2 +- .../icon-registry/icons/icon-bar-chart.ts | 4 +- .../core/icon-registry/icons/icon-barcode.ts | 2 +- .../core/icon-registry/icons/icon-bars.ts | 4 +- .../icon-registry/icons/icon-battery-full.ts | 2 +- .../icon-registry/icons/icon-battery-low.ts | 2 +- .../icon-registry/icons/icon-beer-glass.ts | 2 +- .../core/icon-registry/icons/icon-bell-off.ts | 2 +- .../core/icon-registry/icons/icon-bell.ts | 2 +- .../icon-registry/icons/icon-binarycode.ts | 2 +- .../core/icon-registry/icons/icon-bird.ts | 2 +- .../icon-registry/icons/icon-birthday-cake.ts | 2 +- .../core/icon-registry/icons/icon-block.ts | 2 +- .../icon-registry/icons/icon-bluetooth.ts | 2 +- .../icon-registry/icons/icon-boat-shipping.ts | 2 +- .../core/icon-registry/icons/icon-bones.ts | 2 +- .../icon-registry/icons/icon-book-alt-2.ts | 2 +- .../core/icon-registry/icons/icon-book-alt.ts | 2 +- .../core/icon-registry/icons/icon-book.ts | 2 +- .../core/icon-registry/icons/icon-bookmark.ts | 2 +- .../core/icon-registry/icons/icon-books.ts | 2 +- .../core/icon-registry/icons/icon-box-alt.ts | 2 +- .../core/icon-registry/icons/icon-box-open.ts | 2 +- .../core/icon-registry/icons/icon-box.ts | 2 +- .../core/icon-registry/icons/icon-brackets.ts | 2 +- .../core/icon-registry/icons/icon-brick.ts | 2 +- .../icon-registry/icons/icon-briefcase.ts | 2 +- .../icons/icon-browser-window.ts | 2 +- .../icon-registry/icons/icon-brush-alt-2.ts | 2 +- .../icon-registry/icons/icon-brush-alt.ts | 2 +- .../core/icon-registry/icons/icon-brush.ts | 2 +- .../core/icon-registry/icons/icon-bug.ts | 2 +- .../icon-registry/icons/icon-bulleted-list.ts | 2 +- .../core/icon-registry/icons/icon-burn.ts | 2 +- .../core/icon-registry/icons/icon-bus.ts | 2 +- .../icon-registry/icons/icon-calculator.ts | 2 +- .../icon-registry/icons/icon-calendar-alt.ts | 2 +- .../core/icon-registry/icons/icon-calendar.ts | 2 +- .../icon-registry/icons/icon-camcorder.ts | 2 +- .../icon-registry/icons/icon-camera-roll.ts | 2 +- .../core/icon-registry/icons/icon-candy.ts | 2 +- .../icon-registry/icons/icon-caps-lock.ts | 2 +- .../core/icon-registry/icons/icon-car.ts | 2 +- .../icon-registry/icons/icon-categories.ts | 2 +- .../icon-registry/icons/icon-certificate.ts | 2 +- .../icon-registry/icons/icon-chart-curve.ts | 12 +++-- .../core/icon-registry/icons/icon-chart.ts | 6 +-- .../icon-registry/icons/icon-chat-active.ts | 2 +- .../core/icon-registry/icons/icon-chat.ts | 2 +- .../core/icon-registry/icons/icon-check.ts | 2 +- .../icons/icon-checkbox-dotted.ts | 2 +- .../icons/icon-checkbox-empty.ts | 2 +- .../core/icon-registry/icons/icon-checkbox.ts | 2 +- .../core/icon-registry/icons/icon-chip-alt.ts | 2 +- .../core/icon-registry/icons/icon-chip.ts | 2 +- .../core/icon-registry/icons/icon-cinema.ts | 2 +- .../icons/icon-circle-dotted-active.ts | 2 +- .../icon-registry/icons/icon-circle-dotted.ts | 2 +- .../core/icon-registry/icons/icon-circuits.ts | 2 +- .../core/icon-registry/icons/icon-client.ts | 2 +- .../icon-registry/icons/icon-cloud-drive.ts | 2 +- .../icon-registry/icons/icon-cloud-upload.ts | 6 +-- .../core/icon-registry/icons/icon-cloud.ts | 2 +- .../core/icon-registry/icons/icon-cloudy.ts | 2 +- .../core/icon-registry/icons/icon-clubs.ts | 2 +- .../core/icon-registry/icons/icon-cocktail.ts | 2 +- .../core/icon-registry/icons/icon-code.ts | 2 +- .../core/icon-registry/icons/icon-coffee.ts | 2 +- .../icon-registry/icons/icon-coin-dollar.ts | 2 +- .../icon-registry/icons/icon-coin-euro.ts | 2 +- .../icon-registry/icons/icon-coin-pound.ts | 2 +- .../core/icon-registry/icons/icon-coin-yen.ts | 2 +- .../icon-registry/icons/icon-coins-alt.ts | 2 +- .../core/icon-registry/icons/icon-coins.ts | 2 +- .../icon-registry/icons/icon-color-bucket.ts | 2 +- .../icon-registry/icons/icon-colorpicker.ts | 2 +- .../core/icon-registry/icons/icon-columns.ts | 2 +- .../icons/icon-combination-lock-open.ts | 2 +- .../icons/icon-combination-lock.ts | 2 +- .../core/icon-registry/icons/icon-command.ts | 2 +- .../core/icon-registry/icons/icon-company.ts | 2 +- .../core/icon-registry/icons/icon-compress.ts | 2 +- .../icon-registry/icons/icon-connection.ts | 2 +- .../core/icon-registry/icons/icon-console.ts | 2 +- .../core/icon-registry/icons/icon-contrast.ts | 2 +- .../icons/icon-conversation-alt.ts | 2 +- .../icon-registry/icons/icon-conversation.ts | 2 +- .../icon-registry/icons/icon-coverflow.ts | 2 +- .../icons/icon-credit-card-alt.ts | 2 +- .../icon-registry/icons/icon-credit-card.ts | 2 +- .../core/icon-registry/icons/icon-crop.ts | 2 +- .../icon-registry/icons/icon-crosshair.ts | 2 +- .../icon-registry/icons/icon-crown-alt.ts | 2 +- .../core/icon-registry/icons/icon-crown.ts | 2 +- .../core/icon-registry/icons/icon-cupcake.ts | 2 +- .../core/icon-registry/icons/icon-curve.ts | 2 +- .../core/icon-registry/icons/icon-cut.ts | 2 +- .../icon-registry/icons/icon-dashboard.ts | 2 +- .../core/icon-registry/icons/icon-database.ts | 2 +- .../core/icon-registry/icons/icon-defrag.ts | 6 +-- .../icon-registry/icons/icon-delete-key.ts | 2 +- .../core/icon-registry/icons/icon-delete.ts | 2 +- .../icon-registry/icons/icon-departure.ts | 2 +- .../core/icon-registry/icons/icon-desktop.ts | 2 +- .../icon-registry/icons/icon-diagnostics.ts | 2 +- .../icons/icon-diagonal-arrow-alt.ts | 2 +- .../icons/icon-diagonal-arrow.ts | 2 +- .../core/icon-registry/icons/icon-diamond.ts | 2 +- .../core/icon-registry/icons/icon-diamonds.ts | 2 +- .../core/icon-registry/icons/icon-dice.ts | 2 +- .../icon-registry/icons/icon-diploma-alt.ts | 2 +- .../core/icon-registry/icons/icon-diploma.ts | 2 +- .../icons/icon-directions-alt.ts | 2 +- .../icon-registry/icons/icon-directions.ts | 2 +- .../core/icon-registry/icons/icon-disc.ts | 2 +- .../icon-registry/icons/icon-disk-image.ts | 2 +- .../core/icon-registry/icons/icon-display.ts | 2 +- .../core/icon-registry/icons/icon-dna.ts | 2 +- .../icons/icon-dock-connector.ts | 2 +- .../icons/icon-document-dashed-line.ts | 2 +- .../core/icon-registry/icons/icon-document.ts | 2 +- .../icon-registry/icons/icon-documents.ts | 2 +- .../core/icon-registry/icons/icon-donate.ts | 2 +- .../icon-registry/icons/icon-door-open-alt.ts | 2 +- .../icon-registry/icons/icon-door-open.ts | 2 +- .../icon-registry/icons/icon-download-alt.ts | 2 +- .../core/icon-registry/icons/icon-download.ts | 2 +- .../core/icon-registry/icons/icon-drop.ts | 2 +- .../core/icon-registry/icons/icon-eco.ts | 2 +- .../core/icon-registry/icons/icon-economy.ts | 2 +- .../core/icon-registry/icons/icon-edit.ts | 2 +- .../core/icon-registry/icons/icon-employee.ts | 2 +- .../icons/icon-energy-saving-bulb.ts | 2 +- .../core/icon-registry/icons/icon-enter.ts | 2 +- .../icon-registry/icons/icon-equalizer.ts | 2 +- .../core/icon-registry/icons/icon-escape.ts | 2 +- .../core/icon-registry/icons/icon-ethernet.ts | 2 +- .../icons/icon-exit-fullscreen.ts | 2 +- .../core/icon-registry/icons/icon-eye.ts | 4 +- .../icon-registry/icons/icon-facebook-like.ts | 2 +- .../core/icon-registry/icons/icon-factory.ts | 2 +- .../core/icon-registry/icons/icon-favorite.ts | 2 +- .../icon-registry/icons/icon-file-cabinet.ts | 2 +- .../core/icon-registry/icons/icon-files.ts | 2 +- .../icon-registry/icons/icon-filter-arrows.ts | 2 +- .../core/icon-registry/icons/icon-filter.ts | 2 +- .../icon-registry/icons/icon-fingerprint.ts | 2 +- .../core/icon-registry/icons/icon-fire.ts | 2 +- .../core/icon-registry/icons/icon-firewire.ts | 2 +- .../core/icon-registry/icons/icon-flag-alt.ts | 2 +- .../core/icon-registry/icons/icon-flag.ts | 2 +- .../core/icon-registry/icons/icon-flash.ts | 2 +- .../icon-registry/icons/icon-flashlight.ts | 2 +- .../icon-registry/icons/icon-flowerpot.ts | 2 +- .../core/icon-registry/icons/icon-folder.ts | 2 +- .../core/icon-registry/icons/icon-folders.ts | 2 +- .../core/icon-registry/icons/icon-font.ts | 2 +- .../core/icon-registry/icons/icon-food.ts | 2 +- .../icon-registry/icons/icon-footprints.ts | 2 +- .../core/icon-registry/icons/icon-forking.ts | 2 +- .../icon-registry/icons/icon-frame-alt.ts | 2 +- .../core/icon-registry/icons/icon-frame.ts | 2 +- .../icons/icon-fullscreen-alt.ts | 2 +- .../icon-registry/icons/icon-fullscreen.ts | 2 +- .../core/icon-registry/icons/icon-game.ts | 2 +- .../core/icon-registry/icons/icon-geometry.ts | 2 +- .../core/icon-registry/icons/icon-gift.ts | 2 +- .../core/icon-registry/icons/icon-glasses.ts | 2 +- .../icon-registry/icons/icon-globe-alt.ts | 2 +- .../icon-registry/icons/icon-globe-asia.ts | 2 +- .../icons/icon-globe-europe-africa.ts | 2 +- .../icons/icon-globe-inverted-america.ts | 2 +- .../icons/icon-globe-inverted-asia.ts | 2 +- .../icon-globe-inverted-europe-africa.ts | 2 +- .../core/icon-registry/icons/icon-globe.ts | 2 +- .../core/icon-registry/icons/icon-gps.ts | 2 +- .../core/icon-registry/icons/icon-graduate.ts | 2 +- .../core/icon-registry/icons/icon-grid.ts | 2 +- .../core/icon-registry/icons/icon-hammer.ts | 2 +- .../icons/icon-hand-active-alt.ts | 2 +- .../icon-registry/icons/icon-hand-active.ts | 2 +- .../icons/icon-hand-pointer-alt.ts | 2 +- .../icon-registry/icons/icon-hand-pointer.ts | 2 +- .../icon-registry/icons/icon-handshake.ts | 2 +- .../icon-registry/icons/icon-handtool-alt.ts | 2 +- .../core/icon-registry/icons/icon-handtool.ts | 2 +- .../icons/icon-hard-drive-alt.ts | 2 +- .../icon-registry/icons/icon-hard-drive.ts | 2 +- .../icon-registry/icons/icon-headphones.ts | 2 +- .../core/icon-registry/icons/icon-headset.ts | 2 +- .../core/icon-registry/icons/icon-hearts.ts | 2 +- .../core/icon-registry/icons/icon-height.ts | 2 +- .../core/icon-registry/icons/icon-help-alt.ts | 2 +- .../core/icon-registry/icons/icon-help.ts | 2 +- .../core/icon-registry/icons/icon-home.ts | 2 +- .../icon-registry/icons/icon-hourglass.ts | 2 +- .../core/icon-registry/icons/icon-imac.ts | 2 +- .../icon-registry/icons/icon-inbox-full.ts | 2 +- .../core/icon-registry/icons/icon-inbox.ts | 2 +- .../core/icon-registry/icons/icon-indent.ts | 2 +- .../core/icon-registry/icons/icon-infinity.ts | 2 +- .../core/icon-registry/icons/icon-info.ts | 2 +- .../core/icon-registry/icons/icon-invoice.ts | 2 +- .../core/icon-registry/icons/icon-ipad.ts | 2 +- .../core/icon-registry/icons/icon-iphone.ts | 2 +- .../icons/icon-item-arrangement.ts | 2 +- .../core/icon-registry/icons/icon-junk.ts | 2 +- .../core/icon-registry/icons/icon-key.ts | 2 +- .../core/icon-registry/icons/icon-keyboard.ts | 2 +- .../core/icon-registry/icons/icon-lab.ts | 2 +- .../core/icon-registry/icons/icon-laptop.ts | 2 +- .../icon-registry/icons/icon-layers-alt.ts | 2 +- .../core/icon-registry/icons/icon-layers.ts | 2 +- .../core/icon-registry/icons/icon-layout.ts | 2 +- .../icons/icon-left-double-arrow.ts | 2 +- .../core/icon-registry/icons/icon-legal.ts | 2 +- .../core/icon-registry/icons/icon-lense.ts | 2 +- .../core/icon-registry/icons/icon-library.ts | 2 +- .../icon-registry/icons/icon-light-down.ts | 2 +- .../core/icon-registry/icons/icon-light-up.ts | 2 +- .../icons/icon-lightbulb-active.ts | 2 +- .../icon-registry/icons/icon-lightbulb.ts | 2 +- .../icon-registry/icons/icon-lightning.ts | 2 +- .../core/icon-registry/icons/icon-link.ts | 2 +- .../core/icon-registry/icons/icon-list.ts | 2 +- .../core/icon-registry/icons/icon-load.ts | 2 +- .../core/icon-registry/icons/icon-loading.ts | 2 +- .../core/icon-registry/icons/icon-locate.ts | 2 +- .../icons/icon-location-near-me.ts | 6 +-- .../icons/icon-location-nearby.ts | 6 +-- .../core/icon-registry/icons/icon-lock.ts | 2 +- .../core/icon-registry/icons/icon-log-out.ts | 2 +- .../core/icon-registry/icons/icon-logout.ts | 2 +- .../core/icon-registry/icons/icon-loupe.ts | 2 +- .../core/icon-registry/icons/icon-magnet.ts | 2 +- .../core/icon-registry/icons/icon-mailbox.ts | 2 +- .../core/icon-registry/icons/icon-map-alt.ts | 2 +- .../icon-registry/icons/icon-map-location.ts | 6 +-- .../icon-registry/icons/icon-map-marker.ts | 4 +- .../core/icon-registry/icons/icon-map.ts | 2 +- .../core/icon-registry/icons/icon-medal.ts | 2 +- .../icons/icon-medical-emergency.ts | 2 +- .../core/icon-registry/icons/icon-medicine.ts | 2 +- .../core/icon-registry/icons/icon-meeting.ts | 2 +- .../icon-registry/icons/icon-megaphone.ts | 2 +- .../core/icon-registry/icons/icon-merge.ts | 2 +- .../icon-registry/icons/icon-message-open.ts | 2 +- .../icons/icon-message-unopened.ts | 2 +- .../core/icon-registry/icons/icon-message.ts | 2 +- .../icon-registry/icons/icon-microscope.ts | 2 +- .../core/icon-registry/icons/icon-mindmap.ts | 2 +- .../core/icon-registry/icons/icon-mobile.ts | 2 +- .../core/icon-registry/icons/icon-mountain.ts | 2 +- .../icon-registry/icons/icon-mouse-cursor.ts | 2 +- .../core/icon-registry/icons/icon-mouse.ts | 2 +- .../icon-registry/icons/icon-movie-alt.ts | 2 +- .../core/icon-registry/icons/icon-movie.ts | 2 +- .../icons/icon-multiple-credit-cards.ts | 2 +- .../icons/icon-multiple-windows.ts | 2 +- .../core/icon-registry/icons/icon-music.ts | 2 +- .../icon-registry/icons/icon-name-badge.ts | 2 +- .../icons/icon-navigation-bottom.ts | 2 +- .../icons/icon-navigation-down.ts | 2 +- .../icons/icon-navigation-first.ts | 2 +- .../icons/icon-navigation-horizontal.ts | 2 +- .../icons/icon-navigation-last.ts | 2 +- .../icons/icon-navigation-left.ts | 2 +- .../icons/icon-navigation-right.ts | 2 +- .../icons/icon-navigation-road.ts | 2 +- .../icons/icon-navigation-top.ts | 2 +- .../icon-registry/icons/icon-navigation-up.ts | 2 +- .../icons/icon-navigation-vertical.ts | 2 +- .../icon-registry/icons/icon-navigation.ts | 2 +- .../icons/icon-navigational-arrow.ts | 2 +- .../icon-registry/icons/icon-network-alt.ts | 2 +- .../icon-registry/icons/icon-newspaper-alt.ts | 2 +- .../icon-registry/icons/icon-newspaper.ts | 2 +- .../icon-registry/icons/icon-next-media.ts | 2 +- .../core/icon-registry/icons/icon-next.ts | 2 +- .../core/icon-registry/icons/icon-nodes.ts | 2 +- .../icon-registry/icons/icon-notepad-alt.ts | 2 +- .../core/icon-registry/icons/icon-notepad.ts | 2 +- .../core/icon-registry/icons/icon-old-key.ts | 2 +- .../icon-registry/icons/icon-old-phone.ts | 2 +- .../core/icon-registry/icons/icon-operator.ts | 2 +- .../icon-registry/icons/icon-ordered-list.ts | 2 +- .../core/icon-registry/icons/icon-out.ts | 2 +- .../core/icon-registry/icons/icon-outbox.ts | 2 +- .../core/icon-registry/icons/icon-outdent.ts | 2 +- .../core/icon-registry/icons/icon-page-add.ts | 2 +- .../icon-registry/icons/icon-page-down.ts | 2 +- .../icon-registry/icons/icon-page-remove.ts | 2 +- .../icons/icon-page-restricted.ts | 2 +- .../core/icon-registry/icons/icon-page-up.ts | 2 +- .../icon-registry/icons/icon-paint-roller.ts | 2 +- .../core/icon-registry/icons/icon-palette.ts | 2 +- .../icon-registry/icons/icon-panel-show.ts | 2 +- .../icon-registry/icons/icon-pannel-close.ts | 2 +- .../icon-registry/icons/icon-paper-bag.ts | 2 +- .../icons/icon-paper-plane-alt.ts | 2 +- .../icon-registry/icons/icon-paper-plane.ts | 2 +- .../icon-registry/icons/icon-partly-cloudy.ts | 2 +- .../core/icon-registry/icons/icon-paste-in.ts | 2 +- .../core/icon-registry/icons/icon-pause.ts | 2 +- .../core/icon-registry/icons/icon-pc.ts | 2 +- .../icon-registry/icons/icon-people-alt-2.ts | 2 +- .../icon-registry/icons/icon-people-alt.ts | 2 +- .../icon-registry/icons/icon-people-female.ts | 2 +- .../core/icon-registry/icons/icon-people.ts | 2 +- .../icon-registry/icons/icon-phone-ring.ts | 2 +- .../core/icon-registry/icons/icon-phone.ts | 2 +- .../icon-registry/icons/icon-photo-album.ts | 2 +- .../core/icon-registry/icons/icon-picture.ts | 2 +- .../icons/icon-pictures-alt-2.ts | 2 +- .../icon-registry/icons/icon-pictures-alt.ts | 2 +- .../core/icon-registry/icons/icon-pictures.ts | 2 +- .../icon-registry/icons/icon-pie-chart.ts | 6 +-- .../icon-registry/icons/icon-piggy-bank.ts | 2 +- .../icon-registry/icons/icon-pin-location.ts | 4 +- .../core/icon-registry/icons/icon-plane.ts | 2 +- .../core/icon-registry/icons/icon-planet.ts | 2 +- .../core/icon-registry/icons/icon-play.ts | 2 +- .../icon-registry/icons/icon-playing-cards.ts | 2 +- .../core/icon-registry/icons/icon-playlist.ts | 2 +- .../core/icon-registry/icons/icon-plugin.ts | 2 +- .../core/icon-registry/icons/icon-podcast.ts | 2 +- .../core/icon-registry/icons/icon-poll.ts | 2 +- .../core/icon-registry/icons/icon-post-it.ts | 2 +- .../icon-registry/icons/icon-power-outlet.ts | 2 +- .../core/icon-registry/icons/icon-power.ts | 2 +- .../icon-registry/icons/icon-presentation.ts | 2 +- .../icons/icon-previous-media.ts | 2 +- .../core/icon-registry/icons/icon-previous.ts | 2 +- .../icon-registry/icons/icon-price-dollar.ts | 2 +- .../icon-registry/icons/icon-price-euro.ts | 2 +- .../icon-registry/icons/icon-price-pound.ts | 2 +- .../icon-registry/icons/icon-price-yen.ts | 2 +- .../core/icon-registry/icons/icon-print.ts | 2 +- .../icon-registry/icons/icon-printer-alt.ts | 2 +- .../icon-registry/icons/icon-projector.ts | 2 +- .../core/icon-registry/icons/icon-pulse.ts | 2 +- .../core/icon-registry/icons/icon-pushpin.ts | 2 +- .../core/icon-registry/icons/icon-qr-code.ts | 2 +- .../core/icon-registry/icons/icon-quote.ts | 2 +- .../icon-registry/icons/icon-radio-alt.ts | 2 +- .../icons/icon-radio-receiver.ts | 2 +- .../core/icon-registry/icons/icon-radio.ts | 2 +- .../core/icon-registry/icons/icon-rain.ts | 2 +- .../core/icon-registry/icons/icon-rate.ts | 2 +- .../core/icon-registry/icons/icon-re-post.ts | 2 +- .../core/icon-registry/icons/icon-readonly.ts | 2 +- .../icon-registry/icons/icon-receipt-alt.ts | 2 +- .../icon-registry/icons/icon-reception.ts | 2 +- .../core/icon-registry/icons/icon-record.ts | 2 +- .../icons/icon-rectangle-ellipsis.ts | 2 +- .../core/icon-registry/icons/icon-redo.ts | 2 +- .../core/icon-registry/icons/icon-refresh.ts | 2 +- .../core/icon-registry/icons/icon-remote.ts | 2 +- .../core/icon-registry/icons/icon-remove.ts | 2 +- .../icon-registry/icons/icon-repeat-one.ts | 2 +- .../core/icon-registry/icons/icon-repeat.ts | 2 +- .../icon-registry/icons/icon-reply-arrow.ts | 2 +- .../core/icon-registry/icons/icon-resize.ts | 2 +- .../icon-registry/icons/icon-return-to-top.ts | 2 +- .../icons/icon-right-double-arrow.ts | 2 +- .../core/icon-registry/icons/icon-roadsign.ts | 2 +- .../core/icon-registry/icons/icon-rocket.ts | 2 +- .../core/icon-registry/icons/icon-rss.ts | 2 +- .../icon-registry/icons/icon-ruler-alt.ts | 2 +- .../core/icon-registry/icons/icon-ruler.ts | 2 +- .../icons/icon-satellite-dish.ts | 2 +- .../core/icon-registry/icons/icon-save.ts | 2 +- .../core/icon-registry/icons/icon-scan.ts | 2 +- .../core/icon-registry/icons/icon-school.ts | 2 +- .../icon-registry/icons/icon-screensharing.ts | 2 +- .../icon-registry/icons/icon-script-alt.ts | 2 +- .../core/icon-registry/icons/icon-script.ts | 2 +- .../core/icon-registry/icons/icon-scull.ts | 9 ++-- .../core/icon-registry/icons/icon-search.ts | 2 +- .../core/icon-registry/icons/icon-sensor.ts | 4 +- .../icon-registry/icons/icon-server-alt.ts | 2 +- .../core/icon-registry/icons/icon-server.ts | 2 +- .../icon-registry/icons/icon-settings-alt.ts | 2 +- .../core/icon-registry/icons/icon-settings.ts | 2 +- .../icon-registry/icons/icon-share-alt.ts | 2 +- .../core/icon-registry/icons/icon-share.ts | 2 +- .../icons/icon-sharing-iphone.ts | 2 +- .../core/icon-registry/icons/icon-shield.ts | 2 +- .../core/icon-registry/icons/icon-shift.ts | 2 +- .../icon-registry/icons/icon-shipping-box.ts | 2 +- .../core/icon-registry/icons/icon-shipping.ts | 2 +- .../core/icon-registry/icons/icon-shoe.ts | 2 +- .../icons/icon-shopping-basket-alt-2.ts | 2 +- .../icons/icon-shopping-basket-alt.ts | 2 +- .../icons/icon-shopping-basket.ts | 2 +- .../core/icon-registry/icons/icon-shuffle.ts | 2 +- .../core/icon-registry/icons/icon-sience.ts | 2 +- .../icon-registry/icons/icon-single-note.ts | 2 +- .../core/icon-registry/icons/icon-sitemap.ts | 2 +- .../core/icon-registry/icons/icon-sleep.ts | 2 +- .../icon-registry/icons/icon-slideshow.ts | 2 +- .../icons/icon-smiley-inverted.ts | 2 +- .../core/icon-registry/icons/icon-smiley.ts | 2 +- .../core/icon-registry/icons/icon-snow.ts | 2 +- .../icon-registry/icons/icon-sound-low.ts | 2 +- .../icon-registry/icons/icon-sound-medium.ts | 2 +- .../icon-registry/icons/icon-sound-off.ts | 2 +- .../icon-registry/icons/icon-sound-waves.ts | 2 +- .../core/icon-registry/icons/icon-sound.ts | 2 +- .../core/icon-registry/icons/icon-spades.ts | 2 +- .../core/icon-registry/icons/icon-speaker.ts | 2 +- .../icon-registry/icons/icon-speed-gauge.ts | 2 +- .../icon-registry/icons/icon-split-alt.ts | 2 +- .../core/icon-registry/icons/icon-split.ts | 2 +- .../core/icon-registry/icons/icon-sprout.ts | 2 +- .../icon-registry/icons/icon-squiggly-line.ts | 2 +- .../core/icon-registry/icons/icon-ssd.ts | 2 +- .../icon-registry/icons/icon-stacked-disks.ts | 2 +- .../core/icon-registry/icons/icon-stamp.ts | 2 +- .../core/icon-registry/icons/icon-star.ts | 2 +- .../core/icon-registry/icons/icon-stop-alt.ts | 2 +- .../icon-registry/icons/icon-stop-hand.ts | 2 +- .../core/icon-registry/icons/icon-stop.ts | 2 +- .../core/icon-registry/icons/icon-store.ts | 2 +- .../core/icon-registry/icons/icon-stream.ts | 2 +- .../core/icon-registry/icons/icon-sunny.ts | 2 +- .../icon-registry/icons/icon-sweatshirt.ts | 2 +- .../core/icon-registry/icons/icon-sync.ts | 2 +- .../core/icon-registry/icons/icon-t-shirt.ts | 2 +- .../core/icon-registry/icons/icon-tab-key.ts | 2 +- .../core/icon-registry/icons/icon-tag.ts | 2 +- .../core/icon-registry/icons/icon-tags.ts | 2 +- .../icon-registry/icons/icon-takeaway-cup.ts | 2 +- .../core/icon-registry/icons/icon-target.ts | 2 +- .../icons/icon-temperatrure-alt.ts | 2 +- .../icon-registry/icons/icon-temperature.ts | 2 +- .../core/icon-registry/icons/icon-terminal.ts | 2 +- .../core/icon-registry/icons/icon-theater.ts | 2 +- .../icon-registry/icons/icon-thumb-down.ts | 2 +- .../core/icon-registry/icons/icon-thumb-up.ts | 2 +- .../icons/icon-thumbnail-list.ts | 2 +- .../icons/icon-thumbnails-small.ts | 2 +- .../icon-registry/icons/icon-thumbnails.ts | 2 +- .../core/icon-registry/icons/icon-ticket.ts | 2 +- .../core/icon-registry/icons/icon-time.ts | 2 +- .../core/icon-registry/icons/icon-timer.ts | 2 +- .../core/icon-registry/icons/icon-tools.ts | 2 +- .../core/icon-registry/icons/icon-top.ts | 2 +- .../icon-registry/icons/icon-traffic-alt.ts | 2 +- .../core/icon-registry/icons/icon-trafic.ts | 2 +- .../core/icon-registry/icons/icon-train.ts | 2 +- .../icon-registry/icons/icon-trash-alt-2.ts | 2 +- .../icon-registry/icons/icon-trash-alt.ts | 2 +- .../core/icon-registry/icons/icon-trash.ts | 2 +- .../core/icon-registry/icons/icon-tree.ts | 2 +- .../core/icon-registry/icons/icon-trophy.ts | 2 +- .../core/icon-registry/icons/icon-truck.ts | 2 +- .../core/icon-registry/icons/icon-tv-old.ts | 2 +- .../core/icon-registry/icons/icon-tv.ts | 2 +- .../icon-registry/icons/icon-umb-content.ts | 2 +- .../icon-registry/icons/icon-umb-developer.ts | 2 +- .../icon-registry/icons/icon-umb-manifest.ts | 14 +++++ .../icon-registry/icons/icon-umb-media.ts | 2 +- .../icon-registry/icons/icon-umb-settings.ts | 2 +- .../icon-registry/icons/icon-umb-users.ts | 2 +- .../core/icon-registry/icons/icon-umbrella.ts | 2 +- .../core/icon-registry/icons/icon-undo.ts | 2 +- .../core/icon-registry/icons/icon-unlocked.ts | 2 +- .../core/icon-registry/icons/icon-untitled.ts | 2 +- .../icon-registry/icons/icon-usb-connector.ts | 2 +- .../core/icon-registry/icons/icon-usb.ts | 2 +- .../icon-registry/icons/icon-user-female.ts | 2 +- .../icons/icon-user-females-alt.ts | 2 +- .../icon-registry/icons/icon-user-females.ts | 2 +- .../icon-registry/icons/icon-user-glasses.ts | 2 +- .../core/icon-registry/icons/icon-user.ts | 2 +- .../icon-registry/icons/icon-users-alt.ts | 2 +- .../core/icon-registry/icons/icon-users.ts | 2 +- .../icon-registry/icons/icon-utilities.ts | 2 +- .../core/icon-registry/icons/icon-vcard.ts | 2 +- .../core/icon-registry/icons/icon-video.ts | 2 +- .../core/icon-registry/icons/icon-voice.ts | 2 +- .../icon-registry/icons/icon-wall-plug.ts | 2 +- .../core/icon-registry/icons/icon-wallet.ts | 2 +- .../core/icon-registry/icons/icon-wand.ts | 2 +- .../core/icon-registry/icons/icon-webhook.ts | 2 +- .../core/icon-registry/icons/icon-weight.ts | 2 +- .../core/icon-registry/icons/icon-width.ts | 2 +- .../core/icon-registry/icons/icon-wifi.ts | 2 +- .../icon-registry/icons/icon-window-popin.ts | 2 +- .../icon-registry/icons/icon-window-popout.ts | 2 +- .../icon-registry/icons/icon-window-sizes.ts | 2 +- .../icon-registry/icons/icon-wine-glass.ts | 2 +- .../core/icon-registry/icons/icon-wrench.ts | 2 +- .../core/icon-registry/icons/icon-wrong.ts | 2 +- .../core/icon-registry/icons/icon-zip.ts | 2 +- .../core/icon-registry/icons/icon-zom-out.ts | 2 +- .../core/icon-registry/icons/icon-zoom-in.ts | 2 +- .../core/icon-registry/icons/icon-zoom-out.ts | 2 +- 533 files changed, 642 insertions(+), 568 deletions(-) create mode 100644 src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/components/ref-manifest/ref-manifest.element.ts create mode 100644 src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-umb-manifest.ts diff --git a/src/Umbraco.Web.UI.Client/package-lock.json b/src/Umbraco.Web.UI.Client/package-lock.json index dafc1e3c8f..0de4402765 100644 --- a/src/Umbraco.Web.UI.Client/package-lock.json +++ b/src/Umbraco.Web.UI.Client/package-lock.json @@ -82,7 +82,7 @@ "eslint-plugin-wc": "^2.1.0", "glob": "^11.0.0", "globals": "^15.8.0", - "lucide-static": "^0.408.0", + "lucide-static": "^0.424.0", "msw": "^1.3.2", "playwright-msw": "^3.0.1", "prettier": "3.3.3", @@ -15281,9 +15281,9 @@ } }, "node_modules/lucide-static": { - "version": "0.408.0", - "resolved": "https://registry.npmjs.org/lucide-static/-/lucide-static-0.408.0.tgz", - "integrity": "sha512-XJioz3vKagiyA6qMDWkYqU1RUS/bMjqio0/TCOItievnV/C4wwgJZGAbk6eVDe6Wv+d0e9NbhS7Y8yMEpGkElQ==", + "version": "0.424.0", + "resolved": "https://registry.npmjs.org/lucide-static/-/lucide-static-0.424.0.tgz", + "integrity": "sha512-KUsIoKeIZF/rc5dttI/bZmd3+zQ/V9YA/G/NsGALA3QWqVncuZsyJ+IrM+jI0BTHiARwVZfp7zOEhc7gqn5x7A==", "dev": true }, "node_modules/lunr": { diff --git a/src/Umbraco.Web.UI.Client/package.json b/src/Umbraco.Web.UI.Client/package.json index 3ed5ffa50b..112daa104b 100644 --- a/src/Umbraco.Web.UI.Client/package.json +++ b/src/Umbraco.Web.UI.Client/package.json @@ -252,7 +252,7 @@ "eslint-plugin-wc": "^2.1.0", "glob": "^11.0.0", "globals": "^15.8.0", - "lucide-static": "^0.408.0", + "lucide-static": "^0.424.0", "msw": "^1.3.2", "playwright-msw": "^3.0.1", "prettier": "3.3.3", diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts index 4436f647b0..4fe1db856c 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts @@ -83,11 +83,7 @@ export class UmbBlockTypeCustomViewGuideElement extends UmbLitElement { ${repeat( this._manifests, (x) => x.alias, - (x) => html` - - - `, + (x) => html` `, )} ` : html`No custom view matches the current block editor type and content type.`; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/components/index.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/components/index.ts index 4f454594ee..1a9cdd1415 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/components/index.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/components/index.ts @@ -1,2 +1,3 @@ export * from './extension-slot/index.js'; export * from './extension-with-api-slot/index.js'; +export * from './ref-manifest/ref-manifest.element.js'; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/components/ref-manifest/ref-manifest.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/components/ref-manifest/ref-manifest.element.ts new file mode 100644 index 0000000000..b341c0f4b0 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/components/ref-manifest/ref-manifest.element.ts @@ -0,0 +1,52 @@ +import { UUIIconRequestEvent, UUIRefNodeElement } from '@umbraco-cms/backoffice/external/uui'; +import { html, customElement, property, state } from '@umbraco-cms/backoffice/external/lit'; +import { UmbElementMixin } from '@umbraco-cms/backoffice/element-api'; +import type { ManifestBase } from '@umbraco-cms/backoffice/extension-api'; + +@customElement('umb-ref-manifest') +export class UmbRefManifestElement extends UmbElementMixin(UUIRefNodeElement) { + @property({ type: Object, attribute: false }) + public get manifest(): ManifestBase | undefined { + return undefined; + } + public set manifest(value: ManifestBase | undefined) { + this._alias = value?.alias; + this.name = value?.name ?? ''; + } + + @state() + private _alias?: string; + + override connectedCallback() { + super.connectedCallback(); + + this.#requestIconSVG('icon-umb-manifest'); + } + + /* This is a bit stupid, but because this element extends from uui-ref-node, it only accepts the icon via the icon slot. + ** Instead we overwrite the fallbackIcon property which requires a SVG... */ + #requestIconSVG(iconName: string) { + if (iconName !== '' && iconName !== null) { + const event = new UUIIconRequestEvent(UUIIconRequestEvent.ICON_REQUEST, { + detail: { iconName: iconName }, + }); + this.dispatchEvent(event); + if (event.icon !== null) { + event.icon.then((iconSvg: string) => { + this.fallbackIcon = iconSvg; + this.requestUpdate('fallbackIcon'); + }); + } + } + } + + protected override renderDetail() { + return html`${this._alias}`; + } +} + +declare global { + interface HTMLElementTagNameMap { + 'umb-ref-manifest': UmbRefManifestElement; + } +} diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icon-dictionary.json b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icon-dictionary.json index 5058e26d8d..4288bb4b7d 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icon-dictionary.json +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icon-dictionary.json @@ -139,7 +139,7 @@ }, { "name": "icon-bar-chart", - "file": "bar-chart-2.svg" + "file": "chart-no-axes-column.svg" }, { "name": "icon-barcode", @@ -147,7 +147,7 @@ }, { "name": "icon-bars", - "file": "bar-chart.svg" + "file": "chart-no-axes-column-increasing.svg" }, { "name": "icon-battery-full", @@ -376,11 +376,11 @@ }, { "name": "icon-chart-curve", - "file": "area-chart.svg" + "file": "chart-no-axes-combined.svg" }, { "name": "icon-chart", - "file": "line-chart.svg" + "file": "chart-line.svg" }, { "name": "icon-chat-active", @@ -653,7 +653,7 @@ }, { "name": "icon-defrag", - "file": "scatter-chart.svg" + "file": "chart-scatter.svg" }, { "name": "icon-delete-key", @@ -1664,7 +1664,7 @@ }, { "name": "icon-pie-chart", - "file": "pie-chart.svg" + "file": "chart-pie.svg" }, { "name": "icon-piggy-bank", @@ -2447,6 +2447,10 @@ { "name": "icon-database", "file": "database.svg" + }, + { + "name": "icon-umb-manifest", + "file": "puzzle.svg" } ], "simpleIcons": [ diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons.ts index e9edf842e7..5b8e14cb97 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons.ts @@ -2099,6 +2099,10 @@ name: "icon-database", path: () => import("./icons/icon-database.js"), },{ +name: "icon-umb-manifest", + +path: () => import("./icons/icon-umb-manifest.js"), +},{ name: "icon-facebook", path: () => import("./icons/icon-facebook.js"), diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-activity.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-activity.ts index bbd5e59293..bde54263f9 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-activity.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-activity.ts @@ -1,4 +1,4 @@ -export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` stroke-linecap="round" stroke-linejoin="round" > - - + + + + + + `; \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-chart.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-chart.ts index dbeaa8358d..ee6ba799f0 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-chart.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-chart.ts @@ -1,6 +1,6 @@ -export default ` +export default ` stroke-linecap="round" stroke-linejoin="round" > - + `; \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-chat-active.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-chat-active.ts index 375bc1007a..3c89732a26 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-chat-active.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-chat-active.ts @@ -1,4 +1,4 @@ -export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` stroke-linecap="round" stroke-linejoin="round" > + - - + `; \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-cloud.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-cloud.ts index 2f2c1f0ab3..0eb80f0aea 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-cloud.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-cloud.ts @@ -1,4 +1,4 @@ -export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` - + `; \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-delete-key.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-delete-key.ts index 099bd68add..f5b4a2ee15 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-delete-key.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-delete-key.ts @@ -1,4 +1,4 @@ -export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` stroke-linecap="round" stroke-linejoin="round" > - + `; \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-facebook-like.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-facebook-like.ts index 7b3d95a435..e89cb6be28 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-facebook-like.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-facebook-like.ts @@ -1,4 +1,4 @@ -export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` stroke-linecap="round" stroke-linejoin="round" > - + - + `; \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-location-nearby.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-location-nearby.ts index 2a5d5c30a5..e011664799 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-location-nearby.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-location-nearby.ts @@ -1,4 +1,4 @@ -export default ` +export default ` stroke-linecap="round" stroke-linejoin="round" > - + - + `; \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-lock.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-lock.ts index c2b8df200a..3ef090933e 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-lock.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-lock.ts @@ -1,4 +1,4 @@ -export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` stroke-linecap="round" stroke-linejoin="round" > - + - + `; \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-map-marker.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-map-marker.ts index 7f33231ec0..f47cf31b67 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-map-marker.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-map-marker.ts @@ -1,4 +1,4 @@ -export default ` +export default ` stroke-linecap="round" stroke-linejoin="round" > - + `; \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-map.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-map.ts index 7ee625bc8e..a88b9316e4 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-map.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-map.ts @@ -1,4 +1,4 @@ -export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` stroke-linecap="round" stroke-linejoin="round" > + - `; \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-piggy-bank.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-piggy-bank.ts index a2ba6f2280..686b1a9c57 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-piggy-bank.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-piggy-bank.ts @@ -1,4 +1,4 @@ -export default ` +export default ` +export default ` stroke-linecap="round" stroke-linejoin="round" > - + `; \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-plane.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-plane.ts index 37c381b14c..6ccbf557e9 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-plane.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-plane.ts @@ -1,4 +1,4 @@ -export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` stroke-linecap="round" stroke-linejoin="round" > - - - - + + + `; \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-search.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-search.ts index d02739cbe0..095cb065e7 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-search.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-search.ts @@ -1,4 +1,4 @@ -export default ` +export default ` +export default ` - + `; \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-server-alt.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-server-alt.ts index f1a06991a6..5422530d7a 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-server-alt.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-server-alt.ts @@ -1,4 +1,4 @@ -export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` + + + +`; \ No newline at end of file diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-umb-media.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-umb-media.ts index 5c267b2b5b..864938c517 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-umb-media.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icons/icon-umb-media.ts @@ -1,4 +1,4 @@ -export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` +export default ` Date: Fri, 2 Aug 2024 22:31:29 +0200 Subject: [PATCH 03/16] manifest viewer modal --- .../src/assets/lang/en-us.ts | 1 + .../src/assets/lang/en.ts | 1 + .../block-type-custom-view-guide.element.ts | 16 +++++++-- .../modals/composition-picker/index.ts | 1 - .../modals/composition-picker/manifest.ts | 8 +++++ .../core/content-type/modals/manifests.ts | 13 ++----- .../packages/core/extension-registry/index.ts | 1 + .../core/extension-registry/manifests.ts | 2 ++ .../modals/manifest-viewer/index.ts | 2 ++ .../manifest-viewer-modal.element.ts | 35 +++++++++++++++++++ .../manifest-viewer-modal.token.ts | 16 +++++++++ .../modals/manifest-viewer/manifest.ts | 8 +++++ 12 files changed, 90 insertions(+), 14 deletions(-) create mode 100644 src/Umbraco.Web.UI.Client/src/packages/core/content-type/modals/composition-picker/manifest.ts create mode 100644 src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/index.ts create mode 100644 src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/manifest-viewer-modal.element.ts create mode 100644 src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/manifest-viewer-modal.token.ts create mode 100644 src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/manifest.ts diff --git a/src/Umbraco.Web.UI.Client/src/assets/lang/en-us.ts b/src/Umbraco.Web.UI.Client/src/assets/lang/en-us.ts index a6468f4f6c..a212371ec1 100644 --- a/src/Umbraco.Web.UI.Client/src/assets/lang/en-us.ts +++ b/src/Umbraco.Web.UI.Client/src/assets/lang/en-us.ts @@ -820,6 +820,7 @@ export default { logout: 'Logout', macro: 'Macro', mandatory: 'Mandatory', + manifest: 'Manifest', media: 'Media', message: 'Message', move: 'Move', diff --git a/src/Umbraco.Web.UI.Client/src/assets/lang/en.ts b/src/Umbraco.Web.UI.Client/src/assets/lang/en.ts index f1b6833566..95c5df5eee 100644 --- a/src/Umbraco.Web.UI.Client/src/assets/lang/en.ts +++ b/src/Umbraco.Web.UI.Client/src/assets/lang/en.ts @@ -831,6 +831,7 @@ export default { logout: 'Logout', macro: 'Macro', mandatory: 'Mandatory', + manifest: 'Manifest', message: 'Message', move: 'Move', name: 'Name', diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts index 4fe1db856c..b41533ef53 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts @@ -1,10 +1,15 @@ import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element'; import { html, customElement, state, property, repeat } from '@umbraco-cms/backoffice/external/lit'; import { UMB_PROPERTY_DATASET_CONTEXT } from '@umbraco-cms/backoffice/property'; -import { umbExtensionsRegistry, type ManifestBlockEditorCustomView } from '@umbraco-cms/backoffice/extension-registry'; +import { + UMB_MANIFEST_VIEWER_MODAL, + umbExtensionsRegistry, + type ManifestBlockEditorCustomView, +} from '@umbraco-cms/backoffice/extension-registry'; import { stringOrStringArrayContains } from '@umbraco-cms/backoffice/utils'; import { UmbExtensionsManifestInitializer } from '@umbraco-cms/backoffice/extension-api'; import { UmbDocumentTypeDetailRepository } from '@umbraco-cms/backoffice/document-type'; +import { UMB_MODAL_MANAGER_CONTEXT } from '@umbraco-cms/backoffice/modal'; @customElement('umb-block-type-custom-view-guide') export class UmbBlockTypeCustomViewGuideElement extends UmbLitElement { @@ -77,13 +82,20 @@ export class UmbBlockTypeCustomViewGuideElement extends UmbLitElement { return true; }; + async #viewManifest(manifest: ManifestBlockEditorCustomView) { + const modalManager = await this.getContext(UMB_MODAL_MANAGER_CONTEXT); + modalManager.open(this, UMB_MANIFEST_VIEWER_MODAL, { data: manifest }); + } + override render() { return this._manifests && this._manifests.length > 0 ? html`
${repeat( this._manifests, (x) => x.alias, - (x) => html` `, + (x) => html` + this.#viewManifest(x)} .manifest=${x}> + `, )}
` : html`No custom view matches the current block editor type and content type.`; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/content-type/modals/composition-picker/index.ts b/src/Umbraco.Web.UI.Client/src/packages/core/content-type/modals/composition-picker/index.ts index 653c14e841..9a964efe55 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/content-type/modals/composition-picker/index.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/content-type/modals/composition-picker/index.ts @@ -1,2 +1 @@ -export * from './composition-picker-modal.element.js'; export * from './composition-picker-modal.token.js'; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/content-type/modals/composition-picker/manifest.ts b/src/Umbraco.Web.UI.Client/src/packages/core/content-type/modals/composition-picker/manifest.ts new file mode 100644 index 0000000000..e743da34a9 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/src/packages/core/content-type/modals/composition-picker/manifest.ts @@ -0,0 +1,8 @@ +import type { ManifestModal } from '@umbraco-cms/backoffice/extension-registry'; + +export const manifest: ManifestModal = { + type: 'modal', + alias: 'Umb.Modal.CompositionPicker', + name: 'ContentType Composition Picker Modal', + element: () => import('./composition-picker-modal.element.js'), +}; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/content-type/modals/manifests.ts b/src/Umbraco.Web.UI.Client/src/packages/core/content-type/modals/manifests.ts index 516bbb553f..a0372901b3 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/content-type/modals/manifests.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/content-type/modals/manifests.ts @@ -1,12 +1,3 @@ -import type { ManifestModal } from '@umbraco-cms/backoffice/extension-registry'; +import { manifest } from './composition-picker/manifest.js'; -const modals: Array = [ - { - type: 'modal', - alias: 'Umb.Modal.CompositionPicker', - name: 'ContentType Composition Picker Modal', - element: () => import('./composition-picker/composition-picker-modal.element.js'), - }, -]; - -export const manifests = modals; +export const manifests = [manifest]; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/index.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/index.ts index 017d4122e2..4987fe24c9 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/index.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/index.ts @@ -1,5 +1,6 @@ export * from './conditions/index.js'; export * from './initializers/index.js'; +export * from './modals/manifest-viewer/index.js'; export * from './registry.js'; export * from './utils/index.js'; export type * from './interfaces/index.js'; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/manifests.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/manifests.ts index dd1a2d6e84..7025355d5b 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/manifests.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/manifests.ts @@ -3,6 +3,7 @@ import { manifests as menuItemManifests } from './menu-item/manifests.js'; import { manifests as workspaceManifests } from './workspace/manifests.js'; import { manifests as collectionManifests } from './collection/manifests.js'; import { manifests as entityActionManifests } from './entity-actions/manifests.js'; +import { manifest as modalManifest } from './modals/manifest-viewer/manifest.js'; import type { ManifestTypes } from './models/index.js'; export const manifests: Array = [ @@ -11,4 +12,5 @@ export const manifests: Array = [ ...workspaceManifests, ...collectionManifests, ...entityActionManifests, + modalManifest, ]; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/index.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/index.ts new file mode 100644 index 0000000000..89988a329e --- /dev/null +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/index.ts @@ -0,0 +1,2 @@ +export * from './manifest-viewer-modal.token.js'; +export * from './manifest.js'; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/manifest-viewer-modal.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/manifest-viewer-modal.element.ts new file mode 100644 index 0000000000..47100de84a --- /dev/null +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/manifest-viewer-modal.element.ts @@ -0,0 +1,35 @@ +import type { UmbManifestViewerModalData, UmbManifestViewerModalValue } from './manifest-viewer-modal.token.js'; +import { css, html, customElement, nothing } from '@umbraco-cms/backoffice/external/lit'; +import { UmbModalBaseElement } from '@umbraco-cms/backoffice/modal'; + +@customElement('umb-manifest-viewer-modal') +export class UmbManifestViewerModalElement extends UmbModalBaseElement< + UmbManifestViewerModalData, + UmbManifestViewerModalValue +> { + override render() { + console.log('data', this.data); + return html` + + ${this.data + ? html`${JSON.stringify(this.data, null, 2)}` + : nothing} +
+ +
+ + `; + } + + static override styles = [css``]; +} + +export default UmbManifestViewerModalElement; + +declare global { + interface HTMLElementTagNameMap { + 'umb-manifest-viewer-modal': UmbManifestViewerModalElement; + } +} diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/manifest-viewer-modal.token.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/manifest-viewer-modal.token.ts new file mode 100644 index 0000000000..96fb68b015 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/manifest-viewer-modal.token.ts @@ -0,0 +1,16 @@ +import type { ManifestBase } from '@umbraco-cms/backoffice/extension-api'; +import { UmbModalToken } from '@umbraco-cms/backoffice/modal'; + +export interface UmbManifestViewerModalData extends ManifestBase {} + +export type UmbManifestViewerModalValue = undefined; + +export const UMB_MANIFEST_VIEWER_MODAL = new UmbModalToken( + 'Umb.Modal.ManifestViewer', + { + modal: { + type: 'sidebar', + size: 'medium', + }, + }, +); diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/manifest.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/manifest.ts new file mode 100644 index 0000000000..db4ef7f807 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/manifest.ts @@ -0,0 +1,8 @@ +import type { ManifestModal } from '@umbraco-cms/backoffice/extension-registry'; + +export const manifest: ManifestModal = { + type: 'modal', + alias: 'Umb.Modal.ManifestViewer', + name: 'Manifest Viewer Modal', + element: () => import('./manifest-viewer-modal.element.js'), +}; From 258727da39fe9d338220af34493e0b97acc808a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niels=20Lyngs=C3=B8?= Date: Fri, 2 Aug 2024 22:59:44 +0200 Subject: [PATCH 04/16] generator --- .../block-grid-entries.element.ts | 1 - ...itor-ui-block-grid-areas-config.element.ts | 2 +- .../property-editor-ui-block-list.element.ts | 6 +--- .../block-type-custom-view-guide.element.ts | 36 +++++++++++++++++-- .../manifest-viewer-modal.element.ts | 13 +++++-- 5 files changed, 46 insertions(+), 12 deletions(-) diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/components/block-grid-entries/block-grid-entries.element.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/components/block-grid-entries/block-grid-entries.element.ts index 9ce184c1be..e4e62d56d9 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/components/block-grid-entries/block-grid-entries.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/components/block-grid-entries/block-grid-entries.element.ts @@ -291,7 +291,6 @@ export class UmbBlockGridEntriesElement extends UmbFormControlMixin(UmbLitElemen if (this._areaKey === null || this._layoutEntries.length === 0) { return html` `, )} - ` + ` : ''; } } diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-list/property-editors/block-list-editor/property-editor-ui-block-list.element.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-list/property-editors/block-list-editor/property-editor-ui-block-list.element.ts index 584de1645c..2a96c2e0c0 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-list/property-editors/block-list-editor/property-editor-ui-block-list.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block-list/property-editors/block-list-editor/property-editor-ui-block-list.element.ts @@ -175,11 +175,7 @@ export class UmbPropertyEditorUIBlockListElement extends UmbLitElement implement `, )} - + { + this.#contentTypeName = model?.name; this.#contentTypeAlias = model?.alias; this.#loadManifests(); }, @@ -54,7 +56,6 @@ export class UmbBlockTypeCustomViewGuideElement extends UmbLitElement { } #loadManifests() { - console.log('this.#blockEditorType', this.#blockEditorType, 'this.#contentTypeAlias', this.#contentTypeAlias); if (!this.#blockEditorType || !this.#contentTypeAlias) return; new UmbExtensionsManifestInitializer( this, @@ -87,6 +88,20 @@ export class UmbBlockTypeCustomViewGuideElement extends UmbLitElement { modalManager.open(this, UMB_MANIFEST_VIEWER_MODAL, { data: manifest }); } + async #generateManifest() { + const modalManager = await this.getContext(UMB_MODAL_MANAGER_CONTEXT); + + const manifest = { + type: 'blockEditorCustomView', + alias: 'Local.blockEditorCustomView.' + this.#contentTypeAlias, + name: 'Block Editor Custom View for ' + this.#contentTypeName, + element: '[replace with path to your web component js file...]', + forContentTypeAlias: this.#contentTypeAlias, + forBlockEditor: this.#blockEditorType, + }; + modalManager.open(this, UMB_MANIFEST_VIEWER_MODAL, { data: manifest }); + } + override render() { return this._manifests && this._manifests.length > 0 ? html`
@@ -98,8 +113,23 @@ export class UmbBlockTypeCustomViewGuideElement extends UmbLitElement { `, )}
` - : html`No custom view matches the current block editor type and content type.`; + : html` this.#generateManifest()}>`; } + + static override styles = [ + css` + #add-button { + text-align: center; + width: 100%; + } + `, + ]; } export default UmbBlockTypeCustomViewGuideElement; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/manifest-viewer-modal.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/manifest-viewer-modal.element.ts index 47100de84a..2e5e8e476e 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/manifest-viewer-modal.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/modals/manifest-viewer/manifest-viewer-modal.element.ts @@ -2,18 +2,27 @@ import type { UmbManifestViewerModalData, UmbManifestViewerModalValue } from './ import { css, html, customElement, nothing } from '@umbraco-cms/backoffice/external/lit'; import { UmbModalBaseElement } from '@umbraco-cms/backoffice/modal'; +// JSON parser for the manifest viewer modal +// Enabling us to view JS code, but it is not optimal, but currently better than nothing [NL] +// Ideally we should have a JS code stringify that can print the manifest as JS. [NL] +function JsonParser(key: string, value: any) { + if (typeof value === 'function' && value !== null && value.toString) { + return Function.prototype.toString.call(value); + } + return value; +} + @customElement('umb-manifest-viewer-modal') export class UmbManifestViewerModalElement extends UmbModalBaseElement< UmbManifestViewerModalData, UmbManifestViewerModalValue > { override render() { - console.log('data', this.data); return html` ${this.data ? html`${JSON.stringify(this.data, null, 2)}${JSON.stringify(this.data, JsonParser, 2)}` : nothing}
From 277290e7346570fc19328952482f97541022171f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niels=20Lyngs=C3=B8?= Date: Fri, 2 Aug 2024 23:02:28 +0200 Subject: [PATCH 05/16] no repeat, we only want one manifest for this --- .../block-type-custom-view-guide.element.ts | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts index 6eb4361882..fb32f61d89 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts @@ -105,13 +105,10 @@ export class UmbBlockTypeCustomViewGuideElement extends UmbLitElement { override render() { return this._manifests && this._manifests.length > 0 ? html`
- ${repeat( - this._manifests, - (x) => x.alias, - (x) => html` - this.#viewManifest(x)} .manifest=${x}> - `, - )} + this.#viewManifest(this._manifests![0])} + .manifest=${this._manifests[0]}>
` : html` Date: Mon, 5 Aug 2024 09:00:53 +0200 Subject: [PATCH 06/16] remove repeat import --- .../block-type-custom-view-guide.element.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts index fb32f61d89..b9edb181ef 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block-type/components/block-type-custom-view-guide/block-type-custom-view-guide.element.ts @@ -1,5 +1,5 @@ import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element'; -import { html, customElement, state, property, repeat, css } from '@umbraco-cms/backoffice/external/lit'; +import { html, customElement, state, property, css } from '@umbraco-cms/backoffice/external/lit'; import { UMB_PROPERTY_DATASET_CONTEXT } from '@umbraco-cms/backoffice/property'; import { UMB_MANIFEST_VIEWER_MODAL, From c3eb00ba5a3e70042226c754724ad771092f7ad4 Mon Sep 17 00:00:00 2001 From: Mads Rasmussen Date: Mon, 5 Aug 2024 14:26:35 +0200 Subject: [PATCH 07/16] install jsdocs eslint rules --- src/Umbraco.Web.UI.Client/eslint.config.js | 4 +- src/Umbraco.Web.UI.Client/package-lock.json | 142 ++++++++++++++++++++ src/Umbraco.Web.UI.Client/package.json | 1 + 3 files changed, 146 insertions(+), 1 deletion(-) diff --git a/src/Umbraco.Web.UI.Client/eslint.config.js b/src/Umbraco.Web.UI.Client/eslint.config.js index 498884d147..4cb0823456 100644 --- a/src/Umbraco.Web.UI.Client/eslint.config.js +++ b/src/Umbraco.Web.UI.Client/eslint.config.js @@ -6,6 +6,7 @@ import wcPlugin from 'eslint-plugin-wc'; import litPlugin from 'eslint-plugin-lit'; import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended'; import tseslint from 'typescript-eslint'; +import jsdoc from 'eslint-plugin-jsdoc'; export default [ // Recommended config applied to all files @@ -13,6 +14,7 @@ export default [ ...tseslint.configs.recommended, wcPlugin.configs['flat/recommended'], litPlugin.configs['flat/recommended'], + jsdoc.configs['flat/recommended-typescript'], localRules.configs.all, eslintPluginPrettierRecommended, @@ -46,7 +48,7 @@ export default [ }, rules: { semi: ['warn', 'always'], - "prettier/prettier": ["warn", { "endOfLine": "auto" }], + 'prettier/prettier': ['warn', { endOfLine: 'auto' }], 'no-unused-vars': 'off', //Let '@typescript-eslint/no-unused-vars' catch the errors to allow unused function parameters (ex: in interfaces) 'no-var': 'error', ...importPlugin.configs.recommended.rules, diff --git a/src/Umbraco.Web.UI.Client/package-lock.json b/src/Umbraco.Web.UI.Client/package-lock.json index bfe157ce3a..9a0b1de11e 100644 --- a/src/Umbraco.Web.UI.Client/package-lock.json +++ b/src/Umbraco.Web.UI.Client/package-lock.json @@ -77,6 +77,7 @@ "eslint": "^9.7.0", "eslint-config-prettier": "^9.1.0", "eslint-plugin-import": "^2.29.1", + "eslint-plugin-jsdoc": "^48.11.0", "eslint-plugin-lit": "^1.14.0", "eslint-plugin-local-rules": "^3.0.2", "eslint-plugin-prettier": "^5.1.3", @@ -2166,6 +2167,20 @@ "react": ">=16.8.0" } }, + "node_modules/@es-joy/jsdoccomment": { + "version": "0.46.0", + "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.46.0.tgz", + "integrity": "sha512-C3Axuq1xd/9VqFZpW4YAzOx5O9q/LP46uIQy/iNDpHG3fmPa6TBtvfglMCs3RBiBxAIi0Go97r8+jvTt55XMyQ==", + "dev": true, + "dependencies": { + "comment-parser": "1.4.1", + "esquery": "^1.6.0", + "jsdoc-type-pratt-parser": "~4.0.0" + }, + "engines": { + "node": ">=16" + } + }, "node_modules/@esbuild/aix-ppc64": { "version": "0.19.12", "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.19.12.tgz", @@ -9279,6 +9294,15 @@ "integrity": "sha512-jlpIfsOoNoafl92Sz//64uQHGSyMrD2vYG5d8o2a4qGvyNCvXur7bzIsWtAC/6flI2RYAp3kv8rsfBtaLm7w0g==", "dev": true }, + "node_modules/are-docs-informative": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/are-docs-informative/-/are-docs-informative-0.0.2.tgz", + "integrity": "sha512-ixiS0nLNNG5jNQzgZJNoUpBKdo9yTYZMGJ+QgT2jmjR7G7+QHRCc4v6LQ3NgE7EBJq+o0ams3waJwkrlBom8Ig==", + "dev": true, + "engines": { + "node": ">=14" + } + }, "node_modules/arg": { "version": "4.1.3", "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", @@ -10635,6 +10659,15 @@ "node": ">=18" } }, + "node_modules/comment-parser": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/comment-parser/-/comment-parser-1.4.1.tgz", + "integrity": "sha512-buhp5kePrmda3vhc5B9t7pUQXAb2Tnd0qgpkIhPhkHXxJpiPJ11H0ZEU0oBpJ2QztSbzG/ZxMj/CHsYJqRHmyg==", + "dev": true, + "engines": { + "node": ">= 12.0.0" + } + }, "node_modules/common-path-prefix": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/common-path-prefix/-/common-path-prefix-3.0.0.tgz", @@ -11894,6 +11927,81 @@ "node": ">=0.10.0" } }, + "node_modules/eslint-plugin-jsdoc": { + "version": "48.11.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-48.11.0.tgz", + "integrity": "sha512-d12JHJDPNo7IFwTOAItCeJY1hcqoIxE0lHA8infQByLilQ9xkqrRa6laWCnsuCrf+8rUnvxXY1XuTbibRBNylA==", + "dev": true, + "dependencies": { + "@es-joy/jsdoccomment": "~0.46.0", + "are-docs-informative": "^0.0.2", + "comment-parser": "1.4.1", + "debug": "^4.3.5", + "escape-string-regexp": "^4.0.0", + "espree": "^10.1.0", + "esquery": "^1.6.0", + "parse-imports": "^2.1.1", + "semver": "^7.6.3", + "spdx-expression-parse": "^4.0.0", + "synckit": "^0.9.1" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "eslint": "^7.0.0 || ^8.0.0 || ^9.0.0" + } + }, + "node_modules/eslint-plugin-jsdoc/node_modules/escape-string-regexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint-plugin-jsdoc/node_modules/semver": { + "version": "7.6.3", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz", + "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/eslint-plugin-jsdoc/node_modules/spdx-expression-parse": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-4.0.0.tgz", + "integrity": "sha512-Clya5JIij/7C6bRR22+tnGXbc4VKlibKSVj2iHvVeX5iMW7s1SIQlqu699JkODJJIhh/pUu8L0/VLh8xflD+LQ==", + "dev": true, + "dependencies": { + "spdx-exceptions": "^2.1.0", + "spdx-license-ids": "^3.0.0" + } + }, + "node_modules/eslint-plugin-jsdoc/node_modules/synckit": { + "version": "0.9.1", + "resolved": "https://registry.npmjs.org/synckit/-/synckit-0.9.1.tgz", + "integrity": "sha512-7gr8p9TQP6RAHusBOSLs46F4564ZrjV8xFmw5zCmgmhGUcw2hxsShhJ6CEiHQMgPDwAQ1fWHPM0ypc4RMAig4A==", + "dev": true, + "dependencies": { + "@pkgr/core": "^0.1.0", + "tslib": "^2.6.2" + }, + "engines": { + "node": "^14.18.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/unts" + } + }, "node_modules/eslint-plugin-lit": { "version": "1.14.0", "resolved": "https://registry.npmjs.org/eslint-plugin-lit/-/eslint-plugin-lit-1.14.0.tgz", @@ -14725,6 +14833,15 @@ "signal-exit": "^3.0.2" } }, + "node_modules/jsdoc-type-pratt-parser": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-4.0.0.tgz", + "integrity": "sha512-YtOli5Cmzy3q4dP26GraSOeAhqecewG04hoO8DY56CH4KJ9Fvv5qKWUCCo3HZob7esJQHCv6/+bnTy72xZZaVQ==", + "dev": true, + "engines": { + "node": ">=12.0.0" + } + }, "node_modules/jsesc": { "version": "2.5.2", "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-2.5.2.tgz", @@ -17293,6 +17410,25 @@ "node": ">=6" } }, + "node_modules/parse-imports": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/parse-imports/-/parse-imports-2.1.1.tgz", + "integrity": "sha512-TDT4HqzUiTMO1wJRwg/t/hYk8Wdp3iF/ToMIlAoVQfL1Xs/sTxq1dKWSMjMbQmIarfWKymOyly40+zmPHXMqCA==", + "dev": true, + "dependencies": { + "es-module-lexer": "^1.5.3", + "slashes": "^3.0.12" + }, + "engines": { + "node": ">= 18" + } + }, + "node_modules/parse-imports/node_modules/es-module-lexer": { + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.5.4.tgz", + "integrity": "sha512-MVNK56NiMrOwitFB7cqDwq0CQutbw+0BvLshJSse0MUNU+y1FC3bUS/AQg7oUng+/wKrrki7JfmwtVHkVfPLlw==", + "dev": true + }, "node_modules/parse-json": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", @@ -19024,6 +19160,12 @@ "node": ">=8" } }, + "node_modules/slashes": { + "version": "3.0.12", + "resolved": "https://registry.npmjs.org/slashes/-/slashes-3.0.12.tgz", + "integrity": "sha512-Q9VME8WyGkc7pJf6QEkj3wE+2CnvZMI+XJhwdTPR8Z/kWQRXi7boAWLDibRPyHRTUTPx5FaU7MsyrjI3yLB4HA==", + "dev": true + }, "node_modules/slice-ansi": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz", diff --git a/src/Umbraco.Web.UI.Client/package.json b/src/Umbraco.Web.UI.Client/package.json index 766ac0c7bb..277a0da7ab 100644 --- a/src/Umbraco.Web.UI.Client/package.json +++ b/src/Umbraco.Web.UI.Client/package.json @@ -247,6 +247,7 @@ "eslint": "^9.7.0", "eslint-config-prettier": "^9.1.0", "eslint-plugin-import": "^2.29.1", + "eslint-plugin-jsdoc": "^48.11.0", "eslint-plugin-lit": "^1.14.0", "eslint-plugin-local-rules": "^3.0.2", "eslint-plugin-prettier": "^5.1.3", From e28852ec7718f46f2a4e6633779e8ae9afd362d4 Mon Sep 17 00:00:00 2001 From: Mads Rasmussen Date: Tue, 6 Aug 2024 13:24:55 +0200 Subject: [PATCH 08/16] use the non typescript version --- src/Umbraco.Web.UI.Client/eslint.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Umbraco.Web.UI.Client/eslint.config.js b/src/Umbraco.Web.UI.Client/eslint.config.js index 4cb0823456..d5c5d55530 100644 --- a/src/Umbraco.Web.UI.Client/eslint.config.js +++ b/src/Umbraco.Web.UI.Client/eslint.config.js @@ -14,7 +14,7 @@ export default [ ...tseslint.configs.recommended, wcPlugin.configs['flat/recommended'], litPlugin.configs['flat/recommended'], - jsdoc.configs['flat/recommended-typescript'], + jsdoc.configs['flat/recommended'], // We use the non typescript version to allow types to be defined in the jsdoc comments. This will allow js docs as an alternative to typescript types. localRules.configs.all, eslintPluginPrettierRecommended, From 1c03acce0f43f4efdf511e79bd73cf6f364eb03e Mon Sep 17 00:00:00 2001 From: Mads Rasmussen Date: Tue, 6 Aug 2024 13:28:42 +0200 Subject: [PATCH 09/16] auto fix jsdocs based on lint rules --- .../src/apps/app/app-auth.controller.ts | 1 + .../src/apps/app/app-error.element.ts | 4 -- .../src/apps/app/app.element.ts | 2 - .../src/apps/app/server-connection.ts | 6 +-- .../src/apps/installer/installer.context.ts | 6 +-- .../src/libs/class-api/class.interface.ts | 8 ++-- .../consume/context-request.event.ts | 2 +- .../debug/context-data.function.ts | 10 +---- .../provide/context-provide.event.ts | 4 +- .../provide/context-provider.element.ts | 1 - .../libs/context-api/token/context-token.ts | 3 -- .../controller-host-element.mixin.ts | 3 +- .../controller-api/controller-host.mixin.ts | 3 +- .../base-extension-initializer.controller.ts | 1 - .../base-extensions-initializer.controller.ts | 1 - .../extension-api-initializer.controller.ts | 1 - ...-element-and-api-initializer.controller.ts | 1 - ...xtension-element-initializer.controller.ts | 1 - ...tension-manifest-initializer.controller.ts | 1 - .../extensions-api-initializer.controller.ts | 7 ++-- .../create-extension-api.function.ts | 6 +++ ...ate-extension-element-with-api.function.ts | 7 ++++ .../create-extension-element.function.ts | 5 +++ .../functions/has-init-export.function.ts | 1 + .../has-on-unload-export.function.ts | 1 + .../functions/load-manifest-api.function.ts | 4 ++ .../load-manifest-element.function.ts | 4 ++ .../load-manifest-plain-css.function.ts | 4 ++ .../load-manifest-plain-js.function.ts | 4 ++ .../registry/extension.registry.ts | 20 ++++++++++ .../type-guards/has-api-export.function.ts | 4 ++ .../has-default-export.function.ts | 4 ++ .../has-element-export.function.ts | 4 ++ .../is-manifest-base-type.function.ts | 4 ++ .../is-manifest-element-name-type.function.ts | 4 ++ .../types/manifest-base.interface.ts | 1 - .../types/manifest-kind.interface.ts | 1 - .../formatting-api/formatting.controller.ts | 1 + .../localizeAndTransform.function.ts | 2 + .../localization.controller.ts | 26 ++++++++++--- .../localization-api/localization.manager.ts | 5 ++- .../libs/observable-api/states/array-state.ts | 37 ++++++++++--------- .../libs/observable-api/states/basic-state.ts | 12 +++--- .../observable-api/states/boolean-state.ts | 2 +- .../libs/observable-api/states/class-state.ts | 6 +-- .../libs/observable-api/states/deep-state.ts | 14 +++---- .../observable-api/states/number-state.ts | 2 +- .../observable-api/states/object-state.ts | 6 +-- .../observable-api/states/string-state.ts | 2 +- .../utils/append-to-frozen-array.function.ts | 3 +- .../utils/assign-to-frozen-object.function.ts | 5 +++ .../utils/create-observable-part.function.ts | 2 +- .../utils/default-memoization.function.ts | 2 +- .../utils/filter-frozen-array.function.ts | 2 +- .../utils/json-string-comparison.function.ts | 2 +- .../utils/merge-observables.function.ts | 2 +- .../utils/observe-multiple.function.ts | 2 +- .../partial-update-frozen-array.function.ts | 5 ++- .../utils/push-at-to-unique-array.function.ts | 3 +- .../utils/push-to-unique-array.function.ts | 2 +- .../utils/simple-hash-code.function.ts | 4 +- .../strict-equality-memoization.function.ts | 2 +- .../src/mocks/data/examine.data.ts | 7 ++++ .../src/mocks/data/health-check.data.ts | 8 ++++ .../mocks/data/user-group/user-group.db.ts | 2 +- .../src/mocks/data/user/user.db.ts | 2 +- .../src/mocks/data/utils/paged-result.ts | 6 +++ ...ck-grid-inline-property-dataset.context.ts | 3 ++ .../block-grid-entries.element.ts | 1 + .../context/block-grid-manager.context.ts | 3 +- .../packages/block/block-grid/utils/index.ts | 6 +++ .../context/block-rte-manager.context.ts | 5 ++- .../block/context/block-entry.context.ts | 4 +- .../block/context/block-manager.context.ts | 5 +++ .../block-element-property-dataset.context.ts | 3 ++ .../code-editor/code-editor.controller.ts | 31 +++------------- .../components/code-editor.element.ts | 17 +-------- .../code-editor/models/code-editor.model.ts | 5 --- .../src/packages/code-editor/themes/index.ts | 3 +- .../src/packages/core/auth/auth-flow.ts | 8 ++-- .../src/packages/core/auth/auth.context.ts | 7 ++-- .../collection/collection-alias.manifest.ts | 1 - .../collection/collection-view.manager.ts | 2 +- .../collection-selection-actions.element.ts | 4 ++ .../default/collection-default.context.ts | 4 +- .../backoffice-modal-container.element.ts | 7 +++- .../body-layout/body-layout.element.ts | 2 +- .../code-block/code-block.element.ts | 1 - .../footer-layout/footer-layout.element.ts | 2 +- .../core/components/icon/icon.element.ts | 4 +- .../input-date/input-date.element.ts | 2 - .../input-number-range.element.ts | 4 ++ .../input-multiple-text-string.element.ts | 4 +- .../popover-layout/popover-layout.element.ts | 2 - .../core/components/stack/stack.element.ts | 6 +-- .../core/components/table/table.element.ts | 2 +- .../content-type-structure-repository-base.ts | 2 +- ...-type-structure-server-data-source-base.ts | 3 +- ...t-type-container-structure-helper.class.ts | 1 + .../content-type-structure-manager.class.ts | 2 + ...t-type-design-editor-properties.element.ts | 3 +- ...ent-type-design-editor-property.element.ts | 2 +- .../content-type-design-editor-tab.element.ts | 3 +- .../content-type-design-editor.element.ts | 3 +- .../content-property-dataset.context.ts | 8 ++-- .../repository/sources/culture.server.data.ts | 2 +- .../core/entity-action/entity-action-base.ts | 2 +- .../packages/core/entity/entity.context.ts | 2 +- .../extension-slot/extension-slot.element.ts | 4 +- .../extension-with-api-slot.element.ts | 4 +- .../conditions/section-alias.condition.ts | 2 - ...nsion-element-and-api-slot-element-base.ts | 2 +- .../models/auth-provider.model.ts | 1 - .../models/collection-view.model.ts | 2 - .../models/current-user-action.model.ts | 2 - .../models/dashboard-collection.model.ts | 1 - .../models/dashboard.model.ts | 1 - .../models/entity-action.model.ts | 2 - .../models/entity-bulk-action.model.ts | 2 - .../models/entry-point.model.ts | 1 - .../models/property-action.model.ts | 2 - .../models/section-view.model.ts | 1 - .../models/tinymce-plugin.model.ts | 3 -- .../workspace-action-menu-item.model.ts | 2 - .../core/icon-registry/icon.registry.ts | 4 +- .../directives/focus.lit-directive.ts | 1 - .../core/lit-element/lit-element.element.ts | 3 -- .../registry/localization.registry.ts | 14 +++++-- .../confirm/confirm-modal.controller.ts | 5 +++ .../modal/component/modal-base.element.ts | 1 + .../modal/context/modal-manager.context.ts | 2 +- .../core/modal/context/modal.context.ts | 3 ++ .../packages/core/modal/token/modal-token.ts | 3 -- .../extractUmbNotificationColor.function.ts | 4 ++ .../isUmbNotifications.function.ts | 8 ++++ .../core/notification/notification-handler.ts | 2 +- .../core/notification/notification.context.ts | 7 ++-- .../property-action-menu.element.ts | 4 ++ .../property-action-base.controller.ts | 2 +- .../ref-property-editor-ui.element.ts | 2 +- .../property-dataset-base-context.ts | 5 ++- .../property/property/property.element.ts | 12 +++--- .../is-trashed/is-trashed.entity-context.ts | 4 +- .../empty-recycle-bin.action.ts | 2 +- .../restore-from-recycle-bin.action.ts | 2 +- .../entity-action/trash/trash.action.ts | 2 +- .../recycle-bin-repository-base.ts | 10 ++--- .../detail/detail-repository-base.ts | 14 +++---- .../repository/item/item-repository-base.ts | 4 +- .../item/item-server-data-source-base.ts | 2 +- .../resources/apiTypeValidators.function.ts | 12 ++++++ .../extractUmbColorVariable.function.ts | 4 ++ .../core/resources/resource.controller.ts | 3 +- .../core/resources/tryExecute.function.ts | 4 ++ .../resources/tryExecuteAndNotify.function.ts | 6 +++ .../generate-route-path-builder.function.ts | 4 ++ .../modal-route-registration.controller.ts | 1 + .../core/router/path-pattern.class.ts | 2 - .../core/router/router-slot.element.ts | 2 +- .../input-section/input-section.element.ts | 4 +- .../item/section-item.repository.ts | 4 +- .../rename-server-file-repository-base.ts | 2 +- .../server-path-unique-serializer.ts | 4 +- .../packages/core/sorter/sorter.controller.ts | 25 ++++++++++++- .../core/store/detail/detail-store-base.ts | 4 +- .../core/store/item/item-store-base.ts | 3 +- .../temporary-file.repository.ts | 8 ++-- .../temporary-file.server.data-source.ts | 6 +-- .../tree/data/tree-data-source.interface.ts | 6 +-- .../core/tree/data/tree-repository-base.ts | 14 +++---- .../tree/data/tree-repository.interface.ts | 2 +- .../tree/data/tree-server-data-source-base.ts | 6 +-- .../core/tree/data/tree-store.interface.ts | 4 +- .../core/tree/data/unique-tree-store.ts | 4 +- .../core/tree/default/default-tree.context.ts | 9 +++-- .../tree/folder/folder-repository-base.ts | 10 ++--- .../tree-item-base/tree-item-context-base.ts | 2 +- .../utils/download/blob-download.function.ts | 2 - .../utils/get-processed-image-url.function.ts | 2 + .../src/packages/core/utils/math/math.ts | 12 ------ .../core/utils/object/deep-merge.function.ts | 2 + .../pagination-manager/pagination.manager.ts | 10 ++--- .../utils/path/ensure-local-path.function.ts | 2 + .../ensure-path-ends-with-slash.function.ts | 4 ++ .../utils/path/has-own-opener.function.ts | 1 - ...remove-initial-slash-from-path.function.ts | 4 ++ .../core/utils/path/stored-path.function.ts | 1 + ...orm-server-path-to-client-path.function.ts | 4 ++ .../core/utils/path/umbraco-path.function.ts | 4 ++ .../path/url-pattern-to-string.function.ts | 5 +++ .../selection-manager/selection.manager.ts | 8 ++-- .../utils/string/from-camel-case.function.ts | 2 - .../string/generate-umbraco-alias.function.ts | 4 ++ .../utils/string/increment-string.function.ts | 4 ++ .../utils/string/split-string-to-array.ts | 5 +-- ...tring-or-string-array-contains.function.ts | 5 +++ .../validation/mixins/form-control.mixin.ts | 23 ++++++------ .../packages/core/variant/variant-id.class.ts | 4 ++ ...kspace-action-menu-item-base.controller.ts | 2 +- .../default/workspace-action.element.ts | 4 ++ .../workspace-action-base.controller.ts | 2 +- .../workspace-editor.element.ts | 2 +- .../workspace-footer.element.ts | 6 ++- .../conditions/workspace-alias.condition.ts | 2 - .../workspace-entity-type.condition.ts | 1 - ...iant-workspace-property-dataset-context.ts | 3 ++ ...data-type-collection.server.data-source.ts | 2 +- .../data-type-flow-input.element.ts | 2 +- .../data-type-input.element.ts | 4 +- .../ref-data-type/ref-data-type.element.ts | 8 ++-- .../data-type-duplicate.server.data-source.ts | 2 +- .../data-type-move.server.data-source.ts | 3 +- .../data-type-reference.server.data.ts | 2 +- .../data-type-detail.server.data-source.ts | 10 ++--- .../detail/data-type-detail.store.ts | 2 +- .../repository/item/data-type-item.store.ts | 2 +- .../data-type-search.server.data-source.ts | 2 +- .../data-type/tree/data-type-tree.store.ts | 2 +- .../data-type-folder.server.data-source.ts | 8 ++-- ...ictionary-collection.server.data-source.ts | 2 +- .../dictionary-move.server.data-source.ts | 3 +- .../dictionary-detail.server.data-source.ts | 10 ++--- .../detail/dictionary-detail.store.ts | 2 +- .../export/dictionary-export.repository.ts | 4 +- .../dictionary-export.server.data-source.ts | 2 +- .../import/dictionary-import.repository.ts | 2 +- .../repository/item/dictionary-item.store.ts | 2 +- .../dictionary/tree/dictionary-tree.store.ts | 2 +- ...ument-blueprint-move.server.data-source.ts | 3 +- ...ent-blueprint-detail.server.data-source.ts | 10 ++--- .../detail/document-blueprint-detail.store.ts | 2 +- .../item/document-blueprint-item.store.ts | 2 +- .../tree/document-blueprint-tree.store.ts | 2 +- ...ent-blueprint-folder.server.data-source.ts | 8 ++-- .../input-document-type.element.ts | 4 +- ...ument-type-duplicate.server.data-source.ts | 2 +- .../document-type-move.server.data-source.ts | 3 +- ...ent-type-composition.server.data-source.ts | 5 ++- ...document-type-detail.server.data-source.ts | 10 ++--- .../detail/document-type-detail.store.ts | 2 +- .../document-type-item.server.data-source.ts | 2 +- .../item/document-type-item.store.ts | 2 +- ...ument-type-structure.server.data-source.ts | 2 +- ...document-type-search.server.data-source.ts | 2 +- .../document-type.tree.server.data-source.ts | 2 +- .../tree/document-type.tree.store.ts | 2 +- ...document-type-folder.server.data-source.ts | 8 ++-- .../document-audit-log.repository.ts | 4 +- .../document-audit-log.server.data-source.ts | 2 +- .../documents/collection/views/index.ts | 5 +++ .../input-document/input-document.element.ts | 4 +- .../document-duplicate.server.data-source.ts | 2 +- .../document-move.server.data-source.ts | 3 +- .../repository/rollback.server.data-source.ts | 4 +- .../modals/rollback/rollback-modal.element.ts | 4 ++ .../tree/document-recycle-bin-tree.store.ts | 2 +- .../document-reference.server.data.ts | 2 +- .../document-detail.server.data-source.ts | 10 ++--- .../detail/document-detail.store.ts | 2 +- .../repository/item/document-item.store.ts | 2 +- .../preview/document-preview.repository.ts | 4 +- .../document-publishing.repository.ts | 9 ++++- .../document-publishing.server.data-source.ts | 4 +- .../document-validation.repository.ts | 6 +-- .../document-validation.server.data-source.ts | 4 +- .../document-search.server.data-source.ts | 2 +- .../tree/document-tree.server.data-source.ts | 2 +- .../documents/tree/document-tree.store.ts | 2 +- .../document-user-permission.condition.ts | 2 - .../documents/user-permissions/utils.ts | 4 ++ .../language-collection.server.data-source.ts | 2 +- .../input-language/input-language.element.ts | 4 +- .../language-detail.server.data-source.ts | 10 ++--- .../detail/language-detail.store.ts | 2 +- .../repository/item/language-item.store.ts | 2 +- .../donut-chart/donut-chart.element.ts | 8 +--- .../donut-chart/donut-slice.element.ts | 7 +--- .../sources/log-viewer.server.data.ts | 25 ++++--------- .../log-viewer-log-level-overview.element.ts | 1 - .../media/imaging/imaging.repository.ts | 1 + .../packages/media/imaging/imaging.store.ts | 7 ++++ .../input-media-type.element.ts | 4 +- ...media-type-duplicate.server.data-source.ts | 2 +- .../media-type-move.server.data-source.ts | 3 +- ...dia-type-composition.server.data-source.ts | 5 ++- .../media-type-detail.server.data-source.ts | 10 ++--- .../detail/media-type-detail.store.ts | 2 +- .../repository/item/media-type-item.store.ts | 2 +- ...media-type-structure.server.data-source.ts | 2 +- .../media-type-search.server.data-source.ts | 2 +- .../media-type-folder.server.data-source.ts | 8 ++-- .../media-type-tree.server.data-source.ts | 2 +- .../media-types/tree/media-type-tree.store.ts | 2 +- .../media/media-types/utils.ts/index.ts | 7 ++++ .../repository/media-audit-log.repository.ts | 4 +- .../media-audit-log.server.data-source.ts | 2 +- .../input-media/input-media.element.ts | 4 +- .../input-upload-field.element.ts | 7 +++- .../media/dropzone/dropzone-manager.class.ts | 4 +- .../media-move.server.data-source.ts | 3 +- .../tree/media-recycle-bin-tree.store.ts | 2 +- .../repository/media-reference.server.data.ts | 2 +- .../detail/media-detail.server.data-source.ts | 10 ++--- .../repository/detail/media-detail.store.ts | 2 +- .../media/repository/item/media-item.store.ts | 2 +- .../media/repository/url/media-url.store.ts | 2 +- .../search/media-search.server.data-source.ts | 2 +- .../tree/media-tree.server.data-source.ts | 2 +- .../media/media/tree/media-tree.store.ts | 2 +- .../src/packages/media/media/utils/index.ts | 8 ++++ ...ber-group-collection.server.data-source.ts | 2 +- .../input-member-group.element.ts | 4 +- .../detail/member-group-detail.repository.ts | 2 +- .../member-group-detail.server.data-source.ts | 10 ++--- .../detail/member-group-detail.store.ts | 2 +- .../item/member-group-item.store.ts | 2 +- .../input-member-type.element.ts | 4 +- ...ember-type-duplicate.server.data-source.ts | 2 +- ...ber-type-composition.server.data-source.ts | 5 ++- .../detail/member-type-detail.repository.ts | 2 +- .../member-type-detail.server.data-source.ts | 10 ++--- .../detail/member-type-detail.store.ts | 2 +- .../repository/item/member-type-item.store.ts | 2 +- .../member-type-search.server.data-source.ts | 2 +- .../tree/member-type-tree.store.ts | 2 +- .../member-collection.server.data-source.ts | 2 +- .../input-member/input-member.element.ts | 4 +- .../detail/member-detail.repository.ts | 2 +- .../member-detail.server.data-source.ts | 10 ++--- .../repository/detail/member-detail.store.ts | 2 +- .../repository/item/member-item.store.ts | 2 +- .../member-search.server.data-source.ts | 2 +- .../input-multi-url.element.ts | 2 +- .../package/repository/package.repository.ts | 2 + .../package/repository/package.store.ts | 3 +- .../repository/dynamic-root.repository.ts | 4 +- .../repository/dynamic-root.server.data.ts | 2 +- .../property-editor-ui-date-picker.element.ts | 2 +- ...tion-type-collection.server.data-source.ts | 2 +- .../detail/relation-type-detail.repository.ts | 4 +- ...relation-type-detail.server.data-source.ts | 2 +- .../detail/relation-type-detail.store.ts | 2 +- .../relation-collection.server.data-source.ts | 2 +- .../src/packages/relations/relations/utils.ts | 12 ++++++ .../input-static-file.element.ts | 4 +- .../repository/item/static-file-item.store.ts | 2 +- .../tree/static-file-tree.store.ts | 2 +- .../repository/sources/tag.server.data.ts | 2 +- .../src/packages/tags/repository/tag.store.ts | 4 +- .../rename-partial-view.server.data-source.ts | 2 +- .../partial-view-item.server.data-source.ts | 2 +- .../item/partial-view-item.store.ts | 2 +- .../repository/partial-view-detail.store.ts | 2 +- .../partial-view-folder.server.data-source.ts | 6 +-- .../tree/partial-view-tree.store.ts | 2 +- .../rename-script.server.data-source.ts | 2 +- .../item/script-item.server.data-source.ts | 2 +- .../repository/item/script-item.store.ts | 2 +- .../scripts/repository/script-detail.store.ts | 2 +- .../script-folder.server.data-source.ts | 6 +-- .../scripts/tree/script-tree.store.ts | 2 +- .../rename-stylesheet.server.data-source.ts | 2 +- .../stylesheet-input.element.ts | 4 +- .../stylesheet-rule-ref.element.ts | 2 +- .../stylesheet-item.server.data-source.ts | 2 +- .../repository/item/stylesheet-item.store.ts | 2 +- .../repository/stylesheet-detail.store.ts | 2 +- .../stylesheet-folder.server.data-source.ts | 6 +-- .../stylesheets/tree/stylesheet-tree.store.ts | 2 +- .../utils/stylesheet-rule-manager.ts | 4 +- .../templates/modals/query-builder/utils.ts | 25 +++++++++++++ .../template-detail.server.data-source.ts | 10 ++--- .../detail/template-detail.store.ts | 2 +- .../repository/item/template-item.store.ts | 2 +- .../template-query.server.data-source.ts | 5 +-- .../template-search.server.data-source.ts | 2 +- .../templates/tree/template-tree.store.ts | 2 +- .../input-tiny-mce/input-tiny-mce.element.ts | 4 +- .../input-tiny-mce.sanitizer.ts | 4 +- .../src/packages/tiny-mce/utils.ts | 4 ++ .../packages/ufm/plugins/marked-ufm.plugin.ts | 4 ++ .../mfa-provider-default.element.ts | 1 + .../user/current-user/current-user.context.ts | 1 - .../modals/external-login-modal.element.ts | 1 + .../current-user-mfa-modal.element.ts | 3 ++ .../repository/current-user.repository.ts | 7 +++- .../current-user.server.data-source.ts | 7 +++- .../utils/is-current-user.function.ts | 3 ++ .../user-group-input.element.ts | 4 +- .../user-group-ref/user-group-ref.element.ts | 2 +- .../user-group-detail.server.data-source.ts | 10 ++--- .../detail/user-group-detail.store.ts | 2 +- .../repository/item/user-group-item.store.ts | 2 +- .../user-collection.server.data-source.ts | 2 +- .../user-input/user-input.element.ts | 4 +- .../user-allow-action-base.condition.ts | 2 +- .../invite-user-server.data-source.ts | 1 + .../repository/invite-user.repository.ts | 4 +- .../modals/user-mfa/user-mfa-modal.element.ts | 2 + .../avatar/user-avatar.repository.ts | 4 +- .../avatar/user-avatar.server.data-source.ts | 4 +- ...change-user-password.server.data-source.ts | 2 +- .../config/user-config.repository.ts | 1 + .../detail/user-detail.repository.ts | 5 ++- .../detail/user-detail.server.data-source.ts | 12 +++--- .../repository/detail/user-detail.store.ts | 2 +- .../user/repository/item/user-item.store.ts | 2 +- .../new-user-password.repository.ts | 4 +- .../new-user-password.server.data-source.ts | 2 +- .../user-set-group.server.data-source.ts | 4 +- .../user/user/utils/is-user.function.ts | 2 + .../webhook-collection.server.data-source.ts | 2 +- .../webhook-detail.server.data-source.ts | 10 ++--- .../repository/detail/webhook-detail.store.ts | 2 +- .../repository/event/webhook-event.store.ts | 2 +- .../repository/item/webhook-item.store.ts | 2 +- 416 files changed, 1014 insertions(+), 712 deletions(-) diff --git a/src/Umbraco.Web.UI.Client/src/apps/app/app-auth.controller.ts b/src/Umbraco.Web.UI.Client/src/apps/app/app-auth.controller.ts index b893575d90..2d7f492808 100644 --- a/src/Umbraco.Web.UI.Client/src/apps/app/app-auth.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/apps/app/app-auth.controller.ts @@ -60,6 +60,7 @@ export class UmbAppAuthController extends UmbControllerBase { /** * Starts the authorization flow. * It will check which providers are available and either redirect directly to the provider or show a provider selection screen. + * @param userLoginState */ async makeAuthorizationRequest(userLoginState: UmbUserLoginState = 'loggingIn'): Promise { if (!this.#authContext) { diff --git a/src/Umbraco.Web.UI.Client/src/apps/app/app-error.element.ts b/src/Umbraco.Web.UI.Client/src/apps/app/app-error.element.ts index 9aa8a3da8c..da1a03ffbe 100644 --- a/src/Umbraco.Web.UI.Client/src/apps/app/app-error.element.ts +++ b/src/Umbraco.Web.UI.Client/src/apps/app/app-error.element.ts @@ -10,7 +10,6 @@ import { UmbTextStyles } from '@umbraco-cms/backoffice/style'; export class UmbAppErrorElement extends UmbLitElement { /** * The headline to display - * * @attr */ @property() @@ -18,7 +17,6 @@ export class UmbAppErrorElement extends UmbLitElement { /** * The error message to display - * * @attr */ @property() @@ -26,7 +24,6 @@ export class UmbAppErrorElement extends UmbLitElement { /** * The error to display - * * @attr */ @property() @@ -34,7 +31,6 @@ export class UmbAppErrorElement extends UmbLitElement { /** * Hide the back button - * * @attr */ @property({ type: Boolean, attribute: 'hide-back-button' }) diff --git a/src/Umbraco.Web.UI.Client/src/apps/app/app.element.ts b/src/Umbraco.Web.UI.Client/src/apps/app/app.element.ts index 68dd2e5b1b..d48bbbd57d 100644 --- a/src/Umbraco.Web.UI.Client/src/apps/app/app.element.ts +++ b/src/Umbraco.Web.UI.Client/src/apps/app/app.element.ts @@ -25,7 +25,6 @@ import { hasOwnOpener, retrieveStoredPath } from '@umbraco-cms/backoffice/utils' export class UmbAppElement extends UmbLitElement { /** * The base URL of the configured Umbraco server. - * * @attr * @remarks This is the base URL of the Umbraco server, not the base URL of the backoffice. */ @@ -39,7 +38,6 @@ export class UmbAppElement extends UmbLitElement { /** * The base path of the backoffice. - * * @attr */ @property({ type: String }) diff --git a/src/Umbraco.Web.UI.Client/src/apps/app/server-connection.ts b/src/Umbraco.Web.UI.Client/src/apps/app/server-connection.ts index d4e24cb350..6f30829184 100644 --- a/src/Umbraco.Web.UI.Client/src/apps/app/server-connection.ts +++ b/src/Umbraco.Web.UI.Client/src/apps/app/server-connection.ts @@ -24,7 +24,7 @@ export class UmbServerConnection { /** * Gets the URL of the server. - * @return {*} + * @returns {*} * @memberof UmbServerConnection */ getUrl() { @@ -33,7 +33,7 @@ export class UmbServerConnection { /** * Gets the status of the server. - * @return {string} + * @returns {string} * @memberof UmbServerConnection */ getStatus() { @@ -43,7 +43,7 @@ export class UmbServerConnection { /** * Checks if the server is connected. - * @return {boolean} + * @returns {boolean} * @memberof UmbServerConnection */ getIsConnected() { diff --git a/src/Umbraco.Web.UI.Client/src/apps/installer/installer.context.ts b/src/Umbraco.Web.UI.Client/src/apps/installer/installer.context.ts index 37c76e05b0..3fbff9cb89 100644 --- a/src/Umbraco.Web.UI.Client/src/apps/installer/installer.context.ts +++ b/src/Umbraco.Web.UI.Client/src/apps/installer/installer.context.ts @@ -38,7 +38,7 @@ export class UmbInstallerContext { /** * Observable method to get the current step in the installation process * @public - * @return {*} {Observable} + * @returns {*} {Observable} * @memberof UmbInstallerContext */ public currentStepChanges(): Observable { @@ -48,7 +48,7 @@ export class UmbInstallerContext { /** * Observable method to get the install status in the installation process * @public - * @return {*} {(Observable)} + * @returns {*} {(Observable)} * @memberof UmbInstallerContext */ public installStatusChanges(): Observable { @@ -96,7 +96,7 @@ export class UmbInstallerContext { /** * Get the data for the installation process * @public - * @return {*} {PostInstallRequest} + * @returns {*} {PostInstallRequest} * @memberof UmbInstallerContext */ public getData(): InstallRequestModel { diff --git a/src/Umbraco.Web.UI.Client/src/libs/class-api/class.interface.ts b/src/Umbraco.Web.UI.Client/src/libs/class-api/class.interface.ts index 3439b5650e..149ce9ecfb 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/class-api/class.interface.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/class-api/class.interface.ts @@ -13,7 +13,7 @@ export interface UmbClassInterface extends UmbControllerHost { * @description Observe an Observable. An Observable is a declared source of data that can be observed. An observables is declared from a UmbState. * @param {Observable} source An Observable to observe from. * @param {method} callback Callback method called when data is changed. - * @return {UmbObserverController} Reference to the created Observer Controller instance. + * @returns {UmbObserverController} Reference to the created Observer Controller instance. * @memberof UmbClassMixin */ observe< @@ -38,7 +38,7 @@ export interface UmbClassInterface extends UmbControllerHost { * @description Provide a context API for this or child elements. * @param {string} contextAlias * @param {instance} instance The API instance to be exposed. - * @return {UmbContextProviderController} Reference to the created Context Provider Controller instance + * @returns {UmbContextProviderController} Reference to the created Context Provider Controller instance * @memberof UmbClassMixin */ provideContext(alias: string | UmbContextToken, instance: R): UmbContextProviderController; @@ -47,7 +47,7 @@ export interface UmbClassInterface extends UmbControllerHost { * @description Setup a subscription for a context. The callback is called when the context is resolved. * @param {string} contextAlias * @param {method} callback Callback method called when context is resolved. - * @return {UmbContextConsumerController} Reference to the created Context Consumer Controller instance + * @returns {UmbContextConsumerController} Reference to the created Context Consumer Controller instance * @memberof UmbClassMixin */ consumeContext( @@ -58,7 +58,7 @@ export interface UmbClassInterface extends UmbControllerHost { /** * @description Retrieve a context. Notice this is a one time retrieving of a context, meaning if you expect this to be up to date with reality you should instead use the consumeContext method. * @param {string} contextAlias - * @return {Promise} A Promise with the reference to the Context Api Instance + * @returns {Promise} A Promise with the reference to the Context Api Instance * @memberof UmbClassMixin */ getContext( diff --git a/src/Umbraco.Web.UI.Client/src/libs/context-api/consume/context-request.event.ts b/src/Umbraco.Web.UI.Client/src/libs/context-api/consume/context-request.event.ts index 96c27954b4..030b6e45b2 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/context-api/consume/context-request.event.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/context-api/consume/context-request.event.ts @@ -18,7 +18,7 @@ export interface UmbContextRequestEvent extends Event { /** * @export * @class UmbContextRequestEventImplementation - * @extends {Event} + * @augments {Event} * @implements {UmbContextRequestEvent} */ export class UmbContextRequestEventImplementation diff --git a/src/Umbraco.Web.UI.Client/src/libs/context-api/debug/context-data.function.ts b/src/Umbraco.Web.UI.Client/src/libs/context-api/debug/context-data.function.ts index 74bdc34d9b..e82cbc7f37 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/context-api/debug/context-data.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/context-api/debug/context-data.function.ts @@ -1,7 +1,6 @@ /* eslint-disable no-case-declarations */ /** * Change the collection of Contexts into a simplified array of data - * * @param contexts This is a map of the collected contexts from umb-debug * @returns An array of simplified context data */ @@ -16,7 +15,6 @@ export function contextData(contexts: Map): Array /** * Used to find the methods and properties of a context - * * @param contextInstance The instance of the context * @returns A simplied object contain the properties and methods of the context */ @@ -82,8 +80,8 @@ function contextItemData(contextInstance: any): UmbDebugContextItemData { /** * Gets a list of methods from a class - * * @param class The class to get the methods from + * @param klass * @returns An array of method names as strings */ function getClassMethodNames(klass: any) { @@ -104,7 +102,6 @@ function getClassMethodNames(klass: any) { export interface UmbDebugContextData { /** * The alias of the context - * * @type {string} * @memberof UmbDebugContextData */ @@ -112,7 +109,6 @@ export interface UmbDebugContextData { /** * The type of the context such as object or string - * * @type {("string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function")} * @memberof UmbDebugContextData */ @@ -120,7 +116,6 @@ export interface UmbDebugContextData { /** * Data about the context that includes method and property names - * * @type {UmbDebugContextItemData} * @memberof UmbDebugContextData */ @@ -137,7 +132,6 @@ export interface UmbDebugContextItemData { export interface UmbDebugContextItemPropertyData { /** * The name of the property - * * @type {string} * @memberof UmbDebugContextItemPropertyData */ @@ -145,7 +139,6 @@ export interface UmbDebugContextItemPropertyData { /** * The type of the property's value such as string or number - * * @type {("string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function")} * @memberof UmbDebugContextItemPropertyData */ @@ -153,7 +146,6 @@ export interface UmbDebugContextItemPropertyData { /** * Simple types such as string or number can have their value displayed stored inside the property - * * @type {("string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function")} * @memberof UmbDebugContextItemPropertyData */ diff --git a/src/Umbraco.Web.UI.Client/src/libs/context-api/provide/context-provide.event.ts b/src/Umbraco.Web.UI.Client/src/libs/context-api/provide/context-provide.event.ts index 072ec1342b..65789c9fd7 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/context-api/provide/context-provide.event.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/context-api/provide/context-provide.event.ts @@ -13,7 +13,7 @@ export interface UmbContextProvideEvent extends Event { /** * @export * @class UmbContextProvideEventImplementation - * @extends {Event} + * @augments {Event} * @implements {UmbContextProvideEvent} */ export class UmbContextProvideEventImplementation extends Event implements UmbContextProvideEvent { @@ -40,7 +40,7 @@ export interface UmbContextUnprovidedEvent extends Event { /** * @export * @class UmbContextUnprovidedEventImplementation - * @extends {Event} + * @augments {Event} * @implements {UmbContextUnprovidedEvent} */ /* diff --git a/src/Umbraco.Web.UI.Client/src/libs/context-api/provide/context-provider.element.ts b/src/Umbraco.Web.UI.Client/src/libs/context-api/provide/context-provider.element.ts index 7d78d50c1c..5ac97278bc 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/context-api/provide/context-provider.element.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/context-api/provide/context-provider.element.ts @@ -5,7 +5,6 @@ import { UmbControllerHostElementMixin } from '@umbraco-cms/backoffice/controlle /** * Provides a value to the context down the DOM tree. - * * @remarks This element is a wrapper around the `provideContext` function. * @slot - The context will be available to all descendants given in the default slot. * @throws {Error} If the key property is not set. diff --git a/src/Umbraco.Web.UI.Client/src/libs/context-api/token/context-token.ts b/src/Umbraco.Web.UI.Client/src/libs/context-api/token/context-token.ts index 5db192429a..be10a9b5df 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/context-api/token/context-token.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/context-api/token/context-token.ts @@ -12,7 +12,6 @@ export class UmbContextToken | undefined; /** * Get the type of the token - * * @public * @type {T} * @memberOf UmbContextToken @@ -36,7 +35,6 @@ export class UmbContextToken | undefined { @@ -46,7 +44,6 @@ export class UmbContextToken(superClass: T) => { diff --git a/src/Umbraco.Web.UI.Client/src/libs/controller-api/controller-host.mixin.ts b/src/Umbraco.Web.UI.Client/src/libs/controller-api/controller-host.mixin.ts index befc05c0d5..61561ea731 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/controller-api/controller-host.mixin.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/controller-api/controller-host.mixin.ts @@ -11,8 +11,7 @@ interface UmbControllerHostBaseDeclaration extends Omit(superClass: T) => { diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/base-extension-initializer.controller.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/base-extension-initializer.controller.ts index be3570a7ba..3757e0ad5f 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/base-extension-initializer.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/base-extension-initializer.controller.ts @@ -13,7 +13,6 @@ import type { UmbObserverController } from '@umbraco-cms/backoffice/observable-a /** * This abstract Controller holds the core to manage a single Extension. * When the extension is permitted to be used, then the extender of this class can instantiate what is relevant for this type and thereby make it available for the consumer. - * * @export * @abstract * @class UmbBaseExtensionInitializer diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/base-extensions-initializer.controller.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/base-extensions-initializer.controller.ts index 4893f340f9..120ed01b0a 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/base-extensions-initializer.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/base-extensions-initializer.controller.ts @@ -14,7 +14,6 @@ export type PermittedControllerType = /** * This abstract Controller holds the core to manage a multiple Extensions. * When one or more extensions are permitted to be used, then the extender of this class can instantiate the relevant single extension initiator relevant for this type. - * * @export * @abstract * @class UmbBaseExtensionsInitializer diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-api-initializer.controller.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-api-initializer.controller.ts index f72f4887f5..c8610c55d0 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-api-initializer.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-api-initializer.controller.ts @@ -9,7 +9,6 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; /** * This Controller manages a single Extension and its API instance. * When the extension is permitted to be used, its API will be instantiated and available for the consumer. - * * @example * ```ts * const controller = new UmbExtensionApiController(host, extensionRegistry, alias, [], (permitted, ctrl) => { ctrl.api.helloWorld() })); diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-element-and-api-initializer.controller.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-element-and-api-initializer.controller.ts index 176af8f9b7..2dff742462 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-element-and-api-initializer.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-element-and-api-initializer.controller.ts @@ -14,7 +14,6 @@ import type { UmbControllerHost, UmbControllerHostElement } from '@umbraco-cms/b /** * This Controller manages a single Extension initializing its Element and API. * When the extension is permitted to be used, its Element and API will be instantiated and available for the consumer. - * * @example * ```ts * const controller = new UmbExtensionApiAndElementInitializer(host, extensionRegistry, alias, (permitted, ctrl) => { console.log("Extension is permitted and this is the element: ", ctrl.component) })); diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-element-initializer.controller.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-element-initializer.controller.ts index 63eb119c74..9bca28649a 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-element-initializer.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-element-initializer.controller.ts @@ -7,7 +7,6 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; /** * This Controller manages a single Extension and its Element. * When the extension is permitted to be used, its Element will be instantiated and available for the consumer. - * * @example * ```ts * const controller = new UmbExtensionElementController(host, extensionRegistry, alias, (permitted, ctrl) => { console.log("Extension is permitted and this is the element: ", ctrl.component) })); diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-manifest-initializer.controller.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-manifest-initializer.controller.ts index 79339f8b73..966b483bad 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-manifest-initializer.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-manifest-initializer.controller.ts @@ -6,7 +6,6 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; /** * This Controller manages a single Extension and its Manifest. * When the extension is permitted to be used, the manifest is available for the consumer. - * * @example * ```ts * const controller = new UmbExtensionManifestController(host, extensionRegistry, alias, (permitted, ctrl) => { console.log("Extension is permitted and this is the manifest: ", ctrl.manifest) })); diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extensions-api-initializer.controller.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extensions-api-initializer.controller.ts index ddd340623c..0ca1b58929 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extensions-api-initializer.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extensions-api-initializer.controller.ts @@ -15,12 +15,11 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; /** * This Controller manages a set of Extensions and their Manifest. * When one or more extensions is permitted to be used, the callback gives all permitted extensions and their manifest. - * * @example -* ```ts + * ```ts TODO: Correct this, start using builder pattern: -* const controller = new UmbExtensionsApiInitializer(host, extensionRegistry, type, ['constructor argument 1', 'constructor argument '], filter?, (permitted, ctrl) => { console.log("Extension is permitted and this is the manifest: ", ctrl.manifest) })); -* ``` + * const controller = new UmbExtensionsApiInitializer(host, extensionRegistry, type, ['constructor argument 1', 'constructor argument '], filter?, (permitted, ctrl) => { console.log("Extension is permitted and this is the manifest: ", ctrl.manifest) })); + * ``` * @export * @class UmbExtensionsApiInitializer */ diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/create-extension-api.function.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/create-extension-api.function.ts index ef0b8612b9..a168758d3a 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/create-extension-api.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/create-extension-api.function.ts @@ -4,6 +4,12 @@ import { loadManifestApi } from './load-manifest-api.function.js'; import type { UmbApiConstructorArgumentsMethodType } from './types.js'; import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; +/** + * + * @param host + * @param manifest + * @param constructorArgs + */ export async function createExtensionApi( host: UmbControllerHost, manifest: ManifestApi | ManifestElementAndApi, diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/create-extension-element-with-api.function.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/create-extension-element-with-api.function.ts index 0cbed7fbf4..6d52122519 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/create-extension-element-with-api.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/create-extension-element-with-api.function.ts @@ -6,6 +6,13 @@ import { loadManifestElement } from './load-manifest-element.function.js'; import type { UmbApiConstructorArgumentsMethodType } from './types.js'; import type { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller-api'; +/** + * + * @param manifest + * @param constructorArgs + * @param fallbackElement + * @param fallbackApi + */ export async function createExtensionElementWithApi< ElementType extends UmbControllerHostElement, ApiType extends UmbApi = UmbApi, diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/create-extension-element.function.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/create-extension-element.function.ts index fe503df335..38318ccff4 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/create-extension-element.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/create-extension-element.function.ts @@ -1,6 +1,11 @@ import type { ManifestElement, ManifestElementAndApi } from '../types/base.types.js'; import { loadManifestElement } from './load-manifest-element.function.js'; +/** + * + * @param manifest + * @param fallbackElement + */ export async function createExtensionElement( manifest: ManifestElement | ManifestElementAndApi, fallbackElement?: string, diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/has-init-export.function.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/has-init-export.function.ts index 3c808cc56e..af19edfe9f 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/has-init-export.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/has-init-export.function.ts @@ -2,6 +2,7 @@ import type { UmbEntryPointModule } from '../models/entry-point.interface.js'; /** * Validate if an ESModule export has a function called 'onInit' + * @param obj */ export function hasInitExport(obj: unknown): obj is Pick { return obj !== null && typeof obj === 'object' && 'onInit' in obj; diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/has-on-unload-export.function.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/has-on-unload-export.function.ts index 716494239c..8703590d4d 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/has-on-unload-export.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/has-on-unload-export.function.ts @@ -2,6 +2,7 @@ import type { UmbEntryPointModule } from '../models/entry-point.interface.js'; /** * Validate if an ESModule has exported a function called `onUnload` + * @param obj */ export function hasOnUnloadExport(obj: unknown): obj is Pick { return obj !== null && typeof obj === 'object' && 'onUnload' in obj; diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/load-manifest-api.function.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/load-manifest-api.function.ts index f153cf1e22..e168e376a7 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/load-manifest-api.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/load-manifest-api.function.ts @@ -7,6 +7,10 @@ import type { ElementLoaderExports, } from '../types/utils.js'; +/** + * + * @param property + */ export async function loadManifestApi( property: ApiLoaderProperty | ElementAndApiLoaderProperty, ): Promise | undefined> { diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/load-manifest-element.function.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/load-manifest-element.function.ts index 89699f7fe0..9a08338dfb 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/load-manifest-element.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/load-manifest-element.function.ts @@ -6,6 +6,10 @@ import type { ElementLoaderProperty, } from '../types/utils.js'; +/** + * + * @param property + */ export async function loadManifestElement( property: ElementLoaderProperty | ElementAndApiLoaderProperty, ): Promise | undefined> { diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/load-manifest-plain-css.function.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/load-manifest-plain-css.function.ts index 861b220ba0..77ddc1f908 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/load-manifest-plain-css.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/load-manifest-plain-css.function.ts @@ -1,5 +1,9 @@ import type { CssLoaderExports, CssLoaderProperty } from '../types/utils.js'; +/** + * + * @param property + */ export async function loadManifestPlainCss( property: CssLoaderProperty, ): Promise { diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/load-manifest-plain-js.function.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/load-manifest-plain-js.function.ts index 4614de736a..f829237d9a 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/load-manifest-plain-js.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/functions/load-manifest-plain-js.function.ts @@ -1,5 +1,9 @@ import type { JsLoaderProperty } from '../types/utils.js'; +/** + * + * @param property + */ export async function loadManifestPlainJs(property: JsLoaderProperty): Promise { const propType = typeof property; if (propType === 'function') { diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/registry/extension.registry.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/registry/extension.registry.ts index 99449dbf88..2680d599e9 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/registry/extension.registry.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/registry/extension.registry.ts @@ -4,6 +4,11 @@ import { UmbBasicState } from '@umbraco-cms/backoffice/observable-api'; import type { Observable } from '@umbraco-cms/backoffice/external/rxjs'; import { map, distinctUntilChanged, combineLatest, of, switchMap } from '@umbraco-cms/backoffice/external/rxjs'; +/** + * + * @param previousValue + * @param currentValue + */ function extensionArrayMemoization>( previousValue: Array, currentValue: Array, @@ -19,6 +24,11 @@ function extensionArrayMemoization>( return true; } +/** + * + * @param previousValue + * @param currentValue + */ function extensionAndKindMatchArrayMemoization< T extends Pick & { __isMatchedWithKind?: boolean }, >(previousValue: Array, currentValue: Array): boolean { @@ -45,6 +55,11 @@ function extensionAndKindMatchArrayMemoization< return true; } +/** + * + * @param previousValue + * @param currentValue + */ function extensionSingleMemoization>( previousValue: T | undefined, currentValue: T | undefined, @@ -55,6 +70,11 @@ function extensionSingleMemoization>( return previousValue === currentValue; } +/** + * + * @param previousValue + * @param currentValue + */ function extensionAndKindMatchSingleMemoization< T extends Pick & { __isMatchedWithKind?: boolean }, >(previousValue: T | undefined, currentValue: T | undefined): boolean { diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/has-api-export.function.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/has-api-export.function.ts index d9e5c601b1..af4d87e5d6 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/has-api-export.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/has-api-export.function.ts @@ -1,3 +1,7 @@ +/** + * + * @param object + */ export function hasApiExport(object: unknown): object is { api: ConstructorType } { return typeof object === 'object' && object !== null && 'api' in object; } diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/has-default-export.function.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/has-default-export.function.ts index 2353e38f4c..f5bf111fbe 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/has-default-export.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/has-default-export.function.ts @@ -1,3 +1,7 @@ +/** + * + * @param object + */ export function hasDefaultExport(object: unknown): object is { default: ConstructorType } { return typeof object === 'object' && object !== null && 'default' in object; } diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/has-element-export.function.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/has-element-export.function.ts index 241c27efd3..47c66e70fb 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/has-element-export.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/has-element-export.function.ts @@ -1,3 +1,7 @@ +/** + * + * @param object + */ export function hasElementExport(object: unknown): object is { element: ConstructorType } { return typeof object === 'object' && object !== null && 'element' in object; } diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/is-manifest-base-type.function.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/is-manifest-base-type.function.ts index 3e92e93ccb..4c160f44c4 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/is-manifest-base-type.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/is-manifest-base-type.function.ts @@ -1,5 +1,9 @@ import type { ManifestBase } from '../types/manifest-base.interface.js'; +/** + * + * @param x + */ export function isManifestBaseType(x: unknown): x is ManifestBase { return typeof x === 'object' && x !== null && 'alias' in x; } diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/is-manifest-element-name-type.function.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/is-manifest-element-name-type.function.ts index f59f6249e9..ea627dfd86 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/is-manifest-element-name-type.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/type-guards/is-manifest-element-name-type.function.ts @@ -1,5 +1,9 @@ import type { ManifestElement, ManifestElementWithElementName } from '../types/index.js'; +/** + * + * @param manifest + */ export function isManifestElementNameType(manifest: unknown): manifest is ManifestElementWithElementName { return typeof manifest === 'object' && manifest !== null && (manifest as ManifestElement).elementName !== undefined; } diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/types/manifest-base.interface.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/types/manifest-base.interface.ts index 9b82ca4491..cfe485004f 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/types/manifest-base.interface.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/types/manifest-base.interface.ts @@ -11,7 +11,6 @@ export interface ManifestBase { /** * The kind of the extension, used to group extensions together - * * @examples ["button"] */ kind?: unknown; // I had to add the optional kind property set to undefined. To make the ManifestTypes recognize the Manifest Kind types. Notice that Kinds has to Omit the kind property when extending. diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/types/manifest-kind.interface.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/types/manifest-kind.interface.ts index b95853c77c..45831666db 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/types/manifest-kind.interface.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/types/manifest-kind.interface.ts @@ -6,7 +6,6 @@ export interface ManifestKind { /** * Provide pre defined properties for the extension manifest. * Define the `type`-property and other properties you like to preset for implementations of this kind. - * * @example { * type: 'section', * weight: 123, diff --git a/src/Umbraco.Web.UI.Client/src/libs/formatting-api/formatting.controller.ts b/src/Umbraco.Web.UI.Client/src/libs/formatting-api/formatting.controller.ts index e3e2c7578e..427e44e0a3 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/formatting-api/formatting.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/formatting-api/formatting.controller.ts @@ -23,6 +23,7 @@ export class UmbFormattingController extends UmbControllerBase { /** * A method to localize the string input then transform any markdown to santized HTML. + * @param input * @deprecated - Use the `` component instead. This method will be removed in Umbraco 15. */ public transform(input?: string): string { diff --git a/src/Umbraco.Web.UI.Client/src/libs/formatting-api/localizeAndTransform.function.ts b/src/Umbraco.Web.UI.Client/src/libs/formatting-api/localizeAndTransform.function.ts index a066d53bb9..157b6f3e30 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/formatting-api/localizeAndTransform.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/formatting-api/localizeAndTransform.function.ts @@ -2,6 +2,8 @@ import { UmbFormattingController } from './formatting.controller.js'; import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; /** + * @param host + * @param input * @deprecated - Use the `` component instead. This method will be removed in Umbraco 15. */ export function localizeAndTransform(host: UmbControllerHost, input: string): string { diff --git a/src/Umbraco.Web.UI.Client/src/libs/localization-api/localization.controller.ts b/src/Umbraco.Web.UI.Client/src/libs/localization-api/localization.controller.ts index 3eb471f110..49f337f3b4 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/localization-api/localization.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/localization-api/localization.controller.ts @@ -24,7 +24,6 @@ import type { UmbController, UmbControllerHost } from '@umbraco-cms/backoffice/c const LocalizationControllerAlias = Symbol(); /** * The UmbLocalizeController enables localization for your element. - * * @see UmbLocalizeElement * @example * ```ts @@ -108,7 +107,11 @@ export class UmbLocalizationController(key: K, ...args: FunctionParams): string { if (!this.#usedKeys.includes(key)) { this.#usedKeys.push(key); @@ -145,19 +148,32 @@ export class UmbLocalizationController} + * @augments {UmbDeepState} * @description - A RxJS BehaviorSubject which deepFreezes the object-data to ensure its not manipulated from any implementations. * Additionally the Subject ensures the data is unique, not updating any Observes unless there is an actual change of the content. * @@ -22,7 +22,7 @@ export class UmbArrayState extends UmbDeepState { } /** - * @method sortBy + * @function sortBy * @param {(a: T, b: T) => number} sortMethod - A method to be used for sorting every time data is set. * @description - A sort method to this Subject. * @example Example add sort method @@ -43,7 +43,8 @@ export class UmbArrayState extends UmbDeepState { } /** - * @method setValue + * @function setValue + * @param value * @param {T} data - The next data for this state to hold. * @description - Set the data of this state, if sortBy has been defined for this state the data will be sorted before set. If data is different than current this will trigger observations to update. * @example Example change the data of a state @@ -61,9 +62,9 @@ export class UmbArrayState extends UmbDeepState { } /** - * @method remove + * @function remove * @param {unknown[]} uniques - The unique values to remove. - * @return {UmbArrayState} Reference to it self. + * @returns {UmbArrayState} Reference to it self. * @description - Remove some new data of this Subject. * @example Example remove entry with id '1' and '2' * const data = [ @@ -90,9 +91,9 @@ export class UmbArrayState extends UmbDeepState { } /** - * @method removeOne + * @function removeOne * @param {unknown} unique - The unique value to remove. - * @return {UmbArrayState} Reference to it self. + * @returns {UmbArrayState} Reference to it self. * @description - Remove some new data of this Subject. * @example Example remove entry with id '1' * const data = [ @@ -117,9 +118,10 @@ export class UmbArrayState extends UmbDeepState { } /** - * @method filter + * @function filter + * @param predicate * @param {unknown} filterMethod - The unique value to remove. - * @return {UmbArrayState} Reference to it self. + * @returns {UmbArrayState} Reference to it self. * @description - Remove some new data of this Subject. * @example Example remove entry with key '1' * const data = [ @@ -135,7 +137,6 @@ export class UmbArrayState extends UmbDeepState { * { key: 2, value: 'bar'}, * { key: 3, value: 'poo'} * ] - * */ filter(predicate: (value: T, index: number, array: T[]) => boolean) { this.setValue(this.getValue().filter(predicate)); @@ -143,9 +144,9 @@ export class UmbArrayState extends UmbDeepState { } /** - * @method appendOne + * @function appendOne * @param {T} entry - new data to be added in this Subject. - * @return {UmbArrayState} Reference to it self. + * @returns {UmbArrayState} Reference to it self. * @description - Append some new data to this Subject. * @example Example append some data. * const data = [ @@ -167,10 +168,10 @@ export class UmbArrayState extends UmbDeepState { } /** - * @method appendOneAt + * @function appendOneAt * @param {T} entry - new data to be added in this Subject. * @param {T} index - index of where to append this data into the Subject. - * @return {UmbArrayState} Reference to it self. + * @returns {UmbArrayState} Reference to it self. * @description - Append some new data to this Subject. * @example Example append some data. * const data = [ @@ -194,9 +195,9 @@ export class UmbArrayState extends UmbDeepState { } /** - * @method append + * @function append * @param {T[]} entries - A array of new data to be added in this Subject. - * @return {UmbArrayState} Reference to it self. + * @returns {UmbArrayState} Reference to it self. * @description - Append some new data to this Subject, if it compares to existing data it will replace it. * @example Example append some data. * const data = [ @@ -223,10 +224,10 @@ export class UmbArrayState extends UmbDeepState { } /** - * @method updateOne + * @function updateOne * @param {unknown} unique - Unique value to find entry to update. * @param {Partial} entry - new data to be added in this Subject. - * @return {UmbArrayState} Reference to it self. + * @returns {UmbArrayState} Reference to it self. * @description - Update a item with some new data, requires the ArrayState to be constructed with a getUnique method. * @example Example append some data. * const data = [ diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/basic-state.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/basic-state.ts index 4c6394849f..33bfaa968a 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/basic-state.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/basic-state.ts @@ -13,8 +13,8 @@ export class UmbBasicState { } /** - * @method asObservable - * @return {Observable} Observable that the State casts to. + * @function asObservable + * @returns {Observable} Observable that the State casts to. * @description - Creates a new Observable with this State as the source. Observe this to subscribe to its value and future changes. * @example Example observe the data of a state * const myState = new UmbArrayState('Hello world'); @@ -37,8 +37,8 @@ export class UmbBasicState { } /** - * @method getValue - * @return {T} The current data of this state. + * @function getValue + * @returns {T} The current data of this state. * @description - Provides the current data of this state. * @example Example retrieve the current data of a state * const myState = new UmbArrayState('Hello world'); @@ -49,7 +49,7 @@ export class UmbBasicState { } /** - * @method destroy + * @function destroy * @description - Destroys this state and completes all observations made to it. */ public destroy(): void { @@ -58,7 +58,7 @@ export class UmbBasicState { } /** - * @method setValue + * @function setValue * @param {T} data - The next data for this state to hold. * @description - Set the data of this state, if data is different than current this will trigger observations to update. * @example Example change the data of a state diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/boolean-state.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/boolean-state.ts index ce7acf7773..e6e07d10cf 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/boolean-state.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/boolean-state.ts @@ -3,7 +3,7 @@ import { UmbBasicState } from './basic-state.js'; /** * @export * @class UmbBooleanState - * @extends {UmbBasicState} + * @augments {UmbBasicState} * @description - This state ensures the data is unique, not updating any Observes unless there is an actual change of the value. */ export class UmbBooleanState extends UmbBasicState { diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/class-state.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/class-state.ts index 6f5609c156..628054f65a 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/class-state.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/class-state.ts @@ -10,7 +10,7 @@ export interface UmbClassStateData { /** * @export * @class UmbClassState - * @extends {UmbBasicState} + * @augments {UmbBasicState} * @description - This state can hold class instance which has a equal method to compare in coming instances for changes. */ export class UmbClassState extends UmbBasicState { @@ -20,7 +20,7 @@ export class UmbClassState extends UmbB /** * @export - * @method createObservablePart + * @function createObservablePart * @param {(mappable: T) => R} mappingFunction - Method to return the part for this Observable to return. * @param {(previousResult: R, currentResult: R) => boolean} [memoizationFunction] - Method to Compare if the data has changed. Should return true when data is different. * @description - Creates an Observable from this State. @@ -33,7 +33,7 @@ export class UmbClassState extends UmbB } /** - * @method setValue + * @function setValue * @param {T} data - The next data for this state to hold. * @description - Set the data of this state, if data is different than current this will trigger observations to update. */ diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/deep-state.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/deep-state.ts index f17d3ce54d..5c115cdf10 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/deep-state.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/deep-state.ts @@ -8,7 +8,7 @@ import { UmbBasicState } from './basic-state.js'; /** * @export * @class UmbDeepState - * @extends {BehaviorSubject} + * @augments {BehaviorSubject} * @description - A RxJS BehaviorSubject which deepFreezes the data to ensure its not manipulated from any implementations. * Additionally the Subject ensures the data is unique, not updating any Observes unless there is an actual change of the content. */ @@ -22,7 +22,7 @@ export class UmbDeepState extends UmbBasicState { } /** - * @method createObservablePart + * @function createObservablePart * @param {(mappable: T) => R} mappingFunction - Method to return the part for this Observable to return. * @param {(previousResult: R, currentResult: R) => boolean} [memoizationFunction] - Method to Compare if the data has changed. Should return true when data is different. * @returns {Observable} @@ -36,7 +36,7 @@ export class UmbDeepState extends UmbBasicState { } /** - * @method setValue + * @function setValue * @param {T} data - The next data for this state to hold. * @description - Set the data of this state, if data is different than current this will trigger observations to update. */ @@ -55,7 +55,7 @@ export class UmbDeepState extends UmbBasicState { } /** - * @method mute + * @function mute * @description - Set mute for this state. */ mute() { @@ -64,7 +64,7 @@ export class UmbDeepState extends UmbBasicState { } /** - * @method unmute + * @function unmute * @description - Unset the mute of this state. */ unmute() { @@ -77,7 +77,7 @@ export class UmbDeepState extends UmbBasicState { } /** - * @method isMuted + * @function isMuted * @description - Check if the state is muted. * @returns {boolean} - Returns true if the state is muted. */ @@ -86,7 +86,7 @@ export class UmbDeepState extends UmbBasicState { } /** - * @method getMutePromise + * @function getMutePromise * @description - Get a promise which resolves when the mute is unset. * @returns {Promise} */ diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/number-state.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/number-state.ts index d508418117..37af3b62d1 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/number-state.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/number-state.ts @@ -3,7 +3,7 @@ import { UmbBasicState } from './basic-state.js'; /** * @export * @class UmbNumberState - * @extends {BehaviorSubject} + * @augments {BehaviorSubject} * @description - State holding data of number, this ensures the data is unique, not updating any Observes unless there is an actual change of the value bu using `===`. */ export class UmbNumberState extends UmbBasicState { diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/object-state.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/object-state.ts index b325d50b8a..4519888e76 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/object-state.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/object-state.ts @@ -3,7 +3,7 @@ import { UmbDeepState } from './deep-state.js'; /** * @export * @class UmbObjectState - * @extends {UmbDeepState} + * @augments {UmbDeepState} * @description - A RxJS BehaviorSubject which deepFreezes the object-data to ensure its not manipulated from any implementations. * Additionally the Subject ensures the data is unique, not updating any Observes unless there is an actual change of the content. * @@ -11,10 +11,10 @@ import { UmbDeepState } from './deep-state.js'; */ export class UmbObjectState extends UmbDeepState { /** - * @method update + * @function update * @param {Partial} partialData - A object containing some of the data to update in this Subject. * @description - Append some new data to this Object. - * @return {UmbObjectState} Reference to it self. + * @returns {UmbObjectState} Reference to it self. * @example Example append some data. * const data = {key: 'myKey', value: 'myInitialValue'}; * const myState = new UmbObjectState(data); diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/string-state.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/string-state.ts index 7208de66fc..20052e3564 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/string-state.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/states/string-state.ts @@ -5,7 +5,7 @@ import { UmbBasicState } from './basic-state.js'; /** * @export * @class UmbStringState - * @extends {UmbBasicState} + * @augments {UmbBasicState} * @description - A state holding string data, this ensures the data is unique, not updating any Observes unless there is an actual change of the value, by using `===`. */ export class UmbStringState extends UmbBasicState { diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/append-to-frozen-array.function.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/append-to-frozen-array.function.ts index b70fa4b335..14e16a6bc4 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/append-to-frozen-array.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/append-to-frozen-array.function.ts @@ -1,7 +1,8 @@ /** * @export - * @method appendToFrozenArray + * @function appendToFrozenArray * @param {Array} source - An Array which is frozen and should be updated. + * @param data * @param {T} entry - A new entry to append to the array. * @param {(entry: T) => unknown} getUniqueMethod - Method to retrieve a value of an entry that is unique to it. This enables the method to replace existing value if it matches the unique value. * @returns {Array} - Returns a new array with the new entry appended. diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/assign-to-frozen-object.function.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/assign-to-frozen-object.function.ts index f0f2665bbb..f0e7bfafe7 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/assign-to-frozen-object.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/assign-to-frozen-object.function.ts @@ -1,3 +1,8 @@ +/** + * + * @param target + * @param source + */ export function assignToFrozenObject(target: T, source: Partial): T { return Object.assign(Object.create(Object.getPrototypeOf(target)), target, source); } diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/create-observable-part.function.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/create-observable-part.function.ts index 8d7f4b728a..8377be60be 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/create-observable-part.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/create-observable-part.function.ts @@ -6,7 +6,7 @@ import { distinctUntilChanged, map, shareReplay } from '@umbraco-cms/backoffice/ /** * @export - * @method createObservablePart + * @function createObservablePart * @param {Observable} source - RxJS Subject to use for this Observable. * @param {(mappable: T) => R} mappingFunction - Method to return the part for this Observable to return. * @param {(previousResult: R, currentResult: R) => boolean} [memoizationFunction] - Method to Compare if the data has changed. Should return true when data is different. diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/default-memoization.function.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/default-memoization.function.ts index a5b3eb951e..62859de397 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/default-memoization.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/default-memoization.function.ts @@ -2,7 +2,7 @@ import { jsonStringComparison } from './json-string-comparison.function.js'; /** * @export - * @method defaultMemoization + * @function defaultMemoization * @param {any} previousValue - The previous value to compare. * @param {any} currentValue - The current value to compare. * @returns {boolean} - Returns true if the values are identical. diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/filter-frozen-array.function.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/filter-frozen-array.function.ts index e9e2659ca4..410d2bab0b 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/filter-frozen-array.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/filter-frozen-array.function.ts @@ -1,6 +1,6 @@ /** * @export - * @method filterFrozenArray + * @function filterFrozenArray * @param {Array} data - RxJS Subject to use for this Observable. * @param {(entry: T) => boolean} filterMethod - Method to filter the array. * @description - Creates a RxJS Observable from RxJS Subject. diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/json-string-comparison.function.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/json-string-comparison.function.ts index cf46f388e4..d0eaa4f4c5 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/json-string-comparison.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/json-string-comparison.function.ts @@ -1,6 +1,6 @@ /** * @export - * @method jsonStringComparison + * @function jsonStringComparison * @param {unknown} a - The first object to compare. * @param {unknown} b - The second object to compare. * @returns {boolean} - Returns true if the JSON strings are identical. diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/merge-observables.function.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/merge-observables.function.ts index 4824eaa926..5db0262d85 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/merge-observables.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/merge-observables.function.ts @@ -10,7 +10,7 @@ type ArrayToObservableTypes>> = { /** * @export - * @method mergeObservables + * @function mergeObservables * @param {Array>} sources - an Array of Observables to merge for this Observable. * @param {(mappable: Array) => R} mergeFunction - Merge method to return the part for this Observable to return. * @param {(previousResult: R, currentResult: R) => boolean} [memoizationFunction] - Method to Compare if the merged data has changed. Should return true when data is different. diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/observe-multiple.function.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/observe-multiple.function.ts index 8a4704a280..febbcb8b11 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/observe-multiple.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/observe-multiple.function.ts @@ -2,7 +2,7 @@ import { combineLatest } from '@umbraco-cms/backoffice/external/rxjs'; /** * @export - * @method observeMultiple + * @function observeMultiple * @param {Array>} sources - an Array of Observables to use for this combined observation. * @description - combines multiple Observables into a single Observable that can be observed. * @returns {Observable>} - Returns a new Observable that combines the Observables into a single Observable with the values of the given Observables in an Array with the same order as the Array of Observables. diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/partial-update-frozen-array.function.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/partial-update-frozen-array.function.ts index c97db83e42..d00d3843c8 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/partial-update-frozen-array.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/partial-update-frozen-array.function.ts @@ -1,7 +1,10 @@ /** * @export - * @method partialUpdateFrozenArray + * @function partialUpdateFrozenArray * @param {Observable} source - RxJS Subject to use for this Observable. + * @param data + * @param partialEntry + * @param findMethod * @param {(mappable: T) => R} mappingFunction - Method to return the part for this Observable to return. * @param {(previousResult: R, currentResult: R) => boolean} [memoizationFunction] - Method to Compare if the data has changed. Should return true when data is different. * @description - Creates a RxJS Observable from RxJS Subject. diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/push-at-to-unique-array.function.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/push-at-to-unique-array.function.ts index 5c96db318f..37408e6f06 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/push-at-to-unique-array.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/push-at-to-unique-array.function.ts @@ -1,7 +1,8 @@ /** * @export - * @method pushToUniqueArray + * @function pushToUniqueArray * @param {T[]} data - An array of objects. + * @param index * @param {T} entry - The object to insert or replace with. * @param {getUniqueMethod: (entry: T) => unknown} [getUniqueMethod] - Method to get the unique value of an entry. * @description - Append or replaces an item of an Array. diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/push-to-unique-array.function.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/push-to-unique-array.function.ts index 4c6f4e0978..468565335e 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/push-to-unique-array.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/push-to-unique-array.function.ts @@ -1,6 +1,6 @@ /** * @export - * @method pushToUniqueArray + * @function pushToUniqueArray * @param {T[]} data - An array of objects. * @param {T} entry - The object to insert or replace with. * @param {getUniqueMethod: (entry: T) => unknown} [getUniqueMethod] - Method to get the unique value of an entry. diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/simple-hash-code.function.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/simple-hash-code.function.ts index 2e02997326..077a6fd06b 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/simple-hash-code.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/simple-hash-code.function.ts @@ -1,7 +1,7 @@ /** * Returns a hash code from a string - * @param {String} str - The string to hash. - * @return {Number} - A 32bit integer + * @param {string} str - The string to hash. + * @returns {number} - A 32bit integer */ export function simpleHashCode(str: string) { let hash = 0, diff --git a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/strict-equality-memoization.function.ts b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/strict-equality-memoization.function.ts index ca2dc61675..e0d0c4112c 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/strict-equality-memoization.function.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/strict-equality-memoization.function.ts @@ -1,6 +1,6 @@ /** * @export - * @method strictEqualityMemoization + * @function strictEqualityMemoization * @param {unknown} previousValue - The previous value to compare. * @param {unknown} currentValue - The current value to compare. * @returns {boolean} - Returns true if the values are identical. diff --git a/src/Umbraco.Web.UI.Client/src/mocks/data/examine.data.ts b/src/Umbraco.Web.UI.Client/src/mocks/data/examine.data.ts index 75124653fe..d639085407 100644 --- a/src/Umbraco.Web.UI.Client/src/mocks/data/examine.data.ts +++ b/src/Umbraco.Web.UI.Client/src/mocks/data/examine.data.ts @@ -5,6 +5,10 @@ import type { } from '@umbraco-cms/backoffice/external/backend-api'; import { HealthStatusModel } from '@umbraco-cms/backoffice/external/backend-api'; +/** + * + * @param indexName + */ export function getIndexByName(indexName: string) { return Indexers.find((index) => { if (index.name) return index.name.toLocaleLowerCase() == indexName.toLocaleLowerCase(); @@ -12,6 +16,9 @@ export function getIndexByName(indexName: string) { }); } +/** + * + */ export function getSearchResultsMockData(): SearchResultResponseModel[] { return searchResultMockData; } diff --git a/src/Umbraco.Web.UI.Client/src/mocks/data/health-check.data.ts b/src/Umbraco.Web.UI.Client/src/mocks/data/health-check.data.ts index 5b884b0cba..c21d88e50a 100644 --- a/src/Umbraco.Web.UI.Client/src/mocks/data/health-check.data.ts +++ b/src/Umbraco.Web.UI.Client/src/mocks/data/health-check.data.ts @@ -4,10 +4,18 @@ import type { } from '@umbraco-cms/backoffice/external/backend-api'; import { StatusResultTypeModel } from '@umbraco-cms/backoffice/external/backend-api'; +/** + * + * @param name + */ export function getGroupByName(name: string) { return healthGroupsWithoutResult.find((group) => group.name?.toLowerCase() == name.toLowerCase()); } +/** + * + * @param name + */ export function getGroupWithResultsByName(name: string) { return healthGroups.find((group) => group.name.toLowerCase() === name.toLowerCase()); } diff --git a/src/Umbraco.Web.UI.Client/src/mocks/data/user-group/user-group.db.ts b/src/Umbraco.Web.UI.Client/src/mocks/data/user-group/user-group.db.ts index 60d8f4fbf2..5df763d89e 100644 --- a/src/Umbraco.Web.UI.Client/src/mocks/data/user-group/user-group.db.ts +++ b/src/Umbraco.Web.UI.Client/src/mocks/data/user-group/user-group.db.ts @@ -34,7 +34,7 @@ export class UmbUserGroupMockDB extends UmbEntityMockDbBase { /** * Get current user - * @return {*} {UmbCurrentUser} + * @returns {*} {UmbCurrentUser} * @memberof UmbUserData */ getCurrentUser(): CurrentUserResponseModel { diff --git a/src/Umbraco.Web.UI.Client/src/mocks/data/utils/paged-result.ts b/src/Umbraco.Web.UI.Client/src/mocks/data/utils/paged-result.ts index ef584dbd48..8999f73d53 100644 --- a/src/Umbraco.Web.UI.Client/src/mocks/data/utils/paged-result.ts +++ b/src/Umbraco.Web.UI.Client/src/mocks/data/utils/paged-result.ts @@ -1,3 +1,9 @@ +/** + * + * @param allItems + * @param skip + * @param take + */ export function pagedResult(allItems: T[], skip: number, take: number) { const total = allItems.length; const paginatedItems = allItems.slice(skip, take + skip); diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/components/block-grid-block-inline/block-grid-inline-property-dataset.context.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/components/block-grid-block-inline/block-grid-inline-property-dataset.context.ts index 7fc1c7436f..6f8f9c6a95 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/components/block-grid-block-inline/block-grid-inline-property-dataset.context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/components/block-grid-block-inline/block-grid-inline-property-dataset.context.ts @@ -37,6 +37,7 @@ export class UmbBlockGridInlinePropertyDatasetContext extends UmbControllerBase /** * TODO: Write proper JSDocs here. + * @param propertyAlias */ async propertyValueByAlias(propertyAlias: string) { // TODO: Investigate how I do that with the workspaces.. @@ -45,6 +46,8 @@ export class UmbBlockGridInlinePropertyDatasetContext extends UmbControllerBase /** * TODO: Write proper JSDocs here. + * @param propertyAlias + * @param value */ async setPropertyValue(propertyAlias: string, value: unknown) { // TODO: Investigate how I do that with the workspaces.. diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/components/block-grid-entries/block-grid-entries.element.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/components/block-grid-entries/block-grid-entries.element.ts index 9ce184c1be..3ef9c550b1 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/components/block-grid-entries/block-grid-entries.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/components/block-grid-entries/block-grid-entries.element.ts @@ -20,6 +20,7 @@ import type { UmbBlockGridLayoutModel } from '@umbraco-cms/backoffice/block-grid /** * Notice this utility method is not really shareable with others as it also takes areas into account. [NL] + * @param args */ function resolvePlacementAsGrid(args: resolvePlacementArgs) { // If this has areas, we do not want to move, unless we are at the edge diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/context/block-grid-manager.context.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/context/block-grid-manager.context.ts index a27b8bf65c..15ae596750 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/context/block-grid-manager.context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/context/block-grid-manager.context.ts @@ -73,12 +73,13 @@ export class UmbBlockGridManagerContext< /** * Inserts a layout entry into an area of a layout entry. * @param layoutEntry The layout entry to insert. + * @param insert * @param entries The layout entries to search within. * @param parentUnique The parentUnique to search for. + * @param parentId * @param areaKey The areaKey to insert the layout entry into. * @param index The index to insert the layout entry at. * @returns a updated layout entries array if the insert was successful. - * * @remarks * This method is recursive and will search for the parentUnique in the layout entries. * If the parentUnique is found, the layout entry will be inserted into the items of the area that matches the areaKey. diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/utils/index.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/utils/index.ts index f46dced98d..3b3970ac62 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/utils/index.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block-grid/utils/index.ts @@ -1,3 +1,9 @@ +/** + * + * @param target + * @param map + * @param max + */ export function closestColumnSpanOption(target: number, map: Array, max: number) { if (map.length > 0) { const result = map.reduce((a, b) => { diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block-rte/context/block-rte-manager.context.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block-rte/context/block-rte-manager.context.ts index 54417230b0..f8eedba484 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block-rte/context/block-rte-manager.context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block-rte/context/block-rte-manager.context.ts @@ -80,7 +80,10 @@ export class UmbBlockRteManagerContext< return true; } - /** @internal */ + /** + * @param contentUdi + * @internal + */ public deleteLayoutElement(contentUdi: string) { if (!this.#editor) return; diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block/context/block-entry.context.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block/context/block-entry.context.ts index 9dd27d8944..3436a7818b 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block/context/block-entry.context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block/context/block-entry.context.ts @@ -133,7 +133,7 @@ export abstract class UmbBlockEntryContext< /** * Set the contentUdi of this entry. - * @method setContentUdi + * @function setContentUdi * @param {string} contentUdi the entry content UDI. * @returns {void} */ @@ -144,7 +144,7 @@ export abstract class UmbBlockEntryContext< /** * Get the current value of this Blocks label. - * @method getLabel + * @function getLabel * @returns {string} */ getLabel() { diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block/context/block-manager.context.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block/context/block-manager.context.ts index ffc8c85022..680669faa3 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block/context/block-manager.context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block/context/block-manager.context.ts @@ -12,6 +12,11 @@ import type { UmbPropertyEditorConfigCollection } from '@umbraco-cms/backoffice/ import { UMB_PROPERTY_CONTEXT } from '@umbraco-cms/backoffice/property'; import type { UmbVariantId } from '@umbraco-cms/backoffice/variant'; +/** + * + * @param entityType + * @param guid + */ function buildUdi(entityType: string, guid: string) { return `umb://${entityType}/${guid.replace(/-/g, '')}`; } diff --git a/src/Umbraco.Web.UI.Client/src/packages/block/block/workspace/block-element-property-dataset.context.ts b/src/Umbraco.Web.UI.Client/src/packages/block/block/workspace/block-element-property-dataset.context.ts index ae47ee00f9..22a0d90c66 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/block/block/workspace/block-element-property-dataset.context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/block/block/workspace/block-element-property-dataset.context.ts @@ -37,6 +37,7 @@ export class UmbBlockElementPropertyDatasetContext extends UmbControllerBase imp /** * TODO: Write proper JSDocs here. + * @param propertyAlias */ async propertyValueByAlias(propertyAlias: string) { return await this.#elementManager.propertyValueByAlias(propertyAlias); @@ -44,6 +45,8 @@ export class UmbBlockElementPropertyDatasetContext extends UmbControllerBase imp /** * TODO: Write proper JSDocs here. + * @param propertyAlias + * @param value */ async setPropertyValue(propertyAlias: string, value: unknown) { return this.#elementManager.setPropertyValue(propertyAlias, value); diff --git a/src/Umbraco.Web.UI.Client/src/packages/code-editor/code-editor.controller.ts b/src/Umbraco.Web.UI.Client/src/packages/code-editor/code-editor.controller.ts index a4c041da7a..5b1341d25e 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/code-editor/code-editor.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/code-editor/code-editor.controller.ts @@ -23,8 +23,6 @@ import { UmbControllerBase } from '@umbraco-cms/backoffice/class-api'; * By using monaco library directly you can access the entire monaco API along with code completions, actions etc. This class creates some level of abstraction over the monaco editor. It only provides basic functionality, that should be enough for most of the use cases and should be possible to implement with any code editor library. * * Current issues: [shadow DOM related issues](https://github.com/microsoft/monaco-editor/labels/editor-shadow-dom) #3217 currently fixed by a hack , [razor syntax highlight](https://github.com/microsoft/monaco-editor/issues/1997) - * - * * @export * @class UmbCodeEditor */ @@ -35,7 +33,6 @@ export class UmbCodeEditorController extends UmbControllerBase { /** * The monaco editor object. This is the actual monaco editor object. It is exposed for advanced usage, but mind the fact that editor might be swapped in the future for a different library, so use on your own responsibility. For more information see [monaco editor API](https://microsoft.github.io/monaco-editor/docs.html#interfaces/editor.IStandaloneCodeEditor.html). - * * @readonly * @memberof UmbCodeEditor */ @@ -47,7 +44,6 @@ export class UmbCodeEditorController extends UmbControllerBase { /** * The options used to create the editor. - * * @readonly * @type {CodeEditorConstructorOptions} * @memberof UmbCodeEditor @@ -70,7 +66,6 @@ export class UmbCodeEditorController extends UmbControllerBase { /** * Provides the current position of the cursor. - * * @readonly * @memberof UmbCodeEditor */ @@ -82,7 +77,6 @@ export class UmbCodeEditorController extends UmbControllerBase { /** * Provides positions of all the secondary cursors. - * * @readonly * @memberof UmbCodeEditor */ @@ -92,7 +86,6 @@ export class UmbCodeEditorController extends UmbControllerBase { /** * Provides the current value of the editor. - * * @memberof UmbCodeEditor */ get value() { @@ -112,7 +105,6 @@ export class UmbCodeEditorController extends UmbControllerBase { /** * Provides the current model of the editor. For advanced usage. Bare in mind that in case of the monaco library being swapped in the future, this might not be available. For more information see [monaco editor model API](https://microsoft.github.io/monaco-editor/docs.html#interfaces/editor.ITextModel.html). - * * @readonly * @memberof UmbCodeEditor */ @@ -179,7 +171,6 @@ export class UmbCodeEditorController extends UmbControllerBase { } /** * Updates the options of the editor. This is useful for updating the options after the editor has been created. - * * @param {CodeEditorConstructorOptions} newOptions * @memberof UmbCodeEditor */ @@ -201,8 +192,7 @@ export class UmbCodeEditorController extends UmbControllerBase { } /** * Provides the current selections of the editor. - * - * @return {*} {UmbCodeEditorSelection[]} + * @returns {*} {UmbCodeEditorSelection[]} * @memberof UmbCodeEditor */ getSelections(): UmbCodeEditorSelection[] { @@ -211,8 +201,7 @@ export class UmbCodeEditorController extends UmbControllerBase { } /** * Provides the current positions of the cursor or multiple cursors. - * - * @return {*} {(UmbCodeEditorCursorPosition | null)} + * @returns {*} {(UmbCodeEditorCursorPosition | null)} * @memberof UmbCodeEditor */ getPositions(): UmbCodeEditorCursorPosition | null { @@ -221,7 +210,6 @@ export class UmbCodeEditorController extends UmbControllerBase { } /** * Inserts text at the current cursor position or multiple cursor positions. - * * @param {string} text * @memberof UmbCodeEditor */ @@ -237,10 +225,9 @@ export class UmbCodeEditorController extends UmbControllerBase { } /** * Looks for a string or matching strings in the editor and returns the ranges of the found strings. Can use regex, case sensitive and more. If you want regex set the isRegex to true in the options. - * * @param {string} searchString - * @param {CodeEditorSearchOptions} [searchOptions={}] - * @return {*} {UmbCodeEditorRange[]} + * @param {CodeEditorSearchOptions} [searchOptions] + * @returns {*} {UmbCodeEditorRange[]} * @memberof UmbCodeEditor */ find( @@ -277,9 +264,8 @@ export class UmbCodeEditorController extends UmbControllerBase { } /** * Returns the value of the editor for a given range. - * * @param {UmbCodeEditorRange} range - * @return {*} {string} + * @returns {*} {string} * @memberof UmbCodeEditor */ getValueInRange(range: UmbCodeEditorRange): string { @@ -288,7 +274,6 @@ export class UmbCodeEditorController extends UmbControllerBase { } /** * Inserts text at a given position. - * * @param {string} text * @param {UmbCodeEditorCursorPosition} position * @memberof UmbCodeEditor @@ -310,7 +295,6 @@ export class UmbCodeEditorController extends UmbControllerBase { /** * Selects a range of text in the editor. - * * @param {UmbCodeEditorRange} range * @memberof UmbCodeEditor */ @@ -321,7 +305,6 @@ export class UmbCodeEditorController extends UmbControllerBase { /** * Changes the theme of the editor. - * * @template T * @param {(CodeEditorTheme | T)} theme * @memberof UmbCodeEditor @@ -333,7 +316,6 @@ export class UmbCodeEditorController extends UmbControllerBase { /** * Runs callback on change of model content. (for example when typing) - * * @param {() => void} callback * @memberof UmbCodeEditor */ @@ -346,7 +328,6 @@ export class UmbCodeEditorController extends UmbControllerBase { /** * Runs callback on change of model (when the entire model is replaced ) - * * @param {() => void} callback * @memberof UmbCodeEditor */ @@ -358,7 +339,6 @@ export class UmbCodeEditorController extends UmbControllerBase { } /** * Runs callback on change of cursor position. Gives as parameter the new position. - * * @param {((e: UmbCodeEditorCursorPositionChangedEvent | undefined) => void)} callback * @memberof UmbCodeEditor */ @@ -370,7 +350,6 @@ export class UmbCodeEditorController extends UmbControllerBase { } /** * Runs callback on change of cursor selection. Gives as parameter the new selection. - * * @param {((e: UmbCodeEditorCursorSelectionChangedEvent | undefined) => void)} callback * @memberof UmbCodeEditor */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/code-editor/components/code-editor.element.ts b/src/Umbraco.Web.UI.Client/src/packages/code-editor/components/code-editor.element.ts index 128b78982a..1927f0e341 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/code-editor/components/code-editor.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/code-editor/components/code-editor.element.ts @@ -28,12 +28,10 @@ const elementName = 'umb-code-editor'; * A custom element that renders a code editor. Code editor is based on the Monaco Editor library. * The element will listen to the theme context and update the theme accordingly. * Parts of the monaco Api is exposed through the `editor` property. You can access the monaco editor instance through `editor.monacoEditor`. - * * @element umb-code-editor - * * @export * @class UmbCodeEditorElement - * @extends {UmbLitElement} + * @augments {UmbLitElement} * @implements {UmbCodeEditorHost} * @fires input - Fired when the value of the editor changes. * @fires change - Fired when the entire model of editor is replaced. @@ -56,7 +54,6 @@ export class UmbCodeEditorElement extends UmbLitElement implements UmbCodeEditor /** * Theme of the editor. Default is light. Element will listen to the theme context and update the theme accordingly. - * * @type {CodeEditorTheme} * @memberof UmbCodeEditorElement */ @@ -65,7 +62,6 @@ export class UmbCodeEditorElement extends UmbLitElement implements UmbCodeEditor /** * Language of the editor. Default is javascript. - * * @type {CodeEditorLanguage} * @memberof UmbCodeEditorElement */ @@ -74,7 +70,6 @@ export class UmbCodeEditorElement extends UmbLitElement implements UmbCodeEditor /** * Label of the editor. Default is 'Code Editor'. - * * @memberof UmbCodeEditorElement */ @property() @@ -85,7 +80,6 @@ export class UmbCodeEditorElement extends UmbLitElement implements UmbCodeEditor /** * Value of the editor. Default is empty string. - * * @readonly * @memberof UmbCodeEditorElement */ @@ -105,7 +99,6 @@ export class UmbCodeEditorElement extends UmbLitElement implements UmbCodeEditor /** * Whether the editor is readonly. - * * @memberof UmbCodeEditorElement */ @property({ type: Boolean, attribute: 'readonly' }) @@ -113,7 +106,6 @@ export class UmbCodeEditorElement extends UmbLitElement implements UmbCodeEditor /** * Whether to show line numbers. - * * @memberof UmbCodeEditorElement */ @property({ type: Boolean, attribute: 'disable-line-numbers' }) @@ -121,7 +113,6 @@ export class UmbCodeEditorElement extends UmbLitElement implements UmbCodeEditor /** * Whether to show minimap. - * * @memberof UmbCodeEditorElement */ @property({ type: Boolean, attribute: 'disable-minimap' }) @@ -129,7 +120,6 @@ export class UmbCodeEditorElement extends UmbLitElement implements UmbCodeEditor /** * Whether to enable word wrap. Default is false. - * * @memberof UmbCodeEditorElement */ @property({ type: Boolean, attribute: 'word-wrap' }) @@ -137,7 +127,6 @@ export class UmbCodeEditorElement extends UmbLitElement implements UmbCodeEditor /** * Whether to enable folding. Default is true. - * * @memberof UmbCodeEditorElement */ @property({ type: Boolean, attribute: 'disable-folding' }) @@ -221,7 +210,6 @@ export class UmbCodeEditorElement extends UmbLitElement implements UmbCodeEditor /** * Inserts text at the current cursor position. - * * @param {string} text * @memberof UmbCodeEditorElement */ @@ -231,9 +219,8 @@ export class UmbCodeEditorElement extends UmbLitElement implements UmbCodeEditor /** * Finds all occurrence of the given string or matches the given regular expression. - * * @param {string} text - * @return {*} + * @returns {*} * @memberof UmbCodeEditorElement */ find(text: string, searchOptions: CodeEditorSearchOptions = {}) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/code-editor/models/code-editor.model.ts b/src/Umbraco.Web.UI.Client/src/packages/code-editor/models/code-editor.model.ts index 30109cb436..04c68d2e5c 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/code-editor/models/code-editor.model.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/code-editor/models/code-editor.model.ts @@ -203,35 +203,30 @@ export interface CodeEditorConstructorOptions { export interface CodeEditorSearchOptions { /** * Limit the searching to only search inside the editable range of the model. - * * @type {boolean} * @memberof CodeEditorSearchOptions */ searchOnlyEditableRange?: boolean; /** * Used to indicate that searchString is a regular expression. - * * @type {boolean} * @memberof CodeEditorSearchOptions */ isRegex?: boolean; /** * Force the matching to match lower/upper case exactly. - * * @type {boolean} * @memberof CodeEditorSearchOptions */ matchCase?: boolean; /** * Force the matching to match entire words only. Pass null otherwise. - * * @type {string} * @memberof CodeEditorSearchOptions */ wordSeparators?: string | null; /** * The result will contain the captured groups. - * * @type {boolean} * @memberof CodeEditorSearchOptions */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/code-editor/themes/index.ts b/src/Umbraco.Web.UI.Client/src/packages/code-editor/themes/index.ts index bf9894f126..e85333503e 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/code-editor/themes/index.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/code-editor/themes/index.ts @@ -7,8 +7,7 @@ import type { monaco } from '@umbraco-cms/backoffice/external/monaco-editor'; /** * 4 themes for the code editor. - * - * @type {*} */ + @type {*} */ const themes: Record = { 'umb-dark': UmbCodeEditorThemeDark, 'umb-light': UmbCodeEditorThemeLight, diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/auth/auth-flow.ts b/src/Umbraco.Web.UI.Client/src/packages/core/auth/auth-flow.ts index 6df36be6b9..a23d31729b 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/auth/auth-flow.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/auth/auth-flow.ts @@ -197,7 +197,6 @@ export class UmbAuthFlow { /** * Make an authorization request to the server using the specified identity provider. * This method will redirect the user to the authorization endpoint of the server. - * * @param identityProvider The identity provider to use for the authorization request. * @param usernameHint (Optional) The username to use for the authorization request. It will be provided to the OpenID server as a hint. */ @@ -234,7 +233,6 @@ export class UmbAuthFlow { /** * This method will check if the user is logged in by validating if there is a token stored. * If no token is stored, it will return false. - * * @returns true if the user is logged in, false otherwise. */ isAuthorized(): boolean { @@ -307,7 +305,6 @@ export class UmbAuthFlow { /** * This method will check if the token needs to be refreshed and if so, it will refresh it and return the new access token. * If the token does not need to be refreshed, it will return the current access token. - * * @returns The access token for the user. */ async performWithFreshTokens(): Promise { @@ -357,6 +354,8 @@ export class UmbAuthFlow { /** * This method will unlink the current user from the specified provider. + * @param loginProvider + * @param providerKey */ async unlinkLogin(loginProvider: string, providerKey: string): Promise { const token = await this.performWithFreshTokens(); @@ -389,6 +388,8 @@ export class UmbAuthFlow { /** * This method will make a token request to the server using the authorization code. + * @param code + * @param codeVerifier */ async #makeTokenRequest(code: string, codeVerifier: string | undefined): Promise { const extras: StringMap = {}; @@ -430,6 +431,7 @@ export class UmbAuthFlow { /** * This method will make a token request to the server using the refresh token. * If the request fails, it will sign the user out (clear the token state). + * @param request */ async #performTokenRequest(request: TokenRequest): Promise { try { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/auth/auth.context.ts b/src/Umbraco.Web.UI.Client/src/packages/core/auth/auth.context.ts index c39aff0bb8..01263f311d 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/auth/auth.context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/auth/auth.context.ts @@ -162,13 +162,11 @@ export class UmbAuthContext extends UmbContextBase { * If the token is expired, it will be refreshed. * * NB! The user may experience being redirected to the login screen if the token is expired. - * * @example Using the latest token * ```js * const token = await authContext.getLatestToken(); * const result = await fetch('https://my-api.com', { headers: { Authorization: `Bearer ${token}` } }); * ``` - * * @memberof UmbAuthContext * @returns The latest token from the Management API */ @@ -235,7 +233,6 @@ export class UmbAuthContext extends UmbContextBase { * Get the default OpenAPI configuration, which is set up to communicate with the Management API. * @remark This is useful if you want to communicate with your own resources generated by the [openapi-typescript-codegen](https://github.com/ferdikoomen/openapi-typescript-codegen) library. * @memberof UmbAuthContext - * * @example Using the default OpenAPI configuration * ```js * const defaultOpenApi = authContext.getOpenApiConfiguration(); @@ -268,6 +265,7 @@ export class UmbAuthContext extends UmbContextBase { /** * Gets all registered auth providers. + * @param extensionsRegistry */ getAuthProviders(extensionsRegistry: UmbBackofficeExtensionRegistry) { return this.#isInitialized.pipe( @@ -292,6 +290,7 @@ export class UmbAuthContext extends UmbContextBase { } /** + * @param provider * @see UmbAuthFlow#linkLogin */ linkLogin(provider: string) { @@ -299,6 +298,8 @@ export class UmbAuthContext extends UmbContextBase { } /** + * @param providerName + * @param providerKey * @see UmbAuthFlow#unlinkLogin */ unlinkLogin(providerName: string, providerKey: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/collection/collection-alias.manifest.ts b/src/Umbraco.Web.UI.Client/src/packages/core/collection/collection-alias.manifest.ts index 3d918b9311..52eadd23f3 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/collection/collection-alias.manifest.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/collection/collection-alias.manifest.ts @@ -3,7 +3,6 @@ import type { ManifestCondition, UmbConditionConfigBase } from '@umbraco-cms/bac export type CollectionAliasConditionConfig = UmbConditionConfigBase & { /** * The collection that this extension should be available in - * * @example * "Umb.Collection.User" */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/collection/collection-view.manager.ts b/src/Umbraco.Web.UI.Client/src/packages/core/collection/collection-view.manager.ts index 7d380142c3..d160e72c3e 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/collection/collection-view.manager.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/collection/collection-view.manager.ts @@ -53,7 +53,7 @@ export class UmbCollectionViewManager extends UmbControllerBase { /** * Returns the current view. - * @return {ManifestCollectionView} + * @returns {ManifestCollectionView} * @memberof UmbCollectionContext */ public getCurrentView() { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/collection/components/collection-selection-actions.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/collection/components/collection-selection-actions.element.ts index c12a20a145..8beb70b56c 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/collection/components/collection-selection-actions.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/collection/components/collection-selection-actions.element.ts @@ -5,6 +5,10 @@ import { css, html, nothing, customElement, state } from '@umbraco-cms/backoffic import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element'; import type { ManifestEntityBulkAction, MetaEntityBulkAction } from '@umbraco-cms/backoffice/extension-registry'; +/** + * + * @param manifest + */ function apiArgsMethod(manifest: ManifestEntityBulkAction) { return [{ meta: manifest.meta }] as unknown[]; } diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/collection/default/collection-default.context.ts b/src/Umbraco.Web.UI.Client/src/packages/core/collection/default/collection-default.context.ts index 2c2eafa933..4134924760 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/collection/default/collection-default.context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/collection/default/collection-default.context.ts @@ -197,7 +197,7 @@ export class UmbDefaultCollectionContext< /** * Requests the collection from the repository. - * @return {*} + * @returns {*} * @memberof UmbCollectionContext */ public async requestCollection() { @@ -300,7 +300,7 @@ export class UmbDefaultCollectionContext< /** * Returns the manifest for the collection. - * @return {ManifestCollection} + * @returns {ManifestCollection} * @memberof UmbCollectionContext * @deprecated Use get the `.manifest` property instead. */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/components/backoffice-modal-container/backoffice-modal-container.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/components/backoffice-modal-container/backoffice-modal-container.element.ts index 1f3053e5a6..8ce49a89a3 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/components/backoffice-modal-container/backoffice-modal-container.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/components/backoffice-modal-container/backoffice-modal-container.element.ts @@ -35,8 +35,11 @@ export class UmbBackofficeModalContainerElement extends UmbLitElement { }); } - /** We cannot render the umb-modal element directly in the uui-modal-container because it wont get recognized by UUI. - * We therefore have a helper class which creates the uui-modal element and returns it. */ + /** + * We cannot render the umb-modal element directly in the uui-modal-container because it wont get recognized by UUI. + * We therefore have a helper class which creates the uui-modal element and returns it. + * @param modals + */ #createModalElements(modals: Array) { this.removeAttribute('fill-background'); const oldValue = this._modals; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/components/body-layout/body-layout.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/components/body-layout/body-layout.element.ts index 8c23db144a..968639c5d4 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/components/body-layout/body-layout.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/components/body-layout/body-layout.element.ts @@ -25,7 +25,7 @@ import { * @slot default - slot for main content * @export * @class UmbBodyLayout - * @extends {UmbLitElement} + * @augments {UmbLitElement} */ @customElement('umb-body-layout') export class UmbBodyLayoutElement extends LitElement { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/components/code-block/code-block.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/components/code-block/code-block.element.ts index 686f2d8a68..5bfa206456 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/components/code-block/code-block.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/components/code-block/code-block.element.ts @@ -6,7 +6,6 @@ import { css, customElement, html, property, state, when, LitElement } from '@um /** * A simple styled box for showing code-based error messages or blocks od code. * @slot the full message - * */ @customElement('umb-code-block') export class UmbCodeBlockElement extends LitElement { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/components/footer-layout/footer-layout.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/components/footer-layout/footer-layout.element.ts index 96a8b9d6ad..f9974dd400 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/components/footer-layout/footer-layout.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/components/footer-layout/footer-layout.element.ts @@ -8,7 +8,7 @@ import { UmbTextStyles } from '@umbraco-cms/backoffice/style'; * @slot actions - Slot actions * @export * @class UmbFooterLayout - * @extends {UmbLitElement} + * @augments {UmbLitElement} */ @customElement('umb-footer-layout') export class UmbFooterLayoutElement extends LitElement { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/components/icon/icon.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/components/icon/icon.element.ts index 86150d93fa..e50830421e 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/components/icon/icon.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/components/icon/icon.element.ts @@ -7,7 +7,7 @@ import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element'; /** * @element umb-icon * @description A wrapper for the uui-icon component with color alias support - * @extends {UmbLitElement} + * @augments {UmbLitElement} */ @customElement('umb-icon') export class UmbIconElement extends UmbLitElement { @@ -23,7 +23,7 @@ export class UmbIconElement extends UmbLitElement { /** * Color alias or a color code directly.\ * If a color has been set via the name property, this property will override it. - * */ + */ @property({ type: String }) public set color(value: string) { this.#color = value; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/components/input-date/input-date.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/components/input-date/input-date.element.ts index 8b7d50123e..f405ee4083 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/components/input-date/input-date.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/components/input-date/input-date.element.ts @@ -6,11 +6,9 @@ import type { UUIInputEvent } from '@umbraco-cms/backoffice/external/uui'; /** * This element passes a datetime string to a regular HTML input element. - * * @remark Be aware that you cannot include a time demonination, i.e. "10:44:00" if you * set the input type of this element to "date". If you do, the browser will not show * the value at all. - * * @element umb-input-date */ @customElement('umb-input-date') diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/components/input-number-range/input-number-range.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/components/input-number-range/input-number-range.element.ts index 63a3b4a565..83cf63b026 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/components/input-number-range/input-number-range.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/components/input-number-range/input-number-range.element.ts @@ -5,6 +5,10 @@ import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element'; import type { UmbNumberRangeValueType } from '@umbraco-cms/backoffice/models'; import type { UUIInputElement } from '@umbraco-cms/backoffice/external/uui'; +/** + * + * @param value + */ function getNumberOrUndefined(value: string) { const num = parseInt(value, 10); return isNaN(num) ? undefined : num; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/components/multiple-text-string-input/input-multiple-text-string.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/components/multiple-text-string-input/input-multiple-text-string.element.ts index 1b16a5439d..69104fce20 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/components/multiple-text-string-input/input-multiple-text-string.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/components/multiple-text-string-input/input-multiple-text-string.element.ts @@ -71,7 +71,7 @@ export class UmbInputMultipleTextStringElement extends UmbFormControlMixin /** * Returns a promise with the allowed children of a content type * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbContentTypeStructureRepositoryBase */ requestAllowedChildrenOf(unique: string | null) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/content-type/repository/structure/content-type-structure-server-data-source-base.ts b/src/Umbraco.Web.UI.Client/src/packages/core/content-type/repository/structure/content-type-structure-server-data-source-base.ts index 8765c33180..de2366e456 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/content-type/repository/structure/content-type-structure-server-data-source-base.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/content-type/repository/structure/content-type-structure-server-data-source-base.ts @@ -31,6 +31,7 @@ export abstract class UmbContentTypeStructureServerDataSourceBase< /** * Creates an instance of UmbContentTypeStructureServerDataSourceBase. * @param {UmbControllerHost} host + * @param args * @memberof UmbItemServerDataSourceBase */ constructor( @@ -45,7 +46,7 @@ export abstract class UmbContentTypeStructureServerDataSourceBase< /** * Returns a promise with the allowed content types for the given unique * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbContentTypeStructureServerDataSourceBase */ async getAllowedChildrenOf(unique: string | null) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/content-type/structure/content-type-container-structure-helper.class.ts b/src/Umbraco.Web.UI.Client/src/packages/core/content-type/structure/content-type-container-structure-helper.class.ts index 32912b50e8..7f98ef7b37 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/content-type/structure/content-type-container-structure-helper.class.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/content-type/structure/content-type-container-structure-helper.class.ts @@ -236,6 +236,7 @@ export class UmbContentTypeContainerStructureHelper { - /** Explanation: If the item is the first in list, we compare it to the item behind it to set a sortOrder. + /** + * Explanation: If the item is the first in list, we compare it to the item behind it to set a sortOrder. * If it's not the first in list, we will compare to the item in before it, and check the following item to see if it caused overlapping sortOrder, then update * the overlap if true, which may cause another overlap, so we loop through them till no more overlaps... */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/content/property-dataset-context/content-property-dataset.context.ts b/src/Umbraco.Web.UI.Client/src/packages/core/content/property-dataset-context/content-property-dataset.context.ts index 7fb54f6aff..1f981f0da4 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/content/property-dataset-context/content-property-dataset.context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/content/property-dataset-context/content-property-dataset.context.ts @@ -74,7 +74,7 @@ export class UmbContentPropertyDatasetContext< } /** - * @method propertyVariantId + * @function propertyVariantId * @param {string} propertyAlias * @returns {Promise | undefined>} * @description Get an Observable for the variant id of this property. @@ -86,7 +86,7 @@ export class UmbContentPropertyDatasetContext< } /** - * @method propertyValueByAlias + * @function propertyValueByAlias * @param {string} propertyAlias * @returns {Promise | undefined>} * @description Get an Observable for the value of this property. @@ -111,7 +111,7 @@ export class UmbContentPropertyDatasetContext< } /** - * @method setPropertyValueByVariant + * @function setPropertyValueByVariant * @param {string} propertyAlias * @param {PromiseLike} value - value can be a promise resolving into the actual value or the raw value it self. * @param {UmbVariantId} propertyVariantId - The variant id for the value to be set for. @@ -127,7 +127,7 @@ export class UmbContentPropertyDatasetContext< } /** - * @method setPropertyValue + * @function setPropertyValue * @param {string} propertyAlias * @param {PromiseLike} value - value can be a promise resolving into the actual value or the raw value it self. * @returns {Promise} diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/culture/repository/sources/culture.server.data.ts b/src/Umbraco.Web.UI.Client/src/packages/core/culture/repository/sources/culture.server.data.ts index 7ac0ac1a6f..06d5fecb97 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/culture/repository/sources/culture.server.data.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/culture/repository/sources/culture.server.data.ts @@ -23,7 +23,7 @@ export class UmbCultureServerDataSource implements UmbCultureDataSource { /** * Get a list of cultures on the server - * @return {*} + * @returns {*} * @memberof UmbLanguageServerDataSource */ async getCollection({ skip, take }: { skip: number; take: number }) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/entity-action/entity-action-base.ts b/src/Umbraco.Web.UI.Client/src/packages/core/entity-action/entity-action-base.ts index 0e5ea77faf..7548c8bfed 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/entity-action/entity-action-base.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/entity-action/entity-action-base.ts @@ -7,7 +7,7 @@ import { UmbActionBase } from '@umbraco-cms/backoffice/action'; * @export * @abstract * @class UmbEntityActionBase - * @extends {UmbActionBase} + * @augments {UmbActionBase} * @implements {UmbEntityAction} * @template RepositoryType */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/entity/entity.context.ts b/src/Umbraco.Web.UI.Client/src/packages/core/entity/entity.context.ts index 8f193465ae..99852dd929 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/entity/entity.context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/entity/entity.context.ts @@ -7,7 +7,7 @@ import { UmbStringState } from '@umbraco-cms/backoffice/observable-api'; * Provides the entity context * @export * @class UmbEntityContext - * @extends {UmbContextBase} + * @augments {UmbContextBase} */ export class UmbEntityContext extends UmbContextBase { #entityType = new UmbStringState(undefined); diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/components/extension-slot/extension-slot.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/components/extension-slot/extension-slot.element.ts index ab38f6b6b9..469cb4d1dc 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/components/extension-slot/extension-slot.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/components/extension-slot/extension-slot.element.ts @@ -13,7 +13,7 @@ import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element'; * @slot default - slot for inserting additional things into this slot. * @export * @class UmbExtensionSlot - * @extends {UmbLitElement} + * @augments {UmbLitElement} */ // TODO: Fire change event. @@ -34,7 +34,6 @@ export class UmbExtensionSlotElement extends UmbLitElement { * * or multiple: * - * */ @property({ type: String }) public get type(): string | string[] | undefined { @@ -54,7 +53,6 @@ export class UmbExtensionSlotElement extends UmbLitElement { * @memberof UmbExtensionSlot * @example * ext.meta.anyPropToFilter === 'foo'}> - * */ @property({ type: Object, attribute: false }) public get filter(): (manifest: any) => boolean { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/components/extension-with-api-slot/extension-with-api-slot.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/components/extension-with-api-slot/extension-with-api-slot.element.ts index 84738a56d2..5e7b8bfe36 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/components/extension-with-api-slot/extension-with-api-slot.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/components/extension-with-api-slot/extension-with-api-slot.element.ts @@ -15,7 +15,7 @@ import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element'; * @slot default - slot for inserting additional things into this slot. * @export * @class UmbExtensionSlot - * @extends {UmbLitElement} + * @augments {UmbLitElement} */ // TODO: Fire change event. @@ -36,7 +36,6 @@ export class UmbExtensionWithApiSlotElement extends UmbLitElement { * * or multiple: * - * */ @property({ type: String }) public get type(): string | string[] | undefined { @@ -56,7 +55,6 @@ export class UmbExtensionWithApiSlotElement extends UmbLitElement { * @memberof UmbExtensionSlot * @example * ext.meta.anyPropToFilter === 'foo'}> - * */ @property({ type: Object, attribute: false }) public get filter(): (manifest: any) => boolean { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/conditions/section-alias.condition.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/conditions/section-alias.condition.ts index dc163ed815..234a5809cc 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/conditions/section-alias.condition.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/conditions/section-alias.condition.ts @@ -35,13 +35,11 @@ export class UmbSectionAliasCondition export type SectionAliasConditionConfig = UmbConditionConfigBase<'Umb.Condition.SectionAlias'> & { /** * Define the section that this extension should be available in - * * @example "Umb.Section.Content" */ match: string; /** * Define one or more workspaces that this extension should be available in - * * @example * ["Umb.Section.Content", "Umb.Section.Media"] */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/extension-element-and-api-slot-element-base.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/extension-element-and-api-slot-element-base.ts index ec6eb0eee7..bf24a8b9f6 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/extension-element-and-api-slot-element-base.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/extension-element-and-api-slot-element-base.ts @@ -86,7 +86,7 @@ export abstract class UmbExtensionElementAndApiSlotElementBase< /** * Render the element. - * @return {*} + * @returns {*} * @memberof UmbExtensionElementAndApiSlotElementBase */ override render() { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/auth-provider.model.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/auth-provider.model.ts index 9bd0244c57..0134f61be5 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/auth-provider.model.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/auth-provider.model.ts @@ -4,7 +4,6 @@ import type { UUIInterfaceColor, UUIInterfaceLook } from '@umbraco-cms/backoffic /** * Represents an authentication provider that can be used to authenticate users. * The provider needs to be registered in the API that the authorization request is sent to in order to be used. - * * @see {forProviderName} for the provider name that this provider is for. */ export interface ManifestAuthProvider extends ManifestElement { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/collection-view.model.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/collection-view.model.ts index 6e7643e4e9..5f1e3d3ba3 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/collection-view.model.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/collection-view.model.ts @@ -14,7 +14,6 @@ export interface MetaCollectionView { /** * An icon to represent the collection view - * * @examples [ * "icon-box", * "icon-grid" @@ -34,7 +33,6 @@ export interface MetaCollectionView { export interface ConditionsCollectionView { /** * Type of entity this collection view should be available for - * * @examples ["media"] */ entityType: string; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/current-user-action.model.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/current-user-action.model.ts index 7af684a83a..03cfa4019d 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/current-user-action.model.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/current-user-action.model.ts @@ -41,7 +41,6 @@ export interface ManifestCurrentUserActionDefaultKind< export interface MetaCurrentUserActionDefaultKind extends MetaCurrentUserAction { /** * An icon to represent the action to be performed - * * @examples [ * "icon-box", * "icon-grid" @@ -51,7 +50,6 @@ export interface MetaCurrentUserActionDefaultKind extends MetaCurrentUserAction /** * The friendly name of the action to perform - * * @examples [ * "Create", * "Create Content Template" diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/dashboard-collection.model.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/dashboard-collection.model.ts index ffb51ea7f5..8ec72d8a82 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/dashboard-collection.model.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/dashboard-collection.model.ts @@ -36,7 +36,6 @@ export interface MetaDashboardCollection { export interface ConditionsDashboardCollection { /** * An array of section aliases that the dashboard collection should be available in - * * @uniqueItems true * @examples [ * "Umb.Section.Content", diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/dashboard.model.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/dashboard.model.ts index 8c1ddc0ac5..95d78dcafb 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/dashboard.model.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/dashboard.model.ts @@ -18,7 +18,6 @@ export interface MetaDashboard { /** * This is the URL path part for this view. This is used for navigating or deep linking directly to the dashboard * https://yoursite.com/section/settings/dashboard/my-dashboard-path - * * @example my-dashboard-path * @examples [ * "my-dashboard-path" diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/entity-action.model.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/entity-action.model.ts index ebb89ea663..8fe12643a4 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/entity-action.model.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/entity-action.model.ts @@ -25,7 +25,6 @@ export interface ManifestEntityActionDefaultKind extends ManifestEntityAction { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/property-action.model.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/property-action.model.ts index 27484ac995..84faf0f978 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/property-action.model.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/property-action.model.ts @@ -23,7 +23,6 @@ export interface ManifestPropertyActionDefaultKind< export interface MetaPropertyActionDefaultKind extends MetaPropertyAction { /** * An icon to represent the action to be performed - * * @examples [ * "icon-box", * "icon-grid" @@ -33,7 +32,6 @@ export interface MetaPropertyActionDefaultKind extends MetaPropertyAction { /** * The friendly name of the action to perform - * * @examples [ * "Create", * "Create Content Template" diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/section-view.model.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/section-view.model.ts index a27c2e4ce1..426dd4eaae 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/section-view.model.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/section-view.model.ts @@ -18,7 +18,6 @@ export interface MetaSectionView { /** * This is the URL path part for this view. This is used for navigating or deep linking directly to the view * https://yoursite.com/section/settings/view/my-view-path - * * @example my-view-path * @examples [ * "my-view-path" diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/tinymce-plugin.model.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/tinymce-plugin.model.ts index 77c997ae44..01a891c48a 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/tinymce-plugin.model.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/tinymce-plugin.model.ts @@ -10,7 +10,6 @@ export interface MetaTinyMcePlugin { toolbar?: Array<{ /** * The alias of the toolbar button that will be configured in the TinyMCE editor. - * * @see [TinyMCE Toolbar](https://www.tiny.cloud/docs/tinymce/6/toolbar-configuration-options/) for more information. */ alias: string; @@ -30,7 +29,6 @@ export interface MetaTinyMcePlugin { /** * Sets the default configuration for the TinyMCE editor. This configuration will be used when the editor is initialized. - * * @see [TinyMCE Configuration](https://www.tiny.cloud/docs/configure/) for more information. * @optional * @examples [ @@ -49,7 +47,6 @@ export interface MetaTinyMcePlugin { * A plugin can add things like buttons, menu items, context menu items, etc. through the TinyMCE API. * A plugin can also add custom commands to the editor. * A plugin can also modify the behavior of the editor. - * * @see [TinyMCE Plugin](https://www.tiny.cloud/docs/tinymce/6/apis/tinymce.plugin/) for more information. */ export interface ManifestTinyMcePlugin extends ManifestApi { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/workspace-action-menu-item.model.ts b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/workspace-action-menu-item.model.ts index e2178dcb4c..1b73291e5c 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/workspace-action-menu-item.model.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/workspace-action-menu-item.model.ts @@ -32,7 +32,6 @@ export interface ManifestWorkspaceActionMenuItemDefaultKind< export interface MetaWorkspaceActionMenuItemDefaultKind extends MetaWorkspaceActionMenuItem { /** * An icon to represent the action to be performed - * * @examples [ * "icon-box", * "icon-grid" @@ -42,7 +41,6 @@ export interface MetaWorkspaceActionMenuItemDefaultKind extends MetaWorkspaceAct /** * The friendly name of the action to perform - * * @examples [ * "Create", * "Create Content Template" diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icon.registry.ts b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icon.registry.ts index 63b71fdaff..7150e77cb3 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icon.registry.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/icon-registry/icon.registry.ts @@ -5,7 +5,7 @@ import { type UUIIconHost, UUIIconRegistry } from '@umbraco-cms/backoffice/exter /** * @export * @class UmbIconRegistry - * @extends {UUIIconRegistry} + * @augments {UUIIconRegistry} * @description - Icon Registry. Provides icons from the icon manifest. Icons are loaded on demand. All icons are prefixed with 'icon-' */ export class UmbIconRegistry extends UUIIconRegistry { @@ -41,7 +41,7 @@ export class UmbIconRegistry extends UUIIconRegistry { } /** * @param {string} iconName - * @return {*} {boolean} + * @returns {*} {boolean} * @memberof UmbIconStore */ override acceptIcon(iconName: string): boolean { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/lit-element/directives/focus.lit-directive.ts b/src/Umbraco.Web.UI.Client/src/packages/core/lit-element/directives/focus.lit-directive.ts index f4e7032fd8..fc0fb57538 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/lit-element/directives/focus.lit-directive.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/lit-element/directives/focus.lit-directive.ts @@ -79,7 +79,6 @@ class UmbFocusDirective extends AsyncDirective { /** * @description * A Lit directive, which sets focus on the element of scope once its connected to the DOM. - * * @example: * ```js * html``; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/lit-element/lit-element.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/lit-element/lit-element.element.ts index 490081a7c9..5e358f28d6 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/lit-element/lit-element.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/lit-element/lit-element.element.ts @@ -3,7 +3,6 @@ import { UmbElementMixin } from '@umbraco-cms/backoffice/element-api'; /** * The base class for all Umbraco LitElement elements. - * * @abstract * @remarks This class is a wrapper around the LitElement class. * @remarks The `dir` and `lang` properties are defined here as reactive properties so they react to language changes. @@ -11,7 +10,6 @@ import { UmbElementMixin } from '@umbraco-cms/backoffice/element-api'; export class UmbLitElement extends UmbElementMixin(LitElement) { /** * The direction of the element. - * * @attr * @remarks This is the direction of the element, not the direction of the backoffice. * @example 'ltr' @@ -21,7 +19,6 @@ export class UmbLitElement extends UmbElementMixin(LitElement) { /** * The language of the element. - * * @attr * @remarks This is the language of the element, not the language of the backoffice. * @example 'en-us' diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/localization/registry/localization.registry.ts b/src/Umbraco.Web.UI.Client/src/packages/core/localization/registry/localization.registry.ts index cc755ebd24..a155177661 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/localization/registry/localization.registry.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/localization/registry/localization.registry.ts @@ -2,8 +2,8 @@ import { type UmbLocalizationSetBase, type UmbLocalizationDictionary, type UmbLocalizationFlatDictionary, - UMB_DEFAULT_LOCALIZATION_CULTURE -} from "@umbraco-cms/backoffice/localization-api"; + UMB_DEFAULT_LOCALIZATION_CULTURE, +} from '@umbraco-cms/backoffice/localization-api'; import { umbLocalizationManager } from '@umbraco-cms/backoffice/localization-api'; import type { ManifestLocalization, UmbBackofficeExtensionRegistry } from '@umbraco-cms/backoffice/extension-registry'; import { umbExtensionsRegistry } from '@umbraco-cms/backoffice/extension-registry'; @@ -11,6 +11,12 @@ import { UmbStringState } from '@umbraco-cms/backoffice/observable-api'; import { combineLatest } from '@umbraco-cms/backoffice/external/rxjs'; import { hasDefaultExport, loadManifestPlainJs } from '@umbraco-cms/backoffice/extension-api'; +/** + * + * @param innerDictionary + * @param dictionaryName + * @param dictionary + */ function addOrUpdateDictionary( innerDictionary: UmbLocalizationFlatDictionary, dictionaryName: string, @@ -22,7 +28,9 @@ function addOrUpdateDictionary( } export class UmbLocalizationRegistry { - #currentLanguage = new UmbStringState(document.documentElement.lang !== '' ? document.documentElement.lang : UMB_DEFAULT_LOCALIZATION_CULTURE); + #currentLanguage = new UmbStringState( + document.documentElement.lang !== '' ? document.documentElement.lang : UMB_DEFAULT_LOCALIZATION_CULTURE, + ); readonly currentLanguage = this.#currentLanguage.asObservable(); #loadedExtAliases: Array = []; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/modal/common/confirm/confirm-modal.controller.ts b/src/Umbraco.Web.UI.Client/src/packages/core/modal/common/confirm/confirm-modal.controller.ts index c950224cc1..1f2e3009ee 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/modal/common/confirm/confirm-modal.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/modal/common/confirm/confirm-modal.controller.ts @@ -26,6 +26,11 @@ export class UmbConfirmModalController extends UmbControllerBase { } } +/** + * + * @param host + * @param args + */ export function umbConfirmModal(host: UmbControllerHost, args: UmbConfirmModalArgs) { return new UmbConfirmModalController(host).open(args); } diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/modal/component/modal-base.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/modal/component/modal-base.element.ts index a1aeb0725c..40ee28d5d3 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/modal/component/modal-base.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/modal/component/modal-base.element.ts @@ -69,6 +69,7 @@ export abstract class UmbModalBaseElement< /** * Rejects the modal + * @param reason * @protected * @memberof UmbModalBaseElement */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/modal/context/modal-manager.context.ts b/src/Umbraco.Web.UI.Client/src/packages/core/modal/context/modal-manager.context.ts index 0764a232c8..162ba3e476 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/modal/context/modal-manager.context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/modal/context/modal-manager.context.ts @@ -34,7 +34,7 @@ export class UmbModalManagerContext extends UmbContextBase { /** * Get the data type of the token's data. - * * @public * @type {ModalDataType} * @memberOf UmbModalToken @@ -26,7 +25,6 @@ export class UmbModalToken< /** * Get the value type of the token - * * @public * @type {ModalValueType} * @memberOf UmbModalToken @@ -50,7 +48,6 @@ export class UmbModalToken< /** * This method must always return the unique alias of the token since that * will be used to look up the token in the injector. - * * @returns the unique alias of the token */ toString(): string { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/notification/extractUmbNotificationColor.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/notification/extractUmbNotificationColor.function.ts index 105b025fc5..6ad0399501 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/notification/extractUmbNotificationColor.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/notification/extractUmbNotificationColor.function.ts @@ -1,6 +1,10 @@ import type { UmbNotificationColor } from './notification.context.js'; import { EventMessageTypeModel } from '@umbraco-cms/backoffice/external/backend-api'; +/** + * + * @param type + */ export function extractUmbNotificationColor(type: EventMessageTypeModel): UmbNotificationColor { switch (type) { case EventMessageTypeModel.ERROR: diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/notification/isUmbNotifications.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/notification/isUmbNotifications.function.ts index 036185b355..6c8b9b2895 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/notification/isUmbNotifications.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/notification/isUmbNotifications.function.ts @@ -1,5 +1,9 @@ import { EventMessageTypeModel } from '@umbraco-cms/backoffice/external/backend-api'; +/** + * + * @param notification + */ function objectIsUmbNotification(notification: unknown): notification is UmbNotificationsEventModel { if (typeof notification !== 'object' || notification === null) { return false; @@ -19,6 +23,10 @@ export interface UmbNotificationsEventModel { type: EventMessageTypeModel; } +/** + * + * @param notifications + */ export function isUmbNotifications(notifications: Array): notifications is Array { return notifications.every(objectIsUmbNotification); } diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/notification/notification-handler.ts b/src/Umbraco.Web.UI.Client/src/packages/core/notification/notification-handler.ts index b63eea9663..81f50dbebd 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/notification/notification-handler.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/notification/notification-handler.ts @@ -76,7 +76,7 @@ export class UmbNotificationHandler { } /** - * @return {*} + * @returns {*} * @memberof UmbNotificationHandler */ public onClose(): Promise { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/notification/notification.context.ts b/src/Umbraco.Web.UI.Client/src/packages/core/notification/notification.context.ts index cf73a33857..f34619e5c5 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/notification/notification.context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/notification/notification.context.ts @@ -41,7 +41,7 @@ export class UmbNotificationContext extends UmbContextBase} options - * @return {*} {UmbNotificationHandler} + * @returns {*} {UmbNotificationHandler} * @memberof UmbNotificationContext */ private _open(options: UmbNotificationOptions): UmbNotificationHandler { @@ -64,6 +64,7 @@ export class UmbNotificationContext extends UmbContextBase} options - * @return {*} + * @returns {*} * @memberof UmbNotificationContext */ public peek(color: UmbNotificationColor, options: UmbNotificationOptions): UmbNotificationHandler { @@ -87,7 +88,7 @@ export class UmbNotificationContext extends UmbContextBase} options - * @return {*} + * @returns {*} * @memberof UmbNotificationContext */ public stay(color: UmbNotificationColor, options: UmbNotificationOptions): UmbNotificationHandler { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/property-action/components/property-action-menu/property-action-menu.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/property-action/components/property-action-menu/property-action-menu.element.ts index 7aa24b9c1e..799135db0c 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/property-action/components/property-action-menu/property-action-menu.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/property-action/components/property-action-menu/property-action-menu.element.ts @@ -7,6 +7,10 @@ import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element'; import { UmbTextStyles } from '@umbraco-cms/backoffice/style'; import type { UmbExtensionElementAndApiInitializer } from '@umbraco-cms/backoffice/extension-api'; +/** + * + * @param manifest + */ function ExtensionApiArgsMethod(manifest: ManifestPropertyAction): [UmbPropertyActionArgs] { return [{ meta: manifest.meta }]; } diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/property-action/components/property-action/property-action-base.controller.ts b/src/Umbraco.Web.UI.Client/src/packages/core/property-action/components/property-action/property-action-base.controller.ts index bec96eb168..3ba3f42464 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/property-action/components/property-action/property-action-base.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/property-action/components/property-action/property-action-base.controller.ts @@ -7,7 +7,7 @@ import { UmbActionBase } from '@umbraco-cms/backoffice/action'; * @export * @abstract * @class UmbPropertyActionBase - * @extends {UmbActionBase} + * @augments {UmbActionBase} * @implements {UmbPropertyAction} */ export abstract class UmbPropertyActionBase diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/property-editor/components/ref-property-editor-ui/ref-property-editor-ui.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/property-editor/components/ref-property-editor-ui/ref-property-editor-ui.element.ts index 9d100bebfe..9b3a6c0f58 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/property-editor/components/ref-property-editor-ui/ref-property-editor-ui.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/property-editor/components/ref-property-editor-ui/ref-property-editor-ui.element.ts @@ -5,7 +5,7 @@ import { html, customElement, property } from '@umbraco-cms/backoffice/external/ /** * @element umb-ref-property-editor-ui * @description - Component for displaying a reference to a Property Editor UI - * @extends UUIRefNodeElement + * @augments UUIRefNodeElement */ @customElement('umb-ref-property-editor-ui') export class UmbRefPropertyEditorUIElement extends UUIRefNodeElement { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/property/property-dataset/property-dataset-base-context.ts b/src/Umbraco.Web.UI.Client/src/packages/core/property/property-dataset/property-dataset-base-context.ts index d7e723ec2f..0527d11772 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/property/property-dataset/property-dataset-base-context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/property/property-dataset/property-dataset-base-context.ts @@ -10,7 +10,7 @@ import { UmbVariantId } from '@umbraco-cms/backoffice/variant'; /** * A base property dataset context implementation. * @class UmbPropertyDatasetContextBase - * @extends {UmbContextBase} + * @augments {UmbContextBase} */ export class UmbPropertyDatasetContextBase extends UmbContextBase @@ -48,6 +48,7 @@ export class UmbPropertyDatasetContextBase /** * TODO: Write proper JSDocs here. + * @param propertyAlias */ async propertyValueByAlias(propertyAlias: string) { return this.#values.asObservablePart((values) => { @@ -58,6 +59,8 @@ export class UmbPropertyDatasetContextBase /** * TODO: Write proper JSDocs here. + * @param alias + * @param value */ setPropertyValue(alias: string, value: unknown) { this.#values.appendOne({ alias, value }); diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/property/property/property.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/property/property/property.element.ts index 2eda498629..40cded944c 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/property/property/property.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/property/property/property.element.ts @@ -33,7 +33,7 @@ export class UmbPropertyElement extends UmbLitElement { * Label. Name of the property * @type {string} * @attr - * @default '' + * @default */ @property({ type: String }) public set label(label: string | undefined) { @@ -47,7 +47,7 @@ export class UmbPropertyElement extends UmbLitElement { * Description: render a description underneath the label. * @type {string} * @attr - * @default '' + * @default */ @property({ type: String }) public set description(description: string | undefined) { @@ -73,7 +73,7 @@ export class UmbPropertyElement extends UmbLitElement { * @public * @type {string} * @attr - * @default '' + * @default */ @property({ type: String }) public set alias(alias: string) { @@ -88,7 +88,7 @@ export class UmbPropertyElement extends UmbLitElement { * @public * @type {string} * @attr - * @default '' + * @default */ @property({ type: String, attribute: 'property-editor-ui-alias' }) public set propertyEditorUiAlias(value: string | undefined) { @@ -105,7 +105,7 @@ export class UmbPropertyElement extends UmbLitElement { * @public * @type {string} * @attr - * @default '' + * @default */ @property({ type: Array, attribute: false }) public set config(value: UmbPropertyEditorConfig | undefined) { @@ -131,7 +131,7 @@ export class UmbPropertyElement extends UmbLitElement { * @public * @type {string} * @attr - * @default '' + * @default */ @property({ type: String, attribute: false }) public set dataPath(dataPath: string | undefined) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/recycle-bin/contexts/is-trashed/is-trashed.entity-context.ts b/src/Umbraco.Web.UI.Client/src/packages/core/recycle-bin/contexts/is-trashed/is-trashed.entity-context.ts index b80ed8301f..2e8816f9fe 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/recycle-bin/contexts/is-trashed/is-trashed.entity-context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/recycle-bin/contexts/is-trashed/is-trashed.entity-context.ts @@ -7,7 +7,7 @@ import { UmbBooleanState } from '@umbraco-cms/backoffice/observable-api'; * A entity context for the isTrashed state. * @export * @class UmbIsTrashedEntityContext - * @extends {UmbContextBase} + * @augments {UmbContextBase} * @implements {UmbIsTrashedEntityContext} */ export class UmbIsTrashedEntityContext extends UmbContextBase { @@ -20,7 +20,7 @@ export class UmbIsTrashedEntityContext extends UmbContextBase} + * @augments {UmbEntityActionBase} */ export class UmbEmptyRecycleBinEntityAction extends UmbEntityActionBase { /** diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/recycle-bin/entity-action/restore-from-recycle-bin/restore-from-recycle-bin.action.ts b/src/Umbraco.Web.UI.Client/src/packages/core/recycle-bin/entity-action/restore-from-recycle-bin/restore-from-recycle-bin.action.ts index 95788f75c2..a3d8972296 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/recycle-bin/entity-action/restore-from-recycle-bin/restore-from-recycle-bin.action.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/recycle-bin/entity-action/restore-from-recycle-bin/restore-from-recycle-bin.action.ts @@ -9,7 +9,7 @@ import type { MetaEntityActionRestoreFromRecycleBinKind } from '@umbraco-cms/bac * Entity action for restoring an item from the recycle bin. * @export * @class UmbRestoreFromRecycleBinEntityAction - * @extends {UmbEntityActionBase} + * @augments {UmbEntityActionBase} */ export class UmbRestoreFromRecycleBinEntityAction extends UmbEntityActionBase { /** diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/recycle-bin/entity-action/trash/trash.action.ts b/src/Umbraco.Web.UI.Client/src/packages/core/recycle-bin/entity-action/trash/trash.action.ts index 772d81d31e..4d79b58ba0 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/recycle-bin/entity-action/trash/trash.action.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/recycle-bin/entity-action/trash/trash.action.ts @@ -11,7 +11,7 @@ import { UMB_ACTION_EVENT_CONTEXT } from '@umbraco-cms/backoffice/action'; * Entity action for trashing an item. * @export * @class UmbTrashEntityAction - * @extends {UmbEntityActionBase} + * @augments {UmbEntityActionBase} */ export class UmbTrashEntityAction extends UmbEntityActionBase { /** diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/recycle-bin/recycle-bin-repository-base.ts b/src/Umbraco.Web.UI.Client/src/packages/core/recycle-bin/recycle-bin-repository-base.ts index 1dd19e0809..5d9d207177 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/recycle-bin/recycle-bin-repository-base.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/recycle-bin/recycle-bin-repository-base.ts @@ -17,7 +17,7 @@ import { UmbRepositoryBase } from '@umbraco-cms/backoffice/repository'; * @export * @abstract * @class UmbRecycleBinRepositoryBase - * @extends {UmbRepositoryBase} + * @augments {UmbRepositoryBase} * @implements {UmbRecycleBinRepository} */ export abstract class UmbRecycleBinRepositoryBase extends UmbRepositoryBase implements UmbRecycleBinRepository { @@ -37,7 +37,7 @@ export abstract class UmbRecycleBinRepositoryBase extends UmbRepositoryBase impl /** * Requests to trash an item. * @param {UmbRecycleBinTrashRequestArgs} args - * @return {*} + * @returns {*} * @memberof UmbRecycleBinRepositoryBase */ async requestTrash(args: UmbRecycleBinTrashRequestArgs) { @@ -55,7 +55,7 @@ export abstract class UmbRecycleBinRepositoryBase extends UmbRepositoryBase impl /** * Requests to restore an item. * @param {UmbRecycleBinRestoreRequestArgs} args - * @return {*} + * @returns {*} * @memberof UmbRecycleBinRepositoryBase */ async requestRestore(args: UmbRecycleBinRestoreRequestArgs) { @@ -72,7 +72,7 @@ export abstract class UmbRecycleBinRepositoryBase extends UmbRepositoryBase impl /** * Requests to empty the recycle bin. - * @return {*} + * @returns {*} * @memberof UmbRecycleBinRepositoryBase */ async requestEmpty() { @@ -90,7 +90,7 @@ export abstract class UmbRecycleBinRepositoryBase extends UmbRepositoryBase impl /** * Requests the original parent of an item. * @param {UmbRecycleBinOriginalParentRequestArgs} args - * @return {*} + * @returns {*} * @memberof UmbRecycleBinRepositoryBase */ async requestOriginalParent(args: UmbRecycleBinOriginalParentRequestArgs) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/repository/detail/detail-repository-base.ts b/src/Umbraco.Web.UI.Client/src/packages/core/repository/detail/detail-repository-base.ts index 327ada0717..1031b28f49 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/repository/detail/detail-repository-base.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/repository/detail/detail-repository-base.ts @@ -44,7 +44,7 @@ export abstract class UmbDetailRepositoryBase< /** * Creates a scaffold * @param {Partial} [preset] - * @return {*} + * @returns {*} * @memberof UmbDetailRepositoryBase */ async createScaffold(preset?: Partial) { @@ -54,7 +54,7 @@ export abstract class UmbDetailRepositoryBase< /** * Requests the detail for the given unique * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbDetailRepositoryBase */ async requestByUnique(unique: string) { @@ -73,8 +73,8 @@ export abstract class UmbDetailRepositoryBase< /** * Returns a promise with an observable of the detail for the given unique * @param {DetailModelType} model - * @param {string | null} [parentUnique=null] - * @return {*} + * @param {string | null} [parentUnique] + * @returns {*} * @memberof UmbDetailRepositoryBase */ async create(model: DetailModelType, parentUnique: string | null) { @@ -97,7 +97,7 @@ export abstract class UmbDetailRepositoryBase< /** * Saves the given data * @param {DetailModelType} model - * @return {*} + * @returns {*} * @memberof UmbDetailRepositoryBase */ async save(model: DetailModelType) { @@ -121,7 +121,7 @@ export abstract class UmbDetailRepositoryBase< /** * Deletes the detail for the given unique * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbDetailRepositoryBase */ async delete(unique: string) { @@ -144,7 +144,7 @@ export abstract class UmbDetailRepositoryBase< /** * Returns a promise with an observable of the detail for the given unique * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbDetailRepositoryBase */ async byUnique(unique: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/repository/item/item-repository-base.ts b/src/Umbraco.Web.UI.Client/src/packages/core/repository/item/item-repository-base.ts index 8fc9b78f12..f1f89b1a87 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/repository/item/item-repository-base.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/repository/item/item-repository-base.ts @@ -29,7 +29,7 @@ export class UmbItemRepositoryBase /** * Requests the items for the given uniques * @param {Array} uniques - * @return {*} + * @returns {*} * @memberof UmbItemRepositoryBase */ async requestItems(uniques: Array) { @@ -48,7 +48,7 @@ export class UmbItemRepositoryBase /** * Returns a promise with an observable of the items for the given uniques * @param {Array} uniques - * @return {*} + * @returns {*} * @memberof UmbItemRepositoryBase */ async items(uniques: Array) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/repository/item/item-server-data-source-base.ts b/src/Umbraco.Web.UI.Client/src/packages/core/repository/item/item-server-data-source-base.ts index f793d64ab0..3def61427b 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/repository/item/item-server-data-source-base.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/repository/item/item-server-data-source-base.ts @@ -34,7 +34,7 @@ export abstract class UmbItemServerDataSourceBase} uniques - * @return {*} + * @returns {*} * @memberof UmbItemServerDataSourceBase */ async getItems(uniques: Array) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/resources/apiTypeValidators.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/resources/apiTypeValidators.function.ts index 396d34025d..b30736d2b4 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/resources/apiTypeValidators.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/resources/apiTypeValidators.function.ts @@ -1,13 +1,25 @@ import type { ApiError, CancelError, CancelablePromise } from '@umbraco-cms/backoffice/external/backend-api'; +/** + * + * @param error + */ export function isApiError(error: unknown): error is ApiError { return (error as ApiError).name === 'ApiError'; } +/** + * + * @param error + */ export function isCancelError(error: unknown): error is CancelError { return (error as CancelError).name === 'CancelError'; } +/** + * + * @param promise + */ export function isCancelablePromise(promise: unknown): promise is CancelablePromise { return (promise as CancelablePromise).cancel !== undefined; } diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/resources/extractUmbColorVariable.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/resources/extractUmbColorVariable.function.ts index 3c45463744..56120d2c8e 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/resources/extractUmbColorVariable.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/resources/extractUmbColorVariable.function.ts @@ -22,6 +22,10 @@ export const umbracoColors = [ { alias: 'deep-orange', legacy: true, varName: '--uui-palette-cocoa-brown' }, ]; +/** + * + * @param colorAlias + */ export function extractUmbColorVariable(colorAlias: string): string | undefined { const found = umbracoColors.find((umbColor) => umbColor.alias === colorAlias); return found?.varName; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/resources/resource.controller.ts b/src/Umbraco.Web.UI.Client/src/packages/core/resources/resource.controller.ts index 7b12366898..59c7110b92 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/resources/resource.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/resources/resource.controller.ts @@ -39,6 +39,7 @@ export class UmbResourceController extends UmbControllerBase { /** * Base execute function with a try/catch block and return a tuple with the result and the error. + * @param promise */ static async tryExecute(promise: Promise): Promise> { try { @@ -56,6 +57,7 @@ export class UmbResourceController extends UmbControllerBase { /** * Wrap the {tryExecute} function in a try/catch block and return the result. * If the executor function throws an error, then show the details in a notification. + * @param options */ async tryExecuteAndNotify(options?: UmbNotificationOptions): Promise> { const { data, error } = await UmbResourceController.tryExecute(this.#promise); @@ -171,7 +173,6 @@ export class UmbResourceController extends UmbControllerBase { * This works by checking if the promise is a CancelablePromise and if so, it will call the cancel method. * * This is useful when the controller is being disconnected from the DOM. - * * @see CancelablePromise * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortController diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/resources/tryExecute.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/resources/tryExecute.function.ts index 4f849b2632..c4b8b60adf 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/resources/tryExecute.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/resources/tryExecute.function.ts @@ -1,6 +1,10 @@ import { UmbResourceController } from './resource.controller.js'; import type { UmbDataSourceResponse } from '@umbraco-cms/backoffice/repository'; +/** + * + * @param promise + */ export function tryExecute(promise: Promise): Promise> { return UmbResourceController.tryExecute(promise); } diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/resources/tryExecuteAndNotify.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/resources/tryExecuteAndNotify.function.ts index b5173a55df..2e2b416704 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/resources/tryExecuteAndNotify.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/resources/tryExecuteAndNotify.function.ts @@ -3,6 +3,12 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; import type { UmbNotificationOptions } from '@umbraco-cms/backoffice/notification'; import type { UmbDataSourceResponse } from '@umbraco-cms/backoffice/repository'; +/** + * + * @param host + * @param resource + * @param options + */ export function tryExecuteAndNotify( host: UmbControllerHost, resource: Promise, diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/router/generate-route-path-builder.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/router/generate-route-path-builder.function.ts index 24db7b9dc6..c7199cc42d 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/router/generate-route-path-builder.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/router/generate-route-path-builder.function.ts @@ -1,6 +1,10 @@ import { type UrlParametersRecord, umbUrlPatternToString } from '../utils/path/url-pattern-to-string.function.js'; import { stripSlash } from '@umbraco-cms/backoffice/external/router-slot'; // This must only include the util to avoid side effects of registering the route element. +/** + * + * @param path + */ export function umbGenerateRoutePathBuilder(path: string) { return (params: UrlParametersRecord | null) => { return '/' + stripSlash(umbUrlPatternToString(path, params)) + '/'; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/router/modal-registration/modal-route-registration.controller.ts b/src/Umbraco.Web.UI.Client/src/packages/core/router/modal-registration/modal-route-registration.controller.ts index 72c393e052..850124e146 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/router/modal-registration/modal-route-registration.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/router/modal-registration/modal-route-registration.controller.ts @@ -78,6 +78,7 @@ export class UmbModalRouteRegistrationController< * Creates an instance of UmbModalRouteRegistrationController. * @param {UmbControllerHost} host - The host element of the modal, this determine the ownership of the modal and the origin of it. * @param {UmbModalToken} alias - The alias of the modal, this is used to identify the modal. + * @param ctrlAlias * @memberof UmbModalRouteRegistrationController */ constructor( diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/router/path-pattern.class.ts b/src/Umbraco.Web.UI.Client/src/packages/core/router/path-pattern.class.ts index 57dbda10eb..3edab9c88d 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/router/path-pattern.class.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/router/path-pattern.class.ts @@ -17,7 +17,6 @@ export class UmbPathPattern< /** * Get the params type of the path pattern - * * @public * @type {T} * @memberOf UmbPathPattern @@ -27,7 +26,6 @@ export class UmbPathPattern< /** * Get absolute params type of the path pattern - * * @public * @type {T} * @memberOf UmbPathPattern diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/router/router-slot.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/router/router-slot.element.ts index ae9f336236..6b45549d73 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/router/router-slot.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/router/router-slot.element.ts @@ -10,7 +10,7 @@ import type { IRouterSlot } from '@umbraco-cms/backoffice/external/router-slot'; /** * @element umb-router-slot * @description - Component for wrapping Router Slot element, providing some local events for implementation. - * @extends UmbLitElement + * @augments UmbLitElement * @fires {UmbRouterSlotInitEvent} init - fires when the router is connected * @fires {UmbRouterSlotChangeEvent} change - fires when a path of this router is changed */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/section/components/input-section/input-section.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/section/components/input-section/input-section.element.ts index 788f3db7ec..e2db5cafb1 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/section/components/input-section/input-section.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/section/components/input-section/input-section.element.ts @@ -13,7 +13,7 @@ export class UmbInputSectionElement extends UmbFormControlMixin} uniques - * @return {*} + * @returns {*} * @memberof UmbItemRepositoryBase */ async requestItems(uniques: Array) { @@ -33,7 +33,7 @@ export class UmbSectionItemRepository extends UmbRepositoryBase implements UmbIt /** * Returns a promise with an observable of the items for the given uniques * @param {Array} uniques - * @return {*} + * @returns {*} * @memberof UmbItemRepositoryBase */ async items(uniques: Array) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/server-file-system/rename/rename-server-file-repository-base.ts b/src/Umbraco.Web.UI.Client/src/packages/core/server-file-system/rename/rename-server-file-repository-base.ts index d93b3b444f..96a7f62d73 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/server-file-system/rename/rename-server-file-repository-base.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/server-file-system/rename/rename-server-file-repository-base.ts @@ -25,7 +25,7 @@ export abstract class UmbRenameServerFileRepositoryBase< * Rename * @param {string} unique * @param {string} name - * @return {*} + * @returns {*} * @memberof UmbRenameServerFileRepositoryBase */ async rename(unique: string, name: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/server-file-system/server-path-unique-serializer.ts b/src/Umbraco.Web.UI.Client/src/packages/core/server-file-system/server-path-unique-serializer.ts index 96a180e26e..0359f83758 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/server-file-system/server-path-unique-serializer.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/server-file-system/server-path-unique-serializer.ts @@ -4,7 +4,7 @@ export class UmbServerFilePathUniqueSerializer { /** * Converts a server file path to a unique URL friendly string that can be used in the client * @param {string} serverFilePath - * @return {*} {(string | null)} + * @returns {*} {(string | null)} * @memberof UmbServerFilePathSerializer */ toUnique(serverFilePath: string): string { @@ -15,7 +15,7 @@ export class UmbServerFilePathUniqueSerializer { /** * Converts a unique URL friendly string to a server path * @param {string} serverFilePathUnique - * @return {*} {(string | null)} + * @returns {*} {(string | null)} * @memberof UmbServerFilePathSerializer */ toServerPath(serverFilePathUnique: string | null): string | null { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/sorter/sorter.controller.ts b/src/Umbraco.Web.UI.Client/src/packages/core/sorter/sorter.controller.ts index 4107034ecc..63b0ca6389 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/sorter/sorter.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/sorter/sorter.controller.ts @@ -5,6 +5,11 @@ import type { UmbControllerHostElement } from '@umbraco-cms/backoffice/controlle const autoScrollSensitivity = 50; const autoScrollSpeed = 16; +/** + * + * @param el + * @param includeSelf + */ function getParentScrollElement(el: Element, includeSelf: boolean) { if (!el || !el.getBoundingClientRect) return null; @@ -38,20 +43,38 @@ function getParentScrollElement(el: Element, includeSelf: boolean) { return null; } +/** + * + * @param element + * @param ignorerSelectors + */ function setupIgnorerElements(element: HTMLElement, ignorerSelectors: string) { ignorerSelectors.split(',').forEach(function (criteria) { element.querySelectorAll(criteria.trim()).forEach(setupPreventEvent); }); } +/** + * + * @param element + * @param ignorerSelectors + */ function destroyIgnorerElements(element: HTMLElement, ignorerSelectors: string) { ignorerSelectors.split(',').forEach(function (criteria: string) { element.querySelectorAll(criteria.trim()).forEach(destroyPreventEvent); }); } +/** + * + * @param element + */ function setupPreventEvent(element: Element) { (element as HTMLElement).draggable = false; //(element as HTMLElement).setAttribute('draggable', 'false'); } +/** + * + * @param element + */ function destroyPreventEvent(element: Element) { (element as HTMLElement).draggable = false; //element.removeAttribute('draggable'); @@ -76,7 +99,7 @@ type UniqueType = string | symbol | number; /** * Internal type, which is adjusted to become the public one. - * @internal */ + @internal */ type INTERNAL_UmbSorterConfig = { /** * Define how to retrive the unique identifier of an element. If this method returns undefined, the move will be cancelled. diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/store/detail/detail-store-base.ts b/src/Umbraco.Web.UI.Client/src/packages/core/store/detail/detail-store-base.ts index 1116c0d2c4..5221cb6f2a 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/store/detail/detail-store-base.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/store/detail/detail-store-base.ts @@ -6,7 +6,7 @@ import { UmbArrayState } from '@umbraco-cms/backoffice/observable-api'; /** * @export * @class UmbDetailStoreBase - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for Data Type items */ @@ -17,6 +17,7 @@ export abstract class UmbDetailStoreBase /** * Creates an instance of UmbDetailStoreBase. * @param {UmbControllerHost} host + * @param storeAlias * @memberof UmbDetailStoreBase */ constructor(host: UmbControllerHost, storeAlias: string) { @@ -26,6 +27,7 @@ export abstract class UmbDetailStoreBase /** * Retrieve a detail model from the store * @param {unique} string unique + * @param unique * @memberof UmbDetailStoreBase */ byUnique(unique: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/store/item/item-store-base.ts b/src/Umbraco.Web.UI.Client/src/packages/core/store/item/item-store-base.ts index 31f8103477..d8abe12821 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/store/item/item-store-base.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/store/item/item-store-base.ts @@ -6,7 +6,7 @@ import { UmbArrayState } from '@umbraco-cms/backoffice/observable-api'; /** * @export * @class UmbItemStoreBase - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for items with a unique property */ @@ -17,6 +17,7 @@ export abstract class UmbItemStoreBase /** * Creates an instance of UmbItemStoreBase. * @param {UmbControllerHost} host + * @param storeAlias * @memberof UmbItemStoreBase */ constructor(host: UmbControllerHost, storeAlias: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/temporary-file/temporary-file.repository.ts b/src/Umbraco.Web.UI.Client/src/packages/core/temporary-file/temporary-file.repository.ts index 12476f482c..b69257ab7b 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/temporary-file/temporary-file.repository.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/temporary-file/temporary-file.repository.ts @@ -6,7 +6,7 @@ import { UmbRepositoryBase } from '@umbraco-cms/backoffice/repository'; * A repository for uploading temporary files * @export * @class UmbTemporaryFileRepository - * @extends {UmbRepositoryBase} + * @augments {UmbRepositoryBase} */ export class UmbTemporaryFileRepository extends UmbRepositoryBase { #source: UmbTemporaryFileServerDataSource; @@ -25,7 +25,7 @@ export class UmbTemporaryFileRepository extends UmbRepositoryBase { * Uploads a temporary file * @param {string} id * @param {File} file - * @return {*} + * @returns {*} * @memberof UmbTemporaryFileRepository */ upload(id: string, file: File) { @@ -35,7 +35,7 @@ export class UmbTemporaryFileRepository extends UmbRepositoryBase { /** * Deletes a temporary file * @param {string} id - * @return {*} + * @returns {*} * @memberof UmbTemporaryFileRepository */ delete(id: string) { @@ -45,7 +45,7 @@ export class UmbTemporaryFileRepository extends UmbRepositoryBase { /** * Gets a temporary file * @param {string} id - * @return {*} + * @returns {*} * @memberof UmbTemporaryFileRepository */ requestById(id: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/temporary-file/temporary-file.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/core/temporary-file/temporary-file.server.data-source.ts index c5393ee8ff..132801370c 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/temporary-file/temporary-file.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/temporary-file/temporary-file.server.data-source.ts @@ -24,7 +24,7 @@ export class UmbTemporaryFileServerDataSource { * Uploads a temporary file to the server * @param {string} id * @param {File} file - * @return {*} + * @returns {*} * @memberof UmbTemporaryFileServerDataSource */ async create(id: string, file: File) { @@ -42,7 +42,7 @@ export class UmbTemporaryFileServerDataSource { /** * Gets a temporary file from the server * @param {string} id - * @return {*} + * @returns {*} * @memberof UmbTemporaryFileServerDataSource */ read(id: string) { @@ -53,7 +53,7 @@ export class UmbTemporaryFileServerDataSource { /** * Deletes a temporary file from the server * @param {string} id - * @return {*} + * @returns {*} * @memberof UmbTemporaryFileServerDataSource */ delete(id: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-data-source.interface.ts b/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-data-source.interface.ts index a909305c8d..328293e3a2 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-data-source.interface.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-data-source.interface.ts @@ -31,21 +31,21 @@ export interface UmbTreeDataSource< > { /** * Gets the root items of the tree. - * @return {*} {Promise>>} + * @returns {*} {Promise>>} * @memberof UmbTreeDataSource */ getRootItems(args: TreeRootItemsRequestArgsType): Promise>>; /** * Gets the children of the given parent item. - * @return {*} {Promise>} + * @returns {*} {Promise>} * @memberof UmbTreeDataSource */ getChildrenOf(args: TreeChildrenOfRequestArgsType): Promise>>; /** * Gets the ancestors of the given item. - * @return {*} {Promise>} + * @returns {*} {Promise>} * @memberof UmbTreeDataSource */ getAncestorsOf(args: TreeAncestorsOfRequestArgsType): Promise>>; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-repository-base.ts b/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-repository-base.ts index bbd9469bd9..731da92197 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-repository-base.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-repository-base.ts @@ -18,7 +18,7 @@ import type { UmbContextToken } from '@umbraco-cms/backoffice/context-api'; * @export * @abstract * @class UmbTreeRepositoryBase - * @extends {UmbRepositoryBase} + * @augments {UmbRepositoryBase} * @implements {UmbTreeRepository} * @implements {UmbApi} * @template TreeItemType @@ -68,14 +68,14 @@ export abstract class UmbTreeRepositoryBase< /** * Request the tree root item - * @return {*} + * @returns {*} * @memberof UmbTreeRepositoryBase */ abstract requestTreeRoot(): Promise<{ data?: TreeRootType; error?: ProblemDetails }>; /** * Requests root items of a tree - * @return {*} + * @returns {*} * @memberof UmbTreeRepositoryBase */ async requestTreeRootItems(args: TreeRootItemsRequestArgsType) { @@ -93,7 +93,7 @@ export abstract class UmbTreeRepositoryBase< /** * Requests tree items of a given parent * @param {(string | null)} parentUnique - * @return {*} + * @returns {*} * @memberof UmbTreeRepositoryBase */ async requestTreeItemsOf(args: TreeChildrenOfRequestArgsType) { @@ -114,7 +114,7 @@ export abstract class UmbTreeRepositoryBase< /** * Requests ancestors of a given item * @param {UmbTreeAncestorsOfRequestArgs} args - * @return {*} + * @returns {*} * @memberof UmbTreeRepositoryBase */ async requestTreeItemAncestors(args: TreeAncestorsOfRequestArgsType) { @@ -129,7 +129,7 @@ export abstract class UmbTreeRepositoryBase< /** * Returns a promise with an observable of tree root items - * @return {*} + * @returns {*} * @memberof UmbTreeRepositoryBase */ async rootTreeItems() { @@ -140,7 +140,7 @@ export abstract class UmbTreeRepositoryBase< /** * Returns a promise with an observable of children items of a given parent * @param {(string | null)} parentUnique - * @return {*} + * @returns {*} * @memberof UmbTreeRepositoryBase */ async treeItemsOf(parentUnique: string | null) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-repository.interface.ts b/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-repository.interface.ts index 186b593fe5..764039aaf7 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-repository.interface.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-repository.interface.ts @@ -13,7 +13,7 @@ import type { UmbApi } from '@umbraco-cms/backoffice/extension-api'; * Interface for a tree repository. * @export * @interface UmbTreeRepository - * @extends {UmbApi} + * @augments {UmbApi} * @template TreeItemType * @template TreeRootType */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-server-data-source-base.ts b/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-server-data-source-base.ts index ff238113a0..c881b997b0 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-server-data-source-base.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-server-data-source-base.ts @@ -73,7 +73,7 @@ export abstract class UmbTreeServerDataSourceBase< /** * Fetches the root items for the tree from the server * @param {UmbTreeRootItemsRequestArgs} args - * @return {*} + * @returns {*} * @memberof UmbTreeServerDataSourceBase */ async getRootItems(args: TreeRootItemsRequestArgsType) { @@ -90,7 +90,7 @@ export abstract class UmbTreeServerDataSourceBase< /** * Fetches the children of a given parent unique from the server * @param {UmbTreeChildrenOfRequestArgs} args - * @return {*} + * @returns {*} * @memberof UmbTreeServerDataSourceBase */ async getChildrenOf(args: TreeChildrenOfRequestArgsType) { @@ -109,7 +109,7 @@ export abstract class UmbTreeServerDataSourceBase< /** * Fetches the ancestors of a given item from the server * @param {UmbTreeAncestorsOfRequestArgs} args - * @return {*} + * @returns {*} * @memberof UmbTreeServerDataSourceBase */ async getAncestorsOf(args: TreeAncestorsOfRequestArgsType) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-store.interface.ts b/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-store.interface.ts index 11355a21f4..78398c10e7 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-store.interface.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/tree-store.interface.ts @@ -7,8 +7,8 @@ import type { UmbApi } from '@umbraco-cms/backoffice/extension-api'; * Interface for a tree store. * @export * @interface UmbTreeStore - * @extends {UmbStore} - * @extends {UmbApi} + * @augments {UmbStore} + * @augments {UmbApi} * @template TreeItemType */ export interface UmbTreeStore extends UmbStore, UmbApi { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/unique-tree-store.ts b/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/unique-tree-store.ts index 5a6f94e720..e0ba5e64f4 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/unique-tree-store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/tree/data/unique-tree-store.ts @@ -8,7 +8,7 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; /** * @export * @class UmbUniqueTreeStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Entity Tree Store */ export class UmbUniqueTreeStore extends UmbStoreBase implements UmbTreeStore { @@ -25,7 +25,7 @@ export class UmbUniqueTreeStore extends UmbStoreBase implement /** * Returns an observable to observe the children of a given parent * @param {(string | null)} parentUnique - * @return {*} + * @returns {*} * @memberof UmbUniqueTreeStore */ childrenOf(parentUnique: string | null) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/tree/default/default-tree.context.ts b/src/Umbraco.Web.UI.Client/src/packages/core/tree/default/default-tree.context.ts index a4ac48c6db..cef4e9a0de 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/tree/default/default-tree.context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/tree/default/default-tree.context.ts @@ -124,7 +124,7 @@ export class UmbDefaultTreeContext< // TODO: getManifest, could be refactored to use the getter method [NL] /** * Returns the manifest. - * @return {ManifestTree} + * @returns {ManifestTree} * @memberof UmbDefaultTreeContext */ public getManifest() { @@ -228,7 +228,7 @@ export class UmbDefaultTreeContext< /** * Gets the hideTreeRoot config - * @return {boolean} + * @returns {boolean} * @memberof UmbDefaultTreeContext */ getHideTreeRoot() { @@ -249,7 +249,7 @@ export class UmbDefaultTreeContext< /** * Gets the startNode config - * @return {UmbTreeStartNode} + * @returns {UmbTreeStartNode} * @memberof UmbDefaultTreeContext */ getStartNode() { @@ -270,7 +270,7 @@ export class UmbDefaultTreeContext< /** * Gets the foldersOnly config - * @return {boolean} + * @returns {boolean} * @memberof UmbDefaultTreeContext */ getFoldersOnly() { @@ -279,6 +279,7 @@ export class UmbDefaultTreeContext< /** * Updates the requestArgs config and reloads the tree. + * @param args */ public updateAdditionalRequestArgs(args: Partial) { this.#additionalRequestArgs.setValue({ ...this.#additionalRequestArgs.getValue(), ...args }); diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/tree/folder/folder-repository-base.ts b/src/Umbraco.Web.UI.Client/src/packages/core/tree/folder/folder-repository-base.ts index 7c1f77ff8b..9c48199eea 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/tree/folder/folder-repository-base.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/tree/folder/folder-repository-base.ts @@ -25,7 +25,7 @@ export abstract class UmbFolderRepositoryBase extends UmbRepositoryBase implemen /** * Creates a scaffold for a folder - * @return {*} + * @returns {*} * @memberof UmbFolderRepositoryBase */ async createScaffold() { @@ -40,7 +40,7 @@ export abstract class UmbFolderRepositoryBase extends UmbRepositoryBase implemen /** * Creates a folder * @param {UmbCreateFolderModel} args - * @return {*} + * @returns {*} * @memberof UmbFolderRepositoryBase */ async create(args: UmbCreateFolderModel) { @@ -63,7 +63,7 @@ export abstract class UmbFolderRepositoryBase extends UmbRepositoryBase implemen /** * Request a folder * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbFolderRepositoryBase */ async request(unique: string) { @@ -75,7 +75,7 @@ export abstract class UmbFolderRepositoryBase extends UmbRepositoryBase implemen /** * Updates a folder * @param {UmbUpdateFolderModel} args - * @return {*} + * @returns {*} * @memberof UmbFolderRepositoryBase */ async update(args: UmbUpdateFolderModel) { @@ -96,7 +96,7 @@ export abstract class UmbFolderRepositoryBase extends UmbRepositoryBase implemen /** * Deletes a folder * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbFolderRepositoryBase */ async delete(unique: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/tree/tree-item/tree-item-base/tree-item-context-base.ts b/src/Umbraco.Web.UI.Client/src/packages/core/tree/tree-item/tree-item-base/tree-item-context-base.ts index e42ce7cf00..7c64a54380 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/tree/tree-item/tree-item-base/tree-item-context-base.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/tree/tree-item/tree-item-base/tree-item-context-base.ts @@ -124,7 +124,7 @@ export abstract class UmbTreeItemContextBase< // TODO: Be aware that this method, could be removed and we can use the getter method instead [NL] /** * Returns the manifest. - * @return {ManifestCollection} + * @returns {ManifestCollection} * @memberof UmbCollectionContext */ public getManifest() { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/download/blob-download.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/download/blob-download.function.ts index f4371b4ac0..10c74bffaf 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/download/blob-download.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/download/blob-download.function.ts @@ -2,12 +2,10 @@ * Triggers a client-side download of a file, using a `Blob` object. * To do this, a temporary anchor element is created, appended to the document body, * immediate triggered to download, then removed from the document body. - * * @param {any} data - The data to be downloaded. * @param {string} filename - The name of the file to be downloaded. * @param {string} mimeType - The MIME type of the file to be downloaded. * @returns {void} - * * @example * blobDownload(data, 'package.xml', 'text/xml'); */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/get-processed-image-url.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/get-processed-image-url.function.ts index 7744eae0a3..674e6de91b 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/get-processed-image-url.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/get-processed-image-url.function.ts @@ -2,6 +2,8 @@ /** * Returns the URL of the processed image + * @param imagePath + * @param options */ export async function getProcessedImageUrl(imagePath: string, options: any) { if (!options) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/math/math.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/math/math.ts index 7e9c21ff76..e1a0c4c88d 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/math/math.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/math/math.ts @@ -3,13 +3,10 @@ export { clamp }; /** * Performs linear interpolation (lerp) between two numbers based on a blending factor. - * * @param {number} start - The starting value. * @param {number} end - The ending value. * @param {number} alpha - The blending factor, clamped to the range [0, 1]. - * * @returns {number} The result of linear interpolation between `start` and `end` using `alpha`. - * * @example * // Interpolate between two values. * const value1 = 10; @@ -38,17 +35,14 @@ export function lerp(start: number, end: number, alpha: number): number { * The inverse lerp factor indicates where the given `value` falls between `start` and `end`. * * If `value` is equal to `start`, the function returns 0. If `value` is equal to `end`, the function returns 1. - * * @param {number} start - The starting value. * @param {number} end - The ending value. * @param {number} value - The value to calculate the inverse lerp factor for. - * * @returns {number} The inverse lerp factor, a value in the range [0, 1], indicating where `value` falls between `start` and `end`. * - If `start` and `end` are equal, the function returns 0. * - If `value` is less than `start`, the factor is less than 0, indicating it's before `start`. * - If `value` is greater than `end`, the factor is greater than 1, indicating it's after `end`. * - If `value` is between `start` and `end`, the factor is between 0 and 1, indicating where `value` is along that range. - * * @example * // Calculate the inverse lerp factor for a value between two points. * const startValue = 10; @@ -72,12 +66,9 @@ export function inverseLerp(start: number, end: number, value: number): number { /** * Calculates the absolute difference between two numbers. - * * @param {number} a - The first number. * @param {number} b - The second number. - * * @returns {number} The absolute difference between `a` and `b`. - * * @example * // Calculate the distance between two points on a number line. * const point1 = 5; @@ -97,14 +88,11 @@ export function distance(a: number, b: number): number { /** * Calculates the extrapolated final value based on an initial value and an increase factor. - * * @param {number} initialValue - The starting value. * @param {number} increaseFactor - The factor by which the value should increase * (must be in the range [0(inclusive), 1(exclusive)] where 0 means no increase and 1 means no limit). - * * @returns {number} The extrapolated final value. * Returns NaN if the increase factor is not within the valid range. - * * @example * // Valid input * const result = calculateExtrapolatedValue(100, 0.2); diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/object/deep-merge.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/object/deep-merge.function.ts index 2031517316..6b42109e76 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/object/deep-merge.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/object/deep-merge.function.ts @@ -4,6 +4,8 @@ import type { UmbDeepPartialObject } from '../type/deep-partial-object.type.js'; * Deep merge two objects. * @param target * @param ...sources + * @param source + * @param fallback */ export function umbDeepMerge< T extends { [key: string]: any }, diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/pagination-manager/pagination.manager.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/pagination-manager/pagination.manager.ts index 40fd9ca3a9..9c1db36e9c 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/pagination-manager/pagination.manager.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/pagination-manager/pagination.manager.ts @@ -35,7 +35,7 @@ export class UmbPaginationManager extends EventTarget { /** * Gets the number of items per page - * @return {number} + * @returns {number} * @memberof UmbPaginationManager */ public getPageSize() { @@ -44,7 +44,7 @@ export class UmbPaginationManager extends EventTarget { /** * Gets the total number of items - * @return {number} + * @returns {number} * @memberof UmbPaginationManager */ public getTotalItems() { @@ -63,7 +63,7 @@ export class UmbPaginationManager extends EventTarget { /** * Gets the total number of pages - * @return {number} + * @returns {number} * @memberof UmbPaginationManager */ public getTotalPages() { @@ -72,7 +72,7 @@ export class UmbPaginationManager extends EventTarget { /** * Gets the current page number - * @return {number} + * @returns {number} * @memberof UmbPaginationManager */ public getCurrentPageNumber() { @@ -100,7 +100,7 @@ export class UmbPaginationManager extends EventTarget { /** * Gets the number of items to skip - * @return {number} + * @returns {number} * @memberof UmbPaginationManager */ public getSkip() { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/ensure-local-path.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/ensure-local-path.function.ts index 6862d689cb..d689400a95 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/ensure-local-path.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/ensure-local-path.function.ts @@ -1,5 +1,7 @@ /** * Ensure that the path is a local path. + * @param path + * @param fallbackPath */ export function ensureLocalPath(path: URL | string, fallbackPath?: URL | string): URL { const url = new URL(path, window.location.origin); diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/ensure-path-ends-with-slash.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/ensure-path-ends-with-slash.function.ts index d4a66ab9d3..282910475a 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/ensure-path-ends-with-slash.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/ensure-path-ends-with-slash.function.ts @@ -1,3 +1,7 @@ +/** + * + * @param path + */ export function ensurePathEndsWithSlash(path: string) { return path.endsWith('/') ? path : path + '/'; } diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/has-own-opener.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/has-own-opener.function.ts index a1763d6214..575bcfaf6d 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/has-own-opener.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/has-own-opener.function.ts @@ -4,7 +4,6 @@ * @remark If the current window was opened by another window, the opener window is accessible via `window.opener`. * @remark There could still be an opener if the opener window is closed or navigated away or if the opener window is not from the same origin, * but this function will only return `true` if the opener window is accessible and has the same origin and optional pathname. - * * @param pathname Optional pathname to check if the opener window has the same pathname. * @param windowLike The window-like object to use for checking the opener. Default is `window`. * @returns `true` if the current window has an opener window with the same origin and optional pathname, otherwise `false`. diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/remove-initial-slash-from-path.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/remove-initial-slash-from-path.function.ts index a12040a589..64ab8b51c8 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/remove-initial-slash-from-path.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/remove-initial-slash-from-path.function.ts @@ -1,3 +1,7 @@ +/** + * + * @param path + */ export function removeInitialSlashFromPath(path: string) { return path.startsWith('/') ? path.slice(1) : path; } diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/stored-path.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/stored-path.function.ts index 12c35df508..01e877a5bb 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/stored-path.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/stored-path.function.ts @@ -18,6 +18,7 @@ export function retrieveStoredPath(): URL | null { /** * Store the path in the session storage. + * @param path * @remark This is used to redirect the user to the correct page after login. * @remark The path must be a local path, otherwise it is not stored. */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/transform-server-path-to-client-path.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/transform-server-path-to-client-path.function.ts index ecca6cb3a4..1589180c59 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/transform-server-path-to-client-path.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/transform-server-path-to-client-path.function.ts @@ -1,5 +1,9 @@ type StringMaybeUndefined = string | undefined; +/** + * + * @param path + */ export function transformServerPathToClientPath(path: T): T { if (path?.indexOf('~/') === 0) { path = path.slice(1) as T; diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/umbraco-path.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/umbraco-path.function.ts index 9c54a56c4e..754e07d3a9 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/umbraco-path.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/umbraco-path.function.ts @@ -1,4 +1,8 @@ // TODO: Rename to something more obvious, naming wise this can mean anything. I suggest: umbracoManagementApiPath() +/** + * + * @param path + */ export function umbracoPath(path: string) { return `/umbraco/management/api/v1${path}`; } diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/url-pattern-to-string.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/url-pattern-to-string.function.ts index 1cd087a67e..9b200c9785 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/url-pattern-to-string.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/path/url-pattern-to-string.function.ts @@ -2,6 +2,11 @@ export type UrlParametersRecord = Record { diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/selection-manager/selection.manager.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/selection-manager/selection.manager.ts index 6bfb64d0b9..bf89c41a8f 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/selection-manager/selection.manager.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/selection-manager/selection.manager.ts @@ -24,7 +24,7 @@ export class UmbSelectionManager (+t + 1).toString().padStart(t.length, '0')); } diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/string/split-string-to-array.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/string/split-string-to-array.ts index d5a6fb5d02..cc1339abdb 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/string/split-string-to-array.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/string/split-string-to-array.ts @@ -1,15 +1,12 @@ /** * Splits a string into an array using a specified delimiter, * trims whitespace from each element, and removes empty elements. - * * @param {string | undefined} string - The input string to be split and processed. - * @param {string} [split=','] - The delimiter used for splitting the string (default is comma). + * @param {string} [split] - The delimiter used for splitting the string (default is comma). * @returns {Array} An array of non-empty, trimmed strings. - * * @example * const result = splitStringToArray('one, two, three, ,five'); * // result: ['one', 'two', 'three', 'five'] - * * @example * const customDelimiterResult = splitStringToArray('apple | orange | banana', ' | '); * // customDelimiterResult: ['apple', 'orange', 'banana'] diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/string/string-or-string-array-contains.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/string/string-or-string-array-contains.function.ts index 54f8dc419f..23c9981df1 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/string/string-or-string-array-contains.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/string/string-or-string-array-contains.function.ts @@ -1,3 +1,8 @@ +/** + * + * @param value + * @param search + */ export function stringOrStringArrayContains(value: string | Array, search: string) { return Array.isArray(value) ? value.indexOf(search) !== -1 : value === search; } diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/validation/mixins/form-control.mixin.ts b/src/Umbraco.Web.UI.Client/src/packages/core/validation/mixins/form-control.mixin.ts index 2fbeb54a11..b390b64463 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/validation/mixins/form-control.mixin.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/validation/mixins/form-control.mixin.ts @@ -84,8 +84,8 @@ export declare abstract class UmbFormControlMixinElement /** * The mixin allows a custom element to participate in HTML forms. - * - * @param {Object} superClass - superclass to be extended. + * @param {object} superClass - superclass to be extended. + * @param defaultValue * @mixin */ export function UmbFormControlMixin< @@ -106,7 +106,7 @@ export function UmbFormControlMixin< * Value of this form control. * @type {string} * @attr value - * @default '' + * @default */ @property({ reflect: false }) // Do not 'reflect' as the attribute value is used as fallback. [NL] get value(): ValueType | DefaultValueType { @@ -125,7 +125,7 @@ export function UmbFormControlMixin< * Determines wether the form control has been touched or interacted with, this determines wether the validation-status of this form control should be made visible. * @type {boolean} * @attr - * @default true + * @default */ @property({ type: Boolean, reflect: true }) public set pristine(value: boolean) { @@ -158,7 +158,7 @@ export function UmbFormControlMixin< /** * Get internal form element. * This has to be implemented to provide a FormControl Element of choice for the given context. The element is used as anchor for validation-messages. - * @method getFormElement + * @function getFormElement * @returns {HTMLElement | undefined | null} */ protected getFormElement(): HTMLElement | undefined | null { @@ -167,7 +167,7 @@ export function UmbFormControlMixin< /** * Focus first element that is invalid. - * @method focusFirstInvalidElement + * @function focusFirstInvalidElement * @returns {HTMLElement | undefined} */ focusFirstInvalidElement() { @@ -196,14 +196,13 @@ export function UmbFormControlMixin< /** * Add validation, to validate this Form Control. * See https://developer.mozilla.org/en-US/docs/Web/API/ValidityState for available Validator FlagTypes. - * * @example * this.addValidator( * 'tooLong', * () => 'This input contains too many characters', * () => this._value.length > 10 * ); - * @method addValidator + * @function addValidator * @param {FlagTypes} flagKey the type of validation. * @param {method} getMessageMethod method to retrieve relevant message. Is executed every time the validator is re-executed. * @param {method} checkMethod method to determine if this validator should invalidate this form control. Return true if this should prevent submission. @@ -224,7 +223,7 @@ export function UmbFormControlMixin< /** * Remove validation from this form control. - * @method removeValidator + * @function removeValidator * @param {UmbFormControlValidatorConfig} validator - The specific validation configuration to remove. */ removeValidator(validator: UmbFormControlValidatorConfig) { @@ -235,7 +234,7 @@ export function UmbFormControlMixin< } /** - * @method addFormControlElement + * @function addFormControlElement * @description Important notice if adding a native form control then ensure that its value and thereby validity is updated when value is changed from the outside. * @param element {UmbNativeFormControlElement} - element to validate and include as part of this form association. */ @@ -258,7 +257,7 @@ export function UmbFormControlMixin< private _customValidityObject?: UmbFormControlValidatorConfig; /** - * @method setCustomValidity + * @function setCustomValidity * @description Set custom validity state, set to empty string to remove the custom message. * @param message {string} - The message to be shown * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLObjectElement/setCustomValidity|HTMLObjectElement:setCustomValidity} @@ -280,7 +279,7 @@ export function UmbFormControlMixin< } /** - * @method _runValidators + * @function _runValidators * @description Run all validators and set the validityState of this form control. * Run this method when you want to re-run all validators. * This can be relevant if you have a validators that is using values that is not triggering the Lit Updated Callback. diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/variant/variant-id.class.ts b/src/Umbraco.Web.UI.Client/src/packages/core/variant/variant-id.class.ts index 0abd9da458..ce012c8c61 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/variant/variant-id.class.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/variant/variant-id.class.ts @@ -3,6 +3,10 @@ export type UmbObjectWithVariantProperties = { segment: string | null; }; +/** + * + * @param variant + */ export function variantPropertiesObjectToString(variant: UmbObjectWithVariantProperties): string { // Currently a direct copy of the toString method of variantId. return (variant.culture || UMB_INVARIANT_CULTURE) + (variant.segment ? `_${variant.segment}` : ''); diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-action-menu-item/workspace-action-menu-item-base.controller.ts b/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-action-menu-item/workspace-action-menu-item-base.controller.ts index 97b0c44fd5..60eb18db91 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-action-menu-item/workspace-action-menu-item-base.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-action-menu-item/workspace-action-menu-item-base.controller.ts @@ -7,7 +7,7 @@ import { UmbActionBase } from '@umbraco-cms/backoffice/action'; * @export * @abstract * @class UmbWorkspaceActionMenuItemBase - * @extends {UmbActionBase} + * @augments {UmbActionBase} * @implements {UmbWorkspaceActionMenuItem} * @template RepositoryType */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-action/default/workspace-action.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-action/default/workspace-action.element.ts index 242ed854e4..550376a01f 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-action/default/workspace-action.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-action/default/workspace-action.element.ts @@ -185,6 +185,10 @@ declare global { } } +/** + * + * @param manifest + */ function ExtensionApiArgsMethod(manifest: ManifestWorkspaceActionMenuItem) { return [{ meta: manifest.meta }]; } diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-action/workspace-action-base.controller.ts b/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-action/workspace-action-base.controller.ts index 791bf2c720..bbad446011 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-action/workspace-action-base.controller.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-action/workspace-action-base.controller.ts @@ -8,7 +8,7 @@ import { UmbActionBase } from '@umbraco-cms/backoffice/action'; * @export * @abstract * @class UmbWorkspaceActionBase - * @extends {UmbActionBase} + * @augments {UmbActionBase} * @implements {UmbEntityAction} * @template RepositoryType */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-editor/workspace-editor.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-editor/workspace-editor.element.ts index bf13c6af6c..15639d6ed7 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-editor/workspace-editor.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-editor/workspace-editor.element.ts @@ -17,7 +17,7 @@ import type { UmbRoute, UmbRouterSlotInitEvent, UmbRouterSlotChangeEvent } from * @slot - slot for main content * @export * @class UmbWorkspaceEditor - * @extends {UmbLitElement} + * @augments {UmbLitElement} */ // TODO: This element has a bug in the tabs. After the url changes - for example a new entity/file is chosen in the tree and loaded to the workspace the links in the tabs still point to the previous url and therefore views do not change correctly @customElement('umb-workspace-editor') diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-footer/workspace-footer.element.ts b/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-footer/workspace-footer.element.ts index b590ec4927..0e2aef208f 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-footer/workspace-footer.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/workspace/components/workspace-footer/workspace-footer.element.ts @@ -8,6 +8,10 @@ import { UMB_MODAL_CONTEXT } from '@umbraco-cms/backoffice/modal'; import type { ManifestWorkspaceAction, MetaWorkspaceAction } from '@umbraco-cms/backoffice/extension-registry'; import type { UmbWorkspaceActionArgs } from '@umbraco-cms/backoffice/workspace'; +/** + * + * @param manifest + */ function ExtensionApiArgsMethod( manifest: ManifestWorkspaceAction, ): [UmbWorkspaceActionArgs] { @@ -21,7 +25,7 @@ function ExtensionApiArgsMethod( * @slot actions - Slot for workspace actions * @export * @class UmbWorkspaceFooterLayout - * @extends {UmbLitElement} + * @augments {UmbLitElement} */ // TODO: stop naming this something with layout. as its not just an layout. it hooks up with extensions. @customElement('umb-workspace-footer') diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/workspace/conditions/workspace-alias.condition.ts b/src/Umbraco.Web.UI.Client/src/packages/core/workspace/conditions/workspace-alias.condition.ts index db6308554b..cd9026d329 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/workspace/conditions/workspace-alias.condition.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/workspace/conditions/workspace-alias.condition.ts @@ -37,14 +37,12 @@ export class UmbWorkspaceAliasCondition export type WorkspaceAliasConditionConfig = UmbConditionConfigBase<'Umb.Condition.WorkspaceAlias'> & { /** * Define the workspace that this extension should be available in - * * @example * "Umb.Workspace.Document" */ match?: string; /** * Define one or more workspaces that this extension should be available in - * * @example * ["Umb.Workspace.Document", "Umb.Workspace.Media"] */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/workspace/conditions/workspace-entity-type.condition.ts b/src/Umbraco.Web.UI.Client/src/packages/core/workspace/conditions/workspace-entity-type.condition.ts index 661a8a136a..b8b510681f 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/workspace/conditions/workspace-entity-type.condition.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/workspace/conditions/workspace-entity-type.condition.ts @@ -23,7 +23,6 @@ export class UmbWorkspaceEntityTypeCondition export type WorkspaceEntityTypeConditionConfig = UmbConditionConfigBase<'Umb.Condition.WorkspaceEntityType'> & { /** * Define the workspace that this extension should be available in - * * @example * "Document" */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/workspace/workspace-property-dataset/invariant-workspace-property-dataset-context.ts b/src/Umbraco.Web.UI.Client/src/packages/core/workspace/workspace-property-dataset/invariant-workspace-property-dataset-context.ts index 5187570626..46b0a136f8 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/workspace/workspace-property-dataset/invariant-workspace-property-dataset-context.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/workspace/workspace-property-dataset/invariant-workspace-property-dataset-context.ts @@ -45,6 +45,7 @@ export class UmbInvariantWorkspacePropertyDatasetContext< /** * TODO: Write proper JSDocs here. + * @param propertyAlias */ async propertyValueByAlias(propertyAlias: string) { return await this.#workspace.propertyValueByAlias(propertyAlias); @@ -52,6 +53,8 @@ export class UmbInvariantWorkspacePropertyDatasetContext< /** * TODO: Write proper JSDocs here. + * @param propertyAlias + * @param value */ async setPropertyValue(propertyAlias: string, value: unknown) { return this.#workspace.setPropertyValue(propertyAlias, value); diff --git a/src/Umbraco.Web.UI.Client/src/packages/data-type/collection/repository/data-type-collection.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/data-type/collection/repository/data-type-collection.server.data-source.ts index e516f6f973..1e53a2dae7 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/data-type/collection/repository/data-type-collection.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/data-type/collection/repository/data-type-collection.server.data-source.ts @@ -36,7 +36,7 @@ export class UmbDataTypeCollectionServerDataSource implements UmbCollectionDataS /** * Gets the DataType collection filtered by the given filter. * @param {UmbDataTypeCollectionFilterModel} filter - * @return {*} + * @returns {*} * @DataTypeof UmbDataTypeCollectionServerDataSource */ async getCollection(filter: UmbDataTypeCollectionFilterModel) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/data-type/components/data-type-flow-input/data-type-flow-input.element.ts b/src/Umbraco.Web.UI.Client/src/packages/data-type/components/data-type-flow-input/data-type-flow-input.element.ts index 7478333f9e..62700d299f 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/data-type/components/data-type-flow-input/data-type-flow-input.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/data-type/components/data-type-flow-input/data-type-flow-input.element.ts @@ -25,7 +25,7 @@ export class UmbInputDataTypeElement extends UUIFormControlMixin(UmbLitElement, /** * @param {string} dataTypeId - * @default [] + * @default */ @property({ type: String, attribute: false }) override set value(dataTypeId: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/data-type/components/data-type-input/data-type-input.element.ts b/src/Umbraco.Web.UI.Client/src/packages/data-type/components/data-type-input/data-type-input.element.ts index 3b9173d9f8..b83c05e011 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/data-type/components/data-type-input/data-type-input.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/data-type/components/data-type-input/data-type-input.element.ts @@ -30,7 +30,7 @@ export class UmbDataTypeInputElement extends UUIFormControlMixin(UmbLitElement, * This is a minimum amount of selected items in this input. * @type {number} * @attr - * @default 0 + * @default */ @property({ type: Number }) public set min(value: number) { @@ -53,7 +53,7 @@ export class UmbDataTypeInputElement extends UUIFormControlMixin(UmbLitElement, * This is a maximum amount of selected items in this input. * @type {number} * @attr - * @default Infinity + * @default */ @property({ type: Number }) public set max(value: number) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/data-type/components/ref-data-type/ref-data-type.element.ts b/src/Umbraco.Web.UI.Client/src/packages/data-type/components/ref-data-type/ref-data-type.element.ts index 460df6de75..ea3bd568e0 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/data-type/components/ref-data-type/ref-data-type.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/data-type/components/ref-data-type/ref-data-type.element.ts @@ -7,7 +7,7 @@ import { umbExtensionsRegistry } from '@umbraco-cms/backoffice/extension-registr /** * @element umb-ref-data-type * @description - Component for displaying a reference to a Data Type - * @extends UUIRefNodeElement + * @augments UUIRefNodeElement */ @customElement('umb-ref-data-type') export class UmbRefDataTypeElement extends UmbElementMixin(UUIRefNodeElement) { @@ -65,9 +65,11 @@ export class UmbRefDataTypeElement extends UmbElementMixin(UUIRefNodeElement) { umbExtensionsRegistry.byTypeAndAlias('propertyEditorUi', this.propertyEditorUiAlias), async (manifestPropertyEditorUi) => { const icon = manifestPropertyEditorUi?.meta.icon; - /** [LI] We have the icon name now, but because this element extends from uui-ref-node, it wants the icon via the icon slot. + /** + * [LI] We have the icon name now, but because this element extends from uui-ref-node, it wants the icon via the icon slot. * From what I can see, this is not possible via this file, but this is the file that have the datatype data.... - * Instead, overwriting the fallbackIcon property which requires a SVG... */ + * Instead, overwriting the fallbackIcon property which requires a SVG... + */ if (icon) { this.#requestIconSVG(icon); } diff --git a/src/Umbraco.Web.UI.Client/src/packages/data-type/entity-actions/duplicate/repository/data-type-duplicate.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/data-type/entity-actions/duplicate/repository/data-type-duplicate.server.data-source.ts index f6d717c241..291ebcc504 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/data-type/entity-actions/duplicate/repository/data-type-duplicate.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/data-type/entity-actions/duplicate/repository/data-type-duplicate.server.data-source.ts @@ -23,7 +23,7 @@ export class UmbDuplicateDataTypeServerDataSource implements UmbDuplicateToDataS /** * Duplicate an item for the given unique to the destination unique * @param {UmbDuplicateToRequestArgs} args - * @return {*} + * @returns {*} * @memberof UmbDuplicateDataTypeServerDataSource */ async duplicateTo(args: UmbDuplicateToRequestArgs) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/data-type/entity-actions/move-to/repository/data-type-move.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/data-type/entity-actions/move-to/repository/data-type-move.server.data-source.ts index b8c4291175..65d1366c73 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/data-type/entity-actions/move-to/repository/data-type-move.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/data-type/entity-actions/move-to/repository/data-type-move.server.data-source.ts @@ -24,7 +24,8 @@ export class UmbMoveDataTypeServerDataSource implements UmbMoveDataSource { * Move an item for the given id to the target unique * @param {string} unique * @param {(string | null)} targetUnique - * @return {*} + * @param args + * @returns {*} * @memberof UmbMoveDataTypeServerDataSource */ async moveTo(args: UmbMoveToRequestArgs) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/data-type/reference/repository/data-type-reference.server.data.ts b/src/Umbraco.Web.UI.Client/src/packages/data-type/reference/repository/data-type-reference.server.data.ts index f1b6f15f43..ef2fb073db 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/data-type/reference/repository/data-type-reference.server.data.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/data-type/reference/repository/data-type-reference.server.data.ts @@ -22,7 +22,7 @@ export class UmbDataTypeReferenceServerDataSource { /** * Fetches the item for the given unique from the server * @param {string} id - * @return {*} + * @returns {*} * @memberof UmbDataTypeReferenceServerDataSource */ async getReferencedBy(id: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/data-type/repository/detail/data-type-detail.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/data-type/repository/detail/data-type-detail.server.data-source.ts index 0902e37c11..482f7b58e5 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/data-type/repository/detail/data-type-detail.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/data-type/repository/detail/data-type-detail.server.data-source.ts @@ -31,7 +31,7 @@ export class UmbDataTypeServerDataSource implements UmbDetailDataSource = {}) { @@ -51,7 +51,7 @@ export class UmbDataTypeServerDataSource implements UmbDetailDataSource { diff --git a/src/Umbraco.Web.UI.Client/src/packages/data-type/repository/item/data-type-item.store.ts b/src/Umbraco.Web.UI.Client/src/packages/data-type/repository/item/data-type-item.store.ts index d8d6381e22..f4cc74dbde 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/data-type/repository/item/data-type-item.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/data-type/repository/item/data-type-item.store.ts @@ -6,7 +6,7 @@ import { UmbItemStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbDataTypeItemStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for Data Type items */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/data-type/search/data-type-search.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/data-type/search/data-type-search.server.data-source.ts index 20f021a3c5..d7bc1cd6d4 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/data-type/search/data-type-search.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/data-type/search/data-type-search.server.data-source.ts @@ -25,7 +25,7 @@ export class UmbDataTypeSearchServerDataSource implements UmbSearchDataSource { diff --git a/src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/export/dictionary-export.repository.ts b/src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/export/dictionary-export.repository.ts index 1a2fdf597e..a7e3c6e314 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/export/dictionary-export.repository.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/export/dictionary-export.repository.ts @@ -13,8 +13,8 @@ export class UmbDictionaryExportRepository extends UmbRepositoryBase { /** * @description - Export a Dictionary, optionally including child items. * @param {string} unique - * @param {boolean} [includeChildren=false] - * @return {*} + * @param {boolean} [includeChildren] + * @returns {*} * @memberof UmbDictionaryExportRepository */ async requestExport(unique: string, includeChildren = false) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/export/dictionary-export.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/export/dictionary-export.server.data-source.ts index 4c32bd8e25..e55b695ac3 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/export/dictionary-export.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/export/dictionary-export.server.data-source.ts @@ -13,7 +13,7 @@ export class UmbDictionaryExportServerDataSource { * @description - Export a Dictionary, optionally including child items. * @param {string} unique * @param {boolean} includeChildren - * @return {*} + * @returns {*} * @memberof UmbDictionaryExportServerDataSource */ async export(unique: string, includeChildren: boolean) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/import/dictionary-import.repository.ts b/src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/import/dictionary-import.repository.ts index 110d6644f5..73f2de83cb 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/import/dictionary-import.repository.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/import/dictionary-import.repository.ts @@ -17,7 +17,7 @@ export class UmbDictionaryImportRepository extends UmbRepositoryBase { * @description - Import a dictionary * @param {string} temporaryFileUnique * @param {string} [parentUnique] - * @return {*} + * @returns {*} * @memberof UmbDictionaryImportRepository */ async requestImport(temporaryFileUnique: string, parentUnique: string | null) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/item/dictionary-item.store.ts b/src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/item/dictionary-item.store.ts index a3d427afc6..be5fdd4eb2 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/item/dictionary-item.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/item/dictionary-item.store.ts @@ -6,7 +6,7 @@ import { UmbItemStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbDictionaryItemStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for Dictionary items */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/dictionary/tree/dictionary-tree.store.ts b/src/Umbraco.Web.UI.Client/src/packages/dictionary/tree/dictionary-tree.store.ts index b329f812e7..f192abcec8 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/dictionary/tree/dictionary-tree.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/dictionary/tree/dictionary-tree.store.ts @@ -5,7 +5,7 @@ import { UmbUniqueTreeStore } from '@umbraco-cms/backoffice/tree'; /** * @export * @class UmbDictionaryTreeStore - * @extends {UmbUniqueTreeStore} + * @augments {UmbUniqueTreeStore} * @description - Tree Data Store for Dictionary Items */ export class UmbDictionaryTreeStore extends UmbUniqueTreeStore { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/entity-actions/move-to/repository/document-blueprint-move.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/entity-actions/move-to/repository/document-blueprint-move.server.data-source.ts index 7c3f4dbfe7..418f3d2dc5 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/entity-actions/move-to/repository/document-blueprint-move.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/entity-actions/move-to/repository/document-blueprint-move.server.data-source.ts @@ -24,7 +24,8 @@ export class UmbMoveDocumentBlueprintServerDataSource implements UmbMoveDataSour * Move an item for the given id to the target unique * @param {string} unique * @param {(string | null)} targetUnique - * @return {*} + * @param args + * @returns {*} * @memberof UmbMoveDocumentBlueprintServerDataSource */ async moveTo(args: UmbMoveToRequestArgs) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/repository/detail/document-blueprint-detail.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/repository/detail/document-blueprint-detail.server.data-source.ts index 524f12f553..4a7adea15c 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/repository/detail/document-blueprint-detail.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/repository/detail/document-blueprint-detail.server.data-source.ts @@ -30,7 +30,7 @@ export class UmbDocumentBlueprintServerDataSource implements UmbDetailDataSource /** * Creates a new Document scaffold - * @return { UmbDocumentBlueprintDetailModel } + * @returns { UmbDocumentBlueprintDetailModel } * @memberof UmbDocumentBlueprintServerDataSource */ async createScaffold(preset: Partial = {}) { @@ -71,7 +71,7 @@ export class UmbDocumentBlueprintServerDataSource implements UmbDetailDataSource /** * Fetches a Document with the given id from the server * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbDocumentBlueprintServerDataSource */ async read(unique: string) { @@ -121,7 +121,7 @@ export class UmbDocumentBlueprintServerDataSource implements UmbDetailDataSource /** * Inserts a new Document on the server * @param {UmbDocumentBlueprintDetailModel} model - * @return {*} + * @returns {*} * @memberof UmbDocumentBlueprintServerDataSource */ async create(model: UmbDocumentBlueprintDetailModel, parentUnique: string | null = null) { @@ -154,7 +154,7 @@ export class UmbDocumentBlueprintServerDataSource implements UmbDetailDataSource /** * Updates a Document on the server * @param {UmbDocumentBlueprintDetailModel} Document - * @return {*} + * @returns {*} * @memberof UmbDocumentBlueprintServerDataSource */ async update(model: UmbDocumentBlueprintDetailModel) { @@ -184,7 +184,7 @@ export class UmbDocumentBlueprintServerDataSource implements UmbDetailDataSource /** * Deletes a Document on the server * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbDocumentBlueprintServerDataSource */ async delete(unique: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/repository/detail/document-blueprint-detail.store.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/repository/detail/document-blueprint-detail.store.ts index 00560e76ff..93bc133427 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/repository/detail/document-blueprint-detail.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/repository/detail/document-blueprint-detail.store.ts @@ -6,7 +6,7 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; /** * @export * @class UmbDocumentBlueprintDetailStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for Document Blueprint Details */ export class UmbDocumentBlueprintDetailStore extends UmbDetailStoreBase { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/repository/item/document-blueprint-item.store.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/repository/item/document-blueprint-item.store.ts index 74e2d2cdd6..52ccc63678 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/repository/item/document-blueprint-item.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/repository/item/document-blueprint-item.store.ts @@ -6,7 +6,7 @@ import { UmbItemStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbDocumentBlueprintItemStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for Document items */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/tree/document-blueprint-tree.store.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/tree/document-blueprint-tree.store.ts index 9fa5d56362..071d955d33 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/tree/document-blueprint-tree.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/tree/document-blueprint-tree.store.ts @@ -5,7 +5,7 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; /** * @export * @class UmbDocumentBlueprintTreeStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Tree Data Store for Document Blueprints */ export class UmbDocumentBlueprintTreeStore extends UmbUniqueTreeStore { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/tree/folder/document-blueprint-folder.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/tree/folder/document-blueprint-folder.server.data-source.ts index ef7645c2ae..7c762f580b 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/tree/folder/document-blueprint-folder.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/document-blueprints/tree/folder/document-blueprint-folder.server.data-source.ts @@ -24,7 +24,7 @@ export class UmbDocumentBlueprintFolderServerDataSource implements UmbFolderData /** * Fetches a Document Blueprint folder from the server * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbDocumentBlueprintFolderServerDataSource */ async read(unique: string) { @@ -52,7 +52,7 @@ export class UmbDocumentBlueprintFolderServerDataSource implements UmbFolderData /** * Creates a Document Blueprint folder on the server * @param {UmbCreateFolderModel} args - * @return {*} + * @returns {*} * @memberof UmbDocumentBlueprintFolderServerDataSource */ async create(args: UmbCreateFolderModel) { @@ -82,7 +82,7 @@ export class UmbDocumentBlueprintFolderServerDataSource implements UmbFolderData /** * Updates a Document Blueprint folder on the server * @param {UmbUpdateFolderModel} args - * @return {*} + * @returns {*} * @memberof UmbDocumentBlueprintFolderServerDataSource */ async update(args: UmbUpdateFolderModel) { @@ -107,7 +107,7 @@ export class UmbDocumentBlueprintFolderServerDataSource implements UmbFolderData /** * Deletes a Document Blueprint folder on the server * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbDocumentBlueprintServerDataSource */ async delete(unique: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/components/input-document-type/input-document-type.element.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/components/input-document-type/input-document-type.element.ts index a0a7d6a13c..f9249a9e2b 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/components/input-document-type/input-document-type.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/components/input-document-type/input-document-type.element.ts @@ -53,7 +53,7 @@ export class UmbInputDocumentTypeElement extends UmbFormControlMixin = {}) { @@ -68,7 +68,7 @@ export class UmbDocumentTypeDetailServerDataSource implements UmbDetailDataSourc /** * Fetches a Media Type with the given id from the server * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbDocumentTypeServerDataSource */ async read(unique: string) { @@ -135,7 +135,7 @@ export class UmbDocumentTypeDetailServerDataSource implements UmbDetailDataSourc /** * Inserts a new Media Type on the server * @param {UmbDocumentTypeDetailModel} model - * @return {*} + * @returns {*} * @memberof UmbDocumentTypeServerDataSource */ async create(model: UmbDocumentTypeDetailModel, parentUnique: string | null = null) { @@ -205,7 +205,7 @@ export class UmbDocumentTypeDetailServerDataSource implements UmbDetailDataSourc /** * Updates a DocumentType on the server * @param {UmbDocumentTypeDetailModel} DocumentType - * @return {*} + * @returns {*} * @memberof UmbDocumentTypeServerDataSource */ async update(model: UmbDocumentTypeDetailModel) { @@ -281,7 +281,7 @@ export class UmbDocumentTypeDetailServerDataSource implements UmbDetailDataSourc /** * Deletes a Media Type on the server * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbDocumentTypeServerDataSource */ async delete(unique: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/detail/document-type-detail.store.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/detail/document-type-detail.store.ts index b95c4d884c..e914fd259a 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/detail/document-type-detail.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/detail/document-type-detail.store.ts @@ -6,7 +6,7 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; /** * @export * @class UmbDocumentTypeStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for Document Types */ export class UmbDocumentTypeDetailStore extends UmbDetailStoreBase { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/item/document-type-item.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/item/document-type-item.server.data-source.ts index 31798bd0e5..3a608ce213 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/item/document-type-item.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/item/document-type-item.server.data-source.ts @@ -9,7 +9,7 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; * A data source for Document Type items that fetches data from the server * @export * @class UmbDocumentTypeItemServerDataSource - * @extends {UmbItemServerDataSourceBase} + * @augments {UmbItemServerDataSourceBase} */ export class UmbDocumentTypeItemServerDataSource extends UmbItemServerDataSourceBase< DocumentTypeItemResponseModel, diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/item/document-type-item.store.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/item/document-type-item.store.ts index 2272ea4f50..711208115f 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/item/document-type-item.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/item/document-type-item.store.ts @@ -6,7 +6,7 @@ import { UmbItemStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbDocumentTypeItemStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for Document Type items */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/structure/document-type-structure.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/structure/document-type-structure.server.data-source.ts index aead8f5ff7..0f4d1d93e0 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/structure/document-type-structure.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/repository/structure/document-type-structure.server.data-source.ts @@ -8,7 +8,7 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; * * @export * @class UmbDocumentTypeStructureServerDataSource - * @extends {UmbContentTypeStructureServerDataSourceBase} + * @augments {UmbContentTypeStructureServerDataSourceBase} */ export class UmbDocumentTypeStructureServerDataSource extends UmbContentTypeStructureServerDataSourceBase< AllowedDocumentTypeModel, diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/search/document-type-search.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/search/document-type-search.server.data-source.ts index beb2bc9f0a..3b1e86164c 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/search/document-type-search.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/search/document-type-search.server.data-source.ts @@ -25,7 +25,7 @@ export class UmbDocumentTypeSearchServerDataSource implements UmbSearchDataSourc /** * Get a list of versions for a data - * @return {*} + * @returns {*} * @memberof UmbDocumentTypeSearchServerDataSource */ async search(args: UmbSearchRequestArgs) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/tree/document-type.tree.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/tree/document-type.tree.server.data-source.ts index 04f34144bb..b53ee18b4d 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/tree/document-type.tree.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/tree/document-type.tree.server.data-source.ts @@ -18,7 +18,7 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; * A data source for the Document Type tree that fetches data from the server * @export * @class UmbDocumentTypeTreeServerDataSource - * @extends {UmbTreeServerDataSourceBase} + * @augments {UmbTreeServerDataSourceBase} */ export class UmbDocumentTypeTreeServerDataSource extends UmbTreeServerDataSourceBase< DocumentTypeTreeItemResponseModel, diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/tree/document-type.tree.store.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/tree/document-type.tree.store.ts index 6330ce6dde..ac9ab80cbd 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/tree/document-type.tree.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/tree/document-type.tree.store.ts @@ -5,7 +5,7 @@ import { UmbUniqueTreeStore } from '@umbraco-cms/backoffice/tree'; /** * @export * @class UmbDocumentTypeTreeStore - * @extends {UmbUniqueTreeStore} + * @augments {UmbUniqueTreeStore} * @description - Tree Data Store for Document Types */ export class UmbDocumentTypeTreeStore extends UmbUniqueTreeStore { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/tree/folder/document-type-folder.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/tree/folder/document-type-folder.server.data-source.ts index 03d1fcee78..5783f7b871 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/tree/folder/document-type-folder.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/document-types/tree/folder/document-type-folder.server.data-source.ts @@ -24,7 +24,7 @@ export class UmbDocumentTypeFolderServerDataSource implements UmbFolderDataSourc /** * Fetches a Document Type folder from the server * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbDocumentTypeFolderServerDataSource */ async read(unique: string) { @@ -52,7 +52,7 @@ export class UmbDocumentTypeFolderServerDataSource implements UmbFolderDataSourc /** * Creates a Document Type folder on the server * @param {UmbCreateFolderModel} args - * @return {*} + * @returns {*} * @memberof UmbDocumentTypeFolderServerDataSource */ async create(args: UmbCreateFolderModel) { @@ -82,7 +82,7 @@ export class UmbDocumentTypeFolderServerDataSource implements UmbFolderDataSourc /** * Updates a Document Type folder on the server * @param {UmbUpdateFolderModel} args - * @return {*} + * @returns {*} * @memberof UmbDocumentTypeFolderServerDataSource */ async update(args: UmbUpdateFolderModel) { @@ -107,7 +107,7 @@ export class UmbDocumentTypeFolderServerDataSource implements UmbFolderDataSourc /** * Deletes a Document Type folder on the server * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbDocumentTypeServerDataSource */ async delete(unique: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/audit-log/repository/document-audit-log.repository.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/audit-log/repository/document-audit-log.repository.ts index 47bb272a5e..5a14c7fb8e 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/audit-log/repository/document-audit-log.repository.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/audit-log/repository/document-audit-log.repository.ts @@ -8,7 +8,7 @@ import { UmbRepositoryBase } from '@umbraco-cms/backoffice/repository'; * Repository for the document audit log * @export * @class UmbDocumentAuditLogRepository - * @extends {UmbRepositoryBase} + * @augments {UmbRepositoryBase} */ export class UmbDocumentAuditLogRepository extends UmbRepositoryBase @@ -29,7 +29,7 @@ export class UmbDocumentAuditLogRepository /** * Request the audit log for a document * @param {UmbAuditLogRequestArgs} args - * @return {*} + * @returns {*} * @memberof UmbDocumentAuditLogRepository */ async requestAuditLog(args: UmbAuditLogRequestArgs) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/audit-log/repository/document-audit-log.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/audit-log/repository/document-audit-log.server.data-source.ts index a6e8050020..d0ea9c9e25 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/audit-log/repository/document-audit-log.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/audit-log/repository/document-audit-log.server.data-source.ts @@ -26,7 +26,7 @@ export class UmbDocumentAuditLogServerDataSource implements UmbAuditLogDataSourc /** * Get the audit log for a document * @param {UmbAuditLogRequestArgs} args - * @return {*} + * @returns {*} * @memberof UmbDocumentAuditLogServerDataSource */ async getAuditLog(args: UmbAuditLogRequestArgs) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/collection/views/index.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/collection/views/index.ts index bad7d3c6de..b27700a842 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/collection/views/index.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/collection/views/index.ts @@ -3,6 +3,11 @@ import { fromCamelCase } from '@umbraco-cms/backoffice/utils'; export { UMB_DOCUMENT_GRID_COLLECTION_VIEW_ALIAS, UMB_DOCUMENT_TABLE_COLLECTION_VIEW_ALIAS } from './manifests.js'; +/** + * + * @param item + * @param alias + */ export function getPropertyValueByAlias(item: UmbDocumentCollectionItemModel, alias: string) { switch (alias) { case 'contentTypeAlias': diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/components/input-document/input-document.element.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/components/input-document/input-document.element.ts index df5e20479a..6c07e8834a 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/components/input-document/input-document.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/components/input-document/input-document.element.ts @@ -36,7 +36,7 @@ export class UmbInputDocumentElement extends UmbFormControlMixin = {}) { @@ -74,7 +74,7 @@ export class UmbDocumentServerDataSource implements UmbDetailDataSource { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/item/document-item.store.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/item/document-item.store.ts index af5d7462c2..5244b30d47 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/item/document-item.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/item/document-item.store.ts @@ -6,7 +6,7 @@ import { UmbItemStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbDocumentItemStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for Document items */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/preview/document-preview.repository.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/preview/document-preview.repository.ts index 6b3c1cd87e..ed04e8634c 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/preview/document-preview.repository.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/preview/document-preview.repository.ts @@ -10,7 +10,7 @@ export class UmbDocumentPreviewRepository extends UmbRepositoryBase { /** * Enters preview mode. - * @return {Promise} + * @returns {Promise} * @memberof UmbDocumentPreviewRepository */ async enter(): Promise { @@ -20,7 +20,7 @@ export class UmbDocumentPreviewRepository extends UmbRepositoryBase { /** * Exits preview mode. - * @return {Promise} + * @returns {Promise} * @memberof UmbDocumentPreviewRepository */ async exit(): Promise { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/publishing/document-publishing.repository.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/publishing/document-publishing.repository.ts index f5a744a96c..02e4e5de88 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/publishing/document-publishing.repository.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/publishing/document-publishing.repository.ts @@ -26,7 +26,9 @@ export class UmbDocumentPublishingRepository extends UmbRepositoryBase { * Publish one or more variants of a Document * @param {string} id * @param {Array} variantIds - * @return {*} + * @param unique + * @param variants + * @returns {*} * @memberof UmbDocumentPublishingRepository */ async publish(unique: string, variants: Array) { @@ -48,7 +50,7 @@ export class UmbDocumentPublishingRepository extends UmbRepositoryBase { * Unpublish one or more variants of a Document * @param {string} id * @param {Array} variantIds - * @return {*} + * @returns {*} * @memberof UmbDocumentPublishingRepository */ async unpublish(id: string, variantIds: Array) { @@ -68,6 +70,9 @@ export class UmbDocumentPublishingRepository extends UmbRepositoryBase { /** * Publish variants of a document including its descendants + * @param id + * @param variantIds + * @param includeUnpublishedDescendants * @memberof UmbDocumentPublishingRepository */ async publishWithDescendants(id: string, variantIds: Array, includeUnpublishedDescendants: boolean) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/publishing/document-publishing.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/publishing/document-publishing.server.data-source.ts index af96d59a88..b28416c330 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/publishing/document-publishing.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/publishing/document-publishing.server.data-source.ts @@ -32,7 +32,7 @@ export class UmbDocumentPublishingServerDataSource { * Publish one or more variants of a Document * @param {string} unique * @param {Array} variantIds - * @return {*} + * @returns {*} * @memberof UmbDocumentPublishingServerDataSource */ async publish(unique: string, variants: Array) { @@ -59,7 +59,7 @@ export class UmbDocumentPublishingServerDataSource { * Unpublish one or more variants of a Document * @param {string} unique * @param {Array} variantIds - * @return {*} + * @returns {*} * @memberof UmbDocumentPublishingServerDataSource */ async unpublish(unique: string, variantIds: Array) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/validation/document-validation.repository.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/validation/document-validation.repository.ts index 6e857ba03f..73a246fd1e 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/validation/document-validation.repository.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/validation/document-validation.repository.ts @@ -17,8 +17,8 @@ export class UmbDocumentValidationRepository extends UmbRepositoryBase { /** * Returns a promise with an observable of the detail for the given unique * @param {DetailModelType} model - * @param {string | null} [parentUnique=null] - * @return {*} + * @param {string | null} [parentUnique] + * @returns {*} * @memberof UmbDetailRepositoryBase */ async validateCreate(model: DetailModelType, parentUnique: string | null) { @@ -30,7 +30,7 @@ export class UmbDocumentValidationRepository extends UmbRepositoryBase { /** * Saves the given data * @param {DetailModelType} model - * @return {*} + * @returns {*} * @memberof UmbDetailRepositoryBase */ async validateSave(model: DetailModelType) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/validation/document-validation.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/validation/document-validation.server.data-source.ts index 340ba822ce..2df5e28d58 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/validation/document-validation.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/repository/validation/document-validation.server.data-source.ts @@ -30,7 +30,7 @@ export class UmbDocumentValidationServerDataSource { /** * Validate a new Document on the server * @param {UmbDocumentDetailModel} model - Document Model - * @return {*} + * @returns {*} */ async validateCreate(model: UmbDocumentDetailModel, parentUnique: string | null = null) { if (!model) throw new Error('Document is missing'); @@ -58,7 +58,7 @@ export class UmbDocumentValidationServerDataSource { /** * Validate a existing Document * @param {UmbDocumentDetailModel} model - Document Model - * @return {*} + * @returns {*} */ async validateUpdate(model: UmbDocumentDetailModel) { if (!model.unique) throw new Error('Unique is missing'); diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/search/document-search.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/search/document-search.server.data-source.ts index 824dd544ec..13587af65b 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/search/document-search.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/search/document-search.server.data-source.ts @@ -25,7 +25,7 @@ export class UmbDocumentSearchServerDataSource implements UmbSearchDataSource & { /** * The user must have all of the permissions in this array for the condition to be met. - * * @example * ["Umb.Document.Save", "Umb.Document.Publish"] */ @@ -121,7 +120,6 @@ export type UmbDocumentUserPermissionConditionConfig = /** * The user must have at least one of the permissions in this array for the condition to be met. - * * @example * ["Umb.Document.Save", "Umb.Document.Publish"] */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/user-permissions/utils.ts b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/user-permissions/utils.ts index f49a1d73eb..c9b647678d 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/documents/documents/user-permissions/utils.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/documents/documents/user-permissions/utils.ts @@ -3,6 +3,10 @@ import type { UnknownTypePermissionPresentationModel, } from '@umbraco-cms/backoffice/external/backend-api'; +/** + * + * @param permission + */ export function isDocumentUserPermission( permission: DocumentPermissionPresentationModel | UnknownTypePermissionPresentationModel, ): permission is DocumentPermissionPresentationModel { diff --git a/src/Umbraco.Web.UI.Client/src/packages/language/collection/repository/language-collection.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/language/collection/repository/language-collection.server.data-source.ts index 7b9b341661..c75b922817 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/language/collection/repository/language-collection.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/language/collection/repository/language-collection.server.data-source.ts @@ -27,7 +27,7 @@ export class UmbLanguageCollectionServerDataSource implements UmbCollectionDataS /** * Gets the language collection filtered by the given filter. * @param {UmbLanguageCollectionFilterModel} filter - * @return {*} + * @returns {*} * @memberof UmbLanguageCollectionServerDataSource */ async getCollection(filter: UmbLanguageCollectionFilterModel) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/language/components/input-language/input-language.element.ts b/src/Umbraco.Web.UI.Client/src/packages/language/components/input-language/input-language.element.ts index 7149bde906..7fe689f003 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/language/components/input-language/input-language.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/language/components/input-language/input-language.element.ts @@ -29,7 +29,7 @@ export class UmbInputLanguageElement extends UUIFormControlMixin(UmbLitElement, * This is a minimum amount of selected items in this input. * @type {number} * @attr - * @default 0 + * @default */ @property({ type: Number }) public set min(value: number) { @@ -52,7 +52,7 @@ export class UmbInputLanguageElement extends UUIFormControlMixin(UmbLitElement, * This is a maximum amount of selected items in this input. * @type {number} * @attr - * @default Infinity + * @default */ @property({ type: Number }) public set max(value: number) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/language/repository/detail/language-detail.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/language/repository/detail/language-detail.server.data-source.ts index e40ed9bc28..f9eaa2c3f4 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/language/repository/detail/language-detail.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/language/repository/detail/language-detail.server.data-source.ts @@ -30,7 +30,7 @@ export class UmbLanguageServerDataSource implements UmbDetailDataSource} [preset] - * @return { CreateLanguageRequestModel } + * @returns { CreateLanguageRequestModel } * @memberof UmbLanguageServerDataSource */ async createScaffold(preset: Partial = {}) { @@ -50,7 +50,7 @@ export class UmbLanguageServerDataSource implements UmbDetailDataSource { diff --git a/src/Umbraco.Web.UI.Client/src/packages/language/repository/item/language-item.store.ts b/src/Umbraco.Web.UI.Client/src/packages/language/repository/item/language-item.store.ts index 58b72dd799..84962a982d 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/language/repository/item/language-item.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/language/repository/item/language-item.store.ts @@ -6,7 +6,7 @@ import { UmbItemStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbLanguageItemStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for Language items */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/log-viewer/components/donut-chart/donut-chart.element.ts b/src/Umbraco.Web.UI.Client/src/packages/log-viewer/components/donut-chart/donut-chart.element.ts index 60f521d0d4..b0f06aa766 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/log-viewer/components/donut-chart/donut-chart.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/log-viewer/components/donut-chart/donut-chart.element.ts @@ -28,10 +28,9 @@ interface CircleWithCommands extends Circle { //TODO: maybe move to UI Library /** * This is a donut chart component that can be used to display data in a circular way. - * * @export * @class UmbDonutChartElement - * @extends {LitElement} + * @augments {LitElement} */ @customElement('umb-donut-chart') export class UmbDonutChartElement extends LitElement { @@ -41,7 +40,6 @@ export class UmbDonutChartElement extends LitElement { /** * Circle radius in pixels - * * @memberof UmbDonutChartElement */ @property({ type: Number }) @@ -49,7 +47,6 @@ export class UmbDonutChartElement extends LitElement { /** * The circle thickness in pixels - * * @memberof UmbDonutChartElement */ @property({ type: Number, attribute: 'border-size' }) @@ -57,7 +54,6 @@ export class UmbDonutChartElement extends LitElement { /** * The size of SVG element in pixels - * * @memberof UmbDonutChartElement */ @property({ type: Number, attribute: 'svg-size' }) @@ -65,7 +61,6 @@ export class UmbDonutChartElement extends LitElement { /** * Description of the graph, added for accessibility purposes - * * @memberof UmbDonutChartElement */ @property() @@ -73,7 +68,6 @@ export class UmbDonutChartElement extends LitElement { /** * Hides the box that appears oh hover with the details of the slice - * * @memberof UmbDonutChartElement */ @property({ type: Boolean }) diff --git a/src/Umbraco.Web.UI.Client/src/packages/log-viewer/components/donut-chart/donut-slice.element.ts b/src/Umbraco.Web.UI.Client/src/packages/log-viewer/components/donut-chart/donut-slice.element.ts index 43192ce686..4b4638cc94 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/log-viewer/components/donut-chart/donut-slice.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/log-viewer/components/donut-chart/donut-slice.element.ts @@ -1,38 +1,33 @@ import { LitElement, customElement, property } from '@umbraco-cms/backoffice/external/lit'; /** * This component is used to display a single slice of a donut chart. It only makes sense insice the donut chart - * * @export * @class UmbDonutSliceElement * @fires slice-update - This event is fired when the slice is updated - * @extends {LitElement} + * @augments {LitElement} */ @customElement('umb-donut-slice') export class UmbDonutSliceElement extends LitElement { /** * Number of items that this slice represents - * * @memberof UmbDonutSliceElement */ @property({ type: Number }) amount = 0; /** * Color of the slice. Any valid css color is accepted, custom properties are also supported - * * @memberof UmbDonutSliceElement */ @property() color = 'red'; /** * Name of the slice. This is used to display the name of the slice in the donut chart - * * @memberof UmbDonutSliceElement */ @property() name = ''; /** * Kind of the slice. This is shown on a details box when hovering over the slice - * * @memberof UmbDonutSliceElement */ @property() diff --git a/src/Umbraco.Web.UI.Client/src/packages/log-viewer/repository/sources/log-viewer.server.data.ts b/src/Umbraco.Web.UI.Client/src/packages/log-viewer/repository/sources/log-viewer.server.data.ts index 402a34696a..f7ea4f095a 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/log-viewer/repository/sources/log-viewer.server.data.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/log-viewer/repository/sources/log-viewer.server.data.ts @@ -28,9 +28,8 @@ export class UmbLogSearchesServerDataSource implements LogSearchDataSource { /** * Grabs all the log viewer saved searches from the server - * * @param {{ skip?: number; take?: number }} { skip = 0, take = 100 } - * @return {*} + * @returns {*} * @memberof UmbLogSearchesServerDataSource */ async getAllSavedSearches({ skip = 0, take = 100 }: { skip?: number; take?: number }) { @@ -38,9 +37,8 @@ export class UmbLogSearchesServerDataSource implements LogSearchDataSource { } /** * Get a log viewer saved search by name from the server - * * @param {{ name: string }} { name } - * @return {*} + * @returns {*} * @memberof UmbLogSearchesServerDataSource */ async getSavedSearchByName({ name }: { name: string }) { @@ -49,9 +47,8 @@ export class UmbLogSearchesServerDataSource implements LogSearchDataSource { /** * Post a new log viewer saved search to the server - * * @param {{ requestBody?: SavedLogSearch }} { requestBody } - * @return {*} + * @returns {*} * @memberof UmbLogSearchesServerDataSource */ async postLogViewerSavedSearch({ name, query }: SavedLogSearchResponseModel) { @@ -62,9 +59,8 @@ export class UmbLogSearchesServerDataSource implements LogSearchDataSource { } /** * Remove a log viewer saved search by name from the server - * * @param {{ name: string }} { name } - * @return {*} + * @returns {*} * @memberof UmbLogSearchesServerDataSource */ async deleteSavedSearchByName({ name }: { name: string }) { @@ -73,7 +69,6 @@ export class UmbLogSearchesServerDataSource implements LogSearchDataSource { } /** * A data source for the log messages and levels - * * @export * @class UmbLogMessagesServerDataSource * @implements {LogMessagesDataSource} @@ -92,9 +87,8 @@ export class UmbLogMessagesServerDataSource implements LogMessagesDataSource { /** * Grabs all the loggers from the server - * * @param {{ skip?: number; take?: number }} { skip = 0, take = 100 } - * @return {*} + * @returns {*} * @memberof UmbLogMessagesServerDataSource */ async getLogViewerLevel({ skip = 0, take = 100 }: { skip?: number; take?: number }) { @@ -103,9 +97,8 @@ export class UmbLogMessagesServerDataSource implements LogMessagesDataSource { /** * Grabs all the number of different log messages from the server - * * @param {{ skip?: number; take?: number }} { skip = 0, take = 100 } - * @return {*} + * @returns {*} * @memberof UmbLogMessagesServerDataSource */ async getLogViewerLevelCount({ startDate, endDate }: { startDate?: string; endDate?: string }) { @@ -119,7 +112,6 @@ export class UmbLogMessagesServerDataSource implements LogMessagesDataSource { } /** * Grabs all the log messages from the server - * * @param {{ * skip?: number; * take?: number; @@ -137,7 +129,7 @@ export class UmbLogMessagesServerDataSource implements LogMessagesDataSource { * startDate, * endDate, * } - * @return {*} + * @returns {*} * @memberof UmbLogMessagesServerDataSource */ async getLogViewerLogs({ @@ -172,7 +164,6 @@ export class UmbLogMessagesServerDataSource implements LogMessagesDataSource { } /** * Grabs all the log message templates from the server - * * @param {{ * skip?: number; * take?: number; @@ -184,7 +175,7 @@ export class UmbLogMessagesServerDataSource implements LogMessagesDataSource { * startDate, * endDate, * } - * @return {*} + * @returns {*} * @memberof UmbLogMessagesServerDataSource */ async getLogViewerMessageTemplate({ diff --git a/src/Umbraco.Web.UI.Client/src/packages/log-viewer/workspace/views/overview/components/log-viewer-log-level-overview.element.ts b/src/Umbraco.Web.UI.Client/src/packages/log-viewer/workspace/views/overview/components/log-viewer-log-level-overview.element.ts index 751094c6ed..ee03bf2a66 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/log-viewer/workspace/views/overview/components/log-viewer-log-level-overview.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/log-viewer/workspace/views/overview/components/log-viewer-log-level-overview.element.ts @@ -20,7 +20,6 @@ export class UmbLogViewerLogLevelOverviewElement extends UmbLitElement { private _loggers: LoggerResponseModel[] = []; /** * The name of the logger to get the level for. Defaults to 'Global'. - * * @memberof UmbLogViewerLogLevelOverviewElement */ @property() diff --git a/src/Umbraco.Web.UI.Client/src/packages/media/imaging/imaging.repository.ts b/src/Umbraco.Web.UI.Client/src/packages/media/imaging/imaging.repository.ts index c602078a52..4672f801d9 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/media/imaging/imaging.repository.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/media/imaging/imaging.repository.ts @@ -22,6 +22,7 @@ export class UmbImagingRepository extends UmbRepositoryBase implements UmbApi { /** * Requests the items for the given uniques * @param {Array} uniques + * @param imagingModel * @memberof UmbImagingRepository */ async requestResizedItems( diff --git a/src/Umbraco.Web.UI.Client/src/packages/media/imaging/imaging.store.ts b/src/Umbraco.Web.UI.Client/src/packages/media/imaging/imaging.store.ts index c48a6a2d0d..85af357997 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/media/imaging/imaging.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/media/imaging/imaging.store.ts @@ -14,6 +14,7 @@ export class UmbImagingStore extends UmbContextBase implements UmbApi { /** * Gets the data from the store. + * @param unique */ getData(unique: string) { return this.#data.get(unique); @@ -21,6 +22,8 @@ export class UmbImagingStore extends UmbContextBase implements UmbApi { /** * Gets a specific crop if it exists. + * @param unique + * @param data */ getCrop(unique: string, data?: UmbImagingModel) { return this.#data.get(unique)?.get(this.#generateCropKey(data)); @@ -28,6 +31,9 @@ export class UmbImagingStore extends UmbContextBase implements UmbApi { /** * Adds a new crop to the store. + * @param unique + * @param urlInfo + * @param data */ addCrop(unique: string, urlInfo: string, data?: UmbImagingModel) { if (!this.#data.has(unique)) { @@ -38,6 +44,7 @@ export class UmbImagingStore extends UmbContextBase implements UmbApi { /** * Generates a unique key for the crop based on the width, height and mode. + * @param data */ #generateCropKey(data?: UmbImagingModel) { return data ? `${data.width}x${data.height};${data.mode}` : 'generic'; diff --git a/src/Umbraco.Web.UI.Client/src/packages/media/media-types/components/input-media-type/input-media-type.element.ts b/src/Umbraco.Web.UI.Client/src/packages/media/media-types/components/input-media-type/input-media-type.element.ts index 9b7c64f927..a9c164c06e 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/media/media-types/components/input-media-type/input-media-type.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/media/media-types/components/input-media-type/input-media-type.element.ts @@ -33,7 +33,7 @@ export class UmbInputMediaTypeElement extends UmbFormControlMixin} [preset] - * @return { CreateMediaTypeRequestModel } + * @returns { CreateMediaTypeRequestModel } * @memberof UmbMediaTypeServerDataSource */ async createScaffold(preset: Partial = {}) { @@ -61,7 +61,7 @@ export class UmbMediaTypeServerDataSource implements UmbDetailDataSource { diff --git a/src/Umbraco.Web.UI.Client/src/packages/media/media-types/repository/item/media-type-item.store.ts b/src/Umbraco.Web.UI.Client/src/packages/media/media-types/repository/item/media-type-item.store.ts index 1f24660008..6591caf6a6 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/media/media-types/repository/item/media-type-item.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/media/media-types/repository/item/media-type-item.store.ts @@ -6,7 +6,7 @@ import { UmbItemStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbMediaTypeItemStore - * @extends {UmbItemStoreBase} + * @augments {UmbItemStoreBase} * @description - Data Store for Media Type items */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/media/media-types/repository/structure/media-type-structure.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/media/media-types/repository/structure/media-type-structure.server.data-source.ts index acdfad98f0..fa68ca7471 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/media/media-types/repository/structure/media-type-structure.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/media/media-types/repository/structure/media-type-structure.server.data-source.ts @@ -8,7 +8,7 @@ import { MediaTypeService } from '@umbraco-cms/backoffice/external/backend-api'; * * @export * @class UmbMediaTypeStructureServerDataSource - * @extends {UmbContentTypeStructureServerDataSourceBase} + * @augments {UmbContentTypeStructureServerDataSourceBase} */ export class UmbMediaTypeStructureServerDataSource extends UmbContentTypeStructureServerDataSourceBase< AllowedMediaTypeModel, diff --git a/src/Umbraco.Web.UI.Client/src/packages/media/media-types/search/media-type-search.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/media/media-types/search/media-type-search.server.data-source.ts index b49edd53b6..a9575774fa 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/media/media-types/search/media-type-search.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/media/media-types/search/media-type-search.server.data-source.ts @@ -25,7 +25,7 @@ export class UmbMediaTypeSearchServerDataSource implements UmbSearchDataSource} - * @default undefined + * @type {Array} + * @default */ @property({ type: Array }) set allowedFileExtensions(value: Array) { @@ -124,6 +124,9 @@ export class UmbInputUploadFieldElement extends UmbLitElement { ${this.#renderButtonRemove()} `; + /** + * + */ function getElementTemplate() { switch (extension) { case 'audio': diff --git a/src/Umbraco.Web.UI.Client/src/packages/media/media/dropzone/dropzone-manager.class.ts b/src/Umbraco.Web.UI.Client/src/packages/media/media/dropzone/dropzone-manager.class.ts index ca7593959c..a5d24d6dd2 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/media/media/dropzone/dropzone-manager.class.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/media/media/dropzone/dropzone-manager.class.ts @@ -25,8 +25,8 @@ export interface UmbUploadableExtensionModel { /** * Manages the dropzone and uploads files to the server. - * @method createFilesAsMedia - Upload files to the server and creates the items using corresponding media type. - * @method createFilesAsTemporary - Upload the files as temporary files and returns the data. + * @function createFilesAsMedia - Upload files to the server and creates the items using corresponding media type. + * @function createFilesAsTemporary - Upload the files as temporary files and returns the data. * @observable completed - Emits an array of completed uploads. */ export class UmbDropzoneManager extends UmbControllerBase { diff --git a/src/Umbraco.Web.UI.Client/src/packages/media/media/entity-actions/move-to/repository/media-move.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/media/media/entity-actions/move-to/repository/media-move.server.data-source.ts index 89307edbf9..693ee93c95 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/media/media/entity-actions/move-to/repository/media-move.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/media/media/entity-actions/move-to/repository/media-move.server.data-source.ts @@ -24,7 +24,8 @@ export class UmbMoveMediaServerDataSource implements UmbMoveDataSource { * Move an item for the given id to the target unique * @param {string} unique * @param {(string | null)} targetUnique - * @return {*} + * @param args + * @returns {*} * @memberof UmbMoveMediaServerDataSource */ async moveTo(args: UmbMoveToRequestArgs) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/media/media/recycle-bin/tree/media-recycle-bin-tree.store.ts b/src/Umbraco.Web.UI.Client/src/packages/media/media/recycle-bin/tree/media-recycle-bin-tree.store.ts index 9d44096c60..a907014ea5 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/media/media/recycle-bin/tree/media-recycle-bin-tree.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/media/media/recycle-bin/tree/media-recycle-bin-tree.store.ts @@ -5,7 +5,7 @@ import { UmbUniqueTreeStore } from '@umbraco-cms/backoffice/tree'; /** * @export * @class UmbMediaRecycleBinTreeStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Tree Data Store for Media Recycle Bin Tree Items */ export class UmbMediaRecycleBinTreeStore extends UmbUniqueTreeStore { diff --git a/src/Umbraco.Web.UI.Client/src/packages/media/media/reference/repository/media-reference.server.data.ts b/src/Umbraco.Web.UI.Client/src/packages/media/media/reference/repository/media-reference.server.data.ts index 7def339e28..f0305c98f0 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/media/media/reference/repository/media-reference.server.data.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/media/media/reference/repository/media-reference.server.data.ts @@ -22,7 +22,7 @@ export class UmbMediaReferenceServerDataSource { /** * Fetches the item for the given id from the server * @param {Array} ids - * @return {*} + * @returns {*} * @memberof UmbMediaReferenceServerDataSource */ async getReferencedBy(id: string, skip = 0, take = 20) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/media/media/repository/detail/media-detail.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/media/media/repository/detail/media-detail.server.data-source.ts index 2ff98e2b98..eca15c1739 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/media/media/repository/detail/media-detail.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/media/media/repository/detail/media-detail.server.data-source.ts @@ -28,7 +28,7 @@ export class UmbMediaServerDataSource implements UmbDetailDataSource} [preset] - * @return { UmbMediaDetailModel } + * @returns { UmbMediaDetailModel } * @memberof UmbMediaServerDataSource */ async createScaffold(preset: Partial = {}) { @@ -60,7 +60,7 @@ export class UmbMediaServerDataSource implements UmbDetailDataSource { diff --git a/src/Umbraco.Web.UI.Client/src/packages/media/media/repository/item/media-item.store.ts b/src/Umbraco.Web.UI.Client/src/packages/media/media/repository/item/media-item.store.ts index 0d70f203c1..0ebb35a1c8 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/media/media/repository/item/media-item.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/media/media/repository/item/media-item.store.ts @@ -6,7 +6,7 @@ import { UmbItemStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbMediaItemStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for Media items */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/media/media/repository/url/media-url.store.ts b/src/Umbraco.Web.UI.Client/src/packages/media/media/repository/url/media-url.store.ts index 90cf30ed1a..4e9183adc8 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/media/media/repository/url/media-url.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/media/media/repository/url/media-url.store.ts @@ -6,7 +6,7 @@ import { UmbItemStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbMediaUrlStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for Media urls */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/media/media/search/media-search.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/media/media/search/media-search.server.data-source.ts index 21a2ae1858..f9fd8573b8 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/media/media/search/media-search.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/media/media/search/media-search.server.data-source.ts @@ -25,7 +25,7 @@ export class UmbMediaSearchServerDataSource implements UmbSearchDataSource} + * @augments {UmbDetailRepositoryBase} */ export class UmbMemberGroupDetailRepository extends UmbDetailRepositoryBase { constructor(host: UmbControllerHost) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/members/member-group/repository/detail/member-group-detail.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/members/member-group/repository/detail/member-group-detail.server.data-source.ts index 90196926c9..fd75118830 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/members/member-group/repository/detail/member-group-detail.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/members/member-group/repository/detail/member-group-detail.server.data-source.ts @@ -28,7 +28,7 @@ export class UmbMemberGroupServerDataSource implements UmbDetailDataSource { diff --git a/src/Umbraco.Web.UI.Client/src/packages/members/member-group/repository/item/member-group-item.store.ts b/src/Umbraco.Web.UI.Client/src/packages/members/member-group/repository/item/member-group-item.store.ts index d4b097cc25..aa8eb44236 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/members/member-group/repository/item/member-group-item.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/members/member-group/repository/item/member-group-item.store.ts @@ -6,7 +6,7 @@ import { UmbItemStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbMemberGroupItemStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for Member Group items */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/members/member-type/components/input-member-type/input-member-type.element.ts b/src/Umbraco.Web.UI.Client/src/packages/members/member-type/components/input-member-type/input-member-type.element.ts index d66e61df7e..e54988609a 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/members/member-type/components/input-member-type/input-member-type.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/members/member-type/components/input-member-type/input-member-type.element.ts @@ -13,7 +13,7 @@ export class UmbInputMemberTypeElement extends UmbFormControlMixin} + * @augments {UmbDetailRepositoryBase} */ export class UmbMemberTypeDetailRepository extends UmbDetailRepositoryBase { /** diff --git a/src/Umbraco.Web.UI.Client/src/packages/members/member-type/repository/detail/member-type-detail.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/members/member-type/repository/detail/member-type-detail.server.data-source.ts index 118babc5a9..9e5539a81a 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/members/member-type/repository/detail/member-type-detail.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/members/member-type/repository/detail/member-type-detail.server.data-source.ts @@ -32,7 +32,7 @@ export class UmbMemberTypeServerDataSource implements UmbDetailDataSource} [preset] - * @return { CreateMemberTypeRequestModel } + * @returns { CreateMemberTypeRequestModel } * @memberof UmbMemberTypeServerDataSource */ async createScaffold(preset: Partial = {}) { @@ -61,7 +61,7 @@ export class UmbMemberTypeServerDataSource implements UmbDetailDataSource { diff --git a/src/Umbraco.Web.UI.Client/src/packages/members/member-type/repository/item/member-type-item.store.ts b/src/Umbraco.Web.UI.Client/src/packages/members/member-type/repository/item/member-type-item.store.ts index 440c7fdeae..2b7a8a5f7c 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/members/member-type/repository/item/member-type-item.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/members/member-type/repository/item/member-type-item.store.ts @@ -6,7 +6,7 @@ import { UmbItemStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbMemberTypeItemStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for Member Type items */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/members/member-type/search/member-type-search.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/members/member-type/search/member-type-search.server.data-source.ts index 0fc23e69bb..117b183bb8 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/members/member-type/search/member-type-search.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/members/member-type/search/member-type-search.server.data-source.ts @@ -25,7 +25,7 @@ export class UmbMemberTypeSearchServerDataSource implements UmbSearchDataSource< /** * Get a list of versions for a data - * @return {*} + * @returns {*} * @memberof UmbMemberTypeSearchServerDataSource */ async search(args: UmbSearchRequestArgs) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/members/member-type/tree/member-type-tree.store.ts b/src/Umbraco.Web.UI.Client/src/packages/members/member-type/tree/member-type-tree.store.ts index d197904fdb..7f9b8f5520 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/members/member-type/tree/member-type-tree.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/members/member-type/tree/member-type-tree.store.ts @@ -5,7 +5,7 @@ import { UmbUniqueTreeStore } from '@umbraco-cms/backoffice/tree'; /** * @export * @class UmbMemberTypeTreeStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Tree Data Store for MemberType Items */ export class UmbMemberTypeTreeStore extends UmbUniqueTreeStore { diff --git a/src/Umbraco.Web.UI.Client/src/packages/members/member/collection/repository/member-collection.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/members/member/collection/repository/member-collection.server.data-source.ts index ca64ad7003..b853af60fb 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/members/member/collection/repository/member-collection.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/members/member/collection/repository/member-collection.server.data-source.ts @@ -29,7 +29,7 @@ export class UmbMemberCollectionServerDataSource implements UmbCollectionDataSou /** * Gets the member collection filtered by the given filter. * @param {UmbMemberCollectionFilterModel} filter - * @return {*} + * @returns {*} * @memberof UmbMemberCollectionServerDataSource */ async getCollection(filter: UmbMemberCollectionFilterModel) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/members/member/components/input-member/input-member.element.ts b/src/Umbraco.Web.UI.Client/src/packages/members/member/components/input-member/input-member.element.ts index 20f5188702..65a9d3eb64 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/members/member/components/input-member/input-member.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/members/member/components/input-member/input-member.element.ts @@ -35,7 +35,7 @@ export class UmbInputMemberElement extends UmbFormControlMixin} + * @augments {UmbDetailRepositoryBase} */ export class UmbMemberDetailRepository extends UmbDetailRepositoryBase { /** diff --git a/src/Umbraco.Web.UI.Client/src/packages/members/member/repository/detail/member-detail.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/members/member/repository/detail/member-detail.server.data-source.ts index a3a123d02c..bf624e1932 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/members/member/repository/detail/member-detail.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/members/member/repository/detail/member-detail.server.data-source.ts @@ -28,7 +28,7 @@ export class UmbMemberServerDataSource implements UmbDetailDataSource} [preset] - * @return { CreateMemberRequestModel } + * @returns { CreateMemberRequestModel } * @memberof UmbMemberServerDataSource */ async createScaffold(preset: Partial = {}) { @@ -67,7 +67,7 @@ export class UmbMemberServerDataSource implements UmbDetailDataSource { diff --git a/src/Umbraco.Web.UI.Client/src/packages/members/member/repository/item/member-item.store.ts b/src/Umbraco.Web.UI.Client/src/packages/members/member/repository/item/member-item.store.ts index ae43e1c587..6922152e65 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/members/member/repository/item/member-item.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/members/member/repository/item/member-item.store.ts @@ -6,7 +6,7 @@ import { UmbItemStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbMemberItemStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for Member items */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/members/member/search/member-search.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/members/member/search/member-search.server.data-source.ts index b56ebd9dc6..64acfdc31b 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/members/member/search/member-search.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/members/member/search/member-search.server.data-source.ts @@ -25,7 +25,7 @@ export class UmbMemberSearchServerDataSource implements UmbSearchDataSource} - * @default [] + * @default */ @property({ attribute: false }) set urls(data: Array) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/packages/package/repository/package.repository.ts b/src/Umbraco.Web.UI.Client/src/packages/packages/package/repository/package.repository.ts index 415d70195e..1fff84bae8 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/packages/package/repository/package.repository.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/packages/package/repository/package.repository.ts @@ -96,6 +96,7 @@ export class UmbPackageRepository extends UmbControllerBase implements UmbApi { /** * Request the root items from the Data Source + * @param store * @memberOf UmbPackageRepository */ async requestRootItems(store: UmbPackageStore) { @@ -145,6 +146,7 @@ export class UmbPackageRepository extends UmbControllerBase implements UmbApi { /** * Request the package migrations from the Data Source + * @param store * @memberOf UmbPackageRepository */ async requestPackageMigrations(store: UmbPackageStore) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/packages/package/repository/package.store.ts b/src/Umbraco.Web.UI.Client/src/packages/packages/package/repository/package.store.ts index 9baef843ed..d2de1af91b 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/packages/package/repository/package.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/packages/package/repository/package.store.ts @@ -15,7 +15,7 @@ export const UMB_PACKAGE_STORE_TOKEN = new UmbContextToken('Umb /** * Store for Packages * @export - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} */ export class UmbPackageStore extends UmbStoreBase { #configuration = new UmbObjectState({ marketplaceUrl: '' }); @@ -57,6 +57,7 @@ export class UmbPackageStore extends UmbStoreBase { /** * Append items to the store + * @param packages */ override appendItems(packages: Array) { this.#packages.next(packages); diff --git a/src/Umbraco.Web.UI.Client/src/packages/property-editors/content-picker/dynamic-root/repository/dynamic-root.repository.ts b/src/Umbraco.Web.UI.Client/src/packages/property-editors/content-picker/dynamic-root/repository/dynamic-root.repository.ts index c6a5c22c7d..6f2e6d3fd5 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/property-editors/content-picker/dynamic-root/repository/dynamic-root.repository.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/property-editors/content-picker/dynamic-root/repository/dynamic-root.repository.ts @@ -10,7 +10,7 @@ const GUID_EMPTY: string = '00000000-0000-0000-0000-000000000000'; * UmbContentPickerDynamicRootRepository * @export * @class UmbContentPickerDynamicRootRepository - * @extends {UmbControllerBase} + * @augments {UmbControllerBase} */ export class UmbContentPickerDynamicRootRepository extends UmbControllerBase { #dataSource: UmbContentPickerDynamicRootServerDataSource; @@ -26,7 +26,7 @@ export class UmbContentPickerDynamicRootRepository extends UmbControllerBase { * @param {UmbContentPickerDynamicRoot} query * @param {string} entityUnique * @param {string} [parentUnique] - * @return {*} + * @returns {*} * @memberof UmbContentPickerDynamicRootRepository */ async requestRoot(query: UmbContentPickerDynamicRoot, entityUnique: string, parentUnique?: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/property-editors/content-picker/dynamic-root/repository/dynamic-root.server.data.ts b/src/Umbraco.Web.UI.Client/src/packages/property-editors/content-picker/dynamic-root/repository/dynamic-root.server.data.ts index 2e19b051e8..b931f03699 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/property-editors/content-picker/dynamic-root/repository/dynamic-root.server.data.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/property-editors/content-picker/dynamic-root/repository/dynamic-root.server.data.ts @@ -18,7 +18,7 @@ export class UmbContentPickerDynamicRootServerDataSource { /** * Get dynamic root * @param {DynamicRootRequestModel} args - * @return {*} {(Promise)} + * @returns {*} {(Promise)} * @memberof UmbContentPickerDynamicRootServerDataSource */ async getRoot(args: DynamicRootRequestModel): Promise { diff --git a/src/Umbraco.Web.UI.Client/src/packages/property-editors/date-picker/property-editor-ui-date-picker.element.ts b/src/Umbraco.Web.UI.Client/src/packages/property-editors/date-picker/property-editor-ui-date-picker.element.ts index db9afdce7d..a26276f082 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/property-editors/date-picker/property-editor-ui-date-picker.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/property-editors/date-picker/property-editor-ui-date-picker.element.ts @@ -22,7 +22,6 @@ import type { UmbPropertyEditorUiElement } from '@umbraco-cms/backoffice/extensi * data editor with one exception: the "T" character in "datetime-local". To be backwards compatible, we are * replacing the T character with a whitespace, which also happens to work just fine * with the "datetime-local" type. - * * @element umb-property-editor-ui-date-picker */ @customElement('umb-property-editor-ui-date-picker') @@ -97,6 +96,7 @@ export class UmbPropertyEditorUIDatePickerElement extends UmbLitElement implemen /** * Formats the value depending on the input type. + * @param value */ #formatValue(value: string) { this._inputValue = undefined; diff --git a/src/Umbraco.Web.UI.Client/src/packages/relations/relation-types/collection/repository/relation-type-collection.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/relations/relation-types/collection/repository/relation-type-collection.server.data-source.ts index 0759a38fbb..cfb59dd288 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/relations/relation-types/collection/repository/relation-type-collection.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/relations/relation-types/collection/repository/relation-type-collection.server.data-source.ts @@ -27,7 +27,7 @@ export class UmbRelationTypeCollectionServerDataSource implements UmbCollectionD /** * Gets the relation type collection filtered by the given filter. * @param {UmbRelationTypeCollectionFilterModel} filter - * @return {*} + * @returns {*} * @memberof UmbRelationTypeCollectionServerDataSource */ async getCollection(filter: UmbRelationTypeCollectionFilterModel) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/relations/relation-types/repository/detail/relation-type-detail.repository.ts b/src/Umbraco.Web.UI.Client/src/packages/relations/relation-types/repository/detail/relation-type-detail.repository.ts index 829cbf00ec..9624de75be 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/relations/relation-types/repository/detail/relation-type-detail.repository.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/relations/relation-types/repository/detail/relation-type-detail.repository.ts @@ -28,7 +28,7 @@ export class UmbRelationTypeDetailRepository /** * Requests the detail for the given unique * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbDetailRepositoryBase */ async requestByUnique(unique: string) { @@ -47,7 +47,7 @@ export class UmbRelationTypeDetailRepository /** * Returns a promise with an observable of the detail for the given unique * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbDetailRepositoryBase */ async byUnique(unique: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/relations/relation-types/repository/detail/relation-type-detail.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/relations/relation-types/repository/detail/relation-type-detail.server.data-source.ts index a196655e7f..99cbea90d3 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/relations/relation-types/repository/detail/relation-type-detail.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/relations/relation-types/repository/detail/relation-type-detail.server.data-source.ts @@ -26,7 +26,7 @@ export class UmbRelationTypeDetailServerDataSource implements UmbReadDetailDataS /** * Fetches a Relation Type with the given id from the server * @param {string} unique - * @return {*} + * @returns {*} * @memberof UmbRelationTypeServerDataSource */ async read(unique: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/relations/relation-types/repository/detail/relation-type-detail.store.ts b/src/Umbraco.Web.UI.Client/src/packages/relations/relation-types/repository/detail/relation-type-detail.store.ts index 87e9eed4b0..c88fed4f10 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/relations/relation-types/repository/detail/relation-type-detail.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/relations/relation-types/repository/detail/relation-type-detail.store.ts @@ -6,7 +6,7 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; /** * @export * @class UmbRelationTypeDetailStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for RelationType Details */ export class UmbRelationTypeDetailStore extends UmbDetailStoreBase { diff --git a/src/Umbraco.Web.UI.Client/src/packages/relations/relations/collection/repository/relation-collection.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/relations/relations/collection/repository/relation-collection.server.data-source.ts index d14b56abfc..5f43559db5 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/relations/relations/collection/repository/relation-collection.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/relations/relations/collection/repository/relation-collection.server.data-source.ts @@ -27,7 +27,7 @@ export class UmbRelationCollectionServerDataSource implements UmbCollectionDataS /** * Gets the relation collection filtered by the given filter. * @param {UmbRelationCollectionFilterModel} filter - * @return {*} + * @returns {*} * @memberof UmbRelationCollectionServerDataSource */ async getCollection(filter: UmbRelationCollectionFilterModel) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/relations/relations/utils.ts b/src/Umbraco.Web.UI.Client/src/packages/relations/relations/utils.ts index b27936d26a..6d1fab486c 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/relations/relations/utils.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/relations/relations/utils.ts @@ -5,14 +5,26 @@ import type { MediaReferenceResponseModel, } from '@umbraco-cms/backoffice/external/backend-api'; +/** + * + * @param item + */ export function isDocumentReference(item: UmbReferenceModel): item is DocumentReferenceResponseModel { return typeof (item as DocumentReferenceResponseModel).documentType !== 'undefined'; } +/** + * + * @param item + */ export function isMediaReference(item: UmbReferenceModel): item is MediaReferenceResponseModel { return typeof (item as MediaReferenceResponseModel).mediaType !== 'undefined'; } +/** + * + * @param item + */ export function isDefaultReference(item: UmbReferenceModel): item is DefaultReferenceResponseModel { return typeof (item as DefaultReferenceResponseModel).type !== 'undefined'; } diff --git a/src/Umbraco.Web.UI.Client/src/packages/static-file/components/input-static-file/input-static-file.element.ts b/src/Umbraco.Web.UI.Client/src/packages/static-file/components/input-static-file/input-static-file.element.ts index 58aedf9137..cc3b589f18 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/static-file/components/input-static-file/input-static-file.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/static-file/components/input-static-file/input-static-file.element.ts @@ -16,7 +16,7 @@ export class UmbInputStaticFileElement extends UmbFormControlMixin('UmbTagSto /** * @export * @class UmbTagStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for Template Details */ export class UmbTagStore extends UmbStoreBase { @@ -26,6 +26,7 @@ export class UmbTagStore extends UmbStoreBase { /** * Append a tag to the store * @param {TagResponseModel} TAG + * @param tag * @memberof UmbTagStore */ override append(tag: TagResponseModel) { @@ -35,6 +36,7 @@ export class UmbTagStore extends UmbStoreBase { /** * Append a tag to the store * @param {id} TagResponseModel id. + * @param id * @memberof UmbTagStore */ byId(id: TagResponseModel['id']) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/entity-actions/rename/rename-partial-view.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/entity-actions/rename/rename-partial-view.server.data-source.ts index 5f178979f4..92965afabb 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/entity-actions/rename/rename-partial-view.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/entity-actions/rename/rename-partial-view.server.data-source.ts @@ -22,7 +22,7 @@ export class UmbRenamePartialViewServerDataSource { * Rename Partial View * @param {string} unique * @param {string} name - * @return {*} + * @returns {*} * @memberof UmbRenamePartialViewServerDataSource */ async rename(unique: string, name: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/repository/item/partial-view-item.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/repository/item/partial-view-item.server.data-source.ts index 96b2840354..79896b8c32 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/repository/item/partial-view-item.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/repository/item/partial-view-item.server.data-source.ts @@ -28,7 +28,7 @@ export class UmbPartialViewItemServerDataSource implements UmbItemDataSource} uniques - * @return {*} + * @returns {*} * @memberof UmbPartialViewItemServerDataSource */ async getItems(uniques: Array) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/repository/item/partial-view-item.store.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/repository/item/partial-view-item.store.ts index 0cfab9c4f9..e39cada649 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/repository/item/partial-view-item.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/repository/item/partial-view-item.store.ts @@ -6,7 +6,7 @@ import { UmbItemStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbPartialViewItemStore - * @extends {UmbItemStoreBase} + * @augments {UmbItemStoreBase} * @description - Data Store for PartialView items */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/repository/partial-view-detail.store.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/repository/partial-view-detail.store.ts index b3865f8e9e..bbebd05012 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/repository/partial-view-detail.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/repository/partial-view-detail.store.ts @@ -6,7 +6,7 @@ import { UmbDetailStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbPartialViewDetailStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for Partial View detail */ export class UmbPartialViewDetailStore extends UmbDetailStoreBase { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/tree/folder/partial-view-folder.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/tree/folder/partial-view-folder.server.data-source.ts index bdb3b96bcb..b66cedfb70 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/tree/folder/partial-view-folder.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/tree/folder/partial-view-folder.server.data-source.ts @@ -27,7 +27,7 @@ export class UmbPartialViewFolderServerDataSource implements UmbFolderDataSource /** * Fetches a Partial View folder from the server * @param {string} unique - * @return {UmbDataSourceResponse} + * @returns {UmbDataSourceResponse} * @memberof UmbPartialViewFolderServerDataSource */ async read(unique: string) { @@ -59,7 +59,7 @@ export class UmbPartialViewFolderServerDataSource implements UmbFolderDataSource /** * Creates a Partial View folder on the server * @param {UmbCreateFolderModel} args - * @return {UmbDataSourceResponse} + * @returns {UmbDataSourceResponse} * @memberof UmbPartialViewFolderServerDataSource */ async create(args: UmbCreateFolderModel) { @@ -92,7 +92,7 @@ export class UmbPartialViewFolderServerDataSource implements UmbFolderDataSource /** * Deletes a Partial View folder on the server * @param {string} unique - * @return {UmbDataSourceErrorResponse} + * @returns {UmbDataSourceErrorResponse} * @memberof UmbPartialViewServerDataSource */ async delete(unique: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/tree/partial-view-tree.store.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/tree/partial-view-tree.store.ts index d1534b877b..3f6321b1cc 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/tree/partial-view-tree.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/partial-views/tree/partial-view-tree.store.ts @@ -5,7 +5,7 @@ import { UmbUniqueTreeStore } from '@umbraco-cms/backoffice/tree'; /** * @export * @class UmbPartialViewTreeStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Tree Data Store for PartialView */ export class UmbPartialViewTreeStore extends UmbUniqueTreeStore { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/entity-actions/rename/rename-script.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/entity-actions/rename/rename-script.server.data-source.ts index 9361984091..6aae06b1d4 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/entity-actions/rename/rename-script.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/entity-actions/rename/rename-script.server.data-source.ts @@ -22,7 +22,7 @@ export class UmbRenameScriptServerDataSource { * Rename Script * @param {string} unique * @param {string} name - * @return {*} + * @returns {*} * @memberof UmbRenameScriptServerDataSource */ async rename(unique: string, name: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/repository/item/script-item.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/repository/item/script-item.server.data-source.ts index 11b9ccb95d..41eee6373a 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/repository/item/script-item.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/repository/item/script-item.server.data-source.ts @@ -28,7 +28,7 @@ export class UmbScriptItemServerDataSource implements UmbItemDataSource} uniques - * @return {*} + * @returns {*} * @memberof UmbScriptItemServerDataSource */ async getItems(uniques: Array) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/repository/item/script-item.store.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/repository/item/script-item.store.ts index 05b362b10c..875acbde1a 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/repository/item/script-item.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/repository/item/script-item.store.ts @@ -6,7 +6,7 @@ import { UmbItemStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbScriptItemStore - * @extends {UmbItemStoreBase} + * @augments {UmbItemStoreBase} * @description - Data Store for Script items */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/repository/script-detail.store.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/repository/script-detail.store.ts index 3a82a7c266..2f43bfe5ee 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/repository/script-detail.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/repository/script-detail.store.ts @@ -6,7 +6,7 @@ import { UmbDetailStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbScriptDetailStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for scripts */ export class UmbScriptDetailStore extends UmbDetailStoreBase { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/tree/folder/script-folder.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/tree/folder/script-folder.server.data-source.ts index 9ce702765a..e1333596f7 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/tree/folder/script-folder.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/tree/folder/script-folder.server.data-source.ts @@ -27,7 +27,7 @@ export class UmbScriptFolderServerDataSource implements UmbFolderDataSource { /** * Fetches a Script folder from the server * @param {string} unique - * @return {UmbDataSourceResponse} + * @returns {UmbDataSourceResponse} * @memberof UmbScriptFolderServerDataSource */ async read(unique: string) { @@ -59,7 +59,7 @@ export class UmbScriptFolderServerDataSource implements UmbFolderDataSource { /** * Creates a Script folder on the server * @param {UmbCreateFolderModel} args - * @return {UmbDataSourceResponse} + * @returns {UmbDataSourceResponse} * @memberof UmbScriptFolderServerDataSource */ async create(args: UmbCreateFolderModel) { @@ -92,7 +92,7 @@ export class UmbScriptFolderServerDataSource implements UmbFolderDataSource { /** * Deletes a Script folder on the server * @param {string} unique - * @return {UmbDataSourceErrorResponse} + * @returns {UmbDataSourceErrorResponse} * @memberof UmbScriptServerDataSource */ async delete(unique: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/tree/script-tree.store.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/tree/script-tree.store.ts index 476ae99859..103931a05c 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/tree/script-tree.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/scripts/tree/script-tree.store.ts @@ -5,7 +5,7 @@ import { UmbUniqueTreeStore } from '@umbraco-cms/backoffice/tree'; /** * @export * @class UmbScriptTreeStore - * @extends {UmbUniqueTreeStore} + * @augments {UmbUniqueTreeStore} * @description - Tree Data Store for Scripts */ export class UmbScriptTreeStore extends UmbUniqueTreeStore { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/entity-actions/rename/rename-stylesheet.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/entity-actions/rename/rename-stylesheet.server.data-source.ts index d3a8cd1698..64a68d35cd 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/entity-actions/rename/rename-stylesheet.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/entity-actions/rename/rename-stylesheet.server.data-source.ts @@ -22,7 +22,7 @@ export class UmbRenameStylesheetServerDataSource { * Rename Stylesheet * @param {string} unique * @param {string} name - * @return {*} + * @returns {*} * @memberof UmbRenameStylesheetServerDataSource */ async rename(unique: string, name: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/global-components/stylesheet-input/stylesheet-input.element.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/global-components/stylesheet-input/stylesheet-input.element.ts index 172d6ccfe3..96f3e710a3 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/global-components/stylesheet-input/stylesheet-input.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/global-components/stylesheet-input/stylesheet-input.element.ts @@ -11,7 +11,7 @@ export class UmbStylesheetInputElement extends UUIFormControlMixin(UmbLitElement * This is a minimum amount of selected items in this input. * @type {number} * @attr - * @default 0 + * @default */ @property({ type: Number }) public set min(value: number) { @@ -34,7 +34,7 @@ export class UmbStylesheetInputElement extends UUIFormControlMixin(UmbLitElement * This is a maximum amount of selected items in this input. * @type {number} * @attr - * @default Infinity + * @default */ @property({ type: Number }) public set max(value: number) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/global-components/stylesheet-rule-ref/stylesheet-rule-ref.element.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/global-components/stylesheet-rule-ref/stylesheet-rule-ref.element.ts index 7557e42e50..badb9382b6 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/global-components/stylesheet-rule-ref/stylesheet-rule-ref.element.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/global-components/stylesheet-rule-ref/stylesheet-rule-ref.element.ts @@ -4,7 +4,7 @@ import { customElement } from '@umbraco-cms/backoffice/external/lit'; /** * @element umb-stylesheet-rule-ref * @description - Component for displaying a reference to a stylesheet rule - * @extends UUIRefNodeElement + * @augments UUIRefNodeElement */ @customElement('umb-stylesheet-rule-ref') export class UmbStylesheetRuleRefElement extends UUIRefNodeElement { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/repository/item/stylesheet-item.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/repository/item/stylesheet-item.server.data-source.ts index ebdb50678e..a939816c45 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/repository/item/stylesheet-item.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/repository/item/stylesheet-item.server.data-source.ts @@ -28,7 +28,7 @@ export class UmbStylesheetItemServerDataSource implements UmbItemDataSource} uniques - * @return {*} + * @returns {*} * @memberof UmbStylesheetItemServerDataSource */ async getItems(uniques: Array) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/repository/item/stylesheet-item.store.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/repository/item/stylesheet-item.store.ts index 5c177c2c0a..f04e1a6aae 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/repository/item/stylesheet-item.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/repository/item/stylesheet-item.store.ts @@ -6,7 +6,7 @@ import { UmbItemStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbStylesheetItemStore - * @extends {UmbItemStoreBase} + * @augments {UmbItemStoreBase} * @description - Data Store for Stylesheet items */ diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/repository/stylesheet-detail.store.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/repository/stylesheet-detail.store.ts index e6e8f115c2..014208d49f 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/repository/stylesheet-detail.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/repository/stylesheet-detail.store.ts @@ -6,7 +6,7 @@ import { UmbDetailStoreBase } from '@umbraco-cms/backoffice/store'; /** * @export * @class UmbStylesheetDetailStore - * @extends {UmbStoreBase} + * @augments {UmbStoreBase} * @description - Data Store for stylesheet detail */ export class UmbStylesheetDetailStore extends UmbDetailStoreBase { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/tree/folder/stylesheet-folder.server.data-source.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/tree/folder/stylesheet-folder.server.data-source.ts index 55477245fd..8521756f2e 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/tree/folder/stylesheet-folder.server.data-source.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/tree/folder/stylesheet-folder.server.data-source.ts @@ -27,7 +27,7 @@ export class UmbStylesheetFolderServerDataSource implements UmbFolderDataSource /** * Fetches a Stylesheet folder from the server * @param {string} unique - * @return {UmbDataSourceResponse} + * @returns {UmbDataSourceResponse} * @memberof UmbStylesheetFolderServerDataSource */ async read(unique: string) { @@ -59,7 +59,7 @@ export class UmbStylesheetFolderServerDataSource implements UmbFolderDataSource /** * Creates a Stylesheet folder on the server * @param {UmbCreateFolderModel} args - * @return {UmbDataSourceResponse} + * @returns {UmbDataSourceResponse} * @memberof UmbStylesheetFolderServerDataSource */ async create(args: UmbCreateFolderModel) { @@ -92,7 +92,7 @@ export class UmbStylesheetFolderServerDataSource implements UmbFolderDataSource /** * Deletes a Stylesheet folder on the server * @param {string} unique - * @return {UmbDataSourceErrorResponse} + * @returns {UmbDataSourceErrorResponse} * @memberof UmbStylesheetServerDataSource */ async delete(unique: string) { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/tree/stylesheet-tree.store.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/tree/stylesheet-tree.store.ts index 7c362717b9..38fe2bd58f 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/tree/stylesheet-tree.store.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/tree/stylesheet-tree.store.ts @@ -5,7 +5,7 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; /** * @export * @class UmbStylesheetTreeStore - * @extends {UmbUniqueTreeStore} + * @augments {UmbUniqueTreeStore} * @description - Tree Data Store for Stylesheets */ export class UmbStylesheetTreeStore extends UmbUniqueTreeStore { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/utils/stylesheet-rule-manager.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/utils/stylesheet-rule-manager.ts index fde71d19d2..31376e29d3 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/utils/stylesheet-rule-manager.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/stylesheets/utils/stylesheet-rule-manager.ts @@ -6,7 +6,7 @@ export class UmbStylesheetRuleManager { /** * Extracts umbraco rules from a stylesheet content * @param {string} stylesheetContent - * @return {*} + * @returns {*} * @memberof UmbStylesheetRuleManager */ extractRules(stylesheetContent: string): Array { @@ -26,7 +26,7 @@ export class UmbStylesheetRuleManager { * Inserts umbraco rules into stylesheet content * @param {string} stylesheetContent * @param {UmbStylesheetRule[]} rules - * @return {*} + * @returns {*} * @memberof UmbStylesheetRuleManager */ insertRules(stylesheetContent: string, rules: Array): string { diff --git a/src/Umbraco.Web.UI.Client/src/packages/templating/templates/modals/query-builder/utils.ts b/src/Umbraco.Web.UI.Client/src/packages/templating/templates/modals/query-builder/utils.ts index 37c082a0f3..3cc9dbd0cb 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/templating/templates/modals/query-builder/utils.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/templating/templates/modals/query-builder/utils.ts @@ -13,6 +13,11 @@ type TemplateOperatorModel = TemplateQueryOperatorModel & { localizeKey?: string type TemplatePropertyModel = TemplateQueryPropertyPresentationModel & { localizeKey?: string }; type TemplateSortModel = TemplateQueryExecuteSortModel & { localizeKey?: string }; +/** + * + * @param operators + * @param currentPropertyType + */ export function localizeOperators( operators: Array, currentPropertyType: TemplateQueryPropertyTypeModel | null, @@ -29,6 +34,10 @@ export function localizeOperators( } } +/** + * + * @param propertyTypes + */ export function localizePropertyType(propertyTypes?: Array) { if (!propertyTypes) return; return propertyTypes.map((propertyType): TemplatePropertyModel => { @@ -47,6 +56,10 @@ export function localizePropertyType(propertyTypes?: Array): Array { return operators.map((operator): TemplateOperatorModel => { switch (operator.operator) { @@ -78,6 +95,10 @@ function isString(operators: Array): Array): Array { return operators.map((operator): TemplateOperatorModel => { switch (operator.operator) { @@ -99,6 +120,10 @@ function isInteger(operators: Array): Array