@settlemint/dalp-sdk 3.1.25 → 3.1.26-main.37116470199

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/README.md +239 -172
  2. package/dist/auth/client.d.ts +103 -0
  3. package/dist/auth/invite-step-up.d.ts +2 -0
  4. package/dist/auth/live.d.ts +47 -0
  5. package/dist/auth/native-passkey.d.ts +9 -0
  6. package/dist/{auth-permissions.d.ts → auth/permissions.d.ts} +0 -8
  7. package/dist/{auth-wallet-plugins.d.ts → auth/wallet-plugins.d.ts} +68 -6
  8. package/dist/auth-surface.d.ts +2 -0
  9. package/dist/auth.d.ts +8 -115
  10. package/dist/auth.js +525 -0
  11. package/dist/chunk-4f4kjtt0.js +149 -0
  12. package/dist/chunk-b03ycwb7.js +68 -0
  13. package/dist/chunk-ghgcmyhk.js +5 -0
  14. package/dist/chunk-h241xecg.js +1625 -0
  15. package/dist/chunk-hqz56e6q.js +4 -0
  16. package/dist/chunk-k3ntysxx.js +57 -0
  17. package/dist/chunk-pjjrxre1.js +36 -0
  18. package/dist/chunk-qvtjb3dz.js +102 -0
  19. package/dist/chunk-v54k7mgr.js +271 -0
  20. package/dist/chunk-w361dpdk.js +5 -0
  21. package/dist/client/conditional-request.d.ts +8 -0
  22. package/dist/client/factory.d.ts +4 -0
  23. package/dist/client/query-serializer.d.ts +1 -0
  24. package/dist/client/request-compression.d.ts +12 -0
  25. package/dist/client/ssr-fetch.d.ts +10 -0
  26. package/dist/client/step-up-challenge.d.ts +10 -0
  27. package/dist/effect.d.ts +38 -0
  28. package/dist/effect.js +87 -0
  29. package/dist/errors/api-error.d.ts +35 -0
  30. package/dist/errors/error-codes.d.ts +21 -0
  31. package/dist/errors/find-current-error.d.ts +2 -0
  32. package/dist/errors/sdk-error.d.ts +52 -0
  33. package/dist/errors/sdk-error.js +8 -0
  34. package/dist/generated/api-types.d.ts +69961 -0
  35. package/dist/generated/console-routes.d.ts +12 -0
  36. package/dist/generated/error-catalog.d.ts +9 -0
  37. package/dist/generated/error-codes.d.ts +9 -0
  38. package/dist/generated/response-scalars.d.ts +9 -0
  39. package/dist/generated/response-schemas.d.ts +9 -0
  40. package/dist/generated/route-error-codes.d.ts +9 -0
  41. package/dist/generated/routes.d.ts +12 -0
  42. package/dist/index.d.ts +28 -45
  43. package/dist/index.js +150 -96216
  44. package/dist/proxy/builder.d.ts +17 -0
  45. package/dist/proxy/client-core.d.ts +28 -0
  46. package/dist/proxy/client.d.ts +5 -0
  47. package/dist/proxy/fetch-executor.d.ts +6 -0
  48. package/dist/proxy/flat-args.d.ts +24 -0
  49. package/dist/proxy/response-decode.d.ts +37 -0
  50. package/dist/proxy/sse.d.ts +11 -0
  51. package/dist/proxy/step-up-challenge.d.ts +4 -0
  52. package/dist/proxy/tanstack.d.ts +6 -0
  53. package/dist/proxy/transport.d.ts +63 -0
  54. package/dist/react-query.d.ts +2 -0
  55. package/dist/react-query.js +12 -0
  56. package/dist/readonly-deep.d.ts +3 -0
  57. package/dist/routes/console.d.ts +14 -0
  58. package/dist/routes/console.js +25 -0
  59. package/dist/routes/index.d.ts +4 -0
  60. package/dist/routes/index.js +10 -0
  61. package/dist/routes/types.d.ts +72 -0
  62. package/dist/runtime-exports.d.ts +4 -0
  63. package/dist/runtime-exports.js +16 -0
  64. package/dist/runtime.d.ts +11 -0
  65. package/dist/scalars/big-decimal.d.ts +4 -0
  66. package/dist/scalars/ethereum-address.d.ts +5 -0
  67. package/dist/scalars/exchange-rates.d.ts +13 -0
  68. package/dist/scalars/index.d.ts +10 -0
  69. package/dist/scalars/index.js +102 -0
  70. package/dist/scalars/organization-id.d.ts +5 -0
  71. package/dist/scalars/token-decimals.d.ts +4 -0
  72. package/dist/secret.d.ts +12 -0
  73. package/dist/sign-webhook-receipt.d.ts +16 -0
  74. package/dist/sign-webhook-receipt.js +26 -0
  75. package/dist/transport/cookie-store.d.ts +9 -0
  76. package/dist/transport/sse-lifecycle.d.ts +24 -0
  77. package/dist/types.d.ts +37 -114
  78. package/dist/url.d.ts +0 -1
  79. package/dist/verify-webhook.d.ts +17 -28
  80. package/dist/verify-webhook.js +8 -0
  81. package/dist/version.d.ts +0 -3
  82. package/dist/wait-for-transaction.d.ts +44 -86
  83. package/dist/wait-for-transaction.js +151 -0
  84. package/dist/webhook-events.d.ts +543 -33
  85. package/package.json +110 -34
  86. package/dist/api-types.generated.d.ts +0 -14160
  87. package/dist/api-types.generated.d.ts.map +0 -1
  88. package/dist/auth-permissions.d.ts.map +0 -1
  89. package/dist/auth-wallet-plugins.d.ts.map +0 -1
  90. package/dist/auth.d.ts.map +0 -1
  91. package/dist/bundler.d.ts +0 -217
  92. package/dist/bundler.d.ts.map +0 -1
  93. package/dist/chunk-xm8h1dzh.js +0 -33
  94. package/dist/client.d.ts +0 -19
  95. package/dist/client.d.ts.map +0 -1
  96. package/dist/contract-errors.d.ts +0 -4156
  97. package/dist/contract-errors.d.ts.map +0 -1
  98. package/dist/contract.d.ts +0 -22
  99. package/dist/contract.d.ts.map +0 -1
  100. package/dist/cookie-store.d.ts +0 -10
  101. package/dist/cookie-store.d.ts.map +0 -1
  102. package/dist/dapi-errors.d.ts +0 -654
  103. package/dist/dapi-errors.d.ts.map +0 -1
  104. package/dist/errors.d.ts +0 -637
  105. package/dist/errors.d.ts.map +0 -1
  106. package/dist/index.d.ts.map +0 -1
  107. package/dist/platform.d.ts +0 -41
  108. package/dist/platform.d.ts.map +0 -1
  109. package/dist/plugins/index.d.ts +0 -13
  110. package/dist/plugins/index.d.ts.map +0 -1
  111. package/dist/plugins/index.js +0 -10
  112. package/dist/sdk-error.d.ts +0 -74
  113. package/dist/sdk-error.d.ts.map +0 -1
  114. package/dist/serializers.d.ts +0 -41
  115. package/dist/serializers.d.ts.map +0 -1
  116. package/dist/types.d.ts.map +0 -1
  117. package/dist/url.d.ts.map +0 -1
  118. package/dist/verify-webhook.d.ts.map +0 -1
  119. package/dist/version.d.ts.map +0 -1
  120. package/dist/version.generated.d.ts +0 -8
  121. package/dist/version.generated.d.ts.map +0 -1
  122. package/dist/wait-for-transaction.d.ts.map +0 -1
  123. package/dist/webhook-events.d.ts.map +0 -1
