@rvoh/psychic 0.34.5 → 0.35.1

package/dist/cjs/src/bin/helpers/syncTypescriptOpenapiFiles.js

@@ -0,0 +1,51 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = syncTypescriptOpenapiFiles;
+const dream_1 = require("@rvoh/dream");
+const fs = __importStar(require("node:fs/promises"));
+const path = __importStar(require("node:path"));
+const index_js_1 = __importDefault(require("../../psychic-app/index.js"));
+const psychicPath_js_1 = __importDefault(require("../../helpers/path/psychicPath.js"));
+async function syncTypescriptOpenapiFiles() {
+    const psychicApp = index_js_1.default.getOrFail();
+    const syncableKeys = Object.keys(psychicApp.openapi).filter(key => psychicApp.openapi[key]?.syncTypes);
+    await Promise.all(syncableKeys.map(key => {
+        const openapiOpts = psychicApp.openapi[key];
+        const jsonPath = openapiOpts.outputFilename;
+        const outpath = path.join((0, psychicPath_js_1.default)('types'), `${jsonPath.replace(/\.json$/, '')}.d.ts`);
+        return dream_1.DreamCLI.spawn(`npx openapi-typescript ${jsonPath} -o ${outpath}`).then(async () => {
+            const file = (await fs.readFile(outpath)).toString();
+            const exportName = (0, dream_1.camelize)(jsonPath
+                .split('/')
+                .at(-1)
+                ?.replace(/\.json/, '')) + 'Paths';
+            await fs.writeFile(outpath, file.replace(/export interface paths/, `export interface ${exportName}`));
+        });
+    }));
+}

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

@@ -39,6 +39,7 @@ const index_js_2 = __importDefault(require("../server/index.js"));
 const enumsFileStr_js_1 = __importDefault(require("./helpers/enumsFileStr.js"));
 const generateRouteTypes_js_1 = __importDefault(require("./helpers/generateRouteTypes.js"));
 const printRoutes_js_1 = __importDefault(require("./helpers/printRoutes.js"));
