@rvoh/psychic 3.0.0-alpha.8 → 3.0.1

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "3.0.0-alpha.8",
+  "version": "3.0.1",
   "author": "RVOHealth",
   "repository": {
     "type": "git",
@@ -47,6 +47,24 @@
   "files": [
     "dist/**/*"
   ],
+  "scripts": {
+    "client": "cd client && pnpm start",
+    "client:fspec": "cd client && VITE_PSYCHIC_ENV=test BROWSER=none pnpm start",
+    "psy": "NODE_ENV=${NODE_ENV:-test} pnpm psyts",
+    "psyjs": "node ./dist/test-app/src/cli/index.js",
+    "psyts": "NODE_ENV=${NODE_ENV:-test} tsx ./test-app/src/cli/index.ts",
+    "gpsy": "tsx ./global-cli/main.ts",
+    "build": "echo \"building cjs...\" && rm -rf dist && tsc -p ./tsconfig.cjs.build.json && echo \"building esm...\" && tsc -p ./tsconfig.esm.build.json",
+    "build:test-app": "rm -rf dist && echo \"building test app to esm...\" && tsc -p ./tsconfig.esm.build.test-app.json && echo \"building test app to cjs...\" && tsc -p ./tsconfig.cjs.build.test-app.json",
+    "types:esm:trace": "rm -rf dist && tsc -p ./tsconfig.esm.build.json --generateTrace ./typetrace --diagnostics && pnpm analyze-trace ./typetrace --skipMillis 100 --forceMillis 300",
+    "dev": "nodemon --quiet --no-stdin",
+    "console": "tsx ./test-app/src/conf/repl.ts",
+    "uspec": "vitest --config ./spec/unit/vite.config.ts",
+    "fspec": "vitest run --config=./spec/features/vite.config.ts",
+    "format": "pnpm prettier . --write",
+    "lint": "pnpm eslint --no-warn-ignored \"src/**/*.ts\" \"spec/**/*.ts\" \"test-app/**/*.ts\" && pnpm prettier . --check",
+    "prepack": "pnpm build"
+  },
   "dependencies": {
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
@@ -74,9 +92,9 @@
     "@koa/cors": "^5.0.0",
     "@koa/etag": "^5.0.2",
     "@koa/router": "^15.3.1",
-    "@rvoh/dream": "^2.4.0-alpha.1",
+    "@rvoh/dream": "^2.4.0",
     "@rvoh/dream-spec-helpers": "^2.1.1",
-    "@rvoh/psychic-spec-helpers": "3.0.0-alpha.3",
+    "@rvoh/psychic-spec-helpers": "3.0.0",
     "@types/koa": "^3.0.1",
     "@types/koa-bodyparser": "^4.3.12",
     "@types/koa-conditional-get": "^2.0.3",
@@ -120,21 +138,13 @@
     "vitest": "^4.0.9",
     "winston": "^3.14.2"
   },
-  "scripts": {
-    "client": "cd client && pnpm start",
-    "client:fspec": "cd client && VITE_PSYCHIC_ENV=test BROWSER=none pnpm start",
-    "psy": "NODE_ENV=${NODE_ENV:-test} pnpm psyts",
-    "psyjs": "node ./dist/test-app/src/cli/index.js",
-    "psyts": "NODE_ENV=${NODE_ENV:-test} tsx ./test-app/src/cli/index.ts",
-    "gpsy": "tsx ./global-cli/main.ts",
-    "build": "echo \"building cjs...\" && rm -rf dist && tsc -p ./tsconfig.cjs.build.json && echo \"building esm...\" && tsc -p ./tsconfig.esm.build.json",
-    "build:test-app": "rm -rf dist && echo \"building test app to esm...\" && tsc -p ./tsconfig.esm.build.test-app.json && echo \"building test app to cjs...\" && tsc -p ./tsconfig.cjs.build.test-app.json",
-    "types:esm:trace": "rm -rf dist && tsc -p ./tsconfig.esm.build.json --generateTrace ./typetrace --diagnostics && pnpm analyze-trace ./typetrace --skipMillis 100 --forceMillis 300",
-    "dev": "nodemon --quiet --no-stdin",
-    "console": "tsx ./test-app/src/conf/repl.ts",
-    "uspec": "vitest --config ./spec/unit/vite.config.ts",
-    "fspec": "vitest run --config=./spec/features/vite.config.ts",
-    "format": "pnpm prettier . --write",
-    "lint": "pnpm eslint --no-warn-ignored \"src/**/*.ts\" \"spec/**/*.ts\" \"test-app/**/*.ts\" && pnpm prettier . --check"
+  "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"
+    }
   }
