@crewx/sdk 0.9.0-rc.57 → 0.9.0-rc.59

package/dist/ui-instance/definition.d.ts

@@ -0,0 +1,6 @@
+import type { UiDefinition, UiDefinitionInput, UiDefinitionRef } from './types.js';
+export declare function hashUiDefinition(input: UiDefinitionInput): string;
+export declare function definitionKey(ref: UiDefinitionRef): string;
+export declare function validateDefinition(definition: UiDefinition): void;
+export declare function isExactCapability(value: string): boolean;
+export declare function refFromDefinition(definition: UiDefinition): UiDefinitionRef;

package/dist/ui-instance/errors.d.ts

@@ -0,0 +1,17 @@
+export type UiRuntimeErrorCode = 'UNAUTHENTICATED' | 'INSTANCE_NOT_FOUND' | 'WORKSPACE_MISMATCH' | 'INSTANCE_NOT_ACTIONABLE' | 'DEFINITION_UNSUPPORTED' | 'CAPABILITY_DENIED' | 'INPUT_INVALID' | 'REVISION_CONFLICT' | 'ACTION_UNAVAILABLE' | 'HANDLER_NOT_FOUND' | 'ACTION_IN_FLIGHT' | 'DOMAIN_REJECTED' | 'EXECUTION_FAILED';
+export declare class UiRuntimeError extends Error {
+    readonly code: UiRuntimeErrorCode;
+    readonly currentRevision?: number | undefined;
+    readonly name = "UiRuntimeError";
+    constructor(code: UiRuntimeErrorCode, message?: string, currentRevision?: number | undefined);
+}
+export declare class UiRetryableDatabaseError extends Error {
+    readonly cause: unknown;
+    readonly name = "UiRetryableDatabaseError";
+    constructor(cause: unknown);
+}
+export declare class UiReservationConflictError extends Error {
+    readonly currentRevision: number;
+    readonly name = "UiReservationConflictError";
+    constructor(currentRevision: number);
+}

package/dist/ui-instance/index.d.ts

@@ -0,0 +1,6 @@
+export type { ActionReceipt, ActionReceiptOutcome, CreateUiInstanceInput, JsonObject, JsonPrimitive, JsonValue, UiActionHandlerContext, UiActionHandlerRegistration, UiActionHandlerResult, UiActionEnvelope, UiActor, UiDefinition, UiDefinitionAction, UiDefinitionInput, UiDefinitionRef, UiProjectionPolicy, UiExecutionContext, UiAuthenticatedActor, UiAuthenticatedExecutionContext, UiAuthenticatedGrantPolicy, UiServerRuntimeFacade, UiServerRuntimeOptions, UiAgentContextProjection, UiExternalActionHandlerRegistration, UiInstance, UiInstanceStatus, UiLocalGrantPolicy, UiRuntimeFacade, UiRuntimeOptions, UiStateActionHandlerRegistration, } from './types.js';
+export { resolveUiEffectiveCapabilities } from './types.js';
+export { UiRuntimeError } from './errors.js';
+export type { UiRuntimeErrorCode } from './errors.js';
+export { hashUiDefinition } from './definition.js';
+export { createUiRuntimeForTest, createUiServerRuntime } from './runtime.js';

package/dist/ui-instance/json.d.ts

@@ -0,0 +1,5 @@
+import type { JsonObject, JsonValue } from './types.js';
+export declare function projectSafeJsonObject(value: unknown): JsonObject;
+export declare function serializeJson(value: JsonValue): string;
+export declare function canonicalJson(value: JsonValue): string;
+export declare function utf8ByteLength(value: string): number;

package/dist/ui-instance/runtime.d.ts

@@ -0,0 +1,13 @@
+import type { UiRuntimeFacade, UiRuntimeOptions, UiServerRuntimeFacade, UiServerRuntimeOptions } from './types.js';
+export interface UiRuntimeTestHooks {
+    beforeReservation?: () => Promise<void> | void;
+    injectDatabaseError?: () => unknown | undefined;
+    bumpRevisionBeforeCas?: boolean;
+}
+export interface UiRuntimeForTestOptions extends UiRuntimeOptions {
+    workspaceId: string;
+    testHooks?: UiRuntimeTestHooks;
+}
+export declare function createUiRuntime(workspaceId: string, options: UiRuntimeOptions): UiRuntimeFacade;
+export declare function createUiRuntimeForTest(options: UiRuntimeForTestOptions): UiRuntimeFacade;
+export declare function createUiServerRuntime(options: UiServerRuntimeOptions): UiServerRuntimeFacade;

package/dist/ui-instance/store.d.ts

