@umbraco-cms/backoffice 1.0.0-next.de0ffca0 → 1.0.0-next.f1bd6ec7

package/extensions-api.d.ts

@@ -1,6 +1,7 @@
 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 {
@@ -22,7 +23,7 @@ declare class UmbExtensionRegistry {
 }
 declare const UMB_EXTENSION_REGISTRY_TOKEN: UmbContextToken<UmbExtensionRegistry>;
 
-declare function createExtensionElement(manifest: ManifestElement): Promise<HTMLElement | undefined>;
+declare function createExtensionElement(manifest: ManifestElement): Promise<PageComponent>;
 
 declare function hasDefaultExport<ConstructorType>(object: unknown): object is {
     default: ConstructorType;

package/modal.d.ts

@@ -6,8 +6,9 @@ import { LitElement, TemplateResult } from 'lit';
 import { UUIModalDialogElement, UUIModalSidebarElement, UUIModalSidebarSize } from '@umbraco-ui/uui';
 import { UmbControllerHostElement, UmbControllerInterface } from './controller';
 import { UmbContextToken } from './context-api';
+import { Params } from './router';
 import { UmbModalToken as UmbModalToken$1, UmbModalConfig as UmbModalConfig$1, UmbPickerModalData as UmbPickerModalData$1 } from './modal';
-import { LanguageResponseModel } from './backend-api';
+import { LanguageResponseModel, FolderReponseModel } from './backend-api';
 import { UserDetails } from './models';
 
 declare class UmbSearchModalElement extends LitElement {
@@ -104,7 +105,7 @@ interface UmbModalConfig {
 declare class UmbModalContext {
     #private;
     host: UmbControllerHostElement;
-    readonly modals: rxjs.Observable<UmbModalHandler<object, any>[]>;
+    readonly modals: rxjs.Observable<UmbModalHandler[]>;
     constructor(host: UmbControllerHostElement);
     search(): UmbModalHandler<any, any>;
     /**
@@ -126,316 +127,6 @@ declare class UmbModalContext {
 }
 declare const UMB_MODAL_CONTEXT_TOKEN: UmbContextToken<UmbModalContext>;
 
-interface IRouterSlot<D = any, P = any> extends HTMLElement {
-    readonly route: IRoute<D> | null;
-    readonly isRoot: boolean;
-    readonly fragments: IPathFragments | null;
-    readonly params: Params | null;
-    readonly match: IRouteMatch<D> | null;
-    routes: IRoute<D>[];
-    add: ((routes: IRoute<D>[], navigate?: boolean) => void);
-    clear: (() => void);
-    render: (() => Promise<void>);
-    constructAbsolutePath: ((path: PathFragment) => string);
-    parent: IRouterSlot<P> | null | undefined;
-    queryParentRouterSlot: (() => IRouterSlot<P> | null);
-}
-type IRoutingInfo<D = any, P = any> = {
-    slot: IRouterSlot<D, P>;
-    match: IRouteMatch<D>;
-};
-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 PageComponent = HTMLElement;
-type ModuleResolver = Promise<{
-    default: any;
-}>;
-type Class<T extends PageComponent = PageComponent> = {
-    new (...args: any[]): T;
-};
-type Setup<D = any> = ((component: PageComponent, info: IRoutingInfo<D>) => void);
-type PathMatch = "prefix" | "suffix" | "full" | "fuzzy";
-/**
- * The base route interface.
- * D = the data type of the data
- */
-interface IRouteBase<D = any> {
-    path: PathFragment;
-    data?: D;
-    guards?: Guard[];
-    pathMatch?: PathMatch;
-}
-/**
- * Route type used for redirection.
- */
-interface IRedirectRoute<D = any> extends IRouteBase<D> {
-    redirectTo: string;
-    preserveQuery?: boolean;
-}
-/**
- * Route type used to resolve and stamp components.
- */
-interface IComponentRoute<D = any> extends IRouteBase<D> {
-    component: Class | ModuleResolver | PageComponent | (() => Class) | (() => PageComponent) | (() => ModuleResolver);
-    setup?: Setup;
-}
-/**
- * Route type used to take control of how the route should resolve.
- */
-interface IResolverRoute<D = any> extends IRouteBase<D> {
-    resolve: CustomResolver;
-}
-type IRoute<D = any> = IRedirectRoute<D> | IComponentRoute<D> | IResolverRoute<D>;
-type PathFragment = string;
-type IPathFragments = {
-    consumed: PathFragment;
-    rest: PathFragment;
-};
-interface IRouteMatch<D = any> {
-    route: IRoute<D>;
-    params: Params;
-    fragments: IPathFragments;
-    match: RegExpMatchArray;
-}
-type PushStateEvent = CustomEvent<null>;
-type ReplaceStateEvent = CustomEvent<null>;
-type ChangeStateEvent = CustomEvent<null>;
-type WillChangeStateEvent = CustomEvent<{
-    url?: string | null;
-    eventName: GlobalRouterEvent;
-}>;
-type NavigationStartEvent<D = any> = CustomEvent<IRoutingInfo<D>>;
-type NavigationSuccessEvent<D = any> = CustomEvent<IRoutingInfo<D>>;
-type NavigationCancelEvent<D = any> = CustomEvent<IRoutingInfo<D>>;
-type NavigationErrorEvent<D = any> = CustomEvent<IRoutingInfo<D>>;
-type NavigationEndEvent<D = any> = CustomEvent<IRoutingInfo<D>>;
-type Params = {
-    [key: string]: string;
-};
-/**
- * History related events.
- */
-type GlobalRouterEvent = "pushstate" | "replacestate" | "popstate" | "changestate" | "willchangestate" | "navigationstart" | "navigationcancel" | "navigationerror" | "navigationsuccess" | "navigationend";
-declare global {
-    interface GlobalEventHandlersEventMap {
-        "pushstate": PushStateEvent;
-        "replacestate": ReplaceStateEvent;
-        "popstate": PopStateEvent;
-        "changestate": ChangeStateEvent;
-        "navigationstart": NavigationStartEvent;
-        "navigationend": NavigationEndEvent;
-        "navigationsuccess": NavigationSuccessEvent;
-        "navigationcancel": NavigationCancelEvent;
-        "navigationerror": NavigationErrorEvent;
-        "willchangestate": WillChangeStateEvent;
-    }
-}
-
-/**
- * Slot for a node in the router tree.
- * @slot - Default content.
- * @event changestate - Dispatched when the router slot state changes.
- */
-declare class RouterSlot<D = any, P = any> extends HTMLElement implements IRouterSlot<D, P> {
-    /**
-     * Listeners on the router.
-     */
-    private listeners;
-    /**
-     * The available routes.
-     */
-    private _routes;
-    get routes(): IRoute<D>[];
-    set routes(routes: IRoute<D>[]);
-    /**
-     * The parent router.
-     * Is REQUIRED if this router is a child.
-     * When set, the relevant listeners are added or teared down because they depend on the parent.
-     */
-    _parent: IRouterSlot<P> | null | undefined;
-    get parent(): IRouterSlot<P> | null | undefined;
-    set parent(router: IRouterSlot<P> | null | undefined);
-    /**
-     * Whether the router is a root router.
-     */
-    get isRoot(): boolean;
-    /**
-     * The current route match.
-     */
-    private _routeMatch;
-    get match(): IRouteMatch<D> | null;
-    /**
-     * The current route of the match.
-     */
-    get route(): IRoute<D> | null;
-    /**
-     * The current path fragment of the match
-     */
-    get fragments(): IPathFragments | null;
-    /**
-     * The current params of the match.
-     */
-    get params(): Params | null;
-    /**
-     * Hooks up the element.
-     */
-    constructor();
-    /**
-     * Query the parent router slot when the router slot is connected.
-     */
-    connectedCallback(): void;
-    /**
-     * Tears down the element.
-     */
-    disconnectedCallback(): void;
-    /**
-     * Queries the parent router.
-     */
-    queryParentRouterSlot(): IRouterSlot<P> | null;
-    /**
-     * Returns an absolute path relative to the router slot.
-     * @param path
-     */
-    constructAbsolutePath(path: PathFragment): string;
-    /**
-     * Adds routes to the router.
-     * Navigates automatically if the router slot is the root and is connected.
-     * @param routes
-     * @param navigate
-     */
-    add(routes: IRoute<D>[], navigate?: boolean): void;
-    /**
-     * Removes all routes.
-     */
-    clear(): void;
-    /**
-     * Each time the path changes, load the new path.
-     */
-    render(): Promise<void>;
-    /**
-     * Attaches listeners, either globally or on the parent router.
-     */
-    protected attachListeners(): void;
-    /**
-     * Clears the children in the DOM.
-     */
-    protected clearChildren(): void;
-    /**
-     * Detaches the listeners.
-     */
-    protected detachListeners(): void;
-    /**
-     * Notify the listeners.
-     */
-    notifyChildRouters(info: any): void;
-    /**
-     * Loads a new path based on the routes.
-     * Returns true if a navigation was made to a new page.
-     */
-    protected renderPath(path: string | PathFragment): Promise<boolean>;
-}
-declare global {
-    interface HTMLElementTagNameMap {
-        "router-slot": RouterSlot;
-    }
-}
-
-/**
- * Router link.
- * @slot - Default content.
- */
-declare class RouterLink extends HTMLElement {
-    private listeners;
-    private _context;
-    static get observedAttributes(): string[];
-    /**
-     * The path of the navigation.
-     * @attr
-     */
-    set path(value: string | PathFragment);
-    get path(): string | PathFragment;
-    /**
-     * Whether the element is disabled or not.
-     * @attr
-     */
-    get disabled(): boolean;
-    set disabled(value: boolean);
-    /**
-     * Whether the element is active or not.
-     * @attr
-     */
-    get active(): boolean;
-    set active(value: boolean);
-    /**
-     * Whether the focus should be delegated.
-     * @attr
-     */
-    get delegateFocus(): boolean;
-    set delegateFocus(value: boolean);
-    /**
-     * Whether the query should be preserved or not.
-     * @attr
-     */
-    get preserveQuery(): boolean;
-    set preserveQuery(value: boolean);
-    /**
-     * The current router slot context.
-     */
-    get context(): IRouterSlot | null;
-    set context(value: IRouterSlot | null);
-    /**
-     * Returns the absolute path.
-     */
-    get absolutePath(): string;
-    constructor();
-    /**
-     * Hooks up the element.
-     */
-    connectedCallback(): void;
-    /**
-     * Tear down listeners.
-     */
-    disconnectedCallback(): void;
-    /**
-     * Reacts to attribute changed callback.
-     * @param name
-     * @param oldValue
-     * @param newValue
-     */
-    attributeChangedCallback(name: string, oldValue: unknown, newValue: unknown): void;
-    private updateTabIndex;
-    /**
-     * Returns the absolute path constructed relative to the context.
-     * If no router parent was found the path property is the absolute one.
-     */
-    constructAbsolutePath(path: string): string;
-    /**
-     * Updates whether the route is active or not.
-     */
-    protected updateActive(): void;
-    /**
-     * Navigates to the specified path.
-     */
-    navigate(path: string, e?: Event): void;
-}
-declare global {
-    interface HTMLElementTagNameMap {
-        "router-link": RouterLink;
-    }
-}
-
-declare global {
-    interface History {
-        "native": {
-            "back": ((distance?: any) => void);
-            "forward": ((distance?: any) => void);
-            "go": ((delta?: any) => void);
-            "pushState": ((data: any, title?: string, url?: string | null) => void);
-            "replaceState": ((data: any, title?: string, url?: string | null) => void);
-        };
-    }
-}
-
 type UmbModalRouteBuilder = (params: {
     [key: string]: string | number;
 }) => string;
@@ -478,7 +169,7 @@ declare class UmbModalRouteRegistrationController<D extends object = object, R =
 }
 
 interface UmbAllowedDocumentTypesModalData {
-    key: string | null;
+    id: string | null;
 }
 interface UmbAllowedDocumentTypesModalResult {
     documentTypeKey: string;
@@ -589,8 +280,8 @@ interface UmbImportDictionaryModalData {
     unique: string | null;
 }
 interface UmbImportDictionaryModalResult {
-    fileName?: string;
-    parentKey?: string;
+    temporaryFileId?: string;
+    parentId?: string;
 }
 declare const UMB_IMPORT_DICTIONARY_MODAL: UmbModalToken$1<UmbImportDictionaryModalData, UmbImportDictionaryModalResult>;
 
@@ -674,11 +365,11 @@ interface UmbSectionPickerModalData {
 declare const UMB_SECTION_PICKER_MODAL: UmbModalToken$1<UmbSectionPickerModalData, unknown>;
 
 interface UmbTemplateModalData {
-    key: string;
+    id: string;
     language?: 'razor' | 'typescript' | 'javascript' | 'css' | 'markdown' | 'json' | 'html';
 }
 interface UmbTemplateModalResult {
-    key: string;
+    id: string;
 }
 declare const UMB_TEMPLATE_MODAL: UmbModalToken$1<UmbTemplateModalData, UmbTemplateModalResult>;
 
@@ -695,6 +386,15 @@ declare const UMB_USER_GROUP_PICKER_MODAL: UmbModalToken$1<UmbPickerModalData$1<
 
 declare const UMB_USER_PICKER_MODAL: UmbModalToken$1<UmbPickerModalData$1<UserDetails>, unknown>;
 
+interface UmbFolderModalData {
+    repositoryAlias: string;
+    unique?: string;
+}
+interface UmbFolderModalResult {
+    folder: FolderReponseModel;
+}
+declare const UMB_FOLDER_MODAL: UmbModalToken$1<UmbFolderModalData, UmbFolderModalResult>;
+
 interface UmbPickerModalData<T> {
     multiple: boolean;
     selection: Array<string>;
@@ -704,4 +404,4 @@ interface UmbPickerModalResult<T> {
     selection: Array<string>;
 }
 
-export { OEmbedResult, OEmbedStatus, UMB_ALLOWED_DOCUMENT_TYPES_MODAL, UMB_CHANGE_PASSWORD_MODAL, UMB_CONFIRM_MODAL, UMB_CONTEXT_DEBUGGER_MODAL, UMB_CREATE_DICTIONARY_MODAL, UMB_CREATE_USER_MODAL, UMB_CURRENT_USER_MODAL, UMB_DOCUMENT_PICKER_MODAL, UMB_DOCUMENT_TYPE_PICKER_MODAL, UMB_EMBEDDED_MEDIA_MODAL, UMB_EXAMINE_FIELDS_SETTINGS_MODAL, UMB_EXPORT_DICTIONARY_MODAL, UMB_ICON_PICKER_MODAL, UMB_IMPORT_DICTIONARY_MODAL, UMB_INVITE_USER_MODAL, UMB_LANGUAGE_PICKER_MODAL, UMB_LINK_PICKER_MODAL, UMB_MEDIA_PICKER_MODAL, UMB_MODAL_CONTEXT_TOKEN, UMB_PROPERTY_EDITOR_UI_PICKER_MODAL, UMB_PROPERTY_SETTINGS_MODAL, UMB_SEARCH_MODAL, UMB_SECTION_PICKER_MODAL, UMB_TEMPLATE_MODAL, UMB_TEMPLATE_PICKER_MODAL, UMB_USER_GROUP_PICKER_MODAL, UMB_USER_PICKER_MODAL, UmbAllowedDocumentTypesModalData, UmbAllowedDocumentTypesModalResult, UmbChangePasswordModalData, UmbConfirmModalData, UmbConfirmModalResult, UmbContextDebuggerModalData, UmbCreateDictionaryModalData, UmbCreateDictionaryModalResult, UmbCreateDocumentModalResultData, UmbDocumentPickerModalData, UmbDocumentPickerModalResult, UmbDocumentTypePickerModalData, UmbDocumentTypePickerModalResult, UmbEmbeddedMediaModalData, UmbEmbeddedMediaModalResult, UmbExamineFieldsSettingsModalData, UmbExportDictionaryModalData, UmbExportDictionaryModalResult, UmbIconPickerModalData, UmbIconPickerModalResult, UmbImportDictionaryModalData, UmbImportDictionaryModalResult, UmbLanguagePickerModalData, UmbLanguagePickerModalResult, UmbLinkPickerConfig, UmbLinkPickerLink, UmbLinkPickerModalData, UmbLinkPickerModalResult, UmbMediaPickerModalData, UmbMediaPickerModalResult, UmbModalConfig, UmbModalContext, UmbModalHandler, UmbModalHandlerClass, UmbModalRouteBuilder, UmbModalRouteRegistration, UmbModalRouteRegistrationController, UmbModalToken, UmbModalType, UmbPickerModalData, UmbPickerModalResult, UmbPropertyEditorUIPickerModalData, UmbPropertyEditorUIPickerModalResult, UmbPropertySettingsModalResult, UmbSectionPickerModalData, UmbTemplateModalData, UmbTemplateModalResult, UmbTemplatePickerModalData, UmbTemplatePickerModalResult };
+export { OEmbedResult, OEmbedStatus, UMB_ALLOWED_DOCUMENT_TYPES_MODAL, UMB_CHANGE_PASSWORD_MODAL, UMB_CONFIRM_MODAL, UMB_CONTEXT_DEBUGGER_MODAL, UMB_CREATE_DICTIONARY_MODAL, UMB_CREATE_USER_MODAL, UMB_CURRENT_USER_MODAL, UMB_DOCUMENT_PICKER_MODAL, UMB_DOCUMENT_TYPE_PICKER_MODAL, UMB_EMBEDDED_MEDIA_MODAL, UMB_EXAMINE_FIELDS_SETTINGS_MODAL, UMB_EXPORT_DICTIONARY_MODAL, UMB_FOLDER_MODAL, UMB_ICON_PICKER_MODAL, UMB_IMPORT_DICTIONARY_MODAL, UMB_INVITE_USER_MODAL, UMB_LANGUAGE_PICKER_MODAL, UMB_LINK_PICKER_MODAL, UMB_MEDIA_PICKER_MODAL, UMB_MODAL_CONTEXT_TOKEN, UMB_PROPERTY_EDITOR_UI_PICKER_MODAL, UMB_PROPERTY_SETTINGS_MODAL, UMB_SEARCH_MODAL, UMB_SECTION_PICKER_MODAL, UMB_TEMPLATE_MODAL, UMB_TEMPLATE_PICKER_MODAL, UMB_USER_GROUP_PICKER_MODAL, UMB_USER_PICKER_MODAL, UmbAllowedDocumentTypesModalData, UmbAllowedDocumentTypesModalResult, UmbChangePasswordModalData, UmbConfirmModalData, UmbConfirmModalResult, UmbContextDebuggerModalData, UmbCreateDictionaryModalData, UmbCreateDictionaryModalResult, UmbCreateDocumentModalResultData, UmbDocumentPickerModalData, UmbDocumentPickerModalResult, UmbDocumentTypePickerModalData, UmbDocumentTypePickerModalResult, UmbEmbeddedMediaModalData, UmbEmbeddedMediaModalResult, UmbExamineFieldsSettingsModalData, UmbExportDictionaryModalData, UmbExportDictionaryModalResult, UmbFolderModalData, UmbFolderModalResult, UmbIconPickerModalData, UmbIconPickerModalResult, UmbImportDictionaryModalData, UmbImportDictionaryModalResult, UmbLanguagePickerModalData, UmbLanguagePickerModalResult, UmbLinkPickerConfig, UmbLinkPickerLink, UmbLinkPickerModalData, UmbLinkPickerModalResult, UmbMediaPickerModalData, UmbMediaPickerModalResult, UmbModalConfig, UmbModalContext, UmbModalHandler, UmbModalHandlerClass, UmbModalRouteBuilder, UmbModalRouteRegistration, UmbModalRouteRegistrationController, UmbModalToken, UmbModalType, UmbPickerModalData, UmbPickerModalResult, UmbPropertyEditorUIPickerModalData, UmbPropertyEditorUIPickerModalResult, UmbPropertySettingsModalResult, UmbSectionPickerModalData, UmbTemplateModalData, UmbTemplateModalResult, UmbTemplatePickerModalData, UmbTemplatePickerModalResult };

package/models.d.ts

@@ -3,16 +3,16 @@ import { EntityTreeItemResponseModel, FolderTreeItemResponseModel, PackageManife
 type HTMLElementConstructor<T = HTMLElement> = new (...args: any[]) => T;
 type ClassConstructor<T> = new (...args: any[]) => T;
 interface Entity {
-    key: string;
+    id: string;
     name: string;
     icon: string;
     type: string;
     hasChildren: boolean;
-    parentKey: string | null;
+    parentId: string | null;
 }
 /** Tried to find a common base of our entities — used by Entity Workspace Context */
 type BaseEntity = {
-    key?: string;
+    id?: string;
     name?: string;
 };
 interface UserEntity extends Entity {
@@ -43,23 +43,23 @@ interface UserGroupDetails extends UserGroupEntity {
     permissions: Array<string>;
 }
 interface MemberTypeDetails extends EntityTreeItemResponseModel {
-    key: string;
+    id: string;
     alias: string;
     properties: [];
 }
 interface MediaTypeDetails extends FolderTreeItemResponseModel {
-    key: string;
+    id: string;
     alias: string;
     properties: [];
 }
 interface MemberGroupDetails extends EntityTreeItemResponseModel {
-    key: string;
+    id: string;
 }
 interface MemberDetails extends EntityTreeItemResponseModel {
-    key: string;
+    id: string;
 }
 interface DocumentBlueprintDetails {
-    key: string;
+    id: string;
     name: string;
     type: 'document-blueprint';
     properties: Array<any>;

package/observable-api.d.ts

@@ -98,19 +98,33 @@ declare class DeepState<T> extends BehaviorSubject<T> {
  * The ArrayState provides methods to append data when the data is an Object.
  */
 declare class ArrayState<T> extends DeepState<T[]> {
-    private _getUnique?;
+    #private;
     constructor(initialData: T[], getUniqueMethod?: (entry: T) => unknown);
+    /**
+     * @method sortBy
+     * @param {(a: T, b: T) => number} sortMethod - A method to be used for sorting everytime data is set.
+     * @description - A sort method to this Subject.
+     * @example <caption>Example add sort method</caption>
+     * const data = [
+     * 	{ key: 1, value: 'foo'},
+     * 	{ key: 2, value: 'bar'}
+     * ];
+     * const myState = new ArrayState(data, (x) => x.key);
+     * myState.sortBy((a, b) => (a.sortOrder || 0) - (b.sortOrder || 0));
+     */
+    sortBy(sortMethod?: (a: T, b: T) => number): this;
+    next(value: T[]): void;
     /**
      * @method remove
      * @param {unknown[]} uniques - The unique values to remove.
      * @return {ArrayState<T>} Reference to it self.
      * @description - Remove some new data of this Subject.
-     * @example <caption>Example remove entry with key '1' and '2'</caption>
+     * @example <caption>Example remove entry with id '1' and '2'</caption>
      * const data = [
-     * 	{ key: 1, value: 'foo'},
-     * 	{ key: 2, value: 'bar'}
+     * 	{ id: 1, value: 'foo'},
+     * 	{ id: 2, value: 'bar'}
      * ];
-     * const myState = new ArrayState(data, (x) => x.key);
+     * const myState = new ArrayState(data, (x) => x.id);
      * myState.remove([1, 2]);
      */
     remove(uniques: unknown[]): this;
@@ -119,12 +133,12 @@ declare class ArrayState<T> extends DeepState<T[]> {
      * @param {unknown} unique - The unique value to remove.
      * @return {ArrayState<T>} Reference to it self.
      * @description - Remove some new data of this Subject.
-     * @example <caption>Example remove entry with key '1'</caption>
+     * @example <caption>Example remove entry with id '1'</caption>
      * const data = [
-     * 	{ key: 1, value: 'foo'},
-     * 	{ key: 2, value: 'bar'}
+     * 	{ id: 1, value: 'foo'},
+     * 	{ id: 2, value: 'bar'}
      * ];
-     * const myState = new ArrayState(data, (x) => x.key);
+     * const myState = new ArrayState(data, (x) => x.id);
      * myState.removeOne(1);
      */
     removeOne(unique: unknown): this;
@@ -241,8 +255,8 @@ declare function createObservablePart<R, T>(source$: Observable<T>, mappingFunct
  * @param {(previousResult: R, currentResult: R) => boolean} [memoizationFunction] - Method to Compare if the data has changed. Should return true when data is different.
  * @description - Creates a RxJS Observable from RxJS Subject.
  * @example <caption>Example append new entry for a ArrayState or a part of DeepState/ObjectState it which is an array. Where the key is unique and the item will be updated if matched with existing.</caption>
- * const entry = {key: 'myKey', value: 'myValue'};
- * const newDataSet = appendToFrozenArray(mySubject.getValue(), entry, x => x.key === key);
+ * const entry = {id: 'myKey', value: 'myValue'};
+ * const newDataSet = appendToFrozenArray(mySubject.getValue(), entry, x => x.id === id);
  * mySubject.next(newDataSet);
  */
 declare function appendToFrozenArray<T>(data: T[], entry: T, getUniqueMethod?: (entry: T) => unknown): T[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@umbraco-cms/backoffice",
-	"version": "1.0.0-next.de0ffca0",
+	"version": "1.0.0-next.f1bd6ec7",
 	"license": "MIT",
 	"keywords": [
 		"umbraco",

package/repository.d.ts

@@ -1,4 +1,4 @@
-import { ProblemDetailsModel } from './backend-api';
+import { ProblemDetailsModel, FolderReponseModel, CreateFolderRequestModel, UpdateFolderReponseModel, FolderModelBaseModel } from './backend-api';
 import { DataSourceResponse as DataSourceResponse$1 } from './repository';
 import { Observable } from 'rxjs';
 
@@ -7,12 +7,20 @@ interface DataSourceResponse<T = undefined> {
     error?: ProblemDetailsModel;
 }
 
-interface UmbDataSource<T> {
-    createScaffold(parentKey: string | null): Promise<DataSourceResponse$1<T>>;
-    get(key: string): Promise<DataSourceResponse$1<T>>;
-    insert(data: T): Promise<DataSourceResponse$1<T>>;
-    update(data: T): Promise<DataSourceResponse$1<T>>;
-    delete(key: string): Promise<DataSourceResponse$1<T>>;
+interface UmbDataSource<CreateRequestType, UpdateRequestType, ResponseType> {
+    createScaffold(parentId: string | null): Promise<DataSourceResponse$1<CreateRequestType>>;
+    get(unique: string): Promise<DataSourceResponse$1<ResponseType>>;
+    insert(data: CreateRequestType): Promise<any>;
+    update(unique: string, data: UpdateRequestType): Promise<DataSourceResponse$1<ResponseType>>;
+    delete(unique: string): Promise<DataSourceResponse$1>;
+}
+
+interface UmbFolderDataSource {
+    createScaffold(parentId: string | null): Promise<DataSourceResponse<FolderReponseModel>>;
+    get(unique: string): Promise<DataSourceResponse<FolderReponseModel>>;
+    insert(data: CreateFolderRequestModel): Promise<DataSourceResponse<string>>;
+    update(unique: string, data: CreateFolderRequestModel): Promise<DataSourceResponse<UpdateFolderReponseModel>>;
+    delete(unique: string): Promise<DataSourceResponse>;
 }
 
 interface UmbTreeDataSource<PagedItemsType = any, ItemsType = any> {
@@ -21,24 +29,18 @@ interface UmbTreeDataSource<PagedItemsType = any, ItemsType = any> {
     getItems(unique: Array<string>): Promise<DataSourceResponse$1<Array<ItemsType>>>;
 }
 
-interface UmbDetailRepository<DetailType> {
-    createScaffold(parentKey: string | null): Promise<{
-        data?: DetailType;
-        error?: ProblemDetailsModel;
-    }>;
-    requestByKey(key: string): Promise<{
-        data?: DetailType;
-        error?: ProblemDetailsModel;
-    }>;
-    create(data: DetailType): Promise<{
-        error?: ProblemDetailsModel;
-    }>;
-    save(data: DetailType): Promise<{
-        error?: ProblemDetailsModel;
-    }>;
-    delete(key: string): Promise<{
-        error?: ProblemDetailsModel;
-    }>;
+interface UmbRepositoryErrorResponse {
+    error?: ProblemDetailsModel;
+}
+interface UmbRepositoryResponse<T> extends UmbRepositoryErrorResponse {
+    data?: T;
+}
+interface UmbDetailRepository<CreateRequestType = any, UpdateRequestType = any, ResponseType = any> {
+    createScaffold(parentId: string | null): Promise<UmbRepositoryResponse<CreateRequestType>>;
+    requestById(id: string): Promise<UmbRepositoryResponse<ResponseType>>;
+    create(data: CreateRequestType): Promise<UmbRepositoryErrorResponse>;
+    save(id: string, data: UpdateRequestType): Promise<UmbRepositoryErrorResponse>;
+    delete(id: string): Promise<UmbRepositoryErrorResponse>;
 }
 
 interface UmbPagedData<T> {
@@ -66,4 +68,26 @@ interface UmbTreeRepository<ItemType = any, PagedItemType = UmbPagedData<ItemTyp
     treeItems: (uniques: string[]) => Promise<Observable<ItemType[]>>;
 }
 
-export { DataSourceResponse, UmbDataSource, UmbDetailRepository, UmbPagedData, UmbTreeDataSource, UmbTreeRepository };
+interface UmbFolderRepository {
+    createFolderScaffold(parentId: string | null): Promise<{
+        data?: FolderReponseModel;
+        error?: ProblemDetailsModel;
+    }>;
+    createFolder(folderRequest: CreateFolderRequestModel): Promise<{
+        data?: string;
+        error?: ProblemDetailsModel;
+    }>;
+    requestFolder(unique: string): Promise<{
+        data?: FolderReponseModel;
+        error?: ProblemDetailsModel;
+    }>;
+    updateFolder(unique: string, folder: FolderModelBaseModel): Promise<{
+        data?: UpdateFolderReponseModel;
+        error?: ProblemDetailsModel;
+    }>;
+    deleteFolder(id: string): Promise<{
+        error?: ProblemDetailsModel;
+    }>;
+}
+
+export { DataSourceResponse, UmbDataSource, UmbDetailRepository, UmbFolderDataSource, UmbFolderRepository, UmbPagedData, UmbRepositoryErrorResponse, UmbRepositoryResponse, UmbTreeDataSource, UmbTreeRepository };