@rvoh/psychic 2.3.9 → 3.0.0-alpha.2

package/dist/types/src/openapi-renderer/helpers/validator-cache.d.ts

@@ -0,0 +1,35 @@
+import { ValidateFunction } from 'ajv';
+/**
+ * @internal
+ *
+ * Retrieves a cached validator function if it exists.
+ *
+ * @param cacheKey - The cache key identifying the validator
+ * @returns The cached validator function, or undefined if not found
+ */
+export declare function getCachedValidator(cacheKey: string): ValidateFunction | undefined;
+/**
+ * @internal
+ *
+ * Stores a compiled validator function in the cache.
+ *
+ * @param cacheKey - The cache key identifying the validator
+ * @param validator - The compiled AJV validator function to cache
+ */
+export declare function cacheValidator(cacheKey: string, validator: ValidateFunction): void;
+/**
+ * @internal
+ *
+ * Clears a specific validator from the cache.
+ * Used in test environments to ensure test isolation.
+ *
+ * @param cacheKey - The cache key identifying the validator to clear
+ */
+export declare function _testOnlyClearValidator(cacheKey: string): void;
+/**
+ * @internal
+ *
+ * Clears all validators from the cache.
+ * Used in test environments to ensure test isolation.
+ */
+export declare function _testOnlyClearValidatorCache(): void;

package/dist/types/src/psychic-app/index.d.ts

@@ -1,11 +1,11 @@
+import cors from '@koa/cors';
 import { DreamApp } from '@rvoh/dream';
 import { OpenapiSchemaBody } from '@rvoh/dream/openapi';
 import { DreamAppAllowedPackageManagersEnum } from '@rvoh/dream/system';
 import { DreamAppInitOptions, DreamLogLevel, DreamLogger, EncryptOptions } from '@rvoh/dream/types';
-import * as bodyParser from 'body-parser';
 import { Command } from 'commander';
-import { CorsOptions } from 'cors';
-import { Express, Request, RequestHandler, Response } from 'express';
+import Koa from 'koa';
+import bodyParser from 'koa-bodyparser';
 import * as http from 'node:http';
 import * as https from 'node:https';
 import { OpenapiValidateTarget } from '../openapi-renderer/defaults.js';
