@rvoh/psychic 3.0.4 → 3.1.0

package/dist/cjs/src/cli/helpers/PackageManager.js

@@ -32,4 +32,14 @@ export default class PackageManager {
                 return `${this.packageManager} ${cmd}`;
         }
     }
+    static exec(cmd) {
+        switch (this.packageManager) {
+            case 'npm':
+                return `npm exec -- ${cmd}`;
+            case 'yarn':
+                return `yarn ${cmd}`;
+            default:
+                return `${this.packageManager} exec ${cmd}`;
+        }
+    }
 }

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

@@ -249,7 +249,7 @@ ${INDENT}    --client-config-file=../client/app/api/backend/client.ts \\
 ${INDENT}    --export-name=backendApi`)
             .option('--schema-file <schemaFile>', 'path to the OpenAPI JSON spec file generated by Psychic, e.g., ./src/openapi/openapi.json')
             .option('--output-dir <outputDir>', 'directory where @hey-api/openapi-ts will generate typed API functions, types, and schemas, e.g., ../client/app/api/backend')
-            .option('--client-config-file <clientConfigFile>', 'path to the @hey-api/client-fetch configuration file that sets the base URL and credentials, e.g., ../client/app/api/backend/client.ts')
+            .option('--client-config-file <clientConfigFile>', 'path to the @hey-api/openapi-ts client configuration file that sets the base URL and credentials, e.g., ../client/app/api/backend/client.ts')
             .option('--export-name <exportName>', 'the camelCased name for the exported API module, e.g., backendApi')
             .action(async ({ schemaFile, outputDir, clientConfigFile, exportName, }) => {
             await initializePsychicApp({

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

@@ -1,6 +1,7 @@
 import { camelize, pascalize } from '@rvoh/dream/utils';
 import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
+import PackageManager from '../../../cli/helpers/PackageManager.js';
 import psychicPath from '../../../helpers/path/psychicPath.js';
 export default async function writeInitializer({ exportName }) {
     const pascalized = pascalize(exportName);
@@ -22,6 +23,7 @@ export default async function writeInitializer({ exportName }) {
         await fs.mkdir(destDir, { recursive: true });
     }
     const filePath = path.join('.', 'src', 'conf', 'openapi', `${camelized}.openapi-codegen.json`);
+    const execCmd = PackageManager.exec(`@rtk-query/codegen-openapi ${filePath}`);
     const contents = `\
 import { DreamCLI } from '@rvoh/dream/system'
 import { PsychicApp } from '@rvoh/psychic'
