@lwrjs/shared-utils 0.20.0 → 0.20.2

package/build/cjs/html-meta.cjs

@@ -27,10 +27,12 @@ __export(exports, {
   HYDRATE_CLIENT_VALUE: () => HYDRATE_CLIENT_VALUE,
   HYDRATE_DIRECTIVE: () => HYDRATE_DIRECTIVE,
   HYDRATE_LOAD_VALUE: () => HYDRATE_LOAD_VALUE,
+  HYDRATE_VISIBLE_VALUE: () => HYDRATE_VISIBLE_VALUE,
   extractMetadataFromHtml: () => extractMetadataFromHtml,
   getHydrateDirective: () => getHydrateDirective,
   isCsrIsland: () => isCsrIsland,
   isHydrateOnLoad: () => isHydrateOnLoad,
+  isHydrateVisible: () => isHydrateVisible,
   isRelative: () => isRelative,
   isSelfUrl: () => isSelfUrl
 });
@@ -172,8 +174,9 @@ function extractMetadataFromHtml(htmlSource, viewMetadata, appConfig) {
 }
 var HYDRATE_DIRECTIVE = "lwr:hydrate";
 var HYDRATE_LOAD_VALUE = "load";
+var HYDRATE_VISIBLE_VALUE = "visible";
 var HYDRATE_CLIENT_VALUE = "client-only";
-var HYDRATION_VALUES = [HYDRATE_LOAD_VALUE, HYDRATE_CLIENT_VALUE];
+var HYDRATION_VALUES = [HYDRATE_LOAD_VALUE, HYDRATE_CLIENT_VALUE, HYDRATE_VISIBLE_VALUE];
 function getHydrateDirective(props = {}) {
   const rawValue = props[HYDRATE_DIRECTIVE];
   const value = rawValue === "true" ? HYDRATE_LOAD_VALUE : rawValue;
@@ -183,6 +186,9 @@ function getHydrateDirective(props = {}) {
 function isHydrateOnLoad(props = {}) {
   return getHydrateDirective(props) === HYDRATE_LOAD_VALUE;
 }
+function isHydrateVisible(props = {}) {
+  return getHydrateDirective(props) === HYDRATE_VISIBLE_VALUE;
+}
 function isCsrIsland(props = {}) {
   return getHydrateDirective(props) === HYDRATE_CLIENT_VALUE;
 }

package/build/es/html-meta.d.ts

@@ -8,8 +8,15 @@ export declare function isSelfUrl(url: string): boolean;
 export declare function extractMetadataFromHtml(htmlSource: string, viewMetadata: RenderedViewMetadata, appConfig: NormalizedLwrGlobalConfig): HtmlMetadata;
 export declare const HYDRATE_DIRECTIVE = "lwr:hydrate";
 export declare const HYDRATE_LOAD_VALUE = "load";
+export declare const HYDRATE_VISIBLE_VALUE = "visible";
 export declare const HYDRATE_CLIENT_VALUE = "client-only";
-export declare function getHydrateDirective(props?: Record<string, string>): string | undefined;
-export declare function isHydrateOnLoad(props?: {}): boolean;
-export declare function isCsrIsland(props?: {}): boolean;
+export declare function getHydrateDirective(props?: Readonly<Record<string, string>>): string | undefined;
+export declare function isHydrateOnLoad(props?: Readonly<Record<string, string>>): boolean;
+/**
+ * Checks if the custom element is a hydration visible island by on the lwr:hydrate attribute.
+ * @param props - The custom element properties
+ * @returns True if the custom element is a hydration visible island
+ */
+export declare function isHydrateVisible(props?: Readonly<Record<string, string>>): boolean;
+export declare function isCsrIsland(props?: Readonly<Record<string, string>>): boolean;
 //# sourceMappingURL=html-meta.d.ts.map

package/build/es/html-meta.js

@@ -171,8 +171,9 @@ export function extractMetadataFromHtml(htmlSource, viewMetadata, appConfig) {
 }
 export const HYDRATE_DIRECTIVE = 'lwr:hydrate';
 export const HYDRATE_LOAD_VALUE = 'load';
+export const HYDRATE_VISIBLE_VALUE = 'visible';
 export const HYDRATE_CLIENT_VALUE = 'client-only';
-const HYDRATION_VALUES = [HYDRATE_LOAD_VALUE, HYDRATE_CLIENT_VALUE];
+const HYDRATION_VALUES = [HYDRATE_LOAD_VALUE, HYDRATE_CLIENT_VALUE, HYDRATE_VISIBLE_VALUE];
 export function getHydrateDirective(props = {}) {
     const rawValue = props[HYDRATE_DIRECTIVE];
     const value = rawValue === 'true' ? HYDRATE_LOAD_VALUE : rawValue; // valueless hyration directives => lwr:hydrate="load"
@@ -182,6 +183,14 @@ export function getHydrateDirective(props = {}) {
 export function isHydrateOnLoad(props = {}) {
     return getHydrateDirective(props) === HYDRATE_LOAD_VALUE;
 }
+/**
+ * Checks if the custom element is a hydration visible island by on the lwr:hydrate attribute.
+ * @param props - The custom element properties
+ * @returns True if the custom element is a hydration visible island
+ */
+export function isHydrateVisible(props = {}) {
+    return getHydrateDirective(props) === HYDRATE_VISIBLE_VALUE;
+}
 export function isCsrIsland(props = {}) {
     return getHydrateDirective(props) === HYDRATE_CLIENT_VALUE;
 }

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.20.0",
+    "version": "0.20.2",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -37,7 +37,7 @@
         "build/**/*.d.ts"
     ],
     "dependencies": {
-        "@lwrjs/diagnostics": "0.20.0",
+        "@lwrjs/diagnostics": "0.20.2",
         "es-module-lexer": "^1.5.4",
         "fast-json-stable-stringify": "^2.1.0",
         "magic-string": "^0.30.9",
@@ -50,7 +50,7 @@
         "slugify": "^1.4.5"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.20.0",
+        "@lwrjs/types": "0.20.2",
         "@types/mime-types": "2.1.4",
         "@types/path-to-regexp": "^1.7.0",
         "memfs": "^4.13.0"
@@ -58,5 +58,5 @@
     "engines": {
         "node": ">=20.0.0"
     },
-    "gitHead": "d2632661c89b535cc33b131edf04b7a75ca9469c"
+    "gitHead": "be82aca54f9a3b6cd18a4aac86f2f96c0184a930"
 }