Merge pull request #397 from emilefokkemanavara/fix/rule-types

fix: type of Rule constructor and Rule's name

Author: chris-pardy

test/rule.test.mjs

@@ -12,6 +12,11 @@ describe("Rule", () => {
   });
 
   describe("constructor()", () => {
+    it("can be initialized without anything", () => {
+      const rule = new Rule();
+      expect(rule.name).toBeUndefined();
+    })
+
     it("can be initialized with priority, conditions, event, and name", () => {
       const condition = {
         all: [Object.assign({}, conditionBase)],

test/types.test-d.mts

@@ -87,6 +87,11 @@ describe("type tests", () => {
     const rule = new Rule(ruleProps);
     const ruleFromString: Rule = new Rule(JSON.stringify(ruleProps));
 
+    it("name of rule is possibly undefined", () => {
+      const ruleWithoutInit = new Rule();
+      expectTypeOf<string | undefined>(ruleWithoutInit.name);
+    })
+
     it("returns the engine when adding a rule", () => {
       expectTypeOf<Engine>(engine.addRule(rule));
     });

types/index.d.ts

@@ -189,8 +189,8 @@ export interface RuleResult {
 }
 
 export class Rule implements RuleProperties {
-  constructor(ruleProps: RuleProperties | string);
-  name: string;
+  constructor(ruleProps?: RuleProperties | string);
+  name?: string;
   conditions: TopLevelCondition;
   event: Event;
   priority: number;