yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

rename UmbContextAlias to UmbContextToken

Browse Source
This commit is contained in:
Jacob Overgaard
2023-01-19 10:57:03 +01:00
parent d30ac60499
commit d1dfa276c5
32 changed files with 68 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/Umbraco.Web.UI.Client/src/backoffice/documents/document-blueprints/document-blueprint.store.ts
View File

@@ -2,7 +2,7 @@ import { map, Observable } from 'rxjs';
import { UmbNodeStoreBase } from '../../../core/stores/store';
import type { DocumentBlueprintDetails, DocumentDetails } from '@umbraco-cms/models';
import { DocumentBlueprintTreeItem } from '@umbraco-cms/backend-api';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
export type UmbDocumentStoreItemType = DocumentBlueprintDetails | DocumentBlueprintTreeItem;
@@ -41,4 +41,4 @@ export class UmbDocumentBlueprintStore extends UmbNodeStoreBase<UmbDocumentStore
}
}
export const UMB_DOCUMENT_BLULEPRINT_STORE_CONTEXT_ALIAS = new UmbContextAlias<UmbDocumentBlueprintStore>(STORE_ALIAS);
export const UMB_DOCUMENT_BLULEPRINT_STORE_CONTEXT_ALIAS = new UmbContextToken<UmbDocumentBlueprintStore>(STORE_ALIAS);

4
src/Umbraco.Web.UI.Client/src/backoffice/documents/document-types/document-type.store.ts
View File

@@ -3,7 +3,7 @@ import { UmbDataStoreBase } from '../../../core/stores/store';
import { DocumentTypeResource, DocumentTypeTreeItem } from '@umbraco-cms/backend-api';
import type { DocumentTypeDetails } from '@umbraco-cms/models';
import { tryExecuteAndNotify } from '@umbraco-cms/resources';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
export const isDocumentTypeDetails = (
documentType: DocumentTypeDetails | DocumentTypeTreeItem
@@ -86,4 +86,4 @@ export class UmbDocumentTypeStore extends UmbDataStoreBase<UmbDocumentTypeStoreI
}
}
export const UMB_DOCUMENT_TYPE_STORE_CONTEXT_ALIAS = new UmbContextAlias<UmbDocumentTypeStore>(STORE_ALIAS);
export const UMB_DOCUMENT_TYPE_STORE_CONTEXT_ALIAS = new UmbContextToken<UmbDocumentTypeStore>(STORE_ALIAS);

4
src/Umbraco.Web.UI.Client/src/backoffice/documents/documents/document.store.ts
View File

@@ -3,7 +3,7 @@ import { UmbNodeStoreBase } from '../../../core/stores/store';
import type { DocumentDetails } from '@umbraco-cms/models';
import { DocumentResource, DocumentTreeItem, FolderTreeItem } from '@umbraco-cms/backend-api';
import { tryExecuteAndNotify } from '@umbraco-cms/resources';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
export const isDocumentDetails = (document: DocumentDetails | DocumentTreeItem): document is DocumentDetails => {
return (document as DocumentDetails).data !== undefined;
@@ -131,4 +131,4 @@ export class UmbDocumentStore extends UmbNodeStoreBase<UmbDocumentStoreItemType>
}
}
export const UMB_DOCUMENT_STORE_CONTEXT_ALIAS = new UmbContextAlias<UmbDocumentStore>(STORE_ALIAS);
export const UMB_DOCUMENT_STORE_CONTEXT_ALIAS = new UmbContextToken<UmbDocumentStore>(STORE_ALIAS);

4
src/Umbraco.Web.UI.Client/src/backoffice/media/media-types/media-type.store.ts
View File

@@ -3,7 +3,7 @@ import { UmbNodeStoreBase } from '../../../core/stores/store';
import { MediaTypeResource, FolderTreeItem } from '@umbraco-cms/backend-api';
import type { MediaTypeDetails } from '@umbraco-cms/models';
import { tryExecuteAndNotify } from '@umbraco-cms/resources';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
export type UmbMediaTypeStoreItemType = MediaTypeDetails | FolderTreeItem;
@@ -90,4 +90,4 @@ export class UmbMediaTypeStore extends UmbNodeStoreBase<UmbMediaTypeStoreItemTyp
}
}
export const UMB_MEDIA_TYPE_STORE_CONTEXT_ALIAS = new UmbContextAlias<UmbMediaTypeStore>(STORE_ALIAS);
export const UMB_MEDIA_TYPE_STORE_CONTEXT_ALIAS = new UmbContextToken<UmbMediaTypeStore>(STORE_ALIAS);

