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

package/{element.d.ts → element-api.d.ts}

@@ -1,8 +1,8 @@
 import { Observable } from 'rxjs';
-import { HTMLElementConstructor } from './models';
-import { UmbControllerHostElement } from './controller';
-import { UmbContextToken, UmbContextProviderController, UmbContextCallback, UmbContextConsumerController } from './context-api';
-import { UmbObserverController } from './observable-api';
+import { HTMLElementConstructor } from '@umbraco-cms/backoffice/extension-api';
+import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller-api';
+import { UmbContextToken, UmbContextProviderController, UmbContextCallback, UmbContextConsumerController } from '@umbraco-cms/backoffice/context-api';
+import { UmbObserverController } from '@umbraco-cms/backoffice/observable-api';
 
 interface ResolvedContexts {
     [key: string]: any;

package/entity-action.d.ts

@@ -1,6 +1,6 @@
-import { UmbControllerHostElement } from './controller';
-import { UmbEntityActionBase as UmbEntityActionBase$1 } from './entity-action';
-import { UmbFolderRepository } from './repository';
+import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller-api';
+import { UmbEntityActionBase as UmbEntityActionBase$1 } from '@umbraco-cms/backoffice/entity-action';
+import { UmbDetailRepository, UmbItemRepository, UmbFolderRepository } from '@umbraco-cms/backoffice/repository';
 
 interface UmbAction<RepositoryType = unknown> {
     host: UmbControllerHostElement;
@@ -39,19 +39,13 @@ declare class UmbCopyEntityAction<T extends {
     execute(): Promise<void>;
 }
 
-declare class UmbDeleteEntityAction<T extends {
-    delete(unique: string): Promise<void>;
-    requestTreeItems(uniques: Array<string>): any;
-}> extends UmbEntityActionBase$1<T> {
+declare class UmbDeleteEntityAction<T extends UmbDetailRepository & UmbItemRepository<any>> extends UmbEntityActionBase$1<T> {
     #private;
     constructor(host: UmbControllerHostElement, repositoryAlias: string, unique: string);
     execute(): Promise<void>;
 }
 
-declare class UmbDeleteFolderEntityAction<T extends {
-    deleteFolder(unique: string): Promise<void>;
-    requestTreeItems(uniques: Array<string>): any;
-}> extends UmbEntityActionBase$1<T> {
+declare class UmbDeleteFolderEntityAction<T extends UmbFolderRepository> extends UmbEntityActionBase$1<T> {
     #private;
     constructor(host: UmbControllerHostElement, repositoryAlias: string, unique: string);
     execute(): Promise<void>;
@@ -77,9 +71,8 @@ declare class UmbSortChildrenOfEntityAction<T extends {
     execute(): Promise<void>;
 }
 
-declare class UmbTrashEntityAction<T extends {
+declare class UmbTrashEntityAction<T extends UmbItemRepository<any> & {
     trash(unique: Array<string>): Promise<void>;
-    requestTreeItems(uniques: Array<string>): any;
 }> extends UmbEntityActionBase$1<T> {
     #private;
     constructor(host: UmbControllerHostElement, repositoryAlias: string, unique: string);

package/extension-api.d.ts

@@ -0,0 +1,200 @@
+import { Observable } from 'rxjs';
+import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller-api';
+
+type HTMLElementConstructor<T = HTMLElement> = new (...args: any[]) => T;
+type ClassConstructor<T> = new (...args: any[]) => T;
+type ManifestTypeMap<ManifestTypes extends ManifestBase> = {
+    [Manifest in ManifestTypes as Manifest['type']]: Manifest;
+} & {
+    [key: string]: ManifestBase;
+};
+type SpecificManifestTypeOrManifestBase<ManifestTypes extends ManifestBase, T extends keyof ManifestTypeMap<ManifestTypes> | string> = T extends keyof ManifestTypeMap<ManifestTypes> ? ManifestTypeMap<ManifestTypes>[T] : ManifestBase;
+interface ManifestBase {
+    /**
+     * The type of extension such as dashboard etc...
+     */
+    type: string;
+    /**
+     * The alias of the extension, ensure it is unique
+     */
+    alias: string;
+    /**
+     * The kind of the extension, used to group extensions together
+     *
+     * @examples ["button"]
+     */
+    kind?: unknown;
+    /**
+     * The friendly name of the extension
+     */
+    name: string;
+    /**
+     * Extensions such as dashboards are ordered by weight with lower numbers being first in the list
+     */
+    weight?: number;
+}
+interface ManifestKind<ManifestTypes> {
+    type: 'kind';
+    alias: string;
+    matchType: string;
+    matchKind: string;
+    manifest: Partial<ManifestTypes>;
+}
+interface ManifestWithConditions<ConditionsType> {
+    /**
+     * Set the conditions for when the extension should be loaded
+     */
+    conditions: ConditionsType;
+}
+interface ManifestWithLoader<LoaderReturnType> extends ManifestBase {
+    /**
+     * @TJS-ignore
+     */
+    loader?: () => Promise<LoaderReturnType>;
+}
+/**
+ * The type of extension such as dashboard etc...
+ */
+interface ManifestClass<ClassType = unknown> extends ManifestWithLoader<{
+    default: ClassConstructor<ClassType>;
+}> {
+    readonly CLASS_TYPE?: ClassType;
+    /**
+     * The file location of the javascript file to load
+     * @TJS-required
+     */
+    js?: string;
+    /**
+     * @TJS-ignore
+     */
+    className?: string;
+    /**
+     * @TJS-ignore
+     */
+    class?: ClassConstructor<ClassType>;
+}
+interface ManifestClassWithClassConstructor<T = unknown> extends ManifestClass<T> {
+    class: ClassConstructor<T>;
+}
+interface ManifestElement<ElementType extends HTMLElement = HTMLElement> extends ManifestWithLoader<{
+    default: ClassConstructor<ElementType>;
+} | Omit<object, 'default'>> {
+    readonly ELEMENT_TYPE?: ElementType;
+    /**
+     * The file location of the javascript file to load
+     *
+     * @TJS-require
+     */
+    js?: string;
+    /**
+     * The HTML web component name to use such as 'my-dashboard'
+     * Note it is NOT <my-dashboard></my-dashboard> but just the name
+     */
+    elementName?: string;
+    /**
+     * This contains properties specific to the type of extension
+     */
+    meta?: unknown;
+}
+interface ManifestWithView<ElementType extends HTMLElement = HTMLElement> extends ManifestElement<ElementType> {
+    meta: MetaManifestWithView;
+}
+interface MetaManifestWithView {
+    pathname: string;
+    label: string;
+    icon: string;
+}
+interface ManifestElementWithElementName extends ManifestElement {
+    /**
+     * The HTML web component name to use such as 'my-dashboard'
+     * Note it is NOT <my-dashboard></my-dashboard> but just the name
+     */
+    elementName: string;
+}
+interface ManifestWithMeta extends ManifestBase {
+    /**
+     * This contains properties specific to the type of extension
+     */
+    meta: unknown;
+}
+/**
+ * This type of extension gives full control and will simply load the specified JS file
+ * You could have custom logic to decide which extensions to load/register by using extensionRegistry
+ */
+interface ManifestEntryPoint extends ManifestBase {
+    type: 'entryPoint';
+    /**
+     * The file location of the javascript file to load in the backoffice
+     */
+    js: string;
+}
+
+declare class UmbExtensionRegistry<IncomingManifestTypes extends ManifestBase, ManifestTypes extends ManifestBase = IncomingManifestTypes | ManifestBase> {
+    private _extensions;
+    readonly extensions: Observable<ManifestTypes[]>;
+    private _kinds;
+    readonly kinds: Observable<ManifestKind<ManifestTypes>[]>;
+    defineKind(kind: ManifestKind<ManifestTypes>): void;
+    register(manifest: ManifestTypes | ManifestKind<ManifestTypes>): void;
+    registerMany(manifests: Array<ManifestTypes | ManifestKind<ManifestTypes>>): void;
+    unregister(alias: string): void;
+    isRegistered(alias: string): boolean;
+    private _kindsOfType;
+    private _extensionsOfType;
+    private _kindsOfTypes;
+    private _extensionsOfTypes;
+    getByTypeAndAlias<Key extends keyof ManifestTypeMap<ManifestTypes> | string, T extends ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>>(type: Key, alias: string): Observable<T | undefined>;
+    extensionsOfType<Key extends keyof ManifestTypeMap<ManifestTypes> | string, T extends ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>>(type: Key): Observable<T[]>;
+    extensionsOfTypes<ExtensionTypes extends ManifestBase = ManifestBase>(types: string[]): Observable<Array<ExtensionTypes>>;
+}
+
+declare function isManifestClassConstructorType(manifest: unknown): manifest is ManifestClassWithClassConstructor;
+
+declare function isManifestClassableType(manifest: ManifestBase): manifest is ManifestClass;
+
+declare function isManifestElementNameType(manifest: unknown): manifest is ManifestElementWithElementName;
+
+declare function isManifestElementableType<ElementType extends HTMLElement = HTMLElement>(manifest: ManifestBase): manifest is ManifestElement;
+
+type ManifestJSType<T> = ManifestWithLoader<T> & {
+    js: string;
+};
+declare function isManifestJSType<T>(manifest: ManifestBase | unknown): manifest is ManifestJSType<T>;
+
+type ManifestLoaderType<T> = ManifestWithLoader<T> & {
+    loader: () => Promise<T>;
+};
+declare function isManifestLoaderType<T>(manifest: ManifestBase): manifest is ManifestLoaderType<T>;
+
+declare function createExtensionElement<ElementType extends HTMLElement>(manifest: ManifestElement<ElementType>): Promise<ElementType | undefined>;
+
+declare function hasDefaultExport<ConstructorType>(object: unknown): object is {
+    default: ConstructorType;
+};
+
+type UmbEntryPointOnInit = (host: UmbControllerHostElement, extensionRegistry: UmbExtensionRegistry<ManifestBase>) => void;
+/**
+ * Interface containing supported life-cycle functions for ESModule entry points
+ */
+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 loadExtension<T = unknown>(manifest: ManifestWithLoader<T>): Promise<T | null>;
+
+declare function createExtensionElementOrFallback(manifest: any, fallbackElementName: string): Promise<HTMLElement | undefined>;
+
+declare function createExtensionClass<T = unknown>(manifest: ManifestClass, constructorArguments: unknown[]): Promise<T | undefined>;
+
+declare class UmbEntryPointExtensionInitializer {
+    #private;
+    constructor(host: UmbControllerHostElement, extensionRegistry: UmbExtensionRegistry<ManifestEntryPoint>);
+    instantiateEntryPoint(manifest: ManifestEntryPoint): Promise<void>;
+}
+
+export { ClassConstructor, HTMLElementConstructor, ManifestBase, ManifestClass, ManifestClassWithClassConstructor, ManifestElement, ManifestElementWithElementName, ManifestEntryPoint, ManifestJSType, ManifestKind, ManifestLoaderType, ManifestTypeMap, ManifestWithConditions, ManifestWithLoader, ManifestWithMeta, ManifestWithView, MetaManifestWithView, SpecificManifestTypeOrManifestBase, UmbEntryPointExtensionInitializer, UmbEntryPointModule, UmbEntryPointOnInit, UmbExtensionRegistry, createExtensionClass, createExtensionElement, createExtensionElementOrFallback, hasDefaultExport, hasInitExport, isManifestClassConstructorType, isManifestClassableType, isManifestElementNameType, isManifestElementableType, isManifestJSType, isManifestLoaderType, loadExtension };