@rvoh/psychic 1.1.7 → 1.1.8

package/CHANGELOG.md

@@ -66,3 +66,7 @@ Fix route printing regression causing route printouts to show the path instead o
 ## 1.1.7
 
 - Add support for middleware arrays, enabling express plugins like passport
+
+## 1.1.8
+
+- Tap into CliFileWriter provided by dream to tap into file reversion for sync files, since the auto-sync function in psychic can fail and leave your file tree in a bad state.

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

@@ -28,7 +28,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = generateRouteTypes;
 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"));
 async function generateRouteTypes(routes) {
@@ -38,5 +37,5 @@ async function generateRouteTypes(routes) {
   `;
     const psychicApp = index_js_1.default.getOrFail();
     const routeTypesPath = path.join(psychicApp.apiRoot, 'src', 'conf', 'routeTypes.ts');
-    await fs.writeFile(routeTypesPath, fileStr);
+    await dream_1.CliFileWriter.write(routeTypesPath, fileStr);
 }

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

@@ -74,22 +74,15 @@ class PsychicBin {
         dream_1.DreamCLI.logger.logEndProgress();
     }
     static async postSync() {
-        const psychicApp = index_js_1.default.getOrFail();
-        await PsychicBin.syncOpenapiJson();
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        let output = {};
-        for (const hook of psychicApp.specialHooks.cliSync) {
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-            const res = await hook();
-            if ((0, isObject_js_1.default)(res)) {
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-                output = { ...output, ...res };
-            }
+        try {
+            await this.syncOpenapiJson();
+            await this.runCliHooksAndUpdatePsychicTypesFileWithOutput();
+            await this.syncTypescriptOpenapiFiles();
         }
-        if (Object.keys(output).length) {
-            await PsychicBin.syncTypes(output);
+        catch (error) {
+            console.error(error);
+            await dream_1.CliFileWriter.revert();
         }
-        await this.syncTypescriptOpenapiFiles();
     }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     static async syncTypes(customTypes = undefined) {
@@ -125,8 +118,34 @@ class PsychicBin {
         catch {
             // noop
         }
-        await fs.writeFile(outfile, enumsStr, {});
+        await dream_1.CliFileWriter.write(outfile, enumsStr);
         dream_1.DreamCLI.logger.logEndProgress();
     }
+    /**
+     * @internal
+     *
+     * runs all the custom cli hooks provided for the user's application.
+     * if any of the cli hooks returns an object-based output, we will splat
+     * it all together into a single `output` variable, which we then
+     * feed into the `syncTypes` method to provide custom type data.
+     * This enables psychic plugins to add custom types to the psychic type
+     * bindings.
+     */
+    static async runCliHooksAndUpdatePsychicTypesFileWithOutput() {
+        const psychicApp = index_js_1.default.getOrFail();
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        let output = {};
+        for (const hook of psychicApp.specialHooks.cliSync) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            const res = await hook();
+            if ((0, isObject_js_1.default)(res)) {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                output = { ...output, ...res };
+            }
+        }
+        if (Object.keys(output).length) {
+            await PsychicBin.syncTypes(output);
+        }
+    }
 }
 exports.default = PsychicBin;

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

@@ -27,7 +27,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 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"));
 class TypesBuilder {
@@ -35,7 +34,7 @@ class TypesBuilder {
     static async sync(customTypes = undefined) {
         const dreamApp = dream_1.DreamApp.getOrFail();
         const schemaPath = path.join(dreamApp.projectRoot, dreamApp.paths.types, 'psychic.ts');
-        await fs.writeFile(schemaPath, this.build(customTypes));
+        await dream_1.CliFileWriter.write(schemaPath, this.build(customTypes));
     }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     static build(customTypes = undefined) {

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

@@ -1,33 +1,9 @@
 "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 });
 const dream_1 = require("@rvoh/dream");
-const fs = __importStar(require("node:fs/promises"));
 const node_util_1 = require("node:util");
 const UnexpectedUndefined_js_1 = __importDefault(require("../error/UnexpectedUndefined.js"));
 const openapiJsonPath_js_1 = __importDefault(require("../helpers/openapiJsonPath.js"));
@@ -49,9 +25,7 @@ class OpenapiAppRenderer {
         const psychicApp = index_js_1.default.getOrFail();
         const asyncWriteOpenapiFile = async (key) => {
             const jsonPath = (0, openapiJsonPath_js_1.default)(key);
-            await fs.writeFile(jsonPath, JSON.stringify(openapiContents[key], null, 2), {
-                flag: 'w+',
-            });
+            await dream_1.CliFileWriter.write(jsonPath, JSON.stringify(openapiContents[key], null, 2), { flag: 'w+' });
         };
         await Promise.all(Object.keys(psychicApp.openapi).map(key => asyncWriteOpenapiFile(key)));
     }

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

@@ -1,5 +1,4 @@
-import { uniq } from '@rvoh/dream';
-import * as fs from 'node:fs/promises';
+import { CliFileWriter, uniq } from '@rvoh/dream';
 import * as path from 'node:path';
 import PsychicApp from '../../psychic-app/index.js';
 export default async function generateRouteTypes(routes) {
@@ -9,5 +8,5 @@ export default async function generateRouteTypes(routes) {
   `;
     const psychicApp = PsychicApp.getOrFail();
     const routeTypesPath = path.join(psychicApp.apiRoot, 'src', 'conf', 'routeTypes.ts');
-    await fs.writeFile(routeTypesPath, fileStr);
+    await CliFileWriter.write(routeTypesPath, fileStr);
 }

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

@@ -1,4 +1,4 @@
-import { DreamBin, DreamCLI } from '@rvoh/dream';
+import { CliFileWriter, DreamBin, DreamCLI } from '@rvoh/dream';
 import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
 import TypesBuilder from '../cli/helpers/TypesBuilder.js';
@@ -46,22 +46,15 @@ export default class PsychicBin {
         DreamCLI.logger.logEndProgress();
     }
     static async postSync() {
-        const psychicApp = PsychicApp.getOrFail();
-        await PsychicBin.syncOpenapiJson();
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        let output = {};
-        for (const hook of psychicApp.specialHooks.cliSync) {
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-            const res = await hook();
-            if (isObject(res)) {
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-                output = { ...output, ...res };
-            }
+        try {
+            await this.syncOpenapiJson();
+            await this.runCliHooksAndUpdatePsychicTypesFileWithOutput();
+            await this.syncTypescriptOpenapiFiles();
         }
-        if (Object.keys(output).length) {
-            await PsychicBin.syncTypes(output);
+        catch (error) {
+            console.error(error);
+            await CliFileWriter.revert();
         }
-        await this.syncTypescriptOpenapiFiles();
     }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     static async syncTypes(customTypes = undefined) {
@@ -97,7 +90,33 @@ export default class PsychicBin {
         catch {
             // noop
         }
-        await fs.writeFile(outfile, enumsStr, {});
+        await CliFileWriter.write(outfile, enumsStr);
         DreamCLI.logger.logEndProgress();
     }
+    /**
+     * @internal
+     *
+     * runs all the custom cli hooks provided for the user's application.
+     * if any of the cli hooks returns an object-based output, we will splat
+     * it all together into a single `output` variable, which we then
+     * feed into the `syncTypes` method to provide custom type data.
+     * This enables psychic plugins to add custom types to the psychic type
+     * bindings.
+     */
+    static async runCliHooksAndUpdatePsychicTypesFileWithOutput() {
+        const psychicApp = PsychicApp.getOrFail();
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        let output = {};
+        for (const hook of psychicApp.specialHooks.cliSync) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            const res = await hook();
+            if (isObject(res)) {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                output = { ...output, ...res };
+            }
+        }
+        if (Object.keys(output).length) {
+            await PsychicBin.syncTypes(output);
+        }
+    }
 }

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

@@ -1,5 +1,4 @@
-import { DreamApp } from '@rvoh/dream';
-import * as fs from 'node:fs/promises';
+import { CliFileWriter, DreamApp } from '@rvoh/dream';
 import * as path from 'node:path';
 import PsychicApp from '../../psychic-app/index.js';
 export default class TypesBuilder {
@@ -7,7 +6,7 @@ export default class TypesBuilder {
     static async sync(customTypes = undefined) {
         const dreamApp = DreamApp.getOrFail();
         const schemaPath = path.join(dreamApp.projectRoot, dreamApp.paths.types, 'psychic.ts');
-        await fs.writeFile(schemaPath, this.build(customTypes));
+        await CliFileWriter.write(schemaPath, this.build(customTypes));
     }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     static build(customTypes = undefined) {

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

@@ -1,5 +1,4 @@
-import { compact, groupBy, sortObjectByKey } from '@rvoh/dream';
-import * as fs from 'node:fs/promises';
+import { CliFileWriter, compact, groupBy, sortObjectByKey } from '@rvoh/dream';
 import { debuglog } from 'node:util';
 import UnexpectedUndefined from '../error/UnexpectedUndefined.js';
 import openapiJsonPath from '../helpers/openapiJsonPath.js';
@@ -21,9 +20,7 @@ export default class OpenapiAppRenderer {
         const psychicApp = PsychicApp.getOrFail();
         const asyncWriteOpenapiFile = async (key) => {
             const jsonPath = openapiJsonPath(key);
-            await fs.writeFile(jsonPath, JSON.stringify(openapiContents[key], null, 2), {
-                flag: 'w+',
-            });
+            await CliFileWriter.write(jsonPath, JSON.stringify(openapiContents[key], null, 2), { flag: 'w+' });
         };
         await Promise.all(Object.keys(psychicApp.openapi).map(key => asyncWriteOpenapiFile(key)));
     }

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

@@ -17,4 +17,15 @@ export default class PsychicBin {
     static syncOpenapiJson(): Promise<void>;
     static syncRoutes(): Promise<void>;
     static syncClientEnums(outfile: string): Promise<void>;
+    /**
+     * @internal
+     *
+     * runs all the custom cli hooks provided for the user's application.
+     * if any of the cli hooks returns an object-based output, we will splat
+     * it all together into a single `output` variable, which we then
+     * feed into the `syncTypes` method to provide custom type data.
+     * This enables psychic plugins to add custom types to the psychic type
+     * bindings.
+     */
+    private static runCliHooksAndUpdatePsychicTypesFileWithOutput;
 }

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "author": "RVOHealth",
   "repository": {
     "type": "git",
@@ -59,7 +59,7 @@
   "devDependencies": {
     "@eslint/js": "^9.19.0",
     "@jest-mock/express": "^3.0.0",
-    "@rvoh/dream": "^1.0.2",
+    "@rvoh/dream": "^1.1.2",
     "@rvoh/dream-spec-helpers": "^1.0.0",
     "@rvoh/psychic-spec-helpers": "^1.0.0",
     "@types/express": "^5.0.1",

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

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadFile = loadFile;
-exports.writeFile = writeFile;
-const node_fs_1 = require("node:fs");
-async function loadFile(filepath) {
-    return await node_fs_1.promises.readFile(filepath);
-}
-async function writeFile(filepath, contents) {
-    return await node_fs_1.promises.writeFile(filepath, contents);
-}

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

@@ -1,7 +0,0 @@
-import { promises as fs } from 'node:fs';
-export async function loadFile(filepath) {
-    return await fs.readFile(filepath);
-}
-export async function writeFile(filepath, contents) {
-    return await fs.writeFile(filepath, contents);
-}

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

@@ -1,2 +0,0 @@
-export declare function loadFile(filepath: string): Promise<Buffer>;
-export declare function writeFile(filepath: string, contents: string): Promise<void>;