4
src/Umbraco.Web.UI.Client/src/backoffice/media/media/media.store.ts
View File

@@ -3,7 +3,7 @@ import { UmbDataStoreBase } from '../../../core/stores/store';
import type { MediaDetails } from '@umbraco-cms/models';
import { ContentTreeItem, MediaResource } from '@umbraco-cms/backend-api';
import { tryExecuteAndNotify } from '@umbraco-cms/resources';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
const isMediaDetails = (media: UmbMediaStoreItemType): media is MediaDetails => {
return (media as MediaDetails).data !== undefined;
@@ -112,4 +112,4 @@ export class UmbMediaStore extends UmbDataStoreBase<UmbMediaStoreItemType> {
}
}
export const UMB_MEDIA_STORE_CONTEXT_ALIAS = new UmbContextAlias<UmbMediaStore>(STORE_ALIAS);
export const UMB_MEDIA_STORE_CONTEXT_ALIAS = new UmbContextToken<UmbMediaStore>(STORE_ALIAS);

4
src/Umbraco.Web.UI.Client/src/backoffice/members/member-groups/member-group.store.ts
View File

@@ -3,7 +3,7 @@ import { UmbNodeStoreBase } from '../../../core/stores/store';
import { EntityTreeItem, MemberGroupResource } from '@umbraco-cms/backend-api';
import type { MemberGroupDetails } from '@umbraco-cms/models';
import { tryExecuteAndNotify } from '@umbraco-cms/resources';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
export type UmbMemberGroupStoreItemType = MemberGroupDetails | EntityTreeItem;
@@ -37,4 +37,4 @@ export class UmbMemberGroupStore extends UmbNodeStoreBase<UmbMemberGroupStoreIte
}
}
export const UMB_MEMBER_GROUP_STORE_CONTEXT_ALIAS = new UmbContextAlias<UmbMemberGroupStore>(STORE_ALIAS);
export const UMB_MEMBER_GROUP_STORE_CONTEXT_ALIAS = new UmbContextToken<UmbMemberGroupStore>(STORE_ALIAS);

4
src/Umbraco.Web.UI.Client/src/backoffice/members/member-types/member-type.store.ts
View File

@@ -3,7 +3,7 @@ import { UmbDataStoreBase } from '../../../core/stores/store';
import { MemberTypeResource, EntityTreeItem } from '@umbraco-cms/backend-api';
import type { MemberTypeDetails } from '@umbraco-cms/models';
import { tryExecuteAndNotify } from '@umbraco-cms/resources';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
export type UmbMemberTypeStoreItemType = MemberTypeDetails | EntityTreeItem;
@@ -37,4 +37,4 @@ export class UmbMemberTypeStore extends UmbDataStoreBase<UmbMemberTypeStoreItemT
}
}
export const UMB_MEMBER_TYPE_STORE_CONTEXT_ALIAS = new UmbContextAlias<UmbMemberTypeStore>(STORE_ALIAS);
export const UMB_MEMBER_TYPE_STORE_CONTEXT_ALIAS = new UmbContextToken<UmbMemberTypeStore>(STORE_ALIAS);

4
src/Umbraco.Web.UI.Client/src/backoffice/settings/data-types/data-type.store.ts
View File

@@ -3,7 +3,7 @@ import { UmbDataStoreBase } from '../../../core/stores/store';
import type { DataTypeDetails } from '@umbraco-cms/models';
import { DataTypeResource, FolderTreeItem } from '@umbraco-cms/backend-api';
import { tryExecuteAndNotify } from '@umbraco-cms/resources';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
const isDataTypeDetails = (dataType: DataTypeDetails | FolderTreeItem): dataType is DataTypeDetails => {
return (dataType as DataTypeDetails).data !== undefined;
@@ -126,4 +126,4 @@ export class UmbDataTypeStore extends UmbDataStoreBase<UmbDataTypeStoreItemType>
}
}
export const UMB_DATA_TYPE_STORE_CONTEXT_ALIAS = new UmbContextAlias<UmbDataTypeStore>(STORE_ALIAS);
export const UMB_DATA_TYPE_STORE_CONTEXT_ALIAS = new UmbContextToken<UmbDataTypeStore>(STORE_ALIAS);

