@muxoai/sdk 1.4.3 → 1.4.5

package/dist/oss-suite.d.ts

@@ -6,7 +6,7 @@
  * 4. FinOps & Commercial ROI Unit-Economics Analytics
  */
 import { type DurableWorkflow } from "./durable-workflow.js";
-import type { ActionPlan, ByokKeyRecord, ExecutionReceipt, ExecutionRun, GovernancePolicy, HumanFriendlyExplanation, ProviderLane, ProvisionedResource, RiskLevel, TemporalGraphFact, Workspace } from "./types.js";
+import type { ActionPlan, ApprovalImpactPreview, BusinessReceiptSummary, ByokKeyRecord, ExecutionReceipt, ExecutionRun, GovernanceDecisionRecord, GovernancePolicy, HumanFriendlyExplanation, ProviderLane, ProvisionedResource, RiskLevel, SupplierSettlement, TemporalGraphFact, Workspace } from "./types.js";
 export interface CompiledPolicyAsCodeBundle {
     workspaceId: string;
     workspaceSlug: string;
@@ -134,15 +134,23 @@ export declare function buildOtelTraceExport(params: {
     version?: string;
 }): OtelTraceExportBundle;
 export interface CommercialPlaybookDefinition {
-    slug: "fullstack-cloud-bootstrap" | "competitor-seo-growth-brief" | "incident-containment-audit" | "customer-release-readiness";
+    slug: string;
     name: string;
-    persona: "Engineering & DevOps" | "Marketing & Growth" | "SecOps & Compliance" | "Product & Founders";
+    persona: "Customer Operations & Support" | "Engineering & DevOps" | "Marketing & Growth" | "SecOps & Compliance" | "Product & Founders" | "Custom Workspace Saga";
     summary: string;
     commercialValue: string;
     estimatedMinutesSaved: number;
     creditCost: number;
+    expectedCostUsd: number;
     defaultProvider: string;
     defaultServiceRef: string;
+    requiredConnections: string[];
+    explicitPermissions: string[];
+    approvalRules: string[];
+    failureAndRecoveryBehavior: string;
+    usableBusinessOutcome: string;
+    naturalLanguageTriggers?: string[];
+    custom?: boolean;
     steps: Array<{
         name: string;
         toolSlug: string;
@@ -152,7 +160,8 @@ export interface CommercialPlaybookDefinition {
     }>;
 }
 export declare const MUXO_COMMERCIAL_PLAYBOOKS: CommercialPlaybookDefinition[];
-export declare function getCommercialPlaybook(slug: string): CommercialPlaybookDefinition | null;
+export declare function getCommercialPlaybook(slugOrQuery: string, customPlaybooks?: CommercialPlaybookDefinition[]): CommercialPlaybookDefinition | null;
+export declare function parseNaturalLanguageCustomPlaybook(prompt: string, explicitInput?: Record<string, unknown>): CommercialPlaybookDefinition;
 export declare function buildPlaybookSagaExecution(params: {
     id: string;
     workspaceId: string;
@@ -162,6 +171,21 @@ export declare function buildPlaybookSagaExecution(params: {
 }): {
     playbook: CommercialPlaybookDefinition;
     workflow: DurableWorkflow;
+    usableResult: {
+        playbookSlug: string;
+        playbookName: string;
+        status: "completed";
+        summary: string;
+        deliverableOutcome: string;
+        targetProvider: string;
+        targetEntity: string;
+        completedStepsCount: number;
+        registeredCompensationsCount: number;
+        estimatedCostUsd: number;
+        creditsMetered: number;
+        estimatedMinutesSaved: number;
+        recoveryGuarantee: string;
+    };
     temporalFact: {
         subject: string;
         predicate: string;
@@ -183,6 +207,7 @@ export interface CommercialRoiReport {
         byokZeroCreditRunsCount: number;
         managedFundedRunsCount: number;
         totalCreditsConsumed: number;
+        totalMonetarySpendUsd: number;
         byokCreditsSaved: number;
         byokDollarsSavedUsd: number;
         estimatedEngineeringMinutesSaved: number;
@@ -193,9 +218,28 @@ export interface CommercialRoiReport {
         activeBiTemporalFactsCount: number;
         configuredByokProviders: string[];
     };
+    validationMetrics: {
+        timeToFirstSuccessfulActionSeconds: number;
+        completionRateWithoutManualRepairPct: number;
+        avgTimeSavedPerWorkflowMinutes: number;
+        avgCostPerCompletedWorkflowUsd: number;
+        repeatWorkflowExecutionsCount: number;
+        zeroChargeFailedRunsCount: number;
+    };
+    workflowBreakdown: Array<{
+        toolSlug: string;
+        lane: ProviderLane;
+        runsCount: number;
+        succeededCount: number;
+        completionRatePct: number;
+        creditsConsumed: number;
+        costUsd: number;
+        estimatedMinutesSaved: number;
+    }>;
     laneBreakdown: Record<ProviderLane, {
         runsCount: number;
         creditsConsumed: number;
+        costUsd: number;
         estimatedMinutesSaved: number;
     }>;
     recommendations: Array<{
@@ -215,3 +259,143 @@ export declare function buildCommercialRoiReport(params: {
     byokKeys: ByokKeyRecord[];
     temporalFacts: TemporalGraphFact[];
 }): CommercialRoiReport;
+export type HarnessPresetSlug = "startup-builder" | "strict-production" | "read-only-auditor" | "finops-byok-zero-cost";
+export interface HarnessPresetDefinition {
+    slug: HarnessPresetSlug;
+    name: string;
+    summary: string;
+    recommendedFor: string;
+    naturalLanguageTriggers: string[];
+    policyPatch: Partial<GovernancePolicy>;
+}
+export declare const MUXO_HARNESS_PRESETS: HarnessPresetDefinition[];
+export declare function resolveHarnessPreset(presetOrPrompt?: string | null): HarnessPresetDefinition | null;
+export interface HarnessConfigurationBundle {
+    ok: true;
+    workspaceId: string;
+    workspaceSlug: string;
+    targetHarness: string;
+    appliedPreset: HarnessPresetDefinition | null;
+    availablePresets: HarnessPresetDefinition[];
+    policy: GovernancePolicy;
+    harnessConfigs: {
+        claudeCode: {
+            installPluginCommand: string;
+            addMcpCommand: string;
+            mcpJson: Record<string, unknown>;
+        };
+        cursor: {
+            filePath: ".cursor/mcp.json";
+            mcpJson: Record<string, unknown>;
+        };
+        codex: {
+            filePath: "~/.codex/config.toml";
+            toml: string;
+        };
+        chatgpt: {
+            mcpServerUrl: string;
+            authMode: string;
+            instructions: string;
+        };
+        claudeDesktop: {
+            filePath: "claude_desktop_config.json";
+            mcpJson: Record<string, unknown>;
+        };
+        factoryDroid: {
+            mcpServerUrl: string;
+            skillCommand: string;
+        };
+    };
+    systemPromptDirective: string;
+    naturalLanguageCheatsheet: Array<{
+        category: string;
+        sayInPlainEnglish: string;
+        mcpEquivalent: Record<string, unknown>;
+        restEndpoint: string;
+    }>;
+    explanation: HumanFriendlyExplanation;
+    humanMessage: string;
+}
+export declare function buildHarnessConfigurationBundle(params: {
+    workspace: Pick<Workspace, "id" | "slug" | "name" | "tier" | "policy">;
+    baseUrl?: string;
+    targetHarness?: string;
+    appliedPreset?: HarnessPresetDefinition | null;
+}): HarnessConfigurationBundle;
+export type NaturalLanguageOssIntentKind = "list_playbooks" | "run_playbook" | "create_playbook" | "rollback_workflow" | "signal_workflow" | "workflow_history" | "memory_graph" | "cedar_compile" | "cedar_evaluate" | "otel_traces" | "roi_analytics" | "configure_harness";
+export interface ParsedNaturalLanguageOssIntent {
+    matched: boolean;
+    kind: NaturalLanguageOssIntentKind | null;
+    playbookSlug?: string;
+    playbookInput?: Record<string, unknown>;
+    customPlaybook?: CommercialPlaybookDefinition;
+    workflowId?: string;
+    workflowReason?: string;
+    signalName?: string;
+    signalPayload?: Record<string, unknown>;
+    asOf?: string | null;
+    focalEntity?: string | null;
+    maxHops?: number;
+    toolSlug?: string;
+    evaluationInput?: Record<string, unknown>;
+    preset?: HarnessPresetDefinition | null;
+    targetHarness?: string;
+    extraGuardrailPrompt?: string | null;
+    limit?: number;
+    summary: string;
+}
+export declare function extractPlaybookInputFromNaturalLanguage(prompt: string, explicitInput?: Record<string, unknown>): Record<string, unknown>;
+export declare function parseNaturalLanguageOssIntent(prompt: string, options?: {
+    customPlaybooks?: CommercialPlaybookDefinition[];
+    explicitInput?: Record<string, unknown>;
+}): ParsedNaturalLanguageOssIntent;
+export declare function buildApprovalImpactPreview(params: {
+    toolSlug: string;
+    lane: ProviderLane;
+    riskLevel: RiskLevel;
+    input: Record<string, unknown>;
+    reason?: string;
+    creditCost: number;
+    fundingMode?: "muxo_funded" | "byok";
+    supplierSettlement?: SupplierSettlement | null;
+    decisionRecord?: GovernanceDecisionRecord | null;
+    workspaceName?: string;
+}): ApprovalImpactPreview;
+export declare function buildBusinessReceiptSummary(params: {
+    toolSlug: string;
+    lane: ProviderLane;
+    riskLevel: RiskLevel;
+    status: "succeeded" | "failed" | "cancelled";
+    creditsMetered: number;
+    input?: Record<string, unknown>;
+    output?: unknown;
+    error?: string | null;
+    approvedBy?: string | null;
+    actorId?: string;
+    decisionRecord?: GovernanceDecisionRecord | null;
+    supplierSettlement?: SupplierSettlement | null;
+}): BusinessReceiptSummary;
+export interface RunReconciliationReport {
+    ok: true;
+    runId: string;
+    planId: string;
+    workspaceId: string;
+    toolSlug: string;
+    status: ExecutionRun["status"];
+    reconciliationStatus: "verified_complete" | "failed_zero_charge" | "cancelled" | "needs_reconciliation";
+    executeOnceEnforced: boolean;
+    idempotentReplaySafe: boolean;
+    zeroChargeOnFailureVerified: boolean;
+    creditsMetered: number;
+    estimatedCostUsd: number;
+    receiptVerified: boolean;
+    receiptId: string | null;
+    businessSummary: BusinessReceiptSummary;
+    recommendedNextAction: string;
+}
+export declare function buildRunReconciliationReport(params: {
+    run?: ExecutionRun | null;
+    plan?: ActionPlan | null;
+    receipt?: ExecutionReceipt | null;
+    signatureValid?: boolean;
+}): RunReconciliationReport;