Skip to content

Commit 4484d58

Browse files
hotfix: Rename condition config map (#2401)
* adapt condition manifests * rename types --------- Co-authored-by: Jacob Overgaard <[email protected]>
1 parent 34c35cc commit 4484d58

31 files changed

+56
-67
lines changed

src/libs/extension-api/types/condition.types.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,23 @@ export interface UmbConditionConfigBase<AliasType extends string = string> {
44
alias: AliasType;
55
}
66

7-
export type ConditionTypeMap<ConditionTypes extends UmbConditionConfigBase> = {
8-
[Condition in ConditionTypes as Condition['alias']]: Condition;
7+
export type ConditionTypeMap<ConditionConfigs extends UmbConditionConfigBase> = {
8+
[Condition in ConditionConfigs as Condition['alias']]: Condition;
99
} & {
1010
[key: string]: UmbConditionConfigBase;
1111
};
1212

1313
export type SpecificConditionTypeOrUmbConditionConfigBase<
14-
ConditionTypes extends UmbConditionConfigBase,
15-
T extends keyof ConditionTypeMap<ConditionTypes> | string,
16-
> = T extends keyof ConditionTypeMap<ConditionTypes> ? ConditionTypeMap<ConditionTypes>[T] : UmbConditionConfigBase;
14+
ConditionConfigs extends UmbConditionConfigBase,
15+
T extends keyof ConditionTypeMap<ConditionConfigs> | string,
16+
> = T extends keyof ConditionTypeMap<ConditionConfigs> ? ConditionTypeMap<ConditionConfigs>[T] : UmbConditionConfigBase;
1717

18-
export interface ManifestWithDynamicConditions<ConditionTypes extends UmbConditionConfigBase = UmbConditionConfigBase>
18+
export interface ManifestWithDynamicConditions<ConditionConfigs extends UmbConditionConfigBase = UmbConditionConfigBase>
1919
extends ManifestBase {
2020
/**
2121
* Set the conditions for when the extension should be loaded
2222
*/
23-
conditions?: Array<ConditionTypes>;
23+
conditions?: Array<ConditionConfigs>;
2424
/**
2525
* Define one or more extension aliases that this extension should overwrite.
2626
*/

src/packages/block/block/conditions/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export interface BlockEntryIsExposedConditionConfig
1212
}
1313

1414
declare global {
15-
interface UmbExtensionConditionMap {
15+
interface UmbExtensionConditionConfigMap {
1616
umbBlock:
1717
| BlockEntryShowContentEditConditionConfig
1818
| BlockWorkspaceHasSettingsConditionConfig

src/packages/core/collection/extensions/collection-action.extension.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import type { ManifestElementAndApi, ManifestWithDynamicConditions } from '@umbr
77
// TODO: create interface for API
88
export interface ManifestCollectionAction
99
extends ManifestElementAndApi,
10-
ManifestWithDynamicConditions<UmbExtensionCondition> {
10+
ManifestWithDynamicConditions<UmbExtensionConditionConfig> {
1111
type: 'collectionAction';
1212
meta: MetaCollectionAction;
1313
}

src/packages/core/collection/extensions/collection-view.extension.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
import type { ManifestElement, ManifestWithDynamicConditions } from '@umbraco-cms/backoffice/extension-api';
22

3-
export interface ManifestCollectionView extends ManifestElement, ManifestWithDynamicConditions<UmbExtensionCondition> {
3+
export interface ManifestCollectionView
4+
extends ManifestElement,
5+
ManifestWithDynamicConditions<UmbExtensionConditionConfig> {
46
type: 'collectionView';
57
meta: MetaCollectionView;
68
}

src/packages/core/collection/extensions/collection.extension.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import type { ManifestElementAndApi, ManifestWithDynamicConditions } from '@umbr
22

33
export interface ManifestCollection
44
extends ManifestElementAndApi,
5-
ManifestWithDynamicConditions<UmbExtensionCondition> {
5+
ManifestWithDynamicConditions<UmbExtensionConditionConfig> {
66
type: 'collection';
77
meta: MetaCollection;
88
}

src/packages/core/dashboard/dashboard.extension.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import type { ManifestElement, ManifestWithDynamicConditions } from '@umbraco-cm
33

44
export interface ManifestDashboard
55
extends ManifestElement<UmbDashboardElement>,
6-
ManifestWithDynamicConditions<UmbExtensionCondition> {
6+
ManifestWithDynamicConditions<UmbExtensionConditionConfig> {
77
type: 'dashboard';
88
meta: MetaDashboard;
99
}

src/packages/core/entity-action/entity-action.extension.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import type { UmbEntityAction, UmbEntityActionElement } from '@umbraco-cms/backo
77
*/
88
export interface ManifestEntityAction<MetaType extends MetaEntityAction = MetaEntityAction>
99
extends ManifestElementAndApi<UmbEntityActionElement, UmbEntityAction<MetaType>>,
10-
ManifestWithDynamicConditions<UmbExtensionCondition> {
10+
ManifestWithDynamicConditions<UmbExtensionConditionConfig> {
1111
type: 'entityAction';
1212
forEntityTypes: Array<string>;
1313
meta: MetaType;
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
export { UmbSwitchCondition } from './switch.condition.js';
22
export { UmbConditionBase } from './condition-base.controller.js';
33

4-
export type { ConditionTypes } from './types.js';
4+
export type { UmbCoreConditionConfigs } from './types.js';

src/packages/core/extension-registry/conditions/types.ts

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,17 @@ import type { CollectionBulkActionPermissionConditionConfig } from '../../collec
33
import type { SwitchConditionConfig } from './switch.condition.js';
44
import type { UmbConditionConfigBase } from '@umbraco-cms/backoffice/extension-api';
55

6-
export type ConditionTypes =
6+
export type UmbCoreConditionConfigs =
77
| CollectionAliasConditionConfig
88
| CollectionBulkActionPermissionConditionConfig
99
| SwitchConditionConfig
1010
| UmbConditionConfigBase;
1111

12+
/**
13+
* @deprecated instead use global UmbExtensionConditionConfig
14+
*/
15+
export type ConditionTypes = UmbCoreConditionConfigs;
16+
1217
type UnionOfProperties<T> = T extends object ? T[keyof T] : never;
1318

1419
declare global {
@@ -17,27 +22,27 @@ declare global {
1722
* @example
1823
```js
1924
declare global {
20-
interface UmbExtensionConditionMap {
25+
interface UmbExtensionConditionConfigMap {
2126
My_UNIQUE_CONDITION_NAME: MyExtensionConditionType;
2227
}
2328
}
2429
```
2530
If you have multiple types, you can declare them in this way:
2631
```js
2732
declare global {
28-
interface UmbExtensionConditionMap {
33+
interface UmbExtensionConditionConfigMap {
2934
My_UNIQUE_CONDITION_NAME: MyExtensionConditionTypeA | MyExtensionConditionTypeB;
3035
}
3136
}
3237
```
3338
*/
34-
interface UmbExtensionConditionMap {
35-
UMB_CORE: ConditionTypes;
39+
interface UmbExtensionConditionConfigMap {
40+
UMB_CORE: UmbCoreConditionConfigs;
3641
}
3742

3843
/**
3944
* This global type provides a union of all declared manifest types.
4045
* If this is a local package that declares additional Manifest Types, then these will also be included in this union.
4146
*/
42-
type UmbExtensionCondition = UnionOfProperties<UmbExtensionConditionMap>;
47+
type UmbExtensionConditionConfig = UnionOfProperties<UmbExtensionConditionConfigMap>;
4348
}

src/packages/core/extension-registry/extensions/entity-bulk-action.extension.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import type { ManifestElementAndApi, ManifestWithDynamicConditions } from '@umbr
88
*/
99
export interface ManifestEntityBulkAction<MetaType extends MetaEntityBulkAction = MetaEntityBulkAction>
1010
extends ManifestElementAndApi<UmbEntityBulkActionElement, UmbEntityBulkAction<MetaType>>,
11-
ManifestWithDynamicConditions<UmbExtensionCondition> {
11+
ManifestWithDynamicConditions<UmbExtensionConditionConfig> {
1212
type: 'entityBulkAction';
1313
forEntityTypes: Array<string>;
1414
meta: MetaType;

0 commit comments

Comments
 (0)