@rvoh/psychic 0.24.1

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

@@ -0,0 +1,73 @@
+import { DreamCLI } from '@rvoh/dream';
+import PsychicBin from '../bin/index.js';
+import EnvInternal from '../helpers/EnvInternal.js';
+export default class PsychicCLI {
+    static provide(program, { initializePsychicApplication, seedDb, }) {
+        DreamCLI.generateDreamCli(program, {
+            initializeDreamApplication: initializePsychicApplication,
+            seedDb,
+            onSync: async () => {
+                await PsychicBin.sync({ bypassDreamSync: true });
+            },
+        });
+        program
+            .command('generate:resource')
+            .alias('g:resource')
+            .description('create a Dream model, migration, controller, serializer, and spec placeholders')
+            .argument('<path>', 'URL path from root domain')
+            .argument('<modelName>', 'the name of the model to create, e.g. Post or Settings/CommunicationPreferences')
+            .argument('[columnsWithTypes...]', 'properties of the model property1:text/string/enum/etc. property2:text/string/enum/etc. ... propertyN:text/string/enum/etc.')
+            .action(async (route, modelName, columnsWithTypes) => {
+            EnvInternal.provideDefaultNodeEnv('test');
+            await initializePsychicApplication();
+            await PsychicBin.generateResource(route, modelName, columnsWithTypes);
+            process.exit();
+        });
+        program
+            .command('generate:controller')
+            .alias('g:controller')
+            .description('create a controller')
+            .argument('<controllerName>', 'the name of the controller to create, including namespaces, e.g. Posts or Api/V1/Posts')
+            .argument('[actions...]', 'the names of controller actions to create')
+            .action(async (controllerName, actions) => {
+            EnvInternal.provideDefaultNodeEnv('test');
+            await initializePsychicApplication();
+            await PsychicBin.generateController(controllerName, actions);
+            process.exit();
+        });
+        program
+            .command('routes')
+            .description('examines your current models, building a type-map of the associations so that the ORM can understand your relational setup. This is commited to your repo, and synced to the dream repo for consumption within the underlying library.')
+            .action(async () => {
+            EnvInternal.provideDefaultNodeEnv('test');
+            await initializePsychicApplication();
+            await PsychicBin.routes();
+            process.exit();
+        });
+        program
+            .command('sync')
+            .description('sync introspects your database, updating your schema to reflect, and then syncs the new schema with the installed dream node module, allowing it provide your schema to the underlying kysely integration')
+            .action(async () => {
+            EnvInternal.provideDefaultNodeEnv('test');
+            await initializePsychicApplication();
+            await PsychicBin.sync();
+            process.exit();
+        });
+        program
+            .command('sync:routes')
+            .description('reads the routes generated by your app and generates a cache file, which is then used to give autocomplete support to the route helper, amoongst other things.')
+            .action(async () => {
+            EnvInternal.provideDefaultNodeEnv('test');
+            await PsychicBin.syncRoutes();
+        });
+        program
+            .command('sync:openapi')
+            .description('syncs openapi.json file to current state of all psychic controllers within the app')
+            .action(async () => {
+            EnvInternal.provideDefaultNodeEnv('test');
+            await initializePsychicApplication();
+            await PsychicBin.syncOpenapiJson();
+            process.exit();
+        });
+    }
+}

package/dist/esm/src/controller/decorators.js

