@bubblelab/shared-schemas 0.1.0

package/dist/bubbleflow-execution-schema.js

@@ -0,0 +1,230 @@
+import { z } from '@hono/zod-openapi';
+import { ParsedBubbleWithInfoSchema } from './bubble-definition-schema';
+export const TokenUsageSchema = z
+    .object({
+    inputTokens: z.number().openapi({
+        description: 'Number of input tokens used',
+        example: 150,
+    }),
+    outputTokens: z.number().openapi({
+        description: 'Number of output tokens generated',
+        example: 75,
+    }),
+    totalTokens: z.number().openapi({
+        description: 'Total number of tokens used (input + output)',
+        example: 225,
+    }),
+    modelName: z.string().optional().openapi({
+        description: 'Name of the model used for token consumption',
+        example: 'google/gemini-2.5-flash',
+    }),
+})
+    .openapi('TokenUsage');
+export const ExecutionSummarySchema = z
+    .object({
+    totalDuration: z.number().openapi({
+        description: 'Total execution duration in milliseconds',
+        example: 1500,
+    }),
+    lineExecutionCount: z.number().openapi({
+        description: 'Number of lines executed',
+        example: 25,
+    }),
+    bubbleExecutionCount: z.number().openapi({
+        description: 'Number of bubbles executed',
+        example: 5,
+    }),
+    errorCount: z.number().openapi({
+        description: 'Number of errors encountered',
+        example: 0,
+    }),
+    warningCount: z.number().openapi({
+        description: 'Number of warnings encountered',
+        example: 1,
+    }),
+    averageLineExecutionTime: z.number().openapi({
+        description: 'Average execution time per line in milliseconds',
+        example: 60,
+    }),
+    slowestLines: z
+        .array(z.object({
+        lineNumber: z.number().openapi({
+            description: 'Line number',
+            example: 15,
+        }),
+        duration: z.number().openapi({
+            description: 'Execution duration in milliseconds',
+            example: 250,
+        }),
+        message: z.string().openapi({
+            description: 'Description of what was executed on this line',
+            example: 'API call to external service',
+        }),
+    }))
+        .openapi({
+        description: 'Array of the slowest executing lines',
+    }),
+    memoryPeakUsage: z.any().optional().openapi({
+        description: 'Peak memory usage during execution (NodeJS.MemoryUsage type)',
+    }), // NodeJS.MemoryUsage type
+    startTime: z.number().openapi({
+        description: 'Execution start timestamp (Unix timestamp)',
+        example: 1703123456789,
+    }),
+    endTime: z.number().openapi({
+        description: 'Execution end timestamp (Unix timestamp)',
+        example: 1703123458289,
+    }),
+    tokenUsage: TokenUsageSchema,
+    tokenUsageByModel: z
+        .record(z.string(), TokenUsageSchema.omit({ modelName: true }))
+        .optional()
+        .openapi({
+        description: 'Token usage breakdown by model (key: model name, value: token usage)',
+        example: {
+            'google/gemini-2.5-flash': {
+                inputTokens: 1500,
+                outputTokens: 750,
+                totalTokens: 2250,
+            },
+        },
+    }),
+})
+    .openapi('ExecutionSummary');
+// BubbleFlow execution history item schema
+export const bubbleFlowExecutionSchema = z.object({
+    id: z.number().openapi({ description: 'Execution ID' }),
+    status: z
+        .enum(['running', 'success', 'error'])
+        .openapi({ description: 'Execution status' }),
+    payload: z
+        .record(z.string(), z.any())
+        .openapi({ description: 'Execution payload' }),
+    result: z.any().optional().openapi({ description: 'Execution result data' }),
+    error: z
+        .string()
+        .optional()
+        .openapi({ description: 'Error message if failed' }),
+    startedAt: z.string().openapi({ description: 'Execution start timestamp' }),
+    webhook_url: z.string().openapi({ description: 'Webhook URL' }),
+    completedAt: z
+        .string()
+        .optional()
+        .openapi({ description: 'Execution completion timestamp' }),
+});
+// GET /bubble-flow/:id/executions - List BubbleFlow executions response
+export const listBubbleFlowExecutionsResponseSchema = z
+    .array(bubbleFlowExecutionSchema)
+    .openapi('ListBubbleFlowExecutionsResponse');
+export const executeBubbleFlowResponseSchema = z
+    .object({
+    executionId: z.number().openapi({
+        description: 'ID of the execution record',
+        example: 789,
+    }),
+    success: z.boolean().openapi({
+        description: 'Whether the execution was successful',
+        example: true,
+    }),
+    data: z
+        .any()
+        .optional()
+        .openapi({
+        description: 'Data returned by the BubbleFlow (if successful)',
+        example: { result: 'processed successfully', count: 42 },
+    }),
+    summary: ExecutionSummarySchema.optional().openapi({
+        description: 'Execution summary',
+    }),
+    error: z.string().optional().openapi({
+        description: 'Error message (if execution failed)',
+        example: 'Validation error in BubbleFlow',
+    }),
+})
+    .openapi('ExecuteBubbleFlowResponse');
+// Validation schemas
+export const validateBubbleFlowCodeSchema = z.object({
+    code: z.string().min(1).openapi({
+        description: 'TypeScript BubbleFlow code to validate',
+        example: 'export class TestFlow extends BubbleFlow<"webhook/http"> { async handle() { return {}; } }',
+    }),
+    options: z
+        .object({
+        includeDetails: z.boolean().default(true).openapi({
+            description: 'Include detailed bubble analysis',
+        }),
+        strictMode: z.boolean().default(true).openapi({
+            description: 'Enable strict TypeScript validation',
+        }),
+    })
+        .optional()
+        .openapi({
+        description: 'Validation options',
+    }),
+    flowId: z.number().positive().optional().openapi({
+        description: 'Optional BubbleFlow ID to update with validation results if user owns the flow',
+        example: 123,
+    }),
+    credentials: z
+        .record(z.string(), z.record(z.string(), z.number()))
+        .optional()
+        .openapi({
+        description: 'Optional credentials mapping: bubble name -> credential type -> credential ID',
+        example: {
+            'slack-sender': {
+                SLACK_CRED: 123,
+            },
+            'ai-agent': {
+                OPENAI_CRED: 456,
+            },
+        },
+    }),
+});
+export const validateBubbleFlowCodeResponseSchema = z.object({
+    valid: z.boolean().openapi({
+        description: 'Whether the code is valid',
+    }),
+    errors: z.array(z.string()).optional().openapi({
+        description: 'List of validation errors if any',
+    }),
+    bubbleCount: z.number().optional().openapi({
+        description: 'Number of bubbles found in the code',
+    }),
+    inputSchema: z.record(z.string(), z.unknown()).openapi({
+        description: 'Input schema',
+        example: {
+            name: 'string',
+            age: 'number',
+        },
+    }),
+    bubbles: z.record(z.string(), ParsedBubbleWithInfoSchema).optional().openapi({
+        description: 'Record mapping bubble IDs to their detailed information',
+    }),
+    requiredCredentials: z
+        .record(z.string(), z.array(z.string()))
+        .optional()
+        .openapi({
+        description: 'Required credentials for the bubbles in the code',
+    }),
+    metadata: z
+        .object({
+        validatedAt: z.string().openapi({
+            description: 'Timestamp when validation was performed',
+        }),
+        codeLength: z.number().openapi({
+            description: 'Length of the code in characters',
+        }),
+        strictMode: z.boolean().openapi({
+            description: 'Whether strict mode was used',
+        }),
+        flowUpdated: z.boolean().optional().openapi({
+            description: 'Whether the BubbleFlow was updated with validation results',
+        }),
+    })
+        .openapi({
+        description: 'Validation metadata',
+    }),
+    success: z.boolean(),
+    error: z.string(),
+});
+//# sourceMappingURL=bubbleflow-execution-schema.js.map

