@podium/podlet 5.1.16 → 5.1.18

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [5.1.18](https://github.com/podium-lib/podlet/compare/v5.1.17...v5.1.18) (2024-10-11)
+
+
+### Bug Fixes
+
+* include some app info as a default metric ([5c9fdcb](https://github.com/podium-lib/podlet/commit/5c9fdcb269f9b1867f8df127fcd412f150d3ca95))
+
+## [5.1.17](https://github.com/podium-lib/podlet/compare/v5.1.16...v5.1.17) (2024-09-23)
+
+
+### Bug Fixes
+
+* type the known context values in an extendable way ([#427](https://github.com/podium-lib/podlet/issues/427)) ([f90ef57](https://github.com/podium-lib/podlet/commit/f90ef577cf6f0fdeabb08edb121a8a0107e77c4d))
+
 ## [5.1.16](https://github.com/podium-lib/podlet/compare/v5.1.15...v5.1.16) (2024-09-23)
 
 

package/lib/podlet.js

@@ -382,6 +382,18 @@ export default class PodiumPodlet {
             });
 
             versionGauge.set(1);
+
+            const podletGauge = this.metrics.gauge({
+                name: 'podium_podlet_application_info',
+                description: '@podium/podlet application info',
+                labels: {
+                    name: this.name,
+                    version: this.version,
+                    has_fallback: Boolean(fallback),
+                },
+            });
+
+            podletGauge.set(1);
         });
 
         // @ts-ignore

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@podium/podlet",
-  "version": "5.1.16",
+  "version": "5.1.18",
   "type": "module",
   "description": "Module for building page fragment servers in a micro frontend architecture.",
   "license": "MIT",
@@ -26,11 +26,10 @@
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
-    "test": "run-s test:*",
-    "test:unit": "tap --disable-coverage --allow-empty-coverage",
-    "test:types": "tsc --project tsconfig.test.json",
-    "types": "run-s types:tsc types:fixup",
+    "test": "tap --disable-coverage --allow-empty-coverage",
+    "types": "run-s types:tsc types:fixup types:test",
     "types:tsc": "tsc --declaration --emitDeclarationOnly",
+    "types:test": "tsc --project tsconfig.test.json",
     "types:fixup": "node ./fixup.js"
   },
   "dependencies": {
@@ -43,25 +42,18 @@
     "objobj": "1.0.0"
   },
   "devDependencies": {
-    "@babel/eslint-parser": "7.25.1",
-    "@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",
-    "@semantic-release/github": "9.2.6",
-    "@semantic-release/npm": "11.0.3",
-    "@semantic-release/release-notes-generator": "12.1.0",
-    "@types/node": "^20.10.3",
+    "@podium/eslint-config": "1.0.0",
+    "@podium/semantic-release-config": "2.0.0",
+    "@podium/test-utils": "3.0.10",
+    "@podium/typescript-config": "1.0.0",
+    "@types/node": "20.16.10",
     "@types/readable-stream": "4.0.15",
-    "eslint": "9.9.1",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-prettier": "5.2.1",
+    "eslint": "9.11.1",
     "express": "4.20.0",
-    "globals": "15.9.0",
     "json-stringify-safe": "5.0.1",
     "npm-run-all2": "6.2.3",
     "prettier": "3.3.3",
-    "semantic-release": "23.1.1",
+    "semantic-release": "24.1.2",
     "tap": "18.8.0",
     "typescript": "5.5.4"
   }

package/types/podium.d.ts

@@ -0,0 +1,72 @@
+declare global {
+    namespace Express {
+        export interface PodiumHttpIncomingParameters {
+            [key: string]: unknown;
+        }
+
+        export interface PodiumHttpIncomingContext {
+            /**
+             * @see https://podium-lib.io/docs/guides/context#default-context-variables
+             */
+            debug?: string;
+            /**
+             * Does user agent sniffing to try to guess the visitor's device type.
+             * @see https://podium-lib.io/docs/guides/context#default-context-variables
+             */
+            deviceType?: string;
+            /**
+             * Locale information from the layout.
+             * @see https://podium-lib.io/docs/guides/context#default-context-variables
+             */
+            locale?: string;
+            /**
+             * Used to calculate the podlet's public URL when proxied behind a layout.
+             * @see https://podium-lib.io/docs/guides/context#construct-public-urls
+             */
+            mountOrigin?: string;
+            /**
+             * Used to calculate the podlet's public URL when proxied behind a layout.
+             * @see https://podium-lib.io/docs/guides/context#construct-public-urls
+             */
+            mountPathname?: string;
+            /**
+             * Used to calculate the podlet's public URL when proxied behind a layout.
+             * @see https://podium-lib.io/docs/guides/context#construct-public-urls
+             */
+            publicPathname?: string;
+            /**
+             * Name of the caller.
+             */
+            requestedBy?: string;
+            [key: string]: unknown;
+        }
+
+        export interface PodiumHttpIncomingViewParameters {
+            [key: string]: unknown;
+        }
+
+        export interface Locals {
+            podium: HttpIncoming<
+                PodiumHttpIncomingParameters,
+                PodiumHttpIncomingContext,
+                PodiumHttpIncomingViewParameters
+            >;
+        }
+
+        export interface Response {
+            /**
+             * Calls the send / write method on the `http.ServerResponse` object.
+             *
+             * When in development mode this method will wrap the provided fragment in a
+             * default HTML document before dispatching. When not in development mode, this
+             * method will just dispatch the fragment.
+             *
+             * @example
+             * app.get(podlet.content(), (req, res) => {
+             *     res.podiumSend('<h1>Hello World</h1>');
+             * });
+             */
+            podiumSend(fragment: string, ...args: unknown[]): Response;
+        }
+    }
+}

package/types/podlet.d.ts

@@ -1,28 +1,74 @@
+declare global {
+    namespace Express {
+        export interface PodiumHttpIncomingParameters {
+            [key: string]: unknown;
+        }
 
-import type { HttpIncoming } from "@podium/utils";
+        export interface PodiumHttpIncomingContext {
+            /**
+             * @see https://podium-lib.io/docs/guides/context#default-context-variables
+             */
+            debug?: string;
+            /**
+             * Does user agent sniffing to try to guess the visitor's device type.
+             * @see https://podium-lib.io/docs/guides/context#default-context-variables
+             */
+            deviceType?: string;
+            /**
+             * Locale information from the layout.
+             * @see https://podium-lib.io/docs/guides/context#default-context-variables
+             */
+            locale?: string;
+            /**
+             * Used to calculate the podlet's public URL when proxied behind a layout.
+             * @see https://podium-lib.io/docs/guides/context#construct-public-urls
+             */
+            mountOrigin?: string;
+            /**
+             * Used to calculate the podlet's public URL when proxied behind a layout.
+             * @see https://podium-lib.io/docs/guides/context#construct-public-urls
+             */
+            mountPathname?: string;
+            /**
+             * Used to calculate the podlet's public URL when proxied behind a layout.
+             * @see https://podium-lib.io/docs/guides/context#construct-public-urls
+             */
+            publicPathname?: string;
+            /**
+             * Name of the caller.
+             */
+            requestedBy?: string;
+            [key: string]: unknown;
+        }
 
-declare global {
-  namespace Express {
-    export interface Locals {
-      podium: HttpIncoming;
-    }
+        export interface PodiumHttpIncomingViewParameters {
+            [key: string]: unknown;
+        }
+
+        export interface Locals {
+            podium: HttpIncoming<
+                PodiumHttpIncomingParameters,
+                PodiumHttpIncomingContext,
+                PodiumHttpIncomingViewParameters
+            >;
+        }
 
-    export interface Response {
-      /**
-       * Calls the send / write method on the `http.ServerResponse` object.
-       *
-       * When in development mode this method will wrap the provided fragment in a
-       * default HTML document before dispatching. When not in development mode, this
-       * method will just dispatch the fragment.
-       *
-       * @example
-       * app.get(podlet.content(), (req, res) => {
-       *     res.podiumSend('<h1>Hello World</h1>');
-       * });
-       */
-      podiumSend(fragment: string, ...args: unknown[]): Response;
+        export interface Response {
+            /**
+             * Calls the send / write method on the `http.ServerResponse` object.
+             *
+             * When in development mode this method will wrap the provided fragment in a
+             * default HTML document before dispatching. When not in development mode, this
+             * method will just dispatch the fragment.
+             *
+             * @example
+             * app.get(podlet.content(), (req, res) => {
+             *     res.podiumSend('<h1>Hello World</h1>');
+             * });
+             */
+            podiumSend(fragment: string, ...args: unknown[]): Response;
+        }
     }
-  }
 }
 
 /**