fix: types for context (#276)

Author: wkillerud

README.md

@@ -12,7 +12,7 @@ please see the [Podium documentation].
 ## Installation
 
 ```bash
-$ npm install @podium/fastify-layout
+npm install @podium/fastify-layout
 ```
 
 ## Simple usage
@@ -30,12 +30,11 @@ const layout = new Layout({
     pathname: '/',
     logger: console,
     name: 'layout',
-
 });
 
 const podlet = layout.client.register({
     name: 'myPodlet',
-    uri: 'http://localhost:7100/manifest.json'
+    uri: 'http://localhost:7100/manifest.json',
 });
 
 app.register(FastifyLayout, layout);
@@ -44,17 +43,18 @@ app.get(layout.pathname(), async (request, reply) => {
     const incoming = reply.app.podium;
     const result = await podlet.fetch(incoming);
     reply.podiumSend(result.content);
+    await reply;
 });
 
 const start = async () => {
     try {
-        await app.listen(7000);
+        await app.listen({ port: 7000 });
         app.log.info(`server listening on ${app.server.address().port}`);
     } catch (err) {
         app.log.error(err);
         process.exit(1);
     }
-}
+};
 start();
 ```
 
@@ -121,4 +121,4 @@ SOFTWARE.
 [document template]: https://podium-lib.io/docs/api/document 'document template'
 [@podium/context]: https://github.com/podium-lib/context '@podium/context'
 [@podium/layout]: https://github.com/podium-lib/layout '@podium/layout'
-[fastify]: https://www.fastify.io/ 'Fastify'
+[fastify]: https://www.fastify.io/ 'Fastify'

example/server.js

@@ -2,11 +2,10 @@ import { HttpIncoming, pathnameBuilder } from '@podium/utils';
 import fp from 'fastify-plugin';
 
 export default fp(
-    (fastify, options, done) => {
-        const layout = /** @type {import('@podium/layout').default} */ (
-            options
-        );
-
+    /**
+     * @type {import('fastify').FastifyPluginCallback<import('@podium/layout').default>}
+     */
+    (fastify, layout, done) => {
         // Decorate reply with .app.podium we can write to throughout the request
         fastify.decorateReply('app', null);
         fastify.addHook('onRequest', async (request, reply) => {

lib/layout-plugin.js

@@ -32,12 +32,10 @@
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "test": "run-s test:unit test:types",
-    "test:unit": "tap --disable-coverage --allow-empty-coverage",
-    "test:types": "tsc --project tsconfig.test.json",
+    "test": "tap --disable-coverage --allow-empty-coverage",
     "test:coverage": "tap",
     "types": "run-s types:tsc types:fixup",
-    "types:tsc": "tsc --declaration --emitDeclarationOnly",
+    "types:tsc": "tsc",
     "types:fixup": "node ./fixup.js"
   },
   "author": "Trygve Lie",
@@ -48,7 +46,7 @@
   "devDependencies": {
     "@babel/eslint-parser": "7.24.7",
     "@fastify/formbody": "7.4.0",
-    "@podium/layout": "5.1.14",
+    "@podium/layout": "5.2.7",
     "@podium/test-utils": "3.0.6",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
@@ -61,7 +59,7 @@
     "npm-run-all2": "5.0.2",
     "prettier": "3.3.2",
     "semantic-release": "22.0.12",
-    "tap": "19.2.5",
+    "tap": "21.0.1",
     "typescript": "5.5.4"
   }
 }

package.json

@@ -1,4 +1,3 @@
-/// <reference path="../types/layout-plugin.d.ts" />
 import { PodletServer, request } from '@podium/test-utils';
 import fastify from 'fastify';
 import Layout from '@podium/layout';

tests/layout-plugin.test.js

@@ -7,8 +7,8 @@
     "checkJs": true,
     "allowJs": true,
     "moduleResolution": "nodenext",
+    "emitDeclarationOnly": true,
     "declaration": true,
-    "skipLibCheck": true,
     "allowSyntheticDefaultImports": true,
     "outDir": "types"
   },

tsconfig.json

@@ -1,28 +1,42 @@
-import { HttpIncoming } from "@podium/utils";
+import { HttpIncoming } from '@podium/utils';
 
-declare module "fastify" {
-  interface PodiumParams {}
+declare module 'fastify' {
+    interface PodiumParams {}
 
-	interface PodiumLocals {
-		/**
-		 * @see https://podium-lib.io/docs/api/incoming
-		 */
-		podium: HttpIncoming;
-		params: PodiumParams;
-	}
+    interface PodiumHttpIncomingParameters {
+        [key: string]: unknown;
+    }
 
+    // @podium/layout declares what's on the context. We use the same interface names here to inherit them.
 
-	interface FastifyReply {
-		app: PodiumLocals;
-		/**
-		 * This method wraps the provided fragment in a default HTML document before dispatching.
-		 *
-		 * @param markup The HTML contents of the document
-		 * @param args Parameters sent to the template function
-		 * @returns {void} Sends the FastifyReply
-		 *
-	   * @see https://podium-lib.io/docs/api/layout#respodiumsendfragment
-		 */
-    podiumSend: (markup: unknown, ...args: unknown[]) => void;
-	}
+    interface PodiumHttpIncomingContext {
+        [key: string]: unknown;
+    }
+
+    interface PodiumHttpIncomingViewParameters {
+        [key: string]: unknown;
+    }
+
+    interface PodiumLocals {
+        podium: HttpIncoming<
+            PodiumHttpIncomingParameters,
+            PodiumHttpIncomingContext,
+            PodiumHttpIncomingViewParameters
+        >;
+        params: PodiumParams;
+    }
+
+    interface FastifyReply {
+        app: PodiumLocals;
+        /**
+         * This method wraps the provided fragment in a default HTML document before dispatching.
+         *
+         * @param markup The HTML contents of the document
+         * @param args Parameters sent to the template function
+         * @returns {void} Sends the FastifyReply
+         *
+         * @see https://podium-lib.io/docs/api/layout#respodiumsendfragment
+         */
+        podiumSend: (markup: unknown, ...args: unknown[]) => void;
+    }
 }