@rvoh/psychic 1.1.0 → 1.1.2

package/CHANGELOG.md

@@ -35,3 +35,7 @@ r.get('helloworld', (req, res, next) => {
   res.json({ hello: 'world' })
 })
 ```
+
+## 1.1.1
+
+Fix route printing regression causing route printouts to show the path instead of the action

package/dist/cjs/src/bin/helpers/printRoutes.js

@@ -31,7 +31,7 @@ function buildExpressions(routes) {
         const beginningOfExpression = `${route.httpMethod.toUpperCase()}${' '.repeat(numMethodSpaces)}${formattedPath}`;
         const controllerRouteConf = route;
         const endOfExpression = controllerRouteConf.controller
-            ? controllerRouteConf.controller.controllerActionPath(formattedPath)
+            ? controllerRouteConf.controller.controllerActionPath(controllerRouteConf.action)
             : 'middleware';
         return [beginningOfExpression, endOfExpression];
     });

package/dist/cjs/src/controller/decorators.js

@@ -18,7 +18,9 @@ function BeforeAction(opts = {}) {
             }
             if (!Object.getOwnPropertyDescriptor(psychicControllerClass, 'controllerHooks'))
                 psychicControllerClass.controllerHooks = [...psychicControllerClass.controllerHooks];
-            psychicControllerClass.controllerHooks.push(new hooks_js_1.ControllerHook(psychicControllerClass.name, methodName.toString(), opts));
+            if (!psychicControllerClass.controllerHooks.find(hook => hook.methodName === methodName)) {
+                psychicControllerClass.controllerHooks.push(new hooks_js_1.ControllerHook(psychicControllerClass.name, methodName.toString(), opts));
+            }
         });
     };
 }

package/dist/cjs/src/generate/helpers/reduxBindings/printFinalStepsMessage.js

@@ -7,7 +7,7 @@ exports.default = printFinalStepsMessage;
 const dream_1 = require("@rvoh/dream");
 const colorize_js_1 = __importDefault(require("../../../cli/helpers/colorize.js"));
 function printFinalStepsMessage(opts) {
-    const importLine = (0, colorize_js_1.default)(`+ import { ${opts.exportName} } from '${opts.apiFile}'`, { color: 'green' });
+    const importLine = (0, colorize_js_1.default)(`+ import { ${opts.exportName} } from '${opts.outputFile}'`, { color: 'green' });
     const reducerLine = (0, colorize_js_1.default)(`    + [${opts.exportName}.reducerPath]: ${opts.exportName}.reducer,`, {
         color: 'green',
     });
@@ -17,7 +17,11 @@ function printFinalStepsMessage(opts) {
     dream_1.DreamCLI.logger.log(`
 Finished generating redux bindings for your application,
 but to wire them into your app, we're going to need your help.
-Be sure to add the following to your root store to bind your new
+
+First, you will need to be sure to sync, so that the new openapi
+types are sent over to your client application.
+
+Next, be sure to add the following to your root store to bind your new
 api module into your redux app, i.e.
 
 // add this line, fix the import path if necessary

package/dist/cjs/src/generate/helpers/reduxBindings/writeInitializer.js

