skedyul 1.4.4 → 1.4.7

package/dist/server.js

@@ -307,6 +307,16 @@ var AppAuthInvalidError = class extends Error {
   }
 };
 
+// src/ratelimit/errors.ts
+var RateLimitExceededError = class extends Error {
+  constructor(retryAfterMs, message = "Rate limit exceeded. Please try again later.") {
+    super(message);
+    this.code = "RATE_LIMITED";
+    this.name = "RateLimitExceededError";
+    this.retryAfterMs = retryAfterMs;
+  }
+};
+
 // src/server/context-logger.ts
 var import_async_hooks3 = require("async_hooks");
 var logContextStorage = new import_async_hooks3.AsyncLocalStorage();
@@ -404,6 +414,7 @@ function buildToolMetadata(registry) {
     const rawRetries = tool.retries ?? toolConfig.retries;
     const timeout = typeof rawTimeout === "number" && rawTimeout > 0 ? rawTimeout : 1e4;
     const retries = typeof rawRetries === "number" && rawRetries >= 1 ? rawRetries : 1;
+    const queueTouchPoints = tool.queueTouchPoints ?? toolConfig.queueTouchPoints;
     return {
       name: tool.name,
       displayName: tool.label || tool.name,
@@ -413,10 +424,12 @@ function buildToolMetadata(registry) {
       // Include timeout/retries at top-level for tools/list response (used by syncExecutableTools)
       timeout,
       retries,
+      queueTouchPoints,
       config: {
         timeout,
         retries,
-        completionHints: toolConfig.completionHints
+        completionHints: toolConfig.completionHints,
+        queueTouchPoints
       }
     };
   });
@@ -559,6 +572,27 @@ function createCallToolHandler(registry, state, onMaxRequests) {
         cursor: functionResult.cursor
       };
     } catch (error) {
+      if (error instanceof RateLimitExceededError) {
+        return {
+          success: false,
+          output: null,
+          billing: { credits: 0 },
+          meta: {
+            success: false,
+            message: error.message,
+            toolName
+          },
+          error: {
+            code: "RATE_LIMITED",
+            message: error.message,
+            category: "external"
+          },
+          retry: {
+            allowed: true,
+            afterMs: error.retryAfterMs
+          }
+        };
+      }
       if (error instanceof AppAuthInvalidError) {
         return {
           output: null,
@@ -922,7 +956,8 @@ function serializeConfig(config) {
       description: tool.description,
       // Read timeout/retries from top-level first, then fallback to config
       timeout: tool.timeout ?? tool.config?.timeout,
-      retries: tool.retries ?? tool.config?.retries
+      retries: tool.retries ?? tool.config?.retries,
+      queueTouchPoints: tool.queueTouchPoints ?? tool.config?.queueTouchPoints
     })) : [],
     webhooks: webhookRegistry ? Object.values(webhookRegistry).map((w) => ({
       name: w.name,
@@ -932,6 +967,7 @@ function serializeConfig(config) {
     })) : [],
     provision: isProvisionConfig(config.provision) ? config.provision : void 0,
     agents: config.agents,
+    events: config.events,
     queues: config.queues
   };
 }

package/dist/serverless/server.mjs

@@ -268,6 +268,16 @@ var AppAuthInvalidError = class extends Error {
   }
 };
 
+// src/ratelimit/errors.ts
+var RateLimitExceededError = class extends Error {
+  constructor(retryAfterMs, message = "Rate limit exceeded. Please try again later.") {
+    super(message);
+    this.code = "RATE_LIMITED";
+    this.name = "RateLimitExceededError";
+    this.retryAfterMs = retryAfterMs;
+  }
+};
+
 // src/server/context-logger.ts
 import { AsyncLocalStorage as AsyncLocalStorage3 } from "async_hooks";
 var logContextStorage = new AsyncLocalStorage3();
