@reasonlayer/sdk 0.0.1-rc.3

package/node_modules/@reasonlayer/protocol/dist/readmodels.d.ts

@@ -0,0 +1,617 @@
+/**
+ * The shapes the `FN` functions return.
+ *
+ * `FN` names the Convex functions every consumer calls; this module names what
+ * those calls resolve to. Backend handlers declare these as their return type,
+ * so a handler that stops producing a field fails to compile at the source
+ * instead of silently at the console, the CLI, or the runner.
+ *
+ * Named ceiling: TypeScript is erased at runtime, so this catches drift only at
+ * build time and only for consumers that compile in CI. Upgrade path is Convex
+ * `v.*` return validators on the handlers, with the types derived from those.
+ */
+import type { EnvironmentStatus, ReviewViewIR, VariableIR } from "./ir.js";
+import type { AgentEventLevel, LifecycleEvent, LifecycleEventType, RunStatus } from "./events.js";
+import type { StepRunStatus } from "./scheduling.js";
+import type { Scope } from "./permissions.js";
+export type RunMode = "deployment" | "test";
+export type RunTrigger = "schedule" | "manual";
+/** `FN.runsGet` */
+export interface RunReadModel {
+    runId: string;
+    workflowId: string;
+    mode: RunMode;
+    status: RunStatus;
+    trigger: RunTrigger;
+    input: unknown;
+    variables?: Record<string, unknown> | undefined;
+    output?: unknown;
+    error?: string | undefined;
+    createdAt: number;
+    finishedAt?: number | undefined;
+}
+/** One row of `FN.runsList` (and of the `runs:listPage` page). */
+export interface RunListRow {
+    runId: string;
+    workflowId: string;
+    mode: RunMode;
+    status: RunStatus;
+    trigger: RunTrigger;
+    createdAt: number;
+    finishedAt?: number | undefined;
+    error?: string | undefined;
+    costUsd: number;
+    totalTokens: number;
+    hasStepFailures: boolean;
+    isQueued: boolean;
+}
+export interface RunStepUsageRow {
+    stepId: string;
+    invocationKey: string;
+    attempt: number;
+    model?: string | undefined;
+    inputTokens: number;
+    outputTokens: number;
+    costUsd: number;
+    turns: number;
+    updatedAt: number;
+}
+/** `transcripts:usageForRun`, and the `usage` block of `FN.runsInspect`. */
+export interface RunUsageReadModel {
+    totals: {
+        inputTokens: number;
+        outputTokens: number;
+        costUsd: number;
+    };
+    steps: RunStepUsageRow[];
+}
+export interface RunInspectionStep {
+    stepId: string;
+    invocationKey: string;
+    attempt: number;
+    status: StepRunStatus;
+    output?: unknown;
+    error?: string | undefined;
+    childrenSucceeded?: number | undefined;
+    childrenTotal?: number | undefined;
+    startedAt: number;
+    finishedAt?: number | undefined;
+}
+export interface RunInspectionApproval {
+    approvalId: string;
+    stepId: string;
+    invocationKey: string;
+    status: ApprovalStatus;
+    view: ReviewViewIR;
+    content: unknown;
+    decision?: unknown;
+    edited?: boolean | undefined;
+    originalContentHash?: string | undefined;
+    reason?: string | undefined;
+    deadlineAt?: number | undefined;
+    createdAt: number;
+    resolvedAt?: number | undefined;
+}
+export interface RunLifecycleEventRow {
+    eventId: string;
+    seq: number;
+    at: number;
+    type: LifecycleEventType;
+    stepId?: string | undefined;
+    invocationKey?: string | undefined;
+    attempt?: number | undefined;
+    taskId?: string | undefined;
+    payload: LifecycleEvent["payload"];
+}
+/** `FN.runsInspect` — run, steps, usage, approvals, and the lifecycle log in one read. */
+export interface RunInspection {
+    run: {
+        runId: string;
+        workflowId: string;
+        mode: RunMode;
+        status: RunStatus;
+        trigger: RunTrigger;
+        input: unknown;
+        variables?: Record<string, unknown> | undefined;
+        output?: unknown;
+        error?: string | undefined;
+        interpreterVersion: number;
+        createdAt: number;
+        finishedAt?: number | undefined;
+        hasStepFailures: boolean;
+        isQueued: boolean;
+    };
+    irJson?: string | undefined;
+    steps: RunInspectionStep[];
+    usage: RunUsageReadModel;
+    approvals: RunInspectionApproval[];
+    events: RunLifecycleEventRow[];
+}
+export type TranscriptEventType = "agent.turn" | "agent.tool" | "agent.task" | "agent.log" | "agent.error";
+/** One stored `AgentEvent`, widened with the step locator it was recorded against. */
+export interface TranscriptEvent {
+    seq: number;
+    turnSeq?: number | undefined;
+    level: AgentEventLevel;
+    ts: number;
+    type: TranscriptEventType;
+    data: unknown;
+    stepId: string;
+    invocationKey: string;
+    attempt: number;
+}
+/** `FN.transcriptsList` */
+export interface TranscriptPage {
+    events: TranscriptEvent[];
+    nextCursor: string;
+    isDone: boolean;
+}
+export declare const APPROVAL_STATUSES: readonly ["pending", "approved", "rejected", "expired", "canceled"];
+export type ApprovalStatus = (typeof APPROVAL_STATUSES)[number];
+/** Display identity for whoever resolved a review or published a version. */
+export interface ActorIdentity {
+    memberId?: string | undefined;
+    email?: string | undefined;
+    tokenLabel?: string | undefined;
+}
+/** `FN.approvalsList`, `approvals:listPage` rows, and `approvals:get`. */
+export interface ApprovalReadModel {
+    approvalId: string;
+    runId: string;
+    workflowId: string;
+    workflowName: string;
+    runStatus: RunStatus;
+    stepId: string;
+    invocationKey: string;
+    content: unknown;
+    view: ReviewViewIR;
+    outputSchemaJsonText: string;
+    status: ApprovalStatus;
+    decision?: unknown;
+    edited?: boolean | undefined;
+    originalContentHash?: string | undefined;
+    reason?: string | undefined;
+    resolvedBy?: ActorIdentity | undefined;
+    deadlineAt?: number | undefined;
+    createdAt: number;
+    resolvedAt?: number | undefined;
+}
+export type WorkflowPublishState = "drafting" | "published" | "unpublished_changes";
+export interface WorkflowCompileStatus {
+    ok: boolean;
+    errors?: Array<{
+        stepId?: string | undefined;
+        message: string;
+    }> | undefined;
+    lastGreenArtifactId?: string | undefined;
+    updatedAt: number;
+}
+/**
+ * The operational summary shared by `FN.deploymentsListWorkflows` and
+ * `dashboard:workflowHealth` rows.
+ */
+export interface WorkflowHealthRow {
+    workflowId: string;
+    publishedDeploymentId?: string | undefined;
+    publishedVersionId?: string | undefined;
+    publishedVersionNumber?: number | undefined;
+    description?: string | undefined;
+    group: {
+        groupId: string;
+        name: string;
+        color?: string | undefined;
+    } | null;
+    latestDeployment: {
+        deploymentId: string;
+        createdAt: number;
+        deployedBy?: ActorIdentity | undefined;
+    } | null;
+    lastRun: {
+        runId: string;
+        status: RunStatus;
+        hasStepFailures: boolean;
+        isQueued: boolean;
+        createdAt: number;
+        finishedAt?: number | undefined;
+    } | null;
+    successRate: number | null;
+    successWindow: number;
+    pendingReviews: number;
+    schedules: Array<{
+        name: string;
+        cron: string;
+        timezone: string;
+        status: "enabled" | "disabled";
+        nextRunAt?: number | undefined;
+    }>;
+    scheduleCount: number;
+    nextScheduledRunAt?: number | undefined;
+}
+/** One row of `FN.deploymentsListWorkflows` — health plus draft/publish state. */
+export interface WorkflowListRow extends WorkflowHealthRow {
+    publishState: WorkflowPublishState;
+    compile?: WorkflowCompileStatus | undefined;
+    draftUpdatedAt?: number | undefined;
+    requiredSecrets: string[];
+}
+/** `workflowGroups:list`; the group mutations return one row. */
+export interface WorkflowGroupRow {
+    groupId: string;
+    name: string;
+    description?: string | undefined;
+    color?: string | undefined;
+    workflowIds: string[];
+    createdAt: number;
+    updatedAt: number;
+}
+/** An active authoring session as the console detail reports it. */
+export interface AuthoringSessionRow {
+    sessionId: string;
+    machineLabel: string;
+    startedAt: number;
+    lastHeartbeatAt: number;
+    error?: string | undefined;
+}
+/** `FN.workspacesStatus` */
+export interface WorkspaceStatus {
+    workflowId: string;
+    state: WorkflowPublishState;
+    compile?: WorkflowCompileStatus | undefined;
+    publishedVersionId?: string | undefined;
+    versionNumber?: number | undefined;
+    draftUpdatedAt?: number | undefined;
+    session?: (AuthoringSessionRow & {
+        endedAt?: number | undefined;
+        endReason?: "done" | "expired" | undefined;
+    }) | undefined;
+}
+/** `workspaces:consoleDetail` — null when the workflow doesn't exist. */
+export interface WorkflowConsoleDetail {
+    workflowId: string;
+    state: WorkflowPublishState;
+    compile?: WorkflowCompileStatus | undefined;
+    publishedVersionId?: string | undefined;
+    versionNumber?: number | undefined;
+    draftUpdatedAt?: number | undefined;
+    irJson?: string | undefined;
+    sessions: AuthoringSessionRow[];
+}
+/** One row of `FN.workspacesListVersions`. */
+export interface WorkflowVersionRow {
+    versionId: string;
+    versionNumber: number;
+    deploymentId: string;
+    irJson?: string | undefined;
+    createdAt: number;
+    createdBy: string;
+    fromSessionId?: string | undefined;
+}
+/** One row of `FN.workspacesAvailableBundles`. */
+export interface WorkspaceBundleRow {
+    sha256: string;
+    storageId: string;
+    size: number;
+}
+/** `FN.deploymentsGet` */
+export interface DeploymentReadModel {
+    deploymentId: string;
+    workflowId: string;
+    description?: string | undefined;
+    deployedBy?: ActorIdentity | undefined;
+    codeStepIds: string[];
+    stepsBundleSha256?: string | undefined;
+    agentBundleSha256?: string | undefined;
+    stepsBundleSize?: number | undefined;
+    agentBundleSize?: number | undefined;
+    inputSchemaJsonText: string;
+    environments: EnvironmentStatus[];
+    createdAt: number;
+}
+/** `FN.deploymentsLatestFor` — null when the workflow has no published deployment. */
+export interface LatestDeploymentRef {
+    deploymentId: string;
+    inputSchemaJsonText: string;
+}
+/** One row of `FN.triggersList`; the trigger mutations return one row. */
+export interface TriggerScheduleReadModel {
+    triggerId: string;
+    workflowId: string;
+    name: string;
+    kind: "schedule";
+    cron: string;
+    timezone: string;
+    enabled: boolean;
+    status: "enabled" | "disabled";
+    nextFireAt?: number | undefined;
+    lastFiredAt?: number | undefined;
+    lastRunId?: string | undefined;
+    lastError?: string | undefined;
+    versionId: string;
+    createdAt: number;
+    updatedAt: number;
+}
+/** One row of `FN.variablesList` — a declared variable merged with its org override. */
+export interface WorkflowVariableRow {
+    name: string;
+    description?: string | undefined;
+    schemaJson: VariableIR["schemaJson"];
+    defaultJson: unknown;
+    value?: unknown;
+    updatedAt?: number | undefined;
+}
+export type MemberRole = "admin" | "operator" | "reviewer" | "viewer";
+export type ActorKind = "bootstrap" | "platform_token" | "access_token" | "authoring_session" | "user";
+/** The authenticated caller as `FN.orgsWhoami` reports it. */
+export interface OrgActor {
+    kind: ActorKind;
+    role?: MemberRole | undefined;
+    memberId?: string | undefined;
+    userId?: string | undefined;
+    tokenId?: string | undefined;
+    label?: string | undefined;
+    scopes?: Scope[] | undefined;
+    workflowIds?: string[] | undefined;
+    sessionId?: string | undefined;
+}
+/** `FN.orgsWhoami` */
+export interface OrgReadModel {
+    orgId: string;
+    name: string;
+    actor: OrgActor;
+}
+/** `members:list`, `members:updateRole`. */
+export interface MemberReadModel {
+    memberId: string;
+    userId: string;
+    email: string;
+    name?: string | undefined;
+    role: MemberRole;
+    workflowIds?: string[] | undefined;
+    createdAt: number;
+    updatedAt: number;
+}
+/** One row of `members:myOrgs`. */
+export interface OrgMembershipRow {
+    orgId: string;
+    orgName: string;
+    role: MemberRole;
+}
+/** `members:currentSession` — null when a native human still needs provisioning. */
+export interface SessionReadModel {
+    orgId: string;
+    orgName: string;
+    member: MemberReadModel;
+    orgs: Array<OrgMembershipRow & {
+        workosOrgId: string;
+    }>;
+    user: {
+        email: string;
+        name?: string | undefined;
+    };
+}
+/** `FN.devicesList` */
+export interface DeviceReadModel {
+    deviceId: string;
+    name: string;
+    handles: string[];
+    enabled: boolean;
+    settings: Record<string, unknown>;
+    createdAt: number;
+    updatedAt: number;
+    lastSeenAt?: number | undefined;
+}
+export type DeviceProfileLoginState = "not_started" | "pending" | "ready" | "failed";
+/** `FN.devicesListProfiles` rows; the profile mutations return one row. */
+export interface DeviceProfileReadModel {
+    profileId: string;
+    deviceId: string;
+    profileKey: string;
+    label?: string | undefined;
+    enabled: boolean;
+    loginState: DeviceProfileLoginState;
+    loginMessage?: string | undefined;
+    loginRequestedAt?: number | undefined;
+    loginCompletedAt?: number | undefined;
+    leasedByTaskId?: string | undefined;
+    leaseExpiresAt?: number | undefined;
+    createdAt: number;
+    updatedAt: number;
+}
+/** `invitations:list` and the single-invitation mutations, as WorkOS reports them. */
+export interface InvitationReadModel {
+    id: string;
+    email: string;
+    workosOrgId: string;
+    state: string;
+    createdAt?: number | undefined;
+    expiresAt?: number | undefined;
+}
+/** One row of `FN.secretsList` — names and timestamps only, never values. */
+export interface SecretReadModel {
+    name: string;
+    createdAt: number;
+    updatedAt: number;
+}
+/** One row of `FN.tokensList`; `tokens:create` returns one plus the raw token. */
+export interface PlatformTokenReadModel {
+    tokenId: string;
+    label: string;
+    tokenPrefix?: string | undefined;
+    kind: "bootstrap" | "platform";
+    scopes?: string[] | undefined;
+    workflowIds?: string[] | undefined;
+    createdByMemberId?: string | undefined;
+    createdAt?: number | undefined;
+    expiresAt?: number | undefined;
+    revokedAt?: number | undefined;
+    lastUsedAt?: number | undefined;
+}
+export type IntegrationConnectionState = "not_connected" | "connecting" | "connected" | "unhealthy" | "failed";
+export interface IntegrationCatalogAction {
+    id: string;
+    label: string;
+    description: string;
+    inputSchemaJsonText: string;
+    outputSchemaJsonText: string;
+}
+/** One entry of `FN.integrationsListCatalog`. */
+export interface IntegrationCatalogApp {
+    id: string;
+    label: string;
+    description: string;
+    actions: IntegrationCatalogAction[];
+}
+/** `FN.integrationsGetConnection` */
+export interface IntegrationConnectionReadModel {
+    appId: string;
+    state: IntegrationConnectionState;
+    connectStartedAt?: number | undefined;
+    connectedAt?: number | undefined;
+    lastCheckedAt?: number | undefined;
+    lastHealthyAt?: number | undefined;
+    lastRefreshedAt?: number | undefined;
+    lastUsedAt?: number | undefined;
+    lastError?: string | undefined;
+}
+export declare const ALERT_KINDS: readonly ["run_failed", "run_canceled", "run_retried", "run_succeeded_with_failures", "review_created", "review_expired", "task_failed", "task_timeout", "stuck_run"];
+export type AlertKind = (typeof ALERT_KINDS)[number];
+export type AlertLifecycle = "open" | "resolved" | "exhausted";
+export type AlertPolicyScope = {
+    kind: "org";
+} | {
+    kind: "group";
+    groupId: string;
+    groupName?: string | undefined;
+} | {
+    kind: "workflow";
+    workflowId: string;
+};
+export interface AlertMemberIdentity {
+    memberId: string;
+    email: string;
+    name?: string | undefined;
+}
+export interface AlertChainRung {
+    members: AlertMemberIdentity[];
+}
+/** One row of `alerts:listNotifications`. */
+export interface AlertNotificationRow {
+    notificationId: string;
+    alertId: string;
+    rung: number;
+    channel: "slack";
+    memberIds: string[];
+    ccMemberIds: string[];
+    status: "queued" | "delivered" | "failed";
+    deliveryError?: string | undefined;
+    createdAt: number;
+    deliveredAt?: number | undefined;
+}
+/** A notification inside `FN.alertsList`, with member identities resolved. */
+export interface AlertNotification extends AlertNotificationRow {
+    members: AlertMemberIdentity[];
+    ccMembers: AlertMemberIdentity[];
+}
+/** One row of `FN.alertsList`. */
+export interface AlertReadModel {
+    alertId: string;
+    policyId?: string | undefined;
+    event: AlertKind;
+    title: string;
+    message: string;
+    workflowId?: string | undefined;
+    runId?: string | undefined;
+    stepId?: string | undefined;
+    sourceApprovalId?: string | undefined;
+    status: AlertLifecycle;
+    currentRung: number;
+    notifiedMemberIds: string[];
+    closedReason?: string | undefined;
+    resolvedAt?: number | undefined;
+    createdAt: number;
+    escalateAfterMs?: number | undefined;
+    chain: AlertChainRung[];
+    policy?: {
+        name: string;
+        scope: AlertPolicyScope;
+    } | undefined;
+    integration?: {
+        name: string;
+    } | undefined;
+    notifications: AlertNotification[];
+}
+/** One row of `FN.alertsListPolicies`, with scope and chain identities resolved. */
+export interface AlertPolicyReadModel {
+    policyId: string;
+    name: string;
+    events: AlertKind[];
+    scope: AlertPolicyScope;
+    chain: AlertChainRung[];
+    escalateAfterMs?: number | undefined;
+    slackIntegrationId?: string | undefined;
+    enabled: boolean;
+    createdAt: number;
+    updatedAt: number;
+    integration?: {
+        name: string;
+        enabled: boolean;
+    } | undefined;
+}
+/** One row of `alerts:listSlackIntegrations`. */
+export interface SlackIntegrationReadModel {
+    integrationId: string;
+    name: string;
+    enabled: boolean;
+}
+/** `dashboard:shellCounts` — null for sections the caller can't read. */
+export interface ShellCounts {
+    pendingReviews: number | null;
+    unresolvedAlerts: number | null;
+}
+/** The compact alert row in the home overview feed. */
+export interface AlertSummaryRow {
+    alertId: string;
+    title: string;
+    status: AlertLifecycle;
+    currentRung: number;
+    createdAt: number;
+    workflowId?: string | undefined;
+}
+/** `dashboard:overview` — each section gated by the caller's permissions. */
+export interface HomeOverview {
+    workflows: {
+        available: false;
+    } | {
+        available: true;
+        count: number;
+    };
+    approvals: {
+        available: false;
+    } | {
+        available: true;
+        data: ApprovalReadModel[];
+        recent: ApprovalReadModel[];
+    };
+    runs: {
+        available: false;
+    } | {
+        available: true;
+        data: RunListRow[];
+        recent: RunListRow[];
+    };
+    alerts: {
+        available: false;
+    } | {
+        available: true;
+        data: AlertSummaryRow[];
+    };
+}
+/** `dashboard:workflowHealth` — attention-ranked, paged. */
+export type WorkflowHealthPage = {
+    available: false;
+} | {
+    available: true;
+    rows: WorkflowHealthRow[];
+    totalItems: number;
+    pageIndex: number;
+};