-}
+}

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

@@ -1,36 +0,0 @@
-import { DreamCLI } from '@rvoh/dream/system';
-import { camelize } from '@rvoh/dream/utils';
-import colorize from '../../../cli/helpers/colorize.js';
-export default function printFinalStepsMessage(opts) {
-    const clientFile = `${opts.outputDir}/${camelize(opts.exportName)}.ts`;
-    const importLine = colorize(`+ import { ${opts.exportName} } from '${clientFile}'`, { color: 'green' });
-    DreamCLI.logger.log(`
-Finished generating zustand + openapi-fetch bindings for your application,
-but to wire them into your app, we're going to need your help.
-
-First, you will need to be sure to sync, so that the new openapi
-types are sent over to your client application.
-
-Next, you can use the generated api client in your zustand stores, i.e.
-
-${importLine}
-
-${colorize(`+ import { create } from 'zustand'`, { color: 'green' })}
-
-interface MyState {
-  items: Item[]
-  loading: boolean
-  fetchItems: () => Promise<void>
-}
-
-export const useMyStore = create<MyState>((set) => ({
-  items: [],
-  loading: false,
-  fetchItems: async () => {
-    set({ loading: true })
-    const { data } = await ${opts.exportName}.GET('/items')
-    set({ items: data ?? [], loading: false })
-  },
-}))
-`, { logPrefix: '' });
-}

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

@@ -1,55 +0,0 @@
-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 openapi-typescript will read to produce
-all of its type definitions. 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 typed openapi-fetch client instance that will
-be generated for use in your zustand stores. We recommend naming it something like
-the name of your app, i.e.
-
-  ${defaultVal}
-`);
-        options.exportName = answer || defaultVal;
-    }
-    if (!options.outputDir) {
-        const defaultVal = '../client/src/api';
-        const answer = await cliPrompt(`\
-What would you like the outputDir to be?
-
-The outputDir is the directory where the generated api client and types files
-will be written. If not provided, it will default to:
-
-  ${defaultVal}
-`);
-        options.outputDir = answer || defaultVal;
-    }
-    if (!options.typesFile) {
-        const defaultVal = `${options.outputDir}/${camelize(options.exportName)}.types.d.ts`;
-        const answer = await cliPrompt(`\
-What would you like the typesFile to be?
-
-The typesFile is the path to the generated openapi TypeScript type definitions
-that will be used by the api client. If not provided, it will default to:
-
-  ${defaultVal}
-`);
-        options.typesFile = answer || defaultVal;
-    }
-    return options;
-}

package/dist/cjs/src/generate/helpers/zustandBindings/writeApiClientFile.js

@@ -1,50 +0,0 @@
-import * as fs from 'node:fs/promises';
-import * as path from 'node:path';
-import { camelize } from '@rvoh/dream/utils';
-export default async function writeApiClientFile({ exportName, outputDir, typesFile, }) {
-    const destDir = outputDir;
-    const destPath = path.join(destDir, `${camelize(exportName)}.ts`);
-    try {
-        await fs.access(destPath);
-        return; // early return if the file already exists
-    }
-    catch {
-        // noop
-    }
-    try {
-        await fs.access(destDir);
-    }
-    catch {
-        await fs.mkdir(destDir, { recursive: true });
-    }
-    // compute the relative import path from the output file to the types file
-    const typesRelative = path.relative(destDir, typesFile).replace(/\.d\.ts$/, '.js');
-    const typesImportPath = typesRelative.startsWith('.') ? typesRelative : `./${typesRelative}`;
-    const contents = `\
-import createClient from 'openapi-fetch'
-import type { paths } from '${typesImportPath}'
-
-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'
-}
-
-export const ${exportName} = createClient<paths>({
-  baseUrl: baseUrl(),
-  credentials: 'include',
-
-  // you may customize headers here, for example to add auth tokens:
-  // headers: {
-  //   Authorization: \`Bearer \${getAuthToken()}\`,
-  // },
-})
-`;
-    await fs.writeFile(destPath, contents);
-}

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

@@ -1,46 +0,0 @@
-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, typesFile, }) {
-    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) {
-      DreamCLI.logger.logStartProgress(\`[${camelized}] syncing openapi types...\`)
-      await DreamCLI.spawn('npx openapi-typescript ${schemaFile} -o ${typesFile}', {
-        onStdout: message => {
-          DreamCLI.logger.logContinueProgress(\`[${camelized}]\` + ' ' + message, {
-            logPrefixColor: 'green',
-          })
-        },
-      })
-      DreamCLI.logger.logEndProgress()
-    }
-  })
-}\
-`;
-    await fs.writeFile(initializerPath, contents);
-}

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

