cap-user-info 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jakob Marius Kjaer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,37 @@
+# cap-user-info
+
+CDS plugin that tracks created/modified user details on managed entities.
+
+## Install
+
+```bash
+npm install cap-user-info
+```
+
+## Usage
+
+```cds
+using { UserTracked, UserInfo } from 'cap-user-info';
+
+entity MyEntity : cuid, UserTracked {
+  // your fields
+}
+```
+
+The plugin auto-registers `.after("CREATE" | "UPDATE")` handlers on every
+application-service entity that includes the `UserTracked` aspect. Each
+handler UPSERTs the current user (`req.user`) into `UserInfo`. The
+associations `_toCreatedUserInfo` / `_toModifiedUserInfo` resolve via
+`createdBy` / `modifiedBy`.
+
+## How it works
+
+`UserTracked` extends `managed`, so consuming entities automatically
+inherit `createdBy` / `modifiedBy` (and the corresponding timestamps):
+
+```cds
+aspect UserTracked : managed { ... }
+```
+
+This means no extra `managed` declaration is required on the consuming
+entity — including `UserTracked` is enough.

package/cds-plugin.js

@@ -0,0 +1,9 @@
+const cds = require('@sap/cds');
+
+cds.on('served', async () => {
+  const { registerHandlers } = require('./dist/handlers.js');
+  for (const srv of cds.services) {
+    if (!(srv instanceof cds.ApplicationService)) continue;
+    registerHandlers(srv);
+  }
+});

package/db/user-info.cds

@@ -0,0 +1,53 @@
+using { managed } from '@sap/cds/common';
+namespace cap.userinfo;
+
+@UI.FieldGroup #contactDetails: {Data: [
+    {
+        $Type: 'UI.DataField',
+        Value: GivenName,
+    },
+    {
+        $Type: 'UI.DataField',
+        Value: FamilyName,
+    },
+    {
+        $Type: 'UI.DataField',
+        Value: Email,
+    }
+]}
+@UI.QuickViewFacets         : [{
+    $Type : 'UI.ReferenceFacet',
+    Target: '@UI.FieldGroup#contactDetails',
+    Label : 'Contact Details',
+}]
+@UI.HeaderInfo              : {
+    ImageUrl    : '',
+    TypeImageUrl: 'sap-icon://customer',
+    Title       : {
+        Label: 'Name',
+        Value: FullName,
+    },
+    TypeName    : '',
+}
+@cds.autoexpose
+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
+        );
+}
+
+aspect UserTracked : managed {
+    _toCreatedUserInfo  : Association to one UserInfo
+                            on _toCreatedUserInfo.ID = $self.createdBy;
+    _toModifiedUserInfo : Association to one UserInfo
+                            on _toModifiedUserInfo.ID = $self.modifiedBy;
+}

package/dist/handlers.d.ts

@@ -0,0 +1,9 @@
+import cds from '@sap/cds';
+interface CsnEntity {
+    name: string;
+    kind?: string;
+    elements?: Record<string, any>;
+}
+export declare function hasUserTrackedAspect(entity: CsnEntity): boolean;
+export declare function registerHandlers(srv: cds.ApplicationService): void;
+export {};

package/dist/handlers.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasUserTrackedAspect = hasUserTrackedAspect;
+exports.registerHandlers = registerHandlers;
+const cds_1 = __importDefault(require("@sap/cds"));
+const UPSERTED_FLAG = Symbol.for('cap-user-info.upserted-this-tx');
+function hasUserTrackedAspect(entity) {
+    const els = entity?.elements;
+    if (!els)
+        return false;
+    return Boolean(els._toCreatedUserInfo && els._toModifiedUserInfo);
+}
+async function upsertUserInfo(req) {
+    const user = req.user;
+    if (!user?.id || user.is('system-user') || user._is_anonymous)
+        return;
+    const ctx = cds_1.default.context;
+    if (ctx && ctx[UPSERTED_FLAG])
+        return;
+    if (ctx)
+        ctx[UPSERTED_FLAG] = true;
+    const { UserInfo } = cds_1.default.entities('cap.userinfo');
+    const attr = user.attr ?? {};
+    await UPSERT.into(UserInfo).entries({
+        ID: user.id,
+        Email: attr.email,
+        GivenName: attr.givenName,
+        FamilyName: attr.familyName
+    });
+}
+function registerHandlers(srv) {
+    const tracked = [...srv.entities].filter(hasUserTrackedAspect);
+    if (tracked.length === 0)
+        return;
+    srv.after(['CREATE', 'UPDATE'], tracked, async (_data, req) => {
+        await upsertUserInfo(req);
+    });
+}

package/index.cds

@@ -0,0 +1 @@
+using from './db/user-info';

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "cap-user-info",
+  "version": "0.1.0",
+  "description": "CDS plugin: track created/modified user details on managed entities",
+  "main": "cds-plugin.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/yourusername/cap-user-info.git"
+  },
+  "keywords": [
+    "cds",
+    "cap",
+    "plugin",
+    "user-info",
+    "created-by",
+    "modified-by"
+  ],
+  "author": "Jakob Kjaer",
+  "files": [
+    "cds-plugin.js",
+    "db/",
+    "index.cds",
+    "dist/",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepare": "tsc",
+    "test": "node --import tsx --test-isolation=none --test 'test/**/*.test.ts'"
+  },
+  "peerDependencies": {
+    "@sap/cds": ">=8"
+  },
+  "devDependencies": {
+    "@cap-js/cds-test": "^1.0.1",
+    "@cap-js/cds-types": "^0.15.0",
+    "@cap-js/sqlite": "^2.1.0",
+    "@sap/cds": "^9",
+    "tsx": "^4",
+    "typescript": "^5"
+  }
+}