@stevenkellner/team-conduct-api 2.0.3 → 2.0.4

package/lib/src/types/PayedState.d.ts

@@ -20,6 +20,13 @@ export declare namespace PayedState {
      * @returns Localized string representation of the payment state
      */
     function formatted(state: PayedState, locale: Locale): string;
+    /**
+     * Toggles the payment state between 'payed' and 'notPayed'.
+     *
+     * @param state - The current payment state
+     * @returns The toggled payment state
+     */
+    function toggled(state: PayedState): PayedState;
     /**
      * Type builder for PayedState serialization/deserialization.
      */

package/lib/src/types/PayedState.js

@@ -21,6 +21,21 @@ var PayedState;
         return Localization_1.Localization.shared(locale).payedState[state].value();
     }
     PayedState.formatted = formatted;
+    /**
+     * Toggles the payment state between 'payed' and 'notPayed'.
+     *
+     * @param state - The current payment state
+     * @returns The toggled payment state
+     */
+    function toggled(state) {
+        switch (state) {
+            case 'payed':
+                return 'notPayed';
+            case 'notPayed':
+                return 'payed';
+        }
+    }
+    PayedState.toggled = toggled;
     /**
      * Type builder for PayedState serialization/deserialization.
      */

package/lib/test/types/PayedState.test.js

@@ -86,6 +86,37 @@ describe('PayedState', () => {
             });
         });
     });
+    describe('PayedState.toggled', () => {
+        it('should toggle payed to notPayed', () => {
+            const result = PayedState_1.PayedState.toggled('payed');
+            (0, core_1.expect)(result).toBeEqual('notPayed');
+        });
+        it('should toggle notPayed to payed', () => {
+            const result = PayedState_1.PayedState.toggled('notPayed');
+            (0, core_1.expect)(result).toBeEqual('payed');
+        });
+        it('should toggle back and forth', () => {
+            const state1 = 'payed';
+            const state2 = PayedState_1.PayedState.toggled(state1);
+            const state3 = PayedState_1.PayedState.toggled(state2);
+            (0, core_1.expect)(state2).toBeEqual('notPayed');
+            (0, core_1.expect)(state3).toBeEqual('payed');
+        });
+        it('should toggle all payment states', () => {
+            PayedState_1.PayedState.all.forEach(state => {
+                const toggled = PayedState_1.PayedState.toggled(state);
+                (0, core_1.expect)(toggled).not.toBeEqual(state);
+                (0, core_1.expect)(PayedState_1.PayedState.all.includes(toggled)).toBeTrue();
+            });
+        });
+        it('should be reversible', () => {
+            PayedState_1.PayedState.all.forEach(state => {
+                const toggledOnce = PayedState_1.PayedState.toggled(state);
+                const toggledTwice = PayedState_1.PayedState.toggled(toggledOnce);
+                (0, core_1.expect)(toggledTwice).toBeEqual(state);
+            });
+        });
+    });
     describe('PayedState.builder', () => {
         it('should build valid payment state from string', () => {
             const state = PayedState_1.PayedState.builder.build('payed');

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@stevenkellner/team-conduct-api",
-    "version": "2.0.3",
+    "version": "2.0.4",
     "description": "Firebase API for Team Conduct",
     "license": "MIT",
     "author": "Steven Kellner",

package/src/types/PayedState.ts

@@ -29,6 +29,21 @@ export namespace PayedState {
         return Localization.shared(locale).payedState[state].value();
     }
 
+    /**
+     * Toggles the payment state between 'payed' and 'notPayed'.
+     *
+     * @param state - The current payment state
+     * @returns The toggled payment state
+     */
+    export function toggled(state: PayedState): PayedState {
+        switch (state) {
+        case 'payed':
+            return 'notPayed';
+        case 'notPayed':
+            return 'payed';
+        }
+    }
+
     /**
      * Type builder for PayedState serialization/deserialization.
      */