feat: add list of sent notifications to a signer

Signed-off-by: Vitor Mattos <vitor@php.rio>
LibreSign · Dec 29, 2024 · 0440990 · 0440990
1 parent 84e7038
commit 0440990
Show file tree

Hide file tree

Showing 6 changed files with 92 additions and 0 deletions.
diff --git a/lib/ResponseDefinitions.php b/lib/ResponseDefinitions.php
@@ -143,13 +143,18 @@
  *     emailToken?: LibresignSignatureMethodEmailToken,
  *     password?: LibresignSignatureMethodPassword,
  * }
+ * @psalm-type LibresignNotify = array{
+ *     date: int,
+ *     method: "activity"|"notify"|"mail",
+ * }
  * @psalm-type LibresignSigner = array{
  *     description: ?string,
  *     displayName: string,
  *     request_sign_date: string,
  *     email?: string,
  *     remote_address?: string,
  *     user_agent?: string,
+ *     notify?: LibresignNotify[],
  *     userId?: string,
  *     signed: ?string,
  *     sign_date?: ?string,

diff --git a/lib/Service/FileService.php b/lib/Service/FileService.php
@@ -210,6 +210,9 @@ private function getSigners(): array {
 			if (!empty($metadata['user-agent'])) {
 				$signatureToShow['user_agent'] = $metadata['user-agent'];
 			}
+			if (!empty($metadata['notify'])) {
+				$signatureToShow['notify'] = $metadata['notify'];
+			}
 			if ($signer->getSigned()) {
 				$data['sign_date'] = (new \DateTime())
 					->setTimestamp($signer->getSigned())

diff --git a/openapi-full.json b/openapi-full.json
@@ -465,6 +465,27 @@
                     }
                 }
             },
+            "Notify": {
+                "type": "object",
+                "required": [
+                    "date",
+                    "method"
+                ],
+                "properties": {
+                    "date": {
+                        "type": "integer",
+                        "format": "int64"
+                    },
+                    "method": {
+                        "type": "string",
+                        "enum": [
+                            "activity",
+                            "notify",
+                            "mail"
+                        ]
+                    }
+                }
+            },
             "OCSMeta": {
                 "type": "object",
                 "required": [
@@ -704,6 +725,18 @@
                     "email": {
                         "type": "string"
                     },
+                    "remote_address": {
+                        "type": "string"
+                    },
+                    "user_agent": {
+                        "type": "string"
+                    },
+                    "notify": {
+                        "type": "array",
+                        "items": {
+                            "$ref": "#/components/schemas/Notify"
+                        }
+                    },
                     "userId": {
                         "type": "string"
                     },

diff --git a/openapi.json b/openapi.json
@@ -402,6 +402,27 @@
                     }
                 }
             },
+            "Notify": {
+                "type": "object",
+                "required": [
+                    "date",
+                    "method"
+                ],
+                "properties": {
+                    "date": {
+                        "type": "integer",
+                        "format": "int64"
+                    },
+                    "method": {
+                        "type": "string",
+                        "enum": [
+                            "activity",
+                            "notify",
+                            "mail"
+                        ]
+                    }
+                }
+            },
             "OCSMeta": {
                 "type": "object",
                 "required": [
@@ -608,6 +629,18 @@
                     "email": {
                         "type": "string"
                     },
+                    "remote_address": {
+                        "type": "string"
+                    },
+                    "user_agent": {
+                        "type": "string"
+                    },
+                    "notify": {
+                        "type": "array",
+                        "items": {
+                            "$ref": "#/components/schemas/Notify"
+                        }
+                    },
                     "userId": {
                         "type": "string"
                     },

diff --git a/src/types/openapi/openapi-full.ts b/src/types/openapi/openapi-full.ts
@@ -1172,6 +1172,12 @@ export type components = {
             path: string;
             type: string;
         };
+        Notify: {
+            /** Format: int64 */
+            date: number;
+            /** @enum {string} */
+            method: "activity" | "notify" | "mail";
+        };
         OCSMeta: {
             status: string;
             statuscode: number;
@@ -1234,6 +1240,9 @@ export type components = {
             displayName: string;
             request_sign_date: string;
             email?: string;
+            remote_address?: string;
+            user_agent?: string;
+            notify?: components["schemas"]["Notify"][];
             userId?: string;
             signed: string | null;
             sign_date?: string | null;

diff --git a/src/types/openapi/openapi.ts b/src/types/openapi/openapi.ts
@@ -1034,6 +1034,12 @@ export type components = {
             path: string;
             type: string;
         };
+        Notify: {
+            /** Format: int64 */
+            date: number;
+            /** @enum {string} */
+            method: "activity" | "notify" | "mail";
+        };
         OCSMeta: {
             status: string;
             statuscode: number;
@@ -1088,6 +1094,9 @@ export type components = {
             displayName: string;
             request_sign_date: string;
             email?: string;
+            remote_address?: string;
+            user_agent?: string;
+            notify?: components["schemas"]["Notify"][];
             userId?: string;
             signed: string | null;
             sign_date?: string | null;