feat: add ScriptManager system and metadata + custom script example

Author: Koalhack

src/const.ts

@@ -0,0 +1,19 @@
+import { fileURLToPath } from 'node:url';
+import path from 'node:path';
+
+/////////////////////
+//      Paths      //
+/////////////////////
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const __rootpath = path.resolve(__dirname, '..');
+
+export const defaultScriptPath = path.join(__rootpath, 'src', 'scripts/');
+
+/////////////////////
+//     Metas       //
+/////////////////////
+
+export const metaStartTerm = '/**';
+export const metaEndTerm = '**/';

src/main.ts

@@ -0,0 +1,17 @@
+import process from 'node:process';
+import type { Arguments } from './types.js';
+import { ScriptManager } from './scriptManager.js';
+
+const args: Arguments = JSON.parse(process.argv[2] ?? '{}');
+const { method, parameters } = args;
+
+if (method === 'query') {
+}
+
+if (method === 'do_something_for_query') {
+}
+
+let scriptManager = new ScriptManager();
+scriptManager.init();
+
+console.log(scriptManager.scripts);

src/models/Script.ts

@@ -0,0 +1,27 @@
+import type { Metas } from '../types.js';
+
+type ScriptArguments = {
+  script: string;
+  parameters: Metas;
+  builtIn: boolean;
+};
+
+export class Script {
+  isBuiltInt: boolean;
+  scriptCode: string;
+
+  name: string | undefined;
+  desc: string | undefined;
+  tags: string[] | undefined;
+  bias: number | undefined;
+
+  constructor({ script, parameters, builtIn }: ScriptArguments) {
+    this.scriptCode = script;
+    this.isBuiltInt = builtIn;
+
+    this.name = parameters['name'] as string;
+    this.desc = parameters['description'] as string;
+    this.tags = (parameters['tags'] as string).split(',');
+    this.bias = parameters['bias'] as number;
+  }
+}

src/scriptManager.ts

@@ -0,0 +1,47 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import type { Metas } from './types.js';
+import { defaultScriptPath, metaEndTerm, metaStartTerm } from './const.js';
+import { stringRange } from './utils/utils.js';
+import { Script } from './models/Script.js';
+
+export class ScriptManager {
+  scripts: Script[];
+
+  constructor() {
+    this.scripts = [];
+  }
+
+  init() {
+    this.loadDefaultScripts();
+  }
+
+  loadDefaultScripts() {
+    let scriptsFilenames = fs
+      .readdirSync(defaultScriptPath)
+      .filter(file => file.includes('.js'));
+
+    scriptsFilenames.forEach(filename => {
+      this.loadScript(path.join(defaultScriptPath, filename));
+    });
+  }
+
+  loadScript(path: string) {
+    try {
+      let script: string = fs.readFileSync(path).toString();
+
+      let meta = stringRange(script, metaStartTerm, metaEndTerm);
+      let jsonMeta = JSON.parse(meta) as Metas;
+
+      let scriptObject = new Script({
+        script: script,
+        parameters: jsonMeta,
+        builtIn: true
+      });
+
+      this.scripts.push(scriptObject);
+    } catch (e) {
+      console.error(`Unable to load ${path}, Error: ${e}`);
+    }
+  }
+}

src/scripts/JoinLines.js

@@ -0,0 +1,14 @@
+/**
+	{
+		"api":1,
+		"name":"Join Lines",
+		"description":"Joins all lines without any delimiter.",
+		"author":"riesentoaster",
+		"icon":"collapse",
+		"tags":"join"
+	}
+**/
+
+function main(input) {
+  input.text = input.text.replace(/\n/g, '');
+}

src/types.ts

@@ -0,0 +1,27 @@
+/////////////////////////////
+//      Flow Launcher      //
+/////////////////////////////
+
+export type Arguments = {
+  method: string;
+  parameters: string[];
+};
+
+export type Result = {
+  Title: string;
+  Subtitle: string;
+  JsonRPCAction?: {
+    method: string;
+    parameters: string[];
+  };
+  IcoPath?: string;
+  score?: number;
+};
+
+/////////////////////
+//      Metas      //
+/////////////////////
+
+export type Metas = {
+  [key: string]: any;
+};

src/utils/metas.ts

@@ -0,0 +1,3 @@
+function stringRange(str: string, start: string, end: string): string {
+  return str.substring(str.indexOf(start) + start.length, str.indexOf(end));
+}

src/utils/utils.ts

@@ -0,0 +1,16 @@
+/**
+ * Return part of a string based on terms
+ * @param str The string range.
+ * @param start The term searched to start range.
+ * @param end The term searched to end range.
+ */
+export function stringRange(str: string, start: string, end: string): string {
+  const NOT_FOUND = -1;
+  let startPos = str.indexOf(start);
+  let endPos = str.indexOf(end);
+
+  if (startPos === NOT_FOUND || endPos === NOT_FOUND)
+    throw new Error('Search terms not found');
+
+  return str.substring(str.indexOf(start) + start.length, str.indexOf(end));
+}