foliko 2.0.6 → 2.0.7

package/plugins/core/workflow/examples/06-script.js

@@ -0,0 +1,82 @@
+/**
+ * Script Workflow (JS Format)
+ * Demonstrates script execution and data transformation
+ */
+
+FLOW(function($) {
+    // Stage 1: Initialize data
+    $.push('init', function($) {
+        const rawData = {
+            users: [
+                { id: 1, name: 'Alice', age: 30, active: true },
+                { id: 2, name: 'Bob', age: 25, active: false },
+                { id: 3, name: 'Charlie', age: 35, active: true }
+            ],
+            threshold: 28
+        };
+        $.send({ rawData });
+        $.next('filter');
+    });
+
+    // Stage 2: Filter with script
+    $.push('filter', function($) {
+        const { users, threshold } = $.data.rawData;
+
+        // Use script to filter users by age
+        const filtered = users.filter(u => u.age >= threshold);
+
+        $.send({ filtered, total: users.length, filteredCount: filtered.length });
+        $.next('transform');
+    });
+
+    // Stage 3: Transform with script
+    $.push('transform', function($) {
+        const { filtered } = $.data;
+
+        // Transform to summary format
+        const summary = filtered.map(u => ({
+            displayName: u.name.toUpperCase(),
+            age: u.age,
+            status: u.active ? 'Active' : 'Inactive'
+        }));
+
+        $.send({ summary });
+        $.next('log');
+    });
+
+    // Stage 4: Log results
+    $.push('log', function($) {
+        const { summary, filteredCount, total } = $.data;
+
+        $.tool.execute('log_event', {
+            event: 'filter_complete',
+            total: total,
+            filtered: filteredCount,
+            summary: JSON.stringify(summary)
+        });
+
+        $.next('notify');
+    });
+
+    // Stage 5: Notify
+    $.push('notify', function($) {
+        const { summary } = $.data;
+        const message = summary
+            .map(u => `${u.displayName} (${u.age}) - ${u.status}`)
+            .join('\n');
+
+        $.tool.execute('notification_send', {
+            title: 'Filtered Users',
+            message: message || 'No users matched criteria'
+        });
+
+        $.next('done');
+    });
+
+    // Done
+    $.push('done', function($) {
+        $.destroy();
+    });
+
+    $.next('init');
+});

package/plugins/core/workflow/examples/07-module-export.js

@@ -0,0 +1,43 @@
+/**
+ * Module Export Workflow Example
+ * Demonstrates module.exports = function($) {} format
+ */
+
+module.exports = function ($) {
+    // Initialize
+    $.push('init', function ($) {
+        const data = {
+            userId: $.input.userId || 1,
+            action: 'process'
+        };
+        $.send({ data });
+        $.next('fetch');
+    });
+
+    // Fetch user data
+    $.push('fetch', async function ($) {
+        const result = await $.tool.execute('fetch', {
+            url: 'https://api.example.com/users/' + $.data.data.userId
+        });
+        $.send({ user: result });
+        $.next('process');
+    });
+
+    // Process based on status
+    $.push('process', function ($) {
+        const status = $.data.user?.body?.status || 'unknown';
+        $.tool.execute('log_event', {
+            event: 'user_processed',
+            userId: $.data.data.userId,
+            status: status
+        });
+        $.next('done');
+    });
+
+    // Done
+    $.push('done', function ($) {
+        $.destroy();
+    });
+
+    $.next('init');
+};

package/plugins/core/workflow/examples/08-default-export.js

@@ -0,0 +1,29 @@
+/**
+ * Default Export Workflow Example
+ * Demonstrates module.exports.default = function($) {} format
+ */
+
+module.exports.default = function ($) {
+    $.push('start', async function ($) {
+        const result = await $.tool.execute('fetch', {
+            url: 'https://api.ipify.org?format=json'
+        });
+        $.send({ ip: result });
+        $.next('notify');
+    });
+
+    $.push('notify', function ($) {
+        const ip = $.data.ip?.body?.ip || 'unknown';
+        $.tool.execute('notification_send', {
+            title: 'IP Address',
+            message: 'Your IP is: ' + ip
+        });
+        $.next('done');
+    });
+
+    $.push('done', function ($) {
+        $.destroy();
+    });
+
+    $.next('start');
+};

package/plugins/core/workflow/examples/09-next-with-args.js

