Added UUID/GUID formatting in UUID Generator extension

docs/Extensions/UuidGenerator/README.md

@@ -1,4 +1,4 @@
-# Custom Web Search Extension
+# UUID / GUID Generator
 
 This extension allows to generate [Universally Unique Identifiers](https://en.wikipedia.org/wiki/Universally_unique_identifier), also known as UUID or GUID.
 This can be done either instantly for a single UUID or through a dedicated UI, where multiple UUIDs can be generated at once.
@@ -7,20 +7,28 @@ This can be done either instantly for a single UUID or through a dedicated UI, w
 
 ![Example](example-generator.png)
 
+This extension also allows to format the UUID to several different styles in a fast way.
+
+![Example](example-formatting.png)
 
 ## Settings
 
--   **UUID Version**: The UUID version, either [v4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)), [v6](https://en.wikipedia.org/wiki/Universally_unique_identifier#Versions_1_and_6_(date-time_and_MAC_address)) or [v7](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_7_(timestamp_and_random))
+-   **UUID Version**: The UUID version, either [v4](<https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)>), [v6](<https://en.wikipedia.org/wiki/Universally_unique_identifier#Versions_1_and_6_(date-time_and_MAC_address)>) or [v7](<https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_7_(timestamp_and_random)>)
 -   **Number of UUIDs to generate**: The number of UUIDs that will be created, only applies when using the UI of the extension
 -   **Uppercase**: Whether the characters of the UUID should be uppercase
 -   **Hyphen**: Whether the UUID should contain hyphens (-)
 -   **Braces**: Whether the UUID should be wrapped in braces ({})
 -   **Quotes**: Whether the UUID should be wrapped in quotes
+-   **Search result formats**: Several different formats for fast formatting in search results
+
+![Example](example-settings.png)
 
 ## About this extension
 
 Author: [Christopher Steiner](https://github.com/ChristopherSteiner)
 
+Co-Author: [Marco Senn-Haag](https://github.com/MarcoSennHaag)
+
 Supported operating systems:
 
 -   Windows

package.json

@@ -73,6 +73,6 @@
         "react-router": "^7.1.3",
         "react-router-dom": "^7.1.3",
         "sharp": "^0.33.5",
-        "uuid": "^11.0.3"
+        "uuid": "^11.0.5"
     }
 }

src/common/Extensions/UuidGenerator/UuidFormat.ts

@@ -0,0 +1,6 @@
+export type UuidFormat = {
+    uppercase: boolean;
+    hyphens: boolean;
+    braces: boolean;
+    quotes: boolean;
+};

src/common/Extensions/UuidGenerator/UuidGeneratorSetting.ts

@@ -1,10 +1,9 @@
+import type { UuidFormat } from "./UuidFormat";
 import type { UuidVersion } from "./UuidVersion";
 
 export type UuidGeneratorSetting = {
     uuidVersion: UuidVersion;
     numberOfUuids: number;
-    uppercase: boolean;
-    hyphens: boolean;
-    braces: boolean;
-    quotes: boolean;
+    generatorFormat: UuidFormat;
+    searchResultFormats: UuidFormat[];
 };

src/common/Extensions/UuidGenerator/index.ts

@@ -1,2 +1,3 @@
+export * from "./UuidFormat";
 export * from "./UuidGeneratorSetting";
 export * from "./UuidVersion";

src/main/Extensions/UuidGenerator/UuidGenerator.ts

@@ -1,3 +1,4 @@
+import type { UuidFormat } from "@common/Extensions/UuidGenerator";
 import { v4 as uuidv4, v6 as uuidv6, v7 as uuidv7, validate as uuidValidate } from "uuid";
 
 export class UuidGenerator {
@@ -13,24 +14,64 @@ export class UuidGenerator {
         return uuidv7();
     }
 
-    public static format(uuid: string, uppercase: boolean, hyphens: boolean, braces: boolean, quotes: boolean): string {
+    public static format(uuid: string, format: UuidFormat): string {
         if (!uuidValidate(uuid)) {
             throw new Error("Invalid UUID");
         }
 
         let formattedUuid = uuid;
-        if (uppercase) {
+        if (format.uppercase) {
             formattedUuid = formattedUuid.toUpperCase();
         }
-        if (!hyphens) {
+        if (!format.hyphens) {
             formattedUuid = formattedUuid.replace(/-/g, "");
         }
-        if (braces) {
+        if (format.braces) {
             formattedUuid = `{${formattedUuid}}`;
         }
-        if (quotes) {
+        if (format.quotes) {
             formattedUuid = `"${formattedUuid}"`;
         }
         return formattedUuid;
     }
+
+    public static reformat(uuid: string, format: UuidFormat): string {
+        let formattedUuid = uuid.replace(/["{}-]/g, "");
+        if (format.uppercase) {
+            formattedUuid = formattedUuid.toUpperCase();
+        } else {
+            formattedUuid = formattedUuid.toLowerCase();
+        }
+        if (format.hyphens) {
+            const tempUuid = formattedUuid.replace(/-/g, "");
+
+            formattedUuid =
+                tempUuid.substring(0, 8) +
+                "-" +
+                tempUuid.substring(8, 12) +
+                "-" +
+                tempUuid.substring(12, 16) +
+                "-" +
+                tempUuid.substring(16, 20) +
+                "-" +
+                tempUuid.substring(20);
+        } else {
+            formattedUuid = formattedUuid.replace(/-/g, "");
+        }
+        if (format.braces) {
+            formattedUuid = `{${formattedUuid}}`;
+        } else {
+            formattedUuid = formattedUuid.replace(/[{}]/g, "");
+        }
+        if (format.quotes) {
+            formattedUuid = `"${formattedUuid}"`;
+        } else {
+            formattedUuid = formattedUuid.replace(/"/g, "");
+        }
+        return formattedUuid;
+    }
+
+    public static validateUuid(uuid: string): boolean {
+        return uuidValidate(uuid);
+    }
 }

src/main/Extensions/UuidGenerator/UuidGeneratorExtension.ts

@@ -12,7 +12,7 @@ import {
 import { getExtensionSettingKey } from "@common/Core/Extension";
 import type { Image } from "@common/Core/Image";
 import type { Resources, Translations } from "@common/Core/Translator";
-import type { UuidGeneratorSetting as Settings, UuidVersion } from "@common/Extensions/UuidGenerator";
+import type { UuidGeneratorSetting as Settings, UuidFormat, UuidVersion } from "@common/Extensions/UuidGenerator";
 import { UuidGenerator } from "./UuidGenerator";
 
 export class UuidGeneratorExtension implements Extension {
@@ -22,10 +22,8 @@ export class UuidGeneratorExtension implements Extension {
     public readonly defaultSettings: Settings = {
         uuidVersion: "v4",
         numberOfUuids: 10,
-        uppercase: false,
-        hyphens: true,
-        braces: false,
-        quotes: false,
+        generatorFormat: { uppercase: false, hyphens: true, braces: false, quotes: false },
+        searchResultFormats: [],
     };
 
     public readonly author = {
@@ -40,40 +38,78 @@ export class UuidGeneratorExtension implements Extension {
     ) {}
 
     public getInstantSearchResultItems(searchTerm: string): InstantSearchResultItems {
+        const uuidFormats: UuidFormat[] = this.getSettingValue("searchResultFormats");
+
+        let uuidSearchTerm = searchTerm;
+        if (uuidSearchTerm.toLowerCase().startsWith("uuid") || uuidSearchTerm.toLowerCase().startsWith("guid")) {
+            uuidSearchTerm = uuidSearchTerm.substring(4);
+        }
+
+        uuidSearchTerm = uuidSearchTerm.trim();
+        const possibleUuid = UuidGenerator.reformat(uuidSearchTerm, {
+            uppercase: false,
+            hyphens: true,
+            braces: false,
+            quotes: false,
+        });
+        if (this.validateUuid(possibleUuid)) {
+            return {
+                after: [],
+                before: uuidFormats.map((format, index) => {
+                    const formattedUuid = UuidGenerator.format(possibleUuid, format);
+
+                    return {
+                        name: formattedUuid,
+                        description: "UUID Generator",
+                        descriptionTranslation: {
+                            key: "generatorResult",
+                            namespace: "extension[UuidGenerator]",
+                        },
+                        id: "uuidGenerator:instantResult-" + index,
+                        image: this.getImage(),
+                        defaultAction: createCopyToClipboardAction({
+                            textToCopy: formattedUuid,
+                            description: "Copy UUID to clipboard",
+                            descriptionTranslation: {
+                                key: "copyUuidToClipboard",
+                                namespace: "extension[UuidGenerator]",
+                            },
+                        }),
+                    };
+                }),
+            };
+        }
+
         if (!["uuid", "guid"].includes(searchTerm.toLowerCase())) {
             return createEmptyInstantSearchResult();
         }
 
-        const uuid = this.generateUuid(
-            this.getSettingValue("uuidVersion"),
-            this.getSettingValue("uppercase"),
-            this.getSettingValue("hyphens"),
-            this.getSettingValue("braces"),
-            this.getSettingValue("quotes"),
-        );
+        const generatedUuid = this.generateUuid(this.getSettingValue("uuidVersion"), false, true, false, false);
 
         return {
             after: [],
-            before: [
-                {
-                    name: uuid,
+            before: uuidFormats.map((format, index) => {
+                const formattedUuid = UuidGenerator.reformat(generatedUuid, format);
+
+                return {
+                    name: formattedUuid,
                     description: "UUID Generator",
                     descriptionTranslation: {
                         key: "generatorResult",
                         namespace: "extension[UuidGenerator]",
                     },
-                    id: "uuidGenerator:instantResult",
+                    id: "uuidGenerator:instantResult-" + index,
                     image: this.getImage(),
                     defaultAction: createCopyToClipboardAction({
-                        textToCopy: uuid,
+                        textToCopy: formattedUuid,
                         description: "Copy UUID to clipboard",
                         descriptionTranslation: {
                             key: "copyUuidToClipboard",
                             namespace: "extension[UuidGenerator]",
                         },
                     }),
-                },
-            ],
+                };
+            }),
         };
     }
 
@@ -110,6 +146,10 @@ export class UuidGeneratorExtension implements Extension {
                 hyphens: "Hyphens",
                 braces: "Braces",
                 quotes: "Quotes",
+                defaultGeneratorFormat: "Generator window format",
+                searchResultFormats: "Search result formats",
+                addSearchResultFormat: "Add format",
+                removeSearchResultFormat: "Remove format",
             },
             "de-CH": {
                 copyUuidToClipboard: "UUID in die Zwischenablage kopieren",
@@ -122,6 +162,10 @@ export class UuidGeneratorExtension implements Extension {
                 hyphens: "Bindestriche",
                 braces: "Geschweifte Klammern",
                 quotes: "Anführungszeichen",
+                defaultGeneratorFormat: "Format im Generator-Fenster",
+                searchResultFormats: "Formate der Suchresultate",
+                addSearchResultFormat: "Format hinzufügen",
+                removeSearchResultFormat: "Format entfernen",
             },
         };
     }
@@ -146,10 +190,10 @@ export class UuidGeneratorExtension implements Extension {
             result.push(
                 this.generateUuid(
                     settings.uuidVersion,
-                    settings.uppercase,
-                    settings.hyphens,
-                    settings.braces,
-                    settings.quotes,
+                    settings.generatorFormat.uppercase,
+                    settings.generatorFormat.hyphens,
+                    settings.generatorFormat.braces,
+                    settings.generatorFormat.quotes,
                 ),
             );
         }
@@ -181,7 +225,7 @@ export class UuidGeneratorExtension implements Extension {
             }
         }
 
-        return UuidGenerator.format(uuid, uppercase, hyphens, braces, quotes);
+        return UuidGenerator.format(uuid, { uppercase, hyphens, braces, quotes });
     }
 
     private getSettingValue<T>(key: keyof Settings): T {
@@ -190,4 +234,8 @@ export class UuidGeneratorExtension implements Extension {
             <T>this.getSettingDefaultValue(key),
         );
     }
+
+    private validateUuid(uuid: string): boolean {
+        return UuidGenerator.validateUuid(uuid);
+    }
 }

src/renderer/Extensions/UuidGenerator/Generator.tsx

@@ -69,12 +69,15 @@ export const Generator = ({
     const generate = async () => {
         try {
             const uuids = await contextBridge.invokeExtension<UuidGeneratorSetting, InvocationResult>(extensionId, {
-                uuidVersion,
-                numberOfUuids,
-                uppercase,
-                hyphens,
-                braces,
-                quotes,
+                uuidVersion: uuidVersion,
+                numberOfUuids: numberOfUuids,
+                generatorFormat: {
+                    uppercase: uppercase,
+                    hyphens: hyphens,
+                    braces: braces,
+                    quotes: quotes,
+                },
+                searchResultFormats: [],
             });
 
             setGeneratedUuids(uuids.join("\n"));