@chainlink/cre-sdk 1.11.0 → 1.12.0

package/dist/capabilities/errors/error-codes.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Capability error codes are primarily based on gRPC error codes:
+ * https://grpc.github.io/grpc/core/md_doc_statuscodes.html
+ * Custom error codes specific to this project should start from 100 to avoid
+ * conflicts with future gRPC codes. Note: 0 (OK) is intentionally excluded
+ * because capability errors must always indicate a failure condition.
+ */
+export type ErrorCode = number;
+/** Sentinel for error code strings that are not recognised. */
+export declare const UnrecognisedErrorCode = -1;
+/** Indicates the operation was canceled (typically by the caller). */
+export declare const Canceled = 1;
+/** Unknown error. */
+export declare const Unknown = 2;
+/** Client specified an invalid argument. */
+export declare const InvalidArgument = 3;
+/** Operation expired before completion. */
+export declare const DeadlineExceeded = 4;
+/** Some requested entity was not found. */
+export declare const NotFound = 5;
+/** An attempt to create an entity failed because one already exists. */
+export declare const AlreadyExists = 6;
+/** The caller does not have permission to execute the specified operation. */
+export declare const PermissionDenied = 7;
+/** Some resource has been exhausted. */
+export declare const ResourceExhausted = 8;
+/** Operation was rejected because the system is not in a state required for execution. */
+export declare const FailedPrecondition = 9;
+/** The operation was aborted, typically due to a concurrency issue. */
+export declare const Aborted = 10;
+/** Operation was attempted past the valid range. */
+export declare const OutOfRange = 11;
+/** Operation is not implemented or not supported/enabled in this service. */
+export declare const Unimplemented = 12;
+/** Some invariants expected by the underlying system have been broken. */
+export declare const Internal = 13;
+/** The service is currently unavailable. */
+export declare const Unavailable = 14;
+/** Unrecoverable data loss or corruption. */
+export declare const DataLoss = 15;
+/** The request does not have valid authentication credentials. */
+export declare const Unauthenticated = 16;
+/** Custom error codes not defined in the gRPC error space. */
+/** Failure to reach consensus. */
+export declare const ConsensusFailed = 100;
+/** A CRE limit breach has occurred. */
+export declare const LimitExceeded = 101;
+/** Not enough observations to enable the operation to complete. */
+export declare const InsufficientObservations = 102;
+/** Returns the string representation of the error code. */
+export declare function errorCodeToStringValue(code: ErrorCode): string;
+/** Converts a string to an error code. */
+export declare function fromErrorCodeString(str: string): ErrorCode;

package/dist/capabilities/errors/error-codes.js

