skedyul 1.7.0 → 1.7.1

package/dist/serverless/server.mjs

@@ -1161,6 +1161,72 @@ async function handleProvision(body, hooks) {
   }
 }
 
+// src/server/handlers/setup-revalidate-handler.ts
+async function handleSetupRevalidate(body, hooks) {
+  const revalidateHook = hooks?.setup?.revalidate;
+  if (!revalidateHook) {
+    return {
+      status: 404,
+      body: { error: "Setup revalidate handler not configured" }
+    };
+  }
+  if (!body.context?.appInstallationId || !body.context?.workplace || !body.context?.app || !body.reason || !Array.isArray(body.steps)) {
+    return {
+      status: 400,
+      body: {
+        error: {
+          code: -32602,
+          message: "Missing context (appInstallationId, workplace, app, reason, and steps required)"
+        }
+      }
+    };
+  }
+  const ctx = {
+    env: body.env ?? {},
+    workplace: body.context.workplace,
+    appInstallationId: body.context.appInstallationId,
+    app: body.context.app,
+    reason: body.reason,
+    steps: body.steps,
+    crm: body.crm,
+    envChange: body.envChange,
+    invocation: body.invocation,
+    log: createContextLogger()
+  };
+  const requestConfig = {
+    baseUrl: body.env?.SKEDYUL_API_URL ?? process.env.SKEDYUL_API_URL ?? "",
+    apiToken: body.env?.SKEDYUL_API_TOKEN ?? process.env.SKEDYUL_API_TOKEN ?? ""
+  };
+  try {
+    const handler = typeof revalidateHook === "function" ? revalidateHook : revalidateHook.handler;
+    const result = await runWithLogContext(
+      { invocation: body.invocation },
+      async () => {
+        return await runWithConfig(requestConfig, async () => {
+          return await handler(ctx);
+        });
+      }
+    );
+    return {
+      status: 200,
+      body: {
+        completed: result?.completed ?? [],
+        invalidated: result?.invalidated ?? []
+      }
+    };
+  } catch (err) {
+    return {
+      status: 500,
+      body: {
+        error: {
+          code: -32603,
+          message: err instanceof Error ? err.message : String(err ?? "")
+        }
+      }
+    };
+  }
+}
+
 // src/server/handler-helpers.ts
 function parseHandlerEnvelope(parsedBody) {
   if (typeof parsedBody !== "object" || parsedBody === null || Array.isArray(parsedBody) || !("env" in parsedBody) || !("request" in parsedBody)) {
@@ -1552,6 +1618,14 @@ async function handleProvisionRoute(req, ctx) {
   const result = await handleProvision(parseResult.data, ctx.config.hooks);
   return { status: result.status, body: result.body };
 }
+async function handleSetupRevalidateRoute(req, ctx) {
+  const parseResult = parseJsonBody(req);
+  if (!parseResult.success) {
+    return parseResult.error;
+  }
+  const result = await handleSetupRevalidate(parseResult.data, ctx.config.hooks);
+  return { status: result.status, body: result.body };
+}
 async function handleOAuthCallbackRoute(req, ctx) {
   const parseResult = parseJsonBody(req);
   if (!parseResult.success) {
@@ -1913,6 +1987,9 @@ async function routeRequest(req, ctx) {
     if (req.path === "/provision" && req.method === "POST") {
       return handleProvisionRoute(req, ctx);
     }
+    if (req.path === "/setup/revalidate" && req.method === "POST") {
+      return handleSetupRevalidateRoute(req, ctx);
+    }
     if (req.path === "/oauth_callback" && req.method === "POST") {
       return handleOAuthCallbackRoute(req, ctx);
     }

package/dist/types/handlers.d.ts

@@ -63,6 +63,37 @@ export interface ProvisionHandlerContext {
 export interface ProvisionHandlerResult {
 }
 export type ProvisionHandler = (ctx: ProvisionHandlerContext) => Promise<ProvisionHandlerResult>;
+export type SetupRevalidateReason = 'crm_changed' | 'env_changed';
+export interface SetupRevalidateContext {
+    env: Record<string, string>;
+    workplace: WorkplaceInfo;
+    appInstallationId: string;
+    app: AppInfoWithHandles;
+    reason: SetupRevalidateReason;
+    /** Step handles that listen for this change */
+    steps: string[];
+    crm?: {
+        migrationId?: string;
+        deletedModelIds?: string[];
+        deletedFieldIds?: string[];
+        createdModelIds?: string[];
+        updatedModelIds?: string[];
+        createdFieldIds?: string[];
+        updatedFieldIds?: string[];
+    };
+    envChange?: {
+        keys: string[];
+    };
+    /** Invocation context for log traceability */
+    invocation?: InvocationContext;
+    /** Context-aware logger that automatically includes invocation context */
+    log: ContextLogger;
+}
+export interface SetupRevalidateResult {
+    completed?: string[];
+    invalidated?: string[];
+}
+export type SetupRevalidateHandler = (ctx: SetupRevalidateContext) => Promise<SetupRevalidateResult | void>;
 /**
  * Base ServerHooks type with common fields
  */
@@ -79,6 +110,17 @@ type BaseServerHooks = {
         /** Timeout in milliseconds. Defaults to 60000 (1 minute) if not specified. */
         timeout?: number;
     };
+    /**
+     * Setup revalidation after CRM migrations or env key removal.
+     * App should call setup.complete / setup.invalidate for listening steps.
+     */
+    setup?: {
+        revalidate?: SetupRevalidateHandler | {
+            handler: SetupRevalidateHandler;
+            /** Timeout in milliseconds. Defaults to 60000 (1 minute) if not specified. */
+            timeout?: number;
+        };
+    };
 };
 /**
  * ServerHooks when oauth_callback is present.

package/dist/types/index.d.ts

@@ -16,7 +16,7 @@ export type { FormatMoneyMinorEstimateOptions } from './estimation';
 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';
-export type { InstallHandlerContext, InstallHandlerResponseOAuth, InstallHandlerResponseStandard, HasOAuthCallback, InstallHandlerResult, InstallHandler, UninstallHandlerContext, UninstallHandlerResult, UninstallHandler, OAuthCallbackContext, OAuthCallbackResult, OAuthCallbackHandler, ProvisionHandlerContext, ProvisionHandlerResult, ProvisionHandler, ServerHooksWithOAuth, ServerHooksWithoutOAuth, ServerHooks, } from './handlers';
+export type { InstallHandlerContext, InstallHandlerResponseOAuth, InstallHandlerResponseStandard, HasOAuthCallback, InstallHandlerResult, InstallHandler, UninstallHandlerContext, UninstallHandlerResult, UninstallHandler, OAuthCallbackContext, OAuthCallbackResult, OAuthCallbackHandler, ProvisionHandlerContext, ProvisionHandlerResult, ProvisionHandler, SetupRevalidateReason, SetupRevalidateContext, SetupRevalidateResult, SetupRevalidateHandler, ServerHooksWithOAuth, ServerHooksWithoutOAuth, ServerHooks, } from './handlers';
 export type { APIGatewayProxyEvent, APIGatewayProxyResult } from './aws';
 export type { WebhookWireRequest, HandlerRawRequest, WebhookRequest, WebhookResponse, ProvisionWebhookContext, RuntimeWebhookContext, WebhookContext, WebhookHandler, WebhookLifecycleContext, CommunicationChannelLifecycleContext, WebhookLifecycleResult, WebhookLifecycleHook, WebhookInvocationMode, WebhookType, WebhookDefinition, WebhookRegistry, WebhookName, WebhookMetadata, } from './webhook';
 export { isRuntimeWebhookContext } from './webhook';

package/dist/types/invocation.d.ts

@@ -5,7 +5,7 @@ export type InvocationType = 'tool_call' | 'server_hook' | 'workflow_step' | 'we
 /**
  * Server hook handles for lifecycle events
  */
-export type ServerHookHandle = 'provision' | 'install' | 'uninstall' | 'oauth_callback';
+export type ServerHookHandle = 'provision' | 'install' | 'uninstall' | 'oauth_callback' | 'setup.revalidate';
 /**
  * Context for tracking how an executable was invoked.
  * Used for log traceability and filtering.
@@ -19,7 +19,7 @@ export interface InvocationContext {
     toolCallId?: string;
     /** The tool's handle for searching (e.g., "get_customers") */
     toolHandle?: string;
-    /** Hook type: "provision", "install", "uninstall", "oauth_callback" */
+    /** Hook type: "provision", "install", "uninstall", "oauth_callback", "setup.revalidate" */
     serverHookHandle?: ServerHookHandle;
     /** The app installation that triggered the call */
     appInstallationId?: string;

package/package.json

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