@@ -31,7 +33,7 @@ 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 @rtk-query/codegen-openapi ${filePath}', {
+        await DreamCLI.spawn('${execCmd}', {
           onStdout: message => {
             DreamCLI.logger.logContinueProgress(\`[${camelized}]\` + ' ' + message, {
               logPrefixColor: 'green',

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

@@ -1,6 +1,7 @@
 import { hyphenize } from '@rvoh/dream/utils';
 import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
+import PackageManager from '../../../cli/helpers/PackageManager.js';
 import psychicPath from '../../../helpers/path/psychicPath.js';
 export default async function generateInitializer(openapiFilepath, outfile, initializerFilename) {
     if (!/\.d\.ts$/.test(outfile))
@@ -15,6 +16,7 @@ export default async function generateInitializer(openapiFilepath, outfile, init
     catch {
         await fs.mkdir(destDir, { recursive: true });
     }
+    const execCmd = PackageManager.exec(`openapi-typescript ${openapiFilepath} -o ${outfile}`);
     const contents = `\
 import { DreamCLI } from '@rvoh/dream/system'
 import { PsychicApp } from "@rvoh/psychic"
@@ -24,7 +26,7 @@ export default (psy: PsychicApp) => {
   psy.on('cli:sync', async () => {
     if (AppEnv.isDevelopmentOrTest) {
       await DreamCLI.logger.logProgress(\`[${hyphenized}] extracting types from ${openapiFilepath} to ${outfile}...\`, async () => {
-        await DreamCLI.spawn('npx openapi-typescript ${openapiFilepath} -o ${outfile}')
+        await DreamCLI.spawn('${execCmd}')
       })
     }
   })

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

@@ -46,8 +46,8 @@ If not provided, it will default to:
 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.
+that configures the @hey-api/openapi-ts client 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

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

@@ -16,7 +16,7 @@ export default async function writeClientConfigFile({ clientConfigFile }) {
         await fs.mkdir(destDir, { recursive: true });
     }
     const contents = `\
-import { client } from '@hey-api/client-fetch'
+import { client } from './client.gen'
 
 function baseUrl() {
   // add custom code here for determining your application's baseUrl

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

@@ -1,10 +1,12 @@
 import { camelize, pascalize } from '@rvoh/dream/utils';
 import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
+import PackageManager from '../../../cli/helpers/PackageManager.js';
 import psychicPath from '../../../helpers/path/psychicPath.js';
 export default async function writeInitializer({ exportName, schemaFile, outputDir, }) {
     const pascalized = pascalize(exportName);
     const camelized = camelize(exportName);
+    const execCmd = PackageManager.exec(`@hey-api/openapi-ts -i ${schemaFile} -o ${outputDir}`);
     const destDir = path.join(psychicPath('conf'), 'initializers', 'openapi');
     const initializerFilename = `${camelized}.ts`;
     const initializerPath = path.join(destDir, initializerFilename);
@@ -30,7 +32,7 @@ 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}', {
+        await DreamCLI.spawn('${execCmd}', {
           onStdout: message => {
             DreamCLI.logger.logContinueProgress(\`[${camelized}]\` + ' ' + message, {
               logPrefixColor: 'green',

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

@@ -22,6 +22,6 @@ 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 }));
+    await DreamCLI.spawn(PackageManager.add(['@hey-api/openapi-ts'], { dev: true }));
     printFinalStepsMessage(opts);
 }

package/dist/cjs/src/openapi-renderer/SerializerOpenapiRenderer.js

@@ -139,13 +139,16 @@ export default class SerializerOpenapiRenderer {
                         const openapi = attribute.options.openapi;
                         newlyReferencedSerializers = allSerializersFromHandWrittenOpenapi(openapi);
                         let target;
+                        let delegatedAssociationOptional = false;
                         if (attributeType === 'delegatedAttribute' && DataTypeForOpenapi?.isDream) {
                             const source = DataTypeForOpenapi;
-                            // eslint-disable-next-line @typescript-eslint/no-unsafe-call
-                            const associatedModelOrModels = source['getAssociationMetadata'](attribute.targetName)?.modelCB();
+                            const association = source['getAssociationMetadata'](attribute.targetName);
+                            const associatedModelOrModels = association?.modelCB();
                             target = Array.isArray(associatedModelOrModels)
                                 ? associatedModelOrModels[0]
                                 : associatedModelOrModels;
+                            delegatedAssociationOptional = !!association
+                                ?.optional;
                         }
                         else if (attributeType === 'delegatedAttribute') {
                             target = undefined;
@@ -153,11 +156,36 @@ export default class SerializerOpenapiRenderer {
                         else {
                             target = DataTypeForOpenapi;
                         }
-                        accumulator[outputAttributeName] = allSerializersToRefsInOpenapi(target?.isDream
+                        const resolvedSchema = allSerializersToRefsInOpenapi(target?.isDream
                             ? dreamColumnOpenapiShape(this.serializer.globalName, target, attribute.name, openapi, {
                                 suppressResponseEnums: this.suppressResponseEnums,
                             })
                             : openapiShorthandToOpenapi(openapi));
+                        const optional = attributeType === 'delegatedAttribute' &&
+                            (attribute.options.optional ?? delegatedAssociationOptional);
+                        if (optional && !openapiSchemaIncludesNull(resolvedSchema)) {
+                            const schemaRecord = resolvedSchema;
+                            if (typeof schemaRecord.type === 'string') {
+                                accumulator[outputAttributeName] = {
+                                    ...schemaRecord,
+                                    type: [schemaRecord.type, 'null'],
+                                };
+                            }
+                            else if (Array.isArray(schemaRecord.type)) {
+                                accumulator[outputAttributeName] = {
+                                    ...schemaRecord,
+                                    type: [...schemaRecord.type, 'null'],
+                                };
+                            }
+                            else {
+                                accumulator[outputAttributeName] = {
+                                    anyOf: [resolvedSchema, NULL_OBJECT_OPENAPI],
+                                };
+                            }
+                        }
+                        else {
+                            accumulator[outputAttributeName] = resolvedSchema;
+                        }
                         return accumulator;
                     }
                     /////////////////////////////////////////////
@@ -375,3 +403,16 @@ function descendantSerializers(serializer, alreadyExtractedDescendantSerializers
 // throws an error)
 class CallingSerializersThrewError extends Error {
 }
+function openapiSchemaIncludesNull(schema) {
+    if (typeof schema !== 'object' || schema === null)
+        return false;
+    const schemaRecord = schema;
+    if (Array.isArray(schemaRecord.type) && schemaRecord.type.includes('null'))
+        return true;
+    if (schemaRecord.type === 'null')
+        return true;
+    if (Array.isArray(schemaRecord.anyOf) &&
+        schemaRecord.anyOf.some((member) => openapiSchemaIncludesNull(member)))
+        return true;
+    return false;
+}

package/dist/esm/src/cli/helpers/PackageManager.js

@@ -32,4 +32,14 @@ export default class PackageManager {
                 return `${this.packageManager} ${cmd}`;
         }
     }
+    static exec(cmd) {
+        switch (this.packageManager) {
+            case 'npm':
+                return `npm exec -- ${cmd}`;
+            case 'yarn':
+                return `yarn ${cmd}`;
+            default:
+                return `${this.packageManager} exec ${cmd}`;
+        }
+    }
 }

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

@@ -249,7 +249,7 @@ ${INDENT}    --client-config-file=../client/app/api/backend/client.ts \\
 ${INDENT}    --export-name=backendApi`)
             .option('--schema-file <schemaFile>', 'path to the OpenAPI JSON spec file generated by Psychic, e.g., ./src/openapi/openapi.json')
             .option('--output-dir <outputDir>', 'directory where @hey-api/openapi-ts will generate typed API functions, types, and schemas, e.g., ../client/app/api/backend')
-            .option('--client-config-file <clientConfigFile>', 'path to the @hey-api/client-fetch configuration file that sets the base URL and credentials, e.g., ../client/app/api/backend/client.ts')
+            .option('--client-config-file <clientConfigFile>', 'path to the @hey-api/openapi-ts client configuration file that sets the base URL and credentials, e.g., ../client/app/api/backend/client.ts')
             .option('--export-name <exportName>', 'the camelCased name for the exported API module, e.g., backendApi')
             .action(async ({ schemaFile, outputDir, clientConfigFile, exportName, }) => {
             await initializePsychicApp({

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

@@ -1,6 +1,7 @@
 import { camelize, pascalize } from '@rvoh/dream/utils';
 import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
+import PackageManager from '../../../cli/helpers/PackageManager.js';
 import psychicPath from '../../../helpers/path/psychicPath.js';
 export default async function writeInitializer({ exportName }) {
     const pascalized = pascalize(exportName);
@@ -22,6 +23,7 @@ export default async function writeInitializer({ exportName }) {
         await fs.mkdir(destDir, { recursive: true });
     }
     const filePath = path.join('.', 'src', 'conf', 'openapi', `${camelized}.openapi-codegen.json`);
+    const execCmd = PackageManager.exec(`@rtk-query/codegen-openapi ${filePath}`);
     const contents = `\
 import { DreamCLI } from '@rvoh/dream/system'
 import { PsychicApp } from '@rvoh/psychic'
@@ -31,7 +33,7 @@ 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 @rtk-query/codegen-openapi ${filePath}', {
+        await DreamCLI.spawn('${execCmd}', {
           onStdout: message => {
             DreamCLI.logger.logContinueProgress(\`[${camelized}]\` + ' ' + message, {
               logPrefixColor: 'green',

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

@@ -1,6 +1,7 @@
 import { hyphenize } from '@rvoh/dream/utils';
 import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
+import PackageManager from '../../../cli/helpers/PackageManager.js';
 import psychicPath from '../../../helpers/path/psychicPath.js';
 export default async function generateInitializer(openapiFilepath, outfile, initializerFilename) {
     if (!/\.d\.ts$/.test(outfile))
@@ -15,6 +16,7 @@ export default async function generateInitializer(openapiFilepath, outfile, init
     catch {
         await fs.mkdir(destDir, { recursive: true });
     }
+    const execCmd = PackageManager.exec(`openapi-typescript ${openapiFilepath} -o ${outfile}`);
     const contents = `\
 import { DreamCLI } from '@rvoh/dream/system'
 import { PsychicApp } from "@rvoh/psychic"
@@ -24,7 +26,7 @@ export default (psy: PsychicApp) => {
   psy.on('cli:sync', async () => {
     if (AppEnv.isDevelopmentOrTest) {
       await DreamCLI.logger.logProgress(\`[${hyphenized}] extracting types from ${openapiFilepath} to ${outfile}...\`, async () => {
-        await DreamCLI.spawn('npx openapi-typescript ${openapiFilepath} -o ${outfile}')
+        await DreamCLI.spawn('${execCmd}')
       })
     }
   })

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

@@ -46,8 +46,8 @@ If not provided, it will default to:
 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.
+that configures the @hey-api/openapi-ts client 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

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

@@ -16,7 +16,7 @@ export default async function writeClientConfigFile({ clientConfigFile }) {
         await fs.mkdir(destDir, { recursive: true });
     }
     const contents = `\
-import { client } from '@hey-api/client-fetch'
+import { client } from './client.gen'
 
 function baseUrl() {
   // add custom code here for determining your application's baseUrl

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

@@ -1,10 +1,12 @@
 import { camelize, pascalize } from '@rvoh/dream/utils';
 import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
+import PackageManager from '../../../cli/helpers/PackageManager.js';
 import psychicPath from '../../../helpers/path/psychicPath.js';
 export default async function writeInitializer({ exportName, schemaFile, outputDir, }) {
     const pascalized = pascalize(exportName);
     const camelized = camelize(exportName);
+    const execCmd = PackageManager.exec(`@hey-api/openapi-ts -i ${schemaFile} -o ${outputDir}`);
     const destDir = path.join(psychicPath('conf'), 'initializers', 'openapi');
     const initializerFilename = `${camelized}.ts`;
     const initializerPath = path.join(destDir, initializerFilename);
@@ -30,7 +32,7 @@ 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}', {
+        await DreamCLI.spawn('${execCmd}', {
           onStdout: message => {
             DreamCLI.logger.logContinueProgress(\`[${camelized}]\` + ' ' + message, {
               logPrefixColor: 'green',

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

@@ -22,6 +22,6 @@ 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 }));
+    await DreamCLI.spawn(PackageManager.add(['@hey-api/openapi-ts'], { dev: true }));
     printFinalStepsMessage(opts);
 }

package/dist/esm/src/openapi-renderer/SerializerOpenapiRenderer.js

@@ -139,13 +139,16 @@ export default class SerializerOpenapiRenderer {
                         const openapi = attribute.options.openapi;
                         newlyReferencedSerializers = allSerializersFromHandWrittenOpenapi(openapi);
                         let target;
+                        let delegatedAssociationOptional = false;
                         if (attributeType === 'delegatedAttribute' && DataTypeForOpenapi?.isDream) {
                             const source = DataTypeForOpenapi;
-                            // eslint-disable-next-line @typescript-eslint/no-unsafe-call
-                            const associatedModelOrModels = source['getAssociationMetadata'](attribute.targetName)?.modelCB();
+                            const association = source['getAssociationMetadata'](attribute.targetName);
+                            const associatedModelOrModels = association?.modelCB();
                             target = Array.isArray(associatedModelOrModels)
                                 ? associatedModelOrModels[0]
                                 : associatedModelOrModels;
+                            delegatedAssociationOptional = !!association
+                                ?.optional;
                         }
                         else if (attributeType === 'delegatedAttribute') {
                             target = undefined;
@@ -153,11 +156,36 @@ export default class SerializerOpenapiRenderer {
                         else {
                             target = DataTypeForOpenapi;
                         }
-                        accumulator[outputAttributeName] = allSerializersToRefsInOpenapi(target?.isDream
+                        const resolvedSchema = allSerializersToRefsInOpenapi(target?.isDream
                             ? dreamColumnOpenapiShape(this.serializer.globalName, target, attribute.name, openapi, {
                                 suppressResponseEnums: this.suppressResponseEnums,
                             })
                             : openapiShorthandToOpenapi(openapi));
+                        const optional = attributeType === 'delegatedAttribute' &&
+                            (attribute.options.optional ?? delegatedAssociationOptional);
+                        if (optional && !openapiSchemaIncludesNull(resolvedSchema)) {
+                            const schemaRecord = resolvedSchema;
+                            if (typeof schemaRecord.type === 'string') {
+                                accumulator[outputAttributeName] = {
+                                    ...schemaRecord,
+                                    type: [schemaRecord.type, 'null'],
+                                };
+                            }
+                            else if (Array.isArray(schemaRecord.type)) {
+                                accumulator[outputAttributeName] = {
+                                    ...schemaRecord,
+                                    type: [...schemaRecord.type, 'null'],
+                                };
+                            }
+                            else {
+                                accumulator[outputAttributeName] = {
+                                    anyOf: [resolvedSchema, NULL_OBJECT_OPENAPI],
+                                };
+                            }
+                        }
+                        else {
+                            accumulator[outputAttributeName] = resolvedSchema;
+                        }
                         return accumulator;
                     }
                     /////////////////////////////////////////////
@@ -375,3 +403,16 @@ function descendantSerializers(serializer, alreadyExtractedDescendantSerializers
 // throws an error)
 class CallingSerializersThrewError extends Error {
 }
+function openapiSchemaIncludesNull(schema) {
+    if (typeof schema !== 'object' || schema === null)
+        return false;
+    const schemaRecord = schema;
+    if (Array.isArray(schemaRecord.type) && schemaRecord.type.includes('null'))
+        return true;
+    if (schemaRecord.type === 'null')
+        return true;
+    if (Array.isArray(schemaRecord.anyOf) &&
+        schemaRecord.anyOf.some((member) => openapiSchemaIncludesNull(member)))
+        return true;
+    return false;
+}

package/dist/types/src/cli/helpers/PackageManager.d.ts

@@ -4,4 +4,5 @@ export default class PackageManager {
         dev?: boolean;
     }): string;
     static run(cmd: string): string;
+    static exec(cmd: string): string;
 }

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "3.0.4",
+  "version": "3.1.0",
   "author": "RVOHealth",
   "repository": {
     "type": "git",
@@ -75,7 +75,7 @@
     "@koa/cors": "^5.0.0",
     "@koa/etag": "^5.0.2",
     "@koa/router": "^15.3.0",
-    "@rvoh/dream": "^2.4.0",
+    "@rvoh/dream": "^2.6.0",
     "@types/koa": "^3.0.1",
     "@types/koa-bodyparser": "^4.3.12",
     "@types/koa-conditional-get": "^2.0.3",
@@ -92,7 +92,7 @@
     "@koa/cors": "^5.0.0",
     "@koa/etag": "^5.0.2",
     "@koa/router": "^15.3.1",
-    "@rvoh/dream": "^2.4.0",
+    "@rvoh/dream": "^2.6.0",
     "@rvoh/dream-spec-helpers": "^2.1.1",
     "@rvoh/psychic-spec-helpers": "3.0.0",
     "@types/koa": "^3.0.1",
@@ -118,7 +118,7 @@
     "koa-conditional-get": "^3.0.0",
     "koa-passport": "^6.0.0",
     "koa-session": "^7.0.2",
-    "kysely": "^0.28.13",
+    "kysely": "^0.28.14",
     "kysely-codegen": "~0.19.0",
     "luxon-jest-matchers": "^0.1.14",
     "nodemon": "^3.1.11",