@podium/podlet 5.0.0-next.7 → 5.0.0

package/CHANGELOG.md

@@ -1,3 +1,131 @@
+# [5.0.0](https://github.com/podium-lib/podlet/compare/v4.5.0...v5.0.0) (2023-11-28)
+
+
+### Bug Fixes
+
+* Use latest proxy ([42f622c](https://github.com/podium-lib/podlet/commit/42f622c64f86b49796cc34e0871371ae74088cf1))
+
+
+### Features
+
+* add support for strategy and scope via @podium/schemas and @podium/utils update ([128eaa1](https://github.com/podium-lib/podlet/commit/128eaa1b3de35581d8fe537c63ebc001ce82c282))
+* Convert to ESM ([cedb222](https://github.com/podium-lib/podlet/commit/cedb222127c25469bf856942463ce02491d5ad08))
+* Drop node 10.x support ([1f9ca4f](https://github.com/podium-lib/podlet/commit/1f9ca4f97e8da9addac4e70813ba981e7742ec9e))
+* Remove deprecated return value on .js and .css methods ([4052c02](https://github.com/podium-lib/podlet/commit/4052c02750a0071487bfa1ffb76ccebcc55bf185))
+
+
+### BREAKING CHANGES
+
+* Convert from CommonJS module to ESM
+* In version 4 of podium it became possible to set multiple assets to a podlet through its `.js()` and `.css()` methods. This did make it impossible to let these methods return a resonable value, but to keep a backwards compabillity with version 3 of Podium, the first item passed in was returned for compabillity. This removes this compaillity with version 3 of Podium.
+* Only support node 12 and 14.
+
+# [5.0.0-next.8](https://github.com/podium-lib/podlet/compare/v5.0.0-next.7...v5.0.0-next.8) (2023-11-22)
+
+
+### Bug Fixes
+
+* adding type information closes [#344](https://github.com/podium-lib/podlet/issues/344) ([28e6ed9](https://github.com/podium-lib/podlet/commit/28e6ed9508d9218046f925e85fd97d17479bf390))
+* CJS-shaped export in type definition ([fd96046](https://github.com/podium-lib/podlet/commit/fd96046ca16b89d02526453ff3cbf6d3ace694bd))
+* **deps:** update all dependencies (non-major) ([bf963ad](https://github.com/podium-lib/podlet/commit/bf963ad4f82ca1dabad6a960c2a836f075512385))
+* **deps:** update all dependencies (non-major) ([4475c67](https://github.com/podium-lib/podlet/commit/4475c67d637af2bcc7f843eed386614efc3d7c61))
+* **deps:** update all dependencies (non-major) ([0a47c72](https://github.com/podium-lib/podlet/commit/0a47c7289869c023235d32d301e83fd5de77f7f2))
+* **deps:** update all dependencies (non-major) ([08a5c70](https://github.com/podium-lib/podlet/commit/08a5c702797432b7668195d10c96def7bfc0c0bf))
+* **deps:** update all dependencies (non-major) ([0d14c8a](https://github.com/podium-lib/podlet/commit/0d14c8aae8a69ba80a32021fcd87f7f6e06b791f))
+* **deps:** update all dependencies (non-major) ([94707a5](https://github.com/podium-lib/podlet/commit/94707a5f92f72af94b23b77ac6b27b1dd379efcb))
+* **deps:** update all dependencies (non-major) ([6ab8c85](https://github.com/podium-lib/podlet/commit/6ab8c85ff5ef299049a21e0dc3882d1a8ae1a837))
+* **deps:** update all dependencies (non-major) ([bf8620d](https://github.com/podium-lib/podlet/commit/bf8620dc2693a5c25daa9ae26969b591848ec541))
+* **types:** Add pathname() method to Podium type ([779f8c3](https://github.com/podium-lib/podlet/commit/779f8c33dc92183acec90cd647865a83a99b558e))
+
+
+### Features
+
+* filter assets by scope if scope is provided ([95129b3](https://github.com/podium-lib/podlet/commit/95129b3e2de5b955cc4b5a2aa5942ddc0af39e8e))
+
+# [4.5.0](https://github.com/podium-lib/podlet/compare/v4.4.75...v4.5.0) (2023-11-22)
+
+
+### Features
+
+* filter assets by scope if scope is provided ([95129b3](https://github.com/podium-lib/podlet/commit/95129b3e2de5b955cc4b5a2aa5942ddc0af39e8e))
+
+## [4.4.75](https://github.com/podium-lib/podlet/compare/v4.4.74...v4.4.75) (2023-11-20)
+
+
+### Bug Fixes
+
+* **deps:** update all dependencies (non-major) ([bf963ad](https://github.com/podium-lib/podlet/commit/bf963ad4f82ca1dabad6a960c2a836f075512385))
+
+## [4.4.74](https://github.com/podium-lib/podlet/compare/v4.4.73...v4.4.74) (2023-10-23)
+
+
+### Bug Fixes
+
+* **deps:** update all dependencies (non-major) ([4475c67](https://github.com/podium-lib/podlet/commit/4475c67d637af2bcc7f843eed386614efc3d7c61))
+
+## [4.4.73](https://github.com/podium-lib/podlet/compare/v4.4.72...v4.4.73) (2023-10-09)
+
+
+### Bug Fixes
+
+* CJS-shaped export in type definition ([fd96046](https://github.com/podium-lib/podlet/commit/fd96046ca16b89d02526453ff3cbf6d3ace694bd))
+
+## [4.4.72](https://github.com/podium-lib/podlet/compare/v4.4.71...v4.4.72) (2023-09-25)
+
+
+### Bug Fixes
+
+* **deps:** update all dependencies (non-major) ([0a47c72](https://github.com/podium-lib/podlet/commit/0a47c7289869c023235d32d301e83fd5de77f7f2))
+
+## [4.4.71](https://github.com/podium-lib/podlet/compare/v4.4.70...v4.4.71) (2023-09-18)
+
+
+### Bug Fixes
+
+* **deps:** update all dependencies (non-major) ([08a5c70](https://github.com/podium-lib/podlet/commit/08a5c702797432b7668195d10c96def7bfc0c0bf))
+
+## [4.4.70](https://github.com/podium-lib/podlet/compare/v4.4.69...v4.4.70) (2023-09-13)
+
+
+### Bug Fixes
+
+* adding type information closes [#344](https://github.com/podium-lib/podlet/issues/344) ([28e6ed9](https://github.com/podium-lib/podlet/commit/28e6ed9508d9218046f925e85fd97d17479bf390))
+
+## [4.4.69](https://github.com/podium-lib/podlet/compare/v4.4.68...v4.4.69) (2023-01-09)
+
+
+### Bug Fixes
+
+* **deps:** update all dependencies (non-major) ([0d14c8a](https://github.com/podium-lib/podlet/commit/0d14c8aae8a69ba80a32021fcd87f7f6e06b791f))
+
+## [4.4.68](https://github.com/podium-lib/podlet/compare/v4.4.67...v4.4.68) (2022-12-12)
+
+
+### Bug Fixes
+
+* **deps:** update all dependencies (non-major) ([94707a5](https://github.com/podium-lib/podlet/commit/94707a5f92f72af94b23b77ac6b27b1dd379efcb))
+
+## [4.4.67](https://github.com/podium-lib/podlet/compare/v4.4.66...v4.4.67) (2022-11-21)
+
+
+### Bug Fixes
+
+* **deps:** update all dependencies (non-major) ([6ab8c85](https://github.com/podium-lib/podlet/commit/6ab8c85ff5ef299049a21e0dc3882d1a8ae1a837))
+
+## [4.4.66](https://github.com/podium-lib/podlet/compare/v4.4.65...v4.4.66) (2022-11-14)
+
+
+### Bug Fixes
+
+* **deps:** update all dependencies (non-major) ([bf8620d](https://github.com/podium-lib/podlet/commit/bf8620dc2693a5c25daa9ae26969b591848ec541))
+
+## [4.4.65](https://github.com/podium-lib/podlet/compare/v4.4.64...v4.4.65) (2022-09-02)
+
+
+### Bug Fixes
+
+* **types:** Add pathname() method to Podium type ([779f8c3](https://github.com/podium-lib/podlet/commit/779f8c33dc92183acec90cd647865a83a99b558e))
+
 # [5.0.0-next.7](https://github.com/podium-lib/podlet/compare/v5.0.0-next.6...v5.0.0-next.7) (2023-11-20)
 
 

package/index.d.ts

@@ -1,4 +1,6 @@
 import { HttpIncoming, AssetJs, AssetCss } from '@podium/utils';
+import PodiumProxy from '@podium/proxy';
+import MetricsClient from '@metrics/client';
 
 // Use declaration merging to extend Express.
 declare global {
@@ -9,19 +11,38 @@ declare global {
     }
 }
 
-export interface PodletOptions {
+declare class Podlet {
+    constructor(options: Podlet.PodletOptions);
+
     name: string;
-    pathname: string;
+
     version: string;
-    manifest?: string;
-    content?: string;
-    fallback?: string;
-    logger?: any;
-    development?: boolean;
-}
 
-export default class Podlet {
-    constructor(options: PodletOptions);
+    manifestRoute: string;
+
+    contentRoute: string;
+
+    fallbackRoute: string;
+
+    cssRoute: AssetCss[];
+
+    jsRoute: AssetJs[];
+
+    proxyRoutes: Record<string, string>;
+
+    log: Podlet.AbsLogger;
+
+    development: boolean;
+
+    httpProxy: PodiumProxy;
+
+    baseContext: Podlet.PodletContext;
+
+    defaultContext: Podlet.PodletContext;
+
+    metrics: MetricsClient;
+
+    pathname(): string;
 
     middleware(): (req: any, res: any, next: any) => Promise<void>;
 
@@ -39,19 +60,55 @@ export default class Podlet {
 
     defaults(context: any): any;
 
-    view(
+    view<T = { [key: string]: unknown }>(
         template: (
-            incoming: HttpIncoming,
+            incoming: HttpIncoming<T>,
             fragment: string,
             ...args: unknown[]
         ) => string,
     ): void;
 
-    render(
-        incoming: HttpIncoming,
+    render<T = { [key: string]: unknown }>(
+        incoming: HttpIncoming<T>,
         fragment: string,
         ...args: unknown[]
     ): string;
 
     process(incoming: HttpIncoming): Promise<HttpIncoming>;
 }
+
+declare namespace Podlet {
+    export type AbsLogger = {
+        trace: LogFunction;
+        debug: LogFunction;
+        info: LogFunction;
+        warn: LogFunction;
+        error: LogFunction;
+        fatal: LogFunction;
+    };
+
+    type LogFunction = (...args: any) => void;
+
+    export type PodletContext = {
+        debug: 'true' | 'false';
+        locale: string;
+        deviceType: string;
+        requestedBy: string;
+        mountOrigin: string;
+        mountPathname: string;
+        publicPathname: string;
+    };
+
+    export interface PodletOptions {
+        name: string;
+        pathname: string;
+        version: string;
+        manifest?: string;
+        content?: string;
+        fallback?: string;
+        logger?: Console | AbsLogger;
+        development?: boolean;
+    }
+}
+
+export = Podlet;

package/lib/podlet.js

@@ -28,6 +28,7 @@ const { template } = utils;
 const _sanitize = Symbol('_sanitize');
 const _addCssAsset = Symbol('_addCssAsset');
 const _addJsAsset = Symbol('_addJsAsset');
+const _currentScope = Symbol('_currentScope');
 
 
 export default class PodiumPodlet {
@@ -314,8 +315,16 @@ export default class PodiumPodlet {
 
     async process(incoming, { proxy = true } = {}) {
         incoming.name = this.name;
-        incoming.css = this.cssRoute;
-        incoming.js = this.jsRoute;
+        incoming.css = this.cssRoute.filter(
+            ({ scope = 'all' }) =>
+                scope === this[_currentScope](incoming) ||
+                scope === 'all',
+        );
+        incoming.js = this.jsRoute.filter(
+            ({ scope = 'all' }) =>
+                scope === this[_currentScope](incoming) ||
+                scope === 'all',
+        );
 
         // Determine if request comes from layout server or not
         if (
@@ -397,4 +406,21 @@ export default class PodiumPodlet {
         }
         return uri;
     }
+
+    [_currentScope](incoming) {
+        const fallback = this.fallback({ prefix: true });
+        const content = this.content({ prefix: true });
+        const { pathname } = incoming.url;
+
+        // only check fallback if defined
+        // match fallback first since fallback is a more accurate match since
+        // fallback cannot take dynamic path segments and we can use exact matching
+        if (!!fallback && pathname === fallback) return 'fallback';
+
+        // fallback didn't match so check content
+        // we have to use startsWith since content may contain dynamic path segments
+        if (pathname.startsWith(content)) return 'content';
+
+        return 'all';
+    }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@podium/podlet",
-  "version": "5.0.0-next.7",
+  "version": "5.0.0",
   "type": "module",
   "description": "Module for building page fragment servers in a micro frontend architecture.",
   "license": "MIT",
@@ -29,27 +29,31 @@
     "test": "tap --no-check-coverage"
   },
   "dependencies": {
-    "@metrics/client": "2.5.0",
-    "@podium/proxy": "5.0.0-next.7",
-    "@podium/schemas": "5.0.0-next.7",
-    "@podium/utils": "5.0.0-next.10",
+    "@podium/schemas": "5.0.0",
+    "@podium/utils": "5.0.0",
+    "@podium/proxy": "5.0.0",
+    "@metrics/client": "2.5.2",
     "abslog": "2.4.0",
-    "ajv": "8.11.0",
+    "ajv": "8.12.0",
     "objobj": "1.0.0"
   },
   "devDependencies": {
-    "@semantic-release/changelog": "6.0.1",
-    "@semantic-release/git": "10.0.1",
-    "semantic-release": "19.0.5",
-    "@podium/test-utils": "2.5.2",
     "@babel/eslint-parser": "7.19.1",
     "eslint": "8.23.1",
     "eslint-config-airbnb-base": "15.0.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-import": "2.26.0",
     "eslint-plugin-prettier": "4.2.1",
-    "express": "4.18.1",
-    "prettier": "2.7.1",
-    "tap": "16.3.0"
+    "@semantic-release/changelog": "6.0.3",
+    "@semantic-release/commit-analyzer": "9.0.2",
+    "@semantic-release/git": "10.0.1",
+    "@semantic-release/github": "8.1.0",
+    "@semantic-release/npm": "9.0.2",
+    "@semantic-release/release-notes-generator": "10.0.3",
+    "semantic-release": "19.0.5",
+    "@podium/test-utils": "2.5.2",
+    "eslint-config-prettier": "8.10.0",
+    "eslint-plugin-import": "2.29.0",
+    "express": "4.18.2",
+    "prettier": "2.8.8",
+    "tap": "16.3.9"
   }
 }