feat: add script postInfo and postError + add scripts

Author: Koalhack

src/const.ts

@@ -40,8 +40,9 @@ export const MAIN_FUNCTION_EXEC = 'main(this)';
 // └                   ┘
 
 export const NOTIFY = {
+  title: 'Text Formatter',
   clipboard: {
-    title: 'Clipboard value change',
-    subtitle: 'You have a new value in your clipboard'
+    source: 'CLIP',
+    text: 'Clipboard value change'
   }
 };

src/controllers/NotificationManagerController.ts

@@ -0,0 +1,43 @@
+import { NOTIFY } from '../const.js';
+import type {
+  Notification,
+  NotificationItem,
+  NotificationType
+} from '../types.js';
+import { FlowLauncher } from '../utils/flowLauncher.js';
+
+export class NotificationManagerController {
+  notifications: Notification;
+
+  constructor() {
+    this.notifications = {};
+  }
+
+  add(type: NotificationType, item: NotificationItem) {
+    if (this.notifications[type] === undefined) {
+      this.notifications[type] = [];
+    }
+    this.notifications[type]?.push(item);
+  }
+
+  displayAll() {
+    //INFO: Not sure if this is the best way
+    if (Object.values(this.notifications).length > 0)
+      FlowLauncher.showMessage(NOTIFY.title, this.format());
+  }
+
+  //WARN: Possibly change in futur
+  format(): string {
+    const LINE_FEED = '\n';
+
+    let formattedNotifications = '';
+    for (const [section, items] of Object.entries(this.notifications)) {
+      formattedNotifications += `${String(section).toUpperCase()}${LINE_FEED}`;
+      items.forEach(item => {
+        formattedNotifications += `[${String(item.source).toUpperCase()}] - ${item.text}${LINE_FEED}`;
+      });
+    }
+
+    return formattedNotifications;
+  }
+}

src/main.ts

@@ -2,6 +2,7 @@ import process from 'node:process';
 import type { Arguments } from './types.js';
 import { ScriptManager } from './scriptManager.js';
 import { FlowViewController } from './controllers/FlowViewController.js';
+import { NotificationManagerController } from './controllers/NotificationManagerController.js';
 
 const args: Arguments = JSON.parse(process.argv[2] ?? '{}');
 const { method, parameters } = args;

src/models/ScriptExecution.ts

@@ -1,16 +1,28 @@
+import { NotificationManagerController } from '../controllers/NotificationManagerController.js';
+
 type ScriptExecutionArguments = {
   text: string;
+  notifier: NotificationManagerController;
 };
 
+interface ScriptExecutionJSExport {
+  get text(): string;
+  set text(txt: string);
+  postError(error: string): void;
+  postInfo(info: string): void;
+}
+
 // ╭────────────────────────────────────────────────────────────────────────────────╮
-// │   TODO: postInfo and postError functions (notify user)                         │
 // │   TODO: insert function (clipboard + new value)                                │
 // ╰────────────────────────────────────────────────────────────────────────────────╯
 
