@rvoh/psychic 1.2.0 → 1.2.1

package/CHANGELOG.md

@@ -0,0 +1,96 @@
+## 1.2.1
+
+- add ability to set custom import extension, which will be used when generating new files for your application
+
+## 1.2.0
+
+- update for Dream 1.4.0
+
+## 1.1.11
+
+- 400 is more appropriate than 422 for `DataTypeColumnTypeMismatch`
+
+## 1.1.10
+
+- Don't include deletedAt in generated create/update actions in resource specs since deletedAt is for deleting
+
+- return 422 if Dream throws `NotNullViolation` or `CheckConstraintViolation`
+
+## 1.1.9
+
+- return 422 if dream throws `DataTypeColumnTypeMismatch`, which happens when a dream is saved to the database with data that cannot be inserted into the respective columns, usually because of a type mismatch.
+
+- castParam will now encase params in an array when being explicitly casted as an array type, bypassing a known bug in express from causing arrays with single items in them to be treated as non-arrays.
+
+## 1.1.8
+
+- Tap into CliFileWriter provided by dream to tap into file reversion for sync files, since the auto-sync function in psychic can fail and leave your file tree in a bad state.
+
+## 1.1.7
+
+- Add support for middleware arrays, enabling express plugins like passport
+
+## 1.1.6
+
+- fix regression caused by missing --schema-only option in psychic cli
+
+## 1.1.5
+
+- pass packageManager through to dream, now that it accepts a packageManager setting.
+- update dream shadowing within psychic application initialization to take place after initializers and plugins are processed, so that those initializers and plugins have an opportunity to adjust the settings.
+
+## 1.1.4
+
+- fix regressions to redux bindings caused by default openapi path location changes
+- resource generator can handle prefixing slashes
+
+## 1.1.3
+
+- fix more minor issues with redux openapi bindings
+
+## 1.1.2
+
+- Fix various issues with openapi redux bindings
+- raise hard exception if accidentally using openapi route params in an expressjs route path
+
+## 1.1.1
+
+Fix route printing regression causing route printouts to show the path instead of the action
+
+## v1.1.0
+
+Provides easier access to express middleware by exposing `PsychicApp#use`, which enables a developer to provide express middleware directly through the psychcic application, without tapping into any hooks.
+
+```ts
+psy.use((_, res) => {
+  res.send(
+    'this will be run after psychic middleware (i.e. cors and bodyParser) are processed, but before routes are processed',
+  )
+})
+```
+
+Some middleware needs to be run before other middleware, so we expose an optional first argument which can be provided so explicitly send your middleware into express at various stages of the psychic configuration process. For example, to inject your middleware before cors and bodyParser are configured, provide `before-middleware` as the first argument. To initialize your middleware after the psychic default middleware, but before your routes have been processed, provide `after-middleware` as the first argument (or simply provide a callback function directly, since this is the default). To run after routes have been processed, provide `after-routes` as the first argument.
+
+```ts
+psy.use('before-middleware', (_, res) => {
+  res.send('this will be run before psychic has configured any default middleware')
+})
+
+psy.use('after-middleware', (_, res) => {
+  res.send('this will be run after psychic has configured default middleware')
+})
+
+psy.use('after-routes', (_, res) => {
+  res.send('this will be run after psychic has processed all the routes in your conf/routes.ts file')
+})
+```
+
+Additionally, a new overload has been added to all CRUD methods on the PsychicRouter class, enabling you to provide RequestHandler middleware directly to psychic, like so:
+
+```ts
+// conf/routes.ts
+
+r.get('helloworld', (req, res, next) => {
+  res.json({ hello: 'world' })
+})
+```

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

@@ -31,6 +31,7 @@ const dream_1 = require("@rvoh/dream");
 const node_fs_1 = require("node:fs");
 const fs = __importStar(require("node:fs/promises"));
 const UnexpectedUndefined_js_1 = __importDefault(require("../error/UnexpectedUndefined.js"));
+const addImportSuffix_js_1 = __importDefault(require("../helpers/path/addImportSuffix.js"));
 const psychicFileAndDirPaths_js_1 = __importDefault(require("../helpers/path/psychicFileAndDirPaths.js"));
 const psychicPath_js_1 = __importDefault(require("../helpers/path/psychicPath.js"));
 const generateControllerContent_js_1 = __importDefault(require("./helpers/generateControllerContent.js"));
