@xkova/sdk 0.1.0-alpha.3 → 0.1.0-alpha.5

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 (7) hide show
  1. package/README.md +1 -1
  2. package/dist/generated/types.d.ts +300 -275
  3. package/dist/resources/ramps.d.ts +72 -63
  4. package/dist/resources/rwa.d.ts +9 -9
  5. package/dist/resources/tokenization.d.ts +4 -0
  6. package/llms.txt +5 -5
  7. package/package.json +1 -1
package/dist/resources/ramps.d.ts CHANGED
@@ -11,31 +11,34 @@ export declare class RampsResource extends Resource {
11
11
  has_more: boolean;
12
12
  }>;
13
13
  createFunding(body: ReqBody<'createFundingRequest'>, opts?: RampRequestOptions): Promise<{
14
- id?: import("../generated/types.js").components["schemas"]["FundingRequestId"];
15
- tenant_id?: string;
16
- workspace_id?: string;
14
+ id: import("../generated/types.js").components["schemas"]["FundingRequestId"];
15
+ tenant_id: string;
16
+ workspace_id: string;
17
17
  chain: import("../generated/types.js").components["schemas"]["ChainDescriptor"];
18
- account_holder_id?: import("../generated/types.js").components["schemas"]["AccountHolderId"];
19
- amount?: import("../generated/types.js").components["schemas"]["Money"];
20
- currency?: string;
21
- state?: "pending_compliance" | "pending_issuance" | "settled" | "failed";
22
- failure_reason_code?: string | null;
23
- x_partner_reference?: string | null;
24
- quote_id?: string | null;
25
- bank_debit_transfer_id?: string | null;
26
- partner_status?: string | null;
27
- last_event_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
28
- metadata?: {
18
+ account_holder_id: import("../generated/types.js").components["schemas"]["AccountHolderId"];
19
+ amount: import("../generated/types.js").components["schemas"]["Money"];
20
+ currency: string;
21
+ state: "pending_compliance" | "pending_issuance" | "settled" | "failed";
22
+ failure_reason_code: string | null;
23
+ x_partner_reference: string | null;
24
+ quote_id: string | null;
25
+ quote_rate: string | null;
26
+ quote_stablecoin_amount: import("../generated/types.js").components["schemas"]["Money"] | null;
27
+ quote_partner_fee_fiat: import("../generated/types.js").components["schemas"]["Money"] | null;
28
+ bank_debit_transfer_id: string | null;
29
+ partner_status: string | null;
30
+ last_event_at: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
31
+ metadata: {
29
32
  [key: string]: unknown;
30
33
  } | null;
31
34
  settlement_order: "hold_first" | "debit_first" | null;
32
- idempotency_key?: string;
33
- correlation_id?: string;
34
- ramp_profile?: "mock" | "sandbox" | "coinbase";
35
- hosted_redirect_url?: string | null;
36
- created_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
37
- updated_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
38
- settled_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
35
+ idempotency_key: string;
36
+ correlation_id: string;
37
+ ramp_profile: "mock" | "sandbox" | "coinbase";
38
+ hosted_redirect_url: string | null;
39
+ created_at: import("../generated/types.js").components["schemas"]["TimestampUtc"];
40
+ updated_at: import("../generated/types.js").components["schemas"]["TimestampUtc"];
41
+ settled_at: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
39
42
  }>;
40
43
  /**
41
44
  * One-call sandbox funding convenience. This invokes the normal funding
@@ -43,58 +46,64 @@ export declare class RampsResource extends Resource {
43
46
  * resource, state transitions, webhooks, and idempotency behavior.
44
47
  */
45
48
  fundSandboxWallet(body: SandboxFundingBody, opts?: RampRequestOptions): Promise<{
46
- id?: import("../generated/types.js").components["schemas"]["FundingRequestId"];
47
- tenant_id?: string;
48
- workspace_id?: string;
49
+ id: import("../generated/types.js").components["schemas"]["FundingRequestId"];
50
+ tenant_id: string;
51
+ workspace_id: string;
49
52
  chain: import("../generated/types.js").components["schemas"]["ChainDescriptor"];
50
- account_holder_id?: import("../generated/types.js").components["schemas"]["AccountHolderId"];
51
- amount?: import("../generated/types.js").components["schemas"]["Money"];
52
- currency?: string;
53
- state?: "pending_compliance" | "pending_issuance" | "settled" | "failed";
54
- failure_reason_code?: string | null;
55
- x_partner_reference?: string | null;
56
- quote_id?: string | null;
57
- bank_debit_transfer_id?: string | null;
58
- partner_status?: string | null;
59
- last_event_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
60
- metadata?: {
53
+ account_holder_id: import("../generated/types.js").components["schemas"]["AccountHolderId"];
54
+ amount: import("../generated/types.js").components["schemas"]["Money"];
55
+ currency: string;
56
+ state: "pending_compliance" | "pending_issuance" | "settled" | "failed";
57
+ failure_reason_code: string | null;
58
+ x_partner_reference: string | null;
59
+ quote_id: string | null;
60
+ quote_rate: string | null;
61
+ quote_stablecoin_amount: import("../generated/types.js").components["schemas"]["Money"] | null;
62
+ quote_partner_fee_fiat: import("../generated/types.js").components["schemas"]["Money"] | null;
63
+ bank_debit_transfer_id: string | null;
64
+ partner_status: string | null;
65
+ last_event_at: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
66
+ metadata: {
61
67
  [key: string]: unknown;
62
68
  } | null;
63
69
  settlement_order: "hold_first" | "debit_first" | null;
64
- idempotency_key?: string;
65
- correlation_id?: string;
66
- ramp_profile?: "mock" | "sandbox" | "coinbase";
67
- hosted_redirect_url?: string | null;
68
- created_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
69
- updated_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
70
- settled_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
70
+ idempotency_key: string;
71
+ correlation_id: string;
72
+ ramp_profile: "mock" | "sandbox" | "coinbase";
73
+ hosted_redirect_url: string | null;
74
+ created_at: import("../generated/types.js").components["schemas"]["TimestampUtc"];
75
+ updated_at: import("../generated/types.js").components["schemas"]["TimestampUtc"];
76
+ settled_at: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
71
77
  }>;
72
78
  getFunding(id: string): Promise<{
73
- id?: import("../generated/types.js").components["schemas"]["FundingRequestId"];
74
- tenant_id?: string;
75
- workspace_id?: string;
79
+ id: import("../generated/types.js").components["schemas"]["FundingRequestId"];
80
+ tenant_id: string;
81
+ workspace_id: string;
76
82
  chain: import("../generated/types.js").components["schemas"]["ChainDescriptor"];
77
- account_holder_id?: import("../generated/types.js").components["schemas"]["AccountHolderId"];
78
- amount?: import("../generated/types.js").components["schemas"]["Money"];
79
- currency?: string;
80
- state?: "pending_compliance" | "pending_issuance" | "settled" | "failed";
81
- failure_reason_code?: string | null;
82
- x_partner_reference?: string | null;
83
- quote_id?: string | null;
84
- bank_debit_transfer_id?: string | null;
85
- partner_status?: string | null;
86
- last_event_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
87
- metadata?: {
83
+ account_holder_id: import("../generated/types.js").components["schemas"]["AccountHolderId"];
84
+ amount: import("../generated/types.js").components["schemas"]["Money"];
85
+ currency: string;
86
+ state: "pending_compliance" | "pending_issuance" | "settled" | "failed";
87
+ failure_reason_code: string | null;
88
+ x_partner_reference: string | null;
89
+ quote_id: string | null;
90
+ quote_rate: string | null;
91
+ quote_stablecoin_amount: import("../generated/types.js").components["schemas"]["Money"] | null;
92
+ quote_partner_fee_fiat: import("../generated/types.js").components["schemas"]["Money"] | null;
93
+ bank_debit_transfer_id: string | null;
94
+ partner_status: string | null;
95
+ last_event_at: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
96
+ metadata: {
88
97
  [key: string]: unknown;
89
98
  } | null;
90
99
  settlement_order: "hold_first" | "debit_first" | null;
91
- idempotency_key?: string;
92
- correlation_id?: string;
93
- ramp_profile?: "mock" | "sandbox" | "coinbase";
94
- hosted_redirect_url?: string | null;
95
- created_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
96
- updated_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"];
97
- settled_at?: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
100
+ idempotency_key: string;
101
+ correlation_id: string;
102
+ ramp_profile: "mock" | "sandbox" | "coinbase";
103
+ hosted_redirect_url: string | null;
104
+ created_at: import("../generated/types.js").components["schemas"]["TimestampUtc"];
105
+ updated_at: import("../generated/types.js").components["schemas"]["TimestampUtc"];
106
+ settled_at: import("../generated/types.js").components["schemas"]["TimestampUtc"] | null;
98
107
  }>;
99
108
  listOffRamp(query?: Query<'listOffRampRequests'>): Promise<{
100
109
  data: import("../generated/types.js").components["schemas"]["OffRampRequest"][];
package/dist/resources/rwa.d.ts CHANGED
@@ -75,10 +75,10 @@ export declare class RwaResource extends Resource {
75
75
  bound_at: string;
76
76
  }>;
77
77
  proposeSchemaRebind(body: ReqBody<'proposeRwaSchemaRebind'>, opts?: XKOVAMutationOptions): Promise<{
78
- ceremony_id: string;
78
+ ceremony_id: import("../generated/types.js").components["schemas"]["SchemaRebindId"];
79
79
  }>;
80
80
  getSchemaRebind(id: string): Promise<{
81
- id: string;
81
+ id: import("../generated/types.js").components["schemas"]["SchemaRebindId"];
82
82
  status: "proposed" | "dry_run_passed" | "dry_run_failed" | "attested" | "committed" | "failed";
83
83
  asset_schema_id: string;
84
84
  from_version: number;
@@ -119,7 +119,7 @@ export declare class RwaResource extends Resource {
119
119
  submitAttestedEntry(tokenId: string, fieldPath: string, body: ReqBody<'submitRwaAttestedEntry'>, opts?: XKOVAMutationOptions): Promise<{
120
120
  committed: boolean;
121
121
  deduped: boolean;
122
- attester_id: string;
122
+ attester_id: import("../generated/types.js").components["schemas"]["RwaAttesterId"];
123
123
  attester_address: string;
124
124
  attested_digest: string;
125
125
  }>;
@@ -183,7 +183,7 @@ export declare class RwaResource extends Resource {
183
183
  created_at: string;
184
184
  }>;
185
185
  createCorporateAction(tokenId: string, body: ReqBody<'createRwaCorporateAction'>, opts?: XKOVAMutationOptions): Promise<{
186
- id: string;
186
+ id: import("../generated/types.js").components["schemas"]["CorporateActionId"];
187
187
  customer_token_id: string;
188
188
  kind: "redemption" | "split" | "consolidation" | "additional_issuance" | "capital_call" | "mandatory_conversion";
189
189
  state: string;
@@ -201,7 +201,7 @@ export declare class RwaResource extends Resource {
201
201
  created_at: string;
202
202
  }>;
203
203
  getCorporateAction(tokenId: string, caId: string): Promise<{
204
- id: string;
204
+ id: import("../generated/types.js").components["schemas"]["CorporateActionId"];
205
205
  customer_token_id: string;
206
206
  kind: "redemption" | "split" | "consolidation" | "additional_issuance" | "capital_call" | "mandatory_conversion";
207
207
  state: string;
@@ -219,7 +219,7 @@ export declare class RwaResource extends Resource {
219
219
  created_at: string;
220
220
  }>;
221
221
  advanceCorporateAction(tokenId: string, caId: string, opts?: XKOVAMutationOptions): Promise<{
222
- id: string;
222
+ id: import("../generated/types.js").components["schemas"]["CorporateActionId"];
223
223
  customer_token_id: string;
224
224
  kind: "redemption" | "split" | "consolidation" | "additional_issuance" | "capital_call" | "mandatory_conversion";
225
225
  state: string;
@@ -285,7 +285,7 @@ export declare class RwaResource extends Resource {
285
285
  reason: string;
286
286
  }>;
287
287
  listAttesters(tokenId: string): Promise<{
288
- id: string;
288
+ id: import("../generated/types.js").components["schemas"]["RwaAttesterId"];
289
289
  customer_token_id: string | null;
290
290
  display_name: string;
291
291
  attester_address: string;
@@ -294,7 +294,7 @@ export declare class RwaResource extends Resource {
294
294
  created_at: string;
295
295
  }[]>;
296
296
  registerAttester(tokenId: string, body: ReqBody<'registerRwaAttester'>, opts?: XKOVAMutationOptions): Promise<{
297
- id: string;
297
+ id: import("../generated/types.js").components["schemas"]["RwaAttesterId"];
298
298
  customer_token_id: string | null;
299
299
  display_name: string;
300
300
  attester_address: string;
@@ -303,7 +303,7 @@ export declare class RwaResource extends Resource {
303
303
  created_at: string;
304
304
  }>;
305
305
  revokeAttester(tokenId: string, attesterId: string, opts?: XKOVAMutationOptions): Promise<{
306
- id: string;
306
+ id: import("../generated/types.js").components["schemas"]["RwaAttesterId"];
307
307
  customer_token_id: string | null;
308
308
  display_name: string;
309
309
  attester_address: string;
package/dist/resources/tokenization.d.ts CHANGED
@@ -56,6 +56,7 @@ export declare class TokenizationResource extends Resource {
56
56
  kind: "server_key" | "safe";
57
57
  purpose: "operator" | "service_account";
58
58
  safe_purpose: ("fund_vault" | "token_control" | "multi_purpose") | null;
59
+ managed_safe_state: ("deploying" | "active" | "decommissioned") | null;
59
60
  address: string;
60
61
  label: string | null;
61
62
  managed_safe_id: import("../generated/types.js").components["schemas"]["ManagedSafeId"] | null;
@@ -68,6 +69,7 @@ export declare class TokenizationResource extends Resource {
68
69
  kind: "server_key" | "safe";
69
70
  purpose: "operator" | "service_account";
70
71
  safe_purpose: ("fund_vault" | "token_control" | "multi_purpose") | null;
72
+ managed_safe_state: ("deploying" | "active" | "decommissioned") | null;
71
73
  address: string;
72
74
  label: string | null;
73
75
  managed_safe_id: import("../generated/types.js").components["schemas"]["ManagedSafeId"] | null;
@@ -82,6 +84,7 @@ export declare class TokenizationResource extends Resource {
82
84
  kind: "server_key" | "safe";
83
85
  purpose: "operator" | "service_account";
84
86
  safe_purpose: ("fund_vault" | "token_control" | "multi_purpose") | null;
87
+ managed_safe_state: ("deploying" | "active" | "decommissioned") | null;
85
88
  address: string;
86
89
  label: string | null;
87
90
  managed_safe_id: import("../generated/types.js").components["schemas"]["ManagedSafeId"] | null;
@@ -100,6 +103,7 @@ export declare class TokenizationResource extends Resource {
100
103
  kind: "server_key" | "safe";
101
104
  purpose: "operator" | "service_account";
102
105
  safe_purpose: ("fund_vault" | "token_control" | "multi_purpose") | null;
106
+ managed_safe_state: ("deploying" | "active" | "decommissioned") | null;
103
107
  address: string;
104
108
  label: string | null;
105
109
  managed_safe_id: import("../generated/types.js").components["schemas"]["ManagedSafeId"] | null;
package/llms.txt CHANGED
@@ -5,12 +5,12 @@ Use this package on a Node.js 22+ server. Read the installed declarations before
5
5
  ## Read first
6
6
 
7
7
  - [Package guide](README.md): installation, production signing, Hosted Auth, member sessions, durable stores, cancellation, errors, webhooks, and proof verification.
8
- - [Client declarations](dist/client.d.ts): exact resource properties and client options for this installed release.
9
- - [Customer API types](dist/generated/types.d.ts): exact request bodies, responses, parameters, and operation IDs. Import types through @xkova/sdk/types.
10
- - [Member BFF declarations](dist/member-bff.d.ts): authorization, session persistence, refresh, logout, action reviews, and human authorization.
11
- - [Member resources](dist/member-resources.d.ts): typed resources bound to the exact authenticated member.
8
+ - `dist/client.d.ts`: exact resource properties and client options for this installed release.
9
+ - `dist/generated/types.d.ts`: exact request bodies, responses, parameters, and operation IDs. Import types through @xkova/sdk/types.
10
+ - `dist/member-bff.d.ts`: authorization, session persistence, refresh, logout, action reviews, and human authorization.
11
+ - `dist/member-resources.d.ts`: typed resources bound to the exact authenticated member.
12
12
  - [Quickstart](https://docs.xkova.com/getting-started.html): sandbox access and first authenticated call.
13
- - [Customer OpenAPI](https://docs.xkova.com/data/openapi-customer.json): machine-readable customer contract for the current published documentation.
13
+ - [Customer OpenAPI](https://github.com/XKOVA/typescript-sdk/blob/main/schema/customer-api.json): customer contract in this source repository. Installed declarations determine your release’s exact request and response types.
14
14
  - [SDK guide](https://docs.xkova.com/sdk-overview.html): client and resource examples.
15
15
  - [Workflow guide](https://docs.xkova.com/sdk-workflows.html): supported workflow helpers.
16
16
  - [Member integration](https://docs.xkova.com/embedded-member.html): browser, BFF, identity, and signing boundaries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xkova/sdk",
3
- "version": "0.1.0-alpha.3",
3
+ "version": "0.1.0-alpha.5",
4
4
  "description": "TypeScript SDK for the XKOVA API.",
5
5
  "homepage": "https://docs.xkova.com",
6
6
  "repository": {