@rvoh/psychic 1.10.4 → 1.11.0-beta.1

package/dist/cjs/src/psychic-app/index.js

@@ -62,7 +62,7 @@ class PsychicApp {
      */
     static async init(cb, dreamCb, opts = {}) {
         let psychicApp;
-        await dream_1.DreamApp.init(dreamCb, { bypassModelIntegrityCheck: opts.bypassModelIntegrityCheck }, async (dreamApp) => {
+        await dream_1.DreamApp.init(dreamCb, opts, async (dreamApp) => {
             psychicApp = new PsychicApp();
             await cb(psychicApp);
             if (!psychicApp.loadedControllers)
@@ -97,7 +97,7 @@ class PsychicApp {
             dreamApp.set('logger', psychicApp.logger);
             dreamApp.set('packageManager', psychicApp.packageManager);
             (0, cache_js_1.cachePsychicApp)(psychicApp);
-            if (!opts.bypassModelIntegrityCheck) {
+            if (!opts.bypassDreamIntegrityChecks) {
                 // routes _must_ be built before openapi
                 // cache can be processed
                 await psychicApp.buildRoutesCache();

package/dist/cjs/src/router/index.js

@@ -266,7 +266,7 @@ suggested fix:  "${(0, helpers_js_1.convertRouteParams)(path)}"
     async handle(controller, action, { req, res, }) {
         const controllerInstance = this._initializeController(controller, req, res, action);
         if (typeof controllerInstance[action] !== 'function') {
-            res.sendStatus(404);
+            controllerInstance['expressSendStatus'](404);
             return;
         }
         try {
@@ -274,25 +274,23 @@ suggested fix:  "${(0, helpers_js_1.convertRouteParams)(path)}"
         }
         catch (error) {
             const err = error;
-            if (!EnvInternal_js_1.default.isTest)
-                index_js_1.default.logWithLevel('error', err.message);
             if ((0, errorIsRescuableHttpError_js_1.default)(err)) {
                 const httpErr = err;
                 if (httpErr.data) {
-                    res.status(httpErr.status).json(httpErr.data);
+                    controllerInstance['expressSendJson'](httpErr.data, httpErr.status);
                 }
                 else {
-                    res.sendStatus(httpErr.status);
+                    controllerInstance['expressSendStatus'](httpErr.status);
                 }
             }
             else if (err instanceof dream_1.RecordNotFound) {
-                res.sendStatus(404);
+                controllerInstance['expressSendStatus'](404);
             }
             else if (err instanceof dream_1.DataIncompatibleWithDatabaseField) {
                 /**
                  * See comment at top of this method for philosophy of 400
                  */
-                res.sendStatus(400);
+                controllerInstance['expressSendStatus'](400);
             }
             else if (err instanceof dream_1.ValidationError) {
                 if (this.validationErrorLoggingEnabled) {
@@ -304,7 +302,7 @@ suggested fix:  "${(0, helpers_js_1.convertRouteParams)(path)}"
                 /**
                  * See comment at top of this method for philosophy of 400
                  */
-                res.sendStatus(400);
+                controllerInstance['expressSendStatus'](400);
             }
             else if (err instanceof OpenapiRequestValidationFailure_js_1.default) {
                 if (this.validationErrorLoggingEnabled) {
@@ -317,7 +315,7 @@ suggested fix:  "${(0, helpers_js_1.convertRouteParams)(path)}"
                 /**
                  * See comment at top of this method for philosophy of 400
                  */
-                res.sendStatus(400);
+                controllerInstance['expressSendStatus'](400);
             }
             else if (err instanceof ParamValidationError_js_1.default) {
                 if (this.validationErrorLoggingEnabled) {
@@ -331,7 +329,7 @@ suggested fix:  "${(0, helpers_js_1.convertRouteParams)(path)}"
                 /**
                  * See comment at top of this method for philosophy of 400
                  */
-                res.sendStatus(400);
+                controllerInstance['expressSendStatus'](400);
             }
             else if (err instanceof ParamValidationErrors_js_1.default) {
                 if (this.validationErrorLoggingEnabled) {
@@ -343,17 +341,10 @@ suggested fix:  "${(0, helpers_js_1.convertRouteParams)(path)}"
                 /**
                  * See comment at top of this method for philosophy of 400
                  */
-                res.sendStatus(400);
+                controllerInstance['expressSendStatus'](400);
             }
             else {
-                // by default, ts-node will mask these errors for no good reason, causing us
-                // to have to apply an ugly and annoying try-catch pattern to our controllers
-                // and manually console log the error to determine what the actual error was.
-                // this block enables us to not have to do that anymore.
-                if (EnvInternal_js_1.default.isTest && !EnvInternal_js_1.default.boolean('PSYCHIC_EXPECTING_INTERNAL_SERVER_ERROR')) {
-                    index_js_1.default.log('ATTENTION: a server error was detected:');
-                    index_js_1.default.logWithLevel('error', err);
-                }
+                index_js_1.default.logWithLevel('error', err);
                 if (index_js_1.default.getOrFail().specialHooks.serverError.length) {
                     try {
                         for (const hook of index_js_1.default.getOrFail().specialHooks.serverError) {

package/dist/cjs/src/server/helpers/startPsychicServer.js

@@ -32,8 +32,10 @@ const dream_1 = require("@rvoh/dream");
 const fs = __importStar(require("node:fs"));
 const http = __importStar(require("node:http"));
 const https = __importStar(require("node:https"));
+const colorize_js_1 = __importDefault(require("../../cli/helpers/colorize.js"));
 const EnvInternal_js_1 = __importDefault(require("../../helpers/EnvInternal.js"));
-const index_js_1 = __importDefault(require("../../server/index.js"));
+const index_js_1 = __importDefault(require("../../psychic-app/index.js"));
+const PsychicLogos_js_1 = __importDefault(require("../../cli/helpers/PsychicLogos.js"));
 async function startPsychicServer({ app, port, sslCredentials, }) {
     return await new Promise(accept => {
         const httpOrHttps = createPsychicHttpInstance(app, sslCredentials);
@@ -55,9 +57,20 @@ function createPsychicHttpInstance(app, sslCredentials) {
     }
 }
 function welcomeMessage({ port }) {
-    if (!EnvInternal_js_1.default.isTest) {
-        dream_1.DreamCLI.logger.log('starting psychic server...');
-        dream_1.DreamCLI.logger.log(index_js_1.default.asciiLogo(), { logPrefix: '' });
+    if (EnvInternal_js_1.default.isDevelopment) {
+        dream_1.DreamCLI.logger.log((0, colorize_js_1.default)(PsychicLogos_js_1.default.babyAster(), { color: 'greenBright' }), {
+            logPrefix: '',
+        });
+        dream_1.DreamCLI.logger.log('', { logPrefix: '' });
+        dream_1.DreamCLI.logger.log((0, colorize_js_1.default)('✺ ' + index_js_1.default.getOrFail().appName, { color: 'greenBright' }), {
+            logPrefix: '',
+        });
+        dream_1.DreamCLI.logger.log((0, colorize_js_1.default)(`└─ http://localhost:${port.toString()}`, { color: 'greenBright' }), {
+            logPrefix: '',
+        });
+        dream_1.DreamCLI.logger.log('', { logPrefix: '' });
+    }
+    else {
         dream_1.DreamCLI.logger.log(`psychic dev server started at port ${port}`);
     }
 }

package/dist/cjs/src/server/index.js

@@ -34,6 +34,7 @@ const EnvInternal_js_1 = __importDefault(require("../helpers/EnvInternal.js"));
 const index_js_1 = __importDefault(require("../psychic-app/index.js"));
 const index_js_2 = __importDefault(require("../router/index.js"));
 const startPsychicServer_js_1 = __importStar(require("./helpers/startPsychicServer.js"));
+const logIfDevelopment_js_1 = __importDefault(require("../controller/helpers/logIfDevelopment.js"));
 // const debugEnabled = debuglog('psychic').enabled
 class PsychicServer {
     static async startPsychicServer(opts) {
@@ -42,9 +43,6 @@ class PsychicServer {
     static createPsychicHttpInstance(app, sslCredentials) {
         return (0, startPsychicServer_js_1.createPsychicHttpInstance)(app, sslCredentials);
     }
-    static asciiLogo() {
-        return dream_1.DreamLogos.colorful();
-    }
     expressApp;
     httpServer;
     booted = false;
@@ -92,9 +90,28 @@ class PsychicServer {
         for (const afterRoutesHook of index_js_1.default.getOrFail().specialHooks.serverInitAfterRoutes) {
             await afterRoutesHook(this);
         }
+        this.applyNotFoundMiddleware();
         this.booted = true;
         return true;
     }
+    applyNotFoundMiddleware() {
+        if (!EnvInternal_js_1.default.isDevelopment)
+            return;
+        this.expressApp.use((req, res, next) => {
+            // express by default will set the 200 status code. If a user explicitly
+            // provides anything other than 200, we should assume that a prior middleware
+            // would have have sent headers, which would prevent any of this from happening.
+            // this means that if we are here, we should not be sending a 200. Future middleware
+            // by express will automatically pick this up and turn it into a 404, so we are
+            // going to automatically set the status to 404 now, so that our logger can
+            // pick up the correct status code.
+            if (res.statusCode === 200)
+                res.status(404);
+            (0, logIfDevelopment_js_1.default)({ req, res, startTime: Date.now(), fallbackStatusCode: 404 });
+            // call next to let express handle sending the 404
+            next();
+        });
+    }
     setSecureDefaultHeaders() {
         this.expressApp.disable('x-powered-by');
         this.expressApp.use((_, res, next) => {

package/dist/esm/src/bin/helpers/enumsFileStr.js

@@ -14,6 +14,7 @@ export const ${exportedTypeName} = [
             .map(val => `'${val}'`)
             .join(',\n  ')}
 ] as const
+export type ${exportedTypeName.replace(/Values^/, '')} = (typeof ${exportedTypeName})[number]
 
 `;
     });

package/dist/esm/src/cli/helpers/PsychicLogos.js

@@ -0,0 +1,32 @@
+import colorize from './colorize.js';
+export default class PsychicLogos {
+    static babyAster() {
+        const g = (str) => colorize(str, { color: 'green' });
+        return `
+░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
+░░░░░░█▀█░█▀▀░█░█░█▀▀░█░█░▀█▀░█▀▀░░░░░░░░░
+░░░░░░█▀▀░▀▀█░░█░░█░░░█▀█░░█░░█░░░░░░░░░░░
+░░░░░░▀░░░▀▀▀░░▀░░▀▀▀░▀░▀░▀▀▀░▀▀▀░░░░░░░░░
+░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
+⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡿⠿⣿⣿⣿⣿⣿⣿⣿⣿⠟⢉⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
+⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡟⣀⡀⠈⠻⠿⡿⠿⠛⠉⠁⢠⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
+⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡟⠀⠀⠹⠀⠀⠀⠀⠀⠀⠀⢰⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
+⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠿⠿⠃⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
+⣿⣿⣿⣿⣿⣿⣿⣿⠟⠉⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⢸⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
+⣿⠿⠛⠋⠉⠉⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢴⣲⠀⠀⠀⠋⣼⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢸⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣤⡀⠀⢀⣠⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠰⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠀
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿
+⠀⠀⠀⠀⠀⠀⣀⠀⠀⠀⠀⠀⠀⠀⢸▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓
+⠀⠀⠀⠀⢠▓⣿⠀⠀⠀⣿ ⠀ ⣸⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿
+⠀⠀⠀⢠▓⣿▓⣦⠀⠀⣿▓⠀⠀⠋▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓
+⠀⠀⠀⢸⣿▓⣿▓⡄⠀⠈⠙⣄⣀⣠⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿
+⠀⠀⠀⠺▓⣿▓⣿▓⣄⣀⣤⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓⣿▓\
+`.replace(/▓/g, g('▓'));
+    }
+}

package/dist/esm/src/cli/index.js

@@ -67,7 +67,7 @@ export default class PsychicCLI {
             .argument('<modelName>', 'the name of the model to create, e.g. Post or Settings/CommunicationPreferences')
             .argument('[columnsWithTypes...]', columnsWithTypesDescription)
             .action(async (route, modelName, columnsWithTypes, options) => {
-            await initializePsychicApp();
+            await initializePsychicApp({ bypassDreamIntegrityChecks: true });
             await PsychicBin.generateResource(route, modelName, columnsWithTypes, options);
             process.exit();
         });
@@ -78,7 +78,7 @@ export default class PsychicCLI {
             .argument('<controllerName>', 'the name of the controller to create, including namespaces, e.g. Posts or Api/V1/Posts')
             .argument('[actions...]', 'the names of controller actions to create')
             .action(async (controllerName, actions) => {
-            await initializePsychicApp();
+            await initializePsychicApp({ bypassDreamIntegrityChecks: true });
             await PsychicBin.generateController(controllerName, actions);
             process.exit();
         });
@@ -135,7 +135,7 @@ export default class PsychicCLI {
             .description('sync introspects your database, updating your schema to reflect, and then syncs the new schema with the installed dream node module, allowing it provide your schema to the underlying kysely integration')
             .option('--schema-only')
             .action(async (options = {}) => {
-            await initializePsychicApp();
+            await initializePsychicApp({ bypassDreamIntegrityChecks: !!options.schemaOnly });
             await PsychicBin.sync(options);
             process.exit();
         });
@@ -144,7 +144,7 @@ export default class PsychicCLI {
             .description('watches your app for changes, and re-syncs any time they happen')
             .argument('[dir]', 'the folder you want to watch, defaults to ./src')
             .action(async (dir) => {
-            await initializePsychicApp();
+            await initializePsychicApp({ bypassDreamIntegrityChecks: true });
             Watcher.watch(dir);
         });
         program

package/dist/esm/src/controller/helpers/httpMethodColor.js

@@ -0,0 +1,30 @@
+export default function httpMethodColor(httpMethod) {
+    switch (httpMethod) {
+        case 'delete':
+            return 'red';
+        case 'options':
+            return 'gray';
+        case 'patch':
+        case 'put':
+            return 'magentaBright';
+        case 'post':
+            return 'greenBright';
+        default:
+            return 'blue';
+    }
+}
+export function httpMethodBgColor(httpMethod) {
+    switch (httpMethod) {
+        case 'delete':
+            return 'bgRed';
+        case 'options':
+            return 'bgWhite';
+        case 'patch':
+        case 'put':
+            return 'bgMagentaBright';
+        case 'post':
+            return 'bgGreen';
+        default:
+            return 'bgBlue';
+    }
+}

package/dist/esm/src/controller/helpers/logIfDevelopment.js

@@ -0,0 +1,22 @@
+import { DreamCLI } from '@rvoh/dream';
+import colorize from '../../cli/helpers/colorize.js';
+import EnvInternal from '../../helpers/EnvInternal.js';
+import { httpMethodBgColor } from './httpMethodColor.js';
+import { statusCodeBgColor } from './statusCodeColor.js';
+export default function logIfDevelopment({ req, res, startTime, fallbackStatusCode = 200, }) {
+    if (!EnvInternal.isDevelopment)
+        return;
+    const method = colorize(` ${req.method.toUpperCase()} `, {
+        color: 'black',
+        bgColor: httpMethodBgColor(req.method.toLowerCase()),
+    });
+    const computedStatus = res.statusCode || fallbackStatusCode;
+    const statusBgColor = statusCodeBgColor(computedStatus);
+    const status = colorize(` ${computedStatus} `, {
+        color: 'black',
+        bgColor: statusBgColor,
+    });
+    const url = colorize(req.url, { color: 'green' });
+    const benchmark = colorize(`${Date.now() - startTime}ms`, { color: 'gray' });
+    DreamCLI.logger.log(`${method} ${url} ${status} ${benchmark}`, { logPrefix: '' });
+}

package/dist/esm/src/controller/helpers/statusCodeColor.js

@@ -0,0 +1,18 @@
+export default function statusCodeColor(statusCode) {
+    if (statusCode >= 200 && statusCode < 300)
+        return 'green';
+    if (statusCode >= 300 && statusCode < 400)
+        return 'yellow';
+    if (statusCode >= 400 && statusCode < 500)
+        return 'red';
+    return 'redBright';
+}
+export function statusCodeBgColor(statusCode) {
+    if (statusCode >= 200 && statusCode < 300)
+        return 'bgGreen';
+    if (statusCode >= 300 && statusCode < 400)
+        return 'bgYellow';
+    if (statusCode >= 400 && statusCode < 500)
+        return 'bgRed';
+    return 'bgRedBright';
+}

package/dist/esm/src/controller/index.js

@@ -37,7 +37,9 @@ import PsychicApp from '../psychic-app/index.js';
 import Params from '../server/params.js';
 import Session from '../session/index.js';
 import isPaginatedResult from './helpers/isPaginatedResult.js';
+import logIfDevelopment from './helpers/logIfDevelopment.js';
 import renderDreamOrVewModel from './helpers/renderDreamOrViewModel.js';
+import EnvInternal from '../helpers/EnvInternal.js';
 export const PsychicParamsPrimitiveLiterals = [
     'bigint',
     'bigint[]',
@@ -171,7 +173,9 @@ export default class PsychicController {
     session;
     action;
     renderOpts;
+    startTime;
     constructor(req, res, { action, }) {
+        this.startTime = Date.now();
         this.req = req;
         this.res = res;
         this.session = new Session(req, res);
@@ -422,7 +426,26 @@ export default class PsychicController {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     data) {
         this.validateOpenapiResponseBody(data);
-        this.res.type('json').send(toJson(data, PsychicApp.getOrFail().sanitizeResponseJson));
+        this.expressSendJson(data);
+    }
+    expressSendJson(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    data, statusCode = this.res.statusCode) {
+        this.res.type('json').status(statusCode).send(toJson(data, PsychicApp.getOrFail().sanitizeResponseJson));
+        this.logIfDevelopment();
+    }
+    expressSendStatus(statusCode) {
+        this.res.sendStatus(statusCode);
+        this.logIfDevelopment();
+    }
+    expressRedirect(statusCode, newLocation) {
+        this.res.redirect(statusCode, newLocation);
+        this.logIfDevelopment();
+    }
+    logIfDevelopment() {
+        if (!EnvInternal.isDevelopment)
+            return;
+        logIfDevelopment({ req: this.req, res: this.res, startTime: this.startTime });
     }
     defaultSerializerPassthrough = {};
     serializerPassthrough(passthrough) {
@@ -469,15 +492,15 @@ export default class PsychicController {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     nonAuthoritativeInformation(message = undefined) {
         if (message) {
-            this.res.status(203).json(message);
+            this.expressSendJson(message, 203);
         }
         else {
-            this.res.sendStatus(203);
+            this.expressSendStatus(203);
         }
     }
     // 204
     noContent() {
-        this.res.sendStatus(204);
+        this.expressSendStatus(204);
     }
     // 205
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -493,27 +516,23 @@ export default class PsychicController {
     }
     // 301
     movedPermanently(newLocation) {
-        this.res.redirect(301, newLocation);
+        this.expressRedirect(301, newLocation);
     }
     // 302
     found(newLocation) {
-        this.res.redirect(302, newLocation);
+        this.expressRedirect(302, newLocation);
     }
     // 303
     seeOther(newLocation) {
-        this.res.redirect(303, newLocation);
-    }
-    // 304
-    notModified(newLocation) {
-        this.res.redirect(304, newLocation);
+        this.expressRedirect(303, newLocation);
     }
     // 307
     temporaryRedirect(newLocation) {
-        this.res.redirect(307, newLocation);
+        this.expressRedirect(307, newLocation);
     }
     // 308
     permanentRedirect(newLocation) {
-        this.res.redirect(308, newLocation);
+        this.expressRedirect(308, newLocation);
     }
     // 400
     // eslint-disable-next-line @typescript-eslint/no-explicit-any