@@ -1,27 +0,0 @@
-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 writeApiClientFile from '../helpers/zustandBindings/writeApiClientFile.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 zustand + openapi-fetch.
- *
- * * generates a typed openapi-fetch client file
- * * generates an initializer, which taps into the sync hooks
- *   to automatically run openapi-typescript to keep types in sync
- * * prints a helpful message, instructing devs on the final
- *   steps for hooking into the newly-generated api mechanisms
- *   within their client application's zustand stores.
- */
-export default async function generateOpenapiZustandBindings(options = {}) {
-    const opts = await promptForOptions(options);
-    await writeApiClientFile(opts);
-    await writeInitializer(opts);
-    await DreamCLI.spawn(PackageManager.add(['openapi-fetch', 'openapi-typescript'], { dev: true }));
-    printFinalStepsMessage(opts);
-}

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

@@ -1,36 +0,0 @@
-import { DreamCLI } from '@rvoh/dream/system';
-import { camelize } from '@rvoh/dream/utils';
-import colorize from '../../../cli/helpers/colorize.js';
-export default function printFinalStepsMessage(opts) {
-    const clientFile = `${opts.outputDir}/${camelize(opts.exportName)}.ts`;
-    const importLine = colorize(`+ import { ${opts.exportName} } from '${clientFile}'`, { color: 'green' });
-    DreamCLI.logger.log(`
-Finished generating zustand + openapi-fetch bindings for your application,
-but to wire them into your app, we're going to need your help.
-
-First, you will need to be sure to sync, so that the new openapi
-types are sent over to your client application.
-
-Next, you can use the generated api client in your zustand stores, i.e.
-
-${importLine}
-
-${colorize(`+ import { create } from 'zustand'`, { color: 'green' })}
-
-interface MyState {
-  items: Item[]
-  loading: boolean
-  fetchItems: () => Promise<void>
-}
-
-export const useMyStore = create<MyState>((set) => ({
-  items: [],
-  loading: false,
-  fetchItems: async () => {
-    set({ loading: true })
-    const { data } = await ${opts.exportName}.GET('/items')
-    set({ items: data ?? [], loading: false })
-  },
-}))
-`, { logPrefix: '' });
-}

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