package/node_modules/@reasonlayer/protocol/dist/readmodels.js

@@ -0,0 +1,36 @@
+/**
+ * The shapes the `FN` functions return.
+ *
+ * `FN` names the Convex functions every consumer calls; this module names what
+ * those calls resolve to. Backend handlers declare these as their return type,
+ * so a handler that stops producing a field fails to compile at the source
+ * instead of silently at the console, the CLI, or the runner.
+ *
+ * Named ceiling: TypeScript is erased at runtime, so this catches drift only at
+ * build time and only for consumers that compile in CI. Upgrade path is Convex
+ * `v.*` return validators on the handlers, with the types derived from those.
+ */
+/* -------------------------------------------------------------------------- */
+/* reviews                                                                    */
+/* -------------------------------------------------------------------------- */
+export const APPROVAL_STATUSES = [
+    "pending",
+    "approved",
+    "rejected",
+    "expired",
+    "canceled",
+];
+/* -------------------------------------------------------------------------- */
+/* alerts                                                                     */
+/* -------------------------------------------------------------------------- */
+export const ALERT_KINDS = [
+    "run_failed",
+    "run_canceled",
+    "run_retried",
+    "run_succeeded_with_failures",
+    "review_created",
+    "review_expired",
+    "task_failed",
+    "task_timeout",
+    "stuck_run",
+];