@umbraco-cms/backoffice 1.0.0-next.23b74307 → 1.0.0-next.264a3c21

package/extension-registry.d.ts

@@ -0,0 +1,472 @@
+import { ManifestElement, ManifestWithConditions, ManifestBase, ManifestClass, ManifestWithLoader, ClassConstructor, ManifestWithView, MetaManifestWithView, ManifestEntryPoint, ManifestKind, UmbExtensionRegistry } from '@umbraco-cms/backoffice/extension-api';
+import { UmbModalHandler } from '@umbraco-cms/backoffice/modal';
+import { DataTypePropertyPresentationModel, TreeItemPresentationModel } from '@umbraco-cms/backoffice/backend-api';
+import { UmbStoreBase, UmbTreeStore, UmbItemStore } from '@umbraco-cms/backoffice/store';
+import { InterfaceLook, InterfaceColor } from '@umbraco-ui/uui-base/lib/types/index';
+import { UmbWorkspaceAction } from '@umbraco-cms/backoffice/workspace';
+
+interface ManifestCollectionView extends ManifestElement, ManifestWithConditions<ConditionsCollectionView> {
+    type: 'collectionView';
+    meta: MetaCollectionView;
+}
+interface MetaCollectionView {
+    /**
+     * The friendly name of the collection view
+     */
+    label: string;
+    /**
+     * An icon to represent the collection view
+     *
+     * @examples [
+     *   "umb:box",
+     *   "umb:grid"
+     * ]
+     */
+    icon: string;
+    /**
+     * The URL pathname for this collection view that can be deep linked to by sharing the url
+     */
+    pathName: string;
+}
+interface ConditionsCollectionView {
+    entityType: string;
+}
+
+interface ManifestDashboard extends ManifestElement<UmbDashboardExtensionElement>, ManifestWithConditions<ConditionsDashboard> {
+    type: 'dashboard';
+    meta: MetaDashboard;
+}
+interface MetaDashboard {
+    /**
+     * This is the URL path for the dashboard which is used for navigating or deep linking directly to the dashboard
+     * https://yoursite.com/section/settings/dashboard/my-dashboard-path
+     *
+     * @example my-dashboard-path
+     * @examples [
+     *  "my-dashboard-path"
+     * ]
+     */
+    pathname: string;
+    /**
+     * The displayed name (label) for the tab of the dashboard
+     */
+    label?: string;
+}
+interface ConditionsDashboard {
+    /**
+     * An array of section aliases that the dashboard should be available in
+     *
+     * @uniqueItems true
+     * @minItems 1
+     * @items.examples [
+     *   "Umb.Section.Content",
+     *   "Umb.Section.Settings"
+     * ]
+     *
+     */
+    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;
+}
+
+/**
+ * An action to perform on an entity
+ * For example for content you may wish to create a new document etc
+ */
+interface ManifestEntityAction extends ManifestElement {
+    type: 'entityAction';
+    meta: MetaEntityAction;
+    conditions: ConditionsEntityAction;
+}
+interface MetaEntityAction {
+    /**
+     * An icon to represent the action to be performed
+     *
+     * @examples [
+     *   "umb:box",
+     *   "umb:grid"
+     * ]
+     */
+    icon?: string;
+    /**
+     * The friendly name of the action to perform
+     *
+     * @examples [
+     *   "Create",
+     *   "Create Content Template"
+     * ]
+     */
+    label: string;
+    /**
+     * @TJS-ignore
+     */
+    api: any;
+    /**
+     * The alias for the repsoitory of the entity type this action is for
+     * such as 'Umb.Repository.Documents'
+     * @examples [
+     *   "Umb.Repository.Documents"
+     * ]
+     */
+    repositoryAlias: string;
+}
+interface ConditionsEntityAction {
+    entityTypes: Array<string>;
+}
+
+/**
+ * An action to perform on multiple entities
+ * For example for content you may wish to move one or more documents in bulk
+ */
+interface ManifestEntityBulkAction extends ManifestElement, ManifestWithConditions<ConditionsEntityBulkAction> {
+    type: 'entityBulkAction';
+    meta: MetaEntityBulkAction;
+}
+interface MetaEntityBulkAction {
+    /**
+     * A friendly label for the action
+     */
+    label: string;
+    /**
+     * @TJS-ignore
+     */
+    api: any;
+    /**
+     * The alias for the repsoitory of the entity type this action is for
+     * such as 'Umb.Repository.Documents'
+     *
+     * @examples [
+     *   "Umb.Repository.Documents"
+     * ]
+     */
+    repositoryAlias: string;
+}
+interface ConditionsEntityBulkAction {
+    entityType: string;
+}
+
+interface UmbExternalLoginProviderExtensionElement extends HTMLElement {
+    manifest?: ManifestExternalLoginProvider;
+}
+
+interface ManifestExternalLoginProvider extends ManifestElement<UmbExternalLoginProviderExtensionElement> {
+    type: 'externalLoginProvider';
+    meta: MetaExternalLoginProvider;
+}
+interface MetaExternalLoginProvider {
+    label: string;
+    pathname: string;
+}
+
+/**
+ * Header apps are displayed in the top right corner of the backoffice
+ * The two provided header apps are the search and the user menu
+ */
+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 ManifestMenu extends ManifestElement {
+    type: 'menu';
+}
+
+interface UmbMenuItemExtensionElement extends HTMLElement {
+    manifest?: ManifestMenuItem;
+}
+
+interface ManifestMenuItem extends ManifestElement<UmbMenuItemExtensionElement> {
+    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 ManifestModal extends ManifestElement {
+    type: 'modal';
+}
+
+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<UmbPropertyEditorExtensionElement> {
+    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 ManifestRepository extends ManifestClass<unknown> {
+    type: 'repository';
+}
+
+interface ManifestSection extends ManifestElement<UmbSectionExtensionElement> {
+    type: 'section';
+    meta: MetaSection;
+}
+interface MetaSection {
+    label: string;
+    pathname: string;
+}
+
+interface UmbSectionSidebarAppExtensionElement extends HTMLElement {
+    manifest?: ManifestSectionSidebarApp;
+}
+
+interface ManifestSectionSidebarApp extends ManifestElement<UmbSectionSidebarAppExtensionElement> {
+    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 UmbSectionViewExtensionElement extends HTMLElement {
+    manifest?: ManifestSectionView;
+}
+
+interface ManifestSectionView extends ManifestElement<UmbSectionViewExtensionElement>, ManifestWithConditions<ConditionsSectionView> {
+    type: 'sectionView';
+    meta: MetaSectionView;
+}
+interface MetaSectionView {
+    label: string;
+    pathname: string;
+    icon: string;
+}
+interface ConditionsSectionView {
+    sections: Array<string>;
+}
+
+interface ManifestStore extends ManifestClass<UmbStoreBase> {
+    type: 'store';
+}
+interface ManifestTreeStore extends ManifestClass<UmbTreeStore> {
+    type: 'treeStore';
+}
+interface ManifestItemStore extends ManifestClass<UmbItemStore> {
+    type: 'itemStore';
+}
+
+/**
+ * Theme manifest for styling the backoffice of Umbraco such as dark, high contrast etc
+ */
+interface ManifestTheme extends ManifestWithLoader<string> {
+    type: 'theme';
+    /**
+     * File location of the CSS file of the theme
+     *
+     * @examples ["themes/dark.theme.css"]
+     */
+    css?: string;
+}
+
+interface ManifestTree extends ManifestBase {
+    type: 'tree';
+    meta: MetaTree;
+}
+interface MetaTree {
+    repositoryAlias: string;
+}
+
+interface ManifestTreeItem extends ManifestElement<UmbTreeItemExtensionElement> {
+    type: 'treeItem';
+    conditions: ConditionsTreeItem;
+}
+interface ConditionsTreeItem {
+    entityTypes: Array<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 UmbWorkspaceEditorViewExtensionElement extends HTMLElement {
+    manifest?: ManifestWorkspaceEditorView;
+}
+
+interface ManifestWorkspaceEditorView extends ManifestWithView<UmbWorkspaceEditorViewExtensionElement> {
+    type: 'workspaceEditorView';
+    conditions: ConditionsWorkspaceView;
+}
+interface ConditionsWorkspaceView {
+    workspaces: string[];
+}
+
+interface ManifestWorkspaceViewCollection extends ManifestWithView, ManifestWithConditions<ConditionsEditorViewCollection> {
+    type: 'workspaceViewCollection';
+    meta: MetaEditorViewCollection;
+}
+interface MetaEditorViewCollection extends MetaManifestWithView {
+    entityType: string;
+    repositoryAlias: string;
+}
+interface ConditionsEditorViewCollection {
+    workspaces: string[];
+}
+
+type ManifestTypes = ManifestCollectionView | ManifestDashboard | ManifestDashboardCollection | ManifestEntityAction | ManifestEntityBulkAction | ManifestEntryPoint | ManifestExternalLoginProvider | ManifestHeaderApp | ManifestHeaderAppButtonKind | ManifestHealthCheck | ManifestItemStore | ManifestMenu | ManifestMenuItem | ManifestMenuItemTreeKind | ManifestModal | ManifestPackageView | ManifestPropertyAction | ManifestPropertyEditorModel | ManifestPropertyEditorUI | ManifestRepository | ManifestSection | ManifestSectionSidebarApp | ManifestSectionSidebarAppMenuKind | ManifestSectionView | ManifestStore | ManifestTheme | ManifestTree | ManifestTreeItem | ManifestTreeStore | ManifestUserProfileApp | ManifestWorkspace | ManifestWorkspaceAction | ManifestWorkspaceEditorView | ManifestWorkspaceViewCollection | ManifestBase;
+
+interface UmbDashboardExtensionElement extends HTMLElement {
+    manifest?: ManifestDashboard;
+}
+
+interface UmbModalExtensionElement<UmbModalData extends object = object, UmbModalResult = unknown, ModalManifestType extends ManifestModal = ManifestModal> extends HTMLElement {
+    manifest?: ModalManifestType;
+    modalHandler?: UmbModalHandler<UmbModalData, UmbModalResult>;
+    data?: UmbModalData;
+}
+
+interface UmbPropertyEditorExtensionElement extends HTMLElement {
+    value: unknown;
+    config: DataTypePropertyPresentationModel[];
+}
+
+interface UmbSectionExtensionElement extends HTMLElement {
+    manifest?: ManifestSection;
+}
+
+interface UmbTreeItemExtensionElement extends HTMLElement {
+    item?: TreeItemPresentationModel;
+}
+
+type UmbBackofficeManifestKind = ManifestKind<ManifestTypes>;
+type UmbBackofficeExtensionRegistry = UmbExtensionRegistry<ManifestTypes>;
+declare const umbExtensionsRegistry: UmbBackofficeExtensionRegistry;
+
+export { ConditionsCollectionView, ConditionsDashboard, ConditionsDashboardCollection, ConditionsEditorViewCollection, ConditionsEntityAction, ConditionsEntityBulkAction, ConditionsMenuItem, ConditionsPropertyAction, ConditionsSectionSidebarApp, ConditionsSectionView, ConditionsTreeItem, ConditionsWorkspaceAction, ConditionsWorkspaceView, HealthCheck, ManifestCollectionView, ManifestDashboard, ManifestDashboardCollection, ManifestEntityAction, ManifestEntityBulkAction, ManifestExternalLoginProvider, ManifestHeaderApp, ManifestHeaderAppButtonKind, ManifestHealthCheck, ManifestItemStore, ManifestMenu, ManifestMenuItem, ManifestMenuItemTreeKind, ManifestModal, ManifestPackageView, ManifestPropertyAction, ManifestPropertyEditorModel, ManifestPropertyEditorUI, ManifestRepository, ManifestSection, ManifestSectionSidebarApp, ManifestSectionSidebarAppMenuKind, ManifestSectionView, ManifestStore, ManifestTheme, ManifestTree, ManifestTreeItem, ManifestTreeStore, ManifestTypes, ManifestUserProfileApp, ManifestWorkspace, ManifestWorkspaceAction, ManifestWorkspaceEditorView, ManifestWorkspaceViewCollection, MetaCollectionView, MetaDashboard, MetaDashboardCollection, MetaEditor, MetaEditorViewCollection, MetaEntityAction, MetaEntityBulkAction, MetaExternalLoginProvider, MetaHeaderApp, MetaHeaderAppButtonKind, MetaHealthCheck, MetaMenuItem, MetaMenuItemTreeKind, MetaPackageView, MetaPropertyEditorModel, MetaPropertyEditorUI, MetaSection, MetaSectionSidebarAppMenuKind, MetaSectionView, MetaTree, MetaUserProfileApp, MetaWorkspaceAction, PropertyEditorConfig, PropertyEditorConfigDefaultData, PropertyEditorConfigProperty, UmbBackofficeExtensionRegistry, UmbBackofficeManifestKind, UmbDashboardExtensionElement, UmbExternalLoginProviderExtensionElement, UmbMenuItemExtensionElement, UmbModalExtensionElement, UmbPropertyEditorExtensionElement, UmbSectionExtensionElement, UmbSectionSidebarAppExtensionElement, UmbSectionViewExtensionElement, UmbTreeItemExtensionElement, UmbWorkspaceEditorViewExtensionElement, umbExtensionsRegistry };

package/id.d.ts

@@ -0,0 +1,6 @@
+declare class UmbId {
+    static new(): string;
+    static validate(id: string): boolean;
+}
+
+export { UmbId };