@@ -0,0 +1,65 @@
+import type { ActionReceipt, ActionReceiptOutcome, JsonObject, UiActionHandlerContext, UiActor, UiInstance } from './types.js';
+interface UiInstanceStoreTestHooks {
+    injectDatabaseError?: () => unknown | undefined;
+    bumpRevisionBeforeCas?: boolean;
+}
+export interface ReservationInput {
+    instanceId: string;
+    requestId: string;
+    actionId: string;
+    actor: UiActor;
+    source: 'cli' | 'ui_host' | 'system';
+    expectedRevision: number;
+    input: JsonObject;
+    now: number;
+}
+export interface StateHandlerExecution {
+    handle: (context: UiActionHandlerContext) => {
+        state?: JsonObject;
+        result?: JsonObject;
+    } | {
+        outcome: 'rejected' | 'failed';
+        errorCode: string;
+        state?: JsonObject;
+        result?: JsonObject;
+    };
+}
+export interface ExternalReservation {
+    instance: UiInstance;
+    receipt: ActionReceipt;
+    reservedRevision: number;
+}
+export declare class UiInstanceStore {
+    private readonly handle;
+    private readonly db;
+    private readonly testHooks?;
+    constructor(dbPath?: string, testHooks?: UiInstanceStoreTestHooks);
+    close(): void;
+    create(input: {
+        id: string;
+        definitionId: string;
+        definitionVersion: number;
+        definitionHash: string;
+        workspaceId: string;
+        threadId: string;
+        anchorTaskId: string | null;
+        domainRef: JsonObject;
+        state: JsonObject;
+        grants: readonly string[];
+        now: number;
+    }): UiInstance;
+    get(instanceId: string): UiInstance | null;
+    getReceipt(instanceId: string, requestId: string): ActionReceipt | null;
+    runStateOnly(reservation: ReservationInput, handler: StateHandlerExecution['handle']): ActionReceipt;
+    reserveExternal(reservation: ReservationInput): ExternalReservation;
+    settleExternal(input: {
+        reservation: ReservationInput;
+        reservedRevision: number;
+        outcome: ActionReceiptOutcome;
+        state: JsonObject;
+        result: JsonObject | null;
+        errorCode: string | null;
+        now: number;
+    }): ActionReceipt;
+}
+export {};

package/dist/ui-instance/types.d.ts

