Typescript conversion (#1805)

1 files changed, 122 insertions, 0 deletions

diff --git a/src/models/Recipe.ts b/src/models/Recipe.ts
new file mode 100644
index 000000000..33d383983
--- /dev/null
+++ b/src/models/Recipe.ts
@@ -0,0 +1,122 @@
+import semver from 'semver';
+import { pathExistsSync } from 'fs-extra';
+import { join } from 'path';
+
+interface IRecipe {
+  id: string;
+  name: string;
+  version: string;
+  aliases?: string[];
+  path: string;
+  config: {
+    serviceURL?: string;
+    hasDirectMessages?: boolean;
+    hasIndirectMessages?: boolean;
+    hasNotificationSound?: boolean;
+    hasTeamId?: boolean;
+    hasCustomUrl?: boolean;
+    hasHostedOption?: boolean;
+    urlInputPrefix?: string;
+    urlInputSuffix?: string;
+    disablewebsecurity?: boolean;
+    autoHibernate?: boolean;
+    partition?: string;
+    message?: string;
+  };
+}
+
+export default class Recipe {
+  // Note: Do NOT change these default values. If they change, then the corresponding changes in the recipes needs to be done
+  id: string = '';
+
+  name: string = '';
+
+  description = '';
+
+  version: string = '';
+
+  aliases: string[] = [];
+
+  path: string = '';
+
+  serviceURL: string = '';
+
+  hasDirectMessages: boolean = true;
+
+  hasIndirectMessages: boolean = false;
+
+  hasNotificationSound: boolean = false;
+
+  hasTeamId: boolean = false;
+
+  hasCustomUrl: boolean = false;
+
+  hasHostedOption: boolean = false;
+
+  urlInputPrefix: string = '';
+
+  urlInputSuffix: string = '';
+
+  message: string = '';
+
+  disablewebsecurity: boolean = false;
+
+  autoHibernate: boolean = false;
+
+  partition: string = '';
+
+  // TODO: Need to reconcile which of these are optional/mandatory
+  constructor(data: IRecipe) {
+    if (!data) {
+      throw Error('Recipe config not valid');
+    }
+
+    if (!data.id) {
+      // Ferdi 4 recipes do not have an Id
+      throw Error(`Recipe '${data.name}' requires Id`);
+    }
+
+    try {
+      if (!semver.valid(data.version)) {
+        throw Error(`Version ${data.version} of recipe '${data.name}' is not a valid semver version`);
+      }
+    } catch (e) {
+      console.warn(e.message);
+    }
+
+    this.id = data.id || this.id;
+    this.name = data.name || this.name;
+    this.version = data.version || this.version;
+    this.aliases = data.aliases || this.aliases;
+    this.path = data.path;
+
+    this.serviceURL = data.config.serviceURL || this.serviceURL;
+
+    this.hasDirectMessages = data.config.hasDirectMessages || this.hasDirectMessages;
+    this.hasIndirectMessages = data.config.hasIndirectMessages || this.hasIndirectMessages;
+    this.hasNotificationSound = data.config.hasNotificationSound || this.hasNotificationSound;
+    this.hasTeamId = data.config.hasTeamId || this.hasTeamId;
+    this.hasCustomUrl = data.config.hasCustomUrl || this.hasCustomUrl;
+    this.hasHostedOption = data.config.hasHostedOption || this.hasHostedOption;
+
+    this.urlInputPrefix = data.config.urlInputPrefix || this.urlInputPrefix;
+    this.urlInputSuffix = data.config.urlInputSuffix || this.urlInputSuffix;
+
+    this.disablewebsecurity = data.config.disablewebsecurity || this.disablewebsecurity;
+
+    this.autoHibernate = data.config.autoHibernate || this.autoHibernate;
+
+    this.partition = data.config.partition || this.partition;
+
+    this.message = data.config.message || this.message;
+  }
+
+  // TODO: Need to remove this if its not used anywhere
+  get author(): string[] {
+    return [];
+  }
+
+  get hasDarkMode(): boolean {
+    return pathExistsSync(join(this.path, 'darkmode.css'));
+  }
+}