@lunnoa/client 1.2.0 → 1.4.0

package/dist/index.d.cts

@@ -131,6 +131,15 @@ type ChatMode = 'builder' | 'preview';
 interface StreamMessageOptions {
     /** Agent chat mode; defaults to the server default (`builder`). */
     chatMode?: ChatMode;
+    /** Optional image attachment forwarded with this turn. */
+    data?: {
+        imageUrl?: string;
+    };
+    /**
+     * Answer to an ask-before-sending personal-data prompt.
+     * Applies to this message only.
+     */
+    piiResolution?: 'anonymize' | 'fallback';
     /** Abort the stream (closes the HTTP connection; the run keeps going server-side — call `stop` to cancel it). */
     signal?: AbortSignal;
 }
@@ -806,8 +815,8 @@ interface paths {
         get?: never;
         put?: never;
         /**
-         * Upsert entity type by workspace-scoped slug
-         * @description Creates or updates an entity type identified by workspace-scoped `slug`. Marks `managedByCode` by default. Prefer the CLI (`npx @lunnoa/client entity-types deploy`) over calling this from application code. Unknown instance attributes are rejected unless `allowUnknownAttributes` is true; reserved key `extensions` is always allowed.
+         * Upsert entity type by deployment-wide slug
+         * @description Creates or updates an entity type identified by deployment-wide `slug`. A new slug is granted to the caller workspace. A type already granted to other workspaces is not rewritten unless the caller is a platform admin. Marks `managedByCode` by default. Prefer the CLI (`npx @lunnoa/client entity-types deploy`). Unknown instance attributes are rejected unless `allowUnknownAttributes` is true; reserved key `extensions` is always allowed.
          */
         post: operations["ObjectTypesController_upsertBySlug"];
         delete?: never;
@@ -859,7 +868,7 @@ interface paths {
         };
         /**
          * Get all entities for workspace with filtering
-         * @description Returns a paginated list of entities in the workspace, optionally filtered by type, state, owner or a name search.
+         * @description Returns a paginated list of entities in the workspace, optionally filtered by type, state, or a name search.
          */
         get: operations["ObjectsController_findAll"];
         put?: never;
@@ -1660,8 +1669,6 @@ interface components {
             SKILLS: boolean;
             /** @description Whether the hexagonal agent builder canvas UI is enabled. */
             AGENT_BUILDER_CANVAS: boolean;
-            /** @description Whether the Solution Designer UI is enabled. */
-            SOLUTION_DESIGNER: boolean;
             /** @description Whether isolated code execution for agents is enabled. */
             CODE_EXECUTION: boolean;
             /** @description Whether SSO (OIDC) login is enabled. Requires at least one enabled SSO provider. */
@@ -2282,9 +2289,7 @@ interface components {
             /** @description Error message to record against the queue item. */
             error: string;
             /** @description Additional structured error details, supplied as a JSON string. */
-            errorDetails?: {
-                [key: string]: unknown;
-            };
+            errorDetails?: string;
         };
         BulkDeleteItemsDto: {
             /** @description IDs of the queue items to delete. */
@@ -2403,7 +2408,7 @@ interface components {
             managedByCode?: boolean;
         };
         UpsertObjectTypeBySlugDto: {
-            /** @description Stable workspace-scoped slug (lowercase, digits, hyphens). Used as the upsert key. */
+            /** @description Stable deployment-wide slug (lowercase, digits, hyphens). Used as the upsert key. Granted to the caller workspace when new. */
             slug: string;
             /** @description Singular display name. */
             name?: string;
@@ -2466,7 +2471,7 @@ interface components {
             name: string;
             /** @description Plural display name of the entity type. */
             namePlural: string;
-            /** @description URL-safe slug, unique within the workspace. */
+            /** @description URL-safe slug, unique across the deployment. */
             slug: string;
             /** @description Icon identifier for the entity type. */
             icon: string;
@@ -2519,11 +2524,6 @@ interface components {
             attributes?: {
                 [key: string]: unknown;
             };
-            /**
-             * Format: uuid
-             * @description Workspace user ID of the entity owner.
-             */
-            ownerId?: string;
         };
         ObjectTypeSummaryDto: {
             /** @description Entity type ID. */
@@ -2639,8 +2639,6 @@ interface components {
             attributes?: {
                 [key: string]: unknown;
             };
-            /** @description Workspace user ID of the new entity owner. */
-            ownerId?: string;
         };
         ChangeObjectStateDto: {
             /** @description ID of the target state. Must be a valid transition from the current state when the entity type defines transitions. */
@@ -3424,7 +3422,7 @@ interface components {
             approvalStatus?: "pending" | "partially_approved" | "approved" | "rejected" | "expired";
             /** @description Number of approve decisions received so far */
             approvalsReceived?: number;
-            /** @description Number of approvals required for quorum / current stage */
+            /** @description How many approvals are required before the workflow continues */
             approvalsRequired?: number;
         };
         PendingInputFieldDto: {
@@ -3802,11 +3800,15 @@ interface components {
              *       "imageUrl": "https://example.com/image.png"
              *     }
              */
-            data?: Record<string, never>;
-            /** @description Solution Designer handoff */
-            solutionId?: string;
-            planStepId?: string;
-            delegationId?: string;
+            data?: {
+                /** @description URL of an image attached to the message. */
+                imageUrl?: string;
+            };
+            /**
+             * @description Answer to an ask-before-sending personal-data prompt. Applies to this message only.
+             * @enum {string}
+             */
+            piiResolution?: "anonymize" | "fallback";
         };
         StreamMessageStopDto: {
             /** @description Partial assistant message to persist when stopping a stream */
@@ -4870,8 +4872,6 @@ interface operations {
                 state?: string;
                 /** @description Filter by multiple state IDs, supplied as a comma-separated list. */
                 states?: string;
-                /** @description Filter by owner workspace user ID. */
-                ownerId?: string;
                 /** @description Case-insensitive search on the entity name. */
                 search?: string;
                 /** @description Field to sort by (for example name, createdAt, updatedAt). Defaults to updatedAt. */
@@ -5153,13 +5153,11 @@ interface operations {
                      * @enum {string}
                      */
                     format?: "csv" | "xlsx";
-                    /** @description When true, adds an ownerName column resolved from the owning workspace member. */
-                    includeRelatedEntityNames?: boolean;
                 };
             };
         };
         responses: {
-            /** @description Flat export rows. Each row contains id, name, state, createdAt, updatedAt, the requested attribute fields, and ownerName when includeRelatedEntityNames is true. */
+            /** @description Flat export rows. Each row contains id, name, state, createdAt, updatedAt, and the requested attribute fields. */
             201: {
                 headers: {
                     [name: string]: unknown;
@@ -6626,7 +6624,7 @@ declare function defineWorkflow(config: Omit<WorkflowDefinition, 'kind'>): Workf
 declare function defineAgent(config: Omit<AgentDefinition, 'kind'>): AgentDefinition;
 interface EntityTypeDefinition {
     kind: typeof DEFINE_KINDS.entityType;
-    /** Stable workspace-scoped slug (upsert key). */
+    /** Stable deployment-wide slug (upsert key). Granted to the deployer's workspace when new. */
     slug: string;
     name?: string;
     namePlural?: string;
@@ -6851,8 +6849,6 @@ interface ListEntitiesOptions {
     state?: string;
     /** Filter by several states (comma-separated server-side). */
     states?: string[];
-    /** Filter by owner workspace-user ID. */
-    ownerId?: string;
     /** Free-text search over entity names. */
     search?: string;
     sortBy?: string;
@@ -6884,7 +6880,6 @@ interface ExportEntitiesInput {
         value: unknown;
     }>;
     format?: 'csv' | 'xlsx';
-    includeRelatedEntityNames?: boolean;
 }
 /**
  * Entities (the platform calls them Objects internally): the structured data
@@ -6960,7 +6955,7 @@ declare class EntityTypesResource {
     private readonly http;
     constructor(http: HttpClient);
     /**
-     * Lists entity types in the workspace. Request
+     * Lists entity types granted to the API key's workspace. Request
      * `expansion: ['attributeSchema', 'stateSchema']` for the field and state
      * machine definitions the codegen CLI builds types from.
      */
@@ -6972,7 +6967,9 @@ declare class EntityTypesResource {
     /** Returns a single entity type by its URL-safe slug. */
     getBySlug(slug: string, options?: EntityTypeReadOptions): Promise<EntityType>;
     /**
-     * Creates or updates an entity type by workspace-scoped slug.
+     * Creates or updates an entity type by deployment-wide slug.
+     * A new slug is granted to the API key's workspace. A slug already shared
+     * with another workspace is rejected unless the key belongs to a platform admin.
      * Prefer the CLI (`npx @lunnoa/client entity-types deploy`) for happy-path deploy.
      */
     upsertBySlug(definition: EntityTypeDefinition | UpsertEntityTypeBySlugInput): Promise<EntityType>;
@@ -6991,7 +6988,6 @@ type ApprovalInboxItem = {
     status: string;
     requiredCount: number;
     receivedApprovals: number;
-    currentStageIndex?: number;
     expiresAt?: string;
     createdAt?: string;
     updatedAt?: string;
@@ -7010,7 +7006,7 @@ type ApprovalInboxItem = {
         comment?: string;
         decidedAt?: string;
     };
-    /** People who can still decide (current stage; emails resolved). */
+    /** People who can still decide. */
     eligibleApprovers?: EligibleApprover[];
     approval?: Record<string, unknown>;
 };
@@ -7079,6 +7075,16 @@ declare class ProjectsResource {
     create(data: CreateProjectInput): Promise<Project>;
 }
 
+type QueueItemStatus = 'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILED' | 'RETRYING';
+interface AddQueueItemErrorInput {
+    /** Error message recorded on the item. */
+    error: string;
+    /**
+     * Extra details. An object is sent as a JSON string, which is what the
+     * server validates.
+     */
+    errorDetails?: string | Record<string, unknown>;
+}
 interface ListQueueItemsOptions {
     limit?: number;
     offset?: number;
@@ -7124,12 +7130,18 @@ declare class QueueItemsResource {
     }): Promise<QueueItem[]>;
     /** Returns items eligible for retry. */
     listRetryable(queueId: string): Promise<QueueItem[]>;
-    /** Returns items with the given status. */
-    listByStatus(queueId: string, status: string): Promise<QueueItem[]>;
+    /** Returns a page of items with the given status. */
+    listByStatus(queueId: string, status: QueueItemStatus, options?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<QueueItemList>;
     /** Looks an item up by the external ID your system supplied. */
     getByExternalId(queueId: string, externalId: string): Promise<QueueItemFull>;
-    /** Searches items in the queue. */
-    search(queueId: string, query: string): Promise<QueueItem[]>;
+    /**
+     * Searches items by external id, item data, and metadata.
+     * Returns one page, same shape as `list`.
+     */
+    search(queueId: string, query: string, options?: Omit<ListQueueItemsOptions, 'filterBy'>): Promise<QueueItemList>;
     /** Returns per-status and per-priority counts for the queue. */
     stats(queueId: string): Promise<QueueItemStats>;
     /** Returns the recorded processing errors of an item. */
@@ -7141,10 +7153,7 @@ declare class QueueItemsResource {
     /** Queues the item for another processing attempt. */
     retry(queueId: string, itemId: string): Promise<QueueItem>;
     /** Records a processing error on the item. */
-    addError(queueId: string, itemId: string, error: {
-        message: string;
-        [key: string]: unknown;
-    }): Promise<QueueItem>;
+    addError(queueId: string, itemId: string, error: AddQueueItemErrorInput): Promise<QueueItem>;
 }
 
 declare class QueuesResource {
@@ -7201,6 +7210,91 @@ declare class RunsResource {
     startAndWait(input: StartRunInput, waitOptions?: WaitUntilFinishedOptions): Promise<Execution>;
 }
 
+type ScorecardMeasureStatus = 'ON_TRACK' | 'AT_RISK' | 'OFF_TRACK' | 'NO_DATA';
+type ScorecardSummary = {
+    id: string;
+    name: string;
+    periodLabel: string | null;
+    description: string | null;
+    FK_ownerId: string | null;
+    createdAt: string;
+    _count: {
+        objectives: number;
+    };
+};
+type ScorecardMeasure = {
+    id: string;
+    name: string;
+    unit: string;
+    currency: string | null;
+    direction: 'HIGHER_IS_BETTER' | 'LOWER_IS_BETTER';
+    kind: 'LEADING' | 'LAGGING';
+    cadence: 'DAILY' | 'WEEKLY' | 'MONTHLY';
+    sourceType: 'MANUAL' | 'API' | 'WORKFLOW' | 'BUILT_IN';
+    builtInKey: string | null;
+    target: number;
+    atRiskThreshold: number | null;
+    latest: {
+        value: number;
+        periodStart: string;
+        createdAt: string;
+    } | null;
+    previousValue: number | null;
+    series: {
+        periodStart: string;
+        value: number;
+    }[];
+    status: ScorecardMeasureStatus;
+    stale: boolean;
+};
+type ScorecardObjective = {
+    id: string;
+    perspective: 'FINANCIAL' | 'CUSTOMER' | 'PROCESS' | 'LEARNING';
+    name: string;
+    description: string | null;
+    ownerLabel: string | null;
+    drivesIds: string[];
+    position: number;
+    status: ScorecardMeasureStatus;
+    measures: ScorecardMeasure[];
+};
+type Scorecard = Omit<ScorecardSummary, '_count'> & {
+    aiSpendUsdThisMonth: number;
+    objectives: ScorecardObjective[];
+};
+type ScorecardMeasureValue = {
+    id: string;
+    FK_measureId: string;
+    periodStart: string;
+    value: number;
+    note: string | null;
+    sourceType: ScorecardMeasure['sourceType'];
+    supersededAt: string | null;
+    createdAt: string;
+};
+type RecordMeasureValueInput = {
+    value: number;
+    /** Any ISO date inside the target period; defaults to the current period. */
+    period?: string;
+    note?: string;
+};
+/**
+ * Balanced Scorecard (workspace API). Pushing values needs `scorecard:record`.
+ */
+declare class ScorecardsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** Lists scorecards in the workspace. */
+    list(): Promise<ScorecardSummary[]>;
+    /** Returns a scorecard with objectives, measures, latest values and status. */
+    get(scorecardId: string): Promise<Scorecard>;
+    /**
+     * Records a measure value. A value for the same period replaces the current
+     * one; the old value is kept as superseded history.
+     */
+    recordValue(measureId: string, data: RecordMeasureValueInput): Promise<ScorecardMeasureValue>;
+}
+
 declare class TasksResource {
     private readonly http;
     constructor(http: HttpClient);
@@ -7220,9 +7314,7 @@ declare class TasksResource {
      * messages in AI SDK UIMessage format. For token-by-token output use
      * `client.agentChat.streamMessage` instead.
      */
-    message(agentId: string, taskId: string, message: string | UIMessage, options?: {
-        chatMode?: ChatMode;
-    }): Promise<string | UIMessage[]>;
+    message(agentId: string, taskId: string, message: string | UIMessage, options?: Omit<StreamMessageOptions, 'signal'>): Promise<string | UIMessage[]>;
 }
 
 declare class VariablesResource {
@@ -7338,6 +7430,7 @@ declare class LunnoaClient {
     readonly queues: QueuesResource;
     readonly queueItems: QueueItemsResource;
     readonly variables: VariablesResource;
+    readonly scorecards: ScorecardsResource;
     readonly connections: ConnectionsResource;
     readonly projects: ProjectsResource;
     readonly workflowApps: WorkflowAppsResource;
@@ -7486,4 +7579,4 @@ interface CreateServerClientOptions {
  */
 declare function createServerClient(options: CreateServerClientOptions): LunnoaClient;
 
-export { API_KEY_PREFIX, type ActionDefinition, ActionsResource, type Agent, AgentChatClient, AgentChatStream, type AgentDefinition, type AgentToolDefinition, AgentsResource, type AiConnectionDefinition, type ApprovalInboxItem, ApprovalsResource, AuthResource, type AuthTokens, type BulkCreateQueueItemsInput, type BulkCreateQueueItemsResult, type ChangeEntityStateInput, type ChangeEntityStateResult, type ChatMode, type Connection, type ConnectionDefinition, ConnectionsResource, type CreateBrowserClientOptions, type CreateEntityInput, type CreateKnowledgeInput, type CreateProjectInput, type CreateQueueInput, type CreateQueueItemInput, type CreateServerClientOptions, type CreateTaskInput, type CreateVariableInput, type CurrentUser, DEFINE_KINDS, type DefineKind, type DeletedTask, DiscoveryResource, type EligibleApprover, type EnabledFeatures, EntitiesResource, type Entity, type EntityStateHistoryEntry, type EntityStateTransitions, type EntityType, type EntityTypeDefinition, type EntityTypeReadOptions, EntityTypesResource, type ExecuteWorkflowResult, type Execution, type ExecutionPathStep, type ExecutionProgress, type ExecutionProgressPayload, type ExecutionProgressStep, ExecutionProgressStream, type ExecutionStatus, type ExecutionStreamEvent, type ExecutionStreamEventType, ExecutionTimeoutError, ExecutionsResource, type ExportEntitiesInput, type FetchLike, HttpClient, type ImportEntitiesInput, type ImportEntitiesResult, type ImportTemplate, type Knowledge, type KnowledgeDocument, type KnowledgeDocumentGroup, KnowledgeResource, type ListEntitiesOptions, type ListQueryOptions, type ListQueueItemsByObjectOptions, type ListQueueItemsOptions, type LocalStorageTokenStoreOptions, type LoginRequires2FA, type LoginResult, type LoginSuccess, LunnoaApiError, LunnoaClient, type LunnoaClientOptions, type MessageTaskInput, type OffsetPagination, type PagePagination, type PaginatedEntities, type PendingInput, type PendingInputField, type Project, ProjectsResource, type QueryValue, type Queue, type QueueAllowedObjectType, type QueueItem, type QueueItemCreated, type QueueItemErrorEntry, type QueueItemFull, type QueueItemList, type QueueItemObjectSummary, type QueueItemStats, QueueItemsResource, type QueueStats, QueuesResource, type RequestOptions, type RunActionInput, type RunActionOptions, type RunActionResult, RunsResource, type SaveUploadedTextInput, type SseEvent, SsoAuthResource, type SsoProviderSummary, type SsoProvidersResponse, type StartRunInput, type StartRunInputDto, type StartRunOptions, type StartRunStep, type StopStreamOptions, type StreamMessageOptions, type Task, type TaskListItem, TasksResource, type TokenStore, type UpdateEntityInput, type UpdateKnowledgeInput, type UpdateQueueInput, type UpdateQueueItemInput, type UpdateTaskInput, type UpdateVariableInput, type UpsertAgentBySlugInput, type UpsertAgentBySlugInputDto, type UpsertAgentToolInput, type UpsertEntityTypeBySlugInput, type UpsertWorkflowBySlugInput, type UpsertWorkflowBySlugInputDto, type UpsertWorkflowStepInput, type Variable, VariablesResource, type WaitUntilFinishedOptions, type WatchProgressOptions, type Workflow, type WorkflowApp, WorkflowAppsResource, type WorkflowDefinition, type WorkflowStepDefinition, WorkflowsResource, assertApiKeyAllowedInEnvironment, type components, createBrowserClient, createLocalStorageTokenStore, createMemoryTokenStore, createServerClient, defineAction, defineAgent, defineAiConnection, defineConnection, defineEntityType, defineWorkflow, entityTypeDefinitionToUpsert, isBrowserEnvironment, isLoginRequires2FA, iterateOffset, iteratePages, type operations, parseSseEvents, parseSseStream, type paths, resolveActionAppId, resolveActionId };
+export { API_KEY_PREFIX, type ActionDefinition, ActionsResource, type AddQueueItemErrorInput, type Agent, AgentChatClient, AgentChatStream, type AgentDefinition, type AgentToolDefinition, AgentsResource, type AiConnectionDefinition, type ApprovalInboxItem, ApprovalsResource, AuthResource, type AuthTokens, type BulkCreateQueueItemsInput, type BulkCreateQueueItemsResult, type ChangeEntityStateInput, type ChangeEntityStateResult, type ChatMode, type Connection, type ConnectionDefinition, ConnectionsResource, type CreateBrowserClientOptions, type CreateEntityInput, type CreateKnowledgeInput, type CreateProjectInput, type CreateQueueInput, type CreateQueueItemInput, type CreateServerClientOptions, type CreateTaskInput, type CreateVariableInput, type CurrentUser, DEFINE_KINDS, type DefineKind, type DeletedTask, DiscoveryResource, type EligibleApprover, type EnabledFeatures, EntitiesResource, type Entity, type EntityStateHistoryEntry, type EntityStateTransitions, type EntityType, type EntityTypeDefinition, type EntityTypeReadOptions, EntityTypesResource, type ExecuteWorkflowResult, type Execution, type ExecutionPathStep, type ExecutionProgress, type ExecutionProgressPayload, type ExecutionProgressStep, ExecutionProgressStream, type ExecutionStatus, type ExecutionStreamEvent, type ExecutionStreamEventType, ExecutionTimeoutError, ExecutionsResource, type ExportEntitiesInput, type FetchLike, HttpClient, type ImportEntitiesInput, type ImportEntitiesResult, type ImportTemplate, type Knowledge, type KnowledgeDocument, type KnowledgeDocumentGroup, KnowledgeResource, type ListEntitiesOptions, type ListQueryOptions, type ListQueueItemsByObjectOptions, type ListQueueItemsOptions, type LocalStorageTokenStoreOptions, type LoginRequires2FA, type LoginResult, type LoginSuccess, LunnoaApiError, LunnoaClient, type LunnoaClientOptions, type MessageTaskInput, type OffsetPagination, type PagePagination, type PaginatedEntities, type PendingInput, type PendingInputField, type Project, ProjectsResource, type QueryValue, type Queue, type QueueAllowedObjectType, type QueueItem, type QueueItemCreated, type QueueItemErrorEntry, type QueueItemFull, type QueueItemList, type QueueItemObjectSummary, type QueueItemStats, type QueueItemStatus, QueueItemsResource, type QueueStats, QueuesResource, type RecordMeasureValueInput, type RequestOptions, type RunActionInput, type RunActionOptions, type RunActionResult, RunsResource, type SaveUploadedTextInput, type Scorecard, type ScorecardMeasure, type ScorecardMeasureStatus, type ScorecardMeasureValue, type ScorecardObjective, type ScorecardSummary, ScorecardsResource, type SseEvent, SsoAuthResource, type SsoProviderSummary, type SsoProvidersResponse, type StartRunInput, type StartRunInputDto, type StartRunOptions, type StartRunStep, type StopStreamOptions, type StreamMessageOptions, type Task, type TaskListItem, TasksResource, type TokenStore, type UpdateEntityInput, type UpdateKnowledgeInput, type UpdateQueueInput, type UpdateQueueItemInput, type UpdateTaskInput, type UpdateVariableInput, type UpsertAgentBySlugInput, type UpsertAgentBySlugInputDto, type UpsertAgentToolInput, type UpsertEntityTypeBySlugInput, type UpsertWorkflowBySlugInput, type UpsertWorkflowBySlugInputDto, type UpsertWorkflowStepInput, type Variable, VariablesResource, type WaitUntilFinishedOptions, type WatchProgressOptions, type Workflow, type WorkflowApp, WorkflowAppsResource, type WorkflowDefinition, type WorkflowStepDefinition, WorkflowsResource, assertApiKeyAllowedInEnvironment, type components, createBrowserClient, createLocalStorageTokenStore, createMemoryTokenStore, createServerClient, defineAction, defineAgent, defineAiConnection, defineConnection, defineEntityType, defineWorkflow, entityTypeDefinitionToUpsert, isBrowserEnvironment, isLoginRequires2FA, iterateOffset, iteratePages, type operations, parseSseEvents, parseSseStream, type paths, resolveActionAppId, resolveActionId };