4
src/Umbraco.Web.UI.Client/src/backoffice/shared/collection/collection.context.ts
View File

@@ -1,7 +1,7 @@
import { ContentTreeItem } from '@umbraco-cms/backend-api';
import { UmbTreeDataStore } from '@umbraco-cms/stores/store';
import { UmbControllerHostInterface } from '@umbraco-cms/controller';
import { UmbContextAlias, UmbContextConsumerController } from '@umbraco-cms/context-api';
import { UmbContextToken, UmbContextConsumerController } from '@umbraco-cms/context-api';
import { UniqueBehaviorSubject, UmbObserverController } from '@umbraco-cms/observable-api';
export class UmbCollectionContext<
DataType extends ContentTreeItem,
@@ -111,6 +111,6 @@ export class UmbCollectionContext<
}
}
export const UMB_COLLECTION_CONTEXT_ALIAS = new UmbContextAlias<UmbCollectionContext<any, any>>(
export const UMB_COLLECTION_CONTEXT_ALIAS = new UmbContextToken<UmbCollectionContext<any, any>>(
UmbCollectionContext.name
);

4
src/Umbraco.Web.UI.Client/src/backoffice/shared/components/section/section.context.ts
View File

@@ -1,7 +1,7 @@
import { BehaviorSubject } from 'rxjs';
import type { Entity, ManifestSection, ManifestSectionView, ManifestTree } from '@umbraco-cms/models';
import { UniqueBehaviorSubject } from '@umbraco-cms/observable-api';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
export class UmbSectionContext {
#manifest;
@@ -45,4 +45,4 @@ export class UmbSectionContext {
}
}
export const UMB_SECTION_CONTEXT_ALIAS = new UmbContextAlias<UmbSectionContext>(UmbSectionContext.name);
export const UMB_SECTION_CONTEXT_ALIAS = new UmbContextToken<UmbSectionContext>(UmbSectionContext.name);

4
src/Umbraco.Web.UI.Client/src/backoffice/shared/components/section/section.store.ts
View File

@@ -1,6 +1,6 @@
import { Observable, ReplaySubject } from 'rxjs';
import { umbExtensionsRegistry } from '@umbraco-cms/extensions-registry';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
// TODO: maybe this should be named something else than store?
export class UmbSectionStore {
@@ -22,4 +22,4 @@ export class UmbSectionStore {
}
}
export const UMB_SECTION_STORE_CONTEXT_ALIAS = new UmbContextAlias<UmbSectionStore>(UmbSectionStore.name);
export const UMB_SECTION_STORE_CONTEXT_ALIAS = new UmbContextToken<UmbSectionStore>(UmbSectionStore.name);

4
src/Umbraco.Web.UI.Client/src/backoffice/shared/components/tree/context-menu/tree-context-menu-page.service.ts
View File

@@ -5,7 +5,7 @@ import UmbTreeItemActionElement, { ActionPageEntity } from '../action/tree-item-
import { UmbTreeContextMenuService } from './tree-context-menu.service';
import { UmbLitElement } from '@umbraco-cms/element';
import { UniqueBehaviorSubject } from '@umbraco-cms/observable-api';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
// TODO: Refactor this, its not a service and the data should be handled by a context api.
@customElement('umb-tree-context-menu-page-service')
@@ -66,7 +66,7 @@ export class UmbTreeContextMenuPageService extends UmbLitElement {
}
}
export const UMB_TREE_CONTEXT_MENU_PAGE_SERVICE_CONTEXT_ALIAS = new UmbContextAlias<UmbTreeContextMenuPageService>(
export const UMB_TREE_CONTEXT_MENU_PAGE_SERVICE_CONTEXT_ALIAS = new UmbContextToken<UmbTreeContextMenuPageService>(
UmbTreeContextMenuService.name
);

4
src/Umbraco.Web.UI.Client/src/backoffice/shared/components/tree/context-menu/tree-context-menu.service.ts
View File

@@ -3,7 +3,7 @@ import { css, html, nothing } from 'lit';
import { customElement, state } from 'lit/decorators.js';
import { ActionPageEntity } from '../action/tree-item-action.element';
import { UmbLitElement } from '@umbraco-cms/element';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
@customElement('umb-tree-context-menu-service')
export class UmbTreeContextMenuService extends UmbLitElement {
@@ -93,7 +93,7 @@ export class UmbTreeContextMenuService extends UmbLitElement {
}
}
export const UMB_TREE_CONTEXT_MENU_SERVICE_CONTEXT_ALIAS = new UmbContextAlias<UmbTreeContextMenuService>(
export const UMB_TREE_CONTEXT_MENU_SERVICE_CONTEXT_ALIAS = new UmbContextToken<UmbTreeContextMenuService>(
UmbTreeContextMenuService.name
);

4
src/Umbraco.Web.UI.Client/src/backoffice/translation/dictionary/dictionary.store.ts
View File

@@ -2,7 +2,7 @@ import { map, Observable } from 'rxjs';
import { UmbDataStoreBase } from '../../../core/stores/store';
import { DictionaryResource, EntityTreeItem } from '@umbraco-cms/backend-api';
import { tryExecuteAndNotify } from '@umbraco-cms/resources';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
export const STORE_ALIAS = 'umbDictionaryStore';
@@ -52,4 +52,4 @@ export class UmbDictionaryStore extends UmbDataStoreBase<EntityTreeItem> {
}
}
export const UMB_DICTIONARY_STORE_CONTEXT_ALIAS = new UmbContextAlias<UmbDictionaryStore>(STORE_ALIAS);
export const UMB_DICTIONARY_STORE_CONTEXT_ALIAS = new UmbContextToken<UmbDictionaryStore>(STORE_ALIAS);

4
src/Umbraco.Web.UI.Client/src/backoffice/users/current-user/current-user-history.store.ts
View File

@@ -1,4 +1,4 @@
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
import { createObservablePart, UniqueBehaviorSubject } from '@umbraco-cms/observable-api';
export type UmbModelType = 'dialog' | 'sidebar';
@@ -50,6 +50,6 @@ export class UmbCurrentUserHistoryStore {
}
}
export const UMB_CURRENT_USER_HISTORY_STORE_CONTEXT_ALIAS = new UmbContextAlias<UmbCurrentUserHistoryStore>(
export const UMB_CURRENT_USER_HISTORY_STORE_CONTEXT_ALIAS = new UmbContextToken<UmbCurrentUserHistoryStore>(
UmbCurrentUserHistoryStore.name
);

4
src/Umbraco.Web.UI.Client/src/backoffice/users/current-user/current-user.store.ts
View File

@@ -2,7 +2,7 @@ import { BehaviorSubject, Observable } from 'rxjs';
import { umbUsersData } from '../../../core/mocks/data/users.data';
import type { UserDetails } from '@umbraco-cms/models';
import { umbracoPath } from '@umbraco-cms/utils';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
export class UmbCurrentUserStore {
private _currentUser = new BehaviorSubject<UserDetails>(umbUsersData.getAll()[0]); //TODO: Temp solution to set the first user as the current logged in user
@@ -28,4 +28,4 @@ export class UmbCurrentUserStore {
}
}
export const UMB_CURRENT_USER_STORE_CONTEXT_ALIAS = new UmbContextAlias<UmbCurrentUserStore>(UmbCurrentUserStore.name);
export const UMB_CURRENT_USER_STORE_CONTEXT_ALIAS = new UmbContextToken<UmbCurrentUserStore>(UmbCurrentUserStore.name);

4
src/Umbraco.Web.UI.Client/src/backoffice/users/user-groups/user-group.store.ts
View File

@@ -1,7 +1,7 @@
import { map, Observable } from 'rxjs';
import { UmbDataStoreBase } from '../../../core/stores/store';
import type { UserGroupDetails, UserGroupEntity } from '@umbraco-cms/models';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
// TODO: get rid of this type addition & { ... }:
export type UmbUserGroupStoreItemType = UserGroupDetails & { users?: Array<string> };
@@ -87,4 +87,4 @@ export class UmbUserGroupStore extends UmbDataStoreBase<UmbUserGroupStoreItemTyp
}
}
export const UMB_USER_GROUP_STORE_CONTEXT_ALIAS = new UmbContextAlias<UmbUserGroupStore>(STORE_ALIAS);
export const UMB_USER_GROUP_STORE_CONTEXT_ALIAS = new UmbContextToken<UmbUserGroupStore>(STORE_ALIAS);

