@podium/client 5.0.0-next.9 → 5.0.0

package/lib/resource.js

@@ -1,7 +1,6 @@
 /* eslint-disable no-param-reassign */
 
 import Metrics from '@metrics/client';
-import stream from 'stream';
 import abslog from 'abslog';
 import assert from 'assert';
 
@@ -63,22 +62,16 @@ export default class PodiumClientResource {
 
         this.#state.setInitializingState();
 
-        const chunks = [];
-        const to = new stream.Writable({
-            write: (chunk, encoding, next) => {
-                chunks.push(chunk);
-                next();
-            },
-        });
-
-        stream.pipeline([outgoing, to], () => {
-            // noop
-        });
-
-        const { manifest, headers, redirect } = await this.#resolver.resolve(
+        const { manifest, headers, redirect, isFallback } = await this.#resolver.resolve(
             outgoing,
         );
 
+        const chunks = [];
+        // eslint-disable-next-line no-restricted-syntax
+        for await (const chunk of outgoing) {
+            chunks.push(chunk)
+        }
+
         const content = !outgoing.redirect
             ? Buffer.concat(chunks).toString()
             : '';
@@ -86,8 +79,8 @@ export default class PodiumClientResource {
         return new Response({
             headers,
             content,
-            css: manifest.css,
-            js: manifest.js,
+            css: utils.filterAssets(isFallback ? "fallback" : "content", manifest.css),
+            js: utils.filterAssets(isFallback ? "fallback" : "content", manifest.js),
             redirect,
         });
     }

package/lib/response.js