@@ -0,0 +1,200 @@
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue = JsonPrimitive | JsonObject | JsonValue[];
+export interface JsonObject {
+    [key: string]: JsonValue;
+}
+export type UiInstanceStatus = 'active' | 'completed' | 'expired' | 'revoked' | 'unsupported';
+export interface UiDefinitionRef {
+    id: string;
+    version: number;
+    hash: string;
+}
+export interface UiDefinitionAction {
+    readonly capabilities: readonly string[];
+    readonly inputKeys?: readonly string[];
+    readonly resultProjection?: UiProjectionPolicy;
+}
+export interface UiProjectionPolicy {
+    allow: readonly string[];
+}
+export interface UiDefinitionInput {
+    readonly id: string;
+    readonly version: number;
+    readonly actions: Readonly<Record<string, UiDefinitionAction>>;
+    readonly renderer?: string;
+    readonly surfaces?: readonly string[];
+    readonly stateProjection?: UiProjectionPolicy;
+}
+export interface UiDefinition extends UiDefinitionInput {
+    readonly hash: string;
+}
+export interface CreateUiInstanceInput {
+    definition: UiDefinitionRef;
+    workspaceId: string;
+    threadId: string;
+    anchorTaskId?: string;
+    domainRef: JsonObject;
+    state: JsonObject;
+}
+export interface UiInstance {
+    id: string;
+    definition: UiDefinitionRef;
+    workspaceId: string;
+    threadId: string;
+    anchorTaskId: string | null;
+    domainRef: JsonObject;
+    state: JsonObject;
+    revision: number;
+    status: UiInstanceStatus;
+    grantedCapabilities: readonly string[];
+    createdAt: number;
+    updatedAt: number;
+}
+export interface UiActionEnvelope {
+    instanceId: string;
+    actionId: string;
+    expectedRevision: number;
+    requestId: string;
+    input: JsonObject;
+}
+export type UiActor = {
+    kind: 'local';
+    id: string;
+} | {
+    kind: 'authenticated';
+    id: string;
+};
+export interface UiExecutionContext {
+    source: 'cli' | 'ui_host' | 'system';
+    workspaceId: string;
+    actor: UiActor;
+}
+export interface UiAuthenticatedActor {
+    kind: 'authenticated';
+    id: string;
+}
+export interface UiAuthenticatedExecutionContext {
+    source: 'ui_host' | 'system';
+    workspaceId: string;
+    threadId: string;
+    actor: UiAuthenticatedActor;
+}
+export type ActionReceiptOutcome = 'succeeded' | 'rejected' | 'failed' | 'conflicted' | 'expired';
+export interface ActionReceipt {
+    id: string;
+    instanceId: string;
+    requestId: string;
+    actionId: string;
+    actor: UiActor;
+    source: 'cli' | 'ui_host' | 'system';
+    expectedRevision: number;
+    beforeRevision: number;
+    afterRevision: number | null;
+    status: 'requested' | 'settled';
+    outcome: ActionReceiptOutcome | null;
+    input: JsonObject;
+    result: JsonObject | null;
+    errorCode: string | null;
+    requestedAt: number;
+    settledAt: number | null;
+}
+export interface UiLocalGrantPolicy {
+    resolveInstanceGrants(input: {
+        definition: UiDefinitionRef;
+        workspaceId: string;
+        actor: Extract<UiActor, {
+            kind: 'local';
+        }>;
+    }): readonly string[];
+    resolveActionCapabilities(input: {
+        definition: UiDefinitionRef;
+        actionId: string;
+    }): readonly string[];
+}
+export interface UiActionHandlerContext {
+    instance: UiInstance;
+    actor: UiActor;
+    source: 'cli' | 'ui_host' | 'system';
+    input: JsonObject;
+    requestId: string;
+}
+export type UiActionHandlerResult = {
+    state?: JsonObject;
+    result?: JsonObject;
+} | {
+    outcome: 'rejected' | 'failed';
+    errorCode: string;
+    state?: JsonObject;
+    result?: JsonObject;
+};
+export interface UiStateActionHandlerRegistration {
+    definitionId: string;
+    version: number;
+    actionId: string;
+    kind: 'state';
+    handle: (context: UiActionHandlerContext) => UiActionHandlerResult;
+}
+export interface UiExternalActionHandlerRegistration {
+    definitionId: string;
+    version: number;
+    actionId: string;
+    kind: 'external';
+    handle: (context: UiActionHandlerContext) => Promise<UiActionHandlerResult>;
+}
+export type UiActionHandlerRegistration = UiStateActionHandlerRegistration | UiExternalActionHandlerRegistration;
+export interface UiRuntimeOptions {
+    dbPath?: string;
+    localActor: Extract<UiActor, {
+        kind: 'local';
+    }>;
+    localGrantPolicy?: UiLocalGrantPolicy;
+    definitions?: readonly UiDefinition[];
+    handlers?: readonly UiActionHandlerRegistration[];
+    clock?: () => number;
+}
+export interface UiRuntimeFacade {
+    resolveDefinition(ref: UiDefinitionRef): UiDefinition | null;
+    createInstance(input: CreateUiInstanceInput): Promise<UiInstance>;
+    dispatchAction(input: UiActionEnvelope, context: UiExecutionContext): Promise<ActionReceipt>;
+    getReceipt(instanceId: string, requestId: string): Promise<ActionReceipt | null>;
+    close(): void;
+}
+export interface UiAuthenticatedGrantPolicy {
+    resolveInstanceGrants(input: {
+        definition: UiDefinitionRef;
+        workspaceId: string;
+        actor: UiAuthenticatedActor;
+    }): readonly string[];
+    resolveDispatchCapabilities?(input: {
+        definition: UiDefinitionRef;
+        actionId: string;
+        actor: UiAuthenticatedActor;
+        source: 'ui_host' | 'system';
+    }): readonly string[];
+}
+export declare function resolveUiEffectiveCapabilities(declared: readonly string[], instanceGranted: readonly string[], dispatchGranted?: readonly string[]): readonly string[];
+export interface UiServerRuntimeOptions {
+    workspaceId: string;
+    dbPath: string;
+    definitions: readonly UiDefinition[];
+    handlers: readonly UiActionHandlerRegistration[];
+    grantPolicy: UiAuthenticatedGrantPolicy;
+    clock?: () => number;
+}
+export interface UiServerRuntimeFacade {
+    resolveDefinition(ref: UiDefinitionRef): UiDefinition | null;
+    getInstance(instanceId: string, context: UiAuthenticatedExecutionContext): Promise<UiInstance | null>;
+    createInstance(input: CreateUiInstanceInput, context: UiAuthenticatedExecutionContext): Promise<UiInstance>;
+    dispatchAction(input: UiActionEnvelope, context: UiAuthenticatedExecutionContext): Promise<ActionReceipt>;
+    getReceipt(instanceId: string, requestId: string, context: UiAuthenticatedExecutionContext): Promise<ActionReceipt | null>;
+    close(): void;
+}
+export interface UiAgentContextProjection {
+    instanceId: string;
+    definition: UiDefinitionRef;
+    revision: number;
+    facts: JsonObject;
+    recentChanges: readonly JsonObject[];
+    pendingDecision: JsonObject | null;
+    availableActions: readonly string[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crewx/sdk",
-  "version": "0.9.0-rc.57",
+  "version": "0.9.0-rc.59",
   "license": "UNLICENSED",
   "engines": {
     "node": ">=20.19.0"