@0xtrails/api 0.10.4 → 0.11.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xtrails/api",
-  "version": "0.10.4",
+  "version": "0.11.1",
   "type": "module",
   "description": "Trails API Client SDK",
   "repository": "https://github.com/0xsequence/trails/tree/master/packages/trails-api",

package/src/api-types.ts

@@ -0,0 +1,61 @@
+/**
+ * Union types for API shapes that differ between v1 and v1_5.
+ * Allows typechecking against both response shapes.
+ * TrailsClient is v1 (primary) plus v1_5-only methods (shim).
+ */
+import type * as V1 from "./trails-api.gen.js"
+import type * as V1_5 from "./trails-api-v1_5.gen.js"
+
+/** v1 primary; v1_5-only methods shimmed in; commit/execute accept union request types */
+export type TrailsClient = Omit<
+  V1.TrailsClient,
+  "commitIntent" | "executeIntent"
+> &
+  Pick<
+    V1_5.TrailsClient,
+    "getIntentConfig" | "getSupportedIntentProtocolVersions"
+  > & {
+    commitIntent(
+      req: CommitIntentRequest,
+      headers?: object,
+      signal?: AbortSignal,
+    ): Promise<CommitIntentResponse>
+    executeIntent(
+      req: ExecuteIntentRequest,
+      headers?: object,
+      signal?: AbortSignal,
+    ): Promise<ExecuteIntentResponse>
+  }
+
+export type TrailsContracts = V1.TrailsContracts | V1_5.TrailsContracts
+/** Union; augmented so optional intentProtocolVersion is always readable (v2 has it, v1 does not). */
+export type Intent = (V1.Intent | V1_5.Intent) & {
+  intentProtocolVersion?: V1_5.IntentProtocolVersion
+}
+/** Union; augmented so optional v1_5-only fields are readable. */
+export type DepositSignature = (V1.DepositSignature | V1_5.DepositSignature) & {
+  intentSignature?: string
+  userNonce?: number
+}
+export type DepositIntentEntry = V1.DepositIntentEntry | V1_5.DepositIntentEntry
+export type QuoteIntentRequest = V1.QuoteIntentRequest | V1_5.QuoteIntentRequest
+/** Request with union Intent so callers don't need to cast */
+export type CommitIntentRequest = { intent: Intent }
+/** Request with union DepositSignature so callers don't need to cast */
+export type ExecuteIntentRequest = {
+  intentId: string
+  depositTransactionHash?: string
+  depositSignature?: DepositSignature
+}
+export type GetIntentResponse = V1.GetIntentResponse | V1_5.GetIntentResponse
+export type CommitIntentResponse =
+  | V1.CommitIntentResponse
+  | V1_5.CommitIntentResponse
+export type ExecuteIntentResponse =
+  | V1.ExecuteIntentResponse
+  | V1_5.ExecuteIntentResponse
+export type IntentReceipt = V1.IntentReceipt | V1_5.IntentReceipt
+export type WaitIntentReceiptResponse =
+  | V1.WaitIntentReceiptResponse
+  | V1_5.WaitIntentReceiptResponse
+export type IntentHistory = V1.IntentHistory | V1_5.IntentHistory

package/src/index.ts

@@ -1,6 +1,39 @@
+export type {
+  CommitIntentRequest,
+  CommitIntentResponse,
+  DepositIntentEntry,
+  DepositSignature,
+  ExecuteIntentRequest,
+  ExecuteIntentResponse,
+  GetIntentResponse,
+  Intent,
+  IntentHistory,
+  IntentReceipt,
+  QuoteIntentRequest,
+  TrailsClient,
+  TrailsContracts,
+  WaitIntentReceiptResponse,
+} from "./api-types.js"
 export * from "./trails-api.gen.js"
-
+export type {
+  GetIntentConfigRequest,
+  GetIntentConfigResponse,
+  GetSupportedIntentProtocolVersionsResponse,
+} from "./trails-api-v1_5.gen.js"
+export { IntentProtocolVersion, IntentSource } from "./trails-api-v1_5.gen.js"
+import type {
+  CommitIntentRequest,
+  CommitIntentResponse,
+  ExecuteIntentRequest,
+  ExecuteIntentResponse,
+} from "./api-types.js"
 import { Trails as BaseTrails } from "./trails-api.gen.js"
+import type {
+  GetIntentConfigRequest,
+  GetIntentConfigResponse,
+  GetSupportedIntentProtocolVersionsResponse,
+} from "./trails-api-v1_5.gen.js"
+import { Trails as TrailsV1_5 } from "./trails-api-v1_5.gen.js"
 
 export interface TrailsApiOptions {
   apiKey?: string
@@ -8,14 +41,16 @@ export interface TrailsApiOptions {
   hostname?: string
 }
 
+// Use v1 client as base, shim v2 methods in
+
 export class TrailsApi extends BaseTrails {
+  private _v1_5: TrailsV1_5
+
   constructor(apiKey: string, options?: TrailsApiOptions) {
     const customFetch = (
       input: RequestInfo,
       init?: RequestInit,
     ): Promise<Response> => {
-      // automatically include jwt and access key auth header to requests
-      // if its been set on the api client
       const headers: { [key: string]: any } = {}
 
       if (options?.jwt && options?.jwt.length > 0) {
@@ -26,7 +61,6 @@ export class TrailsApi extends BaseTrails {
         headers["X-Access-Key"] = apiKey
       }
 
-      // before the request is made
       init = init || {}
       init.headers = { ...init.headers, ...headers }
 
@@ -38,10 +72,17 @@ export class TrailsApi extends BaseTrails {
         ? options?.hostname
         : "https://trails-api.sequence.app"
 
-    super(
-      hostname.endsWith("/") ? hostname.slice(0, -1) : hostname,
-      customFetch,
-    )
+    const baseUrl = hostname.endsWith("/") ? hostname.slice(0, -1) : hostname
+    super(baseUrl, customFetch)
+    this._v1_5 = new TrailsV1_5(baseUrl, customFetch)
+
+    // Capture and re-bind commit/executeIntent
+    const baseCommitIntent = this.commitIntent.bind(this)
+    const baseExecuteIntent = this.executeIntent.bind(this)
+    this.commitIntent = (req, headers?, signal?) =>
+      baseCommitIntent(req, headers, signal)
+    this.executeIntent = (req, headers?, signal?) =>
+      baseExecuteIntent(req, headers, signal)
   }
 
   getHostname(): string {
@@ -51,4 +92,34 @@ export class TrailsApi extends BaseTrails {
   getFetch(): any {
     return this.fetch
   }
+
+  // Accept union request types (CommitIntentRequest / ExecuteIntentRequest from api-types)
+  declare commitIntent: (
+    req: CommitIntentRequest,
+    headers?: object,
+    signal?: AbortSignal,
+  ) => Promise<CommitIntentResponse>
+
+  declare executeIntent: (
+    req: ExecuteIntentRequest,
+    headers?: object,
+    signal?: AbortSignal,
+  ) => Promise<ExecuteIntentResponse>
+
+  // V2-specific methods (shim)
+
+  getIntentConfig(
+    req: GetIntentConfigRequest,
+    headers?: object,
+    signal?: AbortSignal,
+  ): Promise<GetIntentConfigResponse> {
+    return this._v1_5.getIntentConfig(req, headers, signal)
+  }
+
+  getSupportedIntentProtocolVersions(
+    headers?: object,
+    signal?: AbortSignal,
+  ): Promise<GetSupportedIntentProtocolVersionsResponse> {
+    return this._v1_5.getSupportedIntentProtocolVersions(headers, signal)
+  }
 }