Merge pull request #209 from devforth/next

Next

Author: ivictbor

adminforth/documentation/docs/tutorial/001-gettingStarted.md

@@ -19,13 +19,6 @@ nvm use 20
 
 The recommended way to get started with AdminForth is via the **`create-app`** CLI, which scaffolds a basic fully functional back-office application. Apart boilerplate it creates one resource for users management.
 
-First, create and enter a directory where you want your AdminForth project to live. For instance:
-
-```bash
-mkdir myadmin
-cd myadmin
-```
-
 You can provide options directorly:
 
 ```bash
@@ -38,6 +31,12 @@ Or omit them to be prompted interactively:
 npx adminforth create-app
 ```
 
+Once the project is created, navigate into its directory:
+
+```bash
+cd myadmin # or any other name you provided
+```
+
 CLI options:
 
 * **`--app-name`** - name for your project. Used in `package.json`, `index.ts` branding, etc. Default value: **`adminforth-app`**.

adminforth/documentation/docs/tutorial/03-Customization/09-Actions.md

@@ -85,7 +85,7 @@ Return:
 - A string with an error message to explain why access was denied
 
 Here is how it looks:
-![alt text](<Custom bulk actions.png>)
+![alt text](<Single record actions.png>)
 
 
 You might want to allow only certain users to perform your custom bulk action. 

adminforth/documentation/docs/tutorial/03-Customization/Single record actions.png

