@rvoh/psychic 0.26.3 → 0.27.2

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

@@ -7,6 +7,7 @@ import EnvInternal from '../helpers/EnvInternal.js';
 import { cachePsychicApplication, getCachedPsychicApplicationOrFail } from './cache.js';
 import importControllers, { getControllersOrFail } from './helpers/import/importControllers.js';
 import lookupClassByGlobalName from './helpers/lookupClassByGlobalName.js';
+import PsychicApplicationInitMissingPackageManager from '../error/psychic-application/init-missing-package-manager.js';
 export default class PsychicApplication {
     static async init(cb, dreamCb, opts = {}) {
         let psychicApp;
@@ -19,11 +20,16 @@ export default class PsychicApplication {
                 throw new PsychicApplicationInitMissingApiRoot();
             if (!psychicApp.routesCb)
                 throw new PsychicApplicationInitMissingRoutesCallback();
+            if (!PsychicApplicationAllowedPackageManagersEnumValues.includes(psychicApp.packageManager))
+                throw new PsychicApplicationInitMissingPackageManager();
             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);
+            for (const plugin of psychicApp.plugins) {
+                await plugin(psychicApp);
+            }
             cachePsychicApplication(psychicApp);
         });
         return psychicApp;
@@ -32,6 +38,29 @@ export default class PsychicApplication {
         // eslint-disable-next-line @typescript-eslint/no-unsafe-return
         return lookupClassByGlobalName(name);
     }
