@umbraco-cms/backoffice 1.0.0-next.37dcc47c → 1.0.0-next.426eb58e
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -8
- package/backend-api.d.ts +596 -280
- package/context-api.d.ts +76 -6
- package/controller.d.ts +7 -6
- package/custom-elements.json +8234 -0
- package/element.d.ts +6 -6
- package/entity-action.d.ts +29 -19
- package/extensions-api.d.ts +7 -5
- package/extensions-registry.d.ts +188 -20
- package/modal.d.ts +298 -17
- package/models.d.ts +14 -9
- package/notification.d.ts +1 -1
- package/observable-api.d.ts +90 -49
- package/package.json +6 -3
- package/picker-input.d.ts +24 -0
- package/property-editor.d.ts +1 -1
- package/repository.d.ts +99 -40
- package/resources.d.ts +25 -16
- package/router.d.ts +375 -0
- package/sorter.d.ts +103 -0
- package/store.d.ts +93 -52
- package/umbraco-package-schema.json +2439 -0
- package/utils.d.ts +4 -2
- package/vscode-html-custom-data.json +3351 -0
- package/workspace.d.ts +19 -12
package/element.d.ts
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
import { Observable } from 'rxjs';
|
|
2
|
-
import { HTMLElementConstructor } from '
|
|
3
|
-
import {
|
|
4
|
-
import { UmbContextToken, UmbContextProviderController, UmbContextCallback, UmbContextConsumerController } from '
|
|
5
|
-
import { UmbObserverController } from '
|
|
2
|
+
import { HTMLElementConstructor } from '@umbraco-cms/backoffice/models';
|
|
3
|
+
import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
|
|
4
|
+
import { UmbContextToken, UmbContextProviderController, UmbContextCallback, UmbContextConsumerController } from '@umbraco-cms/backoffice/context-api';
|
|
5
|
+
import { UmbObserverController } from '@umbraco-cms/backoffice/observable-api';
|
|
6
6
|
|
|
7
7
|
interface ResolvedContexts {
|
|
8
8
|
[key: string]: any;
|
|
9
9
|
}
|
|
10
|
-
declare class UmbElementMixinInterface extends
|
|
10
|
+
declare class UmbElementMixinInterface extends UmbControllerHostElement {
|
|
11
11
|
observe<T>(source: Observable<T>, callback: (_value: T) => void, unique?: string): UmbObserverController<T>;
|
|
12
12
|
provideContext<R = unknown>(alias: string | UmbContextToken<R>, instance: R): UmbContextProviderController<R>;
|
|
13
13
|
consumeContext<R = unknown>(alias: string | UmbContextToken<R>, callback: UmbContextCallback<R>): UmbContextConsumerController<R>;
|
|
14
14
|
consumeAllContexts(contextAliases: string[], callback: (_instances: ResolvedContexts) => void): void;
|
|
15
15
|
}
|
|
16
|
-
declare const UmbElementMixin: <T extends HTMLElementConstructor
|
|
16
|
+
declare const UmbElementMixin: <T extends HTMLElementConstructor>(superClass: T) => HTMLElementConstructor<UmbElementMixinInterface> & T;
|
|
17
17
|
|
|
18
18
|
export { UmbElementMixin, UmbElementMixinInterface };
|
package/entity-action.d.ts
CHANGED
|
@@ -1,15 +1,16 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { UmbEntityActionBase as UmbEntityActionBase$1 } from '
|
|
1
|
+
import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
|
|
2
|
+
import { UmbEntityActionBase as UmbEntityActionBase$1 } from '@umbraco-cms/backoffice/entity-action';
|
|
3
|
+
import { UmbDetailRepository, UmbItemRepository, UmbFolderRepository } from '@umbraco-cms/backoffice/repository';
|
|
3
4
|
|
|
4
5
|
interface UmbAction<RepositoryType = unknown> {
|
|
5
|
-
host:
|
|
6
|
+
host: UmbControllerHostElement;
|
|
6
7
|
repository: RepositoryType;
|
|
7
8
|
execute(): Promise<void>;
|
|
8
9
|
}
|
|
9
10
|
declare class UmbActionBase<RepositoryType> {
|
|
10
|
-
host:
|
|
11
|
+
host: UmbControllerHostElement;
|
|
11
12
|
repository?: RepositoryType;
|
|
12
|
-
constructor(host:
|
|
13
|
+
constructor(host: UmbControllerHostElement, repositoryAlias: string);
|
|
13
14
|
}
|
|
14
15
|
|
|
15
16
|
interface UmbEntityAction<RepositoryType> extends UmbAction<RepositoryType> {
|
|
@@ -17,7 +18,8 @@ interface UmbEntityAction<RepositoryType> extends UmbAction<RepositoryType> {
|
|
|
17
18
|
}
|
|
18
19
|
declare class UmbEntityActionBase<RepositoryType> extends UmbActionBase<RepositoryType> {
|
|
19
20
|
unique: string;
|
|
20
|
-
|
|
21
|
+
repositoryAlias: string;
|
|
22
|
+
constructor(host: UmbControllerHostElement, repositoryAlias: string, unique: string);
|
|
21
23
|
}
|
|
22
24
|
|
|
23
25
|
interface UmbEntityBulkAction<RepositoryType = unknown> extends UmbAction<RepositoryType> {
|
|
@@ -26,47 +28,55 @@ interface UmbEntityBulkAction<RepositoryType = unknown> extends UmbAction<Reposi
|
|
|
26
28
|
}
|
|
27
29
|
declare class UmbEntityBulkActionBase<RepositoryType = unknown> extends UmbActionBase<RepositoryType> {
|
|
28
30
|
selection: Array<string>;
|
|
29
|
-
constructor(host:
|
|
31
|
+
constructor(host: UmbControllerHostElement, repositoryAlias: string, selection: Array<string>);
|
|
30
32
|
setSelection(selection: Array<string>): void;
|
|
31
33
|
}
|
|
32
34
|
|
|
33
35
|
declare class UmbCopyEntityAction<T extends {
|
|
34
36
|
copy(): Promise<void>;
|
|
35
37
|
}> extends UmbEntityActionBase$1<T> {
|
|
36
|
-
constructor(host:
|
|
38
|
+
constructor(host: UmbControllerHostElement, repositoryAlias: string, unique: string);
|
|
37
39
|
execute(): Promise<void>;
|
|
38
40
|
}
|
|
39
41
|
|
|
40
|
-
declare class UmbDeleteEntityAction<T extends {
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
42
|
+
declare class UmbDeleteEntityAction<T extends UmbDetailRepository & UmbItemRepository<any>> extends UmbEntityActionBase$1<T> {
|
|
43
|
+
#private;
|
|
44
|
+
constructor(host: UmbControllerHostElement, repositoryAlias: string, unique: string);
|
|
45
|
+
execute(): Promise<void>;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
declare class UmbDeleteFolderEntityAction<T extends UmbFolderRepository> extends UmbEntityActionBase$1<T> {
|
|
49
|
+
#private;
|
|
50
|
+
constructor(host: UmbControllerHostElement, repositoryAlias: string, unique: string);
|
|
51
|
+
execute(): Promise<void>;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
declare class UmbFolderUpdateEntityAction<T extends UmbFolderRepository = UmbFolderRepository> extends UmbEntityActionBase$1<T> {
|
|
44
55
|
#private;
|
|
45
|
-
constructor(host:
|
|
56
|
+
constructor(host: UmbControllerHostElement, repositoryAlias: string, unique: string);
|
|
46
57
|
execute(): Promise<void>;
|
|
47
58
|
}
|
|
48
59
|
|
|
49
60
|
declare class UmbMoveEntityAction<T extends {
|
|
50
61
|
move(): Promise<void>;
|
|
51
62
|
}> extends UmbEntityActionBase$1<T> {
|
|
52
|
-
constructor(host:
|
|
63
|
+
constructor(host: UmbControllerHostElement, repositoryAlias: string, unique: string);
|
|
53
64
|
execute(): Promise<void>;
|
|
54
65
|
}
|
|
55
66
|
|
|
56
67
|
declare class UmbSortChildrenOfEntityAction<T extends {
|
|
57
68
|
sortChildrenOf(): Promise<void>;
|
|
58
69
|
}> extends UmbEntityActionBase$1<T> {
|
|
59
|
-
constructor(host:
|
|
70
|
+
constructor(host: UmbControllerHostElement, repositoryAlias: string, unique: string);
|
|
60
71
|
execute(): Promise<void>;
|
|
61
72
|
}
|
|
62
73
|
|
|
63
|
-
declare class UmbTrashEntityAction<T extends {
|
|
74
|
+
declare class UmbTrashEntityAction<T extends UmbItemRepository<any> & {
|
|
64
75
|
trash(unique: Array<string>): Promise<void>;
|
|
65
|
-
requestTreeItems(uniques: Array<string>): any;
|
|
66
76
|
}> extends UmbEntityActionBase$1<T> {
|
|
67
77
|
#private;
|
|
68
|
-
constructor(host:
|
|
78
|
+
constructor(host: UmbControllerHostElement, repositoryAlias: string, unique: string);
|
|
69
79
|
execute(): Promise<void>;
|
|
70
80
|
}
|
|
71
81
|
|
|
72
|
-
export { UmbAction, UmbActionBase, UmbCopyEntityAction, UmbDeleteEntityAction, UmbEntityAction, UmbEntityActionBase, UmbEntityBulkAction, UmbEntityBulkActionBase, UmbMoveEntityAction, UmbSortChildrenOfEntityAction, UmbTrashEntityAction };
|
|
82
|
+
export { UmbAction, UmbActionBase, UmbCopyEntityAction, UmbDeleteEntityAction, UmbDeleteFolderEntityAction, UmbEntityAction, UmbEntityActionBase, UmbEntityBulkAction, UmbEntityBulkActionBase, UmbFolderUpdateEntityAction, UmbMoveEntityAction, UmbSortChildrenOfEntityAction, UmbTrashEntityAction };
|
package/extensions-api.d.ts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { Observable } from 'rxjs';
|
|
2
|
-
import { ManifestTypes, ManifestKind, ManifestTypeMap, ManifestBase, SpecificManifestTypeOrManifestBase, ManifestElement, ManifestElementWithElementName, ManifestClass } from '
|
|
3
|
-
import { UmbContextToken } from '
|
|
4
|
-
import {
|
|
2
|
+
import { ManifestTypes, ManifestKind, ManifestTypeMap, ManifestBase, SpecificManifestTypeOrManifestBase, ManifestElement, ManifestElementWithElementName, ManifestClass } from '@umbraco-cms/backoffice/extensions-registry';
|
|
3
|
+
import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
|
|
4
|
+
import { PageComponent } from '@umbraco-cms/backoffice/router';
|
|
5
|
+
import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
|
|
5
6
|
|
|
6
7
|
declare class UmbExtensionRegistry {
|
|
7
8
|
private _extensions;
|
|
@@ -10,6 +11,7 @@ declare class UmbExtensionRegistry {
|
|
|
10
11
|
readonly kinds: Observable<ManifestKind[]>;
|
|
11
12
|
defineKind(kind: ManifestKind): void;
|
|
12
13
|
register(manifest: ManifestTypes | ManifestKind): void;
|
|
14
|
+
registerMany(manifests: Array<ManifestTypes>): void;
|
|
13
15
|
unregister(alias: string): void;
|
|
14
16
|
isRegistered(alias: string): boolean;
|
|
15
17
|
private _kindsOfType;
|
|
@@ -22,13 +24,13 @@ declare class UmbExtensionRegistry {
|
|
|
22
24
|
}
|
|
23
25
|
declare const UMB_EXTENSION_REGISTRY_TOKEN: UmbContextToken<UmbExtensionRegistry>;
|
|
24
26
|
|
|
25
|
-
declare function createExtensionElement(manifest: ManifestElement): Promise<
|
|
27
|
+
declare function createExtensionElement(manifest: ManifestElement): Promise<PageComponent>;
|
|
26
28
|
|
|
27
29
|
declare function hasDefaultExport<ConstructorType>(object: unknown): object is {
|
|
28
30
|
default: ConstructorType;
|
|
29
31
|
};
|
|
30
32
|
|
|
31
|
-
type UmbEntrypointOnInit = (host:
|
|
33
|
+
type UmbEntrypointOnInit = (host: UmbControllerHostElement, extensionRegistry: UmbExtensionRegistry) => void;
|
|
32
34
|
/**
|
|
33
35
|
* Interface containing supported life-cycle functions for ESModule entrypoints
|
|
34
36
|
*/
|
package/extensions-registry.d.ts
CHANGED
|
@@ -1,17 +1,30 @@
|
|
|
1
|
-
import { ClassConstructor } from './models';
|
|
2
1
|
import { InterfaceLook, InterfaceColor } from '@umbraco-ui/uui-base/lib/types/index';
|
|
3
|
-
import {
|
|
4
|
-
import { UmbStoreBase,
|
|
5
|
-
import { UmbExtensionRegistry } from '
|
|
6
|
-
import {
|
|
2
|
+
import { ClassConstructor } from '@umbraco-cms/backoffice/models';
|
|
3
|
+
import { UmbStoreBase, UmbTreeStore, UmbItemStore } from '@umbraco-cms/backoffice/store';
|
|
4
|
+
import { UmbExtensionRegistry } from '@umbraco-cms/backoffice/extensions-api';
|
|
5
|
+
import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller';
|
|
7
6
|
|
|
8
7
|
interface ManifestCollectionView extends ManifestElement, ManifestWithConditions<ConditionsCollectionView> {
|
|
9
8
|
type: 'collectionView';
|
|
10
9
|
meta: MetaCollectionView;
|
|
11
10
|
}
|
|
12
11
|
interface MetaCollectionView {
|
|
12
|
+
/**
|
|
13
|
+
* The friendly name of the collection view
|
|
14
|
+
*/
|
|
13
15
|
label: string;
|
|
16
|
+
/**
|
|
17
|
+
* An icon to represent the collection view
|
|
18
|
+
*
|
|
19
|
+
* @examples [
|
|
20
|
+
* "umb:box",
|
|
21
|
+
* "umb:grid"
|
|
22
|
+
* ]
|
|
23
|
+
*/
|
|
14
24
|
icon: string;
|
|
25
|
+
/**
|
|
26
|
+
* The URL pathname for this collection view that can be deep linked to by sharing the url
|
|
27
|
+
*/
|
|
15
28
|
pathName: string;
|
|
16
29
|
}
|
|
17
30
|
interface ConditionsCollectionView {
|
|
@@ -23,10 +36,33 @@ interface ManifestDashboard extends ManifestElement, ManifestWithConditions<Cond
|
|
|
23
36
|
meta: MetaDashboard;
|
|
24
37
|
}
|
|
25
38
|
interface MetaDashboard {
|
|
39
|
+
/**
|
|
40
|
+
* This is the URL path for the dashboard which is used for navigating or deep linking directly to the dashboard
|
|
41
|
+
* https://yoursite.com/section/settings/dashboard/my-dashboard-path
|
|
42
|
+
*
|
|
43
|
+
* @example my-dashboard-path
|
|
44
|
+
* @examples [
|
|
45
|
+
* "my-dashboard-path"
|
|
46
|
+
* ]
|
|
47
|
+
*/
|
|
26
48
|
pathname: string;
|
|
49
|
+
/**
|
|
50
|
+
* The displayed name (label) for the tab of the dashboard
|
|
51
|
+
*/
|
|
27
52
|
label?: string;
|
|
28
53
|
}
|
|
29
54
|
interface ConditionsDashboard {
|
|
55
|
+
/**
|
|
56
|
+
* An array of section aliases that the dashboard should be available in
|
|
57
|
+
*
|
|
58
|
+
* @uniqueItems true
|
|
59
|
+
* @minItems 1
|
|
60
|
+
* @items.examples [
|
|
61
|
+
* "Umb.Section.Content",
|
|
62
|
+
* "Umb.Section.Settings"
|
|
63
|
+
* ]
|
|
64
|
+
*
|
|
65
|
+
*/
|
|
30
66
|
sections: string[];
|
|
31
67
|
}
|
|
32
68
|
|
|
@@ -45,28 +81,76 @@ interface ConditionsDashboardCollection {
|
|
|
45
81
|
entityType: string;
|
|
46
82
|
}
|
|
47
83
|
|
|
84
|
+
/**
|
|
85
|
+
* An action to perform on an entity
|
|
86
|
+
* For example for content you may wish to create a new document etc
|
|
87
|
+
*/
|
|
48
88
|
interface ManifestEntityAction extends ManifestElement {
|
|
49
89
|
type: 'entityAction';
|
|
50
90
|
meta: MetaEntityAction;
|
|
51
91
|
conditions: ConditionsEntityAction;
|
|
52
92
|
}
|
|
53
93
|
interface MetaEntityAction {
|
|
94
|
+
/**
|
|
95
|
+
* An icon to represent the action to be performed
|
|
96
|
+
*
|
|
97
|
+
* @examples [
|
|
98
|
+
* "umb:box",
|
|
99
|
+
* "umb:grid"
|
|
100
|
+
* ]
|
|
101
|
+
*/
|
|
54
102
|
icon?: string;
|
|
103
|
+
/**
|
|
104
|
+
* The friendly name of the action to perform
|
|
105
|
+
*
|
|
106
|
+
* @examples [
|
|
107
|
+
* "Create",
|
|
108
|
+
* "Create Content Template"
|
|
109
|
+
* ]
|
|
110
|
+
*/
|
|
55
111
|
label: string;
|
|
112
|
+
/**
|
|
113
|
+
* @TJS-ignore
|
|
114
|
+
*/
|
|
56
115
|
api: any;
|
|
116
|
+
/**
|
|
117
|
+
* The alias for the repsoitory of the entity type this action is for
|
|
118
|
+
* such as 'Umb.Repository.Documents'
|
|
119
|
+
* @examples [
|
|
120
|
+
* "Umb.Repository.Documents"
|
|
121
|
+
* ]
|
|
122
|
+
*/
|
|
57
123
|
repositoryAlias: string;
|
|
58
124
|
}
|
|
59
125
|
interface ConditionsEntityAction {
|
|
60
126
|
entityType: string;
|
|
61
127
|
}
|
|
62
128
|
|
|
129
|
+
/**
|
|
130
|
+
* An action to perform on multiple entities
|
|
131
|
+
* For example for content you may wish to move one or more documents in bulk
|
|
132
|
+
*/
|
|
63
133
|
interface ManifestEntityBulkAction extends ManifestElement, ManifestWithConditions<ConditionsEntityBulkAction> {
|
|
64
134
|
type: 'entityBulkAction';
|
|
65
135
|
meta: MetaEntityBulkAction;
|
|
66
136
|
}
|
|
67
137
|
interface MetaEntityBulkAction {
|
|
138
|
+
/**
|
|
139
|
+
* A friendly label for the action
|
|
140
|
+
*/
|
|
68
141
|
label: string;
|
|
142
|
+
/**
|
|
143
|
+
* @TJS-ignore
|
|
144
|
+
*/
|
|
69
145
|
api: any;
|
|
146
|
+
/**
|
|
147
|
+
* The alias for the repsoitory of the entity type this action is for
|
|
148
|
+
* such as 'Umb.Repository.Documents'
|
|
149
|
+
*
|
|
150
|
+
* @examples [
|
|
151
|
+
* "Umb.Repository.Documents"
|
|
152
|
+
* ]
|
|
153
|
+
*/
|
|
70
154
|
repositoryAlias: string;
|
|
71
155
|
}
|
|
72
156
|
interface ConditionsEntityBulkAction {
|
|
@@ -82,6 +166,10 @@ interface MetaExternalLoginProvider {
|
|
|
82
166
|
pathname: string;
|
|
83
167
|
}
|
|
84
168
|
|
|
169
|
+
/**
|
|
170
|
+
* Header apps are displayed in the top right corner of the backoffice
|
|
171
|
+
* The two provided header apps are the search and the user menu
|
|
172
|
+
*/
|
|
85
173
|
interface ManifestHeaderApp extends ManifestElement {
|
|
86
174
|
type: 'headerApp';
|
|
87
175
|
}
|
|
@@ -232,8 +320,16 @@ interface MetaMenuItemTreeKind {
|
|
|
232
320
|
entityType?: string;
|
|
233
321
|
}
|
|
234
322
|
|
|
323
|
+
/**
|
|
324
|
+
* Theme manifest for styling the backoffice of Umbraco such as dark, high contrast etc
|
|
325
|
+
*/
|
|
235
326
|
interface ManifestTheme extends ManifestWithLoader<string> {
|
|
236
327
|
type: 'theme';
|
|
328
|
+
/**
|
|
329
|
+
* File location of the CSS file of the theme
|
|
330
|
+
*
|
|
331
|
+
* @examples ["themes/dark.theme.css"]
|
|
332
|
+
*/
|
|
237
333
|
css?: string;
|
|
238
334
|
}
|
|
239
335
|
|
|
@@ -242,15 +338,22 @@ interface ManifestTree extends ManifestBase {
|
|
|
242
338
|
meta: MetaTree;
|
|
243
339
|
}
|
|
244
340
|
interface MetaTree {
|
|
245
|
-
|
|
246
|
-
repository?: ClassConstructor<unknown>;
|
|
341
|
+
repositoryAlias: string;
|
|
247
342
|
}
|
|
248
343
|
|
|
249
|
-
interface
|
|
250
|
-
type: '
|
|
251
|
-
|
|
344
|
+
interface ManifestTreeItem extends ManifestElement {
|
|
345
|
+
type: 'treeItem';
|
|
346
|
+
conditions: ConditionsTreeItem;
|
|
347
|
+
}
|
|
348
|
+
interface ConditionsTreeItem {
|
|
349
|
+
entityType: string;
|
|
252
350
|
}
|
|
253
|
-
|
|
351
|
+
|
|
352
|
+
interface ManifestUserProfileApp extends ManifestElement {
|
|
353
|
+
type: 'userProfileApp';
|
|
354
|
+
meta: MetaUserProfileApp;
|
|
355
|
+
}
|
|
356
|
+
interface MetaUserProfileApp {
|
|
254
357
|
label: string;
|
|
255
358
|
pathname: string;
|
|
256
359
|
}
|
|
@@ -272,7 +375,7 @@ interface MetaWorkspaceAction {
|
|
|
272
375
|
label?: string;
|
|
273
376
|
look?: InterfaceLook;
|
|
274
377
|
color?: InterfaceColor;
|
|
275
|
-
api: ClassConstructor<
|
|
378
|
+
api: ClassConstructor<any>;
|
|
276
379
|
}
|
|
277
380
|
interface ConditionsWorkspaceAction {
|
|
278
381
|
workspaces: Array<string>;
|
|
@@ -319,21 +422,41 @@ interface ManifestModal extends ManifestElement {
|
|
|
319
422
|
interface ManifestStore extends ManifestClass<UmbStoreBase> {
|
|
320
423
|
type: 'store';
|
|
321
424
|
}
|
|
322
|
-
interface ManifestTreeStore extends ManifestClass<
|
|
425
|
+
interface ManifestTreeStore extends ManifestClass<UmbTreeStore> {
|
|
323
426
|
type: 'treeStore';
|
|
324
427
|
}
|
|
428
|
+
interface ManifestItemStore extends ManifestClass<UmbItemStore> {
|
|
429
|
+
type: 'itemStore';
|
|
430
|
+
}
|
|
325
431
|
|
|
326
|
-
type ManifestTypes = ManifestCollectionView | ManifestDashboard | ManifestDashboardCollection | ManifestEntityAction | ManifestEntityBulkAction | ManifestEntrypoint | ManifestExternalLoginProvider | ManifestHeaderApp | ManifestHeaderAppButtonKind | ManifestHealthCheck | ManifestPackageView | ManifestPropertyAction | ManifestPropertyEditorModel | ManifestPropertyEditorUI | ManifestRepository | ManifestSection | ManifestSectionSidebarApp | ManifestSectionSidebarAppMenuKind | ManifestSectionView | ManifestMenu | ManifestMenuItem | ManifestMenuItemTreeKind | ManifestTheme | ManifestTree |
|
|
432
|
+
type ManifestTypes = ManifestCollectionView | ManifestDashboard | ManifestDashboardCollection | ManifestEntityAction | ManifestEntityBulkAction | ManifestEntrypoint | ManifestExternalLoginProvider | ManifestHeaderApp | ManifestHeaderAppButtonKind | ManifestHealthCheck | ManifestPackageView | ManifestPropertyAction | ManifestPropertyEditorModel | ManifestPropertyEditorUI | ManifestRepository | ManifestSection | ManifestSectionSidebarApp | ManifestSectionSidebarAppMenuKind | ManifestSectionView | ManifestMenu | ManifestMenuItem | ManifestMenuItemTreeKind | ManifestTheme | ManifestTree | ManifestTreeItem | ManifestUserProfileApp | ManifestWorkspace | ManifestWorkspaceAction | ManifestWorkspaceView | ManifestWorkspaceViewCollection | ManifestModal | ManifestStore | ManifestTreeStore | ManifestItemStore | ManifestBase;
|
|
327
433
|
type ManifestStandardTypes = ManifestTypes['type'];
|
|
328
434
|
type ManifestTypeMap = {
|
|
329
435
|
[Manifest in ManifestTypes as Manifest['type']]: Manifest;
|
|
330
436
|
};
|
|
331
437
|
type SpecificManifestTypeOrManifestBase<T extends keyof ManifestTypeMap | string> = T extends keyof ManifestTypeMap ? ManifestTypeMap[T] : ManifestBase;
|
|
332
438
|
interface ManifestBase {
|
|
439
|
+
/**
|
|
440
|
+
* The type of extension such as dashboard etc...
|
|
441
|
+
*/
|
|
333
442
|
type: string;
|
|
443
|
+
/**
|
|
444
|
+
* The alias of the extension, ensure it is unique
|
|
445
|
+
*/
|
|
334
446
|
alias: string;
|
|
335
|
-
|
|
447
|
+
/**
|
|
448
|
+
* The kind of the extension, used to group extensions together
|
|
449
|
+
*
|
|
450
|
+
* @examples ["button"]
|
|
451
|
+
*/
|
|
452
|
+
kind?: unknown;
|
|
453
|
+
/**
|
|
454
|
+
* The friendly name of the extension
|
|
455
|
+
*/
|
|
336
456
|
name: string;
|
|
457
|
+
/**
|
|
458
|
+
* Extensions such as dashboards are ordered by weight with lower numbers being first in the list
|
|
459
|
+
*/
|
|
337
460
|
weight?: number;
|
|
338
461
|
}
|
|
339
462
|
interface ManifestKind {
|
|
@@ -344,23 +467,54 @@ interface ManifestKind {
|
|
|
344
467
|
manifest: Partial<ManifestTypes>;
|
|
345
468
|
}
|
|
346
469
|
interface ManifestWithConditions<ConditionsType> {
|
|
470
|
+
/**
|
|
471
|
+
* Set the conditions for when the extension should be loaded
|
|
472
|
+
*/
|
|
347
473
|
conditions: ConditionsType;
|
|
348
474
|
}
|
|
349
475
|
interface ManifestWithLoader<LoaderReturnType> extends ManifestBase {
|
|
476
|
+
/**
|
|
477
|
+
* @TJS-ignore
|
|
478
|
+
*/
|
|
350
479
|
loader?: () => Promise<LoaderReturnType>;
|
|
351
480
|
}
|
|
481
|
+
/**
|
|
482
|
+
* The type of extension such as dashboard etc...
|
|
483
|
+
*/
|
|
352
484
|
interface ManifestClass<T = unknown> extends ManifestWithLoader<object> {
|
|
485
|
+
/**
|
|
486
|
+
* The file location of the javascript file to load
|
|
487
|
+
* @TJS-required
|
|
488
|
+
*/
|
|
353
489
|
js?: string;
|
|
490
|
+
/**
|
|
491
|
+
* @TJS-ignore
|
|
492
|
+
*/
|
|
354
493
|
className?: string;
|
|
494
|
+
/**
|
|
495
|
+
* @TJS-ignore
|
|
496
|
+
*/
|
|
355
497
|
class?: ClassConstructor<T>;
|
|
356
498
|
}
|
|
357
499
|
interface ManifestClassWithClassConstructor extends ManifestClass {
|
|
358
500
|
class: ClassConstructor<unknown>;
|
|
359
501
|
}
|
|
360
502
|
interface ManifestElement extends ManifestWithLoader<object | HTMLElement> {
|
|
503
|
+
/**
|
|
504
|
+
* The file location of the javascript file to load
|
|
505
|
+
*
|
|
506
|
+
* @TJS-require
|
|
507
|
+
*/
|
|
361
508
|
js?: string;
|
|
509
|
+
/**
|
|
510
|
+
* The HTML web component name to use such as 'my-dashboard'
|
|
511
|
+
* Note it is NOT <my-dashboard></my-dashboard> but just the name
|
|
512
|
+
*/
|
|
362
513
|
elementName?: string;
|
|
363
|
-
|
|
514
|
+
/**
|
|
515
|
+
* This contains properties specific to the type of extension
|
|
516
|
+
*/
|
|
517
|
+
meta?: unknown;
|
|
364
518
|
}
|
|
365
519
|
interface ManifestWithView extends ManifestElement {
|
|
366
520
|
meta: MetaManifestWithView;
|
|
@@ -371,20 +525,34 @@ interface MetaManifestWithView {
|
|
|
371
525
|
icon: string;
|
|
372
526
|
}
|
|
373
527
|
interface ManifestElementWithElementName extends ManifestElement {
|
|
528
|
+
/**
|
|
529
|
+
* The HTML web component name to use such as 'my-dashboard'
|
|
530
|
+
* Note it is NOT <my-dashboard></my-dashboard> but just the name
|
|
531
|
+
*/
|
|
374
532
|
elementName: string;
|
|
375
533
|
}
|
|
376
534
|
interface ManifestWithMeta extends ManifestBase {
|
|
535
|
+
/**
|
|
536
|
+
* This contains properties specific to the type of extension
|
|
537
|
+
*/
|
|
377
538
|
meta: unknown;
|
|
378
539
|
}
|
|
540
|
+
/**
|
|
541
|
+
* This type of extension gives full control and will simply load the specified JS file
|
|
542
|
+
* You could have custom logic to decide which extensions to load/register by using extensionRegistry
|
|
543
|
+
*/
|
|
379
544
|
interface ManifestEntrypoint extends ManifestBase {
|
|
380
|
-
type: '
|
|
545
|
+
type: 'entryPoint';
|
|
546
|
+
/**
|
|
547
|
+
* The file location of the javascript file to load in the backoffice
|
|
548
|
+
*/
|
|
381
549
|
js: string;
|
|
382
550
|
}
|
|
383
551
|
|
|
384
552
|
declare class UmbEntryPointExtensionInitializer {
|
|
385
553
|
#private;
|
|
386
|
-
constructor(
|
|
387
|
-
instantiateEntryPoint(manifest: ManifestEntrypoint): void
|
|
554
|
+
constructor(host: UmbControllerHostElement, extensionRegistry: UmbExtensionRegistry);
|
|
555
|
+
instantiateEntryPoint(manifest: ManifestEntrypoint): Promise<void>;
|
|
388
556
|
}
|
|
389
557
|
|
|
390
|
-
export { ConditionsCollectionView, ConditionsDashboard, ConditionsDashboardCollection, ConditionsEditorViewCollection, ConditionsEntityAction, ConditionsEntityBulkAction, ConditionsMenuItem, ConditionsPropertyAction, ConditionsSectionSidebarApp, ConditionsSectionView, ConditionsWorkspaceAction, ConditionsWorkspaceView, HealthCheck, ManifestBase, ManifestClass, ManifestClassWithClassConstructor, ManifestCollectionView, ManifestDashboard, ManifestDashboardCollection, ManifestElement, ManifestElementWithElementName, ManifestEntityAction, ManifestEntityBulkAction, ManifestEntrypoint, ManifestExternalLoginProvider, ManifestHeaderApp, ManifestHeaderAppButtonKind, ManifestHealthCheck, ManifestKind, ManifestMenu, ManifestMenuItem, ManifestMenuItemTreeKind, ManifestModal, ManifestPackageView, ManifestPropertyAction, ManifestPropertyEditorModel, ManifestPropertyEditorUI, ManifestRepository, ManifestSection, ManifestSectionSidebarApp, ManifestSectionSidebarAppMenuKind, ManifestSectionView, ManifestStandardTypes, ManifestStore, ManifestTheme, ManifestTree, ManifestTreeStore, ManifestTypeMap, ManifestTypes,
|
|
558
|
+
export { ConditionsCollectionView, ConditionsDashboard, ConditionsDashboardCollection, ConditionsEditorViewCollection, ConditionsEntityAction, ConditionsEntityBulkAction, ConditionsMenuItem, ConditionsPropertyAction, ConditionsSectionSidebarApp, ConditionsSectionView, ConditionsTreeItem, ConditionsWorkspaceAction, ConditionsWorkspaceView, HealthCheck, ManifestBase, ManifestClass, ManifestClassWithClassConstructor, ManifestCollectionView, ManifestDashboard, ManifestDashboardCollection, ManifestElement, ManifestElementWithElementName, ManifestEntityAction, ManifestEntityBulkAction, ManifestEntrypoint, ManifestExternalLoginProvider, ManifestHeaderApp, ManifestHeaderAppButtonKind, ManifestHealthCheck, ManifestItemStore, ManifestKind, ManifestMenu, ManifestMenuItem, ManifestMenuItemTreeKind, ManifestModal, ManifestPackageView, ManifestPropertyAction, ManifestPropertyEditorModel, ManifestPropertyEditorUI, ManifestRepository, ManifestSection, ManifestSectionSidebarApp, ManifestSectionSidebarAppMenuKind, ManifestSectionView, ManifestStandardTypes, ManifestStore, ManifestTheme, ManifestTree, ManifestTreeItem, ManifestTreeStore, ManifestTypeMap, ManifestTypes, ManifestUserProfileApp, ManifestWithConditions, ManifestWithLoader, ManifestWithMeta, ManifestWithView, ManifestWorkspace, ManifestWorkspaceAction, ManifestWorkspaceView, ManifestWorkspaceViewCollection, MetaCollectionView, MetaDashboard, MetaDashboardCollection, MetaEditor, MetaEditorViewCollection, MetaEntityAction, MetaEntityBulkAction, MetaExternalLoginProvider, MetaHeaderApp, MetaHeaderAppButtonKind, MetaHealthCheck, MetaManifestWithView, MetaMenuItem, MetaMenuItemTreeKind, MetaPackageView, MetaPropertyEditorModel, MetaPropertyEditorUI, MetaSection, MetaSectionSidebarAppMenuKind, MetaSectionView, MetaTree, MetaUserProfileApp, MetaWorkspaceAction, MetaWorkspaceView, PropertyEditorConfig, PropertyEditorConfigDefaultData, PropertyEditorConfigProperty, SpecificManifestTypeOrManifestBase, UmbEntryPointExtensionInitializer };
|