package/dist/bubbleflow-execution-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bubbleflow-execution-schema.js","sourceRoot":"","sources":["../src/bubbleflow-execution-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,mBAAmB,CAAC;AACtC,OAAO,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AAExE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,MAAM,CAAC;IACN,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;QAC9B,WAAW,EAAE,6BAA6B;QAC1C,OAAO,EAAE,GAAG;KACb,CAAC;IACF,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;QAC/B,WAAW,EAAE,mCAAmC;QAChD,OAAO,EAAE,EAAE;KACZ,CAAC;IACF,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;QAC9B,WAAW,EAAE,8CAA8C;QAC3D,OAAO,EAAE,GAAG;KACb,CAAC;IACF,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;QACvC,WAAW,EAAE,8CAA8C;QAC3D,OAAO,EAAE,yBAAyB;KACnC,CAAC;CACH,CAAC;KACD,OAAO,CAAC,YAAY,CAAC,CAAC;AAIzB,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC;KACpC,MAAM,CAAC;IACN,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;QAChC,WAAW,EAAE,0CAA0C;QACvD,OAAO,EAAE,IAAI;KACd,CAAC;IACF,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;QACrC,WAAW,EAAE,0BAA0B;QACvC,OAAO,EAAE,EAAE;KACZ,CAAC;IACF,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;QACvC,WAAW,EAAE,4BAA4B;QACzC,OAAO,EAAE,CAAC;KACX,CAAC;IACF,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;QAC7B,WAAW,EAAE,8BAA8B;QAC3C,OAAO,EAAE,CAAC;KACX,CAAC;IACF,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;QAC/B,WAAW,EAAE,gCAAgC;QAC7C,OAAO,EAAE,CAAC;KACX,CAAC;IACF,wBAAwB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;QAC3C,WAAW,EAAE,iDAAiD;QAC9D,OAAO,EAAE,EAAE;KACZ,CAAC;IACF,YAAY,EAAE,CAAC;SACZ,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;YAC7B,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,EAAE;SACZ,CAAC;QACF,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;YAC3B,WAAW,EAAE,oCAAoC;YACjD,OAAO,EAAE,GAAG;SACb,CAAC;QACF,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;YAC1B,WAAW,EAAE,+CAA+C;YAC5D,OAAO,EAAE,8BAA8B;SACxC,CAAC;KACH,CAAC,CACH;SACA,OAAO,CAAC;QACP,WAAW,EAAE,sCAAsC;KACpD,CAAC;IACJ,eAAe,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;QAC1C,WAAW,EACT,8DAA8D;KACjE,CAAC,EAAE,0BAA0B;IAC9B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;QAC5B,WAAW,EAAE,4CAA4C;QACzD,OAAO,EAAE,aAAa;KACvB,CAAC;IACF,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;QAC1B,WAAW,EAAE,0CAA0C;QACvD,OAAO,EAAE,aAAa;KACvB,CAAC;IACF,UAAU,EAAE,gBAAgB;IAC5B,iBAAiB,EAAE,CAAC;SACjB,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,gBAAgB,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;SAC9D,QAAQ,EAAE;SACV,OAAO,CAAC;QACP,WAAW,EACT,sEAAsE;QACxE,OAAO,EAAE;YACP,yBAAyB,EAAE;gBACzB,WAAW,EAAE,IAAI;gBACjB,YAAY,EAAE,GAAG;gBACjB,WAAW,EAAE,IAAI;aAClB;SACF;KACF,CAAC;CACL,CAAC;KACD,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAI/B,2CAA2C;AAC3C,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC;IACvD,MAAM,EAAE,CAAC;SACN,IAAI,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;SACrC,OAAO,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAC/C,OAAO,EAAE,CAAC;SACP,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;SAC3B,OAAO,CAAC,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC;IAChD,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,uBAAuB,EAAE,CAAC;IAC5E,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,OAAO,CAAC,EAAE,WAAW,EAAE,yBAAyB,EAAE,CAAC;IACtD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,2BAA2B,EAAE,CAAC;IAC3E,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC;IAC/D,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,OAAO,CAAC,EAAE,WAAW,EAAE,gCAAgC,EAAE,CAAC;CAC9D,CAAC,CAAC;AAEH,wEAAwE;AACxE,MAAM,CAAC,MAAM,sCAAsC,GAAG,CAAC;KACpD,KAAK,CAAC,yBAAyB,CAAC;KAChC,OAAO,CAAC,kCAAkC,CAAC,CAAC;AAM/C,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC;KAC7C,MAAM,CAAC;IACN,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;QAC9B,WAAW,EAAE,4BAA4B;QACzC,OAAO,EAAE,GAAG;KACb,CAAC;IACF,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC;QAC3B,WAAW,EAAE,sCAAsC;QACnD,OAAO,EAAE,IAAI;KACd,CAAC;IACF,IAAI,EAAE,CAAC;SACJ,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,OAAO,CAAC;QACP,WAAW,EAAE,iDAAiD;QAC9D,OAAO,EAAE,EAAE,MAAM,EAAE,wBAAwB,EAAE,KAAK,EAAE,EAAE,EAAE;KACzD,CAAC;IACJ,OAAO,EAAE,sBAAsB,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;QACjD,WAAW,EAAE,mBAAmB;KACjC,CAAC;IACF,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;QACnC,WAAW,EAAE,qCAAqC;QAClD,OAAO,EAAE,gCAAgC;KAC1C,CAAC;CACH,CAAC;KACD,OAAO,CAAC,2BAA2B,CAAC,CAAC;AASxC,qBAAqB;AACrB,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAC9B,WAAW,EAAE,wCAAwC;QACrD,OAAO,EACL,4FAA4F;KAC/F,CAAC;IACF,OAAO,EAAE,CAAC;SACP,MAAM,CAAC;QACN,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YAChD,WAAW,EAAE,kCAAkC;SAChD,CAAC;QACF,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YAC5C,WAAW,EAAE,qCAAqC;SACnD,CAAC;KACH,CAAC;SACD,QAAQ,EAAE;SACV,OAAO,CAAC;QACP,WAAW,EAAE,oBAAoB;KAClC,CAAC;IACJ,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;QAC/C,WAAW,EACT,gFAAgF;QAClF,OAAO,EAAE,GAAG;KACb,CAAC;IACF,WAAW,EAAE,CAAC;SACX,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;SACpD,QAAQ,EAAE;SACV,OAAO,CAAC;QACP,WAAW,EACT,+EAA+E;QACjF,OAAO,EAAE;YACP,cAAc,EAAE;gBACd,UAAU,EAAE,GAAG;aAChB;YACD,UAAU,EAAE;gBACV,WAAW,EAAE,GAAG;aACjB;SACF;KACF,CAAC;CACL,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3D,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC;QACzB,WAAW,EAAE,2BAA2B;KACzC,CAAC;IACF,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;QAC7C,WAAW,EAAE,kCAAkC;KAChD,CAAC;IACF,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;QACzC,WAAW,EAAE,qCAAqC;KACnD,CAAC;IACF,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC;QACrD,WAAW,EAAE,cAAc;QAC3B,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,GAAG,EAAE,QAAQ;SACd;KACF,CAAC;IACF,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,0BAA0B,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;QAC3E,WAAW,EAAE,yDAAyD;KACvE,CAAC;IACF,mBAAmB,EAAE,CAAC;SACnB,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;SACvC,QAAQ,EAAE;SACV,OAAO,CAAC;QACP,WAAW,EAAE,kDAAkD;KAChE,CAAC;IACJ,QAAQ,EAAE,CAAC;SACR,MAAM,CAAC;QACN,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;YAC9B,WAAW,EAAE,yCAAyC;SACvD,CAAC;QACF,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;YAC7B,WAAW,EAAE,kCAAkC;SAChD,CAAC;QACF,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC;YAC9B,WAAW,EAAE,8BAA8B;SAC5C,CAAC;QACF,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC;YAC1C,WAAW,EACT,4DAA4D;SAC/D,CAAC;KACH,CAAC;SACD,OAAO,CAAC;QACP,WAAW,EAAE,qBAAqB;KACnC,CAAC;IACJ,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAC"}