@podium/client 4.5.32 → 4.5.34

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [4.5.34](https://github.com/podium-lib/client/compare/v4.5.33...v4.5.34) (2023-10-09)
+
+
+### Bug Fixes
+
+* update type definitions ([d63a621](https://github.com/podium-lib/client/commit/d63a621762909e01acd6d29629c6061a757df146))
+
+## [4.5.33](https://github.com/podium-lib/client/compare/v4.5.32...v4.5.33) (2023-09-19)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @metrics/client to v2.5.2 ([764886f](https://github.com/podium-lib/client/commit/764886fe374bc364c9b3efd83a35d3fd041e6c43))
+
 ## [4.5.32](https://github.com/podium-lib/client/compare/v4.5.31...v4.5.32) (2023-09-14)
 
 

package/README.md

@@ -31,12 +31,12 @@ const component = client.register({
 });
 
 const stream = component.stream(new HttpIncoming());
-stream.once('beforeStream', res => {
+stream.once('beforeStream', (res) => {
     console.log(res.headers);
     console.log(res.css);
     console.log(res.js);
 });
-stream.on('error', error => {
+stream.on('error', (error) => {
     console.log(error);
 });
 stream.pipe(process.stdout);
@@ -58,13 +58,13 @@ const component = client.register({
 
 component
     .fetch(new HttpIncoming())
-    .then(res => {
+    .then((res) => {
         console.log(res.content);
         console.log(res.headers);
         console.log(res.css);
         console.log(res.js);
     })
-    .catch(error => {
+    .catch((error) => {
         console.log(error);
     });
 ```
@@ -299,7 +299,7 @@ When there is a change in state. See the section
 
 ```js
 const client = new Client();
-client.on('state', state => {
+client.on('state', (state) => {
     console.log(state);
 });
 
@@ -330,7 +330,7 @@ Emits the new manifest.
 
 ```js
 const client = new Client();
-client.on('change', manifest => {
+client.on('change', (manifest) => {
     console.log(manifest);
 });
 
@@ -421,7 +421,7 @@ otherwise `css` will be an empty string.
 
 ```js
 const stream = component.stream();
-stream.once('beforeStream', data => {
+stream.once('beforeStream', (data) => {
     console.log(data.headers);
     console.log(data.css);
     console.log(data.js);
@@ -492,10 +492,10 @@ const bar = client.register({
 });
 
 Promise.all([foo.fetch(), bar.fetch()])
-    .then(res => {
+    .then((res) => {
         console.log(res.content);
     })
-    .catch(error => {
+    .catch((error) => {
         console.log(error);
     });
 ```

package/client.d.ts

@@ -0,0 +1,140 @@
+import MetricsClient from '@metrics/client';
+import { HttpIncoming, AssetJs, AssetCss } from '@podium/utils';
+import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
+import { Agent as HttpAgent } from 'http';
+import { Agent as HttpsAgent } from 'https';
+
+declare class PodiumClient {
+    constructor(options?: PodiumClient.PodiumClientOptions);
+
+    readonly metrics: MetricsClient;
+    readonly state:
+        | 'instantiated'
+        | 'initializing'
+        | 'unstable'
+        | 'stable'
+        | 'unhealthy';
+
+    register(
+        options: PodiumClient.RegisterOptions,
+    ): PodiumClient.PodiumClientResource;
+
+    /**
+     * Refreshes the manifests of all registered resources. Does so by calling the
+     * `.refresh()` method on all resources under the hood.
+     */
+    refreshManifests(): Promise<void>;
+    /**
+     * This method will refresh a resource by reading its manifest and fallback
+     * if defined in the manifest. The method will not call the URI to the content
+     * of a component.
+     */
+    refresh(): Promise<number>;
+
+    js(): Array<AssetJs>;
+    css(): Array<AssetCss>;
+    /**
+     * @returns An array of all loaded manifests ready to be used by `.load()`
+     */
+    dump(): PodiumClient.PodletManifest[];
+    /**
+     * Loads an Array of manifests (provided by `.dump()`) into the proxy. If any of
+     * the items in the loaded Array contains a key which is already in the cache, the
+     * entry in the cache will be overwritten.
+     *
+     * If any of the entries in the loaded Array are not compatible with the format
+     * which `.dump()` exports, they will not be inserted into the cache.
+     *
+     * @returns An Array with the keys which were inserted into the cache.
+     */
+    load(manifests: PodiumClient.PodletManifest[]): string[];
+}
+
+declare namespace PodiumClient {
+    export type PodletManifest = {
+        name: string;
+        version: string;
+        content: string;
+        fallback?: string;
+        proxy?: Record<string, string>;
+        assets?: {
+            js?: string[];
+            css?: string[];
+        };
+        css?: string[];
+        js?: string[];
+    };
+
+    type AbsLogger = {
+        trace: LogFunction;
+        debug: LogFunction;
+        info: LogFunction;
+        warn: LogFunction;
+        error: LogFunction;
+        fatal: LogFunction;
+    };
+
+    type LogFunction = (...args: any) => void;
+
+    export type PodiumClientOptions = {
+        name?: string;
+        logger?: AbsLogger | Console;
+        retries?: number;
+        timeout?: number;
+        maxAge?: number;
+        rejectUnauthorized?: boolean;
+        resolveThreshold?: number;
+        resolveMax?: number;
+        httpAgent?: HttpAgent;
+        httpsAgent?: HttpsAgent;
+    };
+    export interface PodiumClientResourceOptions {
+        pathname?: string;
+        headers?: OutgoingHttpHeaders;
+        query?: any;
+    }
+
+    export interface PodiumClientResponse {
+        readonly redirect: PodiumRedirect;
+        readonly content: string;
+        readonly headers: IncomingHttpHeaders;
+        readonly js: Array<AssetJs>;
+        readonly css: Array<AssetCss>;
+    }
+
+    export class PodiumClientResource {
+        readonly name: string;
+
+        readonly uri: string;
+
+        fetch(
+            incoming: HttpIncoming,
+            options?: PodiumClientResourceOptions,
+        ): Promise<PodiumClientResponse>;
+
+        stream(
+            incoming: HttpIncoming,
+            options?: PodiumClientResourceOptions,
+        ): ReadableStream<PodiumClientResponse>;
+
+        refresh(): Promise<boolean>;
+    }
+
+    export interface RegisterOptions {
+        uri: string;
+        name: string;
+        retries?: number;
+        timeout?: number;
+        throwable?: boolean;
+        redirectable?: boolean;
+        resolveJs?: boolean;
+        resolveCss?: boolean;
+    }
+
+    export interface PodiumRedirect {
+        readonly statusCode: number;
+        readonly location: string;
+    }
+}
+
+export = PodiumClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@podium/client",
-  "version": "4.5.32",
+  "version": "4.5.34",
   "main": "lib/client.js",
   "license": "MIT",
   "keywords": [
@@ -21,12 +21,12 @@
   "files": [
     "package.json",
     "CHANGELOG.md",
-    "index.d.ts",
+    "client.d.ts",
     "README.md",
     "LICENSE",
     "lib"
   ],
-  "types": "index.d.ts",
+  "types": "client.d.ts",
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
@@ -36,9 +36,9 @@
   },
   "dependencies": {
     "@hapi/boom": "^9.0.0",
-    "@metrics/client": "2.5.1",
+    "@metrics/client": "2.5.2",
     "@podium/schemas": "4.1.34",
-    "@podium/utils": "4.4.39",
+    "@podium/utils": "4.4.40",
     "abslog": "2.4.0",
     "http-cache-semantics": "^4.0.3",
     "lodash.clonedeep": "^4.5.0",
@@ -67,6 +67,6 @@
     "is-stream": "2.0.1",
     "prettier": "2.8.8",
     "semantic-release": "18.0.1",
-    "tap": "16.3.8"
+    "tap": "16.3.9"
   }
 }

package/index.d.ts

@@ -1,63 +0,0 @@
-import { HttpIncoming, AssetJs, AssetCss } from '@podium/utils';
-import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
-
-declare interface PodiumClientResourceOptions {
-    pathname?: string;
-    headers?: OutgoingHttpHeaders;
-    query?: any;
-}
-
-declare interface PodiumClientResponse {
-    readonly redirect: PodiumRedirect;
-    readonly content: string;
-    readonly headers: IncomingHttpHeaders;
-    readonly js: Array<AssetJs>;
-    readonly css: Array<AssetCss>;
-}
-
-declare class PodiumClientResource {
-    readonly name: string;
-
-    readonly uri: string;
-
-    fetch(
-        incoming: HttpIncoming,
-        options?: PodiumClientResourceOptions,
-    ): Promise<PodiumClientResponse>;
-
-    stream(
-        incoming: HttpIncoming,
-        options?: PodiumClientResourceOptions,
-    ): ReadableStream<PodiumClientResponse>;
-
-    refresh(): Promise<boolean>;
-}
-
-declare interface RegisterOptions {
-    uri: string;
-    name: string;
-    retries?: number;
-    timeout?: number;
-    throwable?: boolean;
-    redirectable?: boolean;
-    resolveJs?: boolean;
-    resolveCss?: boolean;
-}
-
-declare interface PodiumRedirect {
-    readonly statusCode: number;
-    readonly location: string;
-}
-
-export default class PodiumClient {
-    readonly state:
-        | 'instantiated'
-        | 'initializing'
-        | 'unstable'
-        | 'stable'
-        | 'unhealthy';
-
-    register(options: RegisterOptions): PodiumClientResource;
-
-    refreshManifests(): Promise<void>;
-}