@umbraco-cms/backoffice 1.0.0-next.249bf505 → 1.0.0-next.264a3c21

package/workspace.d.ts

@@ -1,40 +1,85 @@
-import { UmbControllerHostElement } from './controller';
+import * as rxjs from 'rxjs';
 import { Observable } from 'rxjs';
-import { UmbWorkspaceContextInterface as UmbWorkspaceContextInterface$1 } from './workspace';
-
-interface UmbWorkspaceAction<T = unknown> {
-    host: UmbControllerHostElement;
-    workspaceContext?: T;
-    execute(): Promise<void>;
-}
-declare class UmbWorkspaceActionBase<WorkspaceType> {
-    host: UmbControllerHostElement;
-    workspaceContext?: WorkspaceType;
-    constructor(host: UmbControllerHostElement);
-}
+import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller-api';
+import { UmbWorkspaceContextInterface as UmbWorkspaceContextInterface$1 } from '@umbraco-cms/backoffice/workspace';
+import { UmbEntityBase } from '@umbraco-cms/backoffice/models';
+import { UmbVariantId } from '@umbraco-cms/backoffice/variant';
 
 interface UmbWorkspaceContextInterface<DataType = unknown> {
     host: UmbControllerHostElement;
     repository: any;
-    isNew: Observable<boolean>;
-    getIsNew(): boolean;
+    isNew: Observable<boolean | undefined>;
+    getIsNew(): boolean | undefined;
     setIsNew(value: boolean): void;
     getEntityType(): string;
     getData(): DataType | undefined;
+    save(): Promise<void>;
     destroy(): void;
     setValidationErrors?(errorMap: any): void;
 }
 
