From 8e6cf62625f30af501e238ea55c5344dd0e875b4 Mon Sep 17 00:00:00 2001 From: Mads Rasmussen Date: Tue, 21 Mar 2023 14:59:46 +0100 Subject: [PATCH] Cleanup: move dictionary interface (#612) * use import aliases when importing when the libs folder * move data source response interface to the repository module * remove unused interfaces * move dictionary interface into dictionary silo * delete unused interface --- src/Umbraco.Web.UI.Client/libs/models/index.ts | 14 -------------- .../src/backoffice/translation/dictionary/index.ts | 6 ++++++ .../dictionary/repository/dictionary.repository.ts | 10 +++++----- .../dictionary/repository/dictionary.store.ts | 2 +- .../sources/dictionary.detail.server.data.ts | 4 ++-- .../dictionary.details.server.data.interface.ts | 2 +- .../workspace/dictionary-workspace.context.ts | 6 +++--- .../src/core/mocks/data/dictionary.data.ts | 4 ++-- .../src/core/mocks/domains/dictionary.handlers.ts | 4 ++-- 9 files changed, 22 insertions(+), 30 deletions(-) create mode 100644 src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/index.ts diff --git a/src/Umbraco.Web.UI.Client/libs/models/index.ts b/src/Umbraco.Web.UI.Client/libs/models/index.ts index 49ab203967..37795a300c 100644 --- a/src/Umbraco.Web.UI.Client/libs/models/index.ts +++ b/src/Umbraco.Web.UI.Client/libs/models/index.ts @@ -1,6 +1,5 @@ import type { ContentTreeItemResponseModel, - DictionaryItemTranslationModel, EntityTreeItemResponseModel, FolderTreeItemResponseModel, PackageManifestResponseModel, @@ -23,13 +22,6 @@ export interface Entity { parentKey: string | null; } -export interface ContentDetails extends ContentTreeItemResponseModel { - isTrashed: boolean; // TODO: remove only temp part of refactor - properties: Array; - //data: Array; - //layout?: any; // TODO: define layout type - make it non-optional -} - export interface UserEntity extends Entity { type: 'user'; } @@ -108,12 +100,6 @@ export interface MemberDetails extends EntityTreeItemResponseModel { key: string; // TODO: Remove this when the backend is fixed } -// Dictionary -export interface DictionaryDetails extends EntityTreeItemResponseModel { - key: string; // TODO: Remove this when the backend is fixed - translations: DictionaryItemTranslationModel[]; -} - // Document Blueprint export interface DocumentBlueprintDetails { key: string; diff --git a/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/index.ts b/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/index.ts new file mode 100644 index 0000000000..8caa4f12a7 --- /dev/null +++ b/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/index.ts @@ -0,0 +1,6 @@ +import { DictionaryItemTranslationModel, EntityTreeItemResponseModel } from '@umbraco-cms/backoffice/backend-api'; + +export interface DictionaryDetails extends EntityTreeItemResponseModel { + key: string; // TODO: Remove this when the backend is fixed + translations: DictionaryItemTranslationModel[]; +} diff --git a/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/repository/dictionary.repository.ts b/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/repository/dictionary.repository.ts index 709c8f8473..a57b2c645f 100644 --- a/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/repository/dictionary.repository.ts +++ b/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/repository/dictionary.repository.ts @@ -1,13 +1,13 @@ -import { DictionaryTreeServerDataSource } from './sources/dictionary.tree.server.data'; -import { UmbDictionaryTreeStore, UMB_DICTIONARY_TREE_STORE_CONTEXT_TOKEN } from './dictionary.tree.store'; -import { UmbDictionaryDetailServerDataSource } from './sources/dictionary.detail.server.data'; -import { UmbDictionaryStore, UMB_DICTIONARY_STORE_CONTEXT_TOKEN } from './dictionary.store'; import { UmbControllerHostInterface } from '@umbraco-cms/backoffice/controller'; import { UmbContextConsumerController } from '@umbraco-cms/backoffice/context-api'; import { RepositoryTreeDataSource, UmbDetailRepository, UmbTreeRepository } from '@umbraco-cms/backoffice/repository'; import { ProblemDetailsModel } from '@umbraco-cms/backoffice/backend-api'; import { UmbNotificationContext, UMB_NOTIFICATION_CONTEXT_TOKEN } from '@umbraco-cms/backoffice/notification'; -import type { DictionaryDetails } from '@umbraco-cms/backoffice/models'; +import type { DictionaryDetails } from '../'; +import { UmbDictionaryStore, UMB_DICTIONARY_STORE_CONTEXT_TOKEN } from './dictionary.store'; +import { UmbDictionaryDetailServerDataSource } from './sources/dictionary.detail.server.data'; +import { UmbDictionaryTreeStore, UMB_DICTIONARY_TREE_STORE_CONTEXT_TOKEN } from './dictionary.tree.store'; +import { DictionaryTreeServerDataSource } from './sources/dictionary.tree.server.data'; export class UmbDictionaryRepository implements UmbTreeRepository, UmbDetailRepository { #init!: Promise; diff --git a/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/repository/dictionary.store.ts b/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/repository/dictionary.store.ts index 0efd26c759..f549e112b4 100644 --- a/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/repository/dictionary.store.ts +++ b/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/repository/dictionary.store.ts @@ -2,7 +2,7 @@ import { UmbContextToken } from '@umbraco-cms/backoffice/context-api'; import { UmbStoreBase } from '@umbraco-cms/backoffice/store'; import { UmbControllerHostInterface } from '@umbraco-cms/backoffice/controller'; import { ArrayState } from '@umbraco-cms/backoffice/observable-api'; -import type { DictionaryDetails } from '@umbraco-cms/backoffice/models'; +import type { DictionaryDetails } from '../'; /** * @export diff --git a/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/repository/sources/dictionary.detail.server.data.ts b/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/repository/sources/dictionary.detail.server.data.ts index c31bb8f13a..1fb529a992 100644 --- a/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/repository/sources/dictionary.detail.server.data.ts +++ b/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/repository/sources/dictionary.detail.server.data.ts @@ -1,4 +1,3 @@ -import { DictionaryDetailDataSource } from './dictionary.details.server.data.interface'; import { UmbControllerHostInterface } from '@umbraco-cms/backoffice/controller'; import { tryExecuteAndNotify } from '@umbraco-cms/backoffice/resources'; import { @@ -7,7 +6,8 @@ import { LanguageResource, ProblemDetailsModel, } from '@umbraco-cms/backoffice/backend-api'; -import type { DictionaryDetails } from '@umbraco-cms/backoffice/models'; +import type { DictionaryDetails } from '../../'; +import { DictionaryDetailDataSource } from './dictionary.details.server.data.interface'; /** * @description - A data source for the Dictionary detail that fetches data from the server diff --git a/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/repository/sources/dictionary.details.server.data.interface.ts b/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/repository/sources/dictionary.details.server.data.interface.ts index 0cd4ff682a..af64c6f596 100644 --- a/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/repository/sources/dictionary.details.server.data.interface.ts +++ b/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/repository/sources/dictionary.details.server.data.interface.ts @@ -4,8 +4,8 @@ import { PagedDictionaryOverviewResponseModel, PagedLanguageResponseModel, } from '@umbraco-cms/backoffice/backend-api'; -import type { DictionaryDetails } from '@umbraco-cms/backoffice/models'; import type { DataSourceResponse } from '@umbraco-cms/backoffice/repository'; +import type { DictionaryDetails } from '../../'; export interface DictionaryDetailDataSource { createScaffold(parentKey: string): Promise>; diff --git a/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/workspace/dictionary-workspace.context.ts b/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/workspace/dictionary-workspace.context.ts index 49e41fd0b1..fceb0e11ba 100644 --- a/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/workspace/dictionary-workspace.context.ts +++ b/src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/workspace/dictionary-workspace.context.ts @@ -1,9 +1,9 @@ +import { ObjectState } from '@umbraco-cms/backoffice/observable-api'; +import { UmbControllerHostInterface } from '@umbraco-cms/backoffice/controller'; import { UmbDictionaryRepository } from '../repository/dictionary.repository'; import { UmbWorkspaceContext } from '../../../../backoffice/shared/components/workspace/workspace-context/workspace-context'; import { UmbEntityWorkspaceContextInterface } from '../../../../backoffice/shared/components/workspace/workspace-context/workspace-entity-context.interface'; -import { UmbControllerHostInterface } from '@umbraco-cms/backoffice/controller'; -import { ObjectState } from '@umbraco-cms/backoffice/observable-api'; -import type { DictionaryDetails } from '@umbraco-cms/backoffice/models'; +import type { DictionaryDetails } from '../'; type EntityType = DictionaryDetails; diff --git a/src/Umbraco.Web.UI.Client/src/core/mocks/data/dictionary.data.ts b/src/Umbraco.Web.UI.Client/src/core/mocks/data/dictionary.data.ts index fcd6635acd..c3b27857dd 100644 --- a/src/Umbraco.Web.UI.Client/src/core/mocks/data/dictionary.data.ts +++ b/src/Umbraco.Web.UI.Client/src/core/mocks/data/dictionary.data.ts @@ -1,7 +1,7 @@ +import type { EntityTreeItemResponseModel } from '@umbraco-cms/backoffice/backend-api'; +import type { DictionaryDetails } from '../../../backoffice/translation/dictionary'; import { UmbEntityData } from './entity.data'; import { createEntityTreeItem } from './utils'; -import type { EntityTreeItemResponseModel } from '@umbraco-cms/backoffice/backend-api'; -import type { DictionaryDetails } from '@umbraco-cms/backoffice/models'; export const data: Array = [ { diff --git a/src/Umbraco.Web.UI.Client/src/core/mocks/domains/dictionary.handlers.ts b/src/Umbraco.Web.UI.Client/src/core/mocks/domains/dictionary.handlers.ts index ad2ed638d7..e4b837534d 100644 --- a/src/Umbraco.Web.UI.Client/src/core/mocks/domains/dictionary.handlers.ts +++ b/src/Umbraco.Web.UI.Client/src/core/mocks/domains/dictionary.handlers.ts @@ -1,7 +1,7 @@ import { rest } from 'msw'; -import { umbDictionaryData } from '../data/dictionary.data'; import { ImportDictionaryRequestModel, DictionaryOverviewResponseModel } from '@umbraco-cms/backoffice/backend-api'; -import type { DictionaryDetails } from '@umbraco-cms/backoffice/models'; +import type { DictionaryDetails } from '../../../backoffice/translation/dictionary'; +import { umbDictionaryData } from '../data/dictionary.data'; const uploadResponse: ImportDictionaryRequestModel = { fileName: 'c:/path/to/tempfilename.udt',