@rvoh/psychic 3.0.2 → 3.0.4

package/dist/esm/src/devtools/helpers/launchDevServer.js

@@ -1,12 +1,11 @@
 import { spawn } from 'child_process';
-import { createServer } from 'net';
 import { debuglog } from 'node:util';
-import sleep from '../../../spec/helpers/sleep.js';
 import UnexpectedUndefined from '../../error/UnexpectedUndefined.js';
 import PsychicApp from '../../psychic-app/index.js';
+import sleep from './sleep.js';
 const devServerProcesses = {};
 const debugEnabled = debuglog('psychic').enabled;
-export async function launchDevServer(key, { port = 3000, cmd = 'pnpm client', timeout = 5000, onStdOut } = {}) {
+export async function launchDevServer(key, { port = 3000, cmd = 'pnpm client', timeout = 20000, onStdOut } = {}) {
     if (devServerProcesses[key])
         return;
     if (debugEnabled)
@@ -34,16 +33,7 @@ export async function launchDevServer(key, { port = 3000, cmd = 'pnpm client', t
             console.log(txt);
         }
     });
-    devServerProcesses[key] = proc;
-    await waitForPort(key, port, timeout);
-    proc.on('error', err => {
-        throw err;
-    });
-    proc.stdout.on('data', data => {
-        if (debugEnabled)
-            PsychicApp.log(`Server output: ${data}`);
-    });
-    proc.stderr.on('data', data => {
+    proc.stderr?.on('data', data => {
         if (debugEnabled)
             PsychicApp.logWithLevel('error', `Server error: ${data}`);
     });
@@ -54,6 +44,8 @@ export async function launchDevServer(key, { port = 3000, cmd = 'pnpm client', t
         if (debugEnabled)
             PsychicApp.log(`Server process exited with code ${code}`);
     });
+    devServerProcesses[key] = proc;
+    await waitForHttpServer(proc, key, port, timeout);
 }
 export function stopDevServer(key) {
     const proc = devServerProcesses[key];
@@ -80,40 +72,23 @@ export function stopDevServers() {
         stopDevServer(key);
     });
 }
-async function isPortAvailable(port) {
-    return new Promise(resolve => {
-        const server = createServer()
-            .once('error', err => {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access
-            if (err.code === 'EADDRINUSE') {
-                resolve(false);
-            }
-            else {
-                resolve(true);
-            }
-        })
-            .once('listening', () => {
-            server.close();
-            resolve(true);
-        })
-            .listen(port, '127.0.0.1');
-    });
-}
-async function waitForPort(key, port, timeout = 5000) {
-    if (await isPortAvailable(port)) {
-        return true;
-    }
+async function waitForHttpServer(proc, key, port, timeout = 20000) {
     const startTime = Date.now();
-    async function recursiveWaitForPort() {
-        if (await isPortAvailable(port)) {
-            return true;
+    while (Date.now() - startTime < timeout) {
+        if (proc.exitCode != null) {
+            delete devServerProcesses[key];
+            throw new Error(`dev server exited with code ${proc.exitCode} before becoming ready on port ${port}`);
         }
-        if (Date.now() > startTime + timeout) {
-            stopDevServer(key);
-            throw new Error('waited too long for port: ' + port);
+        try {
+            const response = await fetch(`http://localhost:${port}`, { redirect: 'manual' });
+            if (response.status > 0)
+                return;
+        }
+        catch {
+            // server not ready yet, keep waiting
         }
-        await sleep(50);
-        return await recursiveWaitForPort();
+        await sleep(100);
     }
-    return await recursiveWaitForPort();
+    stopDevServer(key);
+    throw new Error(`waited too long for dev server on port ${port}`);
 }

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

@@ -30,15 +30,15 @@ import AppEnv from '../../AppEnv.js'
 export default function initialize${pascalized}(psy: PsychicApp) {
   psy.on('cli:sync', async () => {
     if (AppEnv.isDevelopmentOrTest) {
-      DreamCLI.logger.logStartProgress(\`[${camelized}] syncing...\`)
-      await DreamCLI.spawn('npx @rtk-query/codegen-openapi ${filePath}', {
-        onStdout: message => {
-          DreamCLI.logger.logContinueProgress(\`[${camelized}]\` + ' ' + message, {
-            logPrefixColor: 'green',
-          })
-        },
+      await DreamCLI.logger.logProgress(\`[${camelized}] syncing...\`, async () => {
+        await DreamCLI.spawn('npx @rtk-query/codegen-openapi ${filePath}', {
+          onStdout: message => {
+            DreamCLI.logger.logContinueProgress(\`[${camelized}]\` + ' ' + message, {
+              logPrefixColor: 'green',
+            })
+          },
+        })
       })
-      DreamCLI.logger.logEndProgress()
     }
   })
 }\

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

@@ -23,9 +23,9 @@ import AppEnv from '../AppEnv.js'
 export default (psy: PsychicApp) => {
   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}')
-      DreamCLI.logger.logEndProgress()
+      await DreamCLI.logger.logProgress(\`[${hyphenized}] extracting types from ${openapiFilepath} to ${outfile}...\`, async () => {
+        await DreamCLI.spawn('npx openapi-typescript ${openapiFilepath} -o ${outfile}')
+      })
     }
   })
 }\

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

@@ -0,0 +1,47 @@
+import { DreamCLI } from '@rvoh/dream/system';
+import colorize from '../../../cli/helpers/colorize.js';
+export default function printFinalStepsMessage(opts) {
+    const importLine = colorize(`+ import '${opts.clientConfigFile}'`, { color: 'green' });
+    const sdkImportLine = colorize(`+ import { getAdminCities, postAdminCities } from '${opts.outputDir}/sdk.gen'`, {
+        color: 'green',
+    });
+    const usageLine = colorize(`  const { data, error } = await getAdminCities()`, {
+        color: 'green',
+    });
+    const zustandLine = colorize(`  const { data } = await getAdminCities()
+    set({ cities: data?.results })`, { color: 'green' });
+    DreamCLI.logger.log(`
+Finished generating @hey-api/openapi-ts bindings for your application.
+
+First, you will need to be sure to sync, so that the typed API functions
+are generated from your openapi schema:
+
+  pnpm psy sync
+
+This will generate typed API functions and types in ${opts.outputDir}/
+
+To use the generated API, first import the client config at your app's
+entry point to configure the base URL and credentials:
+
+${importLine}
+
+Then import and use the generated typed functions anywhere:
+
+${sdkImportLine}
+
+// all functions are fully typed with request params and response types
+${usageLine}
+
+To use with a Zustand store:
+
+import { create } from 'zustand'
+${sdkImportLine}
+
+const useCitiesStore = create((set) => ({
+  cities: [],
+  fetchCities: async () => {
+${zustandLine}
+  },
+}))
+`, { logPrefix: '' });
+}

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

@@ -0,0 +1,61 @@
+import { camelize } from '@rvoh/dream/utils';
+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 = './src/openapi/openapi.json';
+        const answer = await cliPrompt(`\
+What would you like the schemaFile to be?
+
+The schemaFile is the openapi file that @hey-api/openapi-ts will read to produce
+all of its typed API functions and types. If not provided, it will default to
+
+  ${defaultVal}
+`);
+        options.schemaFile = answer || defaultVal;
+    }
+    if (!options.exportName) {
+        const defaultVal = `${camelize(PsychicApp.getOrFail().appName)}Api`;
+        const answer = await cliPrompt(`\
+What would you like the exportName to be?
+
+The exportName is used to name the generated API output. It will be used to name
+the initializer and config files. We recommend naming it something like the name
+of your app, i.e.
+
+  ${defaultVal}
+`);
+        options.exportName = answer || defaultVal;
+    }
+    if (!options.outputDir) {
+        const defaultVal = `../client/app/api/${camelize(options.exportName)}`;
+        const answer = await cliPrompt(`\
+What would you like the outputDir to be?
+
+The outputDir is the directory where @hey-api/openapi-ts will generate the typed
+API functions and types. It will contain files like types.gen.ts and sdk.gen.ts.
+If not provided, it will default to:
+
+  ${defaultVal}
+`);
+        options.outputDir = answer || defaultVal;
+    }
+    if (!options.clientConfigFile) {
+        const defaultVal = `../client/app/api/${camelize(options.exportName)}/client.ts`;
+        const answer = await cliPrompt(`\
+What would you like the path to your clientConfigFile to be?
+
+The clientConfigFile specifies where to generate the client configuration file
+that configures @hey-api/client-fetch with your base URL, credentials, and
+other request options.
+
+We expect you to provide this path with the api root in mind, so you will need
+to consider how to travel to the desired filepath from within your psychic
+project, i.e.
+
+  ${defaultVal}
+`);
+        options.clientConfigFile = answer || defaultVal;
+    }
+    return options;
+}

package/dist/esm/src/generate/helpers/zustandBindings/writeClientConfigFile.js

@@ -0,0 +1,43 @@
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+export default async function writeClientConfigFile({ clientConfigFile }) {
+    const destDir = path.dirname(clientConfigFile);
+    try {
+        await fs.access(clientConfigFile);
+        return; // early return if the file already exists
+    }
+    catch {
+        // noop
+    }
+    try {
+        await fs.access(destDir);
+    }
+    catch {
+        await fs.mkdir(destDir, { recursive: true });
+    }
+    const contents = `\
+import { client } from '@hey-api/client-fetch'
+
+function baseUrl() {
+  // add custom code here for determining your application's baseUrl
+  // this would generally be something different, depending on if you
+  // are in dev/test/production environments. For dev, you might want
+  // http://localhost:7777, while test may be http://localhost:7778, or
+  // some other port, depending on how you have your spec hooks configured.
+  // for production, it should be the real host for your application, i.e.
+  // https://myapi.com
+
+  return 'http://localhost:7777'
+}
+
+client.setConfig({
+  baseUrl: baseUrl(),
+  credentials: 'include',
+
+  // you can customize headers here, for example to add auth tokens:
+  // headers: {
+  //   Authorization: \`Bearer \${getToken()}\`,
+  // },
+})`;
+    await fs.writeFile(clientConfigFile, contents);
+}

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

@@ -0,0 +1,46 @@
+import { camelize, pascalize } from '@rvoh/dream/utils';
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+import psychicPath from '../../../helpers/path/psychicPath.js';
+export default async function writeInitializer({ exportName, schemaFile, outputDir, }) {
+    const pascalized = pascalize(exportName);
+    const camelized = camelize(exportName);
+    const destDir = path.join(psychicPath('conf'), 'initializers', 'openapi');
+    const initializerFilename = `${camelized}.ts`;
+    const initializerPath = path.join(destDir, initializerFilename);
+    try {
+        await fs.access(initializerPath);
+        return; // early return if the file already exists
+    }
+    catch {
+        // noop
+    }
+    try {
+        await fs.access(destDir);
+    }
+    catch {
+        await fs.mkdir(destDir, { recursive: true });
+    }
+    const contents = `\
+import { DreamCLI } from '@rvoh/dream/system'
+import { PsychicApp } from '@rvoh/psychic'
+import AppEnv from '../../AppEnv.js'
+
+export default function initialize${pascalized}(psy: PsychicApp) {
+  psy.on('cli:sync', async () => {
+    if (AppEnv.isDevelopmentOrTest) {
+      await DreamCLI.logger.logProgress(\`[${camelized}] syncing...\`, async () => {
+        await DreamCLI.spawn('npx @hey-api/openapi-ts -i ${schemaFile} -o ${outputDir}', {
+          onStdout: message => {
+            DreamCLI.logger.logContinueProgress(\`[${camelized}]\` + ' ' + message, {
+              logPrefixColor: 'green',
+            })
+          },
+        })
+      })
+    }
+  })
+}\
+`;
+    await fs.writeFile(initializerPath, contents);
+}

package/dist/esm/src/generate/initializer/syncEnums.js

@@ -29,9 +29,9 @@ import AppEnv from '../AppEnv.js'
 export default function ${camelized}(psy: PsychicApp) {
   psy.on('cli:sync', async () => {
     if (AppEnv.isDevelopmentOrTest) {
-      DreamCLI.logger.logStartProgress(\`[${camelized}] syncing enums to ${outfile}...\`)
-      await PsychicBin.syncClientEnums('${outfile}')
-      DreamCLI.logger.logEndProgress()
+      await DreamCLI.logger.logProgress(\`[${camelized}] syncing enums to ${outfile}...\`, async () => {
+        await PsychicBin.syncClientEnums('${outfile}')
+      })
     }
   })
 }\

package/dist/esm/src/generate/openapi/zustandBindings.js

@@ -0,0 +1,27 @@
+import { DreamCLI } from '@rvoh/dream/system';
+import PackageManager from '../../cli/helpers/PackageManager.js';
+import printFinalStepsMessage from '../helpers/zustandBindings/printFinalStepsMessage.js';
+import promptForOptions from '../helpers/zustandBindings/promptForOptions.js';
+import writeClientConfigFile from '../helpers/zustandBindings/writeClientConfigFile.js';
+import writeInitializer from '../helpers/zustandBindings/writeInitializer.js';
+/**
+ * @internal
+ *
+ * used by the psychic CLI to generate boilerplate
+ * that can be used to integrate a specific openapi.json
+ * file with a client using @hey-api/openapi-ts.
+ *
+ * * generates the client config file if it does not exist
+ * * generates an initializer, which taps into the sync hooks
+ *   to automatically run the @hey-api/openapi-ts CLI util
+ * * prints a helpful message, instructing devs on the final
+ *   steps for using the generated typed API functions
+ *   within their client application.
+ */
+export default async function generateOpenapiZustandBindings(options = {}) {
+    const opts = await promptForOptions(options);
+    await writeClientConfigFile(opts);
+    await writeInitializer(opts);
+    await DreamCLI.spawn(PackageManager.add(['@hey-api/openapi-ts', '@hey-api/client-fetch'], { dev: true }));
+    printFinalStepsMessage(opts);
+}

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

@@ -27,6 +27,7 @@ export default async function generateResource({ route, fullyQualifiedModelName,
             includeAdminSerializers: forAdmin,
             includeInternalSerializers: forInternal,
             connectionName: options.connectionName,
+            tableName: options.tableName,
             modelName: options.modelName,
         },
     });

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

@@ -29,6 +29,7 @@ export default class PsychicCLI {
             stiBaseSerializer: boolean;
             owningModel?: string;
             connectionName: string;
+            tableName?: string;
             modelName?: string;
         };
         columnsWithTypes: string[];

package/dist/types/src/generate/helpers/zustandBindings/printFinalStepsMessage.d.ts

@@ -0,0 +1,2 @@
+import { OpenapiZustandBindingsOptions } from '../../openapi/zustandBindings.js';
+export default function printFinalStepsMessage(opts: Required<OpenapiZustandBindingsOptions>): void;

package/dist/types/src/generate/helpers/zustandBindings/promptForOptions.d.ts

@@ -0,0 +1,2 @@
+import { OpenapiZustandBindingsOptions } from '../../openapi/zustandBindings.js';
+export default function promptForOptions(options: OpenapiZustandBindingsOptions): Promise<Required<OpenapiZustandBindingsOptions>>;

package/dist/types/src/generate/helpers/zustandBindings/writeClientConfigFile.d.ts

@@ -0,0 +1,3 @@
+export default function writeClientConfigFile({ clientConfigFile }: {
+    clientConfigFile: string;
+}): Promise<void>;

package/dist/types/src/generate/helpers/zustandBindings/writeInitializer.d.ts

@@ -0,0 +1,5 @@
+export default function writeInitializer({ exportName, schemaFile, outputDir, }: {
+    exportName: string;
+    schemaFile: string;
+    outputDir: string;
+}): Promise<void>;

package/dist/types/src/generate/openapi/zustandBindings.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @internal
+ *
+ * used by the psychic CLI to generate boilerplate
+ * that can be used to integrate a specific openapi.json
+ * file with a client using @hey-api/openapi-ts.
+ *
+ * * generates the client config file if it does not exist
+ * * generates an initializer, which taps into the sync hooks
+ *   to automatically run the @hey-api/openapi-ts CLI util
+ * * prints a helpful message, instructing devs on the final
+ *   steps for using the generated typed API functions
+ *   within their client application.
+ */
+export default function generateOpenapiZustandBindings(options?: OpenapiZustandBindingsOptions): Promise<void>;
+export interface OpenapiZustandBindingsOptions {
+    exportName?: string;
+    schemaFile?: string;
+    outputDir?: string;
+    clientConfigFile?: string;
+}

package/dist/types/src/generate/resource.d.ts

@@ -9,6 +9,7 @@ export default function generateResource({ route, fullyQualifiedModelName, optio
         stiBaseSerializer: boolean;
         owningModel?: string;
         connectionName: string;
+        tableName?: string;
         modelName?: string;
     };
     columnsWithTypes: string[];

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "3.0.2",
+  "version": "3.0.4",
   "author": "RVOHealth",
   "repository": {
     "type": "git",
@@ -76,15 +76,15 @@
     "@koa/etag": "^5.0.2",
     "@koa/router": "^15.3.0",
     "@rvoh/dream": "^2.4.0",
-    "@types/koa__cors": "^5.0.0",
-    "@types/koa__router": "^12.0.5",
+    "@types/koa": "^3.0.1",
     "@types/koa-bodyparser": "^4.3.12",
     "@types/koa-conditional-get": "^2.0.3",
     "@types/koa-etag": "^3.0.3",
-    "@types/koa": "^3.0.1",
+    "@types/koa__cors": "^5.0.0",
+    "@types/koa__router": "^12.0.5",
+    "koa": "^3.1.2",
     "koa-bodyparser": "^4.4.1",
     "koa-conditional-get": "^3.0.0",
-    "koa": "^3.1.2",
     "openapi-typescript": "^7.8.0"
   },
   "devDependencies": {
@@ -107,18 +107,18 @@
     "@types/passport-local": "^1",
     "@types/pg": "^8.11.8",
     "@types/supertest": "^6.0.3",
-    "@typescript-eslint/parser": "^8.48.1",
+    "@typescript-eslint/parser": "^8.57.1",
     "@typescript/analyze-trace": "^0.10.1",
     "commander": "^14.0.3",
     "dotenv": "^16.4.5",
-    "eslint": "^9.39.1",
+    "eslint": "^9.39.4",
     "jsdom": "^26.1.0",
     "koa": "^3.1.2",
     "koa-bodyparser": "^4.4.1",
     "koa-conditional-get": "^3.0.0",
     "koa-passport": "^6.0.0",
     "koa-session": "^7.0.2",
-    "kysely": "^0.28.5",
+    "kysely": "^0.28.13",
     "kysely-codegen": "~0.19.0",
     "luxon-jest-matchers": "^0.1.14",
     "nodemon": "^3.1.11",
@@ -128,23 +128,20 @@
     "pg": "^8.12.0",
     "pluralize-esm": "^9.0.5",
     "prettier": "^3.3.3",
-    "puppeteer": "^24.22.3",
-    "supertest": "^7.1.4",
+    "puppeteer": "^24.39.1",
+    "supertest": "^7.2.2",
     "tslib": "^2.7.0",
     "tsx": "^4.21.0",
     "typedoc": "^0.28.17",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.48.1",
-    "vitest": "^4.0.9",
+    "typescript-eslint": "^8.57.1",
+    "vitest": "^4.1.0",
     "winston": "^3.14.2"
   },
   "packageManager": "pnpm@10.26.0+sha512.3b3f6c725ebe712506c0ab1ad4133cf86b1f4b687effce62a9b38b4d72e3954242e643190fc51fa1642949c735f403debd44f5cb0edd657abe63a8b6a7e1e402",
   "pnpm": {
     "overrides": {
-      "diff": ">=8.0.3",
-      "minimatch@3": "3.1.3",
-      "minimatch@5": "5.1.7",
-      "minimatch@9": "9.0.6"
+      "diff": ">=8.0.3"
     }
   }
 }