4
src/Umbraco.Web.UI.Client/src/backoffice/users/users/user.store.ts
View File

@@ -2,7 +2,7 @@ import { map, Observable } from 'rxjs';
import { UmbDataStoreBase } from '../../../core/stores/store';
import type { UserDetails } from '@umbraco-cms/models';
import { UniqueBehaviorSubject } from '@umbraco-cms/observable-api';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
export type UmbUserStoreItemType = UserDetails;
@@ -280,4 +280,4 @@ export class UmbUserStore extends UmbDataStoreBase<UmbUserStoreItemType> {
// }
}
export const UMB_USER_STORE_CONTEXT_ALIAS = new UmbContextAlias<UmbUserStore>(STORE_ALIAS);
export const UMB_USER_STORE_CONTEXT_ALIAS = new UmbContextToken<UmbUserStore>(STORE_ALIAS);

4
src/Umbraco.Web.UI.Client/src/core/context-api/consume/context-consumer.controller.ts
View File

@@ -1,4 +1,4 @@
import { UmbContextAlias } from '../context-alias';
import { UmbContextToken } from '../context-token';
import { UmbContextConsumer } from './context-consumer';
import { UmbContextCallback } from './context-request.event';
@@ -14,7 +14,7 @@ export class UmbContextConsumerController<T = unknown>
constructor(
host: UmbControllerHostInterface,
contextAlias: string | UmbContextAlias<T>,
contextAlias: string | UmbContextToken<T>,
callback: UmbContextCallback<T>
) {
super(host, contextAlias, callback);

4
src/Umbraco.Web.UI.Client/src/core/context-api/consume/context-consumer.ts
View File

@@ -1,4 +1,4 @@
import { UmbContextAlias } from '../context-alias';
import { UmbContextToken } from '../context-token';
import { isUmbContextProvideEventType, umbContextProvideEventType } from '../provide/context-provide.event';
import { UmbContextRequestEventImplementation, UmbContextCallback } from './context-request.event';
@@ -26,7 +26,7 @@ export class UmbContextConsumer<HostType extends EventTarget = EventTarget, T =
*/
constructor(
protected host: HostType,
_contextAlias: string | UmbContextAlias<T>,
_contextAlias: string | UmbContextToken<T>,
private _callback: UmbContextCallback<T>
) {
this._contextAlias = _contextAlias.toString();

6
src/Umbraco.Web.UI.Client/src/core/context-api/consume/context-request.event.ts
View File

@@ -1,4 +1,4 @@
import { UmbContextAlias } from '../context-alias';
import { UmbContextToken } from '../context-token';
export const umbContextRequestEventType = 'umb:context-request';
@@ -9,7 +9,7 @@ export type UmbContextCallback<T> = (instance: T) => void;
* @interface UmbContextRequestEvent
*/
export interface UmbContextRequestEvent<T = unknown> extends Event {
readonly contextAlias: string | UmbContextAlias<T>;
readonly contextAlias: string | UmbContextToken<T>;
readonly callback: UmbContextCallback<T>;
}
@@ -21,7 +21,7 @@ export interface UmbContextRequestEvent<T = unknown> extends Event {
*/
export class UmbContextRequestEventImplementation<T = unknown> extends Event implements UmbContextRequestEvent<T> {
public constructor(
public readonly contextAlias: string | UmbContextAlias<T>,
public readonly contextAlias: string | UmbContextToken<T>,
public readonly callback: UmbContextCallback<T>
) {
super(umbContextRequestEventType, { bubbles: true, composed: true, cancelable: true });

4
src/Umbraco.Web.UI.Client/src/core/context-api/context-alias.test.ts → src/Umbraco.Web.UI.Client/src/core/context-api/context-token.test.ts
View File

@@ -1,6 +1,6 @@
import { expect } from '@open-wc/testing';
import { UmbContextConsumer } from './consume/context-consumer';
import { UmbContextAlias } from './context-alias';
import { UmbContextToken } from './context-token';
import { UmbContextProvider } from './provide/context-provider';
const testContextAlias = 'my-test-context';
@@ -10,7 +10,7 @@ class MyClass {
}
describe('ContextAlias', () => {
const contextAlias = new UmbContextAlias<MyClass>(testContextAlias);
const contextAlias = new UmbContextToken<MyClass>(testContextAlias);
const typedProvider = new UmbContextProvider(document.body, contextAlias, new MyClass());
typedProvider.hostConnected();

6
src/Umbraco.Web.UI.Client/src/core/context-api/context-alias.ts → src/Umbraco.Web.UI.Client/src/core/context-api/context-token.ts
View File

@@ -1,4 +1,4 @@
export class UmbContextAlias<T = unknown> {
export class UmbContextToken<T = unknown> {
/**
* @param alias Unique identifier for the token,
* @param _desc Description for the token,
@@ -10,8 +10,8 @@ export class UmbContextAlias<T = unknown> {
/**
* @internal
*/
get multi(): UmbContextAlias<Array<T>> {
return this as UmbContextAlias<Array<T>>;
get multi(): UmbContextToken<Array<T>> {
return this as UmbContextToken<Array<T>>;
}
/**

2
src/Umbraco.Web.UI.Client/src/core/context-api/index.ts
View File

@@ -4,4 +4,4 @@ export * from './consume/context-request.event';
export * from './provide/context-provider.controller';
export * from './provide/context-provider';
export * from './provide/context-provide.event';
export * from './context-alias';
export * from './context-token';

6
src/Umbraco.Web.UI.Client/src/core/context-api/provide/context-provide.event.ts
View File

@@ -1,4 +1,4 @@
import { UmbContextAlias } from '../context-alias';
import { UmbContextToken } from '../context-token';
export const umbContextProvideEventType = 'umb:context-provide';
@@ -7,7 +7,7 @@ export const umbContextProvideEventType = 'umb:context-provide';
* @interface UmbContextProvideEvent
*/
export interface UmbContextProvideEvent extends Event {
readonly contextAlias: string | UmbContextAlias;
readonly contextAlias: string | UmbContextToken;
}
/**
@@ -17,7 +17,7 @@ export interface UmbContextProvideEvent extends Event {
* @implements {UmbContextProvideEvent}
*/
export class UmbContextProvideEventImplementation extends Event implements UmbContextProvideEvent {
public constructor(public readonly contextAlias: string | UmbContextAlias) {
public constructor(public readonly contextAlias: string | UmbContextToken) {
super(umbContextProvideEventType, { bubbles: true, composed: true });
}
}

4
src/Umbraco.Web.UI.Client/src/core/context-api/provide/context-provider.controller.ts
View File

@@ -1,4 +1,4 @@
import { UmbContextAlias } from '../context-alias';
import { UmbContextToken } from '../context-token';
import { UmbContextProvider } from './context-provider';
import type { UmbControllerHostInterface, UmbControllerInterface } from '@umbraco-cms/controller';
@@ -10,7 +10,7 @@ export class UmbContextProviderController<T = unknown>
return this._contextAlias.toString();
}
constructor(host: UmbControllerHostInterface, contextAlias: string | UmbContextAlias<T>, instance: T) {
constructor(host: UmbControllerHostInterface, contextAlias: string | UmbContextToken<T>, instance: T) {
super(host, contextAlias, instance);
// TODO: What if this API is already provided with this alias? maybe handle this in the controller:

2
src/Umbraco.Web.UI.Client/src/core/context-api/provide/context-provider.test.ts
View File

@@ -1,7 +1,7 @@
import { expect } from '@open-wc/testing';
import { UmbContextConsumer } from '../consume/context-consumer';
import { UmbContextRequestEventImplementation } from '../consume/context-request.event';
import { UmbContextAlias } from '../context-alias';
import { UmbContextToken } from '../context-token';
import { UmbContextProvider } from './context-provider';
class MyClass {

4
src/Umbraco.Web.UI.Client/src/core/context-api/provide/context-provider.ts
View File

@@ -1,5 +1,5 @@
import { umbContextRequestEventType, isUmbContextRequestEvent } from '../consume/context-request.event';
import { UmbContextAlias } from '../context-alias';
import { UmbContextToken } from '../context-token';
import { UmbContextProvideEventImplementation } from './context-provide.event';
/**
@@ -19,7 +19,7 @@ export class UmbContextProvider<HostType extends EventTarget = EventTarget> {
* @param {*} instance
* @memberof UmbContextProvider
*/
constructor(host: HostType, contextAlias: string | UmbContextAlias, instance: unknown) {
constructor(host: HostType, contextAlias: string | UmbContextToken, instance: unknown) {
this.host = host;
this._contextAlias = contextAlias.toString();
this.#instance = instance;

10
src/Umbraco.Web.UI.Client/src/core/element/element.mixin.ts
View File

@@ -4,7 +4,7 @@ import type { HTMLElementConstructor } from '../models';
import { UmbControllerHostInterface, UmbControllerHostMixin } from '@umbraco-cms/controller';
import {
UmbContextAlias,
UmbContextToken,
UmbContextCallback,
UmbContextConsumerController,
UmbContextProviderController,
@@ -18,9 +18,9 @@ interface ResolvedContexts {
export declare class UmbElementMixinInterface extends UmbControllerHostInterface {
observe<T>(source: Observable<T>, callback: (_value: T) => void, unique?: string): UmbObserverController<T>;
provideContext<R = unknown>(alias: string | UmbContextAlias<R>, instance: R): UmbContextProviderController<R>;
provideContext<R = unknown>(alias: string | UmbContextToken<R>, instance: R): UmbContextProviderController<R>;
consumeContext<R = unknown>(
alias: string | UmbContextAlias<R>,
alias: string | UmbContextToken<R>,
callback: UmbContextCallback<R>
): UmbContextConsumerController<R>;
consumeAllContexts(contextAliases: string[], callback: (_instances: ResolvedContexts) => void): void;
@@ -46,7 +46,7 @@ export const UmbElementMixin = <T extends HTMLElementConstructor>(superClass: T)
* @return {UmbContextProviderController} Reference to a Context Provider Controller instance
* @memberof UmbElementMixin
*/
provideContext<R = unknown>(alias: string | UmbContextAlias<R>, instance: R): UmbContextProviderController<R> {
provideContext<R = unknown>(alias: string | UmbContextToken<R>, instance: R): UmbContextProviderController<R> {
return new UmbContextProviderController(this, alias, instance);
}
@@ -58,7 +58,7 @@ export const UmbElementMixin = <T extends HTMLElementConstructor>(superClass: T)
* @memberof UmbElementMixin
*/
consumeContext<R = unknown>(
alias: string | UmbContextAlias<R>,
alias: string | UmbContextToken<R>,
callback: UmbContextCallback<R>
): UmbContextConsumerController<R> {
return new UmbContextConsumerController(this, alias, callback);

4
src/Umbraco.Web.UI.Client/src/core/modal/modal.service.ts
View File

@@ -15,7 +15,7 @@ import type { UmbModalConfirmData } from './layouts/confirm/modal-layout-confirm
import type { UmbModalContentPickerData } from './layouts/content-picker/modal-layout-content-picker.element';
import type { UmbModalPropertyEditorUIPickerData } from './layouts/property-editor-ui-picker/modal-layout-property-editor-ui-picker.element';
import { UmbModalHandler } from './modal-handler';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
export type UmbModalType = 'dialog' | 'sidebar';
@@ -133,4 +133,4 @@ export class UmbModalService {
}
}
export const UMB_MODAL_SERVICE_CONTEXT_ALIAS = new UmbContextAlias<UmbModalService>(UmbModalService.name);
export const UMB_MODAL_SERVICE_CONTEXT_ALIAS = new UmbContextToken<UmbModalService>(UmbModalService.name);

4
src/Umbraco.Web.UI.Client/src/core/notification/notification.service.ts
View File

@@ -1,6 +1,6 @@
import { BehaviorSubject } from 'rxjs';
import { UmbNotificationHandler } from '.';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
export type UmbNotificationData = any;
@@ -86,6 +86,6 @@ export class UmbNotificationService {
}
}
export const UMB_NOTIFICATION_SERVICE_CONTEXT_ALIAS = new UmbContextAlias<UmbNotificationService>(
export const UMB_NOTIFICATION_SERVICE_CONTEXT_ALIAS = new UmbContextToken<UmbNotificationService>(
UmbNotificationService.name
);

4
src/Umbraco.Web.UI.Client/src/installer/installer.context.ts
View File

@@ -1,7 +1,7 @@
import { BehaviorSubject, Observable, ReplaySubject } from 'rxjs';
import { Install, InstallResource, InstallSettings, ProblemDetails, TelemetryLevel } from '@umbraco-cms/backend-api';
import { tryExecute } from '@umbraco-cms/resources';
import { UmbContextAlias } from '@umbraco-cms/context-api';
import { UmbContextToken } from '@umbraco-cms/context-api';
/**
* Context API for the installer
@@ -123,4 +123,4 @@ export class UmbInstallerContext {
}
}
export const UMB_INSTALLER_CONTEXT_ALIAS = new UmbContextAlias<UmbInstallerContext>(UmbInstallerContext.name);
export const UMB_INSTALLER_CONTEXT_ALIAS = new UmbContextToken<UmbInstallerContext>(UmbInstallerContext.name);