codika 3.1.0 → 3.2.0

package/dist/validation/use-case-scripts/schedule-trigger-fields.js

@@ -0,0 +1,140 @@
+/**
+ * SCHEDULE-TRIGGER-FIELDS Validation Script
+ *
+ * Validates that schedule triggers in config.ts have all required fields:
+ * - cronExpression: the cron schedule
+ * - timezone: IANA timezone (e.g., 'Europe/Brussels')
+ * - humanReadable: plain English schedule description (e.g., 'Every 5 minutes')
+ * - manualTriggerUrl: webhook URL for manual/dashboard-triggered runs
+ *
+ * These fields are required by the deployment API but were not previously
+ * validated by the CLI, causing confusing deployment failures after
+ * successful verification.
+ */
+import { readFileSync, existsSync } from 'fs';
+import { join } from 'path';
+export const RULE_ID = 'SCHEDULE-TRIGGER-FIELDS';
+export const metadata = {
+    id: RULE_ID,
+    name: 'schedule_trigger_fields',
+    severity: 'must',
+    description: 'Schedule triggers must include cronExpression, timezone, humanReadable, and manualTriggerUrl',
+    details: 'The deployment API requires all four fields on every schedule trigger. ' +
+        'Missing any of them causes a deployment failure with INVALID_CONFIGURATION.',
+    fixable: false,
+    category: 'triggers',
+};
+const REQUIRED_FIELDS = ['cronExpression', 'timezone', 'humanReadable', 'manualTriggerUrl'];
+const FIELD_EXAMPLES = {
+    cronExpression: '"*/5 * * * *"',
+    timezone: '"Europe/Brussels"',
+    humanReadable: '"Every 5 minutes"',
+    manualTriggerUrl: '`{{ORGSECRET_N8N_BASE_URL_TERCESORG}}/webhook/{{PROCDATA_PROCESS_ID_ATADCORP}}/{{USERDATA_PROCESS_INSTANCE_UID_ATADRESU}}/<workflow-slug>-manual`',
+};
+/**
+ * Extracts schedule trigger blocks from config.ts content.
+ *
+ * Strategy:
+ * 1. Find all workflowTemplateId values
+ * 2. For each workflow block, find triggers with type: 'schedule'
+ * 3. Extract what fields are present in each schedule trigger
+ */
+function extractScheduleTriggers(configContent) {
+    const results = [];
+    const lines = configContent.split('\n');
+    // Find all workflow blocks by workflowTemplateId
+    const templateIdPattern = /workflowTemplateId:\s*['"]([^'"]+)['"]/g;
+    let templateMatch;
+    while ((templateMatch = templateIdPattern.exec(configContent)) !== null) {
+        const templateId = templateMatch[1];
+        const templateIdPos = templateMatch.index;
+        // Find end of this workflow block (next workflowTemplateId or end of content)
+        const nextPattern = /workflowTemplateId:/g;
+        nextPattern.lastIndex = templateIdPos + templateMatch[0].length;
+        const nextMatch = nextPattern.exec(configContent);
+        const blockEnd = nextMatch ? nextMatch.index : configContent.length;
+        const workflowBlock = configContent.slice(templateIdPos, blockEnd);
+        // Check if this block contains a schedule trigger
+        if (!workflowBlock.includes("type: 'schedule'") && !workflowBlock.includes('type: "schedule"')) {
+            continue;
+        }
+        // Find the line number of the schedule type declaration within the full content
+        const scheduleTypeOffset = workflowBlock.search(/type:\s*['"]schedule['"]/);
+        const absoluteOffset = templateIdPos + scheduleTypeOffset;
+        const triggerStartLine = configContent.slice(0, absoluteOffset).split('\n').length;
+        // Check which required fields are present in the trigger block
+        // We need to scope to just the trigger object, not the whole workflow block.
+        // Find the triggers: [...] content first
+        const triggersMatch = workflowBlock.match(/triggers:\s*\[([\s\S]*?)\]\s*,?\s*\n/);
+        const triggersContent = triggersMatch ? triggersMatch[1] : workflowBlock;
+        const presentFields = new Set();
+        for (const field of REQUIRED_FIELDS) {
+            // Match field: followed by a value (string, template literal, or variable)
+            const fieldPattern = new RegExp(`${field}\\s*:`);
+            if (fieldPattern.test(triggersContent)) {
+                presentFields.add(field);
+            }
+        }
+        results.push({
+            workflowTemplateId: templateId,
+            triggerBlockContent: triggersContent,
+            triggerStartLine,
+            presentFields,
+        });
+    }
+    return results;
+}
+/**
+ * Validates that all schedule triggers have required fields.
+ */
+export async function checkScheduleTriggerFields(useCasePath) {
+    const findings = [];
+    const configPath = join(useCasePath, 'config.ts');
+    if (!existsSync(configPath)) {
+        return findings;
+    }
+    let configContent;
+    try {
+        configContent = readFileSync(configPath, 'utf-8');
+    }
+    catch {
+        return findings;
+    }
+    const scheduleTriggers = extractScheduleTriggers(configContent);
+    for (const trigger of scheduleTriggers) {
+        const missingFields = REQUIRED_FIELDS.filter(f => !trigger.presentFields.has(f));
+        if (missingFields.length === 0)
+            continue;
+        const missingList = missingFields
+            .map(f => `  - ${f}: ${FIELD_EXAMPLES[f]}`)
+            .join('\n');
+        findings.push({
+            rule: RULE_ID,
+            severity: 'must',
+            path: configPath,
+            line: trigger.triggerStartLine,
+            message: `Schedule trigger in workflow "${trigger.workflowTemplateId}" is missing required field${missingFields.length > 1 ? 's' : ''}: ${missingFields.join(', ')}. ` +
+                `The deployment API will reject this configuration.`,
+            raw_details: `Schedule triggers require all of these fields:\n` +
+                `  - cronExpression: the cron schedule (e.g., "*/5 * * * *")\n` +
+                `  - timezone: IANA timezone (e.g., "Europe/Brussels")\n` +
+                `  - humanReadable: plain English description (e.g., "Every 5 minutes")\n` +
+                `  - manualTriggerUrl: webhook URL for manual runs from the dashboard\n\n` +
+                `Missing in "${trigger.workflowTemplateId}":\n${missingList}\n\n` +
+                `Example of a complete schedule trigger:\n` +
+                `  {\n` +
+                `    triggerId: crypto.randomUUID(),\n` +
+                `    type: "schedule" as const,\n` +
+                `    cronExpression: "*/5 * * * *",\n` +
+                `    timezone: "Europe/Brussels",\n` +
+                `    humanReadable: "Every 5 minutes",\n` +
+                `    manualTriggerUrl: \`\${baseUrl}/my-workflow-manual\`,\n` +
+                `    title: "My Scheduled Task",\n` +
+                `    description: "Runs every 5 minutes",\n` +
+                `  } satisfies ScheduleTrigger`,
+        });
+    }
+    return findings;
+}
+export default checkScheduleTriggerFields;
+//# sourceMappingURL=schedule-trigger-fields.js.map

package/dist/validation/use-case-scripts/schedule-trigger-fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schedule-trigger-fields.js","sourceRoot":"","sources":["../../../src/validation/use-case-scripts/schedule-trigger-fields.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAG5B,MAAM,CAAC,MAAM,OAAO,GAAG,yBAAyB,CAAC;AAEjD,MAAM,CAAC,MAAM,QAAQ,GAAiB;IACpC,EAAE,EAAE,OAAO;IACX,IAAI,EAAE,yBAAyB;IAC/B,QAAQ,EAAE,MAAM;IAChB,WAAW,EAAE,8FAA8F;IAC3G,OAAO,EACL,yEAAyE;QACzE,6EAA6E;IAC/E,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,UAAU;CACrB,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,gBAAgB,EAAE,UAAU,EAAE,eAAe,EAAE,kBAAkB,CAAU,CAAC;AAErG,MAAM,cAAc,GAA2B;IAC7C,cAAc,EAAE,eAAe;IAC/B,QAAQ,EAAE,mBAAmB;IAC7B,aAAa,EAAE,mBAAmB;IAClC,gBAAgB,EAAE,mJAAmJ;CACtK,CAAC;AAYF;;;;;;;GAOG;AACH,SAAS,uBAAuB,CAAC,aAAqB;IACpD,MAAM,OAAO,GAA0B,EAAE,CAAC;IAC1C,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAExC,iDAAiD;IACjD,MAAM,iBAAiB,GAAG,yCAAyC,CAAC;IACpE,IAAI,aAAa,CAAC;IAElB,OAAO,CAAC,aAAa,GAAG,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QACxE,MAAM,UAAU,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;QACpC,MAAM,aAAa,GAAG,aAAa,CAAC,KAAK,CAAC;QAE1C,8EAA8E;QAC9E,MAAM,WAAW,GAAG,sBAAsB,CAAC;QAC3C,WAAW,CAAC,SAAS,GAAG,aAAa,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAChE,MAAM,SAAS,GAAG,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC;QACpE,MAAM,aAAa,GAAG,aAAa,CAAC,KAAK,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QAEnE,kDAAkD;QAClD,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAC/F,SAAS;QACX,CAAC;QAED,gFAAgF;QAChF,MAAM,kBAAkB,GAAG,aAAa,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC;QAC5E,MAAM,cAAc,GAAG,aAAa,GAAG,kBAAkB,CAAC;QAC1D,MAAM,gBAAgB,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;QAEnF,+DAA+D;QAC/D,6EAA6E;QAC7E,yCAAyC;QACzC,MAAM,aAAa,GAAG,aAAa,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAClF,MAAM,eAAe,GAAG,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;QAEzE,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;QACxC,KAAK,MAAM,KAAK,IAAI,eAAe,EAAE,CAAC;YACpC,2EAA2E;YAC3E,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,GAAG,KAAK,OAAO,CAAC,CAAC;YACjD,IAAI,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;gBACvC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;QAED,OAAO,CAAC,IAAI,CAAC;YACX,kBAAkB,EAAE,UAAU;YAC9B,mBAAmB,EAAE,eAAe;YACpC,gBAAgB;YAChB,aAAa;SACd,CAAC,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAC,WAAmB;IAClE,MAAM,QAAQ,GAAc,EAAE,CAAC;IAE/B,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAClD,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,IAAI,aAAqB,CAAC;IAC1B,IAAI,CAAC;QACH,aAAa,GAAG,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,aAAa,CAAC,CAAC;IAEhE,KAAK,MAAM,OAAO,IAAI,gBAAgB,EAAE,CAAC;QACvC,MAAM,aAAa,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjF,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QAEzC,MAAM,WAAW,GAAG,aAAa;aAC9B,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;aAC1C,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,OAAO,CAAC,gBAAgB;YAC9B,OAAO,EACL,iCAAiC,OAAO,CAAC,kBAAkB,8BAA8B,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;gBAC7J,oDAAoD;YACtD,WAAW,EACT,kDAAkD;gBAClD,+DAA+D;gBAC/D,yDAAyD;gBACzD,0EAA0E;gBAC1E,0EAA0E;gBAC1E,eAAe,OAAO,CAAC,kBAAkB,OAAO,WAAW,MAAM;gBACjE,2CAA2C;gBAC3C,OAAO;gBACP,uCAAuC;gBACvC,kCAAkC;gBAClC,sCAAsC;gBACtC,oCAAoC;gBACpC,yCAAyC;gBACzC,6DAA6D;gBAC7D,mCAAmC;gBACnC,4CAA4C;gBAC5C,+BAA+B;SAClC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,eAAe,0BAA0B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codika",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Codika SDK - types, utilities, and CLI for use case configuration, validation, and deployment",
   "type": "module",
   "main": "./dist/index.js",