@uipath/integrationservice-sdk 1.201.0 → 1.202.0-preview.136

package/dist/src/client-factory.d.ts

@@ -7,6 +7,9 @@ export interface ExecuteOperationResult {
     body: unknown;
     headers: Record<string, string>;
 }
+export interface ExecuteOperationRequestOptions {
+    multipartBodyField?: string;
+}
 export interface CreateApiClientOptions {
     tenant?: string;
     loginValidity?: number;
@@ -20,11 +23,37 @@ export declare function getValidatedAuthContext(options?: CreateApiClientOptions
 export declare function createConnectionsConfig(options?: CreateApiClientOptions): Promise<ConnectionsConfiguration>;
 export declare function createElementsConfig(options?: CreateApiClientOptions): Promise<ElementsConfiguration>;
 export declare function createApiClient<T>(ApiClass: new (config: ConnectionsConfiguration | ElementsConfiguration) => T, options?: CreateApiClientOptions): Promise<T>;
-export declare function executeOperation(options: CreateApiClientOptions | undefined, connectionId: string, objectName: string, httpMethod?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE", body?: unknown, queryParams?: Record<string, string>): Promise<ExecuteOperationResult>;
+export declare function executeOperation(options: CreateApiClientOptions | undefined, connectionId: string, objectName: string, httpMethod?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE", body?: unknown, queryParams?: Record<string, string>, requestOptions?: ExecuteOperationRequestOptions): Promise<ExecuteOperationResult>;
 /**
  * Fetch object metadata as JSON Schema (no connection — base/standard fields only).
  */
 export declare function getObjectMetadataAsSchema(options: CreateApiClientOptions | undefined, elementKey: string, objectName: string): Promise<unknown>;
+/**
+ * Activity metadata versions accepted by `--activity-version` (is resources
+ * describe). Single source of truth — consumers import these instead of
+ * re-declaring the literals. (maestro flow registry get reads the version from
+ * the node's own config, so it exposes no flag.)
+ */
+export declare const ACTIVITY_VERSION_V1 = "1.0.0";
+export declare const ACTIVITY_VERSION_V4 = "4.0.0";
+export declare const SUPPORTED_ACTIVITY_VERSIONS: readonly string[];
+/**
+ * Whether a connector activity configuration (the parsed `configuration` JSON
+ * from a node definition / manifest, aka instanceParameters) identifies a
+ * 4.0.0 activity. Single source of truth for the v4 predicate: the version
+ * says 4.0.0.
+ */
+export declare function isV4ActivityConfiguration(instanceParameters: Record<string, unknown> | null | undefined): boolean;
+/**
+ * Fetch activity metadata from the v4 elements endpoints (4.0.0 activities).
+ *
+ * v4 activities are addressed by activity name (the `activityName` in the
+ * activity's configuration JSON), not by object name, and the v4 route has no
+ * `/instances/{connectionId}` prefix — the instance segment was removed in v4.
+ *
+ * Endpoint: GET {baseUrl}/{org}/{tenant}/elements_/v4/element/connectors/{connectorKey}/activities/{activityName}/metadata
+ */
+export declare function getConnectorActivityMetadataV4(options: CreateApiClientOptions | undefined, connectorKey: string, activityName: string): Promise<Record<string, unknown>>;
 /**
  * Fetch object metadata as JSON Schema (with connection — enriched fields including custom).
  */

package/dist/src/dap/index.d.ts

@@ -1,6 +1,6 @@
 export { applySavedFilterTree, assertActivityMetadataResolved, buildActivityEssentialConfiguration, buildManagedHttpEssentialConfiguration, createConfiguredActivityClient, MANAGED_HTTP_CONNECTOR_KEY, MANAGED_HTTP_CONNECTOR_VERSION, } from "./essential-config.js";
 export * from "./filter-builder/index.js";
-export { buildInputMetadata, extractMultipartParameters, inlineMultipartFileValues, } from "./input-metadata.js";
-export type { ConnectorMethodInfo, CustomFieldsRequestDetails, FieldDesign, FieldReference, InputMetadata, ISField, ISFieldMethod, ISMetadata, ISMetadataParam, MultipartParam, TriggerField, TriggerFieldEvent, TriggerObjectMetadata, } from "./types.js";
+export { buildInputMetadata, extractMultipartParameters, inlineMultipartFileValues, isListOperation, resolveMultipartOperationMetadata, } from "./input-metadata.js";
+export type { ConnectorMethodInfo, CustomFieldsRequestDetails, FieldDesign, FieldReference, InputMetadata, ISField, ISFieldMethod, ISMetadata, ISMetadataParam, MultipartFileField, MultipartOperationMetadata, MultipartParam, TriggerField, TriggerFieldEvent, TriggerObjectMetadata, } from "./types.js";
 export type { ConnectorValidationContext, Issue, IssueType, ValidationRule, } from "./validation/index.js";
 export { DEFAULT_RULES, METHOD_TO_OPERATION, normalizeHttpMethod, OPERATION_TO_METHOD, validateConfiguration, validateConnectionId, validateEndpoint, validateEventMode, validateEventType, validateFolderKey, validateHttpMethod, validateIntSvcNode, validateMethodInMetadata, validateMethodMatchesOperation, validateObjectName, validatePathTemplateParams, validateRequiredEventParameters, validateRequiredFields, validateRequiredParameters, } from "./validation/index.js";

package/dist/src/dap/input-metadata.d.ts

@@ -1,4 +1,4 @@
-import type { InputMetadata, ISMetadataParam, MultipartParam } from "./types.js";
+import type { InputMetadata, ISMetadataParam, MultipartOperationMetadata, MultipartParam } from "./types.js";
 /**
  * Extract multipart parameters from IS metadata parameters.
  * These are fields with type "multipart" (e.g. file attachments).
@@ -9,6 +9,14 @@ import type { InputMetadata, ISMetadataParam, MultipartParam } from "./types.js"
  * call.
  */
 export declare function extractMultipartParameters(params: ISMetadataParam[]): MultipartParam[];
+/**
+ * Resolve the request fields declared by an Integration Service operation.
+ *
+ * Direct callers need the exact metadata: this helper never invents a JSON
+ * body field when the connector declares only file parts. That lets callers
+ * reject request shapes they cannot send instead of falling back to JSON.
+ */
+export declare function resolveMultipartOperationMetadata(params: ISMetadataParam[]): MultipartOperationMetadata | undefined;
 /**
  * Move file-typed multipart values from `bodyParameters` into the matching
  * multipart entry's inline `value` slot, matching Studio Web's on-wire shape.
@@ -37,6 +45,14 @@ export declare function inlineMultipartFileValues(multipartParams: MultipartPara
     multipartParams: MultipartParam[];
     bodyParameters: Record<string, unknown> | undefined;
 };
+/**
+ * True when an IS method is a `list` operation (search / query / list-all):
+ * its `=result.response` is the bare ARRAY of records, not an envelope. IS
+ * spells the operation `List` in `connectorMethodInfo` and `list` in
+ * `essentialConfiguration`; compare case-insensitively. The single predicate
+ * behind `inputMetadata.operation` and the configure-time output-type patch.
+ */
+export declare function isListOperation(operation: unknown): boolean;
 /**
  * Build inputMetadata from multipart params and operation type.
  *

package/dist/src/dap/types.d.ts

@@ -35,6 +35,14 @@ export type MultipartParam = {
     dataType: string;
     value?: string;
 };
+export type MultipartFileField = {
+    name: string;
+    required: boolean;
+};
+export type MultipartOperationMetadata = {
+    bodyField?: string;
+    fileFields: MultipartFileField[];
+};
 export type InputMetadata = {
     type?: string;
     multipart?: {

package/dist/src/index.d.ts

@@ -4,8 +4,9 @@ export * from "../generated/connections/src/index.js";
 export { ElementsApi } from "../generated/elements/src/apis/index.js";
 export * from "../generated/elements/src/models/index.js";
 export { Configuration as ElementsConfiguration } from "../generated/elements/src/runtime.js";
-export { type ConnectorSummary, type CreateApiClientOptions, createApiClient, createConnectionsConfig, createDesignConnector, createElementsConfig, type DesignConnectorRef, type EventOperationObject, type ExecuteOperationResult, executeOperation, exportConnectorZip, findDesignConnectorByKey, folderOverride, getConnectorById, getEventObjectMetadataAsSchema, getEventOperationObjects, getHttpRequestPreview, getInstanceEventObjectMetadataAsSchema, getInstanceObjectMetadataAsSchema, getObjectMetadataAsSchema, getPublishStatus, getValidatedAuthContext, getWebhookConfig, type HttpRequestPreviewResult, type ImportedConnector, type InstanceDesignActionResult, importConnectorZip, listConnectors, type PersistedConnector, type PublishConnectorArgs, type PublishJobResult, type PublishStatusResult, publishConnector, runInstanceDesignAction, updateDesignConnector, type WebhookConfigResult, } from "./client-factory.js";
+export { ACTIVITY_VERSION_V4, type ConnectorSummary, type CreateApiClientOptions, createApiClient, createConnectionsConfig, createDesignConnector, createElementsConfig, type DesignConnectorRef, type EventOperationObject, type ExecuteOperationRequestOptions, type ExecuteOperationResult, executeOperation, exportConnectorZip, findDesignConnectorByKey, folderOverride, getConnectorActivityMetadataV4, getConnectorById, getEventObjectMetadataAsSchema, getEventOperationObjects, getHttpRequestPreview, getInstanceEventObjectMetadataAsSchema, getInstanceObjectMetadataAsSchema, getObjectMetadataAsSchema, getPublishStatus, getValidatedAuthContext, getWebhookConfig, type HttpRequestPreviewResult, type ImportedConnector, type InstanceDesignActionResult, importConnectorZip, isV4ActivityConfiguration, listConnectors, type PersistedConnector, type PublishConnectorArgs, type PublishJobResult, type PublishStatusResult, publishConnector, runInstanceDesignAction, SUPPORTED_ACTIVITY_VERSIONS, updateDesignConnector, type WebhookConfigResult, } from "./client-factory.js";
 export { normalizeConnectionStatus } from "./connection-state.js";
 export * from "./dap/index.js";
+export { buildResourceCompactSummary, buildTriggerCompactSummary, CRUD_OPERATIONS, fetchRawMetadata, fetchTriggerMetadata, fetchTriggerObjects, normalizeObjectsList, } from "./metadata/resource-metadata.js";
 export { decodeElementsNextPageToken, ELEMENTS_NEXT_PAGE_DONE, type ElementsNextPage, hasMoreElementsPages, } from "./pagination.js";
 export { SDK_USER_AGENT } from "./user-agent.js";

package/dist/src/metadata/resource-metadata.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Shared Integration Service resource/trigger metadata fetch + agent-friendly
+ * compact-summary logic.
+ *
+ * Single source of truth for `uip is resources describe`, `uip is triggers
+ * describe`, and Maestro BPMN registry enrichment (`registry get` on connector
+ * activity / event types). Keep these here — do not re-implement per tool — so
+ * every surface returns the same shape for the same connector object/event.
+ */
+import type { ElementsApi } from "../../generated/elements/src/apis/index.js";
+/**
+ * Fetch raw object metadata for a connector activity. With a connection id the
+ * instance-scoped endpoint returns enriched (custom) fields; without one the
+ * base endpoint returns standard fields only.
+ */
+export declare function fetchRawMetadata(api: ElementsApi, connectorKey: string, objectName: string, connectionId?: string): Promise<Record<string, unknown>>;
+/**
+ * Build an agent-friendly compact summary from raw object metadata.
+ *
+ * With `operation`: returns requestFields, responseFields, parameters for that
+ * operation. Without: returns the availableOperations list plus a hint.
+ */
+export declare function buildResourceCompactSummary(metadata: Record<string, unknown>, operation?: string): Record<string, unknown>;
+/**
+ * Operations that require an intermediate "objects" step before metadata.
+ */
+export declare const CRUD_OPERATIONS: Set<string>;
+export declare function fetchTriggerObjects(api: ElementsApi, connectorKey: string, operationName: string, connectionId?: string): Promise<[Error, undefined] | [undefined, unknown]>;
+export declare function fetchTriggerMetadata(api: ElementsApi, connectorKey: string, operationName: string, objectName: string, connectionId?: string): Promise<[Error, undefined] | [undefined, unknown]>;
+export declare function normalizeObjectsList(objects: unknown): unknown[];
+/**
+ * Build a structured, agent-friendly summary from raw trigger metadata.
+ *
+ * Categories:
+ * - eventParameters: fields where events[operationName] exists (required if .required === true)
+ * - filterFields: fields where order === 1 or isCuratedEventField === true
+ * - outputFields: all fields
+ */
+export declare function buildTriggerCompactSummary(metadata: Record<string, unknown>, operationName: string): Record<string, unknown>;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@uipath/integrationservice-sdk",
     "license": "MIT",
-    "version": "1.201.0",
+    "version": "1.202.0-preview.136",
     "repository": {
         "type": "git",
         "url": "https://github.com/UiPath/cli.git",
@@ -30,5 +30,5 @@
     "dependencies": {
         "@uipath/integration-service-design-time": "0.25.2"
     },
-    "gitHead": "7933378ad5276ac369900293a1447474dcec6826"
+    "gitHead": "f6270de2c7c04f4c43b2f5187b0c3d3c314c2610"
 }