@podium/client 5.2.0-next.3 → 5.2.0-next.4

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [5.2.0-next.4](https://github.com/podium-lib/client/compare/v5.2.0-next.3...v5.2.0-next.4) (2024-09-24)
+
+
+### Bug Fixes
+
+* update @podium/utils to support hints asset collection ([fe97c44](https://github.com/podium-lib/client/commit/fe97c44bc6d29d1e45d335235cd3b1ef6eeafeaa))
+
+
+### Features
+
+* keep track of which resources have emitted early hints and emit complete event once all resources have emitted ([7cf916a](https://github.com/podium-lib/client/commit/7cf916ab286a3c6cb8fbfdae46634b58f2be256f))
+
 # [5.2.0-next.3](https://github.com/podium-lib/client/compare/v5.2.0-next.2...v5.2.0-next.3) (2024-09-20)
 
 

package/lib/http-outgoing.js

@@ -70,6 +70,7 @@ export default class PodletClientHttpOutgoing extends PassThrough {
     #uri;
     #js;
     #css;
+    #hintsReceived = false;
 
     /**
      * @constructor
@@ -300,6 +301,20 @@ export default class PodletClientHttpOutgoing extends PassThrough {
         this.#redirect = value;
     }
 
+    get hintsReceived() {
+        return this.#hintsReceived;
+    }
+
+    set hintsReceived(value) {
+        this.#hintsReceived = value;
+        if (this.#hintsReceived) {
+            this.#incoming?.hints?.addReceivedHint(this.#name, {
+                js: this.js,
+                css: this.css,
+            });
+        }
+    }
+
     /**
      * Whether the podlet can signal redirects to the layout.
      *
@@ -337,6 +352,8 @@ export default class PodletClientHttpOutgoing extends PassThrough {
         this.css = this.#manifest._css;
         this.push(null);
         this.#isFallback = true;
+        // assume the hints from the podlet have failed and fallback assets will be used
+        this.hintsReceived = true;
     }
 
     writeEarlyHints(cb = () => {}) {

package/lib/resolver.content.js

@@ -139,8 +139,6 @@ export default class PodletClientContentResolver {
             outgoing.contentUri,
         );
 
-        let hintsReceived = false;
-
         /** @type {import('./http.js').PodiumHttpClientRequestOptions} */
         const reqOptions = {
             rejectUnauthorized: outgoing.rejectUnauthorized,
@@ -149,7 +147,7 @@ export default class PodletClientContentResolver {
             query: outgoing.reqOptions.query,
             headers,
             onInfo: ({ statusCode, headers }) => {
-                if (statusCode === 103 && !hintsReceived) {
+                if (statusCode === 103 && !outgoing.hintsReceived) {
                     const parsedAssetObjects = parseLinkHeaders(headers.link);
 
                     const scriptObjects = parsedAssetObjects.filter(
@@ -165,7 +163,7 @@ export default class PodletClientContentResolver {
                     // write the early hints to the browser
                     if (this.#earlyHints) outgoing.writeEarlyHints();
 
-                    hintsReceived = true;
+                    outgoing.hintsReceived = true;
                 }
             },
         };

package/lib/resource.js

@@ -105,6 +105,10 @@ export default class PodiumClientResource {
             throw new TypeError(
                 'you must pass an instance of "HttpIncoming" as the first argument to the .fetch() method',
             );
+        // add the name of this resource as expecting a hint to be received
+        // we use this to track across resources and emit a hint completion event once
+        // all hints from all resources have been received.
+        incoming.hints.addExpectedHint(this.#options.name);
         const outgoing = new HttpOutgoing(this.#options, reqOptions, incoming);
 
         if (this.#options.excludeBy) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@podium/client",
-  "version": "5.2.0-next.3",
+  "version": "5.2.0-next.4",
   "type": "module",
   "license": "MIT",
   "keywords": [
@@ -40,7 +40,7 @@
     "@hapi/boom": "10.0.1",
     "@metrics/client": "2.5.3",
     "@podium/schemas": "5.0.6",
-    "@podium/utils": "5.2.1",
+    "@podium/utils": "5.3.1",
     "abslog": "2.4.4",
     "http-cache-semantics": "^4.0.3",
     "lodash.clonedeep": "^4.5.0",

package/types/http-outgoing.d.ts

@@ -105,6 +105,8 @@ export default class PodletClientHttpOutgoing extends PassThrough {
      * @see https://podium-lib.io/docs/layout/handling_redirects
      */
     get redirect(): PodiumRedirect;
+    set hintsReceived(value: boolean);
+    get hintsReceived(): boolean;
     set redirectable(value: boolean);
     /**
      * Whether the podlet can signal redirects to the layout.