rename models

This commit is contained in:
Jacob Overgaard
2023-02-10 10:51:02 +01:00
parent a3434a544e
commit 584afafaf4
12 changed files with 42 additions and 45 deletions

View File

@@ -137,7 +137,7 @@ export interface MemberGroupDetails extends EntityTreeItemModel {
key: string; // TODO: Remove this when the backend is fixed
}
export interface MemberDetails extends EntityTreeItem {
export interface MemberDetails extends EntityTreeItemModel {
key: string; // TODO: Remove this when the backend is fixed
}

View File

@@ -3,7 +3,7 @@ import { UmbMemberGroupTreeStore, UMB_MEMBER_GROUP_TREE_STORE_CONTEXT_TOKEN } fr
import { UmbControllerHostInterface } from '@umbraco-cms/controller';
import { UmbNotificationService, UMB_NOTIFICATION_SERVICE_CONTEXT_TOKEN } from '@umbraco-cms/notification';
import { UmbContextConsumerController } from '@umbraco-cms/context-api';
import { ProblemDetails } from '@umbraco-cms/backend-api';
import { ProblemDetailsModel } from '@umbraco-cms/backend-api';
import type { UmbTreeRepository } from '@umbraco-cms/models';
export class UmbMemberGroupTreeRepository implements UmbTreeRepository {
@@ -54,15 +54,15 @@ export class UmbMemberGroupTreeRepository implements UmbTreeRepository {
}
async requestChildrenOf(parentKey: string | null) {
const error: ProblemDetails = { title: 'Not implemented' };
return { data: undefined, error };
const error: ProblemDetailsModel = { title: 'Not implemented' };
return { data: undefined, error };
}
async requestItems(keys: Array<string>) {
await this.#init;
if (!keys) {
const error: ProblemDetails = { title: 'Keys are missing' };
const error: ProblemDetailsModel = { title: 'Keys are missing' };
return { data: undefined, error };
}

View File

@@ -1,8 +1,8 @@
import { EntityTreeItem } from '@umbraco-cms/backend-api';
import type { EntityTreeItemModel } from '@umbraco-cms/backend-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
import { ArrayState } from '@umbraco-cms/observable-api';
import { UmbStoreBase } from '@umbraco-cms/store';
import { UmbControllerHostInterface } from '@umbraco-cms/controller';
import type { UmbControllerHostInterface } from '@umbraco-cms/controller';
/**
* @export
@@ -11,7 +11,7 @@ import { UmbControllerHostInterface } from '@umbraco-cms/controller';
* @description - Tree Data Store for Member Groups
*/
export class UmbMemberGroupTreeStore extends UmbStoreBase {
#data = new ArrayState<EntityTreeItem>([], (x) => x.key);
#data = new ArrayState<EntityTreeItemModel>([], (x) => x.key);
/**
* Creates an instance of UmbTemplateTreeStore.
@@ -27,7 +27,7 @@ export class UmbMemberGroupTreeStore extends UmbStoreBase {
* @param {Array<EntityTreeItem>} items
* @memberof UmbTemplateTreeStore
*/
appendItems(items: Array<EntityTreeItem>) {
appendItems(items: Array<EntityTreeItemModel>) {
this.#data.append(items);
}
@@ -37,7 +37,7 @@ export class UmbMemberGroupTreeStore extends UmbStoreBase {
* @param {Partial<EntityTreeItem>} data
* @memberof UmbMemberGroupTreeStore
*/
updateItem(key: string, data: Partial<EntityTreeItem>) {
updateItem(key: string, data: Partial<EntityTreeItemModel>) {
const entries = this.#data.getValue();
const entry = entries.find((entry) => entry.key === key);

View File

@@ -1,7 +1,7 @@
import type { DataSourceResponse } from '@umbraco-cms/models';
import { EntityTreeItem, PagedEntityTreeItem } from '@umbraco-cms/backend-api';
import { EntityTreeItemModel, PagedEntityTreeItemModel } from '@umbraco-cms/backend-api';
export interface MemberGroupTreeDataSource {
getRootItems(): Promise<DataSourceResponse<PagedEntityTreeItem>>;
getItems(key: Array<string>): Promise<DataSourceResponse<EntityTreeItem[]>>;
getRootItems(): Promise<DataSourceResponse<PagedEntityTreeItemModel>>;
getItems(key: Array<string>): Promise<DataSourceResponse<EntityTreeItemModel[]>>;
}

View File

@@ -1,5 +1,5 @@
import { MemberGroupTreeDataSource } from '.';
import { MemberGroupResource, ProblemDetails } from '@umbraco-cms/backend-api';
import { MemberGroupResource, ProblemDetailsModel } from '@umbraco-cms/backend-api';
import { UmbControllerHostInterface } from '@umbraco-cms/controller';
import { tryExecuteAndNotify } from '@umbraco-cms/resources';
@@ -21,7 +21,7 @@ export class MemberGroupTreeServerDataSource implements MemberGroupTreeDataSourc
this.#host = host;
}
/**
/**
* Fetches the root items for the tree from the server
* @return {*}
* @memberof MemberGroupTreeServerDataSource
@@ -38,7 +38,7 @@ export class MemberGroupTreeServerDataSource implements MemberGroupTreeDataSourc
*/
async getItems(keys: Array<string>) {
if (keys) {
const error: ProblemDetails = { title: 'Keys are missing' };
const error: ProblemDetailsModel = { title: 'Keys are missing' };
return { error };
}

View File

@@ -3,7 +3,7 @@ import { MemberTreeServerDataSource } from './sources/member.tree.server.data';
import { UmbControllerHostInterface } from '@umbraco-cms/controller';
import { UmbNotificationService, UMB_NOTIFICATION_SERVICE_CONTEXT_TOKEN } from '@umbraco-cms/notification';
import { UmbContextConsumerController } from '@umbraco-cms/context-api';
import { ProblemDetails } from '@umbraco-cms/backend-api';
import { ProblemDetailsModel } from '@umbraco-cms/backend-api';
import type { UmbTreeRepository } from '@umbraco-cms/models';
export class UmbMemberTreeRepository implements UmbTreeRepository {
@@ -54,15 +54,15 @@ export class UmbMemberTreeRepository implements UmbTreeRepository {
}
async requestChildrenOf(parentKey: string | null) {
const error: ProblemDetails = { title: 'Not implemented' };
return { data: undefined, error };
const error: ProblemDetailsModel = { title: 'Not implemented' };
return { data: undefined, error };
}
async requestItems(keys: Array<string>) {
await this.#init;
if (!keys) {
const error: ProblemDetails = { title: 'Keys are missing' };
const error: ProblemDetailsModel = { title: 'Keys are missing' };
return { data: undefined, error };
}

View File

@@ -1,8 +1,8 @@
import { EntityTreeItem } from '@umbraco-cms/backend-api';
import type { EntityTreeItemModel } from '@umbraco-cms/backend-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
import { ArrayState } from '@umbraco-cms/observable-api';
import { UmbStoreBase } from '@umbraco-cms/store';
import { UmbControllerHostInterface } from '@umbraco-cms/controller';
import type { UmbControllerHostInterface } from '@umbraco-cms/controller';
/**
* @export
@@ -11,7 +11,7 @@ import { UmbControllerHostInterface } from '@umbraco-cms/controller';
* @description - Tree Data Store for Members
*/
export class UmbMemberTreeStore extends UmbStoreBase {
#data = new ArrayState<EntityTreeItem>([], (x) => x.key);
#data = new ArrayState<EntityTreeItemModel>([], (x) => x.key);
/**
* Creates an instance of UmbTemplateTreeStore.
@@ -27,7 +27,7 @@ export class UmbMemberTreeStore extends UmbStoreBase {
* @param {Array<EntityTreeItem>} items
* @memberof UmbTemplateTreeStore
*/
appendItems(items: Array<EntityTreeItem>) {
appendItems(items: Array<EntityTreeItemModel>) {
this.#data.append(items);
}
@@ -37,7 +37,7 @@ export class UmbMemberTreeStore extends UmbStoreBase {
* @param {Partial<EntityTreeItem>} data
* @memberof UmbMemberGroupTreeStore
*/
updateItem(key: string, data: Partial<EntityTreeItem>) {
updateItem(key: string, data: Partial<EntityTreeItemModel>) {
const entries = this.#data.getValue();
const entry = entries.find((entry) => entry.key === key);
@@ -90,6 +90,4 @@ export class UmbMemberTreeStore extends UmbStoreBase {
}
}
export const UMB_MEMBER_TREE_STORE_CONTEXT_TOKEN = new UmbContextToken<UmbMemberTreeStore>(
UmbMemberTreeStore.name
);
export const UMB_MEMBER_TREE_STORE_CONTEXT_TOKEN = new UmbContextToken<UmbMemberTreeStore>(UmbMemberTreeStore.name);

View File

@@ -1,7 +1,7 @@
import type { DataSourceResponse } from '@umbraco-cms/models';
import { EntityTreeItem, PagedEntityTreeItem } from '@umbraco-cms/backend-api';
import type { EntityTreeItemModel, PagedEntityTreeItemModel } from '@umbraco-cms/backend-api';
export interface MemberTreeDataSource {
getRootItems(): Promise<DataSourceResponse<PagedEntityTreeItem>>;
getItems(key: Array<string>): Promise<DataSourceResponse<EntityTreeItem[]>>;
getRootItems(): Promise<DataSourceResponse<PagedEntityTreeItemModel>>;
getItems(key: Array<string>): Promise<DataSourceResponse<EntityTreeItemModel[]>>;
}

View File

@@ -1,7 +1,6 @@
import { MemberTreeDataSource } from '.';
import { ProblemDetails } from '@umbraco-cms/backend-api';
import { ProblemDetailsModel } from '@umbraco-cms/backend-api';
import { UmbControllerHostInterface } from '@umbraco-cms/controller';
import { tryExecuteAndNotify } from '@umbraco-cms/resources';
/**
* A data source for the Member tree that fetches data from the server
@@ -47,7 +46,7 @@ export class MemberTreeServerDataSource implements MemberTreeDataSource {
return { data, error: undefined };
// if (keys) {
// const error: ProblemDetails = { title: 'Keys are missing' };
// const error: ProblemDetailsModel = { title: 'Keys are missing' };
// return { error };
// }

View File

@@ -11,7 +11,7 @@ import {
UMB_LANGUAGE_STORE_CONTEXT_TOKEN,
} from '../../../../language.store';
import { UmbLitElement } from '@umbraco-cms/element';
import { Culture, Language } from '@umbraco-cms/backend-api';
import { CultureModel, LanguageModel } from '@umbraco-cms/backend-api';
@customElement('umb-workspace-view-language-edit')
export class UmbWorkspaceViewLanguageEditElement extends UmbLitElement {
@@ -56,13 +56,13 @@ export class UmbWorkspaceViewLanguageEditElement extends UmbLitElement {
private _languages: UmbLanguageStoreItemType[] = [];
@state()
private _availableCultures: Culture[] = [];
private _availableCultures: CultureModel[] = [];
@state()
private _search = '';
@state()
private _startData: Language | null = null;
private _startData: LanguageModel | null = null;
#languageWorkspaceContext?: UmbWorkspaceLanguageContext;
@@ -153,7 +153,7 @@ export class UmbWorkspaceViewLanguageEditElement extends UmbLitElement {
}
}
get #filteredCultures(): Array<Culture> {
get #filteredCultures(): Array<CultureModel> {
return this._availableCultures.filter((culture) => {
return culture.englishName?.toLowerCase().includes(this._search.toLowerCase());
});

View File

@@ -1,12 +1,12 @@
import { Culture, PagedCulture } from '@umbraco-cms/backend-api';
import type { CultureModel, PagedCultureModel } from '@umbraco-cms/backend-api';
class UmbCulturesData {
get(): PagedCulture {
get(): PagedCultureModel {
return { total: culturesMock.length, items: culturesMock };
}
}
export const culturesMock: Array<Culture> = [
export const culturesMock: Array<CultureModel> = [
{
name: 'af',
englishName: 'Afrikaans',

View File

@@ -1,7 +1,7 @@
import { UmbEntityData } from './entity.data';
import { createEntityTreeItem } from './utils';
import type { MemberDetails } from '@umbraco-cms/models';
import { EntityTreeItem, PagedEntityTreeItem } from '@umbraco-cms/backend-api';
import type { EntityTreeItemModel, PagedEntityTreeItemModel } from '@umbraco-cms/backend-api';
export const data: Array<MemberDetails> = [
{
@@ -24,21 +24,21 @@ class UmbMemberData extends UmbEntityData<MemberDetails> {
super(data);
}
getTreeRoot(): PagedEntityTreeItem {
getTreeRoot(): PagedEntityTreeItemModel {
const items = this.data.filter((item) => item.parentKey === null);
const treeItems = items.map((item) => createEntityTreeItem(item));
const total = items.length;
return { items: treeItems, total };
}
getTreeItemChildren(key: string): PagedEntityTreeItem {
getTreeItemChildren(key: string): PagedEntityTreeItemModel {
const items = this.data.filter((item) => item.parentKey === key);
const treeItems = items.map((item) => createEntityTreeItem(item));
const total = items.length;
return { items: treeItems, total };
}
getTreeItem(keys: Array<string>): Array<EntityTreeItem> {
getTreeItem(keys: Array<string>): Array<EntityTreeItemModel> {
const items = this.data.filter((item) => keys.includes(item.key ?? ''));
return items.map((item) => createEntityTreeItem(item));
}