@@ -0,0 +1,50 @@
+/**
+ * $.next() with Arguments - Function Parameters Demo
+ * Demonstrates $.next('stage', arg1, arg2, ...) and function($, a, b, ...) receiving args
+ */
+
+FLOW(function($) {
+    // Stage 1: Fetch and pass data directly to next stage
+    $.push('fetch', async function($, ip) {
+        // ip is undefined in first call, use default value
+        const url = ip || 'https://api.ipify.org?format=json';
+
+        const result = await $.tool.execute('fetch', { url: url });
+        const ipAddress = result?.body?.ip || 'unknown';
+
+        // Pass result directly to next stage - no need for $.send()
+        $.next('process', ipAddress);
+    });
+
+    // Stage 2: Receive IP directly as function parameter
+    $.push('process', function($, ip) {
+        // ip is received directly from $.next('process', ip)
+
+        $.tool.execute('log_event', {
+            event: 'ip_processed',
+            ip: ip
+        });
+
+        // Pass multiple values to next stage
+        $.next('notify', ip, 'success', new Date().toISOString());
+    });
+
+    // Stage 3: Receive multiple parameters as function arguments
+    $.push('notify', function($, ip, status, timestamp) {
+        // ip = '1.2.3.4', status = 'success', timestamp = '2024-...'
+
+        $.tool.execute('notification_send', {
+            title: 'IP Address',
+            message: `IP: ${ip}, Status: ${status}, Time: ${timestamp}`
+        });
+
+        $.next('done');
+    });
+
+    // Done
+    $.push('done', function($) {
+        $.destroy();
+    });
+
+    $.next('fetch');
+});

package/plugins/core/workflow/examples/10-logger.js

@@ -0,0 +1,34 @@
+/**
+ * Logger Example - Demonstrates $.logger usage
+ * Shows different log levels and logger.child()
+ */
+
+FLOW(function($) {
+    // Stage 1: Logging demo
+    $.push('logging-demo', async function($) {
+        // Use different log levels
+        $.logger.debug('Debug: Starting workflow execution');
+        $.logger.info('Info: User input received', { userId: $.input.userId || 1 });
+        $.logger.warn('Warn: This is a warning example');
+        $.logger.error('Error: This is an error example');
+
+        // Use logger.child() for module-specific logging
+        const dbLogger = $.logger.child('database');
+        dbLogger.info('Connecting to database...');
+        dbLogger.info('Query executed successfully');
+
+        const apiLogger = $.logger.child('api');
+        apiLogger.debug('API request sent');
+        apiLogger.info('API response received', { status: 200 });
+
+        $.next('done');
+    });
+
+    // Done
+    $.push('done', function($) {
+        $.logger.info('Workflow completed');
+        $.destroy();
+    });
+
+    $.next('logging-demo');
+});

package/plugins/core/workflow/examples/11-storage.js

@@ -0,0 +1,68 @@
+/**
+ * Storage Example - Demonstrates $.storage usage
+ * Shows set, get, list, delete operations
+ */
+
+FLOW(function($) {
+    // Stage 1: Store data
+    $.push('store-data', async function($) {
+        // Store user preferences
+        await $.storage.set('preferences', {
+            theme: 'dark',
+            language: 'zh-CN'
+        });
+
+        // Store with custom namespace
+        await $.storage.set('session', {
+            userId: 12345,
+            loginTime: new Date().toISOString()
+        }, 'user');
+
+        $.next('retrieve-data');
+    });
+
+    // Stage 2: Retrieve data
+    $.push('retrieve-data', async function($) {
+        // Get preferences
+        const prefs = await $.storage.get('preferences');
+        $.logger.info('Preferences:', prefs?.data);
+
+        // Get user session from namespace
+        const session = await $.storage.get('session', 'user');
+        $.logger.info('User session:', session?.data);
+
+        // Store processed result
+        const processedData = {
+            preferences: prefs?.data,
+            session: session?.data,
+            processed: true
+        };
+        await $.storage.set('processed', processedData);
+
+        $.next('list-keys');
+    });
+
+    // Stage 3: List and cleanup
+    $.push('list-keys', async function($) {
+        // List all keys in default namespace
+        const allKeys = await $.storage.list();
+        $.logger.info('All keys:', allKeys?.data);
+
+        // List keys in user namespace
+        const userKeys = await $.storage.list('user');
+        $.logger.info('User namespace keys:', userKeys?.data);
+
+        // Delete temporary data
+        await $.storage.delete('processed');
+
+        $.next('done');
+    });
+
+    // Done
+    $.push('done', function($) {
+        $.logger.info('Storage workflow completed');
+        $.destroy();
+    });
+
+    $.next('store-data');
+});

