@umbraco-cms/backoffice 1.0.0-next.c62aa1ac → 1.0.0-next.cb6349ee

package/repository.d.ts

@@ -1,18 +1,19 @@
-import { ProblemDetailsModel, FolderReponseModel, CreateFolderRequestModel, UpdateFolderReponseModel, FolderModelBaseModel, ItemResponseModelBaseModel } from '@umbraco-cms/backoffice/backend-api';
+import { ApiError, CancelError, FolderReponseModel, CreateFolderRequestModel, UpdateFolderReponseModel, TreeItemPresentationModel, ProblemDetailsModel, FolderModelBaseModel, ItemResponseModelBaseModel } from '@umbraco-cms/backoffice/backend-api';
 import { DataSourceResponse as DataSourceResponse$1, UmbDataSourceErrorResponse as UmbDataSourceErrorResponse$1 } from '@umbraco-cms/backoffice/repository';
 import { Observable } from 'rxjs';
+import { UmbTreeRootModel, UmbTreeRootEntityModel } from '@umbraco-cms/backoffice/tree';
 
 interface DataSourceResponse<T = undefined> extends UmbDataSourceErrorResponse {
     data?: T;
 }
 interface UmbDataSourceErrorResponse {
-    error?: ProblemDetailsModel;
+    error?: ApiError | CancelError;
 }
 
