@podium/podlet 5.1.8 → 5.1.10

package/README.md

@@ -993,7 +993,7 @@ SOFTWARE.
 [@podium/proxy]: https://github.com/podium-lib/proxy '@podium/proxy'
 [express]: https://expressjs.com/ 'Express'
 [hapi podlet plugin]: https://github.com/podium-lib/hapi-podlet 'Hapi Podlet Plugin'
-[httpincoming]: https://github.com/podium-lib/utils/blob/master/lib/http-incoming.js 'HttpIncoming'
+[httpincoming]: https://github.com/podium-lib/utils/blob/main/lib/http-incoming.js 'HttpIncoming'
 [publicpathname]: https://github.com/podium-lib/context#public-pathname '`publicPathname`'
 [mountorigin]: https://github.com/podium-lib/context#mount-origin '`mountOrigin`'
 [abslog]: https://github.com/trygve-lie/abslog 'abslog'

package/lib/podlet.js

@@ -1,8 +1,3 @@
-/* eslint-disable consistent-return */
-/* eslint-disable no-underscore-dangle */
-/* eslint-disable no-restricted-syntax */
-/* eslint-disable no-param-reassign */
-
 import {
     HttpIncoming,
     pathnameBuilder,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@podium/podlet",
-  "version": "5.1.8",
+  "version": "5.1.10",
   "type": "module",
   "description": "Module for building page fragment servers in a micro frontend architecture.",
   "license": "MIT",
@@ -26,20 +26,24 @@
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
-    "test": "tap --disable-coverage --allow-empty-coverage && tsc --project tsconfig.test.json",
-    "types": "tsc --declaration --emitDeclarationOnly && ./fixup.sh"
+    "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",
+    "types:tsc": "tsc --declaration --emitDeclarationOnly",
+    "types:fixup": "node ./fixup.js"
   },
   "dependencies": {
     "@metrics/client": "2.5.2",
-    "@podium/proxy": "5.0.21",
-    "@podium/schemas": "5.0.5",
+    "@podium/proxy": "5.0.22",
+    "@podium/schemas": "5.0.6",
     "@podium/utils": "5.0.7",
     "abslog": "2.4.4",
-    "ajv": "8.16.0",
+    "ajv": "8.17.1",
     "objobj": "1.0.0"
   },
   "devDependencies": {
-    "@babel/eslint-parser": "7.24.6",
+    "@babel/eslint-parser": "7.24.7",
     "@podium/test-utils": "2.5.2",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/commit-analyzer": "11.1.0",
@@ -49,16 +53,16 @@
     "@semantic-release/release-notes-generator": "12.1.0",
     "@types/node": "^20.10.3",
     "@types/readable-stream": "4.0.14",
-    "eslint": "8.57.0",
-    "eslint-config-airbnb-base": "15.0.0",
+    "eslint": "9.6.0",
     "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-import": "2.29.1",
     "eslint-plugin-prettier": "5.1.3",
     "express": "4.19.2",
+    "globals": "15.8.0",
     "json-stringify-safe": "5.0.1",
-    "prettier": "3.2.5",
+    "npm-run-all": "4.1.5",
+    "prettier": "3.3.2",
     "semantic-release": "23.1.1",
     "tap": "18.8.0",
-    "typescript": "5.4.5"
+    "typescript": "5.5.3"
   }
 }

package/types/podlet.d.ts

@@ -1,3 +1,30 @@
+
+import type { HttpIncoming } from "@podium/utils";
+
+declare global {
+  namespace Express {
+    export interface Locals {
+      podium: HttpIncoming;
+    }
+
+    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;
+    }
+  }
+}
+
 /**
  * @typedef {Object} PodletOptions
  * @property {string} name - (required) podlet name
@@ -97,7 +124,7 @@ export default class PodiumPodlet {
      *
      * @type {import('abslog').ValidLogger}
      */
-    log: import('abslog').ValidLogger;
+    log: import("abslog").ValidLogger;
     /**
      * An instance of the `@podium/proxy` module
      * @see https://github.com/podium-lib/proxy
@@ -466,7 +493,7 @@ export default class PodiumPodlet {
      */
     view<T extends {
         [key: string]: unknown;
-    }>(fn: (incoming: HttpIncoming<T, Record<string, unknown>, Record<string, unknown>>, fragment: string, ...args: unknown[]) => string): void;
+    }>(fn: (incoming: HttpIncoming<T>, fragment: string, ...args: unknown[]) => string): void;
     /**
      * Method for serialising the podlet instance into a plain JS object. Called automatically when stringifying the podlet with JSON.stringify(podlet).
      * Doing so will result in a correct Podium manifest file string and so is suitable for usage in a manifest route hook.
@@ -515,9 +542,9 @@ export default class PodiumPodlet {
      * @param  {...any} args - additional args depending on the template and what values it accepts
      * @returns {string}
      */
-    render<T_1 extends {
+    render<T extends {
         [key: string]: unknown;
-    }>(incoming: HttpIncoming<T_1, Record<string, unknown>, Record<string, unknown>>, data: string, ...args: any[]): string;
+    }>(incoming: HttpIncoming<T>, data: string, ...args: any[]): string;
     /**
      * Method for processing an incoming HTTP request. This method is intended to be used to implement support for multiple HTTP frameworks and in most cases will not need to be used directly by podlet developers when creating podlet servers.
      *
@@ -587,14 +614,14 @@ export type PodletOptions = {
     /**
      * - 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)
      */
-    logger?: import('abslog').AbstractLoggerOptions;
+    logger?: import("abslog").AbstractLoggerOptions;
     /**
      * - options that can be provided to configure the
      */
     proxy?: import("@podium/proxy").PodiumProxyOptions;
 };
 export type PodletContext = {
-    debug: 'true' | 'false';
+    debug: "true" | "false";
     locale: string;
     deviceType: string;
     requestedBy: string;
@@ -605,7 +632,7 @@ export type PodletContext = {
 export type AssetCssLike = {
     as?: string | false | null;
     crossorigin?: string | null | boolean;
-    disabled?: boolean | '' | null;
+    disabled?: boolean | "" | null;
     hreflang?: string | false | null;
     title?: string | false | null;
     media?: string | false | null;
@@ -626,9 +653,9 @@ export type AssetJsLike = {
     type?: string | null | false;
     integrity?: string | null | false;
     referrerpolicy?: string | null | false;
-    nomodule?: boolean | null | '';
-    async?: boolean | null | '';
-    defer?: boolean | null | '';
+    nomodule?: boolean | null | "";
+    async?: boolean | null | "";
+    defer?: boolean | null | "";
     data?: Array<{
         key: string;
         value: string;
@@ -642,22 +669,3 @@ import { AssetCss } from '@podium/utils';
 import { AssetJs } from '@podium/utils';
 import Metrics from '@metrics/client';
 import { HttpIncoming } from '@podium/utils';
-declare global {
-  namespace Express {
-    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;
-    }
-  }
-}