CRISTAL-371: Shows details about the last edition on pages

* Use UserDetails instead of string * Make use of Date and User UI elements
xwiki-contrib · Dec 17, 2024 · 9947932 · 9947932
1 parent 96456e2
commit 9947932
Show file tree

Hide file tree

Showing 24 changed files with 206 additions and 63 deletions.
diff --git a/api/package.json b/api/package.json
@@ -26,6 +26,7 @@
     "test": "vitest --run"
   },
   "dependencies": {
+    "@xwiki/cristal-authentication-api": "workspace:*",
     "inversify": "6.2.0",
     "vue": "3.5.13",
     "vue-router": "4.5.0"

diff --git a/api/src/api/PageData.ts b/api/src/api/PageData.ts
@@ -19,6 +19,7 @@
  */
 
 import type { Document } from "./document";
+import type { UserDetails } from "@xwiki/cristal-authentication-api";
 
 export interface PageData {
   id: string;
@@ -41,7 +42,7 @@ export interface PageData {
    * Name of the last user to edit this page.
    * @since 0.13
    */
-  lastAuthor: string | undefined;
+  lastAuthor: UserDetails | undefined;
 
   // TODO: remove any
   toObject(): any; // eslint-disable-line

diff --git a/api/src/components/DefaultPageData.ts b/api/src/components/DefaultPageData.ts
@@ -21,6 +21,7 @@
 import { JSONLDDocument } from "./JSONLDDocument";
 import type { PageData } from "../api/PageData";
 import type { Document } from "../api/document";
+import type { UserDetails } from "@xwiki/cristal-authentication-api";
 
 export class DefaultPageData implements PageData {
   id: string;
@@ -36,7 +37,7 @@ export class DefaultPageData implements PageData {
   headline: string = "";
   headlineRaw: string = "";
   lastModificationDate: Date | undefined;
-  lastAuthor: string | undefined;
+  lastAuthor: UserDetails | undefined;
 
   public constructor(
     id: string = "",

diff --git a/core/authentication/authentication-api/package.json b/core/authentication/authentication-api/package.json
@@ -22,10 +22,6 @@
     "clean": "rimraf dist",
     "lint": "eslint \"./src/**/*.{ts,tsx,vue}\" --max-warnings=0"
   },
-  "dependencies": {
-    "@xwiki/cristal-api": "workspace:*",
-    "inversify": "6.2.0"
-  },
   "peerDependencies": {
     "reflect-metadata": "0.2.2"
   },

diff --git a/core/authentication/authentication-api/src/index.ts b/core/authentication/authentication-api/src/index.ts
@@ -18,24 +18,8 @@
  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
  */
 
-import { DefaultAuthenticationManagerProvider } from "./defaultAuthenticationManagerProvider";
-import { Container } from "inversify";
 import type { AuthenticationManager } from "./authenticationManager";
 import type { AuthenticationManagerProvider } from "./authenticationManagerProvider";
 import type { UserDetails } from "./userDetails";
 
-class ComponentInit {
-  constructor(container: Container) {
-    container
-      .bind<AuthenticationManagerProvider>("AuthenticationManagerProvider")
-      .to(DefaultAuthenticationManagerProvider)
-      .inSingletonScope();
-  }
-}
-
-export {
-  AuthenticationManager,
-  AuthenticationManagerProvider,
-  ComponentInit,
-  UserDetails,
-};
+export { AuthenticationManager, AuthenticationManagerProvider, UserDetails };
diff --git a/core/authentication/authentication-default/package.json b/core/authentication/authentication-default/package.json
@@ -0,0 +1,49 @@
+{
+  "name": "@xwiki/cristal-authentication-default",
+  "version": "0.12.0",
+  "license": "LGPL 2.1",
+  "author": "XWiki Org Community <[email protected]>",
+  "homepage": "https://cristal.xwiki.org/",
+  "repository": {
+    "type": "git",
+    "directory": "/core/authentication/authentication-default",
+    "url": "https://github.com/xwiki-contrib/cristal/"
+  },
+  "bugs": {
+    "url": "https://jira.xwiki.org/projects/CRISTAL/"
+  },
+  "type": "module",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "main": "./src/index.ts",
+  "scripts": {
+    "build": "tsc --project tsconfig.json && vite build",
+    "clean": "rimraf dist",
+    "lint": "eslint \"./src/**/*.{ts,tsx,vue}\" --max-warnings=0"
+  },
+  "dependencies": {
+    "@xwiki/cristal-api": "workspace:*",
+    "@xwiki/cristal-authentication-api": "workspace:*",
+    "inversify": "6.2.0"
+  },
+  "peerDependencies": {
+    "reflect-metadata": "0.2.2"
+  },
+  "devDependencies": {
+    "reflect-metadata": "0.2.2",
+    "typescript": "5.6.3",
+    "vite": "6.0.3"
+  },
+  "publishConfig": {
+    "exports": {
+      ".": {
+        "import": "./dist/index.es.js",
+        "require": "./dist/index.umd.js",
+        "types": "./dist/index.d.ts"
+      }
+    },
+    "main": "./dist/index.es.js",
+    "types": "./dist/index.d.ts"
+  }
+}
diff --git a/...c/defaultAuthenticationManagerProvider.ts → ...c/defaultAuthenticationManagerProvider.ts b/...c/defaultAuthenticationManagerProvider.ts → ...c/defaultAuthenticationManagerProvider.ts
@@ -18,8 +18,10 @@
  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
  */
 
-import { AuthenticationManager } from "./authenticationManager";
-import { AuthenticationManagerProvider } from "./authenticationManagerProvider";
+import {
+  AuthenticationManager,
+  AuthenticationManagerProvider,
+} from "@xwiki/cristal-authentication-api";
 import { inject, injectable } from "inversify";
 import type { CristalApp } from "@xwiki/cristal-api";
 

diff --git a/core/authentication/authentication-default/src/index.ts b/core/authentication/authentication-default/src/index.ts
@@ -0,0 +1,32 @@
+/*
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+
+import { DefaultAuthenticationManagerProvider } from "./defaultAuthenticationManagerProvider";
+import { Container } from "inversify";
+import type { AuthenticationManagerProvider } from "@xwiki/cristal-authentication-api";
+
+export class ComponentInit {
+  constructor(container: Container) {
+    container
+      .bind<AuthenticationManagerProvider>("AuthenticationManagerProvider")
+      .to(DefaultAuthenticationManagerProvider)
+      .inSingletonScope();
+  }
+}
diff --git a/core/authentication/authentication-default/tsconfig.json b/core/authentication/authentication-default/tsconfig.json
@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist",
+    "resolveJsonModule": true
+  },
+  "extends": "../../../tsconfig.json",
+  "include": [
+    "./src/index.ts",
+    "./src/**/*"
+  ]
+}
diff --git a/core/authentication/authentication-default/tsdoc.json b/core/authentication/authentication-default/tsdoc.json
@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["../../../tsdoc.json"]
+}
diff --git a/core/authentication/authentication-default/vite.config.ts b/core/authentication/authentication-default/vite.config.ts
@@ -0,0 +1,23 @@
+/*
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+
+import { generateConfig } from "../../../vite.config";
+
+export default generateConfig(import.meta.url);
diff --git a/core/backends/backend-nextcloud/package.json b/core/backends/backend-nextcloud/package.json
@@ -23,6 +23,7 @@
   },
   "dependencies": {
     "@xwiki/cristal-api": "workspace:*",
+    "@xwiki/cristal-authentication-api": "workspace:*",
     "@xwiki/cristal-backend-api": "workspace:*",
     "inversify": "6.2.0"
   },

diff --git a/core/backends/backend-nextcloud/src/nextcloudStorage.ts b/core/backends/backend-nextcloud/src/nextcloudStorage.ts
@@ -27,6 +27,7 @@ import {
 import { AbstractStorage } from "@xwiki/cristal-backend-api";
 import { inject, injectable } from "inversify";
 import type { Logger } from "@xwiki/cristal-api";
+import type { UserDetails } from "@xwiki/cristal-authentication-api";
 
 // TODO: To be replaced by an actual authentication with CRISTAL-267
 const USERNAME = "test";
@@ -71,7 +72,7 @@ export class NextcloudStorage extends AbstractStorage {
       );
 
       if (response.status >= 200 && response.status < 300) {
-        let lastAuthor: string | undefined;
+        let lastAuthor: UserDetails | undefined;
         let lastModificationDate: Date | undefined;
         const propResponse = await fetch(
           `${this.getWikiConfig().baseRestURL}/${USERNAME}/.cristal/${page}/page.json`,
@@ -102,8 +103,10 @@ export class NextcloudStorage extends AbstractStorage {
           if (modifiedProp) {
             lastModificationDate = new Date(Date.parse(modifiedProp));
           }
-          lastAuthor = propData.getElementsByTagName("oc:owner-display-name")[0]
-            ?.innerHTML;
+          lastAuthor = {
+            name: propData.getElementsByTagName("oc:owner-display-name")[0]
+              ?.innerHTML,
+          };
         }
 
         const json = await response.json();

diff --git a/core/backends/backend-xwiki/src/xwikiStorage.ts b/core/backends/backend-xwiki/src/xwikiStorage.ts
@@ -185,7 +185,7 @@ export class XWikiStorage extends AbstractStorage {
     pageContentData.lastModificationDate = new Date(
       Date.parse(json.dateModified),
     );
-    pageContentData.lastAuthor = json.editor;
+    pageContentData.lastAuthor = { name: json.editor };
     return pageContentData;
   }
 

diff --git a/electron/storage/src/electron/main/index.ts b/electron/storage/src/electron/main/index.ts
@@ -86,7 +86,7 @@ async function readPage(path: string): Promise<PageData | undefined> {
       parse.name = basename(dirname(path));
     }
     parse.lastModificationDate = new Date(pageStats.mtimeMs);
-    parse.lastAuthor = os.userInfo().username;
+    parse.lastAuthor = { name: os.userInfo().username };
     return parse;
   } else {
     return undefined;

diff --git a/lib/package.json b/lib/package.json
@@ -32,6 +32,7 @@
     "@xwiki/cristal-attachments-default": "workspace:*",
     "@xwiki/cristal-attachments-ui": "workspace:*",
     "@xwiki/cristal-authentication-api": "workspace:*",
+    "@xwiki/cristal-authentication-default": "workspace:*",
     "@xwiki/cristal-authentication-ui": "workspace:*",
     "@xwiki/cristal-backend-api": "workspace:*",
     "@xwiki/cristal-backend-dexie": "workspace:*",

diff --git a/lib/src/staticBuild.ts b/lib/src/staticBuild.ts
@@ -21,7 +21,7 @@
 import { ComponentInit as AlertsDefaultComponentInit } from "@xwiki/cristal-alerts-default";
 import { ComponentInit as AttachmentsDefaultComponentInit } from "@xwiki/cristal-attachments-default";
 import { ComponentInit as AttachmentsUIComponentInit } from "@xwiki/cristal-attachments-ui";
-import { ComponentInit as AuthenticationAPIComponentInit } from "@xwiki/cristal-authentication-api";
+import { ComponentInit as AuthenticationDefaultComponentInit } from "@xwiki/cristal-authentication-default";
 import { ComponentInit as AuthenticationUIComponentInit } from "@xwiki/cristal-authentication-ui";
 import { ComponentInit as BackendAPIComponentInit } from "@xwiki/cristal-backend-api";
 import { ComponentInit as DexieBackendComponentInit } from "@xwiki/cristal-backend-dexie";
@@ -98,7 +98,7 @@ export class StaticBuild {
       new UIExtensionDefaultComponentInit(container);
       new AuthenticationUIComponentInit(container);
       new BackendAPIComponentInit(container);
-      new AuthenticationAPIComponentInit(container);
+      new AuthenticationDefaultComponentInit(container);
       new LinkSuggestComponentInit(container);
       new XWikiLinkSuggestComponentInit(container);
       new NextcloudLinkSuggestComponentInit(container);