Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ssr-client] Move experimental hydrate modules #3720

Merged
merged 10 commits into from Apr 3, 2023
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions .changeset/pretty-goats-switch.md
@@ -0,0 +1,9 @@
---
'@lit-labs/eleventy-plugin-lit': patch
'@lit-labs/ssr-react': patch
'@lit-labs/testing': patch
'@lit-labs/nextjs': patch
'@lit-labs/ssr': patch
---

Use hydration modules from `@lit-labs/ssr-client`
10 changes: 10 additions & 0 deletions .changeset/sweet-lemons-brake.md
@@ -0,0 +1,10 @@
---
'@lit-labs/ssr-client': minor
'lit-element': patch
'lit-html': patch
'lit': patch
---

`lit-html/experimental-hydrate.js` and `lit-element/experimental-hydrate-support.js` have been moved to `@lit-labs/ssr-client`.

The modules in the original location have been marked deprecated and will be removed in a future version.
4 changes: 3 additions & 1 deletion .eslintignore
Expand Up @@ -273,9 +273,11 @@ packages/labs/ssr/index.*

packages/labs/ssr-client/development/
packages/labs/ssr-client/directives/
packages/labs/ssr-client/controllers/
packages/labs/ssr-client/lib/
packages/labs/ssr-client/node/
packages/labs/ssr-client/node_modules/
packages/labs/ssr-client/index.*
packages/labs/ssr-client/lit-element-hydrate-support.*

packages/labs/ssr-dom-shim/index.*
packages/labs/ssr-dom-shim/lib/
Expand Down
4 changes: 3 additions & 1 deletion .prettierignore
Expand Up @@ -260,9 +260,11 @@ packages/labs/ssr/index.*

packages/labs/ssr-client/development/
packages/labs/ssr-client/directives/
packages/labs/ssr-client/controllers/
packages/labs/ssr-client/lib/
packages/labs/ssr-client/node/
packages/labs/ssr-client/node_modules/
packages/labs/ssr-client/index.*
packages/labs/ssr-client/lit-element-hydrate-support.*

