Merge pull request #435 from devforth/feature/AdminForth/292/add-ability-to-store-county-is

Feature/admin forth/292/add ability to store county is

Author: ivictbor

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

@@ -244,4 +244,109 @@ Also, update the resource configuration in `./resources/auditLogs.ts`:
       }),
     ],
   }
+```
+## Logging client ip country
+
+Audit log can also log the client's country if needed.
+
+First, you need to migrate the `audit_logs` table in `./schema.prisma`:
+
+```ts title='./schema.prisma'
+model audit_logs {
+  id                String      @id
+  created_at        DateTime  /// timestamp of applied change
+  resource_id       String    /// identifier of resource where change were applied
+  user_id           String    /// identifier of user who made the changes
+  action            String    /// type of change (create, edit, delete)
+  diff              String?   /// delta betwen before/after versions
+  record_id         String?   /// identifier of record that been changed
+  ip_address        String?   /// client ip address
+//diff-add
+  country           String?   /// client country
+
+//diff-add
+  @@index([ip_address])       /// index for fast lookups by IP
+}
+```
+
+And `prisma migrate`:
+
+```bash
+npm run makemigration -- --name add-ip-address-to-audit-logs ; npm run migrate:local
+```
+
+Update the resource configuration in `./resources/auditLogs.ts`:
+
+```ts title='./resources/auditLogs.ts'
+  export default {
+    dataSource: 'maindb', 
+    table: 'audit_logs',
+    columns: [
+      ...
+      { name: 'action', required: false },
+      { name: 'diff', required: false, type: AdminForthDataTypes.JSON, showIn: {
+          list: false,
+          edit: false,
+          create: false,
+          filter: false,
+        } },
+      { name: 'record_id', required: false },
+      { name: 'ip_address', required: false },
+       //diff-add
+      { 
+        //diff-add
+        name: "country",
+        //diff-add
+        required: false,
+        //diff-add
+        components: {
+        //diff-add
+          list: '@/renderers/CountryFlag.vue'
+        //diff-add
+          show: '@/renderers/CountryFlag.vue'
+        //diff-add
+        }, 
+         //diff-add
+      },
+    ],
+    ...
+    plugins: [
+      new AuditLogPlugin({
+        resourceColumns: {
+          resourceIdColumnName: 'resource_id',
+          resourceActionColumnName: 'action',
+          resourceDataColumnName: 'diff',
+          resourceUserIdColumnName: 'user_id',
+          resourceRecordIdColumnName: 'record_id',
+          resourceCreatedColumnName: 'created_at'
+          resourceIpColumnName: "ip_address",
+//diff-add
+          resourceCountryColumnName: "country",
+        }
+      }),
+    ],
+  }
+```
+
+### Providing Country Headers
+
+If your deployed app has header with user country in ISO 3166-1 alpha-2 format, you can specify this header, so country will be taken from it: 
+
+```ts
+plugins: [
+      new AuditLogPlugin({
+        //diff-add
+        isoCountryCodeRequestHeader: 'CF-IPCountry',
+        resourceColumns: {
+          resourceIdColumnName: 'resource_id',
+          resourceActionColumnName: 'action',
+          resourceDataColumnName: 'diff',
+          resourceUserIdColumnName: 'user_id',
+          resourceRecordIdColumnName: 'record_id',
+          resourceCreatedColumnName: 'created_at'
+          resourceIpColumnName: "ip_address",
+          resourceCountryColumnName: "country",
+        }
+      }),
+    ],
 ```