@@ -0,0 +1,81 @@
+import OpenapiEndpointRenderer from '../openapi-renderer/endpoint.js';
+import { ControllerHook } from './hooks.js';
+export function BeforeAction(opts = {}) {
+    return function (_, context) {
+        const methodName = context.name;
+        context.addInitializer(function () {
+            const psychicControllerClass = this.constructor;
+            if (!psychicControllerClass['globallyInitializingDecorators']) {
+                return;
+            }
+            if (!Object.getOwnPropertyDescriptor(psychicControllerClass, 'controllerHooks'))
+                psychicControllerClass.controllerHooks = [...psychicControllerClass.controllerHooks];
+            psychicControllerClass.controllerHooks.push(new ControllerHook(psychicControllerClass.name, methodName.toString(), opts));
+        });
+    };
+}
+/**
+ * Used to annotate your controller method in a way that enables
+ * Psychic to automatically generate an openapi spec for you. Using
+ * this feature, you can easily document your api in typescript, taking
+ * advantage of powerful type completion and validation, as well as useful
+ * shorthand notation to keep annotations simple when possible.
+ *
+ * @param modelOrSerializer - a function which immediately returns either a serializer class, a dream model class, or else something that has a serializers getter on it.
+ * @param body - Optional. The shape of the request body
+ * @param headers - Optional. The list of request headers to provide for this endpoint
+ * @param many - Optional. whether or not to render a top level array for this serializer
+ * @param method - The HTTP method to use when hitting this endpoint
+ * @param path - Optional. If passed, this path will be used as the request path. If not, it will be looked up in the conf/routes.ts file.
+ * @param query - Optional. A list of query params to provide for this endpoint
+ * @param responses - Optional. A list of additional responses that your app may return
+ * @param serializerKey - Optional. Use this to override the serializer key to use when looking up a serializer by the provided model or view model.
+ * @param status - Optional. The status code this endpoint uses when responding successfully. If not passed, 200 is assummed.
+ * @param tags - Optional. string array
+ * @param uri - Optional. A list of uri segments that this endpoint uses
+ */
+export function OpenAPI(modelOrSerializer, opts) {
+    return function (_, context) {
+        const methodName = context.name;
+        context.addInitializer(function () {
+            const psychicControllerClass = this.constructor;
+            if (!psychicControllerClass['globallyInitializingDecorators']) {
+                return;
+            }
+            const methodNameString = methodName.toString();
+            if (!Object.getOwnPropertyDescriptor(psychicControllerClass, 'openapi'))
+                psychicControllerClass.openapi = {};
+            if (!Object.getOwnPropertyDescriptor(psychicControllerClass, 'controllerActionMetadata'))
+                psychicControllerClass['controllerActionMetadata'] = {};
+            if (opts) {
+                psychicControllerClass.openapi[methodNameString] = new OpenapiEndpointRenderer(modelOrSerializer, psychicControllerClass, methodNameString, opts);
+                psychicControllerClass['controllerActionMetadata'][methodNameString] ||= {};
+                psychicControllerClass['controllerActionMetadata'][methodNameString]['serializerKey'] =
+                    opts.serializerKey;
+                //
+            }
+            else {
+                if (isSerializable(modelOrSerializer)) {
+                    psychicControllerClass.openapi[methodNameString] = new OpenapiEndpointRenderer(modelOrSerializer, psychicControllerClass, methodNameString, undefined);
+                }
+                else {
+                    psychicControllerClass.openapi[methodNameString] = new OpenapiEndpointRenderer(null, psychicControllerClass, methodNameString, modelOrSerializer);
+                }
+            }
+        });
+    };
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function isSerializable(dreamOrSerializerClass) {
+    return (Array.isArray(dreamOrSerializerClass) ||
+        hasSerializersGetter(dreamOrSerializerClass) ||
+        !!dreamOrSerializerClass?.isDreamSerializer);
+}
+function hasSerializersGetter(dreamOrSerializerClass) {
+    try {
+        return !!dreamOrSerializerClass?.prototype?.serializers;
+    }
+    catch {
+        return false;
+    }
+}

package/dist/esm/src/controller/hooks.js

@@ -0,0 +1,25 @@
+export class ControllerHook {
+    controllerClassName;
+    methodName;
+    isStatic;
+    only;
+    except;
+    constructor(controllerClassName, methodName, { isStatic = false, only = [], except = [], }) {
+        this.controllerClassName = controllerClassName;
+        this.methodName = methodName;
+        this.isStatic = isStatic;
+        this.only = only;
+        this.except = except;
+    }
+    shouldFireForAction(actionName) {
+        if (!!this.only.length && this.only.includes(actionName))
+            return true;
+        if (!!this.only.length && !this.only.includes(actionName))
+            return false;
+        if (!!this.except.length && this.except.includes(actionName))
+            return false;
+        if (!!this.except.length && !this.except.includes(actionName))
+            return true;
+        return true;
+    }
+}