bb88604045
Phase 2 of Core DI migration: - Add *core.Core field + SetCore() to PrepSubsystem and monitor.Subsystem - Register agentic/monitor/brain as Core services with lifecycle hooks - Mark SetCompletionNotifier and SetNotifier as deprecated (removed in Phase 3) - Fix monitor test to match actual event names - initServices() now wires Core refs before legacy callbacks Co-Authored-By: Virgil <virgil@lethean.io>
4.8 KiB
@lit-labs/ssr-dom-shim
Overview
This package provides minimal implementations of Element, HTMLElement,
EventTarget, Event, CustomEvent, CustomElementRegistry, and
customElements, designed to be used when Server Side Rendering (SSR) web
components from Node, including Lit components.
Usage
Usage from Lit
Lit itself automatically imports these shims when running in Node, so Lit users should typically not need to directly depend on or import from this package.
See the lit.dev SSR docs for general information about server-side rendering with Lit.
Usage in other contexts
Other libraries or frameworks who wish to support SSR are welcome to also depend
on these shims. (This package is planned to eventually move to
@webcomponents/ssr-dom-shim to better reflect this use case). There are two
main patterns for providing access to these shims to users:
-
Assigning shims to
globalThis, ensuring that assignment occurs before user-code runs. -
Importing shims directly from the module that provides your base class, using the
nodeexport condition to ensure this only happens when running in Node, and not in the browser.
Lit takes approach #2 for all of the shims except for customElements, Event
and CustomEvent, so that users who have imported lit are able to call
customElements.define or new Event(...)/new CustomEvent(...) in their
components from Node.
Exports
The main module exports the following values. Note that no globals are set by this module.
EventTargetElement- (Inherits from EventTarget)
attachShadowshadowRootattributeshasAttributegetAttributesetAttributeremoveAttribute
HTMLElement- (Inherits from Element)
CustomElementRegistrycustomElementsEventCustomEventMediaListStyleSheetCSSRuleCSSRuleListCSSStyleSheet- (Inherits from StyleSheet)
replacereplaceSync
CSS Node.js customization hook
@lit-labs/ssr-dom-shim/register-css-hook.js implements/registers a
Node.js customization hook
(Node.js >= 18.6.0) to import CSS files/modules as instances of CSSStyleSheet.
import styles from 'my-styles.css' with {type: 'css'};
// styles is now an instance of CSSStyleSheet
This can either be used as a parameter with the Node.js CLI
(e.g. node --import @lit-labs/ssr-dom-shim/register-css-hook.js my-script.js or via
environment variable NODE_OPTIONS="--import @lit-labs/ssr-dom-shim/register-css-hook.js")
or imported inline, and it will apply to any module dynamically imported afterwards
(e.g. import @lit-labs/ssr-dom-shim/register-css-hook.js and
subsequently await import('./my-component.js')).
Contributing
Please see CONTRIBUTING.md.