+const syncTypescriptOpenapiFiles_js_1 = __importDefault(require("./helpers/syncTypescriptOpenapiFiles.js"));
 class PsychicBin {
     static async generateController(controllerName, actions) {
         await (0, controller_js_1.default)({ fullyQualifiedControllerName: controllerName, actions });
@@ -71,7 +72,7 @@ class PsychicBin {
         await PsychicBin.syncOpenapiJson();
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         let output = {};
-        for (const hook of psychicApp.specialHooks.sync) {
+        for (const hook of psychicApp.specialHooks.cliSync) {
             // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
             const res = await hook();
             if ((0, typechecks_js_1.isObject)(res)) {
@@ -82,6 +83,7 @@ class PsychicBin {
         if (Object.keys(output).length) {
             await PsychicBin.syncTypes(output);
         }
+        await this.syncTypescriptOpenapiFiles();
     }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     static async syncTypes(customTypes = undefined) {
@@ -89,6 +91,11 @@ class PsychicBin {
         await TypesBuilder_js_1.default.sync(customTypes);
         dream_1.DreamCLI.logger.logEndProgress();
     }
+    static async syncTypescriptOpenapiFiles() {
+        dream_1.DreamCLI.logger.logStartProgress(`syncing openapi types...`);
+        await (0, syncTypescriptOpenapiFiles_js_1.default)();
+        dream_1.DreamCLI.logger.logEndProgress();
+    }
     static async syncOpenapiJson() {
         dream_1.DreamCLI.logger.logStartProgress(`syncing openapi...`);
         await app_js_1.default.sync();

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

@@ -7,6 +7,7 @@ const dream_1 = require("@rvoh/dream");
 const index_js_1 = __importDefault(require("../bin/index.js"));
 const reduxBindings_js_1 = __importDefault(require("../generate/openapi/reduxBindings.js"));
 const syncEnums_js_1 = __importDefault(require("../generate/initializer/syncEnums.js"));
+const syncOpenapiTypescript_js_1 = __importDefault(require("../generate/initializer/syncOpenapiTypescript.js"));
 class PsychicCLI {
     static provide(program, { initializePsychicApp, seedDb, }) {
         dream_1.DreamCLI.generateDreamCli(program, {
@@ -40,8 +41,17 @@ class PsychicCLI {
             process.exit();
         });
         program
-            .command('generate:openapi:redux')
-            .alias('g:openapi:redux')
+            .command('setup:sync:enums')
+            .description('generates an initializer in your app for syncing enums to a particular path.')
+            .argument('<outfile>', 'the path from your backend directory to the location which you want the enums copied. Should end with .ts, i.e. "../client/src/api/enums.ts"')
+            .option('--initializer-filename', 'the name you want the file to be in your initializers folder. defaults to `sync-enums.ts`')
+            .action(async (outfile, { initializerName, }) => {
+            await initializePsychicApp();
+            await (0, syncEnums_js_1.default)(outfile, initializerName);
+            process.exit();
+        });
+        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('--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')
@@ -60,14 +70,14 @@ class PsychicCLI {
             process.exit();
         });
         program
-            .command('generate:initializer:sync-enums')
-            .alias('g:initializer:sync-enums')
-            .description('generates an initializer in your app for syncing enums to a particular path.')
-            .argument('<outfile>', 'the path from your backend directory to the location which you want the enums copied. Should end with .ts, i.e. "../client/src/api/enums.ts"')
-            .option('--initializer-filename', 'the name you want the file to be in your initializers folder. defaults to `sync-enums.ts`')
-            .action(async (outfile, { initializerName, }) => {
+            .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('<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, }) => {
             await initializePsychicApp();
-            await (0, syncEnums_js_1.default)(outfile, initializerName);
+            await (0, syncOpenapiTypescript_js_1.default)(openapiFilepath, outfile, initializerName);
             process.exit();
         });
         program

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

@@ -65,7 +65,7 @@ export const ${apiImport} = createApi({
   keepUnusedDataFor: 0,
 
   baseQuery: fetchBaseQuery({
-    baseUrl: baseURL(),
+    baseUrl: baseUrl(),
     credentials: 'include',
 
     // we recommend that you use a function like this for preparing

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

@@ -0,0 +1,63 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = generateInitializer;
+const dream_1 = require("@rvoh/dream");
+const fs = __importStar(require("node:fs/promises"));
+const path = __importStar(require("node:path"));
+const psychicPath_js_1 = __importDefault(require("../../../helpers/path/psychicPath.js"));
+async function generateInitializer(openapiFilepath, outfile, initializerFilename) {
+    if (!/\.d\.ts$/.test(outfile))
+        throw new Error(`outfile must have extension .d.ts`);
+    const initializerFilenameWithoutExtension = initializerFilename.replace(/\.ts$/, '');
+    const hyphenized = (0, dream_1.hyphenize)(initializerFilenameWithoutExtension);
+    const destDir = path.join((0, psychicPath_js_1.default)('conf'), 'initializers');
+    const initializerPath = path.join(destDir, `${initializerFilenameWithoutExtension}.ts`);
+    try {
+        await fs.access(destDir);
+    }
+    catch {
+        await fs.mkdir(destDir, { recursive: true });
+    }
+    const contents = `\
+import { DreamCLI } from '@rvoh/dream'
+import { PsychicApp } from "@rvoh/psychic"
+import AppEnv from '../AppEnv.js'
+
+export default (psy: PsychicApp) => {
+  psy.on('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 fs.writeFile(initializerPath, contents);
+}

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

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = installOpenapiTypescript;
+const dream_1 = require("@rvoh/dream");
+const PackageManager_js_1 = __importDefault(require("../../../cli/helpers/PackageManager.js"));
+const EnvInternal_js_1 = __importDefault(require("../../../helpers/EnvInternal.js"));
+async function installOpenapiTypescript() {
+    if (EnvInternal_js_1.default.isTest)
+        return;
+    const cmd = PackageManager_js_1.default.add('openapi-typescript', { dev: true });
+    try {
+        await dream_1.DreamCLI.spawn(cmd);
+    }
+    catch (err) {
+        console.log(`Failed to install openapi-typescript as a dev dependency. Please make sure the following command succeeds:
+
+"${cmd}"
+`);
+    }
+}

package/dist/cjs/src/generate/initializer/syncOpenapiTypescript.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = generateSyncOpenapiTypescriptInitializer;
+const generateInitializer_js_1 = __importDefault(require("../helpers/syncOpenapiTypescript/generateInitializer.js"));
+const installOpenapiTypescript_js_1 = __importDefault(require("../helpers/syncOpenapiTypescript/installOpenapiTypescript.js"));
+async function generateSyncOpenapiTypescriptInitializer(openapiFilepath, outfile, initializerFilename = 'sync-openapi-typescript.ts') {
+    await (0, generateInitializer_js_1.default)(openapiFilepath, outfile, initializerFilename);
+    await (0, installOpenapiTypescript_js_1.default)();
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -15,6 +15,8 @@ const openapiRoute_js_1 = __importDefault(require("./helpers/openapiRoute.js"));
 const primitiveOpenapiStatementToOpenapi_js_1 = __importDefault(require("./helpers/primitiveOpenapiStatementToOpenapi.js"));
 const serializer_js_1 = __importDefault(require("./serializer.js"));
 const FailedToLookupSerializerForEndpoint_js_1 = __importDefault(require("../error/openapi/FailedToLookupSerializerForEndpoint.js"));
+const pageParamOpenapiProperty_js_1 = __importDefault(require("./helpers/pageParamOpenapiProperty.js"));
+const safelyAttachPaginationParamsToBodySegment_js_1 = __importDefault(require("./helpers/safelyAttachPaginationParamsToBodySegment.js"));
 class OpenapiEndpointRenderer {
     dreamsOrSerializers;
     controllerClass;
@@ -299,7 +301,7 @@ class OpenapiEndpointRenderer {
      * "parameters" field for a single endpoint.
      */
     queryArray(openapiName) {
-        return (Object.keys(this.query || {}).map((queryName) => {
+        const queryParams = Object.keys(this.query || {}).map((queryName) => {
             const queryParam = this.query[queryName];
             let output = {
                 in: 'query',
@@ -325,7 +327,21 @@ class OpenapiEndpointRenderer {
                 };
             }
             return output;
-        }) || []);
+        }) || [];
+        const paginationName = this.paginate?.query;
+        if (paginationName) {
+            queryParams.push({
+                in: 'query',
+                required: false,
+                name: paginationName,
+                description: 'Page number',
+                allowReserved: true,
+                schema: {
+                    type: 'string',
+                },
+            });
+        }
+        return queryParams;
     }
     /**
      * @internal
@@ -335,17 +351,22 @@ class OpenapiEndpointRenderer {
     computedRequestBody(openapiName, processedSchemas, routes) {
         const method = this.computedMethod(routes);
         if (this.requestBody === null)
-            return undefined;
+            return this.defaultRequestBody();
         const httpMethodsThatAllowBody = ['post', 'patch', 'put'];
         if (!httpMethodsThatAllowBody.includes(method))
-            return undefined;
+            return this.defaultRequestBody();
         if (this.shouldAutogenerateBody()) {
             return this.generateRequestBodyForModel(openapiName, processedSchemas);
         }
         // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-        const schema = this.recursivelyParseBody(openapiName, this.requestBody, processedSchemas, {
+        let schema = this.recursivelyParseBody(openapiName, this.requestBody, processedSchemas, {
             target: 'request',
         });
+        const bodyPageParam = this.paginate?.body;
+        if (bodyPageParam) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            schema = (0, safelyAttachPaginationParamsToBodySegment_js_1.default)(bodyPageParam, schema);
+        }
         if (!schema)
             return undefined;
         return {
@@ -357,6 +378,24 @@ class OpenapiEndpointRenderer {
             },
         };
     }
+    defaultRequestBody() {
+        const bodyPageParam = this.paginate?.body;
+        if (bodyPageParam) {
+            return {
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                [bodyPageParam]: (0, pageParamOpenapiProperty_js_1.default)(),
+                            },
+                        },
+                    },
+                },
+            };
+        }
+        return undefined;
+    }
     /**
      * @internal
      *
@@ -390,7 +429,7 @@ class OpenapiEndpointRenderer {
         const forDreamClass = this.requestBody?.for;
         const dreamClass = forDreamClass || this.getSingleDreamModelClass();
         if (!dreamClass)
-            return undefined;
+            return this.defaultRequestBody();
         let paramSafeColumns = dreamClass.paramSafeColumnsOrFallback();
         const only = this.requestBody?.only;
         if (only) {
@@ -541,12 +580,17 @@ class OpenapiEndpointRenderer {
                     }
             }
         }
+        let processedSchema = this.recursivelyParseBody(openapiName, paramsShape, processedSchemas, {
+            target: 'request',
+        });
+        const bodyPageParam = this.paginate?.body;
+        if (bodyPageParam) {
+            processedSchema = (0, safelyAttachPaginationParamsToBodySegment_js_1.default)(bodyPageParam, processedSchema);
+        }
         return {
             content: {
                 'application/json': {
-                    schema: this.recursivelyParseBody(openapiName, paramsShape, processedSchemas, {
-                        target: 'request',
-                    }),
+                    schema: processedSchema,
                 },
             },
         };

package/dist/cjs/src/openapi-renderer/helpers/pageParamOpenapiProperty.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = openapiPageParamProperty;
+function openapiPageParamProperty() {
+    return {
+        type: 'integer',
+        description: 'Page number',
+    };
+}

package/dist/cjs/src/openapi-renderer/helpers/safelyAttachPaginationParamsToBodySegment.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = safelyAttachPaginationParamToRequestBodySegment;
+const pageParamOpenapiProperty_js_1 = __importDefault(require("./pageParamOpenapiProperty.js"));
+/**
+ * @internal
+ *
+ * Used to carefully bind implicit pagination params
+ * to the requestBody properties. It will not apply
+ * the pagination param unless the provided bodySegment
+ * is:
+ *
+ * a.) falsey (null, undefined, etc...)
+ * b.) an openapi object (must have { type: 'object'})
+ *
+ * If neither of these apply, it will simply return
+ * what was given to it, without any modifications
+ */
+function safelyAttachPaginationParamToRequestBodySegment(paramName, bodySegment) {
+    bodySegment ||= {
+        type: 'object',
+        properties: {},
+    };
+    if (bodySegment.type === 'object') {
+        ;
+        bodySegment.properties = {
+            ...bodySegment.properties,
+            [paramName]: (0, pageParamOpenapiProperty_js_1.default)(),
+        };
+    }
+    return bodySegment;
+}

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

@@ -220,19 +220,10 @@ Try setting it to something valid, like:
     get inflections() {
         return this._inflections;
     }
-    _bootHooks = {
-        boot: [],
-        load: [],
-        'load:dev': [],
-        'load:test': [],
-        'load:prod': [],
-    };
-    get bootHooks() {
-        return this._bootHooks;
-    }
     _specialHooks = {
-        sync: [],
-        serverInit: [],
+        cliSync: [],
+        serverInitBeforeMiddleware: [],
+        serverInitAfterMiddleware: [],
         serverInitAfterRoutes: [],
         serverStart: [],
         serverError: [],
@@ -297,18 +288,6 @@ Try setting it to something valid, like:
         if (this.booted && !force)
             return;
         // await new IntegrityChecker().check()
-        await this.runHooksFor('load');
-        switch (EnvInternal_js_1.default.nodeEnv) {
-            case 'development':
-                await this.runHooksFor('load:dev');
-                break;
-            case 'production':
-                await this.runHooksFor('load:prod');
-                break;
-            case 'test':
-                await this.runHooksFor('load:test');
-                break;
-        }
         await this.inflections?.();
         this.booted = true;
     }
@@ -320,8 +299,11 @@ Try setting it to something valid, like:
             case 'server:error':
                 this._specialHooks.serverError.push(cb);
                 break;
-            case 'server:init':
-                this._specialHooks.serverInit.push(cb);
+            case 'server:init:before-middleware':
+                this._specialHooks.serverInitBeforeMiddleware.push(cb);
+                break;
+            case 'server:init:after-middleware':
+                this._specialHooks.serverInitAfterMiddleware.push(cb);
                 break;
             case 'server:start':
                 this._specialHooks.serverStart.push(cb);
@@ -332,12 +314,10 @@ Try setting it to something valid, like:
             case 'server:init:after-routes':
                 this._specialHooks.serverInitAfterRoutes.push(cb);
                 break;
-            case 'sync':
+            case 'cli:sync':
                 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                this._specialHooks['sync'].push(cb);
+                this._specialHooks['cliSync'].push(cb);
                 break;
-            default:
-                this.bootHooks[hookEventType].push(cb);
         }
     }
     set(option, unknown1, unknown2) {
@@ -429,11 +409,6 @@ Try setting it to something valid, like:
                 this.overrides['server:start'] = value;
         }
     }
-    async runHooksFor(hookEventType) {
-        for (const hook of this.bootHooks[hookEventType]) {
-            await hook(this);
-        }
-    }
 }
 exports.default = PsychicApp;
 exports.PsychicAppAllowedPackageManagersEnumValues = ['yarn', 'npm', 'pnpm'];

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

@@ -73,7 +73,9 @@ class PsychicServer {
             });
             next();
         });
-        await this.config['runHooksFor']('boot');
+        for (const serverInitBeforeMiddlewareHook of this.config.specialHooks.serverInitBeforeMiddleware) {
+            await serverInitBeforeMiddlewareHook(this);
+        }
         this.initializeCors();
         this.initializeJSON();
         try {
@@ -87,8 +89,8 @@ class PsychicServer {
           ${error.message}
       `);
         }
-        for (const expressInitHook of this.config.specialHooks.serverInit) {
-            await expressInitHook(this);
+        for (const serverInitAfterMiddlewareHook of this.config.specialHooks.serverInitAfterMiddleware) {
+            await serverInitAfterMiddlewareHook(this);
         }
         this.initializeOpenapiValidation();
         await this.buildRoutes();

package/dist/esm/src/bin/helpers/syncTypescriptOpenapiFiles.js

@@ -0,0 +1,22 @@
+import { camelize, DreamCLI } from '@rvoh/dream';
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+import PsychicApp from '../../psychic-app/index.js';
+import psychicPath from '../../helpers/path/psychicPath.js';
+export default async function syncTypescriptOpenapiFiles() {
+    const psychicApp = PsychicApp.getOrFail();
+    const syncableKeys = Object.keys(psychicApp.openapi).filter(key => psychicApp.openapi[key]?.syncTypes);
+    await Promise.all(syncableKeys.map(key => {
+        const openapiOpts = psychicApp.openapi[key];
+        const jsonPath = openapiOpts.outputFilename;
+        const outpath = path.join(psychicPath('types'), `${jsonPath.replace(/\.json$/, '')}.d.ts`);
+        return DreamCLI.spawn(`npx openapi-typescript ${jsonPath} -o ${outpath}`).then(async () => {
+            const file = (await fs.readFile(outpath)).toString();
+            const exportName = camelize(jsonPath
+                .split('/')
+                .at(-1)
+                ?.replace(/\.json/, '')) + 'Paths';
+            await fs.writeFile(outpath, file.replace(/export interface paths/, `export interface ${exportName}`));
+        });
+    }));
+}

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

@@ -11,6 +11,7 @@ import PsychicServer from '../server/index.js';
 import enumsFileStr from './helpers/enumsFileStr.js';
 import generateRouteTypes from './helpers/generateRouteTypes.js';
 import printRoutes from './helpers/printRoutes.js';
+import syncTypescriptOpenapiFiles from './helpers/syncTypescriptOpenapiFiles.js';
 export default class PsychicBin {
     static async generateController(controllerName, actions) {
         await generateController({ fullyQualifiedControllerName: controllerName, actions });
@@ -43,7 +44,7 @@ export default class PsychicBin {
         await PsychicBin.syncOpenapiJson();
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         let output = {};
-        for (const hook of psychicApp.specialHooks.sync) {
+        for (const hook of psychicApp.specialHooks.cliSync) {
             // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
             const res = await hook();
             if (isObject(res)) {
@@ -54,6 +55,7 @@ export default class PsychicBin {
         if (Object.keys(output).length) {
             await PsychicBin.syncTypes(output);
         }
+        await this.syncTypescriptOpenapiFiles();
     }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     static async syncTypes(customTypes = undefined) {
@@ -61,6 +63,11 @@ export default class PsychicBin {
         await TypesBuilder.sync(customTypes);
         DreamCLI.logger.logEndProgress();
     }
+    static async syncTypescriptOpenapiFiles() {
+        DreamCLI.logger.logStartProgress(`syncing openapi types...`);
+        await syncTypescriptOpenapiFiles();
+        DreamCLI.logger.logEndProgress();
+    }
     static async syncOpenapiJson() {
         DreamCLI.logger.logStartProgress(`syncing openapi...`);
         await OpenapiAppRenderer.sync();

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

@@ -2,6 +2,7 @@ import { DreamCLI } from '@rvoh/dream';
 import PsychicBin from '../bin/index.js';
 import generateOpenapiReduxBindings from '../generate/openapi/reduxBindings.js';
 import generateSyncEnumsInitializer from '../generate/initializer/syncEnums.js';
+import generateSyncOpenapiTypescriptInitializer from '../generate/initializer/syncOpenapiTypescript.js';
 export default class PsychicCLI {
     static provide(program, { initializePsychicApp, seedDb, }) {
         DreamCLI.generateDreamCli(program, {
@@ -35,8 +36,17 @@ export default class PsychicCLI {
             process.exit();
         });
         program
-            .command('generate:openapi:redux')
-            .alias('g:openapi:redux')
+            .command('setup:sync:enums')
+            .description('generates an initializer in your app for syncing enums to a particular path.')
+            .argument('<outfile>', 'the path from your backend directory to the location which you want the enums copied. Should end with .ts, i.e. "../client/src/api/enums.ts"')
+            .option('--initializer-filename', 'the name you want the file to be in your initializers folder. defaults to `sync-enums.ts`')
+            .action(async (outfile, { initializerName, }) => {
+            await initializePsychicApp();
+            await generateSyncEnumsInitializer(outfile, initializerName);
+            process.exit();
+        });
+        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('--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')
@@ -55,14 +65,14 @@ export default class PsychicCLI {
             process.exit();
         });
         program
-            .command('generate:initializer:sync-enums')
-            .alias('g:initializer:sync-enums')
-            .description('generates an initializer in your app for syncing enums to a particular path.')
-            .argument('<outfile>', 'the path from your backend directory to the location which you want the enums copied. Should end with .ts, i.e. "../client/src/api/enums.ts"')
-            .option('--initializer-filename', 'the name you want the file to be in your initializers folder. defaults to `sync-enums.ts`')
-            .action(async (outfile, { initializerName, }) => {
+            .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('<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, }) => {
             await initializePsychicApp();
-            await generateSyncEnumsInitializer(outfile, initializerName);
+            await generateSyncOpenapiTypescriptInitializer(openapiFilepath, outfile, initializerName);
             process.exit();
         });
         program

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

@@ -39,7 +39,7 @@ export const ${apiImport} = createApi({
   keepUnusedDataFor: 0,
 
   baseQuery: fetchBaseQuery({
-    baseUrl: baseURL(),
+    baseUrl: baseUrl(),
     credentials: 'include',
 
     // we recommend that you use a function like this for preparing