@podium/podlet 5.1.14 → 5.1.16

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [5.1.16](https://github.com/podium-lib/podlet/compare/v5.1.15...v5.1.16) (2024-09-23)
+
+
+### Bug Fixes
+
+* **deps:** update all dependencies (non-major) ([b8eddfd](https://github.com/podium-lib/podlet/commit/b8eddfd676810607adc56cdc71d2622e73b25e0e))
+
+## [5.1.15](https://github.com/podium-lib/podlet/compare/v5.1.14...v5.1.15) (2024-09-16)
+
+
+### Bug Fixes
+
+* correct the JSDoc for fallback ([#423](https://github.com/podium-lib/podlet/issues/423)) ([7444897](https://github.com/podium-lib/podlet/commit/7444897b7cf45a9e2b9c310ce309f69f80fa91d1))
+
 ## [5.1.14](https://github.com/podium-lib/podlet/compare/v5.1.13...v5.1.14) (2024-09-16)
 
 

package/lib/podlet.js

@@ -25,14 +25,14 @@ const { template } = utils;
 
 /**
  * @typedef {Object} PodletOptions
- * @property {string} name - (required) podlet name
- * @property {string} version - (required) podlet version
- * @property {string} pathname - (required) podlet pathname
- * @property {string} [manifest] - path where the podlet manifest file is served from (default '/manifest.json')
- * @property {string} [content] - path where the podlet content HTML markup is served from (default '/')
- * @property {string} [fallback] - path where the podlet fallback HTML markup is served from (default '/fallback')
- * @property {boolean} [development] - a boolean flag that, when true, enables additional development setup (default false)
- * @property {import('abslog').AbstractLoggerOptions} [logger] - a logger to use when provided. Can be the console object if console logging is desired but can also be any Log4j compatible logging object as well. Nothing is logged if no logger is provided. (default null)
+ * @property {string} name - Podlet name
+ * @property {string} version - Podlet version
+ * @property {string} pathname - Podlet pathname
+ * @property {string} [manifest="/manifest.json"] - Path where the podlet manifest file is served from.
+ * @property {string} [content="/"] - Path where the podlet content HTML markup is served from.
+ * @property {string} [fallback=""] - Path where the podlet fallback HTML markup is served from. By default there is no fallback. Set this to for instance `"/fallback"` to serve a cacheable version of the contents in case the podlet goes down.
+ * @property {boolean} [development=false] - a boolean flag that, when true, enables additional development setup
+ * @property {import('abslog').AbstractLoggerOptions} [logger] - a logger to use when provided. Can be the console object if console logging is desired but can also be any Log4j compatible logging object as well. Nothing is logged if no logger is provided.
  * @property {import("@podium/proxy").PodiumProxyOptions} [proxy] - options that can be provided to configure the @podium/proxy instance used by the podlet. See that module for details.
  *
  * @typedef {{ debug: 'true' | 'false', locale: string, deviceType: string, requestedBy: string, mountOrigin: string, mountPathname: string, publicPathname: string }} PodletContext
@@ -134,7 +134,7 @@ export default class PodiumPodlet {
     httpProxy;
 
     /**
-     * The pathname for the manifest of the podlet. Defaults to /manifest.json. (set in the constructor)
+     * The pathname for the manifest of the podlet. Defaults to "/manifest.json".
      * The value should be relative to the value set on the pathname argument.
      * In other words if a podlet is mounted into an HTTP server at /foo and the manifest is at /foo/component.json, pathname will be /foo and manifestRoute will be /component.json
      *
@@ -148,7 +148,7 @@ export default class PodiumPodlet {
     manifestRoute = '/manifest.json';
 
     /**
-     * The pathname for the content route of the podlet. Defaults to /. (set in the constructor)
+     * The pathname for the content route of the podlet. Defaults to "/".
      * The value should be relative to the value set on the pathname argument.
      * In other words if a podlet is mounted into an HTTP server at /foo and the content is at /foo/content, pathname will be /foo and contentRoute will be /content
      *
@@ -162,7 +162,7 @@ export default class PodiumPodlet {
     contentRoute = '/';
 
     /**
-     * The pathname for the fallback route of the podlet. Defaults to /fallback. (set in the constructor)
+     * The pathname for the fallback route of the podlet. Defaults to no fallback.
      * The value should be relative to the value set on the pathname argument.
      * In other words if a podlet is mounted into an HTTP server at /foo and the fallback is at /foo/fallback, pathname will be /foo and fallbackRoute will be /fallback
      *
@@ -285,16 +285,6 @@ export default class PodiumPodlet {
      * Creates a new instance of a Podium podlet which can be used in conjunction with your framework of choice to build podlet server apps.
      * `name`, `version` and `pathname` constructor arguments are required. All other options are optional.
      *
-     * * `name` - podlet name (**required**)
-     * * `version` - podlet version (**required**)
-     * * `pathname` - podlet pathname (**required**)
-     * * `manifest` - path where the podlet manifest file is served from (**default** `'/manifest.json'`)
-     * * `content` - path where the podlet content HTML markup is served from (**default** `'/'`)
-     * * `fallback` - path where the podlet fallback HTML markup is served from (**default** `'/fallback'`)
-     * * `development` - a boolean flag that, when true, enables additional development setup (**default** `false`)
-     * * `logger` - a logger to use when provided. Can be the console object if console logging is desired but can also be any Log4j compatible logging object as well. Nothing is logged if no logger is provided. (**default** `null`)
-     * * `proxy` - options that can be provided to configure the @podium/proxy instance used by the podlet. See that module for details. (**default**: `{}`)
-     *
      * @see https://podium-lib.io/docs/api/podlet/#constructor
      * @see https://podium-lib.io/docs/podlet/getting_started
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@podium/podlet",
-  "version": "5.1.14",
+  "version": "5.1.16",
   "type": "module",
   "description": "Module for building page fragment servers in a micro frontend architecture.",
   "license": "MIT",
@@ -35,16 +35,16 @@
   },
   "dependencies": {
     "@metrics/client": "2.5.3",
-    "@podium/proxy": "5.0.26",
+    "@podium/proxy": "5.0.28",
     "@podium/schemas": "5.0.6",
-    "@podium/utils": "5.2.0",
+    "@podium/utils": "5.3.1",
     "abslog": "2.4.4",
     "ajv": "8.17.1",
     "objobj": "1.0.0"
   },
   "devDependencies": {
     "@babel/eslint-parser": "7.25.1",
-    "@podium/test-utils": "2.5.2",
+    "@podium/test-utils": "3.0.8",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/commit-analyzer": "11.1.0",
     "@semantic-release/git": "10.0.1",
@@ -56,10 +56,10 @@
     "eslint": "9.9.1",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-prettier": "5.2.1",
-    "express": "4.19.2",
+    "express": "4.20.0",
     "globals": "15.9.0",
     "json-stringify-safe": "5.0.1",
-    "npm-run-all2": "5.0.2",
+    "npm-run-all2": "6.2.3",
     "prettier": "3.3.3",
     "semantic-release": "23.1.1",
     "tap": "18.8.0",

package/types/podlet.d.ts

@@ -27,14 +27,14 @@ declare global {
 
 /**
  * @typedef {Object} PodletOptions
- * @property {string} name - (required) podlet name
- * @property {string} version - (required) podlet version
- * @property {string} pathname - (required) podlet pathname
- * @property {string} [manifest] - path where the podlet manifest file is served from (default '/manifest.json')
- * @property {string} [content] - path where the podlet content HTML markup is served from (default '/')
- * @property {string} [fallback] - path where the podlet fallback HTML markup is served from (default '/fallback')
- * @property {boolean} [development] - a boolean flag that, when true, enables additional development setup (default false)
- * @property {import('abslog').AbstractLoggerOptions} [logger] - a logger to use when provided. Can be the console object if console logging is desired but can also be any Log4j compatible logging object as well. Nothing is logged if no logger is provided. (default null)
+ * @property {string} name - Podlet name
+ * @property {string} version - Podlet version
+ * @property {string} pathname - Podlet pathname
+ * @property {string} [manifest="/manifest.json"] - Path where the podlet manifest file is served from.
+ * @property {string} [content="/"] - Path where the podlet content HTML markup is served from.
+ * @property {string} [fallback=""] - Path where the podlet fallback HTML markup is served from. By default there is no fallback. Set this to for instance `"/fallback"` to serve a cacheable version of the contents in case the podlet goes down.
+ * @property {boolean} [development=false] - a boolean flag that, when true, enables additional development setup
+ * @property {import('abslog').AbstractLoggerOptions} [logger] - a logger to use when provided. Can be the console object if console logging is desired but can also be any Log4j compatible logging object as well. Nothing is logged if no logger is provided.
  * @property {import("@podium/proxy").PodiumProxyOptions} [proxy] - options that can be provided to configure the @podium/proxy instance used by the podlet. See that module for details.
  *
  * @typedef {{ debug: 'true' | 'false', locale: string, deviceType: string, requestedBy: string, mountOrigin: string, mountPathname: string, publicPathname: string }} PodletContext
@@ -46,16 +46,6 @@ export default class PodiumPodlet {
      * Creates a new instance of a Podium podlet which can be used in conjunction with your framework of choice to build podlet server apps.
      * `name`, `version` and `pathname` constructor arguments are required. All other options are optional.
      *
-     * * `name` - podlet name (**required**)
-     * * `version` - podlet version (**required**)
-     * * `pathname` - podlet pathname (**required**)
-     * * `manifest` - path where the podlet manifest file is served from (**default** `'/manifest.json'`)
-     * * `content` - path where the podlet content HTML markup is served from (**default** `'/'`)
-     * * `fallback` - path where the podlet fallback HTML markup is served from (**default** `'/fallback'`)
-     * * `development` - a boolean flag that, when true, enables additional development setup (**default** `false`)
-     * * `logger` - a logger to use when provided. Can be the console object if console logging is desired but can also be any Log4j compatible logging object as well. Nothing is logged if no logger is provided. (**default** `null`)
-     * * `proxy` - options that can be provided to configure the @podium/proxy instance used by the podlet. See that module for details. (**default**: `{}`)
-     *
      * @see https://podium-lib.io/docs/api/podlet/#constructor
      * @see https://podium-lib.io/docs/podlet/getting_started
      *
@@ -131,7 +121,7 @@ export default class PodiumPodlet {
      */
     httpProxy: Proxy;
     /**
-     * The pathname for the manifest of the podlet. Defaults to /manifest.json. (set in the constructor)
+     * The pathname for the manifest of the podlet. Defaults to "/manifest.json".
      * The value should be relative to the value set on the pathname argument.
      * In other words if a podlet is mounted into an HTTP server at /foo and the manifest is at /foo/component.json, pathname will be /foo and manifestRoute will be /component.json
      *
@@ -144,7 +134,7 @@ export default class PodiumPodlet {
      */
     manifestRoute: string;
     /**
-     * The pathname for the content route of the podlet. Defaults to /. (set in the constructor)
+     * The pathname for the content route of the podlet. Defaults to "/".
      * The value should be relative to the value set on the pathname argument.
      * In other words if a podlet is mounted into an HTTP server at /foo and the content is at /foo/content, pathname will be /foo and contentRoute will be /content
      *
@@ -157,7 +147,7 @@ export default class PodiumPodlet {
      */
     contentRoute: string;
     /**
-     * The pathname for the fallback route of the podlet. Defaults to /fallback. (set in the constructor)
+     * The pathname for the fallback route of the podlet. Defaults to no fallback.
      * The value should be relative to the value set on the pathname argument.
      * In other words if a podlet is mounted into an HTTP server at /foo and the fallback is at /foo/fallback, pathname will be /foo and fallbackRoute will be /fallback
      *
@@ -584,35 +574,35 @@ export default class PodiumPodlet {
 }
 export type PodletOptions = {
     /**
-     * - (required) podlet name
+     * - Podlet name
      */
     name: string;
     /**
-     * - (required) podlet version
+     * - Podlet version
      */
     version: string;
     /**
-     * - (required) podlet pathname
+     * - Podlet pathname
      */
     pathname: string;
     /**
-     * - path where the podlet manifest file is served from (default '/manifest.json')
+     * - Path where the podlet manifest file is served from.
      */
     manifest?: string;
     /**
-     * - path where the podlet content HTML markup is served from (default '/')
+     * - Path where the podlet content HTML markup is served from.
      */
     content?: string;
     /**
-     * - path where the podlet fallback HTML markup is served from (default '/fallback')
+     * - Path where the podlet fallback HTML markup is served from. By default there is no fallback. Set this to for instance `"/fallback"` to serve a cacheable version of the contents in case the podlet goes down.
      */
     fallback?: string;
     /**
-     * - a boolean flag that, when true, enables additional development setup (default false)
+     * - a boolean flag that, when true, enables additional development setup
      */
     development?: boolean;
     /**
-     * - a logger to use when provided. Can be the console object if console logging is desired but can also be any Log4j compatible logging object as well. Nothing is logged if no logger is provided. (default null)
+     * - a logger to use when provided. Can be the console object if console logging is desired but can also be any Log4j compatible logging object as well. Nothing is logged if no logger is provided.
      */
     logger?: import("abslog").AbstractLoggerOptions;
     /**