@crewx/sdk 0.9.0-rc.181 → 0.9.0-rc.182

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

@@ -1,5 +1,5 @@
-export type { ActionReceipt, ActionReceiptResultSummary, ActionExecutionReceipt, ActionReceiptOutcome, CreateUiInstanceInput, JsonObject, JsonPrimitive, JsonValue, UiActionHandlerContext, UiActionHandlerRegistration, UiActionHandlerResult, UiActionEnvelope, UiActionConfirmation, UiSkillBackendEnvironmentKey, UiActor, UiDefinition, UiDefinitionAction, UiDefinitionDisplayMode, UiDefinitionInput, UiDefinitionLegacyMetadata, UiDefinitionRef, UiDefinitionUsage, UiProjectionPolicy, UiExecutionContext, UiAuthenticatedActor, UiTaskActorSnapshot, UiAuthenticatedExecutionContext, UiApprovalRequestContext, UiTaskExecutionContext, UiApprovalDecisionProvenance, UiApprovalPendingReceipt, UiApprovalRequestReceiptResult, UiAuthenticatedGrantPolicy, UiServerRuntimeFacade, UiServerRuntimeOptions, UiAgentContextProjection, UiExternalActionHandlerRegistration, UiAgentOpenReason, UiAgentOpenRequest, UiInstance, UiInstanceStatus, UiLocalGrantPolicy, UiRuntimeFacade, UiRuntimeOptions, UiStateActionHandlerRegistration, } from './types.js';
-export { isUiAuthenticatedActor, resolveUiEffectiveCapabilities } from './types.js';
+export type { ActionReceipt, ActionReceiptResultSummary, ActionExecutionReceipt, ActionReceiptOutcome, CreateUiInstanceInput, JsonObject, JsonPrimitive, JsonValue, UiActionHandlerContext, UiActionHandlerRegistration, UiActionHandlerResult, UiActionImageDescriptor, UiActionEnvelope, UiActionConfirmation, UiSkillBackendEnvironmentKey, UiActor, UiDefinition, UiDefinitionAction, UiDefinitionDisplayMode, UiDefinitionInput, UiDefinitionLegacyMetadata, UiDefinitionRef, UiDefinitionUsage, UiProjectionPolicy, UiExecutionContext, UiAuthenticatedActor, UiTaskActorSnapshot, UiAuthenticatedExecutionContext, UiApprovalRequestContext, UiTaskExecutionContext, UiApprovalDecisionProvenance, UiApprovalPendingReceipt, UiApprovalRequestReceiptResult, UiAuthenticatedGrantPolicy, UiServerRuntimeFacade, UiServerRuntimeOptions, UiAgentContextProjection, UiExternalActionHandlerRegistration, UiAgentOpenReason, UiAgentOpenRequest, UiInstance, UiInstanceStatus, UiLocalGrantPolicy, UiRuntimeFacade, UiRuntimeOptions, UiStateActionHandlerRegistration, UiViewCallActionResult, UiViewCallHandler, UiViewCallHandlerContext, UiViewCallHandlerRegistration, UiViewCallHandlerResponse, } from './types.js';
+export { DEFAULT_UI_DEFINITION_USAGE, UI_VIEW_CALL_HANDLER_NAME, UI_VIEW_CALL_IMAGE_RESULT_KEY, isUiAuthenticatedActor, resolveUiEffectiveCapabilities, } from './types.js';
 export { UiRuntimeError } from './errors.js';
 export type { UiRuntimeErrorCode } from './errors.js';
 export { projectSafeJsonObject, redactJsonPaths } from './json.js';

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

