@umbraco-cms/backoffice 1.0.0-next.b82f3242 → 1.0.0-next.ba26bec7

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/sorter.d.ts

@@ -0,0 +1,103 @@
+import { UmbControllerInterface, UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
+
+type INTERNAL_UmbSorterConfig<T> = {
+    compareElementToModel: (el: HTMLElement, modelEntry: T) => boolean;
+    querySelectModelToElement: (container: HTMLElement, modelEntry: T) => HTMLElement | null;
+    identifier: string;
+    itemSelector: string;
+    disabledItemSelector?: string;
+    containerSelector: string;
+    ignorerSelector: string;
+    placeholderClass: string;
+    draggableSelector?: string;
+    boundarySelector?: string;
+    dataTransferResolver?: (dataTransfer: DataTransfer | null, currentItem: T) => void;
+    onStart?: (argument: {
+        item: T;
+        element: HTMLElement;
+    }) => void;
+    onChange?: (argument: {
+        item: T;
+        element: HTMLElement;
+    }) => void;
+    onContainerChange?: (argument: {
+        item: T;
+        element: HTMLElement;
+    }) => void;
+    onEnd?: (argument: {
+        item: T;
+        element: HTMLElement;
+    }) => void;
+    onSync?: (argument: {
+        item: T;
+        fromController: UmbSorterController<T>;
+        toController: UmbSorterController<T>;
+    }) => void;
+    itemHasNestedContainersResolver?: (element: HTMLElement) => boolean;
+    onDisallowed?: () => void;
+    onAllowed?: () => void;
+    onRequestDrop?: (argument: {
+        item: T;
+    }) => boolean | void;
+    resolveVerticalDirection?: (argument: {
+        containerElement: Element;
+        containerRect: DOMRect;
+        item: T;
+        element: HTMLElement;
+        elementRect: DOMRect;
+        relatedElement: HTMLElement;
+        relatedRect: DOMRect;
+        placeholderIsInThisRow: boolean;
+        horizontalPlaceAfter: boolean;
+    }) => void;
+    performItemInsert?: (argument: {
+        item: T;
+        newIndex: number;
+    }) => Promise<boolean> | boolean;
+    performItemRemove?: (argument: {
+        item: T;
+    }) => Promise<boolean> | boolean;
+};
+type UmbSorterConfig<T> = Omit<INTERNAL_UmbSorterConfig<T>, 'placeholderClass' | 'ignorerSelector' | 'containerSelector'> & Partial<Pick<INTERNAL_UmbSorterConfig<T>, 'placeholderClass' | 'ignorerSelector' | 'containerSelector'>>;
+/**
+ * @export
+ * @class UmbSorterController
+ * @implements {UmbControllerInterface}
+ * @description This controller can make user able to sort items.
+ */
+declare class UmbSorterController<T> implements UmbControllerInterface {
+    #private;
+    private _lastIndicationContainerVM;
+    get unique(): string;
+    constructor(host: UmbControllerHostElement, config: UmbSorterConfig<T>);
+    setModel(model: Array<T>): void;
+    hostConnected(): void;
+    private _onFirstRender;
+    hostDisconnected(): void;
+    setupItem(element: HTMLElement): void;
+    destroyItem(element: HTMLElement): void;
+    handleDragStart: (event: DragEvent) => void;
+    handleDragEnd: () => Promise<void>;
+    handleDragMove: (event: DragEvent) => void;
+    moveCurrentElement: () => void;
+    move(orderedContainerElements: Array<Element>, newElIndex: number): void;
+    /** Management methods: */
+    getItemOfElement(element: HTMLElement): T | null | undefined;
+    removeItem(item: T): Promise<boolean | T | null>;
+    hasOtherItemsThan(item: T): boolean;
+    sync(element: HTMLElement, fromVm: UmbSorterController<T>): Promise<boolean>;
+    updateAllowIndication(contextVM: UmbSorterController<T>, item: T): boolean;
+    removeAllowIndication(): void;
+    private autoScrollX;
+    private autoScrollY;
+    private handleAutoScroll;
+    private _performAutoScroll;
+    private stopAutoScroll;
+    notifySync(data: any): void;
+    notifyDisallowed(): void;
+    notifyAllowed(): void;
+    notifyRequestDrop(data: any): boolean;
+    destroy(): void;
+}
+
+export { UmbSorterConfig, UmbSorterController };