Add support for returning transforming activity logs on the front-end

resources/scripts/api/definitions/user/models.d.ts

@@ -1,4 +1,16 @@
-import { Model } from '@/api/definitions';
+import { Model, UUID } from '@/api/definitions';
+import { SubuserPermission } from '@/state/server/subusers';
+
+interface User extends Model {
+    uuid: string;
+    username: string;
+    email: string;
+    image: string;
+    twoFactorEnabled: boolean;
+    createdAt: Date;
+    permissions: SubuserPermission[];
+    can (permission: SubuserPermission): boolean;
+}
 
 interface SSHKey extends Model {
     name: string;
@@ -6,3 +18,15 @@ interface SSHKey extends Model {
     fingerprint: string;
     createdAt: Date;
 }
+
+interface ActivityLog extends Model<'actor'> {
+    batch: UUID | null;
+    event: string;
+    ip: string;
+    description: string | null;
+    properties: Record<string, string | unknown>;
+    timestamp: Date;
+    relationships: {
+        actor: User | null;
+    }
+}

resources/scripts/api/definitions/user/transformers.ts

@@ -1,7 +1,9 @@
-import { SSHKey } from '@definitions/user/models';
+import * as Models from '@definitions/user/models';
+import { FractalResponseData } from '@/api/http';
+import { transform } from '@definitions/helpers';
 
 export default class Transformers {
-    static toSSHKey (data: Record<any, any>): SSHKey {
+    static toSSHKey (data: Record<any, any>): Models.SSHKey {
         return {
             name: data.name,
             publicKey: data.public_key,
@@ -9,6 +11,37 @@ export default class Transformers {
             createdAt: new Date(data.created_at),
         };
     }
+
+    static toUser ({ attributes }: FractalResponseData): Models.User {
+        return {
+            uuid: attributes.uuid,
+            username: attributes.username,
+            email: attributes.email,
+            image: attributes.image,
+            twoFactorEnabled: attributes['2fa_enabled'],
+            permissions: attributes.permissions || [],
+            createdAt: new Date(attributes.created_at),
+            can (permission): boolean {
+                return this.permissions.includes(permission);
+            },
+        };
+    }
+
+    static toActivityLog ({ attributes }: FractalResponseData): Models.ActivityLog {
+        const { actor } = attributes.relationships || {};
+
+        return {
+            batch: attributes.batch,
+            event: attributes.event,
+            ip: attributes.ip,
+            description: attributes.description,
+            properties: attributes.properties,
+            timestamp: new Date(attributes.timestamp),
+            relationships: {
+                actor: transform(actor as FractalResponseData, this.toUser, null),
+            },
+        };
+    }
 }
 
 export class MetaTransformers {