@@ -35,7 +35,7 @@ export default class PsychicApp {
     /**
      * @internal
      */
-    static getPsychicHttpInstance(app: Express, sslCredentials: PsychicSslCredentials | undefined): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse> | https.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
+    static getPsychicHttpInstance(app: Koa, sslCredentials: PsychicSslCredentials | undefined): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse> | https.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
     /**
      * Builds the routes cache if it does not already
      * exist. This is called during PsychicApp.init,
@@ -143,7 +143,7 @@ export default class PsychicApp {
     private _httpServerOptions;
     get httpServerOptions(): http.ServerOptions<typeof http.IncomingMessage, typeof http.ServerResponse> | https.ServerOptions<typeof http.IncomingMessage, typeof http.ServerResponse>;
     private _corsOptions;
-    get corsOptions(): CorsOptions;
+    get corsOptions(): cors.Options;
     private _jsonOptions;
     get jsonOptions(): bodyParser.Options;
     private _cookieOptions;
@@ -156,8 +156,6 @@ export default class PsychicApp {
     get sslCredentials(): PsychicSslCredentials | undefined;
     private _saltRounds;
     get saltRounds(): number | undefined;
-    private _sanitizeResponseJson;
-    get sanitizeResponseJson(): boolean;
     private _packageManager;
     get packageManager(): "pnpm" | "yarn" | "npm";
     private _importExtension;
@@ -219,16 +217,15 @@ export default class PsychicApp {
     load<RT extends 'controllers' | 'services' | 'initializers'>(resourceType: RT, resourcePath: string, importCb: (path: string) => Promise<any>): Promise<void>;
     private booted;
     boot(force?: boolean): Promise<void>;
-    use(on: PsychicUseEventType, handler: RequestHandler): void;
-    use(handler: RequestHandler): void;
-    use(handler: () => void): void;
+    use(on: PsychicUseEventType, handler: Koa.Middleware): void;
+    use(handler: Koa.Middleware): void;
     plugin(cb: (app: PsychicApp) => void | Promise<void>): void;
-    on<T extends PsychicHookEventType>(hookEventType: T, cb: T extends 'server:error' ? (err: Error, req: Request, res: Response) => void | Promise<void> : T extends 'server:init:before-middleware' ? (psychicServer: PsychicServer) => void | Promise<void> : T extends 'server:init:after-middleware' ? (psychicServer: PsychicServer) => void | Promise<void> : T extends 'server:start' ? (psychicServer: PsychicServer) => void | Promise<void> : T extends 'server:shutdown' ? (psychicServer: PsychicServer) => void | Promise<void> : T extends 'server:init:after-routes' ? (psychicServer: PsychicServer) => void | Promise<void> : T extends 'cli:start' ? (program: Command) => void | Promise<void> : T extends 'cli:sync' ? () => any : (conf: PsychicApp) => void | Promise<void>): void;
+    on<T extends PsychicHookEventType>(hookEventType: T, cb: T extends 'server:error' ? (err: Error, ctx: Koa.Context) => void | Promise<void> : T extends 'server:init:before-middleware' ? (psychicServer: PsychicServer) => void | Promise<void> : T extends 'server:init:after-middleware' ? (psychicServer: PsychicServer) => void | Promise<void> : T extends 'server:start' ? (psychicServer: PsychicServer) => void | Promise<void> : T extends 'server:shutdown' ? (psychicServer: PsychicServer) => void | Promise<void> : T extends 'server:init:after-routes' ? (psychicServer: PsychicServer) => void | Promise<void> : T extends 'cli:start' ? (program: Command) => void | Promise<void> : T extends 'cli:sync' ? () => any : (conf: PsychicApp) => void | Promise<void>): void;
     set(option: 'openapi', name: string, value: NamedPsychicOpenapiOptions): void;
-    set<Opt extends PsychicAppOption>(option: Opt, value: Opt extends 'appName' ? string : Opt extends 'apiOnly' ? boolean : Opt extends 'defaultResponseHeaders' ? Record<string, string | null> : Opt extends 'httpServerOptions' ? http.ServerOptions | https.ServerOptions : Opt extends 'encryption' ? PsychicAppEncryptionOptions : Opt extends 'cors' ? CorsOptions : Opt extends 'cookie' ? CustomCookieOptions : Opt extends 'apiRoot' ? string : Opt extends 'importExtension' ? GeneratorImportStyle : Opt extends 'sessionCookieName' ? string : Opt extends 'json' ? bodyParser.Options : Opt extends 'logger' ? PsychicLogger : Opt extends 'ssl' ? PsychicSslCredentials : Opt extends 'openapi' ? DefaultPsychicOpenapiOptions : Opt extends 'paths' ? PsychicPathOptions : Opt extends 'port' ? number : Opt extends 'saltRounds' ? number : Opt extends 'sanitizeResponseJson' ? boolean : Opt extends 'packageManager' ? DreamAppAllowedPackageManagersEnum : Opt extends 'inflections' ? () => void | Promise<void> : Opt extends 'routes' ? (r: PsychicRouter) => void | Promise<void> : never): void;
+    set<Opt extends PsychicAppOption>(option: Opt, value: Opt extends 'appName' ? string : Opt extends 'apiOnly' ? boolean : Opt extends 'defaultResponseHeaders' ? Record<string, string | null> : Opt extends 'httpServerOptions' ? http.ServerOptions | https.ServerOptions : Opt extends 'encryption' ? PsychicAppEncryptionOptions : Opt extends 'cors' ? cors.Options : Opt extends 'cookie' ? CustomCookieOptions : Opt extends 'apiRoot' ? string : Opt extends 'importExtension' ? GeneratorImportStyle : Opt extends 'sessionCookieName' ? string : Opt extends 'json' ? bodyParser.Options : Opt extends 'logger' ? PsychicLogger : Opt extends 'ssl' ? PsychicSslCredentials : Opt extends 'openapi' ? DefaultPsychicOpenapiOptions : Opt extends 'paths' ? PsychicPathOptions : Opt extends 'port' ? number : Opt extends 'saltRounds' ? number : Opt extends 'packageManager' ? DreamAppAllowedPackageManagersEnum : Opt extends 'inflections' ? () => void | Promise<void> : Opt extends 'routes' ? (r: PsychicRouter) => void | Promise<void> : never): void;
     override<Override extends keyof PsychicAppOverrides>(override: Override, value: PsychicAppOverrides[Override]): void;
 }
-export type PsychicAppOption = 'appName' | 'apiOnly' | 'apiRoot' | 'httpServerOptions' | 'importExtension' | 'encryption' | 'sessionCookieName' | 'cookie' | 'cors' | 'defaultResponseHeaders' | 'inflections' | 'json' | 'logger' | 'openapi' | 'packageManager' | 'paths' | 'port' | 'routes' | 'saltRounds' | 'sanitizeResponseJson' | 'ssl';
+export type PsychicAppOption = 'appName' | 'apiOnly' | 'apiRoot' | 'httpServerOptions' | 'importExtension' | 'encryption' | 'sessionCookieName' | 'cookie' | 'cors' | 'defaultResponseHeaders' | 'inflections' | 'json' | 'logger' | 'openapi' | 'packageManager' | 'paths' | 'port' | 'routes' | 'saltRounds' | 'ssl';
 export interface PsychicAppSpecialHooks {
     cliSync: (() => any)[];
     serverInitBeforeMiddleware: ((server: PsychicServer) => void | Promise<void>)[];
@@ -236,7 +233,7 @@ export interface PsychicAppSpecialHooks {
     serverInitAfterRoutes: ((server: PsychicServer) => void | Promise<void>)[];
     serverStart: ((server: PsychicServer) => void | Promise<void>)[];
     serverShutdown: ((server: PsychicServer) => void | Promise<void>)[];
-    serverError: ((err: Error, req: Request, res: Response) => void | Promise<void>)[];
+    serverError: ((err: Error, ctx: Koa.Context) => void | Promise<void>)[];
 }
 export interface PsychicAppOverrides {
     ['server:start']: ((psychicServer: PsychicServer, opts: PsychicServerStartProviderOptions) => http.Server | Promise<http.Server>) | null;

package/dist/types/src/router/index.d.ts

@@ -1,37 +1,38 @@
-import { Application, Request, RequestHandler, Response, Router } from 'express';
+import Koa from 'koa';
+import KoaRouter from '@koa/router';
 import PsychicController from '../controller/index.js';
 import { NamespaceConfig, PsychicControllerActions } from '../router/helpers.js';
-import RouteManager from './route-manager.js';
+import RouteManager, { KoaMiddleware } from './route-manager.js';
 import { HttpMethod, ResourcesOptions } from './types.js';
 export default class PsychicRouter {
-    app: Application | null;
+    app: Koa | null;
     currentNamespaces: NamespaceConfig[];
     routeManager: RouteManager;
-    constructor(app: Application | null);
+    constructor(app: Koa | null);
     get routes(): import("./route-manager.js").RouteConfig[];
     private get currentNamespacePaths();
     commit(): void;
     get(path: string): void;
-    get(path: string, middleware: RequestHandler | RequestHandler[]): void;
+    get(path: string, middleware: KoaMiddleware | KoaMiddleware[]): void;
     get<T extends typeof PsychicController>(path: string, controller: T, action: PsychicControllerActions<T>): void;
     post(path: string): void;
-    post(path: string, middleware: RequestHandler | RequestHandler[]): void;
+    post(path: string, middleware: KoaMiddleware | KoaMiddleware[]): void;
     post<T extends typeof PsychicController>(path: string, controller: T, action: PsychicControllerActions<T>): void;
     put(path: string): void;
-    put(path: string, middleware: RequestHandler | RequestHandler[]): void;
+    put(path: string, middleware: KoaMiddleware | KoaMiddleware[]): void;
     put<T extends typeof PsychicController>(path: string, controller: T, action: PsychicControllerActions<T>): void;
     patch(path: string): void;
-    patch(path: string, middleware: RequestHandler | RequestHandler[]): void;
+    patch(path: string, middleware: KoaMiddleware | KoaMiddleware[]): void;
     patch<T extends typeof PsychicController>(path: string, controller: T, action: PsychicControllerActions<T>): void;
     delete(path: string): void;
-    delete(path: string, middleware: RequestHandler | RequestHandler[]): void;
+    delete(path: string, middleware: KoaMiddleware | KoaMiddleware[]): void;
     delete<T extends typeof PsychicController>(path: string, controller: T, action: PsychicControllerActions<T>): void;
     options(path: string): void;
-    options(path: string, middleware: RequestHandler | RequestHandler[]): void;
+    options(path: string, middleware: KoaMiddleware | KoaMiddleware[]): void;
     options<T extends typeof PsychicController>(path: string, controller: T, action: PsychicControllerActions<T>): void;
     private prefixPathWithNamespaces;
     crud(httpMethod: HttpMethod, path: string): void;
-    crud(httpMethod: HttpMethod, path: string, middleware: RequestHandler | RequestHandler[]): void;
+    crud(httpMethod: HttpMethod, path: string, middleware: KoaMiddleware | KoaMiddleware[]): void;
     crud(httpMethod: HttpMethod, path: string, controller: typeof PsychicController, action: string): void;
     private checkPathForInvalidChars;
     namespace(namespace: string, cb: (router: PsychicNestedRouter) => void): void;
@@ -62,15 +63,14 @@ export default class PsychicRouter {
      * By default, do not provide an attacker with any visibility into which layer
      * of the application rejected their request.
      */
-    handle(controller: typeof PsychicController, action: string, { req, res, }: {
-        req: Request;
-        res: Response;
+    handle(controller: typeof PsychicController, action: string, { ctx, }: {
+        ctx: Koa.Context;
     }): Promise<void>;
-    _initializeController(ControllerClass: typeof PsychicController, req: Request, res: Response, action: string): PsychicController;
+    _initializeController(ControllerClass: typeof PsychicController, ctx: Koa.Context, action: string): PsychicController;
 }
 export declare class PsychicNestedRouter extends PsychicRouter {
-    router: Router;
-    constructor(expressApp: Application | null, routeManager: RouteManager, { namespaces, }?: {
+    router: KoaRouter;
+    constructor(koaApp: Koa | null, routeManager: RouteManager, { namespaces, }?: {
         namespaces?: NamespaceConfig[];
     });
 }

package/dist/types/src/router/route-manager.d.ts

@@ -1,6 +1,7 @@
-import { RequestHandler } from 'express';
+import Koa from 'koa';
 import PsychicController from '../controller/index.js';
 import { HttpMethod } from './types.js';
+export type KoaMiddleware = Koa.Middleware;
 export default class RouteManager {
     routes: RouteConfig[];
     addRoute({ httpMethod, path, controller, action, }: {
@@ -12,7 +13,7 @@ export default class RouteManager {
     addMiddleware({ httpMethod, path, middleware, }: {
         httpMethod: HttpMethod;
         path: string;
-        middleware: RequestHandler | RequestHandler[];
+        middleware: KoaMiddleware | KoaMiddleware[];
     }): void;
 }
 export type RouteConfig = ControllerActionRouteConfig | MiddlewareRouteConfig;
@@ -25,6 +26,6 @@ export type ControllerActionRouteConfig = BaseRouteConfig & {
     action: string;
 };
 export type MiddlewareRouteConfig = BaseRouteConfig & {
-    middleware: RequestHandler | RequestHandler[];
+    middleware: KoaMiddleware | KoaMiddleware[];
 };
 export {};

package/dist/types/src/server/helpers/startPsychicServer.d.ts

@@ -1,12 +1,12 @@
-import { Express } from 'express';
+import Koa from 'koa';
 import * as http from 'node:http';
 import { Server } from 'node:http';
 import * as https from 'node:https';
 import { PsychicSslCredentials } from '../../psychic-app/index.js';
 export interface StartPsychicServerOptions {
-    app: Express;
+    app: Koa;
     port: number;
     sslCredentials: PsychicSslCredentials | undefined;
 }
 export default function startPsychicServer({ app, port, sslCredentials, }: StartPsychicServerOptions): Promise<Server>;
-export declare function createPsychicHttpInstance(app: Express, sslCredentials: PsychicSslCredentials | undefined): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse> | https.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
+export declare function createPsychicHttpInstance(app: Koa, sslCredentials: PsychicSslCredentials | undefined): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse> | https.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;

package/dist/types/src/server/index.d.ts

@@ -1,11 +1,11 @@
-import { Express } from 'express';
+import Koa from 'koa';
 import { Server } from 'node:http';
 import { PsychicSslCredentials } from '../psychic-app/index.js';
 import { StartPsychicServerOptions } from './helpers/startPsychicServer.js';
 export default class PsychicServer {
     static startPsychicServer(opts: StartPsychicServerOptions): Promise<Server>;
-    static createPsychicHttpInstance(app: Express, sslCredentials: PsychicSslCredentials | undefined): Server<typeof import("http").IncomingMessage, typeof import("http").ServerResponse> | import("https").Server<typeof import("http").IncomingMessage, typeof import("http").ServerResponse>;
-    expressApp: Express;
+    static createPsychicHttpInstance(app: Koa, sslCredentials: PsychicSslCredentials | undefined): Server<typeof import("http").IncomingMessage, typeof import("http").ServerResponse> | import("https").Server<typeof import("http").IncomingMessage, typeof import("http").ServerResponse>;
+    koaApp: Koa;
     httpServer: Server;
     private booted;
     constructor();

package/dist/types/src/session/index.d.ts

@@ -1,12 +1,20 @@
-import { CookieOptions, Request, Response } from 'express';
+import Koa from 'koa';
 import { CustomCookieOptions } from '../psychic-app/index.js';
 export default class Session {
-    private req;
-    private res;
-    constructor(req: Request, res: Response);
+    private ctx;
+    constructor(ctx: Koa.Context);
     getCookie(name: string): unknown;
     setCookie(name: string, data: string, opts?: CustomSessionCookieOptions): void;
     clearCookie(name: string): void;
     daysToMilliseconds(numDays: number): number;
 }
-export type CustomSessionCookieOptions = Omit<CookieOptions, 'maxAge'> & CustomCookieOptions;
+export interface CustomSessionCookieOptions extends CustomCookieOptions {
+    secure?: boolean;
+    httpOnly?: boolean;
+    domain?: string;
+    path?: string;
+    sameSite?: 'strict' | 'lax' | 'none' | boolean;
+    expires?: Date;
+    signed?: boolean;
+    overwrite?: boolean;
+}

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "2.3.9",
+  "version": "3.0.0-alpha.2",
   "author": "RVOHealth",
   "repository": {
     "type": "git",
@@ -66,34 +66,41 @@
     "prepack": "pnpm build"
   },
   "dependencies": {
-    "@types/cookie-parser": "^1.4.8",
-    "@types/cors": "^2.8.17",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
-    "body-parser": "^2.2.1",
     "commander": "^12.1.0",
-    "cookie-parser": "^1.4.7",
-    "cors": "^2.8.5",
     "dotenv": "^16.4.5",
+    "fast-json-stringify": "^6.3.0",
     "pluralize-esm": "^9.0.5",
     "yoctocolors": "^2.1.1"
   },
   "peerDependencies": {
-    "@rvoh/dream": "^2.3.0",
-    "@types/express": "^5.0.1",
+    "@koa/cors": "^5.0.0",
+    "@koa/router": "^15.3.0",
+    "@rvoh/dream": "^2.3.1",
+    "@types/koa": "^2.15.0",
+    "@types/koa__router": "^12.0.5",
     "commander": "^12.1.0",
-    "express": "^5.2.1",
+    "koa": "^2.15.3",
+    "koa-bodyparser": "^4.4.1",
+    "koa-conditional-get": "^3.0.0",
+    "koa-etag": "^5.0.0",
     "openapi-typescript": "^7.8.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.39.1",
-    "@jest-mock/express": "^3.0.0",
-    "@rvoh/dream": "^2.3.0",
+    "@koa/cors": "^5.0.0",
+    "@koa/router": "^15.3.0",
+    "@rvoh/dream": "^2.3.1",
     "@rvoh/dream-spec-helpers": "^2.1.1",
-    "@rvoh/psychic-spec-helpers": "^2.0.0",
-    "@types/body-parser": "^1.19.6",
-    "@types/express": "^5.0.6",
-    "@types/express-session": "^1.18.2",
+    "@rvoh/psychic-spec-helpers": "^3.0.0-alpha.1",
+    "@types/koa": "^2.15.0",
+    "@types/koa-bodyparser": "^4.3.12",
+    "@types/koa-conditional-get": "^2.0.3",
+    "@types/koa-etag": "^3.0.3",
+    "@types/koa-passport": "^6.0.3",
+    "@types/koa__cors": "^5.0.0",
+    "@types/koa__router": "^12.0.5",
     "@types/node": "^22.17.1",
     "@types/passport": "^0",
     "@types/passport-local": "^1",
@@ -102,9 +109,13 @@
     "@typescript-eslint/parser": "^8.48.1",
     "@typescript/analyze-trace": "^0.10.1",
     "eslint": "^9.39.1",
-    "express": "^5.2.1",
-    "express-session": "^1.18.2",
     "jsdom": "^26.1.0",
+    "koa": "^2.15.3",
+    "koa-bodyparser": "^4.4.1",
+    "koa-conditional-get": "^3.0.0",
+    "koa-etag": "^4.0.0",
+    "koa-passport": "^6.0.0",
+    "koa-session": "^7.0.2",
     "kysely": "^0.28.5",
     "kysely-codegen": "~0.19.0",
     "luxon-jest-matchers": "^0.1.14",
@@ -117,7 +128,7 @@
     "puppeteer": "^24.22.3",
     "supertest": "^7.1.4",
     "tslib": "^2.7.0",
-    "tsx": "^4.19.3",
+    "tsx": "^4.21.0",
     "typedoc": "^0.26.6",
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.48.1",

package/dist/cjs/src/error/router/cannot-commit-routes-without-express-app.js

@@ -1,12 +0,0 @@
-export default class CannotCommitRoutesWithoutExpressApp extends Error {
-    get message() {
-        return `
-      When instantiating a PsychicRouter, if no express app is provided as the
-      first argument, you are not able to commit your routes. Make sure
-      to provide an actual express app before commiting, like so:
-
-        const app = express()
-        new PsychicRouter(app, ...)
-    `;
-    }
-}

package/dist/esm/src/error/router/cannot-commit-routes-without-express-app.js

@@ -1,12 +0,0 @@
-export default class CannotCommitRoutesWithoutExpressApp extends Error {
-    get message() {
-        return `
-      When instantiating a PsychicRouter, if no express app is provided as the
-      first argument, you are not able to commit your routes. Make sure
-      to provide an actual express app before commiting, like so:
-
-        const app = express()
-        new PsychicRouter(app, ...)
-    `;
-    }
-}

package/dist/types/src/error/router/cannot-commit-routes-without-express-app.d.ts

@@ -1,3 +0,0 @@
-export default class CannotCommitRoutesWithoutExpressApp extends Error {
-    get message(): string;
-}