@@ -0,0 +1,71 @@
+/** Sentinel for error code strings that are not recognised. */
+export const UnrecognisedErrorCode = -1;
+/** Indicates the operation was canceled (typically by the caller). */
+export const Canceled = 1;
+/** Unknown error. */
+export const Unknown = 2;
+/** Client specified an invalid argument. */
+export const InvalidArgument = 3;
+/** Operation expired before completion. */
+export const DeadlineExceeded = 4;
+/** Some requested entity was not found. */
+export const NotFound = 5;
+/** An attempt to create an entity failed because one already exists. */
+export const AlreadyExists = 6;
+/** The caller does not have permission to execute the specified operation. */
+export const PermissionDenied = 7;
+/** Some resource has been exhausted. */
+export const ResourceExhausted = 8;
+/** Operation was rejected because the system is not in a state required for execution. */
+export const FailedPrecondition = 9;
+/** The operation was aborted, typically due to a concurrency issue. */
+export const Aborted = 10;
+/** Operation was attempted past the valid range. */
+export const OutOfRange = 11;
+/** Operation is not implemented or not supported/enabled in this service. */
+export const Unimplemented = 12;
+/** Some invariants expected by the underlying system have been broken. */
+export const Internal = 13;
+/** The service is currently unavailable. */
+export const Unavailable = 14;
+/** Unrecoverable data loss or corruption. */
+export const DataLoss = 15;
+/** The request does not have valid authentication credentials. */
+export const Unauthenticated = 16;
+/** Custom error codes not defined in the gRPC error space. */
+/** Failure to reach consensus. */
+export const ConsensusFailed = 100;
+/** A CRE limit breach has occurred. */
+export const LimitExceeded = 101;
+/** Not enough observations to enable the operation to complete. */
+export const InsufficientObservations = 102;
+const errorCodeToString = new Map([
+    [Canceled, 'Canceled'],
+    [Unknown, 'Unknown'],
+    [InvalidArgument, 'InvalidArgument'],
+    [DeadlineExceeded, 'DeadlineExceeded'],
+    [NotFound, 'NotFound'],
+    [AlreadyExists, 'AlreadyExists'],
+    [PermissionDenied, 'PermissionDenied'],
+    [ResourceExhausted, 'ResourceExhausted'],
+    [FailedPrecondition, 'FailedPrecondition'],
+    [Aborted, 'Aborted'],
+    [OutOfRange, 'OutOfRange'],
+    [Unimplemented, 'Unimplemented'],
+    [Internal, 'Internal'],
+    [Unavailable, 'Unavailable'],
+    [DataLoss, 'DataLoss'],
+    [Unauthenticated, 'Unauthenticated'],
+    [ConsensusFailed, 'ConsensusFailed'],
+    [LimitExceeded, 'LimitExceeded'],
+    [InsufficientObservations, 'InsufficientObservations'],
+]);
+const stringToErrorCode = new Map(Array.from(errorCodeToString.entries()).map(([code, name]) => [name, code]));
+/** Returns the string representation of the error code. */
+export function errorCodeToStringValue(code) {
+    return errorCodeToString.get(code) ?? 'UnrecognisedErrorCode';
+}
+/** Converts a string to an error code. */
+export function fromErrorCodeString(str) {
+    return stringToErrorCode.get(str) ?? UnrecognisedErrorCode;
+}

package/dist/capabilities/errors/error-serialization.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Parses errorMsg in the capability error wire format.
+ * If errorMsg is not a serialized capability error, a plain Error is returned.
+ */
+export declare function deserializeErrorFromString(errorMsg: string): Error;

package/dist/capabilities/errors/error-serialization.js

@@ -0,0 +1,18 @@
+import { CapabilityExecutionError, fromOriginString, fromVisibilityString } from './error';
+import { fromErrorCodeString } from './error-codes';
+const errorMessageSeparator = ':';
+/**
+ * Parses errorMsg in the capability error wire format.
+ * If errorMsg is not a serialized capability error, a plain Error is returned.
+ */
+export function deserializeErrorFromString(errorMsg) {
+    const parts = errorMsg.split(errorMessageSeparator);
+    if (parts.length < 4) {
+        return new Error(errorMsg);
+    }
+    const visibility = fromVisibilityString(parts[0]);
+    const origin = fromOriginString(parts[1]);
+    const errorCode = fromErrorCodeString(parts[2]);
+    const detail = parts.slice(3).join(errorMessageSeparator);
+    return new CapabilityExecutionError(detail, visibility, origin, errorCode);
+}

package/dist/capabilities/errors/error.d.ts

@@ -0,0 +1,31 @@
+/**
+ * CRE capability errors and wire format shared across CRE components.
+ * Aligns with github.com/smartcontractkit/chainlink-common/pkg/capabilities/errors.
+ */
+import { type ErrorCode } from './error-codes';
+export type Origin = number;
+/** The error originated from a system issue. */
+export declare const OriginSystem = 0;
+/** The error originated from user input or action. */
+export declare const OriginUser = 1;
+export declare function originToString(origin: Origin): string;
+/** Converts a string to an Origin value. */
+export declare function fromOriginString(s: string): Origin;
+export type Visibility = number;
+/** The full details of the error can be shared across all nodes in the network. */
+export declare const VisibilityPublic = 0;
+/** The error contains sensitive information visible only to the local node. */
+export declare const VisibilityPrivate = 1;
+export declare function visibilityToString(visibility: Visibility): string;
+/** Converts a string to a Visibility value. */
+export declare function fromVisibilityString(s: string): Visibility;
+export declare class CapabilityExecutionError extends Error {
+    readonly detail: string;
+    readonly visibility: Visibility;
+    readonly origin: Origin;
+    readonly code: ErrorCode;
+    readonly name = "CapabilityExecutionError";
+    constructor(detail: string, visibility: Visibility, origin: Origin, code: ErrorCode);
+    toString(): string;
+}
+export declare function isCapabilityExecutionError(err: unknown): err is CapabilityExecutionError;

