Merge branch 'main' of github.com:devforth/adminforth

Author: ivictbor

.vscode/settings.json

@@ -0,0 +1,34 @@
+{
+  "files.watcherExclude": {
+    "**/.cache": true,
+    "**/.cache/**": true,
+    "**/.git": true,
+    "**/.git/**": true,
+    "**/.pnpm-store": true,
+    "**/.pnpm-store/**": true,
+    "**/.turbo": true,
+    "**/.turbo/**": true,
+    "**/.vite": true,
+    "**/.vite/**": true,
+    "**/build": true,
+    "**/build/**": true,
+    "**/coverage": true,
+    "**/coverage/**": true,
+    "**/dist": true,
+    "**/dist/**": true,
+    "**/node_modules": true,
+    "**/node_modules/**": true
+  },
+  "search.exclude": {
+    "**/.cache": true,
+    "**/.git": true,
+    "**/.pnpm-store": true,
+    "**/.turbo": true,
+    "**/.vite": true,
+    "**/build": true,
+    "**/coverage": true,
+    "**/dist": true,
+    "**/node_modules": true
+  },
+  "git.autoRepositoryDetection": "openEditors"
+}

adminforth/basePlugin.ts

@@ -20,6 +20,7 @@ export default class AdminForthPlugin implements IAdminForthPlugin {
   resourceConfig: AdminForthResource;
   className: string;
   activationOrder: number = 0;
+  pluginsScope: 'resource' | 'global' = 'resource';
   shouldHaveSingleInstancePerWholeApp?: () => boolean;
 
   constructor(pluginOptions: any, metaUrl: string) {
@@ -41,14 +42,27 @@ export default class AdminForthPlugin implements IAdminForthPlugin {
   }
 
 
+  initializePluginInstanceId = (resourceConfig?: AdminForthResource) => {
+    const uniqueness = this.instanceUniqueRepresentation(this.pluginOptions);
+    let seed = '';
+    if (resourceConfig) {
+      seed = `af_pl_${this.constructor.name}_${resourceConfig?.resourceId || '_'}_${uniqueness}`;
+    } else {
+      seed = `af_pl_${this.constructor.name}_global_${uniqueness}`;
+    }
+    this.pluginInstanceId = md5hash(seed);
+    afLogger.trace({seed, pluginInstanceId: this.pluginInstanceId}, `🪲 AdminForthPlugin.initializePluginInstanceId`);
+  }
+
   modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource, allPluginInstances?: {pi: AdminForthPlugin, resource: AdminForthResource}[]) {
     this.resourceConfig = resourceConfig;
-    const uniqueness = this.instanceUniqueRepresentation(this.pluginOptions);
+    this.initializePluginInstanceId(resourceConfig);
+    this.adminforth = adminforth;
+  }
 
-    const seed = `af_pl_${this.constructor.name}_${resourceConfig.resourceId}_${uniqueness}`;
-    this.pluginInstanceId = md5hash(seed);
-    afLogger.trace({seed, pluginInstanceId: this.pluginInstanceId}, `🪲 AdminForthPlugin.modifyResourceConfig`);
+  modifyGlobalConfig(adminforth: IAdminForth) {
     this.adminforth = adminforth;
+    this.initializePluginInstanceId();
   }
 
   /** 

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

@@ -0,0 +1 @@
+export const globalPlugins = []

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

@@ -6,6 +6,7 @@ import path from 'path';
 import { Filters } from 'adminforth';
 import { initApi } from './api.js';
 import { logger } from 'adminforth';
+import { globalPlugins } from './globalPlugins.js';
 
 const ADMIN_BASE_URL = '';
 
@@ -66,6 +67,7 @@ export const admin = new AdminForth({
       resourceId: 'adminuser'
     },
   ],
+  globalPlugins: globalPlugins,
 });
 
 if (fileURLToPath(import.meta.url) === path.resolve(process.argv[1])) {

adminforth/commands/createApp/utils.js

@@ -428,6 +428,11 @@ async function writeTemplateFiles(dirname, cwd, useNpm, includePrismaMigrations,
       src: 'custom/package.json.hbs',
       dest: 'custom/package.json',
       data: {}
+    },
+    {
+      src: 'globalPlugins.ts.hbs',
+      dest: 'globalPlugins.ts',
+      data: {},
     }
   ];
 

adminforth/dataConnectors/baseConnector.ts

@@ -37,7 +37,7 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon
   client: any;
 
   /**
-   * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use .client instead.
+   * @deprecated Since 1.2.9. Will be removed in 4.0.0. Use .client instead.
    */
   get db() {
     afLogger.warn('.db is deprecated, use .client instead');

adminforth/documentation/docs/tutorial/03-Customization/02-customFieldRendering.md

@@ -605,6 +605,30 @@ For fields containing sensitive data (like passwords, API keys, tokens, or other
 
 The renderer wraps the standard value output and adds a click-to-reveal blur effect. Clicking again hides the value.
 
+For long values (like API keys) you can enable compact mode by passing `compact: true` via `meta`. When set, the value is shortened the same way as the `CompactUUID` renderer (first 4 + `...` + last 4 characters). In compact mode you can additionally pass `copy: true` to render a copy-to-clipboard button next to the value. The copy button is only shown once the value is revealed (blur removed):
+
+```ts title='./resources/anyResource.ts'
+  columns: [
+    ...
+    {
+      name: 'api_key',
+      components: {
+        show: {
+  //diff-add
+          file: '@/renderers/SensitiveBlurCell.vue',
+  //diff-add
+          meta: { compact: true, copy: true },
+        },
+        list: {
+  //diff-add
+          file: '@/renderers/SensitiveBlurCell.vue',
+  //diff-add
+          meta: { compact: true, copy: true },
+        },
+      },
+    ...
+```
+
 
 ### Custom filter component for square meters
 

adminforth/documentation/docs/tutorial/03-Customization/11-dataApi.md

@@ -300,20 +300,49 @@ This lets you answer questions like:
 
 ### Available aggregates
 - Aggregates.count()
--  Aggregates.avg(field)
+- Aggregates.countDistinct(field)
+- Aggregates.avg(field)
 - Aggregates.sum(field)
+- Aggregates.min(field)
+- Aggregates.max(field)
 - Aggregates.median(field)
 
 ### Available grouping
-- GroupBy.Field(field)
-- GroupBy.DateTrunc(field, unit, timezone)
+- GroupBy.Field(field, as?)
+- GroupBy.DateTrunc(field, unit, timezone?, as?)
+
+You can pass either one grouping rule or an array of grouping rules.
+When you use a single grouping rule, the grouping value is returned in `group`.
+When you use several grouping rules, the values are returned in `group1`, `group2`, etc.
+
+To use explicit response keys, pass the optional `as` argument:
+
+```ts
+GroupBy.Field('country', 'country')
+GroupBy.DateTrunc('created_at', 'month', 'Europe/Kyiv', 'month')
+```
 
 Example:
 ```ts
 GroupBy.DateTrunc('created_at', 'month', 'Europe/Kyiv')
 ```
 
 ### Response format
+Without grouping, each row contains only requested aggregate aliases:
+
+```ts
+[
+  {
+    count: number | string,
+    avgPrice?: number | null,
+    sum?: number | null,
+    medianPrice?: number | null,
+  }
+]
+```
+
+With one grouping rule:
+
 ```ts
 [
   {
@@ -326,6 +355,35 @@ GroupBy.DateTrunc('created_at', 'month', 'Europe/Kyiv')
 ]
 ```
 
+With several grouping rules:
+
+```ts
+[
+  {
+    group1: string,
+    group2: string,
+    count: number | string,
+    avgPrice?: number | null,
+  }
+]
+```
+
+With explicit grouping aliases:
+
+```ts
+[
+  {
+    country: string,
+    month: string,
+    count: number | string,
+    uniqueOwners?: number | string,
+    minPrice?: number | null,
+    maxPrice?: number | null,
+    avgPrice?: number | null,
+  }
+]
+```
+
 ### Get daily apartment stats (count, avg, sum, median) for listed apartments
 ```ts
 const rows = await admin.resource('apartments').aggregate(
@@ -369,4 +427,32 @@ What is happening here:
 - [] → no filters (all records)
 - GroupBy.Field('country')
 → grouping by country
-- same aggregates (count, avg, sum, median)
+- same aggregates (count, avg, sum, median)
+
+### Get apartment stats grouped by country and month
+```ts
+const rows = await admin.resource('apartments').aggregate(
+  [],
+  {
+    count: Aggregates.count(),
+    uniqueOwners: Aggregates.countDistinct('owner_id'),
+    minPrice: Aggregates.min('price'),
+    maxPrice: Aggregates.max('price'),
+    avgPrice: Aggregates.avg('price'),
+  },
+  [
+    GroupBy.Field('country', 'country'),
+    GroupBy.DateTrunc('created_at', 'month', 'Europe/Kyiv', 'month'),
+  ],
+);
+```
+
+What is happening here:
+- [] → no filters (all records)
+- GroupBy.Field('country', 'country')
+→ groups by country and returns the value in the `country` key
+- GroupBy.DateTrunc('created_at', 'month', 'Europe/Kyiv', 'month')
+→ groups by month and returns the value in the `month` key
+- countDistinct('owner_id') → number of unique owners in each group
+- min('price') and max('price') → price range in each group
+- the result has one row per country and month combination

adminforth/documentation/docs/tutorial/03-Customization/12-security.md

@@ -53,6 +53,7 @@ new AdminForth({
 
 The format is `requests/period`, where period can use `s`, `m`, `h`, or `d`.
 Because rate limits are keyed by client IP, configure `auth.clientIpHeader` when AdminForth runs behind a trusted CDN or reverse proxy. See [Trusting client IP addresses](#trusting-client-ip-addresses).
+> It is important to provide '`auth.clientIpHeader`, because otherwise adminforth will automatically detect client IP in headers and if you don't use proxy, hacker can change IP like `x-forwarded-for: 1.1.1.1` in request headers and skip rate limit 
 
 
 ## Password strength

adminforth/documentation/docs/tutorial/03-Customization/13-standardPagesTuning.md

@@ -542,6 +542,26 @@ And `edit` action will be available as quick action:
      
 
 
+## Show
+
+### Next record button
+
+By default, when a user opens a record from the list view, a **Next** button appears on the show page. It allows navigating through records one by one, respecting the current filters and sorting applied in the list. When the user reaches the last record on the current page, AdminForth automatically fetches the next page and continues navigation seamlessly.
+
+To disable the Next button for a resource, set `showNextButton` to `false`:
+
+```typescript title="./resources/apartments.ts"
+export default {
+  resourceId: 'aparts',
+  options: {
+//diff-add
+    showNextButton: false,
+  }
+}
+```
+
+> ☝️ The Next button is only shown when the user navigates to the show page from the list view. Opening a record directly via URL will not display the button.
+
 ## Creating
 
 ### Fill with default values