@@ -0,0 +1,17 @@
1
+ import type { RouteRow, RouteTable } from "../routes/types.ts";
2
+ export interface CallOptions {
3
+ readonly signal?: AbortSignal;
4
+ readonly settlementTimeoutMs?: number;
5
+ readonly headers?: Readonly<Record<string, string>> | (() => Readonly<Record<string, string>>);
6
+ }
7
+ export type Executor = (route: RouteRow, id: string, input: unknown, options: CallOptions | undefined) => unknown;
8
+ export interface LeafExtras {
9
+ readonly queryOptions: (input?: unknown, options?: CallOptions) => unknown;
10
+ readonly mutationOptions: (options?: CallOptions) => unknown;
11
+ }
12
+ export interface LeafFactories {
13
+ readonly queryOptions: (route: RouteRow, id: string, input: unknown, options: CallOptions | undefined) => unknown;
14
+ readonly mutationOptions: (route: RouteRow, id: string, options: CallOptions | undefined) => unknown;
15
+ }
16
+ export declare function buildProxy(table: RouteTable, executor: Executor, factories: LeafFactories): unknown;
17
+ export declare function findRoute(table: RouteTable, id: string): RouteRow | undefined;
@@ -0,0 +1,28 @@
1
+ import type { DalpApi, DalpRouteTypes } from "../generated/api-types.d.ts";
2
+ import type { RouteTable } from "../routes/types.ts";
3
+ import { type CallOptions } from "./builder.ts";
4
+ import type { DalpRequestParts } from "./flat-args.ts";
5
+ import { type CreateDalpClientOptions } from "./transport.ts";
6
+ export interface DalpRouteTypeEntry {
7
+ readonly request: unknown;
8
+ readonly requestParts?: unknown;
9
+ readonly response: unknown;
10
+ readonly streaming?: boolean;
11
+ }
12
+ export type DalpExecuteResult<Entry extends DalpRouteTypeEntry> = Promise<Entry["streaming"] extends true ? AsyncIterable<Entry["response"]> : Entry["response"]>;
13
+ export type DalpStreamRouteKey<RouteTypes> = {
14
+ [Id in keyof RouteTypes]: RouteTypes[Id] extends {
15
+ readonly streaming: true;
16
+ } ? Id : never;
17
+ }[keyof RouteTypes];
18
+ export type DalpRequestRouteKey<RouteTypes> = Exclude<keyof RouteTypes, DalpStreamRouteKey<RouteTypes>>;
19
+ export interface DalpClient<Api = DalpApi, RouteTypes extends Record<keyof RouteTypes, DalpRouteTypeEntry> = DalpRouteTypes> {
20
+ readonly api: Api;
21
+ readonly conditionalRequests: {
22
+ readonly clear: () => void;
23
+ };
24
+ readonly execute: <Id extends keyof RouteTypes>(routeId: Id, input?: RouteTypes[Id]["request"], options?: CallOptions) => DalpExecuteResult<RouteTypes[Id]>;
25
+ readonly sendParts: <Id extends DalpRequestRouteKey<RouteTypes>>(routeId: Id, parts?: DalpRequestParts<RouteTypes[Id]["requestParts"]>, options?: CallOptions) => Promise<RouteTypes[Id]["response"]>;
26
+ readonly streamParts: <Id extends DalpStreamRouteKey<RouteTypes>>(routeId: Id, parts?: DalpRequestParts<RouteTypes[Id]["requestParts"]>, options?: CallOptions) => AsyncIterable<RouteTypes[Id]["response"]>;
27
+ }
28
+ export declare function buildDalpClient<Api, RouteTypes extends Record<keyof RouteTypes, DalpRouteTypeEntry>>(options: CreateDalpClientOptions, table: RouteTable): DalpClient<Api, RouteTypes>;
@@ -0,0 +1,5 @@
1
+ import { type DalpClient } from "./client-core.ts";
2
+ import type { CreateDalpClientOptions } from "./transport.ts";
3
+ export type { DalpClient, DalpExecuteResult, DalpRequestRouteKey, DalpRouteTypeEntry, DalpStreamRouteKey, } from "./client-core.ts";
4
+ export type { DalpRequestParts } from "./flat-args.ts";
5
+ export declare function createDalpClient(options: CreateDalpClientOptions): DalpClient;
@@ -0,0 +1,6 @@
1
+ import type { CallOptions, Executor } from "./builder.ts";
2
+ import { type Transport } from "./transport.ts";
3
+ import type { RouteRow } from "../routes/types.ts";
4
+ import type { RequestInput } from "./flat-args.ts";
5
+ export declare function sendRequest(transport: Transport, route: RouteRow, routeId: string, input: RequestInput, options: CallOptions | undefined): Promise<unknown>;
6
+ export declare function createFetchExecutor(transport: Transport): Executor;
@@ -0,0 +1,24 @@
1
+ import type { RouteRow } from "../routes/types.ts";
2
+ export type FlatCallValue = null | boolean | number | string | ReadonlyArray<FlatCallValue> | FlatCallObject;
3
+ export interface FlatCallObject {
4
+ readonly [key: string]: FlatCallValue;
5
+ }
6
+ export type FlatCallInput = FlatCallObject;
7
+ export interface SplitArgs {
8
+ readonly path: FlatCallInput;
9
+ readonly query: FlatCallInput;
10
+ readonly body: FlatCallInput | undefined;
11
+ }
12
+ export declare function splitFlatArgs(route: RouteRow, input: unknown): SplitArgs;
13
+ export type DalpRequestParts<Parts> = {
14
+ [K in keyof Parts as K extends "path" ? "params" : K extends "url" ? never : K]: Parts[K];
15
+ };
16
+ export type RequestInput = {
17
+ readonly flat: unknown;
18
+ } | {
19
+ readonly parts: unknown;
20
+ };
21
+ export declare function splitRequestParts(route: RouteRow, parts: unknown): SplitArgs;
22
+ export declare function splitRequestInput(route: RouteRow, input: RequestInput): SplitArgs;
23
+ export declare function buildPath(route: RouteRow, path: FlatCallInput): string;
24
+ export declare function pathTarget(route: RouteRow, path: FlatCallInput): string | null;
@@ -0,0 +1,37 @@
1
+ import type { JsonSchemaNode, ResponseSchemaTable } from "../routes/types.ts";
2
+ export declare const MALFORMED_SUCCESS_ERROR_CODE = "sdk.response.MALFORMED_SUCCESS";
3
+ export interface ResponseMismatch {
4
+ readonly path: string;
5
+ readonly expected: string;
6
+ readonly received: string;
7
+ }
8
+ export declare class ResponseSchemaChecker {
9
+ private readonly compiled;
10
+ private readonly patterns;
11
+ private readonly definitions;
12
+ constructor(definitions: ResponseSchemaTable["definitions"]);
13
+ validate(node: JsonSchemaNode, value: unknown): boolean;
14
+ explain(node: JsonSchemaNode, value: unknown, path?: string): ResponseMismatch | undefined;
15
+ private definition;
16
+ private pattern;
17
+ private compile;
18
+ private build;
19
+ private buildValueChecks;
20
+ private buildObjectChecks;
21
+ private buildArrayChecks;
22
+ private buildCompositionChecks;
23
+ private explainType;
24
+ private explainValue;
25
+ private explainObject;
26
+ private explainArray;
27
+ private explainComposition;
28
+ private tagsMatch;
29
+ }
30
+ export declare class ResponseDecoder {
31
+ private readonly checker;
32
+ private readonly table;
33
+ constructor(table: ResponseSchemaTable);
34
+ declaresBody(routeId: string, status: number): boolean;
35
+ decode(routeId: string, status: number, payload: unknown): unknown;
36
+ }
37
+ export declare function loadResponseDecoder(): Promise<ResponseDecoder>;
@@ -0,0 +1,11 @@
1
+ import type { CallOptions } from "./builder.ts";
2
+ import type { RouteRow } from "../routes/types.ts";
3
+ import type { RequestInput } from "./flat-args.ts";
4
+ import { type Transport } from "./transport.ts";
5
+ export declare const RESERVED_STREAM_FAILURE_EVENT = "effect/http-api/stream/failure";
6
+ export declare const STREAM_FAILED_ERROR_CODE = "sdk.stream.FAILED";
7
+ export declare const STREAM_UNREADABLE_BODY_ERROR_CODE = "sdk.stream.UNREADABLE_BODY";
8
+ type FrameDecoder = (frame: unknown) => unknown;
9
+ export declare function decodeEventStream(body: ReadableStream<Uint8Array>, decodeFrame?: FrameDecoder, routeId?: string): AsyncGenerator<unknown>;
10
+ export declare function streamRequest(transport: Transport, route: RouteRow, routeId: string, input: RequestInput, options: CallOptions | undefined): AsyncGenerator<unknown>;
11
+ export {};
@@ -0,0 +1,4 @@
1
+ import type { RouteRow } from "../routes/types.ts";
2
+ import type { CallOptions } from "./builder.ts";
3
+ import { type PreparedRequest, type Transport } from "./transport.ts";
4
+ export declare function presentStepUpChallenge(transport: Transport, route: RouteRow, prepared: PreparedRequest, options: CallOptions | undefined): Promise<void>;
@@ -0,0 +1,6 @@
1
+ import type { LeafFactories } from "./builder.ts";
2
+ import type { Transport } from "./transport.ts";
3
+ export declare function canonicalize(value: unknown): unknown;
4
+ export declare function queryKeyFor(id: string, input: unknown): ReadonlyArray<unknown>;
5
+ export declare const UI_SETTLEMENT_TIMEOUT_MS = 30000;
6
+ export declare function createTanstackFactories(transport: Transport): LeafFactories;
@@ -0,0 +1,63 @@
1
+ import { type DalpAuthSurface } from "../auth-surface.ts";
2
+ import { Secret } from "../secret.ts";
3
+ import { type DalpRuntime } from "../runtime.ts";
4
+ import { type DalpFetch } from "../client/ssr-fetch.ts";
5
+ import { type ConditionalRequestStore } from "../client/conditional-request.ts";
6
+ import type { RouteRow } from "../routes/types.ts";
7
+ import { type FlatCallInput, type RequestInput } from "./flat-args.ts";
8
+ import type { CallOptions } from "./builder.ts";
9
+ export interface DalpClientContext {
10
+ readonly organizationId?: string;
11
+ readonly participant?: string;
12
+ readonly executor?: "eoa" | "smart-wallet";
13
+ readonly chainId?: number | string;
14
+ readonly selectedSigners?: ReadonlyArray<string>;
15
+ readonly idempotencyKey?: string;
16
+ }
17
+ export interface DalpSsrOptions {
18
+ readonly requestHeaders: HeadersInit;
19
+ readonly allowedOrigins?: ReadonlyArray<string | URL>;
20
+ }
21
+ export interface CreateDalpClientOptions {
22
+ readonly baseUrl: string | URL;
23
+ readonly apiKey?: string | Secret;
24
+ readonly authSurface?: DalpAuthSurface;
25
+ readonly context?: DalpClientContext;
26
+ readonly fetch?: DalpFetch;
27
+ readonly runtime?: DalpRuntime;
28
+ readonly ssr?: DalpSsrOptions;
29
+ readonly settlementTimeoutMs?: number;
30
+ }
31
+ export declare const CONTEXT_HEADERS: {
32
+ readonly organizationId: "X-Organization-Id";
33
+ readonly participant: "X-Participant";
34
+ readonly executor: "X-Executor";
35
+ readonly chainId: "X-Chain-Id";
36
+ readonly selectedSigners: "X-Selected-Signers";
37
+ readonly idempotencyKey: "Idempotency-Key";
38
+ };
39
+ export declare function createDalpContextHeaders(context: DalpClientContext): Headers;
40
+ export interface PreparedRequest {
41
+ readonly url: string;
42
+ readonly method: string;
43
+ readonly headers: Headers;
44
+ readonly pathParams: FlatCallInput;
45
+ readonly body: string | undefined;
46
+ }
47
+ export interface Transport {
48
+ readonly baseUrl: string;
49
+ readonly fetch: DalpFetch;
50
+ readonly credentials: RequestCredentials;
51
+ readonly apiKey: Secret | undefined;
52
+ readonly contextHeaders: Headers;
53
+ readonly settlementTimeoutMs: number | undefined;
54
+ readonly conditionalRequests: ConditionalRequestStore;
55
+ readonly streamsResponseBody: boolean;
56
+ }
57
+ export declare const DEFAULT_PREFER_WAIT_SECONDS = 15;
58
+ export declare function createTransport(options: CreateDalpClientOptions): Transport;
59
+ export declare function callHeaders(transport: Transport, options: CallOptions | undefined): Headers;
60
+ export declare function prepareRequest(transport: Transport, route: RouteRow, input: RequestInput, options: CallOptions | undefined): PreparedRequest;
61
+ export declare function raiseResponseError(response: Response, routeId: string): Promise<never>;
62
+ export declare function readBinaryResponse(response: Response, routeId: string): Promise<Uint8Array>;
63
+ export declare function readResponse(response: Response, routeId: string, bodyDeclared: boolean): Promise<unknown>;
@@ -0,0 +1,2 @@
1
+ export { canonicalize, queryKeyFor, UI_SETTLEMENT_TIMEOUT_MS } from "./proxy/tanstack.ts";
2
+ export type { CallOptions } from "./proxy/builder.ts";
@@ -0,0 +1,12 @@
1
+ import"./chunk-k3ntysxx.js";
2
+ import {
3
+ canonicalize2,
4
+ queryKeyFor2,
5
+ UI_SETTLEMENT_TIMEOUT_MS2
6
+ } from "./chunk-h241xecg.js";
7
+ import"./chunk-4f4kjtt0.js";
8
+ export {
9
+ UI_SETTLEMENT_TIMEOUT_MS2 as UI_SETTLEMENT_TIMEOUT_MS,
10
+ canonicalize2 as canonicalize,
11
+ queryKeyFor2 as queryKeyFor
12
+ };
@@ -0,0 +1,3 @@
1
+ export type ReadonlyDeep<T> = T extends string | number | bigint | boolean | symbol | null | undefined | Date | RegExp | Map<unknown, unknown> | Set<unknown> | Promise<unknown> ? T : T extends CallableFunction ? T : T extends object ? {
2
+ readonly [Key in keyof T]: ReadonlyDeep<T[Key]>;
3
+ } : T;
@@ -0,0 +1,14 @@
1
+ import { data as routeTable } from "../generated/console-routes.ts";
2
+ import type { DalpConsoleApi, DalpConsoleRouteErrorCode, DalpConsoleRouteId, DalpConsoleRouteTypes } from "../generated/api-types.d.ts";
3
+ import { type DalpApiError } from "../errors/api-error.ts";
4
+ import { type DalpSdkLocalErrorCode } from "../errors/error-codes.ts";
5
+ import { type DalpClient } from "../proxy/client-core.ts";
6
+ import type { CreateDalpClientOptions } from "../proxy/transport.ts";
7
+ export declare const routeIds: ReadonlyArray<keyof typeof routeTable.routes>;
8
+ export type DalpConsoleClient = DalpClient<DalpConsoleApi, DalpConsoleRouteTypes>;
9
+ export declare function createDalpConsoleClient(options: CreateDalpClientOptions): DalpConsoleClient;
10
+ export declare const isDalpConsoleRouteError: <Id extends DalpConsoleRouteId>(error: unknown, ...routeIds: readonly [Id, ...ReadonlyArray<Id>]) => error is DalpApiError<DalpConsoleRouteErrorCode<Id> | DalpSdkLocalErrorCode>;
11
+ export { routeTable };
12
+ export type { DalpConsoleApi, DalpConsoleRouteErrorCode, DalpConsoleRouteId, DalpConsoleRouteTypes, } from "../generated/api-types.d.ts";
13
+ export type { DalpRequestRouteKey, DalpStreamRouteKey } from "../proxy/client-core.ts";
14
+ export type { DalpRequestParts } from "../proxy/flat-args.ts";