package/dist/capabilities/errors/error.js

@@ -0,0 +1,77 @@
+/**
+ * CRE capability errors and wire format shared across CRE components.
+ * Aligns with github.com/smartcontractkit/chainlink-common/pkg/capabilities/errors.
+ */
+import { errorCodeToStringValue, UnrecognisedErrorCode } from './error-codes';
+/** The error originated from a system issue. */
+export const OriginSystem = 0;
+/** The error originated from user input or action. */
+export const OriginUser = 1;
+export function originToString(origin) {
+    switch (origin) {
+        case OriginSystem:
+            return 'System';
+        case OriginUser:
+            return 'User';
+        default:
+            return 'UnknownOrigin';
+    }
+}
+/** Converts a string to an Origin value. */
+export function fromOriginString(s) {
+    switch (s) {
+        case 'System':
+            return OriginSystem;
+        case 'User':
+            return OriginUser;
+        default:
+            return -1;
+    }
+}
+/** The full details of the error can be shared across all nodes in the network. */
+export const VisibilityPublic = 0;
+/** The error contains sensitive information visible only to the local node. */
+export const VisibilityPrivate = 1;
+export function visibilityToString(visibility) {
+    switch (visibility) {
+        case VisibilityPublic:
+            return 'Public';
+        case VisibilityPrivate:
+            return 'Private';
+        default:
+            return 'UnknownVisibility';
+    }
+}
+/** Converts a string to a Visibility value. */
+export function fromVisibilityString(s) {
+    switch (s) {
+        case 'Public':
+            return VisibilityPublic;
+        case 'Private':
+            return VisibilityPrivate;
+        default:
+            return -1;
+    }
+}
+export class CapabilityExecutionError extends Error {
+    detail;
+    visibility;
+    origin;
+    code;
+    name = 'CapabilityExecutionError';
+    constructor(detail, visibility, origin, code) {
+        super(code === UnrecognisedErrorCode
+            ? detail
+            : `[${code}]${errorCodeToStringValue(code)}: ${detail}`);
+        this.detail = detail;
+        this.visibility = visibility;
+        this.origin = origin;
+        this.code = code;
+    }
+    toString() {
+        return this.message;
+    }
+}
+export function isCapabilityExecutionError(err) {
+    return err instanceof CapabilityExecutionError;
+}

package/dist/capabilities/errors/index.d.ts

@@ -0,0 +1,3 @@
+export * from './error';
+export * from './error-codes';
+export * from './error-serialization';

package/dist/capabilities/errors/index.js

@@ -0,0 +1,3 @@
+export * from './error';
+export * from './error-codes';
+export * from './error-serialization';

package/dist/generated/capabilities/networking/http/v1alpha/client_pb.d.ts