@@ -120,9 +121,18 @@ function baseAncestorNameAndImport(controllerNameParts, forAdmin, { forBaseContr
     const dotFiles = forBaseController ? '..' : '.';
     return controllerNameParts.length === (forAdmin ? 2 : 1)
         ? forAdmin
-            ? [`AdminAuthedController`, `import AdminAuthedController from '${dotFiles}/AuthedController.js'`]
-            : [`AuthedController`, `import AuthedController from '${dotFiles}/AuthedController.js'`]
-        : [maybeAncestorNameForBase, `import ${maybeAncestorNameForBase} from '${dotFiles}/BaseController.js'`];
+            ? [
+                `AdminAuthedController`,
+                `import AdminAuthedController from '${dotFiles}/${(0, addImportSuffix_js_1.default)('AuthedController.js')}'`,
+            ]
+            : [
+                `AuthedController`,
+                `import AuthedController from '${dotFiles}/${(0, addImportSuffix_js_1.default)('AuthedController.js')}'`,
+            ]
+        : [
+            maybeAncestorNameForBase,
+            `import ${maybeAncestorNameForBase} from '${dotFiles}/${(0, addImportSuffix_js_1.default)('BaseController.js')}'`,
+        ];
 }
 async function generateControllerSpec({ fullyQualifiedControllerName, route, fullyQualifiedModelName, columnsWithTypes, resourceSpecs, owningModel, forAdmin, singular, actions, }) {
     const { relFilePath, absDirPath, absFilePath } = (0, psychicFileAndDirPaths_js_1.default)((0, psychicPath_js_1.default)('controllerSpecs'), fullyQualifiedControllerName + `.spec.ts`);

package/dist/cjs/src/generate/helpers/generateResourceControllerSpecContent.js

@@ -8,6 +8,7 @@ const dream_1 = require("@rvoh/dream");
 const relativePsychicPath_js_1 = __importDefault(require("../../helpers/path/relativePsychicPath.js"));
 const updirsFromPath_js_1 = __importDefault(require("../../helpers/path/updirsFromPath.js"));
 const index_js_1 = require("../../index.js");
+const addImportSuffix_js_1 = __importDefault(require("../../helpers/path/addImportSuffix.js"));
 function generateResourceControllerSpecContent({ fullyQualifiedControllerName, route, fullyQualifiedModelName, columnsWithTypes, owningModel, forAdmin, singular, actions, }) {
     fullyQualifiedModelName = (0, dream_1.standardizeFullyQualifiedModelName)(fullyQualifiedModelName);
     const modelClassName = (0, dream_1.globalClassNameFromFullyQualifiedModelName)(fullyQualifiedModelName);
@@ -134,7 +135,7 @@ function generateResourceControllerSpecContent({ fullyQualifiedControllerName, r
     const omitDestroy = !actions.includes('destroy');
     return `\
 import { ${(0, dream_1.uniq)(dreamImports).join(', ')} } from '@rvoh/dream'${(0, dream_1.uniq)(importStatements).join('')}
-import { session, SpecRequestType } from '${specUnitUpdirs}helpers/authentication.js'
+import { session, SpecRequestType } from '${specUnitUpdirs}helpers/${(0, addImportSuffix_js_1.default)('authentication.js')}'
 
 describe('${fullyQualifiedControllerName}', () => {
   let request: SpecRequestType

package/dist/cjs/src/helpers/path/addImportSuffix.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = addImportSuffix;
+const index_js_1 = __importDefault(require("../../psychic-app/index.js"));
+function addImportSuffix(filepath) {
+    return `${filepath.replace(/(\.ts|\.js)$/, '')}${suffix()}`;
+}
+function suffix() {
+    switch (index_js_1.default.getOrFail().importExtension) {
+        case '.js':
+            return '.js';
+        case '.ts':
+            return '.ts';
+        case 'none':
+            return '';
+    }
+}

package/dist/cjs/src/helpers/path/relativePsychicPath.js

@@ -8,6 +8,7 @@ exports.psychicPathTypeRelativePath = psychicPathTypeRelativePath;
 const dream_1 = require("@rvoh/dream");
 const psychicPath_js_1 = __importDefault(require("./psychicPath.js"));
 const updirsFromPath_js_1 = __importDefault(require("./updirsFromPath.js"));
+const addImportSuffix_js_1 = __importDefault(require("./addImportSuffix.js"));
 function default_1(originDreamPathType, destinationDreamPathType, fullyQualifiedOriginModelName, fullyQualifiedDestinationModelName = fullyQualifiedOriginModelName) {
     fullyQualifiedOriginModelName = (0, dream_1.standardizeFullyQualifiedModelName)(fullyQualifiedOriginModelName);
     fullyQualifiedDestinationModelName = (0, dream_1.pascalize)(fullyQualifiedDestinationModelName);
@@ -30,11 +31,11 @@ function default_1(originDreamPathType, destinationDreamPathType, fullyQualified
         case 'db':
             return destinationPath;
         case 'factories':
-            return `${destinationPath}${fullyQualifiedDestinationModelName}Factory.js`;
+            return (0, addImportSuffix_js_1.default)(`${destinationPath}${fullyQualifiedDestinationModelName}Factory.js`);
         case 'serializers':
-            return `${destinationPath}${fullyQualifiedDestinationModelName}Serializer.js`;
+            return (0, addImportSuffix_js_1.default)(`${destinationPath}${fullyQualifiedDestinationModelName}Serializer.js`);
         default:
-            return `${destinationPath}${fullyQualifiedDestinationModelName}.js`;
+            return (0, addImportSuffix_js_1.default)(`${destinationPath}${fullyQualifiedDestinationModelName}.js`);
     }
 }
 function psychicPathTypeRelativePath(originDreamPathType, destinationDreamPathType) {

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

@@ -26,6 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeneratorImportStyles = void 0;
 const dream_1 = require("@rvoh/dream");
 const PackageManager_js_1 = __importDefault(require("../cli/helpers/PackageManager.js"));
 const init_missing_api_root_js_1 = __importDefault(require("../error/psychic-app/init-missing-api-root.js"));
@@ -183,6 +184,10 @@ Try setting it to something valid, like:
     get packageManager() {
         return this._packageManager;
     }
+    _importExtension = '.js';
+    get importExtension() {
+        return this._importExtension;
+    }
     _routesCb;
     get routesCb() {
         return this._routesCb;
@@ -360,6 +365,9 @@ Try setting it to something valid, like:
             case 'apiRoot':
                 this._apiRoot = value;
                 break;
+            case 'importExtension':
+                this._importExtension = value;
+                break;
             case 'clientRoot':
                 this._clientRoot = value;
                 break;
@@ -439,3 +447,7 @@ Try setting it to something valid, like:
     }
 }
 exports.default = PsychicApp;
+// GeneratorImportStyles are used by CLI generators to determine how
+// to style import suffixes. When integrating with other apps, this
+// suffix style can change, and may need to be configured.
+exports.GeneratorImportStyles = ['.js', '.ts', 'none'];

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

@@ -2,6 +2,7 @@ import { hyphenize, standardizeFullyQualifiedModelName } from '@rvoh/dream';
 import { existsSync } from 'node:fs';
 import * as fs from 'node:fs/promises';
 import UnexpectedUndefined from '../error/UnexpectedUndefined.js';
+import addImportSuffix from '../helpers/path/addImportSuffix.js';
 import psychicFileAndDirPaths from '../helpers/path/psychicFileAndDirPaths.js';
 import psychicPath from '../helpers/path/psychicPath.js';
 import generateControllerContent from './helpers/generateControllerContent.js';
@@ -91,9 +92,18 @@ function baseAncestorNameAndImport(controllerNameParts, forAdmin, { forBaseContr
     const dotFiles = forBaseController ? '..' : '.';
     return controllerNameParts.length === (forAdmin ? 2 : 1)
         ? forAdmin
-            ? [`AdminAuthedController`, `import AdminAuthedController from '${dotFiles}/AuthedController.js'`]
-            : [`AuthedController`, `import AuthedController from '${dotFiles}/AuthedController.js'`]
-        : [maybeAncestorNameForBase, `import ${maybeAncestorNameForBase} from '${dotFiles}/BaseController.js'`];
+            ? [
+                `AdminAuthedController`,
+                `import AdminAuthedController from '${dotFiles}/${addImportSuffix('AuthedController.js')}'`,
+            ]
+            : [
+                `AuthedController`,
+                `import AuthedController from '${dotFiles}/${addImportSuffix('AuthedController.js')}'`,
+            ]
+        : [
+            maybeAncestorNameForBase,
+            `import ${maybeAncestorNameForBase} from '${dotFiles}/${addImportSuffix('BaseController.js')}'`,
+        ];
 }
 async function generateControllerSpec({ fullyQualifiedControllerName, route, fullyQualifiedModelName, columnsWithTypes, resourceSpecs, owningModel, forAdmin, singular, actions, }) {
     const { relFilePath, absDirPath, absFilePath } = psychicFileAndDirPaths(psychicPath('controllerSpecs'), fullyQualifiedControllerName + `.spec.ts`);

package/dist/esm/src/generate/helpers/generateResourceControllerSpecContent.js

@@ -2,6 +2,7 @@ import { camelize, capitalize, compact, globalClassNameFromFullyQualifiedModelNa
 import relativePsychicPath from '../../helpers/path/relativePsychicPath.js';
 import updirsFromPath from '../../helpers/path/updirsFromPath.js';
 import { pluralize } from '../../index.js';
+import addImportSuffix from '../../helpers/path/addImportSuffix.js';
 export default function generateResourceControllerSpecContent({ fullyQualifiedControllerName, route, fullyQualifiedModelName, columnsWithTypes, owningModel, forAdmin, singular, actions, }) {
     fullyQualifiedModelName = standardizeFullyQualifiedModelName(fullyQualifiedModelName);
     const modelClassName = globalClassNameFromFullyQualifiedModelName(fullyQualifiedModelName);
@@ -128,7 +129,7 @@ export default function generateResourceControllerSpecContent({ fullyQualifiedCo
     const omitDestroy = !actions.includes('destroy');
     return `\
 import { ${uniq(dreamImports).join(', ')} } from '@rvoh/dream'${uniq(importStatements).join('')}
-import { session, SpecRequestType } from '${specUnitUpdirs}helpers/authentication.js'
+import { session, SpecRequestType } from '${specUnitUpdirs}helpers/${addImportSuffix('authentication.js')}'
 
 describe('${fullyQualifiedControllerName}', () => {
   let request: SpecRequestType

package/dist/esm/src/helpers/path/addImportSuffix.js

@@ -0,0 +1,14 @@
+import PsychicApp from '../../psychic-app/index.js';
+export default function addImportSuffix(filepath) {
+    return `${filepath.replace(/(\.ts|\.js)$/, '')}${suffix()}`;
+}
+function suffix() {
+    switch (PsychicApp.getOrFail().importExtension) {
+        case '.js':
+            return '.js';
+        case '.ts':
+            return '.ts';
+        case 'none':
+            return '';
+    }
+}

package/dist/esm/src/helpers/path/relativePsychicPath.js

@@ -1,6 +1,7 @@
 import { pascalize, sharedPathPrefix, standardizeFullyQualifiedModelName } from '@rvoh/dream';
 import psychicPath from './psychicPath.js';
 import updirsFromPath from './updirsFromPath.js';
+import addImportSuffix from './addImportSuffix.js';
 export default function (originDreamPathType, destinationDreamPathType, fullyQualifiedOriginModelName, fullyQualifiedDestinationModelName = fullyQualifiedOriginModelName) {
     fullyQualifiedOriginModelName = standardizeFullyQualifiedModelName(fullyQualifiedOriginModelName);
     fullyQualifiedDestinationModelName = pascalize(fullyQualifiedDestinationModelName);
@@ -23,11 +24,11 @@ export default function (originDreamPathType, destinationDreamPathType, fullyQua
         case 'db':
             return destinationPath;
         case 'factories':
-            return `${destinationPath}${fullyQualifiedDestinationModelName}Factory.js`;
+            return addImportSuffix(`${destinationPath}${fullyQualifiedDestinationModelName}Factory.js`);
         case 'serializers':
-            return `${destinationPath}${fullyQualifiedDestinationModelName}Serializer.js`;
+            return addImportSuffix(`${destinationPath}${fullyQualifiedDestinationModelName}Serializer.js`);
         default:
-            return `${destinationPath}${fullyQualifiedDestinationModelName}.js`;
+            return addImportSuffix(`${destinationPath}${fullyQualifiedDestinationModelName}.js`);
     }
 }
 export function psychicPathTypeRelativePath(originDreamPathType, destinationDreamPathType) {

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

@@ -155,6 +155,10 @@ Try setting it to something valid, like:
     get packageManager() {
         return this._packageManager;
     }
+    _importExtension = '.js';
+    get importExtension() {
+        return this._importExtension;
+    }
     _routesCb;
     get routesCb() {
         return this._routesCb;
@@ -332,6 +336,9 @@ Try setting it to something valid, like:
             case 'apiRoot':
                 this._apiRoot = value;
                 break;
+            case 'importExtension':
+                this._importExtension = value;
+                break;
             case 'clientRoot':
                 this._clientRoot = value;
                 break;
@@ -410,3 +417,7 @@ Try setting it to something valid, like:
         }
     }
 }
+// GeneratorImportStyles are used by CLI generators to determine how
+// to style import suffixes. When integrating with other apps, this
+// suffix style can change, and may need to be configured.
+export const GeneratorImportStyles = ['.js', '.ts', 'none'];

package/dist/types/src/helpers/path/addImportSuffix.d.ts

@@ -0,0 +1 @@
+export default function addImportSuffix(filepath: string): string;

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

@@ -59,6 +59,8 @@ export default class PsychicApp {
     get saltRounds(): number | undefined;
     private _packageManager;
     get packageManager(): "yarn" | "npm" | "pnpm";
+    private _importExtension;
+    get importExtension(): "none" | ".js" | ".ts";
     private _routesCb;
     get routesCb(): (r: PsychicRouter) => void | Promise<void>;
     private _openapi;
@@ -95,10 +97,10 @@ export default class PsychicApp {
     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;
     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 'encryption' ? PsychicAppEncryptionOptions : Opt extends 'cors' ? CorsOptions : Opt extends 'cookie' ? CustomCookieOptions : Opt extends 'apiRoot' ? string : Opt extends 'sessionCookieName' ? string : Opt extends 'clientRoot' ? string : Opt extends 'json' ? bodyParser.Options : Opt extends 'logger' ? PsychicLogger : Opt extends 'client' ? PsychicClientOptions : 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;
+    set<Opt extends PsychicAppOption>(option: Opt, value: Opt extends 'appName' ? string : Opt extends 'apiOnly' ? boolean : Opt extends 'defaultResponseHeaders' ? Record<string, string | null> : 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 'clientRoot' ? string : Opt extends 'json' ? bodyParser.Options : Opt extends 'logger' ? PsychicLogger : Opt extends 'client' ? PsychicClientOptions : 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' | 'encryption' | 'sessionCookieName' | 'client' | 'clientRoot' | 'cookie' | 'cors' | 'defaultResponseHeaders' | 'inflections' | 'json' | 'logger' | 'openapi' | 'packageManager' | 'paths' | 'port' | 'routes' | 'saltRounds' | 'ssl';
+export type PsychicAppOption = 'appName' | 'apiOnly' | 'apiRoot' | 'importExtension' | 'encryption' | 'sessionCookieName' | 'client' | 'clientRoot' | 'cookie' | 'cors' | 'defaultResponseHeaders' | 'inflections' | 'json' | 'logger' | 'openapi' | 'packageManager' | 'paths' | 'port' | 'routes' | 'saltRounds' | 'ssl';
 export interface PsychicAppSpecialHooks {
     cliSync: (() => any)[];
     serverInitBeforeMiddleware: ((server: PsychicServer) => void | Promise<void>)[];
@@ -359,4 +361,6 @@ interface SegmentedEncryptionOptions {
     current: EncryptOptions;
     legacy?: EncryptOptions;
 }
+export declare const GeneratorImportStyles: readonly [".js", ".ts", "none"];
+export type GeneratorImportStyle = (typeof GeneratorImportStyles)[number];
 export {};

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "author": "RVOHealth",
   "repository": {
     "type": "git",
@@ -93,4 +93,4 @@
     "winston": "^3.14.2"
   },
   "packageManager": "yarn@4.7.0"
-}
+}