-interface UmbDataSource<CreateRequestType, UpdateRequestType, ResponseType> {
+interface UmbDataSource<CreateRequestType, CreateResponseType, UpdateRequestType, ResponseType> {
     createScaffold(parentId: string | null): Promise<DataSourceResponse$1<CreateRequestType>>;
     get(unique: string): Promise<DataSourceResponse$1<ResponseType>>;
-    insert(data: CreateRequestType): Promise<any>;
+    insert(data: CreateRequestType): Promise<DataSourceResponse$1<CreateResponseType>>;
     update(unique: string, data: UpdateRequestType): Promise<DataSourceResponse$1<ResponseType>>;
     delete(unique: string): Promise<DataSourceResponse$1>;
 }
@@ -25,10 +26,39 @@ interface UmbFolderDataSource {
     delete(unique: string): Promise<DataSourceResponse>;
 }
 
-interface UmbTreeDataSource<PagedItemsType = any, ItemsType = any> {
-    getRootItems(): Promise<DataSourceResponse$1<PagedItemsType>>;
-    getChildrenOf(parentUnique: string): Promise<DataSourceResponse$1<PagedItemsType>>;
-    getItems(unique: Array<string>): Promise<DataSourceResponse$1<Array<ItemsType>>>;
+interface UmbPagedData<T> {
+    total: number;
+    items: Array<T>;
+}
+interface UmbTreeRepository<TreeItemType extends TreeItemPresentationModel, TreeRootType extends UmbTreeRootModel = UmbTreeRootEntityModel> {
+    requestTreeRoot: () => Promise<{
+        data?: TreeRootType;
+        error?: ProblemDetailsModel;
+    }>;
+    requestRootTreeItems: () => Promise<{
+        data?: UmbPagedData<TreeItemType>;
+        error?: ProblemDetailsModel;
+        asObservable?: () => Observable<TreeItemType[]>;
+    }>;
+    requestTreeItemsOf: (parentUnique: string | null) => Promise<{
+        data?: UmbPagedData<TreeItemType>;
+        error?: ProblemDetailsModel;
+        asObservable?: () => Observable<TreeItemType[]>;
+    }>;
+    requestItemsLegacy?: (uniques: string[]) => Promise<{
+        data?: Array<TreeItemType>;
+        error?: ProblemDetailsModel;
+        asObservable?: () => Observable<any[]>;
+    }>;
+    rootTreeItems: () => Promise<Observable<TreeItemType[]>>;
+    treeItemsOf: (parentUnique: string | null) => Promise<Observable<TreeItemType[]>>;
+    itemsLegacy?: (uniques: string[]) => Promise<Observable<any[]>>;
+}
+
+interface UmbTreeDataSource<ItemType = any, PagedItemType = UmbPagedData<ItemType>> {
+    getRootItems(): Promise<DataSourceResponse<PagedItemType>>;
+    getChildrenOf(parentUnique: string | null): Promise<DataSourceResponse<PagedItemType>>;
+    getItems(unique: Array<string>): Promise<DataSourceResponse<Array<any>>>;
 }
 
 interface UmbItemDataSource<ItemType> {
@@ -36,11 +66,16 @@ interface UmbItemDataSource<ItemType> {
 }
 
 interface UmbMoveDataSource {
-    move(unique: string, targetUnique: string): Promise<UmbDataSourceErrorResponse$1>;
+    move(unique: string, targetUnique: string | null): Promise<UmbDataSourceErrorResponse$1>;
 }
 
 interface UmbCopyDataSource {
-    copy(unique: string, targetUnique: string): Promise<DataSourceResponse$1<string>>;
+    copy(unique: string, targetUnique: string | null): Promise<DataSourceResponse$1<string>>;
+}
+
+interface UmbCollectionDataSource<ItemType = any, PagedItemType = UmbPagedData<ItemType>> {
+    getCollection(): Promise<DataSourceResponse<PagedItemType>>;
+    filterCollection(filter: any): Promise<DataSourceResponse<PagedItemType>>;
 }
 
 interface UmbRepositoryErrorResponse {
@@ -49,39 +84,15 @@ interface UmbRepositoryErrorResponse {
 interface UmbRepositoryResponse<T> extends UmbRepositoryErrorResponse {
     data?: T;
 }
-interface UmbDetailRepository<CreateRequestType = any, UpdateRequestType = any, ResponseType = any> {
+interface UmbDetailRepository<CreateRequestType = any, CreateResponseType = any, UpdateRequestType = any, ResponseType = any> {
     createScaffold(parentId: string | null): Promise<UmbRepositoryResponse<CreateRequestType>>;
     requestById(id: string): Promise<UmbRepositoryResponse<ResponseType>>;
-    create(data: CreateRequestType): Promise<UmbRepositoryErrorResponse>;
+    byId(id: string): Promise<Observable<ResponseType>>;
+    create(data: CreateRequestType): Promise<UmbRepositoryResponse<CreateResponseType>>;
     save(id: string, data: UpdateRequestType): Promise<UmbRepositoryErrorResponse>;
     delete(id: string): Promise<UmbRepositoryErrorResponse>;
 }
 
-interface UmbPagedData<T> {
-    total: number;
-    items: Array<T>;
-}
-interface UmbTreeRepository<ItemType = any, PagedItemType = UmbPagedData<ItemType>> {
-    requestRootTreeItems: () => Promise<{
-        data: PagedItemType | undefined;
-        error: ProblemDetailsModel | undefined;
-        asObservable?: () => Observable<ItemType[]>;
-    }>;
-    requestTreeItemsOf: (parentUnique: string | null) => Promise<{
-        data: PagedItemType | undefined;
-        error: ProblemDetailsModel | undefined;
-        asObservable?: () => Observable<ItemType[]>;
-    }>;
-    requestItemsLegacy?: (uniques: string[]) => Promise<{
-        data: Array<ItemType> | undefined;
-        error: ProblemDetailsModel | undefined;
-        asObservable?: () => Observable<ItemType[]>;
-    }>;
-    rootTreeItems: () => Promise<Observable<ItemType[]>>;
-    treeItemsOf: (parentUnique: string | null) => Promise<Observable<ItemType[]>>;
-    itemsLegacy?: (uniques: string[]) => Promise<Observable<ItemType[]>>;
-}
-
 interface UmbFolderRepository {
     createFolderScaffold(parentId: string | null): Promise<{
         data?: FolderReponseModel;
@@ -104,6 +115,10 @@ interface UmbFolderRepository {
     }>;
 }
 
+interface UmbCollectionRepository {
+    requestCollection(filter?: any): Promise<any>;
+}
+
 interface UmbItemRepository<ItemType extends ItemResponseModelBaseModel> {
     requestItems: (uniques: string[]) => Promise<{
         data?: Array<ItemType> | undefined;
@@ -121,4 +136,4 @@ interface UmbCopyRepository {
     copy(unique: string, targetUnique: string): Promise<UmbRepositoryResponse<string>>;
 }
 
-export { DataSourceResponse, UmbCopyDataSource, UmbCopyRepository, UmbDataSource, UmbDataSourceErrorResponse, UmbDetailRepository, UmbFolderDataSource, UmbFolderRepository, UmbItemDataSource, UmbItemRepository, UmbMoveDataSource, UmbMoveRepository, UmbPagedData, UmbRepositoryErrorResponse, UmbRepositoryResponse, UmbTreeDataSource, UmbTreeRepository };
+export { DataSourceResponse, UmbCollectionDataSource, UmbCollectionRepository, UmbCopyDataSource, UmbCopyRepository, UmbDataSource, UmbDataSourceErrorResponse, UmbDetailRepository, UmbFolderDataSource, UmbFolderRepository, UmbItemDataSource, UmbItemRepository, UmbMoveDataSource, UmbMoveRepository, UmbPagedData, UmbRepositoryErrorResponse, UmbRepositoryResponse, UmbTreeDataSource, UmbTreeRepository };

package/resources.d.ts

@@ -1,25 +1,20 @@
 import { UmbNotificationOptions } from '@umbraco-cms/backoffice/notification';
-import { ProblemDetailsModel } from '@umbraco-cms/backoffice/backend-api';
 import { UmbController, UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
 import { DataSourceResponse as DataSourceResponse$1 } from '@umbraco-cms/backoffice/repository';
+import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
+import { ApiError, CancelError } from '@umbraco-cms/backoffice/backend-api';
 
 declare class UmbResourceController extends UmbController {
     #private;
     constructor(host: UmbControllerHostElement, promise: Promise<any>, alias?: string);
     hostConnected(): void;
     hostDisconnected(): void;
-    /**
-     * Extract the ProblemDetailsModel object from an ApiError.
-     *
-     * This assumes that all ApiErrors contain a ProblemDetailsModel object in their body.
-     */
-    static toProblemDetailsModel(error: unknown): ProblemDetailsModel | undefined;
     /**
      * Base execute function with a try/catch block and return a tuple with the result and the error.
      */
     static tryExecute<T>(promise: Promise<T>): Promise<DataSourceResponse$1<T>>;
     /**
-     * Wrap the {execute} function in a try/catch block and return the result.
+     * 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.
      */
     tryExecuteAndNotify<T>(options?: UmbNotificationOptions): Promise<DataSourceResponse$1<T>>;
@@ -38,15 +33,27 @@ declare class UmbResourceController extends UmbController {
     destroy(): void;
 }
 
+/**
+ * The base URL of the configured Umbraco server.
+ * If the server is local, this will be an empty string.
+ *
+ * @remarks This is the base URL of the Umbraco server, not the base URL of the backoffice.
+ *
+ * @example https://localhost:44300
+ * @example https://my-umbraco-site.com
+ * @example ''
+ */
+declare const UMB_SERVER_URL: UmbContextToken<string>;
+
 interface DataSourceResponse<T = undefined> extends UmbDataSourceErrorResponse {
     data?: T;
 }
 interface UmbDataSourceErrorResponse {
-    error?: ProblemDetailsModel;
+    error?: ApiError | CancelError;
 }
 
 declare function tryExecute<T>(promise: Promise<T>): Promise<DataSourceResponse<T>>;
 
-declare function tryExecuteAndNotify<T>(host: UmbControllerHostElement, resource: Promise<T>, options?: UmbNotificationOptions<any>): Promise<DataSourceResponse<T>>;
+declare function tryExecuteAndNotify<T>(host: UmbControllerHostElement, resource: Promise<T>, options?: UmbNotificationOptions): Promise<DataSourceResponse<T>>;
 
-export { UmbResourceController, tryExecute, tryExecuteAndNotify };
+export { UMB_SERVER_URL, UmbResourceController, tryExecute, tryExecuteAndNotify };

package/router.d.ts

@@ -22,7 +22,6 @@ type IRoutingInfo<D = any, P = any> = {
 };
 type CustomResolver<D = any, P = any> = ((info: IRoutingInfo<D>) => boolean | void | Promise<boolean> | Promise<void>);
 type Guard<D = any, P = any> = ((info: IRoutingInfo<D, P>) => boolean | Promise<boolean>);
-type Cancel = (() => boolean);
 type PageComponent = HTMLElement | undefined;
 type ModuleResolver = Promise<{
     default: any;
@@ -99,10 +98,6 @@ type Query = {
     [key: string]: string;
 };
 type EventListenerSubscription = (() => void);
-/**
- * RouterSlot related events.
- */
-type RouterSlotEvent = "changestate";
 /**
  * History related events.
  */
@@ -355,13 +350,6 @@ declare function toQueryString(query: Query): string;
  */
 declare function ensureAnchorHistory(): void;
 
-interface UmbRouteLocation {
-    name?: string;
-    params: {
-        [key: string]: string;
-    };
-}
-
 declare class UmbRouteContext {
     #private;
     private _onGotModals;
@@ -377,4 +365,4 @@ declare function generateRoutePathBuilder(path: string): (params: {
     [key: string]: string | number;
 }) => string;
 
-export { Cancel, ChangeStateEvent, Class, Component, CustomResolver, EventListenerSubscription, GlobalRouterEvent, Guard, IComponentRoute, IPathFragments, IRedirectRoute, IResolverRoute, IRoute, IRouteBase, IRouteMatch, IRouterSlot, IRoutingInfo, ISlashOptions, ModuleResolver, NavigationCancelEvent, NavigationEndEvent, NavigationErrorEvent, NavigationStartEvent, NavigationSuccessEvent, PageComponent, Params, PathFragment, PathMatch, PushStateEvent, Query, ReplaceStateEvent, RouterSlotEvent, RouterTree, Setup, UMB_ROUTE_CONTEXT_TOKEN, IRoute as UmbRoute, UmbRouteContext, UmbRouteLocation, WillChangeStateEvent, addListener, attachCallback, basePath, constructAbsolutePath, constructPathWithBasePath, dispatchGlobalRouterEvent, dispatchRouteChangeEvent, ensureAnchorHistory, ensureHistoryEvents, ensureSlash, generateRoutePathBuilder, getFragments, handleRedirect, historyPatches, isPathActive, isRedirectRoute, isResolverRoute, matchRoute, matchRoutes, path, pathWithoutBasePath, query, queryParentRoots, queryParentRouterSlot, queryString, removeListeners, resolvePageComponent, saveNativeFunction, shouldNavigate, slashify, stripSlash, stripStart, toQuery, toQueryString, traverseRouterTree };
+export { Guard, IComponentRoute, IRedirectRoute, IResolverRoute, IRoutingInfo, PageComponent, Params, Query, UMB_ROUTE_CONTEXT_TOKEN, IRoute as UmbRoute, UmbRouteContext, addListener, attachCallback, basePath, constructAbsolutePath, constructPathWithBasePath, dispatchGlobalRouterEvent, dispatchRouteChangeEvent, ensureAnchorHistory, ensureHistoryEvents, ensureSlash, generateRoutePathBuilder, getFragments, handleRedirect, historyPatches, isPathActive, isRedirectRoute, isResolverRoute, matchRoute, matchRoutes, path, pathWithoutBasePath, query, queryParentRoots, queryParentRouterSlot, queryString, removeListeners, resolvePageComponent, saveNativeFunction, shouldNavigate, slashify, stripSlash, stripStart, toQuery, toQueryString, traverseRouterTree };

package/section.d.ts

@@ -0,0 +1,29 @@
+import * as rxjs from 'rxjs';
+import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
+import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
+import { ManifestSection } from '@umbraco-cms/backoffice/extensions-registry';
+
+declare class UmbSectionSidebarContext {
+    #private;
+    contextMenuIsOpen: rxjs.Observable<boolean>;
+    entityType: rxjs.Observable<string | undefined>;
+    unique: rxjs.Observable<string | null | undefined>;
+    headline: rxjs.Observable<string | undefined>;
+    constructor(host: UmbControllerHostElement);
+    toggleContextMenu(entityType: string, unique: string | null | undefined, headline: string): void;
+    openContextMenu(entityType: string, unique: string | null | undefined, headline: string): void;
+    closeContextMenu(): void;
+}
+declare const UMB_SECTION_SIDEBAR_CONTEXT_TOKEN: UmbContextToken<UmbSectionSidebarContext>;
+
+declare class UmbSectionContext {
+    #private;
+    readonly alias: rxjs.Observable<string | undefined>;
+    readonly pathname: rxjs.Observable<string | undefined>;
+    readonly label: rxjs.Observable<string | undefined>;
+    constructor(manifest: ManifestSection);
+    setManifest(manifest?: ManifestSection): void;
+}
+declare const UMB_SECTION_CONTEXT_TOKEN: UmbContextToken<UmbSectionContext>;
+
+export { UMB_SECTION_CONTEXT_TOKEN, UMB_SECTION_SIDEBAR_CONTEXT_TOKEN, UmbSectionContext, UmbSectionSidebarContext };

package/store.d.ts

@@ -97,7 +97,7 @@ declare class UmbEntityTreeStore extends UmbStoreBase$1<EntityTreeItemResponseMo
      * @return {*}
      * @memberof UmbEntityTreeStore
      */
-    items(ids: Array<string>): rxjs.Observable<EntityTreeItemResponseModel[]>;
+    items(ids: Array<string | null>): rxjs.Observable<EntityTreeItemResponseModel[]>;
 }
 
 /**

package/tree.d.ts

@@ -0,0 +1,135 @@
+import * as _umbraco_cms_backoffice_backend_api from '@umbraco-cms/backoffice/backend-api';
+import { TreeItemPresentationModel, ProblemDetailsModel } from '@umbraco-cms/backoffice/backend-api';
+import * as rxjs from 'rxjs';
+import { Observable } from 'rxjs';
+import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
+import { UmbPagedData as UmbPagedData$1, UmbTreeRepository } from '@umbraco-cms/backoffice/repository';
+import { UmbTreeContextBase as UmbTreeContextBase$1 } from '@umbraco-cms/backoffice/tree';
+import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
+
+interface UmbTreeContext<TreeItemType extends TreeItemPresentationModel> {
+    readonly selectable: Observable<boolean>;
+    readonly selection: Observable<Array<string | null>>;
+    setSelectable(value: boolean): void;
+    getSelectable(): boolean;
+    setMultiple(value: boolean): void;
+    getMultiple(): boolean;
+    setSelection(value: Array<string | null>): void;
+    getSelection(): Array<string | null>;
+    select(unique: string | null): void;
+    deselect(unique: string | null): void;
+    requestChildrenOf: (parentUnique: string | null) => Promise<{
+        data?: UmbPagedData$1<TreeItemType>;
+        error?: ProblemDetailsModel;
+        asObservable?: () => Observable<TreeItemType[]>;
+    }>;
+}
+declare class UmbTreeContextBase<TreeItemType extends TreeItemPresentationModel> implements UmbTreeContext<TreeItemType> {
+    #private;
+    host: UmbControllerHostElement;
+    readonly selectable: Observable<boolean>;
+    readonly multiple: Observable<boolean>;
+    readonly selection: Observable<(string | null)[]>;
+    repository?: UmbTreeRepository<TreeItemType>;
+    constructor(host: UmbControllerHostElement);
+    setTreeAlias(treeAlias?: string): Promise<void>;
+    getTreeAlias(): string | undefined;
+    setSelectable(value: boolean): void;
+    getSelectable(): boolean;
+    setMultiple(value: boolean): void;
+    getMultiple(): boolean;
+    setSelection(value: Array<string | null>): void;
+    getSelection(): (string | null)[];
+    select(unique: string | null): void;
+    deselect(unique: string | null): void;
+    requestTreeRoot(): Promise<{
+        data?: UmbTreeRootEntityModel | undefined;
+        error?: ProblemDetailsModel | undefined;
+    }>;
+    requestRootItems(): Promise<{
+        data?: UmbPagedData$1<TreeItemType> | undefined;
+        error?: ProblemDetailsModel | undefined;
+        asObservable?: (() => Observable<TreeItemType[]>) | undefined;
+    }>;
+    requestChildrenOf(parentUnique: string | null): Promise<{
+        data?: UmbPagedData$1<TreeItemType> | undefined;
+        error?: ProblemDetailsModel | undefined;
+        asObservable?: (() => Observable<TreeItemType[]>) | undefined;
+    }>;
+    rootItems(): Promise<Observable<TreeItemType[]>>;
+    childrenOf(parentUnique: string | null): Promise<Observable<TreeItemType[]>>;
+}
+
+interface UmbPagedData<T> {
+    total: number;
+    items: Array<T>;
+}
+
+interface UmbTreeItemContext<TreeItemType extends TreeItemPresentationModel> {
+    host: UmbControllerHostElement;
+    unique?: string | null;
+    type?: string;
+    treeItem: Observable<TreeItemType | undefined>;
+    hasChildren: Observable<boolean>;
+    isLoading: Observable<boolean>;
+    isSelectable: Observable<boolean>;
+    isSelected: Observable<boolean>;
+    isActive: Observable<boolean>;
+    hasActions: Observable<boolean>;
+    path: Observable<string>;
+    setTreeItem(treeItem: TreeItemType | undefined): void;
+    requestChildren(): Promise<{
+        data?: UmbPagedData$1<TreeItemType> | undefined;
+        error?: ProblemDetailsModel | undefined;
+        asObservable?: () => Observable<TreeItemType[]>;
+    }>;
+    toggleContextMenu(): void;
+    select(): void;
+    deselect(): void;
+    constructPath(pathname: string, entityType: string, unique: string): string;
+}
+
+type UmbTreeItemUniqueFunction<TreeItemType extends TreeItemPresentationModel> = (x: TreeItemType) => string | null | undefined;
+declare class UmbTreeItemContextBase<TreeItemType extends TreeItemPresentationModel> implements UmbTreeItemContext<TreeItemType> {
+    #private;
+    host: UmbControllerHostElement;
+    unique?: string | null;
+    type?: string;
+    treeItem: rxjs.Observable<TreeItemType | undefined>;
+    hasChildren: rxjs.Observable<boolean>;
+    isLoading: rxjs.Observable<boolean>;
+    isSelectable: rxjs.Observable<boolean>;
+    isSelected: rxjs.Observable<boolean>;
+    isActive: rxjs.Observable<boolean>;
+    hasActions: rxjs.Observable<boolean>;
+    path: rxjs.Observable<string>;
+    treeContext?: UmbTreeContextBase$1<TreeItemType>;
+    constructor(host: UmbControllerHostElement, getUniqueFunction: UmbTreeItemUniqueFunction<TreeItemType>);
+    setTreeItem(treeItem: TreeItemType | undefined): void;
+    requestChildren(): Promise<{
+        data?: UmbPagedData<TreeItemType> | undefined;
+        error?: _umbraco_cms_backoffice_backend_api.ProblemDetailsModel | undefined;
+        asObservable?: (() => rxjs.Observable<TreeItemType[]>) | undefined;
+    }>;
+    toggleContextMenu(): void;
+    select(): void;
+    deselect(): void;
+    getTreeItem(): TreeItemType | undefined;
+    constructPath(pathname: string, entityType: string, unique: string | null): string;
+}
+declare const UMB_TREE_ITEM_CONTEXT_TOKEN: UmbContextToken<UmbTreeItemContext<any>>;
+
+interface UmbTreeRootModel {
+    type: string;
+    name: string;
+    hasChildren: boolean;
+    icon?: string;
+}
+interface UmbTreeRootEntityModel extends UmbTreeRootModel {
+    id: string | null;
+}
+interface UmbTreeRootFileSystemModel extends UmbTreeRootModel {
+    path: string | null;
+}
+
+export { UMB_TREE_ITEM_CONTEXT_TOKEN, UmbTreeContext, UmbTreeContextBase, UmbTreeItemContext, UmbTreeItemContextBase, UmbTreeItemUniqueFunction, UmbTreeRootEntityModel, UmbTreeRootFileSystemModel, UmbTreeRootModel };