@@ -365,6 +375,7 @@ function buildToolMetadata(registry) {
     const rawRetries = tool.retries ?? toolConfig.retries;
     const timeout = typeof rawTimeout === "number" && rawTimeout > 0 ? rawTimeout : 1e4;
     const retries = typeof rawRetries === "number" && rawRetries >= 1 ? rawRetries : 1;
+    const queueTouchPoints = tool.queueTouchPoints ?? toolConfig.queueTouchPoints;
     return {
       name: tool.name,
       displayName: tool.label || tool.name,
@@ -374,10 +385,12 @@ function buildToolMetadata(registry) {
       // Include timeout/retries at top-level for tools/list response (used by syncExecutableTools)
       timeout,
       retries,
+      queueTouchPoints,
       config: {
         timeout,
         retries,
-        completionHints: toolConfig.completionHints
+        completionHints: toolConfig.completionHints,
+        queueTouchPoints
       }
     };
   });
@@ -520,6 +533,27 @@ function createCallToolHandler(registry, state, onMaxRequests) {
         cursor: functionResult.cursor
       };
     } catch (error) {
+      if (error instanceof RateLimitExceededError) {
+        return {
+          success: false,
+          output: null,
+          billing: { credits: 0 },
+          meta: {
+            success: false,
+            message: error.message,
+            toolName
+          },
+          error: {
+            code: "RATE_LIMITED",
+            message: error.message,
+            category: "external"
+          },
+          retry: {
+            allowed: true,
+            afterMs: error.retryAfterMs
+          }
+        };
+      }
       if (error instanceof AppAuthInvalidError) {
         return {
           output: null,
@@ -883,7 +917,8 @@ function serializeConfig(config) {
       description: tool.description,
       // Read timeout/retries from top-level first, then fallback to config
       timeout: tool.timeout ?? tool.config?.timeout,
-      retries: tool.retries ?? tool.config?.retries
+      retries: tool.retries ?? tool.config?.retries,
+      queueTouchPoints: tool.queueTouchPoints ?? tool.config?.queueTouchPoints
     })) : [],
     webhooks: webhookRegistry ? Object.values(webhookRegistry).map((w) => ({
       name: w.name,
@@ -893,6 +928,7 @@ function serializeConfig(config) {
     })) : [],
     provision: isProvisionConfig(config.provision) ? config.provision : void 0,
     agents: config.agents,
+    events: config.events,
     queues: config.queues
   };
 }

package/dist/triggers/types.d.ts

@@ -73,6 +73,7 @@ export declare const TriggerContextSchema: z.ZodObject<{
             "thread.workflow.completed": "thread.workflow.completed";
             "thread.follow_up.due": "thread.follow_up.due";
             "thread.reminder.due": "thread.reminder.due";
+            "thread.signal.created": "thread.signal.created";
         }>, z.ZodString]>;
         payload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
         participant: z.ZodOptional<z.ZodObject<{
@@ -199,6 +200,7 @@ export declare const ResolvedTriggerSchema: z.ZodObject<{
                 "thread.workflow.completed": "thread.workflow.completed";
                 "thread.follow_up.due": "thread.follow_up.due";
                 "thread.reminder.due": "thread.reminder.due";
+                "thread.signal.created": "thread.signal.created";
             }>, z.ZodString]>>>;
             condition: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>>;