package/plugins/core/workflow/examples/simple.js

@@ -0,0 +1,77 @@
+/**
+ * Simple User Onboarding Workflow (JS Format - Total.js Style)
+ * Demonstrates $.next() with arguments and function parameter receiving
+ */
+
+FLOW(function($) {
+    // Stage 1: Fetch user data
+    $.push('fetch-user', async function($, userId) {
+        const id = userId || $.input.userId || 1;
+
+        const result = await $.tool.execute('fetch', {
+            url: 'https://api.example.com/users/' + id
+        });
+
+        // Pass user data directly to next stage
+        $.next('validate', result);
+    });
+
+    // Stage 2: Validate user - receives result as function parameter
+    $.push('validate', function($, result) {
+        const user = result?.body || {};
+        const status = user.status || 'unknown';
+
+        // Route based on status - pass user to target stage
+        if (status === 'active') {
+            $.next('welcome', user);
+        } else if (status === 'pending') {
+            $.next('send-verification', user);
+        } else if (status === 'inactive') {
+            $.next('re-engage', user);
+        } else {
+            $.next('unknown-status', user);
+        }
+    });
+
+    // Stage 3: Welcome active user - receives user directly
+    $.push('welcome', function($, user) {
+        $.extension.execute('notify', 'send_email', {
+            template: 'welcome',
+            userId: user.id
+        });
+        $.next('done');
+    });
+
+    // Stage 4: Send verification
+    $.push('send-verification', function($, user) {
+        $.skill.execute('ambient', 'send-verification', {
+            userId: user.id
+        });
+        $.next('done');
+    });
+
+    // Stage 5: Re-engage inactive user
+    $.push('re-engage', function($, user) {
+        $.extension.execute('notify', 'send_email', {
+            template: 're-engage',
+            userId: user.id
+        });
+        $.next('done');
+    });
+
+    // Stage 6: Handle unknown status
+    $.push('unknown-status', function($, user) {
+        $.tool.execute('notify_admin', {
+            message: 'Unknown user status for user ' + user.id
+        });
+        $.next('done');
+    });
+
+    // Done
+    $.push('done', function($) {
+        $.destroy();
+    });
+
+    // Start with userId from input
+    $.next('fetch-user', 1);
+});

package/plugins/core/workflow/examples/simple.json

@@ -0,0 +1,75 @@
+{
+  "flow": "user-onboarding",
+  "version": "2.0",
+  "description": "User onboarding workflow demonstrating action, choice stages and chain-style accessors",
+  "stages": [
+    {
+      "name": "fetch-user",
+      "tool": "fetch",
+      "args": {
+        "url": "https://api.example.com/users/{{input.userId}}"
+      }
+    },
+    {
+      "name": "validate",
+      "action": "script",
+      "script": "return input.status === 'active' || input.status === 'pending'"
+    },
+    {
+      "name": "route",
+      "choice": [
+        { "when": "validate == true && fetch-user.status == 'active'", "do": "welcome" },
+        { "when": "fetch-user.status == 'pending'", "do": "send-verification" },
+        { "when": "fetch-user.status == 'inactive'", "do": "re-engage" }
+      ],
+      "default": "unknown-status"
+    },
+    {
+      "name": "welcome",
+      "description": "Using extension.execute()",
+      "extension": "notify",
+      "tool": "send_email",
+      "args": {
+        "template": "welcome",
+        "userId": "{{input.userId}}"
+      }
+    },
+    {
+      "name": "send-verification",
+      "description": "Using skill.execute()",
+      "skill": "ambient",
+      "command": "send-verification",
+      "args": {
+        "userId": "{{input.userId}}"
+      }
+    },
+    {
+      "name": "re-engage",
+      "description": "Using extension.execute()",
+      "extension": "notify",
+      "tool": "send_email",
+      "args": {
+        "template": "re-engage",
+        "userId": "{{input.userId}}"
+      }
+    },
+    {
+      "name": "unknown-status",
+      "description": "Using tool.execute()",
+      "tool": "notify_admin",
+      "args": {
+        "message": "Unknown user status for user {{input.userId}}"
+      }
+    },
+    {
+      "name": "log-completion",
+      "description": "Using workflow.execute()",
+      "workflow": "log_event",
+      "args": {
+        "event": "onboarding_complete",
+        "userId": "{{input.userId}}",
+        "finalStatus": "{{route}}"
+      }
+    }
+  ]
+}