@rvoh/psychic 1.1.3 → 1.1.5

package/CHANGELOG.md

@@ -48,3 +48,13 @@ Fix route printing regression causing route printouts to show the path instead o
 ## 1.1.3
 
 - fix more minor issues with redux openapi bindings
+
+## 1.1.4
+
+- fix regressions to redux bindings caused by default openapi path location changes
+- resource generator can handle prefixing slashes
+
+## 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.

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

@@ -99,7 +99,7 @@ class PsychicCLI {
         program
             .command('setup:sync:openapi-redux')
             .description('generates openapi redux bindings to connect one of your openapi files to one of your clients')
-            .option('--schema-file', 'the path from your api root to the openapi file you wish to use to generate your schema, i.e. ./openapi/openapi.json')
+            .option('--schema-file', 'the path from your api root to the openapi file you wish to use to generate your schema, i.e. ./src/openapi/openapi.json')
             .option('--api-file', 'the path to the boilerplate api file that will be used to scaffold your backend endpoints together with, i.e. ../client/app/api.ts')
             .option('--api-import', 'the camelCased name of the export from your api module, i.e. emptyBackendApi')
             .option('--output-file', 'the path to the file that will contain your typescript openapi redux bindings, i.e. ../client/app/myBackendApi.ts')
@@ -118,7 +118,7 @@ class PsychicCLI {
         program
             .command('setup:sync:openapi-typescript')
             .description('generates an initializer in your app for converting one of your openapi files to typescript')
-            .argument('<openapiFilepath>', 'the path from your backend directory to the openapi file you wish to scan, i.e. "./openapi/openapi.json"')
+            .argument('<openapiFilepath>', 'the path from your backend directory to the openapi file you wish to scan, i.e. "./src/openapi/openapi.json"')
             .argument('<outfile>', 'the path from your backend directory to the location which you want the openapi types written to. Must end with .d.ts, i.e. "./src/conf/openapi/openapi.types.d.ts"')
             .option('--initializer-filename', 'the name you want the file to be in your initializers folder. defaults to `sync-openapi-typescript.ts`')
             .action(async (openapiFilepath, outfile, { initializerName, }) => {

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

@@ -9,7 +9,7 @@ const cli_prompt_js_1 = __importDefault(require("../../../cli/helpers/cli-prompt
 const index_js_1 = __importDefault(require("../../../psychic-app/index.js"));
 async function promptForOptions(options) {
     if (!options.schemaFile) {
-        const defaultVal = './openapi/openapi.json';
+        const defaultVal = './src/openapi/openapi.json';
         const answer = await (0, cli_prompt_js_1.default)(`\
 What would you like the schemaFile to be?
 

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

@@ -36,9 +36,9 @@ async function writeOpenapiJsonFile({ exportName, schemaFile, apiFile, apiImport
     const destDir = path.join((0, psychicPath_js_1.default)('conf'), 'openapi');
     const destPath = path.join(destDir, destFilename);
     const jsonData = {
-        schemaFile: `../../../${schemaFile.replace(/^\.\//, '')}`,
-        apiFile: `../../../${apiFile.replace(/^\.\//, '')}`,
-        outputFile: `../../../${outputFile.replace(/^\.\//, '')}`,
+        schemaFile: path.join('..', '..', '..', replacePrefixingPathSegment(schemaFile)),
+        apiFile: path.join('..', '..', '..', replacePrefixingPathSegment(apiFile)),
+        outputFile: path.join('..', '..', '..', replacePrefixingPathSegment(outputFile)),
         apiImport,
         exportName,
         hooks: true,
@@ -51,3 +51,6 @@ async function writeOpenapiJsonFile({ exportName, schemaFile, apiFile, apiImport
     }
     await fs.writeFile(destPath, JSON.stringify(jsonData, null, 2));
 }
+function replacePrefixingPathSegment(path) {
+    return path.replace(/^\.[/\\]/, '');
+}

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

@@ -12,6 +12,11 @@ const addResourceToRoutes_js_1 = __importDefault(require("./helpers/addResourceT
 exports.RESOURCE_ACTIONS = ['index', 'show', 'create', 'update', 'destroy'];
 exports.SINGULAR_RESOURCE_ACTIONS = ['show', 'create', 'update', 'destroy'];
 async function generateResource({ route, fullyQualifiedModelName, options, columnsWithTypes, }) {
+    // sanitize route here, making sure that the leading
+    // slash is not passed through to subsequent helpers,
+    // which will exhibit bad behavior when provided with
+    // a prefixing slash.
+    route = route.replace(/^\/+/, '');
     const fullyQualifiedControllerName = (0, dream_1.standardizeFullyQualifiedModelName)(route);
     const resourcefulActions = options.singular ? [...exports.SINGULAR_RESOURCE_ACTIONS] : [...exports.RESOURCE_ACTIONS];
     const onlyActions = options.only?.split(',');

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

@@ -26,7 +26,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PsychicAppAllowedPackageManagersEnumValues = 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"));
@@ -53,13 +52,11 @@ class PsychicApp {
                 throw new init_missing_api_root_js_1.default();
             if (!psychicApp.routesCb)
                 throw new init_missing_routes_callback_js_1.default();
-            if (!exports.PsychicAppAllowedPackageManagersEnumValues.includes(psychicApp.packageManager))
+            if (!dream_1.DreamAppAllowedPackageManagersEnumValues.includes(psychicApp.packageManager))
                 throw new init_missing_package_manager_js_1.default();
             if (psychicApp.encryption?.cookies?.current)
                 this.checkKey('cookies', psychicApp.encryption.cookies.current.key, psychicApp.encryption.cookies.current.algorithm);
             await psychicApp.inflections?.();
-            dreamApp.set('projectRoot', psychicApp.apiRoot);
-            dreamApp.set('logger', psychicApp.logger);
             dreamApp.on('repl:start', context => {
                 const psychicApp = PsychicApp.getOrFail();
                 for (const globalName of Object.keys(psychicApp.services)) {
@@ -77,6 +74,9 @@ class PsychicApp {
             for (const plugin of psychicApp.plugins) {
                 await plugin(psychicApp);
             }
+            dreamApp.set('projectRoot', psychicApp.apiRoot);
+            dreamApp.set('logger', psychicApp.logger);
+            dreamApp.set('packageManager', psychicApp.packageManager);
             (0, cache_js_1.cachePsychicApp)(psychicApp);
         });
         return psychicApp;
@@ -439,4 +439,3 @@ Try setting it to something valid, like:
     }
 }
 exports.default = PsychicApp;
-exports.PsychicAppAllowedPackageManagersEnumValues = ['yarn', 'npm', 'pnpm'];

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

@@ -94,7 +94,7 @@ export default class PsychicCLI {
         program
             .command('setup:sync:openapi-redux')
             .description('generates openapi redux bindings to connect one of your openapi files to one of your clients')
-            .option('--schema-file', 'the path from your api root to the openapi file you wish to use to generate your schema, i.e. ./openapi/openapi.json')
+            .option('--schema-file', 'the path from your api root to the openapi file you wish to use to generate your schema, i.e. ./src/openapi/openapi.json')
             .option('--api-file', 'the path to the boilerplate api file that will be used to scaffold your backend endpoints together with, i.e. ../client/app/api.ts')
             .option('--api-import', 'the camelCased name of the export from your api module, i.e. emptyBackendApi')
             .option('--output-file', 'the path to the file that will contain your typescript openapi redux bindings, i.e. ../client/app/myBackendApi.ts')
@@ -113,7 +113,7 @@ export default class PsychicCLI {
         program
             .command('setup:sync:openapi-typescript')
             .description('generates an initializer in your app for converting one of your openapi files to typescript')
-            .argument('<openapiFilepath>', 'the path from your backend directory to the openapi file you wish to scan, i.e. "./openapi/openapi.json"')
+            .argument('<openapiFilepath>', 'the path from your backend directory to the openapi file you wish to scan, i.e. "./src/openapi/openapi.json"')
             .argument('<outfile>', 'the path from your backend directory to the location which you want the openapi types written to. Must end with .d.ts, i.e. "./src/conf/openapi/openapi.types.d.ts"')
             .option('--initializer-filename', 'the name you want the file to be in your initializers folder. defaults to `sync-openapi-typescript.ts`')
             .action(async (openapiFilepath, outfile, { initializerName, }) => {

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

@@ -3,7 +3,7 @@ import cliPrompt from '../../../cli/helpers/cli-prompt.js';
 import PsychicApp from '../../../psychic-app/index.js';
 export default async function promptForOptions(options) {
     if (!options.schemaFile) {
-        const defaultVal = './openapi/openapi.json';
+        const defaultVal = './src/openapi/openapi.json';
         const answer = await cliPrompt(`\
 What would you like the schemaFile to be?
 

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

@@ -7,9 +7,9 @@ export default async function writeOpenapiJsonFile({ exportName, schemaFile, api
     const destDir = path.join(psychicPath('conf'), 'openapi');
     const destPath = path.join(destDir, destFilename);
     const jsonData = {
-        schemaFile: `../../../${schemaFile.replace(/^\.\//, '')}`,
-        apiFile: `../../../${apiFile.replace(/^\.\//, '')}`,
-        outputFile: `../../../${outputFile.replace(/^\.\//, '')}`,
+        schemaFile: path.join('..', '..', '..', replacePrefixingPathSegment(schemaFile)),
+        apiFile: path.join('..', '..', '..', replacePrefixingPathSegment(apiFile)),
+        outputFile: path.join('..', '..', '..', replacePrefixingPathSegment(outputFile)),
         apiImport,
         exportName,
         hooks: true,
@@ -22,3 +22,6 @@ export default async function writeOpenapiJsonFile({ exportName, schemaFile, api
     }
     await fs.writeFile(destPath, JSON.stringify(jsonData, null, 2));
 }
+function replacePrefixingPathSegment(path) {
+    return path.replace(/^\.[/\\]/, '');
+}

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

@@ -5,6 +5,11 @@ import addResourceToRoutes from './helpers/addResourceToRoutes.js';
 export const RESOURCE_ACTIONS = ['index', 'show', 'create', 'update', 'destroy'];
 export const SINGULAR_RESOURCE_ACTIONS = ['show', 'create', 'update', 'destroy'];
 export default async function generateResource({ route, fullyQualifiedModelName, options, columnsWithTypes, }) {
+    // sanitize route here, making sure that the leading
+    // slash is not passed through to subsequent helpers,
+    // which will exhibit bad behavior when provided with
+    // a prefixing slash.
+    route = route.replace(/^\/+/, '');
     const fullyQualifiedControllerName = standardizeFullyQualifiedModelName(route);
     const resourcefulActions = options.singular ? [...SINGULAR_RESOURCE_ACTIONS] : [...RESOURCE_ACTIONS];
     const onlyActions = options.only?.split(',');

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

@@ -1,4 +1,4 @@
-import { DreamApp, Encrypt, } from '@rvoh/dream';
+import { DreamApp, DreamAppAllowedPackageManagersEnumValues, Encrypt, } from '@rvoh/dream';
 import PackageManager from '../cli/helpers/PackageManager.js';
 import PsychicAppInitMissingApiRoot from '../error/psychic-app/init-missing-api-root.js';
 import PsychicAppInitMissingCallToLoadControllers from '../error/psychic-app/init-missing-call-to-load-controllers.js';
@@ -24,13 +24,11 @@ export default class PsychicApp {
                 throw new PsychicAppInitMissingApiRoot();
             if (!psychicApp.routesCb)
                 throw new PsychicAppInitMissingRoutesCallback();
-            if (!PsychicAppAllowedPackageManagersEnumValues.includes(psychicApp.packageManager))
+            if (!DreamAppAllowedPackageManagersEnumValues.includes(psychicApp.packageManager))
                 throw new PsychicAppInitMissingPackageManager();
             if (psychicApp.encryption?.cookies?.current)
                 this.checkKey('cookies', psychicApp.encryption.cookies.current.key, psychicApp.encryption.cookies.current.algorithm);
             await psychicApp.inflections?.();
-            dreamApp.set('projectRoot', psychicApp.apiRoot);
-            dreamApp.set('logger', psychicApp.logger);
             dreamApp.on('repl:start', context => {
                 const psychicApp = PsychicApp.getOrFail();
                 for (const globalName of Object.keys(psychicApp.services)) {
@@ -48,6 +46,9 @@ export default class PsychicApp {
             for (const plugin of psychicApp.plugins) {
                 await plugin(psychicApp);
             }
+            dreamApp.set('projectRoot', psychicApp.apiRoot);
+            dreamApp.set('logger', psychicApp.logger);
+            dreamApp.set('packageManager', psychicApp.packageManager);
             cachePsychicApp(psychicApp);
         });
         return psychicApp;
@@ -409,4 +410,3 @@ Try setting it to something valid, like:
         }
     }
 }
-export const PsychicAppAllowedPackageManagersEnumValues = ['yarn', 'npm', 'pnpm'];

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

@@ -1,4 +1,4 @@
-import { DreamApp, DreamAppInitOptions, DreamLogLevel, DreamLogger, EncryptOptions, OpenapiSchemaBody } from '@rvoh/dream';
+import { DreamApp, DreamAppAllowedPackageManagersEnum, DreamAppInitOptions, DreamLogLevel, DreamLogger, EncryptOptions, OpenapiSchemaBody } from '@rvoh/dream';
 import * as bodyParser from 'body-parser';
 import { Command } from 'commander';
 import { CorsOptions } from 'cors';
@@ -95,12 +95,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' ? PsychicAppAllowedPackageManagersEnum : 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 '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 declare const PsychicAppAllowedPackageManagersEnumValues: readonly ["yarn", "npm", "pnpm"];
-export type PsychicAppAllowedPackageManagersEnum = (typeof PsychicAppAllowedPackageManagersEnumValues)[number];
 export interface PsychicAppSpecialHooks {
     cliSync: (() => any)[];
     serverInitBeforeMiddleware: ((server: PsychicServer) => void | Promise<void>)[];

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "author": "RVOHealth",
   "repository": {
     "type": "git",
@@ -59,7 +59,7 @@
   "devDependencies": {
     "@eslint/js": "^9.19.0",
     "@jest-mock/express": "^3.0.0",
-    "@rvoh/dream": "^1.0.0",
+    "@rvoh/dream": "^1.0.2",
     "@rvoh/dream-spec-helpers": "^1.0.0",
     "@rvoh/psychic-spec-helpers": "^1.0.0",
     "@types/express": "^5.0.1",