@@ -79,6 +79,43 @@ export type HeaderValuesJson = {
 export declare const HeaderValuesSchema: GenMessage<HeaderValues, {
     jsonType: HeaderValuesJson;
 }>;
+/**
+ * MtlsAuth represents the private-key/cert pair for mtls auth.
+ *
+ * @generated from message capabilities.networking.http.v1alpha.MtlsAuth
+ */
+export type MtlsAuth = Message<'capabilities.networking.http.v1alpha.MtlsAuth'> & {
+    /**
+     * @generated from field: bytes private_key = 1;
+     */
+    privateKey: Uint8Array;
+    /**
+     * @generated from field: bytes certificate = 2;
+     */
+    certificate: Uint8Array;
+};
+/**
+ * MtlsAuth represents the private-key/cert pair for mtls auth.
+ *
+ * @generated from message capabilities.networking.http.v1alpha.MtlsAuth
+ */
+export type MtlsAuthJson = {
+    /**
+     * @generated from field: bytes private_key = 1;
+     */
+    privateKey?: string;
+    /**
+     * @generated from field: bytes certificate = 2;
+     */
+    certificate?: string;
+};
+/**
+ * Describes the message capabilities.networking.http.v1alpha.MtlsAuth.
+ * Use `create(MtlsAuthSchema)` to create a new message.
+ */
+export declare const MtlsAuthSchema: GenMessage<MtlsAuth, {
+    jsonType: MtlsAuthJson;
+}>;
 /**
  * @generated from message capabilities.networking.http.v1alpha.Request
  */
@@ -120,6 +157,10 @@ export type Request = Message<'capabilities.networking.http.v1alpha.Request'> &
     multiHeaders: {
         [key: string]: HeaderValues;
     };
+    /**
+     * @generated from field: optional capabilities.networking.http.v1alpha.MtlsAuth mtls = 8;
+     */
+    mtls?: MtlsAuth;
 };
 /**
  * @generated from message capabilities.networking.http.v1alpha.Request
@@ -162,6 +203,10 @@ export type RequestJson = {
     multiHeaders?: {
         [key: string]: HeaderValuesJson;
     };
+    /**
+     * @generated from field: optional capabilities.networking.http.v1alpha.MtlsAuth mtls = 8;
+     */
+    mtls?: MtlsAuthJson;
 };
 /**
  * Describes the message capabilities.networking.http.v1alpha.Request.

package/dist/generated/capabilities/networking/http/v1alpha/client_pb.js

@@ -9,7 +9,7 @@ import { file_tools_generator_v1alpha_cre_metadata } from '../../../../tools/gen
  */
 export const file_capabilities_networking_http_v1alpha_client = 
 /*@__PURE__*/
