@friggframework/admin-scripts 2.0.0--canary.517.c197eb5.0 → 2.0.0--canary.517.542a9ec.0

package/README.md

@@ -76,8 +76,8 @@ class AttioHealingScript extends AdminScriptBase {
             requireIntegrationInstance: true, // needs this.context.instantiate()
         },
 
-        // Optional default schedule (can be overridden at runtime via the API)
-        schedule: { enabled: false, cronExpression: 'cron(0 12 * * ? *)' },
+        // No schedule here — a script is a capability. An admin activates a
+        // recurring run at runtime via PUT /admin/scripts/:name/schedule.
 
         display: { category: 'maintenance' },
     };
@@ -203,7 +203,7 @@ curl "https://<your-app>/admin/scripts/attio-healing/executions?status=FAILED&li
 
 ## Scheduling
 
-A script can ship a default schedule in its `Definition.schedule`, and operators can override it at runtime. The **effective** schedule resolves as: runtime override (DB) → definition default → none.
+Scripts don't declare a schedule — a script is a capability. An admin activates a recurring run at runtime via `PUT .../schedule`, which persists the schedule and provisions it in EventBridge. The **effective** schedule is therefore either the runtime override (DB) or none — there is no code-defined default that fires on its own.
 
 ```bash
 # Enable a daily 6am UTC run

package/package.json

@@ -1,19 +1,19 @@
 {
     "name": "@friggframework/admin-scripts",
     "prettier": "@friggframework/prettier-config",
-    "version": "2.0.0--canary.517.c197eb5.0",
+    "version": "2.0.0--canary.517.542a9ec.0",
     "description": "Admin Script Runner for Frigg - Execute maintenance and operational scripts in hosted environments",
     "dependencies": {
         "@aws-sdk/client-scheduler": "^3.588.0",
-        "@friggframework/core": "2.0.0--canary.517.c197eb5.0",
+        "@friggframework/core": "2.0.0--canary.517.542a9ec.0",
         "@hapi/boom": "^10.0.1",
         "express": "^4.18.2",
         "serverless-http": "^3.2.0"
     },
     "devDependencies": {
-        "@friggframework/eslint-config": "2.0.0--canary.517.c197eb5.0",
-        "@friggframework/prettier-config": "2.0.0--canary.517.c197eb5.0",
-        "@friggframework/test": "2.0.0--canary.517.c197eb5.0",
+        "@friggframework/eslint-config": "2.0.0--canary.517.542a9ec.0",
+        "@friggframework/prettier-config": "2.0.0--canary.517.542a9ec.0",
+        "@friggframework/test": "2.0.0--canary.517.542a9ec.0",
         "eslint": "^8.22.0",
         "jest": "^29.7.0",
         "prettier": "^2.7.1",
@@ -44,5 +44,5 @@
         "maintenance",
         "operations"
     ],
-    "gitHead": "c197eb5c237e263a8d1b65a94f213ee4732b3c57"
+    "gitHead": "542a9ec92adca85b29dd727125bbeb5d7e688dbc"
 }

package/src/application/__tests__/admin-script-base.test.js

@@ -18,16 +18,11 @@ describe('AdminScriptBase', () => {
                     name: 'test-script',
                     version: '1.0.0',
                     description: 'A test script',
-                    source: 'BUILTIN',
+                    source: 'USER_DEFINED',
                     inputSchema: { type: 'object' },
                     outputSchema: { type: 'object' },
-                    schedule: {
-                        enabled: true,
-                        cronExpression: 'cron(0 12 * * ? *)',
-                    },
                     config: {
                         timeout: 600000,
-                        maxRetries: 3,
                         requireIntegrationInstance: true,
                     },
                     display: {
@@ -40,8 +35,7 @@ describe('AdminScriptBase', () => {
             expect(TestScript.Definition.name).toBe('test-script');
             expect(TestScript.Definition.version).toBe('1.0.0');
             expect(TestScript.Definition.description).toBe('A test script');
-            expect(TestScript.Definition.source).toBe('BUILTIN');
-            expect(TestScript.Definition.schedule.enabled).toBe(true);
+            expect(TestScript.Definition.source).toBe('USER_DEFINED');
             expect(TestScript.Definition.config.timeout).toBe(600000);
         });
 

package/src/application/admin-script-base.js

@@ -8,10 +8,8 @@ class AdminScriptBase {
         inputSchema: null,
         outputSchema: null,
 
-        schedule: {
-            enabled: false,
-            cronExpression: null,
-        },
+        // Scheduling is not declared here — a script is a capability. Admins
+        // activate a schedule at runtime via PUT /admin/scripts/:name/schedule.
 
         config: {
             timeout: 300000,

package/src/application/use-cases/__tests__/delete-schedule-use-case.test.js

@@ -88,33 +88,7 @@ describe('DeleteScheduleUseCase', () => {
             expect(result.schedulerWarning).toBe('Scheduler delete failed');
         });
 
-        it('should return definition schedule as effective after deletion', async () => {
-            const definitionSchedule = {
-                enabled: true,
-                cronExpression: '0 6 * * *',
-                timezone: 'America/Los_Angeles',
-            };
-
-            mockScriptFactory.has.mockReturnValue(true);
-            mockScriptFactory.get.mockReturnValue({
-                Definition: { schedule: definitionSchedule },
-            });
-            mockCommands.deleteSchedule.mockResolvedValue({
-                deletedCount: 1,
-                deleted: { scriptName: 'test-script' },
-            });
-
-            const result = await useCase.execute('test-script');
-
-            expect(result.effectiveSchedule.source).toBe('definition');
-            expect(result.effectiveSchedule.enabled).toBe(true);
-            expect(result.effectiveSchedule.cronExpression).toBe('0 6 * * *');
-            expect(result.effectiveSchedule.timezone).toBe(
-                'America/Los_Angeles'
-            );
-        });
-
-        it('should default timezone to UTC when not in definition', async () => {
+        it('always returns none after deletion, ignoring any Definition schedule', async () => {
             mockScriptFactory.has.mockReturnValue(true);
             mockScriptFactory.get.mockReturnValue({
                 Definition: {
@@ -128,10 +102,11 @@ describe('DeleteScheduleUseCase', () => {
 
             const result = await useCase.execute('test-script');
 
-            expect(result.effectiveSchedule.timezone).toBe('UTC');
+            expect(result.effectiveSchedule.source).toBe('none');
+            expect(result.effectiveSchedule.enabled).toBe(false);
         });
 
-        it('should return none as effective when no definition schedule', async () => {
+        it('should return none as effective after deletion', async () => {
             mockScriptFactory.has.mockReturnValue(true);
             mockScriptFactory.get.mockReturnValue({ Definition: {} });
             mockCommands.deleteSchedule.mockResolvedValue({

package/src/application/use-cases/__tests__/get-effective-schedule-use-case.test.js

@@ -42,41 +42,6 @@ describe('GetEffectiveScheduleUseCase', () => {
             expect(result.schedule).toEqual(dbSchedule);
         });
 
-        it('should return definition schedule when no database override', async () => {
-            const definitionSchedule = {
-                enabled: true,
-                cronExpression: '0 12 * * *',
-                timezone: 'America/New_York',
-            };
-
-            mockScriptFactory.has.mockReturnValue(true);
-            mockScriptFactory.get.mockReturnValue({
-                Definition: { schedule: definitionSchedule },
-            });
-            mockCommands.getScheduleByScriptName.mockResolvedValue(null);
-
-            const result = await useCase.execute('test-script');
-
-            expect(result.source).toBe('definition');
-            expect(result.schedule.enabled).toBe(true);
-            expect(result.schedule.cronExpression).toBe('0 12 * * *');
-            expect(result.schedule.timezone).toBe('America/New_York');
-        });
-
-        it('should default timezone to UTC when not specified in definition', async () => {
-            mockScriptFactory.has.mockReturnValue(true);
-            mockScriptFactory.get.mockReturnValue({
-                Definition: {
-                    schedule: { enabled: true, cronExpression: '0 12 * * *' },
-                },
-            });
-            mockCommands.getScheduleByScriptName.mockResolvedValue(null);
-
-            const result = await useCase.execute('test-script');
-
-            expect(result.schedule.timezone).toBe('UTC');
-        });
-
         it('should return none when no schedule configured', async () => {
             mockScriptFactory.has.mockReturnValue(true);
             mockScriptFactory.get.mockReturnValue({ Definition: {} });
@@ -89,10 +54,12 @@ describe('GetEffectiveScheduleUseCase', () => {
             expect(result.schedule.scriptName).toBe('test-script');
         });
 
-        it('should return none when definition schedule is disabled', async () => {
+        it('ignores any schedule declared in the Definition (DB override is the only source)', async () => {
             mockScriptFactory.has.mockReturnValue(true);
             mockScriptFactory.get.mockReturnValue({
-                Definition: { schedule: { enabled: false } },
+                Definition: {
+                    schedule: { enabled: true, cronExpression: '0 12 * * *' },
+                },
             });
             mockCommands.getScheduleByScriptName.mockResolvedValue(null);
 

package/src/application/use-cases/delete-schedule-use-case.js

@@ -6,7 +6,8 @@ const Boom = require('@hapi/boom');
  * Application Layer - Hexagonal Architecture
  *
  * Deletes a schedule override and cleans up external scheduler resources.
- * Returns the effective schedule after deletion (may fall back to definition).
+ * After deletion the script has no active schedule — schedules are never
+ * derived from the Definition; an admin re-activates one via PUT /schedule.
  */
 class DeleteScheduleUseCase {
     constructor({ commands, schedulerAdapter, scriptFactory }) {
@@ -32,9 +33,9 @@ class DeleteScheduleUseCase {
             deleteResult.deleted?.externalScheduleId
         );
 
-        // Determine effective schedule after deletion
-        const effectiveSchedule =
-            this._getEffectiveScheduleAfterDeletion(scriptName);
+        // Nothing derives a schedule from the Definition, so once the DB
+        // override is removed the script has no active schedule.
+        const effectiveSchedule = { source: 'none', enabled: false };
 
         return {
             success: true,
@@ -57,37 +58,6 @@ class DeleteScheduleUseCase {
         }
     }
 
-    /**
-     * Get the definition schedule from a script class
-     * @private
-     */
-    _getDefinitionSchedule(scriptName) {
-        const scriptClass = this.scriptFactory.get(scriptName);
-        return scriptClass.Definition?.schedule || null;
-    }
-
-    /**
-     * Determine effective schedule after deletion
-     * @private
-     */
-    _getEffectiveScheduleAfterDeletion(scriptName) {
-        const definitionSchedule = this._getDefinitionSchedule(scriptName);
-
-        if (definitionSchedule?.enabled) {
-            return {
-                source: 'definition',
-                enabled: definitionSchedule.enabled,
-                cronExpression: definitionSchedule.cronExpression,
-                timezone: definitionSchedule.timezone || 'UTC',
-            };
-        }
-
-        return {
-            source: 'none',
-            enabled: false,
-        };
-    }
-
     /**
      * Cleanup external scheduler resources
      * @private

package/src/application/use-cases/get-effective-schedule-use-case.js

@@ -5,10 +5,12 @@ const Boom = require('@hapi/boom');
  *
  * Application Layer - Hexagonal Architecture
  *
- * Resolves the effective schedule for a script following priority:
- * 1. Database override (runtime configuration)
- * 2. Definition default (code-defined schedule)
- * 3. None (manual execution only)
+ * Resolves the effective schedule for a script:
+ * 1. Database override (activated at runtime via PUT /schedule)
+ * 2. None (script is declared but not actively scheduled)
+ *
+ * Schedules are never derived from the script Definition — a script declares
+ * a capability; an admin activates a schedule explicitly via the API.
  */
 class GetEffectiveScheduleUseCase {
     constructor({ commands, scriptFactory }) {
@@ -19,7 +21,7 @@ class GetEffectiveScheduleUseCase {
     /**
      * Get effective schedule for a script
      * @param {string} scriptName - Name of the script
-     * @returns {Promise<{source: 'database'|'definition'|'none', schedule: Object}>}
+     * @returns {Promise<{source: 'database'|'none', schedule: Object}>}
      */
     async execute(scriptName) {
         this._validateScriptExists(scriptName);
@@ -35,21 +37,8 @@ class GetEffectiveScheduleUseCase {
             };
         }
 
-        // Priority 2: Definition default
-        const definitionSchedule = this._getDefinitionSchedule(scriptName);
-        if (definitionSchedule?.enabled) {
-            return {
-                source: 'definition',
-                schedule: {
-                    scriptName,
-                    enabled: definitionSchedule.enabled,
-                    cronExpression: definitionSchedule.cronExpression,
-                    timezone: definitionSchedule.timezone || 'UTC',
-                },
-            };
-        }
-
-        // Priority 3: No schedule
+        // No database override: the script is declared but not actively
+        // scheduled. Admins activate scheduling explicitly via PUT /schedule.
         return {
             source: 'none',
             schedule: {
@@ -67,14 +56,6 @@ class GetEffectiveScheduleUseCase {
             throw Boom.notFound(`Script "${scriptName}" not found`);
         }
     }
-
-    /**
-     * @private
-     */
-    _getDefinitionSchedule(scriptName) {
-        const scriptClass = this.scriptFactory.get(scriptName);
-        return scriptClass.Definition?.schedule || null;
-    }
 }
 
 module.exports = { GetEffectiveScheduleUseCase };

package/src/infrastructure/__tests__/admin-script-router.test.js

@@ -107,7 +107,6 @@ describe('Admin Script Router', () => {
                 description: 'Test script',
                 category: 'test',
                 requireIntegrationInstance: false,
-                schedule: null,
             });
         });
 
@@ -352,12 +351,13 @@ describe('Admin Script Router', () => {
             expect(response.body.timezone).toBe('America/New_York');
         });
 
-        it('should return definition schedule when no database override', async () => {
+        it('ignores a schedule declared in the Definition (no DB override → none)', async () => {
             mockCommands.getScheduleByScriptName = jest
                 .fn()
                 .mockResolvedValue(null);
 
-            // Update test script to include schedule
+            // A script may still carry a schedule field, but it is never used —
+            // only a DB override (set via PUT) activates a schedule.
             class ScheduledTestScript extends TestScript {
                 static Definition = {
                     ...TestScript.Definition,
@@ -376,10 +376,8 @@ describe('Admin Script Router', () => {
             );
 
             expect(response.status).toBe(200);
-            expect(response.body.source).toBe('definition');
-            expect(response.body.enabled).toBe(true);
-            expect(response.body.cronExpression).toBe('0 0 * * *');
-            expect(response.body.timezone).toBe('UTC');
+            expect(response.body.source).toBe('none');
+            expect(response.body.enabled).toBe(false);
         });
 
         it('should return none when no schedule configured', async () => {
@@ -656,13 +654,14 @@ describe('Admin Script Router', () => {
             );
         });
 
-        it('should return definition schedule after deleting override', async () => {
+        it('reports no active schedule after deleting the override', async () => {
             mockCommands.deleteSchedule = jest.fn().mockResolvedValue({
                 acknowledged: true,
                 deletedCount: 1,
             });
 
-            // Update test script to include schedule
+            // Even if the script carries a schedule field, it is ignored —
+            // after removing the DB override there is no active schedule.
             class ScheduledTestScript extends TestScript {
                 static Definition = {
                     ...TestScript.Definition,
@@ -681,8 +680,8 @@ describe('Admin Script Router', () => {
             );
 
             expect(response.status).toBe(200);
-            expect(response.body.effectiveSchedule.source).toBe('definition');
-            expect(response.body.effectiveSchedule.enabled).toBe(true);
+            expect(response.body.effectiveSchedule.source).toBe('none');
+            expect(response.body.effectiveSchedule.enabled).toBe(false);
         });
 
         it('should handle no schedule found', async () => {

package/src/infrastructure/admin-script-router.js

@@ -125,7 +125,6 @@ router.get('/scripts', async (req, res) => {
                 category: s.definition.display?.category || 'custom',
                 requireIntegrationInstance:
                     s.definition.config?.requireIntegrationInstance || false,
-                schedule: s.definition.schedule || null,
             })),
         });
     } catch (error) {
@@ -161,7 +160,6 @@ router.get('/scripts/:scriptName', async (req, res) => {
             outputSchema: definition.outputSchema,
             config: definition.config,
             display: definition.display,
-            schedule: definition.schedule,
         });
     } catch (error) {
         console.error('Error getting script:', error);