integrate @umbraco-cms/element and @umbraco-cms/context-api due to circular dependencies

This commit is contained in:
Jacob Overgaard
2023-01-23 16:24:42 +01:00
parent f836800220
commit e87439ff5f
168 changed files with 274 additions and 436 deletions

View File

@@ -0,0 +1,93 @@
import { Observable } from 'rxjs';
import type { UmbContextToken } from '../context-token';
import { UmbContextProviderController } from '../provide/context-provider.controller';
import type { UmbContextCallback } from '../consume/context-request.event';
import { UmbContextConsumerController } from '../consume/context-consumer.controller';
import type { HTMLElementConstructor } from '@umbraco-cms/models';
import { UmbControllerHostInterface, UmbControllerHostMixin } from '@umbraco-cms/controller';
import { UmbObserverController } from '@umbraco-cms/observable-api';
// TODO: can we use this aliases to generate the key of this type
interface ResolvedContexts {
[key: string]: any;
}
export declare class UmbElementMixinInterface extends UmbControllerHostInterface {
observe<T>(source: Observable<T>, callback: (_value: T) => void, unique?: string): UmbObserverController<T>;
provideContext<R = unknown>(alias: string | UmbContextToken<R>, instance: R): UmbContextProviderController<R>;
consumeContext<R = unknown>(
alias: string | UmbContextToken<R>,
callback: UmbContextCallback<R>
): UmbContextConsumerController<R>;
consumeAllContexts(contextAliases: string[], callback: (_instances: ResolvedContexts) => void): void;
}
export const UmbElementMixin = <T extends HTMLElementConstructor>(superClass: T) => {
class UmbElementMixinClass extends UmbControllerHostMixin(superClass) implements UmbElementMixinInterface {
/**
* @description Observe a RxJS source of choice.
* @param {Observable<T>} source RxJS source
* @param {method} callback Callback method called when data is changed.
* @return {UmbObserverController} Reference to a Observer Controller instance
* @memberof UmbElementMixin
*/
observe<T>(source: Observable<T>, callback: (_value: T) => void, unique?: string): UmbObserverController<T> {
return new UmbObserverController<T>(this, source, callback, unique);
}
/**
* @description Provide a context API for this or child elements.
* @param {string} alias
* @param {instance} instance The API instance to be exposed.
* @return {UmbContextProviderController} Reference to a Context Provider Controller instance
* @memberof UmbElementMixin
*/
provideContext<R = unknown>(alias: string | UmbContextToken<R>, instance: R): UmbContextProviderController<R> {
return new UmbContextProviderController(this, alias, instance);
}
/**
* @description Setup a subscription for a context. The callback is called when the context is resolved.
* @param {string} alias
* @param {method} callback Callback method called when context is resolved.
* @return {UmbContextConsumerController} Reference to a Context Consumer Controller instance
* @memberof UmbElementMixin
*/
consumeContext<R = unknown>(
alias: string | UmbContextToken<R>,
callback: UmbContextCallback<R>
): UmbContextConsumerController<R> {
return new UmbContextConsumerController(this, alias, callback);
}
/**
* @description Setup a subscription for multiple contexts. The callback is called when all contexts are resolved.
* @param {string} aliases
* @param {method} callback Callback method called when all contexts are resolved.
* @memberof UmbElementMixin
* @deprecated it should not be necessary to consume multiple contexts at once, use consumeContext instead with an UmbContextToken
*/
consumeAllContexts(_contextAliases: Array<string>, callback: (_instances: ResolvedContexts) => void) {
let resolvedAmount = 0;
const controllers = _contextAliases.map(
(alias) =>
new UmbContextConsumerController(this, alias, () => {
resolvedAmount++;
if (resolvedAmount === _contextAliases.length) {
const result: ResolvedContexts = {};
controllers.forEach((contextCtrl: UmbContextConsumerController) => {
result[contextCtrl.consumerAlias?.toString()] = contextCtrl.instance;
});
callback(result);
}
})
);
}
}
return UmbElementMixinClass as unknown as HTMLElementConstructor<UmbElementMixinInterface> & T;
};

View File

@@ -0,0 +1,2 @@
export * from './element.mixin';
export * from './lit-element.element';

View File

@@ -0,0 +1,6 @@
import { LitElement } from 'lit';
import { UmbElementMixin } from './element.mixin';
export class UmbLitElement extends UmbElementMixin(LitElement) {
}

View File

@@ -6,3 +6,4 @@ export * from './provide/context-provider';
export * from './provide/context-provide.event';
export * from './provide/context-provider.element';
export * from './context-token';
export * from './element';

View File

@@ -1,20 +0,0 @@
{
"name": "@umbraco-cms/context-api",
"version": "0.0.0",
"description": "",
"module": "dist/index.js",
"type": "module",
"files": [
"dist"
],
"scripts": {
"build": "rollup -c",
"test": "echo \"Error: no test specified\" && exit 1"
},
"dependencies": {
"lit": "^2.6.1",
"@umbraco-cms/element": "^0.0.0"
},
"author": "Umbraco HQ",
"license": "MIT"
}

View File

@@ -1,7 +1,7 @@
import { expect, fixture, html } from '@open-wc/testing';
import { customElement } from 'lit/decorators.js';
import { UmbContextProviderElement } from './context-provider.element';
import { UmbLitElement } from '@umbraco-cms/element';
import { UmbLitElement } from '@umbraco-cms/context-api';
@customElement('umb-context-test')
export class ContextTestElement extends UmbLitElement {

View File

@@ -1,6 +1,6 @@
import { html } from 'lit';
import { customElement, property } from 'lit/decorators.js';
import { UmbLitElement } from '@umbraco-cms/element';
import { UmbLitElement } from '../element';
@customElement('umb-context-provider')
export class UmbContextProviderElement extends UmbLitElement {