feat(rules): Introduced the capability to import and export rules usi…

…ng YAML. Additionally, included a rule glossary in the documentation. * fix: Add toast notification with yaml import/export status * refactor: Use the media type in encode & decode * feat: add a rule glossary & delete duplicate radarr.filedate from constants
jorenn92 · Jan 12, 2024 · 97c52d4 · 97c52d4
1 parent 1e812f7
commit 97c52d4
Show file tree

Hide file tree

Showing 13 changed files with 1,245 additions and 93 deletions.
diff --git a/docs/3-using-maintainerr/1-rules/Glossary.md b/docs/3-using-maintainerr/1-rules/Glossary.md
diff --git a/package.json b/package.json
@@ -30,7 +30,9 @@
     "migration:generate": "ts-node node_modules/typeorm/cli.js migration:generate --dataSource ./datasource-config.ts -p"
   },
   "dependencies": {
+    "@headlessui/react": "1.7.12",
     "@heroicons/react": "^1.0.6",
+    "@monaco-editor/react": "^4.6.0",
     "@nestjs/common": "^10.2.7",
     "@nestjs/core": "^10.3.0",
     "@nestjs/platform-express": "^10.3.0",
@@ -50,6 +52,7 @@
     "plex-api": "^5.3.2",
     "react": "18.2.0",
     "react-dom": "18.2.0",
+    "react-toast-notifications": "^2.5.1",
     "react-transition-group": "^4.4.5",
     "reflect-metadata": "^0.1.13",
     "rimraf": "^5.0.5",
@@ -58,7 +61,8 @@
     "swr": "^2.2.4",
     "typeorm": "^0.3.17",
     "web-push": "^3.6.6",
-    "xml2js": "^0.6.2"
+    "xml2js": "^0.6.2",
+    "yaml": "^2.3.4"
   },
   "devDependencies": {
     "@automock/jest": "^1.4.0",
@@ -94,6 +98,7 @@
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-config-next": "14.0.4",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.0.1",
     "jest": "^29.7.0",
     "jsdoc": "^4.0.2",

diff --git a/server/src/modules/api/plex-api/enums/plex-data-type-enum.ts b/server/src/modules/api/plex-api/enums/plex-data-type-enum.ts
@@ -6,3 +6,11 @@ export enum EPlexDataType {
   SEASONS = 3,
   EPISODES = 4,
 }
+
+// EPlexDataType values as strings
+export const PlexDataTypeStrings: string[] = [
+  'MOVIES',
+  'SHOWS',
+  'SEASONS',
+  'EPISODES',
+];
diff --git a/server/src/modules/rules/constants/rules.constants.ts b/server/src/modules/rules/constants/rules.constants.ts
@@ -1,6 +1,6 @@
 import { EPlexDataType } from '../../api/plex-api/enums/plex-data-type-enum';
 
-export const enum RulePossibility {
+export enum RulePossibility {
   BIGGER,
   SMALLER,
   EQUALS,
@@ -15,7 +15,7 @@ export const enum RulePossibility {
   NOT_CONTAINS_PARTIAL,
 }
 
-export const enum RuleOperators {
+export enum RuleOperators {
   AND,
   OR,
 }
@@ -41,37 +41,51 @@ export const enum MediaType {
 }
 
 export class RuleType {
-  static readonly NUMBER = new RuleType('0', [
-    RulePossibility.BIGGER,
-    RulePossibility.SMALLER,
-    RulePossibility.EQUALS,
-    RulePossibility.NOT_EQUALS,
-    RulePossibility.CONTAINS,
-    RulePossibility.NOT_CONTAINS,
-  ]);
-  static readonly DATE = new RuleType('1', [
-    RulePossibility.EQUALS,
-    RulePossibility.NOT_EQUALS,
-    RulePossibility.BEFORE,
-    RulePossibility.AFTER,
-    RulePossibility.IN_LAST,
-    RulePossibility.IN_NEXT,
-  ]);
-  static readonly TEXT = new RuleType('2', [
-    RulePossibility.EQUALS,
-    RulePossibility.NOT_EQUALS,
-    RulePossibility.CONTAINS,
-    RulePossibility.NOT_CONTAINS,
-    RulePossibility.CONTAINS_PARTIAL,
-    RulePossibility.NOT_CONTAINS_PARTIAL,
-  ]);
-  static readonly BOOL = new RuleType('3', [
-    RulePossibility.EQUALS,
-    RulePossibility.NOT_EQUALS,
-  ]);
-  private constructor(
+  static readonly NUMBER = new RuleType(
+    '0',
+    [
+      RulePossibility.BIGGER,
+      RulePossibility.SMALLER,
+      RulePossibility.EQUALS,
+      RulePossibility.NOT_EQUALS,
+      RulePossibility.CONTAINS,
+      RulePossibility.NOT_CONTAINS,
+    ],
+    'number',
+  );
+  static readonly DATE = new RuleType(
+    '1',
+    [
+      RulePossibility.EQUALS,
+      RulePossibility.NOT_EQUALS,
+      RulePossibility.BEFORE,
+      RulePossibility.AFTER,
+      RulePossibility.IN_LAST,
+      RulePossibility.IN_NEXT,
+    ],
+    'date',
+  );
+  static readonly TEXT = new RuleType(
+    '2',
+    [
+      RulePossibility.EQUALS,
+      RulePossibility.NOT_EQUALS,
+      RulePossibility.CONTAINS,
+      RulePossibility.NOT_CONTAINS,
+      RulePossibility.CONTAINS_PARTIAL,
+      RulePossibility.NOT_CONTAINS_PARTIAL,
+    ],
+    'text',
+  );
+  static readonly BOOL = new RuleType(
+    '3',
+    [RulePossibility.EQUALS, RulePossibility.NOT_EQUALS],
+    'boolean',
+  );
+  public constructor(
     private readonly key: string,
     public readonly possibilities: number[],
+    public readonly humanName: string,
   ) {}
   toString() {
     return this.key;
@@ -300,13 +314,7 @@ export class RuleConstants {
           mediaType: MediaType.MOVIE,
           type: RuleType.DATE,
         } as Property,
-        {
-          id: 1,
-          name: 'fileDate',
-          humanName: 'Date file downloaded',
-          mediaType: MediaType.MOVIE,
-          type: RuleType.DATE,
-        } as Property,
+        // Don't use ID 1, It was once used for an old rule value. Changing the id's messes up existing rules.
         {
           id: 2,
           name: 'tags',

diff --git a/server/src/modules/rules/dtos/rule.dto.ts b/server/src/modules/rules/dtos/rule.dto.ts
@@ -6,4 +6,5 @@ export class RuleDto {
   firstVal: [number, number];
   lastVal?: [number, number];
   customVal?: { ruleTypeId: number; value: string };
+  section: number;
 }