codika 3.0.0

package/dist/cli/templates/config-template.js

@@ -0,0 +1,350 @@
+/**
+ * Config Template Generator
+ *
+ * Generates a config.ts file for a new use case following the patterns
+ * established in simple-translator and subworkflow-demo.
+ */
+/**
+ * Generate a complete config.ts file as a string.
+ */
+export function generateConfigTs(params) {
+    const { name, slug, description, icon, withDataIngestion } = params;
+    const dataIngestionImport = withDataIngestion
+        ? `\n  type ProcessDataIngestionConfigInput,`
+        : '';
+    return `/**
+ * ${name} - Configuration
+ *
+ * Generated by codika init.
+ * Edit this file to customize your use case deployment configuration.
+ */
+
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import {
+  loadAndEncodeWorkflow,
+  type FormInputSchema,
+  type FormOutputSchema,
+  type HttpTrigger,
+  type ScheduleTrigger,
+  type SubworkflowTrigger,
+  type ProcessDeploymentConfigurationInput,${dataIngestionImport}
+} from 'codika';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+/**
+ * List of workflow files for archiving and metadata
+ */
+export const WORKFLOW_FILES = [
+  join(__dirname, 'workflows/main-workflow.json'),
+  join(__dirname, 'workflows/scheduled-report.json'),
+  join(__dirname, 'workflows/text-processor.json'),
+];
+
+/**
+ * Get the complete deployment configuration for this use case
+ */
+export function getConfiguration(): ProcessDeploymentConfigurationInput {
+  const httpTriggerId = crypto.randomUUID();
+  const scheduleTriggerId = crypto.randomUUID();
+  const subworkflowTriggerId = crypto.randomUUID();
+
+  // URL patterns with placeholders
+  const webhookUrl = \`{{ORGSECRET_N8N_BASE_URL_TERCESORG}}/webhook/{{PROCDATA_PROCESS_ID_ATADCORP}}/{{USERDATA_PROCESS_INSTANCE_UID_ATADRESU}}/${slug}\`;
+  const manualTriggerUrl = \`{{ORGSECRET_N8N_BASE_URL_TERCESORG}}/webhook/{{PROCDATA_PROCESS_ID_ATADCORP}}/{{USERDATA_PROCESS_INSTANCE_UID_ATADRESU}}/${slug}-report\`;
+
+  // Load and encode workflows
+  const mainWorkflowBase64 = loadAndEncodeWorkflow(
+    join(__dirname, 'workflows/main-workflow.json')
+  );
+  const scheduledReportBase64 = loadAndEncodeWorkflow(
+    join(__dirname, 'workflows/scheduled-report.json')
+  );
+  const textProcessorBase64 = loadAndEncodeWorkflow(
+    join(__dirname, 'workflows/text-processor.json')
+  );
+
+  const workflows = [
+    // Main workflow - user-facing HTTP trigger
+    {
+      workflowTemplateId: 'main-workflow',
+      workflowId: 'main-workflow',
+      workflowName: 'Main Workflow',
+      markdownInfo: getMainWorkflowMarkdown(),
+      knowledgeBaseAccess: {
+        processDocTags: [],
+        processInstanceDocTags: [],
+      },
+      integrationUids: [] as string[],
+      triggers: [
+        {
+          triggerId: httpTriggerId,
+          type: 'http' as const,
+          url: webhookUrl,
+          method: 'POST' as const,
+          title: 'Process Text',
+          description: 'Submit text to be processed',
+          inputSchema: getInputSchema(),
+        } satisfies HttpTrigger,
+      ],
+      outputSchema: getOutputSchema(),
+      n8nWorkflowJsonBase64: mainWorkflowBase64,
+      cost: 1,
+    },
+    // Scheduled report workflow
+    {
+      workflowTemplateId: 'scheduled-report',
+      workflowId: 'scheduled-report',
+      workflowName: 'Scheduled Report',
+      markdownInfo: getScheduledReportMarkdown(),
+      knowledgeBaseAccess: {
+        processDocTags: [],
+        processInstanceDocTags: [],
+      },
+      integrationUids: [] as string[],
+      triggers: [
+        {
+          triggerId: scheduleTriggerId,
+          type: 'schedule' as const,
+          cronExpression: '0 9 * * 1',
+          timezone: 'Europe/Amsterdam',
+          humanReadable: 'Every Monday at 9:00 AM',
+          manualTriggerUrl: manualTriggerUrl,
+          title: 'Weekly Report',
+          description: 'Generates a report every Monday at 9 AM',
+        } satisfies ScheduleTrigger,
+      ],
+      outputSchema: getReportOutputSchema(),
+      n8nWorkflowJsonBase64: scheduledReportBase64,
+      cost: 1,
+    },
+    // Text processor sub-workflow (called by main workflow)
+    {
+      workflowTemplateId: 'text-processor',
+      workflowId: 'text-processor',
+      workflowName: 'Text Processor',
+      markdownInfo: getTextProcessorMarkdown(),
+      knowledgeBaseAccess: {
+        processDocTags: [],
+        processInstanceDocTags: [],
+      },
+      integrationUids: [] as string[],
+      triggers: [
+        {
+          triggerId: subworkflowTriggerId,
+          type: 'subworkflow' as const,
+          title: 'Process Text',
+          description: 'Called by Main Workflow to process text',
+          inputSchema: [{ name: 'text', type: 'string' as const }],
+          calledBy: ['main-workflow'],
+        } satisfies SubworkflowTrigger,
+      ],
+      outputSchema: [] as FormOutputSchema,
+      n8nWorkflowJsonBase64: textProcessorBase64,
+      cost: 0, // Sub-workflows don't cost credits
+    },
+  ];
+
+  return {
+    title: ${JSON.stringify(name)},
+    subtitle: ${JSON.stringify(description)},
+    description: ${JSON.stringify(description)},
+    workflows,
+    processDeploymentMarkdown: getProcessMarkdown(),
+    tags: ['demo'],
+    integrationUids: [],
+    icon: ${JSON.stringify(icon)},
+  };
+}
+
+// ============================================================================
+// Schema Definitions
+// ============================================================================
+
+function getInputSchema(): FormInputSchema {
+  return [
+    {
+      key: 'text',
+      type: 'text',
+      label: 'Text',
+      description: 'Enter the text to process',
+      placeholder: 'Enter text...',
+      required: true,
+      maxLength: 5000,
+      rows: 4,
+    },
+  ];
+}
+
+function getOutputSchema(): FormOutputSchema {
+  return [
+    {
+      key: 'result',
+      type: 'text',
+      label: 'Result',
+      description: 'The processed result',
+      required: true,
+      rows: 4,
+    },
+    {
+      key: 'processedAt',
+      type: 'string',
+      label: 'Processed At',
+      description: 'Timestamp of processing',
+      required: true,
+      maxLength: 100,
+    },
+  ];
+}
+
+function getReportOutputSchema(): FormOutputSchema {
+  return [
+    {
+      key: 'title',
+      type: 'string',
+      label: 'Report Title',
+      required: true,
+      maxLength: 200,
+    },
+    {
+      key: 'summary',
+      type: 'text',
+      label: 'Summary',
+      required: true,
+      rows: 4,
+    },
+    {
+      key: 'generatedAt',
+      type: 'string',
+      label: 'Generated At',
+      required: true,
+      maxLength: 100,
+    },
+  ];
+}
+
+// ============================================================================
+// Markdown Documentation
+// ============================================================================
+
+function getMainWorkflowMarkdown(): string {
+  return \`# Main Workflow
+
+## Purpose
+Receives text input via HTTP and delegates processing to the text-processor sub-workflow.
+
+## How It Works
+1. User submits text via the HTTP trigger
+2. Input is validated
+3. Text is sent to the text-processor sub-workflow
+4. Processed result is returned
+
+## Input
+- **Text**: The text to process
+
+## Output
+- **Result**: The processed text
+- **Processed At**: Timestamp of processing\`;
+}
+
+function getScheduledReportMarkdown(): string {
+  return \`# Scheduled Report
+
+## Purpose
+Generates a report on a recurring schedule (every Monday at 9 AM).
+
+## How It Works
+1. Schedule trigger fires automatically
+2. Report is generated
+3. Result is submitted
+
+## Output
+- **Title**: Report title
+- **Summary**: Report summary
+- **Generated At**: Timestamp\`;
+}
+
+function getTextProcessorMarkdown(): string {
+  return \`# Text Processor (Sub-Workflow)
+
+## Purpose
+Called by the main workflow to process text. Not directly accessible by users.
+
+## How It Works
+1. Receives text from the parent workflow
+2. Processes the text (uppercase + timestamp)
+3. Returns the result to the parent
+
+## Input (from parent)
+- **text**: String to process
+
+## Output (to parent)
+- **originalText**: The original input
+- **processedText**: Processed version
+- **processedAt**: ISO timestamp\`;
+}
+
+function getProcessMarkdown(): string {
+  return \`# ${name.replace(/`/g, "'")}
+
+${description.replace(/`/g, "'")}
+
+## Workflows
+
+### Main Workflow
+- **Trigger**: HTTP POST
+- **Function**: Receives user input, validates it, and delegates to the text processor sub-workflow
+
+### Scheduled Report
+- **Trigger**: Schedule (every Monday at 9 AM)
+- **Function**: Generates a periodic report
+
+### Text Processor (Sub-Workflow)
+- **Trigger**: Called by Main Workflow (not user-accessible)
+- **Function**: Processes text and returns the result
+
+## Getting Started
+
+1. Edit the workflow JSON files in \\\`workflows/\\\` to add your business logic
+2. Update the schemas in this file to match your input/output
+3. Run: \\\`codika verify use-case .\\\`
+4. Run: \\\`codika deploy use-case .\\\`\`;
+}
+${withDataIngestion ? generateDataIngestionSection(slug) : ''}`;
+}
+function generateDataIngestionSection(slug) {
+    return `
+// ============================================================================
+// Data Ingestion Configuration (Process-Level)
+// ============================================================================
+
+/**
+ * Get the data ingestion configuration for this use case.
+ *
+ * This is deployed separately via:
+ *   codika deploy process-data-ingestion <path>
+ *
+ * The workflow file is auto-discovered from the data-ingestion/ folder.
+ */
+export function getDataIngestionConfig(): ProcessDataIngestionConfigInput {
+  const workflowBase64 = loadAndEncodeWorkflow(
+    join(__dirname, 'data-ingestion/${slug}-embedding-ingestion.json')
+  );
+
+  return {
+    workflowTemplateId: '${slug}-embedding-ingestion',
+    workflowName: 'Embedding Ingestion',
+    n8nWorkflowJsonBase64: workflowBase64,
+    webhooks: {
+      embed: \\\`{{PROCDATA_PROCESS_ID_ATADCORP}}/embed\\\`,
+      delete: \\\`{{PROCDATA_PROCESS_ID_ATADCORP}}/embed-delete\\\`,
+    },
+    purpose: 'Embed KB documents into Pinecone for RAG retrieval',
+    cost: 2,
+  };
+}
+`;
+}
+//# sourceMappingURL=config-template.js.map

package/dist/cli/templates/config-template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-template.js","sourceRoot":"","sources":["../../../src/cli/templates/config-template.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAUH;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAA4B;IAC3D,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC;IAEpE,MAAM,mBAAmB,GAAG,iBAAiB;QAC3C,CAAC,CAAC,2CAA2C;QAC7C,CAAC,CAAC,EAAE,CAAC;IAEP,OAAO;KACJ,IAAI;;;;;;;;;;;;;;;6CAeoC,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;kJAwBkF,IAAI;wJACE,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aA+F/I,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBACjB,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;mBACxB,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;;;;;YAKlC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAoIjB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;;EAEpC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;;;;;;;;;;;;;;;;;;;;;;;EAuB9B,iBAAiB,CAAC,CAAC,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AAChE,CAAC;AAED,SAAS,4BAA4B,CAAC,IAAY;IAChD,OAAO;;;;;;;;;;;;;;;sCAe6B,IAAI;;;;2BAIf,IAAI;;;;;;;;;;;CAW9B,CAAC;AACF,CAAC"}

package/dist/cli/templates/skill-templates.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Skill Template Generators
+ *
+ * Generate SKILL.md files for the init command.
+ * Each skill follows the Claude Agent Skills format:
+ * - YAML frontmatter with name, description, workflowTemplateId
+ * - Concise markdown body (under 500 lines)
+ * - Third-person descriptions
+ *
+ * See: https://platform.claude.com/docs/en/agents-and-tools/agent-skills/overview
+ */
+export interface SkillTemplateParams {
+    slug: string;
+    name: string;
+}
+/**
+ * Generate the SKILL.md for the HTTP-triggered main workflow.
+ */
+export declare function generateMainWorkflowSkill(params: SkillTemplateParams): string;
+/**
+ * Generate the SKILL.md for the scheduled report workflow.
+ */
+export declare function generateScheduledReportSkill(params: SkillTemplateParams): string;
+//# sourceMappingURL=skill-templates.d.ts.map

package/dist/cli/templates/skill-templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"skill-templates.d.ts","sourceRoot":"","sources":["../../../src/cli/templates/skill-templates.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,mBAAmB,GAAG,MAAM,CAiD7E;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,mBAAmB,GAAG,MAAM,CAgDhF"}

package/dist/cli/templates/skill-templates.js

@@ -0,0 +1,117 @@
+/**
+ * Skill Template Generators
+ *
+ * Generate SKILL.md files for the init command.
+ * Each skill follows the Claude Agent Skills format:
+ * - YAML frontmatter with name, description, workflowTemplateId
+ * - Concise markdown body (under 500 lines)
+ * - Third-person descriptions
+ *
+ * See: https://platform.claude.com/docs/en/agents-and-tools/agent-skills/overview
+ */
+/**
+ * Generate the SKILL.md for the HTTP-triggered main workflow.
+ */
+export function generateMainWorkflowSkill(params) {
+    const { slug, name } = params;
+    return `---
+name: ${slug}-process-text
+description: Submits text for AI processing via the main-workflow HTTP endpoint of the ${name} use case. Returns processed text with a timestamp.
+workflowTemplateId: main-workflow
+---
+
+# Process Text
+
+Receives text input via HTTP POST and processes it using AI (OpenAI). Calls the text-processor sub-workflow internally.
+
+## How to trigger
+
+\`\`\`bash
+codika trigger main-workflow --payload-file - <<'EOF'
+{
+  "text_input": "Your text to process",
+  "processing_mode": "summarize"
+}
+EOF
+\`\`\`
+
+## Input
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| text_input | string | yes | The text to process (max 5000 chars) |
+| processing_mode | select | yes | One of: "summarize", "analyze", "translate" |
+
+## Output
+
+\`\`\`json
+{
+  "result": "Processed text output",
+  "processedAt": "2025-01-01T00:00:00.000Z"
+}
+\`\`\`
+
+| Field | Type | Description |
+|-------|------|-------------|
+| result | string | The processed text output |
+| processedAt | string | ISO 8601 timestamp of when processing completed |
+
+## Notes
+
+- Cost: 1 credit per execution
+- Uses OpenAI for text processing (via Flex Credentials)
+`;
+}
+/**
+ * Generate the SKILL.md for the scheduled report workflow.
+ */
+export function generateScheduledReportSkill(params) {
+    const { slug, name } = params;
+    return `---
+name: ${slug}-scheduled-report
+description: Generates a weekly report automatically every Monday at 9 AM for the ${name} use case. Can be manually triggered for testing via codika trigger.
+workflowTemplateId: scheduled-report
+---
+
+# Scheduled Report
+
+Runs automatically on a schedule (every Monday at 9:00 AM Brussels time). No user input required for automatic execution.
+
+## Automatic execution
+
+This workflow is triggered automatically by n8n's schedule trigger. Results are stored and viewable in the Codika dashboard.
+
+## Manual trigger (for testing)
+
+To trigger the report manually (bypasses the schedule):
+
+\`\`\`bash
+codika trigger scheduled-report
+\`\`\`
+
+No payload is required. The manual trigger webhook converges with the schedule trigger inside the workflow.
+
+## Output
+
+| Field | Type | Description |
+|-------|------|-------------|
+| title | string | Report title |
+| summary | string | Report summary text |
+| generatedAt | string | ISO 8601 timestamp |
+
+\`\`\`json
+{
+  "title": "Weekly Report - 2025-03-15",
+  "summary": "Summary of activity for the past week...",
+  "generatedAt": "2025-03-15T09:00:00.000Z"
+}
+\`\`\`
+
+## Notes
+
+- Cost: 1 credit per execution (automatic or manual)
+- Schedule: Every Monday at 9:00 AM (Europe/Brussels)
+- No input parameters needed
+`;
+}
+//# sourceMappingURL=skill-templates.js.map

package/dist/cli/templates/skill-templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"skill-templates.js","sourceRoot":"","sources":["../../../src/cli/templates/skill-templates.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAOH;;GAEG;AACH,MAAM,UAAU,yBAAyB,CAAC,MAA2B;IACnE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;IAC9B,OAAO;QACD,IAAI;yFAC6E,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4C5F,CAAC;AACF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,4BAA4B,CAAC,MAA2B;IACtE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;IAC9B,OAAO;QACD,IAAI;oFACwE,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2CvF,CAAC;AACF,CAAC"}

package/dist/cli/templates/slug.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Slug utility for generating URL-safe identifiers from display names.
+ */
+/**
+ * Convert a display name to a URL-safe slug.
+ * "My Translation Service" → "my-translation-service"
+ */
+export declare function toSlug(name: string): string;
+//# sourceMappingURL=slug.d.ts.map

package/dist/cli/templates/slug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slug.d.ts","sourceRoot":"","sources":["../../../src/cli/templates/slug.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQ3C"}

package/dist/cli/templates/slug.js

@@ -0,0 +1,17 @@
+/**
+ * Slug utility for generating URL-safe identifiers from display names.
+ */
+/**
+ * Convert a display name to a URL-safe slug.
+ * "My Translation Service" → "my-translation-service"
+ */
+export function toSlug(name) {
+    return name
+        .toLowerCase()
+        .trim()
+        .replace(/[^a-z0-9\s-]/g, '')
+        .replace(/\s+/g, '-')
+        .replace(/-+/g, '-')
+        .replace(/^-|-$/g, '');
+}
+//# sourceMappingURL=slug.js.map

package/dist/cli/templates/slug.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"slug.js","sourceRoot":"","sources":["../../../src/cli/templates/slug.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AACH,MAAM,UAAU,MAAM,CAAC,IAAY;IACjC,OAAO,IAAI;SACR,WAAW,EAAE;SACb,IAAI,EAAE;SACN,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC;SAC5B,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SACpB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAC3B,CAAC"}