@@ -54,10 +54,10 @@ async function writeInitializer({ exportName }) {
     const contents = `\
 import { DreamCLI } from '@rvoh/dream'
 import { PsychicApp } from '@rvoh/psychic'
-import AppEnv from '../AppEnv.js'
+import AppEnv from '../../AppEnv.js'
 
 export default function initialize${pascalized}(psy: PsychicApp) {
-  psy.on('sync', async () => {
+  psy.on('cli:sync', async () => {
     if (AppEnv.isDevelopmentOrTest) {
       DreamCLI.logger.logStartProgress(\`[${camelized}] syncing...\`)
       await DreamCLI.spawn('npx @rtk-query/codegen-openapi ${filePath}', {

package/dist/cjs/src/generate/helpers/syncOpenapiTypescript/generateInitializer.js

@@ -50,7 +50,7 @@ import { PsychicApp } from "@rvoh/psychic"
 import AppEnv from '../AppEnv.js'
 
 export default (psy: PsychicApp) => {
-  psy.on('sync', async () => {
+  psy.on('cli:sync', async () => {
     if (AppEnv.isDevelopmentOrTest) {
       DreamCLI.logger.logStartProgress(\`[${hyphenized}] extracting types from ${openapiFilepath} to ${outfile}...\`)
       await DreamCLI.spawn('npx openapi-typescript ${openapiFilepath} -o ${outfile}')

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

@@ -12,6 +12,7 @@ exports.namespacedControllerActionString = namespacedControllerActionString;
 exports.lookupControllerOrFail = lookupControllerOrFail;
 exports.applyResourcesAction = applyResourcesAction;
 exports.applyResourceAction = applyResourceAction;
+exports.convertRouteParams = convertRouteParams;
 const dream_1 = require("@rvoh/dream");
 const cannot_find_inferred_controller_from_provided_namespace_js_1 = __importDefault(require("../error/router/cannot-find-inferred-controller-from-provided-namespace.js"));
 const cannot_infer_controller_from_top_level_route_js_1 = __importDefault(require("../error/router/cannot-infer-controller-from-top-level-route.js"));
@@ -123,6 +124,15 @@ function applyResourceAction(path, action, routingMechanism, options) {
             throw new Error(`unsupported resource method type: ${action}`);
     }
 }
+/**
+ * Converts OpenAPI-style route parameters to Express.js-style parameters
+ * Example: users/{userId}/abc/{id} -> users/:userId/abc/:id
+ */
+function convertRouteParams(path) {
+    // Use a more specific regex to avoid polynomial time complexity
+    // Only match valid parameter names (alphanumeric + underscore, 1-50 chars)
+    return path.replace(/\{([a-zA-Z_][a-zA-Z0-9_]{0,49})\}/g, ':$1');
+}
 function httpMethodFromResourcefulAction(action) {
     switch (action) {
         case 'index':

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

@@ -74,6 +74,7 @@ class PsychicRouter {
         return '/' + this.currentNamespacePaths.join('/') + '/' + str;
     }
     crud(httpMethod, path, controllerOrMiddleware, action) {
+        this.checkPathForInvalidChars(path);
         const isMiddleware = typeof controllerOrMiddleware === 'function' &&
             !controllerOrMiddleware?.isPsychicController;
         // devs can provide custom express middleware which bypasses
@@ -98,6 +99,18 @@ class PsychicRouter {
             });
         }
     }
+    checkPathForInvalidChars(path) {
+        if (path.includes('{'))
+            throw new Error(`
+The provided route "${path}" contains characters that are not supported.
+If you are trying to write a uri param, you will need to use expressjs
+param syntax, which is a prefixing colon, rather than using brackets
+to surround the param.
+
+provided route: "${path}"
+suggested fix:  "${(0, helpers_js_1.convertRouteParams)(path)}"
+`);
+    }
     namespace(namespace, cb) {
         const nestedRouter = new PsychicNestedRouter(this.app, this.config, this.routeManager, {
             namespaces: this.currentNamespaces,

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

@@ -25,7 +25,7 @@ function buildExpressions(routes) {
         const beginningOfExpression = `${route.httpMethod.toUpperCase()}${' '.repeat(numMethodSpaces)}${formattedPath}`;
         const controllerRouteConf = route;
         const endOfExpression = controllerRouteConf.controller
-            ? controllerRouteConf.controller.controllerActionPath(formattedPath)
+            ? controllerRouteConf.controller.controllerActionPath(controllerRouteConf.action)
             : 'middleware';
         return [beginningOfExpression, endOfExpression];
     });

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

@@ -11,7 +11,9 @@ export function BeforeAction(opts = {}) {
             }
             if (!Object.getOwnPropertyDescriptor(psychicControllerClass, 'controllerHooks'))
                 psychicControllerClass.controllerHooks = [...psychicControllerClass.controllerHooks];
-            psychicControllerClass.controllerHooks.push(new ControllerHook(psychicControllerClass.name, methodName.toString(), opts));
+            if (!psychicControllerClass.controllerHooks.find(hook => hook.methodName === methodName)) {
+                psychicControllerClass.controllerHooks.push(new ControllerHook(psychicControllerClass.name, methodName.toString(), opts));
+            }
         });
     };
 }

package/dist/esm/src/generate/helpers/reduxBindings/printFinalStepsMessage.js

@@ -1,7 +1,7 @@
 import { DreamCLI } from '@rvoh/dream';
 import colorize from '../../../cli/helpers/colorize.js';
 export default function printFinalStepsMessage(opts) {
-    const importLine = colorize(`+ import { ${opts.exportName} } from '${opts.apiFile}'`, { color: 'green' });
+    const importLine = colorize(`+ import { ${opts.exportName} } from '${opts.outputFile}'`, { color: 'green' });
     const reducerLine = colorize(`    + [${opts.exportName}.reducerPath]: ${opts.exportName}.reducer,`, {
         color: 'green',
     });
@@ -11,7 +11,11 @@ export default function printFinalStepsMessage(opts) {
     DreamCLI.logger.log(`
 Finished generating redux bindings for your application,
 but to wire them into your app, we're going to need your help.
-Be sure to add the following to your root store to bind your new
+
+First, you will need to be sure to sync, so that the new openapi
+types are sent over to your client application.
+
+Next, be sure to add the following to your root store to bind your new
 api module into your redux app, i.e.
 
 // add this line, fix the import path if necessary

package/dist/esm/src/generate/helpers/reduxBindings/writeInitializer.js

@@ -25,10 +25,10 @@ export default async function writeInitializer({ exportName }) {
     const contents = `\
 import { DreamCLI } from '@rvoh/dream'
 import { PsychicApp } from '@rvoh/psychic'
-import AppEnv from '../AppEnv.js'
+import AppEnv from '../../AppEnv.js'
 
 export default function initialize${pascalized}(psy: PsychicApp) {
-  psy.on('sync', async () => {
+  psy.on('cli:sync', async () => {
     if (AppEnv.isDevelopmentOrTest) {
       DreamCLI.logger.logStartProgress(\`[${camelized}] syncing...\`)
       await DreamCLI.spawn('npx @rtk-query/codegen-openapi ${filePath}', {

package/dist/esm/src/generate/helpers/syncOpenapiTypescript/generateInitializer.js

@@ -21,7 +21,7 @@ import { PsychicApp } from "@rvoh/psychic"
 import AppEnv from '../AppEnv.js'
 
 export default (psy: PsychicApp) => {
-  psy.on('sync', async () => {
+  psy.on('cli:sync', async () => {
     if (AppEnv.isDevelopmentOrTest) {
       DreamCLI.logger.logStartProgress(\`[${hyphenized}] extracting types from ${openapiFilepath} to ${outfile}...\`)
       await DreamCLI.spawn('npx openapi-typescript ${openapiFilepath} -o ${outfile}')

package/dist/esm/src/router/helpers.js

@@ -109,6 +109,15 @@ export function applyResourceAction(path, action, routingMechanism, options) {
             throw new Error(`unsupported resource method type: ${action}`);
     }
 }
+/**
+ * Converts OpenAPI-style route parameters to Express.js-style parameters
+ * Example: users/{userId}/abc/{id} -> users/:userId/abc/:id
+ */
+export function convertRouteParams(path) {
+    // Use a more specific regex to avoid polynomial time complexity
+    // Only match valid parameter names (alphanumeric + underscore, 1-50 chars)
+    return path.replace(/\{([a-zA-Z_][a-zA-Z0-9_]{0,49})\}/g, ':$1');
+}
 function httpMethodFromResourcefulAction(action) {
     switch (action) {
         case 'index':

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

@@ -6,7 +6,7 @@ import ParamValidationErrors from '../error/controller/ParamValidationErrors.js'
 import EnvInternal from '../helpers/EnvInternal.js';
 import errorIsRescuableHttpError from '../helpers/error/errorIsRescuableHttpError.js';
 import PsychicApp from '../psychic-app/index.js';
-import { applyResourceAction, applyResourcesAction, lookupControllerOrFail, routePath, } from '../router/helpers.js';
+import { applyResourceAction, applyResourcesAction, convertRouteParams, lookupControllerOrFail, routePath, } from '../router/helpers.js';
 import RouteManager from './route-manager.js';
 import { ResourceMethods, ResourcesMethods, } from './types.js';
 export default class PsychicRouter {
@@ -68,6 +68,7 @@ export default class PsychicRouter {
         return '/' + this.currentNamespacePaths.join('/') + '/' + str;
     }
     crud(httpMethod, path, controllerOrMiddleware, action) {
+        this.checkPathForInvalidChars(path);
         const isMiddleware = typeof controllerOrMiddleware === 'function' &&
             !controllerOrMiddleware?.isPsychicController;
         // devs can provide custom express middleware which bypasses
@@ -92,6 +93,18 @@ export default class PsychicRouter {
             });
         }
     }
+    checkPathForInvalidChars(path) {
+        if (path.includes('{'))
+            throw new Error(`
+The provided route "${path}" contains characters that are not supported.
+If you are trying to write a uri param, you will need to use expressjs
+param syntax, which is a prefixing colon, rather than using brackets
+to surround the param.
+
+provided route: "${path}"
+suggested fix:  "${convertRouteParams(path)}"
+`);
+    }
     namespace(namespace, cb) {
         const nestedRouter = new PsychicNestedRouter(this.app, this.config, this.routeManager, {
             namespaces: this.currentNamespaces,

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

@@ -23,4 +23,9 @@ export interface NamespaceConfig {
 }
 export declare function applyResourcesAction(path: string, action: ResourcesMethodType, routingMechanism: RoutingMechanism, options?: ResourcesOptions): void;
 export declare function applyResourceAction(path: string, action: ResourcesMethodType, routingMechanism: PsychicRouter | PsychicNestedRouter, options?: ResourcesOptions): void;
+/**
+ * Converts OpenAPI-style route parameters to Express.js-style parameters
+ * Example: users/{userId}/abc/{id} -> users/:userId/abc/:id
+ */
+export declare function convertRouteParams(path: string): string;
 export {};

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

@@ -36,6 +36,7 @@ export default class PsychicRouter {
     crud(httpMethod: HttpMethod, path: string): void;
     crud(httpMethod: HttpMethod, path: string, middleware: RequestHandler): void;
     crud(httpMethod: HttpMethod, path: string, controller: typeof PsychicController, action: string): void;
+    private checkPathForInvalidChars;
     namespace(namespace: string, cb: (router: PsychicNestedRouter) => void): void;
     scope(scope: string, cb: (router: PsychicNestedRouter) => void): void;
     resources(path: string, optionsOrCb?: ResourcesOptions | ((router: PsychicNestedRouter) => void), cb?: (router: PsychicNestedRouter) => void): void;

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "author": "RVOHealth",
   "repository": {
     "type": "git",