-declare class UmbSaveWorkspaceAction extends UmbWorkspaceActionBase<UmbWorkspaceContextInterface> {
+interface UmbEntityWorkspaceContextInterface<EntityType = unknown> extends UmbWorkspaceContextInterface$1<EntityType> {
+    getEntityId(): string | undefined;
+    getEntityType(): string;
+    save(): Promise<void>;
+}
+
+declare abstract class UmbWorkspaceContext<T, EntityType extends UmbEntityBase> implements UmbEntityWorkspaceContextInterface<EntityType> {
     #private;
+    host: UmbControllerHostElement;
+    repository: T;
+    isNew: rxjs.Observable<boolean | undefined>;
+    constructor(host: UmbControllerHostElement, repository: T);
+    getIsNew(): boolean | undefined;
+    setIsNew(isNew: boolean): void;
+    abstract getEntityId(): string | undefined;
+    abstract getEntityType(): string;
+    abstract getData(): EntityType | undefined;
+    abstract save(): Promise<void>;
+    abstract destroy(): void;
+}
+
+interface UmbWorkspaceAction<WorkspaceType = unknown> {
+    host: UmbControllerHostElement;
+    workspaceContext?: WorkspaceType;
+    execute(): Promise<void>;
+}
+declare abstract class UmbWorkspaceActionBase<WorkspaceType extends UmbWorkspaceContextInterface> implements UmbWorkspaceAction<WorkspaceType> {
+    host: UmbControllerHostElement;
+    workspaceContext?: WorkspaceType;
+    constructor(host: UmbControllerHostElement);
+    abstract execute(): Promise<void>;
+}
+
+declare class UmbSaveWorkspaceAction extends UmbWorkspaceActionBase<UmbWorkspaceContextInterface> {
     constructor(host: UmbControllerHostElement);
     execute(): Promise<void>;
 }
 
-interface UmbEntityWorkspaceContextInterface<EntityType = unknown> extends UmbWorkspaceContextInterface$1<EntityType> {
-    getEntityId(): string | undefined;
-    getEntityType(): string;
-    save(): Promise<void>;
+type ActiveVariant = {
+    index: number;
+    culture: string | null;
+    segment: string | null;
+};
+/**
+ * @export
+ * @class UmbWorkspaceSplitViewManager
+ * @description - Class managing the split view state for a workspace context.
+ */
+declare class UmbWorkspaceSplitViewManager {
+    #private;
+    readonly activeVariantsInfo: rxjs.Observable<ActiveVariant[]>;
+    constructor(host: UmbControllerHostElement);
+    private _routeBase?;
+    getWorkspaceRoute(): string | undefined;
+    setWorkspaceRoute(route: string | undefined): void;
+    setActiveVariant(index: number, culture: string | null, segment: string | null): void;
+    getActiveVariants(): ActiveVariant[];
+    removeActiveVariant(index: number): void;
+    activeVariantByIndex(index: number): rxjs.Observable<ActiveVariant>;
+    switchVariant(index: number, variantId: UmbVariantId): boolean;
+    openSplitView(newVariant: UmbVariantId): boolean;
+    closeSplitView(index: number): boolean;
 }
 
-export { UmbEntityWorkspaceContextInterface, UmbSaveWorkspaceAction, UmbWorkspaceAction, UmbWorkspaceActionBase, UmbWorkspaceContextInterface };
+export { ActiveVariant, UmbEntityWorkspaceContextInterface, UmbSaveWorkspaceAction, UmbWorkspaceAction, UmbWorkspaceActionBase, UmbWorkspaceContext, UmbWorkspaceContextInterface, UmbWorkspaceSplitViewManager };

package/extensions-api.d.ts

@@ -1,67 +0,0 @@
-import { Observable } from 'rxjs';
-import { ManifestTypes, ManifestKind, ManifestTypeMap, ManifestBase, SpecificManifestTypeOrManifestBase, ManifestElement, ManifestElementWithElementName, ManifestClass } from './extensions-registry';
-import { UmbContextToken } from './context-api';
-import { PageComponent } from './router';
-import { UmbControllerHostElement } from './controller';
-
-declare class UmbExtensionRegistry {
-    private _extensions;
-    readonly extensions: Observable<ManifestTypes[]>;
-    private _kinds;
-    readonly kinds: Observable<ManifestKind[]>;
-    defineKind(kind: ManifestKind): void;
-    register(manifest: ManifestTypes | ManifestKind): void;
-    unregister(alias: string): void;
-    isRegistered(alias: string): boolean;
-    private _kindsOfType;
-    private _extensionsOfType;
-    private _kindsOfTypes;
-    private _extensionsOfTypes;
-    getByTypeAndAlias<Key extends keyof ManifestTypeMap | string, T extends ManifestBase = SpecificManifestTypeOrManifestBase<Key>>(type: Key, alias: string): Observable<T | undefined>;
-    extensionsOfType<Key extends keyof ManifestTypeMap | string, T extends ManifestBase = SpecificManifestTypeOrManifestBase<Key>>(type: Key): Observable<T[]>;
-    extensionsOfTypes<ExtensionTypes extends ManifestBase = ManifestBase>(types: string[]): Observable<Array<ExtensionTypes>>;
-}
-declare const UMB_EXTENSION_REGISTRY_TOKEN: UmbContextToken<UmbExtensionRegistry>;
-
-declare function createExtensionElement(manifest: ManifestElement): Promise<PageComponent>;
-
-declare function hasDefaultExport<ConstructorType>(object: unknown): object is {
-    default: ConstructorType;
-};
-
-type UmbEntrypointOnInit = (host: UmbControllerHostElement, extensionRegistry: UmbExtensionRegistry) => void;
-/**
- * Interface containing supported life-cycle functions for ESModule entrypoints
- */
-interface UmbEntrypointModule {
-    onInit: UmbEntrypointOnInit;
-}
-
-/**
- * Validate if an ESModule exports a known init function called 'onInit'
- */
-declare function hasInitExport(obj: unknown): obj is Pick<UmbEntrypointModule, 'onInit'>;
-
-declare function isManifestElementNameType(manifest: unknown): manifest is ManifestElementWithElementName;
-
-declare function isManifestElementableType(manifest: ManifestBase): manifest is ManifestElement;
-
-type ManifestLoaderType = ManifestElement & {
-    loader: () => Promise<object | HTMLElement>;
-};
-type ManifestJSType = ManifestElement & {
-    js: string;
-};
-declare function loadExtension(manifest: ManifestElement): Promise<object | HTMLElement | null>;
-
-declare function isManifestJSType(manifest: ManifestBase | unknown): manifest is ManifestJSType;
-
-declare function isManifestLoaderType(manifest: ManifestBase): manifest is ManifestLoaderType;
-
-declare function createExtensionElementOrFallback(manifest: any, fallbackElementName: string): Promise<HTMLElement | undefined>;
-
-declare function createExtensionClass<T = unknown>(manifest: ManifestClass, constructorArguments: unknown[]): Promise<T | undefined>;
-
-declare const umbExtensionsRegistry: UmbExtensionRegistry;
-
-export { ManifestJSType, ManifestLoaderType, UMB_EXTENSION_REGISTRY_TOKEN, UmbEntrypointModule, UmbEntrypointOnInit, UmbExtensionRegistry, createExtensionClass, createExtensionElement, createExtensionElementOrFallback, hasDefaultExport, hasInitExport, isManifestElementNameType, isManifestElementableType, isManifestJSType, isManifestLoaderType, loadExtension, umbExtensionsRegistry };

package/extensions-registry.d.ts

@@ -1,397 +0,0 @@
-import { InterfaceLook, InterfaceColor } from '@umbraco-ui/uui-base/lib/types/index';
-import { UmbWorkspaceAction } from './workspace';
-import { ClassConstructor } from './models';
-import { UmbStoreBase, UmbTreeStore } from './store';
-import { UmbExtensionRegistry } from './extensions-api';
-import { UmbControllerHostElement } from './controller';
-
-interface ManifestCollectionView extends ManifestElement, ManifestWithConditions<ConditionsCollectionView> {
-    type: 'collectionView';
-    meta: MetaCollectionView;
-}
-interface MetaCollectionView {
-    label: string;
-    icon: string;
-    pathName: string;
-}
-interface ConditionsCollectionView {
-    entityType: string;
-}
-
-interface ManifestDashboard extends ManifestElement, ManifestWithConditions<ConditionsDashboard> {
-    type: 'dashboard';
-    meta: MetaDashboard;
-}
-interface MetaDashboard {
-    pathname: string;
-    label?: string;
-}
-interface ConditionsDashboard {
-    sections: string[];
-}
-
-interface ManifestDashboardCollection extends ManifestBase {
-    type: 'dashboardCollection';
-    meta: MetaDashboardCollection;
-    conditions: ConditionsDashboardCollection;
-}
-interface MetaDashboardCollection {
-    pathname: string;
-    label?: string;
-    repositoryAlias: string;
-}
-interface ConditionsDashboardCollection {
-    sections: string[];
-    entityType: string;
-}
-
-interface ManifestEntityAction extends ManifestElement {
-    type: 'entityAction';
-    meta: MetaEntityAction;
-    conditions: ConditionsEntityAction;
-}
-interface MetaEntityAction {
-    icon?: string;
-    label: string;
-    api: any;
-    repositoryAlias: string;
-}
-interface ConditionsEntityAction {
-    entityType: string;
-}
-
-interface ManifestEntityBulkAction extends ManifestElement, ManifestWithConditions<ConditionsEntityBulkAction> {
-    type: 'entityBulkAction';
-    meta: MetaEntityBulkAction;
-}
-interface MetaEntityBulkAction {
-    label: string;
-    api: any;
-    repositoryAlias: string;
-}
-interface ConditionsEntityBulkAction {
-    entityType: string;
-}
-
-interface ManifestExternalLoginProvider extends ManifestElement {
-    type: 'externalLoginProvider';
-    meta: MetaExternalLoginProvider;
-}
-interface MetaExternalLoginProvider {
-    label: string;
-    pathname: string;
-}
-
-interface ManifestHeaderApp extends ManifestElement {
-    type: 'headerApp';
-}
-interface MetaHeaderApp {
-    pathname: string;
-    label: string;
-    icon: string;
-}
-interface ManifestHeaderAppButtonKind extends ManifestHeaderApp {
-    type: 'headerApp';
-    kind: 'button';
-    meta: MetaHeaderAppButtonKind;
-}
-interface MetaHeaderAppButtonKind {
-    href: string;
-    label: string;
-    icon: string;
-}
-
-interface ManifestHealthCheck extends ManifestElement {
-    type: 'healthCheck';
-    meta: MetaHealthCheck;
-}
-interface MetaHealthCheck {
-    label: string;
-    api: any;
-}
-interface HealthCheck {
-    alias: string;
-    name: string;
-    description: string;
-}
-
-interface ManifestPackageView extends ManifestElement {
-    type: 'packageView';
-    meta: MetaPackageView;
-}
-interface MetaPackageView {
-    packageName: string;
-}
-
-interface ManifestPropertyAction extends ManifestElement, ManifestWithConditions<ConditionsPropertyAction> {
-    type: 'propertyAction';
-}
-interface ConditionsPropertyAction {
-    propertyEditors: string[];
-}
-
-interface ManifestPropertyEditorUI extends ManifestElement {
-    type: 'propertyEditorUI';
-    meta: MetaPropertyEditorUI;
-}
-interface MetaPropertyEditorUI {
-    label: string;
-    propertyEditorModel: string;
-    icon: string;
-    group: string;
-    config?: PropertyEditorConfig;
-    supportsReadOnly?: boolean;
-}
-interface ManifestPropertyEditorModel extends ManifestBase {
-    type: 'propertyEditorModel';
-    meta: MetaPropertyEditorModel;
-}
-interface MetaPropertyEditorModel {
-    config?: PropertyEditorConfig;
-}
-interface PropertyEditorConfig {
-    properties: PropertyEditorConfigProperty[];
-    defaultData?: PropertyEditorConfigDefaultData[];
-}
-interface PropertyEditorConfigProperty {
-    label: string;
-    description?: string;
-    alias: string;
-    propertyEditorUI: string;
-}
-interface PropertyEditorConfigDefaultData {
-    alias: string;
-    value: any;
-}
-
-interface ManifestSection extends ManifestElement {
-    type: 'section';
-    meta: MetaSection;
-}
-interface MetaSection {
-    label: string;
-    pathname: string;
-}
-
-interface ManifestSectionView extends ManifestElement, ManifestWithConditions<ConditionsSectionView> {
-    type: 'sectionView';
-    meta: MetaSectionView;
-}
-interface MetaSectionView {
-    label: string;
-    pathname: string;
-    icon: string;
-}
-interface ConditionsSectionView {
-    sections: Array<string>;
-}
-
-interface ManifestSectionSidebarApp extends ManifestElement {
-    type: 'sectionSidebarApp';
-    conditions: ConditionsSectionSidebarApp;
-}
-interface ConditionsSectionSidebarApp {
-    sections: Array<string>;
-}
-interface ManifestSectionSidebarAppMenuKind extends ManifestSectionSidebarApp {
-    type: 'sectionSidebarApp';
-    kind: 'menu';
-    meta: MetaSectionSidebarAppMenuKind;
-}
-interface MetaSectionSidebarAppMenuKind {
-    label: string;
-    menu: string;
-}
-
-interface ManifestMenu extends ManifestElement {
-    type: 'menu';
-}
-
-interface ManifestMenuItem extends ManifestElement {
-    type: 'menuItem';
-    meta: MetaMenuItem;
-    conditions: ConditionsMenuItem;
-}
-interface MetaMenuItem {
-    label: string;
-    icon: string;
-    entityType?: string;
-}
-interface ConditionsMenuItem {
-    menus: Array<string>;
-}
-interface ManifestMenuItemTreeKind extends ManifestMenuItem {
-    type: 'menuItem';
-    kind: 'tree';
-    meta: MetaMenuItemTreeKind;
-}
-interface MetaMenuItemTreeKind {
-    treeAlias: string;
-    label: string;
-    icon: string;
-    entityType?: string;
-}
-
-interface ManifestTheme extends ManifestWithLoader<string> {
-    type: 'theme';
-    css?: string;
-}
-
-interface ManifestTree extends ManifestBase {
-    type: 'tree';
-    meta: MetaTree;
-}
-interface MetaTree {
-    repositoryAlias: string;
-}
-
-interface ManifestTreeItem extends ManifestElement {
-    type: 'treeItem';
-    conditions: ConditionsTreeItem;
-}
-interface ConditionsTreeItem {
-    entityType: string;
-}
-
-interface ManifestUserProfileApp extends ManifestElement {
-    type: 'userProfileApp';
-    meta: MetaUserProfileApp;
-}
-interface MetaUserProfileApp {
-    label: string;
-    pathname: string;
-}
-
-interface ManifestWorkspace extends ManifestElement {
-    type: 'workspace';
-    meta: MetaEditor;
-}
-interface MetaEditor {
-    entityType: string;
-}
-
-interface ManifestWorkspaceAction extends ManifestElement {
-    type: 'workspaceAction';
-    meta: MetaWorkspaceAction;
-    conditions: ConditionsWorkspaceAction;
-}
-interface MetaWorkspaceAction {
-    label?: string;
-    look?: InterfaceLook;
-    color?: InterfaceColor;
-    api: ClassConstructor<UmbWorkspaceAction>;
-}
-interface ConditionsWorkspaceAction {
-    workspaces: Array<string>;
-}
-
-interface ManifestWorkspaceView extends ManifestWithView {
-    type: 'workspaceView';
-    meta: MetaWorkspaceView;
-    conditions: ConditionsWorkspaceView;
-}
-interface MetaWorkspaceView {
-    pathname: string;
-    label: string;
-    icon: string;
-}
-interface ConditionsWorkspaceView {
-    workspaces: string[];
-}
-
-interface ManifestWorkspaceViewCollection extends ManifestBase, ManifestWithConditions<ConditionsEditorViewCollection> {
-    type: 'workspaceViewCollection';
-    meta: MetaEditorViewCollection;
-}
-interface MetaEditorViewCollection {
-    pathname: string;
-    label: string;
-    icon: string;
-    entityType: string;
-    storeAlias?: string;
-    repositoryAlias?: string;
-}
-interface ConditionsEditorViewCollection {
-    workspaces: string[];
-}
-
-interface ManifestRepository extends ManifestClass {
-    type: 'repository';
-}
-
-interface ManifestModal extends ManifestElement {
-    type: 'modal';
-}
-
-interface ManifestStore extends ManifestClass<UmbStoreBase> {
-    type: 'store';
-}
-interface ManifestTreeStore extends ManifestClass<UmbTreeStore> {
-    type: 'treeStore';
-}
-
-type ManifestTypes = ManifestCollectionView | ManifestDashboard | ManifestDashboardCollection | ManifestEntityAction | ManifestEntityBulkAction | ManifestEntrypoint | ManifestExternalLoginProvider | ManifestHeaderApp | ManifestHeaderAppButtonKind | ManifestHealthCheck | ManifestPackageView | ManifestPropertyAction | ManifestPropertyEditorModel | ManifestPropertyEditorUI | ManifestRepository | ManifestSection | ManifestSectionSidebarApp | ManifestSectionSidebarAppMenuKind | ManifestSectionView | ManifestMenu | ManifestMenuItem | ManifestMenuItemTreeKind | ManifestTheme | ManifestTree | ManifestTreeItem | ManifestUserProfileApp | ManifestWorkspace | ManifestWorkspaceAction | ManifestWorkspaceView | ManifestWorkspaceViewCollection | ManifestModal | ManifestStore | ManifestTreeStore | ManifestBase;
-type ManifestStandardTypes = ManifestTypes['type'];
-type ManifestTypeMap = {
-    [Manifest in ManifestTypes as Manifest['type']]: Manifest;
-};
-type SpecificManifestTypeOrManifestBase<T extends keyof ManifestTypeMap | string> = T extends keyof ManifestTypeMap ? ManifestTypeMap[T] : ManifestBase;
-interface ManifestBase {
-    type: string;
-    alias: string;
-    kind?: any;
-    name: string;
-    weight?: number;
-}
-interface ManifestKind {
-    type: 'kind';
-    alias: string;
-    matchType: string;
-    matchKind: string;
-    manifest: Partial<ManifestTypes>;
-}
-interface ManifestWithConditions<ConditionsType> {
-    conditions: ConditionsType;
-}
-interface ManifestWithLoader<LoaderReturnType> extends ManifestBase {
-    loader?: () => Promise<LoaderReturnType>;
-}
-interface ManifestClass<T = unknown> extends ManifestWithLoader<object> {
-    js?: string;
-    className?: string;
-    class?: ClassConstructor<T>;
-}
-interface ManifestClassWithClassConstructor extends ManifestClass {
-    class: ClassConstructor<unknown>;
-}
-interface ManifestElement extends ManifestWithLoader<object | HTMLElement> {
-    js?: string;
-    elementName?: string;
-    meta?: any;
-}
-interface ManifestWithView extends ManifestElement {
-    meta: MetaManifestWithView;
-}
-interface MetaManifestWithView {
-    pathname: string;
-    label: string;
-    icon: string;
-}
-interface ManifestElementWithElementName extends ManifestElement {
-    elementName: string;
-}
-interface ManifestWithMeta extends ManifestBase {
-    meta: unknown;
-}
-interface ManifestEntrypoint extends ManifestBase {
-    type: 'entrypoint';
-    js: string;
-}
-
-declare class UmbEntryPointExtensionInitializer {
-    #private;
-    constructor(rootHost: UmbControllerHostElement, extensionRegistry: UmbExtensionRegistry);
-    instantiateEntryPoint(manifest: ManifestEntrypoint): void;
-}
-
-export { ConditionsCollectionView, ConditionsDashboard, ConditionsDashboardCollection, ConditionsEditorViewCollection, ConditionsEntityAction, ConditionsEntityBulkAction, ConditionsMenuItem, ConditionsPropertyAction, ConditionsSectionSidebarApp, ConditionsSectionView, ConditionsTreeItem, ConditionsWorkspaceAction, ConditionsWorkspaceView, HealthCheck, ManifestBase, ManifestClass, ManifestClassWithClassConstructor, ManifestCollectionView, ManifestDashboard, ManifestDashboardCollection, ManifestElement, ManifestElementWithElementName, ManifestEntityAction, ManifestEntityBulkAction, ManifestEntrypoint, ManifestExternalLoginProvider, ManifestHeaderApp, ManifestHeaderAppButtonKind, ManifestHealthCheck, ManifestKind, ManifestMenu, ManifestMenuItem, ManifestMenuItemTreeKind, ManifestModal, ManifestPackageView, ManifestPropertyAction, ManifestPropertyEditorModel, ManifestPropertyEditorUI, ManifestRepository, ManifestSection, ManifestSectionSidebarApp, ManifestSectionSidebarAppMenuKind, ManifestSectionView, ManifestStandardTypes, ManifestStore, ManifestTheme, ManifestTree, ManifestTreeItem, ManifestTreeStore, ManifestTypeMap, ManifestTypes, ManifestUserProfileApp, ManifestWithConditions, ManifestWithLoader, ManifestWithMeta, ManifestWithView, ManifestWorkspace, ManifestWorkspaceAction, ManifestWorkspaceView, ManifestWorkspaceViewCollection, MetaCollectionView, MetaDashboard, MetaDashboardCollection, MetaEditor, MetaEditorViewCollection, MetaEntityAction, MetaEntityBulkAction, MetaExternalLoginProvider, MetaHeaderApp, MetaHeaderAppButtonKind, MetaHealthCheck, MetaManifestWithView, MetaMenuItem, MetaMenuItemTreeKind, MetaPackageView, MetaPropertyEditorModel, MetaPropertyEditorUI, MetaSection, MetaSectionSidebarAppMenuKind, MetaSectionView, MetaTree, MetaUserProfileApp, MetaWorkspaceAction, MetaWorkspaceView, PropertyEditorConfig, PropertyEditorConfigDefaultData, PropertyEditorConfigProperty, SpecificManifestTypeOrManifestBase, UmbEntryPointExtensionInitializer };

package/property-editor.d.ts

@@ -1,8 +0,0 @@
-import { DataTypePropertyPresentationModel } from './backend-api';
-
-interface UmbPropertyEditorElement extends HTMLElement {
-    value: unknown;
-    config: DataTypePropertyPresentationModel[];
-}
-
-export { UmbPropertyEditorElement };