packages/labs/ssr-dom-shim/index.*
packages/labs/ssr-dom-shim/lib/
Expand Down
6 changes: 6 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions packages/labs/eleventy-plugin-lit/README.md
Expand Up @@ -252,7 +252,7 @@ to their JavaScript implementations, becoming responsive and interactive.
Lit components can automatically hydrate themselves when they detect that a
Shadow Root has already been attached, as long as Lit's _experimental hydrate
support_ module has been installed by importing
[`lit/experimental-hydrate-support.js`](https://github.com/lit/lit/blob/main/packages/lit-element/src/experimental-hydrate-support.ts).
[`@lit-labs/ssr-client/lit-element-hydrate-support.js`](https://github.com/lit/lit/blob/main/packages/labs/ssr-client/src/lit-element-hydrate-support.ts).

> ⏱️ The Lit hydration support module **must be loaded before Lit or any
> components that depend on Lit are imported**, because it modifies the initial
Expand Down Expand Up @@ -325,7 +325,7 @@ The file `_includes/default.html` would then contain the following:
execute them yet, though. -->
<link
rel="modulepreload"
href="/node_modules/lit/experimental-hydrate-support.js"
href="/node_modules/@lit-labs/ssr-client/lit-element-hydrate-support.js"
/>
<link rel="modulepreload" href="/_js/component1.js" />
<link rel="modulepreload" href="/_js/component2.js" />
Expand Down Expand Up @@ -368,7 +368,7 @@ The file `_includes/default.html` would then contain the following:
// Start fetching the Lit hydration support module (note the absence
// of "await" -- we don't want to block yet).
const litHydrateSupportInstalled = import(
'/node_modules/lit/experimental-hydrate-support.js'
'/node_modules/@lit-labs/ssr-client/lit-element-hydrate-support.js'
);

// Check if we require the declarative shadow DOM polyfill. As of
Expand Down
Expand Up @@ -44,7 +44,7 @@
// Start fetching the Lit hydration support module (note the absence
// of "await" -- we don't want to block yet).
const litHydrateSupportInstalled = import(
'lit/experimental-hydrate-support.js'
'@lit-labs/ssr-client/lit-element-hydrate-support.js'
);

// Check if we require the declarative shadow DOM polyfill. As of
Expand Down
2 changes: 1 addition & 1 deletion packages/labs/nextjs/src/index.ts
Expand Up @@ -28,7 +28,7 @@ export = (_pluginOptions: LitSsrPluginOptions = {}) =>
options: {
// This adds a side-effectful import which monkey patches
// `React.createElement` in the server and imports
// `lit/experimental-hydrate-support.js` in the client.
// `@lit-labs/ssr-client/lit-element-hydrate-support.js` in the client.
imports: ['side-effects @lit-labs/ssr-react/enable-lit-ssr.js'],
},
});
Expand Down
4 changes: 3 additions & 1 deletion packages/labs/ssr-client/.gitignore
@@ -1,5 +1,7 @@
/development/
/directives/
/controllers/
/lib/
/node/
/node_modules/
/index.*
/lit-element-hydrate-support.*
32 changes: 27 additions & 5 deletions packages/labs/ssr-client/package.json
Expand Up @@ -18,10 +18,25 @@
},
"exports": {
".": {
"types": "./development/index.d.ts",
"node": {
"development": "./node/development/index.js",
"default": "./node/index.js"
},
"development": "./development/index.js",
"default": "./index.js"
},
"./lit-element-hydrate-support.js": {
"types": "./development/lit-element-hydrate-support.d.ts",
"node": {
"development": "./node/development/lit-element-hydrate-support.js",
"default": "./node/lit-element-hydrate-support.js"
},
"development": "./development/lit-element-hydrate-support.js",
"default": "./lit-element-hydrate-support.js"
},
"./directives/render-light.js": {
"types": "./development/directives/render-light.d.ts",
"development": "./development/directives/render-light.js",
"default": "./directives/render-light.js"
}
Expand All @@ -30,7 +45,9 @@
"/development/",
"!/development/test/",
"/directives/",
"/index.{d.ts,d.ts.map,js,js.map}"
"/lib/",
"/index.{d.ts,d.ts.map,js,js.map}",
"/lit-element-hydrate-support.{d.ts,d.ts.map,js,js.map}"
],
"scripts": {
"build": "wireit",
Expand Down Expand Up @@ -72,7 +89,8 @@
"files": [],
"output": [
"*.d.ts{,.map}",
"directives/*.d.ts{,.map}"
"directives/*.d.ts{,.map}",
"lib/*.d.ts{,.map}"
]
},
"build:rollup": {
Expand All @@ -86,7 +104,10 @@
],
"output": [
"index.js{,.map}",
"directives/*.js{,.map}"
"lit-element-hydrate-support.js{,.map}",
"directives/*.js{,.map}",
"lib/*.js{,.map}",
"node/"
]
},
"checksize": {
Expand All @@ -106,9 +127,10 @@
"@lit-internal/scripts": "^1.0.0"
},
"dependencies": {
"@lit-labs/ssr-dom-shim": "^1.1.0",
augustjk marked this conversation as resolved.
Show resolved Hide resolved
"@lit/reactive-element": "^1.0.0",
"lit": "^2.0.0",
"lit-html": "^2.0.0",
"@lit/reactive-element": "^1.0.0"
"lit-html": "^2.0.0"
},
"publishConfig": {
"access": "public"
Expand Down
7 changes: 6 additions & 1 deletion packages/labs/ssr-client/rollup.config.js
Expand Up @@ -9,6 +9,11 @@ import {createRequire} from 'module';

export default litProdConfig({
packageName: createRequire(import.meta.url)('./package.json').name,
entryPoints: ['index', 'directives/render-light'],
entryPoints: [
'index',
'lit-element-hydrate-support',
'directives/render-light',
],
external: ['lit/directive.js', 'lit/directive-helpers.js'],
includeNodeBuild: true,
});
11 changes: 11 additions & 0 deletions packages/labs/ssr-client/src/env.d.ts
@@ -0,0 +1,11 @@
/**
* @license
* Copyright 2020 Google LLC
* SPDX-License-Identifier: BSD-3-Clause
*/

// eslint-disable-next-line no-var
declare var litElementHydrateSupport:
| undefined
// eslint-disable-next-line @typescript-eslint/no-explicit-any
| ((options: {LitElement: any}) => void);
2 changes: 1 addition & 1 deletion packages/labs/ssr-client/src/index.ts
Expand Up @@ -3,4 +3,4 @@
* Copyright 2017 Google LLC
* SPDX-License-Identifier: BSD-3-Clause
*/
export {};
export * from './lib/hydrate-lit-html.js';