-export class ScriptExecution {
+export class ScriptExecution implements ScriptExecutionJSExport {
   fullText: string;
-  constructor({ text }: ScriptExecutionArguments) {
+  notifier: NotificationManagerController;
+
+  constructor({ text, notifier }: ScriptExecutionArguments) {
     this.fullText = text;
+    this.notifier = notifier;
   }
 
   get text(): string {
@@ -20,4 +32,12 @@ export class ScriptExecution {
   set text(txt: string) {
     this.fullText = txt;
   }
+
+  postError(error: string): void {
+    this.notifier.add('ERROR', { source: 'SCRIPT', text: error });
+  }
+
+  postInfo(info: string): void {
+    this.notifier.add('INFO', { source: 'SCRIPT', text: info });
+  }
 }

src/scriptManager.ts

@@ -16,14 +16,20 @@ import { matchesObject, sortByProperty, stringRange } from './utils/utils.js';
 import { Clipboard } from './utils/clipboard.js';
 import { FlowLauncher } from './utils/flowLauncher.js';
 import { ensureError } from './utils/error.js';
+import { NotificationManagerController } from './controllers/NotificationManagerController.js';
 
 export class ScriptManager {
   scripts: Script[];
   scriptsError: ScriptError[];
 
+  //WARN: possibly change in futur
+  notifier: NotificationManagerController;
+
   constructor() {
     this.scripts = [];
     this.scriptsError = [];
+
+    this.notifier = new NotificationManagerController();
   }
 
   init() {
@@ -122,10 +128,16 @@ export class ScriptManager {
     const result = this.runScript(script, clip);
 
     this.replaceText(result, clip);
+
+    //TODO: Possibly change location in futur
+    this.notifier.displayAll();
   }
 
   runScript(script: Script, text: string): string {
-    let scriptExecution = new ScriptExecution({ text: text });
+    let scriptExecution = new ScriptExecution({
+      text: text,
+      notifier: this.notifier
+    });
 
     script.run(scriptExecution);
 
@@ -139,8 +151,7 @@ export class ScriptManager {
 
       //TODO: Possibly change location in futur
       // Notify User from change
-      const { title, subtitle } = NOTIFY.clipboard;
-      FlowLauncher.showMessage(title, subtitle);
+      this.notifier.add('MESSAGE', NOTIFY.clipboard);
     }
   }
 }

src/scripts/ASCIIToHex.js

@@ -0,0 +1,20 @@
+/**
+	{
+		"api":1,
+		"name":"ASCII To Hex",
+		"description":"Converts ASCII characters to hexadecimal codes.",
+		"author":"aWZHY0yQH81uOYvH",
+		"icon":"metamorphose",
+		"tags":"ascii,hex,convert"
+	}
+**/
+
+function main(state) {
+  buf = '';
+  for (i = 0; i < state.text.length; i++) {
+    code = state.text.charCodeAt(i).toString(16);
+    if (code.length < 2) buf += '0';
+    buf += code;
+  }
+  state.text = buf.toUpperCase();
+}

src/scripts/Collapse.js

@@ -0,0 +1,16 @@
+/**
+    {
+        "api":1,
+        "name":"Collapse lines",
+        "description":"Removes all linebreaks from your text",
+        "author":"Dennis",
+        "icon":"collapse",
+        "tags":"strip,remove,collapse,join"
+    }
+**/
+
+function main(input) {
+  let split = input.text.split(/\r\n|\r|\n/);
+  input.postInfo(`${split.length} lines collapsed`);
+  input.text = split.join();
+}

src/scripts/CountCharacters.js

@@ -0,0 +1,14 @@
+/**
+	{
+		"api":1,
+		"name":"Count Characters",
+		"description":"Get the length of your text",
+		"author":"Ivan",
+		"icon":"counter",
+		"tags":"count,length,size,character"
+	}
+**/
+
+function main(input) {
+  input.postInfo(`${input.text.length} characters`);
+}

src/scripts/CountLines.js

@@ -0,0 +1,14 @@
+/**
+	{
+		"api":1,
+		"name":"Count Lines",
+		"description":"Get the line count of your text",
+		"author":"andipaetzold",
+		"icon":"counter",
+		"tags":"count,length,size,line"
+	}
+**/
+
+function main(input) {
+  input.postInfo(`${input.text.split('\n').length} lines`);
+}

src/scripts/CountWords.js

@@ -0,0 +1,15 @@
+/**
+  {
+    "api":1,
+    "name":"Count Words",
+    "description":"Get the word count of your text",
+    "author":"Daniel Stone",
+    "icon":"counter",
+    "tags":"count,length,size,words"
+  }
+**/
+
+function main(input) {
+  let words = input.text.trim().match(/\S+/g);
+  input.postInfo(`${(words && words.length) || 0} words`);
+}