-fileDesc('CjFjYXBhYmlsaXRpZXMvbmV0d29ya2luZy9odHRwL3YxYWxwaGEvY2xpZW50LnByb3RvEiRjYXBhYmlsaXRpZXMubmV0d29ya2luZy5odHRwLnYxYWxwaGEiSgoNQ2FjaGVTZXR0aW5ncxINCgVzdG9yZRgBIAEoCBIqCgdtYXhfYWdlGAIgASgLMhkuZ29vZ2xlLnByb3RvYnVmLkR1cmF0aW9uIh4KDEhlYWRlclZhbHVlcxIOCgZ2YWx1ZXMYASADKAki7wMKB1JlcXVlc3QSCwoDdXJsGAEgASgJEg4KBm1ldGhvZBgCIAEoCRJPCgdoZWFkZXJzGAMgAygLMjouY2FwYWJpbGl0aWVzLm5ldHdvcmtpbmcuaHR0cC52MWFscGhhLlJlcXVlc3QuSGVhZGVyc0VudHJ5QgIYARIMCgRib2R5GAQgASgMEioKB3RpbWVvdXQYBSABKAsyGS5nb29nbGUucHJvdG9idWYuRHVyYXRpb24SSwoOY2FjaGVfc2V0dGluZ3MYBiABKAsyMy5jYXBhYmlsaXRpZXMubmV0d29ya2luZy5odHRwLnYxYWxwaGEuQ2FjaGVTZXR0aW5ncxJWCg1tdWx0aV9oZWFkZXJzGAcgAygLMj8uY2FwYWJpbGl0aWVzLm5ldHdvcmtpbmcuaHR0cC52MWFscGhhLlJlcXVlc3QuTXVsdGlIZWFkZXJzRW50cnkaLgoMSGVhZGVyc0VudHJ5EgsKA2tleRgBIAEoCRINCgV2YWx1ZRgCIAEoCToCOAEaZwoRTXVsdGlIZWFkZXJzRW50cnkSCwoDa2V5GAEgASgJEkEKBXZhbHVlGAIgASgLMjIuY2FwYWJpbGl0aWVzLm5ldHdvcmtpbmcuaHR0cC52MWFscGhhLkhlYWRlclZhbHVlczoCOAEi8QIKCFJlc3BvbnNlEhMKC3N0YXR1c19jb2RlGAEgASgNElAKB2hlYWRlcnMYAiADKAsyOy5jYXBhYmlsaXRpZXMubmV0d29ya2luZy5odHRwLnYxYWxwaGEuUmVzcG9uc2UuSGVhZGVyc0VudHJ5QgIYARIMCgRib2R5GAMgASgMElcKDW11bHRpX2hlYWRlcnMYBCADKAsyQC5jYXBhYmlsaXRpZXMubmV0d29ya2luZy5odHRwLnYxYWxwaGEuUmVzcG9uc2UuTXVsdGlIZWFkZXJzRW50cnkaLgoMSGVhZGVyc0VudHJ5EgsKA2tleRgBIAEoCRINCgV2YWx1ZRgCIAEoCToCOAEaZwoRTXVsdGlIZWFkZXJzRW50cnkSCwoDa2V5GAEgASgJEkEKBXZhbHVlGAIgASgLMjIuY2FwYWJpbGl0aWVzLm5ldHdvcmtpbmcuaHR0cC52MWFscGhhLkhlYWRlclZhbHVlczoCOAEymAEKBkNsaWVudBJsCgtTZW5kUmVxdWVzdBItLmNhcGFiaWxpdGllcy5uZXR3b3JraW5nLmh0dHAudjFhbHBoYS5SZXF1ZXN0Gi4uY2FwYWJpbGl0aWVzLm5ldHdvcmtpbmcuaHR0cC52MWFscGhhLlJlc3BvbnNlGiCCtRgcCAISGGh0dHAtYWN0aW9uc0AxLjAuMC1hbHBoYULqAQooY29tLmNhcGFiaWxpdGllcy5uZXR3b3JraW5nLmh0dHAudjFhbHBoYUILQ2xpZW50UHJvdG9QAaICA0NOSKoCJENhcGFiaWxpdGllcy5OZXR3b3JraW5nLkh0dHAuVjFhbHBoYcoCJENhcGFiaWxpdGllc1xOZXR3b3JraW5nXEh0dHBcVjFhbHBoYeICMENhcGFiaWxpdGllc1xOZXR3b3JraW5nXEh0dHBcVjFhbHBoYVxHUEJNZXRhZGF0YeoCJ0NhcGFiaWxpdGllczo6TmV0d29ya2luZzo6SHR0cDo6VjFhbHBoYWIGcHJvdG8z', [file_google_protobuf_duration, file_tools_generator_v1alpha_cre_metadata]);
+fileDesc('CjFjYXBhYmlsaXRpZXMvbmV0d29ya2luZy9odHRwL3YxYWxwaGEvY2xpZW50LnByb3RvEiRjYXBhYmlsaXRpZXMubmV0d29ya2luZy5odHRwLnYxYWxwaGEiSgoNQ2FjaGVTZXR0aW5ncxINCgVzdG9yZRgBIAEoCBIqCgdtYXhfYWdlGAIgASgLMhkuZ29vZ2xlLnByb3RvYnVmLkR1cmF0aW9uIh4KDEhlYWRlclZhbHVlcxIOCgZ2YWx1ZXMYASADKAkiNAoITXRsc0F1dGgSEwoLcHJpdmF0ZV9rZXkYASABKAwSEwoLY2VydGlmaWNhdGUYAiABKAwiuwQKB1JlcXVlc3QSCwoDdXJsGAEgASgJEg4KBm1ldGhvZBgCIAEoCRJPCgdoZWFkZXJzGAMgAygLMjouY2FwYWJpbGl0aWVzLm5ldHdvcmtpbmcuaHR0cC52MWFscGhhLlJlcXVlc3QuSGVhZGVyc0VudHJ5QgIYARIMCgRib2R5GAQgASgMEioKB3RpbWVvdXQYBSABKAsyGS5nb29nbGUucHJvdG9idWYuRHVyYXRpb24SSwoOY2FjaGVfc2V0dGluZ3MYBiABKAsyMy5jYXBhYmlsaXRpZXMubmV0d29ya2luZy5odHRwLnYxYWxwaGEuQ2FjaGVTZXR0aW5ncxJWCg1tdWx0aV9oZWFkZXJzGAcgAygLMj8uY2FwYWJpbGl0aWVzLm5ldHdvcmtpbmcuaHR0cC52MWFscGhhLlJlcXVlc3QuTXVsdGlIZWFkZXJzRW50cnkSQQoEbXRscxgIIAEoCzIuLmNhcGFiaWxpdGllcy5uZXR3b3JraW5nLmh0dHAudjFhbHBoYS5NdGxzQXV0aEgAiAEBGi4KDEhlYWRlcnNFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBGmcKEU11bHRpSGVhZGVyc0VudHJ5EgsKA2tleRgBIAEoCRJBCgV2YWx1ZRgCIAEoCzIyLmNhcGFiaWxpdGllcy5uZXR3b3JraW5nLmh0dHAudjFhbHBoYS5IZWFkZXJWYWx1ZXM6AjgBQgcKBV9tdGxzIvECCghSZXNwb25zZRITCgtzdGF0dXNfY29kZRgBIAEoDRJQCgdoZWFkZXJzGAIgAygLMjsuY2FwYWJpbGl0aWVzLm5ldHdvcmtpbmcuaHR0cC52MWFscGhhLlJlc3BvbnNlLkhlYWRlcnNFbnRyeUICGAESDAoEYm9keRgDIAEoDBJXCg1tdWx0aV9oZWFkZXJzGAQgAygLMkAuY2FwYWJpbGl0aWVzLm5ldHdvcmtpbmcuaHR0cC52MWFscGhhLlJlc3BvbnNlLk11bHRpSGVhZGVyc0VudHJ5Gi4KDEhlYWRlcnNFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBGmcKEU11bHRpSGVhZGVyc0VudHJ5EgsKA2tleRgBIAEoCRJBCgV2YWx1ZRgCIAEoCzIyLmNhcGFiaWxpdGllcy5uZXR3b3JraW5nLmh0dHAudjFhbHBoYS5IZWFkZXJWYWx1ZXM6AjgBMpgBCgZDbGllbnQSbAoLU2VuZFJlcXVlc3QSLS5jYXBhYmlsaXRpZXMubmV0d29ya2luZy5odHRwLnYxYWxwaGEuUmVxdWVzdBouLmNhcGFiaWxpdGllcy5uZXR3b3JraW5nLmh0dHAudjFhbHBoYS5SZXNwb25zZRoggrUYHAgCEhhodHRwLWFjdGlvbnNAMS4wLjAtYWxwaGFC6gEKKGNvbS5jYXBhYmlsaXRpZXMubmV0d29ya2luZy5odHRwLnYxYWxwaGFCC0NsaWVudFByb3RvUAGiAgNDTkiqAiRDYXBhYmlsaXRpZXMuTmV0d29ya2luZy5IdHRwLlYxYWxwaGHKAiRDYXBhYmlsaXRpZXNcTmV0d29ya2luZ1xIdHRwXFYxYWxwaGHiAjBDYXBhYmlsaXRpZXNcTmV0d29ya2luZ1xIdHRwXFYxYWxwaGFcR1BCTWV0YWRhdGHqAidDYXBhYmlsaXRpZXM6Ok5ldHdvcmtpbmc6Okh0dHA6OlYxYWxwaGFiBnByb3RvMw', [file_google_protobuf_duration, file_tools_generator_v1alpha_cre_metadata]);
 /**
  * Describes the message capabilities.networking.http.v1alpha.CacheSettings.
  * Use `create(CacheSettingsSchema)` to create a new message.
@@ -24,20 +24,27 @@ messageDesc(file_capabilities_networking_http_v1alpha_client, 0);
 export const HeaderValuesSchema = 
 /*@__PURE__*/
 messageDesc(file_capabilities_networking_http_v1alpha_client, 1);
