skedyul 1.6.0 → 1.7.1

package/dist/esm/index.mjs

@@ -1290,6 +1290,45 @@ var ModelDefinitionSchema = z8.object({
   page: z8.string().optional(),
   env: EnvSchemaSchema.optional()
 });
+var EntityFieldDefinitionSchema = z8.object({
+  handle: z8.string(),
+  label: z8.string(),
+  description: z8.string().optional(),
+  type: z8.enum([
+    "string",
+    "long_string",
+    "number",
+    "boolean",
+    "date",
+    "datetime",
+    "object"
+  ]).optional(),
+  isUnique: z8.boolean().optional(),
+  /** @deprecated Prefer isUnique */
+  matchCandidate: z8.boolean().optional(),
+  required: z8.boolean().optional(),
+  options: z8.array(
+    z8.union([
+      z8.string(),
+      z8.object({ value: z8.string(), label: z8.string() })
+    ])
+  ).optional()
+});
+var EntityRelationshipDefinitionSchema = z8.object({
+  handle: z8.string(),
+  label: z8.string(),
+  targetEntity: z8.string().optional(),
+  description: z8.string().optional()
+});
+var EntityDefinitionSchema = z8.object({
+  handle: z8.string(),
+  label: z8.string(),
+  labelPlural: z8.string().optional(),
+  description: z8.string().optional(),
+  fields: z8.array(EntityFieldDefinitionSchema),
+  contextFields: z8.array(EntityFieldDefinitionSchema).optional(),
+  relationships: z8.array(EntityRelationshipDefinitionSchema).optional()
+});
 var RelationshipCardinalitySchema = z8.enum([
   "ONE_TO_ONE",
   "ONE_TO_MANY"
@@ -1706,16 +1745,10 @@ var ListBlockDefinitionSchema = z8.object({
   icon: z8.string().optional(),
   emptyMessage: z8.string().optional()
 });
-var ModelMapperBlockDefinitionSchema = z8.object({
-  type: z8.literal("model_mapper"),
-  /** The SHARED model handle from install config (e.g., "client", "patient") */
-  model: z8.string()
-});
 var PageBlockDefinitionSchema = z8.union([
   CardBlockDefinitionSchema,
   LegacyFormBlockDefinitionSchema,
-  ListBlockDefinitionSchema,
-  ModelMapperBlockDefinitionSchema
+  ListBlockDefinitionSchema
 ]);
 var PageContextModeSchema = z8.enum(["first", "many", "count", "all"]).transform((val) => val === "all" ? "many" : val);
 var PageContextFiltersSchema = z8.record(
@@ -1854,17 +1887,35 @@ var InstallConfigSchema = z8.object({
   /** Relationship definitions between SHARED models */
   relationships: z8.array(RelationshipDefinitionSchema).optional()
 });
+var SetupStepKindSchema = z8.enum(["app", "crm", "realtime", "env"]);
+var SetupStepDefinitionSchema = z8.object({
+  handle: z8.string(),
+  label: z8.string(),
+  description: z8.string().optional(),
+  kind: SetupStepKindSchema,
+  requires: z8.array(z8.string()).optional(),
+  entities: z8.array(z8.string()).optional(),
+  workflowHandles: z8.array(z8.string()).optional(),
+  envKeys: z8.array(z8.string()).optional(),
+  listenToCrm: z8.boolean().optional(),
+  listenToEnv: z8.boolean().optional(),
+  capabilities: z8.array(z8.string()).optional()
+});
 var ProvisionConfigSchema = z8.object({
   env: EnvSchemaSchema.optional(),
   /** INTERNAL model definitions (app-owned, not visible to users) */
   models: z8.array(ModelDefinitionSchema).optional(),
+  /** App entity contracts for install-time CRM maps (not shared models) */
+  entities: z8.array(EntityDefinitionSchema).optional(),
   /** Relationship definitions between INTERNAL models */
   relationships: z8.array(RelationshipDefinitionSchema).optional(),
   channels: z8.array(ChannelDefinitionSchema).optional(),
   workflows: z8.array(WorkflowDefinitionSchema).optional(),
   /** Base navigation configuration for all pages (can be overridden per page) */
   navigation: NavigationConfigSchema.optional(),
-  pages: z8.array(PageDefinitionSchema).optional()
+  pages: z8.array(PageDefinitionSchema).optional(),
+  /** Install setup checklist steps (opt-in) */
+  setup: z8.array(SetupStepDefinitionSchema).optional()
 });
 var SkedyulConfigSchema = z8.object({
   name: z8.string(),
@@ -3513,6 +3564,47 @@ var report = {
     return data;
   }
 };
+var setup = {
+  async list() {
+    const { data } = await callCore("setup.list", {});
+    return data;
+  },
+  async get(handle) {
+    const { data } = await callCore("setup.get", {
+      handle
+    });
+    return data;
+  },
+  async complete(handle, metadata) {
+    const { data } = await callCore("setup.complete", {
+      handle,
+      ...metadata ? { metadata } : {}
+    });
+    return data;
+  },
+  async skip(handle, metadata) {
+    const { data } = await callCore("setup.skip", {
+      handle,
+      ...metadata ? { metadata } : {}
+    });
+    return data;
+  },
+  async invalidate(handle, reason, metadata) {
+    const { data } = await callCore("setup.invalidate", {
+      handle,
+      ...reason ? { reason } : {},
+      ...metadata ? { metadata } : {}
+    });
+    return data;
+  },
+  async capabilities() {
+    const { data } = await callCore(
+      "setup.capabilities",
+      {}
+    );
+    return data.capabilities;
+  }
+};
 
 // src/ratelimit/context.ts
 import { AsyncLocalStorage as AsyncLocalStorage2 } from "async_hooks";
@@ -4547,6 +4639,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)) {
@@ -4933,6 +5091,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) {
@@ -5294,6 +5460,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);
     }
@@ -5748,6 +5917,9 @@ function defineConfig(config) {
 function defineModel(model) {
   return model;
 }
+function defineEntity(entity) {
+  return entity;
+}
 function defineChannel(channel) {
   return channel;
 }
@@ -5766,6 +5938,9 @@ function defineEnv(env) {
 function defineNavigation(navigation) {
   return navigation;
 }
+function defineSetupStep(step) {
+  return step;
+}
 
 // src/config/schema-loader.ts
 import * as fs4 from "fs";
@@ -8230,6 +8405,9 @@ export {
   DatePickerComponentDefinitionSchema,
   DayOfWeekSchema,
   EmptyFormComponentDefinitionSchema,
+  EntityDefinitionSchema,
+  EntityFieldDefinitionSchema,
+  EntityRelationshipDefinitionSchema,
   EnvSchemaSchema,
   EnvVariableDefinitionSchema,
   EnvVisibilitySchema,
@@ -8300,7 +8478,6 @@ export {
   ModelDefinitionSchema,
   ModelDependencySchema,
   ModelFieldDefinitionSchema,
-  ModelMapperBlockDefinitionSchema,
   MoneyMinorRangeSchema,
   NavigationBreadcrumbSchema,
   NavigationConfigSchema,
@@ -8351,6 +8528,8 @@ export {
   SequencerContextError,
   SequencerLockError,
   SequencerNotFoundError,
+  SetupStepDefinitionSchema,
+  SetupStepKindSchema,
   SkedyulConfigSchema,
   SkillExampleSchema,
   SkillMetadataSchema,
@@ -8440,11 +8619,13 @@ export {
   defineAgent,
   defineChannel,
   defineConfig,
+  defineEntity,
   defineEnv,
   defineModel,
   defineNavigation,
   definePage,
   defineSchema,
+  defineSetupStep,
   defineSkill,
   defineWorkflow,
   defineWorkflowYAML,
@@ -8506,6 +8687,7 @@ export {
   allow as sequencerAllow,
   release as sequencerRelease,
   server,
+  setup,
   toGsm7,
   token,
   validateCRMSchema,

package/dist/index.d.ts

@@ -8,15 +8,15 @@ export { DEFAULT_DOCKERFILE } from './dockerfile';
 export { InstallError, MissingRequiredFieldError, AuthenticationError, InvalidConfigurationError, ConnectionError, AppAuthInvalidError, } from './errors';
 export type { InstallErrorCode } from './errors';
 export { z };
-export { workplace, communicationChannel, instance, token, file, webhook, cron, event, resource, ai, call, report, configure, getConfig, runWithConfig, createInstanceClient, } from './core/client';
-export type { InstanceClient, InstanceContext, InstanceData, InstanceEnv, InstanceWriteOptions, InstanceGetOptions, InstanceCreateManyItem, InstanceUpdateManyItem, InstanceMeta, InstancePagination, InstanceListResult, InstanceListArgs, FileInfo, FileUrlResponse, FileUploadParams, FileUploadResult, WebhookCreateResult, WebhookListItem, WebhookDeleteByNameOptions, WebhookListOptions, CallStartParams, CallStartResult, CallAppendTranscriptParams, CallEndParams, CallSummarizeResult, CronSubscribeParams, CronSubscribeResult, CronSubscriptionItem, CronListOptions, EventCreateResult, EventCreateOptions, ResourceLinkParams, ResourceLinkResult, AITextContent, AIFileContent, AIImageContent, AIMessageContent, AIMessage, GenerateObjectOptions, GenerateObjectResult, ReportGenerateParams, ReportGenerateResult, ReportDefineParams, ReportDefineResult, ReportListParams, ReportListItem, ReportListResult, ReportDefinition, } from './core/client';
+export { workplace, communicationChannel, instance, token, file, webhook, cron, event, resource, ai, call, report, setup, configure, getConfig, runWithConfig, createInstanceClient, } from './core/client';
+export type { InstanceClient, InstanceContext, InstanceData, InstanceEnv, InstanceWriteOptions, InstanceGetOptions, InstanceCreateManyItem, InstanceUpdateManyItem, InstanceMeta, InstancePagination, InstanceListResult, InstanceListArgs, FileInfo, FileUrlResponse, FileUploadParams, FileUploadResult, WebhookCreateResult, WebhookListItem, WebhookDeleteByNameOptions, WebhookListOptions, CallStartParams, CallStartResult, CallAppendTranscriptParams, CallEndParams, CallSummarizeResult, CronSubscribeParams, CronSubscribeResult, CronSubscriptionItem, CronListOptions, EventCreateResult, EventCreateOptions, ResourceLinkParams, ResourceLinkResult, AITextContent, AIFileContent, AIImageContent, AIMessageContent, AIMessage, GenerateObjectOptions, GenerateObjectResult, ReportGenerateParams, ReportGenerateResult, ReportDefineParams, ReportDefineResult, ReportListParams, ReportListItem, ReportListResult, ReportDefinition, SetupStepStatus, SetupStepKindApi, SetupStepView, SetupListResult, } from './core/client';
 export { createContextLogger } from './server/logger';
 export type { ContextLogger } from './server/logger';
 declare const _default: {
     z: typeof z;
 };
 export default _default;
-export { defineConfig, defineModel, defineChannel, definePage, defineWorkflow, defineAgent, defineEnv, defineNavigation, getAllEnvKeys, getRequiredInstallEnvKeys, } from './config';
+export { defineConfig, defineModel, defineEntity, defineChannel, definePage, defineWorkflow, defineAgent, defineEnv, defineNavigation, defineSetupStep, getAllEnvKeys, getRequiredInstallEnvKeys, } from './config';
 export { queuedFetch, requeue, resolveQueue, createQueueHandle, queuedFetchResponse, registerQueueConfig, runWithRateLimitExecutionContext, getRateLimitExecutionContext, defaultShouldRetry, QueueContextError, QueueNotFoundError, QueuedFetchExhaustedError, RequeueOutsideContextError, RateLimitBackendError, RateLimitExceededError, } from './ratelimit';
 export type { QueueInput, QueueSelector, Lease, QueueLimits, ResolvedQueue, RateLimitExecutionContext, RateLimitBackend, QueueScope, QueueConfig, SerializableQueueConfig, QueueRegistry, } from './ratelimit';
 export { sequencer, allow as sequencerAllow, acquire as sequencerAcquire, release as sequencerRelease, resolveSequencer, createSequencerHandle, registerSequencerConfig, clearRegisteredSequencerConfig, getSequencerConfig, getSequencerDefinitions, resetSequencerBackendForTests, memorySequencerBackend, platformSequencerBackend, SequencerContextError, SequencerNotFoundError, SequencerBackendError, SequencerLockError, } from './sequencer';
@@ -35,7 +35,7 @@ export type { CRMContext, SenderContext, ThreadContextItem, ThreadInfo, SandboxC
 export { MemoryEntryTypeSchema, MemoryEntrySchema, WorkingMemoryConfigSchema, SemanticMemoryConfigSchema, ExternalMemoryConfigSchema, MemoryConfigSchema, MemoryScopeSchema, MemoryQueryOptionsSchema, ConversationSummarySchema, AgentObservationSchema, ExternalDataCacheSchema, MemoryService, InMemoryStore, createInMemoryService, } from './memory';
 export type { MemoryEntryType, MemoryEntry, WorkingMemoryConfig as MemoryWorkingConfig, SemanticMemoryConfig as MemorySemanticConfig, ExternalMemoryConfig as MemoryExternalConfig, MemoryConfig, MemoryScope, MemoryQueryOptions, ConversationSummary, AgentObservation, ExternalDataCache, MemoryStore, } from './memory';
 export type { CRMFieldType, CRMFieldRequirement, CRMFieldOption, CRMFieldDefinition, CRMFieldSchema, CRMModelSchema, CRMCardinality, CRMOnDelete, CRMRelationshipLink, CRMRelationshipSchema, CRMSchema, CRMSchemaValidationResult, } from './schemas';
-export type { SkedyulConfig, SerializableSkedyulConfig, InstallConfig, ProvisionConfig, BaseDefinition, Scope, FieldOwner, Visibility, ComputeLayer, StructuredFilter, FilterOperator, FilterCondition, FieldOption, EnvVariable, EnvSchema, FieldType, Cardinality, OnDelete, InlineFieldDefinition, FieldVisibility, FieldDefinition, ModelDefinition, RelationshipLink, RelationshipDefinition, CapabilityType, ChannelCapability, ChannelBatchCapability, ChannelFieldPermissions, ChannelField, ChannelDefinition, WorkflowActionInput, WorkflowAction, WorkflowDefinition, AgentDefinition, NavigationItem, NavigationSection, NavigationSidebar, BreadcrumbItem, NavigationBreadcrumb, NavigationConfig, ContextMode, ContextItemModel, ContextItemTool, ContextItem, ContextDefinition, FormStyleProps, ButtonVariant, ButtonSize, ButtonProps, RelationshipExtension, FormHeader, FormActionDefinition, ActionDefinition, ModalFormDefinition, InputComponent, TextareaComponent, SelectComponent, ComboboxComponent, CheckboxComponent, DatePickerComponent, TimePickerComponent, StatusIndicator, FieldSettingComponent, ImageSettingComponent, FileSettingComponent, ListItemTemplate, ListComponent, EmptyFormComponent, AlertComponent, FormComponent, FormLayoutColumn, FormLayoutRow, FormLayoutConfig, FormProps, CardHeader, CardBlock, ListBlock, ModelMapperBlock, BlockDefinition, PageType, PageDefinition, HttpMethod, WebhookRequest, WebhookHandlerContext, WebhookHandlerResponse, WebhookHandlerFn, WebhookHandlerDefinition, Webhooks, WebhookHandlerMetadata, ModelDependency, ChannelDependency, WorkflowDependency, ResourceDependency, } from './config';
+export type { SkedyulConfig, SerializableSkedyulConfig, InstallConfig, ProvisionConfig, BaseDefinition, Scope, FieldOwner, Visibility, ComputeLayer, StructuredFilter, FilterOperator, FilterCondition, FieldOption, EnvVariable, EnvSchema, FieldType, Cardinality, OnDelete, InlineFieldDefinition, FieldVisibility, FieldDefinition, ModelDefinition, RelationshipLink, RelationshipDefinition, CapabilityType, ChannelCapability, ChannelBatchCapability, ChannelFieldPermissions, ChannelField, ChannelDefinition, WorkflowActionInput, WorkflowAction, WorkflowDefinition, AgentDefinition, NavigationItem, NavigationSection, NavigationSidebar, BreadcrumbItem, NavigationBreadcrumb, NavigationConfig, ContextMode, ContextItemModel, ContextItemTool, ContextItem, ContextDefinition, FormStyleProps, ButtonVariant, ButtonSize, ButtonProps, RelationshipExtension, FormHeader, FormActionDefinition, ActionDefinition, ModalFormDefinition, InputComponent, TextareaComponent, SelectComponent, ComboboxComponent, CheckboxComponent, DatePickerComponent, TimePickerComponent, StatusIndicator, FieldSettingComponent, ImageSettingComponent, FileSettingComponent, ListItemTemplate, ListComponent, EmptyFormComponent, AlertComponent, FormComponent, FormLayoutColumn, FormLayoutRow, FormLayoutConfig, FormProps, CardHeader, CardBlock, ListBlock, BlockDefinition, SetupStepDefinition, SetupStepKind, PageType, PageDefinition, HttpMethod, WebhookRequest, WebhookHandlerContext, WebhookHandlerResponse, WebhookHandlerFn, WebhookHandlerDefinition, Webhooks, WebhookHandlerMetadata, ModelDependency, ChannelDependency, WorkflowDependency, ResourceDependency, } from './config';
 export { compileAgent, compileWorkflow } from './compiler';
 export type { ValidationError, ValidationWarning, ResolvedPersona, ResolvedTool, EventConfig as CompilerEventConfig, IRMemoryConfig, PolicyConfig, IRRuntimeConfig, AgentIR, WorkflowStepIR, WorkflowIR, CompilationResult, } from './compiler';
 export { TimeStampSchema, DayOfWeekSchema, TimeWindowSlotSchema, WaitUnitSchema, WaitInputRelativeSchema, WaitInputAbsoluteSchema, WaitInputSchema, } from './scheduling/types';