@rvoh/psychic 1.6.3 → 1.6.4

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.6.4
+
+Raise an exception if attempting to import an openapi file during PsychicApp.init when in production. We will still swallow the exception in non-prod environments so that one can create a new openapi configuration and run sync without getting an error.
+
 ## 1.6.3
 
 - castParam accepts raw openapi shapes as type arguments, correctly casting the result to an interface representing the provided openapi shape.

package/dist/cjs/src/error/openapi/OpenapiFileNotFound.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class OpenapiFileNotFound extends Error {
+    openapiName;
+    openapiPath;
+    constructor(openapiName, openapiPath) {
+        super();
+        this.openapiName = openapiName;
+        this.openapiPath = openapiPath;
+    }
+    get message() {
+        return `
+      Failed to read openapi file during psychic app initialization.
+
+        openapiName: ${this.openapiName}
+        openapi file path: ${this.openapiPath}
+
+      Typically, this occurs when you build your application to production,
+      but fail to copy over your openapi json files as part of the production
+      build. Be sure that your "build" script in your package.json correctly
+      copies the openapi dir over, e.g.
+
+        "build": "... && cp -R ./${this.openapiPath} ./dist/${this.openapiPath}"
+    `;
+    }
+}
+exports.default = OpenapiFileNotFound;

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

