@unconfirmed/sui-effect 0.1.1 → 0.1.3

package/dist/domain/errors.d.ts

@@ -55,6 +55,8 @@ export declare class TransportError extends TransportError_base {
      * ```
      */
     static readonly fromUnknown: (method: string, cause: unknown, retryable?: boolean) => TransportError;
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 /**
  * gRPC status names a read may be retried on, plus HTTP 5xx and 429. Timeouts
@@ -84,6 +86,17 @@ declare const ObjectNotFound_base: Schema.Class<ObjectNotFound, Schema.TaggedStr
 }>, import("effect/Cause").YieldableError>;
 /** The object does not exist, or has never existed. */
 export declare class ObjectNotFound extends ObjectNotFound_base {
+    /**
+     * The one actionable line `SuiError.describe` produces for this error.
+     *
+     * `Schema.TaggedError` gives every class the `Error` constructor and no
+     * message of its own, so `error.message` was the empty string — and a
+     * consumer that surfaces `.message` (a log line, a UI, another library's
+     * error formatter) showed nothing at all. A getter rather than a schema
+     * field, so it is always in step with `describe`, costs nothing to
+     * construct, and stays out of `SuiError.toJson`'s encoding.
+     */
+    get message(): string;
 }
 declare const ObjectDeleted_base: Schema.Class<ObjectDeleted, Schema.TaggedStruct<"ObjectDeleted", {
     readonly objectId: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId"> & {
@@ -93,6 +106,8 @@ declare const ObjectDeleted_base: Schema.Class<ObjectDeleted, Schema.TaggedStruc
 }>, import("effect/Cause").YieldableError>;
 /** The object existed and has been deleted or wrapped. */
 export declare class ObjectDeleted extends ObjectDeleted_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const ObjectUnavailable_base: Schema.Class<ObjectUnavailable, Schema.TaggedStruct<"ObjectUnavailable", {
     readonly objectId: Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId"> & {
@@ -102,12 +117,16 @@ declare const ObjectUnavailable_base: Schema.Class<ObjectUnavailable, Schema.Tag
 }>, import("effect/Cause").YieldableError>;
 /** The node could not say what happened to the object (`ObjectError.reason: "unknown"`). */
 export declare class ObjectUnavailable extends ObjectUnavailable_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const TransactionNotFound_base: Schema.Class<TransactionNotFound, Schema.TaggedStruct<"TransactionNotFound", {
     readonly digest: Schema.brand<Schema.String, "Digest">;
 }>, import("effect/Cause").YieldableError>;
 /** No transaction with this digest is known to the node. */
 export declare class TransactionNotFound extends TransactionNotFound_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const NetworkMismatch_base: Schema.Class<NetworkMismatch, Schema.TaggedStruct<"NetworkMismatch", {
     readonly expected: Schema.String;
@@ -115,17 +134,94 @@ declare const NetworkMismatch_base: Schema.Class<NetworkMismatch, Schema.TaggedS
 }>, import("effect/Cause").YieldableError>;
 /** The chain identifier the node reported is not the one the layer was built for. */
 export declare class NetworkMismatch extends NetworkMismatch_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
+/**
+ * Which of the three things that can go wrong at a decode boundary went wrong.
+ *
+ * - `"type"`: the object, the field or the event **is not of the expected Move
+ *   type**. The bytes were never parsed. This is the one a caller answers with
+ *   "that is not one of mine" — a 404 for a foreign object, a `filter` over a
+ *   heterogeneous list — and the one it is safe to swallow.
+ * - `"bytes"`: the type matched and the **BCS parse failed**, or left trailing
+ *   bytes. Either the layout this package was built with is not the layout the
+ *   package on chain writes, or the object is corrupt. Never safe to swallow.
+ * - `"shape"`: a **domain schema** refused a value that was already parsed or
+ *   that came from the node as JSON — a missing field in a node response, a
+ *   number that is not a timestamp, a simulation with no such command. A bug
+ *   here is in this library, the node, or the caller's expectations.
+ *
+ * Branch on this, never on {@link DecodeError}'s `issue`: `issue` is a human
+ * sentence and its wording changes between releases.
+ *
+ * @since 0.1.2
+ */
+export declare const DecodeKind: Schema.Literals<readonly ["type", "bytes", "shape"]>;
+/** The three decode failures {@link DecodeKind} names. */
+export type DecodeKind = typeof DecodeKind.Type;
 declare const DecodeError_base: Schema.Class<DecodeError, Schema.TaggedStruct<"DecodeError", {
     readonly objectId: Schema.optional<Schema.brand<Schema.decodeTo<Schema.toType<Schema.String>, Schema.String, never, never>, "ObjectId"> & {
         normalize: (input: string) => string & import("effect/Brand").Brand<"ObjectId">;
     }>;
     readonly expectedType: Schema.optional<Schema.String>;
+    /**
+     * Which boundary failed. See {@link DecodeKind}.
+     *
+     * @since 0.1.2
+     */
+    readonly kind: Schema.withConstructorDefault<Schema.withDecodingDefaultKey<Schema.Literals<readonly ["type", "bytes", "shape"]>, never>>;
     readonly issue: Schema.String;
+    /**
+     * Every issue the schema reported, with its path — the structured form of
+     * {@link DecodeError.issue}, which is only the first issue's sentence.
+     *
+     * An operator debugging a relay envelope with three bad fields sees three
+     * paths rather than one line, and a UI can render a message per field. The
+     * key is absent when the producer had no structured issue to carry (a Move
+     * type mismatch, a hand-built `DecodeError`), so `SuiError.toJson` still
+     * round-trips for every error that was built without one.
+     *
+     * `kind` is still the field to branch on; this is for reading.
+     *
+     * @since 0.1.3
+     */
+    readonly issues: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+        /** The path into the decoded value, as the schema walked it. */
+        readonly path: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Number]>>;
+        /** What the schema said about that path. */
+        readonly message: Schema.String;
+    }>>>;
 }>, import("effect/Cause").YieldableError>;
-/** BCS content or a schema boundary did not decode. */
+/**
+ * BCS content or a schema boundary did not decode.
+ *
+ * `kind` says which of the three (`"type"`, `"bytes"`, `"shape"`) and is what a
+ * consumer branches on; `issue` is the sentence for a human and is not stable.
+ * It defaults to `"shape"` when neither a constructor nor an encoded value
+ * carries one, so an extension that builds a `DecodeError` with no `kind` still
+ * compiles and still answers the question conservatively.
+ */
 export declare class DecodeError extends DecodeError_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
+/**
+ * The `DecodeError` payload a failed decode deserves: the first issue as the
+ * sentence `issue` has always been, and every issue as `{ path, message }`.
+ *
+ * `SchemaError.issue` is a tree; the second half is Effect's own
+ * Standard-Schema formatter over it, so the paths are the ones every other
+ * tool prints. A decode run with `{ errors: "all" }` reports every field
+ * rather than the first. Never fails.
+ */
+export declare const decodePayload: (error: Schema.SchemaError) => {
+    readonly issue: string;
+    readonly issues: ReadonlyArray<{
+        readonly path: ReadonlyArray<string | number>;
+        readonly message: string;
+    }>;
+};
 declare const SimulationFailed_base: Schema.Class<SimulationFailed, Schema.TaggedStruct<"SimulationFailed", {
     readonly reason: Schema.toTaggedUnion<"$kind", readonly [Schema.Struct<{
         readonly $kind: Schema.Literal<"MoveAbort">;
@@ -134,13 +230,13 @@ declare const SimulationFailed_base: Schema.Class<SimulationFailed, Schema.Tagge
             readonly location: Schema.optional<Schema.Struct<{
                 readonly package: Schema.optional<Schema.String>;
                 readonly module: Schema.optional<Schema.String>;
-                readonly function: Schema.optional<Schema.Number>;
+                readonly function: Schema.optional<Schema.Finite>;
                 readonly functionName: Schema.optional<Schema.String>;
-                readonly instruction: Schema.optional<Schema.Number>;
+                readonly instruction: Schema.optional<Schema.Finite>;
             }>>;
             readonly cleverError: Schema.optional<Schema.Struct<{
-                readonly errorCode: Schema.optional<Schema.Number>;
-                readonly lineNumber: Schema.optional<Schema.Number>;
+                readonly errorCode: Schema.optional<Schema.Finite>;
+                readonly lineNumber: Schema.optional<Schema.Finite>;
                 readonly constantName: Schema.optional<Schema.String>;
                 readonly constantType: Schema.optional<Schema.String>;
                 readonly value: Schema.optional<Schema.String>;
@@ -150,19 +246,19 @@ declare const SimulationFailed_base: Schema.Class<SimulationFailed, Schema.Tagge
         readonly $kind: Schema.Literal<"SizeError">;
         readonly SizeError: Schema.Struct<{
             readonly name: Schema.String;
-            readonly size: Schema.Number;
-            readonly maxSize: Schema.Number;
+            readonly size: Schema.Finite;
+            readonly maxSize: Schema.Finite;
         }>;
     }>, Schema.Struct<{
         readonly $kind: Schema.Literal<"CommandArgumentError">;
         readonly CommandArgumentError: Schema.Struct<{
-            readonly argument: Schema.Number;
+            readonly argument: Schema.Finite;
             readonly name: Schema.String;
         }>;
     }>, Schema.Struct<{
         readonly $kind: Schema.Literal<"TypeArgumentError">;
         readonly TypeArgumentError: Schema.Struct<{
-            readonly typeArgument: Schema.Number;
+            readonly typeArgument: Schema.Finite;
             readonly name: Schema.String;
         }>;
     }>, Schema.Struct<{
@@ -175,8 +271,8 @@ declare const SimulationFailed_base: Schema.Class<SimulationFailed, Schema.Tagge
     }>, Schema.Struct<{
         readonly $kind: Schema.Literal<"IndexError">;
         readonly IndexError: Schema.Struct<{
-            readonly index: Schema.optional<Schema.Number>;
-            readonly subresult: Schema.optional<Schema.Number>;
+            readonly index: Schema.optional<Schema.Finite>;
+            readonly subresult: Schema.optional<Schema.Finite>;
         }>;
     }>, Schema.Struct<{
         readonly $kind: Schema.Literal<"CoinDenyListError">;
@@ -214,13 +310,13 @@ declare const ExecutionFailed_base: Schema.Class<ExecutionFailed, Schema.TaggedS
             readonly location: Schema.optional<Schema.Struct<{
                 readonly package: Schema.optional<Schema.String>;
                 readonly module: Schema.optional<Schema.String>;
-                readonly function: Schema.optional<Schema.Number>;
+                readonly function: Schema.optional<Schema.Finite>;
                 readonly functionName: Schema.optional<Schema.String>;
-                readonly instruction: Schema.optional<Schema.Number>;
+                readonly instruction: Schema.optional<Schema.Finite>;
             }>>;
             readonly cleverError: Schema.optional<Schema.Struct<{
-                readonly errorCode: Schema.optional<Schema.Number>;
-                readonly lineNumber: Schema.optional<Schema.Number>;
+                readonly errorCode: Schema.optional<Schema.Finite>;
+                readonly lineNumber: Schema.optional<Schema.Finite>;
                 readonly constantName: Schema.optional<Schema.String>;
                 readonly constantType: Schema.optional<Schema.String>;
                 readonly value: Schema.optional<Schema.String>;
@@ -230,19 +326,19 @@ declare const ExecutionFailed_base: Schema.Class<ExecutionFailed, Schema.TaggedS
         readonly $kind: Schema.Literal<"SizeError">;
         readonly SizeError: Schema.Struct<{
             readonly name: Schema.String;
-            readonly size: Schema.Number;
-            readonly maxSize: Schema.Number;
+            readonly size: Schema.Finite;
+            readonly maxSize: Schema.Finite;
         }>;
     }>, Schema.Struct<{
         readonly $kind: Schema.Literal<"CommandArgumentError">;
         readonly CommandArgumentError: Schema.Struct<{
-            readonly argument: Schema.Number;
+            readonly argument: Schema.Finite;
             readonly name: Schema.String;
         }>;
     }>, Schema.Struct<{
         readonly $kind: Schema.Literal<"TypeArgumentError">;
         readonly TypeArgumentError: Schema.Struct<{
-            readonly typeArgument: Schema.Number;
+            readonly typeArgument: Schema.Finite;
             readonly name: Schema.String;
         }>;
     }>, Schema.Struct<{
@@ -255,8 +351,8 @@ declare const ExecutionFailed_base: Schema.Class<ExecutionFailed, Schema.TaggedS
     }>, Schema.Struct<{
         readonly $kind: Schema.Literal<"IndexError">;
         readonly IndexError: Schema.Struct<{
-            readonly index: Schema.optional<Schema.Number>;
-            readonly subresult: Schema.optional<Schema.Number>;
+            readonly index: Schema.optional<Schema.Finite>;
+            readonly subresult: Schema.optional<Schema.Finite>;
         }>;
     }>, Schema.Struct<{
         readonly $kind: Schema.Literal<"CoinDenyListError">;
@@ -280,9 +376,9 @@ declare const ExecutionFailed_base: Schema.Class<ExecutionFailed, Schema.TaggedS
     }>, Schema.Struct<{
         readonly $kind: Schema.Literal<"Unknown">;
     }>]>;
-    readonly command: Schema.optional<Schema.Number>;
+    readonly command: Schema.optional<Schema.Finite>;
     readonly effects: Schema.Struct<{
-        readonly version: Schema.Number;
+        readonly version: Schema.Finite;
         readonly status: Schema.Struct<{
             readonly success: Schema.Boolean;
         }>;
@@ -449,6 +545,8 @@ declare const ExecutionFailed_base: Schema.Class<ExecutionFailed, Schema.TaggedS
 }>, import("effect/Cause").YieldableError>;
 /** The transaction was applied on chain and failed. Gas was charged. */
 export declare class ExecutionFailed extends ExecutionFailed_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const SubmissionUnknown_base: Schema.Class<SubmissionUnknown, Schema.TaggedStruct<"SubmissionUnknown", {
     readonly digest: Schema.brand<Schema.String, "Digest">;
@@ -464,30 +562,30 @@ declare const SubmissionUnknown_base: Schema.Class<SubmissionUnknown, Schema.Tag
             readonly None: Schema.Literal<true>;
         }>, Schema.Struct<{
             readonly $kind: Schema.Literal<"Epoch">;
-            readonly Epoch: Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Number]>, never, never>;
+            readonly Epoch: Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Finite]>, never, never>;
         }>, Schema.Struct<{
             readonly $kind: Schema.Literal<"ValidDuring">;
             readonly ValidDuring: Schema.Struct<{
-                readonly minEpoch: Schema.NullOr<Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Number]>, never, never>>;
-                readonly maxEpoch: Schema.NullOr<Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Number]>, never, never>>;
-                readonly minTimestamp: Schema.NullOr<Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Number]>, never, never>>;
-                readonly maxTimestamp: Schema.NullOr<Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Number]>, never, never>>;
+                readonly minEpoch: Schema.NullOr<Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Finite]>, never, never>>;
+                readonly maxEpoch: Schema.NullOr<Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Finite]>, never, never>>;
+                readonly minTimestamp: Schema.NullOr<Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Finite]>, never, never>>;
+                readonly maxTimestamp: Schema.NullOr<Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Finite]>, never, never>>;
                 readonly chain: Schema.String;
-                readonly nonce: Schema.Number;
+                readonly nonce: Schema.Finite;
             }>;
         }>, Schema.Struct<{
             readonly $kind: Schema.Literal<"Validity">;
             readonly Validity: Schema.Struct<{
                 readonly allowedProposers: Schema.NullOr<Schema.Struct<{
-                    readonly epoch: Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Number]>, never, never>;
-                    readonly proposers: Schema.$Array<Schema.Number>;
+                    readonly epoch: Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Finite]>, never, never>;
+                    readonly proposers: Schema.$Array<Schema.Finite>;
                 }>>;
-                readonly minEpoch: Schema.NullOr<Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Number]>, never, never>>;
-                readonly maxEpoch: Schema.NullOr<Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Number]>, never, never>>;
-                readonly minTimestamp: Schema.NullOr<Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Number]>, never, never>>;
-                readonly maxTimestamp: Schema.NullOr<Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Number]>, never, never>>;
+                readonly minEpoch: Schema.NullOr<Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Finite]>, never, never>>;
+                readonly maxEpoch: Schema.NullOr<Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Finite]>, never, never>>;
+                readonly minTimestamp: Schema.NullOr<Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Finite]>, never, never>>;
+                readonly maxTimestamp: Schema.NullOr<Schema.decodeTo<Schema.BigInt, Schema.Union<readonly [Schema.String, Schema.Finite]>, never, never>>;
                 readonly chain: Schema.String;
-                readonly nonce: Schema.Number;
+                readonly nonce: Schema.Finite;
             }>;
         }>]>>;
         readonly chain: Schema.optional<Schema.String>;
@@ -499,6 +597,8 @@ declare const SubmissionUnknown_base: Schema.Class<SubmissionUnknown, Schema.Tag
  * signed transaction so an operator or a later process can reconcile it.
  */
 export declare class SubmissionUnknown extends SubmissionUnknown_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const NotApplied_base: Schema.Class<NotApplied, Schema.TaggedStruct<"NotApplied", {
     readonly digest: Schema.brand<Schema.String, "Digest">;
@@ -514,12 +614,16 @@ declare const NotApplied_base: Schema.Class<NotApplied, Schema.TaggedStruct<"Not
  * node will not name are all `SubmissionUnknown`, not this.
  */
 export declare class NotApplied extends NotApplied_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const SigningError_base: Schema.Class<SigningError, Schema.TaggedStruct<"SigningError", {
     readonly cause: Schema.Defect;
 }>, import("effect/Cause").YieldableError>;
 /** A signer refused or failed to produce a signature. */
 export declare class SigningError extends SigningError_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const BuildError_base: Schema.Class<BuildError, Schema.TaggedStruct<"BuildError", {
     readonly message: Schema.String;
@@ -540,6 +644,8 @@ declare const JournalError_base: Schema.Class<JournalError, Schema.TaggedStruct<
 }>, import("effect/Cause").YieldableError>;
 /** The submission journal could not be read or written. */
 export declare class JournalError extends JournalError_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const UnexpectedEffects_base: Schema.Class<UnexpectedEffects, Schema.TaggedStruct<"UnexpectedEffects", {
     readonly digest: Schema.brand<Schema.String, "Digest">;
@@ -559,6 +665,8 @@ declare const UnexpectedEffects_base: Schema.Class<UnexpectedEffects, Schema.Tag
  * time for a transaction that already ran.
  */
 export declare class UnexpectedEffects extends UnexpectedEffects_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const GraphQLUnavailable_base: Schema.Class<GraphQLUnavailable, Schema.TaggedStruct<"GraphQLUnavailable", {
     readonly method: Schema.String;
@@ -578,6 +686,8 @@ declare const GraphQLUnavailable_base: Schema.Class<GraphQLUnavailable, Schema.T
  * Outcome `not_applied`: a read that did not happen changed nothing.
  */
 export declare class GraphQLUnavailable extends GraphQLUnavailable_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 declare const ExtensionNotReady_base: Schema.Class<ExtensionNotReady, Schema.TaggedStruct<"ExtensionNotReady", {
     readonly extension: Schema.String;
@@ -598,6 +708,8 @@ declare const ExtensionNotReady_base: Schema.Class<ExtensionNotReady, Schema.Tag
  * Outcome `not_applied`: nothing was sent.
  */
 export declare class ExtensionNotReady extends ExtensionNotReady_base {
+    /** The one actionable line `SuiError.describe` produces for this error. */
+    get message(): string;
 }
 /** Every failure sui-effect can produce. */
 export type SuiError = TransportError | ObjectNotFound | ObjectDeleted | ObjectUnavailable | TransactionNotFound | NetworkMismatch | DecodeError | SimulationFailed | ExecutionFailed | SubmissionUnknown | NotApplied | SigningError | BuildError | PolicyDenied | JournalError | UnexpectedEffects | GraphQLUnavailable | ExtensionNotReady;
@@ -608,6 +720,20 @@ export declare const SuiErrorSchema: Schema.Union<readonly [typeof TransportErro
  * or a wrapper script acts on.
  */
 export type Outcome = "applied" | "not_applied" | "unknown";
+/**
+ * Where in the lifecycle a failure was caught, which is the only thing that
+ * can classify an error the taxonomy does not own.
+ *
+ * `"post-submit"` (the default, and the 0.1.1 behaviour) is "bytes may have
+ * gone out": a tag nobody here recognises proves nothing, so the answer is
+ * `"unknown"`. `"pre-submit"` is a failure caught while **building, simulating
+ * or signing** — an extension's own `PriceTooLow`, a validation error from the
+ * caller's code — where nothing has been sent by construction and the honest
+ * answer is `"not_applied"`.
+ *
+ * @since 0.1.2
+ */
+export type OutcomePhase = "pre-submit" | "post-submit";
 /**
  * An extension error may declare its own `outcome`, and `SuiError.outcome` and
  * `Script.run` honour it before anything else.
@@ -621,13 +747,25 @@ export interface HasOutcome {
     readonly outcome: Outcome;
 }
 /**
- * The four helpers every repo hand-rolls: is this worth retrying, did the
- * transaction land, what does an operator need to read, and what goes in a log.
+ * The helpers every repo hand-rolls: is this worth retrying, did the
+ * transaction land, is it even one of ours, what does an operator need to read,
+ * and what goes in a log.
+ *
+ * For *branching* on a failure, the taxonomy is a flat tagged union, so
+ * `Effect.catchTags({ ObjectNotFound: ..., TransportError: ... })` in the error
+ * channel and `Match.tagsExhaustive` over a `SuiError` value both work and are
+ * the two documented consumer idioms; these helpers are for the questions that
+ * are the same whatever the tag is.
  */
 export declare const SuiError: {
     readonly isRetryable: (error: SuiError) => boolean;
-    readonly outcome: (error: SuiError | HasOutcome) => Outcome;
-    readonly describe: (error: SuiError) => string;
+    readonly isTaxonomy: (error: unknown) => error is SuiError;
+    readonly outcome: (error: SuiError | HasOutcome, options?: {
+        readonly phase?: OutcomePhase;
+    }) => Outcome;
+    readonly describe: (error: SuiError | {
+        readonly _tag: string;
+    }) => string;
     readonly toJson: (error: SuiError | {
         readonly _tag: string;
     }) => Record<string, unknown>;

package/dist/domain/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/domain/errors.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAU,MAAM,EAAE,MAAM,QAAQ,CAAA;AACvC,OAAO,EACL,MAAM,EAOP,MAAM,cAAc,CAAA;AAErB,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;;;;;;;AAEzE;;;;;;;;GAQG;AACH,qBAAa,cAAe,SAAQ,mBAKlC;IACA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,GACzB,QAAQ,MAAM,EACd,OAAO,OAAO,EACd,YAAY,OAAO,KAClB,cAAc,CAQhB;CACF;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,uBAAuB,EAAE,WAAW,CAAC,MAAM,CAMtD,CAAA;AAIF;;;GAGG;AACH,eAAO,MAAM,sBAAsB,GACjC,OAAO,OAAO,KACb;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAA;CAkBzD,CAAA;;;;;;;AAED,uDAAuD;AACvD,qBAAa,cAAe,SAAQ,mBAGlC;CAAG;;;;;;;AAEL,0DAA0D;AAC1D,qBAAa,aAAc,SAAQ,kBAGjC;CAAG;;;;;;;AAEL,4FAA4F;AAC5F,qBAAa,iBAAkB,SAAQ,sBAGtC;CAAG;;;;AAEJ,4DAA4D;AAC5D,qBAAa,mBAAoB,SAAQ,wBAGxC;CAAG;;;;;AAEJ,qFAAqF;AACrF,qBAAa,eAAgB,SAAQ,oBAGnC;CAAG;;;;;;;;AAEL,uDAAuD;AACvD,qBAAa,WAAY,SAAQ,gBAI/B;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL,oEAAoE;AACpE,qBAAa,gBAAiB,SAAQ,qBAGpC;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL,wEAAwE;AACxE,qBAAa,eAAgB,SAAQ,oBAKnC;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,sBAGtC;CAAG;;;;;AAEJ;;;;;;;;GAQG;AACH,qBAAa,UAAW,SAAQ,eAG9B;CAAG;;;;AAEL,yDAAyD;AACzD,qBAAa,YAAa,SAAQ,iBAEhC;CAAG;;;;;AAEL,qDAAqD;AACrD,qBAAa,UAAW,SAAQ,eAG9B;CAAG;;;;;AAEL,uEAAuE;AACvE,qBAAa,YAAa,SAAQ,iBAGhC;CAAG;;;;AAEL,2DAA2D;AAC3D,qBAAa,YAAa,SAAQ,iBAEhC;CAAG;;;;;;;;AAEL;;;;;;;;;GASG;AACH,qBAAa,iBAAkB,SAAQ,sBAGtC;CAAG;;;;;AAEJ;;;;;;;;;;;;GAYG;AACH,qBAAa,kBAAmB,SAAQ,uBAGvC;CAAG;;;;;AAEJ;;;;;;;;;;;;;GAaG;AACH,qBAAa,iBAAkB,SAAQ,sBAGtC;CAAG;AAEJ,4CAA4C;AAC5C,MAAM,MAAM,QAAQ,GAChB,cAAc,GACd,cAAc,GACd,aAAa,GACb,iBAAiB,GACjB,mBAAmB,GACnB,eAAe,GACf,WAAW,GACX,gBAAgB,GAChB,eAAe,GACf,iBAAiB,GACjB,UAAU,GACV,YAAY,GACZ,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,iBAAiB,GACjB,kBAAkB,GAClB,iBAAiB,CAAA;AAErB,gEAAgE;AAChE,eAAO,MAAM,cAAc,8bAmBzB,CAAA;AAEF;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,aAAa,GAAG,SAAS,CAAA;AAE3D;;;;;;;;GAQG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;CAC1B;AA+OD;;;GAGG;AACH,eAAO,MAAM,QAAQ;kCA3OO,QAAQ,KAAG,OAAO;8BAoCtB,QAAQ,GAAG,UAAU,KAAG,OAAO;+BAqE9B,QAAQ,KAAG,MAAM;6BAiHnB,QAAQ,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,KAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAsB3E,CAAA;AAEV,0EAA0E;AAC1E,eAAO,MAAM,QAAQ,GAAI,OAAO,QAAQ,KAAG,MAAM,GAAG,SAWnD,CAAA"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/domain/errors.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAA6B,MAAM,EAAe,MAAM,QAAQ,CAAA;AACvE,OAAO,EACL,MAAM,EAOP,MAAM,cAAc,CAAA;AAErB,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;;;;;;;AAEzE;;;;;;;;GAQG;AACH,qBAAa,cAAe,SAAQ,mBAKlC;IACA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,GACzB,QAAQ,MAAM,EACd,OAAO,OAAO,EACd,YAAY,OAAO,KAClB,cAAc,CAQhB;IAED,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,uBAAuB,EAAE,WAAW,CAAC,MAAM,CAMtD,CAAA;AAIF;;;GAGG;AACH,eAAO,MAAM,sBAAsB,GACjC,OAAO,OAAO,KACb;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAA;CAkBzD,CAAA;;;;;;;AAED,uDAAuD;AACvD,qBAAa,cAAe,SAAQ,mBAGlC;IACA;;;;;;;;;OASG;IACH,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;;;AAED,0DAA0D;AAC1D,qBAAa,aAAc,SAAQ,kBAGjC;IACA,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;;;AAED,4FAA4F;AAC5F,qBAAa,iBAAkB,SAAQ,sBAGtC;IACC,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;AAED,4DAA4D;AAC5D,qBAAa,mBAAoB,SAAQ,wBAGxC;IACC,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;AAED,qFAAqF;AACrF,qBAAa,eAAgB,SAAQ,oBAGnC;IACA,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,UAAU,sDAA8C,CAAA;AACrE,0DAA0D;AAC1D,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA;;;;;;IAc7C;;;;OAIG;;;IAMH;;;;;;;;;;;;;OAaG;;QAIG,gEAAgE;;QAEhE,4CAA4C;;;;AAzCpD;;;;;;;;GAQG;AACH,qBAAa,WAAY,SAAQ,gBAqC/B;IACA,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;AAwBD;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,MAAM,CAAC,WAAW,KAAG;IACxD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,MAAM,EAAE,aAAa,CAC5B;QAAE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;QAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAC5E,CAAA;CACqE,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAaxE,oEAAoE;AACpE,qBAAa,gBAAiB,SAAQ,qBAGpC;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL,wEAAwE;AACxE,qBAAa,eAAgB,SAAQ,oBAKnC;IACA,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAED;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,sBAGtC;IACC,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;AAED;;;;;;;;GAQG;AACH,qBAAa,UAAW,SAAQ,eAG9B;IACA,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;AAED,yDAAyD;AACzD,qBAAa,YAAa,SAAQ,iBAEhC;IACA,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;AAED,qDAAqD;AACrD,qBAAa,UAAW,SAAQ,eAG9B;CAAG;;;;;AAEL,uEAAuE;AACvE,qBAAa,YAAa,SAAQ,iBAGhC;CAAG;;;;AAEL,2DAA2D;AAC3D,qBAAa,YAAa,SAAQ,iBAEhC;IACA,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;;;;AAED;;;;;;;;;GASG;AACH,qBAAa,iBAAkB,SAAQ,sBAGtC;IACC,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,kBAAmB,SAAQ,uBAGvC;IACC,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,iBAAkB,SAAQ,sBAGtC;IACC,2EAA2E;IAC3E,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;AAED,4CAA4C;AAC5C,MAAM,MAAM,QAAQ,GAChB,cAAc,GACd,cAAc,GACd,aAAa,GACb,iBAAiB,GACjB,mBAAmB,GACnB,eAAe,GACf,WAAW,GACX,gBAAgB,GAChB,eAAe,GACf,iBAAiB,GACjB,UAAU,GACV,YAAY,GACZ,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,iBAAiB,GACjB,kBAAkB,GAClB,iBAAiB,CAAA;AAErB,gEAAgE;AAChE,eAAO,MAAM,cAAc,8bAmBzB,CAAA;AAWF;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,aAAa,GAAG,SAAS,CAAA;AAE3D;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG,aAAa,CAAA;AAEvD;;;;;;;;GAQG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;CAC1B;AAuTD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,QAAQ;kCA1TO,QAAQ,KAAG,OAAO;iCA0SnB,OAAO,KAAG,KAAK,IAAI,QAAQ;8BAtQ7C,QAAQ,GAAG,UAAU,YAClB;QAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,CAAA;KAAE,KAC1C,OAAO;+BAqFe,QAAQ,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,KAAG,MAAM;6BAiJ/C,QAAQ,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,KAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAoD3E,CAAA;AAEV,0EAA0E;AAC1E,eAAO,MAAM,QAAQ,GAAI,OAAO,QAAQ,KAAG,MAAM,GAAG,SAWnD,CAAA"}