+/**
+ * Describes the message capabilities.networking.http.v1alpha.MtlsAuth.
+ * Use `create(MtlsAuthSchema)` to create a new message.
+ */
+export const MtlsAuthSchema = 
+/*@__PURE__*/
+messageDesc(file_capabilities_networking_http_v1alpha_client, 2);
 /**
  * Describes the message capabilities.networking.http.v1alpha.Request.
  * Use `create(RequestSchema)` to create a new message.
  */
 export const RequestSchema = 
 /*@__PURE__*/
-messageDesc(file_capabilities_networking_http_v1alpha_client, 2);
+messageDesc(file_capabilities_networking_http_v1alpha_client, 3);
 /**
  * Describes the message capabilities.networking.http.v1alpha.Response.
  * Use `create(ResponseSchema)` to create a new message.
  */
 export const ResponseSchema = 
 /*@__PURE__*/
-messageDesc(file_capabilities_networking_http_v1alpha_client, 3);
+messageDesc(file_capabilities_networking_http_v1alpha_client, 4);
 /**
  * @generated from service capabilities.networking.http.v1alpha.Client
  */

package/dist/sdk/errors.d.ts

@@ -1,4 +1,5 @@
 import type { SecretRequest } from '../generated/sdk/v1alpha/sdk_pb';