@@ -1,55 +0,0 @@
-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 openapi-typescript will read to produce
-all of its type definitions. 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 typed openapi-fetch client instance that will
-be generated for use in your zustand stores. We recommend naming it something like
-the name of your app, i.e.
-
-  ${defaultVal}
-`);
-        options.exportName = answer || defaultVal;
-    }
-    if (!options.outputDir) {
-        const defaultVal = '../client/src/api';
-        const answer = await cliPrompt(`\
-What would you like the outputDir to be?
-
-The outputDir is the directory where the generated api client and types files
-will be written. If not provided, it will default to:
-
-  ${defaultVal}
-`);
-        options.outputDir = answer || defaultVal;
-    }
-    if (!options.typesFile) {
-        const defaultVal = `${options.outputDir}/${camelize(options.exportName)}.types.d.ts`;
-        const answer = await cliPrompt(`\
-What would you like the typesFile to be?
-
-The typesFile is the path to the generated openapi TypeScript type definitions
-that will be used by the api client. If not provided, it will default to:
-
-  ${defaultVal}
-`);
-        options.typesFile = answer || defaultVal;
-    }
-    return options;
-}

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

@@ -1,50 +0,0 @@
-import * as fs from 'node:fs/promises';
-import * as path from 'node:path';
-import { camelize } from '@rvoh/dream/utils';
-export default async function writeApiClientFile({ exportName, outputDir, typesFile, }) {
-    const destDir = outputDir;
-    const destPath = path.join(destDir, `${camelize(exportName)}.ts`);
-    try {
-        await fs.access(destPath);
-        return; // early return if the file already exists
-    }
-    catch {
-        // noop
-    }
-    try {
-        await fs.access(destDir);
-    }
-    catch {
-        await fs.mkdir(destDir, { recursive: true });
-    }
-    // compute the relative import path from the output file to the types file
-    const typesRelative = path.relative(destDir, typesFile).replace(/\.d\.ts$/, '.js');
-    const typesImportPath = typesRelative.startsWith('.') ? typesRelative : `./${typesRelative}`;
-    const contents = `\
-import createClient from 'openapi-fetch'
-import type { paths } from '${typesImportPath}'
-
-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'
-}
-
-export const ${exportName} = createClient<paths>({
-  baseUrl: baseUrl(),
-  credentials: 'include',
-
-  // you may customize headers here, for example to add auth tokens:
-  // headers: {
-  //   Authorization: \`Bearer \${getAuthToken()}\`,
-  // },
-})
-`;
-    await fs.writeFile(destPath, contents);
-}

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

@@ -1,46 +0,0 @@
-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, typesFile, }) {
-    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) {
-      DreamCLI.logger.logStartProgress(\`[${camelized}] syncing openapi types...\`)
-      await DreamCLI.spawn('npx openapi-typescript ${schemaFile} -o ${typesFile}', {
-        onStdout: message => {
-          DreamCLI.logger.logContinueProgress(\`[${camelized}]\` + ' ' + message, {
-            logPrefixColor: 'green',
-          })
-        },
-      })
-      DreamCLI.logger.logEndProgress()
-    }
-  })
-}\
-`;
-    await fs.writeFile(initializerPath, contents);
-}

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

@@ -1,27 +0,0 @@
-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 writeApiClientFile from '../helpers/zustandBindings/writeApiClientFile.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 zustand + openapi-fetch.
- *
- * * generates a typed openapi-fetch client file
- * * generates an initializer, which taps into the sync hooks
- *   to automatically run openapi-typescript to keep types in sync
- * * prints a helpful message, instructing devs on the final
- *   steps for hooking into the newly-generated api mechanisms
- *   within their client application's zustand stores.
- */
-export default async function generateOpenapiZustandBindings(options = {}) {
-    const opts = await promptForOptions(options);
-    await writeApiClientFile(opts);
-    await writeInitializer(opts);
-    await DreamCLI.spawn(PackageManager.add(['openapi-fetch', 'openapi-typescript'], { dev: true }));
-    printFinalStepsMessage(opts);
-}

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

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

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

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

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

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

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

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

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

@@ -1,21 +0,0 @@
-/**
- * @internal
- *
- * used by the psychic CLI to generate boilerplate
- * that can be used to integrate a specific openapi.json
- * file with a client using zustand + openapi-fetch.
- *
- * * generates a typed openapi-fetch client file
- * * generates an initializer, which taps into the sync hooks
- *   to automatically run openapi-typescript to keep types in sync
- * * prints a helpful message, instructing devs on the final
- *   steps for hooking into the newly-generated api mechanisms
- *   within their client application's zustand stores.
- */
-export default function generateOpenapiZustandBindings(options?: OpenapiZustandBindingsOptions): Promise<void>;
-export interface OpenapiZustandBindingsOptions {
-    exportName?: string;
-    schemaFile?: string;
-    outputDir?: string;
-    typesFile?: string;
-}