+    /**
+     * @internal
+     *
+     * used to provide the correct package manager syntax for running a script
+     * inside of the package.json "scripts" section.
+     */
+    packageManagerRunCmd(cmd) {
+        switch (this.packageManager) {
+            case 'npm':
+                return `npm run ${cmd}`;
+            default:
+                return `${this.packageManager} ${cmd}`;
+        }
+    }
+    /**
+     * @internal
+     *
+     * adds the necessary package manager prefix to the psy command provided
+     * i.e. `psyCmd('sync')`
+     */
+    psyCmd(cmd) {
+        return this.packageManagerRunCmd(`psy ${cmd}`);
+    }
     static checkKey(encryptionIdentifier, key, algorithm) {
         if (!Encrypt.validateKey(key, algorithm))
             console.warn(`
@@ -106,14 +135,18 @@ Try setting it to something valid, like:
     get logger() {
         return this._logger;
     }
-    _sslCredentials;
+    _sslCredentials = undefined;
     get sslCredentials() {
         return this._sslCredentials;
     }
-    _saltRounds;
+    _saltRounds = undefined;
     get saltRounds() {
         return this._saltRounds;
     }
+    _packageManager;
+    get packageManager() {
+        return this._packageManager;
+    }
     _routesCb;
     get routesCb() {
         return this._routesCb;
@@ -194,6 +227,10 @@ Try setting it to something valid, like:
     get controllers() {
         return getControllersOrFail();
     }
+    _plugins = [];
+    get plugins() {
+        return this._plugins;
+    }
     async load(resourceType, resourcePath, 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     importCb) {
@@ -224,6 +261,9 @@ Try setting it to something valid, like:
         await this.inflections?.();
         this.booted = true;
     }
+    plugin(cb) {
+        this._plugins.push(cb);
+    }
     on(hookEventType, cb) {
         switch (hookEventType) {
             case 'server:error':
@@ -304,6 +344,9 @@ Try setting it to something valid, like:
             case 'port':
                 this._port = value;
                 break;
+            case 'packageManager':
+                this._packageManager = value;
+                break;
             case 'saltRounds':
                 this._saltRounds = value;
                 break;
@@ -341,3 +384,4 @@ Try setting it to something valid, like:
         }
     }
 }
+export const PsychicApplicationAllowedPackageManagersEnumValues = ['yarn', 'npm', 'pnpm'];

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

@@ -5,6 +5,7 @@ export default class PsychicBin {
     static sync({ bypassDreamSync }?: {
         bypassDreamSync?: boolean;
     }): Promise<void>;
+    static postSync(): Promise<void>;
     static syncTypes(customTypes?: any): Promise<void>;
     static syncOpenapiJson(): Promise<void>;
     static syncRoutes(): Promise<void>;

package/dist/types/src/error/UnexpectedUndefined.d.ts

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

package/dist/types/src/error/psychic-application/init-missing-package-manager.d.ts

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

package/dist/types/src/generate/helpers/generateControllerContent.d.ts

@@ -2,7 +2,7 @@ export default function generateControllerContent({ ancestorName, ancestorImport
     ancestorName: string;
     ancestorImportStatement: string;
     fullyQualifiedControllerName: string;
-    fullyQualifiedModelName?: string;
-    actions?: string[];
-    omitOpenApi?: boolean;
+    fullyQualifiedModelName?: string | undefined;
+    actions?: string[] | undefined;
+    omitOpenApi?: boolean | undefined;
 }): string;

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

@@ -11,6 +11,20 @@ import { PsychicHookEventType, PsychicHookLoadEventTypes } from './types.js';
 export default class PsychicApplication {
     static init(cb: (app: PsychicApplication) => void | Promise<void>, dreamCb: (app: DreamApplication) => void | Promise<void>, opts?: PsychicApplicationInitOptions): Promise<PsychicApplication>;
     static lookupClassByGlobalName(name: string): any;
+    /**
+     * @internal
+     *
+     * used to provide the correct package manager syntax for running a script
+     * inside of the package.json "scripts" section.
+     */
+    packageManagerRunCmd(cmd: string): string;
+    /**
+     * @internal
+     *
+     * adds the necessary package manager prefix to the psy command provided
+     * i.e. `psyCmd('sync')`
+     */
+    psyCmd(cmd: string): string;
     private static checkKey;
     /**
      * Returns the cached psychic application if it has been set.
@@ -45,10 +59,12 @@ export default class PsychicApplication {
     };
     private _logger;
     get logger(): DreamLogger;
-    private _sslCredentials?;
+    private _sslCredentials;
     get sslCredentials(): PsychicSslCredentials | undefined;
-    private _saltRounds?;
+    private _saltRounds;
     get saltRounds(): number | undefined;
+    private _packageManager;
+    get packageManager(): "yarn" | "npm" | "pnpm";
     private _routesCb;
     get routesCb(): (r: PsychicRouter) => void | Promise<void>;
     private _openapi;
@@ -73,16 +89,21 @@ export default class PsychicApplication {
         [x: string]: string | null;
     };
     get controllers(): Record<string, typeof import("../index.js").PsychicController>;
+    private _plugins;
+    get plugins(): ((app: PsychicApplication) => void | Promise<void>)[];
     load<RT extends 'controllers'>(resourceType: RT, resourcePath: string, importCb: (path: string) => Promise<any>): Promise<void>;
     private booted;
     boot(force?: boolean): Promise<void>;
+    plugin(cb: (app: PsychicApplication) => 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' ? (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 'sync' ? () => any : (conf: PsychicApplication) => void | Promise<void>): void;
     set(option: 'openapi', name: string, value: NamedPsychicOpenapiOptions): void;
-    set<Opt extends PsychicApplicationOption>(option: Opt, value: Opt extends 'appName' ? string : Opt extends 'apiOnly' ? boolean : Opt extends 'defaultResponseHeaders' ? Record<string, string | null> : Opt extends 'encryption' ? PsychicApplicationEncryptionOptions : 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 'inflections' ? () => void | Promise<void> : Opt extends 'routes' ? (r: PsychicRouter) => void | Promise<void> : never): void;
+    set<Opt extends PsychicApplicationOption>(option: Opt, value: Opt extends 'appName' ? string : Opt extends 'apiOnly' ? boolean : Opt extends 'defaultResponseHeaders' ? Record<string, string | null> : Opt extends 'encryption' ? PsychicApplicationEncryptionOptions : 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' ? PsychicApplicationAllowedPackageManagersEnum : Opt extends 'inflections' ? () => void | Promise<void> : Opt extends 'routes' ? (r: PsychicRouter) => void | Promise<void> : never): void;
     override<Override extends keyof PsychicApplicationOverrides>(override: Override, value: PsychicApplicationOverrides[Override]): void;
     private runHooksFor;
 }
-export type PsychicApplicationOption = 'appName' | 'apiOnly' | 'apiRoot' | 'encryption' | 'sessionCookieName' | 'client' | 'clientRoot' | 'cookie' | 'cors' | 'defaultResponseHeaders' | 'inflections' | 'json' | 'logger' | 'openapi' | 'paths' | 'port' | 'routes' | 'saltRounds' | 'ssl';
+export type PsychicApplicationOption = 'appName' | 'apiOnly' | 'apiRoot' | 'encryption' | 'sessionCookieName' | 'client' | 'clientRoot' | 'cookie' | 'cors' | 'defaultResponseHeaders' | 'inflections' | 'json' | 'logger' | 'openapi' | 'packageManager' | 'paths' | 'port' | 'routes' | 'saltRounds' | 'ssl';
+export declare const PsychicApplicationAllowedPackageManagersEnumValues: readonly ["yarn", "npm", "pnpm"];
+export type PsychicApplicationAllowedPackageManagersEnum = (typeof PsychicApplicationAllowedPackageManagersEnumValues)[number];
 export interface PsychicApplicationSpecialHooks {
     sync: (() => any)[];
     serverInit: ((server: PsychicServer) => void | Promise<void>)[];

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "0.26.3",
+  "version": "0.27.2",
   "author": "RVOHealth",
   "repository": {
     "type": "git",
@@ -24,13 +24,12 @@
   ],
   "scripts": {
     "client": "yarn --cwd=./client start",
-    "psy": "NODE_ENV=${NODE_ENV:-test} yarn psyts",
+    "psy": "PSYCHIC_CORE_DEVELOPMENT=1 NODE_ENV=${NODE_ENV:-test} yarn psyts",
     "psyjs": "node ./dist/test-app/src/cli/index.js",
     "psyts": "NODE_ENV=${NODE_ENV:-test} tsx ./test-app/src/cli/index.ts",
-    "psycore": "PSYCHIC_CORE_DEVELOPMENT=1 yarn psyts",
-    "gpsycore": "PSYCHIC_CORE_DEVELOPMENT=1 tsx ./global-cli/main.ts",
+    "gpsy": "PSYCHIC_CORE_DEVELOPMENT=1 tsx ./global-cli/main.ts",
     "build": "echo \"building cjs...\" && rm -rf dist && npx tsc -p ./tsconfig.cjs.build.json && echo \"building esm...\" && npx tsc -p ./tsconfig.esm.build.json",
-    "build:core": "rm -rf dist && echo \"building core app to esm...\" && npx tsc -p ./tsconfig.esm.build.core.json && echo \"building core app to cjs...\" && npx tsc -p ./tsconfig.cjs.build.core.json",
+    "build:test-app": "rm -rf dist && echo \"building test app to esm...\" && npx tsc -p ./tsconfig.esm.build.test-app.json && echo \"building test app to cjs...\" && npx tsc -p ./tsconfig.cjs.build.test-app.json",
     "dev": "PSYCHIC_CORE_DEVELOPMENT=1 NODE_ENV=development tsx ./test-app/main.ts",
     "console": "PSYCHIC_CORE_DEVELOPMENT=1 tsx ./test-app/src/conf/repl.ts",
     "uspec": "PSYCHIC_CORE_DEVELOPMENT=1 vitest --config ./spec/unit/vite.config.ts",
@@ -63,7 +62,7 @@
   "devDependencies": {
     "@eslint/js": "^9.19.0",
     "@jest-mock/express": "^3.0.0",
-    "@rvoh/dream": "^0.31.3",
+    "@rvoh/dream": "^0.32.3",
     "@rvoh/dream-spec-helpers": "=0.1.0",
     "@rvoh/psychic-spec-helpers": "=0.2.0",
     "@types/express": "^4.17.21",

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

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = sspawn;
-exports.ssspawn = ssspawn;
-const child_process_1 = require("child_process");
-function sspawn(command, 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-opts = {}) {
-    return new Promise((accept, reject) => {
-        ssspawn(command, opts).on('close', code => {
-            if (code !== 0)
-                reject(new Error(code?.toString()));
-            accept({});
-        });
-    });
-}
-function ssspawn(command, 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-opts = {}) {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-    return (0, child_process_1.spawn)(command, {
-        stdio: 'inherit',
-        shell: true,
-        ...opts,
-    });
-}

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

@@ -1,22 +0,0 @@
-import { spawn } from 'child_process';
-export default function sspawn(command, 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-opts = {}) {
-    return new Promise((accept, reject) => {
-        ssspawn(command, opts).on('close', code => {
-            if (code !== 0)
-                reject(new Error(code?.toString()));
-            accept({});
-        });
-    });
-}
-export function ssspawn(command, 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-opts = {}) {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-    return spawn(command, {
-        stdio: 'inherit',
-        shell: true,
-        ...opts,
-    });
-}

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

@@ -1,2 +0,0 @@
-export default function sspawn(command: string, opts?: any): Promise<unknown>;
-export declare function ssspawn(command: string, opts?: any): import("child_process").ChildProcessWithoutNullStreams;