cap-user-info 0.1.1 → 0.1.4

package/README.md

@@ -1,6 +1,6 @@
 # cap-user-info
 
-CDS plugin that tracks created/modified user details on managed entities.
+CDS plugin that adds user details on managed entities.
 
 ## Install
 
@@ -10,6 +10,25 @@ npm install cap-user-info
 
 ## Usage
 
+The userinfo has the following properties by default that is added to the database
+``` cds
+entity UserInfo {
+        @UI.Hidden
+    key ID         : UUID;
+
+        @assert.unique: true  @title: 'Email Address'
+        @Communication: {IsEmailAddress: true}
+        Email      : String;
+
+        GivenName  : String @title: 'Given Name';
+        FamilyName : String @title: 'Family Name';
+        FullName   : String = concat(
+            GivenName, ' ', FamilyName
+        );
+}
+```
+
+Import it into your cds file.
 ```cds
 using { UserTracked, UserInfo } from 'cap-user-info';
 
@@ -24,6 +43,10 @@ handler UPSERTs the current user (`req.user`) into `UserInfo`. The
 associations `_toCreatedUserInfo` / `_toModifiedUserInfo` resolve via
 `createdBy` / `modifiedBy`.
 
+The fields for createdBy and modifiedBy will automatically be shown as links with a quickview with the user details.
+![alt text](image-1.png)
+
+
 ## How it works
 
 `UserTracked` extends `managed`, so consuming entities automatically
@@ -37,3 +60,79 @@ aspect UserTracked : managed { ... }
 
 This means no extra `managed` declaration is required on the consuming
 entity — including `UserTracked` is enough.
+
+## Using the plugin for other purposes
+
+Add a field to your entity and a association
+
+```cds
+
+using { UserTracked, UserInfo } from 'cap-user-info';
+
+entity MyEntity : cuid, UserTracked {
+  // The cds.on.insert is only to insert the userid automatically, otherwise handle it via code.
+  Responsible: User @cds.on.insert: $user.id;,
+  _toResponsibleUser: association to one UserInfo on _toResponsibleUser.ID = $self.Responsible
+}
+
+```
+
+Then the quickview will automatically be active
+![alt text](image-2.png)
+
+## Extending the quickview
+
+You can extend the UserInfo to add more data into the quickview by adding to the fieldgroup in a cds file.
+
+``` cds
+  // Change the quickview
+extend cap.userinfo.UserInfo with
+  @UI.FieldGroup: {Data: [
+    // Leave the original properties
+    {
+      $Type: 'UI.DataField',
+      Value: GivenName
+    },
+    {
+      $Type: 'UI.DataField',
+      Value: FamilyName
+    },
+    {
+      $Type: 'UI.DataField',
+      Value: Email
+    },
+    // your new field
+    {
+      $Type: 'UI.DataField',
+      Value: Department
+    }, 
+  ]}
+
+  //Change the 
+  @UI.HeaderInfo     : {
+    ImageUrl    : '',
+    TypeImageUrl: 'sap-icon://employee',
+    Title       : {
+        Value: FullName,
+    },
+    TypeName    : '',
+}
+  {
+    // your new field iin the entity
+    Department : String @title                        : 'Department';
+  }
+```
+
+Then register your event handler to populate the data. It's important this piece of code isn't added within your srv.init method. It needs to be in the root context.
+``` javascript
+cds.on("served", () => {
+  const { db } = cds.services;
+  const { UserInfo } = cds.entities("cap.userinfo");
+
+  //Register the handler for the Upsert
+  db.before("UPSERT", UserInfo, async (req) => {
+    //Change the data
+    req.data.Department = "Admin";
+  });
+});
+```

package/db/user-info.cds

@@ -1,7 +1,8 @@
-using { managed } from '@sap/cds/common';
+using {managed} from '@sap/cds/common';
+
 namespace cap.userinfo;
 
-@UI.FieldGroup #contactDetails: {Data: [
+@UI.FieldGroup     : {Data: [
     {
         $Type: 'UI.DataField',
         Value: GivenName,
@@ -15,14 +16,14 @@ namespace cap.userinfo;
         Value: Email,
     }
 ]}
-@UI.QuickViewFacets         : [{
+@UI.QuickViewFacets: [{
     $Type : 'UI.ReferenceFacet',
-    Target: '@UI.FieldGroup#contactDetails',
+    Target: '@UI.FieldGroup',
     Label : 'Contact Details',
 }]
-@UI.HeaderInfo              : {
+@UI.HeaderInfo     : {
     ImageUrl    : '',
-    TypeImageUrl: 'sap-icon://customer',
+    TypeImageUrl: 'sap-icon://avatar',
     Title       : {
         Label: 'Name',
         Value: FullName,
@@ -47,7 +48,7 @@ entity UserInfo {
 
 aspect UserTracked : managed {
     _toCreatedUserInfo  : Association to one UserInfo
-                            on _toCreatedUserInfo.ID = $self.createdBy;
+                              on _toCreatedUserInfo.ID = $self.createdBy;
     _toModifiedUserInfo : Association to one UserInfo
-                            on _toModifiedUserInfo.ID = $self.modifiedBy;
+                              on _toModifiedUserInfo.ID = $self.modifiedBy;
 }

package/dist/handlers.js

@@ -7,16 +7,19 @@ exports.hasUserTrackedAspect = hasUserTrackedAspect;
 exports.registerHandlers = registerHandlers;
 const cds_1 = __importDefault(require("@sap/cds"));
 const UPSERTED_FLAG = Symbol.for("cap-user-info.upserted-this-tx");
+const userInfoLogger = cds_1.default.log("cap.userinfo");
 function hasUserTrackedAspect(entity) {
-    const els = entity?.elements;
-    if (!els)
+    const entieies = entity?.elements;
+    if (!entieies)
         return false;
-    return Boolean(els._toCreatedUserInfo && els._toModifiedUserInfo);
+    return Boolean(entieies._toCreatedUserInfo && entieies._toModifiedUserInfo);
 }
 async function upsertUserInfo(req) {
     const user = req.user;
-    if (!user?.id || user.is("system-user") || user._is_anonymous)
+    if (!user?.id || user.is("system-user") || user._is_anonymous) {
+        userInfoLogger.debug(`Skipping user info upsert for system or anonymous user: ${user?.id}`);
         return;
+    }
     const ctx = cds_1.default.context;
     if (ctx && ctx[UPSERTED_FLAG])
         return;
@@ -25,21 +28,29 @@ async function upsertUserInfo(req) {
     const { UserInfo } = cds_1.default.entities("cap.userinfo");
     let attr = user.attr ?? {};
     if (Object.keys(attr).length === 0) {
+        userInfoLogger.debug(`User ${user.id} has no attr property, using dummy values for user info upsert`);
         attr.email = "Dummy@example.com";
         attr.givenName = user.id || "FirstName";
         attr.familyName = "LastName";
     }
-    await UPSERT.into(UserInfo).entries({
-        ID: user.id,
-        Email: attr.email,
-        GivenName: attr.givenName,
-        FamilyName: attr.familyName,
-    });
+    userInfoLogger.debug(`Upserting user info for user ${user.id}: ${JSON.stringify(attr)}`);
+    try {
+        await UPSERT.into(UserInfo).entries({
+            ID: user.id,
+            Email: attr.email,
+            GivenName: attr.givenName,
+            FamilyName: attr.familyName,
+        });
+    }
+    catch (error) {
+        userInfoLogger.error(`Failed to upsert user info for user ${user.id}: ${error.message}`);
+    }
 }
 function registerHandlers(srv) {
     const tracked = [...srv.entities].filter(hasUserTrackedAspect);
     if (tracked.length === 0)
         return;
+    userInfoLogger.debug(`Registering user info handlers for entities: ${tracked.map((e) => e.name).join(", ")}`);
     srv.after(["CREATE", "UPDATE"], tracked, async (_data, req) => {
         await upsertUserInfo(req);
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cap-user-info",
-  "version": "0.1.1",
+  "version": "0.1.4",
   "description": "CDS plugin: track created/modified user details on managed entities",
   "main": "cds-plugin.js",
   "repository": {