@@ -60,15 +60,11 @@ export default class PodiumClientResponse {
 
     [inspect]() {
         return {
-            referrerpolicy: this.referrerpolicy,
-            crossorigin: this.crossorigin,
-            integrity: this.integrity,
-            nomodule: this.nomodule,
-            value: this.value,
-            async: this.async,
-            defer: this.defer,
-            type: this.type,
-            data: this.data,
+            redirect: this.redirect,
+            content: this.content,
+            headers: this.headers,
+            css: this.css,
+            js: this.js,
         };
     }
 

package/lib/utils.js

@@ -32,4 +32,44 @@ export const hasManifestChange = item => {
     return oldVersion !== newVersion;
 };
 
+
+/**
+ * Check if a value is a HttpIncoming object or not. If not, it
+ * assume the incoming value is a context
+ *
+ * @param {Object} incoming A object
+ *
+ * @returns {HttpIncoming}
+ */
 export const validateIncoming = (incoming = {}) => (Object.prototype.toString.call(incoming) === '[object PodiumHttpIncoming]');
+
+/**
+ * @typedef {import("@podium/utils").AssetCss | import("@podium/utils").AssetJs} Asset
+ */
+
+/**
+ * Filter assets array based on scope.
+ * If scope property is not present, asset will be included (backwards compatibility)
+ * If scope property is set to "all", asset will be included.
+ * If scope is set to "content" and asset scope property is set to "fallback", asset will not be included
+ * If scope is set to "fallback" and asset scope property is set to "content", asset will not be included
+ * @param {"content" | "fallback" | "all"} scope
+ * @param {Asset[]} assets
+ * @returns {Asset[]}
+ *
+ * @example
+ * ```
+ * // plain objects work
+ * const assets = filterAssets("content", [{..., scope: "content"}, {..., scope: "fallback"}]);
+ * // as do AssetJs and AssetCSS objects
+ * const assets = filterAssets("content", [new AssetCss(), new AssetCss()]);
+ * ```
+ */
+export const filterAssets = (scope, assets) => {
+    // if undefined or null, passthrough
+    if (!assets) return assets;
+    // if a non array value is given, throw
+    if (!Array.isArray(assets)) throw new TypeError(`Asset definition must be of type array. Got ${typeof assets}`);
+    // filter the array of asset definitions to matchin scope or anything with all. Treat no scope the same as "all" for backwards compatibility.
+    return assets.filter(asset => !asset.scope || asset.scope === scope || asset.scope === "all");
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@podium/client",
-  "version": "5.0.0-next.9",
+  "version": "5.0.0",
   "type": "module",
   "license": "MIT",
   "keywords": [
@@ -21,7 +21,7 @@
   "files": [
     "package.json",
     "CHANGELOG.md",
-    "index.d.ts",
+    "client.d.ts",
     "README.md",
     "LICENSE",
     "dist",
@@ -32,37 +32,40 @@
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
-    "test": "tap --no-check-coverage"
+    "test": "tap --disable-coverage --allow-empty-coverage"
   },
   "dependencies": {
     "@hapi/boom": "^10.0.0",
-    "@metrics/client": "2.5.0",
-    "@podium/schemas": "5.0.0-next.4",
-    "@podium/utils": "5.0.0-next.6",
+    "@metrics/client": "2.5.2",
+    "@podium/schemas": "5.0.0",
+    "@podium/utils": "5.0.0",
     "abslog": "2.4.0",
     "http-cache-semantics": "^4.0.3",
     "lodash.clonedeep": "^4.5.0",
-    "request": "^2.88.0",
-    "ttl-mem-cache": "4.1.0"
+    "ttl-mem-cache": "4.1.0",
+    "undici": "^5.10.0"
   },
   "devDependencies": {
     "@podium/test-utils": "2.5.2",
-    "@semantic-release/changelog": "6.0.1",
+    "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@sinonjs/fake-timers": "9.1.2",
-    "@babel/eslint-parser": "7.17.0",
+    "@babel/eslint-parser": "7.23.3",
+    "@semantic-release/github": "8.1.0",
+    "@semantic-release/npm": "8.0.3",
+    "@semantic-release/release-notes-generator": "10.0.3",
+    "@sinonjs/fake-timers": "11.2.2",
     "benchmark": "2.1.4",
-    "eslint": "8.15.0",
+    "eslint": "8.54.0",
     "eslint-config-airbnb-base": "15.0.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-prettier": "4.0.0",
-    "express": "4.18.1",
-    "get-stream": "6.0.1",
+    "eslint-config-prettier": "9.0.0",
+    "eslint-plugin-import": "2.29.0",
+    "eslint-plugin-prettier": "5.0.1",
+    "express": "4.18.2",
+    "get-stream": "8.0.1",
     "http-proxy": "1.18.1",
     "is-stream": "3.0.0",
-    "prettier": "2.6.2",
-    "semantic-release": "19.0.2",
-    "tap": "16.2.0"
+    "prettier": "3.1.0",
+    "semantic-release": "22.0.8",
+    "tap": "18.6.1"
   }
 }

package/index.d.ts

@@ -1,63 +0,0 @@
-import { HttpIncoming, AssetJs, AssetCss } from '@podium/utils';
-import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
-
-declare interface PodiumClientResourceOptions {
-    pathname?: string;
-    headers?: OutgoingHttpHeaders;
-    query?: any;
-}
-
-declare interface PodiumClientResponse {
-    readonly redirect: PodiumRedirect;
-    readonly content: string;
-    readonly headers: IncomingHttpHeaders;
-    readonly js: Array<AssetJs>;
-    readonly css: Array<AssetCss>;
-}
-
-declare class PodiumClientResource {
-    readonly name: string;
-
-    readonly uri: string;
-
-    fetch(
-        incoming: HttpIncoming,
-        options?: PodiumClientResourceOptions,
-    ): Promise<PodiumClientResponse>;
-
-    stream(
-        incoming: HttpIncoming,
-        options?: PodiumClientResourceOptions,
-    ): ReadableStream<PodiumClientResponse>;
-
-    refresh(): Promise<boolean>;
-}
-
-declare interface RegisterOptions {
-    uri: string;
-    name: string;
-    retries?: number;
-    timeout?: number;
-    throwable?: boolean;
-    redirectable?: boolean;
-    resolveJs?: boolean;
-    resolveCss?: boolean;
-}
-
-declare interface PodiumRedirect {
-    readonly statusCode: number;
-    readonly location: string;
-}
-
-export default class PodiumClient {
-    readonly state:
-        | 'instantiated'
-        | 'initializing'
-        | 'unstable'
-        | 'stable'
-        | 'unhealthy';
-
-    register(options: RegisterOptions): PodiumClientResource;
-
-    refreshManifests(): void;
-}