@@ -220,6 +222,7 @@ export declare const ResolvedTriggerSchema: z.ZodObject<{
                 "thread.workflow.completed": "thread.workflow.completed";
                 "thread.follow_up.due": "thread.follow_up.due";
                 "thread.reminder.due": "thread.reminder.due";
+                "thread.signal.created": "thread.signal.created";
             }>, z.ZodString]>;
             payload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
             participant: z.ZodOptional<z.ZodObject<{

package/dist/types/index.d.ts

@@ -9,7 +9,7 @@ export type { InvocationType, ServerHookHandle, InvocationContext, } from './inv
 export { createToolCallContext, createServerHookContext, createWebhookContext, createWorkflowStepContext, } from './invocation';
 export type { ToolTrigger, ProvisionToolContext, DeveloperPageActionToolContext, DeveloperFormSubmitToolContext, FieldChangeToolContext, PageActionToolContext, FormSubmitToolContext, AgentToolContext, WorkflowToolContext, CronToolContext, CronContext, ToolExecutionContext, } from './tool-context';
 export { isProvisionContext, isRuntimeContext, isCronContext, isDeveloperContext } from './tool-context';
-export type { ToolResult, ToolSuccess, ToolFailure, ErrorCode, ErrorCategory, ToolWarning, ToolPagination, ToolBilling, ToolRetry, ToolTiming, ToolCompletionHints, ToolConfig, BillingInfo, ToolResponseMeta, ToolEffect, ToolError, ToolExecutionResult, ToolSchemaWithJson, ToolSchema, ToolHandler, ToolDefinition, ToolRegistryEntry, ToolRegistry, ToolName, ToolMetadata, ToolCallResponse, ExecutionScope, } from './tool';
+export type { ToolResult, ToolSuccess, ToolFailure, ErrorCode, ErrorCategory, ToolWarning, ToolPagination, ToolBilling, ToolRetry, ToolTiming, ToolCompletionHints, ToolConfig, QueueTouchPoint, BillingInfo, ToolResponseMeta, ToolEffect, ToolError, ToolExecutionResult, ToolSchemaWithJson, ToolSchema, ToolHandler, ToolDefinition, ToolRegistryEntry, ToolRegistry, ToolName, ToolMetadata, ToolCallResponse, ExecutionScope, } from './tool';
 export { ToolResponseMetaSchema } from './tool';
 export { createSuccessResponse, createListResponse, createErrorResponse, createValidationError, createNotFoundError, createAuthError, createRateLimitError, createExternalError, createTimeoutError, createPermissionError, createConflictError, isSuccess, isFailure, isRetryable, getRetryDelay, } from './tool-response';
 export type { HealthStatus, ComputeLayer, DedicatedServerInstance, ServerlessServerInstance, SkedyulServerInstance, } from './server';

package/dist/types/tool.d.ts

@@ -92,9 +92,18 @@ export interface ToolCompletionHints {
     idempotent?: boolean;
 }
 /**
- * Configuration options for tool execution behavior.
- * Groups timeout, retry, and completion hint settings.
+ * Declares which rate-limit queues a tool may touch (for orchestration probes).
  */
+export interface QueueTouchPoint {
+    /** Queue name from skedyul.config queues (e.g. petbooqz_api) */
+    queue: string;
+    /** Conservative max upstream HTTP calls this handler may make */
+    estimatedCalls: number;
+    /** Arg field used as sub-key for per-resource mutex queues */
+    subKeyFromArg?: string;
+    /** True for correctness mutexes — excluded from rate-limit probe admission */
+    mutexOnly?: boolean;
+}
 export interface ToolConfig {
     /** Timeout in milliseconds. Defaults to 10000 (10 seconds) if not specified. */
     timeout?: number;
@@ -102,6 +111,8 @@ export interface ToolConfig {
     retries?: number;
     /** Hints for controlling tool completion behavior in agent loops */
     completionHints?: ToolCompletionHints;
+    /** Rate-limit queue touch points for orchestration admission probes */
+    queueTouchPoints?: QueueTouchPoint[];
 }
 /**
  * Successful tool execution result.
@@ -179,6 +190,8 @@ export interface ToolExecutionResult<Output = unknown> {
     meta?: ToolResponseMeta;
     effect?: ToolEffect;
     error?: ToolError | null;
+    /** Retry guidance for transient failures (e.g. rate limiting) */
+    retry?: ToolRetry;
     /** Rich data blocks for UI rendering (profiles, spreadsheets, datetime cards) */
     dataBlocks?: import('./data-blocks').DataBlock[];
     /** Cursor state for cron subscriptions - saved and passed to the next run */
@@ -215,6 +228,8 @@ export interface ToolDefinition<Input = unknown, Output = unknown, InputSchema e
     outputSchema?: ToolSchema<OutputSchema>;
     /** Tool execution configuration (timeout, retries, completion hints) */
     config?: ToolConfig;
+    /** Rate-limit queue touch points (also accepted at top level for ergonomics) */
+    queueTouchPoints?: QueueTouchPoint[];
     /**
      * Execution scope for this tool.
      * - `installation` (default): Requires appInstallationId, receives sk_wkp_ token.
@@ -233,6 +248,8 @@ export interface ToolRegistryEntry {
     outputSchema?: ToolSchema;
     /** Tool execution configuration (timeout, retries, completion hints) */
     config?: ToolConfig;
+    /** Rate-limit queue touch points */
+    queueTouchPoints?: QueueTouchPoint[];
     /** Execution scope for this tool */
     executionScope?: ExecutionScope;
     [key: string]: unknown;
@@ -251,6 +268,8 @@ export interface ToolMetadata {
     retries?: number;
     /** Tool execution configuration (timeout, retries, completion hints) */
     config?: ToolConfig;
+    /** Rate-limit queue touch points for orchestration admission probes */
+    queueTouchPoints?: QueueTouchPoint[];
     /** Execution scope for this tool */
     executionScope?: ExecutionScope;
 }

package/dist/workflows/types.d.ts

@@ -82,6 +82,7 @@ export declare const WorkflowYAMLSchema: z.ZodObject<{
             "thread.workflow.completed": "thread.workflow.completed";
             "thread.follow_up.due": "thread.follow_up.due";
             "thread.reminder.due": "thread.reminder.due";
+            "thread.signal.created": "thread.signal.created";
         }>, z.ZodString]>>>;
         condition: z.ZodOptional<z.ZodString>;
         emits: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodEnum<{
@@ -98,6 +99,7 @@ export declare const WorkflowYAMLSchema: z.ZodObject<{
             "thread.workflow.completed": "thread.workflow.completed";
             "thread.follow_up.due": "thread.follow_up.due";
             "thread.reminder.due": "thread.reminder.due";
+            "thread.signal.created": "thread.signal.created";
         }>, z.ZodString]>>>;
         waits: z.ZodOptional<z.ZodArray<z.ZodObject<{
             event: z.ZodUnion<readonly [z.ZodEnum<{
@@ -114,6 +116,7 @@ export declare const WorkflowYAMLSchema: z.ZodObject<{
                 "thread.workflow.completed": "thread.workflow.completed";
                 "thread.follow_up.due": "thread.follow_up.due";
                 "thread.reminder.due": "thread.reminder.due";
+                "thread.signal.created": "thread.signal.created";
             }>, z.ZodString]>;
             timeout: z.ZodOptional<z.ZodString>;
             onTimeout: z.ZodOptional<z.ZodString>;
@@ -132,6 +135,7 @@ export declare const WorkflowYAMLSchema: z.ZodObject<{
             "thread.workflow.completed": "thread.workflow.completed";
             "thread.follow_up.due": "thread.follow_up.due";
             "thread.reminder.due": "thread.reminder.due";
+            "thread.signal.created": "thread.signal.created";
         }>, z.ZodString]>>>;
         cancelCondition: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
@@ -192,6 +196,7 @@ export declare const WorkflowMetadataSchema: z.ZodObject<{
             "thread.workflow.completed": "thread.workflow.completed";
             "thread.follow_up.due": "thread.follow_up.due";
             "thread.reminder.due": "thread.reminder.due";
+            "thread.signal.created": "thread.signal.created";
         }>, z.ZodString]>>>;
         condition: z.ZodOptional<z.ZodString>;
         emits: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodEnum<{
@@ -208,6 +213,7 @@ export declare const WorkflowMetadataSchema: z.ZodObject<{
             "thread.workflow.completed": "thread.workflow.completed";
             "thread.follow_up.due": "thread.follow_up.due";
             "thread.reminder.due": "thread.reminder.due";
+            "thread.signal.created": "thread.signal.created";
         }>, z.ZodString]>>>;
         waits: z.ZodOptional<z.ZodArray<z.ZodObject<{
             event: z.ZodUnion<readonly [z.ZodEnum<{
@@ -224,6 +230,7 @@ export declare const WorkflowMetadataSchema: z.ZodObject<{
                 "thread.workflow.completed": "thread.workflow.completed";
                 "thread.follow_up.due": "thread.follow_up.due";
                 "thread.reminder.due": "thread.reminder.due";
+                "thread.signal.created": "thread.signal.created";
             }>, z.ZodString]>;
             timeout: z.ZodOptional<z.ZodString>;
             onTimeout: z.ZodOptional<z.ZodString>;
@@ -242,6 +249,7 @@ export declare const WorkflowMetadataSchema: z.ZodObject<{
             "thread.workflow.completed": "thread.workflow.completed";
             "thread.follow_up.due": "thread.follow_up.due";
             "thread.reminder.due": "thread.reminder.due";
+            "thread.signal.created": "thread.signal.created";
         }>, z.ZodString]>>>;
         cancelCondition: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skedyul",
-  "version": "1.4.4",
+  "version": "1.4.7",
   "description": "The Skedyul SDK for Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",