@@ -165,14 +165,15 @@ app.get(`${ADMIN_BASE_URL}/api/dashboard/`,
   admin.express.authorize(
     async (req, res) => {
 
-      admin.getPluginByClassName<AuditLogPlugin>('AuditLogPlugin').logCustomAction(
-        'aparts',
-        null, // recordId can be null if not applicable
-        'visitedDashboard',
-        { dashboard: 'main' },
-        req.adminUser,
-        req.headers //required if you want log client ip
-      )
+      admin.getPluginByClassName<AuditLogPlugin>('AuditLogPlugin').logCustomAction({
+        resourceId: 'aparts',
+        recordId: null, // recordId can be null if not applicable
+        actionId: 'visitedDashboard', // any random string you want to useto identify this action 
+        oldData: null, // old data, can be null if not applicable
+        data: { dashboard: 'main' }, // new data or any data you want to log
+        user: req.adminUser,
+        headers: req.headers //required if you want log client ip
+      })
 
       ....
 

adminforth/documentation/docs/tutorial/05-Plugins/01-AuditLog.md

@@ -325,6 +325,63 @@ If you want to limit access to translations resource only to developers or trans
 
 Please note that access to "Translate selected" bulk action which uses LLM AI translation adapter is determined by allowedActions.edit permission of resource.
 
+## Proofreading checkboxes
+
+You can enable didicated checkboxes for proofreading translations. This will allow proofreaders to check each translation and mark it "reviewed" or "not reviewed".
+
+TO enable this options add TEXT column to the resource.
+
+If using prisma, add something like this:
+
+```ts title='./schema.prisma'
+model translations {
+  ...
+    completedLangs   String?
+  //diff-add
+    reviewed          String? 
+    
+    // we need both indexes on en_string+category and separately on category
+    @@index([en_string, category])
+    @@index([category])
+    @@index([completedLangs])
+}  
+```
+
+And add column to the resource:
+
+```ts title='./resources/translations.ts'
+{
+  ...
+  columns: [
+    ...
+    {
+      name: "reviewed",
+      type: AdminForthDataTypes.JSON, // should be JSON type
+      label: 'Reviewed',
+      showIn: {
+        all: false
+      },
+    },
+  ],
+}
+```
+
+
+Now just add `reviewedCheckboxesFieldName` to the plugin options:
+
+```ts title='./resources/translations.ts'
+  plugins: [
+    new I18nPlugin({
+      ...
+      reviewedCheckboxesFieldName: 'reviewed',
+    }),
+  ],
+```
+This will add checkboxes to the translations resource:
+
+![alt text](image-5.png)
+
+
 ## Translations in custom APIs
 
 Sometimes you need to return a translated error or success message from your API. You can use special `tr` function for this.

adminforth/documentation/docs/tutorial/05-Plugins/10-i18n.md

@@ -6,7 +6,7 @@ import SQLiteConnector from './dataConnectors/sqlite.js';
 import CodeInjector from './modules/codeInjector.js';
 import ExpressServer from './servers/express.js';
 // import FastifyServer from './servers/fastify.js';
-import { ADMINFORTH_VERSION, listify, suggestIfTypo, RateLimiter, getClientIp } from './modules/utils.js';
+import { ADMINFORTH_VERSION, listify, suggestIfTypo, RateLimiter, RAMLock, getClientIp } from './modules/utils.js';
 
 import { 
   type AdminForthConfig, 
@@ -42,7 +42,7 @@ export * from './types/Common.js';
 export * from './types/Adapters.js';
 export { interpretResource };
 export { AdminForthPlugin };
-export { suggestIfTypo, RateLimiter, getClientIp };
+export { suggestIfTypo, RateLimiter, RAMLock, getClientIp };
 
 
 class AdminForth implements IAdminForth {
@@ -478,7 +478,6 @@ class AdminForth implements IAdminForth {
     { resource, recordId, record, oldRecord, adminUser, extra }:
     { resource: AdminForthResource, recordId: any, record: any, oldRecord: any, adminUser: AdminUser, extra?: HttpExtra }
   ): Promise<{ error?: string }> {
-
     const err = this.validateRecordValues(resource, record);
     if (err) {
       return { error: err };

adminforth/documentation/docs/tutorial/05-Plugins/image-5.png

@@ -455,4 +455,36 @@ export class RateLimiter {
     }
   }
 
+}
+
+export class RAMLock {
+  private locks: Map<string, { locked: boolean; queue: Function[] }>;
+
+  constructor() {
+    this.locks = new Map();
+  }
+
+  _getLock(key) {
+    if (!this.locks.has(key)) {
+      this.locks.set(key, { locked: false, queue: [] });
+    }
+    return this.locks.get(key);
+  }
+
+  async run(key, fn) {
+    const lock = this._getLock(key);
+    while (lock.locked) {
+      await new Promise(resolve => lock.queue.push(resolve));
+    }
+    lock.locked = true;
+    try {
+      return await fn();
+    } finally {
+      lock.locked = false;
+      if (lock.queue.length > 0) {
+        const next = lock.queue.shift();
+        next();
+      }
+    }
+  }
 }

adminforth/index.ts

@@ -5,7 +5,8 @@
       type="checkbox"
       :checked="props.modelValue"
       @change="$emit('update:modelValue', $event.target.checked)"
-      class="w-4 h-4 border border-gray-300 rounded bg-gray-50 focus:ring-3 focus:ring-lightPrimary focus:ring-opacity-50 dark:bg-gray-700 dark:border-gray-600 dark:focus:ring-blue-600 dark:ring-offset-gray-800 dark:focus:ring-offset-gray-800 checked:bg-lightPrimary checked:dark:bg-darkPrimary" /> 
+      class="w-4 h-4 border border-gray-300 rounded bg-gray-50 focus:ring-3 focus:ring-lightPrimary cursor-pointer 
+        focus:ring-opacity-50 dark:bg-gray-700 dark:border-gray-600 dark:focus:ring-blue-600 dark:ring-offset-gray-800 dark:focus:ring-offset-gray-800 checked:bg-lightPrimary checked:dark:bg-darkPrimary" /> 
   </div>
   <label :for="id" class="ms-2 text-sm font-medium text-gray-900 dark:text-gray-300">
     <slot></slot>

adminforth/modules/utils.ts

@@ -39,8 +39,8 @@ const props = defineProps<{
   type: string,
   fullWidth: boolean,
   modelValue: string,
-  suffix: string,
-  prefix: string,
+  suffix?: string,
+  prefix?: string,
   readonly?: boolean,
 }>()