Umbraco-CMS/src/Umbraco.Web.UI.Client/libs/models/index.ts

import {
	ContentTreeItemResponseModel,
	DictionaryItemTranslationModel,
	EntityTreeItemResponseModel,
	FolderTreeItemResponseModel,
	PackageManifestResponseModel,
	ProblemDetailsModel,
} from '@umbraco-cms/backend-api';

// Extension Manifests
export * from '@umbraco-cms/extensions-registry';

// eslint-disable-next-line @typescript-eslint/no-explicit-any
export type HTMLElementConstructor<T = HTMLElement> = new (...args: any[]) => T;

export type ClassConstructor<T> = new (...args: any[]) => T;

// Users
// TODO: would the right name be Node? as entity is just something with a Key. But node is something in a content structure, aka. with hasChildren and parentKey.
export interface Entity {
	key: string;
	name: string;
	icon: string;
	type: string;
	hasChildren: boolean;
	parentKey: string | null;
}

export interface ContentDetails extends ContentTreeItemResponseModel {
	isTrashed: boolean; // TODO: remove only temp part of refactor
	properties: Array<ContentProperty>;
	//data: Array<ContentPropertyData>;
	//layout?: any; // TODO: define layout type - make it non-optional
}

export interface UserEntity extends Entity {
	type: 'user';
}

export type UserStatus = 'enabled' | 'inactive' | 'invited' | 'disabled';
export interface UserDetails extends UserEntity {
	email: string;
	status: UserStatus;
	language: string;
	lastLoginDate?: string;
	lastLockoutDate?: string;
	lastPasswordChangeDate?: string;
	updateDate: string;
	createDate: string;
	failedLoginAttempts: number;
	userGroups: Array<string>;
	contentStartNodes: Array<string>;
	mediaStartNodes: Array<string>;
}

export interface UserGroupEntity extends Entity {
	type: 'user-group';
}

export interface UserGroupDetails extends UserGroupEntity {
	sections: Array<string>;
	contentStartNode?: string;
	mediaStartNode?: string;
	permissions: Array<string>;
}

/*
// Data Types
export interface DataTypeDetails extends FolderTreeItemModel {
	key: string; // TODO: Remove this when the backend is fixed
	propertyEditorAlias: string | null;
	propertyEditorUiAlias: string | null;
	data: Array<DataTypeProperty>;
}

export interface DataTypeProperty {
	alias: string;
	value: any;
}
*/

// TODO: Make sure Entity Type/interface.
export interface MemberTypeDetails extends EntityTreeItemResponseModel {
	key: string; // TODO: Remove this when the backend is fixed
	alias: string;
	properties: [];
}

// Content
export interface ContentProperty {
	alias: string;
	label: string;
	description: string;
	dataTypeKey: string;
}

export interface ContentPropertyData {
	alias: string;
	value: any;
}

// Media
export interface MediaDetails extends ContentTreeItemResponseModel {
	key: string; // TODO: Remove this when the backend is fixed
	isTrashed: boolean; // TODO: remove only temp part of refactor
	properties: Array<ContentProperty>;
	data: Array<ContentPropertyData>;
	variants: Array<any>; // TODO: define variant data
	//layout?: any; // TODO: define layout type - make it non-optional
}

// Media Types

export interface MediaTypeDetails extends FolderTreeItemResponseModel {
	key: string; // TODO: Remove this when the backend is fixed
	alias: string;
	properties: [];
}

// Member Groups
export interface MemberGroupDetails extends EntityTreeItemResponseModel {
	key: string; // TODO: Remove this when the backend is fixed
}

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;
	name: string;
	type: 'document-blueprint';
	properties: Array<any>;
	data: Array<any>;
	icon: string;
	documentTypeKey: string;
}

export interface DataSourceResponse<T = undefined> {
	data?: T;
	error?: ProblemDetailsModel;
}

export interface SwatchDetails {
	label: string;
	value: string;
}

export type UmbPackage = PackageManifestResponseModel;

export type PackageManifestResponse = UmbPackage[];

export type UmbPackageWithMigrationStatus = UmbPackage & {
	hasPendingMigrations: boolean;
};