obs-scheduler 0.0.3 → 0.1.2

package/README.md

@@ -40,7 +40,8 @@ Options:
     {
       "name": "Example Event 2",
       "schedule_type": "recurring",
-      "schedule": "* * * * * *",
+      // At 14:15 (2:15pm) on each first day of the month.
+      "schedule": "15 14 1 * *",
       "action": "start_recording"
     }
   ]

package/cli.js

@@ -17,7 +17,7 @@ program
         undefined,
     )
     .option('-c, --config <file-path>', 'config file path')
-    .version('0.0.3')
+    .version('0.1.2')
     .action(run);
 
 await program.parseAsync(process.argv);

package/config-schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "OBS Scheduler Config File Schema",
+  "title": "OBS Scheduler Configuration",
   "type": "object",
   "required": [
     "events"
@@ -13,6 +13,7 @@
       "format": "tabs",
       "items": {
         "title": "Event",
+        "headerTemplate": "{{ self.name }}",
         "description": "A scheduled event for triggering a set action in OBS.",
         "type": "object",
         "required": [
@@ -40,11 +41,23 @@
             "$ref": "#/definitions/ScheduleType"
           },
           "date": {
-            "title": "Date",
-            "description": "A date/time for when the action should trigger.",
+            "title": "Date(s)",
+            "description": "A date/time (or a list of dates/times) for when the action should trigger.",
             "propertyOrder": 4,
-            "type": "string",
-            "format": "datetime-local",
+            "anyOf": [
+              {
+                "title": "Single Date/Time",
+                "$ref": "#/definitions/DateString"
+              },
+              {
+                "title": "Multiple Dates/Times",
+                "type": "array",
+                "uniqueItems": true,
+                "items": {
+                  "$ref": "#/definitions/DateString"
+                }
+              }
+            ],
             "options": {
               "dependencies": {
                 "schedule_type": "date"
@@ -52,10 +65,23 @@
             }
           },
           "schedule": {
-            "title": "Schedule",
-            "description": "[WIP] A schedule for a recurring event.",
+            "title": "Schedule(s)",
+            "description": "A schedule (or a list of schedules) for a recurring event in crontab format.",
             "propertyOrder": 4,
-            "type": "string",
+            "anyOf": [
+              {
+                "title": "Single Schedule",
+                "$ref": "#/definitions/CronTabString"
+              },
+              {
+                "title": "Multiple Schedules",
+                "type": "array",
+                "uniqueItems": true,
+                "items": {
+                  "$ref": "#/definitions/CronTabString"
+                }
+              }
+            ],
             "options": {
               "dependencies": {
                 "schedule_type": "recurring"
@@ -79,69 +105,70 @@
           },
           "ws_request": {
             "title": "OBS Websocket Message",
-            "$ref": "#/definitions/OBSWSRequest"
+            "$ref": "#/definitions/OBSWSRequest",
+            "options": {
+              "dependencies": {
+                "action": "obs_ws"
+              }
+            }
           }
         },
         "allOf": [
           {
-            "oneOf": [
-              {
-                "required": [
-                  "date"
-                ],
-                "properties": {
-                  "schedule_type": {
-                    "const": "date"
-                  }
-                }
-              },
-              {
-                "required": [
-                  "schedule"
-                ],
-                "properties": {
-                  "schedule_type": {
-                    "const": "recurring"
-                  }
+            "if": {
+              "properties": {
+                "schedule_type": {
+                  "const": "date"
                 }
               }
-            ]
+            },
+            "then": {
+              "required": [
+                "date"
+              ]
+            }
           },
           {
-            "oneOf": [
-              {
-                "not": {
-                  "properties": {
-                    "action": {
-                      "enum": [
-                        "advanced_scene_switcher",
-                        "obs_ws"
-                      ]
-                    }
-                  }
+            "if": {
+              "properties": {
+                "schedule_type": {
+                  "const": "recurring"
                 }
-              },
-              {
-                "required": [
-                  "switcher_message"
-                ],
-                "properties": {
-                  "action": {
-                    "const": "advanced_scene_switcher"
-                  }
+              }
+            },
+            "then": {
+              "required": [
+                "schedule"
+              ]
+            }
+          },
+          {
+            "if": {
+              "properties": {
+                "action": {
+                  "const": "advanced_scene_switcher"
                 }
-              },
-              {
-                "required": [
-                  "ws_request"
-                ],
-                "properties": {
-                  "action": {
-                    "const": "obs_ws"
-                  }
+              }
+            },
+            "then": {
+              "required": [
+                "switcher_message"
+              ]
+            }
+          },
+          {
+            "if": {
+              "properties": {
+                "action": {
+                  "const": "obs_ws"
                 }
               }
-            ]
+            },
+            "then": {
+              "required": [
+                "ws_request"
+              ]
+            }
           }
         ],
         "options": {
@@ -166,6 +193,15 @@
         ]
       }
     },
+    "DateString": {
+      "type": "string",
+      "format": "datetime-local"
+    },
+    "CronTabString": {
+      "type": "string",
+      "format": "crontab",
+      "pattern": "^((((\\d+,)+\\d+|(\\d+(\\/|-|#)\\d+)|\\d+L?|\\*(\\/\\d+)?|L(-\\d+)?|\\?|[A-Z]{3}(-[A-Z]{3})?) ?){5,7})|(@(annually|yearly|monthly|weekly|daily|hourly|reboot))|(@every (\\d+(ns|us|µs|ms|s|m|h))+)$"
+    },
     "EventAction": {
       "description": "An action to trigger in OBS.",
       "type": "string",
@@ -199,17 +235,15 @@
       ],
       "additionalProperties": false,
       "properties": {
+        "id": {
+          "type": "string"
+        },
         "type": {
           "type": "string"
         },
         "data": {
           "type": "object"
         }
-      },
-      "options": {
-        "dependencies": {
-          "action": "obs_ws"
-        }
       }
     }
   }

package/dist/config.js

@@ -1,3 +1,4 @@
+import CronExpressionParser from "cron-parser";
 import { DateTime } from "luxon";
 
 /** @typedef {'date'|'recurring'} ConfigEventType */
@@ -8,6 +9,7 @@ import { DateTime } from "luxon";
 
 /**
  * @typedef {Object} OBSWSRequest
+ * @property {string} [id]
  * @property {string} type
  * @property {Object} data
  */
@@ -17,8 +19,8 @@ import { DateTime } from "luxon";
  * @property {string} [name]
  * @property {boolean} [enabled=true]
  * @property {ConfigEventType} schedule_type
- * @property {string} [date] Only present if `schedule_type` is `'date'`.
- * @property {string} [schedule] Only present if `schedule_type` is `'recurring'`.
+ * @property {string|string[]} [date] Only present if `schedule_type` is `'date'`.
+ * @property {string|string[]} [schedule] Only present if `schedule_type` is `'recurring'`.
  * @property {ConfigEventAction} action
  * @property {string} [switcher_message] Only present if `action` is `'advanced_scene_switcher'`.
  * @property {OBSWSRequest} [ws_request] Only present if `action` is `'obs_ws'`.
@@ -36,17 +38,47 @@ import { DateTime } from "luxon";
  * @returns {boolean}
  */
 export function checkEventSchedule(date, event) {
+    // Ignore a disabled event
     if (event.enabled == false) {
         return false;
     }
 
-    if (event.date) {
-        const eventDate = DateTime.fromISO(event.date);
-        // console.log(eventDate.getTime(), date.getTime())
-        return eventDate.startOf('second').toMillis() == date.toMillis();
-    } else if (event.schedule) {
-        // TODO: match `schedule` field
-        return false;
+    if (event.date) { // If event has the `date` field
+        /** @type {string[]} */
+        let datesToCompare = new Array();
+        if (typeof event.date == 'string') {
+            datesToCompare.push(event.date);
+        } else {
+            datesToCompare.push(...event.date);
+        }
+        
+        return datesToCompare.some((eventDate) => {
+            // Parse event's date string to `DateTime`
+            const eventDateTime = DateTime.fromISO(eventDate);
+            // console.log(eventDate.getTime(), date.getTime())
+            // Compare parsed date (rounded to the previous second) to the current `date`
+            return eventDateTime.startOf('second').toMillis() == date.toMillis();
+        });
+    } else if (event.schedule) { // If event has the `schedule` field
+        /** @type {string[]} */
+        let schedulesToCompare = new Array();
+        if (typeof event.schedule == 'string') {
+            schedulesToCompare.push(event.schedule);
+        } else {
+            schedulesToCompare.push(...event.schedule);
+        }
+
+        return schedulesToCompare.some((eventSchedule) => {
+            try {
+                // Parse crontab string
+                const schedule = CronExpressionParser.parse(eventSchedule);
+                // Return if the parsed schedule includes the current `date`
+                return schedule.includesDate(date.toJSDate());
+            } catch (error) {
+                // If parse fails, return `false`
+                return false;
+            }
+        });
     } else {
         return false;
     }

package/dist/index.js

@@ -33,12 +33,14 @@ export async function run() {
     }
 
     /** @type {Config} */
-    let config = {};
+    let config;
 
     function updateConfigFromFile() {
         const fileContents = fs.readFileSync(configPath, "utf8")
             .replace(/^[ \t]*\/\/.+$\n/gm, '');
+        const firstRun = config == undefined;
         config = JSON.parse(fileContents);
+        console.log((firstRun ? 'Read' : 'Updated') + ' configuration file.');
     }
 
     // Read config file for initial value
@@ -54,6 +56,9 @@ export async function run() {
         const matchingEvents = config.events
             .filter(e => checkEventSchedule(date, e));
 
+        // console.log(config.events);
+        console.log(matchingEvents);
+
         const wsRequests = matchingEvents
             .flatMap(convertEventToWebsocketRequest);
 

package/dist/obs.js

@@ -6,7 +6,9 @@
  * @returns {import("obs-websocket-js").RequestBatchRequest[]}
  */
 export function convertEventToWebsocketRequest(event) {
-    const requestID = `${event.name ? event.name + '.' : ''}${event.action}`;
+    const requestID = event.action == 'obs_ws' && event.ws_request?.id
+        ? event.ws_request.id
+        : `${event.name ? event.name + '.' : ''}${event.action}`;
 
     switch (event.action) {
         case "start_stream":

package/examples/config-example.json

@@ -1,17 +1,17 @@
 {
-  "$schema": "../config-schema.json",
+  "$schema": "/Users/edon/Documents/Developer Stuff/NPM Packages/obs-scheduler/config-schema.json",
   "events": [
     {
       "name": "Example Event 1",
       "schedule_type": "date",
-      "date": "2026-01-06T10:59",
-      "action": "start_recording"
-    },
-    {
-      "name": "Example Event 2",
-      "schedule_type": "recurring",
-      "schedule": "",
-      "action": "start_recording"
+      // "date": "2026-01-09T14:49:30",
+      "date": [
+        "2026-01-09T15:06:15",
+        "2026-01-09T15:06:45",
+        "2026-01-09T15:07"
+      ],
+      "action": "advanced_scene_switcher",
+      "switcher_message": "test"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "obs-scheduler",
-  "version": "0.0.3",
+  "version": "0.1.2",
   "description": "A CLI tool for scheduling OBS functionality.",
   "author": "edonv",
   "type": "module",
@@ -19,6 +19,7 @@
   "homepage": "https://github.com/edonv/obs-scheduler#readme",
   "dependencies": {
     "commander": "^14.0.2",
+    "cron-parser": "^5.4.0",
     "luxon": "^3.7.2",
     "obs-websocket-js": "^5.0.7"
   },