fastify-txstate 3.2.1 → 3.2.3

package/lib/analytics.d.ts

@@ -1,5 +1,5 @@
 import { type InteractionEvent } from '@txstate-mws/fastify-shared';
-import type { FastifyBaseLogger, FastifyInstance } from 'fastify';
+import type { FastifyBaseLogger, FastifyInstance, FastifyRequest } from 'fastify';
 import { type IBrowser, type IDevice, type IOS } from 'ua-parser-js';
 import { type FastifyTxStateAuthInfo } from '.';
 export interface StoredInteractionEvent extends InteractionEvent {
@@ -30,4 +30,5 @@ export declare class ElasticAnalyticsClient extends AnalyticsClient {
 export declare function analyticsPlugin(fastify: FastifyInstance, opts: {
     appName: string;
     analyticsClient?: AnalyticsClient;
+    authorize?: (req: FastifyRequest) => boolean;
 }, done: (err?: Error) => void): void;

package/lib/analytics.js

@@ -8,6 +8,7 @@ const elasticsearch_1 = __importDefault(require("@elastic/elasticsearch"));
 const fastify_shared_1 = require("@txstate-mws/fastify-shared");
 const txstate_utils_1 = require("txstate-utils");
 const ua_parser_js_1 = require("ua-parser-js");
+const _1 = require(".");
 class AnalyticsClient {
     async push(events) {
         for (const event of events)
@@ -106,6 +107,8 @@ function analyticsPlugin(fastify, opts, done) {
     }
     fastify.post('/analytics', { schema: { body: { type: 'array', items: fastify_shared_1.interactionEvent }, response: { 202: { type: 'string', enum: ['OK'] } } } }, async (req, res) => {
         const { auth } = req;
+        if (opts.authorize && !opts.authorize(req))
+            throw new _1.HttpError(401);
         queueEvents(auth !== null && auth !== void 0 ? auth : { username: 'unauthenticated' }, req.headers, req.ip, req.body);
         res.statusCode = 202;
         return 'OK';

package/lib/index.d.ts

@@ -114,6 +114,8 @@ export declare const devLogger: {
     child(bindings: any, options?: any): any;
 };
 export declare const prodLogger: FastifyLoggerOptions;
+export type FastifyInstanceTyped = FastifyInstance<RawServerDefault, http.IncomingMessage, http.ServerResponse<http.IncomingMessage>, FastifyBaseLogger, JsonSchemaToTsProvider>;
+export type TxServer = Server;
 export default class Server {
     protected config: FastifyTxStateOptions & {
         http2?: true;
@@ -130,7 +132,7 @@ export default class Server {
     protected validOrigins: Record<string, boolean>;
     protected validOriginHosts: Record<string, boolean>;
     protected validOriginSuffixes: Set<string>;
-    app: FastifyInstance<RawServerDefault, http.IncomingMessage, http.ServerResponse<http.IncomingMessage>, FastifyBaseLogger, JsonSchemaToTsProvider>;
+    app: FastifyInstanceTyped;
     constructor(config?: FastifyTxStateOptions & {
         http2?: true;
     });

package/lib/index.js

@@ -140,7 +140,7 @@ class Server {
             this.setValidOriginHosts([...((_g = config.validOriginHosts) !== null && _g !== void 0 ? _g : []), ...((_j = (_h = process.env.VALID_ORIGIN_HOSTS) === null || _h === void 0 ? void 0 : _h.split(',')) !== null && _j !== void 0 ? _j : [])]);
             this.setValidOriginSuffixes([...((_k = config.validOriginSuffixes) !== null && _k !== void 0 ? _k : []), ...((_m = (_l = process.env.VALID_ORIGIN_SUFFIXES) === null || _l === void 0 ? void 0 : _l.split(',')) !== null && _m !== void 0 ? _m : [])]);
             this.app.addHook('preHandler', async (req, res) => {
-                var _a, _b;
+                var _a;
                 res.extraLogInfo = {};
                 if (!req.headers.origin)
                     return;
@@ -174,17 +174,30 @@ class Server {
                     if (req.headers['access-control-request-headers'])
                         void res.header('Access-Control-Allow-Headers', req.headers['access-control-request-headers']);
                 }
+            });
+            this.app.options('*', async (req, res) => {
+                await res.send();
+            });
+        }
+        if (config.authenticate) {
+            const authenticatedMethods = {
+                GET: true,
+                POST: true,
+                PUT: true,
+                PATCH: true,
+                DELETE: true
+            };
+            this.app.addHook('preHandler', async (req, res) => {
+                if (!authenticatedMethods[req.method])
+                    return;
                 try {
-                    req.auth = await ((_b = config.authenticate) === null || _b === void 0 ? void 0 : _b.call(config, req));
+                    req.auth = await config.authenticate(req);
                 }
                 catch (e) {
                     await res.status(401).send('Failed to authenticate.');
                     return res;
                 }
             });
-            this.app.options('*', async (req, res) => {
-                await res.send();
-            });
         }
         this.app.addHook('onSend', this.https && process.env.NODE_ENV !== 'development'
             ? async (_, resp) => {

package/lib/unified-auth.d.ts

@@ -58,4 +58,5 @@ declare class TxStateUAuthContext extends Context {
     authFromPayload(payload: JWTPayload): Promise<FastifyTxStateAuthInfo>;
 }
 export declare function unifiedAuthenticate(req: FastifyRequest, ContextClass?: typeof TxStateUAuthContext): Promise<FastifyTxStateAuthInfo | undefined>;
+export declare function unifiedAuthenticateAll(req: FastifyRequest, ContextClass?: typeof TxStateUAuthContext): Promise<void>;
 export {};

package/lib/unified-auth.js

@@ -1,7 +1,7 @@
 "use strict";
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.unifiedAuthenticate = void 0;
+exports.unifiedAuthenticateAll = exports.unifiedAuthenticate = void 0;
 const crypto_1 = require("crypto");
 const jose_1 = require("jose");
 const txstate_utils_1 = require("txstate-utils");
@@ -136,3 +136,10 @@ async function unifiedAuthenticate(req, ContextClass = TxStateUAuthContext) {
     return ctx.waitForAuth();
 }
 exports.unifiedAuthenticate = unifiedAuthenticate;
+async function unifiedAuthenticateAll(req, ContextClass = TxStateUAuthContext) {
+    const ctx = new ContextClass(req);
+    const auth = await ctx.waitForAuth();
+    if (!(auth === null || auth === void 0 ? void 0 : auth.username.length))
+        throw new Error('All requests require authentication.');
+}
+exports.unifiedAuthenticateAll = unifiedAuthenticateAll;

package/lib-esm/index.js

@@ -5,6 +5,7 @@ export const prodLogger = ftxst.prodLogger
 export const HttpError = ftxst.HttpError
 export const FailedValidationError = ftxst.FailedValidationError
 export const unifiedAuthenticate = ftxst.unifiedAuthenticate
+export const unifiedAuthenticateAll = ftxst.unifiedAuthenticateAll
 export const analyticsPlugin = ftxst.analyticsPlugin
 export const AnalyticsClient = ftxst.AnalyticsClient
 export const LoggingAnalyticsClient = ftxst.LoggingAnalyticsClient

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify-txstate",
-  "version": "3.2.1",
+  "version": "3.2.3",
   "description": "A small wrapper for fastify providing a set of common conventions & utility functions we use.",
   "exports": {
     ".": {