@@ -197,7 +197,7 @@ export declare class UiInstanceStore {
     settleApprovalPendingReceipt(receiptId: string, outcome: 'rejected' | 'expired' | 'conflicted', provenance: UiApprovalDecisionProvenance, now: number): ActionReceipt | null;
     getLatestReceiptForInstance(instanceId: string): ActionReceipt | null;
     runStateOnly(reservation: ReservationInput, handler: StateHandlerExecution['handle']): ActionReceipt;
-    reserveExternal(reservation: ReservationInput): ExternalReservation;
+    reserveExternal(reservation: ReservationInput, readOnly?: boolean): ExternalReservation;
     reserveApprovalPendingReceipt(reservation: ReservationInput, receiptId: string, provenance: UiApprovalDecisionProvenance): ApprovalPendingReservationResult;
     settleExternal(input: {
         reservation: ReservationInput;
@@ -207,6 +207,7 @@ export declare class UiInstanceStore {
         state: JsonObject;
         resultSummary: JsonObject | null;
         errorCode: string | null;
+        readOnly?: boolean;
         apply?: () => ReturnType<StateHandlerExecution['handle']>;
         restoreRevisionOnFailure?: boolean;
         now: number;

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

@@ -6,6 +6,19 @@ export type JsonValue = JsonPrimitive | JsonObject | JsonValue[];
 export interface JsonObject {
     [key: string]: JsonValue;
 }
+export declare const UI_VIEW_CALL_HANDLER_NAME: "view.call";
+export declare const UI_VIEW_CALL_IMAGE_RESULT_KEY: "crewxImage";
+export type UiActionImageDescriptor = JsonObject & {
+    readonly ref: string;
+    readonly mediaType: 'image/png';
+    readonly width: number;
+    readonly height: number;
+    readonly bytes: number;
+    readonly sha256: string;
+};
+export type UiViewCallActionResult = JsonObject & {
+    readonly [UI_VIEW_CALL_IMAGE_RESULT_KEY]: UiActionImageDescriptor;
+};
 export type UiInstanceStatus = 'active' | 'completed' | 'expired' | 'revoked' | 'unsupported';
 export interface UiDefinitionRef {
     id: string;
@@ -20,6 +33,7 @@ export type UiSkillBackendEnvironmentKey = 'CREWX_APP_INSTANCE_ID' | 'CREWX_THRE
 export interface UiDefinitionAction {
     readonly capabilities: readonly string[];
     readonly inputKeys?: readonly string[];
+    readonly mutation?: boolean;
     readonly dataInputs?: readonly string[];
     readonly confirmation?: UiActionConfirmation;
     readonly resultProjection?: UiProjectionPolicy;
@@ -249,6 +263,27 @@ export interface UiActionHandlerContext {
     };
     schedule?: AppScheduleSnapshot;
 }
+export interface UiViewCallHandlerContext extends UiActionHandlerContext {
+    readonly actionId: string;
+}
+export type UiViewCallHandlerResponse = {
+    readonly result: JsonObject;
+    readonly image: UiActionImageDescriptor;
+    readonly outcome?: never;
+    readonly errorCode?: never;
+    readonly state?: never;
+    readonly content?: never;
+    readonly schedule?: never;
+} | {
+    readonly outcome: 'rejected' | 'failed';
+    readonly errorCode: string;
+    readonly result?: never;
+    readonly image?: never;
+    readonly state?: never;
+    readonly content?: never;
+    readonly schedule?: never;
+};
+export type UiViewCallHandler = (context: UiViewCallHandlerContext) => Promise<UiViewCallHandlerResponse>;
 export type UiActionHandlerResult = {
     state?: JsonObject;
     result?: JsonObject;
@@ -274,7 +309,11 @@ export interface UiExternalActionHandlerRegistration {
     actionId: string;
     kind: 'external';
     handle: (context: UiActionHandlerContext) => Promise<UiActionHandlerResult>;
+    readonly viewCallHandler?: UiViewCallHandler;
 }
+export type UiViewCallHandlerRegistration = UiExternalActionHandlerRegistration & {
+    readonly viewCallHandler: UiViewCallHandler;
+};
 export type UiActionHandlerRegistration = UiStateActionHandlerRegistration | UiExternalActionHandlerRegistration;
 export interface UiRuntimeOptions {
     dbPath?: string;

package/package.json

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