Merge pull request #158 from devforth/next

Next

Author: ivictbor

adminforth/commands/cli.js

@@ -6,17 +6,22 @@ const command = args[0];
 import bundle from "./bundle.js";
 import createApp from "./createApp/main.js";
 import generateModels from "./generateModels.js";
-
+import createPlugin from "./createPlugin/main.js";
 switch (command) {
   case "create-app":
     createApp(args);
     break;
+  case "create-plugin":
+    createPlugin(args);
+    break;
   case "generate-models":
     generateModels();
     break;
   case "bundle":
     bundle();
     break;
   default:
-    console.log("Unknown command. Available commands: create-app, generate-models, bundle");
-}
+    console.log(
+      "Unknown command. Available commands: create-app, create-plugin, generate-models, bundle"
+    );
+}

adminforth/commands/createApp/templates/adminuser.ts.hbs

@@ -1,4 +1,5 @@
-import AdminForth, { AdminForthDataTypes, AdminForthResourceInput } from 'adminforth';
+import AdminForth, { AdminForthDataTypes, AdminForthResourceInput, AdminForthResource, AdminUser } from 'adminforth';
+
 import type { AdminUser } from  'adminforth';
 
 async function canModifyUsers({ adminUser }: { adminUser: AdminUser }): Promise<boolean> {
@@ -86,18 +87,19 @@ export default {
   ],
   hooks: {
     create: {
-      beforeSave: async ({ record, adminUser, resource }) => {
-        record.password_hash = await AdminForth.Utils.generatePasswordHash(record.password);
+      beforeSave: async ({ record, adminUser, resource }: { record: any, adminUser: AdminUser, resource: AdminForthResource }) => {
+        record.passwordHash = await AdminForth.Utils.generatePasswordHash(record.password);
         return { ok: true };
       }
     },
     edit: {
-      beforeSave: async ({ record, adminUser, resource }) => {
-        if (record.password) {
-          record.password_hash = await AdminForth.Utils.generatePasswordHash(record.password);
+      beforeSave: async ({ updates, adminUser, resource }: { updates: any, adminUser: AdminUser, resource: AdminForthResource }) => {
+        console.log('Updating user', updates);
+        if (updates.password) {
+          updates.passwordHash = await AdminForth.Utils.generatePasswordHash(updates.password);
         }
         return { ok: true }
       },
     },
-  }
+  },
 } as AdminForthResourceInput;

adminforth/commands/createApp/templates/index.ts.hbs

@@ -77,7 +77,6 @@ if (import.meta.url === `file://${process.argv[1]}`) {
   });
 
   admin.express.listen(port, () => {
-    console.log(`Example app listening at http://localhost:${port}`);
     console.log(`\n⚡ AdminForth is available at http://localhost:${port}${ADMIN_BASE_URL}\n`);
   });
 }

adminforth/commands/createPlugin/main.js

@@ -0,0 +1,26 @@
+import chalk from "chalk";
+
+import {
+  parseArgumentsIntoOptions,
+  prepareWorkflow,
+  promptForMissingOptions,
+} from "./utils.js";
+
+export default async function createPlugin(args) {
+  // Step 1: Parse CLI arguments with `arg`
+  let options = parseArgumentsIntoOptions(args);
+
+  // Step 2: Ask for missing arguments via `inquirer`
+  options = await promptForMissingOptions(options);
+
+  // Step 3: Prepare a Listr-based workflow
+  const tasks = prepareWorkflow(options);
+
+  // Step 4: Run tasks
+  try {
+    await tasks.run();
+  } catch (err) {
+    console.error(chalk.red(`\n❌  ${err.message}\n`));
+    process.exit(1);
+  }
+}

adminforth/commands/createPlugin/templates/.gitignore.hbs

@@ -0,0 +1,3 @@
+node_modules
+custom/node_modules
+dist

adminforth/commands/createPlugin/templates/custom/tsconfig.json.hbs

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".", // This should point to your project root
+    "paths": {
+      "@/*": [
+        // "node_modules/adminforth/dist/spa/src/*"
+        "../../../spa/src/*"
+      ],
+      "*": [
+        // "node_modules/adminforth/dist/spa/node_modules/*"
+        "../../../spa/node_modules/*"
+      ],
+      "@@/*": [
+        // "node_modules/adminforth/dist/spa/src/*"
+        "."
+      ]
+    }
+  }
+}

adminforth/commands/createPlugin/templates/index.ts.hbs

@@ -0,0 +1,41 @@
+import { AdminForthPlugin } from "adminforth";
+import type { IAdminForth, IHttpServer, AdminForthResourcePages, AdminForthResourceColumn, AdminForthDataTypes, AdminForthResource } from "adminforth";
+import type { PluginOptions } from './types.js';
+
+
+export default class ChatGptPlugin extends AdminForthPlugin {
+  options: PluginOptions;
+
+  constructor(options: PluginOptions) {
+    super(options, import.meta.url);
+    this.options = options;
+  }
+
+  async modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
+    super.modifyResourceConfig(adminforth, resourceConfig);
+  
+    // simply modify resourceConfig or adminforth.config. You can get access to plugin options via this.options;
+  }
+  
+  validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
+    // optional method where you can safely check field types after database discovery was performed
+  }
+
+  instanceUniqueRepresentation(pluginOptions: any) : string {
+    // optional method to return unique string representation of plugin instance. 
+    // Needed if plugin can have multiple instances on one resource 
+    return `single`;
+  }
+
+  setupEndpoints(server: IHttpServer) {
+    server.endpoint({
+      method: 'POST',
+      path: `/plugin/${this.pluginInstanceId}/example`,
+      handler: async ({ body }) => {
+        const { name } = body;
+        return { hey: `Hello ${name}` };
+      }
+    });
+  }
+
+}

adminforth/commands/createPlugin/templates/package.json.hbs

@@ -0,0 +1,21 @@
+{
+  "name": "{{pluginName}}",
+  "version": "1.0.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsc && rsync -av --exclude 'node_modules' custom dist/ && npm version patch"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "devDependencies": {
+    "@types/node": "latest",
+    "typescript": "^5.7.3"
+  },
+  "dependencies": {
+    "adminforth": "latest"
+  }
+}

adminforth/commands/createPlugin/templates/tsconfig.json.hbs

@@ -0,0 +1,13 @@
+{
+    "compilerOptions": {
+      "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include*/ 
+      "module": "node16",                                /* Specify what module code is generated. */
+      "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
+      "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules.  */
+      "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+      "strict": false,                                     /* Enable all strict type-checking options. */
+      "skipLibCheck": true,                                 /* Skip type checking all .d.ts files. */
+    },
+    "exclude": ["node_modules", "dist", "custom"],           /* Exclude files from compilation. */
+  }
+  

adminforth/commands/createPlugin/templates/types.ts.hbs

@@ -0,0 +1,3 @@
+export interface PluginOptions {
+
+}