+export { CapabilityError as CapabilityRuntimeError } from './utils/capabilities/capability-error';
 export declare class DonModeError extends Error {
     constructor();
 }

package/dist/sdk/errors.js

@@ -1,3 +1,5 @@
+// TODO: on the next major version, rename this to CapabilityRuntimeError
+export { CapabilityError as CapabilityRuntimeError } from './utils/capabilities/capability-error';
 export class DonModeError extends Error {
     constructor() {
         super('cannot use Runtime inside RunInNodeMode');

package/dist/sdk/impl/runtime-impl.js

@@ -1,10 +1,10 @@
 import { create } from '@bufbuild/protobuf';
 import { anyPack, anyUnpack } from '@bufbuild/protobuf/wkt';
+import { deserializeErrorFromString } from '../../capabilities/errors';
 import { AwaitCapabilitiesRequestSchema, AwaitSecretsRequestSchema, CapabilityRequestSchema, GetSecretsRequestSchema, Mode, SecretRequestSchema, SimpleConsensusInputsSchema, } from '../../generated/sdk/v1alpha/sdk_pb';
 import { ConsensusCapability } from '../../generated-sdk/capabilities/internal/consensus/v1alpha/consensus_sdk_gen';
 import { Value, } from '../utils';
-import { CapabilityError } from '../utils/capabilities/capability-error';
-import { DonModeError, NodeModeError, SecretsError } from '../errors';
+import { CapabilityRuntimeError, DonModeError, NodeModeError, SecretsError } from '../errors';
 const DEFAULT_SECRET_NAMESPACE = 'main';
 /**
  * Base implementation shared by DON and Node runtimes.
@@ -59,7 +59,7 @@ export class BaseRuntimeImpl {
         if (!this.helpers.call(req)) {
             return {
                 result: () => {
-                    throw new CapabilityError(`Capability '${capabilityId}' not found: the host rejected the call to method '${method}'. Verify the capability ID is correct and the capability is available in this CRE environment`, {
+                    throw new CapabilityRuntimeError(`Capability '${capabilityId}' not found: the host rejected the call to method '${method}'. Verify the capability ID is correct and the capability is available in this CRE environment`, {
                         callbackId,
                         method,
                         capabilityId,
@@ -96,7 +96,7 @@ export class BaseRuntimeImpl {
         const awaitResponse = this.helpers.await(awaitRequest, this.maxResponseSize);
         const capabilityResponse = awaitResponse.responses[callbackId];
         if (!capabilityResponse) {
-            throw new CapabilityError(`No response found for capability '${capabilityId}' method '${method}' (callback ID ${callbackId}): the host returned a response map that does not contain an entry for this call`, {
+            throw new CapabilityRuntimeError(`No response found for capability '${capabilityId}' method '${method}' (callback ID ${callbackId}): the host returned a response map that does not contain an entry for this call`, {
                 capabilityId,
                 method,
                 callbackId,
@@ -109,7 +109,7 @@ export class BaseRuntimeImpl {
                     return anyUnpack(response.value, outputSchema);
                 }
                 catch {
-                    throw new CapabilityError(`Failed to deserialize response payload for capability '${capabilityId}' method '${method}': the response could not be unpacked into the expected output schema`, {
+                    throw new CapabilityRuntimeError(`Failed to deserialize response payload for capability '${capabilityId}' method '${method}': the response could not be unpacked into the expected output schema`, {
                         capabilityId,
                         method,
                         callbackId,
@@ -117,13 +117,9 @@ export class BaseRuntimeImpl {
                 }
             }
             case 'error':
-                throw new CapabilityError(`Capability '${capabilityId}' method '${method}' returned an error: ${response.value}`, {
-                    capabilityId,
-                    method,
-                    callbackId,
-                });
+                throw deserializeErrorFromString(response.value);
             default:
-                throw new CapabilityError(`Unexpected response type '${response.case}' for capability '${capabilityId}' method '${method}': expected 'payload' or 'error'`, {
+                throw new CapabilityRuntimeError(`Unexpected response type '${response.case}' for capability '${capabilityId}' method '${method}': expected 'payload' or 'error'`, {
                     capabilityId,
                     method,
                     callbackId,

package/dist/sdk/index.d.ts

@@ -1,3 +1,4 @@
+export * from '../capabilities/errors';
 export * from './cre';
 export * from './don-info';
 export * from './errors';

package/dist/sdk/index.js

@@ -1,3 +1,4 @@
+export * from '../capabilities/errors';
 export * from './cre';
 export * from './don-info';
 export * from './errors';

package/dist/sdk/utils/capabilities/capability-error.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @deprecated Use {@link CapabilityRuntimeError} from `@chainlink/cre-sdk` instead.
+ * Will be removed in the next major version.
+ */
 export declare class CapabilityError extends Error {
     name: string;
     capabilityId?: string;

package/dist/sdk/utils/capabilities/capability-error.js

@@ -1,3 +1,7 @@
+/**
+ * @deprecated Use {@link CapabilityRuntimeError} from `@chainlink/cre-sdk` instead.
+ * Will be removed in the next major version.
+ */
 export class CapabilityError extends Error {
     name;
     capabilityId;

package/dist/workflows/standard_tests/capability_errors/test.ts

@@ -0,0 +1,44 @@
+import { isCapabilityExecutionError, UnrecognisedErrorCode } from '@cre/capabilities/errors'
+import { BasicActionCapability } from '@cre/generated-sdk/capabilities/internal/basicaction/v1/basicaction_sdk_gen'
+import { BasicCapability as BasicTriggerCapability } from '@cre/generated-sdk/capabilities/internal/basictrigger/v1/basic_sdk_gen'
+import { cre, type Runtime } from '@cre/sdk/cre'
+import { Runner } from '@cre/sdk/wasm'
+
+const checkCapabilityErrors = (runtime: Runtime<Uint8Array>) => {
+	const basicAction = new BasicActionCapability()
+	const input = { inputThing: true }
+
+	while (true) {
+		try {
+			const output = basicAction.performAction(runtime, input).result()
+			if (output.adaptedThing !== 'Done') {
+				throw new Error(`expected Done response, got ${output.adaptedThing}`)
+			}
+			return 'Done'
+		} catch (err) {
+			if (!isCapabilityExecutionError(err)) {
+				throw new Error(`expected capability error, got ${String(err)}`)
+			}
+			if (err.code === UnrecognisedErrorCode) {
+				throw new Error('expected recognised error code, got UnrecognisedErrorCode')
+			}
+		}
+	}
+}
+
+const initWorkflow = () => {
+	const basicTrigger = new BasicTriggerCapability()
+
+	return [cre.handler(basicTrigger.trigger({}), checkCapabilityErrors)]
+}
+
+export async function main() {
+	console.log(`TS workflow: standard test: capability errors [${new Date().toISOString()}]`)
+
+	const runner = await Runner.newRunner<Uint8Array>({
+		configParser: (c) => c,
+	})
+	await runner.run(initWorkflow)
+}
+
+await main()

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@chainlink/cre-sdk",
-	"version": "1.11.0",
+	"version": "1.12.0",
 	"type": "module",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",