@@ -50,7 +50,7 @@ class OpenapiPayloadValidator {
         const routes = index_js_1.default.getOrFail().routesCache;
         if (openapiEndpointRenderer.shouldValidateRequestBody(openapiName)) {
             const openapiPathObject = openapiEndpointRenderer['computedRequestBody'](routes, {
-                openapiName: 'default',
+                openapiName,
                 renderOpts: this.renderOpts,
             });
             const requestBodySchema = openapiPathObject?.['content']?.['application/json']?.['schema'];
@@ -101,7 +101,7 @@ class OpenapiPayloadValidator {
         const openapiName = this.openapiName;
         if (openapiEndpointRenderer.shouldValidateQuery(openapiName)) {
             const openapiQueryParams = openapiEndpointRenderer['queryArray']({
-                openapiName: 'default',
+                openapiName,
                 renderOpts: this.renderOpts,
             });
             this.validateOrFail(query, this.openapiParameterResponsesToSchemaObject(openapiQueryParams), 'query');
@@ -126,7 +126,7 @@ class OpenapiPayloadValidator {
         const openapiName = this.openapiName;
         if (openapiEndpointRenderer.shouldValidateResponseBody(openapiName)) {
             const openapiResponseBody = openapiEndpointRenderer['parseResponses']({
-                openapiName: this.openapiName,
+                openapiName,
                 renderOpts: this.renderOpts,
             }).openapi?.[statusCode.toString()];
             const schema = openapiResponseBody?.['content']?.['application/json']?.['schema'];

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

@@ -129,9 +129,18 @@ class PsychicApp {
      * instead of having to build it from scratch.
      */
     async buildOpenapiCache() {
-        await Promise.all(Object.keys(this.openapi).map(async (openapiName) => {
+        // build caches for all files that are registered for validation
+        await Promise.all(Object.keys(this.openapi)
+            .filter(key => this.openapi[key]?.validate)
+            .map(async (openapiName) => {
             await this.cacheOpenapiFile(openapiName);
         }));
+        // ignore all files that are not registered for validation
+        Object.keys(this.openapi)
+            .filter(key => !this.openapi[key]?.validate)
+            .forEach(openapiName => {
+            this.ignoreOpenapiFile(openapiName);
+        });
     }
     /**
      * Since javascript is inherently vulnerable to circular dependencies,
@@ -295,6 +304,16 @@ Try setting it to something valid, like:
     async cacheOpenapiFile(openapiName) {
         await (0, openapi_cache_js_1.readAndCacheOpenapiFile)(openapiName);
     }
+    /**
+     * indicates to the underlying cache that this openapi file is intentionally
+     * being ignored, so that future lookups for the file cache do not raise
+     * an exception
+     *
+     * @param openapiName - the openapiName to ignore
+     */
+    ignoreOpenapiFile(openapiName) {
+        (0, openapi_cache_js_1.ignoreOpenapiFile)(openapiName);
+    }
     /**
      * @internal
      *

package/dist/cjs/src/psychic-app/openapi-cache.js

@@ -28,9 +28,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOpenapiFileOrFail = getOpenapiFileOrFail;
 exports.readAndCacheOpenapiFile = readAndCacheOpenapiFile;
+exports.ignoreOpenapiFile = ignoreOpenapiFile;
 const fs = __importStar(require("node:fs/promises"));
 const openapiJsonPath_js_1 = __importDefault(require("../helpers/openapiJsonPath.js"));
 const must_call_psychic_app_init_first_js_1 = __importDefault(require("../error/psychic-app/must-call-psychic-app-init-first.js"));
+const EnvInternal_js_1 = __importDefault(require("../helpers/EnvInternal.js"));
+const OpenapiFileNotFound_js_1 = __importDefault(require("../error/openapi/OpenapiFileNotFound.js"));
 const _openapiData = {};
 /**
  * Raises an exception if readAndCacheOpenapiFile was not called
@@ -43,7 +46,7 @@ function getOpenapiFileOrFail(openapiName) {
     const val = _openapiData[openapiName];
     if (!val)
         throw new must_call_psychic_app_init_first_js_1.default();
-    if (val === FILE_DOES_NOT_EXIST)
+    if (val === FILE_DOES_NOT_EXIST || val === FILE_WAS_IGNORED)
         return undefined;
     return val;
 }
@@ -59,10 +62,9 @@ function getOpenapiFileOrFail(openapiName) {
 async function readAndCacheOpenapiFile(openapiName) {
     if (_openapiData[openapiName])
         return;
-    // if the openapi file is not generated yet, we don't want to raise an
-    // exception, so we will simply consider this file as undefined.
+    const openapiPath = (0, openapiJsonPath_js_1.default)(openapiName);
     try {
-        const buffer = await fs.readFile((0, openapiJsonPath_js_1.default)(openapiName));
+        const buffer = await fs.readFile(openapiPath);
         const openapiDoc = JSON.parse(buffer.toString());
         //  we only cache the components from the openapi files,
         //  since that is all that we currently need for validation,
@@ -72,8 +74,26 @@ async function readAndCacheOpenapiFile(openapiName) {
             : FILE_DOES_NOT_EXIST;
     }
     catch {
+        if (EnvInternal_js_1.default.isProduction) {
+            throw new OpenapiFileNotFound_js_1.default(openapiName, openapiPath);
+        }
+        // if the openapi file is not generated yet and we are in our local
+        // environment, we don't want to raise an exception, since it could
+        // prevent someone from ever defining a new openapi configuration.
         _openapiData[openapiName] = FILE_DOES_NOT_EXIST;
-        // noop
     }
 }
+/**
+ * Reads the openapi file corresponding to the openapiName,
+ * and caches its contents, enabling them to be read back
+ * at a later time, such as during endpoint validation.
+ *
+ * This function is called during PsychicApp.init sequence automatically.
+ *
+ * @param openapiName - the openapiName you wish to look up
+ */
+function ignoreOpenapiFile(openapiName) {
+    _openapiData[openapiName] = FILE_WAS_IGNORED;
+}
 const FILE_DOES_NOT_EXIST = 'FILE_DOES_NOT_EXIST';
+const FILE_WAS_IGNORED = 'FILE_WAS_IGNORED';

package/dist/esm/src/error/openapi/OpenapiFileNotFound.js

@@ -0,0 +1,24 @@
+export default class OpenapiFileNotFound extends Error {
+    openapiName;
+    openapiPath;
+    constructor(openapiName, openapiPath) {
+        super();
+        this.openapiName = openapiName;
+        this.openapiPath = openapiPath;
+    }
+    get message() {
+        return `
+      Failed to read openapi file during psychic app initialization.
+
+        openapiName: ${this.openapiName}
+        openapi file path: ${this.openapiPath}
+
+      Typically, this occurs when you build your application to production,
+      but fail to copy over your openapi json files as part of the production
+      build. Be sure that your "build" script in your package.json correctly
+      copies the openapi dir over, e.g.
+
+        "build": "... && cp -R ./${this.openapiPath} ./dist/${this.openapiPath}"
+    `;
+    }
+}

package/dist/esm/src/openapi-renderer/helpers/OpenapiPayloadValidator.js

@@ -45,7 +45,7 @@ export default class OpenapiPayloadValidator {
         const routes = PsychicApp.getOrFail().routesCache;
         if (openapiEndpointRenderer.shouldValidateRequestBody(openapiName)) {
             const openapiPathObject = openapiEndpointRenderer['computedRequestBody'](routes, {
-                openapiName: 'default',
+                openapiName,
                 renderOpts: this.renderOpts,
             });
             const requestBodySchema = openapiPathObject?.['content']?.['application/json']?.['schema'];
@@ -96,7 +96,7 @@ export default class OpenapiPayloadValidator {
         const openapiName = this.openapiName;
         if (openapiEndpointRenderer.shouldValidateQuery(openapiName)) {
             const openapiQueryParams = openapiEndpointRenderer['queryArray']({
-                openapiName: 'default',
+                openapiName,
                 renderOpts: this.renderOpts,
             });
             this.validateOrFail(query, this.openapiParameterResponsesToSchemaObject(openapiQueryParams), 'query');
@@ -121,7 +121,7 @@ export default class OpenapiPayloadValidator {
         const openapiName = this.openapiName;
         if (openapiEndpointRenderer.shouldValidateResponseBody(openapiName)) {
             const openapiResponseBody = openapiEndpointRenderer['parseResponses']({
-                openapiName: this.openapiName,
+                openapiName,
                 renderOpts: this.renderOpts,
             }).openapi?.[statusCode.toString()];
             const schema = openapiResponseBody?.['content']?.['application/json']?.['schema'];

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

@@ -13,7 +13,7 @@ import importControllers, { getControllersOrFail } from './helpers/import/import
 import importInitializers, { getInitializersOrBlank } from './helpers/import/importInitializers.js';
 import importServices, { getServicesOrFail } from './helpers/import/importServices.js';
 import lookupClassByGlobalName from './helpers/lookupClassByGlobalName.js';
-import { getOpenapiFileOrFail, readAndCacheOpenapiFile } from './openapi-cache.js';
+import { getOpenapiFileOrFail, ignoreOpenapiFile, readAndCacheOpenapiFile } from './openapi-cache.js';
 export default class PsychicApp {
     /**
      * Called by the initializePsychicApp function, which is built
@@ -100,9 +100,18 @@ export default class PsychicApp {
      * instead of having to build it from scratch.
      */
     async buildOpenapiCache() {
-        await Promise.all(Object.keys(this.openapi).map(async (openapiName) => {
+        // build caches for all files that are registered for validation
+        await Promise.all(Object.keys(this.openapi)
+            .filter(key => this.openapi[key]?.validate)
+            .map(async (openapiName) => {
             await this.cacheOpenapiFile(openapiName);
         }));
+        // ignore all files that are not registered for validation
+        Object.keys(this.openapi)
+            .filter(key => !this.openapi[key]?.validate)
+            .forEach(openapiName => {
+            this.ignoreOpenapiFile(openapiName);
+        });
     }
     /**
      * Since javascript is inherently vulnerable to circular dependencies,
@@ -266,6 +275,16 @@ Try setting it to something valid, like:
     async cacheOpenapiFile(openapiName) {
         await readAndCacheOpenapiFile(openapiName);
     }
+    /**
+     * indicates to the underlying cache that this openapi file is intentionally
+     * being ignored, so that future lookups for the file cache do not raise
+     * an exception
+     *
+     * @param openapiName - the openapiName to ignore
+     */
+    ignoreOpenapiFile(openapiName) {
+        ignoreOpenapiFile(openapiName);
+    }
     /**
      * @internal
      *

package/dist/esm/src/psychic-app/openapi-cache.js

@@ -1,6 +1,8 @@
 import * as fs from 'node:fs/promises';
 import openapiJsonPath from '../helpers/openapiJsonPath.js';
 import MustCallPsychicAppInitFirst from '../error/psychic-app/must-call-psychic-app-init-first.js';
+import EnvInternal from '../helpers/EnvInternal.js';
+import OpenapiFileNotFound from '../error/openapi/OpenapiFileNotFound.js';
 const _openapiData = {};
 /**
  * Raises an exception if readAndCacheOpenapiFile was not called
@@ -13,7 +15,7 @@ export function getOpenapiFileOrFail(openapiName) {
     const val = _openapiData[openapiName];
     if (!val)
         throw new MustCallPsychicAppInitFirst();
-    if (val === FILE_DOES_NOT_EXIST)
+    if (val === FILE_DOES_NOT_EXIST || val === FILE_WAS_IGNORED)
         return undefined;
     return val;
 }
@@ -29,10 +31,9 @@ export function getOpenapiFileOrFail(openapiName) {
 export async function readAndCacheOpenapiFile(openapiName) {
     if (_openapiData[openapiName])
         return;
-    // if the openapi file is not generated yet, we don't want to raise an
-    // exception, so we will simply consider this file as undefined.
+    const openapiPath = openapiJsonPath(openapiName);
     try {
-        const buffer = await fs.readFile(openapiJsonPath(openapiName));
+        const buffer = await fs.readFile(openapiPath);
         const openapiDoc = JSON.parse(buffer.toString());
         //  we only cache the components from the openapi files,
         //  since that is all that we currently need for validation,
@@ -42,8 +43,26 @@ export async function readAndCacheOpenapiFile(openapiName) {
             : FILE_DOES_NOT_EXIST;
     }
     catch {
+        if (EnvInternal.isProduction) {
+            throw new OpenapiFileNotFound(openapiName, openapiPath);
+        }
+        // if the openapi file is not generated yet and we are in our local
+        // environment, we don't want to raise an exception, since it could
+        // prevent someone from ever defining a new openapi configuration.
         _openapiData[openapiName] = FILE_DOES_NOT_EXIST;
-        // noop
     }
 }
+/**
+ * Reads the openapi file corresponding to the openapiName,
+ * and caches its contents, enabling them to be read back
+ * at a later time, such as during endpoint validation.
+ *
+ * This function is called during PsychicApp.init sequence automatically.
+ *
+ * @param openapiName - the openapiName you wish to look up
+ */
+export function ignoreOpenapiFile(openapiName) {
+    _openapiData[openapiName] = FILE_WAS_IGNORED;
+}
 const FILE_DOES_NOT_EXIST = 'FILE_DOES_NOT_EXIST';
+const FILE_WAS_IGNORED = 'FILE_WAS_IGNORED';

package/dist/types/src/error/openapi/OpenapiFileNotFound.d.ts

@@ -0,0 +1,6 @@
+export default class OpenapiFileNotFound extends Error {
+    private openapiName;
+    private openapiPath;
+    constructor(openapiName: string, openapiPath: string);
+    get message(): string;
+}

package/dist/types/src/psychic-app/index.d.ts

@@ -149,7 +149,15 @@ export default class PsychicApp {
      *
      * @param openapiName - the openapiName you want to look up the openapi cache for
      */
-    cacheOpenapiFile(openapiName: string): Promise<void>;
+    private cacheOpenapiFile;
+    /**
+     * indicates to the underlying cache that this openapi file is intentionally
+     * being ignored, so that future lookups for the file cache do not raise
+     * an exception
+     *
+     * @param openapiName - the openapiName to ignore
+     */
+    private ignoreOpenapiFile;
     /**
      * @internal
      *

package/dist/types/src/psychic-app/openapi-cache.d.ts

@@ -26,3 +26,13 @@ export declare function getOpenapiFileOrFail(openapiName: string): OpenapiShell
  * @param openapiName - the openapiName you wish to look up
  */
 export declare function readAndCacheOpenapiFile(openapiName: string): Promise<void>;
+/**
+ * Reads the openapi file corresponding to the openapiName,
+ * and caches its contents, enabling them to be read back
+ * at a later time, such as during endpoint validation.
+ *
+ * This function is called during PsychicApp.init sequence automatically.
+ *
+ * @param openapiName - the openapiName you wish to look up
+ */
+export declare function ignoreOpenapiFile(openapiName: string): void;

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "1.6.3",
+  "version": "1.6.4",
   "author": "RVOHealth",
   "repository": {
     "type": "git",