@podium/podlet 5.1.4 → 5.1.5

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [5.1.5](https://github.com/podium-lib/podlet/compare/v5.1.4...v5.1.5) (2024-05-14)
+
+
+### Bug Fixes
+
+* add docs to podiumSend method ([6f087f2](https://github.com/podium-lib/podlet/commit/6f087f2b9a815d02b844719706499e22912073b2))
+* update dependency typings ([bf4bc75](https://github.com/podium-lib/podlet/commit/bf4bc7550e5364f133b84e01e1a562aed35fed06))
+
 ## [5.1.4](https://github.com/podium-lib/podlet/compare/v5.1.3...v5.1.4) (2024-05-13)
 
 

package/lib/podlet.js

@@ -5,20 +5,15 @@
 
 import {
     HttpIncoming,
-    // @ts-ignore
     pathnameBuilder,
     AssetCss,
     AssetJs,
 } from '@podium/utils';
-// @ts-ignore
 import * as schema from '@podium/schemas';
 import Metrics from '@metrics/client';
-// @ts-ignore
 import abslog from 'abslog';
-// @ts-ignore
 import objobj from 'objobj';
 import * as utils from '@podium/utils';
-// @ts-ignore
 import Proxy from '@podium/proxy';
 import { join, dirname } from 'node:path';
 import { fileURLToPath } from 'node:url';
@@ -31,13 +26,9 @@ const pkgJson = fs.readFileSync(
 );
 const pkg = JSON.parse(pkgJson);
 
-// @ts-ignore
 const { template } = utils;
 
 /**
- * @typedef {(...args: any) => void} LogFunction
- * @typedef {{ trace: LogFunction, debug: LogFunction, info: LogFunction, warn: LogFunction, error: LogFunction, fatal: LogFunction }} AbsLogger
- *
  * @typedef {Object} PodletOptions
  * @property {string} name - (required) podlet name
  * @property {string} version - (required) podlet version
@@ -46,8 +37,8 @@ const { template } = utils;
  * @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 {Console | AbsLogger} [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 {import("@podium/proxy").default.PodiumProxyOptions} [proxy] - options that can be provided to configure the @podium/proxy instance used by the podlet. See that module for details.
+ * @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 {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
  * @typedef {{ as?: string | false | null, crossorigin?: string | null | boolean, disabled?: boolean | '' | null, hreflang?: string | false | null, title?: string | false | null, media?: string | false | null, rel?: string | false | null, type?: string | false | null, value: string | false | null, data?: Array<{ key: string; value: string }>, strategy?: "beforeInteractive" | "afterInteractive" | "lazy", scope?: "content" | "fallback" | "all", [key: string]: any }} AssetCssLike
@@ -137,7 +128,7 @@ export default class PodiumPodlet {
      * podlet.log.fatal('fatal log to the console')
      * ```
      *
-     * @type {AbsLogger}
+     * @type {import('abslog').ValidLogger}
      */
     log;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@podium/podlet",
-  "version": "5.1.4",
+  "version": "5.1.5",
   "type": "module",
   "description": "Module for building page fragment servers in a micro frontend architecture.",
   "license": "MIT",
@@ -26,13 +26,13 @@
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
-    "test": "tap --disable-coverage --allow-empty-coverage",
+    "test": "tap --disable-coverage --allow-empty-coverage && tsc --project tsconfig.test.json",
     "types": "tsc --declaration --emitDeclarationOnly && ./fixup.sh"
   },
   "dependencies": {
     "@metrics/client": "2.5.2",
-    "@podium/proxy": "5.0.14",
-    "@podium/schemas": "5.0.1",
+    "@podium/proxy": "5.0.16",
+    "@podium/schemas": "5.0.2",
     "@podium/utils": "5.0.6",
     "abslog": "2.4.4",
     "ajv": "8.13.0",
@@ -48,6 +48,7 @@
     "@semantic-release/npm": "11.0.3",
     "@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-config-prettier": "9.1.0",

package/types/podlet.d.ts

@@ -1,7 +1,4 @@
 /**
- * @typedef {(...args: any) => void} LogFunction
- * @typedef {{ trace: LogFunction, debug: LogFunction, info: LogFunction, warn: LogFunction, error: LogFunction, fatal: LogFunction }} AbsLogger
- *
  * @typedef {Object} PodletOptions
  * @property {string} name - (required) podlet name
  * @property {string} version - (required) podlet version
@@ -10,8 +7,8 @@
  * @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 {Console | AbsLogger} [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 {import("@podium/proxy").default.PodiumProxyOptions} [proxy] - options that can be provided to configure the @podium/proxy instance used by the podlet. See that module for details.
+ * @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 {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
  * @typedef {{ as?: string | false | null, crossorigin?: string | null | boolean, disabled?: boolean | '' | null, hreflang?: string | false | null, title?: string | false | null, media?: string | false | null, rel?: string | false | null, type?: string | false | null, value: string | false | null, data?: Array<{ key: string; value: string }>, strategy?: "beforeInteractive" | "afterInteractive" | "lazy", scope?: "content" | "fallback" | "all", [key: string]: any }} AssetCssLike
@@ -98,9 +95,9 @@ export default class PodiumPodlet {
      * podlet.log.fatal('fatal log to the console')
      * ```
      *
-     * @type {AbsLogger}
+     * @type {import('abslog').ValidLogger}
      */
-    log: AbsLogger;
+    log: import('abslog').ValidLogger;
     /**
      * An instance of the `@podium/proxy` module
      * @see https://github.com/podium-lib/proxy
@@ -558,15 +555,6 @@ export default class PodiumPodlet {
     get [Symbol.toStringTag](): string;
     #private;
 }
-export type LogFunction = (...args: any) => void;
-export type AbsLogger = {
-    trace: LogFunction;
-    debug: LogFunction;
-    info: LogFunction;
-    warn: LogFunction;
-    error: LogFunction;
-    fatal: LogFunction;
-};
 export type PodletOptions = {
     /**
      * - (required) podlet name
@@ -599,11 +587,11 @@ 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?: Console | AbsLogger;
+    logger?: import('abslog').AbstractLoggerOptions;
     /**
      * - options that can be provided to configure the
      */
-    proxy?: import("@podium/proxy").default.PodiumProxyOptions;
+    proxy?: import("@podium/proxy").PodiumProxyOptions;
 };
 export type PodletContext = {
     debug: 'true' | 'false';
@@ -656,7 +644,19 @@ import Metrics from '@metrics/client';
 import { HttpIncoming } from '@podium/utils';
 declare global {
   namespace Express {
-    interface 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;
     }
   }